Merge pull request #62878 from DougGregor/serialized-diag-pretty-printed-buffers

Author: DougGregor

include/swift/Basic/SourceManager.h

@@ -36,11 +36,10 @@ class GeneratedSourceInfo {
 
     /// A new function body that is replacing an existing function body.
     ReplacedFunctionBody,
-  } kind;
 
-  /// The buffer ID for the enclosing buffer, in which originalSourceRange
-  /// resides.
-  unsigned originalBufferID;
+    /// Pretty-printed declarations that have no source location.
+    PrettyPrinted,
+  } kind;
 
   /// The source range in the enclosing buffer where this source was generated.
   ///

lib/AST/DiagnosticEngine.cpp

@@ -1142,6 +1142,7 @@ DiagnosticEngine::diagnosticInfoForDiagnostic(const Diagnostic &diagnostic) {
         SmallVector<std::pair<const Decl *, uint64_t>, 8> entries;
         llvm::SmallString<128> buffer;
         llvm::SmallString<128> bufferName;
+        const Decl *ppDecl = decl;
         {
           // The access level of the buffer we want to print. Declarations below
           // this access level will be omitted from the buffer; declarations
@@ -1152,7 +1153,6 @@ DiagnosticEngine::diagnosticInfoForDiagnostic(const Diagnostic &diagnostic) {
 
           // Figure out which declaration to print. It's the top-most
           // declaration (not a module).
-          const Decl *ppDecl = decl;
           auto dc = decl->getDeclContext();
 
           // FIXME: Horrible, horrible hackaround. We're not getting a
@@ -1237,6 +1237,20 @@ DiagnosticEngine::diagnosticInfoForDiagnostic(const Diagnostic &diagnostic) {
         auto bufferID = SourceMgr.addMemBufferCopy(buffer, bufferName);
         auto memBufferStartLoc = SourceMgr.getLocForBufferStart(bufferID);
 
+        SourceMgr.setGeneratedSourceInfo(
+            bufferID,
+            GeneratedSourceInfo{
+              GeneratedSourceInfo::PrettyPrinted,
+              SourceRange(),
+              SourceRange(
+                  memBufferStartLoc,
+                  memBufferStartLoc.getAdvancedLoc(buffer.size())
+              ),
+              ASTNode(const_cast<Decl *>(ppDecl)).getOpaqueValue(),
+              nullptr
+            }
+        );
+
         // Go through all of the pretty-printed entries and record their
         // locations.
         for (auto entry : entries) {
@@ -1318,12 +1332,18 @@ std::vector<Diagnostic> DiagnosticEngine::getGeneratedSourceBufferNotes(
       break;
     }
 
+    case GeneratedSourceInfo::PrettyPrinted:
+      break;
+
     case GeneratedSourceInfo::ReplacedFunctionBody:
       return childNotes;
     }
 
     // Walk up the stack.
     currentLoc = expansionNode.getStartLoc();
+    if (currentLoc.isInvalid())
+      return childNotes;
+
     currentBufferID = SourceMgr.findBufferContainingLoc(currentLoc);
   } while (true);
 }

lib/Basic/SourceLoc.cpp

@@ -260,6 +260,7 @@ void SourceManager::setGeneratedSourceInfo(
 
   switch (info.kind) {
   case GeneratedSourceInfo::MacroExpansion:
+  case GeneratedSourceInfo::PrettyPrinted:
     break;
 
   case GeneratedSourceInfo::ReplacedFunctionBody:

lib/IDETool/CompileInstance.cpp

@@ -193,7 +193,6 @@ void retypeCheckFunctionBody(AbstractFunctionDecl *func,
       sliceBufferID,
       GeneratedSourceInfo{
         GeneratedSourceInfo::ReplacedFunctionBody,
-        *func->getParentSourceFile()->getBufferID(),
         func->getOriginalBodySourceRange(),
         newRange,
         func,

lib/IDETool/IDEInspectionInstance.cpp

@@ -346,7 +346,6 @@ bool IDEInspectionInstance::performCachedOperationIfPossible(
         newBufferID,
         GeneratedSourceInfo{
           GeneratedSourceInfo::ReplacedFunctionBody,
-          *AFD->getParentSourceFile()->getBufferID(),
           AFD->getOriginalBodySourceRange(),
           newBodyRange,
           AFD,

lib/Sema/TypeCheckMacros.cpp

@@ -448,7 +448,6 @@ Expr *swift::expandMacroExpr(
   auto macroBufferRange = sourceMgr.getRangeForBuffer(macroBufferID);
   GeneratedSourceInfo sourceInfo{
     GeneratedSourceInfo::MacroExpansion,
-    *sourceFile->getBufferID(),
     expr->getSourceRange(),
     SourceRange(macroBufferRange.getStart(), macroBufferRange.getEnd()),
     ASTNode(expr).getOpaqueValue(),

test/ImportResolution/import-specific-fixits.swift

@@ -55,6 +55,9 @@ import struct ambiguous.funcOrVar // expected-error{{ambiguous name 'funcOrVar'
 // CHECK-NEXT: Number FIXITs = 0
 // CHECK-NEXT: note: found this candidate
 // CHECK-NEXT: Number FIXITs = 0
+// CHECK-NEXT: CONTENTS OF FILE ambiguous_right.funcOrVar:
+// CHECK: public var funcOrVar: Int
+// CHECK: END CONTENTS OF FILE
 // CHECK-NEXT: note: found this candidate
 
 import func ambiguous.someVar // expected-error{{ambiguous name 'someVar' in module 'ambiguous'}}

test/Misc/serialized-diagnostics-prettyprint.swift

@@ -0,0 +1,14 @@
+// RUN: rm -f %t.*
+
+// Test swift executable
+// RUN: %target-swift-frontend -typecheck -serialize-diagnostics-path %t.dia %s -verify
+// RUN: c-index-test -read-diagnostics %t.dia > %t.deserialized_diagnostics.txt 2>&1
+// RUN: %FileCheck --input-file=%t.deserialized_diagnostics.txt %s
+
+var x = String.init // expected-error{{ambiguous use of 'init'}}
+// CHECK: {{.*[/\\]}}serialized-diagnostics-prettyprint.swift:[[@LINE-1]]:9: error: ambiguous use of 'init'
+
+// CHECK: Swift.String:2:23: note: found this candidate
+// CHECK: CONTENTS OF FILE Swift.String:
+// CHECK: extension String {
+// CHECK:    public init(_ content: Substring.UnicodeScalarView)