Merge pull request #69076 from barinsim/local-symbols

[SourceKit] Add option to index local symbols to IndexSource request

Author: bnbarham

test/SourceKit/Indexing/index_locals.swift

@@ -0,0 +1,12 @@
+// RUN: %empty-directory(%t)
+// RUN: %sourcekitd-test -req=index-to-store %s -index-store-path %t/idx -index-unit-output-path %t/index_locals.o -req-opts=include_locals=1 -- %s
+// RUN: c-index-test core -print-record %t/idx | %FileCheck %s
+
+
+func foo(a: Int, b: Double) {
+    var locVar = 1
+}
+
+
+// CHECK: variable(local)/Swift | locVar | s:12index_locals3foo1a1bySi_SdtF6locVarL_Sivp | <no-cgname> | Def,RelChild - RelChild,RelAcc
+// CHECK-NEXT: function/acc-set(local)/Swift | setter:locVar | s:12index_locals3foo1a1bySi_SdtF6locVarL_Sivs | <no-cgname> | Def,Impl,RelChild,RelAcc -

tools/SourceKit/include/SourceKit/Core/LangSupport.h

@@ -912,6 +912,11 @@ struct CategorizedRenameRanges {
 struct IndexStoreOptions {
   std::string IndexStorePath;
   std::string IndexUnitOutputPath;
+  bool IgnoreClangModules = false;
+  bool IncludeSystemModules = false;
+  bool IgnoreStdlib = false;
+  bool DisableImplicitModules = false;
+  bool IncludeLocals = false;
 };
 
 struct IndexStoreInfo{};

tools/SourceKit/lib/SwiftLang/SwiftIndexing.cpp

@@ -370,11 +370,11 @@ void SwiftLangSupport::indexSource(StringRef InputFile,
 }
 
 static void emitIndexDataForSourceFile(SourceFile &PrimarySourceFile,
-                                       StringRef IndexStorePath,
-                                       StringRef IndexUnitOutputPath,
+                                       IndexStoreOptions IndexOpts,
                                        const CompilerInstance &Instance) {
   const auto &Invocation = Instance.getInvocation();
-  const auto &Opts = Invocation.getFrontendOptions();
+//  FIXME: Compiler arguments should be the default for setting options, but this is currently broken (see PR #69076)
+//  const auto &Opts = Invocation.getFrontendOptions();
 
   bool isDebugCompilation;
   switch (Invocation.getSILOptions().OptMode) {
@@ -388,14 +388,15 @@ static void emitIndexDataForSourceFile(SourceFile &PrimarySourceFile,
       break;
   }
 
-  (void) index::indexAndRecord(&PrimarySourceFile, IndexUnitOutputPath,
-                               IndexStorePath,
-                               !Opts.IndexIgnoreClangModules,
-                               Opts.IndexSystemModules,
-                               Opts.IndexIgnoreStdlib,
-                               Opts.IndexIncludeLocals,
+  (void) index::indexAndRecord(&PrimarySourceFile,
+                               IndexOpts.IndexUnitOutputPath,
+                               IndexOpts.IndexStorePath,
+                               !IndexOpts.IgnoreClangModules,
+                               IndexOpts.IncludeSystemModules,
+                               IndexOpts.IgnoreStdlib,
+                               IndexOpts.IncludeLocals,
                                isDebugCompilation,
-                               Opts.DisableImplicitModules,
+                               IndexOpts.DisableImplicitModules,
                                Invocation.getTargetTriple(),
                                *Instance.getDependencyTracker(),
                                Invocation.getIRGenOptions().FilePrefixMap);
@@ -425,8 +426,7 @@ void SwiftLangSupport::indexToStore(
     void handlePrimaryAST(ASTUnitRef AstUnit) override {
       auto &SF = AstUnit->getPrimarySourceFile();
       auto &CI = AstUnit->getCompilerInstance();
-      emitIndexDataForSourceFile(
-          SF, Opts.IndexStorePath, Opts.IndexUnitOutputPath, CI);
+      emitIndexDataForSourceFile(SF, Opts, CI);
       Receiver(RequestResult<IndexStoreInfo>::fromResult(IndexStoreInfo{}));
     }
 

tools/SourceKit/tools/sourcekitd-test/sourcekitd-test.cpp

@@ -1159,6 +1159,7 @@ static int handleTestInvocation(TestOptions Opts, TestOptions &InitOpts) {
     sourcekitd_request_dictionary_set_string(Req, KeyIndexStorePath, Opts.IndexStorePath.c_str());
     sourcekitd_request_dictionary_set_string(Req, KeyIndexUnitOutputPath, Opts.IndexUnitOutputPath.c_str());
     sourcekitd_request_dictionary_set_uid(Req, KeyRequest, RequestIndexToStore);
+    addRequestOptionsDirect(Req, Opts);
     break;
   }
 

tools/SourceKit/tools/sourcekitd/lib/Service/Requests.cpp

@@ -1399,6 +1399,48 @@ static void handleRequestIndex(const RequestDict &Req,
   });
 }
 
+static std::optional<IndexStoreOptions>
+getIndexStoreOpts(const RequestDict &Req, ResponseReceiver Rec) {
+  IndexStoreOptions Opts;
+  if (auto IndexStorePath = Req.getString(KeyIndexStorePath))
+    Opts.IndexStorePath = IndexStorePath->str();
+  else {
+    Rec(createErrorRequestInvalid("'key.index_store_path' is required"));
+    return std::nullopt;
+  }
+
+  if (auto IndexUnitOutputPath = Req.getString(KeyIndexUnitOutputPath))
+    Opts.IndexUnitOutputPath = IndexUnitOutputPath->str();
+  else {
+    Rec(createErrorRequestInvalid("'key.index_unit_output_path' is required"));
+    return std::nullopt;
+  }
+
+  if (auto IncludeLocals = Req.getOptionalInt64(KeyIncludeLocals)) {
+    Opts.IncludeLocals = IncludeLocals.value() > 0;
+  }
+
+  if (auto IgnoreClangModules = Req.getOptionalInt64(KeyIgnoreClangModules)) {
+    Opts.IgnoreClangModules = IgnoreClangModules.value() > 0;
+  }
+
+  if (auto IncludeSystemModules =
+          Req.getOptionalInt64(KeyIncludeSystemModules)) {
+    Opts.IncludeSystemModules = IncludeSystemModules.value() > 0;
+  }
+
+  if (auto IgnoreStdlib = Req.getOptionalInt64(KeyIgnoreStdlib)) {
+    Opts.IgnoreStdlib = IgnoreStdlib.value() > 0;
+  }
+
+  if (auto DisableImplicitModules =
+          Req.getOptionalInt64(KeyDisableImplicitModules)) {
+    Opts.DisableImplicitModules = DisableImplicitModules.value() > 0;
+  }
+
+  return Opts;
+}
+
 static void handleRequestIndexToStore(
     const RequestDict &Req, SourceKitCancellationToken CancellationToken,
     ResponseReceiver Rec) {
@@ -1411,22 +1453,15 @@ static void handleRequestIndexToStore(
     if (!PrimaryFilePath)
       return;
 
-    IndexStoreOptions Opts;
-    if (auto IndexStorePath = Req.getString(KeyIndexStorePath))
-      Opts.IndexStorePath = IndexStorePath->str();
-    else
-      return Rec(createErrorRequestInvalid("'key.index_store_path' is required"));
-
-    if (auto IndexUnitOutputPath = Req.getString(KeyIndexUnitOutputPath))
-      Opts.IndexUnitOutputPath = IndexUnitOutputPath->str();
-    else
-      return Rec(createErrorRequestInvalid("'key.index_unit_output_path' is required"));
+    std::optional<IndexStoreOptions> Opts = getIndexStoreOpts(Req, Rec);
+    if (!Opts)
+      return;
 
     SmallVector<const char *, 0> Args;
     if (getCompilerArgumentsForRequestOrEmitError(Req, Args, Rec))
       return;
     LangSupport &Lang = getGlobalContext().getSwiftLangSupport();
-    Lang.indexToStore(*PrimaryFilePath, Args, std::move(Opts),
+    Lang.indexToStore(*PrimaryFilePath, Args, std::move(*Opts),
       CancellationToken,
       [Rec](const RequestResult<IndexStoreInfo> &Result) {
         if (Result.isCancelled())

utils/gyb_sourcekit_support/UIDs.py

@@ -216,6 +216,11 @@ def __init__(self, internal_name, external_name):
     KEY('ExpandedMacroReplacements', 'key.expanded_macro_replacements'),
     KEY('IndexStorePath', 'key.index_store_path'),
     KEY('IndexUnitOutputPath', 'key.index_unit_output_path'),
+    KEY('IncludeLocals', 'key.include_locals'),
+    KEY('IgnoreClangModules', 'key.ignore_clang_modules'),
+    KEY('IncludeSystemModules', 'key.include_system_modules'),
+    KEY('IgnoreStdlib', 'key.ignore_stdlib'),
+    KEY('DisableImplicitModules', 'key.disable_implicit_modules'),
 ]