Merge pull request swiftlang#30219 from bitjammer/acgarland/rdar-59128787-sg-include-synthesized

[SymbolGraph] Emit synthesized members

Author: bitjammer

include/swift/AST/Comment.h

@@ -93,15 +93,27 @@ class DocComment {
 };
 
 /// Get a parsed documentation comment for the declaration, if there is one.
+///
+/// \param AllowSerialized Allow loading serialized doc comment data, including
+/// comment ranges.
 DocComment *getSingleDocComment(swift::markup::MarkupContext &Context,
-                                const Decl *D);
+                                const Decl *D, bool AllowSerialized = false);
 
-const Decl *getDocCommentProvidingDecl(const Decl *D);
+/// Get the declaration that actually provides a doc comment for another.
+///
+/// \param AllowSerialized Allow loading serialized doc comment data, including
+/// comment ranges.
+const Decl *getDocCommentProvidingDecl(const Decl *D,
+                                       bool AllowSerialized = false);
 
 /// Attempt to get a doc comment from the declaration, or other inherited
 /// sources, like from base classes or protocols.
+///
+/// \param AllowSerialized Allow loading serialized doc comment data, including
+/// comment ranges.
 DocComment *getCascadingDocComment(swift::markup::MarkupContext &MC,
-                                   const Decl *D);
+                                   const Decl *D,
+                                   bool AllowSerialized = false);
 
 /// Extract comments parts from the given Markup node.
 swift::markup::CommentParts

include/swift/SymbolGraphGen/SymbolGraphGen.h

@@ -1,4 +1,4 @@
-//===--- swift_indent_main.cpp - Swift code formatting tool ---------------===//
+//===--- SymbolGraphGen.h - Swift SymbolGraph Generator -------------------===//
 //
 // This source file is part of the Swift.org open source project
 //
@@ -10,32 +10,19 @@
 //
 //===----------------------------------------------------------------------===//
 
-#include "llvm/ADT/Triple.h"
-#include "swift/AST/AttrKind.h"
+#ifndef SWIFT_SYMBOLGRAPHGEN_SYMBOLGRAPHGEN_H
+#define SWIFT_SYMBOLGRAPHGEN_SYMBOLGRAPHGEN_H
 
