implements PLN-0137 (2/7) document-links

Advertise document links only when the frontend supports them.
A link covers the ModuleRef span when module assembly already
bound that module to a regular file. Virtual stdlib and unresolved
modules produce no link.
This commit is contained in:
2026-09-22 08:34:13 +01:00
parent 099857b636
commit 3320f222bb
18 changed files with 489 additions and 2 deletions
@@ -21,6 +21,7 @@ import p.studio.compiler.pbs.semantics.PbsQuickFixCollector;
import p.studio.compiler.services.PBSFrontendPhaseService.PbsSemanticReadSurface;
import p.studio.compiler.services.FrontendCodeAction;
import p.studio.compiler.services.FrontendCompletionCandidate;
import p.studio.compiler.services.FrontendDocumentLink;
import p.studio.compiler.services.FrontendDefinitionLocation;
import p.studio.compiler.services.FrontendDocumentRequest;
import p.studio.compiler.services.FrontendDocumentSymbol;
@@ -40,6 +41,7 @@ import p.studio.compiler.source.Span;
import p.studio.compiler.source.diagnostics.DiagnosticSink;
import p.studio.compiler.source.identifiers.FileId;
import p.studio.compiler.source.tables.FileTableReader;
import p.studio.compiler.source.tables.ModuleReference;
import p.studio.utilities.structures.ReadOnlyList;
import java.nio.file.Files;
@@ -401,6 +403,46 @@ public final class PBSFrontendLanguageService implements FrontendLanguageService
return FrontendRenameResult.applied(List.copyOf(edits.values()));
}
@Override
public boolean documentLinksSupported() {
return true;
}
@Override
public List<FrontendDocumentLink> documentLinks(
final FrontendDocumentRequest request,
final FrontendEditorialContext editorialContext) {
if (request == null
|| editorialContext == null
|| !(editorialContext.syntaxTree() instanceof PbsAst.File ast)
|| !(editorialContext.projectSurface() instanceof PbsSemanticReadSurface surface)
|| surface.physicalModuleFileByReference() == null
|| ast.imports() == null) {
return List.of();
}
final ArrayList<FrontendDocumentLink> links = new ArrayList<>();
for (final PbsAst.ImportDecl importDecl : ast.imports()) {
if (importDecl == null || importDecl.moduleRef() == null) {
continue;
}
final PbsAst.ModuleRef moduleRef = importDecl.moduleRef();
final Span span = moduleRef.span();
if (span == null || span.isNone() || moduleRef.project() == null || moduleRef.project().isBlank()) {
continue;
}
final Path target = surface.physicalModuleFileByReference().get(
new ModuleReference(moduleRef.project(), moduleRef.pathSegments()));
if (target == null) {
continue;
}
links.add(new FrontendDocumentLink(
target,
toOffset(span.getStart()),
toOffset(span.getEnd())));
}
return List.copyOf(links);
}
@Override
public boolean codeActionsSupported() {
return true;
@@ -15,9 +15,12 @@ import p.studio.compiler.pbs.stdlib.StdlibEnvironmentResolver;
import p.studio.compiler.source.diagnostics.DiagnosticSink;
import p.studio.compiler.source.identifiers.FileId;
import p.studio.compiler.source.identifiers.ModuleId;
import p.studio.compiler.source.tables.ModuleReference;
import p.studio.utilities.logs.LogAggregator;
import p.studio.utilities.structures.ReadOnlyList;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.*;
@Slf4j
@@ -153,14 +156,46 @@ public class PBSFrontendPhaseService implements FrontendPhaseService {
Map.copyOf(astByFile),
Map.copyOf(supplementalTopDeclsByFile),
Map.copyOf(inlineHintsByFile),
Map.copyOf(sourceKindByFile));
Map.copyOf(sourceKindByFile),
physicalModuleFiles(ctx, assembly));
}
private static Map<ModuleReference, Path> physicalModuleFiles(
final FrontendPhaseContext ctx,
final PbsModuleAssembly assembly) {
final Map<ModuleReference, Path> files = new LinkedHashMap<>();
if (ctx == null || ctx.fileTable == null || assembly == null || assembly.parsedSourceFiles() == null) {
return Map.of();
}
for (final PbsParsedSourceFile parsed : assembly.parsedSourceFiles()) {
if (parsed.fileId() == null || parsed.fileId().isNone()
|| parsed.moduleId() == null || parsed.moduleId().isNone()) {
continue;
}
final var handle = ctx.fileTable.get(parsed.fileId());
if (handle == null || handle.getCanonPath() == null) {
continue;
}
final Path path = handle.getCanonPath().toAbsolutePath().normalize();
if (!Files.isRegularFile(path)) {
continue;
}
final ModuleReference reference = assembly.moduleTable().get(parsed.moduleId());
if (reference == null) {
continue;
}
files.merge(reference, path, (left, right) ->
left.toString().compareTo(right.toString()) <= 0 ? left : right);
}
return Map.copyOf(files);
}
public record PbsSemanticReadSurface(
Map<FileId, p.studio.compiler.pbs.ast.PbsAst.File> astByFile,
Map<FileId, ReadOnlyList<p.studio.compiler.pbs.ast.PbsAst.TopDecl>> supplementalTopDeclsByFile,
Map<FileId, ReadOnlyList<PbsInlineHintSurface>> inlineHintsByFile,
Map<FileId, SourceKind> sourceKindByFile) {
Map<FileId, SourceKind> sourceKindByFile,
Map<ModuleReference, Path> physicalModuleFileByReference) {
}
private IRBackend mergeCompiledSources(
@@ -0,0 +1,109 @@
package p.studio.compiler;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.io.TempDir;
import p.studio.AppMode;
import p.studio.compiler.messages.BuildingIssueSink;
import p.studio.compiler.messages.FrontendPhaseContext;
import p.studio.compiler.models.BuildStack;
import p.studio.compiler.models.ProjectDescriptor;
import p.studio.compiler.models.SourceHandle;
import p.studio.compiler.services.FrontendDocumentRequest;
import p.studio.compiler.source.diagnostics.DiagnosticSink;
import p.studio.compiler.source.identifiers.FileId;
import p.studio.compiler.source.tables.FileTable;
import p.studio.compiler.source.tables.ProjectTable;
import p.studio.compiler.utilities.SourceProviderFactory;
import p.studio.utilities.structures.ReadOnlyList;
import java.io.IOException;
import java.nio.charset.StandardCharsets;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.attribute.BasicFileAttributes;
import java.util.List;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertTrue;
class PBSFrontendDocumentLinkTest {
@TempDir
Path tempDir;
@Test
void documentLinksUseTheAssembledPhysicalModuleFile() throws IOException {
final Path projectRoot = tempDir.resolve("app");
final Path sourceRoot = projectRoot.resolve("src");
final Path sourceA = sourceRoot.resolve("a").resolve("source.pbs");
final Path sourceB = sourceRoot.resolve("b").resolve("source.pbs");
Files.createDirectories(sourceA.getParent());
Files.createDirectories(sourceB.getParent());
Files.writeString(sourceA, """
fn target() -> int {
return 1;
}
""");
Files.writeString(sourceA.getParent().resolve("mod.barrel"), "pub fn target() -> int;\n");
final String caller = """
import { target } from @app:a;
import { Log } from @sdk:log;
import { Missing } from @app:missing;
fn caller() -> int {
return target();
}
""";
Files.writeString(sourceB, caller);
Files.writeString(sourceB.getParent().resolve("mod.barrel"), "pub fn caller() -> int;\n");
final var projectTable = new ProjectTable();
final var fileTable = new FileTable(1);
final var projectId = projectTable.register(ProjectDescriptor.builder()
.rootPath(projectRoot)
.name("app")
.version("1.0.0")
.sourceRoots(ReadOnlyList.wrap(List.of(sourceRoot)))
.build());
register(projectId, projectRoot, sourceA, fileTable);
register(projectId, projectRoot, sourceA.getParent().resolve("mod.barrel"), fileTable);
final FileId callerId = register(projectId, projectRoot, sourceB, fileTable);
register(projectId, projectRoot, sourceB.getParent().resolve("mod.barrel"), fileTable);
final var phaseContext = new FrontendPhaseContext(
projectTable,
fileTable,
new BuildStack(ReadOnlyList.wrap(List.of(projectId))),
AppMode.Game);
final var service = new PBSFrontendLanguageService();
final var editorialContext = service.prepareEditorialContext(phaseContext, callerId).orElseThrow();
final var links = service.documentLinks(
new FrontendDocumentRequest(projectRoot, sourceB, caller),
editorialContext);
assertEquals(1, links.size());
assertEquals(sourceA.toAbsolutePath().normalize(), links.getFirst().path());
final byte[] bytes = caller.getBytes(StandardCharsets.UTF_8);
assertEquals("@app:a", new String(
bytes,
links.getFirst().startOffset(),
links.getFirst().endOffset() - links.getFirst().startOffset(),
StandardCharsets.UTF_8));
assertTrue(service.documentLinksSupported());
}
private static FileId register(
final p.studio.compiler.source.identifiers.ProjectId projectId,
final Path projectRoot,
final Path file,
final FileTable fileTable) throws IOException {
final BasicFileAttributes attributes = Files.readAttributes(file, BasicFileAttributes.class);
return fileTable.register(new SourceHandle(
projectId,
projectRoot.relativize(file),
file,
attributes.size(),
attributes.lastModifiedTime().toMillis(),
SourceProviderFactory.filesystem()));
}
}