[clangd] Filter out implicit references while renaming

[kbobyrev]

Summary

This patch is based on D72746 and prevents non-spelled references from
being renamed which would cause incorrect behavior otherwise.

[hokein]

looks good, thanks.

clang-tools-extra/clangd/refactor/Rename.cpp

309

nit: I'd use if (!static_cast<int>(R.Kind & RefKind::Spelled)).

clang-tools-extra/clangd/unittests/RenameTests.cpp

913

nit: "only rename spelled references"

[kbobyrev]

Address review comments.

[hokein]

In D74112#1861285, @kbobyrev wrote:

Address review comments.

looks like the code you submitted is the old version, not the one you addressed comments.

clang-tools-extra/clangd/refactor/Rename.cpp

findOccurrencesOutsideFile(const NamedDecl &RenameDecl,
 
   // Absolute file path => rename occurrences in that file.
   llvm::StringMap<std::vector<Range>> AffectedFiles;
   // FIXME: Make the limit customizable.
   static constexpr size_t MaxLimitFiles = 50;
   bool HasMore = Index.refs(RQuest, [&](const Ref &R) {
     if (AffectedFiles.size() > MaxLimitFiles)
       return;
+    if ((R.Kind & RefKind::Spelled) == RefKind::Unknown)
+      return;
     if (auto RefFilePath = filePath(R.Location, /*HintFilePath=*/MainFile)) {
       if (*RefFilePath != MainFile)
         AffectedFiles[*RefFilePath].push_back(toRange(R.Location));
     }
   });
 
   if (AffectedFiles.size() > MaxLimitFiles)
     return llvm::make_error<llvm::StringError>(

clang-tools-extra/clangd/unittests/RenameTests.cpp

 using testing::Pair;
 using testing::IsEmpty;
 using testing::UnorderedElementsAre;
 using testing::UnorderedElementsAreArray;
 
 // Convert a Range to a Ref.
 Ref refWithRange(const clangd::Range &Range, const std::string &URI) {
   Ref Result;
-  Result.Kind = RefKind::Reference;
+  Result.Kind = RefKind::Reference | RefKind::Spelled;
   Result.Location.Start.setLine(Range.start.line);
   Result.Location.Start.setColumn(Range.start.character);
   Result.Location.End.setLine(Range.end.line);
   Result.Location.End.setColumn(Range.end.character);
   Result.Location.FileURI = URI.c_str();
   return Result;
 }
 
llvm::StringRef Tests[] = {
 
       // template class in template argument list.
       R"cpp(
         template<typename T>
         class [[Fo^o]] {};
         template <template<typename> class Z> struct Bar { };
         template <> struct Bar<[[Foo]]> {};
       )cpp",
+
+      {
+          // Implicit references in macro expansions.
+          R"cpp(
+        class [[Fo^o]] {};
+        #define FooFoo Foo
+        #define FOO Foo
+      )cpp",
+          R"cpp(
+        #include "foo.h"
+        void bar() {
+          [[Foo]] x;
+          FOO y;
+          FooFoo z;
+        }
+      )cpp",
+      },
   };
   for (llvm::StringRef T : Tests) {
     SCOPED_TRACE(T);
     Annotations Code(T);
     auto TU = TestTU::withCode(Code.code());
     TU.ExtraArgs.push_back("-fno-delayed-template-parsing");
     auto AST = TU.build();
     llvm::StringRef NewName = "abcde";
llvm::StringRef FooCC;
           R"cpp(
         #include "foo.h"
         Kind ff() {
           return Kind::[[ABC]];
         }
       )cpp",
       },
   };
 
   for (const auto& T : Cases) {
     SCOPED_TRACE(T.FooH);
     Annotations FooH(T.FooH);
     Annotations FooCC(T.FooCC);
     std::string FooHPath = testPath("foo.h");
     std::string FooCCPath = testPath("foo.cc");
 
     MockFSProvider FS;