Compare commits

..
Author SHA1 Message Date
bquarkz fa21a029ae Merge pull request 'implements PLN-0134' (#28) from dev/pbs-lsp-workspace-symbols into master
JaCoCo Coverage #### Project Overview No changes detected, that affect the code coverage. * Line Coverage: 63.37% (18783/29640) * Branch Coverage: 53.99% (7369/13648) * Lines of Code: 29640 * Cyclomatic Complexity: 11938 #### Quality Gates Summary Output truncated.
Test / Build skipped: 15, passed: 674
Intrepid/Prometeu/Studio/pipeline/head This commit looks good
Reviewed-on: #28
2026-09-21 16:27:42 +00:00
bquarkz 12e2a4edcc implements PLN-0134
Intrepid/Prometeu/Studio/pipeline/pr-master Build started...
JaCoCo Coverage #### Project Overview No changes detected, that affect the code coverage. * Line Coverage: 63.37% (18783/29640) * Branch Coverage: 53.99% (7369/13648) * Lines of Code: 29640 * Cyclomatic Complexity: 11938 #### Quality Gates Summary Output truncated.
Test / Build skipped: 15, passed: 674
Intrepid/Prometeu/Studio/pipeline/head This commit looks good
Add PBS workspace symbols as a physical flatten of the outline
named-declaration set on FrontendLanguageService. Regular files
only; virtual stdlib, barrels, imports, locals, and compile-only
frontends stay empty. Advertise workspaceSymbolProvider with flat
SymbolInformation. workspace/symbol does not require an open
document.

Housekeep DSC-0042 with LSN-0071.
2026-09-21 17:18:00 +01:00
bquarkz 78d10cf03c Merge pull request 'implements PLN-0133' (#27) from dev/pbs-lsp-document-symbols-and-outline into master
JaCoCo Coverage #### Project Overview No changes detected, that affect the code coverage. * Line Coverage: 62.84% (18504/29445) * Branch Coverage: 53.33% (7215/13528) * Lines of Code: 29445 * Cyclomatic Complexity: 11850 #### Quality Gates Summary Output truncated.
Test / Build skipped: 15, passed: 669
Intrepid/Prometeu/Studio/pipeline/head This commit looks good
Reviewed-on: #27
2026-09-21 09:23:52 +00:00
bquarkz 5d3d48e802 implements PLN-0133
Intrepid/Prometeu/Studio/pipeline/pr-master Build started...
JaCoCo Coverage #### Project Overview No changes detected, that affect the code coverage. * Line Coverage: 62.84% (18504/29445) * Branch Coverage: 53.33% (7215/13528) * Lines of Code: 29445 * Cyclomatic Complexity: 11850 #### Quality Gates Summary Output truncated.
Test / Build skipped: 15, passed: 669
Intrepid/Prometeu/Studio/pipeline/head This commit looks good
Add PBS document symbols as an AST-backed hierarchical outline of
the open .pbs file on FrontendLanguageService. Recovered syntax is
enough; unnamed InvalidDecl is omitted; barrels, imports, locals,
and compile-only frontends stay empty. Advertise documentSymbolProvider
with hierarchical DocumentSymbol.

Housekeep DSC-0041 with LSN-0070.
2026-09-21 10:16:14 +01:00
bquarkz 331ad752d1 Merge pull request 'implements PLN-0132' (#26) from dev/pbs-lsp-find-references into master
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
Intrepid/Prometeu/Studio/pipeline/head This commit looks good
Reviewed-on: #26
2026-09-21 08:00:40 +00:00
bquarkz 9458312d73 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.
2026-09-21 08:54:11 +01:00
bquarkz 4b72b2a0dd Merge pull request 'implements PLN-0131' (#25) from dev/pbs-lsp-go-to-definition into master
JaCoCo Coverage #### Project Overview No changes detected, that affect the code coverage. * Line Coverage: 62.22% (17996/28921) * Branch Coverage: 52.87% (6986/13213) * Lines of Code: 28921 * Cyclomatic Complexity: 11624 #### Quality Gates Summary Output truncated.
Test / Build skipped: 15, passed: 659
Intrepid/Prometeu/Studio/pipeline/head This commit looks good
Reviewed-on: #25
2026-09-21 06:57:41 +00:00
bquarkz c2112f6ee1 implements PLN-0131
Intrepid/Prometeu/Studio/pipeline/pr-master Build started...
JaCoCo Coverage #### Project Overview No changes detected, that affect the code coverage. * Line Coverage: 62.22% (17996/28921) * Branch Coverage: 52.87% (6986/13213) * Lines of Code: 28921 * Cyclomatic Complexity: 11624 #### Quality Gates Summary Output truncated.
Test / Build skipped: 15, passed: 659
Intrepid/Prometeu/Studio/pipeline/head This commit looks good
Add PBS go-to-definition as hover editorial lookup plus physical
declaration locations on FrontendLanguageService. Empty results stay
honest when the target is not a regular file, including virtual stdlib
paths.

Housekeep DSC-0039 with LSN-0068.
2026-09-21 07:50:14 +01:00
bquarkz 9896e7c657 Merge pull request 'implements PLN-0130' (#24) from dev/multi-frontend-avoid-premature-abstractions into master
JaCoCo Coverage #### Project Overview No changes detected, that affect the code coverage. * Line Coverage: 62.10% (17811/28682) * Branch Coverage: 52.81% (6878/13025) * Lines of Code: 28682 * Cyclomatic Complexity: 11494 #### Quality Gates Summary Output truncated.
Test / Build skipped: 15, passed: 654
Intrepid/Prometeu/Studio/pipeline/head This commit looks good
Reviewed-on: #24
2026-09-19 02:47:17 +00:00
46 changed files with 3833 additions and 272 deletions
+5 -5
View File
@@ -1,4 +1,4 @@
{"type":"meta","next_id":{"DSC":66,"AGD":69,"DEC":52,"PLN":131,"LSN":68,"CLSN":1}} {"type":"meta","next_id":{"DSC":66,"AGD":69,"DEC":56,"PLN":135,"LSN":72,"CLSN":1}}
{"type":"discussion","id":"DSC-0065","status":"done","ticket":"multi-frontend-avoid-premature-abstractions","title":"Evitar abstracoes prematuras na preparacao multi-frontend","created_at":"2026-07-15","updated_at":"2026-09-19","tags":["compiler","compiler-general","studio","frontend","architecture","multi-frontend","simplicity"],"agendas":[],"decisions":[],"plans":[],"lessons":[{"id":"LSN-0067","file":"discussion/lessons/DSC-0065-multi-frontend-avoid-premature-abstractions/LSN-0067-multi-frontend-phase-rejects-premature-infrastructure.md","status":"done","created_at":"2026-09-19","updated_at":"2026-09-19"}]} {"type":"discussion","id":"DSC-0065","status":"done","ticket":"multi-frontend-avoid-premature-abstractions","title":"Evitar abstracoes prematuras na preparacao multi-frontend","created_at":"2026-07-15","updated_at":"2026-09-19","tags":["compiler","compiler-general","studio","frontend","architecture","multi-frontend","simplicity"],"agendas":[],"decisions":[],"plans":[],"lessons":[{"id":"LSN-0067","file":"discussion/lessons/DSC-0065-multi-frontend-avoid-premature-abstractions/LSN-0067-multi-frontend-phase-rejects-premature-infrastructure.md","status":"done","created_at":"2026-09-19","updated_at":"2026-09-19"}]}
{"type":"discussion","id":"DSC-0064","status":"done","ticket":"multi-frontend-architectural-tests","title":"Testes arquiteturais para fronteiras multi-frontend","created_at":"2026-07-15","updated_at":"2026-09-19","tags":["compiler","compiler-general","studio","frontend","architecture","tests","multi-frontend"],"agendas":[],"decisions":[],"plans":[],"lessons":[{"id":"LSN-0066","file":"discussion/lessons/DSC-0064-multi-frontend-architectural-tests/LSN-0066-archunit-guards-java-multi-frontend-boundaries.md","status":"done","created_at":"2026-09-19","updated_at":"2026-09-19"}]} {"type":"discussion","id":"DSC-0064","status":"done","ticket":"multi-frontend-architectural-tests","title":"Testes arquiteturais para fronteiras multi-frontend","created_at":"2026-07-15","updated_at":"2026-09-19","tags":["compiler","compiler-general","studio","frontend","architecture","tests","multi-frontend"],"agendas":[],"decisions":[],"plans":[],"lessons":[{"id":"LSN-0066","file":"discussion/lessons/DSC-0064-multi-frontend-architectural-tests/LSN-0066-archunit-guards-java-multi-frontend-boundaries.md","status":"done","created_at":"2026-09-19","updated_at":"2026-09-19"}]}
{"type":"discussion","id":"DSC-0063","status":"done","ticket":"multi-frontend-synthetic-test-frontend","title":"Frontend sintetico de teste para provar neutralidade do pipeline","created_at":"2026-07-15","updated_at":"2026-09-19","tags":["compiler","compiler-general","frontend","tests","backend","multi-frontend"],"agendas":[],"decisions":[],"plans":[],"lessons":[{"id":"LSN-0065","file":"discussion/lessons/DSC-0063-multi-frontend-synthetic-test-frontend/LSN-0065-synthetic-test-frontend-proves-pipeline-neutrality.md","status":"done","created_at":"2026-09-19","updated_at":"2026-09-19"}]} {"type":"discussion","id":"DSC-0063","status":"done","ticket":"multi-frontend-synthetic-test-frontend","title":"Frontend sintetico de teste para provar neutralidade do pipeline","created_at":"2026-07-15","updated_at":"2026-09-19","tags":["compiler","compiler-general","frontend","tests","backend","multi-frontend"],"agendas":[],"decisions":[],"plans":[],"lessons":[{"id":"LSN-0065","file":"discussion/lessons/DSC-0063-multi-frontend-synthetic-test-frontend/LSN-0065-synthetic-test-frontend-proves-pipeline-neutrality.md","status":"done","created_at":"2026-09-19","updated_at":"2026-09-19"}]}
@@ -22,10 +22,10 @@
{"type":"discussion","id":"DSC-0045","status":"open","ticket":"pbs-lsp-formatting","title":"PBS LSP Formatting","created_at":"2026-07-15","updated_at":"2026-07-15","tags":["studio","lsp","vscode","compiler-pbs","editor","formatting"],"agendas":[{"id":"AGD-0048","file":"AGD-0048-pbs-lsp-formatting.md","status":"open","created_at":"2026-07-15","updated_at":"2026-07-15"}],"decisions":[],"plans":[],"lessons":[]} {"type":"discussion","id":"DSC-0045","status":"open","ticket":"pbs-lsp-formatting","title":"PBS LSP Formatting","created_at":"2026-07-15","updated_at":"2026-07-15","tags":["studio","lsp","vscode","compiler-pbs","editor","formatting"],"agendas":[{"id":"AGD-0048","file":"AGD-0048-pbs-lsp-formatting.md","status":"open","created_at":"2026-07-15","updated_at":"2026-07-15"}],"decisions":[],"plans":[],"lessons":[]}
{"type":"discussion","id":"DSC-0044","status":"open","ticket":"pbs-lsp-code-actions","title":"PBS LSP Code Actions and Quick Fixes","created_at":"2026-07-15","updated_at":"2026-07-15","tags":["studio","lsp","vscode","compiler-pbs","editor","code-actions","quick-fix"],"agendas":[{"id":"AGD-0047","file":"AGD-0047-pbs-lsp-code-actions-and-quick-fixes.md","status":"open","created_at":"2026-07-15","updated_at":"2026-07-15"}],"decisions":[],"plans":[],"lessons":[]} {"type":"discussion","id":"DSC-0044","status":"open","ticket":"pbs-lsp-code-actions","title":"PBS LSP Code Actions and Quick Fixes","created_at":"2026-07-15","updated_at":"2026-07-15","tags":["studio","lsp","vscode","compiler-pbs","editor","code-actions","quick-fix"],"agendas":[{"id":"AGD-0047","file":"AGD-0047-pbs-lsp-code-actions-and-quick-fixes.md","status":"open","created_at":"2026-07-15","updated_at":"2026-07-15"}],"decisions":[],"plans":[],"lessons":[]}
{"type":"discussion","id":"DSC-0043","status":"open","ticket":"pbs-lsp-rename-symbol","title":"PBS LSP Rename Symbol","created_at":"2026-07-15","updated_at":"2026-07-15","tags":["studio","lsp","vscode","compiler-pbs","editor","rename"],"agendas":[{"id":"AGD-0046","file":"AGD-0046-pbs-lsp-rename-symbol.md","status":"open","created_at":"2026-07-15","updated_at":"2026-07-15"}],"decisions":[],"plans":[],"lessons":[]} {"type":"discussion","id":"DSC-0043","status":"open","ticket":"pbs-lsp-rename-symbol","title":"PBS LSP Rename Symbol","created_at":"2026-07-15","updated_at":"2026-07-15","tags":["studio","lsp","vscode","compiler-pbs","editor","rename"],"agendas":[{"id":"AGD-0046","file":"AGD-0046-pbs-lsp-rename-symbol.md","status":"open","created_at":"2026-07-15","updated_at":"2026-07-15"}],"decisions":[],"plans":[],"lessons":[]}
{"type":"discussion","id":"DSC-0042","status":"open","ticket":"pbs-lsp-workspace-symbols","title":"PBS LSP Workspace Symbols","created_at":"2026-07-15","updated_at":"2026-07-15","tags":["studio","lsp","vscode","compiler-pbs","editor","workspace-symbols"],"agendas":[{"id":"AGD-0045","file":"AGD-0045-pbs-lsp-workspace-symbols.md","status":"open","created_at":"2026-07-15","updated_at":"2026-07-15"}],"decisions":[],"plans":[],"lessons":[]} {"type":"discussion","id":"DSC-0042","status":"done","ticket":"pbs-lsp-workspace-symbols","title":"PBS LSP Workspace Symbols","created_at":"2026-07-15","updated_at":"2026-09-21","tags":["studio","lsp","vscode","compiler-pbs","editor","workspace-symbols"],"agendas":[],"decisions":[],"plans":[],"lessons":[{"id":"LSN-0071","file":"discussion/lessons/DSC-0042-pbs-lsp-workspace-symbols/LSN-0071-pbs-workspace-symbols-are-a-physical-named-declaration-search.md","status":"done","created_at":"2026-09-21","updated_at":"2026-09-21"}]}
{"type":"discussion","id":"DSC-0041","status":"open","ticket":"pbs-lsp-document-symbols-outline","title":"PBS LSP Document Symbols and Outline","created_at":"2026-07-15","updated_at":"2026-07-15","tags":["studio","lsp","vscode","compiler-pbs","editor","outline","document-symbols"],"agendas":[{"id":"AGD-0044","file":"AGD-0044-pbs-lsp-document-symbols-and-outline.md","status":"open","created_at":"2026-07-15","updated_at":"2026-07-15"}],"decisions":[],"plans":[],"lessons":[]} {"type":"discussion","id":"DSC-0041","status":"done","ticket":"pbs-lsp-document-symbols-outline","title":"PBS LSP Document Symbols and Outline","created_at":"2026-07-15","updated_at":"2026-09-21","tags":["studio","lsp","vscode","compiler-pbs","editor","outline","document-symbols"],"agendas":[],"decisions":[],"plans":[],"lessons":[{"id":"LSN-0070","file":"discussion/lessons/DSC-0041-pbs-lsp-document-symbols-outline/LSN-0070-pbs-outline-is-an-ast-backed-document-symbol-tree.md","status":"done","created_at":"2026-09-21","updated_at":"2026-09-21"}]}
{"type":"discussion","id":"DSC-0040","status":"open","ticket":"pbs-lsp-find-references","title":"PBS LSP Find References","created_at":"2026-07-15","updated_at":"2026-07-15","tags":["studio","lsp","vscode","compiler-pbs","editor","references"],"agendas":[{"id":"AGD-0043","file":"AGD-0043-pbs-lsp-find-references.md","status":"open","created_at":"2026-07-15","updated_at":"2026-07-15"}],"decisions":[],"plans":[],"lessons":[]} {"type":"discussion","id":"DSC-0040","status":"done","ticket":"pbs-lsp-find-references","title":"PBS LSP Find References","created_at":"2026-07-15","updated_at":"2026-09-21","tags":["studio","lsp","vscode","compiler-pbs","editor","references"],"agendas":[],"decisions":[],"plans":[],"lessons":[{"id":"LSN-0069","file":"discussion/lessons/DSC-0040-pbs-lsp-find-references/LSN-0069-pbs-find-references-is-the-physical-inverse-of-definition.md","status":"done","created_at":"2026-09-21","updated_at":"2026-09-21"}]}
{"type":"discussion","id":"DSC-0039","status":"open","ticket":"pbs-lsp-go-to-definition","title":"PBS LSP Go to Definition","created_at":"2026-07-15","updated_at":"2026-07-15","tags":["studio","lsp","vscode","compiler-pbs","editor","definition"],"agendas":[{"id":"AGD-0042","file":"AGD-0042-pbs-lsp-go-to-definition.md","status":"open","created_at":"2026-07-15","updated_at":"2026-07-15"}],"decisions":[],"plans":[],"lessons":[]} {"type":"discussion","id":"DSC-0039","status":"done","ticket":"pbs-lsp-go-to-definition","title":"PBS LSP Go to Definition","created_at":"2026-07-15","updated_at":"2026-09-21","tags":["studio","lsp","vscode","compiler-pbs","editor","definition"],"agendas":[],"decisions":[],"plans":[],"lessons":[{"id":"LSN-0068","file":"discussion/lessons/DSC-0039-pbs-lsp-go-to-definition/LSN-0068-pbs-go-to-definition-uses-editorial-lookup-and-physical-files.md","status":"done","created_at":"2026-09-21","updated_at":"2026-09-21"}]}
{"type":"discussion","id":"DSC-0038","status":"done","ticket":"studio-packer-rgba8888-asset-pipeline","title":"Studio and Packer RGBA8888 Asset Pipeline Alignment","created_at":"2026-05-23","updated_at":"2026-07-14","tags":["studio","packer","assets","glyph-bank","palette","rgba8888","runtime-alignment"],"agendas":[],"decisions":[],"plans":[],"lessons":[{"id":"LSN-0053","file":"discussion/lessons/DSC-0038-studio-packer-rgba8888-asset-pipeline/LSN-0053-rgba8888-is-the-canonical-studio-packer-palette-contract.md","status":"done","created_at":"2026-07-14","updated_at":"2026-07-14"}]} {"type":"discussion","id":"DSC-0038","status":"done","ticket":"studio-packer-rgba8888-asset-pipeline","title":"Studio and Packer RGBA8888 Asset Pipeline Alignment","created_at":"2026-05-23","updated_at":"2026-07-14","tags":["studio","packer","assets","glyph-bank","palette","rgba8888","runtime-alignment"],"agendas":[],"decisions":[],"plans":[],"lessons":[{"id":"LSN-0053","file":"discussion/lessons/DSC-0038-studio-packer-rgba8888-asset-pipeline/LSN-0053-rgba8888-is-the-canonical-studio-packer-palette-contract.md","status":"done","created_at":"2026-07-14","updated_at":"2026-07-14"}]}
{"type":"discussion","id":"DSC-0037","status":"done","ticket":"pbs-autocomplete-parameter-names","title":"PBS autocomplete parameter names for stdlib and method calls","created_at":"2026-05-08","updated_at":"2026-05-14","tags":["compiler-pbs","studio","lsp","autocomplete","signature-help","stdlib"],"agendas":[],"decisions":[],"plans":[],"lessons":[{"id":"LSN-0052","file":"discussion/lessons/DSC-0037-pbs-autocomplete-parameter-names/LSN-0052-canonical-callable-parameter-names-through-pbs-editor-assistance.md","status":"done","created_at":"2026-05-14","updated_at":"2026-05-14"}]} {"type":"discussion","id":"DSC-0037","status":"done","ticket":"pbs-autocomplete-parameter-names","title":"PBS autocomplete parameter names for stdlib and method calls","created_at":"2026-05-08","updated_at":"2026-05-14","tags":["compiler-pbs","studio","lsp","autocomplete","signature-help","stdlib"],"agendas":[],"decisions":[],"plans":[],"lessons":[{"id":"LSN-0052","file":"discussion/lessons/DSC-0037-pbs-autocomplete-parameter-names/LSN-0052-canonical-callable-parameter-names-through-pbs-editor-assistance.md","status":"done","created_at":"2026-05-14","updated_at":"2026-05-14"}]}
{"type":"discussion","id":"DSC-0036","status":"done","ticket":"pbs-symbol-documentation-and-hover-markdown","title":"Modelo de documentacao de simbolos em PBS e consumo markdown no hover","created_at":"2026-05-08","updated_at":"2026-07-15","tags":["compiler","compiler-pbs","studio","lsp","vscode","editor","hover","documentation","markdown"],"agendas":[],"decisions":[],"plans":[],"lessons":[{"id":"LSN-0057","file":"discussion/lessons/DSC-0036-pbs-symbol-documentation-and-hover-markdown/LSN-0057-compiler-owned-pbs-doc-markdown-for-editor-assistance.md","status":"done","created_at":"2026-07-15","updated_at":"2026-07-15"}]} {"type":"discussion","id":"DSC-0036","status":"done","ticket":"pbs-symbol-documentation-and-hover-markdown","title":"Modelo de documentacao de simbolos em PBS e consumo markdown no hover","created_at":"2026-05-08","updated_at":"2026-07-15","tags":["compiler","compiler-pbs","studio","lsp","vscode","editor","hover","documentation","markdown"],"agendas":[],"decisions":[],"plans":[],"lessons":[{"id":"LSN-0057","file":"discussion/lessons/DSC-0036-pbs-symbol-documentation-and-hover-markdown/LSN-0057-compiler-owned-pbs-doc-markdown-for-editor-assistance.md","status":"done","created_at":"2026-07-15","updated_at":"2026-07-15"}]}
@@ -0,0 +1,98 @@
---
id: LSN-0068
ticket: pbs-lsp-go-to-definition
title: PBS go-to-definition uses editorial lookup and physical files
created: 2026-09-21
tags: [studio, lsp, vscode, compiler-pbs, editor, definition]
---
# PBS go-to-definition uses editorial lookup and physical files
## Original Problem
PBS editor assistance already had compiler-backed completion, hover, and signature help (`LSN-0051`). Users still could not jump from a use to a declaration. Wave 1 explicitly deferred `go to definition`.
The remaining LSP navigation family (references, rename, workspace symbols, document links, hierarchy) needed a destination policy before those features could be honest. The risk was shipping a text search, a new `SymbolId` index, or virtual documents for stdlib before a real physical target existed.
## Consolidated Decision
PBS Go to Definition is the LSP projection of **physical declaration locations** on top of the **same editorial lookup hover already uses**.
Durable locks from `DEC-0052`:
1. Resolve the identifier under the cursor through the hover path (locals, parameters, members, imports/supplementals, current-module top-level). Do not use text search or a new usage index.
2. Keep the capability on the existing aggregated `FrontendLanguageService`. Add a default-empty `definition` method and a generic location DTO. Do not add a Definition SPI.
3. Map PBS editorial spans inside `prometeu-frontend-pbs`. Common LSP must not import `p.studio.compiler.pbs.*`.
4. Jump only when `Span.fileId` maps to a **regular filesystem file**. Otherwise return an empty list. Do not create virtual documents, `untitled:` buffers, or synthetic URIs.
5. The destination is the canonical declaration, not the import-alias line. Overloads return every matching location.
6. Advertise `definitionProvider`. Partial coverage is valid. Keywords, source-less builtins, unresolved names, and virtual stdlib paths stay empty; hover is unchanged.
7. Analysis stays request-local, like hover. This discussion does not build references, rename, or snapshot cache.
Spec 23 §8.3 already listed definition as an optional editor capability. It now also states: a definition location must identify a compiler-known physical source file, or the response must be empty.
## Final Implementation
| Layer | What landed |
|---|---|
| PBS editorial | `PbsEditorialSupportService.definition` reuses hover dispatch and attaches declaration `Span`s (`PbsEditorialLocation`). |
| Generic contract | `FrontendDefinitionLocation` (absolute path + offsets) and `FrontendLanguageService.definition` defaulting to `List.of()`. |
| PBS mapping | `PBSFrontendLanguageService` maps `FileId` through `fileTable` and keeps the location only if `Files.isRegularFile(path)`. |
| LSP | `LanguageServiceBridge.definition`, `definitionProvider`, `textDocument/definition`. Compile-only frontends return empty. |
| VS Code | Unchanged thin client. |
Stdlib and SDK modules are still registered under virtual paths such as `/virtual/stdlib/...`. Those handles are not regular files, so F12 on `Gfx.clear` is empty even though hover works. That is the physical-file rule, not a missing lookup.
The location payload (path + span of an already resolved symbol) is reusable later by references (`AGD-0043`) and rename (`AGD-0046`). Those indexes were not built here. Snapshots (`AGD-0051`) remain a later performance discussion, not a prerequisite for this request-local feature.
## Examples
Same-file jump:
```pbs
fn helper() -> int { return 42; }
fn frame() -> void {
helper(); // definition -> helper's declaration in this file
}
```
Aliased import jumps to the original declaration span, not the `import` line:
```pbs
import { Log as Logger } from @sdk:log;
Logger.info("hello");
```
If `@sdk:log` is only a virtual stdlib handle, definition is empty. If a project file owns the declaration and that file exists on disk, definition uses that path.
Builtins stay hover-only:
```pbs
let n: int = 1; // hover describes the builtin; definition is empty
```
## Pitfalls
Do not implement definition as a second name search in `lsp-v1` or in the VS Code extension. It will break on imports, overloads, and members, then be thrown away when references arrive.
Do not open `/virtual/stdlib/...` or invent an `untitled:` document so stdlib F12 “does something”. Empty is the honest result until those sources are real files.
Do not pick the first overload location in the server. Return the full `Location[]`.
Do not wait for snapshot cache before definition. Hover is already request-local; definition follows that shape.
Do not split a new top-level definition service “for future languages”. PBS is a real consumer of the existing language-service surface (`LSN-0067`).
Do not treat this lesson as closing references, rename, outline, workspace symbols, or document links. Those agendas stay open. This lesson only locks the destination policy they can reuse.
## References
- Agenda: `AGD-0042` (Q1–Q6 = A)
- Decision: `DEC-0052`
- Plan: `PLN-0131`
- Spec 23 §8.3 — optional definition capability; physical-file-or-empty
- `LSN-0051` — wave 1 deferred go-to-definition
- `LSN-0058` — generic `FrontendLanguageService` for LSP
- `LSN-0047` — protocol stays in `lsp-v1`; compiler owns semantics
- `LSN-0067` — no SPI or virtual-document host without a real consumer
- Still open: `AGD-0043` references, `AGD-0045` workspace symbols, `AGD-0046` rename, `AGD-0051` snapshots, `AGD-0055` document links, `AGD-0056` hierarchy
@@ -0,0 +1,111 @@
---
id: LSN-0069
ticket: pbs-lsp-find-references
title: PBS find-references is the physical inverse of definition
created: 2026-09-21
tags: [studio, lsp, vscode, compiler-pbs, editor, references]
---
# PBS find-references is the physical inverse of definition
## Original Problem
PBS already had compiler-backed completion, hover, signature help, and go-to-definition (`LSN-0051`, `LSN-0068`). Users still could not ask where a resolved symbol is used. Text search confuses overloads, shadowing, members, comments, and coincidental names. Rename (`AGD-0046`) and hierarchy (`AGD-0056`) need an honest usage list before they exist.
The risk was inventing a `SymbolId` / `RefIndex`, waiting for snapshot cache (`AGD-0051`), or listing uses of stdlib APIs whose declarations are still virtual paths.
## Consolidated Decision
PBS Find References is the LSP projection of **physical usage sites** of the **same identity definition already returns**.
Durable locks from `DEC-0053` (AGD-0043 Q1–Q6 = A):
1. Resolve the cursor through the definition path (locals, parameters, members, imports/supplementals, current-module top-level). Identity is that physical declaration-location set. Do not text-search. Do not add `SymbolId` or a persistent `RefIndex`.
2. A site is a usage when its definition locations intersect the cursor identity. Overloads follow that intersection.
3. If definition at the same offset is empty, references is empty.
4. Walk regular `fileTable` files from the current `analyze()` surface. Do not scan `/virtual/stdlib` or other non-regular handles.
5. Keep the capability on the existing aggregated `FrontendLanguageService`. Reuse `FrontendDefinitionLocation`. Map PBS spans in `prometeu-frontend-pbs`. Common LSP must not import `p.studio.compiler.pbs.*`. No References SPI.
6. Honor LSP `includeDeclaration` in the server: union usage sites with definition locations when the host asks and the declaration is a regular file. No read/write classification.
7. Advertise `referencesProvider`. Partial coverage is valid. Analysis stays request-local. This discussion does not build rename, hierarchy, workspace symbols, virtual documents, or snapshot cache.
Spec 23 §8.3 now also states: a references location must identify a compiler-known physical source file; empty definition implies empty references; `includeDeclaration` must not invent a virtual location.
## Final Implementation
| Layer | What landed |
|---|---|
| PBS editorial | `PbsEditorialSupportService.references` walks `IDENTIFIER` tokens and keeps sites whose `definition` locations intersect the cursor identity (`FileId` + start + end). |
| Generic contract | `FrontendLanguageService.references` defaults to `List.of()`. `FrontendEditorialContext.projectSurface` carries the PBS semantic read surface so the walk can see `astByFile`. |
| PBS mapping | `PBSFrontendLanguageService` requires a non-empty physical definition set, skips non-regular files, and maps surviving spans through the same `Files.isRegularFile` helper as definition. |
| LSP | `referencesProvider`, `textDocument/references`. The bridge applies `includeDeclaration` by unioning `references` with `definition`. Compile-only frontends stay empty. |
| VS Code | Unchanged thin client. |
Stdlib and SDK modules remain virtual (`/virtual/stdlib/...`). Shift+F12 on `Gfx.clear` is empty, matching F12. Hover is unchanged.
Local binding names are not usage sites: definition at `let total` is empty because the name is not yet in scope. The use `return total` matches. `includeDeclaration` adds the declaration span from definition, not a second name search.
## Examples
Same-file function uses, including the declaring identifier (top-level names resolve to themselves):
```pbs
fn helper() -> int { return 42; }
fn frame() -> void {
helper();
helper();
// helper // not a reference
let text = "helper"; // not a reference
}
```
Imported project (or otherwise physical) symbols collect uses in the importing file. Identity is the foreign declaration span.
```pbs
import { Log as Logger } from @sdk:log;
Logger.info("a");
Logger.info("b");
```
If `@sdk:log` is only a virtual handle, definition is empty, so references is empty.
Builtins stay hover-only:
```pbs
let n: int = 1; // hover works; references is empty
```
`includeDeclaration=true` adds the canonical declaration location on top of identifier usage sites. `false` returns usages only.
## Pitfalls
Do not implement find-references as workspace text search in `lsp-v1` or in the VS Code extension. It will lie about overloads, members, and imports, then poison rename.
Do not add a `SymbolId` index “for rename later”. Definition already gave the key: physical declaration locations. Rename can consume this list once it has its own decision.
Do not wait for snapshot cache. The LSP already reanalyzes on each editorial request. Snapshots (`AGD-0051`) can make the walk cheaper without changing the contract.
Do not treat empty stdlib references as a missing feature. Virtual paths are not regular files. Empty is the honest result until those sources live on disk.
Do not expect `let total` to appear as a usage of `total`. Inverse-of-definition only keeps identifier sites that themselves resolve. The declaration span arrives through `includeDeclaration`.
Do not put `includeDeclaration` into PBS types. It is a host flag applied in the LSP bridge.
Do not scan `/virtual/stdlib` to “find more uses”. That reopens virtual documents.
Do not split a References SPI “for future languages”. PBS is a real consumer of `FrontendLanguageService` (`LSN-0067`).
Do not treat this lesson as closing rename, snapshots, workspace symbols, document links, or hierarchy.
## References
- Agenda: `AGD-0043` (Q1–Q6 = A)
- Decision: `DEC-0053`
- Plan: `PLN-0132`
- Spec 23 §8.3 — optional navigation; physical-file-or-empty; empty definition implies empty references
- `LSN-0068` — definition identity this feature inverts
- `LSN-0051` — wave 1 deferred navigation
- `LSN-0058` — generic `FrontendLanguageService` for LSP
- `LSN-0047` — protocol stays in `lsp-v1`; compiler owns semantics
- `LSN-0067` — no SPI without a real in-repo consumer
- Still open: `AGD-0046` rename, `AGD-0045` workspace symbols, `AGD-0051` snapshots, `AGD-0055` document links, `AGD-0056` hierarchy
@@ -0,0 +1,141 @@
---
id: LSN-0070
ticket: pbs-lsp-document-symbols-outline
title: PBS outline is an AST-backed document-symbol tree
created: 2026-09-21
tags: [studio, lsp, vscode, compiler-pbs, editor, outline, document-symbols]
---
# PBS outline is an AST-backed document-symbol tree
## Original Problem
PBS already had compiler-backed completion, hover, signature help, go-to-definition (`LSN-0068`), and find-references (`LSN-0069`). VS Code Outline stayed empty. Long `.pbs` files had to be scanned by hand.
The risk was building outline from semantic success (so the tree vanishes while typing), flattening to `SymbolInformation`, inventing a Document Symbol SPI, or stuffing workspace search and folding into the same payload.
## Consolidated Decision
PBS Document Symbols is the LSP projection of the **named declaration tree of the open `.pbs` file**, with the **recovered AST as backbone**.
Durable locks from `DEC-0054` (AGD-0044 Q1 A, Q2 AST tree, Q3 A, Q4 A, Q5 A, Q6 `.pbs`-only, Q7 existing kinds):
1. Presence, hierarchy, and ranges come from the document AST. Kind and `detail` may use cheap semantic enrichment. Semantics must not drop a named declaration still in the syntax tree, and must not require full analysis.
2. Named `TopDecl` plus syntactic members:
- `fn` → Function, no children;
- `declare struct` → Struct, children: fields, `ctor`s, methods;
- `declare service` → Service, children: methods;
- `declare contract` → Contract, children: signatures as methods;
- `declare host` → Host, children: signatures;
- `declare builtin type` → Builtin type, children: projection fields and signatures;
- `declare enum` → Enum, children: cases;
- `declare error` → Error, children: labels;
- `declare callback` → Callback, no children;
- `declare global` / `const` → Global / Const, no children;
- `implements Contract for Owner` → top-level Contract named `contractName`, `detail` = owner name, children: methods.
Locals, parameters, `this`, imports, and comments stay out. Private fields stay in. Overloads stay siblings. Host and builtin type appear only if the open file declares them.
3. Recovered AST is enough. Unnamed `InvalidDecl` is omitted. Named decls survive later semantic errors. No `PbsAst.File` → empty list. Do not invent nodes from text or token pairs.
4. Keep the capability on aggregated `FrontendLanguageService.documentSymbols` (default empty) plus a hierarchical DTO (`name`, `kind`, optional `detail`, range offsets, selection offsets, `children`). No file path on the DTO. PBS builds the tree in `prometeu-frontend-pbs`. Common LSP must not import `p.studio.compiler.pbs.*`. No Document Symbol SPI.
5. Advertise `documentSymbolProvider`. Payload is hierarchical `DocumentSymbol`, not flat `SymbolInformation`. `range` is the declaration span. `selectionRange` is the name span only if the AST already has one; this wave reuses the declaration span. Do not scan tokens for identifier spans. VS Code stays a thin client.
6. First wave is the current `.pbs` only. Out: imported supplementals, `mod.barrel`, locals, parameters, imports, comments, virtual documents, workspace symbols, folding, rename, snapshot cache. Server order is AST declaration order, not alphabetical.
7. Reuse `FrontendSymbolKind` / `PbsEditorialSymbolKind`. LSP projects to the closest host `SymbolKind`. Name is the identifier. `detail` may carry the AST signature (`(a: int) -> int`). Attributes such as `[Init]` do not enter the name.
Outline does not jump to another file. The physical-file destination policy of definition/references is not the outline policy.
Spec 23 §8.3 now also states: document symbols are the named declaration tree of the requested document; recovered syntax is enough; a missing syntax tree is empty; this is not a workspace index, folding ranges, or a foreign-file navigation list.
## Final Implementation
| Layer | What landed |
|---|---|
| PBS editorial | `PbsAstDocumentSymbols` walks `PbsAst.File.topDecls` in source order. `PbsEditorialSupportService.documentSymbols` delegates to that walk. |
| Generic contract | `FrontendLanguageService.documentSymbols` defaults to `List.of()`. `FrontendDocumentSymbol` is hierarchical and pathless. |
| PBS mapping | `PBSFrontendLanguageService` requires `editorialContext.syntaxTree()` to be `PbsAst.File`. Barrels and unknown trees stay empty. Kinds map with `valueOf(kind.name())`. |
| LSP | `documentSymbolProvider`, `textDocument/documentSymbol`, hierarchical `DocumentSymbol`. Nested enum/error children project to `EnumMember`. Compile-only frontends stay empty. |
| VS Code | Unchanged thin client. |
`mod.barrel` is assembled as `BarrelFile`, not `PbsAst.File`, so `astByFile` has no barrel outline. Empty is the honest first-wave result.
Error case labels have no per-label span in the AST. Children reuse the parent `ErrorDecl` span rather than scanning tokens.
## Examples
Outline of a file is the declarations in that file, not imports or locals:
```pbs
import { Log } from @sdk:log;
fn helper() -> int { return 42; }
fn frame() -> void {
let local = 1;
helper(local);
}
```
Outline: `helper`, `frame`. Not `Log`, not `local`.
Struct members and overloads as siblings:
```pbs
declare struct Vec(x: int) {
ctor make(x: int) { return; }
fn blend(dx: int, dy: int) -> int { return dx; }
}
fn helper() -> int { return 42; }
fn helper(value: int) -> int { return value; }
```
Outline: `Vec` (`x`, `make`, `blend`), then two `helper` siblings. Private field `x` is present. `detail` on `blend` is `(dx: int, dy: int) -> int`.
Recovered parse keeps the named decl:
```pbs
declare ;
fn ok() -> int { return 1; }
```
Outline: `ok`. The unnamed `InvalidDecl` is omitted.
`[Init] fn init()` still names the symbol `init`.
`implements TickLike for Point` is a top-level node named `TickLike` with detail `Point`.
## Pitfalls
Do not wait for semantic analysis to succeed before showing outline. The tree must survive broken intermediate edits.
Do not omit private fields because they are not in `mod.barrel`. Outline is for the author of this file.
Do not collapse overloads. AST identity forbids merging declaration sets.
Do not walk `File.imports` or supplemental imported `TopDecl`s. Those symbols are not declared in this document.
Do not implement outline for `mod.barrel` in this contract. Barrel AST is a different root. Empty is correct until a later decision.
Do not scan tokens to invent a tighter `selectionRange`. This wave uses the declaration span.
Do not put a file path on `FrontendDocumentSymbol`. The host already has the document URI. Outline is not go-to-definition.
Do not reuse the physical-file jump rule of `LSN-0068` as an outline destination policy. Clicking outline stays inside the buffer.
Do not overload document symbols with folding or scope guides (`LSN-0034`, `AGD-0053`).
Do not split a Document Symbol SPI “for future languages”. PBS is a real consumer of `FrontendLanguageService` (`LSN-0067`).
Do not treat this lesson as closing workspace symbols, folding, rename, document links, or hierarchy.
## References
- Agenda: `AGD-0044` (Q1 A, Q2 AST tree, Q3 A, Q4 A, Q5 A, Q6 `.pbs`-only, Q7 existing kinds)
- Decision: `DEC-0054`
- Plan: `PLN-0133`
- Spec 23 §8.3 — optional document symbols; recovered AST tree of the requested document
- `LSN-0068` — definition is a jump; outline is not
- `LSN-0069` — references invert definition identity
- `LSN-0034` — do not overload document symbols with structural anchors
- `LSN-0058` — generic `FrontendLanguageService` for LSP
- `LSN-0047` — protocol stays in `lsp-v1`; compiler owns semantics
- `LSN-0067` — no SPI without a real in-repo consumer
- Still open: `AGD-0045` workspace symbols, `AGD-0046` rename, `AGD-0051` snapshots, `AGD-0053` folding, `AGD-0055` document links, `AGD-0056` hierarchy
@@ -0,0 +1,149 @@
---
id: LSN-0071
ticket: pbs-lsp-workspace-symbols
title: PBS workspace symbols are a physical named-declaration search
created: 2026-09-21
tags: [studio, lsp, vscode, compiler-pbs, editor, workspace-symbols]
---
# PBS workspace symbols are a physical named-declaration search
## Original Problem
PBS already had compiler-backed completion, hover, signature help, go-to-definition (`LSN-0068`), find-references (`LSN-0069`), and an AST-backed outline of the open `.pbs` file (`LSN-0070`). VS Code workspace search (`Ctrl+T` / `workspace/symbol`) stayed empty.
The risk was treating workspace symbols as a second outline, inventing a `SymbolId` index, waiting for snapshot cache (`AGD-0051`), or returning stdlib/SDK hits whose declarations are still virtual paths (`/virtual/stdlib`). Workspace symbols is a jump. Outline is not.
## Consolidated Decision
PBS Workspace Symbols is the LSP projection of a **flat named-declaration search** over **regular filesystem files** of the current analysis, flattening the **same outline set** and using the **same physical-file destination policy** as definition.
Durable locks from `DEC-0055` (AGD-0045 Q1 A, Q2 A, Q3 A, Q4 A, Q5 A, Q6 first-wave exclusions):
1. Emit only declarations whose `fileTable` handle is a regular filesystem file. Virtual stdlib/SDK, including `/virtual/stdlib`, is omitted. Do not invent virtual documents, `untitled:` buffers, or synthetic URIs.
2. `workspace/symbol` does not require an open text document. The server obtains the project analysis surface (`astByFile` / `projectSurface`) from `analyze()`. Missing surface → empty list.
3. The set is the flatten, file by file, of the named-declaration tree locked by outline (`LSN-0070`):
- `fn` → Function;
- `declare struct` → Struct plus fields, `ctor`s, methods;
- `declare service` → Service plus methods;
- `declare contract` → Contract plus signatures;
- `declare host` → Host plus signatures;
- `declare builtin type` → Builtin type plus projection fields and signatures;
- `declare enum` → Enum plus cases;
- `declare error` → Error plus labels;
- `declare callback` → Callback;
- `declare global` / `const` → Global / Const;
- `implements Contract for Owner` → `contractName`, kind CONTRACT, `detail` = owner, plus methods.
Locals, parameters, `this`, imports, and comments stay out. Private fields stay in. Overloads stay sibling hits. Unnamed `InvalidDecl` is omitted. Named decls survive later semantic errors.
4. First wave is `.pbs` whose recovered root is `PbsAst.File`. `mod.barrel` (`BarrelFile`) stays empty. Presence, name, kind, `detail`, and spans come from recovered AST. Do not invent nodes from text search.
5. Query is a case-insensitive substring of `name` only. Blank query returns the full first-wave corpus. Do not match `detail`, path, `containerName`, or qualified `Vec.blend`. No fuzzy ranking, no `top N`. After the filter, order is stable by name, then path, then start offset.
6. `containerName` is the parent name for members and empty for top-level declarations. `detail` may repeat the outline AST signature. Attributes such as `[Init]` do not enter the name.
7. Keep the capability on aggregated `FrontendLanguageService`. Add `workspaceSymbols` (default empty) plus a flat DTO with `name`, `kind`, optional `detail`, `containerName`, absolute path, and offsets. Do not reuse pathless `FrontendDocumentSymbol`. PBS flattens in `prometeu-frontend-pbs`. Common LSP must not import `p.studio.compiler.pbs.*`. No Workspace Symbol SPI, `SymbolId`, `RefIndex`, or snapshot cache.
8. Advertise `workspaceSymbolProvider` when the frontend exposes a language service. Payload is flat `SymbolInformation`. Do not emit hierarchical `DocumentSymbol` on this request. Compile-only frontends stay empty. VS Code stays a thin client.
Spec 23 §8.3 now also states: workspace symbols are a flat search of named declarations in compiler-known physical source files of the current analysis; recovered syntax is enough; a missing analysis surface is empty; the request must not require an open document; a declaration without a physical file is omitted; this is not outline, folding, a persistent index, or navigation to virtual locations.
## Final Implementation
| Layer | What landed |
|---|---|
| PBS editorial | `PbsAstWorkspaceSymbols` flattens `PbsAstDocumentSymbols` and filters by name. `PbsEditorialSupportService.workspaceSymbols(ast, query)` delegates to that flatten. |
| Generic contract | `FrontendWorkspaceRequest` (`projectRoot`, `query`). `FrontendWorkspaceSymbol` carries path. `FrontendLanguageService.workspaceSymbols` defaults to `List.of()`. `prepareEditorialContext(FrontendPhaseContext)` defaults to empty so a workspace request can obtain project surface without a `FileId`. |
| PBS mapping | Project-level `prepareEditorialContext` attaches `fileTable` + `astByFile`. Regular `PbsAst.File` entries are flattened; non-regular handles are skipped. Results sort by name, path, offset. |
| LSP | `workspaceSymbolProvider`, `workspace/symbol` on `PrometeuWorkspaceService` (no document URI). `CompilerLanguageServiceBridge` analyzes the project with an empty overlay map. Mapper emits flat `SymbolInformation`. Nested enum/error hits with a container project to `EnumMember`. Compile-only frontends stay empty. |
| VS Code | Unchanged thin client. |
`workspace/symbol` in this wave reads the project on disk. Unsaved editor overlays are not shared into the search. Empty is honest until a later overlay/snapshot decision.
`mod.barrel` is still `BarrelFile`, not `PbsAst.File`. Empty barrel hits are the honest first-wave result.
Error case labels still have no per-label span. Flattened children reuse the parent `ErrorDecl` span, same as outline.
## Examples
Workspace search of a project file is the flatten of that file's outline, not imports or locals:
```pbs
import { Log } from @sdk:log;
fn helper() -> int { return 42; }
fn frame() -> void {
let local = 1;
helper(local);
}
```
Query `frame` → `frame`. Query `helper` → `helper`. Query empty → `helper`, `frame` (plus other physical decls), sorted. Not `Log`, not `local`.
Members keep a container; overloads stay siblings:
```pbs
declare struct Vec(x: int) {
ctor make(x: int) { return; }
fn blend(dx: int, dy: int) -> int { return dx; }
}
fn helper() -> int { return 42; }
fn helper(value: int) -> int { return value; }
```
Query `blend` → method `blend` with `containerName` `Vec`. Query `helper` → two hits. Query `Vec.blend` → empty (this wave matches `name` only).
Stdlib remains hover-only while the handle is virtual:
```pbs
import { Gfx } from @sdk:gfx;
Gfx.clear(0);
```
Query `Gfx` is empty. F12 on `Gfx.clear` is already empty (`LSN-0068`). Workspace search does not reopen that jump.
Recovered parse keeps the named decl:
```pbs
declare ;
fn ok() -> int { return 1; }
```
Query empty → `ok`. The unnamed `InvalidDecl` is omitted.
`[Init] fn init()` still names the symbol `init`.
## Pitfalls
Do not implement workspace symbols as workspace text search in `lsp-v1` or in the VS Code extension. It will lie about overloads, members, and imports.
Do not reuse `FrontendDocumentSymbol`. Outline is pathless because the host already has the document URI. Workspace symbols is a jump and must carry a path.
Do not require an open editor buffer to answer `workspace/symbol`. Analyze the project and walk `astByFile`.
Do not include `/virtual/stdlib` so Ctrl+T on `Gfx` “does something”. Empty is the honest result until those sources are regular files.
Do not wait for snapshot cache. References already walks the current analysis request-locally. Snapshots (`AGD-0051`) can make the walk cheaper without changing this contract.
Do not add a `SymbolId` index “for rename later”. Outline already named the declarations; definition already named the destination.
Do not match `containerName`, path, or `Vec.blend` in this wave. The query is a substring of `name`.
Do not emit hierarchical `DocumentSymbol` on `workspace/symbol`. That payload is outline.
Do not treat unsaved overlay absence as a missing feature of this contract. First-wave analysis is the project on disk.
Do not split a Workspace Symbol SPI “for future languages”. PBS is a real consumer of `FrontendLanguageService` (`LSN-0067`).
Do not treat this lesson as closing rename, snapshots, folding, document links, or hierarchy.
## References
- Agenda: `AGD-0045` (Q1 A, Q2 A, Q3 A, Q4 A, Q5 A, Q6 first-wave exclusions)
- Decision: `DEC-0055`
- Plan: `PLN-0134`
- Spec 23 §8.3 — optional workspace symbols; physical-file-or-omit; no open document required
- `LSN-0070` — outline set this feature flattens
- `LSN-0068` — physical-file destination this feature reuses
- `LSN-0069` — project `astByFile` walk already exists for references
- `LSN-0058` — generic `FrontendLanguageService` for LSP
- `LSN-0047` — protocol stays in `lsp-v1`; compiler owns semantics
- `LSN-0067` — no SPI without a real in-repo consumer
- Still open: `AGD-0046` rename, `AGD-0051` snapshots, `AGD-0053` folding, `AGD-0055` document links, `AGD-0056` hierarchy
@@ -1,62 +0,0 @@
---
id: AGD-0042
ticket: pbs-lsp-go-to-definition
title: PBS LSP Go to Definition
status: open
created: 2026-07-15
resolved:
decision:
tags: [studio, lsp, vscode, compiler-pbs, editor, definition]
---
## Pain
Domain owner: `studio/lsp`
PBS users cannot jump from a symbol use to its declaration, which makes navigation across source files, stdlib imports, services, and generated/editorial surfaces slow and error-prone.
## Context
The current LSP exposes diagnostics, hover, completion, signature help, and semantic tokens. The compiler already builds semantic read surfaces and editorial symbol resolution for hover/completion, but there is no LSP definition capability or stable location mapping exposed to VS Code.
## Open Questions
- [ ] Which symbol categories must be supported in the first definition wave?
- [ ] Should stdlib and generated/supplemental declarations navigate to source files, virtual documents, or remain hover-only?
- [ ] What identity model should connect an editor token to the canonical declaration without relying on text search?
## Options
### Option A - Syntactic location lookup
- **Approach:** Use parser spans and local AST traversal to map the token under cursor to a declaration with matching text.
- **Pro:** Fast to implement and useful for same-file declarations.
- **Con:** Breaks on overloads, imports, stdlib, aliases, and same-name symbols.
- **Maintainability:** Weak; it creates a second navigation model separate from semantic resolution.
### Option B - Semantic identity lookup
- **Approach:** Extend the compiler/editorial surface with resolved declaration locations keyed by symbol identity, then expose `textDocument/definition`.
- **Pro:** Correct for imports, overloads, methods, stdlib-backed declarations, and future references/rename.
- **Con:** Requires explicit location metadata in semantic/editorial surfaces.
- **Maintainability:** Strong; it becomes shared infrastructure for references, rename, hierarchy, and code actions.
## Tradeoffs
The syntactic option is tempting for speed, but it would likely be thrown away once references and rename arrive. The main tradeoff is whether stdlib/supplemental declarations must navigate to physical files immediately or can initially return no location while still supporting project symbols.
## Recommendation
Prefer Option B. Build a reusable semantic location index and implement the first wave for project source declarations, then define a policy for stdlib/supplemental targets.
## Discussion
This should probably be the first navigation agenda to resolve because references, rename, workspace symbols, and hierarchy depend on the same symbol identity/location model.
## Resolution
Ainda em aberto.
## Next Step
Decide the first-wave symbol categories and whether stdlib/supplemental declarations require virtual document support.
@@ -1,62 +0,0 @@
---
id: AGD-0043
ticket: pbs-lsp-find-references
title: PBS LSP Find References
status: open
created: 2026-07-15
resolved:
decision:
tags: [studio, lsp, vscode, compiler-pbs, editor, references]
---
## Pain
Domain owner: `studio/lsp`
PBS users cannot ask where a symbol is used, so changes to functions, services, structs, constants, and stdlib-facing APIs require manual search that confuses overloads and unrelated text matches.
## Context
Completion and hover already resolve symbols in local editor context, but the LSP does not expose references and the compiler/editorial layer does not yet provide project-wide usage locations keyed by semantic identity.
## Open Questions
- [ ] Which declarations need reference tracking first: local functions, methods, types, constants, imports, stdlib symbols, or all of them?
- [ ] How should overloads and same-name symbols in different scopes be disambiguated?
- [ ] Should references include declarations, write/read classification, or only usage sites in the first wave?
## Options
### Option A - Text search with filters
- **Approach:** Search workspace text for the selected identifier and filter obvious false positives by token kind.
- **Pro:** Simple and fast for early demos.
- **Con:** Incorrect for overloads, scope, shadowing, fields, methods, imports, and generated/stdlib surfaces.
- **Maintainability:** Poor; later semantic references would duplicate and replace it.
### Option B - Semantic usage index
- **Approach:** During semantic analysis, emit definition and usage sites tied to stable symbol identities and expose `textDocument/references`.
- **Pro:** Correct foundation for rename, call hierarchy, diagnostics UX, and code actions.
- **Con:** Requires compiler-facing usage modeling and careful invalidation.
- **Maintainability:** Strong; one source of truth for all symbol usage features.
## Tradeoffs
Reference accuracy matters more than early breadth. False positives are worse than missing unsupported categories because users will trust rename and references for safe edits.
## Recommendation
Prefer Option B, but scope the first wave to project-owned declarations whose identity is already resolved reliably.
## Discussion
References should follow go-to-definition because both need the same identity and location model.
## Resolution
Ainda em aberto.
## Next Step
Define first-wave symbol categories and whether declarations are included in reference results.
@@ -1,62 +0,0 @@
---
id: AGD-0044
ticket: pbs-lsp-document-symbols-outline
title: PBS LSP Document Symbols and Outline
status: open
created: 2026-07-15
resolved:
decision:
tags: [studio, lsp, vscode, compiler-pbs, editor, outline, document-symbols]
---
## Pain
Domain owner: `studio/lsp`
PBS files do not populate a reliable VS Code outline, forcing users to navigate long source files manually instead of scanning declarations and members structurally.
## Context
The parser and semantic surfaces know top-level declarations and many member declarations. The LSP currently does not announce documentSymbolProvider and does not map PBS declarations to DocumentSymbol or SymbolInformation payloads.
## Open Questions
- [ ] Should the first outline be syntactic, semantic, or hybrid?
- [ ] Which hierarchy should be shown for structs, services, hosts, contracts, builtin types, enums, and methods?
- [ ] How should invalid or partially parsed files contribute to outline during editing?
## Options
### Option A - AST-only outline
- **Approach:** Map parsed declarations and member spans directly to LSP `DocumentSymbol`.
- **Pro:** Works even when semantic analysis is incomplete and gives immediate editor value.
- **Con:** Cannot classify every symbol with semantic precision.
- **Maintainability:** Good if kept as structural outline, not overloaded with semantic behavior.
### Option B - Semantic outline
- **Approach:** Build outline from semantic symbols after analysis.
- **Pro:** More accurate kinds and can hide invalid/unresolved surfaces.
- **Con:** More fragile during active editing and depends on full semantic success.
- **Maintainability:** Good for final precision, but heavier than needed for outline.
## Tradeoffs
Outline should remain available during broken intermediate edits. Semantic precision is useful, but not at the cost of disappearing structure while typing.
## Recommendation
Prefer Option A with semantic enrichment where available. Use AST spans as the stable backbone.
## Discussion
Document symbols are relatively independent and can be implemented before definition/references.
## Resolution
Ainda em aberto.
## Next Step
Decide hierarchy and symbol kinds for PBS declarations and members.
@@ -1,62 +0,0 @@
---
id: AGD-0045
ticket: pbs-lsp-workspace-symbols
title: PBS LSP Workspace Symbols
status: open
created: 2026-07-15
resolved:
decision:
tags: [studio, lsp, vscode, compiler-pbs, editor, workspace-symbols]
---
## Pain
Domain owner: `studio/lsp`
VS Code cannot search PBS symbols across the workspace, so users cannot quickly jump to functions, services, structs, constants, or stdlib-exposed APIs by name.
## Context
Document-level editorial features exist, but the LSP does not announce workspaceSymbolProvider and the compiler pipeline does not expose a project-wide symbol index designed for editor queries.
## Open Questions
- [ ] Should workspace symbols include only project files or also imported stdlib and SDK surfaces?
- [ ] What symbol kinds and ranking should be returned for duplicate names or overloads?
- [ ] Should the symbol index be cached from analysis snapshots or rebuilt per request in the first implementation?
## Options
### Option A - Project source index only
- **Approach:** Index project-owned declarations from analysis snapshots and expose `workspace/symbol`.
- **Pro:** Clear ownership and physical locations.
- **Con:** Does not help users discover stdlib/SDK symbols.
- **Maintainability:** Strong as a first wave.
### Option B - Project plus stdlib index
- **Approach:** Include project declarations and imported stdlib/SDK surfaces in the workspace symbol result set.
- **Pro:** Better discovery, especially for new users.
- **Con:** Requires a navigation policy for stdlib source or virtual targets.
- **Maintainability:** Good if stdlib target handling is solved; awkward otherwise.
## Tradeoffs
Workspace symbols are partly navigation and partly discovery. Including stdlib too early can create broken jumps if target locations are not defined.
## Recommendation
Prefer Option A first, then add stdlib once definition has a target policy.
## Discussion
This should follow document symbols and the semantic location/index work.
## Resolution
Ainda em aberto.
## Next Step
Decide whether first-wave workspace search includes stdlib or project-only symbols.
@@ -272,6 +272,14 @@ Absent editor capabilities MUST have deterministic fallback behavior at tooling
3. host protocols that can represent unsupported operations SHOULD do so explicitly; 3. host protocols that can represent unsupported operations SHOULD do so explicitly;
4. and absent editor capability MUST NOT be reported as a compiler failure. 4. and absent editor capability MUST NOT be reported as a compiler failure.
When a frontend exposes definition or navigation, each returned location MUST identify a compiler-known physical source file. A resolved symbol without a physical file MUST produce an empty definition response. Tooling MUST NOT require virtual documents, untitled buffers, or synthetic URIs for this capability.
When a frontend exposes find-references, each returned usage or declaration location MUST identify a compiler-known physical source file. A cursor offset whose definition response is empty MUST produce an empty references response. Host `includeDeclaration` MAY add the canonical declaration location only when that declaration is a compiler-known physical source file; it MUST NOT invent a virtual, untitled, or synthetic location.
When a frontend exposes document symbols or outline, the result MUST be the named declaration tree of the requested document. Presence, hierarchy, and ranges MUST come from that document's recovered syntax tree. Semantic success MUST NOT be required. Semantic enrichment MUST NOT drop a named declaration that the syntax tree still exposes. A missing syntax tree MUST produce an empty list. Document symbols MUST NOT be a workspace symbol index, folding ranges, or a navigation list of foreign files.
When a frontend exposes workspace symbols, the result MUST be a flat search of named declarations whose locations identify compiler-known physical source files of the current analysis. Presence, names, kinds, details, and ranges MUST come from the recovered syntax of those files. Semantic success MUST NOT be required. Semantic enrichment MUST NOT drop a named declaration that the syntax tree still exposes. A missing analysis surface MUST produce an empty list. The workspace-symbol request MUST NOT require an open text document. A declaration without a compiler-known physical file MUST be omitted. Tooling MUST NOT require virtual documents, untitled buffers, or synthetic URIs for this capability. Workspace symbols MUST NOT be a document outline, folding ranges, a persistent symbol index, or a navigation list of virtual locations.
Compiler diagnostics and editor diagnostics are distinct ownership surfaces. Diagnostics returned by `analyze`, `compile`, and `build` are compiler contract output. Editor diagnostics MAY reuse compiler analysis results, live overlays, caches, or cancellation-aware tooling state, but a frontend MUST NOT be required to provide editor diagnostics in order to compile. Compiler diagnostics and editor diagnostics are distinct ownership surfaces. Diagnostics returned by `analyze`, `compile`, and `build` are compiler contract output. Editor diagnostics MAY reuse compiler analysis results, live overlays, caches, or cancellation-aware tooling state, but a frontend MUST NOT be required to provide editor diagnostics in order to compile.
`FrontendSpec` remains the source of static frontend-owned presentation metadata such as semantic vocabularies, host projections, and visual themes. Producing semantic tokens for a live document is an optional editor-facing capability; the existence of static presentation metadata MUST NOT imply that every frontend can provide live semantic-token results. `FrontendSpec` remains the source of static frontend-owned presentation metadata such as semantic vocabularies, host projections, and visual themes. Producing semantic tokens for a live document is an optional editor-facing capability; the existence of static presentation metadata MUST NOT imply that every frontend can provide live semantic-token results.
@@ -6,12 +6,19 @@ import p.studio.compiler.messages.FrontendPhaseContext;
import p.studio.compiler.models.FrontendSemanticToken; import p.studio.compiler.models.FrontendSemanticToken;
import p.studio.compiler.pbs.ast.PbsAst; import p.studio.compiler.pbs.ast.PbsAst;
import p.studio.compiler.pbs.semantics.PbsEditorialCompletionCandidate; import p.studio.compiler.pbs.semantics.PbsEditorialCompletionCandidate;
import p.studio.compiler.pbs.semantics.PbsEditorialDocumentSymbol;
import p.studio.compiler.pbs.semantics.PbsEditorialLocation;
import p.studio.compiler.pbs.semantics.PbsEditorialResolvedSymbol; import p.studio.compiler.pbs.semantics.PbsEditorialResolvedSymbol;
import p.studio.compiler.pbs.semantics.PbsEditorialSignatureHelp; import p.studio.compiler.pbs.semantics.PbsEditorialSignatureHelp;
import p.studio.compiler.pbs.semantics.PbsEditorialSymbolKind; import p.studio.compiler.pbs.semantics.PbsEditorialSymbolKind;
import p.studio.compiler.pbs.semantics.PbsEditorialSupportService; import p.studio.compiler.pbs.semantics.PbsEditorialSupportService;
import p.studio.compiler.pbs.semantics.PbsEditorialSupportService.EditorialDocument;
import p.studio.compiler.pbs.semantics.PbsEditorialWorkspaceSymbol;
import p.studio.compiler.services.PBSFrontendPhaseService.PbsSemanticReadSurface;
import p.studio.compiler.services.FrontendCompletionCandidate; import p.studio.compiler.services.FrontendCompletionCandidate;
import p.studio.compiler.services.FrontendDefinitionLocation;
import p.studio.compiler.services.FrontendDocumentRequest; import p.studio.compiler.services.FrontendDocumentRequest;
import p.studio.compiler.services.FrontendDocumentSymbol;
import p.studio.compiler.services.FrontendDocumentation; import p.studio.compiler.services.FrontendDocumentation;
import p.studio.compiler.services.FrontendEditorialContext; import p.studio.compiler.services.FrontendEditorialContext;
import p.studio.compiler.services.FrontendHover; import p.studio.compiler.services.FrontendHover;
@@ -19,11 +26,20 @@ import p.studio.compiler.services.FrontendLanguageService;
import p.studio.compiler.services.FrontendSignature; import p.studio.compiler.services.FrontendSignature;
import p.studio.compiler.services.FrontendSignatureHelp; import p.studio.compiler.services.FrontendSignatureHelp;
import p.studio.compiler.services.FrontendSymbolKind; import p.studio.compiler.services.FrontendSymbolKind;
import p.studio.compiler.services.FrontendWorkspaceRequest;
import p.studio.compiler.services.FrontendWorkspaceSymbol;
import p.studio.compiler.services.PBSFrontendPhaseService; import p.studio.compiler.services.PBSFrontendPhaseService;
import p.studio.compiler.source.Span;
import p.studio.compiler.source.diagnostics.DiagnosticSink; import p.studio.compiler.source.diagnostics.DiagnosticSink;
import p.studio.compiler.source.identifiers.FileId; import p.studio.compiler.source.identifiers.FileId;
import p.studio.compiler.source.tables.FileTableReader;
import p.studio.utilities.structures.ReadOnlyList; import p.studio.utilities.structures.ReadOnlyList;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.ArrayList;
import java.util.Comparator;
import java.util.LinkedHashMap;
import java.util.List; import java.util.List;
import java.util.Objects; import java.util.Objects;
import java.util.Optional; import java.util.Optional;
@@ -43,6 +59,23 @@ public final class PBSFrontendLanguageService implements FrontendLanguageService
this.semanticTokenProvider = Objects.requireNonNull(semanticTokenProvider, "semanticTokenProvider"); this.semanticTokenProvider = Objects.requireNonNull(semanticTokenProvider, "semanticTokenProvider");
} }
@Override
public Optional<FrontendEditorialContext> prepareEditorialContext(final FrontendPhaseContext phaseContext) {
if (phaseContext == null) {
return Optional.empty();
}
final var semanticReadSurface = PBSFrontendPhaseService.semanticReadSurface(
phaseContext,
DiagnosticSink.empty(),
BuildingIssueSink.empty());
return Optional.of(new FrontendEditorialContext(
null,
ReadOnlyList.empty(),
phaseContext.feSurfaceContext(),
phaseContext.fileTable,
semanticReadSurface));
}
@Override @Override
public Optional<FrontendEditorialContext> prepareEditorialContext( public Optional<FrontendEditorialContext> prepareEditorialContext(
final FrontendPhaseContext phaseContext, final FrontendPhaseContext phaseContext,
@@ -61,7 +94,9 @@ public final class PBSFrontendLanguageService implements FrontendLanguageService
return Optional.of(new FrontendEditorialContext( return Optional.of(new FrontendEditorialContext(
ast, ast,
semanticReadSurface.supplementalTopDeclsByFile().getOrDefault(fileId, ReadOnlyList.empty()), semanticReadSurface.supplementalTopDeclsByFile().getOrDefault(fileId, ReadOnlyList.empty()),
phaseContext.feSurfaceContext())); phaseContext.feSurfaceContext(),
phaseContext.fileTable,
semanticReadSurface));
} }
public List<PbsEditorialCompletionCandidate> completion( public List<PbsEditorialCompletionCandidate> completion(
@@ -167,6 +202,141 @@ public final class PBSFrontendLanguageService implements FrontendLanguageService
.orElseGet(FrontendSignatureHelp::empty); .orElseGet(FrontendSignatureHelp::empty);
} }
public List<PbsEditorialLocation> definition(
final String sourceText,
final PbsAst.File ast,
final ReadOnlyList<PbsAst.TopDecl> supplementalTopDecls,
final FESurfaceContext feSurfaceContext,
final int offset) {
return editorialSupportService.definition(sourceText, ast, supplementalTopDecls, feSurfaceContext, offset);
}
@Override
public List<FrontendDefinitionLocation> definition(
final FrontendDocumentRequest request,
final FrontendEditorialContext editorialContext,
final int offset) {
if (request == null
|| editorialContext == null
|| !(editorialContext.syntaxTree() instanceof PbsAst.File ast)
|| !(editorialContext.supplementalDeclarations() instanceof ReadOnlyList<?> supplementalTopDecls)
|| !(editorialContext.semanticContext() instanceof FESurfaceContext feSurfaceContext)
|| !(editorialContext.sourceFiles() instanceof FileTableReader fileTable)) {
return List.of();
}
@SuppressWarnings("unchecked")
final ReadOnlyList<PbsAst.TopDecl> typedSupplementalTopDecls =
(ReadOnlyList<PbsAst.TopDecl>) supplementalTopDecls;
final ArrayList<FrontendDefinitionLocation> locations = new ArrayList<>();
for (final PbsEditorialLocation location : definition(
request.documentText(),
ast,
typedSupplementalTopDecls,
feSurfaceContext,
offset)) {
toFrontendLocation(location, fileTable).ifPresent(locations::add);
}
return List.copyOf(locations);
}
@Override
public List<FrontendDefinitionLocation> references(
final FrontendDocumentRequest request,
final FrontendEditorialContext editorialContext,
final int offset) {
if (request == null
|| editorialContext == null
|| !(editorialContext.syntaxTree() instanceof PbsAst.File ast)
|| !(editorialContext.supplementalDeclarations() instanceof ReadOnlyList<?> supplementalTopDecls)
|| !(editorialContext.semanticContext() instanceof FESurfaceContext feSurfaceContext)
|| !(editorialContext.sourceFiles() instanceof FileTableReader fileTable)) {
return List.of();
}
@SuppressWarnings("unchecked")
final ReadOnlyList<PbsAst.TopDecl> typedSupplementalTopDecls =
(ReadOnlyList<PbsAst.TopDecl>) supplementalTopDecls;
final List<PbsEditorialLocation> editorialIdentity = definition(
request.documentText(),
ast,
typedSupplementalTopDecls,
feSurfaceContext,
offset);
final ArrayList<PbsEditorialLocation> physicalIdentity = new ArrayList<>();
for (final PbsEditorialLocation location : editorialIdentity) {
if (toFrontendLocation(location, fileTable).isPresent()) {
physicalIdentity.add(location);
}
}
if (physicalIdentity.isEmpty()) {
return List.of();
}
final EditorialDocument cursorDocument = new EditorialDocument(
request.documentText(),
ast,
typedSupplementalTopDecls,
feSurfaceContext);
final List<PbsEditorialLocation> usages = editorialSupportService.references(
cursorDocument,
offset,
projectDocuments(request, editorialContext, cursorDocument, fileTable));
final LinkedHashMap<String, FrontendDefinitionLocation> mapped = new LinkedHashMap<>();
for (final PbsEditorialLocation usage : usages) {
toFrontendLocation(usage, fileTable).ifPresent(location ->
mapped.putIfAbsent(frontendLocationKey(location), location));
}
return List.copyOf(mapped.values());
}
@Override
public List<FrontendDocumentSymbol> documentSymbols(
final FrontendDocumentRequest request,
final FrontendEditorialContext editorialContext) {
if (editorialContext == null || !(editorialContext.syntaxTree() instanceof PbsAst.File ast)) {
return List.of();
}
return editorialSupportService.documentSymbols(ast).stream()
.map(this::toFrontendDocumentSymbol)
.toList();
}
@Override
public List<FrontendWorkspaceSymbol> workspaceSymbols(
final FrontendWorkspaceRequest request,
final FrontendEditorialContext editorialContext) {
if (request == null
|| editorialContext == null
|| !(editorialContext.sourceFiles() instanceof FileTableReader fileTable)
|| !(editorialContext.projectSurface() instanceof PbsSemanticReadSurface surface)
|| surface.astByFile() == null
|| surface.astByFile().isEmpty()) {
return List.of();
}
final ArrayList<FrontendWorkspaceSymbol> symbols = new ArrayList<>();
for (final var entry : surface.astByFile().entrySet()) {
final Path path = pathForRegularSource(entry.getKey(), fileTable);
if (path == null) {
continue;
}
final PbsAst.File fileAst = entry.getValue();
if (fileAst == null) {
continue;
}
for (final PbsEditorialWorkspaceSymbol symbol : editorialSupportService.workspaceSymbols(
fileAst,
request.query())) {
toFrontendWorkspaceSymbol(symbol, path).ifPresent(symbols::add);
}
}
symbols.sort(Comparator
.comparing(FrontendWorkspaceSymbol::name, String.CASE_INSENSITIVE_ORDER)
.thenComparing(symbol -> symbol.path().toString())
.thenComparingInt(FrontendWorkspaceSymbol::startOffset));
return List.copyOf(symbols);
}
@Override @Override
public List<FrontendSemanticToken> semanticTokens(final FrontendDocumentRequest request) { public List<FrontendSemanticToken> semanticTokens(final FrontendDocumentRequest request) {
return semanticTokens(request == null ? "" : request.documentText()); return semanticTokens(request == null ? "" : request.documentText());
@@ -213,4 +383,142 @@ public final class PBSFrontendLanguageService implements FrontendLanguageService
private FrontendSymbolKind toFrontendSymbolKind(final PbsEditorialSymbolKind kind) { private FrontendSymbolKind toFrontendSymbolKind(final PbsEditorialSymbolKind kind) {
return FrontendSymbolKind.valueOf(kind.name()); return FrontendSymbolKind.valueOf(kind.name());
} }
private Optional<FrontendWorkspaceSymbol> toFrontendWorkspaceSymbol(
final PbsEditorialWorkspaceSymbol symbol,
final Path path) {
if (symbol == null || path == null || symbol.span() == null || symbol.span().isNone()) {
return Optional.empty();
}
return Optional.of(new FrontendWorkspaceSymbol(
symbol.name(),
toFrontendSymbolKind(symbol.kind()),
symbol.detail(),
symbol.containerName(),
path,
toOffset(symbol.span().getStart()),
toOffset(symbol.span().getEnd())));
}
private FrontendDocumentSymbol toFrontendDocumentSymbol(final PbsEditorialDocumentSymbol symbol) {
final int start = toOffset(symbol.span().getStart());
final int end = toOffset(symbol.span().getEnd());
return new FrontendDocumentSymbol(
symbol.name(),
toFrontendSymbolKind(symbol.kind()),
symbol.detail(),
start,
end,
start,
end,
symbol.children().stream().map(this::toFrontendDocumentSymbol).toList());
}
private List<EditorialDocument> projectDocuments(
final FrontendDocumentRequest request,
final FrontendEditorialContext editorialContext,
final EditorialDocument cursorDocument,
final FileTableReader fileTable) {
if (!(editorialContext.projectSurface() instanceof PbsSemanticReadSurface surface)
|| surface.astByFile() == null
|| surface.astByFile().isEmpty()) {
return List.of(cursorDocument);
}
final ArrayList<EditorialDocument> documents = new ArrayList<>();
for (final var entry : surface.astByFile().entrySet()) {
if (!isRegularSource(entry.getKey(), fileTable)) {
continue;
}
final PbsAst.File fileAst = entry.getValue();
if (fileAst == null) {
continue;
}
final ReadOnlyList<PbsAst.TopDecl> fileSupplementals = fileAst == cursorDocument.ast()
? cursorDocument.supplementalTopDecls()
: surface.supplementalTopDeclsByFile().getOrDefault(entry.getKey(), ReadOnlyList.empty());
documents.add(new EditorialDocument(
textForFile(entry.getKey(), fileTable, request),
fileAst,
fileSupplementals,
cursorDocument.feSurfaceContext()));
}
if (documents.isEmpty()) {
return List.of(cursorDocument);
}
return List.copyOf(documents);
}
private Path pathForRegularSource(
final FileId fileId,
final FileTableReader fileTable) {
if (!isRegularSource(fileId, fileTable)) {
return null;
}
return fileTable.get(fileId).getCanonPath().toAbsolutePath().normalize();
}
private boolean isRegularSource(
final FileId fileId,
final FileTableReader fileTable) {
if (fileId == null || fileId.isNone() || fileTable == null) {
return false;
}
final var sourceHandle = fileTable.get(fileId);
if (sourceHandle == null || sourceHandle.getCanonPath() == null) {
return false;
}
return Files.isRegularFile(sourceHandle.getCanonPath().toAbsolutePath().normalize());
}
private String textForFile(
final FileId fileId,
final FileTableReader fileTable,
final FrontendDocumentRequest request) {
final var sourceHandle = fileTable.get(fileId);
if (sourceHandle == null || sourceHandle.getCanonPath() == null) {
return "";
}
final Path path = sourceHandle.getCanonPath().toAbsolutePath().normalize();
if (request != null
&& request.documentPath() != null
&& path.equals(request.documentPath().toAbsolutePath().normalize())) {
return request.documentText() == null ? "" : request.documentText();
}
return sourceHandle.readUtf8().orElse("");
}
private static String frontendLocationKey(final FrontendDefinitionLocation location) {
return location.path() + ":" + location.startOffset() + ":" + location.endOffset();
}
private Optional<FrontendDefinitionLocation> toFrontendLocation(
final PbsEditorialLocation location,
final FileTableReader fileTable) {
if (location == null || fileTable == null) {
return Optional.empty();
}
final Span span = location.span();
if (span == null || span.isNone() || span.getFileId() == null || span.getFileId().isNone()) {
return Optional.empty();
}
final var sourceHandle = fileTable.get(span.getFileId());
if (sourceHandle == null || sourceHandle.getCanonPath() == null) {
return Optional.empty();
}
final Path path = sourceHandle.getCanonPath().toAbsolutePath().normalize();
if (!Files.isRegularFile(path)) {
return Optional.empty();
}
return Optional.of(new FrontendDefinitionLocation(
path,
toOffset(span.getStart()),
toOffset(span.getEnd())));
}
private static int toOffset(final long value) {
if (value <= 0L) {
return 0;
}
return (int) Math.min(Integer.MAX_VALUE, value);
}
} }
@@ -0,0 +1,321 @@
package p.studio.compiler.pbs.semantics;
import p.studio.compiler.pbs.ast.PbsAst;
import p.studio.compiler.source.Span;
import p.studio.utilities.structures.ReadOnlyList;
import java.util.ArrayList;
import java.util.List;
import java.util.Optional;
final class PbsAstDocumentSymbols {
private PbsAstDocumentSymbols() {
}
static List<PbsEditorialDocumentSymbol> list(final PbsAst.File ast) {
if (ast == null || ast.topDecls() == null) {
return List.of();
}
final ArrayList<PbsEditorialDocumentSymbol> symbols = new ArrayList<>();
for (final PbsAst.TopDecl topDecl : ast.topDecls()) {
symbolFor(topDecl).ifPresent(symbols::add);
}
return List.copyOf(symbols);
}
private static Optional<PbsEditorialDocumentSymbol> symbolFor(final PbsAst.TopDecl topDecl) {
if (topDecl instanceof PbsAst.FunctionDecl functionDecl) {
return callableSymbol(
functionDecl.name(),
PbsEditorialSymbolKind.FUNCTION,
functionDecl.parameters(),
functionDecl.returnKind(),
functionDecl.returnType(),
functionDecl.resultErrorType(),
functionDecl.span());
}
if (topDecl instanceof PbsAst.StructDecl structDecl) {
return structSymbol(structDecl);
}
if (topDecl instanceof PbsAst.ServiceDecl serviceDecl) {
return namedSymbol(
serviceDecl.name(),
PbsEditorialSymbolKind.SERVICE,
"",
serviceDecl.span(),
methodSymbols(serviceDecl.methods()));
}
if (topDecl instanceof PbsAst.ContractDecl contractDecl) {
return namedSymbol(
contractDecl.name(),
PbsEditorialSymbolKind.CONTRACT,
"",
contractDecl.span(),
signatureSymbols(contractDecl.signatures()));
}
if (topDecl instanceof PbsAst.HostDecl hostDecl) {
return namedSymbol(
hostDecl.name(),
PbsEditorialSymbolKind.HOST,
"",
hostDecl.span(),
signatureSymbols(hostDecl.signatures()));
}
if (topDecl instanceof PbsAst.BuiltinTypeDecl builtinTypeDecl) {
return builtinTypeSymbol(builtinTypeDecl);
}
if (topDecl instanceof PbsAst.EnumDecl enumDecl) {
return enumSymbol(enumDecl);
}
if (topDecl instanceof PbsAst.ErrorDecl errorDecl) {
return errorSymbol(errorDecl);
}
if (topDecl instanceof PbsAst.CallbackDecl callbackDecl) {
return callableSymbol(
callbackDecl.name(),
PbsEditorialSymbolKind.CALLBACK,
callbackDecl.parameters(),
callbackDecl.returnKind(),
callbackDecl.returnType(),
callbackDecl.resultErrorType(),
callbackDecl.span());
}
if (topDecl instanceof PbsAst.GlobalDecl globalDecl) {
return namedSymbol(
globalDecl.name(),
PbsEditorialSymbolKind.GLOBAL,
formatTypeRef(globalDecl.explicitType()),
globalDecl.span(),
List.of());
}
if (topDecl instanceof PbsAst.ConstDecl constDecl) {
return namedSymbol(
constDecl.name(),
PbsEditorialSymbolKind.CONST,
formatTypeRef(constDecl.explicitType()),
constDecl.span(),
List.of());
}
if (topDecl instanceof PbsAst.ImplementsDecl implementsDecl) {
return namedSymbol(
implementsDecl.contractName(),
PbsEditorialSymbolKind.CONTRACT,
implementsDecl.ownerName() == null ? "" : implementsDecl.ownerName(),
implementsDecl.span(),
methodSymbols(implementsDecl.methods()));
}
return Optional.empty();
}
private static Optional<PbsEditorialDocumentSymbol> structSymbol(final PbsAst.StructDecl structDecl) {
final ArrayList<PbsEditorialDocumentSymbol> children = new ArrayList<>();
for (final PbsAst.StructField field : structDecl.fields()) {
namedSymbol(
field.name(),
PbsEditorialSymbolKind.FIELD,
formatTypeRef(field.typeRef()),
field.span(),
List.of()).ifPresent(children::add);
}
for (final PbsAst.CtorDecl ctorDecl : structDecl.ctors()) {
namedSymbol(
ctorDecl.name(),
PbsEditorialSymbolKind.CONSTRUCTOR,
ctorDetail(ctorDecl.parameters()),
ctorDecl.span(),
List.of()).ifPresent(children::add);
}
children.addAll(methodSymbols(structDecl.methods()));
return namedSymbol(
structDecl.name(),
PbsEditorialSymbolKind.STRUCT,
"",
structDecl.span(),
children);
}
private static Optional<PbsEditorialDocumentSymbol> builtinTypeSymbol(final PbsAst.BuiltinTypeDecl builtinTypeDecl) {
final ArrayList<PbsEditorialDocumentSymbol> children = new ArrayList<>();
for (final PbsAst.BuiltinFieldDecl field : builtinTypeDecl.fields()) {
namedSymbol(
field.name(),
PbsEditorialSymbolKind.FIELD,
formatTypeRef(field.typeRef()),
field.span(),
List.of()).ifPresent(children::add);
}
children.addAll(signatureSymbols(builtinTypeDecl.signatures()));
return namedSymbol(
builtinTypeDecl.name(),
PbsEditorialSymbolKind.BUILTIN_TYPE,
"",
builtinTypeDecl.span(),
children);
}
private static Optional<PbsEditorialDocumentSymbol> enumSymbol(final PbsAst.EnumDecl enumDecl) {
final ArrayList<PbsEditorialDocumentSymbol> children = new ArrayList<>();
for (final PbsAst.EnumCase enumCase : enumDecl.cases()) {
final String detail = enumCase.explicitValue() == null ? "" : String.valueOf(enumCase.explicitValue());
namedSymbol(
enumCase.name(),
PbsEditorialSymbolKind.ENUM,
detail,
enumCase.span(),
List.of()).ifPresent(children::add);
}
return namedSymbol(
enumDecl.name(),
PbsEditorialSymbolKind.ENUM,
"",
enumDecl.span(),
children);
}
private static Optional<PbsEditorialDocumentSymbol> errorSymbol(final PbsAst.ErrorDecl errorDecl) {
final ArrayList<PbsEditorialDocumentSymbol> children = new ArrayList<>();
for (final String label : errorDecl.cases()) {
namedSymbol(
label,
PbsEditorialSymbolKind.ERROR,
"",
errorDecl.span(),
List.of()).ifPresent(children::add);
}
return namedSymbol(
errorDecl.name(),
PbsEditorialSymbolKind.ERROR,
"",
errorDecl.span(),
children);
}
private static List<PbsEditorialDocumentSymbol> methodSymbols(final ReadOnlyList<PbsAst.FunctionDecl> methods) {
if (methods == null || methods.isEmpty()) {
return List.of();
}
final ArrayList<PbsEditorialDocumentSymbol> symbols = new ArrayList<>();
for (final PbsAst.FunctionDecl method : methods) {
callableSymbol(
method.name(),
PbsEditorialSymbolKind.METHOD,
method.parameters(),
method.returnKind(),
method.returnType(),
method.resultErrorType(),
method.span()).ifPresent(symbols::add);
}
return symbols;
}
private static List<PbsEditorialDocumentSymbol> signatureSymbols(
final ReadOnlyList<PbsAst.FunctionSignature> signatures) {
if (signatures == null || signatures.isEmpty()) {
return List.of();
}
final ArrayList<PbsEditorialDocumentSymbol> symbols = new ArrayList<>();
for (final PbsAst.FunctionSignature signature : signatures) {
callableSymbol(
signature.name(),
PbsEditorialSymbolKind.METHOD,
signature.parameters(),
signature.returnKind(),
signature.returnType(),
signature.resultErrorType(),
signature.span()).ifPresent(symbols::add);
}
return symbols;
}
private static Optional<PbsEditorialDocumentSymbol> callableSymbol(
final String name,
final PbsEditorialSymbolKind kind,
final ReadOnlyList<PbsAst.Parameter> parameters,
final PbsAst.ReturnKind returnKind,
final PbsAst.TypeRef returnType,
final PbsAst.TypeRef resultErrorType,
final Span span) {
return namedSymbol(
name,
kind,
callableDetail(parameters, returnKind, returnType, resultErrorType),
span,
List.of());
}
private static Optional<PbsEditorialDocumentSymbol> namedSymbol(
final String name,
final PbsEditorialSymbolKind kind,
final String detail,
final Span span,
final List<PbsEditorialDocumentSymbol> children) {
if (name == null || name.isBlank() || span == null || span.isNone()) {
return Optional.empty();
}
return Optional.of(new PbsEditorialDocumentSymbol(name, kind, detail, span, children));
}
private static String callableDetail(
final ReadOnlyList<PbsAst.Parameter> parameters,
final PbsAst.ReturnKind returnKind,
final PbsAst.TypeRef returnType,
final PbsAst.TypeRef resultErrorType) {
return "(" + formatParameters(parameters) + ") -> " + formatReturn(returnKind, returnType, resultErrorType);
}
private static String ctorDetail(final ReadOnlyList<PbsAst.Parameter> parameters) {
return "(" + formatParameters(parameters) + ")";
}
private static String formatParameters(final ReadOnlyList<PbsAst.Parameter> parameters) {
if (parameters == null || parameters.isEmpty()) {
return "";
}
final ArrayList<String> parts = new ArrayList<>(parameters.size());
for (final PbsAst.Parameter parameter : parameters) {
parts.add(parameter.name() + ": " + formatTypeRef(parameter.typeRef()));
}
return String.join(", ", parts);
}
private static String formatReturn(
final PbsAst.ReturnKind returnKind,
final PbsAst.TypeRef returnType,
final PbsAst.TypeRef resultErrorType) {
if (returnKind == null) {
return formatTypeRef(returnType);
}
return switch (returnKind) {
case INFERRED_UNIT, EXPLICIT_UNIT -> "void";
case PLAIN -> formatTypeRef(returnType);
case RESULT -> {
final String errorType = formatTypeRef(resultErrorType);
if (returnType == null || returnType.kind() == PbsAst.TypeRefKind.UNIT) {
yield "result<" + errorType + ">";
}
yield "result<" + errorType + "> " + formatTypeRef(returnType);
}
};
}
private static String formatTypeRef(final PbsAst.TypeRef typeRef) {
if (typeRef == null) {
return "void";
}
return switch (typeRef.kind()) {
case UNIT -> typeRef.name() == null || typeRef.name().isBlank() ? "void" : typeRef.name();
case SELF -> "Self";
case SIMPLE -> typeRef.name() == null ? "void" : typeRef.name();
case OPTIONAL -> "optional " + formatTypeRef(typeRef.inner());
case GROUP -> "(" + formatTypeRef(typeRef.inner()) + ")";
case NAMED_TUPLE -> {
final ArrayList<String> fields = new ArrayList<>(typeRef.fields().size());
for (final var field : typeRef.fields()) {
fields.add(field.label() + ": " + formatTypeRef(field.typeRef()));
}
yield "(" + String.join(", ", fields) + ")";
}
case ERROR -> "unknown";
};
}
}
@@ -0,0 +1,55 @@
package p.studio.compiler.pbs.semantics;
import p.studio.compiler.pbs.ast.PbsAst;
import java.util.ArrayList;
import java.util.List;
import java.util.Locale;
final class PbsAstWorkspaceSymbols {
private PbsAstWorkspaceSymbols() {
}
static List<PbsEditorialWorkspaceSymbol> list(
final PbsAst.File ast,
final String query) {
if (ast == null) {
return List.of();
}
final ArrayList<PbsEditorialWorkspaceSymbol> symbols = new ArrayList<>();
for (final PbsEditorialDocumentSymbol topDecl : PbsAstDocumentSymbols.list(ast)) {
flatten(topDecl, "", query, symbols);
}
return List.copyOf(symbols);
}
private static void flatten(
final PbsEditorialDocumentSymbol symbol,
final String containerName,
final String query,
final ArrayList<PbsEditorialWorkspaceSymbol> symbols) {
if (matches(symbol.name(), query)) {
symbols.add(new PbsEditorialWorkspaceSymbol(
symbol.name(),
symbol.kind(),
symbol.detail(),
containerName,
symbol.span()));
}
for (final PbsEditorialDocumentSymbol child : symbol.children()) {
flatten(child, symbol.name(), query, symbols);
}
}
static boolean matches(
final String name,
final String query) {
if (name == null || name.isBlank()) {
return false;
}
if (query == null || query.isBlank()) {
return true;
}
return name.toLowerCase(Locale.ROOT).contains(query.trim().toLowerCase(Locale.ROOT));
}
}
@@ -0,0 +1,22 @@
package p.studio.compiler.pbs.semantics;
import p.studio.compiler.source.Span;
import java.util.List;
import java.util.Objects;
public record PbsEditorialDocumentSymbol(
String name,
PbsEditorialSymbolKind kind,
String detail,
Span span,
List<PbsEditorialDocumentSymbol> children) {
public PbsEditorialDocumentSymbol {
name = Objects.requireNonNull(name, "name").trim();
kind = Objects.requireNonNull(kind, "kind");
detail = detail == null ? "" : detail;
span = Objects.requireNonNull(span, "span");
children = children == null ? List.of() : List.copyOf(children);
}
}
@@ -0,0 +1,11 @@
package p.studio.compiler.pbs.semantics;
import p.studio.compiler.source.Span;
import java.util.Objects;
public record PbsEditorialLocation(Span span) {
public PbsEditorialLocation {
Objects.requireNonNull(span, "span");
}
}
@@ -74,6 +74,100 @@ public final class PbsEditorialSupportService {
return context.resolveSymbolHover(token.lexeme(), tokenIndex, scopeState); return context.resolveSymbolHover(token.lexeme(), tokenIndex, scopeState);
} }
public List<PbsEditorialDocumentSymbol> documentSymbols(final PbsAst.File ast) {
return PbsAstDocumentSymbols.list(ast);
}
public List<PbsEditorialWorkspaceSymbol> workspaceSymbols(
final PbsAst.File ast,
final String query) {
return PbsAstWorkspaceSymbols.list(ast, query);
}
public List<PbsEditorialLocation> definition(
final String sourceText,
final PbsAst.File ast,
final ReadOnlyList<PbsAst.TopDecl> supplementalTopDecls,
final int offset) {
return definition(sourceText, ast, supplementalTopDecls, FESurfaceContext.empty(), offset);
}
public List<PbsEditorialLocation> definition(
final String sourceText,
final PbsAst.File ast,
final ReadOnlyList<PbsAst.TopDecl> supplementalTopDecls,
final FESurfaceContext feSurfaceContext,
final int offset) {
return buildContext(sourceText, ast, supplementalTopDecls, feSurfaceContext).definitionAt(offset);
}
public List<PbsEditorialLocation> references(
final String sourceText,
final PbsAst.File ast,
final ReadOnlyList<PbsAst.TopDecl> supplementalTopDecls,
final int offset) {
return references(sourceText, ast, supplementalTopDecls, FESurfaceContext.empty(), offset);
}
public List<PbsEditorialLocation> references(
final String sourceText,
final PbsAst.File ast,
final ReadOnlyList<PbsAst.TopDecl> supplementalTopDecls,
final FESurfaceContext feSurfaceContext,
final int offset) {
final EditorialDocument cursor = new EditorialDocument(sourceText, ast, supplementalTopDecls, feSurfaceContext);
return references(cursor, offset, List.of(cursor));
}
public List<PbsEditorialLocation> references(
final EditorialDocument cursorDocument,
final int offset,
final List<EditorialDocument> projectDocuments) {
if (cursorDocument == null) {
return List.of();
}
final List<PbsEditorialLocation> identity = definition(
cursorDocument.sourceText(),
cursorDocument.ast(),
cursorDocument.supplementalTopDecls(),
cursorDocument.feSurfaceContext(),
offset);
if (identity.isEmpty()) {
return List.of();
}
final Set<String> identityKeys = locationKeys(identity);
final LinkedHashMap<String, PbsEditorialLocation> usages = new LinkedHashMap<>();
final List<EditorialDocument> documents = projectDocuments == null || projectDocuments.isEmpty()
? List.of(cursorDocument)
: projectDocuments;
for (final EditorialDocument document : documents) {
if (document == null || document.ast() == null) {
continue;
}
for (final PbsEditorialLocation usage : buildContext(
document.sourceText(),
document.ast(),
document.supplementalTopDecls(),
document.feSurfaceContext()).usagesMatching(identityKeys)) {
usages.putIfAbsent(locationKey(usage.span()), usage);
}
}
return List.copyOf(usages.values());
}
public record EditorialDocument(
String sourceText,
PbsAst.File ast,
ReadOnlyList<PbsAst.TopDecl> supplementalTopDecls,
FESurfaceContext feSurfaceContext) {
public EditorialDocument {
sourceText = sourceText == null ? "" : sourceText;
Objects.requireNonNull(ast, "ast");
supplementalTopDecls = supplementalTopDecls == null ? ReadOnlyList.empty() : supplementalTopDecls;
feSurfaceContext = feSurfaceContext == null ? FESurfaceContext.empty() : feSurfaceContext;
}
}
public Optional<PbsEditorialSignatureHelp> signatureHelp( public Optional<PbsEditorialSignatureHelp> signatureHelp(
final String sourceText, final String sourceText,
final PbsAst.File ast, final PbsAst.File ast,
@@ -116,6 +210,25 @@ public final class PbsEditorialSupportService {
return new DocumentContext(sourceText, ast, supplementalTopDecls, feSurfaceContext); return new DocumentContext(sourceText, ast, supplementalTopDecls, feSurfaceContext);
} }
private static Set<String> locationKeys(final List<PbsEditorialLocation> locations) {
final LinkedHashSet<String> keys = new LinkedHashSet<>();
if (locations == null) {
return Set.of();
}
for (final PbsEditorialLocation location : locations) {
if (location != null && location.span() != null) {
keys.add(locationKey(location.span()));
}
}
return Set.copyOf(keys);
}
private static String locationKey(final Span span) {
final FileId fileId = span.getFileId();
final int fileNumber = fileId == null ? -1 : fileId.getId();
return fileNumber + ":" + span.getStart() + ":" + span.getEnd();
}
private static final class DocumentContext { private static final class DocumentContext {
private final String sourceText; private final String sourceText;
private final PbsAst.File ast; private final PbsAst.File ast;
@@ -610,6 +723,264 @@ public final class PbsEditorialSupportService {
return Optional.empty(); return Optional.empty();
} }
private List<PbsEditorialLocation> definitionAt(final int offset) {
final Integer tokenIndex = identifierTokenIndexAt(offset);
if (tokenIndex == null) {
return List.of();
}
final var scopeState = scopeStateAt(offset);
final var token = token(tokenIndex);
final Integer previousTokenIndex = previousSignificantTokenIndex(tokenIndex);
if (previousTokenIndex != null && token(previousTokenIndex).kind() == PbsTokenKind.DOT) {
final TypeView receiverType = resolveReceiverTypeBeforeDot(previousTokenIndex, scopeState);
return resolveMemberDefinition(receiverType, token.lexeme());
}
return resolveSymbolDefinition(token.lexeme(), tokenIndex, scopeState, offset);
}
private List<PbsEditorialLocation> usagesMatching(final Set<String> identityKeys) {
if (identityKeys == null || identityKeys.isEmpty()) {
return List.of();
}
final FileId fileId = ast.span() == null ? FileId.none() : ast.span().getFileId();
final LinkedHashMap<String, PbsEditorialLocation> usages = new LinkedHashMap<>();
for (final PbsToken token : tokens) {
if (token.kind() != PbsTokenKind.IDENTIFIER) {
continue;
}
if (!intersects(definitionAt(token.start()), identityKeys)) {
continue;
}
final Span usageSpan = new Span(fileId, token.start(), token.end());
if (!hasPhysicalSpan(usageSpan)) {
continue;
}
usages.putIfAbsent(locationKey(usageSpan), new PbsEditorialLocation(usageSpan));
}
return List.copyOf(usages.values());
}
private boolean intersects(
final List<PbsEditorialLocation> locations,
final Set<String> identityKeys) {
if (locations == null || locations.isEmpty()) {
return false;
}
for (final PbsEditorialLocation location : locations) {
if (location != null && location.span() != null && identityKeys.contains(locationKey(location.span()))) {
return true;
}
}
return false;
}
private List<PbsEditorialLocation> resolveSymbolDefinition(
final String symbolName,
final int tokenIndex,
final ScopeState scopeState,
final int offset) {
if (scopeState.parameterNames().contains(symbolName)) {
return parameterLocations(symbolName, offset);
}
final Scope.LocalSymbol localSymbol = scopeState.scope().entries().get(symbolName);
if (localSymbol != null) {
return localLocations(symbolName, offset);
}
final Integer previousTokenIndex = previousSignificantTokenIndex(tokenIndex);
if (previousTokenIndex != null && token(previousTokenIndex).kind() == PbsTokenKind.NEW) {
return constructorLocations(resolveTopDeclSymbol(symbolName));
}
final TopDeclSymbol importedSymbol = importedSymbols.get(symbolName);
if (importedSymbol != null) {
return topDeclLocations(importedSymbol);
}
final TopDeclSymbol supplementalSymbol = supplementalSymbols.get(symbolName);
if (supplementalSymbol != null) {
return topDeclLocations(supplementalSymbol);
}
final TopDeclSymbol topLevelSymbol = topLevelSymbols.get(symbolName);
if (topLevelSymbol != null) {
return topDeclLocations(topLevelSymbol);
}
return List.of();
}
private List<PbsEditorialLocation> resolveMemberDefinition(
final TypeView receiverType,
final String memberName) {
if (receiverType == null) {
return List.of();
}
if (receiverType.kind() == Kind.STRUCT) {
final Span fieldSpan = structFieldSpan(receiverType.name(), memberName);
if (fieldSpan != null) {
return locations(fieldSpan);
}
final StructInfo structInfo = model.structs.get(receiverType.name());
if (structInfo == null) {
return List.of();
}
return callableLocations(structInfo.methods().get(memberName));
}
if (receiverType.kind() == Kind.SERVICE || receiverType.kind() == Kind.CONTRACT) {
final Map<String, List<CallableSymbol>> methods = receiverType.kind() == Kind.SERVICE
? Optional.ofNullable(model.services.get(receiverType.name())).map(ServiceInfo::methods).orElse(Map.of())
: Optional.ofNullable(model.contracts.get(receiverType.name())).map(ContractInfo::methods).orElse(Map.of());
return callableLocations(methods.get(memberName));
}
return List.of();
}
private List<PbsEditorialLocation> parameterLocations(
final String symbolName,
final int offset) {
final CallableFrame callableFrame = callableFrameAt(offset);
if (callableFrame == null) {
return List.of();
}
for (final var parameter : callableFrame.parameters()) {
if (symbolName.equals(parameter.name())) {
return locations(parameter.span());
}
}
return List.of();
}
private List<PbsEditorialLocation> localLocations(
final String symbolName,
final int offset) {
final CallableFrame callableFrame = callableFrameAt(offset);
if (callableFrame == null) {
return List.of();
}
return locations(bindingSpan(callableFrame.body(), symbolName, offset, null));
}
private Span bindingSpan(
final PbsAst.Block block,
final String symbolName,
final int offset,
final Span current) {
Span found = current;
for (final var statement : block.statements()) {
if (statement.span().getStart() >= offset) {
break;
}
if (statement instanceof PbsAst.LetStatement letStatement && symbolName.equals(letStatement.name())) {
found = letStatement.nameSpan() == null ? letStatement.span() : letStatement.nameSpan();
}
if (statement.span().contains(offset)) {
if (statement instanceof PbsAst.IfStatement ifStatement) {
if (ifStatement.thenBlock().span().contains(offset)) {
return bindingSpan(ifStatement.thenBlock(), symbolName, offset, found);
}
if (ifStatement.elseBlock() != null && ifStatement.elseBlock().span().contains(offset)) {
return bindingSpan(ifStatement.elseBlock(), symbolName, offset, found);
}
if (ifStatement.elseIf() != null && ifStatement.elseIf().span().contains(offset)) {
final var nestedBlock = new PbsAst.Block(
ReadOnlyList.wrap(List.of(ifStatement.elseIf())),
null,
ifStatement.elseIf().span());
return bindingSpan(nestedBlock, symbolName, offset, found);
}
} else if (statement instanceof PbsAst.ForStatement forStatement) {
Span loopFound = found;
if (symbolName.equals(forStatement.iteratorName())) {
loopFound = forStatement.span();
}
if (forStatement.body().span().contains(offset)) {
return bindingSpan(forStatement.body(), symbolName, offset, loopFound);
}
} else if (statement instanceof PbsAst.WhileStatement whileStatement
&& whileStatement.body().span().contains(offset)) {
return bindingSpan(whileStatement.body(), symbolName, offset, found);
}
return found;
}
}
return found;
}
private List<PbsEditorialLocation> constructorLocations(final TopDeclSymbol topDeclSymbol) {
if (topDeclSymbol == null) {
return List.of();
}
if (topDeclSymbol.decl() instanceof PbsAst.StructDecl structDecl) {
if (structDecl.ctors().isEmpty()) {
return locations(structDecl.span());
}
final ArrayList<Span> ctorSpans = new ArrayList<>();
for (final var ctor : structDecl.ctors()) {
ctorSpans.add(ctor.span());
}
return locations(ctorSpans.toArray(Span[]::new));
}
return topDeclLocations(topDeclSymbol);
}
private List<PbsEditorialLocation> topDeclLocations(final TopDeclSymbol topDeclSymbol) {
if (topDeclSymbol == null) {
return List.of();
}
return locations(topDeclSymbol.decl().span());
}
private List<PbsEditorialLocation> callableLocations(final List<CallableSymbol> callables) {
if (callables == null || callables.isEmpty()) {
return List.of();
}
final ArrayList<Span> spans = new ArrayList<>();
for (final var callable : callables) {
spans.add(callable.span());
}
return locations(spans.toArray(Span[]::new));
}
private Span structFieldSpan(
final String typeName,
final String fieldName) {
final TopDeclSymbol typeSymbol = resolveTopDeclSymbol(typeName);
if (typeSymbol == null) {
return null;
}
if (typeSymbol.decl() instanceof PbsAst.StructDecl structDecl) {
for (final var field : structDecl.fields()) {
if (fieldName.equals(field.name())) {
return field.span();
}
}
}
if (typeSymbol.decl() instanceof PbsAst.BuiltinTypeDecl builtinTypeDecl) {
for (final var field : builtinTypeDecl.fields()) {
if (fieldName.equals(field.name())) {
return field.span();
}
}
}
return null;
}
private List<PbsEditorialLocation> locations(final Span... spans) {
final ArrayList<PbsEditorialLocation> locations = new ArrayList<>();
if (spans == null) {
return List.of();
}
for (final Span span : spans) {
if (hasPhysicalSpan(span)) {
locations.add(new PbsEditorialLocation(span));
}
}
return List.copyOf(locations);
}
private boolean hasPhysicalSpan(final Span span) {
return span != null
&& !span.isNone()
&& span.getFileId() != null
&& !span.getFileId().isNone();
}
private List<PbsEditorialSignature> resolveCallableSignatures( private List<PbsEditorialSignature> resolveCallableSignatures(
final String callableName, final String callableName,
final ScopeState scopeState) { final ScopeState scopeState) {
@@ -0,0 +1,21 @@
package p.studio.compiler.pbs.semantics;
import p.studio.compiler.source.Span;
import java.util.Objects;
public record PbsEditorialWorkspaceSymbol(
String name,
PbsEditorialSymbolKind kind,
String detail,
String containerName,
Span span) {
public PbsEditorialWorkspaceSymbol {
name = Objects.requireNonNull(name, "name").trim();
kind = Objects.requireNonNull(kind, "kind");
detail = detail == null ? "" : detail;
containerName = containerName == null ? "" : containerName.trim();
span = Objects.requireNonNull(span, "span");
}
}
@@ -265,6 +265,347 @@ final class PbsEditorialSupportServiceTest {
&& candidate.detail().equals("draw_pixel(x: int, y: int, color: int) -> void"))); && candidate.detail().equals("draw_pixel(x: int, y: int, color: int) -> void")));
} }
@Test
void shouldResolveDefinitionForLocalsParametersMembersAndCanonicalImports() {
final var source = """
import { Log as Logger } from @sdk:log;
fn helper(value: int) -> int {
let total = value;
Logger.info("hello");
missingName;
return total;
}
""";
final var ast = parseOrdinary(source);
final var supplementalTopDecls = supplementalTopDecls("""
declare service Log {
fn info(message: str) -> void {
return;
}
}
""");
final var parameter = requireDefinition(source, ast, supplementalTopDecls, "value;");
assertEquals(1, parameter.size());
assertEquals(0, parameter.getFirst().span().getFileId().getId());
assertTrue(parameter.getFirst().span().contains(source.indexOf("value: int")));
final var local = requireDefinition(source, ast, supplementalTopDecls, "total;");
assertEquals(1, local.size());
assertEquals(0, local.getFirst().span().getFileId().getId());
assertTrue(local.getFirst().span().contains(source.indexOf("total = value")));
final var function = requireDefinition(source, ast, supplementalTopDecls, "helper(value");
assertEquals(1, function.size());
assertEquals(0, function.getFirst().span().getFileId().getId());
assertTrue(function.getFirst().span().getStart() <= source.indexOf("fn helper"));
final var imported = requireDefinition(source, ast, supplementalTopDecls, "Logger.info");
assertEquals(1, imported.size());
assertEquals(100, imported.getFirst().span().getFileId().getId());
assertNotEquals(ast.span().getFileId().getId(), imported.getFirst().span().getFileId().getId());
final var member = requireDefinition(source, ast, supplementalTopDecls, "info(");
assertEquals(1, member.size());
assertEquals(100, member.getFirst().span().getFileId().getId());
assertTrue(service.definition(source, ast, supplementalTopDecls, source.indexOf("fn helper")).isEmpty());
assertTrue(service.definition(source, ast, supplementalTopDecls, source.indexOf("int")).isEmpty());
assertTrue(service.definition(source, ast, supplementalTopDecls, source.indexOf("missingName")).isEmpty());
}
@Test
void shouldReturnEveryMatchingDeclarationLocationForOverloadedMembers() {
final var source = """
declare struct Vec() {
fn blend(dx: int) -> int { return dx; }
fn blend(dx: int, dy: int) -> int { return dx; }
}
fn main(vec: Vec) -> void {
vec.blend(1, 2);
}
""";
final var ast = parseOrdinary(source);
final var locations = requireDefinition(source, ast, ReadOnlyList.empty(), "blend(1");
assertEquals(2, locations.size());
assertTrue(locations.getFirst().span().contains(source.indexOf("fn blend(dx: int)")));
assertTrue(locations.get(1).span().contains(source.indexOf("fn blend(dx: int, dy: int)")));
}
@Test
void shouldCollectSameFileReferencesForPhysicalSymbolsAndSkipTrivia() {
final var source = """
fn helper(value: int) -> int {
let total = value;
return total;
}
fn frame() -> void {
helper(1);
helper(2);
// helper
let text = "helper";
missingName;
}
""";
final var ast = parseOrdinary(source);
final var helperRefs = service.references(source, ast, ReadOnlyList.empty(), source.indexOf("helper(1)"));
assertEquals(3, helperRefs.size(), helperRefs.toString());
assertTrue(helperRefs.stream().anyMatch(location -> location.span().contains(source.indexOf("helper(value"))));
assertTrue(helperRefs.stream().anyMatch(location -> location.span().contains(source.indexOf("helper(1)"))));
assertTrue(helperRefs.stream().anyMatch(location -> location.span().contains(source.indexOf("helper(2)"))));
assertTrue(helperRefs.stream().noneMatch(location -> location.span().contains(source.indexOf("// helper"))));
assertTrue(helperRefs.stream().noneMatch(location -> location.span().contains(source.indexOf("\"helper\""))));
final var parameterRefs = service.references(source, ast, ReadOnlyList.empty(), source.indexOf("value;"));
assertEquals(2, parameterRefs.size());
assertTrue(parameterRefs.stream().anyMatch(location -> location.span().contains(source.indexOf("value: int"))));
assertTrue(parameterRefs.stream().anyMatch(location -> location.span().contains(source.indexOf("value;"))));
final var localRefs = service.references(source, ast, ReadOnlyList.empty(), source.indexOf("total;"));
assertEquals(1, localRefs.size());
assertTrue(localRefs.getFirst().span().contains(source.indexOf("total;")));
assertTrue(service.definition(source, ast, ReadOnlyList.empty(), source.indexOf("total = value")).isEmpty());
assertTrue(service.references(source, ast, ReadOnlyList.empty(), source.indexOf("fn helper")).isEmpty());
assertTrue(service.references(source, ast, ReadOnlyList.empty(), source.indexOf("int")).isEmpty());
assertTrue(service.references(source, ast, ReadOnlyList.empty(), source.indexOf("missingName")).isEmpty());
}
@Test
void shouldCollectImportedAndOverloadedReferencesByDefinitionIntersection() {
final var importedSource = """
declare service Log {
fn info(message: str) -> void {
return;
}
}
""";
final var importedAst = parseInterface(importedSource, new FileId(100));
final var source = """
import { Log as Logger } from @sdk:log;
declare struct Vec() {
fn blend(dx: int) -> int { return dx; }
fn blend(dx: int, dy: int) -> int { return dx; }
}
fn frame(vec: Vec) -> void {
Logger.info("a");
Logger.info("b");
vec.blend(1, 2);
}
""";
final var ast = parseOrdinary(source);
final var supplementalTopDecls = importedAst.topDecls();
final var infoRefs = service.references(
new PbsEditorialSupportService.EditorialDocument(source, ast, supplementalTopDecls, null),
source.indexOf("info(\"a\")"),
List.of(
new PbsEditorialSupportService.EditorialDocument(source, ast, supplementalTopDecls, null),
new PbsEditorialSupportService.EditorialDocument(
importedSource,
importedAst,
ReadOnlyList.empty(),
null)));
assertEquals(2, infoRefs.stream().filter(location -> location.span().getFileId().getId() == 0).count());
assertTrue(infoRefs.stream().anyMatch(location -> location.span().contains(source.indexOf("info(\"a\")"))));
assertTrue(infoRefs.stream().anyMatch(location -> location.span().contains(source.indexOf("info(\"b\")"))));
final var blendRefs = service.references(source, ast, supplementalTopDecls, source.indexOf("blend(1"));
assertTrue(blendRefs.stream().anyMatch(location -> location.span().contains(source.indexOf("blend(1"))));
final var blendIdentity = service.definition(source, ast, supplementalTopDecls, source.indexOf("blend(1"));
assertEquals(2, blendIdentity.size());
}
private List<PbsEditorialLocation> requireDefinition(
final String source,
final PbsAst.File ast,
final ReadOnlyList<PbsAst.TopDecl> supplementalTopDecls,
final String needle) {
final int offset = source.indexOf(needle);
assertTrue(offset >= 0, "Expected to find needle: " + needle);
final var locations = service.definition(source, ast, supplementalTopDecls, offset);
assertFalse(locations.isEmpty(), "Expected definition for needle: " + needle);
return locations;
}
@Test
void shouldBuildAstBackedOutlineHierarchyAndKeepOverloadsAsSiblings() {
final var source = """
import { Log } from @sdk:log;
[Init]
fn init() -> void { return; }
fn helper(a: int) -> int { return a; }
fn helper(a: int, b: int) -> int { return a; }
declare struct Point(x: int, pub y: int) {
ctor make(x: int) { return; }
fn run() -> void { return; }
}
declare contract TickLike { fn tick(dt: int) -> void; }
declare service Physics { fn tick() -> void { return; } }
declare error Io { NotFound; Busy; }
declare enum Mode(Idle = 0, Run = 1);
declare callback OnClick(x: int) -> result<Io> int;
declare global STATE: int = 10;
declare const LIMIT: int = 10;
implements TickLike for Point using s { fn tick(dt: int) -> void { return; } }
fn frame() -> void {
let local = 1;
helper(local);
}
""";
final var ast = parseOrdinary(source);
final var symbols = service.documentSymbols(ast);
assertEquals(List.of(
"init",
"helper",
"helper",
"Point",
"TickLike",
"Physics",
"Io",
"Mode",
"OnClick",
"STATE",
"LIMIT",
"TickLike",
"frame"), names(symbols));
assertTrue(symbols.stream().noneMatch(symbol -> symbol.name().equals("Log") || symbol.name().equals("local")));
assertTrue(symbols.getFirst().name().equals("init"));
assertFalse(symbols.getFirst().name().contains("Init"));
assertEquals("(a: int) -> int", symbols.get(1).detail());
assertEquals("(a: int, b: int) -> int", symbols.get(2).detail());
final var point = requireNamed(symbols, "Point");
assertEquals(PbsEditorialSymbolKind.STRUCT, point.kind());
assertEquals(List.of("x", "y", "make", "run"), names(point.children()));
assertEquals(PbsEditorialSymbolKind.FIELD, point.children().getFirst().kind());
assertEquals("int", point.children().getFirst().detail());
assertEquals(PbsEditorialSymbolKind.CONSTRUCTOR, point.children().get(2).kind());
assertEquals("(x: int)", point.children().get(2).detail());
assertEquals(PbsEditorialSymbolKind.METHOD, point.children().get(3).kind());
final var contract = symbols.get(4);
assertEquals(PbsEditorialSymbolKind.CONTRACT, contract.kind());
assertEquals(List.of("tick"), names(contract.children()));
assertEquals("(dt: int) -> void", contract.children().getFirst().detail());
final var physics = requireNamed(symbols, "Physics");
assertEquals(PbsEditorialSymbolKind.SERVICE, physics.kind());
assertEquals(List.of("tick"), names(physics.children()));
final var error = requireNamed(symbols, "Io");
assertEquals(PbsEditorialSymbolKind.ERROR, error.kind());
assertEquals(List.of("NotFound", "Busy"), names(error.children()));
final var mode = requireNamed(symbols, "Mode");
assertEquals(PbsEditorialSymbolKind.ENUM, mode.kind());
assertEquals(List.of("Idle", "Run"), names(mode.children()));
assertEquals("0", mode.children().getFirst().detail());
final var callback = requireNamed(symbols, "OnClick");
assertEquals(PbsEditorialSymbolKind.CALLBACK, callback.kind());
assertEquals("(x: int) -> result<Io> int", callback.detail());
assertEquals(PbsEditorialSymbolKind.GLOBAL, requireNamed(symbols, "STATE").kind());
assertEquals("int", requireNamed(symbols, "STATE").detail());
assertEquals(PbsEditorialSymbolKind.CONST, requireNamed(symbols, "LIMIT").kind());
final var implementsSymbol = symbols.get(11);
assertEquals("TickLike", implementsSymbol.name());
assertEquals("Point", implementsSymbol.detail());
assertEquals(PbsEditorialSymbolKind.CONTRACT, implementsSymbol.kind());
assertEquals(List.of("tick"), names(implementsSymbol.children()));
}
@Test
void shouldFlattenOutlineMembersForWorkspaceSearchAndFilterByName() {
final var source = """
import { Log } from @sdk:log;
declare struct Vec(x: int) {
ctor make(x: int) { return; }
fn blend(dx: int, dy: int) -> int { return dx; }
}
fn helper() -> int { return 42; }
fn helper(value: int) -> int { return value; }
fn frame() -> void {
let local = 1;
helper(local);
}
""";
final var ast = parseOrdinary(source);
final var all = service.workspaceSymbols(ast, "");
assertEquals(List.of(
"Vec",
"x",
"make",
"blend",
"helper",
"helper",
"frame"), all.stream().map(PbsEditorialWorkspaceSymbol::name).toList());
assertEquals("", all.getFirst().containerName());
assertEquals("Vec", all.stream().filter(symbol -> symbol.name().equals("blend")).findFirst().orElseThrow().containerName());
assertEquals("Vec", all.stream().filter(symbol -> symbol.name().equals("x")).findFirst().orElseThrow().containerName());
assertTrue(all.stream().noneMatch(symbol -> symbol.name().equals("Log") || symbol.name().equals("local")));
final var blendHits = service.workspaceSymbols(ast, "BLEND");
assertEquals(List.of("blend"), blendHits.stream().map(PbsEditorialWorkspaceSymbol::name).toList());
assertEquals("Vec", blendHits.getFirst().containerName());
final var helperHits = service.workspaceSymbols(ast, "helper");
assertEquals(2, helperHits.size());
assertNotEquals(helperHits.getFirst().detail(), helperHits.get(1).detail());
final var qualifiedMiss = service.workspaceSymbols(ast, "Vec.blend");
assertTrue(qualifiedMiss.isEmpty());
}
@Test
void shouldOmitInvalidDeclarationsAndKeepNamedDeclsFromRecoveredAst() {
final var source = """
declare ;
fn ok() -> int { return 1; }
""";
final var ast = parseAllowingErrors(source);
final var symbols = service.documentSymbols(ast);
assertEquals(List.of("ok"), names(symbols));
assertEquals(PbsEditorialSymbolKind.FUNCTION, symbols.getFirst().kind());
final var workspaceSymbols = service.workspaceSymbols(ast, "");
assertEquals(List.of("ok"), workspaceSymbols.stream().map(PbsEditorialWorkspaceSymbol::name).toList());
}
@Test
void shouldOutlineHostAndBuiltinTypeDeclarationsFromInterfaceModules() {
final var source = """
declare host Gfx {
fn clear(color: int) -> void;
}
declare builtin type Color(
pub r: int
) {
fn pack() -> int;
}
""";
final var ast = parseInterface(source, new FileId(0));
final var symbols = service.documentSymbols(ast);
assertEquals(List.of("Gfx", "Color"), names(symbols));
assertEquals(PbsEditorialSymbolKind.HOST, symbols.getFirst().kind());
assertEquals(List.of("clear"), names(symbols.getFirst().children()));
assertEquals(PbsEditorialSymbolKind.BUILTIN_TYPE, symbols.get(1).kind());
assertEquals(List.of("r", "pack"), names(symbols.get(1).children()));
}
private PbsEditorialResolvedSymbol requireHover( private PbsEditorialResolvedSymbol requireHover(
final String source, final String source,
final PbsAst.File ast, final PbsAst.File ast,
@@ -286,6 +627,26 @@ final class PbsEditorialSupportServiceTest {
return ReadOnlyList.wrap(topDecls); return ReadOnlyList.wrap(topDecls);
} }
private List<String> names(final List<PbsEditorialDocumentSymbol> symbols) {
return symbols.stream().map(PbsEditorialDocumentSymbol::name).toList();
}
private PbsEditorialDocumentSymbol requireNamed(
final List<PbsEditorialDocumentSymbol> symbols,
final String name) {
return symbols.stream()
.filter(symbol -> symbol.name().equals(name))
.findFirst()
.orElseThrow(() -> new AssertionError("missing symbol: " + name + " in " + names(symbols)));
}
private PbsAst.File parseAllowingErrors(final String source) {
final var diagnostics = DiagnosticSink.empty();
final var fileId = new FileId(0);
final var tokens = PbsLexer.lex(source, fileId, diagnostics);
return PbsParser.parse(tokens, fileId, diagnostics, PbsParser.ParseMode.ORDINARY);
}
private PbsAst.File parseOrdinary(final String source) { private PbsAst.File parseOrdinary(final String source) {
return parse(source, new FileId(0), PbsParser.ParseMode.ORDINARY); return parse(source, new FileId(0), PbsParser.ParseMode.ORDINARY);
} }
@@ -0,0 +1,20 @@
package p.studio.compiler.services;
import java.nio.file.Path;
import java.util.Objects;
public record FrontendDefinitionLocation(
Path path,
int startOffset,
int endOffset) {
public FrontendDefinitionLocation {
path = Objects.requireNonNull(path, "path").toAbsolutePath().normalize();
if (startOffset < 0) {
throw new IllegalArgumentException("startOffset must not be negative");
}
if (endOffset < startOffset) {
throw new IllegalArgumentException("endOffset must not be before startOffset");
}
}
}
@@ -0,0 +1,44 @@
package p.studio.compiler.services;
import java.util.List;
import java.util.Objects;
public record FrontendDocumentSymbol(
String name,
FrontendSymbolKind kind,
String detail,
int rangeStart,
int rangeEnd,
int selectionStart,
int selectionEnd,
List<FrontendDocumentSymbol> children) {
public FrontendDocumentSymbol {
name = requireText(name, "name");
kind = Objects.requireNonNull(kind, "kind");
detail = detail == null ? "" : detail.trim();
if (rangeStart < 0) {
throw new IllegalArgumentException("rangeStart must not be negative");
}
if (rangeEnd < rangeStart) {
throw new IllegalArgumentException("rangeEnd must not be before rangeStart");
}
if (selectionStart < 0) {
throw new IllegalArgumentException("selectionStart must not be negative");
}
if (selectionEnd < selectionStart) {
throw new IllegalArgumentException("selectionEnd must not be before selectionStart");
}
children = children == null ? List.of() : List.copyOf(children);
}
private static String requireText(
final String value,
final String field) {
final String candidate = Objects.requireNonNull(value, field).trim();
if (candidate.isEmpty()) {
throw new IllegalArgumentException(field + " must not be blank");
}
return candidate;
}
}
@@ -3,5 +3,22 @@ package p.studio.compiler.services;
public record FrontendEditorialContext( public record FrontendEditorialContext(
Object syntaxTree, Object syntaxTree,
Object supplementalDeclarations, Object supplementalDeclarations,
Object semanticContext) { Object semanticContext,
Object sourceFiles,
Object projectSurface) {
public FrontendEditorialContext(
final Object syntaxTree,
final Object supplementalDeclarations,
final Object semanticContext) {
this(syntaxTree, supplementalDeclarations, semanticContext, null, null);
}
public FrontendEditorialContext(
final Object syntaxTree,
final Object supplementalDeclarations,
final Object semanticContext,
final Object sourceFiles) {
this(syntaxTree, supplementalDeclarations, semanticContext, sourceFiles, null);
}
} }
@@ -11,6 +11,11 @@ import java.util.Optional;
* Optional frontend-owned editor services. * Optional frontend-owned editor services.
*/ */
public interface FrontendLanguageService { public interface FrontendLanguageService {
default Optional<FrontendEditorialContext> prepareEditorialContext(
final FrontendPhaseContext phaseContext) {
return Optional.empty();
}
default Optional<FrontendEditorialContext> prepareEditorialContext( default Optional<FrontendEditorialContext> prepareEditorialContext(
final FrontendPhaseContext phaseContext, final FrontendPhaseContext phaseContext,
final FileId fileId) { final FileId fileId) {
@@ -59,4 +64,50 @@ public interface FrontendLanguageService {
final int offset) { final int offset) {
return signatureHelp(request, offset); return signatureHelp(request, offset);
} }
default List<FrontendDefinitionLocation> definition(
final FrontendDocumentRequest request,
final int offset) {
return List.of();
}
default List<FrontendDefinitionLocation> definition(
final FrontendDocumentRequest request,
final FrontendEditorialContext editorialContext,
final int offset) {
return definition(request, offset);
}
default List<FrontendDefinitionLocation> references(
final FrontendDocumentRequest request,
final int offset) {
return List.of();
}
default List<FrontendDefinitionLocation> references(
final FrontendDocumentRequest request,
final FrontendEditorialContext editorialContext,
final int offset) {
return references(request, offset);
}
default List<FrontendDocumentSymbol> documentSymbols(final FrontendDocumentRequest request) {
return List.of();
}
default List<FrontendDocumentSymbol> documentSymbols(
final FrontendDocumentRequest request,
final FrontendEditorialContext editorialContext) {
return documentSymbols(request);
}
default List<FrontendWorkspaceSymbol> workspaceSymbols(final FrontendWorkspaceRequest request) {
return List.of();
}
default List<FrontendWorkspaceSymbol> workspaceSymbols(
final FrontendWorkspaceRequest request,
final FrontendEditorialContext editorialContext) {
return workspaceSymbols(request);
}
} }
@@ -0,0 +1,14 @@
package p.studio.compiler.services;
import java.nio.file.Path;
import java.util.Objects;
public record FrontendWorkspaceRequest(
Path projectRoot,
String query) {
public FrontendWorkspaceRequest {
projectRoot = Objects.requireNonNull(projectRoot, "projectRoot").toAbsolutePath().normalize();
query = query == null ? "" : query;
}
}
@@ -0,0 +1,38 @@
package p.studio.compiler.services;
import java.nio.file.Path;
import java.util.Objects;
public record FrontendWorkspaceSymbol(
String name,
FrontendSymbolKind kind,
String detail,
String containerName,
Path path,
int startOffset,
int endOffset) {
public FrontendWorkspaceSymbol {
name = requireText(name, "name");
kind = Objects.requireNonNull(kind, "kind");
detail = detail == null ? "" : detail.trim();
containerName = containerName == null ? "" : containerName.trim();
path = Objects.requireNonNull(path, "path").toAbsolutePath().normalize();
if (startOffset < 0) {
throw new IllegalArgumentException("startOffset must not be negative");
}
if (endOffset < startOffset) {
throw new IllegalArgumentException("endOffset must not be before startOffset");
}
}
private static String requireText(
final String value,
final String field) {
final String candidate = Objects.requireNonNull(value, field).trim();
if (candidate.isEmpty()) {
throw new IllegalArgumentException(field + " must not be blank");
}
return candidate;
}
}
@@ -22,6 +22,137 @@ class FrontendLanguageServiceTest {
assertTrue(service.completion(request, 0).isEmpty()); assertTrue(service.completion(request, 0).isEmpty());
assertTrue(service.hover(request, 0).isEmpty()); assertTrue(service.hover(request, 0).isEmpty());
assertEquals(FrontendSignatureHelp.empty(), service.signatureHelp(request, 0)); assertEquals(FrontendSignatureHelp.empty(), service.signatureHelp(request, 0));
assertTrue(service.definition(request, 0).isEmpty());
assertTrue(service.references(request, 0).isEmpty());
assertTrue(service.documentSymbols(request).isEmpty());
assertTrue(service.workspaceSymbols(new FrontendWorkspaceRequest(Path.of("."), "frame")).isEmpty());
assertTrue(service.prepareEditorialContext(null).isEmpty());
}
@Test
void documentSymbolRejectsBlankNameAndInvertedRangesAndCopiesChildren() {
final var child = new FrontendDocumentSymbol(
"x",
FrontendSymbolKind.FIELD,
"int",
10,
16,
10,
16,
List.of());
final var symbol = new FrontendDocumentSymbol(
" Point ",
FrontendSymbolKind.STRUCT,
" ",
0,
20,
8,
13,
List.of(child));
assertEquals("Point", symbol.name());
assertEquals("", symbol.detail());
assertEquals(1, symbol.children().size());
assertEquals("x", symbol.children().getFirst().name());
assertThrows(UnsupportedOperationException.class, () -> symbol.children().add(child));
assertThrows(IllegalArgumentException.class, () -> new FrontendDocumentSymbol(
" ",
FrontendSymbolKind.FUNCTION,
"",
0,
1,
0,
1,
List.of()));
assertThrows(IllegalArgumentException.class, () -> new FrontendDocumentSymbol(
"fn",
FrontendSymbolKind.FUNCTION,
"",
-1,
1,
0,
1,
List.of()));
assertThrows(IllegalArgumentException.class, () -> new FrontendDocumentSymbol(
"fn",
FrontendSymbolKind.FUNCTION,
"",
5,
4,
0,
1,
List.of()));
assertThrows(IllegalArgumentException.class, () -> new FrontendDocumentSymbol(
"fn",
FrontendSymbolKind.FUNCTION,
"",
0,
1,
3,
2,
List.of()));
}
@Test
void workspaceSymbolNormalizesOptionalTextAndRejectsBlankNameOrInvertedOffsets() {
final Path path = Path.of("src/main.pbs").toAbsolutePath();
final var symbol = new FrontendWorkspaceSymbol(
" blend ",
FrontendSymbolKind.METHOD,
" (dx: int) -> int ",
" Vec ",
path,
4,
9);
assertEquals("blend", symbol.name());
assertEquals("(dx: int) -> int", symbol.detail());
assertEquals("Vec", symbol.containerName());
assertEquals(path.normalize(), symbol.path());
assertThrows(IllegalArgumentException.class, () -> new FrontendWorkspaceSymbol(
" ",
FrontendSymbolKind.FUNCTION,
"",
"",
path,
0,
1));
assertThrows(NullPointerException.class, () -> new FrontendWorkspaceSymbol(
"fn",
FrontendSymbolKind.FUNCTION,
"",
"",
null,
0,
1));
assertThrows(IllegalArgumentException.class, () -> new FrontendWorkspaceSymbol(
"fn",
FrontendSymbolKind.FUNCTION,
"",
"",
path,
-1,
0));
assertThrows(IllegalArgumentException.class, () -> new FrontendWorkspaceSymbol(
"fn",
FrontendSymbolKind.FUNCTION,
"",
"",
path,
5,
4));
}
@Test
void definitionLocationRejectsBlankPathAndInvertedOffsets() {
final Path path = Path.of("src/main.pbs").toAbsolutePath();
final var location = new FrontendDefinitionLocation(path, 4, 9);
assertEquals(path.normalize(), location.path());
assertEquals(4, location.startOffset());
assertEquals(9, location.endOffset());
assertThrows(NullPointerException.class, () -> new FrontendDefinitionLocation(null, 0, 1));
assertThrows(IllegalArgumentException.class, () -> new FrontendDefinitionLocation(path, -1, 0));
assertThrows(IllegalArgumentException.class, () -> new FrontendDefinitionLocation(path, 5, 4));
} }
@Test @Test
@@ -0,0 +1,15 @@
package p.studio.lsp.messages;
import java.util.List;
public record BaselineDefinition(
List<BaselineDefinitionLocation> locations) {
public BaselineDefinition {
locations = locations == null ? List.of() : List.copyOf(locations);
}
public static BaselineDefinition empty() {
return new BaselineDefinition(List.of());
}
}
@@ -0,0 +1,28 @@
package p.studio.lsp.messages;
import java.util.Objects;
public record BaselineDefinitionLocation(
String uri,
int startLine,
int startCharacter,
int endLine,
int endCharacter) {
public BaselineDefinitionLocation {
uri = requireText(uri, "uri");
if (startLine < 0 || startCharacter < 0 || endLine < 0 || endCharacter < 0) {
throw new IllegalArgumentException("definition range coordinates must not be negative");
}
}
private static String requireText(
final String value,
final String field) {
final String candidate = Objects.requireNonNull(value, field).trim();
if (candidate.isEmpty()) {
throw new IllegalArgumentException(field + " must not be blank");
}
return candidate;
}
}
@@ -0,0 +1,41 @@
package p.studio.lsp.messages;
import java.util.List;
import java.util.Objects;
public record BaselineDocumentSymbol(
String name,
BaselineDocumentSymbolKind kind,
String detail,
int startLine,
int startCharacter,
int endLine,
int endCharacter,
int selectionStartLine,
int selectionStartCharacter,
int selectionEndLine,
int selectionEndCharacter,
List<BaselineDocumentSymbol> children) {
public BaselineDocumentSymbol {
name = requireText(name, "name");
kind = Objects.requireNonNull(kind, "kind");
detail = detail == null ? "" : detail;
if (startLine < 0 || startCharacter < 0 || endLine < 0 || endCharacter < 0
|| selectionStartLine < 0 || selectionStartCharacter < 0
|| selectionEndLine < 0 || selectionEndCharacter < 0) {
throw new IllegalArgumentException("document symbol range coordinates must not be negative");
}
children = children == null ? List.of() : List.copyOf(children);
}
private static String requireText(
final String value,
final String field) {
final String candidate = Objects.requireNonNull(value, field).trim();
if (candidate.isEmpty()) {
throw new IllegalArgumentException(field + " must not be blank");
}
return candidate;
}
}
@@ -0,0 +1,21 @@
package p.studio.lsp.messages;
public enum BaselineDocumentSymbolKind {
KEYWORD,
LOCAL,
PARAMETER,
FIELD,
FUNCTION,
METHOD,
CONSTRUCTOR,
STRUCT,
BUILTIN_TYPE,
SERVICE,
HOST,
CONTRACT,
CALLBACK,
ENUM,
ERROR,
GLOBAL,
CONST
}
@@ -0,0 +1,15 @@
package p.studio.lsp.messages;
import java.util.List;
public record BaselineDocumentSymbols(
List<BaselineDocumentSymbol> symbols) {
public BaselineDocumentSymbols {
symbols = symbols == null ? List.of() : List.copyOf(symbols);
}
public static BaselineDocumentSymbols empty() {
return new BaselineDocumentSymbols(List.of());
}
}
@@ -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());
}
}
@@ -10,6 +10,10 @@ public record BaselineServerDescription(
boolean hoverSupported, boolean hoverSupported,
boolean completionSupported, boolean completionSupported,
boolean signatureHelpSupported, boolean signatureHelpSupported,
boolean definitionSupported,
boolean referencesSupported,
boolean documentSymbolsSupported,
boolean workspaceSymbolsSupported,
List<String> semanticTokenTypes, List<String> semanticTokenTypes,
List<BaselineSemanticHostProjection> semanticHostProjections, List<BaselineSemanticHostProjection> semanticHostProjections,
List<BaselineVisualTheme> visualThemes, List<BaselineVisualTheme> visualThemes,
@@ -0,0 +1,36 @@
package p.studio.lsp.messages;
import java.util.Objects;
public record BaselineWorkspaceSymbol(
String name,
BaselineDocumentSymbolKind kind,
String detail,
String containerName,
String uri,
int startLine,
int startCharacter,
int endLine,
int endCharacter) {
public BaselineWorkspaceSymbol {
name = requireText(name, "name");
kind = Objects.requireNonNull(kind, "kind");
detail = detail == null ? "" : detail;
containerName = containerName == null ? "" : containerName;
uri = requireText(uri, "uri");
if (startLine < 0 || startCharacter < 0 || endLine < 0 || endCharacter < 0) {
throw new IllegalArgumentException("workspace symbol range coordinates must not be negative");
}
}
private static String requireText(
final String value,
final String field) {
final String candidate = Objects.requireNonNull(value, field).trim();
if (candidate.isEmpty()) {
throw new IllegalArgumentException(field + " must not be blank");
}
return candidate;
}
}
@@ -0,0 +1,15 @@
package p.studio.lsp.messages;
import java.util.List;
public record BaselineWorkspaceSymbols(
List<BaselineWorkspaceSymbol> symbols) {
public BaselineWorkspaceSymbols {
symbols = symbols == null ? List.of() : List.copyOf(symbols);
}
public static BaselineWorkspaceSymbols empty() {
return new BaselineWorkspaceSymbols(List.of());
}
}
@@ -2,7 +2,11 @@ package p.studio.lsp.services;
import p.studio.lsp.messages.BaselineDocumentAnalysis; import p.studio.lsp.messages.BaselineDocumentAnalysis;
import p.studio.lsp.messages.BaselineCompletion; import p.studio.lsp.messages.BaselineCompletion;
import p.studio.lsp.messages.BaselineDefinition;
import p.studio.lsp.messages.BaselineHover; import p.studio.lsp.messages.BaselineHover;
import p.studio.lsp.messages.BaselineDocumentSymbols;
import p.studio.lsp.messages.BaselineReferences;
import p.studio.lsp.messages.BaselineWorkspaceSymbols;
import p.studio.lsp.messages.BaselineSemanticTokens; import p.studio.lsp.messages.BaselineSemanticTokens;
import p.studio.lsp.messages.BaselineSignatureHelp; import p.studio.lsp.messages.BaselineSignatureHelp;
import p.studio.lsp.messages.BaselineServerDescription; import p.studio.lsp.messages.BaselineServerDescription;
@@ -17,6 +21,20 @@ public interface LanguageServiceBridge {
BaselineHover hover(LspProjectContext context, String documentUri, String text, int line, int character); BaselineHover hover(LspProjectContext context, String documentUri, String text, int line, int character);
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);
BaselineDocumentSymbols documentSymbols(LspProjectContext context, String documentUri, String text);
BaselineWorkspaceSymbols workspaceSymbols(LspProjectContext context, String query);
BaselineSignatureHelp signatureHelp(LspProjectContext context, String documentUri, String text, int line, int character); BaselineSignatureHelp signatureHelp(LspProjectContext context, String documentUri, String text, int line, int character);
BaselineSemanticTokens semanticTokens(LspProjectContext context, String documentUri, String text); BaselineSemanticTokens semanticTokens(LspProjectContext context, String documentUri, String text);
@@ -5,13 +5,17 @@ import p.studio.compiler.FrontendRegistryService;
import p.studio.compiler.messages.*; import p.studio.compiler.messages.*;
import p.studio.compiler.models.*; import p.studio.compiler.models.*;
import p.studio.compiler.services.FrontendCompletionCandidate; import p.studio.compiler.services.FrontendCompletionCandidate;
import p.studio.compiler.services.FrontendDefinitionLocation;
import p.studio.compiler.services.FrontendDocumentRequest; import p.studio.compiler.services.FrontendDocumentRequest;
import p.studio.compiler.services.FrontendDocumentSymbol;
import p.studio.compiler.services.FrontendEditorialContext; import p.studio.compiler.services.FrontendEditorialContext;
import p.studio.compiler.services.FrontendHover; import p.studio.compiler.services.FrontendHover;
import p.studio.compiler.services.FrontendProvider; import p.studio.compiler.services.FrontendProvider;
import p.studio.compiler.services.FrontendSignature; import p.studio.compiler.services.FrontendSignature;
import p.studio.compiler.services.FrontendSignatureHelp; import p.studio.compiler.services.FrontendSignatureHelp;
import p.studio.compiler.services.FrontendSymbolKind; import p.studio.compiler.services.FrontendSymbolKind;
import p.studio.compiler.services.FrontendWorkspaceRequest;
import p.studio.compiler.services.FrontendWorkspaceSymbol;
import p.studio.compiler.source.identifiers.FileId; import p.studio.compiler.source.identifiers.FileId;
import p.studio.compiler.utilities.SourceProviderFactory; import p.studio.compiler.utilities.SourceProviderFactory;
import p.studio.compiler.workspaces.AssetSurfaceContextLoader; import p.studio.compiler.workspaces.AssetSurfaceContextLoader;
@@ -21,6 +25,8 @@ import p.studio.lsp.services.LanguageServiceBridge;
import p.studio.utilities.logs.LogAggregator; import p.studio.utilities.logs.LogAggregator;
import java.net.URI; import java.net.URI;
import java.nio.charset.StandardCharsets;
import java.nio.file.Files;
import java.nio.file.Path; import java.nio.file.Path;
import java.util.*; import java.util.*;
import java.util.function.Function; import java.util.function.Function;
@@ -42,6 +48,7 @@ public final class CompilerLanguageServiceBridge implements LanguageServiceBridg
Objects.requireNonNull(context, "context"); Objects.requireNonNull(context, "context");
final var frontend = frontendSpec(context); final var frontend = frontendSpec(context);
final var presentation = frontend.getSemanticPresentation(); final var presentation = frontend.getSemanticPresentation();
final boolean languageServicePresent = frontendProvider(context).languageService().isPresent();
return new BaselineServerDescription( return new BaselineServerDescription(
"Prometeu Studio LSP", "Prometeu Studio LSP",
"0.1.0", "0.1.0",
@@ -49,6 +56,10 @@ public final class CompilerLanguageServiceBridge implements LanguageServiceBridg
true, true,
true, true,
true, true,
languageServicePresent,
languageServicePresent,
languageServicePresent,
languageServicePresent,
presentation.semanticKeys(), presentation.semanticKeys(),
presentation.hostProjections().stream().map(this::mapSemanticHostProjection).toList(), presentation.hostProjections().stream().map(this::mapSemanticHostProjection).toList(),
presentation.themes().stream().map(this::mapVisualTheme).toList(), presentation.themes().stream().map(this::mapVisualTheme).toList(),
@@ -87,13 +98,9 @@ public final class CompilerLanguageServiceBridge implements LanguageServiceBridg
context.projectRoot(), context.projectRoot(),
normalizeDocumentPath(documentUri), normalizeDocumentPath(documentUri),
document.text()); document.text());
final FrontendEditorialContext editorialContext = new FrontendEditorialContext(
document.editorialContext().syntaxTree(),
document.editorialContext().supplementalDeclarations(),
document.editorialContext().semanticContext());
final List<FrontendCompletionCandidate> candidates = languageService.orElseThrow().completion( final List<FrontendCompletionCandidate> candidates = languageService.orElseThrow().completion(
request, request,
editorialContext, document.editorialContext(),
offset); offset);
return new BaselineCompletion( return new BaselineCompletion(
false, false,
@@ -122,19 +129,149 @@ public final class CompilerLanguageServiceBridge implements LanguageServiceBridg
context.projectRoot(), context.projectRoot(),
normalizeDocumentPath(documentUri), normalizeDocumentPath(documentUri),
document.text()); document.text());
final FrontendEditorialContext editorialContext = new FrontendEditorialContext(
document.editorialContext().syntaxTree(),
document.editorialContext().supplementalDeclarations(),
document.editorialContext().semanticContext());
return languageService.orElseThrow().hover( return languageService.orElseThrow().hover(
request, request,
editorialContext, document.editorialContext(),
offset); offset);
}) })
.map(symbol -> new BaselineHover(formatHoverMarkdown(symbol))) .map(symbol -> new BaselineHover(formatHoverMarkdown(symbol)))
.orElseGet(() -> new BaselineHover("No symbol information.")); .orElseGet(() -> new BaselineHover("No symbol information."));
} }
@Override
public BaselineDefinition definition(
final LspProjectContext context,
final String documentUri,
final String text,
final int line,
final int character) {
Objects.requireNonNull(context, "context");
final var provider = frontendProvider(context);
final var languageService = provider.languageService();
if (languageService.isEmpty()) {
return BaselineDefinition.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 List<FrontendDefinitionLocation> locations = languageService.orElseThrow().definition(
request,
document.editorialContext(),
offset);
return new BaselineDefinition(mapDefinitionLocations(
locations,
request.documentPath(),
document.text()));
})
.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 BaselineDocumentSymbols documentSymbols(
final LspProjectContext context,
final String documentUri,
final String text) {
Objects.requireNonNull(context, "context");
final var provider = frontendProvider(context);
final var languageService = provider.languageService();
if (languageService.isEmpty()) {
return BaselineDocumentSymbols.empty();
}
return editorialDocument(context, documentUri, text)
.map(document -> {
final FrontendDocumentRequest request = new FrontendDocumentRequest(
context.projectRoot(),
normalizeDocumentPath(documentUri),
document.text());
return new BaselineDocumentSymbols(mapDocumentSymbols(
languageService.orElseThrow().documentSymbols(request, document.editorialContext()),
document.text()));
})
.orElseGet(BaselineDocumentSymbols::empty);
}
@Override
public BaselineWorkspaceSymbols workspaceSymbols(
final LspProjectContext context,
final String query) {
Objects.requireNonNull(context, "context");
final var provider = frontendProvider(context);
final var languageService = provider.languageService();
if (languageService.isEmpty()) {
return BaselineWorkspaceSymbols.empty();
}
final BuilderPipelineContext pipelineContext = BuilderPipelineContext.fromConfig(
new BuilderPipelineConfig(
false,
context.projectRoot().toString(),
"core-v1",
SourceProviderFactory.overlayUtf8(Map.of())));
BuilderPipelineService.INSTANCE.analyze(pipelineContext, LogAggregator.empty());
final FrontendPhaseContext frontendPhaseContext = new FrontendPhaseContext(
pipelineContext.resolvedWorkspace.graph().projectTable(),
pipelineContext.fileTable,
pipelineContext.resolvedWorkspace.stack(),
pipelineContext.resolvedWorkspace.stdlib(),
pipelineContext.resolvedWorkspace.target(),
HostAdmissionContext.permissiveDefault(),
assetSurfaceContextLoader.load(pipelineContext.resolvedWorkspace.mainProject().getRootPath()));
return languageService.orElseThrow()
.prepareEditorialContext(frontendPhaseContext)
.map(editorialContext -> new BaselineWorkspaceSymbols(mapWorkspaceSymbols(
languageService.orElseThrow().workspaceSymbols(
new FrontendWorkspaceRequest(context.projectRoot(), query),
editorialContext))))
.orElseGet(BaselineWorkspaceSymbols::empty);
}
@Override @Override
public BaselineSignatureHelp signatureHelp( public BaselineSignatureHelp signatureHelp(
final LspProjectContext context, final LspProjectContext context,
@@ -155,13 +292,9 @@ public final class CompilerLanguageServiceBridge implements LanguageServiceBridg
context.projectRoot(), context.projectRoot(),
normalizeDocumentPath(documentUri), normalizeDocumentPath(documentUri),
document.text()); document.text());
final FrontendEditorialContext editorialContext = new FrontendEditorialContext(
document.editorialContext().syntaxTree(),
document.editorialContext().supplementalDeclarations(),
document.editorialContext().semanticContext());
return languageService.orElseThrow().signatureHelp( return languageService.orElseThrow().signatureHelp(
request, request,
editorialContext, document.editorialContext(),
offset); offset);
}) })
.map(this::mapSignatureHelp) .map(this::mapSignatureHelp)
@@ -418,6 +551,128 @@ public final class CompilerLanguageServiceBridge implements LanguageServiceBridg
}; };
} }
private static String frontendLocationKey(final FrontendDefinitionLocation location) {
return location.path() + ":" + location.startOffset() + ":" + location.endOffset();
}
private List<BaselineDocumentSymbol> mapDocumentSymbols(
final List<FrontendDocumentSymbol> symbols,
final String documentText) {
if (symbols == null || symbols.isEmpty()) {
return List.of();
}
final DocumentPositionMapper mapper = new DocumentPositionMapper(documentText == null ? "" : documentText);
final ArrayList<BaselineDocumentSymbol> mapped = new ArrayList<>();
for (final FrontendDocumentSymbol symbol : symbols) {
mapped.add(mapDocumentSymbol(symbol, mapper));
}
return List.copyOf(mapped);
}
private BaselineDocumentSymbol mapDocumentSymbol(
final FrontendDocumentSymbol symbol,
final DocumentPositionMapper mapper) {
final DocumentPosition rangeStart = mapper.positionOf(symbol.rangeStart());
final DocumentPosition rangeEnd = mapper.positionOf(symbol.rangeEnd());
final DocumentPosition selectionStart = mapper.positionOf(symbol.selectionStart());
final DocumentPosition selectionEnd = mapper.positionOf(symbol.selectionEnd());
final ArrayList<BaselineDocumentSymbol> children = new ArrayList<>();
for (final FrontendDocumentSymbol child : symbol.children()) {
children.add(mapDocumentSymbol(child, mapper));
}
return new BaselineDocumentSymbol(
symbol.name(),
BaselineDocumentSymbolKind.valueOf(symbol.kind().name()),
symbol.detail(),
rangeStart.line(),
rangeStart.character(),
rangeEnd.line(),
rangeEnd.character(),
selectionStart.line(),
selectionStart.character(),
selectionEnd.line(),
selectionEnd.character(),
children);
}
private List<BaselineWorkspaceSymbol> mapWorkspaceSymbols(final List<FrontendWorkspaceSymbol> symbols) {
if (symbols == null || symbols.isEmpty()) {
return List.of();
}
final LinkedHashMap<Path, DocumentPositionMapper> mappers = new LinkedHashMap<>();
final ArrayList<BaselineWorkspaceSymbol> mapped = new ArrayList<>();
for (final FrontendWorkspaceSymbol symbol : symbols) {
final DocumentPositionMapper mapper = mappers.computeIfAbsent(symbol.path(), this::mapperForPath);
if (mapper == null) {
continue;
}
final DocumentPosition start = mapper.positionOf(symbol.startOffset());
final DocumentPosition end = mapper.positionOf(symbol.endOffset());
mapped.add(new BaselineWorkspaceSymbol(
symbol.name(),
BaselineDocumentSymbolKind.valueOf(symbol.kind().name()),
symbol.detail(),
symbol.containerName(),
symbol.path().toUri().toString(),
start.line(),
start.character(),
end.line(),
end.character()));
}
return List.copyOf(mapped);
}
private DocumentPositionMapper mapperForPath(final Path path) {
if (path == null || !Files.isRegularFile(path)) {
return null;
}
try {
return new DocumentPositionMapper(Files.readString(path, StandardCharsets.UTF_8));
} catch (final Exception ignored) {
return null;
}
}
private List<BaselineDefinitionLocation> mapDefinitionLocations(
final List<FrontendDefinitionLocation> locations,
final Path currentDocumentPath,
final String currentDocumentText) {
if (locations == null || locations.isEmpty()) {
return List.of();
}
final ArrayList<BaselineDefinitionLocation> mapped = new ArrayList<>();
for (final FrontendDefinitionLocation location : locations) {
final String targetText = textForDefinitionTarget(location.path(), currentDocumentPath, currentDocumentText);
if (targetText == null) {
continue;
}
final DocumentPositionMapper mapper = new DocumentPositionMapper(targetText);
final DocumentPosition start = mapper.positionOf(location.startOffset());
final DocumentPosition end = mapper.positionOf(location.endOffset());
mapped.add(new BaselineDefinitionLocation(
location.path().toUri().toString(),
start.line(),
start.character(),
end.line(),
end.character()));
}
return List.copyOf(mapped);
}
private String textForDefinitionTarget(
final Path path,
final Path currentDocumentPath,
final String currentDocumentText) {
if (path.equals(currentDocumentPath)) {
return currentDocumentText == null ? "" : currentDocumentText;
}
try {
return Files.readString(path, StandardCharsets.UTF_8);
} catch (final Exception ignored) {
return null;
}
}
private String formatHoverMarkdown(final FrontendHover symbol) { private String formatHoverMarkdown(final FrontendHover symbol) {
final StringBuilder markdown = new StringBuilder(); final StringBuilder markdown = new StringBuilder();
final List<FrontendSignature> signatures = symbol.signatures(); final List<FrontendSignature> signatures = symbol.signatures();
@@ -29,7 +29,7 @@ public final class PrometeuLanguageServer implements LanguageServer, LanguageCli
compilerBridge, compilerBridge,
new Lsp4jProtocolMessageMapper(), new Lsp4jProtocolMessageMapper(),
null, null,
new PrometeuWorkspaceService()); null);
} }
PrometeuLanguageServer( PrometeuLanguageServer(
@@ -44,7 +44,9 @@ public final class PrometeuLanguageServer implements LanguageServer, LanguageCli
this.textDocumentService = textDocumentService != null this.textDocumentService = textDocumentService != null
? textDocumentService ? textDocumentService
: new PrometeuTextDocumentService(project, languageServiceBridge, protocolMessageMapper); : new PrometeuTextDocumentService(project, languageServiceBridge, protocolMessageMapper);
this.workspaceService = Objects.requireNonNull(workspaceService, "workspaceService"); this.workspaceService = workspaceService != null
? workspaceService
: new PrometeuWorkspaceService(project, languageServiceBridge, protocolMessageMapper);
} }
@Override @Override
@@ -8,6 +8,7 @@ import p.studio.lsp.messages.LspProjectContext;
import p.studio.lsp.services.LanguageServiceBridge; import p.studio.lsp.services.LanguageServiceBridge;
import p.studio.lsp.services.protocol.mapping.ProtocolMessageMapper; import p.studio.lsp.services.protocol.mapping.ProtocolMessageMapper;
import java.util.ArrayList;
import java.util.Objects; import java.util.Objects;
import java.util.concurrent.ConcurrentHashMap; import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.CompletableFuture; import java.util.concurrent.CompletableFuture;
@@ -97,6 +98,49 @@ public final class PrometeuTextDocumentService implements TextDocumentService {
params.getPosition().getCharacter()))); params.getPosition().getCharacter())));
} }
@Override
public CompletableFuture<Either<List<? extends Location>, List<? extends LocationLink>>> definition(
final DefinitionParams params) {
final String uri = params.getTextDocument().getUri();
final String text = documentTextByUri.get(uri);
final List<Location> locations = protocolMessageMapper.mapDefinition(languageServiceBridge.definition(
project,
uri,
text,
params.getPosition().getLine(),
params.getPosition().getCharacter()));
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<List<Either<SymbolInformation, DocumentSymbol>>> documentSymbol(
final DocumentSymbolParams params) {
final String uri = params.getTextDocument().getUri();
final String text = documentTextByUri.get(uri);
final List<Either<SymbolInformation, DocumentSymbol>> symbols = new ArrayList<>();
for (final DocumentSymbol symbol : protocolMessageMapper.mapDocumentSymbols(
languageServiceBridge.documentSymbols(project, uri, text))) {
symbols.add(Either.forRight(symbol));
}
return CompletableFuture.completedFuture(List.copyOf(symbols));
}
@Override @Override
public CompletableFuture<SignatureHelp> signatureHelp(final SignatureHelpParams params) { public CompletableFuture<SignatureHelp> signatureHelp(final SignatureHelpParams params) {
final String uri = params.getTextDocument().getUri(); final String uri = params.getTextDocument().getUri();
@@ -2,9 +2,36 @@ package p.studio.lsp.services.protocol;
import org.eclipse.lsp4j.DidChangeConfigurationParams; import org.eclipse.lsp4j.DidChangeConfigurationParams;
import org.eclipse.lsp4j.DidChangeWatchedFilesParams; import org.eclipse.lsp4j.DidChangeWatchedFilesParams;
import org.eclipse.lsp4j.SymbolInformation;
import org.eclipse.lsp4j.WorkspaceSymbol;
import org.eclipse.lsp4j.WorkspaceSymbolParams;
import org.eclipse.lsp4j.jsonrpc.messages.Either;
import org.eclipse.lsp4j.services.WorkspaceService; import org.eclipse.lsp4j.services.WorkspaceService;
import p.studio.lsp.messages.LspProjectContext;
import p.studio.lsp.services.LanguageServiceBridge;
import p.studio.lsp.services.protocol.mapping.ProtocolMessageMapper;
import java.util.List;
import java.util.concurrent.CompletableFuture;
public final class PrometeuWorkspaceService implements WorkspaceService { public final class PrometeuWorkspaceService implements WorkspaceService {
private final LspProjectContext project;
private final LanguageServiceBridge languageServiceBridge;
private final ProtocolMessageMapper protocolMessageMapper;
public PrometeuWorkspaceService() {
this(null, null, null);
}
public PrometeuWorkspaceService(
final LspProjectContext project,
final LanguageServiceBridge languageServiceBridge,
final ProtocolMessageMapper protocolMessageMapper) {
this.project = project;
this.languageServiceBridge = languageServiceBridge;
this.protocolMessageMapper = protocolMessageMapper;
}
@Override @Override
public void didChangeConfiguration(final DidChangeConfigurationParams params) { public void didChangeConfiguration(final DidChangeConfigurationParams params) {
} }
@@ -12,4 +39,15 @@ public final class PrometeuWorkspaceService implements WorkspaceService {
@Override @Override
public void didChangeWatchedFiles(final DidChangeWatchedFilesParams params) { public void didChangeWatchedFiles(final DidChangeWatchedFilesParams params) {
} }
@Override
public CompletableFuture<Either<List<? extends SymbolInformation>, List<? extends WorkspaceSymbol>>> symbol(
final WorkspaceSymbolParams params) {
if (project == null || languageServiceBridge == null || protocolMessageMapper == null) {
return CompletableFuture.completedFuture(Either.forLeft(List.of()));
}
final String query = params == null || params.getQuery() == null ? "" : params.getQuery();
return CompletableFuture.completedFuture(Either.forLeft(
protocolMessageMapper.mapWorkspaceSymbols(languageServiceBridge.workspaceSymbols(project, query))));
}
} }
@@ -36,6 +36,10 @@ public final class Lsp4jProtocolMessageMapper implements ProtocolMessageMapper {
signatureHelpOptions.setRetriggerCharacters(List.of(",")); signatureHelpOptions.setRetriggerCharacters(List.of(","));
capabilities.setSignatureHelpProvider(signatureHelpOptions); capabilities.setSignatureHelpProvider(signatureHelpOptions);
} }
capabilities.setDefinitionProvider(description.definitionSupported());
capabilities.setReferencesProvider(description.referencesSupported());
capabilities.setDocumentSymbolProvider(description.documentSymbolsSupported());
capabilities.setWorkspaceSymbolProvider(description.workspaceSymbolsSupported());
final SemanticTokensWithRegistrationOptions semanticTokens = new SemanticTokensWithRegistrationOptions(); final SemanticTokensWithRegistrationOptions semanticTokens = new SemanticTokensWithRegistrationOptions();
semanticTokens.setLegend(new SemanticTokensLegend(description.semanticTokenTypes(), List.of())); semanticTokens.setLegend(new SemanticTokensLegend(description.semanticTokenTypes(), List.of()));
semanticTokens.setFull(true); semanticTokens.setFull(true);
@@ -83,6 +87,120 @@ public final class Lsp4jProtocolMessageMapper implements ProtocolMessageMapper {
return result; return result;
} }
@Override
public List<Location> mapDefinition(final BaselineDefinition definition) {
if (definition == null || definition.locations().isEmpty()) {
return List.of();
}
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());
}
@Override
public List<DocumentSymbol> mapDocumentSymbols(final BaselineDocumentSymbols symbols) {
if (symbols == null || symbols.symbols().isEmpty()) {
return List.of();
}
final ArrayList<DocumentSymbol> mapped = new ArrayList<>();
for (final BaselineDocumentSymbol symbol : symbols.symbols()) {
mapped.add(mapDocumentSymbol(symbol, null));
}
return List.copyOf(mapped);
}
@Override
public List<SymbolInformation> mapWorkspaceSymbols(final BaselineWorkspaceSymbols symbols) {
if (symbols == null || symbols.symbols().isEmpty()) {
return List.of();
}
final ArrayList<SymbolInformation> mapped = new ArrayList<>();
for (final BaselineWorkspaceSymbol symbol : symbols.symbols()) {
final SymbolInformation information = new SymbolInformation();
information.setName(symbol.name());
information.setKind(toLspWorkspaceSymbolKind(symbol.kind(), symbol.containerName()));
information.setContainerName(symbol.containerName());
information.setLocation(new Location(
symbol.uri(),
new Range(
new Position(symbol.startLine(), symbol.startCharacter()),
new Position(symbol.endLine(), symbol.endCharacter()))));
mapped.add(information);
}
return List.copyOf(mapped);
}
private DocumentSymbol mapDocumentSymbol(
final BaselineDocumentSymbol symbol,
final BaselineDocumentSymbolKind parentKind) {
final DocumentSymbol mapped = new DocumentSymbol();
mapped.setName(symbol.name());
mapped.setDetail(symbol.detail());
mapped.setKind(toLspSymbolKind(symbol.kind(), parentKind));
mapped.setRange(new Range(
new Position(symbol.startLine(), symbol.startCharacter()),
new Position(symbol.endLine(), symbol.endCharacter())));
mapped.setSelectionRange(new Range(
new Position(symbol.selectionStartLine(), symbol.selectionStartCharacter()),
new Position(symbol.selectionEndLine(), symbol.selectionEndCharacter())));
final ArrayList<DocumentSymbol> children = new ArrayList<>();
for (final BaselineDocumentSymbol child : symbol.children()) {
children.add(mapDocumentSymbol(child, symbol.kind()));
}
mapped.setChildren(children);
return mapped;
}
private SymbolKind toLspWorkspaceSymbolKind(
final BaselineDocumentSymbolKind kind,
final String containerName) {
if (containerName != null
&& !containerName.isBlank()
&& (kind == BaselineDocumentSymbolKind.ENUM || kind == BaselineDocumentSymbolKind.ERROR)) {
return SymbolKind.EnumMember;
}
return toLspSymbolKind(kind, null);
}
private SymbolKind toLspSymbolKind(
final BaselineDocumentSymbolKind kind,
final BaselineDocumentSymbolKind parentKind) {
if (parentKind == BaselineDocumentSymbolKind.ENUM || parentKind == BaselineDocumentSymbolKind.ERROR) {
if (kind == BaselineDocumentSymbolKind.ENUM || kind == BaselineDocumentSymbolKind.ERROR) {
return SymbolKind.EnumMember;
}
}
return switch (kind) {
case FUNCTION -> SymbolKind.Function;
case METHOD -> SymbolKind.Method;
case CONSTRUCTOR -> SymbolKind.Constructor;
case FIELD -> SymbolKind.Field;
case STRUCT, BUILTIN_TYPE -> SymbolKind.Struct;
case SERVICE, HOST -> SymbolKind.Class;
case CONTRACT, CALLBACK -> SymbolKind.Interface;
case ENUM, ERROR -> SymbolKind.Enum;
case GLOBAL, LOCAL, PARAMETER -> SymbolKind.Variable;
case CONST -> SymbolKind.Constant;
case KEYWORD -> SymbolKind.Key;
};
}
private List<Location> mapLocations(final List<BaselineDefinitionLocation> locations) {
return locations.stream()
.map(location -> new Location(
location.uri(),
new Range(
new Position(location.startLine(), location.startCharacter()),
new Position(location.endLine(), location.endCharacter()))))
.toList();
}
@Override @Override
public CompletionList mapCompletion(final BaselineCompletion completion) { public CompletionList mapCompletion(final BaselineCompletion completion) {
final CompletionList list = new CompletionList(); final CompletionList list = new CompletionList();
@@ -6,14 +6,23 @@ import org.eclipse.lsp4j.MessageParams;
import org.eclipse.lsp4j.PublishDiagnosticsParams; import org.eclipse.lsp4j.PublishDiagnosticsParams;
import org.eclipse.lsp4j.SignatureHelp; import org.eclipse.lsp4j.SignatureHelp;
import org.eclipse.lsp4j.SemanticTokens; import org.eclipse.lsp4j.SemanticTokens;
import org.eclipse.lsp4j.DocumentSymbol;
import org.eclipse.lsp4j.Location;
import org.eclipse.lsp4j.SymbolInformation;
import p.studio.lsp.messages.BaselineDocumentAnalysis; import p.studio.lsp.messages.BaselineDocumentAnalysis;
import p.studio.lsp.messages.BaselineDocumentSymbols;
import p.studio.lsp.messages.BaselineWorkspaceSymbols;
import p.studio.lsp.messages.BaselineCompletion; 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.BaselineHover;
import p.studio.lsp.messages.BaselineSemanticTokens; import p.studio.lsp.messages.BaselineSemanticTokens;
import p.studio.lsp.messages.BaselineSignatureHelp; import p.studio.lsp.messages.BaselineSignatureHelp;
import p.studio.lsp.messages.BaselineServerDescription; import p.studio.lsp.messages.BaselineServerDescription;
import org.eclipse.lsp4j.CompletionList; import org.eclipse.lsp4j.CompletionList;
import java.util.List;
public interface ProtocolMessageMapper { public interface ProtocolMessageMapper {
InitializeResult mapInitializeResult(BaselineServerDescription description); InitializeResult mapInitializeResult(BaselineServerDescription description);
@@ -23,6 +32,14 @@ public interface ProtocolMessageMapper {
Hover mapHover(BaselineHover hover); Hover mapHover(BaselineHover hover);
List<Location> mapDefinition(BaselineDefinition definition);
List<Location> mapReferences(BaselineReferences references);
List<DocumentSymbol> mapDocumentSymbols(BaselineDocumentSymbols symbols);
List<SymbolInformation> mapWorkspaceSymbols(BaselineWorkspaceSymbols symbols);
CompletionList mapCompletion(BaselineCompletion completion); CompletionList mapCompletion(BaselineCompletion completion);
SignatureHelp mapSignatureHelp(BaselineSignatureHelp signatureHelp); SignatureHelp mapSignatureHelp(BaselineSignatureHelp signatureHelp);
@@ -15,8 +15,10 @@ import p.studio.utilities.structures.ReadOnlySet;
import java.nio.file.Files; import java.nio.file.Files;
import java.nio.file.Path; import java.nio.file.Path;
import java.util.List;
import static org.junit.jupiter.api.Assertions.assertFalse; import static org.junit.jupiter.api.Assertions.assertFalse;
import static org.junit.jupiter.api.Assertions.assertEquals; import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertNotEquals;
import static org.junit.jupiter.api.Assertions.assertTrue; import static org.junit.jupiter.api.Assertions.assertTrue;
class CompilerLanguageServiceBridgeTest { class CompilerLanguageServiceBridgeTest {
@@ -45,6 +47,18 @@ class CompilerLanguageServiceBridgeTest {
assertEquals(0, signatureHelp.activeSignature()); assertEquals(0, signatureHelp.activeSignature());
assertEquals(0, signatureHelp.activeParameter()); assertEquals(0, signatureHelp.activeParameter());
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 documentSymbols = bridge.documentSymbols(context, documentUri, "fn main() {}");
assertTrue(documentSymbols.symbols().isEmpty());
final var workspaceSymbols = bridge.workspaceSymbols(context, "frame");
assertTrue(workspaceSymbols.symbols().isEmpty());
final var semanticTokens = bridge.semanticTokens(context, documentUri, "fn main() {}"); final var semanticTokens = bridge.semanticTokens(context, documentUri, "fn main() {}");
assertTrue(semanticTokens.legend().isEmpty()); assertTrue(semanticTokens.legend().isEmpty());
assertTrue(semanticTokens.tokens().isEmpty()); assertTrue(semanticTokens.tokens().isEmpty());
@@ -309,6 +323,262 @@ class CompilerLanguageServiceBridgeTest {
assertTrue(helper.documentation().contains("- returns `42`")); assertTrue(helper.documentation().contains("- returns `42`"));
} }
@Test
void definitionUsesEditorialLookupAndPhysicalStdlibFiles() {
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();
vec.blend(1, 2);
Gfx.clear(5);
let n: int = 1;
n;
}
""";
final CompilerLanguageServiceBridge bridge = new CompilerLanguageServiceBridge();
final LspProjectContext context = new LspProjectContext("main", "pbs", projectRoot);
final DocumentPositionMapper mapper = new DocumentPositionMapper(overlay);
final var helperUse = mapper.positionOf(overlay.indexOf("helper();"));
final var helperDefinition = bridge.definition(
context,
documentPath.toUri().toString(),
overlay,
helperUse.line(),
helperUse.character());
assertEquals(1, helperDefinition.locations().size());
assertEquals(documentPath.toUri().toString(), helperDefinition.locations().getFirst().uri());
assertTrue(helperDefinition.locations().getFirst().startLine() < helperUse.line());
final var blendUse = mapper.positionOf(overlay.indexOf("blend(1"));
final var blendDefinition = bridge.definition(
context,
documentPath.toUri().toString(),
overlay,
blendUse.line(),
blendUse.character());
assertEquals(1, blendDefinition.locations().size());
assertEquals(documentPath.toUri().toString(), blendDefinition.locations().getFirst().uri());
final var clearUse = mapper.positionOf(overlay.indexOf("clear"));
final var clearHover = bridge.hover(
context,
documentPath.toUri().toString(),
overlay,
clearUse.line(),
clearUse.character());
assertTrue(clearHover.markdown().contains("clear(color:"));
final var clearDefinition = bridge.definition(
context,
documentPath.toUri().toString(),
overlay,
clearUse.line(),
clearUse.character());
assertTrue(
clearDefinition.locations().isEmpty(),
"stdlib is loaded from a virtual path, so definition stays empty until a physical file exists");
final var builtinUse = mapper.positionOf(overlay.indexOf("int = 1"));
final var builtinHover = bridge.hover(
context,
documentPath.toUri().toString(),
overlay,
builtinUse.line(),
builtinUse.character());
assertTrue(builtinHover.markdown().contains("builtin"));
final var builtinDefinition = bridge.definition(
context,
documentPath.toUri().toString(),
overlay,
builtinUse.line(),
builtinUse.character());
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 documentSymbolsUseAstHierarchyOfTheOpenPbsFile() {
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(x: int) {
ctor make(x: int) { return; }
fn blend(dx: int, dy: int) -> int { return dx; }
}
fn helper() -> int { return 42; }
fn helper(value: int) -> int { return value; }
fn frame() -> void {
let local = 1;
helper(local);
}
""";
final CompilerLanguageServiceBridge bridge = new CompilerLanguageServiceBridge();
final var symbols = bridge.documentSymbols(
new LspProjectContext("main", "pbs", projectRoot),
documentPath.toUri().toString(),
overlay).symbols();
assertEquals(List.of("Vec", "helper", "helper", "frame"), symbols.stream().map(symbol -> symbol.name()).toList());
assertTrue(symbols.stream().noneMatch(symbol -> symbol.name().equals("Gfx") || symbol.name().equals("local")));
final var vec = symbols.getFirst();
assertEquals(p.studio.lsp.messages.BaselineDocumentSymbolKind.STRUCT, vec.kind());
assertEquals(List.of("x", "make", "blend"), vec.children().stream().map(symbol -> symbol.name()).toList());
assertEquals("(dx: int, dy: int) -> int", vec.children().get(2).detail());
assertEquals("helper", symbols.get(1).name());
assertEquals("helper", symbols.get(2).name());
assertNotEquals(symbols.get(1).detail(), symbols.get(2).detail());
}
@Test
void workspaceSymbolsSearchPhysicalNamedDeclarationsWithoutAnOpenDocument() {
final Path projectRoot = findRepoRoot(Path.of("").toAbsolutePath().normalize())
.resolve("test-projects")
.resolve("main")
.toAbsolutePath()
.normalize();
final CompilerLanguageServiceBridge bridge = new CompilerLanguageServiceBridge();
final var context = new LspProjectContext("main", "pbs", projectRoot);
final var frameHits = bridge.workspaceSymbols(context, "frame");
assertTrue(frameHits.symbols().stream().anyMatch(symbol ->
symbol.name().equals("frame") && symbol.containerName().isEmpty()));
assertTrue(frameHits.symbols().stream().allMatch(symbol ->
symbol.uri().contains("main.pbs")));
final var caseInsensitive = bridge.workspaceSymbols(context, "BLA");
assertTrue(caseInsensitive.symbols().stream().anyMatch(symbol ->
symbol.name().equals("Bla") && symbol.containerName().isEmpty()));
final var all = bridge.workspaceSymbols(context, "");
assertTrue(all.symbols().stream().anyMatch(symbol ->
symbol.name().equals("a") && symbol.containerName().equals("Bla")));
assertTrue(all.symbols().stream().anyMatch(symbol -> symbol.name().equals("init")));
assertTrue(all.symbols().stream().noneMatch(symbol ->
symbol.name().equals("Gfx")
|| symbol.name().equals("Log")
|| symbol.name().equals("Composer")));
assertTrue(isSortedByNameThenUriThenOffset(all.symbols()));
final var stdlibMiss = bridge.workspaceSymbols(context, "Gfx");
assertTrue(stdlibMiss.symbols().isEmpty());
}
private boolean isSortedByNameThenUriThenOffset(
final List<p.studio.lsp.messages.BaselineWorkspaceSymbol> symbols) {
for (int index = 1; index < symbols.size(); index += 1) {
final var previous = symbols.get(index - 1);
final var current = symbols.get(index);
final int nameOrder = String.CASE_INSENSITIVE_ORDER.compare(previous.name(), current.name());
if (nameOrder > 0) {
return false;
}
if (nameOrder == 0) {
final int uriOrder = previous.uri().compareTo(current.uri());
if (uriOrder > 0) {
return false;
}
if (uriOrder == 0 && previous.startLine() > current.startLine()) {
return false;
}
}
}
return true;
}
@Test @Test
void describeServerPublishesFrontendVisualThemes() { void describeServerPublishesFrontendVisualThemes() {
final CompilerLanguageServiceBridge bridge = new CompilerLanguageServiceBridge(); final CompilerLanguageServiceBridge bridge = new CompilerLanguageServiceBridge();
@@ -319,6 +589,10 @@ class CompilerLanguageServiceBridgeTest {
assertEquals("pbs-default", description.activeVisualThemeId()); assertEquals("pbs-default", description.activeVisualThemeId());
assertTrue(description.completionSupported()); assertTrue(description.completionSupported());
assertTrue(description.signatureHelpSupported()); assertTrue(description.signatureHelpSupported());
assertTrue(description.definitionSupported());
assertTrue(description.referencesSupported());
assertTrue(description.documentSymbolsSupported());
assertTrue(description.workspaceSymbolsSupported());
assertEquals(1, description.semanticHostProjections().size()); assertEquals(1, description.semanticHostProjections().size());
assertEquals("vscode", description.semanticHostProjections().getFirst().hostId()); assertEquals("vscode", description.semanticHostProjections().getFirst().hostId());
assertTrue(description.semanticHostProjections().getFirst().tokenProjections().stream() assertTrue(description.semanticHostProjections().getFirst().tokenProjections().stream()
@@ -15,6 +15,7 @@ import org.junit.jupiter.api.Test;
import p.studio.lsp.messages.BaselineCompletion; import p.studio.lsp.messages.BaselineCompletion;
import p.studio.lsp.messages.BaselineCompletionItem; import p.studio.lsp.messages.BaselineCompletionItem;
import p.studio.lsp.messages.BaselineCompletionItemKind; import p.studio.lsp.messages.BaselineCompletionItemKind;
import p.studio.lsp.messages.BaselineDefinition;
import p.studio.lsp.messages.BaselineDocumentAnalysis; import p.studio.lsp.messages.BaselineDocumentAnalysis;
import p.studio.lsp.messages.BaselineEditorPalette; import p.studio.lsp.messages.BaselineEditorPalette;
import p.studio.lsp.messages.BaselineHover; import p.studio.lsp.messages.BaselineHover;
@@ -98,6 +99,10 @@ class PrometeuLanguageServerTest {
true, true,
true, true,
true, true,
true,
true,
true,
true,
List.of(), List.of(),
List.of(new BaselineSemanticHostProjection( List.of(new BaselineSemanticHostProjection(
"vscode", "vscode",
@@ -145,6 +150,42 @@ class PrometeuLanguageServerTest {
return new BaselineHover("hover"); return new BaselineHover("hover");
} }
@Override
public BaselineDefinition definition(
final LspProjectContext project,
final String documentUri,
final String text,
final int line,
final int character) {
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 p.studio.lsp.messages.BaselineDocumentSymbols documentSymbols(
final LspProjectContext project,
final String documentUri,
final String text) {
return p.studio.lsp.messages.BaselineDocumentSymbols.empty();
}
@Override
public p.studio.lsp.messages.BaselineWorkspaceSymbols workspaceSymbols(
final LspProjectContext project,
final String query) {
return p.studio.lsp.messages.BaselineWorkspaceSymbols.empty();
}
@Override @Override
public BaselineSignatureHelp signatureHelp( public BaselineSignatureHelp signatureHelp(
final LspProjectContext project, final LspProjectContext project,
@@ -191,6 +232,29 @@ class PrometeuLanguageServerTest {
throw new UnsupportedOperationException(); throw new UnsupportedOperationException();
} }
@Override
public java.util.List<org.eclipse.lsp4j.Location> mapDefinition(final BaselineDefinition definition) {
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 java.util.List<org.eclipse.lsp4j.DocumentSymbol> mapDocumentSymbols(
final p.studio.lsp.messages.BaselineDocumentSymbols symbols) {
throw new UnsupportedOperationException();
}
@Override
public java.util.List<org.eclipse.lsp4j.SymbolInformation> mapWorkspaceSymbols(
final p.studio.lsp.messages.BaselineWorkspaceSymbols symbols) {
throw new UnsupportedOperationException();
}
@Override @Override
public org.eclipse.lsp4j.CompletionList mapCompletion(final BaselineCompletion completion) { public org.eclipse.lsp4j.CompletionList mapCompletion(final BaselineCompletion completion) {
throw new UnsupportedOperationException(); throw new UnsupportedOperationException();
@@ -3,9 +3,15 @@ package p.studio.lsp.services.protocol;
import org.eclipse.lsp4j.CompletionItem; import org.eclipse.lsp4j.CompletionItem;
import org.eclipse.lsp4j.CompletionList; import org.eclipse.lsp4j.CompletionList;
import org.eclipse.lsp4j.CompletionParams; import org.eclipse.lsp4j.CompletionParams;
import org.eclipse.lsp4j.DefinitionParams;
import org.eclipse.lsp4j.DocumentSymbol;
import org.eclipse.lsp4j.DocumentSymbolParams;
import org.eclipse.lsp4j.ReferenceContext;
import org.eclipse.lsp4j.ReferenceParams;
import org.eclipse.lsp4j.DidOpenTextDocumentParams; import org.eclipse.lsp4j.DidOpenTextDocumentParams;
import org.eclipse.lsp4j.Hover; import org.eclipse.lsp4j.Hover;
import org.eclipse.lsp4j.HoverParams; import org.eclipse.lsp4j.HoverParams;
import org.eclipse.lsp4j.Location;
import org.eclipse.lsp4j.MarkupContent; import org.eclipse.lsp4j.MarkupContent;
import org.eclipse.lsp4j.Position; import org.eclipse.lsp4j.Position;
import org.eclipse.lsp4j.SignatureHelp; import org.eclipse.lsp4j.SignatureHelp;
@@ -16,6 +22,12 @@ import org.junit.jupiter.api.Test;
import p.studio.lsp.messages.BaselineCompletion; import p.studio.lsp.messages.BaselineCompletion;
import p.studio.lsp.messages.BaselineCompletionItem; import p.studio.lsp.messages.BaselineCompletionItem;
import p.studio.lsp.messages.BaselineCompletionItemKind; import p.studio.lsp.messages.BaselineCompletionItemKind;
import p.studio.lsp.messages.BaselineDefinition;
import p.studio.lsp.messages.BaselineDefinitionLocation;
import p.studio.lsp.messages.BaselineDocumentSymbol;
import p.studio.lsp.messages.BaselineDocumentSymbolKind;
import p.studio.lsp.messages.BaselineDocumentSymbols;
import p.studio.lsp.messages.BaselineReferences;
import p.studio.lsp.messages.BaselineDocumentAnalysis; import p.studio.lsp.messages.BaselineDocumentAnalysis;
import p.studio.lsp.messages.BaselineHover; import p.studio.lsp.messages.BaselineHover;
import p.studio.lsp.messages.BaselineSemanticTokens; import p.studio.lsp.messages.BaselineSemanticTokens;
@@ -77,6 +89,31 @@ final class PrometeuTextDocumentServiceTest {
assertEquals(1, bridge.lastSignatureHelpLine); assertEquals(1, bridge.lastSignatureHelpLine);
assertEquals(6, bridge.lastSignatureHelpCharacter); assertEquals(6, bridge.lastSignatureHelpCharacter);
assertTrue(mapper.mappedSignatureHelp.signatures().getFirst().label().contains("demo")); assertTrue(mapper.mappedSignatureHelp.signatures().getFirst().label().contains("demo"));
final var definition = service.definition(new DefinitionParams(
new TextDocumentIdentifier(uri),
new Position(1, 2))).join();
assertSame(mapper.definitionLocations, definition.getLeft());
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);
final var documentSymbols = service.documentSymbol(new DocumentSymbolParams(
new TextDocumentIdentifier(uri))).join();
assertEquals(1, documentSymbols.size());
assertTrue(documentSymbols.getFirst().isRight());
assertSame(mapper.documentSymbols.getFirst(), documentSymbols.getFirst().getRight());
assertEquals(text, bridge.lastDocumentSymbolsText);
} }
private static final class RecordingBridge implements LanguageServiceBridge { private static final class RecordingBridge implements LanguageServiceBridge {
@@ -84,6 +121,14 @@ final class PrometeuTextDocumentServiceTest {
private int lastCompletionLine; private int lastCompletionLine;
private int lastCompletionCharacter; private int lastCompletionCharacter;
private String lastHoverText; private String lastHoverText;
private String lastDefinitionText;
private int lastDefinitionLine;
private int lastDefinitionCharacter;
private String lastReferencesText;
private int lastReferencesLine;
private int lastReferencesCharacter;
private boolean lastIncludeDeclaration;
private String lastDocumentSymbolsText;
private String lastSignatureHelpText; private String lastSignatureHelpText;
private int lastSignatureHelpLine; private int lastSignatureHelpLine;
private int lastSignatureHelpCharacter; private int lastSignatureHelpCharacter;
@@ -123,6 +168,62 @@ final class PrometeuTextDocumentServiceTest {
return new BaselineHover("hover"); return new BaselineHover("hover");
} }
@Override
public BaselineDefinition definition(
final LspProjectContext context,
final String documentUri,
final String text,
final int line,
final int character) {
lastDefinitionText = text;
lastDefinitionLine = line;
lastDefinitionCharacter = character;
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 BaselineDocumentSymbols documentSymbols(
final LspProjectContext context,
final String documentUri,
final String text) {
lastDocumentSymbolsText = text;
return new BaselineDocumentSymbols(List.of(new BaselineDocumentSymbol(
"frame",
BaselineDocumentSymbolKind.FUNCTION,
"",
0,
0,
2,
1,
0,
3,
0,
8,
List.of())));
}
@Override
public p.studio.lsp.messages.BaselineWorkspaceSymbols workspaceSymbols(
final LspProjectContext context,
final String query) {
return p.studio.lsp.messages.BaselineWorkspaceSymbols.empty();
}
@Override @Override
public BaselineSignatureHelp signatureHelp( public BaselineSignatureHelp signatureHelp(
final LspProjectContext context, final LspProjectContext context,
@@ -151,6 +252,9 @@ final class PrometeuTextDocumentServiceTest {
private static final class RecordingMapper implements ProtocolMessageMapper { private static final class RecordingMapper implements ProtocolMessageMapper {
private final CompletionList completionList = new CompletionList(false, List.of(new CompletionItem("demo"))); private final CompletionList completionList = new CompletionList(false, List.of(new CompletionItem("demo")));
private final SignatureHelp signatureHelp = new SignatureHelp(); private final SignatureHelp signatureHelp = new SignatureHelp();
private final List<Location> definitionLocations = List.of();
private final List<Location> referenceLocations = List.of();
private final List<DocumentSymbol> documentSymbols = List.of(new DocumentSymbol());
private BaselineSignatureHelp mappedSignatureHelp; private BaselineSignatureHelp mappedSignatureHelp;
@Override @Override
@@ -178,6 +282,27 @@ final class PrometeuTextDocumentServiceTest {
return new Hover(content); return new Hover(content);
} }
@Override
public List<Location> mapDefinition(final BaselineDefinition definition) {
return definitionLocations;
}
@Override
public List<Location> mapReferences(final BaselineReferences references) {
return referenceLocations;
}
@Override
public List<DocumentSymbol> mapDocumentSymbols(final BaselineDocumentSymbols symbols) {
return documentSymbols;
}
@Override
public List<org.eclipse.lsp4j.SymbolInformation> mapWorkspaceSymbols(
final p.studio.lsp.messages.BaselineWorkspaceSymbols symbols) {
return List.of();
}
@Override @Override
public CompletionList mapCompletion(final BaselineCompletion completion) { public CompletionList mapCompletion(final BaselineCompletion completion) {
return completionList; return completionList;
@@ -0,0 +1,229 @@
package p.studio.lsp.services.protocol;
import org.eclipse.lsp4j.SymbolInformation;
import org.eclipse.lsp4j.WorkspaceSymbolParams;
import org.junit.jupiter.api.Test;
import p.studio.lsp.messages.BaselineCompletion;
import p.studio.lsp.messages.BaselineDefinition;
import p.studio.lsp.messages.BaselineDocumentAnalysis;
import p.studio.lsp.messages.BaselineDocumentSymbols;
import p.studio.lsp.messages.BaselineDocumentSymbolKind;
import p.studio.lsp.messages.BaselineHover;
import p.studio.lsp.messages.BaselineReferences;
import p.studio.lsp.messages.BaselineSemanticTokens;
import p.studio.lsp.messages.BaselineServerDescription;
import p.studio.lsp.messages.BaselineSignatureHelp;
import p.studio.lsp.messages.BaselineWorkspaceSymbol;
import p.studio.lsp.messages.BaselineWorkspaceSymbols;
import p.studio.lsp.messages.LspProjectContext;
import p.studio.lsp.services.LanguageServiceBridge;
import p.studio.lsp.services.protocol.mapping.ProtocolMessageMapper;
import java.nio.file.Path;
import java.util.List;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertSame;
import static org.junit.jupiter.api.Assertions.assertTrue;
final class PrometeuWorkspaceServiceTest {
@Test
void symbolDelegatesQueryWithoutADocumentUri() {
final var bridge = new RecordingBridge();
final var mapper = new RecordingMapper();
final var project = new LspProjectContext("main", "pbs", Path.of("."));
final var service = new PrometeuWorkspaceService(project, bridge, mapper);
final var result = service.symbol(new WorkspaceSymbolParams("blend")).join();
assertTrue(result.isLeft());
assertSame(mapper.workspaceSymbols, result.getLeft());
assertEquals("blend", bridge.lastQuery);
assertSame(project, bridge.lastContext);
}
private static final class RecordingBridge implements LanguageServiceBridge {
private LspProjectContext lastContext;
private String lastQuery;
@Override
public BaselineServerDescription describeServer(final LspProjectContext context) {
throw new UnsupportedOperationException();
}
@Override
public BaselineDocumentAnalysis analyzeDocument(
final LspProjectContext context,
final String documentUri,
final String text) {
throw new UnsupportedOperationException();
}
@Override
public BaselineCompletion completion(
final LspProjectContext context,
final String documentUri,
final String text,
final int line,
final int character) {
throw new UnsupportedOperationException();
}
@Override
public BaselineHover hover(
final LspProjectContext context,
final String documentUri,
final String text,
final int line,
final int character) {
throw new UnsupportedOperationException();
}
@Override
public BaselineDefinition definition(
final LspProjectContext context,
final String documentUri,
final String text,
final int line,
final int character) {
throw new UnsupportedOperationException();
}
@Override
public BaselineReferences references(
final LspProjectContext context,
final String documentUri,
final String text,
final int line,
final int character,
final boolean includeDeclaration) {
throw new UnsupportedOperationException();
}
@Override
public BaselineDocumentSymbols documentSymbols(
final LspProjectContext context,
final String documentUri,
final String text) {
throw new UnsupportedOperationException();
}
@Override
public BaselineWorkspaceSymbols workspaceSymbols(
final LspProjectContext context,
final String query) {
lastContext = context;
lastQuery = query;
return new BaselineWorkspaceSymbols(List.of(new BaselineWorkspaceSymbol(
"blend",
BaselineDocumentSymbolKind.METHOD,
"",
"Vec",
"file:///tmp/demo.pbs",
0,
0,
0,
5)));
}
@Override
public BaselineSignatureHelp signatureHelp(
final LspProjectContext context,
final String documentUri,
final String text,
final int line,
final int character) {
throw new UnsupportedOperationException();
}
@Override
public BaselineSemanticTokens semanticTokens(
final LspProjectContext context,
final String documentUri,
final String text) {
throw new UnsupportedOperationException();
}
@Override
public String onSave(final LspProjectContext context, final String documentUri) {
throw new UnsupportedOperationException();
}
}
private static final class RecordingMapper implements ProtocolMessageMapper {
private final List<SymbolInformation> workspaceSymbols = List.of(new SymbolInformation());
@Override
public org.eclipse.lsp4j.InitializeResult mapInitializeResult(final BaselineServerDescription description) {
throw new UnsupportedOperationException();
}
@Override
public org.eclipse.lsp4j.PublishDiagnosticsParams mapDiagnostics(
final String uri,
final BaselineDocumentAnalysis analysis) {
throw new UnsupportedOperationException();
}
@Override
public org.eclipse.lsp4j.PublishDiagnosticsParams emptyDiagnostics(final String uri) {
throw new UnsupportedOperationException();
}
@Override
public org.eclipse.lsp4j.Hover mapHover(final BaselineHover hover) {
throw new UnsupportedOperationException();
}
@Override
public List<org.eclipse.lsp4j.Location> mapDefinition(final BaselineDefinition definition) {
throw new UnsupportedOperationException();
}
@Override
public List<org.eclipse.lsp4j.Location> mapReferences(final BaselineReferences references) {
throw new UnsupportedOperationException();
}
@Override
public List<org.eclipse.lsp4j.DocumentSymbol> mapDocumentSymbols(final BaselineDocumentSymbols symbols) {
throw new UnsupportedOperationException();
}
@Override
public List<SymbolInformation> mapWorkspaceSymbols(final BaselineWorkspaceSymbols symbols) {
return workspaceSymbols;
}
@Override
public org.eclipse.lsp4j.CompletionList mapCompletion(final BaselineCompletion completion) {
throw new UnsupportedOperationException();
}
@Override
public org.eclipse.lsp4j.SignatureHelp mapSignatureHelp(final BaselineSignatureHelp signatureHelp) {
throw new UnsupportedOperationException();
}
@Override
public org.eclipse.lsp4j.SemanticTokens mapSemanticTokens(final BaselineSemanticTokens semanticTokens) {
throw new UnsupportedOperationException();
}
@Override
public org.eclipse.lsp4j.MessageParams mapInfoMessage(final String message) {
throw new UnsupportedOperationException();
}
@Override
public org.eclipse.lsp4j.MessageParams mapErrorMessage(final String message) {
throw new UnsupportedOperationException();
}
@Override
public org.eclipse.lsp4j.MessageParams mapWarningMessage(final String message) {
throw new UnsupportedOperationException();
}
}
}
@@ -1,11 +1,18 @@
package p.studio.lsp.services.protocol.mapping; package p.studio.lsp.services.protocol.mapping;
import org.eclipse.lsp4j.InitializeResult; import org.eclipse.lsp4j.InitializeResult;
import org.eclipse.lsp4j.SymbolKind;
import org.eclipse.lsp4j.jsonrpc.messages.Either; import org.eclipse.lsp4j.jsonrpc.messages.Either;
import org.junit.jupiter.api.Test; import org.junit.jupiter.api.Test;
import p.studio.lsp.messages.BaselineCompletion; import p.studio.lsp.messages.BaselineCompletion;
import p.studio.lsp.messages.BaselineCompletionItem; import p.studio.lsp.messages.BaselineCompletionItem;
import p.studio.lsp.messages.BaselineCompletionItemKind; import p.studio.lsp.messages.BaselineCompletionItemKind;
import p.studio.lsp.messages.BaselineDefinition;
import p.studio.lsp.messages.BaselineDefinitionLocation;
import p.studio.lsp.messages.BaselineDocumentSymbol;
import p.studio.lsp.messages.BaselineDocumentSymbolKind;
import p.studio.lsp.messages.BaselineDocumentSymbols;
import p.studio.lsp.messages.BaselineReferences;
import p.studio.lsp.messages.BaselineEditorPalette; import p.studio.lsp.messages.BaselineEditorPalette;
import p.studio.lsp.messages.BaselineSemanticHostProjection; import p.studio.lsp.messages.BaselineSemanticHostProjection;
import p.studio.lsp.messages.BaselineSemanticHostProjectionEntry; import p.studio.lsp.messages.BaselineSemanticHostProjectionEntry;
@@ -35,6 +42,10 @@ final class Lsp4jProtocolMessageMapperTest {
true, true,
true, true,
true, true,
true,
true,
true,
true,
List.of("demo-keyword"), List.of("demo-keyword"),
List.of(new BaselineSemanticHostProjection( List.of(new BaselineSemanticHostProjection(
"vscode", "vscode",
@@ -55,6 +66,10 @@ final class Lsp4jProtocolMessageMapperTest {
assertEquals(List.of("."), result.getCapabilities().getCompletionProvider().getTriggerCharacters()); assertEquals(List.of("."), result.getCapabilities().getCompletionProvider().getTriggerCharacters());
assertEquals(List.of("(", ","), result.getCapabilities().getSignatureHelpProvider().getTriggerCharacters()); assertEquals(List.of("(", ","), result.getCapabilities().getSignatureHelpProvider().getTriggerCharacters());
assertEquals(Boolean.TRUE, result.getCapabilities().getDefinitionProvider().getLeft());
assertEquals(Boolean.TRUE, result.getCapabilities().getReferencesProvider().getLeft());
assertEquals(Boolean.TRUE, result.getCapabilities().getDocumentSymbolProvider().getLeft());
assertEquals(Boolean.TRUE, result.getCapabilities().getWorkspaceSymbolProvider().getLeft());
final var experimental = assertInstanceOf(Map.class, result.getCapabilities().getExperimental()); final var experimental = assertInstanceOf(Map.class, result.getCapabilities().getExperimental());
final var semanticPayload = assertInstanceOf(Map.class, experimental.get("prometeuSemanticHostProjections")); final var semanticPayload = assertInstanceOf(Map.class, experimental.get("prometeuSemanticHostProjections"));
@@ -104,4 +119,131 @@ final class Lsp4jProtocolMessageMapperTest {
assertEquals("left: int", signatureHelp.getSignatures().getFirst().getParameters().getFirst().getLabel().getLeft()); assertEquals("left: int", signatureHelp.getSignatures().getFirst().getParameters().getFirst().getLabel().getLeft());
assertEquals(1, signatureHelp.getActiveParameter()); assertEquals(1, signatureHelp.getActiveParameter());
} }
@Test
void definitionMapsPhysicalFileLocations() {
final var mapper = new Lsp4jProtocolMessageMapper();
final var locations = mapper.mapDefinition(new BaselineDefinition(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(2, locations.getFirst().getRange().getStart().getLine());
assertEquals(3, locations.getFirst().getRange().getStart().getCharacter());
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());
}
@Test
void documentSymbolsMapToHierarchicalDocumentSymbolTrees() {
final var mapper = new Lsp4jProtocolMessageMapper();
final var mapped = mapper.mapDocumentSymbols(new BaselineDocumentSymbols(List.of(
new BaselineDocumentSymbol(
"Mode",
BaselineDocumentSymbolKind.ENUM,
"",
0,
0,
0,
28,
0,
14,
0,
18,
List.of(new BaselineDocumentSymbol(
"Idle",
BaselineDocumentSymbolKind.ENUM,
"0",
0,
19,
0,
23,
0,
19,
0,
23,
List.of()))),
new BaselineDocumentSymbol(
"Point",
BaselineDocumentSymbolKind.STRUCT,
"",
1,
0,
4,
1,
1,
15,
1,
20,
List.of(new BaselineDocumentSymbol(
"x",
BaselineDocumentSymbolKind.FIELD,
"int",
1,
21,
1,
27,
1,
21,
1,
22,
List.of()))))));
assertEquals(2, mapped.size());
assertEquals("Mode", mapped.getFirst().getName());
assertEquals(SymbolKind.Enum, mapped.getFirst().getKind());
assertEquals("Idle", mapped.getFirst().getChildren().getFirst().getName());
assertEquals(SymbolKind.EnumMember, mapped.getFirst().getChildren().getFirst().getKind());
assertEquals("Point", mapped.get(1).getName());
assertEquals(SymbolKind.Struct, mapped.get(1).getKind());
assertEquals("x", mapped.get(1).getChildren().getFirst().getName());
assertEquals(SymbolKind.Field, mapped.get(1).getChildren().getFirst().getKind());
assertTrue(mapper.mapDocumentSymbols(BaselineDocumentSymbols.empty()).isEmpty());
}
@Test
void workspaceSymbolsMapToFlatSymbolInformation() {
final var mapper = new Lsp4jProtocolMessageMapper();
final var mapped = mapper.mapWorkspaceSymbols(new p.studio.lsp.messages.BaselineWorkspaceSymbols(List.of(
new p.studio.lsp.messages.BaselineWorkspaceSymbol(
"blend",
BaselineDocumentSymbolKind.METHOD,
"(dx: int, dy: int) -> int",
"Vec",
"file:///tmp/demo.pbs",
3,
2,
3,
7),
new p.studio.lsp.messages.BaselineWorkspaceSymbol(
"Idle",
BaselineDocumentSymbolKind.ENUM,
"0",
"Mode",
"file:///tmp/demo.pbs",
0,
19,
0,
23))));
assertEquals(2, mapped.size());
assertEquals("blend", mapped.getFirst().getName());
assertEquals("Vec", mapped.getFirst().getContainerName());
assertEquals(SymbolKind.Method, mapped.getFirst().getKind());
assertEquals("file:///tmp/demo.pbs", mapped.getFirst().getLocation().getUri());
assertEquals(2, mapped.getFirst().getLocation().getRange().getStart().getCharacter());
assertEquals("Idle", mapped.get(1).getName());
assertEquals(SymbolKind.EnumMember, mapped.get(1).getKind());
assertTrue(mapper.mapWorkspaceSymbols(p.studio.lsp.messages.BaselineWorkspaceSymbols.empty()).isEmpty());
}
} }