[SourceKit] Allow references to non-editable base names to be returned by the related identifiers request

While we don't want to return non-editable base names for Edit-All-In-Scope, we do want to return them if the related identifiers response is used as the input for find-syntactic-rename-ranges.

Author: ahoppen

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

@@ -1162,10 +1162,19 @@ class LangSupport {
       SourceKitCancellationToken CancellationToken,
       std::function<void(const RequestResult<CursorInfoData> &)> Receiver) = 0;
 
+  /// - Parameters:
+  ///   - IncludeNonEditableBaseNames: If `true` also return results if the
+  ///     referenced declaration is an initializer or subscript. This is
+  ///     intended if the related identifiers response is used for rename, which
+  ///     allows renaming parameter labels of these declaration.
+  ///     If the function's base name should be highlighted, this should be
+  ///     `false` because e.g. highlighting a subscript with
+  ///     `IncludeNonEditableBaseNames = true` would return the locations of all
+  ///     `[` that call that subscript.
   virtual void findRelatedIdentifiersInFile(
       StringRef PrimaryFilePath, StringRef InputBufferName, unsigned Offset,
-      bool CancelOnSubsequentRequest, ArrayRef<const char *> Args,
-      SourceKitCancellationToken CancellationToken,
+      bool IncludeNonEditableBaseNames, bool CancelOnSubsequentRequest,
+      ArrayRef<const char *> Args, SourceKitCancellationToken CancellationToken,
       std::function<void(const RequestResult<RelatedIdentsResult> &)>
           Receiver) = 0;
 

tools/SourceKit/lib/SwiftLang/SwiftLangSupport.h