-namespace swift {
-
-class ModuleDecl;
+#include "swift/AST/Module.h"
+#include "SymbolGraphOptions.h"
 
+namespace swift {
 namespace symbolgraphgen {
 
-struct SymbolGraphOptions {
-  /// The directory to output the symbol graph JSON files.
-  StringRef OutputDir;
-
-  /// The target of the module.
-  llvm::Triple Target;
-
-  /// Pretty-print the JSON with newlines and indentation.
-  bool PrettyPrint;
-
-  /// The minimum access level that symbols must have in order to be
-  /// included in the graph.
-  AccessLevel MinimumAccessLevel;
-};
-
 /// Emit a Symbol Graph JSON file for a module.
 int emitSymbolGraphForModule(ModuleDecl *M, const SymbolGraphOptions &Options);
 
 } // end namespace symbolgraphgen
 } // end namespace swift
+
+#endif // SWIFT_SYMBOLGRAPHGEN_SYMBOLGRAPHGEN_H

include/swift/SymbolGraphGen/SymbolGraphOptions.h

@@ -0,0 +1,43 @@
+//===--- SymbolGraphOptions.h - Swift SymbolGraph Options -----------------===//
+//
+// This source file is part of the Swift.org open source project
+//
+// Copyright (c) 2014 - 2017 Apple Inc. and the Swift project authors
+// Licensed under Apache License v2.0 with Runtime Library Exception
+//
+// See https://swift.org/LICENSE.txt for license information
+// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
+//
+//===----------------------------------------------------------------------===//
+
+#include "llvm/ADT/Triple.h"
+#include "swift/AST/AttrKind.h"
+
+#ifndef SWIFT_SYMBOLGRAPHGEN_SYMBOLGRAPHOPTIONS_H
+#define SWIFT_SYMBOLGRAPHGEN_SYMBOLGRAPHOPTIONS_H
+
+namespace swift {
+namespace symbolgraphgen {
+
+struct SymbolGraphOptions {
+  /// The directory to output the symbol graph JSON files.
+  StringRef OutputDir;
+
+  /// The target of the module.
+  llvm::Triple Target; 
+  /// Pretty-print the JSON with newlines and indentation.
+  bool PrettyPrint;
+
+  /// The minimum access level that symbols must have in order to be
+  /// included in the graph.
+  AccessLevel MinimumAccessLevel;
+
+  /// Emit members gotten through class inheritance or protocol default
+  /// implementations with compound, "SYNTHESIZED" USRs.
+  bool EmitSynthesizedMembers;
+};
+
+} // end namespace symbolgraphgen
+} // end namespace swift
+
+#endif // SWIFT_SYMBOLGRAPHGEN_SYMBOLGRAPHOPTIONS_H

lib/AST/DocComment.cpp

@@ -381,31 +381,33 @@ void DocComment::addInheritanceNote(swift::markup::MarkupContext &MC,
 }
 
 DocComment *swift::getSingleDocComment(swift::markup::MarkupContext &MC,
-                                       const Decl *D) {
+                                       const Decl *D, bool AllowSerialized) {
   PrettyStackTraceDecl StackTrace("parsing comment for", D);
 
-  auto RC = D->getRawComment();
+  auto RC = D->getRawComment(AllowSerialized);
   if (RC.isEmpty())
     return nullptr;
   return DocComment::create(D, MC, RC);
 }
 
 namespace {
-const ValueDecl *findOverriddenDeclWithDocComment(const ValueDecl *VD) {
+const ValueDecl *findOverriddenDeclWithDocComment(const ValueDecl *VD,
+                                                  bool AllowSerialized = true) {
   // Only applies to class member.
   if (!VD->getDeclContext()->getSelfClassDecl())
     return nullptr;
 
   while (auto *baseDecl = VD->getOverriddenDecl()) {
-    if (!baseDecl->getRawComment().isEmpty())
+    if (!baseDecl->getRawComment(AllowSerialized).isEmpty())
       return baseDecl;
     VD = baseDecl;
   }
 
   return nullptr;
 }
 
-const ValueDecl *findDefaultProvidedDeclWithDocComment(const ValueDecl *VD) {
+const ValueDecl *findDefaultProvidedDeclWithDocComment(const ValueDecl *VD,
+                                                       bool AllowSerialized = false) {
   auto protocol = VD->getDeclContext()->getExtendedProtocolDecl();
   // Only applies to protocol extension member.
   if (!protocol)
@@ -422,7 +424,7 @@ const ValueDecl *findDefaultProvidedDeclWithDocComment(const ValueDecl *VD) {
   for (auto *member : members) {
     if (!isa<ProtocolDecl>(member->getDeclContext()) ||
         !member->isProtocolRequirement() ||
-        member->getRawComment().isEmpty())
+        member->getRawComment(AllowSerialized).isEmpty())
       continue;
     if (requirement)
       // Found two or more decls with doc-comment.
@@ -433,7 +435,8 @@ const ValueDecl *findDefaultProvidedDeclWithDocComment(const ValueDecl *VD) {
   return requirement;
 }
 
-const ValueDecl *findRequirementDeclWithDocComment(const ValueDecl *VD) {
+const ValueDecl *findRequirementDeclWithDocComment(const ValueDecl *VD,
+                                                   bool AllowSerialized = false) {
   std::queue<const ValueDecl *> requirements;
   while (true) {
     for (auto *req : VD->getSatisfiedProtocolRequirements()) {
@@ -450,36 +453,38 @@ const ValueDecl *findRequirementDeclWithDocComment(const ValueDecl *VD) {
 }
 } // namespace
 
-const Decl *swift::getDocCommentProvidingDecl(const Decl *D) {
+const Decl *swift::getDocCommentProvidingDecl(const Decl *D,
+                                              bool AllowSerialized) {
   if (!D->canHaveComment())
     return nullptr;
 
-  if (!D->getRawComment().isEmpty())
+  if (!D->getRawComment(AllowSerialized).isEmpty())
     return D;
 
   auto *VD = dyn_cast<ValueDecl>(D);
   if (!VD)
     return nullptr;
 
-  if (auto *overriden = findOverriddenDeclWithDocComment(VD))
+  if (auto *overriden = findOverriddenDeclWithDocComment(VD, AllowSerialized))
     return overriden;
 
-  if (auto *requirement = findDefaultProvidedDeclWithDocComment(VD))
+  if (auto *requirement = findDefaultProvidedDeclWithDocComment(VD, AllowSerialized))
     return requirement;
 
-  if (auto *requirement = findRequirementDeclWithDocComment(VD))
+  if (auto *requirement = findRequirementDeclWithDocComment(VD, AllowSerialized))
     return requirement;
 
   return nullptr;
 }
 
 DocComment *
-swift::getCascadingDocComment(swift::markup::MarkupContext &MC, const Decl *D) {
-  auto *docD = getDocCommentProvidingDecl(D);
+swift::getCascadingDocComment(swift::markup::MarkupContext &MC, const Decl *D,
+                              bool AllowSerialized) {
+  auto *docD = getDocCommentProvidingDecl(D, AllowSerialized);
   if (!docD)
     return nullptr;
 
-  auto *doc = getSingleDocComment(MC, docD);
+  auto *doc = getSingleDocComment(MC, docD, AllowSerialized);
   assert(doc && "getDocCommentProvidingDecl() returned decl with no comment");
 
   // If the doc-comment is inherited from other decl, add a note about it.

lib/AST/USRGeneration.cpp

@@ -17,6 +17,7 @@
 #include "swift/AST/ASTMangler.h"
 #include "swift/AST/SwiftNameTranslation.h"
 #include "swift/AST/TypeCheckRequests.h"
+#include "swift/AST/USRGeneration.h"
 #include "llvm/ADT/SmallString.h"
 #include "llvm/ADT/StringRef.h"
 #include "llvm/Support/raw_ostream.h"

lib/SymbolGraphGen/DeclarationFragmentPrinter.cpp

@@ -10,6 +10,7 @@
 //
 //===----------------------------------------------------------------------===//
 
+#include "swift/AST/USRGeneration.h"
 #include "DeclarationFragmentPrinter.h"
 #include "SymbolGraphASTWalker.h"
 
@@ -55,6 +56,8 @@ void DeclarationFragmentPrinter::closeFragment() {
     return;
   }
 
+  ++NumFragments;
+
   if (!Spelling.empty()) {
     OS.object([&](){
       OS.attribute("kind", getKindSpelling(Kind));
@@ -128,7 +131,8 @@ void DeclarationFragmentPrinter::printTypeRef(Type T, const TypeDecl *RefTo,
     PrintNameContext NameContext) {
   openFragment(FragmentKind::TypeIdentifier);
   printText(Name.str());
-  USR = Graph.getUSR(RefTo);
+  llvm::raw_svector_ostream OS(USR);
+  ide::printDeclUSR(RefTo, OS);
   closeFragment();
 }
 

lib/SymbolGraphGen/DeclarationFragmentPrinter.h

@@ -55,8 +55,6 @@ class DeclarationFragmentPrinter : public ASTPrinter {
     Text,
   };
 
-  SymbolGraph &Graph;
-
   /// The output stream to print fragment objects to.
   llvm::json::OStream &OS;
 
@@ -76,13 +74,14 @@ class DeclarationFragmentPrinter : public ASTPrinter {
   /// Close the current fragment if there is one, and commit it for display.
   void closeFragment();
 
+  unsigned NumFragments;
+
 public:
-  DeclarationFragmentPrinter(SymbolGraph &Graph,
-                             llvm::json::OStream &OS,
+  DeclarationFragmentPrinter(llvm::json::OStream &OS,
                              Optional<StringRef> Key = None)
-    : Graph(Graph),
-      OS(OS),
-      Kind(FragmentKind::None) {
+    : OS(OS),
+      Kind(FragmentKind::None),
+      NumFragments(0) {
     if (Key) {
       OS.attributeBegin(*Key);
       OS.arrayBegin();
@@ -114,6 +113,7 @@ class DeclarationFragmentPrinter : public ASTPrinter {
     closeFragment();
     OS.arrayEnd();
     OS.attributeEnd();
+    assert(NumFragments);
   }
 };
 

lib/SymbolGraphGen/Edge.cpp

@@ -12,6 +12,7 @@
 
 #include "swift/AST/Module.h"
 #include "Edge.h"
+#include "Symbol.h"
 #include "SymbolGraphASTWalker.h"
 
 using namespace swift;
@@ -20,22 +21,26 @@ using namespace symbolgraphgen;
 void Edge::serialize(llvm::json::OStream &OS) const {
   OS.object([&](){
     OS.attribute("kind", Kind.Name);
-    OS.attribute("source", Graph->getUSR(Source));
-    OS.attribute("target", Graph->getUSR(Target));
+    if (Kind == RelationshipKind::DefaultImplementationOf() && Source.getSynthesizedBaseTypeDecl()) {
+      abort();
+    }
+    SmallString<256> SourceUSR, TargetUSR;
+
+    Source.getUSR(SourceUSR);
+    OS.attribute("source", SourceUSR.str());
+
+    Target.getUSR(TargetUSR);
+    OS.attribute("target", TargetUSR.str());
 
     // In case a dependent module isn't available, serialize a fallback name.
-    auto TargetModuleName = Target->getModuleContext()->getName().str();
+    auto TargetModuleName = Target.getSymbolDecl()
+        ->getModuleContext()->getName().str();
 
     if (TargetModuleName != Graph->M.getName().str()) {
-      SmallVector<SmallString<32>, 8> TargetPathComponents;
-      Graph->getPathComponents(Target, TargetPathComponents);
-
       SmallString<128> Scratch(TargetModuleName);
-      for (auto it = TargetPathComponents.begin();
-           it != TargetPathComponents.end(); ++it) {
-        Scratch.push_back('.');
-        Scratch.append(*it);
-      }
+      llvm::raw_svector_ostream PathOS(Scratch);
+      PathOS << '.';
+      Target.printPath(PathOS);
       OS.attribute("targetFallback", Scratch.str());
     }
   });