Add SymbolRelation class with roles and symbols

Add kind property to Symbol

Add forEachRelation of occurrence function

Author: literalpie

Sources/IndexStoreDB/IndexStoreDB.swift

@@ -107,6 +107,26 @@ public final class IndexStoreDB {
     }
   }
 
+  @discardableResult public func forEachRelation(
+    of occurrence: SymbolOccurrence,
+    body: @escaping (SymbolRelation) -> Bool
+  ) -> Bool {
+    return indexstoredb_symbol_occurrence_relations(occurrence.value){ relation in
+      body(SymbolRelation(relation))
+    }
+  }
+
+}
+
+public final class SymbolRelation {
+  let value: indexstoredb_symbol_relation_t
+
+  public lazy var roles = SymbolRole(rawValue: indexstoredb_symbol_relation_get_roles(value))
+  public lazy var symbol = Symbol(indexstoredb_symbol_relation_get_symbol(value))
+
+  public init(_ value: indexstoredb_symbol_relation_t) {
+    self.value = value
+  }
 }
 
 public struct SymbolRole: OptionSet {
@@ -154,6 +174,7 @@ public final class Symbol {
 
   public lazy var usr: String = String(cString: indexstoredb_symbol_usr(value))
   public lazy var name: String = String(cString: indexstoredb_symbol_name(value))
+  public lazy var kind = indexstoredb_symbol_kind(value)
 
   init(_ value: indexstoredb_symbol_t) {
     self.value = value
@@ -192,6 +213,7 @@ public final class SymbolOccurrence {
   public lazy var symbol: Symbol = Symbol(indexstoredb_symbol_occurrence_symbol(value))
   public lazy var roles: SymbolRole = SymbolRole(rawValue: indexstoredb_symbol_occurrence_roles(value))
   public lazy var location: SymbolLocation = SymbolLocation(indexstoredb_symbol_occurrence_location(value))
+  public lazy var relations: [SymbolRelation] = getRelations()
 
   init(_ value: indexstoredb_symbol_occurrence_t) {
     self.value = value
@@ -200,6 +222,15 @@ public final class SymbolOccurrence {
   deinit {
     indexstoredb_release(value)
   }
+
+  private func getRelations() -> [SymbolRelation] {
+    var relations: [SymbolRelation] = []
+    indexstoredb_symbol_occurrence_relations(value){ relation in
+      relations.append(SymbolRelation(relation))
+      return true
+    }
+    return relations
+  }
 }
 
 public protocol IndexStoreLibraryProvider {

include/CIndexStoreDB/CIndexStoreDB.h

@@ -52,6 +52,8 @@ typedef indexstoredb_object_t indexstoredb_symbol_occurrence_t;
 
 typedef void *indexstoredb_error_t;
 typedef void *indexstoredb_symbol_location_t;
+typedef void *indexstoredb_symbol_relation_t;
+typedef void *indexstoredb_symbol_kind_t;
 
 typedef enum {
   INDEXSTOREDB_SYMBOL_ROLE_DECLARATION = 1 << 0,
@@ -201,6 +203,30 @@ indexstoredb_index_canonical_symbol_occurences_containing_pattern(
     bool ignoreCase,
     _Nonnull indexstoredb_symbol_occurrence_receiver_t receiver);
 
+/// Gets the set of roles of the passed in symbol relation
+/// @param relation A symbol relation
+INDEXSTOREDB_PUBLIC uint64_t
+indexstoredb_symbol_relation_get_roles(_Nonnull  indexstoredb_symbol_relation_t);
+
+/// Gets the symbol associated with the passed in relation
+/// @param relation A symbol relation
+INDEXSTOREDB_PUBLIC _Nonnull indexstoredb_symbol_t
+indexstoredb_symbol_relation_get_symbol(_Nonnull indexstoredb_symbol_relation_t);
+
+/// Loops through each relation that a passed in symbol has, and performs the passed in function.
+/// The relations are owned by the occurrence and shall not be used after the occurrence is freed.
+/// @param occurrence The symbol occurrence that whose relations should be found.
+/// @param applier The function that should be performed on each symbol relation.
+/// The function should return a boolean indicating whether the looping should continue.
+INDEXSTOREDB_PUBLIC bool
+indexstoredb_symbol_occurrence_relations(_Nonnull indexstoredb_symbol_occurrence_t,
+                                         bool(^ _Nonnull applier)(indexstoredb_symbol_relation_t _Nonnull ));
+
+/// Get the SymbolKind of a Symbol
+/// @param symbol The symbol whose kind should be found.
+INDEXSTOREDB_PUBLIC uint8_t
+indexstoredb_symbol_kind(_Nonnull indexstoredb_symbol_t);
+
 INDEXSTOREDB_END_DECLS
 
 #endif

lib/CIndexStoreDB/CIndexStoreDB.cpp

@@ -144,6 +144,12 @@ indexstoredb_symbol_name(indexstoredb_symbol_t symbol) {
   return obj->value->getName().c_str();
 }
 
+uint8_t
+indexstoredb_symbol_kind(indexstoredb_symbol_t symbol) {
+  auto symbolObj = (IndexStoreDBObject<std::shared_ptr<Symbol>> *)symbol;
+  return (uint8_t) symbolObj->value->getSymbolKind();
+}
+
 bool
 indexstoredb_index_symbol_names(indexstoredb_index_t index, indexstoredb_symbol_name_receiver receiver) {
   auto obj = (IndexStoreDBObject<std::shared_ptr<IndexSystem>> *)index;
@@ -193,6 +199,31 @@ indexstoredb_symbol_occurrence_symbol(indexstoredb_symbol_occurrence_t occur) {
   return make_object(obj->value->getSymbol());
 }
 
+uint64_t
+indexstoredb_symbol_relation_get_roles(indexstoredb_symbol_relation_t relation) {
+  auto relationObj = (IndexStoreDBObject<SymbolRelation> *)relation;
+  return relationObj->value.getRoles().toRaw();
+}
+
+indexstoredb_symbol_t
+indexstoredb_symbol_relation_get_symbol(indexstoredb_symbol_relation_t relation) {
+  auto relationObj = (IndexStoreDBObject<SymbolRelation> *)relation;
+  return make_object(relationObj->value.getSymbol());
+}
+
+bool
+indexstoredb_symbol_occurrence_relations(indexstoredb_symbol_occurrence_t occurrence,
+                                         bool(^applier)(indexstoredb_symbol_relation_t)) {
+  auto occurrenceObj = (IndexStoreDBObject<SymbolOccurrenceRef> *)occurrence;
+  ArrayRef<SymbolRelation> relations = occurrenceObj->value->getRelations();
+  for (SymbolRelation rel : relations) {
+    if(!applier(make_object(rel))) {
+      return false;
+    }
+  }
+  return true;
+}
+
 uint64_t
 indexstoredb_symbol_occurrence_roles(indexstoredb_symbol_occurrence_t occur) {
   auto obj = (IndexStoreDBObject<SymbolOccurrenceRef> *)occur;