refactor: Skip occurrences based on file check (#348)

Author: varungandhi-src

indexer/AstConsumer.cc

@@ -22,16 +22,16 @@ class IndexerAstVisitor : public clang::RecursiveASTVisitor<IndexerAstVisitor> {
   using Base = RecursiveASTVisitor;
 
   const FileMetadataMap &fileMetadataMap;
-  FileIdsToBeIndexedSet toBeIndexed;
+  const FileIdsToBeIndexedSet &toBeIndexed;
   bool deterministic;
 
   TuIndexer &tuIndexer;
 
 public:
   IndexerAstVisitor(const FileMetadataMap &fileMetadataMap,
-                    FileIdsToBeIndexedSet &&toBeIndexed, bool deterministic,
-                    TuIndexer &tuIndexer)
-      : fileMetadataMap(fileMetadataMap), toBeIndexed(std::move(toBeIndexed)),
+                    const FileIdsToBeIndexedSet &toBeIndexed,
+                    bool deterministic, TuIndexer &tuIndexer)
+      : fileMetadataMap(fileMetadataMap), toBeIndexed(toBeIndexed),
         deterministic(deterministic), tuIndexer(tuIndexer) {}
 
   // See clang/include/clang/Basic/DeclNodes.td for list of declarations.
@@ -198,15 +198,17 @@ void IndexerAstConsumer::HandleTranslationUnit(clang::ASTContext &astContext) {
                                   clangIdLookupMap, fileMetadataMap,
                                   toBeIndexed);
 
+  toBeIndexed.insert({astContext.getSourceManager().getMainFileID()});
+
   SymbolFormatter symbolFormatter{sourceManager, fileMetadataMap};
-  TuIndexer tuIndexer{sourceManager, this->sema->getLangOpts(),
-                      this->sema->getASTContext(), symbolFormatter,
-                      fileMetadataMap};
+  TuIndexer tuIndexer{
+      sourceManager, this->sema->getLangOpts(), this->sema->getASTContext(),
+      toBeIndexed,   symbolFormatter,           fileMetadataMap};
 
   this->saveIncludeReferences(toBeIndexed, macroIndexer, clangIdLookupMap,
                               fileMetadataMap, tuIndexer);
 
-  IndexerAstVisitor visitor{fileMetadataMap, std::move(toBeIndexed),
+  IndexerAstVisitor visitor{fileMetadataMap, toBeIndexed,
                             this->options.deterministic, tuIndexer};
   visitor.TraverseAST(astContext);
 

indexer/AstConsumer.h

@@ -43,17 +43,6 @@ struct IndexerAstConsumerOptions {
   bool deterministic;
 };
 
-/// Type to track which files should be indexed.
-///
-/// For files that do not belong to this project; their symbols should be
-/// tracked in external symbols instead of creating a \c scip::Document.
-///
-/// Not every file that is part of this project will be part of this map.
-/// For example, if a file+hash was already indexed by another worker,
-/// then one shouldn't call insert(..) for that file.
-using FileIdsToBeIndexedSet =
-    absl::flat_hash_set<llvm_ext::AbslHashAdapter<clang::FileID>>;
-
 struct TuIndexingOutput {
   /// Index storing per-document output and external symbols
   /// for symbols that have definitions.
@@ -86,6 +75,9 @@ class IndexerAstConsumer : public clang::SemaConsumer {
   virtual void ForgetSema() override;
 
 private:
+  using FileIdsToBeIndexedSet =
+      absl::flat_hash_set<llvm_ext::AbslHashAdapter<clang::FileID>>;
+
   void computeFileIdsToBeIndexed(const clang::ASTContext &astContext,
                                  const EmitIndexJobDetails &emitIndexDetails,
                                  const ClangIdLookupMap &clangIdLookupMap,

indexer/Indexer.cc

@@ -372,12 +372,13 @@ void ForwardDeclMap::emit(bool deterministic, scip::ForwardDeclIndex &index) {
 TuIndexer::TuIndexer(const clang::SourceManager &sourceManager,
                      const clang::LangOptions &langOptions,
                      const clang::ASTContext &astContext,
+                     const FileIdsToBeIndexedSet &fileIdsToBeIndexed,
                      SymbolFormatter &symbolFormatter,
                      FileMetadataMap &fileMetadataMap)
     : sourceManager(sourceManager), langOptions(langOptions),
-      astContext(astContext), symbolFormatter(symbolFormatter),
-      approximateNameResolver(astContext), documentMap(),
-      fileMetadataMap(fileMetadataMap), externalSymbols(),
+      astContext(astContext), fileIdsToBeIndexed(fileIdsToBeIndexed),
+      symbolFormatter(symbolFormatter), approximateNameResolver(astContext),
+      documentMap(), fileMetadataMap(fileMetadataMap), externalSymbols(),
       forwardDeclarations() {}
 
 void TuIndexer::saveSyntheticFileDefinition(clang::FileID fileId,
@@ -427,6 +428,9 @@ void TuIndexer::saveInclude(clang::SourceRange sourceRange,
   // ranges in macro expansions, directly call saveOccurrenceImpl.
   auto [range, fileId] =
       FileLocalSourceRange::fromNonEmpty(this->sourceManager, sourceRange);
+  if (!this->fileIdsToBeIndexed.contains({fileId})) {
+    return;
+  }
   this->saveOccurrenceImpl(symbol, range, fileId, 0);
 }
 
@@ -1032,6 +1036,9 @@ void TuIndexer::saveForwardDeclaration(SymbolNameRef symbol,
                                        DocComment &&docComment) {
   auto expansionLoc = this->sourceManager.getExpansionLoc(loc);
   auto [range, fileId] = this->getTokenExpansionRange(expansionLoc);
+  if (!this->fileIdsToBeIndexed.contains({fileId})) {
+    return;
+  }
   auto optStableFileId = this->fileMetadataMap.getStableFileId(fileId);
   if (!optStableFileId.has_value() || !optStableFileId->isInProject) {
     return;
@@ -1044,6 +1051,9 @@ void TuIndexer::saveReference(SymbolNameRef symbol, clang::SourceLocation loc,
                               RefersToForwardDecl fwdDecl, int32_t extraRoles) {
   auto expansionLoc = this->sourceManager.getExpansionLoc(loc);
   auto fileId = this->sourceManager.getFileID(expansionLoc);
+  if (!this->fileIdsToBeIndexed.contains({fileId})) {
+    return;
+  }
   auto optStableFileId = this->fileMetadataMap.getStableFileId(fileId);
   if (!optStableFileId.has_value() || !optStableFileId->isInProject) {
     return;
@@ -1065,6 +1075,9 @@ void TuIndexer::saveDefinition(
     int32_t extraRoles) {
   auto expansionLoc = this->sourceManager.getExpansionLoc(loc);
   auto fileId = this->sourceManager.getFileID(expansionLoc);
+  if (!this->fileIdsToBeIndexed.contains({fileId})) {
+    return;
+  }
   auto optStableFileId = this->fileMetadataMap.getStableFileId(fileId);
   if (!optStableFileId.has_value()) {
     return;

indexer/Indexer.h

@@ -286,10 +286,22 @@ class ForwardDeclMap final {
   void emit(bool deterministic, scip::ForwardDeclIndex &);
 };
 
+/// Type to track which files should be indexed.
+///
+/// For files that do not belong to this project; their symbols should be
+/// tracked in external symbols instead of creating a \c scip::Document.
+///
+/// Not every file that is part of this project will be part of this map.
+/// For example, if a file+hash was already indexed by another worker,
+/// then one shouldn't call insert(..) for that file.
+using FileIdsToBeIndexedSet =
+    absl::flat_hash_set<llvm_ext::AbslHashAdapter<clang::FileID>>;
+
 class TuIndexer final {
   const clang::SourceManager &sourceManager;
   const clang::LangOptions &langOptions;
   [[maybe_unused]] const clang::ASTContext &astContext;
+  const FileIdsToBeIndexedSet &fileIdsToBeIndexed;
   SymbolFormatter &symbolFormatter;
   ApproximateNameResolver approximateNameResolver;
 
@@ -303,7 +315,8 @@ class TuIndexer final {
 
 public:
   TuIndexer(const clang::SourceManager &, const clang::LangOptions &,
-            const clang::ASTContext &, SymbolFormatter &, FileMetadataMap &);
+            const clang::ASTContext &, const FileIdsToBeIndexedSet &,
+            SymbolFormatter &, FileMetadataMap &);
 
   /// Emit a fake 'definition' for a file, which can be used as a target
   /// of Go to definition from #include, as well as the source for

test/index/fwd_decl/myheader.snapshot.h

@@ -2,19 +2,16 @@
 // definition [..] `<file>/myheader.h`/
   /// Look, a function!
   void f();
-//     ^ reference [..] f(49f6e7a06ebc5aa8).
 //     ^ reference [..] f(49f6e7a06ebc5aa8).
 
   /// Look, a struct!
   struct S;
-//       ^ reference [..] S#
 //       ^ reference [..] S#
 
   struct C {
 //       ^ definition [..] C#
     /// Look, a method!
     void m();
-//       ^ reference [..] C#m(49f6e7a06ebc5aa8).
 //       ^ reference [..] C#m(49f6e7a06ebc5aa8).
   };