Allow retrieval of the symbol provider kind for a source file

ahoppen · ahoppen · commit a335a473dc2c · 2024-01-26T17:06:12.000-08:00
diff --git a/Sources/IndexStoreDB/IndexStoreDB.swift b/Sources/IndexStoreDB/IndexStoreDB.swift
@@ -35,6 +35,11 @@ public struct PathMapping {
   }
 }
 
+public enum SymbolProviderKind {
+  case clang
+  case swift
+}
+
 /// IndexStoreDB index.
 public final class IndexStoreDB {
 
@@ -275,6 +280,41 @@ public final class IndexStoreDB {
     return result
   }
     
+  public func symbolProvider(for sourceFilePath: String) -> SymbolProviderKind? {
+    var result: SymbolProviderKind? = nil
+    indexstoredb_index_units_containing_file(impl, sourceFilePath) { unit in
+      let providerKind: SymbolProviderKind? = switch indexstoredb_unit_info_symbol_provider_kind(unit) {
+      case INDEXSTOREDB_SYMBOL_PROVIDER_KIND_SWIFT:
+        .swift
+      case INDEXSTOREDB_SYMBOL_PROVIDER_KIND_CLANG:
+        .clang
+      case INDEXSTOREDB_SYMBOL_PROVIDER_KIND_UNKNOWN:
+        nil
+      default:
+        preconditionFailure("Unknown enum case in indexstoredb_symbol_provider_kind_t")
+      }
+
+      let mainFilePath = String(cString: indexstoredb_unit_info_main_file_path(unit))
+      if providerKind == .swift && mainFilePath != sourceFilePath {
+        // We have a unit that is "included" from Swift. This happens for header
+        // files that Swift files depend on. But Swift doesn't have includes and
+        // we shouldn't infer the header file's language to Swift based on this unit.
+        // Ignore it.
+        return true
+      }
+
+      if result == nil {
+        result = providerKind
+      } else if result != providerKind {
+        // Found two conflicting provider kinds. Return nil as we don't know the provider in this case.
+        result = nil
+        return false
+      }
+      return true
+    }
+    return result
+  }
+
   @discardableResult
   public func foreachFileIncludedByFile(path: String, body: @escaping (String) -> Bool) -> Bool {
     return indexstoredb_index_files_included_by_file(impl, path) { targetPath, line in
diff --git a/Sources/IndexStoreDB/Symbol.swift b/Sources/IndexStoreDB/Symbol.swift
@@ -84,9 +84,9 @@ extension Symbol: Comparable {
 extension Symbol: CustomStringConvertible {
   public var description: String {
     if properties.isEmpty {
-      return "\(name) | \(kind) | \(usr)"
+      return "\(name) | \(kind) | \(usr) | \(language)"
     }
-    return "\(name) | \(kind) (\(properties)) | \(usr)"
+    return "\(name) | \(kind) (\(properties)) | \(usr) | \(language)"
   }
 }
 
diff --git a/Tests/IndexStoreDBTests/IndexTests.swift b/Tests/IndexStoreDBTests/IndexTests.swift
@@ -113,21 +113,21 @@ final class IndexTests: XCTestCase {
     checkOccurrences(cdeclOccs, expected: [
       cdecl.at(ws.testLoc("C:decl"), roles: [.declaration, .canonical]),
       cdecl.at(ws.testLoc("C:def"), roles: .definition),
-      cdecl.at(ws.testLoc("C:ref:swift"), roles: .reference),
+      cdecl.with(language: .swift).at(ws.testLoc("C:ref:swift"), roles: .reference),
       cdecl.at(ws.testLoc("C:ref:e.mm"), roles: .reference),
     ])
 
     let cmethod = Symbol(usr: "c:objc(cs)C(im)method", name: "method", kind: .instanceMethod, language: .objc)
     let cmethodOccs = index.occurrences(ofUSR: cmethod.usr, roles: .all)
     checkOccurrences(cmethodOccs, expected: [
-      cmethod.with(name: "method()").at(ws.testLoc("C.method:call:swift"), roles: [.call, .dynamic]),
+      cmethod.with(name: "method()", language: .swift).at(ws.testLoc("C.method:call:swift"), roles: [.call, .dynamic]),
       cmethod.at(ws.testLoc("C.method:decl"), roles: .declaration),
       cmethod.at(ws.testLoc("C.method:def"), roles: .definition),
       cmethod.at(ws.testLoc("C.method:call:e.mm"), roles: [.call, .dynamic]),
     ])
   #endif
 
-    let ddecl = Symbol(usr: "c:@S@D", name: "D", kind: .class, language: .c)
+    let ddecl = Symbol(usr: "c:@S@D", name: "D", kind: .class, language: .cxx)
     let dOccs = index.occurrences(ofUSR: ddecl.usr, roles: .all)
     checkOccurrences(dOccs, expected: [
       ddecl.at(ws.testLoc("D:def"), roles: .definition),
@@ -139,7 +139,7 @@ final class IndexTests: XCTestCase {
     let bridgingHeaderOccs = index.occurrences(ofUSR: bhdecl.usr, roles: .all)
     checkOccurrences(bridgingHeaderOccs, expected: [
       bhdecl.at(ws.testLoc("bridgingHeader:decl"), roles: .declaration),
-      bhdecl.with(name: "bridgingHeader()").at(ws.testLoc("bridgingHeader:call"), roles: .call),
+      bhdecl.with(name: "bridgingHeader()", language: .swift).at(ws.testLoc("bridgingHeader:call"), roles: .call),
     ])
   }
 
@@ -154,18 +154,18 @@ final class IndexTests: XCTestCase {
     let index = ws.index
 
   #if os(macOS)
-    let cdecl = Symbol(usr: "c:objc(cs)C", name: "C", kind: .class, language: .c)
+    let cdecl = Symbol(usr: "c:objc(cs)C", name: "C", kind: .class, language: .objc)
     let cdeclOccs = index.occurrences(ofUSR: cdecl.usr, roles: .all)
     checkOccurrences(cdeclOccs, expected: [
       cdecl.at(ws.testLoc("C:decl"), roles: [.declaration, .canonical]),
       cdecl.at(ws.testLoc("C:def"), roles: .definition),
-      cdecl.at(ws.testLoc("C:ref:swift"), roles: .reference),
+      cdecl.with(language: .swift).at(ws.testLoc("C:ref:swift"), roles: .reference),
     ])
 
-    let cmethod = Symbol(usr: "c:objc(cs)C(im)method", name: "method", kind: .instanceMethod, language: .c)
+    let cmethod = Symbol(usr: "c:objc(cs)C(im)method", name: "method", kind: .instanceMethod, language: .objc)
     let cmethodOccs = index.occurrences(ofUSR: cmethod.usr, roles: .all)
     checkOccurrences(cmethodOccs, expected: [
-      cmethod.with(name: "method()").at(ws.testLoc("C.method:call:swift"), roles: [.call, .dynamic]),
+      cmethod.with(name: "method()", language: .swift).at(ws.testLoc("C.method:call:swift"), roles: [.call, .dynamic]),
       cmethod.at(ws.testLoc("C.method:decl"), roles: .declaration),
       cmethod.at(ws.testLoc("C.method:def"), roles: .definition),
     ])
@@ -175,7 +175,7 @@ final class IndexTests: XCTestCase {
     let bridgingHeaderOccs = index.occurrences(ofUSR: bhdecl.usr, roles: .all)
     checkOccurrences(bridgingHeaderOccs, expected: [
       bhdecl.at(ws.testLoc("bridgingHeader:decl"), roles: .declaration),
-      bhdecl.with(name: "bridgingHeader()").at(ws.testLoc("bridgingHeader:call"), roles: .call),
+      bhdecl.with(name: "bridgingHeader()", language: .swift).at(ws.testLoc("bridgingHeader:call"), roles: .call),
     ])
   }
 
@@ -191,7 +191,7 @@ final class IndexTests: XCTestCase {
     let index = ws.index
 
   #if os(macOS)
-    let cdecl = Symbol(usr: "c:objc(cs)C", name: "C", kind: .class, language: .c)
+    let cdecl = Symbol(usr: "c:objc(cs)C", name: "C", kind: .class, language: .objc)
     let getOccs = { index.occurrences(ofUSR: cdecl.usr, roles: .all) }
 
     // Output units are not set yet.
@@ -209,13 +209,13 @@ final class IndexTests: XCTestCase {
     let bridgingHeaderOccs = index.occurrences(ofUSR: bhdecl.usr, roles: .all)
     checkOccurrences(bridgingHeaderOccs, expected: [
       bhdecl.at(ws.testLoc("bridgingHeader:decl"), roles: .declaration),
-      bhdecl.with(name: "bridgingHeader()").at(ws.testLoc("bridgingHeader:call"), roles: .call),
+      bhdecl.with(name: "bridgingHeader()", language: .swift).at(ws.testLoc("bridgingHeader:call"), roles: .call),
     ])
   #if os(macOS)
     checkOccurrences(getOccs(), expected: [
       cdecl.at(ws.testLoc("C:decl"), roles: [.declaration, .canonical]),
       cdecl.at(ws.testLoc("C:def"), roles: .definition),
-      cdecl.at(ws.testLoc("C:ref:swift"), roles: .reference),
+      cdecl.with(language: .swift).at(ws.testLoc("C:ref:swift"), roles: .reference),
     ])
 
     let outUnitASwift = try XCTUnwrap(indexOutputPaths.first{ $0.hasSuffix("-a.swift.o") })
@@ -239,7 +239,7 @@ final class IndexTests: XCTestCase {
     let index = ws.index
 
   #if os(macOS)
-    let cdecl = Symbol(usr: "c:objc(cs)C", name: "C", kind: .class, language: .c)
+    let cdecl = Symbol(usr: "c:objc(cs)C", name: "C", kind: .class, language: .objc)
     let getOccs = { index.occurrences(ofUSR: cdecl.usr, roles: .all) }
 
     // Output units are not set yet.
@@ -257,13 +257,13 @@ final class IndexTests: XCTestCase {
     let bridgingHeaderOccs = index.occurrences(ofUSR: bhdecl.usr, roles: .all)
     checkOccurrences(bridgingHeaderOccs, expected: [
       bhdecl.at(ws.testLoc("bridgingHeader:decl"), roles: .declaration),
-      bhdecl.with(name: "bridgingHeader()").at(ws.testLoc("bridgingHeader:call"), roles: .call),
+      bhdecl.with(name: "bridgingHeader()", language: .swift).at(ws.testLoc("bridgingHeader:call"), roles: .call),
     ])
   #if os(macOS)
     checkOccurrences(getOccs(), expected: [
       cdecl.at(ws.testLoc("C:decl"), roles: [.declaration, .canonical]),
       cdecl.at(ws.testLoc("C:def"), roles: .definition),
-      cdecl.at(ws.testLoc("C:ref:swift"), roles: .reference),
+      cdecl.with(language: .swift).at(ws.testLoc("C:ref:swift"), roles: .reference),
     ])
 
     let outUnitASwift = try XCTUnwrap(indexOutputPaths.first{ $0.hasSuffix("-a.swift.o") })
@@ -547,7 +547,7 @@ final class IndexTests: XCTestCase {
     try ws.buildAndIndex()
     let index = ws.index
 
-    let ddecl = Symbol(usr: "c:@S@D", name: "D", kind: .class, language: .c)
+    let ddecl = Symbol(usr: "c:@S@D", name: "D", kind: .class, language: .cxx)
     let getOccs = { index.occurrences(ofUSR: ddecl.usr, roles: .all) }
 
     // Output units are not set yet.
@@ -573,7 +573,7 @@ final class IndexTests: XCTestCase {
     let bridgingHeaderOccs = index.occurrences(ofUSR: bhdecl.usr, roles: .all)
     checkOccurrences(bridgingHeaderOccs, expected: [
       bhdecl.at(ws.testLoc("bridgingHeader:decl"), roles: .declaration),
-      bhdecl.with(name: "bridgingHeader()").at(ws.testLoc("bridgingHeader:call"), roles: .call),
+      bhdecl.with(name: "bridgingHeader()", language: .swift).at(ws.testLoc("bridgingHeader:call"), roles: .call),
     ])
   }
 
@@ -665,7 +665,7 @@ final class IndexTests: XCTestCase {
 
     try ws.buildAndIndex()
 
-    let largeType = Symbol(usr: "c:@CT@LargeType", name: "LargeType", kind: .concept, language: .cxx)
+    let largeType = Symbol(usr: "c:@CT@LargeType", name: "LargeType", kind: .concept, language: .c)
     let largeTypeOccs = ws.index.occurrences(ofUSR: largeType.usr, roles: .all)
     checkOccurrences(largeTypeOccs, expected: [
       largeType.at(ws.testLoc("LargeType:def"), roles: .definition),
diff --git a/include/CIndexStoreDB/CIndexStoreDB.h b/include/CIndexStoreDB/CIndexStoreDB.h
@@ -144,6 +144,12 @@ typedef enum {
   INDEXSTOREDB_LANGUAGE_SWIFT
 } indexstoredb_language_t;
 
+typedef enum {
+  INDEXSTOREDB_SYMBOL_PROVIDER_KIND_CLANG,
+  INDEXSTOREDB_SYMBOL_PROVIDER_KIND_SWIFT,
+  INDEXSTOREDB_SYMBOL_PROVIDER_KIND_UNKNOWN,
+} indexstoredb_symbol_provider_kind_t;
+
 typedef void *indexstoredb_delegate_event_t;
 
 /// Returns true on success.
@@ -483,6 +489,9 @@ indexstoredb_unit_info_main_file_path(_Nonnull indexstoredb_unit_info_t);
 INDEXSTOREDB_PUBLIC const char *_Nonnull
 indexstoredb_unit_info_unit_name(_Nonnull indexstoredb_unit_info_t);
 
+INDEXSTOREDB_PUBLIC indexstoredb_symbol_provider_kind_t
+indexstoredb_unit_info_symbol_provider_kind(_Nonnull indexstoredb_unit_info_t info);
+
 /// Iterates over the compilation units that contain \p path and return their units.
 ///
 /// This can be used to find information for units that include a given header.
diff --git a/include/IndexStoreDB/Index/StoreUnitInfo.h b/include/IndexStoreDB/Index/StoreUnitInfo.h
@@ -13,6 +13,7 @@
 #ifndef INDEXSTOREDB_INDEX_STOREUNITINFO_H
 #define INDEXSTOREDB_INDEX_STOREUNITINFO_H
 
+#include "IndexStoreDB/Core/Symbol.h"
 #include "IndexStoreDB/Support/Path.h"
 #include "llvm/Support/Chrono.h"
 #include <string>
@@ -26,16 +27,18 @@ struct StoreUnitInfo {
   std::string OutFileIdentifier;
   bool HasTestSymbols = false;
   llvm::sys::TimePoint<> ModTime;
+  Optional<SymbolProviderKind> SymProviderKind;
 
   StoreUnitInfo() = default;
   StoreUnitInfo(std::string unitName, CanonicalFilePath mainFilePath,
                 StringRef outFileIdentifier, bool hasTestSymbols,
-                llvm::sys::TimePoint<> modTime)
+                llvm::sys::TimePoint<> modTime, Optional
+                <SymbolProviderKind> SymProviderKind)
       : UnitName(unitName),
         MainFilePath(mainFilePath),
         OutFileIdentifier(outFileIdentifier),
         HasTestSymbols(hasTestSymbols),
-        ModTime(modTime) {}
+        ModTime(modTime), SymProviderKind(SymProviderKind) {}
 };
 
 } // namespace index
diff --git a/lib/CIndexStoreDB/CIndexStoreDB.cpp b/lib/CIndexStoreDB/CIndexStoreDB.cpp
@@ -566,6 +566,20 @@ indexstoredb_unit_info_unit_name(indexstoredb_unit_info_t info) {
   return obj->UnitName.c_str();
 }
 
+indexstoredb_symbol_provider_kind_t
+indexstoredb_unit_info_symbol_provider_kind(_Nonnull indexstoredb_unit_info_t info) {
+  auto obj = (const StoreUnitInfo *)info;
+  if (!obj->SymProviderKind) {
+    return INDEXSTOREDB_SYMBOL_PROVIDER_KIND_UNKNOWN;
+  }
+  switch (*obj->SymProviderKind) {
+  case IndexStoreDB::SymbolProviderKind::Clang:
+    return INDEXSTOREDB_SYMBOL_PROVIDER_KIND_CLANG;
+  case IndexStoreDB::SymbolProviderKind::Swift:
+    return INDEXSTOREDB_SYMBOL_PROVIDER_KIND_SWIFT;
+  }
+}
+
 bool
 indexstoredb_index_units_containing_file(
   indexstoredb_index_t index,
diff --git a/lib/Index/FilePathIndex.cpp b/lib/Index/FilePathIndex.cpp
@@ -166,6 +166,7 @@ bool FileIndexImpl::foreachMainUnitContainingFile(CanonicalFilePathRef filePath,
       currUnit.ModTime = unitInfo.ModTime;
       currUnit.MainFilePath = reader.getFullFilePathFromCode(unitInfo.MainFileCode);
       currUnit.OutFileIdentifier = reader.getUnitFileIdentifierFromCode(unitInfo.OutFileCode);
+      currUnit.SymProviderKind = unitInfo.SymProviderKind;
       return true;
     });
   }
diff --git a/lib/Index/IndexDatastore.cpp b/lib/Index/IndexDatastore.cpp
@@ -479,6 +479,7 @@ void StoreUnitRepo::registerUnit(StringRef unitName, bool isInitialScan, std::sh
   bool needDatabaseUpdate;
   Optional<bool> optIsSystem;
   Optional<bool> PrevHasTestSymbols;
+  Optional<SymbolProviderKind> PrevSymProviderKind;
   IDCode PrevMainFileCode;
   IDCode PrevOutFileCode;
   Optional<StoreUnitInfo> StoreUnitInfoOpt;
@@ -498,6 +499,7 @@ void StoreUnitRepo::registerUnit(StringRef unitName, bool isInitialScan, std::sh
       PrevMainFileCode = unitImport.getPrevMainFileCode();
       PrevOutFileCode = unitImport.getPrevOutFileCode();
       PrevHasTestSymbols = unitImport.getHasTestSymbols();
+      PrevSymProviderKind = unitImport.getSymbolProviderKind();
       return false;
     }
 
@@ -595,7 +597,14 @@ void StoreUnitRepo::registerUnit(StringRef unitName, bool isInitialScan, std::sh
     }
 
     unitImport.commit();
-    StoreUnitInfoOpt = StoreUnitInfo{unitName, CanonMainFile, OutFileIdentifier, unitImport.getHasTestSymbols().getValue(), unitModTime};
+    StoreUnitInfoOpt = StoreUnitInfo{
+      unitName,
+      CanonMainFile,
+      OutFileIdentifier,
+      unitImport.getHasTestSymbols().getValue(),
+      unitModTime,
+      unitImport.getSymbolProviderKind()
+    };
     import.commit();
     return false;
   };
@@ -608,7 +617,14 @@ void StoreUnitRepo::registerUnit(StringRef unitName, bool isInitialScan, std::sh
       ReadTransaction reader(SymIndex->getDBase());
       CanonicalFilePath mainFile = reader.getFullFilePathFromCode(PrevMainFileCode);
       std::string outFileIdentifier = reader.getUnitFileIdentifierFromCode(PrevOutFileCode);
-      StoreUnitInfoOpt = StoreUnitInfo{unitName, mainFile, outFileIdentifier, PrevHasTestSymbols.getValue(), unitModTime};
+      StoreUnitInfoOpt = StoreUnitInfo{
+        unitName,
+        mainFile,
+        outFileIdentifier,
+        PrevHasTestSymbols.getValue(),
+        unitModTime,
+        PrevSymProviderKind.getValue()
+      };
     }
     Delegate->processedStoreUnit(StoreUnitInfoOpt.getValue());
   }
@@ -816,6 +832,7 @@ void StoreUnitRepo::onUnitOutOfDate(IDCode unitCode, StringRef unitName,
   CanonicalFilePath MainFilePath;
   std::string OutFileIdentifier;
   bool hasTestSymbols = false;
+  Optional<SymbolProviderKind> SymProviderKind;
   llvm::sys::TimePoint<> CurrModTime;
   SmallVector<IDCode, 8> dependentUnits;
   {
@@ -827,13 +844,21 @@ void StoreUnitRepo::onUnitOutOfDate(IDCode unitCode, StringRef unitName,
       }
       OutFileIdentifier = reader.getUnitFileIdentifierFromCode(unitInfo.OutFileCode);
       hasTestSymbols = unitInfo.HasTestSymbols;
+      SymProviderKind = unitInfo.SymProviderKind;
       CurrModTime = unitInfo.ModTime;
     }
     reader.getDirectDependentUnits(unitCode, dependentUnits);
   }
 
   if (!MainFilePath.empty() && Delegate) {
-    StoreUnitInfo unitInfo{unitName, MainFilePath, OutFileIdentifier, hasTestSymbols, CurrModTime};
+    StoreUnitInfo unitInfo{
+      unitName,
+      MainFilePath,
+      OutFileIdentifier,
+      hasTestSymbols,
+      CurrModTime,
+      SymProviderKind
+    };
     Delegate->unitIsOutOfDate(unitInfo, outOfDateModTime, hint, synchronous);
   }
 

Original file line number	Diff line number	Diff line change
`@@ -84,9 +84,9 @@ extension Symbol: Comparable {`
`84`	`84`	`extension Symbol: CustomStringConvertible {`
`85`	`85`	`public var description: String {`
`86`	`86`	`if properties.isEmpty {`
`87`		`- return "\(name) \| \(kind) \| \(usr)"`
	`87`	`+ return "\(name) \| \(kind) \| \(usr) \| \(language)"`
`88`	`88`	`}`
`89`		`- return "\(name) \| \(kind) (\(properties)) \| \(usr)"`
	`89`	`+ return "\(name) \| \(kind) (\(properties)) \| \(usr) \| \(language)"`
`90`	`90`	`}`
`91`	`91`	`}`
`92`	`92`
Original file line number	Diff line number	Diff line change
`@@ -166,6 +166,7 @@ bool FileIndexImpl::foreachMainUnitContainingFile(CanonicalFilePathRef filePath,`
`166`	`166`	`currUnit.ModTime = unitInfo.ModTime;`
`167`	`167`	`currUnit.MainFilePath = reader.getFullFilePathFromCode(unitInfo.MainFileCode);`
`168`	`168`	`currUnit.OutFileIdentifier = reader.getUnitFileIdentifierFromCode(unitInfo.OutFileCode);`
	`169`	`+ currUnit.SymProviderKind = unitInfo.SymProviderKind;`
`169`	`170`	`return true;`
`170`	`171`	`});`
`171`	`172`	`}`