[SourceKit] Update requests to handle locations within generated buffers

Update requests to handle being passed a separate `key.primary_file`
which specifies the file to use for building the AST. `key.sourcefile`
is then the file to find in `SourceManager`, which could be a generated
buffer.

Resolves rdar://106863186.

Author: bnbarham

test/SourceKit/Macros/macro_basic.swift

@@ -181,6 +181,25 @@ macro anonymousTypes(_: () -> String) = #externalMacro(module: "MacroDefinition"
 // ATTACHED_EXPAND-NEXT: source.edit.kind.active:
 // ATTACHED_EXPAND-NEXT: 21:1-21:15 ""
 
+//##-- Cursor info on the attribute expanded by @myTypeWrapper
+// RUN: %sourcekitd-test -req=cursor -cursor-action -req-opts=retrieve_symbol_graph=1 -offset=2 @__swiftmacro_9MacroUser1SV13myTypeWrapperfMA_.swift -primary-file %s -- ${COMPILER_ARGS[@]} | %FileCheck -check-prefix=NESTED_ATTACHED_CURSOR %s
+// NESTED_ATTACHED_CURSOR: source.lang.swift.ref.macro
+// NESTED_ATTACHED_CURSOR-SAME: macro_basic.swift:10:27-10:43
+// NESTED_ATTACHED_CURSOR-LABEL: SYMBOL GRAPH BEGIN
+// NESTED_ATTACHED_CURSOR: "identifier": {
+// NESTED_ATTACHED_CURSOR-NEXT:   "interfaceLanguage": "swift",
+// NESTED_ATTACHED_CURSOR-NEXT:   "precise": "s:9MacroUser16accessViaStorageyycfm"
+// NESTED_ATTACHED_CURSOR-NEXT: },
+// NESTED_ATTACHED_CURSOR-NEXT: "kind": {
+// NESTED_ATTACHED_CURSOR-NEXT:   "displayName": "Macro",
+// NESTED_ATTACHED_CURSOR-NEXT:   "identifier": "swift.macro"
+// NESTED_ATTACHED_CURSOR-NEXT: },
+// NESTED_ATTACHED_CURSOR: SYMBOL GRAPH END
+// NESTED_ATTACHED_CURSOR-LABEL: ACTIONS BEGIN
+// NESTED_ATTACHED_CURSOR: source.refactoring.kind.expand.macro
+// NESTED_ATTACHED_CURSOR-NEXT: Expand Macro
+// NESTED_ATTACHED_CURSOR:ACTIONS END
+
 //##-- Refactoring on the attribute expanded by @myTypeWrapper
 // RUN: %sourcekitd-test -req=refactoring.expand.macro -pos=1:2 @__swiftmacro_9MacroUser1SV13myTypeWrapperfMA_.swift -primary-file %s -- ${COMPILER_ARGS[@]} | %FileCheck -check-prefix=NESTED_ATTACHED_EXPAND %s
 // NESTED_ATTACHED_EXPAND: source.edit.kind.active:

tools/SourceKit/include/SourceKit/Core/LangSupport.h

