Merge pull request #200 from ahoppen/symbol-provider-of-occurrence

Expose the symbol provider of a `SymbolOccurrence` via the Swift API

Author: ahoppen

Sources/ISDBTestSupport/TestLocation.swift

@@ -62,8 +62,8 @@ extension SymbolLocation {
 extension Symbol {
 
   /// Returns a SymbolOccurrence with the given location and roles.
-  public func at(_ location: TestLocation, moduleName: String = TestLocation.unknownModuleName, roles: SymbolRole) -> SymbolOccurrence {
-    return self.at(SymbolLocation(location, moduleName: moduleName), roles: roles)
+  public func at(_ location: TestLocation, moduleName: String = TestLocation.unknownModuleName, roles: SymbolRole, symbolProvider: SymbolProviderKind) -> SymbolOccurrence {
+    return self.at(SymbolLocation(location, moduleName: moduleName), symbolProvider: symbolProvider, roles: roles)
   }
 }
 

Sources/IndexStoreDB/IndexStoreDB.swift

@@ -39,6 +39,19 @@ public struct PathMapping {
 public enum SymbolProviderKind {
   case clang
   case swift
+
+  init?(_ cKind: indexstoredb_symbol_provider_kind_t) {
+    switch cKind {
+    case INDEXSTOREDB_SYMBOL_PROVIDER_KIND_SWIFT:
+      self = .swift
+    case INDEXSTOREDB_SYMBOL_PROVIDER_KIND_CLANG:
+      self = .clang
+    case INDEXSTOREDB_SYMBOL_PROVIDER_KIND_UNKNOWN:
+      return nil
+    default:
+      preconditionFailure("Unknown enum case in indexstoredb_symbol_provider_kind_t")
+    }
+  }
 }
 
 /// IndexStoreDB index.
@@ -304,16 +317,7 @@ public final class IndexStoreDB {
   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 providerKind = SymbolProviderKind(indexstoredb_unit_info_symbol_provider_kind(unit))
 
       let mainFilePath = String(cString: indexstoredb_unit_info_main_file_path(unit))
       if providerKind == .swift && mainFilePath != sourceFilePath {

Sources/IndexStoreDB/Symbol.swift

@@ -110,8 +110,8 @@ extension Symbol {
   }
 
   /// Returns a SymbolOccurrence with the given location and roles.
-  public func at(_ location: SymbolLocation, roles: SymbolRole) -> SymbolOccurrence {
-    return SymbolOccurrence(symbol: self, location: location, roles: roles)
+  public func at(_ location: SymbolLocation, symbolProvider: SymbolProviderKind, roles: SymbolRole) -> SymbolOccurrence {
+    return SymbolOccurrence(symbol: self, location: location, roles: roles, symbolProvider: symbolProvider)
   }
 }
 

Sources/IndexStoreDB/SymbolOccurrence.swift

@@ -17,12 +17,14 @@ public struct SymbolOccurrence: Equatable {
   public var symbol: Symbol
   public var location: SymbolLocation
   public var roles: SymbolRole
+  public var symbolProvider: SymbolProviderKind
   public var relations: [SymbolRelation]
 
-  public init(symbol: Symbol, location: SymbolLocation, roles: SymbolRole, relations: [SymbolRelation] = []) {
+  public init(symbol: Symbol, location: SymbolLocation, roles: SymbolRole, symbolProvider: SymbolProviderKind, relations: [SymbolRelation] = []) {
     self.symbol = symbol
     self.location = location
     self.roles = roles
+    self.symbolProvider = symbolProvider
     self.relations = relations
   }
 }
@@ -72,6 +74,8 @@ extension SymbolOccurrence {
       symbol: Symbol(indexstoredb_symbol_occurrence_symbol(value)),
       location: SymbolLocation(indexstoredb_symbol_occurrence_location(value)),
       roles: SymbolRole(rawValue: indexstoredb_symbol_occurrence_roles(value)),
+      // Force unwrap is OK because `indexstoredb_symbol_occurrence_symbol_provider_kind` never returns `INDEXSTOREDB_SYMBOL_PROVIDER_KIND_UNKNOWN`
+      symbolProvider: SymbolProviderKind(indexstoredb_symbol_occurrence_symbol_provider_kind(value))!,
       relations: relations)
   }
 }