Share LocalSymbolsCache and options across plugins (#901)

Author: jupblb

semanticdb-javac/src/main/java/com/sourcegraph/semanticdb_javac/GlobalSymbolsCache.java

@@ -1,5 +1,6 @@
 package com.sourcegraph.semanticdb_javac;
 
+import com.sourcegraph.semanticdb.LocalSymbolsCache;
 import com.sourcegraph.semanticdb.SemanticdbSymbols;
 
 import javax.lang.model.element.Element;
@@ -25,7 +26,7 @@ public GlobalSymbolsCache(SemanticdbJavacOptions options) {
     this.options = options;
   }
 
-  public String semanticdbSymbol(Element sym, LocalSymbolsCache locals) {
+  public String semanticdbSymbol(Element sym, LocalSymbolsCache<Element, String> locals) {
     String result = globals.get(sym);
     if (result != null) return result;
     String localResult = locals.get(sym);
@@ -37,7 +38,7 @@ public String semanticdbSymbol(Element sym, LocalSymbolsCache locals) {
     return result;
   }
 
-  private String uncachedSemanticdbSymbol(Element sym, LocalSymbolsCache locals) {
+  private String uncachedSemanticdbSymbol(Element sym, LocalSymbolsCache<Element, String> locals) {
     if (sym == null) return SemanticdbSymbols.ROOT_PACKAGE;
 
     if (sym instanceof PackageElement) {

semanticdb-javac/src/main/java/com/sourcegraph/semanticdb_javac/LocalSymbolsCache.java

@@ -1,5 +1,9 @@
 package com.sourcegraph.semanticdb_javac;
 
+import com.sourcegraph.semanticdb.NoRelativePathMode;
+import com.sourcegraph.semanticdb.SemanticdbOptions;
+import com.sourcegraph.semanticdb.UriScheme;
+
 import java.io.ByteArrayOutputStream;
 import java.io.PrintStream;
 import java.lang.reflect.Method;
@@ -16,24 +20,13 @@
 import static javax.tools.StandardLocation.SOURCE_OUTPUT;
 
 /** Settings that can be configured alongside the -Xplugin compiler option. */
-public class SemanticdbJavacOptions {
-
-  /** The directory to place META-INF and its .semanticdb files */
-  public Path targetroot;
+public class SemanticdbJavacOptions extends SemanticdbOptions {
 
-  public Path sourceroot;
-  public boolean includeText = false;
   public boolean verboseEnabled = false;
-  public final ArrayList<String> errors;
+  public final ArrayList<String> errors = new ArrayList<>();
   public boolean alreadyReportedErrors = false;
-  public UriScheme uriScheme = UriScheme.DEFAULT;
-  public NoRelativePathMode noRelativePath = NoRelativePathMode.INDEX_ANYWAY;
   public Path generatedTargetRoot;
 
-  public SemanticdbJavacOptions() {
-    errors = new ArrayList<>();
-  }
-
   public static String missingRequiredDirectoryOption(String option) {
     return String.format(
         "missing argument '-%s'. To fix this problem, update the Java compiler option "

semanticdb-javac/src/main/java/com/sourcegraph/semanticdb_javac/SemanticdbJavacOptions.java

@@ -1,5 +1,6 @@
 package com.sourcegraph.semanticdb_javac;
 
+import com.sourcegraph.semanticdb.LocalSymbolsCache;
 import com.sourcegraph.semanticdb.Semanticdb;
 
 import com.sourcegraph.semanticdb.Semanticdb.*;
@@ -20,10 +21,11 @@
 
 public final class SemanticdbSignatures {
   private final GlobalSymbolsCache cache;
-  private final LocalSymbolsCache locals;
+  private final LocalSymbolsCache<Element, String> locals;
   private final Types types;
 
-  public SemanticdbSignatures(GlobalSymbolsCache cache, LocalSymbolsCache locals, Types types) {
+  public SemanticdbSignatures(
+      GlobalSymbolsCache cache, LocalSymbolsCache<Element, String> locals, Types types) {
     this.cache = cache;
     this.locals = locals;
     this.types = types;

semanticdb-javac/src/main/java/com/sourcegraph/semanticdb_javac/SemanticdbSignatures.java

@@ -1,9 +1,13 @@
 package com.sourcegraph.semanticdb_javac;
 
+import com.sourcegraph.semanticdb.LocalSymbolsCache;
+import com.sourcegraph.semanticdb.NoRelativePathMode;
 import com.sourcegraph.semanticdb.Semanticdb;
 import com.sourcegraph.semanticdb.SemanticdbDocumentBuilder;
 import com.sourcegraph.semanticdb.SemanticdbPaths;
+import com.sourcegraph.semanticdb.SemanticdbSymbols;
 import com.sourcegraph.semanticdb.SemanticdbWriter;
+import com.sourcegraph.semanticdb.UriScheme;
 
 import com.sun.source.util.JavacTask;
 import com.sun.source.util.TaskEvent;
@@ -12,6 +16,7 @@
 import javax.lang.model.util.Elements;
 import javax.lang.model.util.Types;
 
+import javax.lang.model.element.Element;
 import javax.tools.JavaFileObject;
 import java.io.ByteArrayOutputStream;
 import java.io.IOException;
@@ -21,6 +26,7 @@
 import java.nio.file.Path;
 import java.nio.file.Paths;
 import java.util.HashMap;
+import java.util.IdentityHashMap;
 import java.util.Map;
 import java.util.Optional;
 
@@ -152,7 +158,8 @@ private void writeSemanticdb(TaskEvent event, Path output, Semanticdb.TextDocume
 
   private static final class PerSourceState {
     final SemanticdbDocumentBuilder documentBuilder = new SemanticdbDocumentBuilder();
-    final LocalSymbolsCache locals = new LocalSymbolsCache();
+    final LocalSymbolsCache<Element, String> locals =
+        new LocalSymbolsCache<>(new IdentityHashMap<>(), SemanticdbSymbols::local);
   }
 
   public static Path absolutePathFromUri(SemanticdbJavacOptions options, JavaFileObject file) {

semanticdb-javac/src/main/java/com/sourcegraph/semanticdb_javac/SemanticdbTaskListener.java

@@ -1,5 +1,6 @@
 package com.sourcegraph.semanticdb_javac;
 
+import com.sourcegraph.semanticdb.LocalSymbolsCache;
 import com.sourcegraph.semanticdb.Semanticdb;
 
 import com.sun.source.tree.*;
@@ -22,7 +23,7 @@
 public class SemanticdbTrees {
   public SemanticdbTrees(
       GlobalSymbolsCache globals,
-      LocalSymbolsCache locals,
+      LocalSymbolsCache<Element, String> locals,
       String semanticdbUri,
       Types types,
       Trees trees,
@@ -37,7 +38,7 @@ public SemanticdbTrees(
   }
 
   private final GlobalSymbolsCache globals;
-  private final LocalSymbolsCache locals;
+  private final LocalSymbolsCache<Element, String> locals;
   private final String semanticdbUri;
   private final Types types;
   private final Trees trees;

semanticdb-javac/src/main/java/com/sourcegraph/semanticdb_javac/SemanticdbTrees.java

@@ -1,5 +1,6 @@
 package com.sourcegraph.semanticdb_javac;
 
+import com.sourcegraph.semanticdb.LocalSymbolsCache;
 import com.sourcegraph.semanticdb.Semanticdb;
 
 import javax.lang.model.element.Element;
@@ -25,10 +26,11 @@ class SemanticdbTypeVisitor extends SimpleTypeVisitor8<Semanticdb.Type, Void> {
   static final String ARRAY_SYMBOL = "scala/Array#";
 
   private final GlobalSymbolsCache cache;
-  private final LocalSymbolsCache locals;
+  private final LocalSymbolsCache<Element, String> locals;
   private final Types types;
 
-  SemanticdbTypeVisitor(GlobalSymbolsCache cache, LocalSymbolsCache locals, Types types) {
+  SemanticdbTypeVisitor(
+      GlobalSymbolsCache cache, LocalSymbolsCache<Element, String> locals, Types types) {
     this.cache = cache;
     this.locals = locals;
     this.types = types;

semanticdb-javac/src/main/java/com/sourcegraph/semanticdb_javac/SemanticdbTypeVisitor.java

@@ -1,5 +1,6 @@
 package com.sourcegraph.semanticdb_javac;
 
+import com.sourcegraph.semanticdb.LocalSymbolsCache;
 import com.sourcegraph.semanticdb.Semanticdb;
 
 import com.sourcegraph.semanticdb.SemanticdbDocumentBuilder;
@@ -64,7 +65,7 @@
 public class SemanticdbVisitor extends TreePathScanner<Void, Void> {
 
   private final GlobalSymbolsCache globals;
-  private final LocalSymbolsCache locals;
+  private final LocalSymbolsCache<Element, String> locals;
   private final Types types;
   private final Trees trees;
   private final CompilationUnitTree compUnitTree;
@@ -78,7 +79,7 @@ public class SemanticdbVisitor extends TreePathScanner<Void, Void> {
 
   public SemanticdbVisitor(
       GlobalSymbolsCache globals,
-      LocalSymbolsCache locals,
+      LocalSymbolsCache<Element, String> locals,
       CompilationUnitTree compUnitTree,
       SemanticdbJavacOptions options,
       Types types,

semanticdb-javac/src/main/java/com/sourcegraph/semanticdb_javac/SemanticdbVisitor.java

@@ -1,13 +1,13 @@
 package com.sourcegraph.semanticdb_kotlinc
 
-import java.nio.file.Path
+import com.sourcegraph.semanticdb.SemanticdbOptions
 import org.jetbrains.kotlin.fir.extensions.FirExtensionRegistrar
 
 class AnalyzerFirExtensionRegistrar(
-    private val sourceroot: Path,
+    private val options: SemanticdbOptions,
 ) : FirExtensionRegistrar() {
     override fun ExtensionRegistrarContext.configurePlugin() {
-        +AnalyzerParamsProvider.getFactory(sourceroot)
+        +AnalyzerParamsProvider.getFactory(options)
         +::AnalyzerCheckers
     }
 }

semanticdb-kotlinc/src/main/kotlin/com/sourcegraph/semanticdb_kotlinc/AnalyzerFirExtensionRegistrar.kt

@@ -1,17 +1,20 @@
 package com.sourcegraph.semanticdb_kotlinc
 
+import com.sourcegraph.semanticdb.SemanticdbOptions
 import java.nio.file.Path
 import org.jetbrains.kotlin.fir.FirSession
 import org.jetbrains.kotlin.fir.extensions.FirExtensionSessionComponent
 import org.jetbrains.kotlin.fir.extensions.FirExtensionSessionComponent.Factory
 
 open class AnalyzerParamsProvider(
     session: FirSession,
-    val sourceroot: Path,
+    val options: SemanticdbOptions,
 ) : FirExtensionSessionComponent(session) {
+    val sourceroot: Path get() = options.sourceroot
+
     companion object {
-        fun getFactory(sourceroot: Path): Factory {
-            return Factory { AnalyzerParamsProvider(it, sourceroot) }
+        fun getFactory(options: SemanticdbOptions): Factory {
+            return Factory { AnalyzerParamsProvider(it, options) }
         }
     }
 }