implements PLN-0132
Intrepid/Prometeu/Studio/pipeline/pr-master Build started...
JaCoCo Coverage #### Project Overview No changes detected, that affect the code coverage. * Line Coverage: 62.51% (18192/29102) * Branch Coverage: 53.15% (7093/13345) * Lines of Code: 29102 * Cyclomatic Complexity: 11715 #### Quality Gates Summary Output truncated.
Test / Build skipped: 15, passed: 663

Add PBS find-references as the request-local inverse of definition
identity on FrontendLanguageService. Usage sites are identifier
tokens whose definition locations intersect the cursor set.
Empty results stay honest when definition is empty, including
virtual stdlib paths. Honor includeDeclaration in the LSP bridge.

Housekeep DSC-0040 with LSN-0069.
This commit is contained in:
2026-09-21 08:54:11 +01:00
parent 4b72b2a0dd
commit 9458312d73
21 changed files with 729 additions and 68 deletions
@@ -0,0 +1,16 @@
package p.studio.lsp.messages;
import java.util.List;
import java.util.Objects;
public record BaselineReferences(
List<BaselineDefinitionLocation> locations) {
public BaselineReferences {
locations = List.copyOf(Objects.requireNonNull(locations, "locations"));
}
public static BaselineReferences empty() {
return new BaselineReferences(List.of());
}
}
@@ -11,6 +11,7 @@ public record BaselineServerDescription(
boolean completionSupported,
boolean signatureHelpSupported,
boolean definitionSupported,
boolean referencesSupported,
List<String> semanticTokenTypes,
List<BaselineSemanticHostProjection> semanticHostProjections,
List<BaselineVisualTheme> visualThemes,
@@ -4,6 +4,7 @@ import p.studio.lsp.messages.BaselineDocumentAnalysis;
import p.studio.lsp.messages.BaselineCompletion;
import p.studio.lsp.messages.BaselineDefinition;
import p.studio.lsp.messages.BaselineHover;
import p.studio.lsp.messages.BaselineReferences;
import p.studio.lsp.messages.BaselineSemanticTokens;
import p.studio.lsp.messages.BaselineSignatureHelp;
import p.studio.lsp.messages.BaselineServerDescription;
@@ -20,6 +21,14 @@ public interface LanguageServiceBridge {
BaselineDefinition definition(LspProjectContext context, String documentUri, String text, int line, int character);
BaselineReferences references(
LspProjectContext context,
String documentUri,
String text,
int line,
int character,
boolean includeDeclaration);
BaselineSignatureHelp signatureHelp(LspProjectContext context, String documentUri, String text, int line, int character);
BaselineSemanticTokens semanticTokens(LspProjectContext context, String documentUri, String text);
@@ -53,6 +53,7 @@ public final class CompilerLanguageServiceBridge implements LanguageServiceBridg
true,
true,
frontendProvider(context).languageService().isPresent(),
frontendProvider(context).languageService().isPresent(),
presentation.semanticKeys(),
presentation.hostProjections().stream().map(this::mapSemanticHostProjection).toList(),
presentation.themes().stream().map(this::mapVisualTheme).toList(),
@@ -163,6 +164,50 @@ public final class CompilerLanguageServiceBridge implements LanguageServiceBridg
.orElseGet(BaselineDefinition::empty);
}
@Override
public BaselineReferences references(
final LspProjectContext context,
final String documentUri,
final String text,
final int line,
final int character,
final boolean includeDeclaration) {
Objects.requireNonNull(context, "context");
final var provider = frontendProvider(context);
final var languageService = provider.languageService();
if (languageService.isEmpty()) {
return BaselineReferences.empty();
}
return editorialDocument(context, documentUri, text)
.map(document -> {
final int offset = new DocumentPositionMapper(document.text()).byteOffsetOf(line, character);
final FrontendDocumentRequest request = new FrontendDocumentRequest(
context.projectRoot(),
normalizeDocumentPath(documentUri),
document.text());
final LinkedHashMap<String, FrontendDefinitionLocation> merged = new LinkedHashMap<>();
for (final FrontendDefinitionLocation location : languageService.orElseThrow().references(
request,
document.editorialContext(),
offset)) {
merged.putIfAbsent(frontendLocationKey(location), location);
}
if (includeDeclaration) {
for (final FrontendDefinitionLocation location : languageService.orElseThrow().definition(
request,
document.editorialContext(),
offset)) {
merged.putIfAbsent(frontendLocationKey(location), location);
}
}
return new BaselineReferences(mapDefinitionLocations(
List.copyOf(merged.values()),
request.documentPath(),
document.text()));
})
.orElseGet(BaselineReferences::empty);
}
@Override
public BaselineSignatureHelp signatureHelp(
final LspProjectContext context,
@@ -442,6 +487,10 @@ public final class CompilerLanguageServiceBridge implements LanguageServiceBridg
};
}
private static String frontendLocationKey(final FrontendDefinitionLocation location) {
return location.path() + ":" + location.startOffset() + ":" + location.endOffset();
}
private List<BaselineDefinitionLocation> mapDefinitionLocations(
final List<FrontendDefinitionLocation> locations,
final Path currentDocumentPath,
@@ -111,6 +111,22 @@ public final class PrometeuTextDocumentService implements TextDocumentService {
return CompletableFuture.completedFuture(Either.forLeft(locations));
}
@Override
public CompletableFuture<List<? extends Location>> references(final ReferenceParams params) {
final String uri = params.getTextDocument().getUri();
final String text = documentTextByUri.get(uri);
final boolean includeDeclaration = params.getContext() != null
&& Boolean.TRUE.equals(params.getContext().isIncludeDeclaration());
return CompletableFuture.completedFuture(protocolMessageMapper.mapReferences(
languageServiceBridge.references(
project,
uri,
text,
params.getPosition().getLine(),
params.getPosition().getCharacter(),
includeDeclaration)));
}
@Override
public CompletableFuture<SignatureHelp> signatureHelp(final SignatureHelpParams params) {
final String uri = params.getTextDocument().getUri();
@@ -37,6 +37,7 @@ public final class Lsp4jProtocolMessageMapper implements ProtocolMessageMapper {
capabilities.setSignatureHelpProvider(signatureHelpOptions);
}
capabilities.setDefinitionProvider(description.definitionSupported());
capabilities.setReferencesProvider(description.referencesSupported());
final SemanticTokensWithRegistrationOptions semanticTokens = new SemanticTokensWithRegistrationOptions();
semanticTokens.setLegend(new SemanticTokensLegend(description.semanticTokenTypes(), List.of()));
semanticTokens.setFull(true);
@@ -89,7 +90,19 @@ public final class Lsp4jProtocolMessageMapper implements ProtocolMessageMapper {
if (definition == null || definition.locations().isEmpty()) {
return List.of();
}
return definition.locations().stream()
return mapLocations(definition.locations());
}
@Override
public List<Location> mapReferences(final BaselineReferences references) {
if (references == null || references.locations().isEmpty()) {
return List.of();
}
return mapLocations(references.locations());
}
private List<Location> mapLocations(final List<BaselineDefinitionLocation> locations) {
return locations.stream()
.map(location -> new Location(
location.uri(),
new Range(
@@ -10,6 +10,7 @@ import org.eclipse.lsp4j.Location;
import p.studio.lsp.messages.BaselineDocumentAnalysis;
import p.studio.lsp.messages.BaselineCompletion;
import p.studio.lsp.messages.BaselineDefinition;
import p.studio.lsp.messages.BaselineReferences;
import p.studio.lsp.messages.BaselineHover;
import p.studio.lsp.messages.BaselineSemanticTokens;
import p.studio.lsp.messages.BaselineSignatureHelp;
@@ -29,6 +30,8 @@ public interface ProtocolMessageMapper {
List<Location> mapDefinition(BaselineDefinition definition);
List<Location> mapReferences(BaselineReferences references);
CompletionList mapCompletion(BaselineCompletion completion);
SignatureHelp mapSignatureHelp(BaselineSignatureHelp signatureHelp);
@@ -48,6 +48,9 @@ class CompilerLanguageServiceBridgeTest {
final var definition = bridge.definition(context, documentUri, "fn main() {}", 0, 0);
assertTrue(definition.locations().isEmpty());
final var references = bridge.references(context, documentUri, "fn main() {}", 0, 0, true);
assertTrue(references.locations().isEmpty());
final var semanticTokens = bridge.semanticTokens(context, documentUri, "fn main() {}");
assertTrue(semanticTokens.legend().isEmpty());
assertTrue(semanticTokens.tokens().isEmpty());
@@ -397,6 +400,80 @@ class CompilerLanguageServiceBridgeTest {
assertTrue(builtinDefinition.locations().isEmpty());
}
@Test
void referencesUsesDefinitionIdentityOnPhysicalFilesAndHonorsIncludeDeclaration() {
final Path projectRoot = findRepoRoot(Path.of("").toAbsolutePath().normalize())
.resolve("test-projects")
.resolve("main")
.toAbsolutePath()
.normalize();
final Path documentPath = projectRoot.resolve("src").resolve("main.pbs");
final String overlay = """
import { Gfx } from @sdk:gfx;
declare struct Vec() {
fn blend(dx: int, dy: int) -> int { return dx; }
}
fn helper() -> int { return 42; }
fn frame(vec: Vec) -> void {
helper();
helper();
vec.blend(1, 2);
Gfx.clear(5);
let n: int = 1;
n;
// helper
let text = "helper";
}
""";
final CompilerLanguageServiceBridge bridge = new CompilerLanguageServiceBridge();
final LspProjectContext context = new LspProjectContext("main", "pbs", projectRoot);
final DocumentPositionMapper mapper = new DocumentPositionMapper(overlay);
final String documentUri = documentPath.toUri().toString();
final var helperUse = mapper.positionOf(overlay.indexOf("helper();"));
final var helperUsages = bridge.references(
context,
documentUri,
overlay,
helperUse.line(),
helperUse.character(),
false);
assertEquals(3, helperUsages.locations().size(), helperUsages.locations().toString());
assertTrue(helperUsages.locations().stream().allMatch(location -> location.uri().equals(documentUri)));
final var helperWithDeclaration = bridge.references(
context,
documentUri,
overlay,
helperUse.line(),
helperUse.character(),
true);
assertTrue(helperWithDeclaration.locations().size() > helperUsages.locations().size());
final var clearUse = mapper.positionOf(overlay.indexOf("clear"));
final var clearReferences = bridge.references(
context,
documentUri,
overlay,
clearUse.line(),
clearUse.character(),
true);
assertTrue(clearReferences.locations().isEmpty());
final var builtinUse = mapper.positionOf(overlay.indexOf("int = 1"));
final var builtinReferences = bridge.references(
context,
documentUri,
overlay,
builtinUse.line(),
builtinUse.character(),
true);
assertTrue(builtinReferences.locations().isEmpty());
}
@Test
void describeServerPublishesFrontendVisualThemes() {
final CompilerLanguageServiceBridge bridge = new CompilerLanguageServiceBridge();
@@ -408,6 +485,7 @@ class CompilerLanguageServiceBridgeTest {
assertTrue(description.completionSupported());
assertTrue(description.signatureHelpSupported());
assertTrue(description.definitionSupported());
assertTrue(description.referencesSupported());
assertEquals(1, description.semanticHostProjections().size());
assertEquals("vscode", description.semanticHostProjections().getFirst().hostId());
assertTrue(description.semanticHostProjections().getFirst().tokenProjections().stream()
@@ -100,6 +100,7 @@ class PrometeuLanguageServerTest {
true,
true,
true,
true,
List.of(),
List.of(new BaselineSemanticHostProjection(
"vscode",
@@ -157,6 +158,17 @@ class PrometeuLanguageServerTest {
return BaselineDefinition.empty();
}
@Override
public p.studio.lsp.messages.BaselineReferences references(
final LspProjectContext project,
final String documentUri,
final String text,
final int line,
final int character,
final boolean includeDeclaration) {
return p.studio.lsp.messages.BaselineReferences.empty();
}
@Override
public BaselineSignatureHelp signatureHelp(
final LspProjectContext project,
@@ -208,6 +220,12 @@ class PrometeuLanguageServerTest {
throw new UnsupportedOperationException();
}
@Override
public java.util.List<org.eclipse.lsp4j.Location> mapReferences(
final p.studio.lsp.messages.BaselineReferences references) {
throw new UnsupportedOperationException();
}
@Override
public org.eclipse.lsp4j.CompletionList mapCompletion(final BaselineCompletion completion) {
throw new UnsupportedOperationException();
@@ -4,6 +4,8 @@ import org.eclipse.lsp4j.CompletionItem;
import org.eclipse.lsp4j.CompletionList;
import org.eclipse.lsp4j.CompletionParams;
import org.eclipse.lsp4j.DefinitionParams;
import org.eclipse.lsp4j.ReferenceContext;
import org.eclipse.lsp4j.ReferenceParams;
import org.eclipse.lsp4j.DidOpenTextDocumentParams;
import org.eclipse.lsp4j.Hover;
import org.eclipse.lsp4j.HoverParams;
@@ -20,6 +22,7 @@ import p.studio.lsp.messages.BaselineCompletionItem;
import p.studio.lsp.messages.BaselineCompletionItemKind;
import p.studio.lsp.messages.BaselineDefinition;
import p.studio.lsp.messages.BaselineDefinitionLocation;
import p.studio.lsp.messages.BaselineReferences;
import p.studio.lsp.messages.BaselineDocumentAnalysis;
import p.studio.lsp.messages.BaselineHover;
import p.studio.lsp.messages.BaselineSemanticTokens;
@@ -89,6 +92,16 @@ final class PrometeuTextDocumentServiceTest {
assertEquals(text, bridge.lastDefinitionText);
assertEquals(1, bridge.lastDefinitionLine);
assertEquals(2, bridge.lastDefinitionCharacter);
final var references = service.references(new ReferenceParams(
new TextDocumentIdentifier(uri),
new Position(1, 2),
new ReferenceContext(true))).join();
assertSame(mapper.referenceLocations, references);
assertEquals(text, bridge.lastReferencesText);
assertEquals(1, bridge.lastReferencesLine);
assertEquals(2, bridge.lastReferencesCharacter);
assertTrue(bridge.lastIncludeDeclaration);
}
private static final class RecordingBridge implements LanguageServiceBridge {
@@ -99,6 +112,10 @@ final class PrometeuTextDocumentServiceTest {
private String lastDefinitionText;
private int lastDefinitionLine;
private int lastDefinitionCharacter;
private String lastReferencesText;
private int lastReferencesLine;
private int lastReferencesCharacter;
private boolean lastIncludeDeclaration;
private String lastSignatureHelpText;
private int lastSignatureHelpLine;
private int lastSignatureHelpCharacter;
@@ -151,6 +168,21 @@ final class PrometeuTextDocumentServiceTest {
return new BaselineDefinition(List.of(new BaselineDefinitionLocation(documentUri, 0, 0, 0, 6)));
}
@Override
public BaselineReferences references(
final LspProjectContext context,
final String documentUri,
final String text,
final int line,
final int character,
final boolean includeDeclaration) {
lastReferencesText = text;
lastReferencesLine = line;
lastReferencesCharacter = character;
lastIncludeDeclaration = includeDeclaration;
return new BaselineReferences(List.of(new BaselineDefinitionLocation(documentUri, 0, 0, 0, 6)));
}
@Override
public BaselineSignatureHelp signatureHelp(
final LspProjectContext context,
@@ -180,6 +212,7 @@ final class PrometeuTextDocumentServiceTest {
private final CompletionList completionList = new CompletionList(false, List.of(new CompletionItem("demo")));
private final SignatureHelp signatureHelp = new SignatureHelp();
private final List<Location> definitionLocations = List.of();
private final List<Location> referenceLocations = List.of();
private BaselineSignatureHelp mappedSignatureHelp;
@Override
@@ -212,6 +245,11 @@ final class PrometeuTextDocumentServiceTest {
return definitionLocations;
}
@Override
public List<Location> mapReferences(final BaselineReferences references) {
return referenceLocations;
}
@Override
public CompletionList mapCompletion(final BaselineCompletion completion) {
return completionList;
@@ -8,6 +8,7 @@ import p.studio.lsp.messages.BaselineCompletionItem;
import p.studio.lsp.messages.BaselineCompletionItemKind;
import p.studio.lsp.messages.BaselineDefinition;
import p.studio.lsp.messages.BaselineDefinitionLocation;
import p.studio.lsp.messages.BaselineReferences;
import p.studio.lsp.messages.BaselineEditorPalette;
import p.studio.lsp.messages.BaselineSemanticHostProjection;
import p.studio.lsp.messages.BaselineSemanticHostProjectionEntry;
@@ -38,6 +39,7 @@ final class Lsp4jProtocolMessageMapperTest {
true,
true,
true,
true,
List.of("demo-keyword"),
List.of(new BaselineSemanticHostProjection(
"vscode",
@@ -59,6 +61,7 @@ final class Lsp4jProtocolMessageMapperTest {
assertEquals(List.of("."), result.getCapabilities().getCompletionProvider().getTriggerCharacters());
assertEquals(List.of("(", ","), result.getCapabilities().getSignatureHelpProvider().getTriggerCharacters());
assertEquals(Boolean.TRUE, result.getCapabilities().getDefinitionProvider().getLeft());
assertEquals(Boolean.TRUE, result.getCapabilities().getReferencesProvider().getLeft());
final var experimental = assertInstanceOf(Map.class, result.getCapabilities().getExperimental());
final var semanticPayload = assertInstanceOf(Map.class, experimental.get("prometeuSemanticHostProjections"));
@@ -121,4 +124,15 @@ final class Lsp4jProtocolMessageMapperTest {
assertEquals(9, locations.getFirst().getRange().getEnd().getCharacter());
assertTrue(mapper.mapDefinition(BaselineDefinition.empty()).isEmpty());
}
@Test
void referencesMapsPhysicalFileLocations() {
final var mapper = new Lsp4jProtocolMessageMapper();
final var locations = mapper.mapReferences(new BaselineReferences(List.of(
new BaselineDefinitionLocation("file:///tmp/demo.pbs", 2, 3, 2, 9))));
assertEquals(1, locations.size());
assertEquals("file:///tmp/demo.pbs", locations.getFirst().getUri());
assertEquals(3, locations.getFirst().getRange().getStart().getCharacter());
assertTrue(mapper.mapReferences(BaselineReferences.empty()).isEmpty());
}
}