@@ -640,9 +640,9 @@ enum class SemanticRefactoringKind {
 
 struct SemanticRefactoringInfo {
   SemanticRefactoringKind Kind;
-  // The name of the source file to start the refactoring in. Empty if it is
-  // the primary file (in which case the primary file from the AST is used).
-  // This must match the buffer identifier stored in the source manager.
+  // The name of the source file to start the refactoring in. This must either
+  // be empty (in which case the primary file for the AST is used), or exactly
+  // match the buffer identifier stored in the source manager.
   StringRef SourceFile;
   unsigned Line;
   unsigned Column;
@@ -982,9 +982,10 @@ class LangSupport {
                                        EditorConsumer &Consumer) = 0;
 
   virtual void getCursorInfo(
-      StringRef Filename, unsigned Offset, unsigned Length, bool Actionables,
-      bool SymbolGraph, bool CancelOnSubsequentRequest,
-      ArrayRef<const char *> Args, Optional<VFSOptions> vfsOptions,
+      StringRef PrimaryFile, StringRef InputFile, unsigned Offset,
+      unsigned Length, bool Actionables, bool SymbolGraph,
+      bool CancelOnSubsequentRequest, ArrayRef<const char *> Args,
+      Optional<VFSOptions> vfsOptions,
       SourceKitCancellationToken CancellationToken,
       std::function<void(const RequestResult<CursorInfoData> &)> Receiver) = 0;
 
@@ -1003,25 +1004,27 @@ class LangSupport {
                   Receiver) = 0;
 
   virtual void getRangeInfo(
-      StringRef Filename, unsigned Offset, unsigned Length,
-      bool CancelOnSubsequentRequest, ArrayRef<const char *> Args,
-      SourceKitCancellationToken CancellationToken,
+      StringRef PrimaryFile, StringRef InputFile, unsigned Offset,
+      unsigned Length, bool CancelOnSubsequentRequest,
+      ArrayRef<const char *> Args, SourceKitCancellationToken CancellationToken,
       std::function<void(const RequestResult<RangeInfo> &)> Receiver) = 0;
 
   virtual void getCursorInfoFromUSR(
-      StringRef Filename, StringRef USR, bool CancelOnSubsequentRequest,
-      ArrayRef<const char *> Args, Optional<VFSOptions> vfsOptions,
+      StringRef PrimaryFile, StringRef InputFile, StringRef USR,
+      bool CancelOnSubsequentRequest, ArrayRef<const char *> Args,
+      Optional<VFSOptions> vfsOptions,
       SourceKitCancellationToken CancellationToken,
       std::function<void(const RequestResult<CursorInfoData> &)> Receiver) = 0;
 
   virtual void findRelatedIdentifiersInFile(
-      StringRef Filename, unsigned Offset, bool CancelOnSubsequentRequest,
-      ArrayRef<const char *> Args, SourceKitCancellationToken CancellationToken,
+      StringRef PrimaryFile, StringRef InputFile, unsigned Offset,
+      bool CancelOnSubsequentRequest, ArrayRef<const char *> Args,
+      SourceKitCancellationToken CancellationToken,
       std::function<void(const RequestResult<RelatedIdentsInfo> &)>
           Receiver) = 0;
 
   virtual void findActiveRegionsInFile(
-      StringRef Filename, ArrayRef<const char *> Args,
+      StringRef PrimaryFile, StringRef InputFile, ArrayRef<const char *> Args,
       SourceKitCancellationToken CancellationToken,
       std::function<void(const RequestResult<ActiveRegionsInfo> &)>
           Receiver) = 0;
@@ -1059,7 +1062,7 @@ class LangSupport {
                                    CategorizedEditsReceiver Receiver) = 0;
 
   virtual void collectExpressionTypes(
-      StringRef FileName, ArrayRef<const char *> Args,
+      StringRef PrimaryFile, StringRef InputFile, ArrayRef<const char *> Args,
       ArrayRef<const char *> ExpectedProtocols, bool FullyQualified,
       bool CanonicalType, SourceKitCancellationToken CancellationToken,
       std::function<void(const RequestResult<ExpressionTypesInFile> &)>
@@ -1069,7 +1072,7 @@ class LangSupport {
   /// the source file. If `Offset` or `Length` are empty, variable types for
   /// the entire document are collected.
   virtual void collectVariableTypes(
-      StringRef FileName, ArrayRef<const char *> Args,
+      StringRef PrimaryFile, StringRef InputFile, ArrayRef<const char *> Args,
       Optional<unsigned> Offset, Optional<unsigned> Length, bool FullyQualified,
       SourceKitCancellationToken CancellationToken,
       std::function<void(const RequestResult<VariableTypesInFile> &)>

tools/SourceKit/lib/SwiftLang/SwiftLangSupport.h

@@ -632,9 +632,9 @@ class SwiftLangSupport : public LangSupport {
   void editorExpandPlaceholder(StringRef Name, unsigned Offset, unsigned Length,
                                EditorConsumer &Consumer) override;
 
-  void getCursorInfo(StringRef Filename, unsigned Offset, unsigned Length,
-                     bool Actionables, bool SymbolGraph,
-                     bool CancelOnSubsequentRequest,
+  void getCursorInfo(StringRef PrimaryFile, StringRef InputFile,
+                     unsigned Offset, unsigned Length, bool Actionables,
+                     bool SymbolGraph, bool CancelOnSubsequentRequest,
                      ArrayRef<const char *> Args,
                      Optional<VFSOptions> vfsOptions,
                      SourceKitCancellationToken CancellationToken,
@@ -655,26 +655,28 @@ class SwiftLangSupport : public LangSupport {
       override;
 
   void getRangeInfo(
-      StringRef Filename, unsigned Offset, unsigned Length,
-      bool CancelOnSubsequentRequest, ArrayRef<const char *> Args,
-      SourceKitCancellationToken CancellationToken,
+      StringRef PrimaryFile, StringRef InputFile, unsigned Offset,
+      unsigned Length, bool CancelOnSubsequentRequest,
+      ArrayRef<const char *> Args, SourceKitCancellationToken CancellationToken,
       std::function<void(const RequestResult<RangeInfo> &)> Receiver) override;
 
   void getCursorInfoFromUSR(
-      StringRef Filename, StringRef USR, bool CancelOnSubsequentRequest,
-      ArrayRef<const char *> Args, Optional<VFSOptions> vfsOptions,
+      StringRef PrimaryFile, StringRef InputFile, StringRef USR,
+      bool CancelOnSubsequentRequest, ArrayRef<const char *> Args,
+      Optional<VFSOptions> vfsOptions,
       SourceKitCancellationToken CancellationToken,
       std::function<void(const RequestResult<CursorInfoData> &)> Receiver)
       override;
 
   void findRelatedIdentifiersInFile(
-      StringRef Filename, unsigned Offset, bool CancelOnSubsequentRequest,
-      ArrayRef<const char *> Args, SourceKitCancellationToken CancellationToken,
+      StringRef PrimaryFile, StringRef InputFile, unsigned Offset,
+      bool CancelOnSubsequentRequest, ArrayRef<const char *> Args,
+      SourceKitCancellationToken CancellationToken,
       std::function<void(const RequestResult<RelatedIdentsInfo> &)> Receiver)
       override;
 
   void findActiveRegionsInFile(
-      StringRef Filename, ArrayRef<const char *> Args,
+      StringRef PrimaryFile, StringRef InputFile, ArrayRef<const char *> Args,
       SourceKitCancellationToken CancellationToken,
       std::function<void(const RequestResult<ActiveRegionsInfo> &)> Receiver)
       override;
@@ -695,14 +697,14 @@ class SwiftLangSupport : public LangSupport {
                              CategorizedRenameRangesReceiver Receiver) override;
 
   void collectExpressionTypes(
-      StringRef FileName, ArrayRef<const char *> Args,
+      StringRef PrimaryFile, StringRef InputFile, ArrayRef<const char *> Args,
       ArrayRef<const char *> ExpectedProtocols, bool FullyQualified,
       bool CanonicalType, SourceKitCancellationToken CancellationToken,
       std::function<void(const RequestResult<ExpressionTypesInFile> &)>
           Receiver) override;
 
   void collectVariableTypes(
-      StringRef FileName, ArrayRef<const char *> Args,
+      StringRef PrimaryFile, StringRef InputFile, ArrayRef<const char *> Args,
       Optional<unsigned> Offset, Optional<unsigned> Length, bool FullyQualified,
       SourceKitCancellationToken CancellationToken,
       std::function<void(const RequestResult<VariableTypesInFile> &)> Receiver)