@@ -682,8 +682,8 @@ class SwiftLangSupport : public LangSupport {
 
   void findRelatedIdentifiersInFile(
       StringRef PrimaryFilePath, StringRef InputBufferName, unsigned Offset,
-      bool CancelOnSubsequentRequest, ArrayRef<const char *> Args,
-      SourceKitCancellationToken CancellationToken,
+      bool IncludeNonEditableBaseNames, bool CancelOnSubsequentRequest,
+      ArrayRef<const char *> Args, SourceKitCancellationToken CancellationToken,
       std::function<void(const RequestResult<RelatedIdentsResult> &)> Receiver)
       override;
 

tools/SourceKit/lib/SwiftLang/SwiftSourceDocInfo.cpp

@@ -2491,8 +2491,8 @@ SwiftLangSupport::findUSRRange(StringRef DocumentName, StringRef USR) {
 
 void SwiftLangSupport::findRelatedIdentifiersInFile(
     StringRef PrimaryFilePath, StringRef InputBufferName, unsigned Offset,
-    bool CancelOnSubsequentRequest, ArrayRef<const char *> Args,
-    SourceKitCancellationToken CancellationToken,
+    bool IncludeNonEditableBaseNames, bool CancelOnSubsequentRequest,
+    ArrayRef<const char *> Args, SourceKitCancellationToken CancellationToken,
     std::function<void(const RequestResult<RelatedIdentsResult> &)> Receiver) {
 
   std::string Error;
@@ -2507,6 +2507,7 @@ void SwiftLangSupport::findRelatedIdentifiersInFile(
   class RelatedIdConsumer : public SwiftASTConsumer {
     std::string InputFile;
     unsigned Offset;
+    bool IncludeNonEditableBaseNames;
     std::function<void(const RequestResult<RelatedIdentsResult> &)> Receiver;
     SwiftInvocationRef Invok;
 
@@ -2538,7 +2539,7 @@ void SwiftLangSupport::findRelatedIdentifiersInFile(
         return RelatedIdentsResult::empty(); // This was a module reference.
 
       // Only accept pointing to an identifier.
-      if (!ValueRefCursorInfo->isRef() &&
+      if (!IncludeNonEditableBaseNames && !ValueRefCursorInfo->isRef() &&
           (isa<ConstructorDecl>(VD) || isa<DestructorDecl>(VD) ||
            isa<SubscriptDecl>(VD)))
         return RelatedIdentsResult::empty();
@@ -2588,11 +2589,12 @@ void SwiftLangSupport::findRelatedIdentifiersInFile(
 
   public:
     RelatedIdConsumer(
-        StringRef InputFile, unsigned Offset,
+        StringRef InputFile, unsigned Offset, bool IncludeNonEditableBaseNames,
         std::function<void(const RequestResult<RelatedIdentsResult> &)>
             Receiver,
         SwiftInvocationRef Invok)
         : InputFile(InputFile.str()), Offset(Offset),
+          IncludeNonEditableBaseNames(IncludeNonEditableBaseNames),
           Receiver(std::move(Receiver)), Invok(Invok) {}
 
     void handlePrimaryAST(ASTUnitRef AstUnit) override {
@@ -2637,8 +2639,8 @@ void SwiftLangSupport::findRelatedIdentifiersInFile(
     }
   };
 
-  auto Consumer = std::make_shared<RelatedIdConsumer>(InputBufferName, Offset,
-                                                      Receiver, Invok);
+  auto Consumer = std::make_shared<RelatedIdConsumer>(
+      InputBufferName, Offset, IncludeNonEditableBaseNames, Receiver, Invok);
   /// FIXME: When request cancellation is implemented and Xcode adopts it,
   /// don't use 'OncePerASTToken'.
   static const char OncePerASTToken = 0;

tools/SourceKit/tools/sourcekitd/lib/Service/Requests.cpp

@@ -212,6 +212,7 @@ static void reportNameInfo(const RequestResult<NameTranslatingInfo> &Result, Res
 
 static void findRelatedIdents(StringRef PrimaryFilePath,
                               StringRef InputBufferName, int64_t Offset,
+                              bool IncludeNonEditableBaseNames,
                               bool CancelOnSubsequentRequest,
                               ArrayRef<const char *> Args,
                               SourceKitCancellationToken CancellationToken,
@@ -1787,14 +1788,18 @@ handleRequestRelatedIdents(const RequestDict &Req,
     if (Req.getInt64(KeyOffset, Offset, /*isOptional=*/false))
       return Rec(createErrorRequestInvalid("missing 'key.offset'"));
 
+    int64_t IncludeNonEditableBaseNames = 0;
+    Req.getInt64(KeyIncludeNonEditableBaseNames, IncludeNonEditableBaseNames,
+                 /*isOptional=*/true);
+
     // For backwards compatibility, the default is 1.
     int64_t CancelOnSubsequentRequest = 1;
     Req.getInt64(KeyCancelOnSubsequentRequest, CancelOnSubsequentRequest,
                  /*isOptional=*/true);
 
-    return findRelatedIdents(*PrimaryFilePath, InputBufferName, Offset,
-                             CancelOnSubsequentRequest, Args, CancellationToken,
-                             Rec);
+    return findRelatedIdents(
+        *PrimaryFilePath, InputBufferName, Offset, IncludeNonEditableBaseNames,
+        CancelOnSubsequentRequest, Args, CancellationToken, Rec);
   });
 }
 
@@ -2873,14 +2878,15 @@ static sourcekitd_uid_t renameLocUsageUID(swift::ide::RenameLocUsage Usage) {
 
 static void findRelatedIdents(StringRef PrimaryFilePath,
                               StringRef InputBufferName, int64_t Offset,
+                              bool IncludeNonEditableBaseNames,
                               bool CancelOnSubsequentRequest,
                               ArrayRef<const char *> Args,
                               SourceKitCancellationToken CancellationToken,
                               ResponseReceiver Rec) {
   LangSupport &Lang = getGlobalContext().getSwiftLangSupport();
   Lang.findRelatedIdentifiersInFile(
-      PrimaryFilePath, InputBufferName, Offset, CancelOnSubsequentRequest, Args,
-      CancellationToken,
+      PrimaryFilePath, InputBufferName, Offset, IncludeNonEditableBaseNames,
+      CancelOnSubsequentRequest, Args, CancellationToken,
       [Rec](const RequestResult<RelatedIdentsResult> &Result) {
         if (Result.isCancelled())
           return Rec(createErrorRequestCancelled());

utils/gyb_sourcekit_support/UIDs.py

@@ -146,6 +146,7 @@ def __init__(self, internal_name, external_name):
     KEY('Simplified', 'key.simplified'),
     KEY('RangeContent', 'key.rangecontent'),
     KEY('CancelOnSubsequentRequest', 'key.cancel_on_subsequent_request'),
+    KEY('IncludeNonEditableBaseNames', 'key.include_non_editable_base_names'),
     KEY('RenameLocations', 'key.renamelocations'),
     KEY('Locations', 'key.locations'),
     KEY('NameType', 'key.nametype'),