Add ability to find symbols by name

Sources/IndexStoreDB/IndexStoreDB.swift

@@ -80,6 +80,33 @@ public final class IndexStoreDB {
       return body(SymbolOccurrence(occur))
     }
   }
+
+  @discardableResult public func forEachCanonicalSymbolOccurrence(byName: String, body: @escaping (SymbolOccurrence) -> Bool) -> Bool {
+    return indexstoredb_index_canonical_symbol_occurences_by_name(impl, byName) { occur in
+      return body(SymbolOccurrence(occur))
+    }
+  }
+
+  @discardableResult public func forEachCanonicalSymbolOccurrence(
+    containing pattern: String,
+    anchorStart: Bool,
+    anchorEnd: Bool,
+    subsequence: Bool,
+    ignoreCase: Bool,
+    body: @escaping (SymbolOccurrence) -> Bool
+  ) -> Bool {
+    return indexstoredb_index_canonical_symbol_occurences_containing_pattern(
+      impl,
+      pattern,
+      anchorStart,
+      anchorEnd,
+      subsequence,
+      ignoreCase
+    ) { occur in
+      body(SymbolOccurrence(occur))
+    }
+  }
+
 }
 
 public struct SymbolRole: OptionSet {

include/CIndexStoreDB/CIndexStoreDB.h

@@ -85,6 +85,9 @@ typedef _Nullable indexstoredb_indexstore_library_t(^indexstore_library_provider
 /// Returns true to continue.
 typedef bool(^indexstoredb_symbol_occurrence_receiver_t)(_Nonnull indexstoredb_symbol_occurrence_t);
 
+/// Returns true to continue.
+typedef bool(^indexstoredb_symbol_name_receiver)(const char *_Nonnull);
+
 INDEXSTOREDB_PUBLIC _Nullable
 indexstoredb_index_t
 indexstoredb_index_create(const char * _Nonnull storePath,
@@ -159,6 +162,45 @@ indexstoredb_error_get_description(_Nonnull indexstoredb_error_t);
 INDEXSTOREDB_PUBLIC void
 indexstoredb_error_dispose(_Nullable indexstoredb_error_t);
 
+/// Loops through each symbol in the index and calls the receiver function with each symbol.
+/// @param index An IndexStoreDB object which contains the symbols.
+/// @param receiver A function to be called for each symbol, the CString of the symbol will be passed in to this function.
+/// The function should return a boolean indicating whether the looping should continue.
+INDEXSTOREDB_PUBLIC bool
+indexstoredb_index_symbol_names(_Nonnull indexstoredb_index_t index, _Nonnull indexstoredb_symbol_name_receiver);
+
+/// Loops through each canonical symbol that matches the string and performs the passed in function.
+/// @param index An IndexStoreDB object which contains the symbols.
+/// @param symbolName The name of the symbol whose canonical occurence should be found.
+/// @param receiver A function to be called for each canonical occurence.
+/// The SymbolOccurenceRef of the symbol will be passed in to this function.
+/// The function should return a boolean indicating whether the looping should continue.
+INDEXSTOREDB_PUBLIC bool
+indexstoredb_index_canonical_symbol_occurences_by_name(
+    indexstoredb_index_t _Nonnull index,
+    const char *_Nonnull symbolName,
+    indexstoredb_symbol_occurrence_receiver_t _Nonnull receiver
+);
+
+/// Loops through each canonical symbol that matches the pattern and performs the passed in function.
+/// @param index An IndexStoreDB object which contains the symbols.
+/// @param anchorStart When true, symbol names should only be considered matching when the first characters of the symbol name match the pattern.
+/// @param anchorEnd When true, symbol names should only be considered matching when the first characters of the symbol name match the pattern.
+/// @param subsequence When true, symbols will be matched even if the pattern is not matched contiguously.
+/// @param ignoreCase When true, symbols may be returned even if the case of letters does not match the pattern.
+/// @param receiver A function to be called for each canonical occurence that matches the pattern.
+/// The SymbolOccurenceRef of the symbol will be passed in to this function.
+/// The function should return a boolean indicating whether the looping should continue.
+INDEXSTOREDB_PUBLIC bool
+indexstoredb_index_canonical_symbol_occurences_containing_pattern(
+    _Nonnull indexstoredb_index_t index,
+    const char *_Nonnull pattern,
+    bool anchorStart,
+    bool anchorEnd,
+    bool subsequence,
+    bool ignoreCase,
+    _Nonnull indexstoredb_symbol_occurrence_receiver_t receiver);
+
 INDEXSTOREDB_END_DECLS
 
 #endif

lib/CIndexStoreDB/CIndexStoreDB.cpp

@@ -144,6 +144,49 @@ indexstoredb_symbol_name(indexstoredb_symbol_t symbol) {
   return obj->value->getName().c_str();
 }
 
+bool
+indexstoredb_index_symbol_names(indexstoredb_index_t index, indexstoredb_symbol_name_receiver receiver) {
+  auto obj = (IndexStoreDBObject<std::shared_ptr<IndexSystem>> *)index;
+  return obj->value->foreachSymbolName([&](StringRef ref) -> bool {
+    return receiver(ref.str().c_str());
+  });
+}
+
+bool
+indexstoredb_index_canonical_symbol_occurences_by_name(
+  indexstoredb_index_t index,
+  const char *_Nonnull symbolName,
+  indexstoredb_symbol_occurrence_receiver_t receiver)
+{
+  auto obj = (IndexStoreDBObject<std::shared_ptr<IndexSystem>> *)index;
+  return obj->value->foreachCanonicalSymbolOccurrenceByName(symbolName, [&](SymbolOccurrenceRef occur) -> bool {
+    return receiver(make_object(occur));
+  });
+}
+
+bool
+indexstoredb_index_canonical_symbol_occurences_containing_pattern(
+  indexstoredb_index_t index,
+  const char *_Nonnull pattern,
+  bool anchorStart,
+  bool anchorEnd,
+  bool subsequence,
+  bool ignoreCase,
+  indexstoredb_symbol_occurrence_receiver_t receiver)
+{
+  auto obj = (IndexStoreDBObject<std::shared_ptr<IndexSystem>> *)index;
+  return obj->value->foreachCanonicalSymbolOccurrenceContainingPattern(
+    pattern,
+    anchorStart,
+    anchorEnd,
+    subsequence,
+    ignoreCase,
+    [&](SymbolOccurrenceRef occur
+  ) -> bool {
+      return receiver(make_object(occur));
+  });
+}
+
 indexstoredb_symbol_t
 indexstoredb_symbol_occurrence_symbol(indexstoredb_symbol_occurrence_t occur) {
   auto obj = (IndexStoreDBObject<SymbolOccurrenceRef> *)occur;