Drop dead helpers, inline one-call wrappers, prefer LinkedHashSet

Author: jupblb

scip-semanticdb/src/main/java/com/sourcegraph/scip_semanticdb/ScipShardAggregator.java

@@ -21,6 +21,7 @@
 import java.util.Collections;
 import java.util.Enumeration;
 import java.util.LinkedHashMap;
+import java.util.LinkedHashSet;
 import java.util.List;
 import java.util.Map;
 import java.util.jar.JarEntry;
@@ -219,10 +220,9 @@ public int hashCode() {
 
   private static SymbolInformation mergeSymbol(SymbolInformation a, SymbolInformation b) {
     SymbolInformation.Builder builder = b.toBuilder();
-    LinkedHashMap<Relationship, Relationship> rels = new LinkedHashMap<>();
-    for (Relationship r : a.getRelationshipsList()) rels.put(r, r);
-    for (Relationship r : b.getRelationshipsList()) rels.put(r, r);
-    builder.clearRelationships().addAllRelationships(rels.values());
+    LinkedHashSet<Relationship> rels = new LinkedHashSet<>(a.getRelationshipsList());
+    rels.addAll(b.getRelationshipsList());
+    builder.clearRelationships().addAllRelationships(rels);
     return builder.build();
   }
 

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

@@ -12,7 +12,9 @@
 import java.nio.file.Path;
 import java.util.ArrayList;
 import java.util.LinkedHashMap;
+import java.util.LinkedHashSet;
 import java.util.List;
+import java.util.Map;
 
 /**
  * Writes and merges per-source SCIP shards produced by the compiler plugin.
@@ -90,7 +92,7 @@ private static Document mergeDocuments(Document a, Document b) {
     builder.addAllOccurrences(occurrences.values());
 
     // Deduplicate symbols by symbol string; merge relationships and documentation.
-    LinkedHashMap<String, SymbolInformation> bySymbol = new LinkedHashMap<>();
+    Map<String, SymbolInformation> bySymbol = new LinkedHashMap<>();
     for (SymbolInformation info : a.getSymbolsList()) bySymbol.put(info.getSymbol(), info);
     for (SymbolInformation info : b.getSymbolsList()) {
       SymbolInformation existing = bySymbol.get(info.getSymbol());
@@ -104,10 +106,9 @@ private static Document mergeDocuments(Document a, Document b) {
   private static SymbolInformation mergeSymbol(SymbolInformation a, SymbolInformation b) {
     SymbolInformation.Builder builder = b.toBuilder();
     // Merge relationships, deduplicating by structural equality with deterministic ordering.
-    LinkedHashMap<Relationship, Relationship> rels = new LinkedHashMap<>();
-    for (Relationship r : a.getRelationshipsList()) rels.put(r, r);
-    for (Relationship r : b.getRelationshipsList()) rels.put(r, r);
-    builder.clearRelationships().addAllRelationships(rels.values());
+    LinkedHashSet<Relationship> rels = new LinkedHashSet<>(a.getRelationshipsList());
+    rels.addAll(b.getRelationshipsList());
+    builder.clearRelationships().addAllRelationships(rels);
 
     // Merge documentation, preserving order and avoiding duplicates.
     List<String> docs = new ArrayList<>(a.getDocumentationList());

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

@@ -93,9 +93,9 @@ public ScipVisitor(
     this.nodes = new LinkedHashMap<>();
   }
 
-  /** Builds a single-document {@link Index} shard for the given compilation unit. */
-  public Index buildShard(CompilationUnitTree tree) {
-    this.scan(tree, null);
+  /** Builds a single-document {@link Index} shard for this compilation unit. */
+  public Index buildShard() {
+    this.scan(compUnitTree, null);
     resolveNodes();
 
     Document.Builder document =

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

@@ -113,7 +113,7 @@ private void onFinishedAnalyze(TaskEvent e) {
     try {
       Index shard =
           new ScipVisitor(globals, e.getCompilationUnit(), options, types, trees, elements)
-              .buildShard(e.getCompilationUnit());
+              .buildShard();
       ScipShardWriter.writeOrMerge(shardPath, shard);
     } catch (IOException ex) {
       this.reportException(ex, e);

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

@@ -29,8 +29,9 @@ class PostAnalysisExtension(
         try {
             for ((ktSourceFile, visitor) in AnalyzerCheckers.visitors) {
                 try {
-                    scipShardOutPathForFile(ktSourceFile)?.apply {
-                        ScipShardWriter.write(this, visitor.buildScipIndex())
+                    scipShardOutPathForFile(ktSourceFile)?.let { outPath ->
+                        Files.createDirectories(outPath.parent)
+                        Files.write(outPath, visitor.buildScipIndex().toByteArray())
                     }
                 } catch (e: Exception) {
                     handleException(e)
@@ -46,15 +47,11 @@ class PostAnalysisExtension(
         if (normalizedPath.startsWith(sourceRoot)) {
             val relative = sourceRoot.relativize(normalizedPath)
             val filename = relative.fileName.toString() + ".scip"
-            val outPath =
-                targetRoot
-                    .resolve("META-INF")
-                    .resolve("scip")
-                    .resolve(relative)
-                    .resolveSibling(filename)
-
-            Files.createDirectories(outPath.parent)
-            return outPath
+            return targetRoot
+                .resolve("META-INF")
+                .resolve("scip")
+                .resolve(relative)
+                .resolveSibling(filename)
         }
         System.err.println(
             "given file is not under the sourceroot.\n\tSourceroot: $sourceRoot\n\tFile path: ${file.path}\n\tNormalized file path: $normalizedPath")

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

@@ -25,11 +25,6 @@ internal class ScipOccurrences {
         }
     }
 
-    /** Adds every occurrence in [occs]. */
-    fun addAll(occs: Iterable<Occurrence>) {
-        for (occ in occs) add(occ)
-    }
-
     /** Returns the deduplicated occurrences in insertion order. */
     fun values(): Collection<Occurrence> = out.values
 

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

@@ -1,22 +1,40 @@
 package com.sourcegraph.semanticdb_kotlinc
 
 /**
- * Converts SemanticDB-style symbol strings into the placeholder SCIP form expected by the
- * aggregator: globals are prefixed with [PLACEHOLDER_PREFIX] (rewritten to
- * `scip-java maven <g> <a> <v> <descriptor>` once coordinates are known), locals use the canonical
- * `local N` form and pass through unchanged. Mirrors the Java `ScipSymbols` helper.
+ * Helpers for emitting SCIP symbol strings from the Kotlin compiler plug-in.
+ *
+ * Mirrors the Java `ScipSymbols` helper. Because the compiler plug-in does not know the final
+ * Maven coordinates (`groupId:artifactId:version`) at compile time, it emits global symbols using
+ * a sentinel placeholder scheme that is rewritten by the aggregator to its final form:
+ *
+ *   `. . . . ` + <semanticdb-style descriptor path>
+ *      ->  "scip-java maven <groupId> <artifactId> <version> <descriptor path>"
+ *
+ * Local symbols are emitted using the canonical SCIP `local N` form (with the space) and are NOT
+ * rewritten by the aggregator.
  */
 object ScipSymbols {
 
+    /**
+     * Prefix marking a global symbol whose package coordinates must be filled in by the aggregator.
+     * The trailing space matches the SCIP grammar requirement of separating the scheme from the
+     * package fields.
+     */
     const val PLACEHOLDER_PREFIX: String = ". . . . "
 
-    fun fromSemanticdbSymbol(symbol: String?): String {
-        if (symbol.isNullOrEmpty()) return ""
-        if (symbol.startsWith("local")) {
-            return "local " + symbol.substring("local".length)
+    /**
+     * Converts a SemanticDB-style [Symbol] into the SCIP symbol form expected by the aggregator.
+     *
+     *   - [Symbol.NONE] becomes the empty string.
+     *   - Local symbols of the form `local42` become `local 42`.
+     *   - Everything else is prefixed with [PLACEHOLDER_PREFIX].
+     */
+    fun fromSemanticdbSymbol(symbol: Symbol): String {
+        if (symbol == Symbol.NONE) return ""
+        val raw = symbol.toString()
+        if (symbol.isLocal()) {
+            return "local " + raw.substring("local".length)
         }
-        return PLACEHOLDER_PREFIX + symbol
+        return PLACEHOLDER_PREFIX + raw
     }
-
-    fun fromSemanticdbSymbol(symbol: Symbol): String = fromSemanticdbSymbol(symbol.toString())
 }

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

@@ -9,7 +9,6 @@ import org.scip_code.scip.SymbolInformation
 import org.scip_code.scip.SymbolRole
 import kotlin.contracts.ExperimentalContracts
 import org.jetbrains.kotlin.KtSourceElement
-import org.jetbrains.kotlin.KtSourceFile
 import org.jetbrains.kotlin.fir.analysis.checkers.context.CheckerContext
 import org.jetbrains.kotlin.fir.analysis.checkers.directOverriddenSymbolsSafe
 import org.jetbrains.kotlin.fir.analysis.checkers.toClassLikeSymbol
@@ -35,7 +34,6 @@ import org.jetbrains.kotlin.text
  */
 @ExperimentalContracts
 class ScipTextDocumentBuilder(
-    private val file: KtSourceFile,
     private val lineMap: LineMap,
     private val cache: SymbolsCache,
     private val relativePath: String,
@@ -105,12 +103,6 @@ class ScipTextDocumentBuilder(
                 .setDisplayName(displayName(firBasedSymbol, element))
                 .setKind(scipKind(firBasedSymbol))
 
-        if (symbol.isLocal()) {
-            // Locals are convenient to navigate from when the enclosing symbol is known.
-            // We don't have direct access to the enclosing FirBasedSymbol here, but the
-            // information is non-essential — leaving enclosing_symbol unset is fine.
-        }
-
         val signature = signatureText(firBasedSymbol)
         if (signature.isNotEmpty()) {
             builder.setSignatureDocumentation(

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

@@ -30,7 +30,7 @@ class SemanticdbVisitor(
 ) {
     private val cache = SymbolsCache(globals, locals)
     private val relativePath: String = computeRelativePath(sourceroot, file)
-    private val scipBuilder = ScipTextDocumentBuilder(file, lineMap, cache, relativePath)
+    private val scipBuilder = ScipTextDocumentBuilder(lineMap, cache, relativePath)
 
     private data class SymbolDescriptorPair(
         val firBasedSymbol: FirBasedSymbol<*>?,
@@ -39,19 +39,16 @@ class SemanticdbVisitor(
 
     fun buildScipIndex(): Index = scipBuilder.buildIndex()
 
-    fun scipRelativePath(): String = relativePath
-
     private fun Sequence<SymbolDescriptorPair>?.emitAll(
         element: KtSourceElement,
         roles: Int,
         context: CheckerContext,
         enclosingSource: KtSourceElement? = null,
-    ): List<Symbol>? =
-        this?.onEach { (firBasedSymbol, symbol) ->
-                scipBuilder.emitScipData(firBasedSymbol, symbol, element, roles, context, enclosingSource)
-            }
-            ?.map { it.symbol }
-            ?.toList()
+    ) {
+        this?.forEach { (firBasedSymbol, symbol) ->
+            scipBuilder.emitScipData(firBasedSymbol, symbol, element, roles, context, enclosingSource)
+        }
+    }
 
     private fun Sequence<Symbol>.with(firBasedSymbol: FirBasedSymbol<*>?) =
         this.map { SymbolDescriptorPair(firBasedSymbol, it) }