Skip to content

Commit abf6fcd

Browse files
CatherineGasnierCatherine Gasnierjupblb
authored
Index SCIP field enclosing_range (#838)
--------- Co-authored-by: Catherine Gasnier <catg@meta.com> Co-authored-by: jupblb <michal.kielbowicz@sourcegraph.com>
1 parent 32bc736 commit abf6fcd

140 files changed

Lines changed: 83428 additions & 82802 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎scip-java/src/main/scala/com/sourcegraph/scip_java/ScipPrinters.scala‎

Lines changed: 67 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,12 @@ import moped.reporters.Position
1212

1313
object ScipPrinters {
1414

15+
/**
16+
* Indent prefix prepended to each source line so that caret-based indicators
17+
* in snapshot comments can point at arbitrary columns.
18+
*/
19+
val sourceIndent = " "
20+
1521
def printTextDocument(
1622
doc: Scip.Document,
1723
text: String,
@@ -51,11 +57,58 @@ object ScipPrinters {
5157
val extension = doc.getRelativePath.split("\\.").lastOption.getOrElse("")
5258
val commentSyntax = comments.extensionSyntax(extension)
5359
val input = Input.filename(doc.getRelativePath, text)
60+
61+
// Collect enclosing ranges from all occurrences, grouped by start/end line.
62+
case class EnclosingRange(
63+
startLine: Int,
64+
startChar: Int,
65+
endLine: Int,
66+
endChar: Int,
67+
symbol: String
68+
)
69+
val allEnclosingRanges =
70+
doc
71+
.getOccurrencesList
72+
.asScala
73+
.flatMap { occ =>
74+
occ.getEnclosingRangeList.asScala.map(_.toInt).toList match {
75+
case List(sl, sc, ec) =>
76+
Some(EnclosingRange(sl, sc, sl, ec, occ.getSymbol))
77+
case List(sl, sc, el, ec) =>
78+
Some(EnclosingRange(sl, sc, el, ec, occ.getSymbol))
79+
case _ =>
80+
None
81+
}
82+
}
83+
.toList
84+
val enclosingByStartLine =
85+
allEnclosingRanges
86+
.groupBy(_.startLine)
87+
.view
88+
.mapValues(_.sortBy(_.startChar))
89+
.toMap
90+
val enclosingByEndLine =
91+
allEnclosingRanges
92+
.groupBy(_.endLine)
93+
.view
94+
.mapValues(_.sortBy(_.endChar))
95+
.toMap
96+
5497
text
5598
.linesWithSeparators
5699
.zipWithIndex
57100
.foreach { case (line, i) =>
58-
out.append(line.replace("\t", "→"))
101+
enclosingByStartLine
102+
.getOrElse(i, Nil)
103+
.foreach { er =>
104+
out
105+
.append(commentSyntax)
106+
.append(" " * er.startChar)
107+
.append("⌄ enclosing_range_start ")
108+
.append(er.symbol)
109+
.append("\n")
110+
}
111+
out.append(sourceIndent).append(line.replace("\t", " "))
59112
val occurrences = occurrencesByLine
60113
.getOrElse(i, Nil)
61114
.toSeq
@@ -80,6 +133,17 @@ object ScipPrinters {
80133
}
81134
}
82135
}
136+
enclosingByEndLine
137+
.getOrElse(i, Nil)
138+
.foreach { er =>
139+
val indent = math.max(0, er.endChar - 1)
140+
out
141+
.append(commentSyntax)
142+
.append(" " * indent)
143+
.append("⌃ enclosing_range_end ")
144+
.append(er.symbol)
145+
.append("\n")
146+
}
83147
}
84148
out.toString()
85149
}
@@ -133,8 +197,8 @@ object ScipPrinters {
133197
else
134198
"reference"
135199
val indent =
136-
if (pos.startColumn > comment.length)
137-
" " * (pos.startColumn - comment.length)
200+
if (pos.startColumn + sourceIndent.length > comment.length)
201+
" " * (pos.startColumn + sourceIndent.length - comment.length)
138202
else
139203
""
140204
val caretCharacter =

‎scip-semanticdb/src/main/java/com/sourcegraph/scip_semanticdb/ScipSemanticdb.java‎

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -179,11 +179,30 @@ private void processTypedDocument(
179179
occ.getRange().getEndLine(),
180180
occ.getRange().getEndCharacter());
181181
Package pkg = packages.packageForSymbol(occ.getSymbol()).orElse(Package.EMPTY);
182-
tdoc.addOccurrences(
182+
Scip.Occurrence.Builder occBuilder =
183183
Scip.Occurrence.newBuilder()
184184
.addAllRange(range)
185185
.setSymbol(typedSymbol(occ.getSymbol(), pkg))
186-
.setSymbolRoles(role));
186+
.setSymbolRoles(role);
187+
// Add enclosing_range if it exists
188+
if (occ.hasEnclosingRange()) {
189+
Semanticdb.Range enclosingRange = occ.getEnclosingRange();
190+
boolean isEnclosingSingleLine =
191+
enclosingRange.getStartLine() == enclosingRange.getEndLine();
192+
Iterable<Integer> enclosingRangeInts =
193+
isEnclosingSingleLine
194+
? Arrays.asList(
195+
enclosingRange.getStartLine(),
196+
enclosingRange.getStartCharacter(),
197+
enclosingRange.getEndCharacter())
198+
: Arrays.asList(
199+
enclosingRange.getStartLine(),
200+
enclosingRange.getStartCharacter(),
201+
enclosingRange.getEndLine(),
202+
enclosingRange.getEndCharacter());
203+
occBuilder.addAllEnclosingRange(enclosingRangeInts);
204+
}
205+
tdoc.addOccurrences(occBuilder);
187206
}
188207
Symtab symtab = new Symtab(doc.semanticdb);
189208
for (SymbolInformation info : doc.semanticdb.getSymbolsList()) {

‎semanticdb-java/src/main/java/com/sourcegraph/semanticdb_javac/SemanticdbBuilders.java‎

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -52,12 +52,14 @@ public static Semanticdb.Signature signature(Semanticdb.TypeSignature.Builder si
5252
// SemanticDB Symbols
5353

5454
public static Semanticdb.SymbolOccurrence symbolOccurrence(
55-
String symbol, Semanticdb.Range range, Semanticdb.SymbolOccurrence.Role role) {
56-
return Semanticdb.SymbolOccurrence.newBuilder()
57-
.setSymbol(symbol)
58-
.setRange(range)
59-
.setRole(role)
60-
.build();
55+
String symbol,
56+
Semanticdb.Range range,
57+
Semanticdb.SymbolOccurrence.Role role,
58+
java.util.Optional<Semanticdb.Range> enclosingRange) {
59+
Semanticdb.SymbolOccurrence.Builder builder =
60+
Semanticdb.SymbolOccurrence.newBuilder().setSymbol(symbol).setRange(range).setRole(role);
61+
enclosingRange.ifPresent(builder::setEnclosingRange);
62+
return builder.build();
6163
}
6264

6365
public static Semanticdb.SymbolInformation.Builder symbolInformation(String symbol) {

‎semanticdb-java/src/main/protobuf/semanticdb.proto‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -182,6 +182,10 @@ message SymbolOccurrence {
182182
Range range = 1;
183183
string symbol = 2;
184184
Role role = 3;
185+
// NOTE: this field does not exist in the upstream SemanticDB spec.
186+
// It is added to support SCIP's enclosing_range field.
187+
// This is the range of the nearest non-trivial enclosing AST node.
188+
optional Range enclosing_range = 4;
185189
}
186190

187191
message Scope {

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

Lines changed: 62 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -110,17 +110,24 @@ private Optional<Semanticdb.Range> emitSymbolOccurrence(
110110
Element sym, Tree tree, Name name, Role role, CompilerRange kind) {
111111
if (sym == null || name == null) return Optional.empty();
112112
Optional<Semanticdb.Range> range = semanticdbRange(tree, kind, sym, name.toString());
113-
emitSymbolOccurrence(sym, range, role);
114113
if (role == Role.DEFINITION) {
114+
emitSymbolOccurrence(sym, range, role, computeEnclosingRange(tree));
115115
// Only emit SymbolInformation for symbols that are defined in this compilation unit.
116116
emitSymbolInformation(sym, tree);
117+
return range;
117118
}
119+
emitSymbolOccurrence(sym, range, role, Optional.empty());
118120
return range;
119121
}
120122

121-
private void emitSymbolOccurrence(Element sym, Optional<Semanticdb.Range> range, Role role) {
123+
private void emitSymbolOccurrence(
124+
Element sym,
125+
Optional<Semanticdb.Range> range,
126+
Role role,
127+
Optional<Semanticdb.Range> enclosingRange) {
122128
if (sym == null) return;
123-
Optional<Semanticdb.SymbolOccurrence> occ = semanticdbOccurrence(sym, range, role);
129+
Optional<Semanticdb.SymbolOccurrence> occ =
130+
semanticdbOccurrence(sym, range, role, enclosingRange);
124131
occ.ifPresent(occurrences::add);
125132
}
126133

@@ -298,7 +305,7 @@ private void resolveVariableTree(VariableTree node, TreePath treePath) {
298305
if (sym.getKind() == ElementKind.ENUM_CONSTANT) {
299306
TreePath typeTreePath = nodes.get(node.getInitializer());
300307
Element typeSym = trees.getElement(typeTreePath);
301-
if (typeSym != null) emitSymbolOccurrence(typeSym, range, Role.REFERENCE);
308+
if (typeSym != null) emitSymbolOccurrence(typeSym, range, Role.REFERENCE, Optional.empty());
302309
}
303310
}
304311
}
@@ -462,11 +469,14 @@ private Semanticdb.Range correctForTabs(Semanticdb.Range range, LineMap lineMap,
462469
}
463470

464471
private Optional<Semanticdb.SymbolOccurrence> semanticdbOccurrence(
465-
Element sym, Optional<Semanticdb.Range> range, Role role) {
472+
Element sym,
473+
Optional<Semanticdb.Range> range,
474+
Role role,
475+
Optional<Semanticdb.Range> enclosingRange) {
466476
if (range.isPresent()) {
467477
String ssym = semanticdbSymbol(sym);
468478
if (!ssym.equals(SemanticdbSymbols.NONE)) {
469-
Semanticdb.SymbolOccurrence occ = symbolOccurrence(ssym, range.get(), role);
479+
Semanticdb.SymbolOccurrence occ = symbolOccurrence(ssym, range.get(), role, enclosingRange);
470480
return Optional.of(occ);
471481
} else {
472482
return Optional.empty();
@@ -476,6 +486,52 @@ private Optional<Semanticdb.SymbolOccurrence> semanticdbOccurrence(
476486
}
477487
}
478488

489+
/**
490+
* Computes the enclosing range for the given tree node. Returns the range of the nearest
491+
* non-trivial enclosing AST node. For definition occurrences, this includes the entire definition
492+
* including documentation. For reference occurrences, this includes the parent expression bounds.
493+
*/
494+
private Optional<Semanticdb.Range> computeEnclosingRange(Tree tree) {
495+
if (tree == null) return Optional.empty();
496+
497+
TreePath path = nodes.get(tree);
498+
if (path == null) return Optional.empty();
499+
500+
// For method, class, and variable definitions, use the tree itself as the enclosing range
501+
// since we're processing the definition node
502+
Tree enclosingTree = tree;
503+
if (!(tree instanceof MethodTree
504+
|| tree instanceof ClassTree
505+
|| tree instanceof VariableTree)) {
506+
// For non-definition nodes (like references), use the parent
507+
TreePath parentPath = path.getParentPath();
508+
if (parentPath == null) return Optional.empty();
509+
enclosingTree = parentPath.getLeaf();
510+
if (enclosingTree == null || enclosingTree == compUnitTree) return Optional.empty();
511+
}
512+
513+
SourcePositions sourcePositions = trees.getSourcePositions();
514+
int start = (int) sourcePositions.getStartPosition(compUnitTree, enclosingTree);
515+
int end = (int) sourcePositions.getEndPosition(compUnitTree, enclosingTree);
516+
517+
if (start != Diagnostic.NOPOS && end != Diagnostic.NOPOS && end > start) {
518+
LineMap lineMap = compUnitTree.getLineMap();
519+
Semanticdb.Range range =
520+
Semanticdb.Range.newBuilder()
521+
.setStartLine((int) lineMap.getLineNumber(start) - 1)
522+
.setStartCharacter((int) lineMap.getColumnNumber(start) - 1)
523+
.setEndLine((int) lineMap.getLineNumber(end) - 1)
524+
.setEndCharacter((int) lineMap.getColumnNumber(end) - 1)
525+
.build();
526+
527+
range = correctForTabs(range, lineMap, start);
528+
529+
return Optional.of(range);
530+
}
531+
532+
return Optional.empty();
533+
}
534+
479535
private String semanticdbText() {
480536
if (source != null) return source;
481537
try {

‎tests/minimized/src/main/java/minimized/AnnotationParameters.java‎

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,41 @@
11
package minimized;
22

33
@interface Bar {
4-
double value();
4+
double value();
55
}
66

77
@interface BarB {
8-
boolean value();
8+
boolean value();
99
}
1010

1111
@interface Nullable {
12-
String value() default "";
12+
String value() default "";
1313
}
1414

1515

1616
@interface BarRef{
17-
SuppressWarnings value();
17+
SuppressWarnings value();
1818
}
1919

2020
interface Foo {
21-
@Bar(-1d)
22-
double test();
21+
@Bar(-1d)
22+
double test();
2323

24-
@Bar(~5)
25-
@SuppressWarnings(value = "unchecked")
26-
double test2();
24+
@Bar(~5)
25+
@SuppressWarnings(value = "unchecked")
26+
double test2();
2727

28-
@BarB(!true)
29-
double test3();
28+
@BarB(!true)
29+
double test3();
3030

31-
@Nullable(("what"))
32-
Foo test4();
31+
@Nullable(("what"))
32+
Foo test4();
3333

34-
@Bar((double) -1)
35-
double testCast();
34+
@Bar((double) -1)
35+
double testCast();
3636
}
3737

3838
interface TestRef {
39-
@BarRef(@SuppressWarnings(value = "unchecked"))
40-
abstract double testCase();
39+
@BarRef(@SuppressWarnings(value = "unchecked"))
40+
abstract double testCase();
4141
}

‎tests/minimized/src/main/java/minimized/LombokBuilder.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,5 @@
22

33
@lombok.Builder
44
class Hello {
5-
private String message;
5+
private String message;
66
}

‎tests/minimized/src/main/java/minimized/TabIndented.java‎

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,22 @@
11
package minimized;
22

33
public class TabIndented {
4-
public void app() {
5-
Object o = new Object() {
6-
@Override
7-
public boolean equals(Object other) {
8-
return false;
9-
}
4+
public void app() {
5+
Object o = new Object() {
6+
@Override
7+
public boolean equals(Object other) {
8+
return false;
9+
}
1010

11-
@Override
12-
public int hashCode() {
13-
return System.identityHashCode(this);
14-
}
11+
@Override
12+
public int hashCode() {
13+
return System.identityHashCode(this);
14+
}
1515

16-
@Override
17-
public String toString() {
18-
return "";
19-
}
20-
};
21-
}
16+
@Override
17+
public String toString() {
18+
return "";
19+
}
20+
};
21+
}
2222
}

0 commit comments

Comments
 (0)