Compare commits
97
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
9458312d73
|
||
|
|
4b72b2a0dd | ||
|
|
c2112f6ee1
|
||
|
|
9896e7c657 | ||
|
|
4574aa17c3
|
||
|
|
bb010d565e | ||
|
|
e809ce63d3
|
||
|
|
59c0d0c3b4 | ||
|
|
79a682b8ec
|
||
|
|
d0b91f8526 | ||
|
|
2b881f5a76
|
||
|
|
4d8dcf28bb | ||
|
|
d7c2ec880f
|
||
|
|
c248b91147 | ||
|
|
46bd0c42d3
|
||
|
|
c6ef56114f | ||
|
|
701f5b0339
|
||
|
|
cc4cb23b76
|
||
|
|
f42c83bdca
|
||
|
|
cf14039077
|
||
|
|
1f1a92d43f
|
||
|
|
38790c0b45
|
||
|
|
5f6bd408a4
|
||
|
|
a77dce1c56 | ||
|
|
b9a32e460a
|
||
|
|
e8079b67fb
|
||
|
|
bde999f1fe
|
||
|
|
26c69d5660
|
||
|
|
ffd2975484 | ||
|
|
a62ddb0f74
|
||
|
|
79e4a64ff2
|
||
|
|
3ca58dcc24
|
||
|
|
bb8669bf46
|
||
|
|
6205b82e0b
|
||
|
|
088101449a
|
||
|
|
b1e75973f9
|
||
|
|
3ee0da3c0a
|
||
|
|
29f46c6606 | ||
|
|
30e3e4145a
|
||
|
|
4233b90b82
|
||
|
|
da00e9c50c
|
||
|
|
fee89d7522
|
||
|
|
bc95b33bd9
|
||
|
|
6cd24bf14f
|
||
|
|
b86cf0117d | ||
|
|
6fdb4828c3
|
||
|
|
44f03f771b
|
||
|
|
ba3af3c01b
|
||
|
|
66c1b1a033
|
||
|
|
f8b9c5b27d
|
||
|
|
e99bb58453
|
||
|
|
db0b71c9ad
|
||
|
|
35b65bb524
|
||
|
|
6e594c15d7
|
||
|
|
d58a96a4c4 | ||
|
|
725c28b3f5
|
||
|
|
d8db99eb81
|
||
|
|
63215ac02f
|
||
|
|
e7647165bc
|
||
|
|
f32a25eb59
|
||
|
|
d680504c31
|
||
|
|
aeea8ca900
|
||
|
|
05dd37a30a
|
||
|
|
f700e400d5
|
||
|
|
2b25364252
|
||
|
|
917b0e1b9a
|
||
|
|
ad2ae00f39
|
||
|
|
fa089c5cd0 | ||
|
|
ae1ba0d2d3
|
||
|
|
ffa41db994
|
||
|
|
13425cee03
|
||
|
|
fae4e9a9fd
|
||
|
|
340442d374
|
||
|
|
013ca4355c
|
||
|
|
3f99e90ac8
|
||
|
|
81437b1fc3 | ||
|
|
cc82e5a59c
|
||
|
|
5dc876c923
|
||
|
|
06f92f808d
|
||
|
|
e32c31a9d3
|
||
|
|
4bf51998dc
|
||
|
|
cfb842c56f
|
||
|
|
e17344af63
|
||
|
|
0be02622c4
|
||
|
|
ad2bfeb66f
|
||
|
|
e044fc15fc
|
||
|
|
8a854dc2ee
|
||
|
|
ff26bb3d4b | ||
|
|
991863d086
|
||
|
|
22887b56cd | ||
|
|
0342df1d4e
|
||
|
|
db8c5147db
|
||
|
|
eab763fd21
|
||
|
|
4e00584af7
|
||
|
|
1ed7a8e193
|
||
|
|
a5c219024e
|
||
|
|
5cde30f502
|
@@ -10,6 +10,11 @@ build
|
||||
# Ignore Kotlin plugin data
|
||||
.kotlin
|
||||
|
||||
.python-version
|
||||
.venv
|
||||
|
||||
# IA
|
||||
.junie
|
||||
/debug/
|
||||
!prometeu-studio/src/main/java/p/studio/workspaces/debug/
|
||||
!prometeu-studio/src/main/java/p/studio/workspaces/debug/**
|
||||
|
||||
@@ -76,22 +76,4 @@ Important reference surfaces:
|
||||
- `docs/specs/packer/`: packer specifications
|
||||
- `docs/vm-arch/`: VM and ISA architecture references
|
||||
|
||||
These documents are the long-term normative source for behavior and contracts. When code and docs diverge, fix the divergence explicitly instead of relying on tribal knowledge.
|
||||
|
||||
## Discussion Workflow
|
||||
|
||||
This repository uses a disciplined discussion workflow under `discussion/`:
|
||||
|
||||
- `discussion/workflow/agendas/`
|
||||
- `discussion/workflow/decisions/`
|
||||
- `discussion/workflow/plans/`
|
||||
- `discussion/lessons/`
|
||||
- `discussion/index.ndjson`
|
||||
|
||||
The expected execution flow is:
|
||||
|
||||
```text
|
||||
agenda -> decision -> plan -> implement -> lesson
|
||||
```
|
||||
|
||||
Do not create new workflow artifacts in legacy `docs/**/agendas`, `docs/**/decisions`, `docs/**/pull-requests`, or `docs/**/learn` paths.
|
||||
These documents are the long-term normative source for behavior and contracts. When code and docs diverge, fix the divergence explicitly instead of relying on tribal knowledge.
|
||||
+33
-4
@@ -1,6 +1,35 @@
|
||||
{"type":"meta","next_id":{"DSC":37,"AGD":40,"DEC":36,"PLN":78,"LSN":51,"CLSN":1}}
|
||||
{"type":"discussion","id":"DSC-0036","status":"open","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-05-08","tags":["compiler","compiler-pbs","studio","lsp","vscode","editor","hover","documentation","markdown"],"agendas":[{"id":"AGD-0039","file":"AGD-0039-pbs-symbol-documentation-and-hover-markdown.md","status":"open","created_at":"2026-05-08","updated_at":"2026-05-08"}],"decisions":[],"plans":[],"lessons":[]}
|
||||
{"type":"discussion","id":"DSC-0035","status":"in_progress","ticket":"pbs-lsp-editor-assistance-wave-1","title":"Wave 1 de assistencia editorial via LSP para PBS no VS Code","created_at":"2026-05-08","updated_at":"2026-05-08","tags":["studio","lsp","vscode","compiler","compiler-pbs","editor","completion","hover","signature-help"],"agendas":[{"id":"AGD-0038","file":"AGD-0038-pbs-lsp-editor-assistance-wave-1.md","status":"accepted","created_at":"2026-05-08","updated_at":"2026-05-08"}],"decisions":[{"id":"DEC-0035","file":"DEC-0035-pbs-lsp-editor-assistance-wave-1.md","status":"accepted","created_at":"2026-05-08","updated_at":"2026-05-08","ref_agenda":"AGD-0038"}],"plans":[{"id":"PLN-0075","file":"PLN-0075-pbs-editorial-resolution-surface-for-symbols-members-and-signatures.md","status":"open","created_at":"2026-05-08","updated_at":"2026-05-08","ref_decisions":["DEC-0035"]},{"id":"PLN-0076","file":"PLN-0076-lsp-completion-hover-and-signature-help-over-editorial-resolution.md","status":"open","created_at":"2026-05-08","updated_at":"2026-05-08","ref_decisions":["DEC-0035"]},{"id":"PLN-0077","file":"PLN-0077-vscode-consumption-and-wave-1-editor-assistance-validation.md","status":"open","created_at":"2026-05-08","updated_at":"2026-05-08","ref_decisions":["DEC-0035"]}],"lessons":[]}
|
||||
{"type":"meta","next_id":{"DSC":66,"AGD":69,"DEC":54,"PLN":133,"LSN":70,"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-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-0062","status":"done","ticket":"multi-frontend-pvm-neutrality","title":"Neutralidade da PVM e identificacao PBX independente de PBS","created_at":"2026-07-15","updated_at":"2026-09-18","tags":["vm-arch","runtime","pvm","pbx","compiler","multi-frontend"],"agendas":[],"decisions":[],"plans":[],"lessons":[{"id":"LSN-0061","file":"discussion/lessons/DSC-0062-multi-frontend-pvm-neutrality/LSN-0061-pbx-runtime-boundary.md","status":"done","created_at":"2026-09-18","updated_at":"2026-09-18"}]}
|
||||
{"type":"discussion","id":"DSC-0061","status":"done","ticket":"multi-frontend-sdk-canonical-definition","title":"Auditoria e centralizacao gradual da definicao canonica do SDK","created_at":"2026-07-15","updated_at":"2026-09-19","tags":["compiler","compiler-general","sdk","stdlib","hostcalls","intrinsics","multi-frontend"],"agendas":[],"decisions":[],"plans":[],"lessons":[{"id":"LSN-0064","file":"discussion/lessons/DSC-0061-multi-frontend-sdk-canonical-definition/LSN-0064-runtime-owns-console-abi-pbs-is-delivery.md","status":"done","created_at":"2026-09-19","updated_at":"2026-09-19"}]}
|
||||
{"type":"discussion","id":"DSC-0060","status":"done","ticket":"multi-frontend-validation-boundaries","title":"Separar validacoes de linguagem e validacoes de plataforma","created_at":"2026-07-15","updated_at":"2026-09-19","tags":["compiler","compiler-general","compiler-pbs","backend","validation","multi-frontend"],"agendas":[],"decisions":[],"plans":[],"lessons":[{"id":"LSN-0063","file":"discussion/lessons/DSC-0060-multi-frontend-validation-boundaries/LSN-0063-language-vs-platform-validation-ownership.md","status":"done","created_at":"2026-09-19","updated_at":"2026-09-19"}]}
|
||||
{"type":"discussion","id":"DSC-0059","status":"done","ticket":"multi-frontend-common-lifecycle","title":"Extrair lifecycle comum das responsabilidades do frontend PBS","created_at":"2026-07-15","updated_at":"2026-09-19","tags":["compiler","compiler-general","compiler-pbs","lifecycle","backend","multi-frontend"],"agendas":[],"decisions":[],"plans":[],"lessons":[{"id":"LSN-0062","file":"discussion/lessons/DSC-0059-multi-frontend-common-lifecycle/LSN-0062-common-lifecycle-assembly-stage.md","status":"done","created_at":"2026-09-19","updated_at":"2026-09-19"}]}
|
||||
{"type":"discussion","id":"DSC-0058","status":"done","ticket":"multi-frontend-serializable-ir","title":"Manter a IR comum serializavel por design","created_at":"2026-07-15","updated_at":"2026-07-15","tags":["compiler","compiler-general","ir","backend","serialization","multi-frontend"],"agendas":[],"decisions":[],"plans":[],"lessons":[{"id":"LSN-0060","file":"discussion/lessons/DSC-0058-multi-frontend-serializable-ir/LSN-0060-data-contract-first-for-serializable-irbackend.md","status":"done","created_at":"2026-07-15","updated_at":"2026-07-15"}]}
|
||||
{"type":"discussion","id":"DSC-0057","status":"done","ticket":"multi-frontend-frontend-backend-contract","title":"Estabilizar contrato entre frontend e backend comum","created_at":"2026-07-15","updated_at":"2026-07-15","tags":["compiler","compiler-general","compiler-pbs","ir","backend","multi-frontend"],"agendas":[],"decisions":[],"plans":[],"lessons":[{"id":"LSN-0059","file":"discussion/lessons/DSC-0057-multi-frontend-frontend-backend-contract/LSN-0059-common-irbackend-handoff-and-backend-guardrails.md","status":"done","created_at":"2026-07-15","updated_at":"2026-07-15"}]}
|
||||
{"type":"discussion","id":"DSC-0056","status":"done","ticket":"multi-frontend-remove-pbs-branches","title":"Generalizar o contrato LSP/editorial para frontends","created_at":"2026-07-15","updated_at":"2026-07-15","tags":["compiler","compiler-general","compiler-pbs","studio","frontend","coupling","multi-frontend"],"agendas":[],"decisions":[],"plans":[],"lessons":[{"id":"LSN-0058","file":"discussion/lessons/DSC-0056-multi-frontend-remove-pbs-branches/LSN-0058-generic-frontend-editorial-contract-for-lsp.md","status":"done","created_at":"2026-07-15","updated_at":"2026-07-15"}]}
|
||||
{"type":"discussion","id":"DSC-0055","status":"done","ticket":"multi-frontend-compiler-vs-language-services","title":"Separar compilacao de servicos editoriais de frontend","created_at":"2026-07-15","updated_at":"2026-07-15","tags":["compiler","compiler-general","studio","lsp","editor","frontend","multi-frontend"],"agendas":[],"decisions":[],"plans":[],"lessons":[{"id":"LSN-0056","file":"discussion/lessons/DSC-0055-multi-frontend-compiler-vs-language-services/LSN-0056-compile-first-frontends-with-optional-editorial-capabilities.md","status":"done","created_at":"2026-07-15","updated_at":"2026-07-15"}]}
|
||||
{"type":"discussion","id":"DSC-0054","status":"done","ticket":"multi-frontend-provider-contract","title":"Introduzir provider completo de frontend","created_at":"2026-07-15","updated_at":"2026-07-15","tags":["compiler","compiler-general","studio","frontend","registry","multi-frontend"],"agendas":[],"decisions":[],"plans":[],"lessons":[{"id":"LSN-0055","file":"discussion/lessons/DSC-0054-multi-frontend-provider-contract/LSN-0055-static-frontend-providers-before-plugin-architecture.md","status":"done","created_at":"2026-07-15","updated_at":"2026-07-15"}]}
|
||||
{"type":"discussion","id":"DSC-0053","status":"open","ticket":"pbs-lsp-call-and-type-hierarchy","title":"PBS LSP Call and Type Hierarchy","created_at":"2026-07-15","updated_at":"2026-07-15","tags":["studio","lsp","vscode","compiler-pbs","editor","call-hierarchy","type-hierarchy"],"agendas":[{"id":"AGD-0056","file":"AGD-0056-pbs-lsp-call-and-type-hierarchy.md","status":"open","created_at":"2026-07-15","updated_at":"2026-07-15"}],"decisions":[],"plans":[],"lessons":[]}
|
||||
{"type":"discussion","id":"DSC-0052","status":"open","ticket":"pbs-lsp-document-links","title":"PBS LSP Document Links","created_at":"2026-07-15","updated_at":"2026-07-15","tags":["studio","lsp","vscode","compiler-pbs","editor","document-links","imports"],"agendas":[{"id":"AGD-0055","file":"AGD-0055-pbs-lsp-document-links.md","status":"open","created_at":"2026-07-15","updated_at":"2026-07-15"}],"decisions":[],"plans":[],"lessons":[]}
|
||||
{"type":"discussion","id":"DSC-0051","status":"open","ticket":"pbs-lsp-diagnostics-ux","title":"PBS LSP Diagnostics UX","created_at":"2026-07-15","updated_at":"2026-07-15","tags":["studio","lsp","vscode","compiler-pbs","editor","diagnostics","ux"],"agendas":[{"id":"AGD-0054","file":"AGD-0054-pbs-lsp-diagnostics-ux.md","status":"open","created_at":"2026-07-15","updated_at":"2026-07-15"}],"decisions":[],"plans":[],"lessons":[]}
|
||||
{"type":"discussion","id":"DSC-0050","status":"open","ticket":"pbs-lsp-folding-and-selection-ranges","title":"PBS LSP Folding and Selection Ranges","created_at":"2026-07-15","updated_at":"2026-07-15","tags":["studio","lsp","vscode","compiler-pbs","editor","folding","selection-range"],"agendas":[{"id":"AGD-0053","file":"AGD-0053-pbs-lsp-folding-and-selection-ranges.md","status":"open","created_at":"2026-07-15","updated_at":"2026-07-15"}],"decisions":[],"plans":[],"lessons":[]}
|
||||
{"type":"discussion","id":"DSC-0049","status":"open","ticket":"pbs-lsp-completion-depth","title":"PBS LSP Completion Depth","created_at":"2026-07-15","updated_at":"2026-07-15","tags":["studio","lsp","vscode","compiler-pbs","editor","completion"],"agendas":[{"id":"AGD-0052","file":"AGD-0052-pbs-lsp-completion-depth.md","status":"open","created_at":"2026-07-15","updated_at":"2026-07-15"}],"decisions":[],"plans":[],"lessons":[]}
|
||||
{"type":"discussion","id":"DSC-0048","status":"open","ticket":"pbs-lsp-performance-cache-and-snapshots","title":"PBS LSP Performance Cache and Snapshots","created_at":"2026-07-15","updated_at":"2026-07-15","tags":["studio","lsp","vscode","compiler-pbs","editor","performance","caching"],"agendas":[{"id":"AGD-0051","file":"AGD-0051-pbs-lsp-performance-cache-and-snapshots.md","status":"open","created_at":"2026-07-15","updated_at":"2026-07-15"}],"decisions":[],"plans":[],"lessons":[]}
|
||||
{"type":"discussion","id":"DSC-0047","status":"open","ticket":"pbs-lsp-semantic-tokens-semantic-classification","title":"PBS LSP Semantic Token Classification","created_at":"2026-07-15","updated_at":"2026-07-15","tags":["studio","lsp","vscode","compiler-pbs","editor","semantic-tokens"],"agendas":[{"id":"AGD-0050","file":"AGD-0050-pbs-lsp-semantic-token-classification.md","status":"open","created_at":"2026-07-15","updated_at":"2026-07-15"}],"decisions":[],"plans":[],"lessons":[]}
|
||||
{"type":"discussion","id":"DSC-0046","status":"open","ticket":"pbs-lsp-import-assistance","title":"PBS LSP Import Assistance","created_at":"2026-07-15","updated_at":"2026-07-15","tags":["studio","lsp","vscode","compiler-pbs","editor","imports","completion"],"agendas":[{"id":"AGD-0049","file":"AGD-0049-pbs-lsp-import-assistance.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-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-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-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":"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-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-0035","status":"done","ticket":"pbs-lsp-editor-assistance-wave-1","title":"Wave 1 de assistencia editorial via LSP para PBS no VS Code","created_at":"2026-05-08","updated_at":"2026-05-08","tags":["studio","lsp","vscode","compiler","compiler-pbs","editor","completion","hover","signature-help"],"agendas":[],"decisions":[],"plans":[],"lessons":[{"id":"LSN-0051","file":"discussion/lessons/DSC-0035-pbs-lsp-editor-assistance-wave-1/LSN-0051-compiler-backed-editor-assistance-for-pbs.md","status":"done","created_at":"2026-05-08","updated_at":"2026-05-08"}]}
|
||||
{"type":"discussion","id":"DSC-0034","status":"done","ticket":"frontend-semantic-host-projection-flexibility","title":"Frontend semantic vocabulary flexibility and declarative host projection","created_at":"2026-05-06","updated_at":"2026-05-07","tags":["compiler","compiler-general","frontend","semantics","vscode","host-projection","lsp"],"agendas":[],"decisions":[],"plans":[],"lessons":[{"id":"LSN-0048","file":"discussion/lessons/DSC-0034-frontend-semantic-host-projection-flexibility/LSN-0048-frontend-owned-semantic-vocabularies-with-declarative-host-projection.md","status":"done","created_at":"2026-05-07","updated_at":"2026-05-07"}]}
|
||||
{"type":"discussion","id":"DSC-0033","status":"done","ticket":"frontend-visual-theme-spec-and-css-retirement","title":"Frontend visual theme spec and retirement of host-consumed semantic CSS","created_at":"2026-05-06","updated_at":"2026-05-08","tags":["compiler","compiler-general","frontend","presentation","theming","studio","vscode","lsp","pbs"],"agendas":[],"decisions":[],"plans":[],"lessons":[{"id":"LSN-0050","file":"discussion/lessons/DSC-0033-frontend-visual-theme-spec-and-css-retirement/LSN-0050-frontend-owned-visual-themes-with-structured-contract-and-host-adapters.md","status":"done","created_at":"2026-05-08","updated_at":"2026-05-08"}]}
|
||||
{"type":"discussion","id":"DSC-0032","status":"done","ticket":"studio-new-lsp-api-and-v1-boundary","title":"Novo boundary entre lsp-api, lsp-v1 e a extensao VS Code","created_at":"2026-05-05","updated_at":"2026-05-07","tags":["studio","lsp","vscode","protocol","api","boundary"],"agendas":[],"decisions":[],"plans":[],"lessons":[{"id":"LSN-0047","file":"discussion/lessons/DSC-0032-studio-new-lsp-api-and-v1-boundary/LSN-0047-project-scoped-lsp-boundary-and-protocol-containment.md","status":"done","created_at":"2026-05-07","updated_at":"2026-05-07"}]}
|
||||
@@ -16,7 +45,7 @@
|
||||
{"type":"discussion","id":"DSC-0002","status":"done","ticket":"palette-management-in-studio","title":"Palette Management in Studio","created_at":"2026-03-26","updated_at":"2026-04-23","tags":["studio","legacy-import","palette-management","tile-bank","packer-boundary"],"agendas":[],"decisions":[],"plans":[],"lessons":[{"id":"LSN-0042","file":"discussion/lessons/DSC-0002-palette-management-in-studio/LSN-0042-schema-driven-palette-authoring-and-local-metadata-events.md","status":"done","created_at":"2026-04-23","updated_at":"2026-04-23"}]}
|
||||
{"type":"discussion","id":"DSC-0003","status":"done","ticket":"packer-docs-import","title":"Import docs/packer into discussion-framework artifacts","created_at":"2026-03-26","updated_at":"2026-03-26","tags":["packer","migration","discussion-framework","docs-import"],"agendas":[],"decisions":[],"plans":[],"lessons":[{"id":"LSN-0009","file":"discussion/lessons/DSC-0003-packer-docs-import/LSN-0009-mental-model-packer-legacy.md","status":"done","created_at":"2026-03-26","updated_at":"2026-03-26"},{"id":"LSN-0010","file":"discussion/lessons/DSC-0003-packer-docs-import/LSN-0010-asset-identity-and-runtime-contract-legacy.md","status":"done","created_at":"2026-03-26","updated_at":"2026-03-26"},{"id":"LSN-0011","file":"discussion/lessons/DSC-0003-packer-docs-import/LSN-0011-foundations-workspace-runtime-and-build-legacy.md","status":"done","created_at":"2026-03-26","updated_at":"2026-03-26"},{"id":"LSN-0012","file":"discussion/lessons/DSC-0003-packer-docs-import/LSN-0012-runtime-ownership-and-studio-boundary-legacy.md","status":"done","created_at":"2026-03-26","updated_at":"2026-03-26"},{"id":"LSN-0013","file":"discussion/lessons/DSC-0003-packer-docs-import/LSN-0013-metadata-convergence-and-runtime-sink-legacy.md","status":"done","created_at":"2026-03-26","updated_at":"2026-03-26"},{"id":"LSN-0014","file":"discussion/lessons/DSC-0003-packer-docs-import/LSN-0014-pack-wizard-summary-validation-and-pack-execution-legacy.md","status":"done","created_at":"2026-03-26","updated_at":"2026-03-26"},{"id":"LSN-0015","file":"discussion/lessons/DSC-0003-packer-docs-import/LSN-0015-tile-bank-packing-contract-legacy.md","status":"done","created_at":"2026-03-26","updated_at":"2026-03-26"},{"id":"LSN-0017","file":"discussion/lessons/DSC-0003-packer-docs-import/LSN-0017-packer-docs-import-pattern.md","status":"done","created_at":"2026-03-26","updated_at":"2026-03-26"}]}
|
||||
{"type":"discussion","id":"DSC-0004","status":"abandoned","ticket":"tilemap-and-metatile-runtime-binary-layout","title":"Tilemap and Metatile Runtime Binary Layout","created_at":"2026-03-26","updated_at":"2026-04-24","tags":["packer","legacy-import","tilemap","metatile","runtime-layout"],"agendas":[{"id":"AGD-0004","file":"AGD-0004-tilemap-and-metatile-runtime-binary-layout.md","status":"abandoned","created_at":"2026-03-26","updated_at":"2026-04-24","_override_reason":"Explicit user request on 2026-04-24 to abandon AGD-0004 because the agenda is no longer valid."}],"decisions":[],"plans":[],"lessons":[]}
|
||||
{"type":"discussion","id":"DSC-0005","status":"open","ticket":"variable-tile-bank-palette-serialization","title":"Variable Tile Bank Palette Serialization","created_at":"2026-03-26","updated_at":"2026-03-26","tags":["packer","legacy-import","tile-bank","palette-serialization","versioning"],"agendas":[{"id":"AGD-0005","file":"AGD-0005-variable-tile-bank-palette-serialization.md","status":"open","created_at":"2026-03-26","updated_at":"2026-03-26"}],"decisions":[],"plans":[],"lessons":[]}
|
||||
{"type":"discussion","id":"DSC-0005","status":"done","ticket":"variable-tile-bank-palette-serialization","title":"Variable Glyph Bank Palette Serialization","created_at":"2026-03-26","updated_at":"2026-07-14","tags":["packer","legacy-import","glyph-bank","palette-serialization","rgba8888","runtime-alignment"],"agendas":[],"decisions":[],"plans":[],"lessons":[{"id":"LSN-0054","file":"discussion/lessons/DSC-0005-variable-glyph-bank-palette-serialization/LSN-0054-runtime-owned-variable-glyph-palette-counts.md","status":"done","created_at":"2026-07-14","updated_at":"2026-07-14"}]}
|
||||
{"type":"discussion","id":"DSC-0006","status":"done","ticket":"pbs-game-facing-asset-refs-and-call-result-discard","title":"PBS Game-Facing Asset References and Ignored Call Result Lowering","created_at":"2026-03-27","updated_at":"2026-03-30","tags":["compiler","pbs","ergonomics","lowering","runtime","asset-identity","expression-statements"],"agendas":[],"decisions":[],"plans":[],"lessons":[{"id":"LSN-0024","file":"discussion/lessons/DSC-0006-pbs-game-facing-asset-refs-and-call-result-discard/LSN-0024-addressable-surface-host-metadata-and-ignored-value-discipline.md","status":"done","created_at":"2026-03-30","updated_at":"2026-03-30"}]}
|
||||
{"type":"discussion","id":"DSC-0007","status":"done","ticket":"pbs-learn-to-discussion-lessons-migration","title":"Migrate PBS Learn Documents into Discussion Lessons","created_at":"2026-03-27","updated_at":"2026-03-27","tags":["compiler","pbs","migration","discussion-framework","lessons","learn-prune"],"agendas":[],"decisions":[],"plans":[],"lessons":[{"id":"LSN-0018","file":"discussion/lessons/DSC-0007-pbs-learn-to-discussion-lessons-migration/LSN-0018-pbs-ast-and-parser-contract-legacy.md","status":"done","created_at":"2026-03-27","updated_at":"2026-03-27"},{"id":"LSN-0019","file":"discussion/lessons/DSC-0007-pbs-learn-to-discussion-lessons-migration/LSN-0019-pbs-name-resolution-and-linking-legacy.md","status":"done","created_at":"2026-03-27","updated_at":"2026-03-27"},{"id":"LSN-0020","file":"discussion/lessons/DSC-0007-pbs-learn-to-discussion-lessons-migration/LSN-0020-pbs-runtime-values-identity-memory-boundaries-legacy.md","status":"done","created_at":"2026-03-27","updated_at":"2026-03-27"},{"id":"LSN-0021","file":"discussion/lessons/DSC-0007-pbs-learn-to-discussion-lessons-migration/LSN-0021-pbs-diagnostics-and-conformance-governance-legacy.md","status":"done","created_at":"2026-03-27","updated_at":"2026-03-27"},{"id":"LSN-0022","file":"discussion/lessons/DSC-0007-pbs-learn-to-discussion-lessons-migration/LSN-0022-pbs-globals-lifecycle-and-published-entrypoint-legacy.md","status":"done","created_at":"2026-03-27","updated_at":"2026-03-27"}]}
|
||||
{"type":"discussion","id":"DSC-0008","status":"done","ticket":"pbs-low-level-asset-manager-surface","title":"PBS Low-Level Asset Manager Surface for Runtime AssetManager","created_at":"2026-03-27","updated_at":"2026-03-27","tags":["compiler","pbs","runtime","asset-manager","host-abi","stdlib","asset"],"agendas":[],"decisions":[],"plans":[],"lessons":[{"id":"LSN-0023","file":"discussion/lessons/DSC-0008-pbs-low-level-asset-manager-surface/LSN-0023-lowassets-runtime-aligned-sdk-surface.md","status":"done","created_at":"2026-03-27","updated_at":"2026-03-27"}]}
|
||||
|
||||
+126
@@ -0,0 +1,126 @@
|
||||
---
|
||||
id: LSN-0054
|
||||
ticket: variable-tile-bank-palette-serialization
|
||||
title: Runtime-Owned Variable Glyph Palette Counts
|
||||
created: 2026-07-14
|
||||
tags:
|
||||
- packer
|
||||
- studio
|
||||
- glyph-bank
|
||||
- palette-serialization
|
||||
- rgba8888
|
||||
- runtime-alignment
|
||||
---
|
||||
|
||||
# Runtime-Owned Variable Glyph Palette Counts
|
||||
|
||||
### Original Problem
|
||||
|
||||
The first RGBA8888 alignment wave made Studio and packer emit palette colors in
|
||||
the runtime channel order, but it deliberately kept the old fixed glyph-bank
|
||||
palette payload shape. Every `GLYPH/indexed_v1` payload still reserved room for
|
||||
64 palettes, so the emitted palette block was always `64 * 16 * 4 = 4096`
|
||||
bytes even when the bank used one or a few palettes.
|
||||
|
||||
That fixed shape left two problems:
|
||||
|
||||
- packer output was larger than the runtime needed;
|
||||
- `palette_count` could not be trusted as the effective runtime resident count,
|
||||
because the payload still looked like a 64-palette bank.
|
||||
|
||||
Runtime later accepted the variable-palette protocol for
|
||||
`GLYPH/indexed_v1`. Studio and packer had to follow that runtime-owned wire
|
||||
contract instead of keeping a stale producer-side convention.
|
||||
|
||||
### Consolidated Decision
|
||||
|
||||
Runtime owns the `GLYPH/indexed_v1` protocol. Studio and packer are downstream
|
||||
producers of runtime-conforming `assets.pa` payloads.
|
||||
|
||||
The accepted rule is:
|
||||
|
||||
1. `palette_count` is the effective serialized and resident palette count.
|
||||
2. `palette_count` must be in the inclusive range `1..=64`.
|
||||
3. Palette bytes are exactly `palette_count * 16 * 4`.
|
||||
4. `size = ceil(width * height / 2) + palette_count * 16 * 4`.
|
||||
5. `decoded_size = width * height + palette_count * 16 * 4`.
|
||||
6. Palette bytes remain RGBA8888 in `R`, `G`, `B`, `A` order.
|
||||
7. `GLYPH/indexed_v1` remains the format name. This change does not introduce
|
||||
`GLYPH/indexed_v2`.
|
||||
8. There is no compatibility mode for the old fixed 64-palette padding.
|
||||
9. Palette IDs remain direct. There is no sparse-to-dense remapping metadata in
|
||||
v1.
|
||||
10. `palette_authored`, when present, is informative tooling metadata only.
|
||||
|
||||
### Implementation Result
|
||||
|
||||
The packer specs now define `palette_count` as runtime-effective metadata for
|
||||
glyph banks and describe the variable palette payload in the build-artifact
|
||||
contract. Studio-facing asset workspace docs now keep `palette_count` distinct
|
||||
from any authored or tooling-only palette count.
|
||||
|
||||
The packer metadata model derives and validates effective palette count instead
|
||||
of hard-coding `64`. Sparse direct palette IDs are preserved by materializing
|
||||
intermediate palette slots up to the highest referenced ID; those slots are not
|
||||
a remapping table.
|
||||
|
||||
Payload emission now writes exactly the effective number of palette slots. Size
|
||||
and decoded-size accounting use the same formula as the runtime contract, so
|
||||
metadata, asset-table entries, and payload lengths agree.
|
||||
|
||||
Tests and fixtures cover `palette_count = 1`, intermediate counts, `64`, sparse
|
||||
direct identity, invalid counts above `64`, RGBA8888 byte order, and payload
|
||||
size accounting. Final validation passed with:
|
||||
|
||||
- `discussion validate`;
|
||||
- `./gradlew :prometeu-packer:prometeu-packer-v1:test`;
|
||||
- `./gradlew build`.
|
||||
|
||||
### Practical Examples
|
||||
|
||||
A 256 by 256 glyph bank with one palette has:
|
||||
|
||||
```text
|
||||
pixel bytes = ceil(256 * 256 / 2) = 32768
|
||||
palette bytes = 1 * 16 * 4 = 64
|
||||
size = 32768 + 64 = 32832
|
||||
decoded_size = 256 * 256 + 64 = 65600
|
||||
```
|
||||
|
||||
A bank that references palette ID `6` has an effective `palette_count` of at
|
||||
least `7`. Palette slots `0` through `6` exist in the serialized palette block.
|
||||
If some lower slots were not authored directly, they are deterministic
|
||||
placeholders; palette `6` is not remapped to palette `0`.
|
||||
|
||||
### Common Pitfalls and Anti-patterns
|
||||
|
||||
- Do not infer runtime payload length from the maximum allowed palette count.
|
||||
`64` is the upper bound, not the default emitted count.
|
||||
- Do not use `palette_authored` as a runtime-effective field. It may describe a
|
||||
tool view, but runtime loads `palette_count`.
|
||||
- Do not preserve fixed 4096-byte palette padding for banks with fewer than 64
|
||||
effective palettes.
|
||||
- Do not create `GLYPH/indexed_v2` to carry this change. The accepted runtime
|
||||
protocol keeps the v1 format name.
|
||||
- Do not introduce sparse-to-dense palette remapping metadata. Existing scene,
|
||||
sprite, packer, and runtime references use direct palette identity.
|
||||
- Do not combine RGBA8888 channel-order work with palette-count semantics.
|
||||
RGBA8888 defines each color value; `palette_count` defines how many palettes
|
||||
are serialized and resident.
|
||||
|
||||
### References
|
||||
|
||||
- Runtime decision:
|
||||
`../runtime/discussion/workflow/decisions/DEC-0041-variable-glyph-bank-palette-protocol.md`.
|
||||
- Studio/packer decision:
|
||||
`discussion/workflow/decisions/DEC-0038-variable-glyph-bank-palette-serialization.md`.
|
||||
- `PLN-0087`: Variable glyph palette spec propagation.
|
||||
- `PLN-0088`: Variable glyph palette metadata and count model.
|
||||
- `PLN-0089`: Variable glyph palette payload emission and size accounting.
|
||||
- `PLN-0090`: Studio and packer projections for variable glyph palettes.
|
||||
- `PLN-0091`: Variable glyph palette tests, fixtures, and final validation.
|
||||
- Prior lesson:
|
||||
`discussion/lessons/DSC-0038-studio-packer-rgba8888-asset-pipeline/LSN-0053-rgba8888-is-the-canonical-studio-packer-palette-contract.md`.
|
||||
- `docs/specs/packer/3. Asset Declaration and Virtual Asset Contract Specification.md`.
|
||||
- `docs/specs/packer/4. Build Artifacts and Deterministic Packing Specification.md`.
|
||||
- `docs/specs/studio/4. Assets Workspace Specification.md`.
|
||||
+78
@@ -0,0 +1,78 @@
|
||||
---
|
||||
id: LSN-0051
|
||||
ticket: pbs-lsp-editor-assistance-wave-1
|
||||
title: Compiler-Backed Editor Assistance for PBS
|
||||
created: 2026-05-08
|
||||
tags: [studio, lsp, vscode, compiler, compiler-pbs, editor, completion, hover, signature-help]
|
||||
---
|
||||
|
||||
## Original Problem
|
||||
|
||||
PBS editing in VS Code already had basic diagnostics and frontend-owned semantic highlighting, but it still lacked the minimum assistance expected during everyday code authoring:
|
||||
|
||||
1. no `completion`;
|
||||
2. placeholder-only `hover`;
|
||||
3. no `signature help`.
|
||||
|
||||
Without those features, the editor behaved more like a colored diagnostic viewer than a practical PBS authoring surface.
|
||||
|
||||
## Consolidated Decision
|
||||
|
||||
Wave 1 of PBS editor assistance is `completion`, symbol-resolved `hover`, and `signature help`.
|
||||
|
||||
These features must be built on one compiler-backed editorial resolution surface. The VS Code extension remains a thin LSP client, and the LSP layer projects compiler knowledge into protocol responses instead of inventing editor-local semantic tables.
|
||||
|
||||
The shared surface must be able to describe:
|
||||
|
||||
1. symbol identity and kind;
|
||||
2. module or origin when relevant;
|
||||
3. signature or shape when applicable;
|
||||
4. available members for recognized receivers;
|
||||
5. optional documentation when available.
|
||||
|
||||
The wave explicitly excludes formatter work, robust automatic indentation, `go to definition`, `references`, `rename`, quick fixes, broad code actions, and the PBS authored-documentation syntax.
|
||||
|
||||
## Final Implementation Shape
|
||||
|
||||
The work was decomposed into three execution fronts:
|
||||
|
||||
1. `compiler/pbs` owns the editorial resolution model for symbols, members, signatures, and optional documentation.
|
||||
2. `studio/lsp` exposes completion, hover, and signature-help request handling over that model and advertises the corresponding LSP capabilities.
|
||||
3. `tools/vscode-extension` consumes the LSP responses as a thin client and must not add hardcoded PBS semantic tables for members, stdlib, or signatures.
|
||||
|
||||
This split keeps semantic truth in the compiler, protocol ownership in the LSP server, and UI integration in the extension.
|
||||
|
||||
## Examples
|
||||
|
||||
Completion should cover at least:
|
||||
|
||||
1. language keywords;
|
||||
2. local names in scope;
|
||||
3. relevant imported or public symbols;
|
||||
4. members after `.` for recognized surfaces such as services, hosts, builtin types, structs, and related callable surfaces.
|
||||
|
||||
Hover should include, when available:
|
||||
|
||||
1. symbol kind;
|
||||
2. signature;
|
||||
3. module or origin;
|
||||
4. basic type or shape.
|
||||
|
||||
Signature help should cover function, method, and constructor calls with active signature and active parameter information.
|
||||
|
||||
## Pitfalls
|
||||
|
||||
Do not implement completion, hover, and signature help as three independent semantic paths. That duplicates parser, linking, stdlib, and member knowledge, then makes the editor inconsistent.
|
||||
|
||||
Do not patch around missing server behavior in the VS Code extension. Client-local tables for PBS members, stdlib, or signatures turn the extension into a second semantic engine.
|
||||
|
||||
Do not block this wave on authored PBS documentation syntax. The editorial model should have an optional documentation slot, but the language feature for authoring that documentation belongs to a separate discussion.
|
||||
|
||||
Do not broaden this wave into general IDE support. Definition, references, rename, formatter, quick fixes, and broad code actions are later work.
|
||||
|
||||
## References
|
||||
|
||||
- `DEC-0035` captured the normative decision for wave 1.
|
||||
- `PLN-0075` covered the compiler-side editorial resolution surface.
|
||||
- `PLN-0076` covered LSP projection and protocol capabilities.
|
||||
- `PLN-0077` covered VS Code thin-client consumption and validation.
|
||||
+104
@@ -0,0 +1,104 @@
|
||||
---
|
||||
id: LSN-0057
|
||||
ticket: pbs-symbol-documentation-and-hover-markdown
|
||||
title: Compiler-Owned PBS Doc Markdown for Editor Assistance
|
||||
created: 2026-07-15
|
||||
tags: [compiler, compiler-pbs, studio, lsp, vscode, editor, hover, documentation, markdown]
|
||||
---
|
||||
|
||||
## Original Problem
|
||||
|
||||
PBS editor assistance had compiler-backed completion, hover, and signature-help surfaces, but it did not yet have a canonical authored documentation model for named API symbols.
|
||||
|
||||
Without that model, hover could show mechanical facts such as kind, signature, origin, and type shape, but it could not reliably explain intent, parameter meaning, semantic constraints, or usage notes. Any editor-side solution would have risked reparsing PBS source or inventing a second documentation binding model outside the compiler.
|
||||
|
||||
## Consolidated Decision
|
||||
|
||||
PBS symbol documentation is authored with a reserved compiler-recognized `Doc` attribute:
|
||||
|
||||
```pbs
|
||||
[Doc(markdown = """
|
||||
Draws a sprite.
|
||||
|
||||
- `x`: screen x coordinate
|
||||
- `y`: screen y coordinate
|
||||
""")]
|
||||
```
|
||||
|
||||
The v1 shape is intentionally narrow:
|
||||
|
||||
1. `Doc` has exactly one required named argument, `markdown`.
|
||||
2. The `markdown` argument uses a triple-quoted documentation text block.
|
||||
3. The text block is documentation-only metadata, not a general runtime multiline string literal.
|
||||
4. `[Doc]` attaches to the following declaration using the normal PBS attribute association rule.
|
||||
5. Attribute order is semantically irrelevant.
|
||||
6. Parameters do not receive `[Doc]` in v1; parameter notes live inside the owning declaration's Markdown.
|
||||
7. Duplicate `Doc`, missing `markdown`, extra arguments, aliases, positional arguments, empty normalized payloads, and invalid targets are semantic errors.
|
||||
|
||||
The compiler owns documentation resolution. LSP and editor consumers receive normalized compiler metadata; they must not reparse PBS source to discover documentation.
|
||||
|
||||
## Final Implementation Shape
|
||||
|
||||
The work landed as a staged compiler-to-editor pipeline:
|
||||
|
||||
1. PBS specs define the syntax, static semantics, AST shape, diagnostics, and stdlib documentation policy for `[Doc(markdown = """...""")]`.
|
||||
2. The PBS lexer recognizes triple-quoted documentation text blocks without changing ordinary string literal behavior.
|
||||
3. The parser and AST preserve documentation text block payloads and spans as structured attribute values.
|
||||
4. A shared normalizer removes incidental surrounding blank lines and common indentation while preserving Markdown content and internal line breaks.
|
||||
5. Semantic validation reserves `Doc` and enforces the single canonical v1 shape.
|
||||
6. Normalized Markdown is attached to resolved PBS semantic symbols as structured documentation metadata.
|
||||
7. PBS editorial and LSP surfaces transport that metadata without source reparsing.
|
||||
8. Hover composition includes the normalized Markdown while preserving existing fallback behavior for undocumented symbols.
|
||||
9. Stdlib, SDK, and interface declarations use the same authored documentation surface.
|
||||
10. Runtime-facing artifacts remain unchanged by documentation metadata.
|
||||
|
||||
This preserves a clean boundary: PBS source authors write documentation in the language, the compiler resolves it, LSP transports it, and editors render it.
|
||||
|
||||
## Examples
|
||||
|
||||
Valid documentation belongs on named API declarations that introduce semantic symbols and can carry attributes, such as functions, methods, services, hosts, interface declarations, and repository-owned stdlib or SDK declarations.
|
||||
|
||||
Parameter documentation is written inside the callable's Markdown:
|
||||
|
||||
```pbs
|
||||
[Doc(markdown = """
|
||||
Fills a rectangle.
|
||||
|
||||
- `x`: left edge in screen coordinates
|
||||
- `y`: top edge in screen coordinates
|
||||
- `width`: rectangle width in pixels
|
||||
- `height`: rectangle height in pixels
|
||||
""")]
|
||||
```
|
||||
|
||||
Invalid v1 forms include:
|
||||
|
||||
```pbs
|
||||
[Doc("Draws a sprite.")]
|
||||
[Doc(text = """Draws a sprite.""")]
|
||||
[Doc(markdown = """Draws a sprite.""", format = "markdown")]
|
||||
[Documentation(markdown = """Draws a sprite.""")]
|
||||
```
|
||||
|
||||
These are rejected because accepting aliases or positional shortcuts would immediately expand the language contract and make future compatibility harder.
|
||||
|
||||
## Pitfalls
|
||||
|
||||
Do not treat `"""..."""` as a general PBS runtime string literal. Runtime multiline strings raise separate questions about type behavior, lowering, constant pools, equality, escaping, and artifact representation.
|
||||
|
||||
Do not let LSP or editor code rediscover documentation by scanning source. That duplicates language semantics outside the compiler and breaks as soon as imports, stdlib declarations, interface modules, or generated sources participate.
|
||||
|
||||
Do not attach `[Doc]` to parameters in v1. Parameter docs are authored inside the declaration Markdown so the compiler can keep one documentation payload per API symbol.
|
||||
|
||||
Do not reflow authored Markdown in a formatter or hover composer. The normalizer may remove incidental indentation, but it must preserve the author's Markdown content.
|
||||
|
||||
Do not lower documentation into runtime artifacts by default. Documentation is compile/editor metadata unless a future runtime or packaging decision explicitly changes that boundary.
|
||||
|
||||
## References
|
||||
|
||||
- `DEC-0039` captured the normative decision for PBS `Doc` markdown text blocks.
|
||||
- `PLN-0092` specified the PBS docs and diagnostics contract.
|
||||
- `PLN-0093` through `PLN-0099` implemented lexer, parser, normalization, semantics, symbol metadata, LSP exposure, and hover composition.
|
||||
- `PLN-0100` authored stdlib, SDK, and interface documentation.
|
||||
- `PLN-0101` protected runtime artifacts from documentation lowering.
|
||||
- `PLN-0102` closed end-to-end conformance coverage.
|
||||
+77
@@ -0,0 +1,77 @@
|
||||
---
|
||||
id: LSN-0052
|
||||
ticket: pbs-autocomplete-parameter-names
|
||||
title: Canonical callable parameter names through PBS editor assistance
|
||||
created: 2026-05-14
|
||||
tags: [compiler-pbs, studio, lsp, autocomplete, signature-help, stdlib]
|
||||
---
|
||||
|
||||
## Context
|
||||
|
||||
PBS editor assistance is compiler-backed. Completion, hover, and signature help should therefore expose the same callable shape that the compiler understands, not a parallel UI-only interpretation.
|
||||
|
||||
Before this discussion, some callable surfaces could reach editor assistance with synthesized labels such as `arg0` and `arg1`. Those labels made stdlib and method calls harder to use because they erased the public meaning of each argument exactly where the editor is meant to help.
|
||||
|
||||
`DEC-0036` made callable parameter names normative semantic metadata. `PLN-0078`, `PLN-0079`, and `PLN-0080` implemented that rule in specs, compiler semantics, and LSP regression coverage.
|
||||
|
||||
## Key Decisions
|
||||
|
||||
### Compiler semantics own parameter identity
|
||||
|
||||
**What:** Every user-visible PBS callable must expose a semantic parameter list with canonical name, zero-based order, type when known, and origin/source metadata.
|
||||
|
||||
**Why:** Completion, hover, signature help, diagnostics, and later documentation surfaces need one source of truth for callable shape. If each editor adapter invents labels independently, stdlib and host-backed API names drift from compiler truth.
|
||||
|
||||
**Trade-offs:** This makes stdlib and host-backed parameter names part of public API shape. Renaming them becomes compatibility-sensitive, but that cost is appropriate because these names are visible to users and tooling.
|
||||
|
||||
### Generated ordinal names stay internal
|
||||
|
||||
**What:** `arg0`, `arg1`, and equivalent ordinal placeholders must not appear in user-facing editor or LSP output.
|
||||
|
||||
**Why:** A generated ordinal name is not a public API name. Publishing it trains users and tests to rely on a placeholder that carries no semantic meaning.
|
||||
|
||||
**Trade-offs:** If a callable genuinely lacks a canonical parameter name, the boundary should represent the metadata as incomplete instead of fabricating a plausible-looking name. That can make missing metadata more visible, but it prevents false API contracts.
|
||||
|
||||
## Patterns and Algorithms
|
||||
|
||||
The compiler-side pattern is to keep parameter identity attached to callable symbols, not only to AST declarations used by direct hover paths.
|
||||
|
||||
The PBS semantic support model now carries `CallableParameter` records beside callable input types. This preserves:
|
||||
|
||||
- authored parameter name;
|
||||
- parameter order;
|
||||
- resolved type view;
|
||||
- source span as origin metadata.
|
||||
|
||||
Editor-facing formatting should then render signatures from those semantic parameters. Direct AST formatting and model-backed callable formatting should produce the same names for user-authored methods, stdlib services, host-backed declarations, and visible builtin/intrinsic method surfaces.
|
||||
|
||||
The LSP bridge should stay thin. It should map compiler editorial signatures into baseline completion, hover, and signature-help payloads without inventing names. The LSP4J mapper should preserve labels and parameter lists exactly as received from the baseline protocol model.
|
||||
|
||||
## Pitfalls
|
||||
|
||||
- Do not fix missing parameter names with an editor-side rename table. That creates a second source of callable truth.
|
||||
- Do not treat stdlib parameter names as incidental implementation details. They are public API surface once completion and signature help expose them.
|
||||
- Do not use `argN` as a harmless fallback in tests. A passing test that expects `arg0` is a regression against the semantic contract.
|
||||
- Be careful when testing stdlib signatures that reference imported types. A test for parameter identity should not accidentally become a test for transitive type rendering unless that is the intended scope.
|
||||
|
||||
## Final Result
|
||||
|
||||
The implemented slice updated:
|
||||
|
||||
- PBS and compiler specs to define callable parameter identity and `argN` leak prevention;
|
||||
- PBS compiler semantic callable symbols to preserve structured parameter metadata;
|
||||
- PBS editorial formatting to render semantic names instead of synthesized ordinals;
|
||||
- LSP bridge and mapper tests to prove completion, hover, and signature help preserve semantic names.
|
||||
|
||||
The validating commits were:
|
||||
|
||||
- `4e00584` implements `PLN-0078`;
|
||||
- `eab763f` implements `PLN-0079`;
|
||||
- `db8c514` implements `PLN-0080`.
|
||||
|
||||
## Takeaways
|
||||
|
||||
- Parameter names are structural callable metadata, not documentation prose.
|
||||
- Editor assistance should consume compiler semantics rather than patching over missing names locally.
|
||||
- Public stdlib and host-backed parameter renames need compatibility review.
|
||||
- Missing semantic metadata is better exposed as incomplete than disguised as `arg0`.
|
||||
+108
@@ -0,0 +1,108 @@
|
||||
---
|
||||
id: LSN-0053
|
||||
ticket: studio-packer-rgba8888-asset-pipeline
|
||||
title: RGBA8888 Is the Canonical Studio and Packer Palette Contract
|
||||
created: 2026-07-14
|
||||
tags:
|
||||
- studio
|
||||
- packer
|
||||
- assets
|
||||
- glyph-bank
|
||||
- palette
|
||||
- rgba8888
|
||||
- runtime-alignment
|
||||
---
|
||||
|
||||
# RGBA8888 Is the Canonical Studio and Packer Palette Contract
|
||||
|
||||
### Original Problem
|
||||
|
||||
The runtime moved to RGBA8888 as the canonical logical color and framebuffer
|
||||
format, but Studio and packer still treated glyph-bank palettes as RGB565-era
|
||||
data. The old pipeline exposed `convertedRgb565`, preserved ARGB as normal
|
||||
projected metadata, reserved palette index `0` for transparency, flattened or
|
||||
discarded alpha semantics, and carried magenta color-key behavior as a hidden
|
||||
transparency shortcut.
|
||||
|
||||
That made the asset pipeline ambiguous. A glyph-bank asset could look valid to
|
||||
Studio while still carrying palette data that no longer matched the runtime
|
||||
contract.
|
||||
|
||||
### Consolidated Decision
|
||||
|
||||
`GLYPH/indexed_v1` remains the runtime-facing format name and keeps its
|
||||
indexed/paletized glyph-bank identity. The incompatible change is inside the
|
||||
palette contract:
|
||||
|
||||
1. `rgba8888` is the canonical authored, projected, and emitted palette field.
|
||||
2. RGBA8888 values are interpreted as `0xRRGGBBAA` in runtime channel order.
|
||||
3. Java `BufferedImage` ARGB values are input-only host API details and must be
|
||||
converted deliberately at the packer boundary.
|
||||
4. Palette index `0` is ordinary. Glyph palettes have 16 usable entries.
|
||||
5. Transparency, including partial transparency, is represented only by alpha.
|
||||
6. Magenta color-key behavior is not a normal Studio or packer feature.
|
||||
7. RGB565 is not a compatibility path for runtime-facing glyph-bank palettes.
|
||||
|
||||
### Implementation Result
|
||||
|
||||
The packer specs now define glyph-bank palette metadata with `rgba8888`, and
|
||||
the binary `GLYPH/indexed_v1` payload uses a `64 * 16 * 4 = 4096` byte palette
|
||||
block instead of the old `64 * 16 * 2 = 2048` byte RGB565 block.
|
||||
|
||||
The packer palette model now carries canonical RGBA8888 values. Image import
|
||||
converts Java ARGB pixels into runtime RGBA values before palette extraction,
|
||||
and palette identity includes alpha. This allows transparent and partially
|
||||
transparent colors to be distinct palette entries.
|
||||
|
||||
Packer read, detail, write, and cache paths now use `rgba8888` as the normal
|
||||
metadata contract. Emission writes palette bytes in `R`, `G`, `B`, `A` order
|
||||
and no longer emits a synthetic magenta entry for index `0`.
|
||||
|
||||
Tests and fixtures were updated to prove the new contract: RGBA channel order,
|
||||
alpha preservation, 16 usable colors, index `0` as ordinary data, magenta as
|
||||
ordinary color data, and 4096-byte palette blocks. Final validation confirmed
|
||||
that remaining stale-looking references are either normative "not supported"
|
||||
statements, historical discussion context, or explicitly out-of-scope generated
|
||||
project cache data.
|
||||
|
||||
### Practical Pattern
|
||||
|
||||
When a host API exposes color in a different layout than the runtime contract,
|
||||
name the boundary explicitly and keep the canonical field runtime-oriented.
|
||||
For this pipeline:
|
||||
|
||||
- accept host ARGB only at import/read time;
|
||||
- convert to RGBA8888 before storing palette metadata;
|
||||
- project `rgba8888` to Studio and packer clients;
|
||||
- emit RGBA bytes directly into `assets.pa`;
|
||||
- convert back to UI-friendly ARGB only inside presentation code.
|
||||
|
||||
This keeps tooling convenient without letting host representation leak into the
|
||||
runtime asset contract.
|
||||
|
||||
### Common Pitfalls and Anti-patterns
|
||||
|
||||
- Do not treat `originalArgb8888` as canonical pipeline data. ARGB can be a UI
|
||||
or image-input representation, but `rgba8888` owns the contract.
|
||||
- Do not reintroduce `convertedRgb565` as a normal projected field or emitted
|
||||
payload. RGB565 compatibility was deliberately rejected for this path.
|
||||
- Do not reserve palette index `0` for transparency. Alpha owns transparency.
|
||||
- Do not use magenta as a hidden color key. A magenta RGBA value is just color
|
||||
data unless an explicit future import tool defines a separate conversion.
|
||||
- Do not change scene `palette_id` semantics as part of color-format work.
|
||||
Scene records still reference glyph-bank palette indices.
|
||||
- Do not fold `DSC-0005` variable palette-count work into RGBA8888 cleanup.
|
||||
Palette encoding changed here; palette-count optimization remains separate.
|
||||
|
||||
### References
|
||||
|
||||
- `DEC-0037`: Studio and Packer RGBA8888 Asset Pipeline Contract.
|
||||
- `PLN-0081`: Packer and Studio spec propagation.
|
||||
- `PLN-0082`: Palette model and ARGB conversion boundary.
|
||||
- `PLN-0083`: Glyph payload emission and size accounting.
|
||||
- `PLN-0084`: Packer projections and workspace APIs.
|
||||
- `PLN-0085`: Tests, fixtures, and conformance updates.
|
||||
- `PLN-0086`: Final integration and residue removal.
|
||||
- `docs/specs/packer/3. Asset Declaration and Virtual Asset Contract Specification.md`.
|
||||
- `docs/specs/packer/4. Build Artifacts and Deterministic Packing Specification.md`.
|
||||
- `docs/specs/studio/4. Assets Workspace Specification.md`.
|
||||
+98
@@ -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
|
||||
+111
@@ -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
|
||||
+74
@@ -0,0 +1,74 @@
|
||||
---
|
||||
id: LSN-0055
|
||||
ticket: multi-frontend-provider-contract
|
||||
title: Static frontend providers before plugin architecture
|
||||
created: 2026-07-15
|
||||
tags: [compiler, compiler-general, studio, frontend, registry, multi-frontend]
|
||||
---
|
||||
|
||||
## Context
|
||||
|
||||
Prometeu needed a multi-frontend boundary without turning the compiler or Studio into a dynamic plugin platform. Before this work, shared code could ask the registry for frontend specs or phase services, and PBS was registered directly as the default language. That worked for a single frontend, but it made the next frontend harder because common code could still depend on PBS-specific construction details.
|
||||
|
||||
The durable ownership rule is now: common compiler and Studio code select a frontend by `languageId`, then consume a provider contract. PBS remains the first and only real provider, but it is no longer the shape of the shared abstraction.
|
||||
|
||||
## Key Decisions
|
||||
|
||||
### `FrontendProvider` is the common registration unit
|
||||
|
||||
**What:** Each registered frontend is represented by a `FrontendProvider` with:
|
||||
|
||||
- `specification()`, for the static frontend contract and `languageId`;
|
||||
- `compiler()`, for compiler-facing frontend execution;
|
||||
- `languageService()`, as an optional editor-facing capability.
|
||||
|
||||
**Why:** This groups the frontend identity, compiler entrypoint, and optional tooling capability without forcing every frontend to implement Studio/editor services.
|
||||
|
||||
**Trade-offs:** The provider is intentionally small. It does not solve dynamic discovery, plugin installation, external loading, or all future language-service APIs. Those are separate architectural decisions.
|
||||
|
||||
### Registration is explicit
|
||||
|
||||
**What:** Frontend registration is static and composition-root-owned. The application composition path bootstraps the default provider set, and the registry resolves providers by `languageId`.
|
||||
|
||||
**Why:** Explicit registration keeps dependencies visible and testable. It lets composition know about PBS while preventing common compiler and Studio consumers from directly constructing PBS services.
|
||||
|
||||
**Trade-offs:** Adding a new in-repository frontend still requires a code change in composition. That is acceptable because this decision optimizes for repository-internal multi-frontend readiness, not external plugin extensibility.
|
||||
|
||||
### PBS is a provider, not the shared model
|
||||
|
||||
**What:** PBS is wrapped by `PBSFrontendProvider`. Shared build and Studio consumers obtain frontend behavior through `FrontendRegistryService.require(languageId)` or provider-derived listings.
|
||||
|
||||
**Why:** PBS remains the correctness baseline, but it must not become the exclusive owner of compiler pipeline semantics.
|
||||
|
||||
**Trade-offs:** PBS-specific tests may still instantiate `PBSFrontendPhaseService` directly because they test PBS internals. Common modules should not.
|
||||
|
||||
## Patterns and Algorithms
|
||||
|
||||
Use this path for common compiler execution:
|
||||
|
||||
1. Resolve the project language from the manifest or default provider.
|
||||
2. Resolve `FrontendProvider` by `languageId`.
|
||||
3. Use `provider.specification()` for static metadata.
|
||||
4. Use `provider.compiler()` for frontend compilation.
|
||||
5. Use `provider.languageService()` only when a tooling consumer needs optional editor services.
|
||||
|
||||
Use this path for Studio language catalogs:
|
||||
|
||||
1. List providers from the registry.
|
||||
2. Derive templates from `provider.specification()`.
|
||||
3. Do not hardcode PBS templates in Studio catalog code.
|
||||
|
||||
## Pitfalls
|
||||
|
||||
- Do not add reflection, classpath scanning, external JAR loading, or runtime plugin installation to solve repository-internal frontend registration.
|
||||
- Do not make `languageService()` mandatory. Compilation and editor assistance are separate capabilities.
|
||||
- Do not instantiate `PBSFrontendPhaseService` from common build, dependency, Studio, or app code.
|
||||
- Do not use PBS as a fallback for unknown `languageId`. Unknown languages must fail explicitly.
|
||||
- Do not move frontend semantic ownership into Studio just because Studio consumes provider metadata.
|
||||
|
||||
## Takeaways
|
||||
|
||||
- Static providers are enough to prepare for multiple in-repository frontends.
|
||||
- The registry boundary is provider-based, not PBS-based.
|
||||
- Composition may know which frontends exist; common consumers should only know `FrontendProvider`.
|
||||
- Optional editor capabilities keep compiler readiness independent from Studio feature depth.
|
||||
+88
@@ -0,0 +1,88 @@
|
||||
# Compile-first frontends with optional editorial capabilities
|
||||
|
||||
## Original Problem
|
||||
|
||||
Prometeu is moving from a PBS-centered compiler/editor stack toward a multi-frontend compiler. PBS already provides compilation plus rich editor assistance, so it was easy for shared code, LSP, or Studio consumers to assume that every frontend can provide diagnostics, semantic tokens, completion, hover, and signature help as one package.
|
||||
|
||||
That assumption makes future frontend adoption too expensive. A new frontend must be able to compile before it has a complete IDE experience.
|
||||
|
||||
## Consolidated Decision
|
||||
|
||||
The frontend contract is compile-first.
|
||||
|
||||
Every frontend must provide a compiler capability through `FrontendProvider.compiler()`. Editorial services are optional and live behind `FrontendProvider.languageService()`.
|
||||
|
||||
A frontend that can compile but has no language service is valid. Missing editor assistance must not block `analyze`, `compile`, `build`, backend lowering, bytecode emission, verification, or artifact writing.
|
||||
|
||||
LSP and Studio consumers must query editorial capability before invoking editor-specific behavior. Absence of a capability is a normal state, not a compiler failure.
|
||||
|
||||
## Final Implementation
|
||||
|
||||
The compiler pipeline spec now defines the provider boundary explicitly:
|
||||
|
||||
- `compiler()` is the only required executable frontend capability.
|
||||
- `languageService()` is optional.
|
||||
- editor capabilities such as completion, hover, definition, signature help, semantic tokens, formatting, rename, and code actions are optional unless a future accepted decision narrows the requirement.
|
||||
- absent editor capabilities have deterministic fallback behavior.
|
||||
- compiler diagnostics and editor diagnostics are separate ownership surfaces.
|
||||
|
||||
PBS keeps its rich editor assistance, but now exposes it through `PBSFrontendLanguageService`, returned by `PBSFrontendProvider.languageService()`.
|
||||
|
||||
The LSP bridge resolves the active `FrontendProvider` and checks for `languageService()` before using editor behavior. For now, PBS remains an adapter-specific implementation because the common language-service DTOs are not yet generalized. That is acceptable because the important boundary is already enforced: the LSP no longer assumes that compiler support implies editor support.
|
||||
|
||||
Conformance coverage now includes:
|
||||
|
||||
- a compile-only provider fixture with no language service;
|
||||
- LSP neutral responses when editor capability is absent;
|
||||
- PBS regression coverage for existing completion, hover, signature help, semantic tokens, and documentation behavior;
|
||||
- architecture tests preventing common modules from directly instantiating PBS editor support.
|
||||
|
||||
## Examples
|
||||
|
||||
A compile-only frontend should look like this at the provider boundary:
|
||||
|
||||
```java
|
||||
public final class ExampleFrontendProvider implements FrontendProvider {
|
||||
@Override
|
||||
public FrontendSpec specification() {
|
||||
return EXAMPLE_SPEC;
|
||||
}
|
||||
|
||||
@Override
|
||||
public FrontendPhaseService compiler() {
|
||||
return exampleCompiler;
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
It does not need to override `languageService()`. The default empty optional is a valid frontend state.
|
||||
|
||||
An editor consumer should treat missing services as a normal fallback:
|
||||
|
||||
```java
|
||||
return provider.languageService()
|
||||
.filter(ExpectedLanguageService.class::isInstance)
|
||||
.map(ExpectedLanguageService.class::cast)
|
||||
.map(service -> service.completion(...))
|
||||
.orElseGet(List::of);
|
||||
```
|
||||
|
||||
## Pitfalls
|
||||
|
||||
Do not use PBS as the minimum frontend contract. PBS is the first rich frontend, not the definition of frontend validity.
|
||||
|
||||
Do not make editor diagnostics a prerequisite for compilation. Build/analyze diagnostics are compiler output; live editor diagnostics may reuse compiler results but have different latency, cancellation, overlay, and UX concerns.
|
||||
|
||||
Do not split the language service into many top-level interfaces before implementation pressure proves a real lifecycle or ownership boundary. The current contract intentionally keeps an aggregated optional language-service surface.
|
||||
|
||||
Do not call PBS editorial classes directly from common compiler, LSP, Studio, or app code. Go through `FrontendProvider.languageService()` and adapter-local capability checks.
|
||||
|
||||
## References
|
||||
|
||||
- Spec: `docs/specs/compiler/23. Compiler Pipeline Entry Points Specification.md`
|
||||
- Provider API: `prometeu-compiler/prometeu-frontend-api/src/main/java/p/studio/compiler/services/FrontendProvider.java`
|
||||
- PBS language service: `prometeu-compiler/frontends/prometeu-frontend-pbs/src/main/java/p/studio/compiler/PBSFrontendLanguageService.java`
|
||||
- LSP bridge: `prometeu-lsp/prometeu-lsp-v1/src/main/java/p/studio/lsp/services/compiler/CompilerLanguageServiceBridge.java`
|
||||
- Conformance tests:
|
||||
- `prometeu-compiler/prometeu-build-pipeline/src/test/java/p/studio/compiler/specs/FrontendProviderBoundaryTest.java`
|
||||
- `prometeu-lsp/prometeu-lsp-v1/src/test/java/p/studio/lsp/services/compiler/CompilerLanguageServiceBridgeTest.java`
|
||||
+92
@@ -0,0 +1,92 @@
|
||||
---
|
||||
id: LSN-0058
|
||||
ticket: multi-frontend-remove-pbs-branches
|
||||
title: Generic Frontend Editorial Contract for LSP
|
||||
created: 2026-07-15
|
||||
tags: [compiler, compiler-general, compiler-pbs, studio, frontend, lsp, coupling, multi-frontend]
|
||||
---
|
||||
|
||||
## Original Problem
|
||||
|
||||
Prometeu was preparing for multiple compiler frontends while the LSP bridge still knew too much about PBS internals. The first framing was broad: remove explicit PBS checks from common code. After inspection, that was too blunt.
|
||||
|
||||
PBS was already mostly centered in `prometeu-frontend-pbs`. Defaults, templates, `.pbs` fixtures, VS Code language registration, semantic keys, and composition-root bootstrap were legitimate PBS references. The real architectural problem was narrower: common LSP code imported and called PBS-specific editorial types and services for semantic tokens, completion, hover, signature help, and semantic read preparation.
|
||||
|
||||
## Consolidated Decision
|
||||
|
||||
The common LSP/editorial path must consume frontend-provided editorial capabilities through generic contracts exposed by `prometeu-frontend-api`.
|
||||
|
||||
The provider contract remains stable:
|
||||
|
||||
1. `FrontendProvider.compiler()` is mandatory.
|
||||
2. `FrontendProvider.languageService()` is optional.
|
||||
3. Compile-only frontends are valid.
|
||||
4. Unknown `languageId` values fail explicitly.
|
||||
5. PBS may be the product default only when the user has not chosen a language.
|
||||
|
||||
PBS is not the shared editor model. PBS implements the generic contract from inside its frontend boundary.
|
||||
|
||||
## Final Implementation Shape
|
||||
|
||||
The implementation introduced generic frontend editorial DTOs and default methods in `FrontendLanguageService`:
|
||||
|
||||
1. `FrontendDocumentRequest`
|
||||
2. `FrontendEditorialContext`
|
||||
3. `FrontendCompletionCandidate`
|
||||
4. `FrontendHover`
|
||||
5. `FrontendSignatureHelp`
|
||||
6. `FrontendSignature`
|
||||
7. `FrontendSymbolKind`
|
||||
8. `FrontendDocumentation`
|
||||
|
||||
`CompilerLanguageServiceBridge` now resolves the selected provider and calls generic `FrontendLanguageService` methods for semantic tokens, completion, hover, and signature help.
|
||||
|
||||
PBS-specific analysis setup moved behind `PBSFrontendLanguageService.prepareEditorialContext(...)`. The bridge no longer imports `p.studio.compiler.pbs.*`, no longer knows `PbsAst.File`, and no longer calls `PBSFrontendPhaseService.semanticReadSurface(...)` directly.
|
||||
|
||||
An architectural test now protects the common LSP code from reintroducing PBS implementation imports.
|
||||
|
||||
## Examples
|
||||
|
||||
A frontend with no language service remains valid:
|
||||
|
||||
```java
|
||||
public final class CompileOnlyFrontendProvider implements FrontendProvider {
|
||||
@Override
|
||||
public FrontendSpec specification() {
|
||||
return SPEC;
|
||||
}
|
||||
|
||||
@Override
|
||||
public FrontendPhaseService compiler() {
|
||||
return compiler;
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
An LSP consumer should resolve the selected provider, ask for `languageService()`, and fall back deterministically when editorial capability is absent.
|
||||
|
||||
PBS can still keep rich internal models such as `PbsEditorialResolvedSymbol`, but those models must be mapped to generic `FrontendHover`, `FrontendCompletionCandidate`, or `FrontendSignatureHelp` before common LSP consumes them.
|
||||
|
||||
## Pitfalls
|
||||
|
||||
Do not remove legitimate PBS defaults just because they mention PBS. PBS remains the product default when the user has not chosen another language.
|
||||
|
||||
Do not use PBS as a fallback for unknown `languageId`. Unknown language identity is a configuration error and must fail explicitly.
|
||||
|
||||
Do not make editor assistance mandatory. Compilation and editor support are separate frontend capabilities.
|
||||
|
||||
Do not move frontend semantic ownership into LSP or Studio. The LSP bridge transports frontend-owned editorial results; it does not author language semantics.
|
||||
|
||||
Do not reintroduce PBS imports in common LSP code for convenience. If a capability needs PBS-specific state, create or extend a frontend-owned generic boundary and keep the PBS mapping inside `prometeu-frontend-pbs`.
|
||||
|
||||
## References
|
||||
|
||||
- `DEC-0042` locked the generic frontend editorial language-service contract.
|
||||
- `PLN-0111` introduced generic frontend editorial DTOs and defaults.
|
||||
- `PLN-0112` migrated semantic tokens.
|
||||
- `PLN-0113` migrated completion.
|
||||
- `PLN-0114` migrated hover and documentation.
|
||||
- `PLN-0115` migrated signature help.
|
||||
- `PLN-0116` removed PBS imports from common LSP and added boundary coverage.
|
||||
- Related lesson: `LSN-0055` Static frontend providers before plugin architecture.
|
||||
- Related lesson: `LSN-0056` Compile-first frontends with optional editorial capabilities.
|
||||
+98
@@ -0,0 +1,98 @@
|
||||
---
|
||||
id: LSN-0059
|
||||
ticket: multi-frontend-frontend-backend-contract
|
||||
title: Common IRBackend handoff and backend guardrails
|
||||
created: 2026-07-15
|
||||
tags: [compiler, compiler-general, compiler-pbs, ir, backend, multi-frontend]
|
||||
---
|
||||
|
||||
# Common IRBackend handoff and backend guardrails
|
||||
|
||||
## Context
|
||||
|
||||
The multi-frontend work needed a clear boundary between language-specific frontends and common backend stages.
|
||||
|
||||
The existing code was already close to the desired architecture: PBS parsing, AST construction, and semantic analysis lowered into `IRBackend`, while the backend consumed `IRBackend` and lowered it into `IRVM`. The risk was not a known broken dependency. The risk was that common backend behavior still looked PBS-owned in specs, names, and missing guardrails, which could invite future coupling when another frontend is introduced.
|
||||
|
||||
## Key Decisions
|
||||
|
||||
### `IRBackend` is the common executable handoff
|
||||
|
||||
**What:** `IRBackend` remains the normative frontend-to-backend executable handoff. Frontends emit it; common backend stages consume it.
|
||||
|
||||
**Why:** The existing model already provides a language-neutral executable contract with modules, callable identities, executable functions, instruction metadata, globals, synthetic functions, host calls, intrinsics, spans, and capabilities. Renaming or redesigning it without a concrete leak would add churn without improving the boundary.
|
||||
|
||||
**Trade-offs:** Keeping the name `IRBackend` means the architecture relies on documentation and tests to communicate its common role. That is acceptable because the name is already established and the guardrails now enforce the boundary.
|
||||
|
||||
### PBS owns lowering into `IRBackend`, not backend consumption of it
|
||||
|
||||
**What:** PBS specs describe PBS admission and translation into `IRBackend`. Compiler-general specs describe the common `IRBackend -> IRVM` contract and backend obligations.
|
||||
|
||||
**Why:** PBS is currently the only rich frontend producing executable `IRBackend`, so many examples naturally come from PBS. Specs must still separate source-language obligations from backend obligations so future frontends do not inherit PBS-specific rules by accident.
|
||||
|
||||
**Trade-offs:** Some PBS-facing examples remain useful, especially around lifecycle wrappers and asset metadata. They must be phrased as current frontend sources of a common backend obligation, not as backend ownership by PBS.
|
||||
|
||||
## Implementation Result
|
||||
|
||||
The completed work:
|
||||
|
||||
1. rewrote the general backend spec so `IRBackend -> IRVM` is explicitly compiler-general;
|
||||
2. rewrote the PBS lowering spec so PBS emits the common handoff instead of owning backend behavior;
|
||||
3. updated the conformance matrix with DEC-0043 guardrail rows;
|
||||
4. added a direct backend test that manually constructs common `IRBackend` and lowers it without PBS parser or frontend services;
|
||||
5. added an architectural test preventing common backend imports from `p.studio.compiler.pbs`;
|
||||
6. added a reflection-based contract test preventing public `IRBackend` model types from exposing PBS packages;
|
||||
7. renamed the common lifecycle helper from `validatePbsLifecycleStructure` to `validateCommonLifecycleStructure`.
|
||||
|
||||
## Patterns and Algorithms
|
||||
|
||||
### Boundary consolidation before abstraction
|
||||
|
||||
When an existing boundary is already technically sound, prefer consolidation over redesign:
|
||||
|
||||
1. document the current contract as normative;
|
||||
2. identify only concrete leaks;
|
||||
3. add tests that would fail if the boundary regresses;
|
||||
4. avoid renames or model extraction until there is evidence of real coupling.
|
||||
|
||||
This keeps multi-frontend preparation focused on preventing regressions rather than inventing abstractions prematurely.
|
||||
|
||||
### Guardrails for common backend neutrality
|
||||
|
||||
A useful backend neutrality guardrail has two layers:
|
||||
|
||||
1. source/package guard: common backend source must not import language frontend packages;
|
||||
2. public-contract guard: common handoff types must not expose language-owned types through fields, constructors, methods, or record components.
|
||||
|
||||
The package guard catches implementation coupling. The reflection guard catches API coupling.
|
||||
|
||||
### Direct handoff construction test
|
||||
|
||||
A backend test should be able to construct executable `IRBackend` manually using only common model types and lower it through `LowerToIRVMService`.
|
||||
|
||||
That test proves the backend consumes the contract, not a specific frontend pipeline.
|
||||
|
||||
## Pitfalls
|
||||
|
||||
- Do not treat the presence of PBS examples as proof that the backend is PBS-owned.
|
||||
- Do not move PBS source rules into compiler-general specs.
|
||||
- Do not let lifecycle terms such as published wrapper, boot guard, or frame root hide whether the obligation is common or PBS-specific.
|
||||
- Do not rename `IRBackend` for aesthetics when the real problem is missing ownership language and missing guardrails.
|
||||
- Do not use a future synthetic test frontend as a substitute for simple direct `IRBackend` construction tests.
|
||||
|
||||
## Takeaways
|
||||
|
||||
- `IRBackend` is the common executable handoff.
|
||||
- PBS owns PBS-to-`IRBackend` lowering; compiler-general owns `IRBackend -> IRVM`.
|
||||
- Common backend code must not depend on `p.studio.compiler.pbs`.
|
||||
- Public `IRBackend` contract types must not expose PBS AST, token, parser, semantic, or editorial types.
|
||||
- Multi-frontend preparation should first lock existing good boundaries before introducing new abstractions.
|
||||
|
||||
## References
|
||||
|
||||
- `docs/specs/compiler/20. IRBackend to IRVM Lowering Specification.md`
|
||||
- `docs/specs/compiler/22. Backend Spec-to-Test Conformance Matrix.md`
|
||||
- `docs/specs/compiler-languages/pbs/13. Lowering IRBackend Specification.md`
|
||||
- `prometeu-compiler/prometeu-build-pipeline/src/test/java/p/studio/compiler/backend/irvm/LowerToIRVMServiceTest.java`
|
||||
- `prometeu-compiler/prometeu-build-pipeline/src/test/java/p/studio/compiler/specs/CommonBackendArchitectureTest.java`
|
||||
- `prometeu-compiler/prometeu-frontend-api/src/test/java/p/studio/compiler/models/IRBackendExecutableContractTest.java`
|
||||
+82
@@ -0,0 +1,82 @@
|
||||
---
|
||||
id: LSN-0060
|
||||
ticket: multi-frontend-serializable-ir
|
||||
title: Data contract first for serializable IRBackend
|
||||
created: 2026-07-15
|
||||
tags: [compiler, compiler-general, ir, backend, serialization, multi-frontend]
|
||||
---
|
||||
|
||||
# Data contract first for serializable IRBackend
|
||||
|
||||
## Original Problem
|
||||
|
||||
The compiler already had a common executable handoff: `IRBackend`. PBS emits it, and common backend stages consume it before lowering to `IRVM`.
|
||||
|
||||
The remaining risk was subtler than direct PBS coupling. A Java-only handoff can accidentally grow around process-local assumptions: callbacks, services, object identity, mutable global state, unordered collections, lazy values, or direct references between live objects. Those shapes can work inside one JVM and still make a future external frontend or out-of-process boundary expensive to add.
|
||||
|
||||
The work needed to keep the handoff serializable by design without choosing JSON, Protobuf, RPC, plugin loading, or a separate process too early.
|
||||
|
||||
## Consolidated Decision
|
||||
|
||||
`IRBackend` is a data contract first.
|
||||
|
||||
Public `IRBackend` contract types must remain modelable as an acyclic, deterministic data graph made from primitives, strings, enums, immutable values, ordered lists, explicit ids, stable symbolic keys, and source attribution values such as file ids and spans.
|
||||
|
||||
The public handoff must not expose callbacks, lambdas, service objects, registries, visitors, live compiler services, frontend AST/parser/token/semantic/editorial objects, mutable global state, object identity semantics, unordered output-affecting collections, cyclic public references, process-dependent lazy values, or a selected wire format.
|
||||
|
||||
The important boundary is the data shape, not a codec. A future serializer should be able to consume the handoff because the public model is already disciplined, but this decision does not require a serializer to exist now.
|
||||
|
||||
## Final Implementation
|
||||
|
||||
The implementation updated the compiler-general backend spec with a new `IRBackend` serializability-by-design subsection. The spec now states the allowed and forbidden public shapes and keeps wire format selection explicitly deferred.
|
||||
|
||||
The conformance matrix added `G20-4.2.x` rows for the new requirements:
|
||||
|
||||
- public `IRBackend` modelability as an acyclic deterministic data graph;
|
||||
- rejection of callbacks, services, mutable or unordered collections, frontend-owned objects, process-dependent lazy values, cyclic public references, and wire-format commitments;
|
||||
- use of explicit ids or stable symbolic keys for cross-object references.
|
||||
|
||||
The executable guardrails live in `IRBackendExecutableContractTest`:
|
||||
|
||||
- the public contract audit covers all current `p.studio.compiler.models` handoff types and nested value types;
|
||||
- support types such as `FileId`, `ModuleId`, `CallableId`, `IntrinsicId`, `Span`, table reference records, and `ReadOnlyList` are explicitly classified;
|
||||
- reflection checks inspect public fields, record components, public constructors, public methods, and generic type arguments;
|
||||
- guardrails reject PBS/frontend exposure, callback shapes, service-like public shapes, mutable/unordered collection contracts, and other non-serializable public exposures;
|
||||
- deterministic aggregation tests prove stable ordering for functions, synthetic functions, globals, executable functions, module pools, callable signatures, intrinsic pools, reserved metadata, and required capabilities;
|
||||
- known references are locked to explicit ids or stable keys rather than direct object references.
|
||||
|
||||
The audit found no concrete public serialization leak that required changing the production model. That result is meaningful: the current `IRBackend` shape was already close to the target, so the correct implementation was spec clarification plus tests, not a redesign.
|
||||
|
||||
## Examples
|
||||
|
||||
Good public handoff shapes:
|
||||
|
||||
- `ModuleId`, `CallableId`, `IntrinsicId`, and `FileId` for table-scoped references;
|
||||
- `ReadOnlyList<T>` for ordered collections;
|
||||
- `ModuleReference`, `CallableSignatureRef`, and `IntrinsicReference` as stable table values;
|
||||
- `Span` for source attribution;
|
||||
- enums and records for fixed value surfaces.
|
||||
|
||||
Bad public handoff shapes:
|
||||
|
||||
- `Map`, `Set`, or mutable collection interfaces where output order matters;
|
||||
- `Runnable`, `Callable`, `Function`, visitors, or callbacks;
|
||||
- compiler services or registries exposed as public fields or constructor parameters;
|
||||
- frontend AST, parser, token, semantic, or editor types;
|
||||
- direct references to another handoff object where an id or ordered table entry is the stable contract.
|
||||
|
||||
## Pitfalls
|
||||
|
||||
- Do not confuse "serializable by design" with "serialize it now." A codec is a future implementation detail.
|
||||
- Do not add typed ids everywhere by taste. Add them when a real public field would otherwise depend on textual identity, object identity, or direct object references.
|
||||
- Do not treat `ReadOnlyList` as cosmetic. Ordered collections are part of the deterministic contract.
|
||||
- Do not let a private assembler or aggregator implementation shape leak into public handoff semantics.
|
||||
- Do not move the rule into PBS specs. PBS owns how it populates the handoff; compiler-general owns the common handoff contract.
|
||||
|
||||
## References
|
||||
|
||||
- `docs/specs/compiler/20. IRBackend to IRVM Lowering Specification.md`
|
||||
- `docs/specs/compiler/22. Backend Spec-to-Test Conformance Matrix.md`
|
||||
- `prometeu-compiler/prometeu-frontend-api/src/test/java/p/studio/compiler/models/IRBackendExecutableContractTest.java`
|
||||
- `prometeu-compiler/prometeu-build-pipeline/src/test/java/p/studio/compiler/specs/BackendConformanceMatrixSpecTest.java`
|
||||
- `prometeu-compiler/prometeu-build-pipeline/src/test/java/p/studio/compiler/backend/irvm/LowerToIRVMServiceTest.java`
|
||||
+143
@@ -0,0 +1,143 @@
|
||||
---
|
||||
id: LSN-0062
|
||||
ticket: multi-frontend-common-lifecycle
|
||||
title: Common lifecycle assembly after frontend declaration
|
||||
created: 2026-09-19
|
||||
tags: [compiler, compiler-general, compiler-pbs, lifecycle, backend, multi-frontend]
|
||||
---
|
||||
|
||||
# Common lifecycle assembly after frontend declaration
|
||||
|
||||
## Original Problem
|
||||
|
||||
`IRBackend` was already the common executable handoff, but the PBS frontend still
|
||||
owned two different jobs. It admitted language markers `[Init]`, `[Frame]`, and
|
||||
`InitAllowed`, and it also assembled the platform lifecycle: module init,
|
||||
project-init wrapper, published frame wrapper, physical entrypoint, and boot
|
||||
guard.
|
||||
|
||||
That second job discovered roles through `__pbs.*` names and lived inside
|
||||
`PBSFrontendPhaseService`. Another frontend could not reuse the boot sequence
|
||||
without copying PBS. Common backend code also risked treating PBS naming as the
|
||||
integration contract.
|
||||
|
||||
The old path had a concrete defect. The `[Init]` colocated with `[Frame]` is
|
||||
project init, but it was also included in the file-init fragment. The published
|
||||
wrapper then called module init and project init separately, so the same
|
||||
callable could run twice. Specs required project init exactly once, after all
|
||||
module initializers and before the frame root.
|
||||
|
||||
## Consolidated Decision
|
||||
|
||||
Declaration and assembly are separate.
|
||||
|
||||
An executable frontend emits an immutable, ordered, typed
|
||||
`IRLifecycleDeclaration` on `IRBackend`. The declaration carries:
|
||||
|
||||
- modules in explicit dependency order;
|
||||
- each module's ordered file-init fragment references;
|
||||
- an optional project-init callable;
|
||||
- exactly one frame-root callable.
|
||||
|
||||
References use `ModuleId`, `FileId`, `CallableId`, a typed role, and source
|
||||
attribution. Absence of a declaration means a deliberately non-executable
|
||||
handoff. It must not synthesize a default `main`.
|
||||
|
||||
`FrontendPhasePipelineStage` stops at that declarative backend.
|
||||
`AssembleLifecyclePipelineStage` runs immediately after it and is the terminal
|
||||
stage of `analyze()`. `LifecycleAssemblerService` is the only owner of derived
|
||||
lifecycle artifacts. `compile()` and `build()` reuse that single assembly pass.
|
||||
|
||||
`ResolveDepsPipelineStage` remains the ordering authority. Frontends propagate
|
||||
that order; the assembler validates and applies it. Neither side may rebuild
|
||||
order from synthetic names, `FileId`, textual module names, or incidental map
|
||||
order.
|
||||
|
||||
Project init is excluded from file-init fragments and runs exactly once. Common
|
||||
derived identities are neutral and deterministic. Common code must not import
|
||||
PBS packages or inspect `__pbs.*` prefixes. Typed roles, ids, and origins are
|
||||
the stable inspection surface; synthetic names are internal.
|
||||
|
||||
## Final Implementation
|
||||
|
||||
PBS now emits per-file lifecycle contributions and a project-level declaration.
|
||||
A colocated `[Init]` is the project-init reference only. File-init fragments
|
||||
remain frontend-lowered executables, consumed by id and role rather than by
|
||||
name prefix. `synthesizePublishedLifecycle` was removed.
|
||||
|
||||
The common assembler validates the declaration and materializes:
|
||||
|
||||
1. module init callables in declared module/file order;
|
||||
2. an optional project-init wrapper, invoked once;
|
||||
3. the published frame wrapper, which is the physical entrypoint;
|
||||
4. a hidden boot guard that prevents a second bootstrap after success.
|
||||
|
||||
The declaration remains on the assembled `IRBackend` as provenance. IRVM
|
||||
lowering keeps only assembled-graph preconditions such as wrapper identity,
|
||||
synthetic origin, and boot-guard presence. It does not reconstruct lifecycle
|
||||
from names.
|
||||
|
||||
`analyze()` still returns a fully assembled executable backend, without IRVM,
|
||||
bytecode, or file output. Neutral names use the `__prometeu.lifecycle.*` prefix.
|
||||
|
||||
Diagnostics stay split: PBS reports marker, signature, placement, cardinality,
|
||||
and colocation errors; the common layer reports unresolved ids, incompatible
|
||||
roles, missing frame root, invalid origins, and frontend-preassembled derived
|
||||
artifacts.
|
||||
|
||||
## Examples
|
||||
|
||||
Good frontend output:
|
||||
|
||||
- a file with globals or a non-project `[Init]` contributes a
|
||||
`FILE_INIT_FRAGMENT`;
|
||||
- the `[Init]` next to `[Frame]` is `PROJECT_INIT` only;
|
||||
- `[Frame]` is `FRAME_ROOT`;
|
||||
- module order follows the resolved dependency graph even when names or file
|
||||
ids would sort the other way.
|
||||
|
||||
Good assembled output:
|
||||
|
||||
- wrapper call order is module inits, then project init once, then frame root;
|
||||
- boot guard is a hidden global, not a user global;
|
||||
- `getLifecycleDeclaration()` still exposes the original typed references.
|
||||
|
||||
Bad output:
|
||||
|
||||
- PBS emitting `MODULE_INIT`, `PROJECT_INIT` wrappers, published wrappers, or
|
||||
boot guards;
|
||||
- common code matching `__pbs.frame_wrapper$m0` to discover the entrypoint;
|
||||
- sorting modules by `FileId` or textual path because the declaration order was
|
||||
inconvenient;
|
||||
- leaving both the PBS assembler and the common stage active.
|
||||
|
||||
## Pitfalls
|
||||
|
||||
- Do not treat `analyze()` as "frontend only." It now includes common lifecycle
|
||||
assembly so callers still receive an executable `IRBackend`.
|
||||
- Do not keep a temporary dual path. Two assemblers duplicate wrappers or init.
|
||||
- Do not infer missing frame roots or repair invalid declarations in the common
|
||||
layer. Fail deterministically.
|
||||
- Do not move PBS marker rules into the assembler. Language admission stays in
|
||||
PBS; structural handoff checks stay common.
|
||||
- Do not preserve `__pbs.*` names for common-derived artifacts as compatibility
|
||||
behavior. They were never a public ABI.
|
||||
- Do not confuse a frontend file-init fragment name with a common-derived
|
||||
identity. PBS may still name its own fragments; common code must not parse
|
||||
those names.
|
||||
|
||||
## References
|
||||
|
||||
- Decision: `DEC-0046`
|
||||
- Plan: `PLN-0125`
|
||||
- Related lessons: `LSN-0059`, `LSN-0060`
|
||||
- `docs/specs/compiler/23. Compiler Pipeline Entry Points Specification.md`
|
||||
- `docs/specs/compiler/20. IRBackend to IRVM Lowering Specification.md`
|
||||
- `docs/specs/compiler/22. Backend Spec-to-Test Conformance Matrix.md`
|
||||
- `docs/specs/compiler-languages/pbs/4. Static Semantics Specification.md`
|
||||
- `docs/specs/compiler-languages/pbs/9. Dynamic Semantics Specification.md`
|
||||
- `docs/specs/compiler-languages/pbs/12. Diagnostics Specification.md`
|
||||
- `docs/specs/compiler-languages/pbs/13. Lowering IRBackend Specification.md`
|
||||
- `prometeu-compiler/prometeu-frontend-api/src/main/java/p/studio/compiler/models/IRLifecycleDeclaration.java`
|
||||
- `prometeu-compiler/prometeu-build-pipeline/src/main/java/p/studio/compiler/lifecycle/LifecycleAssemblerService.java`
|
||||
- `prometeu-compiler/prometeu-build-pipeline/src/main/java/p/studio/compiler/workspaces/stages/AssembleLifecyclePipelineStage.java`
|
||||
+129
@@ -0,0 +1,129 @@
|
||||
---
|
||||
id: LSN-0063
|
||||
ticket: multi-frontend-validation-boundaries
|
||||
title: Language vs platform validation ownership
|
||||
created: 2026-09-19
|
||||
tags: [compiler, compiler-general, compiler-pbs, backend, validation, multi-frontend]
|
||||
---
|
||||
|
||||
# Language vs platform validation ownership
|
||||
|
||||
## Original Problem
|
||||
|
||||
PBS mixed two kinds of rejection. Some failures only make sense with the
|
||||
language: syntax, types, markers, barrel files, imports. Others belong to any
|
||||
executable frontend: malformed `IRBackend`, invalid lifecycle declarations,
|
||||
missing assembled wrappers, host-capability identity, bytecode/preload.
|
||||
|
||||
Without an ownership rule, the next frontend would copy PBS validators, or the
|
||||
common layer would start knowing `[Init]`, barrel, and `E_SEM_*`. Spec 19 was
|
||||
still titled as PBS verification, and the PBS diagnostics catalog listed
|
||||
wrapper and boot-guard failures as PBS coverage.
|
||||
|
||||
Lifecycle assembly had already moved (`LSN-0062`). That proved the pattern. It
|
||||
did not inventory the rest.
|
||||
|
||||
## Consolidated Decision
|
||||
|
||||
A validation lives at the lowest layer that understands the failure without
|
||||
knowing the source language.
|
||||
|
||||
- Language: needs AST, tokens, a language marker, a barrel, or another source
|
||||
rule.
|
||||
- Platform: can be checked on `IRBackend`, `IRLifecycleDeclaration`, IRVM, PBX,
|
||||
host/capability tables, or ids.
|
||||
|
||||
The discussion published that matrix. It did not extract a generic
|
||||
validator-core and did not move validators whose common contract is not closed.
|
||||
|
||||
Host admission is split. PBS owns the source shape of `[Host]` and
|
||||
`[Capability]`. Platform owns canonical `(module, name, version)` identity and
|
||||
capability consistency once those facts exist on `IRReservedMetadata`. The
|
||||
current validator may stay in the PBS package until a later plan. `E_HOST_*`
|
||||
is not eternal PBS semantics.
|
||||
|
||||
The same fact may exist on both sides with distinct identities. PBS can report
|
||||
`E_SEM_MISSING_PROJECT_FRAME`; the common layer still rejects an executable
|
||||
declaration with no frame root.
|
||||
|
||||
Platform codes are `COMMON_*`, `LOWER_IRVM_*`, or `MARSHAL_*`. PBS keeps
|
||||
`E_PARSE_*`, `E_SEM_*`, `E_LINK_*`, and `E_HOST_*`. Copy origin/span when
|
||||
present; a missing origin is a structural error, not a reason to invent a span.
|
||||
|
||||
Linking and barrel stay language-owned. `Addressable` is platform-owned and was
|
||||
classified only. SDK canonical source and the broad architectural harness stay
|
||||
on adjacent discussions.
|
||||
|
||||
## Final Implementation
|
||||
|
||||
The work was editorial and test-facing.
|
||||
|
||||
Spec 19 is now `Compiler Verification and Safety Checks Specification`. Gates
|
||||
S-U and S-I are unchanged. Section 11 states the classification rule, the
|
||||
English ownership matrix, diagnostic identity, dual reporting, and the
|
||||
host-admission split. It explicitly refuses validator-core extraction and
|
||||
package moves.
|
||||
|
||||
PBS diagnostics spec 12 keeps marker, syntax, semantics, linking, and
|
||||
host-attribute coverage. Common structural failures now point at spec 19
|
||||
section 11 and spec 20 instead of appearing as PBS required coverage.
|
||||
|
||||
Spec 20 cross-references that same compiler-general ownership. The conformance
|
||||
matrix added `G19-11.1` through `G19-11.6` and `PBS12-11`.
|
||||
`CommonBackendArchitectureTest` now guards `backend/`, `lifecycle/`, and all
|
||||
common pipeline stages. `ValidationOwnershipSpecTest` locks the title, matrix,
|
||||
and PBS recut.
|
||||
|
||||
`PbsHostAdmissionValidator` remains under `p.studio.compiler.pbs`. No linking
|
||||
or asset production code moved.
|
||||
|
||||
## Examples
|
||||
|
||||
Language-owned:
|
||||
|
||||
- parse errors;
|
||||
- `[Init]` / `[Frame]` signature and colocation;
|
||||
- barrel and import failures;
|
||||
- `host call not allowed during init`.
|
||||
|
||||
Platform-owned and already implemented:
|
||||
|
||||
- invalid `IRLifecycleDeclaration`;
|
||||
- assembled wrapper, boot guard, and synthetic origin preconditions;
|
||||
- IRVM and marshal rejection families.
|
||||
|
||||
Classified as platform, not moved:
|
||||
|
||||
- canonical host-binding identity on `IRReservedMetadata`;
|
||||
- `Addressable` / asset path.
|
||||
|
||||
Dual reporting:
|
||||
|
||||
- missing `[Frame]` in PBS source is `E_SEM_MISSING_PROJECT_FRAME`;
|
||||
- an executable declaration without frame root is a common structural error.
|
||||
|
||||
## Pitfalls
|
||||
|
||||
- Do not treat “classified as platform” as “move the class now.” Host admission
|
||||
still waits on the SDK source discussion.
|
||||
- Do not merge language and platform failures into one hybrid code. Two
|
||||
identities are cheaper than a lost message.
|
||||
- Do not put PBS governance or PBS diagnostics in charge of compiler-general
|
||||
safety gates.
|
||||
- Do not scan PBS frontend sources with the platform architecture guard. The
|
||||
guard is for common validators, not for the language package that must remain.
|
||||
- Do not invent a validator-core because several common checks exist. They
|
||||
already live on their stages.
|
||||
|
||||
## References
|
||||
|
||||
- Decision: `DEC-0047`
|
||||
- Plan: `PLN-0126`
|
||||
- Related lesson: `LSN-0062` - Common lifecycle assembly after frontend declaration
|
||||
- Related lesson: `LSN-0059` - Common IRBackend handoff and backend guardrails
|
||||
- `docs/specs/compiler/19. Verification and Safety Checks Specification.md`
|
||||
- `docs/specs/compiler-languages/pbs/12. Diagnostics Specification.md`
|
||||
- `docs/specs/compiler/20. IRBackend to IRVM Lowering Specification.md`
|
||||
- `docs/specs/compiler/22. Backend Spec-to-Test Conformance Matrix.md`
|
||||
- `prometeu-compiler/prometeu-build-pipeline/src/test/java/p/studio/compiler/specs/ValidationOwnershipSpecTest.java`
|
||||
- `prometeu-compiler/prometeu-build-pipeline/src/test/java/p/studio/compiler/specs/CommonBackendArchitectureTest.java`
|
||||
+121
@@ -0,0 +1,121 @@
|
||||
---
|
||||
id: LSN-0064
|
||||
ticket: multi-frontend-sdk-canonical-definition
|
||||
title: Runtime owns console ABI; PBS is delivery
|
||||
created: 2026-09-19
|
||||
tags: [compiler, compiler-general, sdk, stdlib, hostcalls, intrinsics, multi-frontend]
|
||||
---
|
||||
|
||||
# Runtime owns console ABI; PBS is delivery
|
||||
|
||||
## Original Problem
|
||||
|
||||
"SDK" mixed three layers: platform ABI, PBS stdlib shells, and docs. The PBS
|
||||
compiler reads `[Host]` and `[IntrinsicCall]` from `.pbs` files. It does not
|
||||
read the runtime registry. Intrinsics already had a CSV in the runtime
|
||||
repository, a handwritten Java enum, and a disabled parity test. Spec 8
|
||||
documented `audio` and `@core:math`. Disk had `game/stdlib/1` with `color`,
|
||||
`asset`, `composer`, `gfx`, `input`, and `log`. Spec 18 preferred `@sdk:*` for
|
||||
host APIs while `@sdk:input` was a builtin.
|
||||
|
||||
There is no second language in this phase. The risk was not a missing generic
|
||||
SDK. The risk was treating PBS shells, or a stale spec, as console ABI.
|
||||
DEC-0047 had already classified canonical host identity as platform-owned and
|
||||
left `PbsHostAdmissionValidator` in the PBS package until a shared source
|
||||
existed.
|
||||
|
||||
## Consolidated Decision
|
||||
|
||||
This discussion was an audit. It published an authority map. It did not create
|
||||
a canonical schema, generate bindings, enable intrinsic parity, or move the
|
||||
host-admission validator.
|
||||
|
||||
The console has two distinct axes:
|
||||
|
||||
- VM-owned intrinsics, identity `canonical_name@version` plus `final_id`;
|
||||
- host-backed calls, identity `(module, name, version)` plus capability.
|
||||
|
||||
Do not unify those axes into one catalog while PBS is the only frontend.
|
||||
|
||||
Conflict resolution:
|
||||
|
||||
- Intrinsic conflict: `runtime/docs/vm-arch/INTRINSICS.csv` wins. Studio
|
||||
`docs/vm-arch/INTRINSICS.csv` is a mirror. `IRVMIntrinsicDefinition` is
|
||||
derived. PBS `[BuiltinType]` / `[IntrinsicCall]` shells are delivery.
|
||||
- Host conflict: runtime spec 16 and `SyscallMeta` win. PBS `[Host]` attributes
|
||||
must not define ABI. They declare the shell the PBS compiler reads today.
|
||||
|
||||
`@sdk:*` / `@core:*` paths must not imply ownership. `@sdk:input` is a
|
||||
registered builtin exception. It was not moved to `@core`.
|
||||
|
||||
PBS conformance means PBS shells and docs match runtime ABI, not the reverse.
|
||||
`PbsHostAdmissionValidator` may stay in the PBS package. `E_HOST_*` is not
|
||||
eternal PBS semantics.
|
||||
|
||||
## Final Implementation
|
||||
|
||||
The work was editorial and test-facing.
|
||||
|
||||
Spec 18 now states that PBS stdlib is delivery and must not define syscall IDs,
|
||||
intrinsic `final_id` values, or `SyscallMeta`. Runtime catalogs outrank it.
|
||||
`@sdk:input` is recorded as the current builtin exception.
|
||||
|
||||
Spec 8 now documents `<target>/stdlib/<N>/...` with current line `1` at
|
||||
`game/stdlib/1`: `core/color` and `sdk/{asset,composer,gfx,input,log}`. It no
|
||||
longer ships `audio` or `@core:math` as current modules.
|
||||
|
||||
Spec 6.2 now requires PBS host shells to repeat the runtime registry and forbids
|
||||
inventing `(module, name, version)`. The authority example is
|
||||
`("gfx2d", "clear", 1)`.
|
||||
|
||||
`ConsoleAbiAuthoritySpecTest` locks those sentences. No production compiler
|
||||
code, stdlib `.pbs`, or validator package moved. The intrinsic parity test
|
||||
stays disabled.
|
||||
|
||||
## Examples
|
||||
|
||||
Runtime wins:
|
||||
|
||||
- `color.rgb@1` / `final_id` `0x1101` come from `INTRINSICS.csv`;
|
||||
- `("gfx2d", "clear", 1)` and `("asset", "load", 1)` come from `SyscallMeta`.
|
||||
|
||||
PBS delivers, and does not own, those identities:
|
||||
|
||||
- `@core:color` with `[BuiltinType(name = "color", version = 1)]`;
|
||||
- `@sdk:gfx` `LowGfx.clear` with `[Host(module = "gfx2d", name = "clear", version = 1)]`;
|
||||
- `@sdk:input` with `[BuiltinType]` / `[IntrinsicCall]` under `@sdk`.
|
||||
|
||||
Stale docs that the recut removed as current line-1 inventory:
|
||||
|
||||
- `stdlib/1/sdk/audio`;
|
||||
- `@core:math` as a packaged module.
|
||||
|
||||
## Pitfalls
|
||||
|
||||
- Do not treat PBS stdlib as the ABI catalog because the compiler already reads
|
||||
it. That is convenience, not authority.
|
||||
- Do not create `HOSTCALLS.csv` or generate the Java enum because the map now
|
||||
exists. A catalog waits on a second consumer.
|
||||
- Do not move `PbsHostAdmissionValidator` on the strength of this map. DEC-0047
|
||||
classified identity as platform; this discussion published who wins; the
|
||||
validator still has no shared catalog to consume.
|
||||
- Do not read `@sdk` as host and `@core` as VM. Path is packaging. `@sdk:input`
|
||||
is builtin.
|
||||
- Do not enable `IRVMIntrinsicRegistryParityTest` as a side effect of a doc
|
||||
recut. That is compiler/runtime sync, not PBS packaging conformance.
|
||||
- Do not put the authority map only in a decision. Housekeep deletes workflow
|
||||
artifacts. Specs and this lesson keep the map.
|
||||
|
||||
## References
|
||||
|
||||
- Decision: `DEC-0048`
|
||||
- Plan: `PLN-0127`
|
||||
- Related lesson: `LSN-0063` - Language vs platform validation ownership
|
||||
- Related lesson: `LSN-0061` - PBX is the language-neutral runtime boundary
|
||||
- `docs/specs/compiler/18. Standard Library Surface Specification.md`
|
||||
- `docs/specs/compiler-languages/pbs/8. Stdlib Environment Packaging and Loading Specification.md`
|
||||
- `docs/specs/compiler-languages/pbs/6.2. Host ABI Binding and Loader Resolution Specification.md`
|
||||
- `docs/vm-arch/README.md`
|
||||
- `../runtime/docs/vm-arch/INTRINSICS.csv`
|
||||
- `../runtime/docs/specs/runtime/16-host-abi-and-syscalls.md`
|
||||
- `prometeu-compiler/prometeu-build-pipeline/src/test/java/p/studio/compiler/specs/ConsoleAbiAuthoritySpecTest.java`
|
||||
+136
@@ -0,0 +1,136 @@
|
||||
---
|
||||
id: LSN-0061
|
||||
ticket: multi-frontend-pvm-neutrality
|
||||
title: PBX is the language-neutral runtime boundary
|
||||
created: 2026-09-18
|
||||
tags: [vm-arch, runtime, pvm, pbx, compiler, multi-frontend]
|
||||
---
|
||||
|
||||
# PBX is the language-neutral runtime boundary
|
||||
|
||||
## Original Problem
|
||||
|
||||
PBS was the first implemented frontend, so its name still appeared in a few
|
||||
common compiler specification titles. That editorial residue made it easier to
|
||||
misread the architecture as if PBS owned bytecode, IRVM, or the PVM execution
|
||||
model.
|
||||
|
||||
The implementation was already mostly neutral: the compiler emitted PBX, the
|
||||
runtime loaded PBX, and the common backend did not import PBS frontend packages.
|
||||
The real risk was future drift. In particular, IRVM could be mistaken for a
|
||||
runtime input, `PBS\0` could be confused with the executable magic, and duplicated
|
||||
VM-architecture documents could silently become competing authorities.
|
||||
|
||||
## Consolidated Decision
|
||||
|
||||
The executable pipeline is:
|
||||
|
||||
```text
|
||||
language frontend -> IRBackend -> IRVM -> PBX -> loader/verifier -> PVM
|
||||
```
|
||||
|
||||
`IRBackend`, `IRVM`, optimization, and PBX emission are compiler-owned.
|
||||
`IRVM` is an internal compiler representation and never crosses the runtime
|
||||
boundary. PBX is the only executable artifact consumed by the runtime.
|
||||
|
||||
The runtime repository owns PBX binary layout, Core ISA, loader behavior,
|
||||
verification, and PVM execution. Studio owns the common compiler transformations
|
||||
that produce conforming PBX. Studio copies of VM-architecture documents are
|
||||
mirrors, not independent authorities.
|
||||
|
||||
`PBS` names a language, frontend, stdlib, and explicitly language-specific
|
||||
integration. It does not name the executable format, magic, ISA, ABI, program
|
||||
image, or runtime type. The canonical persisted artifact is `program.pbx`, and
|
||||
its binary magic is `PBX\0`.
|
||||
|
||||
## Final Implementation
|
||||
|
||||
The common compiler specifications now identify bytecode/PBX and IRVM
|
||||
optimization as language-neutral surfaces. They explicitly state that IRVM is
|
||||
internal to the compiler and that PBX is the compiler/runtime boundary. Existing
|
||||
PBS references were retained where they describe legitimate frontend-specific
|
||||
publication or metadata behavior.
|
||||
|
||||
Studio's copies of `ARCHITECTURE.md`, `ISA_CORE.md`, and `INTRINSICS.csv` were
|
||||
synchronized with the runtime repository. A mirror policy now identifies the
|
||||
runtime repository as canonical and provides byte-for-byte comparison commands.
|
||||
|
||||
Existing Studio tests already proved two important invariants:
|
||||
|
||||
- `BytecodeModule` serializes the exact `PBX\0` header;
|
||||
- common backend contracts neither import nor publicly expose PBS frontend
|
||||
types.
|
||||
|
||||
Runtime conformance was strengthened in three focused places:
|
||||
|
||||
- the bytecode invalid-magic regression now explicitly proves that legacy
|
||||
`PBS\0` is rejected;
|
||||
- the PVM initialization regression now creates a `BytecodeModule` directly,
|
||||
serializes it, loads and verifies it, prepares the boot call, and executes it
|
||||
through `HALT` without any frontend;
|
||||
- a quality check inspects the `prometeu-bytecode` and `prometeu-vm` manifests
|
||||
and rejects dependencies whose identities belong to compiler or frontend
|
||||
layers.
|
||||
|
||||
No production VM behavior, ISA, ABI, or binary format changed.
|
||||
|
||||
## Examples
|
||||
|
||||
Language-specific work stops before the common backend:
|
||||
|
||||
```text
|
||||
PBS AST and semantic model
|
||||
-> PBS lowering
|
||||
-> neutral IRBackend data
|
||||
-> common IRVM lowering and optimization
|
||||
-> PBX\0
|
||||
```
|
||||
|
||||
A future frontend follows the same boundary:
|
||||
|
||||
```text
|
||||
FutureLanguage AST and semantic model
|
||||
-> FutureLanguage lowering
|
||||
-> neutral IRBackend data
|
||||
-> the same common IRVM and PBX stages
|
||||
```
|
||||
|
||||
The runtime sees the same PBX contract in both cases. It does not receive a
|
||||
`languageId`, source extension, AST object, IRVM object, or frontend service.
|
||||
|
||||
## Pitfalls and Anti-Patterns
|
||||
|
||||
- Do not expose IRVM as a convenient runtime protocol. It is optimized for
|
||||
compiler transformations, not binary compatibility or runtime loading.
|
||||
- Do not rename PBX concepts after the first frontend. `PBS\0` is invalid even
|
||||
when PBS produced the program.
|
||||
- Do not globally ban the word `PBS` from runtime documentation. PBS is a valid
|
||||
guest-language example; guards should inspect dependencies, public types, and
|
||||
format identities instead of raw text.
|
||||
- Do not duplicate tests when an existing guard proves the entire invariant.
|
||||
Extend coverage only for the missing distinction, such as explicit `PBS\0`
|
||||
rejection.
|
||||
- Do not let a documentation mirror become a second authority. Synchronize it
|
||||
against runtime or replace it with an explicit reference.
|
||||
- Loading a PBX image is not the same as beginning execution. The PVM boot test
|
||||
must prepare the published boot call before running the instruction budget.
|
||||
|
||||
## References
|
||||
|
||||
- `docs/specs/compiler/15. Bytecode and PBX Mapping Specification.md`
|
||||
- `docs/specs/compiler/20. IRBackend to IRVM Lowering Specification.md`
|
||||
- `docs/specs/compiler/21. IRVM Optimization Pipeline Specification.md`
|
||||
- `docs/vm-arch/README.md`
|
||||
- `prometeu-compiler/prometeu-build-pipeline/src/main/java/p/studio/compiler/backend/bytecode/BytecodeModule.java`
|
||||
- `prometeu-compiler/prometeu-build-pipeline/src/test/java/p/studio/compiler/specs/CommonBackendArchitectureTest.java`
|
||||
- Runtime: `crates/console/prometeu-bytecode/src/model.rs`
|
||||
- Runtime: `crates/console/prometeu-vm/src/virtual_machine.rs`
|
||||
- Runtime: `crates/dev/prometeu-quality-checks/tests/pvm_frontend_neutrality.rs`
|
||||
|
||||
## Takeaways
|
||||
|
||||
- PBX is the stable, language-neutral executable boundary.
|
||||
- IRVM stays private to the compiler pipeline.
|
||||
- Runtime authority and compiler authority are complementary, not competing.
|
||||
- Small dependency and artifact tests are enough to protect this boundary
|
||||
without introducing a plugin platform or a second language.
|
||||
+148
@@ -0,0 +1,148 @@
|
||||
---
|
||||
id: LSN-0065
|
||||
ticket: multi-frontend-synthetic-test-frontend
|
||||
title: Synthetic test frontend proves common pipeline neutrality
|
||||
created: 2026-09-19
|
||||
tags: [compiler, compiler-general, frontend, tests, backend, multi-frontend]
|
||||
---
|
||||
|
||||
# Synthetic test frontend proves common pipeline neutrality
|
||||
|
||||
## Original Problem
|
||||
|
||||
The common pipeline already had `FrontendProvider`, `IRBackend` as the
|
||||
executable handoff, common lifecycle assembly, and `IRBackend -> IRVM -> PBX`.
|
||||
Direct construction tests proved the backend could lower a handmade
|
||||
`IRBackend`. Import guards proved common backend code did not depend on PBS
|
||||
packages.
|
||||
|
||||
That was not enough. Nothing proved that a second provider, resolved by
|
||||
`languageId`, could enter through `DiscoverPhase` and
|
||||
`FrontendPhasePipelineStage`, assemble lifecycle, and finish
|
||||
`BuilderPipelineService.compile()` at verified bytecode without instantiating
|
||||
PBS, reading `.pbs` files, or loading PBS stdlib.
|
||||
|
||||
`CompileOnlyFrontendProvider` already existed as a local test double. It was
|
||||
not registered, returned an empty `IRBackend`, and never called the pipeline.
|
||||
It did not close this gap.
|
||||
|
||||
## Consolidated Decision
|
||||
|
||||
Pipeline neutrality is proved by a **test-only** compile-only
|
||||
`FrontendProvider`, not by a second product language and not by injecting IR
|
||||
into compile stages.
|
||||
|
||||
Locked shape (former Option A):
|
||||
|
||||
- `languageId` is `synth`.
|
||||
- The provider and `FrontendPhaseService` live only in
|
||||
`prometeu-build-pipeline` test sources.
|
||||
- `languageService()` is empty. There is no parser, grammar, semantic
|
||||
presentation, or stdlib catalog.
|
||||
- `sourceRoots` is `src`. `allowedExtensions` must not collide with `pbs` /
|
||||
`barrel`. The fixture must **not** create a source file of that extension.
|
||||
An empty `src/` directory must still exist because `WireProjectsPhase`
|
||||
resolves `toRealPath()`.
|
||||
- The compiler ignores source text and emits one module, one `frame` body
|
||||
that is a single `RET`, and an `IRLifecycleDeclaration` with exactly one
|
||||
`FRAME_ROOT` whose origin span is filled.
|
||||
- The handoff must not declare `FILE_INIT_FRAGMENT` or `PROJECT_INIT`, and
|
||||
must not pre-materialize wrappers, module-init, or `BOOT_GUARD`. The common
|
||||
assembler produces `__prometeu.lifecycle.frame_wrapper$mN` and the boot
|
||||
guard.
|
||||
- The IR must not contain host bindings, capabilities, intrinsics, PBS types,
|
||||
PBS stdlib, or `__pbs.` names.
|
||||
|
||||
The acceptance path is `compile()` through `VerifyBytecode`. Writing
|
||||
`program.pbx` is not the criterion. `build()` only adds disk I/O.
|
||||
|
||||
Registration stays on the existing static `FrontendRegistryService`.
|
||||
`register` and `unregister` are public. `unregister` refuses to remove the
|
||||
default PBS provider and is a no-op for unknown ids. Tests register `synth`
|
||||
for the duration of the run and unregister in `try/finally`.
|
||||
`bootstrapDefaults()`, `AppContainer`, and the Studio language catalog must
|
||||
not register `synth`.
|
||||
|
||||
Do not inject a `Registry` into the pipeline, add a `frontends/synth` module,
|
||||
scan the classpath, or treat a dummy on-disk extension as a language. Do not
|
||||
replace `LifecycleAssemblerServiceTest`, `LowerToIRVMServiceTest`, or
|
||||
`IRBackendExecutableContractTest` with this fixture.
|
||||
|
||||
A blank `prometeu.json` `language` field still defaults to PBS. The synthetic
|
||||
project must set `language: synth` explicitly.
|
||||
|
||||
## Final Implementation
|
||||
|
||||
`FrontendRegistryService.register(FrontendProvider)` is the explicit
|
||||
registration API. `unregister(String languageId)` removes a non-PBS provider
|
||||
or no-ops if the id is absent. Duplicate `register` still fails.
|
||||
`bootstrapDefaults()` still registers only PBS.
|
||||
|
||||
The test fixture is:
|
||||
|
||||
- `p.studio.compiler.synth.SyntheticFrontendProvider`
|
||||
- `p.studio.compiler.synth.SyntheticFrontendPhaseService`
|
||||
|
||||
`SyntheticFrontendPipelineTest` writes a temporary project
|
||||
(`language: synth`, `target: Game`, numeric `stdlib`, empty `src/`),
|
||||
registers the provider, calls `BuilderPipelineService.compile()`, and
|
||||
asserts:
|
||||
|
||||
- the synthetic compiler ran;
|
||||
- resolved `languageId` is `synth`, not `pbs`;
|
||||
- diagnostics have no errors;
|
||||
- in-memory bytecode is non-empty and verified;
|
||||
- assembled entrypoint is `__prometeu.lifecycle.frame_wrapper$m0`;
|
||||
- a hidden boot guard is present;
|
||||
- no `__pbs.` names;
|
||||
- no `.pbs` / `.barrel` sources were required;
|
||||
- after `unregister`, `listProviders()` is PBS-only.
|
||||
|
||||
Spec 23 section 8.3 records that a compile-only registered provider is a
|
||||
valid pipeline participant and that the common pipeline must not require PBS
|
||||
types, PBS sources, or PBS stdlib to emit verified bytecode. Spec 22 row
|
||||
`G23-8.3` binds that obligation to the synthetic pipeline test.
|
||||
|
||||
PBS production code, Studio, and `AppContainer` were not changed.
|
||||
|
||||
## Examples
|
||||
|
||||
Good:
|
||||
|
||||
- register `synth`, compile a temp project with empty `src/`, unregister;
|
||||
- `FRAME_ROOT` with `FileId(0)` and a non-none span, even with no source file
|
||||
in `FileTable`;
|
||||
- assert the synthetic compiler was invoked instead of importing
|
||||
`PBSFrontendPhaseService` from build-pipeline tests.
|
||||
|
||||
Bad:
|
||||
|
||||
- omitting `language` in the manifest so discovery silently uses PBS;
|
||||
- creating `main.dummy` and calling that a second frontend;
|
||||
- putting the provider under `prometeu-compiler/frontends/`;
|
||||
- leaving `synth` registered after the test so later tests see two providers;
|
||||
- using this pipeline test as a substitute for assembler or IRVM unit tests.
|
||||
|
||||
## Pitfalls
|
||||
|
||||
- `WireProjectsPhase` still needs `src/` on disk. Empty is not the same as
|
||||
missing.
|
||||
- Origin span `Span.none()` is rejected by the assembler. Use a real
|
||||
`FileId` even when no file was loaded.
|
||||
- `unregister("pbs")` must fail. A cleanup path that blindly unregisters the
|
||||
resolved language would delete the product default.
|
||||
- `listProviders()` feeds the Studio catalog. A leaked test registration
|
||||
would show `synth` as a new-project language.
|
||||
- Direct `IRBackend` construction tests still own backend-only proofs. The
|
||||
synthetic frontend owns the registry-plus-pipeline proof. Keep both.
|
||||
|
||||
## References
|
||||
|
||||
- Decision: `DEC-0049`
|
||||
- Plan: `PLN-0128`
|
||||
- Related lessons: `LSN-0055`, `LSN-0056`, `LSN-0059`, `LSN-0062`, `LSN-0061`
|
||||
- `docs/specs/compiler/23. Compiler Pipeline Entry Points Specification.md`
|
||||
- `docs/specs/compiler/22. Backend Spec-to-Test Conformance Matrix.md`
|
||||
- `prometeu-compiler/prometeu-frontend-registry/src/main/java/p/studio/compiler/FrontendRegistryService.java`
|
||||
- `prometeu-compiler/prometeu-build-pipeline/src/test/java/p/studio/compiler/synth/SyntheticFrontendProvider.java`
|
||||
- `prometeu-compiler/prometeu-build-pipeline/src/test/java/p/studio/compiler/integration/SyntheticFrontendPipelineTest.java`
|
||||
+151
@@ -0,0 +1,151 @@
|
||||
---
|
||||
id: LSN-0066
|
||||
ticket: multi-frontend-architectural-tests
|
||||
title: ArchUnit guards Java multi-frontend boundaries
|
||||
created: 2026-09-19
|
||||
tags: [compiler, compiler-general, studio, frontend, architecture, tests, multi-frontend]
|
||||
---
|
||||
|
||||
# ArchUnit guards Java multi-frontend boundaries
|
||||
|
||||
## Original Problem
|
||||
|
||||
The multi-frontend boundaries already existed in specs and lessons: common
|
||||
code selects a frontend by `languageId`, `IRBackend` is language-neutral,
|
||||
lifecycle assembly is common, and PBS is one provider. The automated
|
||||
protection did not match that model.
|
||||
|
||||
The old guards walked Java source and searched for substrings:
|
||||
|
||||
- `import p.studio.compiler.pbs`
|
||||
- `new PBSFrontendPhaseService(`
|
||||
- `new PbsEditorialSupportService(`
|
||||
|
||||
Those checks missed field, signature, and constructor coupling. They also
|
||||
treated `p.studio.compiler.pbs` as the whole PBS surface. Facades such as
|
||||
`PBSFrontendProvider`, `PBSDefinitions`, and `PBSFrontendPhaseService` live
|
||||
in the PBS module but not in that package. `prometeu-app` and
|
||||
`prometeu-lsp-v1` declared an `implementation` dependency on PBS without
|
||||
importing any PBS type.
|
||||
|
||||
## Consolidated Decision
|
||||
|
||||
Java multi-frontend boundaries are enforced by **ArchUnit + JUnit 5**, not by
|
||||
source substring search, except for the `__pbs.` literal scan that bytecode
|
||||
cannot see.
|
||||
|
||||
Durable locks from DEC-0050:
|
||||
|
||||
- ArchUnit is test-only, pinned in `gradle/libs.versions.toml`.
|
||||
- Rules live in the test-only Gradle project `:prometeu-architecture-tests`.
|
||||
That project has no production sources. It is not a plugin loader.
|
||||
- A PBS type is a class whose bytecode originates from
|
||||
`:prometeu-compiler:frontends:prometeu-frontend-pbs`. Package
|
||||
`p.studio.compiler.pbs` is not the complete boundary. Name prefixes
|
||||
`PBS*` / `Pbs*` are not the identity.
|
||||
- Production may depend on PBS types only in:
|
||||
- the PBS module itself;
|
||||
- `prometeu-frontend-registry` / `FrontendRegistryService`, and only on
|
||||
`PBSFrontendProvider` and `PBSDefinitions`.
|
||||
- `AppContainer` is not a PBS composition root. It may call
|
||||
`FrontendRegistryService.bootstrapDefaults()`. It must not instantiate PBS
|
||||
types.
|
||||
- `synth` is not in the production allowlist and must not be registered in
|
||||
`bootstrapDefaults()`.
|
||||
- Runtime, PVM, and the Rust repository stay out of this discussion
|
||||
(LSN-0061).
|
||||
- `IRBackendExecutableContractTest` remains the public-contract shape audit.
|
||||
ArchUnit covers module-origin dependence.
|
||||
|
||||
Do not migrate PBS facades into another package just to make the test
|
||||
easier. Do not ban the word `PBS` in docs, fixtures, or comments.
|
||||
|
||||
## Final Implementation
|
||||
|
||||
`:prometeu-architecture-tests` imports production classes under `p.studio`
|
||||
with `ImportOption.DoNotIncludeTests` and applies three ArchUnit rules:
|
||||
|
||||
1. classes outside the PBS module and the registry must not depend on
|
||||
PBS-module types;
|
||||
2. registry production may depend only on `PBSFrontendProvider` and
|
||||
`PBSDefinitions` from that module;
|
||||
3. frontend-api `p.studio.compiler.models` must not depend on PBS-module
|
||||
types.
|
||||
|
||||
A separate JUnit test walks `build.gradle.kts` files and allows the PBS
|
||||
project dependency only for:
|
||||
|
||||
- `:prometeu-compiler:prometeu-frontend-registry` as `implementation`/`api`;
|
||||
- `:prometeu-architecture-tests` as `testImplementation` (needed to classify
|
||||
class origin).
|
||||
|
||||
The `__pbs.` source scan moved to
|
||||
`CommonBackendPbsPrefixScanTest` and still covers `backend/`, `lifecycle/`,
|
||||
and `workspaces/stages/`.
|
||||
|
||||
Gradle graph cleanup:
|
||||
|
||||
- `prometeu-app` and `prometeu-lsp-v1` no longer `implementation` PBS.
|
||||
Runtime classloading of `PBSFrontendProvider` still comes through the
|
||||
registry's implementation dependency.
|
||||
- `prometeu-studio` no longer `testImplementation` PBS. No studio test
|
||||
compiled against PBS types.
|
||||
|
||||
Source-walk import/constructor tests were deleted.
|
||||
`FrontendProviderBoundaryTest` keeps only
|
||||
`compileOnlyFrontendProviderMayOmitLanguageService`.
|
||||
|
||||
Specs 19 §11 and 20 now say common/platform code must not depend on types
|
||||
from the PBS frontend module. Matrix rows G19-11.6, G20-4.1.2, and G20-4.3.3
|
||||
point at the ArchUnit rules and the `__pbs.` scan.
|
||||
|
||||
## Examples
|
||||
|
||||
Good:
|
||||
|
||||
- ArchUnit failure names the class that depends on a PBS-module type,
|
||||
including a facade in package `p.studio.compiler`.
|
||||
- Registry `bootstrapDefaults()` constructs `PBSFrontendProvider`. That is
|
||||
the allowed composition root.
|
||||
- App calls `FrontendRegistryService.bootstrapDefaults()` and has no PBS
|
||||
project dependency.
|
||||
|
||||
Bad:
|
||||
|
||||
- Searching source for `import p.studio.compiler.pbs` and calling the
|
||||
boundary protected.
|
||||
- Treating `AppContainer` as the place that may `new PBSFrontendProvider()`.
|
||||
- Identifying PBS by class name prefix, so a future `PbsLike` helper in
|
||||
common code is banned or a PBS facade is missed.
|
||||
- Adding ArchUnit to `java-common-conventions` for every module.
|
||||
|
||||
## Pitfalls
|
||||
|
||||
- Same Java package does not mean same Gradle module.
|
||||
`FrontendRegistryService` and `PBSFrontendProvider` both sit in
|
||||
`p.studio.compiler`. Origin is the module path or JAR name.
|
||||
- `@AnalyzeClasses` classes must not mix `@ArchTest` and Jupiter `@Test` on
|
||||
the same class. The ArchUnit engine owns `@ArchTest`.
|
||||
- `DoNotIncludeTests` is required. The architecture-test sources themselves
|
||||
reference PBS types in order to name the allowlist.
|
||||
- Removing PBS from app/lsp compile classpath is safe only because registry
|
||||
still `implementation`s PBS, which is runtime-transitive.
|
||||
- `testImplementation` of PBS on studio is not a production leak, but if no
|
||||
studio test needs PBS types it is still a lying graph. The allowlist test
|
||||
rejects it.
|
||||
- Do not point ArchUnit at the Rust runtime. `__pbs.` in Java source is a
|
||||
string contract, not a type dependency.
|
||||
|
||||
## References
|
||||
|
||||
- Decision: `DEC-0050`
|
||||
- Plan: `PLN-0129`
|
||||
- Related lessons: `LSN-0055`, `LSN-0059`, `LSN-0062`, `LSN-0063`,
|
||||
`LSN-0061`, `LSN-0065`
|
||||
- `docs/specs/compiler/19. Verification and Safety Checks Specification.md`
|
||||
- `docs/specs/compiler/20. IRBackend to IRVM Lowering Specification.md`
|
||||
- `docs/specs/compiler/22. Backend Spec-to-Test Conformance Matrix.md`
|
||||
- `prometeu-architecture-tests/src/test/java/p/studio/architecture/PbsModuleBoundaryArchTest.java`
|
||||
- `prometeu-architecture-tests/src/test/java/p/studio/architecture/PbsGradleDependencyAllowlistTest.java`
|
||||
- `prometeu-compiler/prometeu-frontend-registry/src/main/java/p/studio/compiler/FrontendRegistryService.java`
|
||||
- `prometeu-compiler/prometeu-frontend-api/src/test/java/p/studio/compiler/models/IRBackendExecutableContractTest.java`
|
||||
+167
@@ -0,0 +1,167 @@
|
||||
---
|
||||
id: LSN-0067
|
||||
ticket: multi-frontend-avoid-premature-abstractions
|
||||
title: Multi-frontend phase rejects premature infrastructure
|
||||
created: 2026-09-19
|
||||
tags: [compiler, compiler-general, studio, frontend, architecture, multi-frontend, simplicity]
|
||||
---
|
||||
|
||||
# Multi-frontend phase rejects premature infrastructure
|
||||
|
||||
## Original Problem
|
||||
|
||||
The multi-frontend preparation needed a standing simplicity rule. The original
|
||||
agenda asked for that rule *before* the other multi-frontend discussions.
|
||||
Those discussions already closed (DSC-0054 through DSC-0064). The remaining
|
||||
risk was not a missing plugin platform.
|
||||
|
||||
The remaining risk was twofold:
|
||||
|
||||
1. using "keep it simple" to put PBS construction back into common compiler,
|
||||
Studio, LSP, or app code;
|
||||
2. inventing marketplace, JAR loading, RPC, validator-core, or a generic SPI
|
||||
"for a future language" that does not exist in this repository.
|
||||
|
||||
`FrontendRegistryService` is a static singleton. The original agenda listed
|
||||
a global service locator as out of scope. Without an explicit exception, a
|
||||
later change could inject a `Registry` into the pipeline for purity, which
|
||||
DSC-0063 already refused.
|
||||
|
||||
## Consolidated Decision
|
||||
|
||||
This is standing policy for *future* work in the current phase: PBS as the
|
||||
only product frontend, `synth` as a test-only provider, frontends in-repo.
|
||||
It is not an audit of closed discussions and must not rewrite them.
|
||||
|
||||
Durable locks from DEC-0051:
|
||||
|
||||
- Implementation of this discussion is the decision plus this lesson. There
|
||||
is no new spec, no new ArchUnit rule, and no production refactor.
|
||||
- Spec 23 §2 and §8.3 remain the discovery MUST NOT surface. Do not copy
|
||||
those sentences into a new spec.
|
||||
- Architectural tests stay owned by LSN-0066.
|
||||
|
||||
### Static registry is allowed
|
||||
|
||||
`FrontendRegistryService` as a static singleton, with public `register` and
|
||||
`unregister` and `bootstrapDefaults()` registering only PBS, is the
|
||||
composition mechanism of this phase. Treat that as an explicit exception,
|
||||
not as a banned service locator.
|
||||
|
||||
Discovery must not use `ServiceLoader`, classpath scanning, reflection-based
|
||||
discovery, an external JAR, or runtime plugin installation.
|
||||
|
||||
Do not inject a `Registry` into the pipeline, LSP, or `AppContainer`.
|
||||
`AppContainer` is not a PBS composition root. It may call
|
||||
`FrontendRegistryService.bootstrapDefaults()`. It must not instantiate PBS
|
||||
types.
|
||||
|
||||
### Real in-repo consumer
|
||||
|
||||
A new interface, module, SPI, generator, or framework is allowed only when
|
||||
a real in-repo consumer exists. In this phase that consumer is one of:
|
||||
|
||||
- the PBS product frontend;
|
||||
- the `synth` test frontend;
|
||||
- a second product frontend accepted by its own decision.
|
||||
|
||||
"For a future language", "for the marketplace", or "when we have plugins"
|
||||
is not a consumer.
|
||||
|
||||
`FrontendProvider`, `IRBackend`, common lifecycle assembly, and test-only
|
||||
ArchUnit are not premature. They already have consumers.
|
||||
|
||||
### Forbidden in this phase
|
||||
|
||||
Until a later decision authorizes it with a real consumer, do not introduce:
|
||||
|
||||
1. dynamic frontend discovery (plugin, `ServiceLoader`, scan, external JAR,
|
||||
runtime install);
|
||||
2. RPC, sockets, a process supervisor, or version negotiation between
|
||||
compiler and frontend;
|
||||
3. a marketplace, hot reload, or frontend sandbox;
|
||||
4. a validator-core or generic validation framework;
|
||||
5. an SDK schema/generator or `HOSTCALLS.csv` as canonical ABI (LSN-0064);
|
||||
6. a product module `frontends/synth`;
|
||||
7. an injected `Registry`, or `AppContainer` as the PBS composition root.
|
||||
|
||||
This list is not a monorepo-wide simplicity charter. It does not govern
|
||||
JavaFX, packer, or LSP protocol design. Owner is `compiler/general`, with
|
||||
impact on `studio` on the multi-frontend axis.
|
||||
|
||||
### Neighbors stay closed
|
||||
|
||||
Do not reinterpret, relax, "simplify", or reimplement:
|
||||
|
||||
- provider/registry (LSN-0055 / spec 23 §8.3);
|
||||
- common lifecycle;
|
||||
- console ABI / PBS delivery;
|
||||
- `synth`;
|
||||
- ArchUnit / PBS module identity.
|
||||
|
||||
Using this policy to keep `new PBSFrontendPhaseService()` (or equivalent)
|
||||
in common code is refused. That is PBS recoupling, not simplicity.
|
||||
|
||||
A second product frontend needs its own decision. This lesson neither
|
||||
replaces that decision nor blocks it.
|
||||
|
||||
## Final Implementation
|
||||
|
||||
No production Java, Gradle, spec, or ArchUnit file changed.
|
||||
|
||||
The map above is the implementation. Future compiler/studio plans on this
|
||||
axis should cite it when they propose a new module, SPI, or discovery
|
||||
mechanism.
|
||||
|
||||
Code that already matches the phase:
|
||||
|
||||
- `FrontendProvider` exposes `specification()`, `compiler()`, and optional
|
||||
`languageService()`;
|
||||
- `FrontendRegistryService.bootstrapDefaults()` registers PBS only;
|
||||
- `AppContainer` only calls that bootstrap;
|
||||
- `synth` lives in build-pipeline test sources;
|
||||
- ArchUnit lives in `:prometeu-architecture-tests`.
|
||||
|
||||
## Examples
|
||||
|
||||
Good:
|
||||
|
||||
- add a method to `FrontendProvider` because PBS or `synth` cannot compile
|
||||
or register without it;
|
||||
- keep `unregister` on the static registry so `synth` tests can clean up;
|
||||
- reject a proposal to load language JARs from a plugin directory.
|
||||
|
||||
Bad:
|
||||
|
||||
- inject `Registry` into `BuilderPipelineService` because static state looks
|
||||
like a service locator;
|
||||
- create `frontends/synth` as a product module;
|
||||
- add validator-core "so the next language has somewhere to put checks";
|
||||
- keep `new PBSFrontendPhaseService()` in pipeline code and call that
|
||||
simpler than going through the provider.
|
||||
|
||||
## Pitfalls
|
||||
|
||||
- The original agenda order ("before the other agendas") is historical.
|
||||
Do not reopen DSC-0054..DSC-0064 to satisfy it.
|
||||
- Static registry plus explicit `register`/`unregister` is visible. Hidden
|
||||
`ServiceLoader` discovery is not the same thing.
|
||||
- A second product frontend *is* a real consumer. Do not use this lesson to
|
||||
refuse that frontend; use it to refuse infrastructure that frontend does
|
||||
not yet need.
|
||||
- Spec 23 already forbids plugin discovery. Do not duplicate it. Do not
|
||||
treat silence in spec 23 as permission for RPC or validator-core.
|
||||
- Simplicity does not mean PBS may leak into common modules. LSN-0066 still
|
||||
owns that boundary.
|
||||
|
||||
## References
|
||||
|
||||
- Decision: `DEC-0051`
|
||||
- Plan: `PLN-0130`
|
||||
- Related lessons: `LSN-0055`, `LSN-0060`, `LSN-0063`, `LSN-0064`,
|
||||
`LSN-0065`, `LSN-0066`
|
||||
- `docs/specs/compiler/23. Compiler Pipeline Entry Points Specification.md`
|
||||
(§2, §8.3)
|
||||
- `prometeu-compiler/prometeu-frontend-registry/src/main/java/p/studio/compiler/FrontendRegistryService.java`
|
||||
- `prometeu-compiler/prometeu-frontend-api/src/main/java/p/studio/compiler/services/FrontendProvider.java`
|
||||
- `prometeu-app/src/main/java/p/studio/AppContainer.java`
|
||||
@@ -1,87 +0,0 @@
|
||||
---
|
||||
id: AGD-0005
|
||||
ticket: variable-tile-bank-palette-serialization
|
||||
title: Variable Tile Bank Palette Serialization
|
||||
status: open
|
||||
created: 2026-03-26
|
||||
resolved:
|
||||
decision:
|
||||
tags:
|
||||
- packer
|
||||
- legacy-import
|
||||
- tile-bank
|
||||
- palette-serialization
|
||||
- versioning
|
||||
---
|
||||
|
||||
## Pain
|
||||
|
||||
The current tile-bank contract serializes a fixed block of `64` palettes in v1 even when an asset authors far fewer palettes.
|
||||
|
||||
That keeps decoding simple, but it wastes cartridge space and leaves the system with a deliberate mismatch between authored and serialized palette counts.
|
||||
|
||||
## Context
|
||||
|
||||
Legacy source: `docs/packer/agendas/Variable Tile Bank Palette Serialization Agenda.md`
|
||||
|
||||
Domain owner: `docs/packer`
|
||||
Cross-domain dependency:
|
||||
|
||||
- runtime
|
||||
|
||||
Current aligned v1 contract:
|
||||
|
||||
- pixels are serialized as packed `u4`;
|
||||
- palettes are serialized as `RGB565 u16`;
|
||||
- `palette_count = 64`;
|
||||
- payload size includes a fixed `64 * 16 * 2` palette block.
|
||||
|
||||
The packer now exposes:
|
||||
|
||||
- `metadata.palette_count = 64`
|
||||
- `metadata.palette_authored = <actual authored count>`
|
||||
|
||||
## Open Questions
|
||||
|
||||
- [ ] Should variable palette serialization arrive as a new payload version or as an incompatible change to the current one?
|
||||
- [ ] If `palette_count` becomes variable, should runtime still materialize a 64-slot resident bank, or truly shrink in-memory representation too?
|
||||
- [ ] Should sparse authored palette indices remain sparse in serialization, or be canonicalized into a dense runtime block?
|
||||
- [ ] Which domain owns compatibility for existing cartridges: `packer`, `runtime`, or `shipper`?
|
||||
|
||||
## Options
|
||||
|
||||
### Option A - Keep fixed 64-palette serialization
|
||||
- **Approach:** Preserve the current fixed v1 payload with zero-filled unused palette slots.
|
||||
- **Pro:** No runtime change and current specs/tests remain stable.
|
||||
- **Con:** Every glyph bank keeps paying the full palette cost.
|
||||
- **Maintainability:** Medium.
|
||||
|
||||
### Option B - Move to variable palette serialization now
|
||||
- **Approach:** Serialize only authored palettes and shrink payload size immediately.
|
||||
- **Pro:** Better cartridge efficiency and tighter semantics for `palette_count`.
|
||||
- **Con:** Reopens a just-stabilized cross-domain runtime contract and forces compatibility decisions now.
|
||||
- **Maintainability:** Medium if done carefully, risky if done incidentally.
|
||||
|
||||
### Option C - Keep v1 fixed and design variable serialization for v2
|
||||
- **Approach:** Preserve v1 stability now and open a later versioned follow-up for variable palette serialization.
|
||||
- **Pro:** Keeps current work stable while preserving a clean path for future optimization.
|
||||
- **Con:** Known waste remains in v1.
|
||||
- **Maintainability:** Strong.
|
||||
|
||||
## Discussion
|
||||
|
||||
The retained agenda recommendation is already clear: the waste is real, but it is not a correctness bug, and reopening the runtime-facing contract immediately would mix optimization work into a freshly stabilized path.
|
||||
|
||||
That makes versioned follow-up a cleaner vehicle than incidental mutation of the current contract.
|
||||
|
||||
## Resolution
|
||||
|
||||
Recommended direction: adopt **Option C**.
|
||||
|
||||
Imported retained recommendation:
|
||||
|
||||
1. keep the current fixed 64-palette contract for v1;
|
||||
2. if variable serialization is desired, design it explicitly as a versioned follow-up;
|
||||
3. treat compatibility, runtime representation, and sparse-vs-dense palette identity as explicit next-wave questions rather than silent payload tweaks.
|
||||
|
||||
Next step suggestion: if the team wants to remove the fixed padding, open the corresponding runtime-side discussion and close the versioning/compatibility story before planning implementation.
|
||||
@@ -1,207 +0,0 @@
|
||||
---
|
||||
id: AGD-0038
|
||||
ticket: pbs-lsp-editor-assistance-wave-1
|
||||
title: Wave 1 de assistencia editorial via LSP para PBS no VS Code
|
||||
status: accepted
|
||||
created: 2026-05-08
|
||||
resolved: 2026-05-08
|
||||
decision: DEC-0035
|
||||
tags: [studio, lsp, vscode, compiler, compiler-pbs, editor, completion, hover, signature-help]
|
||||
---
|
||||
|
||||
## Pain
|
||||
|
||||
O stack atual de PBS no VS Code ja entrega duas capacidades relevantes:
|
||||
|
||||
- diagnostics basicos;
|
||||
- semantic highlighting com tema frontend-owned.
|
||||
|
||||
Mas ele ainda nao entrega o minimo de assistencia editorial para um fluxo real de escrita de codigo:
|
||||
|
||||
- nao existe `completion`;
|
||||
- `hover` ainda eh placeholder;
|
||||
- nao existe `signature help`.
|
||||
|
||||
Sem isso, o editor continua servindo mais como viewer colorido com erros do que como ambiente minimamente utilizavel para escrever PBS com conforto.
|
||||
|
||||
## Context
|
||||
|
||||
Domain owner: `studio`
|
||||
|
||||
Subdomains touched:
|
||||
|
||||
- `studio/lsp`
|
||||
- `compiler/pbs`
|
||||
- `compiler/general`
|
||||
|
||||
Estado atual observado no codigo:
|
||||
|
||||
- o servidor anuncia `hover` e `semanticTokens`, mas nao anuncia `completionProvider`, `signatureHelpProvider` ou `documentFormattingProvider`;
|
||||
- o bridge interno do LSP so expõe `describeServer`, `analyzeDocument`, `hover`, `semanticTokens` e `onSave`;
|
||||
- `hover` hoje retorna texto fixo, sem usar simbolo, assinatura, tipo ou docs;
|
||||
- o pipeline do compiler ja consegue analisar overlay do documento e possui superficies semanticas e de linking relevantes no PBS;
|
||||
- o highlighting recente ja resolve bastante informacao lexical e parte da superficie stdlib/imports.
|
||||
|
||||
Esta agenda trata apenas da wave 1 de assistencia editorial.
|
||||
Ela nao tenta fechar todo o problema de IDE features.
|
||||
|
||||
## Open Questions
|
||||
|
||||
- Qual deve ser o escopo minimo de `completion` para chamarmos essa wave de utilizavel?
|
||||
- [x] Qual deve ser o escopo minimo de `completion` para chamarmos essa wave de utilizavel?
|
||||
R: keywords, nomes locais em escopo, simbolos importados/publicos, e members apos `.` para superfícies reconhecidas (`service`, `host`, `builtin type`, `struct` e constructors/funcoes relacionados). Sem isso, a feature ainda nao ajuda na descoberta real da API.
|
||||
- `completion` deve nascer apenas com heuristicas lexicais/sintaticas, ou ja deve usar semantica e linking do compiler onde isso for viavel?
|
||||
- [x] `completion` deve nascer apenas com heuristicas lexicais/sintaticas, ou ja deve usar semantica e linking do compiler onde isso for viavel?
|
||||
R: deve nascer compiler-backed sempre que a informacao ja existir de forma confiavel no pipeline semantico/linking. Heuristica local pode existir apenas como complemento estritamente limitado para casos ainda nao resolvidos, nunca como segunda semantica canônica.
|
||||
- Em `hover`, quais informacoes sao obrigatorias na primeira entrega:
|
||||
assinatura, kind, modulo de origem, tipo inferido, documentacao?
|
||||
- [x] Em `hover`, quais informacoes sao obrigatorias na primeira entrega:
|
||||
assinatura, kind, modulo de origem, tipo inferido, documentacao?
|
||||
R: obrigatorios: `kind`, assinatura quando aplicavel, modulo/origem quando relevante, e tipo/shape basico quando houver. Documentacao textual eh desejavel para stdlib e builtins, mas nao deve bloquear a wave 1 se a infraestrutura de docstring ainda nao existir. Se a linguagem vier a adotar algo como `Document(...)` com markdown pronto para hover, isso deve nascer em discussao propria; nesta wave atual, basta preparar o local de consumo para documentacao opcional quando ela existir.
|
||||
- `signature help` deve usar a mesma fonte semantica de `hover/completion`, ou pode nascer numa implementacao mais local para chamadas conhecidas?
|
||||
- [x] `signature help` deve usar a mesma fonte semantica de `hover/completion`, ou pode nascer numa implementacao mais local para chamadas conhecidas?
|
||||
R: deve usar a mesma base semantica. O objetivo da wave eh justamente evitar tres caminhos tecnicos diferentes para responder "qual assinatura esta sendo chamada?".
|
||||
- Como tratar membros de stdlib, aliases importados, services, hosts, builtin types e metodos de struct sem criar uma segunda semantica paralela no LSP?
|
||||
- [x] Como tratar membros de stdlib, aliases importados, services, hosts, builtin types e metodos de struct sem criar uma segunda semantica paralela no LSP?
|
||||
R: o LSP deve perguntar ao compiler por uma superficie editorial/resolutiva unica, derivada das mesmas fontes usadas para analise, linking, stdlib e metadata do frontend. O LSP nao deve reconstruir manualmente tabelas paralelas de membros.
|
||||
- Esta wave deve incluir `go to definition`, ou isso deve ficar explicitamente fora do escopo para nao diluir a entrega?
|
||||
- [x] Esta wave deve incluir `go to definition`, ou isso deve ficar explicitamente fora do escopo para nao diluir a entrega?
|
||||
R: deve ficar fora do escopo desta wave. Ele eh um proximo passo natural, mas nao eh requisito para chamar `completion + hover + signature help` de minimamente utilizaveis.
|
||||
- Formatacao e identacao automatica devem ficar fora desta agenda como non-goal explicito?
|
||||
- [x] Formatacao e identacao automatica devem ficar fora desta agenda como non-goal explicito?
|
||||
R: sim. Podem virar discussao/plan posterior. Nesta wave, elas seriam custo adicional sem impacto proporcional comparado a completion/hover/signature help.
|
||||
|
||||
## Options
|
||||
|
||||
### Option A - Completion e hover por heuristica leve, com signature help posterior
|
||||
|
||||
- **Approach:** implementar `completion` usando contexto local, imports, keywords e alguns casos de member access, implementar `hover` com informacao minima, e deixar `signature help` para uma wave seguinte.
|
||||
- **Pro:** menor custo inicial e menor risco de travar na arquitetura semantica.
|
||||
- **Con:** pode criar uma primeira entrega inconsistente, especialmente em chamadas de stdlib e tipos importados, e pode forcar refactor cedo demais depois.
|
||||
- **Maintainability:** media.
|
||||
|
||||
### Option B - Wave 1 coerente com completion, hover e signature help sobre uma mesma base semantica
|
||||
|
||||
- **Approach:** desenhar uma pequena superficie de assistencia editorial no LSP que use uma base comum para resolver simbolos, membros e assinaturas. Entregar juntos:
|
||||
- completion minimo utilizavel;
|
||||
- hover real;
|
||||
- signature help em chamadas.
|
||||
- **Pro:** evita duplicacao conceitual e produz uma experiencia de editor mais consistente desde a primeira wave.
|
||||
- **Con:** custo maior de desenho e implementacao agora.
|
||||
- **Maintainability:** forte.
|
||||
|
||||
### Option C - Adiar assistencia semantica e depender do VS Code + snippets
|
||||
|
||||
- **Approach:** manter diagnostics e colors como estao, adicionar no maximo snippets ou pequenas ajudas na extensao.
|
||||
- **Pro:** quase nenhum custo de backend.
|
||||
- **Con:** nao resolve o problema real; o editor continua insuficiente para escrita cotidiana de PBS.
|
||||
- **Maintainability:** fraca.
|
||||
|
||||
## Tradeoffs
|
||||
|
||||
Option C nao fecha a dor real e deve ser descartada.
|
||||
|
||||
Option A parece atraente para ganhar velocidade, mas carrega um risco ruim:
|
||||
|
||||
- introduzir `completion`, `hover` e depois `signature help` por caminhos tecnicos diferentes;
|
||||
- duplicar logica entre parser local, heuristicas e linking;
|
||||
- e transformar a wave 2 num retrabalho de consolidacao.
|
||||
|
||||
Option B custa mais, mas o custo eh justificavel porque estas tres features se apoiam nas mesmas perguntas:
|
||||
|
||||
- o que este simbolo representa?
|
||||
- quais membros ele expõe?
|
||||
- qual eh a assinatura desta chamada?
|
||||
- qual o modulo/origem deste item?
|
||||
|
||||
Se essas perguntas forem respondidas por uma base comum, a wave 1 fica mais coerente e abre caminho natural para futuras features como `definition`, `references` e `inlay hints` via LSP.
|
||||
|
||||
## Recommendation
|
||||
|
||||
Seguir com **Option B**.
|
||||
|
||||
A recomendacao eh abrir uma wave 1 coerente de assistencia editorial com:
|
||||
|
||||
- `completion` minimo utilizavel;
|
||||
- `hover` funcional;
|
||||
- `signature help` funcional.
|
||||
|
||||
Escopo minimo recomendado para `completion`:
|
||||
|
||||
- keywords;
|
||||
- simbolos locais em escopo;
|
||||
- nomes importados/publicos relevantes;
|
||||
- members apos `.` para stdlib, builtin types, structs e services/hosts reconhecidos.
|
||||
|
||||
Escopo minimo recomendado para `hover`:
|
||||
|
||||
- kind do simbolo;
|
||||
- assinatura quando aplicavel;
|
||||
- modulo/origem quando relevante;
|
||||
- tipo ou shape basico quando isso existir de forma confiavel.
|
||||
|
||||
Escopo minimo recomendado para `signature help`:
|
||||
|
||||
- chamadas de funcao/metodo/construtor;
|
||||
- parametro ativo;
|
||||
- labels consistentes com a mesma representacao de assinatura usada no hover.
|
||||
|
||||
## Discussion
|
||||
|
||||
O ponto principal desta agenda nao eh “adicionar IDE features” genericamente.
|
||||
|
||||
O ponto principal eh definir a primeira wave de superfícies de assistencia que tiram o PBS no VS Code do estado de:
|
||||
|
||||
- diagnostics + coloracao
|
||||
|
||||
para um estado de:
|
||||
|
||||
- escrita assistida minima, com descoberta de API e leitura de assinatura.
|
||||
|
||||
Isso exige disciplina de boundary.
|
||||
|
||||
O VS Code extension nao deve inventar semantica local.
|
||||
O servidor LSP deve continuar sendo o owner da assistencia editorial.
|
||||
|
||||
Da mesma forma, o LSP nao deve criar uma semantica paralela desconectada do compiler se ja existe informacao aproveitavel em parser, linking, stdlib e superficies semanticas do PBS.
|
||||
|
||||
Tambem vale explicitar o que fica fora desta agenda:
|
||||
|
||||
- formatter completo;
|
||||
- identacao automatica robusta de documento;
|
||||
- quick fixes;
|
||||
- definition/references;
|
||||
- rename;
|
||||
- code actions mais amplas.
|
||||
|
||||
Esses itens podem virar agenda posterior.
|
||||
|
||||
Tambem fica registrado um criterio importante de arquitetura:
|
||||
|
||||
- o primeiro passo nao eh encher o protocolo de features;
|
||||
- o primeiro passo eh criar uma base editorial coerente no lado `compiler/pbs` + `studio/lsp` que consiga responder simbolo, members e assinatura;
|
||||
- `completion`, `hover` e `signature help` sao projeções diferentes sobre a mesma base.
|
||||
|
||||
E um criterio adicional de preparacao editorial:
|
||||
|
||||
- a wave 1 deve prever um campo/superficie opcional de documentacao no modelo editorial resolvido por simbolo;
|
||||
- mas a autoria dessa documentacao na linguagem PBS, inclusive eventual anotacao `Document(...)` com markdown, fica fora desta agenda e pode seguir para discussao separada.
|
||||
|
||||
## Resolution
|
||||
|
||||
Resolucao preliminar:
|
||||
|
||||
- a wave 1 deve ser considerada valida quando o VS Code conseguir oferecer descoberta minima de API, leitura de assinatura e ajuda em chamadas sem depender de conhecimento local na extensao;
|
||||
- `completion`, `hover` e `signature help` devem nascer sobre uma mesma base compiler-backed;
|
||||
- `go to definition`, formatter e outras features de IDE ficam explicitamente fora do escopo.
|
||||
|
||||
Se esta leitura fizer sentido, o proximo passo eh aceitar a agenda e fechar uma `decision` que:
|
||||
|
||||
1. defina o escopo normativo exato de `completion`, `hover` e `signature help`;
|
||||
2. fixe o boundary entre `compiler/pbs`, `studio/lsp` e `tools/vscode-extension`;
|
||||
3. declare explicitamente os non-goals desta wave;
|
||||
4. determine se a base deve nascer compiler-backed desde o inicio ou com alguma heuristica local estritamente limitada.
|
||||
|
||||
## Next Step
|
||||
|
||||
Se voce concordar com o enquadramento, eu converto esta agenda em `accepted` e escrevo a `decision` normativa da wave 1 de assistencia editorial para PBS no VS Code.
|
||||
@@ -1,137 +0,0 @@
|
||||
---
|
||||
id: AGD-0039
|
||||
ticket: pbs-symbol-documentation-and-hover-markdown
|
||||
title: Modelo de documentacao de simbolos em PBS e consumo markdown no hover
|
||||
status: open
|
||||
created: 2026-05-08
|
||||
tags: [compiler, compiler-pbs, studio, lsp, vscode, editor, hover, documentation, markdown]
|
||||
---
|
||||
|
||||
## Pain
|
||||
|
||||
A wave atual de assistencia editorial quer `hover` util, mas ainda nao existe um modelo claro para documentacao authored dentro de PBS.
|
||||
|
||||
Sem esse modelo, o hover pode até mostrar:
|
||||
|
||||
- kind;
|
||||
- assinatura;
|
||||
- origem;
|
||||
- tipo/shape.
|
||||
|
||||
Mas continua sem uma superficie limpa para explicar intencao de uso, contrato semantico, detalhes de parametros ou observacoes de API.
|
||||
|
||||
Hoje a ideia proposta eh algo como:
|
||||
|
||||
- `Document(qualquer markdown aqui dentro...)`
|
||||
|
||||
como anotacao consumida diretamente pelo hover.
|
||||
|
||||
Isso parece simples no uso, mas toca em decisoes de linguagem e contrato editorial que merecem discussao propria.
|
||||
|
||||
## Context
|
||||
|
||||
Domain owner: `compiler/pbs`
|
||||
|
||||
Subdomains touched:
|
||||
|
||||
- `compiler/general`
|
||||
- `studio/lsp`
|
||||
- `tools/vscode-extension`
|
||||
|
||||
Esta agenda eh deliberadamente separada de `AGD-0038`.
|
||||
|
||||
Razao:
|
||||
|
||||
- `AGD-0038` trata da wave 1 de `completion`, `hover` e `signature help`;
|
||||
- esta nova agenda trata da autoria, armazenamento, propagacao e consumo de documentacao de simbolos.
|
||||
|
||||
O objetivo eh evitar que a primeira wave de assistencia editorial fique bloqueada por uma decisao de linguagem ainda nao fechada.
|
||||
|
||||
## Open Questions
|
||||
|
||||
- A autoria da documentacao deve acontecer por anotacao explicita como `Document(...)`, por comentario estruturado, ou por outro mecanismo?
|
||||
- O payload authored deve aceitar markdown arbitrario como fonte canonica, ou deve haver alguma normalizacao/restricao?
|
||||
- Quais simbolos podem carregar documentacao na wave inicial:
|
||||
funcoes, methods, services, hosts, builtin types, structs, enums, fields, constructors?
|
||||
- A documentacao deve viver no AST/semantics como superficie compiler-backed explicita?
|
||||
- Como a documentacao authored em PBS se relaciona com documentacao de stdlib gerada ou importada de outras fontes?
|
||||
- O hover deve consumir markdown pronto sem transformacao, ou deve haver um pipeline intermediario de sanitizacao/normalizacao?
|
||||
- Como tratar multilinhas, escaping e ergonomia de escrita se a surface for `Document(...)`?
|
||||
- A agenda deve definir apenas o modelo de autoria, ou tambem o transporte LSP e a composicao final do hover?
|
||||
|
||||
## Options
|
||||
|
||||
### Option A - Anotacao `Document(...)` com markdown como payload canonico
|
||||
|
||||
- **Approach:** introduzir uma anotacao explicita na linguagem PBS cujo conteudo ja eh markdown pronto para o hover.
|
||||
- **Pro:** autoria direta, intencao clara, pipeline simples de consumo no LSP e no hover.
|
||||
- **Con:** precisa desenhar sintaxe, escaping, multiline e regras de onde a anotacao eh permitida.
|
||||
- **Maintainability:** forte se a surface de linguagem ficar limpa.
|
||||
|
||||
### Option B - Comentarios estruturados como fonte de documentacao
|
||||
|
||||
- **Approach:** usar comentarios especiais ou doc-comments, com parser especifico para gerar documentacao de simbolo.
|
||||
- **Pro:** mais familiar para quem vem de outras linguagens e menos intrusivo no corpo semantico da linguagem.
|
||||
- **Con:** exige novo contrato de binding entre comentarios e simbolos, e pode aumentar ambiguidade editorial.
|
||||
- **Maintainability:** media.
|
||||
|
||||
### Option C - Nao definir autoria em PBS agora e suportar apenas docs de stdlib por metadata externa
|
||||
|
||||
- **Approach:** deixar a linguagem sem surface authored por enquanto e alimentar hover apenas com docs externas/geradas.
|
||||
- **Pro:** menor custo imediato de linguagem.
|
||||
- **Con:** resolve mal a autoria de codigo de usuario e deixa o modelo incompleto.
|
||||
- **Maintainability:** fraca.
|
||||
|
||||
## Tradeoffs
|
||||
|
||||
Option C nao parece suficiente como direcao de produto se a intencao eh ter hover realmente util para APIs authored em PBS.
|
||||
|
||||
Option B eh plausivel, mas move o problema para um binding entre comentario e simbolo que tambem precisa ser projetado com cuidado. Isso costuma parecer mais barato do que realmente eh.
|
||||
|
||||
Option A tem um custo claro de sintaxe e modelo, mas pelo menos deixa explicito que documentacao eh metadado semantico e nao apenas texto solto ao redor do codigo.
|
||||
|
||||
Se a equipe realmente quer markdown authored pronto para consumo no hover, Option A parece a discussao mais direta e honesta.
|
||||
|
||||
## Recommendation
|
||||
|
||||
Discutir esta agenda com viés inicial para **Option A**, mas sem fechar ainda a sintaxe final.
|
||||
|
||||
A recomendacao preliminar eh separar o problema em duas perguntas:
|
||||
|
||||
1. qual eh a surface canonical de autoria da documentacao em PBS?
|
||||
2. como essa documentacao vira um payload editorial resolvido para hover e futuros consumers?
|
||||
|
||||
Mesmo que `Document(...)` seja a direcao vencedora, a decisao deve deixar claro:
|
||||
|
||||
- onde ela pode ser usada;
|
||||
- qual formato textual aceita;
|
||||
- como ela eh preservada no compiler;
|
||||
- como chega ao LSP;
|
||||
- e como o hover deve compor isso com assinatura e metadados do simbolo.
|
||||
|
||||
## Discussion
|
||||
|
||||
Esta agenda nao deve ser reduzida a "mostrar markdown no hover".
|
||||
|
||||
O problema real eh definir ownership e boundary da documentacao:
|
||||
|
||||
- o author escreve onde?
|
||||
- o compiler preserva como?
|
||||
- o LSP transporta em qual shape?
|
||||
- o hover monta o resultado com qual ordem e responsabilidade?
|
||||
|
||||
Tambem vale observar que a escolha aqui pode influenciar mais do que hover:
|
||||
|
||||
- completions futuras podem querer `detail` e `documentation`;
|
||||
- signature help pode querer descricoes de parametros;
|
||||
- docs de stdlib podem querer surface unificada com docs authored.
|
||||
|
||||
Por isso, mesmo sendo uma agenda separada, ela conversa diretamente com a futura qualidade do editor.
|
||||
|
||||
## Resolution
|
||||
|
||||
Ainda em aberto.
|
||||
|
||||
## Next Step
|
||||
|
||||
Se o enquadramento fizer sentido, o proximo passo eh discutir as open questions e fechar uma `decision` propria para o modelo de documentacao de simbolos em PBS.
|
||||
@@ -0,0 +1,62 @@
|
||||
---
|
||||
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.
|
||||
@@ -0,0 +1,62 @@
|
||||
---
|
||||
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.
|
||||
@@ -0,0 +1,62 @@
|
||||
---
|
||||
id: AGD-0046
|
||||
ticket: pbs-lsp-rename-symbol
|
||||
title: PBS LSP Rename Symbol
|
||||
status: open
|
||||
created: 2026-07-15
|
||||
resolved:
|
||||
decision:
|
||||
tags: [studio, lsp, vscode, compiler-pbs, editor, rename]
|
||||
---
|
||||
|
||||
## Pain
|
||||
|
||||
Domain owner: `studio/lsp`
|
||||
|
||||
PBS users cannot safely rename a symbol through the editor, so they must edit text manually and risk missing references or changing unrelated overloads and same-name declarations.
|
||||
|
||||
## Context
|
||||
|
||||
Rename requires the same semantic identity and reference machinery needed by definition/references, plus workspace edits and conflict detection. The current LSP does not announce renameProvider.
|
||||
|
||||
## Open Questions
|
||||
|
||||
- [ ] Which symbols should be renameable in the first wave, and which should be protected such as stdlib, generated, host, or builtin declarations?
|
||||
- [ ] How should rename handle overloads, member methods, imports, and labels with the same text?
|
||||
- [ ] What validation should run before returning a WorkspaceEdit?
|
||||
|
||||
## Options
|
||||
|
||||
### Option A - Local file rename
|
||||
|
||||
- **Approach:** Rename only references in the current file using local semantic resolution.
|
||||
- **Pro:** Smaller blast radius and easier conflict handling.
|
||||
- **Con:** Incomplete for imported symbols and project-wide APIs.
|
||||
- **Maintainability:** Acceptable only if explicitly presented as limited.
|
||||
|
||||
### Option B - Workspace semantic rename
|
||||
|
||||
- **Approach:** Use a project-wide reference index and return a `WorkspaceEdit` for all usage and declaration sites.
|
||||
- **Pro:** Matches user expectations for editor rename.
|
||||
- **Con:** Requires reliable references, collision checks, and write-safety across files.
|
||||
- **Maintainability:** Strong once references exist.
|
||||
|
||||
## Tradeoffs
|
||||
|
||||
Rename is high trust. A partial or text-based rename can corrupt code silently, so scope must be explicit and conservative.
|
||||
|
||||
## Recommendation
|
||||
|
||||
Prefer Option B after semantic references are implemented. If delivered earlier, ship only a clearly limited local rename.
|
||||
|
||||
## Discussion
|
||||
|
||||
Do not implement rename before definition/references are resolved.
|
||||
|
||||
## Resolution
|
||||
|
||||
Ainda em aberto.
|
||||
|
||||
## Next Step
|
||||
|
||||
Decide whether rename waits for workspace references or ships a limited local-only wave.
|
||||
@@ -0,0 +1,62 @@
|
||||
---
|
||||
id: AGD-0047
|
||||
ticket: pbs-lsp-code-actions
|
||||
title: PBS LSP Code Actions and Quick Fixes
|
||||
status: open
|
||||
created: 2026-07-15
|
||||
resolved:
|
||||
decision:
|
||||
tags: [studio, lsp, vscode, compiler-pbs, editor, code-actions, quick-fix]
|
||||
---
|
||||
|
||||
## Pain
|
||||
|
||||
Domain owner: `studio/lsp`
|
||||
|
||||
PBS diagnostics are visible, but users do not get actionable quick fixes for common compiler/editor problems, making simple repairs slower than necessary.
|
||||
|
||||
## Context
|
||||
|
||||
The LSP maps diagnostics but does not announce codeActionProvider. Compiler diagnostics already carry codes and ranges, but not every diagnostic has enough structured repair data to generate safe edits.
|
||||
|
||||
## Open Questions
|
||||
|
||||
- [ ] Which diagnostics should receive quick fixes first?
|
||||
- [ ] Should code actions be produced from diagnostic codes only, or from structured compiler repair hints?
|
||||
- [ ] How should imports, reserved attributes, missing methods, and invalid Doc shapes be prioritized?
|
||||
|
||||
## Options
|
||||
|
||||
### Option A - Diagnostic-code quick fixes
|
||||
|
||||
- **Approach:** Map known diagnostic codes to simple edits in the LSP layer.
|
||||
- **Pro:** Fast for a small set of obvious repairs.
|
||||
- **Con:** Couples fixes to diagnostic text/ranges and can become brittle.
|
||||
- **Maintainability:** Moderate if limited to trivial edits.
|
||||
|
||||
### Option B - Compiler repair hints
|
||||
|
||||
- **Approach:** Extend diagnostics with structured repair metadata and let the LSP map hints to code actions.
|
||||
- **Pro:** Keeps product logic close to compiler knowledge.
|
||||
- **Con:** Requires a new diagnostic/repair contract.
|
||||
- **Maintainability:** Strong for non-trivial fixes and future frontends.
|
||||
|
||||
## Tradeoffs
|
||||
|
||||
Quick fixes are only useful if safe. Simple code-based fixes can ship first, but imports and generated stubs need stronger compiler context.
|
||||
|
||||
## Recommendation
|
||||
|
||||
Prefer Option B as the target design, with Option A allowed only for a small bootstrap set of unambiguous repairs.
|
||||
|
||||
## Discussion
|
||||
|
||||
This should follow diagnostics UX and import assistance for the first high-value fixes.
|
||||
|
||||
## Resolution
|
||||
|
||||
Ainda em aberto.
|
||||
|
||||
## Next Step
|
||||
|
||||
Pick the first three diagnostic codes eligible for safe quick fixes.
|
||||
@@ -0,0 +1,62 @@
|
||||
---
|
||||
id: AGD-0048
|
||||
ticket: pbs-lsp-formatting
|
||||
title: PBS LSP Formatting
|
||||
status: open
|
||||
created: 2026-07-15
|
||||
resolved:
|
||||
decision:
|
||||
tags: [studio, lsp, vscode, compiler-pbs, editor, formatting]
|
||||
---
|
||||
|
||||
## Pain
|
||||
|
||||
Domain owner: `studio/lsp`
|
||||
|
||||
PBS formatting is not automated, so style drifts across files, especially around attributes, services, blocks, imports, and multi-line Doc text blocks.
|
||||
|
||||
## Context
|
||||
|
||||
The LSP does not announce documentFormattingProvider. PBS has a parser and AST, but formatting must preserve documentation text block content while normalizing surrounding syntax and indentation.
|
||||
|
||||
## Open Questions
|
||||
|
||||
- [ ] Should formatting be AST-based, token-based, or hybrid to preserve comments and text blocks?
|
||||
- [ ] What canonical style should PBS use for attributes, braces, imports, params, and text blocks?
|
||||
- [ ] Should the first wave support full document formatting only, or also range/on-type formatting?
|
||||
|
||||
## Options
|
||||
|
||||
### Option A - Token-preserving formatter
|
||||
|
||||
- **Approach:** Format from tokens and trivia, preserving comments and documentation text block contents.
|
||||
- **Pro:** Safer for active editing and text blocks.
|
||||
- **Con:** Harder to enforce deep structural layout.
|
||||
- **Maintainability:** Good if PBS formatting remains mostly syntactic.
|
||||
|
||||
### Option B - AST pretty-printer
|
||||
|
||||
- **Approach:** Reprint code from the AST using canonical style rules.
|
||||
- **Pro:** Produces consistent output.
|
||||
- **Con:** Risks losing comments/trivia and cannot handle malformed files well.
|
||||
- **Maintainability:** Strong only after AST/trivia ownership is explicit.
|
||||
|
||||
## Tradeoffs
|
||||
|
||||
Formatting must not damage `Doc` text blocks. That makes trivia preservation a first-class requirement rather than an implementation detail.
|
||||
|
||||
## Recommendation
|
||||
|
||||
Prefer Option A or a hybrid token/AST formatter. Avoid a pure AST pretty-printer until comments/trivia are modeled.
|
||||
|
||||
## Discussion
|
||||
|
||||
Formatter decision should define canonical style before implementation.
|
||||
|
||||
## Resolution
|
||||
|
||||
Ainda em aberto.
|
||||
|
||||
## Next Step
|
||||
|
||||
Decide PBS canonical formatting rules for attributes, braces, imports, params, and text blocks.
|
||||
@@ -0,0 +1,62 @@
|
||||
---
|
||||
id: AGD-0049
|
||||
ticket: pbs-lsp-import-assistance
|
||||
title: PBS LSP Import Assistance
|
||||
status: open
|
||||
created: 2026-07-15
|
||||
resolved:
|
||||
decision:
|
||||
tags: [studio, lsp, vscode, compiler-pbs, editor, imports, completion]
|
||||
---
|
||||
|
||||
## Pain
|
||||
|
||||
Domain owner: `studio/lsp`
|
||||
|
||||
PBS users do not get import-aware assistance, so discovering exported symbols and adding the right import from barrels, stdlib, or project modules remains manual.
|
||||
|
||||
## Context
|
||||
|
||||
Completion already exists for local/editorial contexts, and stdlib imports are understood by the compiler pipeline. The LSP does not yet provide auto-import completion, organize imports, or import quick fixes.
|
||||
|
||||
## Open Questions
|
||||
|
||||
- [ ] Should auto-import target project modules, stdlib modules, or both in the first wave?
|
||||
- [ ] How should barrels and explicit module imports be ranked and rendered in completion?
|
||||
- [ ] Should organize imports be a code action, source action, formatter responsibility, or separate feature?
|
||||
|
||||
## Options
|
||||
|
||||
### Option A - Import completion only
|
||||
|
||||
- **Approach:** Suggest symbols from known modules and include import detail, but do not edit imports automatically.
|
||||
- **Pro:** Low risk and improves discovery.
|
||||
- **Con:** Still leaves manual import edits.
|
||||
- **Maintainability:** Good as a stepping stone.
|
||||
|
||||
### Option B - Auto-import and organize imports
|
||||
|
||||
- **Approach:** Completion/code actions insert missing imports and source actions sort/remove unused imports.
|
||||
- **Pro:** Matches modern editor expectations.
|
||||
- **Con:** Requires robust module export indexing and edit placement rules.
|
||||
- **Maintainability:** Strong if built on a proper import graph.
|
||||
|
||||
## Tradeoffs
|
||||
|
||||
Auto-import depends on knowing canonical exports and choosing an edit location. Doing that ad hoc in completion would create formatting and duplicate import issues.
|
||||
|
||||
## Recommendation
|
||||
|
||||
Prefer Option B as the target, but start with import-aware suggestions plus a limited missing-import quick fix.
|
||||
|
||||
## Discussion
|
||||
|
||||
This should be coordinated with code actions and formatter.
|
||||
|
||||
## Resolution
|
||||
|
||||
Ainda em aberto.
|
||||
|
||||
## Next Step
|
||||
|
||||
Decide first-wave import sources: stdlib only, project modules only, or both.
|
||||
@@ -0,0 +1,62 @@
|
||||
---
|
||||
id: AGD-0050
|
||||
ticket: pbs-lsp-semantic-tokens-semantic-classification
|
||||
title: PBS LSP Semantic Token Classification
|
||||
status: open
|
||||
created: 2026-07-15
|
||||
resolved:
|
||||
decision:
|
||||
tags: [studio, lsp, vscode, compiler-pbs, editor, semantic-tokens]
|
||||
---
|
||||
|
||||
## Pain
|
||||
|
||||
Domain owner: `studio/lsp`
|
||||
|
||||
PBS semantic highlighting exists, but parts of the token classification can remain lexical or superficial, which limits visual accuracy for same-looking identifiers with different semantic roles.
|
||||
|
||||
## Context
|
||||
|
||||
The current LSP announces full semantic tokens and maps frontend semantic presentation to VS Code. The compiler has semantic read surfaces that can classify symbols more accurately than raw tokenization.
|
||||
|
||||
## Open Questions
|
||||
|
||||
- [ ] Which token categories must become semantic identity-based first?
|
||||
- [ ] Should semantic tokens be produced from compiler semantic surfaces, parser AST, lexer tokens, or layered output?
|
||||
- [ ] How should tokens behave in files with syntax or semantic errors during active editing?
|
||||
|
||||
## Options
|
||||
|
||||
### Option A - Lexical tokens with semantic overlays
|
||||
|
||||
- **Approach:** Keep lexer-based tokenization as baseline and overlay semantic categories where resolution succeeds.
|
||||
- **Pro:** Stable during broken edits and incremental to improve.
|
||||
- **Con:** Some unresolved identifiers remain visually generic.
|
||||
- **Maintainability:** Strong because fallback behavior is explicit.
|
||||
|
||||
### Option B - Fully semantic token stream
|
||||
|
||||
- **Approach:** Generate all semantic tokens from compiler semantic surfaces.
|
||||
- **Pro:** Maximum accuracy when analysis succeeds.
|
||||
- **Con:** Highlighting may disappear or degrade sharply on incomplete code.
|
||||
- **Maintainability:** Risky unless snapshot/error recovery is excellent.
|
||||
|
||||
## Tradeoffs
|
||||
|
||||
Highlighting must be resilient while the user is typing. A perfect semantic pass that fails on partial code is worse than a layered model.
|
||||
|
||||
## Recommendation
|
||||
|
||||
Prefer Option A: lexical baseline plus semantic overlays from resolved symbols.
|
||||
|
||||
## Discussion
|
||||
|
||||
This can proceed independently but benefits from LSP snapshot/cache work.
|
||||
|
||||
## Resolution
|
||||
|
||||
Ainda em aberto.
|
||||
|
||||
## Next Step
|
||||
|
||||
Choose semantic overlay categories for the first pass.
|
||||
@@ -0,0 +1,62 @@
|
||||
---
|
||||
id: AGD-0051
|
||||
ticket: pbs-lsp-performance-cache-and-snapshots
|
||||
title: PBS LSP Performance Cache and Snapshots
|
||||
status: open
|
||||
created: 2026-07-15
|
||||
resolved:
|
||||
decision:
|
||||
tags: [studio, lsp, vscode, compiler-pbs, editor, performance, caching]
|
||||
---
|
||||
|
||||
## Pain
|
||||
|
||||
Domain owner: `studio/lsp`
|
||||
|
||||
Several PBS LSP requests rebuild or reanalyze substantial project state, which can become slow or jittery as projects grow and as richer features are added.
|
||||
|
||||
## Context
|
||||
|
||||
The current bridge favors correctness and simplicity by invoking compiler pipeline analysis for diagnostics and editorial documents. A complete LSP needs snapshot caching, invalidation, cancellation, and predictable latency.
|
||||
|
||||
## Open Questions
|
||||
|
||||
- [ ] What is the canonical project/document snapshot boundary for LSP requests?
|
||||
- [ ] Which requests can reuse semantic read surfaces safely across document changes?
|
||||
- [ ] How should cancellation, stale responses, and background reanalysis be handled?
|
||||
|
||||
## Options
|
||||
|
||||
### Option A - Request-local analysis
|
||||
|
||||
- **Approach:** Keep each LSP request self-contained and rebuild analysis as needed.
|
||||
- **Pro:** Simple, deterministic, and less stateful.
|
||||
- **Con:** Latency grows with project size and feature richness.
|
||||
- **Maintainability:** Good for correctness, weak for interactive performance.
|
||||
|
||||
### Option B - Project snapshot cache
|
||||
|
||||
- **Approach:** Maintain per-project analysis snapshots with document overlays, invalidation, and cancellation-aware request handling.
|
||||
- **Pro:** Required for responsive definition, references, rename, and semantic tokens.
|
||||
- **Con:** Introduces lifecycle complexity and stale-result risks.
|
||||
- **Maintainability:** Strong if snapshot ownership and invalidation are explicit.
|
||||
|
||||
## Tradeoffs
|
||||
|
||||
A complete LSP needs shared state, but shared state must not leak stale analysis into edits. The decision is about the boundary, not just caching.
|
||||
|
||||
## Recommendation
|
||||
|
||||
Prefer Option B before implementing workspace-wide features like references and rename.
|
||||
|
||||
## Discussion
|
||||
|
||||
Define snapshot lifecycle, invalidation triggers, and cancellation policy.
|
||||
|
||||
## Resolution
|
||||
|
||||
Ainda em aberto.
|
||||
|
||||
## Next Step
|
||||
|
||||
Decide whether snapshot caching is a prerequisite for references/rename or can be staged later.
|
||||
@@ -0,0 +1,62 @@
|
||||
---
|
||||
id: AGD-0052
|
||||
ticket: pbs-lsp-completion-depth
|
||||
title: PBS LSP Completion Depth
|
||||
status: open
|
||||
created: 2026-07-15
|
||||
resolved:
|
||||
decision:
|
||||
tags: [studio, lsp, vscode, compiler-pbs, editor, completion]
|
||||
---
|
||||
|
||||
## Pain
|
||||
|
||||
Domain owner: `studio/lsp`
|
||||
|
||||
PBS completion works for core cases, but a complete daily-use experience needs ranking, resolve details, snippets, overload handling, context-aware suggestions, and richer documentation.
|
||||
|
||||
## Context
|
||||
|
||||
The current LSP announces completion with trigger character '.' and returns detail/documentation for resolved compiler candidates. It does not use resolveProvider, snippets, broad trigger contexts, or advanced ranking.
|
||||
|
||||
## Open Questions
|
||||
|
||||
- [ ] Which completion contexts should be supported first beyond member access?
|
||||
- [ ] Should completion use resolveProvider for expensive documentation/details or return everything eagerly?
|
||||
- [ ] How should overloads, snippets, imports, keywords, and stdlib candidates be ranked?
|
||||
|
||||
## Options
|
||||
|
||||
### Option A - Eager rich completion
|
||||
|
||||
- **Approach:** Return labels, details, docs, and snippets directly in every completion response.
|
||||
- **Pro:** Simple client behavior and immediate docs.
|
||||
- **Con:** Can become expensive for broad/global completion.
|
||||
- **Maintainability:** Good while candidate sets remain small.
|
||||
|
||||
### Option B - Completion resolve provider
|
||||
|
||||
- **Approach:** Return lightweight candidates first and populate expensive docs/details through `completionItem/resolve`.
|
||||
- **Pro:** Scales better for large candidate sets and import-aware suggestions.
|
||||
- **Con:** Requires client/server resolve plumbing and stable candidate identities.
|
||||
- **Maintainability:** Strong for a full LSP.
|
||||
|
||||
## Tradeoffs
|
||||
|
||||
The current eager model is fine for scoped completions, but global/import-aware completion may need resolve to avoid latency.
|
||||
|
||||
## Recommendation
|
||||
|
||||
Prefer a staged approach: keep eager for current contexts, design resolve before broad workspace/import completion.
|
||||
|
||||
## Discussion
|
||||
|
||||
Define completion contexts and ranking before adding snippets or resolve.
|
||||
|
||||
## Resolution
|
||||
|
||||
Ainda em aberto.
|
||||
|
||||
## Next Step
|
||||
|
||||
List first-wave completion contexts beyond member access.
|
||||
@@ -0,0 +1,62 @@
|
||||
---
|
||||
id: AGD-0053
|
||||
ticket: pbs-lsp-folding-and-selection-ranges
|
||||
title: PBS LSP Folding and Selection Ranges
|
||||
status: open
|
||||
created: 2026-07-15
|
||||
resolved:
|
||||
decision:
|
||||
tags: [studio, lsp, vscode, compiler-pbs, editor, folding, selection-range]
|
||||
---
|
||||
|
||||
## Pain
|
||||
|
||||
Domain owner: `studio/lsp`
|
||||
|
||||
PBS users do not get structural folding or smart selection ranges, so navigating and selecting nested functions, blocks, services, attributes, and Doc text blocks is more manual than it should be.
|
||||
|
||||
## Context
|
||||
|
||||
The parser knows syntactic spans for declarations and blocks. The LSP currently does not announce foldingRangeProvider or selectionRangeProvider.
|
||||
|
||||
## Open Questions
|
||||
|
||||
- [ ] Should folding ranges be computed from AST spans, token pairs, or a hybrid that handles malformed files?
|
||||
- [ ] Which constructs should fold in the first wave: imports, declarations, blocks, attributes, text blocks, or all of them?
|
||||
- [ ] What selection range hierarchy should VS Code expose for identifiers, calls, params, blocks, and declarations?
|
||||
|
||||
## Options
|
||||
|
||||
### Option A - Parser span ranges
|
||||
|
||||
- **Approach:** Use AST spans for declarations, blocks, parameter lists, and text blocks.
|
||||
- **Pro:** Accurate for well-formed code and easy to map to LSP ranges.
|
||||
- **Con:** Can degrade when parsing fails mid-file.
|
||||
- **Maintainability:** Good because parser owns structure.
|
||||
|
||||
### Option B - Token pair scanning
|
||||
|
||||
- **Approach:** Compute ranges from brace/paren/text-block tokens without relying on full AST validity.
|
||||
- **Pro:** More resilient during malformed edits.
|
||||
- **Con:** Less semantically meaningful and can produce noisy ranges.
|
||||
- **Maintainability:** Good only as fallback.
|
||||
|
||||
## Tradeoffs
|
||||
|
||||
Folding and selection should keep working while typing. AST ranges are higher quality, but token fallback may be needed for broken files.
|
||||
|
||||
## Recommendation
|
||||
|
||||
Prefer a hybrid: AST ranges first, token fallback for unmatched/incomplete constructs.
|
||||
|
||||
## Discussion
|
||||
|
||||
This is an editor UX feature with low semantic dependency and can be planned independently.
|
||||
|
||||
## Resolution
|
||||
|
||||
Ainda em aberto.
|
||||
|
||||
## Next Step
|
||||
|
||||
Decide first-wave foldable constructs and selection hierarchy.
|
||||
@@ -0,0 +1,62 @@
|
||||
---
|
||||
id: AGD-0054
|
||||
ticket: pbs-lsp-diagnostics-ux
|
||||
title: PBS LSP Diagnostics UX
|
||||
status: open
|
||||
created: 2026-07-15
|
||||
resolved:
|
||||
decision:
|
||||
tags: [studio, lsp, vscode, compiler-pbs, editor, diagnostics, ux]
|
||||
---
|
||||
|
||||
## Pain
|
||||
|
||||
Domain owner: `studio/lsp`
|
||||
|
||||
PBS diagnostics reach VS Code, but the editor experience can still be hard to act on when ranges, related information, severity, and phase context are too generic.
|
||||
|
||||
## Context
|
||||
|
||||
The LSP maps compiler diagnostics to LSP diagnostics. Compiler diagnostics include phase/code/message/range in several paths, but not all editor-friendly fields are consistently exposed.
|
||||
|
||||
## Open Questions
|
||||
|
||||
- [ ] Which diagnostics need better ranges or related information first?
|
||||
- [ ] Should diagnostic source include compiler phase, frontend, or both?
|
||||
- [ ] What structured diagnostic metadata is needed for future quick fixes without coupling UI to text messages?
|
||||
|
||||
## Options
|
||||
|
||||
### Option A - Mapper-only UX improvements
|
||||
|
||||
- **Approach:** Improve LSP diagnostic mapping using existing diagnostic fields.
|
||||
- **Pro:** Quick improvements to source, severity, and display consistency.
|
||||
- **Con:** Cannot add missing related spans or repair metadata that compiler diagnostics do not expose.
|
||||
- **Maintainability:** Good for presentation-only changes.
|
||||
|
||||
### Option B - Structured diagnostic contract
|
||||
|
||||
- **Approach:** Extend compiler diagnostics with editor-facing metadata such as phase, related locations, stable quick-fix hints, and refined ranges.
|
||||
- **Pro:** Enables better diagnostics and future code actions without parsing message text.
|
||||
- **Con:** Requires compiler/core diagnostic API changes.
|
||||
- **Maintainability:** Strong as the foundation for quick fixes and richer UX.
|
||||
|
||||
## Tradeoffs
|
||||
|
||||
Some improvements belong in the LSP mapper, but the most valuable changes require structured information at diagnostic creation time.
|
||||
|
||||
## Recommendation
|
||||
|
||||
Prefer Option B as the target, with mapper-only cleanup allowed for low-risk display fixes.
|
||||
|
||||
## Discussion
|
||||
|
||||
This agenda should inform code actions before quick fixes become broad.
|
||||
|
||||
## Resolution
|
||||
|
||||
Ainda em aberto.
|
||||
|
||||
## Next Step
|
||||
|
||||
Inventory high-frequency diagnostics and identify which need better ranges, related information, or repair hints.
|
||||
@@ -0,0 +1,62 @@
|
||||
---
|
||||
id: AGD-0055
|
||||
ticket: pbs-lsp-document-links
|
||||
title: PBS LSP Document Links
|
||||
status: open
|
||||
created: 2026-07-15
|
||||
resolved:
|
||||
decision:
|
||||
tags: [studio, lsp, vscode, compiler-pbs, editor, document-links, imports]
|
||||
---
|
||||
|
||||
## Pain
|
||||
|
||||
Domain owner: `studio/lsp`
|
||||
|
||||
PBS import/module references and asset-like surfaces are plain text in VS Code, so users cannot click through to imported modules or related project resources.
|
||||
|
||||
## Context
|
||||
|
||||
The compiler understands module references and project files. The LSP does not announce documentLinkProvider, and the VS Code extension delegates all language behavior to the server.
|
||||
|
||||
## Open Questions
|
||||
|
||||
- [ ] Which references should become document links first: imports, barrels, stdlib modules, assets/addressables, or docs?
|
||||
- [ ] How should virtual or stdlib resources be represented as link targets?
|
||||
- [ ] Should document links overlap with go-to-definition or remain a separate lightweight navigation feature?
|
||||
|
||||
## Options
|
||||
|
||||
### Option A - Import/module links only
|
||||
|
||||
- **Approach:** Expose `documentLink` for module references such as `@sdk:gfx` and barrel paths.
|
||||
- **Pro:** Narrow, useful, and mostly aligned with existing module resolution.
|
||||
- **Con:** Does not cover assets/addressables or documentation links.
|
||||
- **Maintainability:** Strong first wave.
|
||||
|
||||
### Option B - General resource links
|
||||
|
||||
- **Approach:** Link imports, stdlib modules, assets, addressables, and possibly documentation/resource surfaces.
|
||||
- **Pro:** Richer navigation across project resources.
|
||||
- **Con:** Requires resource-specific target policy and may overlap with definition.
|
||||
- **Maintainability:** Good only after resource ownership is defined.
|
||||
|
||||
## Tradeoffs
|
||||
|
||||
Document links should remain lightweight. If a link requires semantic identity and symbol resolution, it may belong in go-to-definition instead.
|
||||
|
||||
## Recommendation
|
||||
|
||||
Prefer Option A first: imports and module references only.
|
||||
|
||||
## Discussion
|
||||
|
||||
Coordinate stdlib target handling with go-to-definition.
|
||||
|
||||
## Resolution
|
||||
|
||||
Ainda em aberto.
|
||||
|
||||
## Next Step
|
||||
|
||||
Decide first-wave link targets and how stdlib/module URIs are represented.
|
||||
@@ -0,0 +1,62 @@
|
||||
---
|
||||
id: AGD-0056
|
||||
ticket: pbs-lsp-call-and-type-hierarchy
|
||||
title: PBS LSP Call and Type Hierarchy
|
||||
status: open
|
||||
created: 2026-07-15
|
||||
resolved:
|
||||
decision:
|
||||
tags: [studio, lsp, vscode, compiler-pbs, editor, call-hierarchy, type-hierarchy]
|
||||
---
|
||||
|
||||
## Pain
|
||||
|
||||
Domain owner: `studio/lsp`
|
||||
|
||||
PBS users cannot inspect call relationships or type/member relationships from the editor, which limits understanding of larger projects after basic navigation exists.
|
||||
|
||||
## Context
|
||||
|
||||
Call hierarchy and type hierarchy are advanced LSP features. They depend on reliable semantic identity, references, callsite classification, and type ownership surfaces, so they should probably follow definition/references rather than precede them.
|
||||
|
||||
## Open Questions
|
||||
|
||||
- [ ] Should call hierarchy and type hierarchy be one discussion or split after dependencies are clearer?
|
||||
- [ ] Which relationships are valuable for PBS: function call graph, service method calls, struct methods, contract implementations, host/intrinsic calls, or all of them?
|
||||
- [ ] What prerequisite symbol/reference infrastructure must be completed before this feature is safe to implement?
|
||||
|
||||
## Options
|
||||
|
||||
### Option A - Call hierarchy only
|
||||
|
||||
- **Approach:** Implement incoming/outgoing calls for functions and methods after callsite references are stable.
|
||||
- **Pro:** Directly useful and builds on executable call resolution.
|
||||
- **Con:** Does not cover type ownership, contracts, or implementations.
|
||||
- **Maintainability:** Strong if based on the reference/callsite index.
|
||||
|
||||
### Option B - Split call hierarchy and type hierarchy
|
||||
|
||||
- **Approach:** Treat call graph and type/member/contract hierarchy as separate decisions and implementations.
|
||||
- **Pro:** Avoids mixing two different semantic models.
|
||||
- **Con:** Creates more workflow artifacts and sequencing work.
|
||||
- **Maintainability:** Strong; each feature can evolve on its own contract.
|
||||
|
||||
## Tradeoffs
|
||||
|
||||
Call hierarchy and type hierarchy share LSP vocabulary but not the same compiler data. Coupling them too early would make the first implementation harder to reason about.
|
||||
|
||||
## Recommendation
|
||||
|
||||
Prefer Option B: split after this agenda confirms dependencies, likely implementing call hierarchy first.
|
||||
|
||||
## Discussion
|
||||
|
||||
This should wait until definition and references are complete.
|
||||
|
||||
## Resolution
|
||||
|
||||
Ainda em aberto.
|
||||
|
||||
## Next Step
|
||||
|
||||
Decide whether to split into two discussions before moving to decisions.
|
||||
@@ -1,192 +0,0 @@
|
||||
---
|
||||
id: DEC-0035
|
||||
ticket: pbs-lsp-editor-assistance-wave-1
|
||||
title: Wave 1 de assistencia editorial via LSP para PBS no VS Code
|
||||
status: accepted
|
||||
created: 2026-05-08
|
||||
accepted: 2026-05-08
|
||||
agenda: AGD-0038
|
||||
plans: [PLN-0075, PLN-0076, PLN-0077]
|
||||
tags: [studio, lsp, vscode, compiler, compiler-pbs, editor, completion, hover, signature-help]
|
||||
---
|
||||
|
||||
## Context
|
||||
|
||||
O stack atual de PBS no VS Code ja entrega diagnostics basicos e semantic highlighting frontend-owned, mas ainda nao oferece assistencia editorial minima para escrita cotidiana de codigo.
|
||||
|
||||
Hoje:
|
||||
|
||||
1. nao existe `completion`;
|
||||
2. `hover` existe apenas como placeholder;
|
||||
3. nao existe `signature help`;
|
||||
4. o servidor ainda nao anuncia capabilities correspondentes para essas superficies;
|
||||
5. o compiler e o frontend PBS ja possuem informacao semantica, de linking, stdlib e metadata suficiente para nao precisarmos inventar uma segunda semantica local na extensao.
|
||||
|
||||
Esta decisao trata apenas da primeira wave de assistencia editorial para PBS no VS Code.
|
||||
Ela nao cobre formatter, identacao automatica robusta, quick fixes, `go to definition`, `references`, `rename` nem code actions gerais.
|
||||
|
||||
## Decision
|
||||
|
||||
O repositório SHALL entregar uma wave 1 de assistencia editorial via LSP para PBS no VS Code com tres superfícies funcionais:
|
||||
|
||||
1. `completion`;
|
||||
2. `hover`;
|
||||
3. `signature help`.
|
||||
|
||||
Esta wave SHALL ser considerada valida quando essas tres superfícies permitirem:
|
||||
|
||||
1. descoberta minima de API;
|
||||
2. leitura de assinatura em simbolos e chamadas;
|
||||
3. ajuda de chamada sem dependencia de conhecimento semantico local na extensao VS Code.
|
||||
|
||||
Esta decisao ALSO locks que:
|
||||
|
||||
1. `completion`, `hover` e `signature help` MUST nascer sobre uma mesma base editorial compiler-backed;
|
||||
2. o LSP MUST ser o owner operacional da assistencia editorial;
|
||||
3. a extensao VS Code MUST atuar apenas como cliente/adaptador do protocolo, e MUST NOT reconstruir semantica propria para simbolos, members ou assinaturas;
|
||||
4. heuristicas locais no LSP MAY existir apenas como complemento temporario e estritamente limitado para lacunas nao resolvidas, mas MUST NOT virar uma segunda semantica canônica;
|
||||
5. `go to definition`, formatter, identacao automatica robusta, quick fixes, `references`, `rename` e code actions amplas MUST ficar fora desta wave.
|
||||
|
||||
## Rationale
|
||||
|
||||
As tres features desta wave respondem essencialmente ao mesmo conjunto de perguntas:
|
||||
|
||||
1. que simbolo eh este?
|
||||
2. quais members ele expõe?
|
||||
3. qual assinatura ele tem?
|
||||
4. de onde ele vem?
|
||||
|
||||
Implementa-las por caminhos tecnicos diferentes introduziria:
|
||||
|
||||
1. duplicacao entre parser local, heuristicas e linking;
|
||||
2. incoerencia entre o que aparece em `completion`, `hover` e `signature help`;
|
||||
3. retrabalho na wave seguinte.
|
||||
|
||||
Portanto, a primeira entrega precisa nascer sobre uma base editorial unificada, reaproveitando o que o compiler e o frontend PBS ja sabem sobre:
|
||||
|
||||
1. escopo local;
|
||||
2. imports e aliases;
|
||||
3. stdlib;
|
||||
4. builtin types;
|
||||
5. services, hosts, structs, enums, constructors, functions e methods.
|
||||
|
||||
## Technical Specification
|
||||
|
||||
### 1. Shared Editorial Resolution Surface
|
||||
|
||||
`compiler/pbs` e `studio/lsp` MUST introduzir uma superficie editorial resolvida comum para uso de `completion`, `hover` e `signature help`.
|
||||
|
||||
Essa superficie MUST ser capaz de responder, de forma compiler-backed:
|
||||
|
||||
1. identidade do simbolo;
|
||||
2. `kind` do simbolo;
|
||||
3. modulo/origem quando relevante;
|
||||
4. assinatura ou shape quando aplicavel;
|
||||
5. members disponíveis para receivers reconhecidos;
|
||||
6. documentacao opcional quando existir, sem bloquear esta wave.
|
||||
|
||||
Essa superficie MAY ser exposta por novos modelos internos do compiler, novos adapters no bridge do LSP, ou ambos.
|
||||
Mas ela MUST permanecer derivada do compiler e MUST NOT ser reautoriada na extensao.
|
||||
|
||||
### 2. Completion Scope
|
||||
|
||||
`completion` MUST ser entregue como superfície minima utilizavel.
|
||||
|
||||
Na wave 1, isso MUST cobrir pelo menos:
|
||||
|
||||
1. keywords da linguagem;
|
||||
2. nomes locais em escopo;
|
||||
3. simbolos importados/publicos relevantes;
|
||||
4. members apos `.` para superfícies reconhecidas, incluindo `service`, `host`, `builtin type`, `struct`, e call surfaces relacionadas.
|
||||
|
||||
`completion` SHOULD expor labels, kinds e detalhes coerentes com a mesma base usada por `hover`.
|
||||
|
||||
`completion` MUST NOT depender de tabela hardcoded na extensao para stdlib ou members de PBS.
|
||||
|
||||
### 3. Hover Scope
|
||||
|
||||
`hover` MUST deixar de ser placeholder e passar a ser simbolo-resolved.
|
||||
|
||||
Na wave 1, o hover MUST incluir quando disponivel:
|
||||
|
||||
1. `kind` do simbolo;
|
||||
2. assinatura quando aplicavel;
|
||||
3. modulo/origem quando relevante;
|
||||
4. tipo ou shape basico quando isso existir de forma confiavel.
|
||||
|
||||
`hover` MAY incluir documentacao textual opcional.
|
||||
Mas a autoria de documentacao em PBS, incluindo eventual anotacao como `Document(...)`, MUST seguir discussao separada e MUST NOT bloquear esta wave.
|
||||
|
||||
### 4. Signature Help Scope
|
||||
|
||||
`signature help` MUST ser implementado para chamadas de:
|
||||
|
||||
1. funcao;
|
||||
2. metodo;
|
||||
3. construtor.
|
||||
|
||||
Na wave 1, ele MUST informar:
|
||||
|
||||
1. a assinatura ativa;
|
||||
2. o parametro ativo;
|
||||
3. labels coerentes com a mesma representacao de assinatura usada no hover.
|
||||
|
||||
`signature help` MUST usar a mesma base editorial de resolucao usada por `completion` e `hover`.
|
||||
|
||||
### 5. Boundary Responsibilities
|
||||
|
||||
`compiler/pbs`:
|
||||
|
||||
1. MUST continuar sendo a fonte de verdade de semantica, linking e metadata relevante para simbolos e call surfaces;
|
||||
2. MUST fornecer a base necessaria para resolucao editorial de simbolos, members e assinaturas.
|
||||
|
||||
`studio/lsp`:
|
||||
|
||||
1. MUST projetar essa base editorial em endpoints/protocol features adequados;
|
||||
2. MUST anunciar as capabilities LSP necessarias para `completion`, `hover` e `signature help`;
|
||||
3. MUST manter o transporte fiel ao modelo compiler-backed.
|
||||
|
||||
`tools/vscode-extension`:
|
||||
|
||||
1. MUST consumir o protocolo como cliente;
|
||||
2. MUST NOT carregar tabelas paralelas de membros, stdlib ou assinaturas como fonte principal;
|
||||
3. MAY conter apenas a logica estrutural normal de integração exigida pelo VS Code.
|
||||
|
||||
### 6. Documentation Preparation Rule
|
||||
|
||||
Esta wave MUST preparar um campo ou superfície opcional para documentacao editorial resolvida por simbolo.
|
||||
|
||||
Mas esta decisao ALSO locks que:
|
||||
|
||||
1. a surface de autoria dessa documentacao em PBS nao faz parte desta wave;
|
||||
2. a sintaxe ou contrato de linguagem para documentacao authored deve ser discutido separadamente;
|
||||
3. a ausencia dessa autoria nao bloqueia `completion`, `hover` nem `signature help` da wave 1.
|
||||
|
||||
### 7. Explicit Non-Goals
|
||||
|
||||
Esta decisao MUST NOT:
|
||||
|
||||
1. incluir formatter completo;
|
||||
2. incluir identacao automatica robusta de documento;
|
||||
3. incluir `go to definition`;
|
||||
4. incluir `references`;
|
||||
5. incluir `rename`;
|
||||
6. incluir quick fixes;
|
||||
7. incluir code actions mais amplas;
|
||||
8. definir o modelo de autoria de documentacao em PBS.
|
||||
|
||||
## Constraints
|
||||
|
||||
1. A wave 1 MUST priorizar coerencia entre `completion`, `hover` e `signature help` sobre cobertura enciclopedica de todos os casos.
|
||||
2. A extensao VS Code MUST permanecer thin; a inteligencia editorial MUST ficar no compiler/LSP.
|
||||
3. A implementacao MUST favorecer evolucao futura para `definition`, `references`, `documentation`, e outras editor features sem exigir reescrita conceitual da base editorial.
|
||||
4. A implementacao MUST evitar surfaces duplicadas para stdlib, aliases, members e signatures.
|
||||
5. Qualquer plan derivado desta decisao MUST separar claramente:
|
||||
- base editorial compiler-backed;
|
||||
- projeção LSP/protocolo;
|
||||
- integração VS Code.
|
||||
|
||||
## Revision Log
|
||||
|
||||
- 2026-05-08: Initial draft from AGD-0038.
|
||||
- 2026-05-08: Accepted and decomposed into PLN-0075, PLN-0076, and PLN-0077.
|
||||
-135
@@ -1,135 +0,0 @@
|
||||
---
|
||||
id: PLN-0075
|
||||
ticket: pbs-lsp-editor-assistance-wave-1
|
||||
title: PBS Editorial Resolution Surface for Symbols, Members, and Signatures
|
||||
status: open
|
||||
created: 2026-05-08
|
||||
completed:
|
||||
tags: [compiler, compiler-pbs, editor, completion, hover, signature-help, semantics]
|
||||
---
|
||||
|
||||
## Objective
|
||||
|
||||
Introduce a compiler-backed editorial resolution surface in `compiler/pbs` that can answer symbol identity, kind, origin, signature/shape, callable details, and receiver members for use by LSP `completion`, `hover`, and `signature help`.
|
||||
|
||||
## Background
|
||||
|
||||
`DEC-0035` requires all three editor-assistance features to be built over one shared compiler-backed base. The current repository already has useful pieces:
|
||||
|
||||
- parser and AST for PBS;
|
||||
- semantic validation and flow analysis;
|
||||
- stdlib and import visibility rules;
|
||||
- semantic token classification;
|
||||
- builder-pipeline overlay analysis.
|
||||
|
||||
What is still missing is an explicit editorial surface designed for interactive symbol resolution instead of only diagnostics or coloring.
|
||||
|
||||
## Scope
|
||||
|
||||
### Included
|
||||
|
||||
- Define internal compiler-side models for editorial symbol resolution.
|
||||
- Resolve local names, imported/public symbols, and recognized member surfaces.
|
||||
- Resolve callable signatures for functions, methods, and constructors.
|
||||
- Provide optional documentation slot(s) in the model without defining authored PBS documentation syntax.
|
||||
- Add PBS-focused tests for symbol/member/signature resolution.
|
||||
|
||||
### Excluded
|
||||
|
||||
- LSP protocol capability changes.
|
||||
- VS Code client behavior.
|
||||
- Authored documentation syntax such as `Document(...)`.
|
||||
- `go to definition`, `references`, `rename`, formatter, or code actions.
|
||||
|
||||
## Non-Goals
|
||||
|
||||
- Rebuilding the full compiler around IDE concerns.
|
||||
- Solving every ambiguous or partial parse state in wave 1.
|
||||
- Designing a generic multi-language IDE framework before PBS proves the model.
|
||||
|
||||
## Execution Steps
|
||||
|
||||
### Step 1 - Define editorial resolution models in compiler-owned surfaces
|
||||
|
||||
**What:** Introduce explicit models for resolved symbols, member candidates, callable signatures, and optional documentation payload.
|
||||
**How:** Add compiler-owned DTO/model types that can express:
|
||||
|
||||
1. symbol identity and kind;
|
||||
2. declared/imported origin;
|
||||
3. callable label/signature shape;
|
||||
4. receiver member entries;
|
||||
5. optional documentation text field.
|
||||
|
||||
The model must be expressive enough for `completion`, `hover`, and `signature help` without forcing each consumer to reinterpret raw AST nodes.
|
||||
**File(s):** `prometeu-compiler/prometeu-compiler-core/src/main/java/**` and/or `prometeu-compiler/frontends/prometeu-frontend-pbs/src/main/java/**` depending on final ownership split.
|
||||
|
||||
### Step 2 - Build PBS symbol resolution for local and imported surfaces
|
||||
|
||||
**What:** Resolve names in editorial contexts.
|
||||
**How:** Reuse parser, name/linking, stdlib import knowledge, and any existing semantic tables to resolve:
|
||||
|
||||
1. local bindings in scope;
|
||||
2. declared top-level PBS symbols;
|
||||
3. imported/public symbols and aliases;
|
||||
4. stdlib-owned surfaces currently recognized by the frontend.
|
||||
|
||||
The implementation must avoid duplicating semantic truth already present in compiler/linking logic.
|
||||
**File(s):** `prometeu-compiler/frontends/prometeu-frontend-pbs/src/main/java/p/studio/compiler/**`.
|
||||
|
||||
### Step 3 - Build member and callable resolution
|
||||
|
||||
**What:** Resolve members and callable signatures for recognized receiver and call surfaces.
|
||||
**How:** Support at minimum:
|
||||
|
||||
1. member lookup after `.` for services, hosts, builtin types, and structs;
|
||||
2. direct callable lookup for functions and constructors;
|
||||
3. active-call signature resolution for later `signature help` use.
|
||||
|
||||
This step must produce stable labels/details that can be reused unchanged by LSP features.
|
||||
**File(s):** `prometeu-compiler/frontends/prometeu-frontend-pbs/src/main/java/p/studio/compiler/**`.
|
||||
|
||||
### Step 4 - Add editorial conformance tests
|
||||
|
||||
**What:** Lock the compiler-backed editorial contract before LSP integration.
|
||||
**How:** Add tests for:
|
||||
|
||||
1. local variable and parameter resolution;
|
||||
2. imported service/host/builtin-type resolution;
|
||||
3. member lookup after `.` on recognized surfaces;
|
||||
4. callable signature extraction for function/method/constructor cases;
|
||||
5. optional documentation field stability when absent.
|
||||
|
||||
**File(s):** PBS/compiler test suites under `prometeu-compiler/**/src/test/java/**`.
|
||||
|
||||
## Test Requirements
|
||||
|
||||
### Unit Tests
|
||||
|
||||
- Model invariants for symbol/member/signature payloads.
|
||||
- Resolver tests covering locals, imports, aliases, members, and constructors.
|
||||
|
||||
### Integration Tests
|
||||
|
||||
- Compiler-backed overlay/editorial tests using representative PBS snippets and stdlib imports.
|
||||
|
||||
### Manual Verification
|
||||
|
||||
- Inspect resolved payloads in tests or debug output and confirm they are sufficient to drive all three editor features without ad hoc reinterpretation.
|
||||
|
||||
## Acceptance Criteria
|
||||
|
||||
- [ ] Compiler-side editorial models exist for symbols, members, signatures, and optional documentation.
|
||||
- [ ] PBS can resolve local names, imported/public symbols, and recognized member surfaces.
|
||||
- [ ] Function, method, and constructor signatures are available through the shared editorial surface.
|
||||
- [ ] No consumer is required to reconstruct signature/member meaning from raw AST-only data.
|
||||
|
||||
## Dependencies
|
||||
|
||||
- `DEC-0035` accepted and normatively locked.
|
||||
- Existing PBS semantic and import/linking infrastructure remains the truth source.
|
||||
|
||||
## Risks
|
||||
|
||||
- Overfitting the first resolver to the current stdlib shape may hurt future fronts or future PBS growth.
|
||||
- Mixing diagnostics-only semantics with editorial semantics carelessly may produce partial or contradictory answers.
|
||||
- Incomplete member resolution can make `completion` appear flaky even if `hover` works.
|
||||
-121
@@ -1,121 +0,0 @@
|
||||
---
|
||||
id: PLN-0076
|
||||
ticket: pbs-lsp-editor-assistance-wave-1
|
||||
title: LSP Completion, Hover, and Signature Help over Editorial Resolution
|
||||
status: open
|
||||
created: 2026-05-08
|
||||
completed:
|
||||
tags: [studio, lsp, protocol, completion, hover, signature-help, editor]
|
||||
---
|
||||
|
||||
## Objective
|
||||
|
||||
Expose `completion`, real `hover`, and `signature help` through the project-scoped LSP stack by projecting the compiler-backed editorial resolution surface into explicit protocol capabilities and request handlers.
|
||||
|
||||
## Background
|
||||
|
||||
`DEC-0035` requires `studio/lsp` to be the operational owner of these editor features while remaining faithful to compiler-backed symbol, member, and signature resolution. The current LSP path only handles diagnostics, semantic tokens, and a placeholder hover.
|
||||
|
||||
## Scope
|
||||
|
||||
### Included
|
||||
|
||||
- Extend the internal bridge/API with completion and signature-help operations.
|
||||
- Replace placeholder hover with symbol-resolved hover.
|
||||
- Announce LSP capabilities for completion and signature help.
|
||||
- Add message models/mappers/tests for the new request/response paths.
|
||||
|
||||
### Excluded
|
||||
|
||||
- Creation of the underlying compiler editorial model itself.
|
||||
- Authored documentation syntax.
|
||||
- VS Code-specific UI behavior beyond normal LSP consumption.
|
||||
|
||||
## Non-Goals
|
||||
|
||||
- `go to definition`, `references`, `rename`, formatter, code actions, or quick fixes.
|
||||
- Rich workspace-wide indexing beyond what the shared editorial surface already provides.
|
||||
|
||||
## Execution Steps
|
||||
|
||||
### Step 1 - Extend the LSP bridge contract
|
||||
|
||||
**What:** Add compiler-backed editor-assistance operations to the bridge.
|
||||
**How:** Evolve `LanguageServiceBridge` and related internal messages to support at minimum:
|
||||
|
||||
1. completion requests;
|
||||
2. symbol-resolved hover payloads;
|
||||
3. signature-help requests.
|
||||
|
||||
The bridge contract must align structurally with the shared editorial resolution surface rather than inventing a second feature-specific abstraction.
|
||||
**File(s):** `prometeu-lsp/prometeu-lsp-v1/src/main/java/p/studio/lsp/services/**`, `prometeu-lsp/prometeu-lsp-v1/src/main/java/p/studio/lsp/messages/**`.
|
||||
|
||||
### Step 2 - Implement compiler-backed request handling
|
||||
|
||||
**What:** Wire LSP requests to compiler-backed editorial resolution.
|
||||
**How:** Update `CompilerLanguageServiceBridge` so it:
|
||||
|
||||
1. resolves completion candidates from local/import/member contexts;
|
||||
2. resolves hover payloads from symbol identity, origin, and signatures;
|
||||
3. resolves active call signatures for `signature help`.
|
||||
|
||||
This step must remove the current fixed hover placeholder.
|
||||
**File(s):** `prometeu-lsp/prometeu-lsp-v1/src/main/java/p/studio/lsp/services/compiler/**`.
|
||||
|
||||
### Step 3 - Announce and map protocol capabilities
|
||||
|
||||
**What:** Make the server advertise the new feature set and map payloads into lsp4j types.
|
||||
**How:** Update protocol mappers and text-document service so the server announces:
|
||||
|
||||
1. `completionProvider`;
|
||||
2. `signatureHelpProvider`;
|
||||
3. improved `hoverProvider` backed by real payloads.
|
||||
|
||||
Map completion items, hover markdown, and signature-help structures into concrete LSP responses.
|
||||
**File(s):** `prometeu-lsp/prometeu-lsp-v1/src/main/java/p/studio/lsp/services/protocol/**`, `.../mapping/**`.
|
||||
|
||||
### Step 4 - Add transport and conformance tests
|
||||
|
||||
**What:** Prevent regression to placeholder/editor-local behavior.
|
||||
**How:** Add tests that verify:
|
||||
|
||||
1. capabilities are announced correctly;
|
||||
2. completion returns compiler-backed candidates;
|
||||
3. hover no longer returns the baseline placeholder;
|
||||
4. signature-help returns deterministic active-signature information.
|
||||
|
||||
**File(s):** `prometeu-lsp/prometeu-lsp-v1/src/test/java/**`.
|
||||
|
||||
## Test Requirements
|
||||
|
||||
### Unit Tests
|
||||
|
||||
- DTO/model invariants for completion, hover, and signature-help payloads.
|
||||
- Mapper tests for lsp4j conversion.
|
||||
|
||||
### Integration Tests
|
||||
|
||||
- LSP request/response tests using realistic PBS snippets with locals, imports, and member access.
|
||||
|
||||
### Manual Verification
|
||||
|
||||
- Connect the VS Code extension and confirm server capabilities include completion and signature help.
|
||||
- Confirm hover content changes with the hovered symbol rather than returning static baseline text.
|
||||
|
||||
## Acceptance Criteria
|
||||
|
||||
- [ ] The LSP bridge exposes completion and signature-help operations in addition to diagnostics, hover, and semantic tokens.
|
||||
- [ ] Hover is symbol-resolved and no longer hardcoded placeholder text.
|
||||
- [ ] The server advertises completion and signature-help capabilities.
|
||||
- [ ] Completion, hover, and signature help all derive from the same compiler-backed editorial surface.
|
||||
|
||||
## Dependencies
|
||||
|
||||
- `DEC-0035` accepted and normatively locked.
|
||||
- `PLN-0075` for the shared compiler-backed editorial resolution surface.
|
||||
|
||||
## Risks
|
||||
|
||||
- Protocol mapping can drift from compiler payload shape if feature-specific shortcuts are added.
|
||||
- Active parameter/signature calculation may be brittle around incomplete syntax unless request handling is conservative.
|
||||
- Completion can feel noisy if candidate ranking or filtering is too weak in wave 1.
|
||||
-103
@@ -1,103 +0,0 @@
|
||||
---
|
||||
id: PLN-0077
|
||||
ticket: pbs-lsp-editor-assistance-wave-1
|
||||
title: VS Code Consumption and Wave 1 Editor Assistance Validation
|
||||
status: open
|
||||
created: 2026-05-08
|
||||
completed:
|
||||
tags: [vscode, extension, editor, completion, hover, signature-help, validation]
|
||||
---
|
||||
|
||||
## Objective
|
||||
|
||||
Keep the VS Code extension thin while validating that the new LSP-delivered `completion`, `hover`, and `signature help` features actually produce a minimally usable PBS editing experience end to end.
|
||||
|
||||
## Background
|
||||
|
||||
`DEC-0035` explicitly requires the extension to remain a client/adaptor rather than a second semantic engine. Because VS Code already knows how to consume LSP completion, hover, and signature-help responses, the extension work should be small and mostly about ensuring transport, configuration, and real validation are correct.
|
||||
|
||||
## Scope
|
||||
|
||||
### Included
|
||||
|
||||
- Confirm the extension does not need or gain local semantic tables for stdlib, members, or signatures.
|
||||
- Adjust only the minimal extension/bootstrap behavior needed for the new LSP features to flow correctly.
|
||||
- Add verification coverage and manual validation guidance for the full wave.
|
||||
|
||||
### Excluded
|
||||
|
||||
- Compiler-side editorial resolution logic.
|
||||
- LSP-side protocol feature implementation.
|
||||
- Formatter/indentation, code actions, or non-wave-1 IDE features.
|
||||
|
||||
## Non-Goals
|
||||
|
||||
- Turning the extension into a feature-rich semantic client.
|
||||
- Adding hardcoded completion/signature content for PBS inside TypeScript runtime code.
|
||||
|
||||
## Execution Steps
|
||||
|
||||
### Step 1 - Verify thin-client integration boundaries
|
||||
|
||||
**What:** Confirm the extension remains a pure LSP consumer for the new features.
|
||||
**How:** Review and adjust the extension only where necessary so completion, hover, and signature help are obtained from the LSP session without client-side semantic fallback tables.
|
||||
**File(s):** `tools/vscode-extension/src/**`, `tools/vscode-extension/package.json`.
|
||||
|
||||
### Step 2 - Add any minimal structural configuration required by VS Code
|
||||
|
||||
**What:** Keep static contribution surfaces minimal and structural.
|
||||
**How:** If VS Code requires additional structural contribution metadata for the new features, add only that metadata. Do not add curated PBS semantic or signature data into the extension package.
|
||||
**File(s):** `tools/vscode-extension/package.json`.
|
||||
|
||||
### Step 3 - Add validation coverage for end-to-end editor assistance
|
||||
|
||||
**What:** Lock the no-local-semantics rule and the end-to-end feature expectations.
|
||||
**How:** Add tests or deterministic verification steps that ensure:
|
||||
|
||||
1. the extension connects and receives the feature set from the server;
|
||||
2. no local completion/signature tables were introduced;
|
||||
3. the user-facing wave can be exercised end to end.
|
||||
|
||||
**File(s):** `tools/vscode-extension/**`, existing validation harnesses if present, and related docs/test notes.
|
||||
|
||||
### Step 4 - Define manual smoke scenarios for wave 1 usability
|
||||
|
||||
**What:** Make the wave verifiable as a product experience rather than only a protocol exercise.
|
||||
**How:** Document and run manual checks for:
|
||||
|
||||
1. keyword and local-name completion;
|
||||
2. imported stdlib/member completion after `.`;
|
||||
3. hover on locals, imported services, builtin types, and methods;
|
||||
4. signature help during function/method/constructor calls.
|
||||
|
||||
**File(s):** extension verification notes or adjacent implementation docs/tests as appropriate.
|
||||
|
||||
## Test Requirements
|
||||
|
||||
### Unit Tests
|
||||
|
||||
- Any extension-side helpers introduced for structural integration only.
|
||||
|
||||
### Integration Tests
|
||||
|
||||
- End-to-end or near-end-to-end validation that VS Code consumes the server feature set without local semantic duplication.
|
||||
|
||||
### Manual Verification
|
||||
|
||||
- Open representative PBS files in VS Code and verify `completion`, `hover`, and `signature help` behavior matches the expected wave-1 scope.
|
||||
|
||||
## Acceptance Criteria
|
||||
|
||||
- [ ] The extension remains thin and contains no new hardcoded PBS semantic tables for members or signatures.
|
||||
- [ ] VS Code can consume the new LSP completion, hover, and signature-help responses without extension-side semantic authorship.
|
||||
- [ ] Wave-1 smoke scenarios are documented and manually verifiable.
|
||||
|
||||
## Dependencies
|
||||
|
||||
- `DEC-0035` accepted and normatively locked.
|
||||
- `PLN-0076` for the actual LSP feature delivery.
|
||||
|
||||
## Risks
|
||||
|
||||
- It is easy to accidentally patch around server gaps with client-local logic; this plan must resist that.
|
||||
- Validation can become too protocol-centric and miss real usability failures if manual smoke scenarios are weak.
|
||||
@@ -462,6 +462,8 @@ Campos:
|
||||
* `sortText`: prefixado para impor bucket (ex.: `"1_"`, `"2_"`)
|
||||
* `filterText`: label
|
||||
|
||||
Callable completion details and snippets must consume parameter names from the compiler semantic callable model. LSP/editor code must not invent display names such as `arg0` or `arg1`; missing semantic names should remain visibly incomplete rather than being presented as API names.
|
||||
|
||||
---
|
||||
|
||||
## Tarefas de implementação
|
||||
|
||||
@@ -65,6 +65,8 @@ Habilitar `references`, `prepareRename`, `rename` com regras de segurança.
|
||||
|
||||
* Type facts básicos: `NodeId -> TypeId`
|
||||
* Modelo de assinatura: para functions (params, retorno)
|
||||
* Parameter names for signatureHelp and hover come from the compiler semantic callable model, including stdlib, host-backed, builtin, and intrinsic callables.
|
||||
* Generated placeholders such as `arg0` must not appear in LSP completion, signatureHelp, or hover output.
|
||||
|
||||
### Testes
|
||||
|
||||
|
||||
@@ -76,10 +76,18 @@ Mandatory declaration metadata on required declaration nodes includes:
|
||||
2. declared signature/surface when applicable (parameters/return),
|
||||
3. declaration-level syntactic flags/attributes required by later phases,
|
||||
4. stable `file/start/end` attribution,
|
||||
5. lifecycle-marker metadata when a declaration carries `[Init]` or `[Frame]`.
|
||||
5. lifecycle-marker metadata when a declaration carries `[Init]` or `[Frame]`,
|
||||
6. documentation attribute metadata when a declaration carries `[Doc(markdown = """...""")]`.
|
||||
|
||||
Missing required attribution or metadata on mandatory nodes is non-conformant.
|
||||
|
||||
Documentation metadata rules:
|
||||
|
||||
- The AST MUST preserve the `Doc` attribute name, the `markdown` argument name, the raw documentation text block payload, and source attribution for the whole attribute and payload.
|
||||
- The AST MUST distinguish documentation text block payloads from ordinary string literals.
|
||||
- The AST MUST preserve enough attribution for later diagnostics to point at malformed or invalid `Doc` usage.
|
||||
- AST construction MUST NOT normalize documentation text block content in a way that loses source-observable parse meaning before the semantic normalization step.
|
||||
|
||||
## 8. Mandatory Declaration Families
|
||||
|
||||
The v1 AST must represent, at minimum, declaration families for:
|
||||
@@ -104,6 +112,8 @@ Lifecycle-observable declarations must preserve marker metadata explicitly:
|
||||
- top-level `fn` marked with `[Frame]`,
|
||||
- and host method signatures marked with `[InitAllowed]`.
|
||||
|
||||
Documentation-observable declarations must preserve `Doc` metadata explicitly on every accepted named API declaration surface that carries `[Doc(markdown = """...""")]`.
|
||||
|
||||
## 9. Mandatory Statement and Expression Families
|
||||
|
||||
The v1 AST must represent statement/expression families for the supported core syntax slice, including at minimum:
|
||||
|
||||
@@ -82,7 +82,8 @@ The following inputs are already fixed elsewhere and must not be contradicted he
|
||||
- Stable source span metadata is required at the token level and must remain useful to later diagnostics.
|
||||
- Traps are fatal runtime outcomes rather than a recoverable userland diagnostic flow.
|
||||
- Qualitative cost facts such as retention-bearing operations and host-boundary crossings are normative, but quantitative performance metrics are not.
|
||||
- Topic `19` requires deterministic diagnostics for globals, lifecycle markers, init admission, and published-wrapper structural failures.
|
||||
- PBS requires deterministic diagnostics for source-form globals, lifecycle markers, and init admission.
|
||||
- Published-wrapper, boot-guard, synthetic-origin, and invalid-lifecycle-declaration failures are compiler-general. See `docs/specs/compiler/19. Verification and Safety Checks Specification.md` section 11 and `docs/specs/compiler/20. IRBackend to IRVM Lowering Specification.md`.
|
||||
|
||||
## 6. Required Diagnostic Phases
|
||||
|
||||
@@ -97,6 +98,8 @@ PBS-facing tooling must distinguish at least the following external diagnostic p
|
||||
|
||||
`linking` is a first-class phase in the external diagnostics contract and must not be collapsed away into a generic resolution bucket.
|
||||
|
||||
The `host-binding/capability admission` phase covers the source shape of `[Host]` and `[Capability]`. Canonical host-binding identity and capability consistency over `IRReservedMetadata` are platform-owned and are not moved by this specification.
|
||||
|
||||
This document does not require one finer-grained public phase split for verifier internals, artifact offsets, or transport-specific backend stages beyond what is stated here.
|
||||
|
||||
## 7. Required Diagnostic Identity, Payload, and Attribution
|
||||
@@ -180,7 +183,7 @@ At minimum, the PBS diagnostics baseline must cover:
|
||||
5. malformed, unauthorized, or capability-rejected host usage required by `6.2. Host ABI Binding and Loader Resolution Specification.md` and `7. Cartridge Manifest and Runtime Capabilities Specification.md`,
|
||||
6. source-attributable backend-originated failures that remain user-actionable under normative lowering or load-facing rules.
|
||||
7. dependency-scoped fail-fast admission at frontend boundary: when one module is rejected, modules that import it (directly or transitively) must not be emitted, while diagnostics collection for independent modules must continue.
|
||||
8. lifecycle and globals diagnostics required by topic `19`, including:
|
||||
8. lifecycle-marker and source-form global diagnostics, including:
|
||||
- `global initializer uses unsupported form`,
|
||||
- `global dependency cycle detected`,
|
||||
- `global import must resolve through a global barrel entry`,
|
||||
@@ -194,16 +197,13 @@ At minimum, the PBS diagnostics baseline must cover:
|
||||
- `project init must be colocated with frame`,
|
||||
- `Init attribute target invalid`,
|
||||
- `InitAllowed is valid only on SDK host methods`,
|
||||
- `host call not allowed during init`,
|
||||
- `synthetic wrapper entrypoint missing`,
|
||||
- `published entrypoint is not function index 0`,
|
||||
- `hidden boot guard is missing`,
|
||||
- `synthetic callable origin missing`.
|
||||
9. symbolic asset-reference diagnostics required by backend-owned `Addressable` resolution, including:
|
||||
- `host call not allowed during init`.
|
||||
9. compiler-general lifecycle-assembly and IRVM-precondition failures, which this PBS catalog MUST NOT claim as PBS required coverage; see `docs/specs/compiler/19. Verification and Safety Checks Specification.md` section 11 and `docs/specs/compiler/20. IRBackend to IRVM Lowering Specification.md`.
|
||||
10. symbolic asset-reference diagnostics required by backend-owned `Addressable` resolution, including:
|
||||
- unresolved terminal asset reference,
|
||||
- namespace-versus-terminal asset misuse,
|
||||
- structurally invalid symbolic asset path admitted by source syntax but rejected by semantic surface rules.
|
||||
10. ignored-value diagnostics for expression statements, including:
|
||||
11. ignored-value diagnostics for expression statements, including:
|
||||
- a stable warning when a materialized value is produced and then ignored,
|
||||
- and no warning for unit-like expression statements.
|
||||
|
||||
@@ -214,6 +214,19 @@ Reserved-attribute diagnostics for host-backed asset lowering must also cover:
|
||||
- out-of-range `AssetLowering.param` indexes,
|
||||
- and `AssetLowering` targets whose selected parameter is not statically typed as `Addressable`.
|
||||
|
||||
Documentation attribute diagnostics must cover:
|
||||
|
||||
- unterminated documentation text block syntax,
|
||||
- `Doc` used without the required `markdown` argument,
|
||||
- `Doc` with extra or unknown arguments,
|
||||
- `Doc` with a non-documentation-text-block payload,
|
||||
- duplicate `Doc` on the same declaration,
|
||||
- `Doc` applied to a parameter or other non-documentable surface,
|
||||
- normalized empty or whitespace-only documentation payload,
|
||||
- and rejected aliases or alternate forms such as `text`, positional arguments, `html`, `format`, `Document`, `Documentation`, or `md"""..."""`.
|
||||
|
||||
Diagnostics for duplicate `Doc` attributes must be static semantic diagnostics and should include a related site for the conflicting declaration attribute when available.
|
||||
|
||||
At minimum, host-admission diagnostics must cover missing or malformed host capability metadata and unknown or undeclared capability names.
|
||||
|
||||
Only backend-originated failures that remain source-attributable and user-actionable belong to the PBS-facing diagnostics contract.
|
||||
|
||||
@@ -1,13 +1,13 @@
|
||||
# PBS Lowering IRBackend Specification
|
||||
|
||||
Status: Draft v1 (Frontend Scope + Backend Handoff Addendum)
|
||||
Applies to: first lowering boundary from bound PBS frontend model into `IRBackend`/`IRBackendFile`, plus executable-backend handoff obligations at this boundary
|
||||
Status: Draft v1 (PBS Frontend Scope + Common Handoff Emission)
|
||||
Applies to: first lowering boundary from bound PBS frontend model into the common `IRBackend`/`IRBackendFile` handoff
|
||||
|
||||
## 1. Purpose
|
||||
|
||||
This document defines the normative frontend lowering contract from PBS source semantics to `IRBackend`.
|
||||
This document defines the normative frontend lowering contract from PBS source semantics to the common `IRBackend` handoff.
|
||||
|
||||
Its purpose is to keep the first lowering deterministic and shared across implementations while PBS and backend design evolve.
|
||||
Its purpose is to keep PBS lowering deterministic while preserving the common frontend-to-backend contract owned by compiler-general backend specs.
|
||||
|
||||
## 2. Scope
|
||||
|
||||
@@ -18,7 +18,7 @@ This document defines:
|
||||
- semantic obligations preserved in `IRBackend`,
|
||||
- deterministic rejection behavior for unsupported frontend-lowering forms,
|
||||
- diagnostics attribution obligations for lowering failures in frontend scope,
|
||||
- executable-backend handoff obligations at the `IRBackend` boundary,
|
||||
- PBS obligations for emitting the common executable `IRBackend` handoff,
|
||||
- and backend-owned symbolic lowering obligations for asset-facing references.
|
||||
|
||||
This document does not define:
|
||||
@@ -26,7 +26,8 @@ This document does not define:
|
||||
- VM lowering (`IRVM`),
|
||||
- bytecode/PBX mapping,
|
||||
- runtime execution behavior,
|
||||
- verifier/loader internals.
|
||||
- verifier/loader internals,
|
||||
- or common backend ownership of the `IRBackend -> IRVM` contract.
|
||||
|
||||
Those concerns belong to shared acceptance specs under `docs/specs/compiler`.
|
||||
|
||||
@@ -75,9 +76,9 @@ When the active source slice depends on a backend-owned symbolic surface such as
|
||||
- the frontend must not query domain services directly to discover operational assets;
|
||||
- and lowering must preserve enough identity for the backend to complete final operational resolution.
|
||||
|
||||
## 6. IRBackend Preserved Obligations
|
||||
## 6. PBS IRBackend Emission Obligations
|
||||
|
||||
For each admitted source unit and callable in the current lowering slice, `IRBackend` must preserve at minimum:
|
||||
For each admitted PBS source unit and callable in the current lowering slice, PBS lowering must emit `IRBackend` that preserves at minimum:
|
||||
|
||||
1. callable identity (name/category as applicable),
|
||||
2. callable arity,
|
||||
@@ -85,14 +86,18 @@ For each admitted source unit and callable in the current lowering slice, `IRBac
|
||||
4. source attribution anchor (`file + span`) for diagnostics and traceability,
|
||||
5. source-observable parse intent for statement/expression structure (including precedence/associativity outcome already fixed by AST shape).
|
||||
6. deterministic `requiredCapabilities` derived from admitted host-binding metadata for packer/runtime-manifest assistance.
|
||||
7. compiler-selected published-wrapper entrypoint identity for backend handoff,
|
||||
8. explicit global and synthetic lifecycle structure required by executable lowering.
|
||||
7. a typed `IRLifecycleDeclaration` for executable programs, with file-init fragment, optional project-init, and required frame-root references,
|
||||
8. explicit user globals and frontend-lowered file-init fragments required by later common lifecycle assembly,
|
||||
9. backend-owned symbolic identities that must survive to later executable lowering, including symbolic asset references when admitted by the source slice.
|
||||
|
||||
PBS lowering MUST NOT emit module init, project-init wrapper, published frame wrapper, physical entrypoint, or boot guard. Those artifacts are produced exclusively by common lifecycle assembly.
|
||||
|
||||
Lowering must not collapse source categories in a way that erases required declaration/callable identity needed by downstream diagnostics or conformance assertions.
|
||||
|
||||
The normative contract is obligation-based, not tied to one mandatory in-memory class graph.
|
||||
|
||||
`IRBackend` itself is the common frontend-to-backend executable handoff. This PBS spec owns only the PBS-specific admission and translation path into that handoff. Common backend rules for consuming `IRBackend` are owned by `docs/specs/compiler/20. IRBackend to IRVM Lowering Specification.md`.
|
||||
|
||||
## 7. Deterministic Rejection Policy
|
||||
|
||||
If a source form is outside current frontend-lowering support:
|
||||
@@ -111,7 +116,7 @@ For multi-module builds, lowering admission must apply dependency-scoped fail-fa
|
||||
|
||||
## 8. Conformance Boundary
|
||||
|
||||
`IRBackend` is the first lowering boundary (frontend responsibility).
|
||||
PBS emission into `IRBackend` is the first PBS lowering boundary (frontend responsibility).
|
||||
|
||||
Conformance-valid claims at this boundary require Gate U evidence from `docs/specs/compiler/13. Conformance Test Specification.md`.
|
||||
|
||||
@@ -148,9 +153,9 @@ This document is healthy when:
|
||||
3. deterministic rejection policy is explicit and test-backed,
|
||||
4. and scope boundaries with general/backend acceptance specs are explicit.
|
||||
|
||||
## 12. Executable Backend Handoff Addendum (v1)
|
||||
## 12. PBS Executable Handoff Emission Obligations (v1)
|
||||
|
||||
For executable backends, the `IRBackend` output from this frontend boundary must satisfy the additional handoff obligations below.
|
||||
For executable backends, PBS lowering must emit `IRBackend` satisfying the additional handoff obligations below before common backend lowering starts.
|
||||
|
||||
### 12.1 Callable obligations
|
||||
|
||||
@@ -170,7 +175,7 @@ Each executable callsite in `IRBackend` must be classified into exactly one cate
|
||||
2. `CALL_HOST`,
|
||||
3. `CALL_INTRINSIC`.
|
||||
|
||||
Backend lowering must not infer this category by textual heuristics.
|
||||
PBS lowering must not leave this category for backend inference by textual heuristics.
|
||||
|
||||
### 12.3 Host-backed metadata obligations
|
||||
|
||||
@@ -187,11 +192,11 @@ When a host-backed callsite also depends on backend-owned symbolic asset lowerin
|
||||
- the frontend boundary MUST preserve which callsite argument is asset-facing;
|
||||
- for PBS v1 this asset-facing designation is carried by reserved host metadata `[AssetLowering(param = N)]`;
|
||||
- the preserved symbolic operand MUST remain attributable to a backend-provided `Addressable` identity;
|
||||
- backend stages MUST be able to rewrite that symbolic operand into runtime-facing `asset_id` before the final low-level host path is emitted.
|
||||
- common backend stages MUST be able to rewrite that symbolic operand into runtime-facing `asset_id` before the final low-level host path is emitted.
|
||||
|
||||
When an expression statement leaves a materialized runtime value on the stack:
|
||||
|
||||
- `IRBackend` lowering MUST emit explicit discard behavior rather than relying on implicit backend stack cleanup;
|
||||
- PBS lowering into `IRBackend` MUST emit explicit discard behavior rather than relying on implicit backend stack cleanup;
|
||||
- for single-slot materialized values this discard is represented by `POP`;
|
||||
- and the discard path MUST preserve stack-accounting validity for subsequent backend lowering stages.
|
||||
|
||||
@@ -218,20 +223,18 @@ It does not replace:
|
||||
2. `docs/specs/compiler/21. IRVM Optimization Pipeline Specification.md`,
|
||||
3. or `docs/specs/compiler/15. Bytecode and PBX Mapping Specification.md`.
|
||||
|
||||
### 12.7 Executable Lifecycle and Published Wrapper Obligation
|
||||
### 12.7 Executable Lifecycle Declaration Obligation
|
||||
|
||||
For executable PBS frontends, backend handoff must preserve the compiler-selected published wrapper rather than a frontend-declared nominal entrypoint.
|
||||
For executable PBS frontends, PBS lowering MUST emit a typed `IRLifecycleDeclaration` rather than assembling the published lifecycle.
|
||||
|
||||
At `IRBackend` emission time:
|
||||
At frontend `IRBackend` emission time:
|
||||
|
||||
1. the lowered graph must contain explicit lifecycle structure for:
|
||||
- user-authored globals,
|
||||
- file init fragments,
|
||||
- module init,
|
||||
- project init when present,
|
||||
- and the published frame wrapper,
|
||||
2. the published frame wrapper must be the effective entrypoint identity handed to backend stages,
|
||||
3. the userland callable marked with `[Frame]` must remain distinguishable as the logical frame root,
|
||||
4. the wrapper must own final `FRAME_RET`,
|
||||
5. backend stages must not reintroduce manifest-owned or `FrontendSpec`-owned nominal entrypoint authority,
|
||||
6. and hidden compiler-owned lifecycle state such as the boot guard must remain structurally distinguishable from user globals.
|
||||
1. PBS MUST retain marker admission for `[Init]`, `[Frame]`, and `InitAllowed`,
|
||||
2. PBS MUST emit typed references for:
|
||||
- file-init fragments that include global materialization and non-project `[Init]`,
|
||||
- the optional project-init callable, which is the `[Init]` colocated with `[Frame]`,
|
||||
- and the required frame-root callable marked with `[Frame]`,
|
||||
3. the colocated project init MUST be excluded from file-init fragments,
|
||||
4. module order in the declaration MUST propagate the explicit dependency order already derived from resolved project/module data, without sorting by `FileId`, textual module name, or synthetic callable name,
|
||||
5. PBS MUST NOT emit module init, project-init wrapper, published frame wrapper, physical entrypoint, or boot guard,
|
||||
6. and common lifecycle assembly remains the owner of derived artifacts, including the published wrapper that becomes the physical entrypoint and owns the final frame return.
|
||||
|
||||
@@ -114,6 +114,13 @@ String literals:
|
||||
- delimited by `"`.
|
||||
- supported escapes: `\\`, `\"`, `\n`, `\r`, `\t`.
|
||||
|
||||
Documentation text block literals:
|
||||
|
||||
- delimited by `"""`.
|
||||
- valid only as the value of the `markdown` argument in the reserved `[Doc(markdown = """...""")]` attribute surface.
|
||||
- not part of the runtime expression literal surface in v1 core.
|
||||
- preserve authored text for later documentation normalization.
|
||||
|
||||
Boolean literals:
|
||||
|
||||
- `true`, `false`.
|
||||
@@ -241,7 +248,8 @@ Attribute ::= '[' Identifier AttrArgs? ']'
|
||||
AttrArgs ::= '(' AttrArgList? ')'
|
||||
AttrArgList ::= AttrArg (',' AttrArg)*
|
||||
AttrArg ::= Identifier '=' AttrValue
|
||||
AttrValue ::= StringLit | IntLit | BoolLit
|
||||
AttrValue ::= StringLit | IntLit | BoolLit | DocTextBlock
|
||||
DocTextBlock ::= '"""' DocTextBlockChar* '"""'
|
||||
```
|
||||
|
||||
Rules:
|
||||
@@ -250,11 +258,16 @@ Rules:
|
||||
- Attributes do not introduce values, types, callables, or modules by themselves.
|
||||
- In v1 core, ordinary user-authored modules MUST reject attributes unless another specification explicitly permits them.
|
||||
- Ordinary userland source MAY use `[Init]` and `[Frame]` only on top-level `fn` declarations.
|
||||
- Ordinary userland source MAY use `[Doc(markdown = """...""")]` on named API declarations where the static semantics specification permits documentation.
|
||||
- Reserved stdlib/toolchain interface modules MAY use attributes where explicitly allowed by syntax and semantics.
|
||||
- Reserved stdlib/toolchain interface modules MAY additionally use `[InitAllowed]` only on `declare host` method signatures where another specification explicitly permits it.
|
||||
- Attribute interpretation is compile-time only unless another specification explicitly lowers its effect into runtime-facing metadata.
|
||||
- Reserved attribute names used by builtin-type and intrinsic shells do not become ordinary value-level syntax.
|
||||
- `Slot(...)` is not part of the v1 attribute surface; source that uses `Slot` must be rejected in syntax phase.
|
||||
- `Doc` is a reserved documentation attribute name. Its only v1 syntactic shape is `[Doc(markdown = """...""")]`.
|
||||
- The `Doc` attribute MUST NOT accept positional arguments, `text`, `html`, `format`, `Document`, `Documentation`, or prefixed text block forms such as `md"""..."""`.
|
||||
- Documentation text blocks are not string literals and MUST NOT appear in ordinary expressions, parameter defaults, or non-`Doc` attribute arguments.
|
||||
- Attribute ordering is syntactically insignificant; semantic validation determines duplicate or invalid attribute combinations.
|
||||
|
||||
### 6.2 Top-level declarations
|
||||
|
||||
@@ -922,7 +935,7 @@ Examples in this section are intended to stay mutually consistent with the synta
|
||||
|
||||
```pbs
|
||||
declare host Gfx {
|
||||
[Host(module = "gfx", name = "draw_pixel", version = 1)]
|
||||
[Host(module = "gfx2d", name = "draw_pixel", version = 1)]
|
||||
fn draw_pixel(x: int, y: int, c: color);
|
||||
}
|
||||
```
|
||||
|
||||
@@ -80,7 +80,7 @@ Rules:
|
||||
- Attributes are not first-class values and are not reflectable in v1 core.
|
||||
- Attributes do not automatically survive into runtime or bytecode artifacts.
|
||||
- An attribute affects runtime artifacts only when another specification defines an explicit lowering for its semantic effect.
|
||||
- In v1 core, the normative reserved attributes are `Host`, `Capability`, `AssetLowering`, `BuiltinType`, `BuiltinConst`, `IntrinsicCall`, `Init`, `Frame`, and `InitAllowed`.
|
||||
- In v1 core, the normative reserved attributes are `Host`, `Capability`, `AssetLowering`, `BuiltinType`, `BuiltinConst`, `IntrinsicCall`, `Init`, `Frame`, `InitAllowed`, and `Doc`.
|
||||
- `Host` is valid only on a host method signature declared directly inside a reserved stdlib/interface-module `declare host` body.
|
||||
- `Capability` is valid only on a host method signature declared directly inside a reserved stdlib/interface-module `declare host` body.
|
||||
- `AssetLowering` is valid only on a host method signature declared directly inside a reserved stdlib/interface-module `declare host` body.
|
||||
@@ -100,6 +100,42 @@ Rules:
|
||||
- Builtin metadata is consumed by the compiler during VM-owned builtin and intrinsic lowering rather than by host-binding lowering.
|
||||
- `Init` and `Frame` are consumed by lifecycle analysis and lowering rather than by ordinary runtime reflection.
|
||||
- `InitAllowed` is consumed by init-time host-admission analysis and does not become ordinary userland metadata.
|
||||
- `Doc` is compile/editor documentation metadata and is consumed by compiler-owned editorial surfaces.
|
||||
- `Doc` MUST NOT be lowered into bytecode, PBX, cartridge, or runtime-facing artifacts unless a future specification explicitly defines such lowering.
|
||||
|
||||
### 2.3.1 `Doc` documentation metadata
|
||||
|
||||
`Doc` attaches authored Markdown documentation to a named API declaration.
|
||||
|
||||
Canonical v1 shape:
|
||||
|
||||
```pbs
|
||||
[Doc(markdown = """
|
||||
Draws a sprite.
|
||||
|
||||
- `x`: screen x
|
||||
- `y`: screen y
|
||||
""")]
|
||||
```
|
||||
|
||||
Rules:
|
||||
|
||||
- `Doc` MUST declare exactly one named argument, `markdown`.
|
||||
- `Doc.markdown` MUST be a documentation text block.
|
||||
- `Doc` MUST NOT accept aliases or alternate forms such as `text`, positional arguments, `html`, `format`, `Document`, `Documentation`, or `md"""..."""`.
|
||||
- A declaration MUST NOT carry more than one `Doc` attribute.
|
||||
- Duplicate `Doc` attributes are static semantic errors and must not be rejected only as parser errors.
|
||||
- Attribute order is semantically irrelevant; `Doc` colocated with other valid attributes has the same meaning regardless of ordering.
|
||||
- `Doc` is valid only on named API declarations that introduce named semantic symbols and can carry attributes.
|
||||
- The v1 documentable surface includes functions, methods, classes/structs when present, services, hosts, builtin and stdlib declarations, and interface declarations.
|
||||
- Parameters MUST NOT receive `Doc` in v1. Parameter documentation, when present, MUST be authored inside the Markdown payload of the owning declaration.
|
||||
- Fields, enum cases, tuple fields, local variables, expressions, and other non-API declaration surfaces MUST NOT receive `Doc` unless a future decision explicitly classifies them as documentable named API declarations.
|
||||
- Documentation text block content MUST be normalized before semantic empty-payload validation and before exposure to editor consumers.
|
||||
- Normalization MUST remove an incidental leading empty line, remove an incidental trailing empty line, compute the common indentation of non-empty content lines, remove that common indentation, preserve internal line breaks, and preserve Markdown content after indentation normalization.
|
||||
- A normalized empty or whitespace-only `Doc.markdown` payload is invalid.
|
||||
- The authored format is a supported Markdown subset. Rendering, sanitization, and unsupported Markdown constructs are consumer responsibilities.
|
||||
- Compiler semantic metadata MUST preserve normalized Markdown documentation as metadata of the documented symbol.
|
||||
- LSP and editor consumers MUST consume compiler-resolved documentation metadata rather than reparsing source text.
|
||||
|
||||
### 2.4 Tuple shapes
|
||||
|
||||
@@ -167,6 +203,8 @@ The following constructs are callable in v1 core:
|
||||
Rules:
|
||||
|
||||
- All callable categories use the same input/output tuple model.
|
||||
- Every user-visible callable category MUST expose a semantic parameter list for editor and tooling consumers.
|
||||
- Each semantic parameter record MUST carry its canonical source/API name, zero-based order, type when known, and origin/source sufficient for implementation and diagnostics.
|
||||
- A struct method is identified by `(struct type, method name, input tuple shape excluding the receiver slot, output tuple shape)`.
|
||||
- A contract value is identified at the type level by its contract type and at runtime by an underlying concrete struct instance or service singleton value plus its selected implementation.
|
||||
- A callback declaration defines a nominal callable type with exactly one input/output tuple shape.
|
||||
@@ -177,6 +215,9 @@ Rules:
|
||||
- A callback value is identified at the type level by its declared callback type and signature.
|
||||
- Contract signatures and barrel signatures must preserve the same callable shape.
|
||||
- Canonical host primitive identity and binding are governed by the Host ABI Binding specification rather than by ordinary v1 core declaration identity alone.
|
||||
- The compiler semantic model is the canonical owner of callable parameter names for completion, signature help, hover, diagnostics, and other editor-facing surfaces.
|
||||
- Generated ordinal placeholders such as `arg0`, `arg1`, or equivalent names are internal implementation fallbacks only and MUST NOT be exposed as public parameter names.
|
||||
- If a user-visible callable lacks a real canonical parameter name, semantic metadata MUST represent that name as missing or unresolved rather than fabricating an ordinal placeholder.
|
||||
|
||||
### 3.3 Declaration validity
|
||||
|
||||
@@ -209,6 +250,8 @@ Rules:
|
||||
- A file may declare at most one `[Init]`.
|
||||
- The `[Init]` colocated with `[Frame]` is the project init.
|
||||
- Project init must be colocated with `[Frame]`.
|
||||
- PBS static semantics and lowering admit those markers and translate them into a typed `IRLifecycleDeclaration`.
|
||||
- PBS MUST NOT materialize module init, project-init wrapper, published frame wrapper, physical entrypoint, or boot guard; those artifacts belong to common lifecycle assembly.
|
||||
- `InitAllowed` is valid only on SDK host methods and is invalid on userland `fn`, `global`, `service`, `const`, `struct`, `contract`, and callback surfaces.
|
||||
- A host method signature in a reserved stdlib/interface module MUST carry exactly one `Host` attribute.
|
||||
- A host method signature in a reserved stdlib/interface module MUST carry exactly one `Capability` attribute.
|
||||
|
||||
+26
-3
@@ -343,6 +343,20 @@ This list fixes the currently required declarative role of interface modules, bu
|
||||
|
||||
An interface module is not runtime code.
|
||||
|
||||
### 9.2.1 Callable parameter identity
|
||||
|
||||
Stdlib and SDK interface modules define public callable surfaces. Their method and function signatures MUST preserve stable canonical parameter names in the compiler semantic callable model.
|
||||
|
||||
Rules:
|
||||
|
||||
- Stdlib and SDK-hosted callable definitions MUST carry parameter names, zero-based order, type when known, and source/origin metadata.
|
||||
- Stdlib and host-backed parameter names are part of the public API surface.
|
||||
- Renaming a public stdlib or host-backed parameter is API compatibility-sensitive and MUST be reviewed with the same discipline as other public callable-shape changes.
|
||||
- Interface-module loaders MUST NOT replace missing or unavailable public parameter names with generated ordinal placeholders such as `arg0` or `arg1`.
|
||||
- Missing canonical parameter identity MUST be represented as incomplete semantic metadata, not as a fabricated public name.
|
||||
- Stdlib, SDK, and interface-module API declarations SHOULD carry authored English documentation through `[Doc(markdown = """...""")]` once the documentation surface is implemented.
|
||||
- Stdlib and SDK parameter documentation MUST be authored inside the owning declaration's Markdown payload; parameters MUST NOT carry `[Doc]`.
|
||||
|
||||
### 9.3 Interface-module restrictions
|
||||
|
||||
At minimum, an interface module MUST remain declarative.
|
||||
@@ -363,7 +377,7 @@ Illustrative stdlib interface module:
|
||||
declare enum color(red, green, blue);
|
||||
|
||||
declare host Gfx {
|
||||
[Host(module = "gfx", name = "draw_pixel", version = 1)]
|
||||
[Host(module = "gfx2d", name = "draw_pixel", version = 1)]
|
||||
fn draw_pixel(x: int, y: int, c: color);
|
||||
}
|
||||
```
|
||||
@@ -379,7 +393,7 @@ Another valid reserved stdlib interface module in stdlib line `1` is the sprite-
|
||||
```pbs
|
||||
declare host LowComposer {
|
||||
[Host(module = "composer", name = "emit_sprite", version = 1)]
|
||||
[Capability(name = "gfx")]
|
||||
[Capability(name = "composer")]
|
||||
fn emit_sprite(
|
||||
glyph_id: int,
|
||||
palette_id: int,
|
||||
@@ -429,12 +443,21 @@ Rules:
|
||||
- Attributes are not exported as ordinary values, types, or runtime-reflectable objects.
|
||||
- Attributes do not automatically survive into bytecode, PBX, or runtime metadata.
|
||||
|
||||
`Doc` is a reserved documentation attribute for compiler/editor metadata.
|
||||
|
||||
Rules:
|
||||
|
||||
- Stdlib, SDK, and interface modules MUST use the same `[Doc(markdown = """...""")]` surface as ordinary PBS source for authored API documentation.
|
||||
- Authored source documentation takes precedence over imported or generated documentation for the same symbol.
|
||||
- Conflicts between authored and imported/generated documentation MUST be resolved deterministically or reported through explicit diagnostics.
|
||||
- `Doc` metadata enriches compiler/editor surfaces and MUST NOT change import resolution, host binding, ABI identity, executable lowering, or runtime behavior.
|
||||
|
||||
### 11.2 `Host` attribute
|
||||
|
||||
The canonical reserved host-binding attribute is:
|
||||
|
||||
```pbs
|
||||
[Host(module = "gfx", name = "draw_pixel", version = 1)]
|
||||
[Host(module = "gfx2d", name = "draw_pixel", version = 1)]
|
||||
```
|
||||
|
||||
Rules:
|
||||
|
||||
@@ -82,6 +82,8 @@ This document depends on, at minimum:
|
||||
|
||||
PBS distinguishes three ownership categories for callable behavior.
|
||||
|
||||
All categories share the callable parameter identity contract from the Static Semantics Specification. A PBS-visible callable MUST project canonical parameter names, order, type when known, and origin into the semantic callable model regardless of whether the behavior is program-owned, VM-owned, or host-backed.
|
||||
|
||||
### 5.1 Program-owned function
|
||||
|
||||
A program-owned function is authored by the program and compiled from a PBS body.
|
||||
@@ -129,6 +131,8 @@ Properties:
|
||||
Host-backed operations are the domain of `declare host`, PBX `SYSC`, loader
|
||||
resolution, and final `SYSCALL`.
|
||||
|
||||
Host-backed ownership changes runtime authority and lowering, but it does not remove source/API parameter identity. Host-backed callable parameter names remain public semantic metadata and MUST NOT be replaced with generated ordinal placeholders in editor-facing surfaces.
|
||||
|
||||
## 6. The Boundary Question
|
||||
|
||||
The normative classification question is:
|
||||
|
||||
@@ -106,6 +106,8 @@ reserved top-level `declare const` shell carrying builtin metadata.
|
||||
An intrinsic operation is a VM-owned callable behavior with canonical
|
||||
definition in the VM contract.
|
||||
|
||||
Visible intrinsic operations and builtin method surfaces MUST be projected into the same semantic callable parameter shape used by ordinary PBS callables. Each visible intrinsic parameter MUST expose a canonical name, order, type when known, and VM/intrinsic origin metadata. If an intrinsic registry entry or builtin descriptor lacks a real public parameter name, compiler/editor metadata MUST represent the name as missing or unresolved rather than publishing `arg0`, `arg1`, or another generated ordinal placeholder.
|
||||
|
||||
### 5.5 Canonical intrinsic registry artifact
|
||||
|
||||
Final intrinsic ids are owned by one canonical ISA-scoped registry artifact.
|
||||
|
||||
+26
-12
@@ -15,6 +15,10 @@ This document defines the current contract between:
|
||||
Its purpose is to let compiler and runtime work in parallel without diverging on the most critical boundary:
|
||||
how host-backed SDK calls become load-time-resolved numeric syscalls.
|
||||
|
||||
PBS `declare host` / `[Host]` shells are compile-time delivery. The
|
||||
loader-facing catalog is runtime-owned. This document MUST NOT publish syscall
|
||||
IDs or `SyscallMeta`.
|
||||
|
||||
This document is intentionally narrower than a full PBX or VM specification.
|
||||
It focuses on loader behavior and the minimum artifact contract the loader must consume.
|
||||
|
||||
@@ -44,16 +48,20 @@ This document does not define:
|
||||
|
||||
This document follows two prior decisions:
|
||||
|
||||
1. Canonical host identity is defined by the hardware ABI as `(module, name, version)`.
|
||||
1. Canonical host identity is defined by the runtime host registry as `(module, name, version)`.
|
||||
2. User code does not declare host bindings directly; SDK/toolchain-controlled modules expose reserved `declare host` surfaces and the compiler lowers those usages into PBX host-binding metadata.
|
||||
|
||||
PBS shells MUST repeat identities already published by the runtime registry
|
||||
(`../runtime/docs/specs/runtime/16-host-abi-and-syscalls.md` and `SyscallMeta`).
|
||||
They MUST NOT invent `(module, name, version)`.
|
||||
|
||||
This document therefore treats:
|
||||
|
||||
- `declare host Gfx { fn draw_pixel(...); }`
|
||||
- `declare host LowGfx { [Host(module = "gfx2d", name = "clear", version = 1)] fn clear(...); }`
|
||||
|
||||
as compile-time surface only, and treats:
|
||||
|
||||
- `("gfx", "draw_pixel", 1)`
|
||||
- `("gfx2d", "clear", 1)`
|
||||
|
||||
as the normative runtime-facing identity.
|
||||
|
||||
@@ -63,7 +71,7 @@ The host-binding pipeline is:
|
||||
|
||||
1. User code imports SDK surfaces such as `Gfx` from `@sdk:gfx` and `Composer` from `@sdk:composer`.
|
||||
2. The compiler resolves those surfaces against the selected stdlib line.
|
||||
3. The compiler maps each host-backed SDK member to a canonical identity `(module, name, version)`.
|
||||
3. The compiler maps each host-backed SDK member to a canonical identity `(module, name, version)` that already exists in the runtime host registry.
|
||||
4. The compiler emits those required canonical identities into the PBX `SYSC` table.
|
||||
5. The compiler emits pre-load host call sites as `HOSTCALL <sysc_index>`.
|
||||
6. At cartridge load time, the loader resolves `SYSC` entries against the host syscall registry.
|
||||
@@ -84,7 +92,7 @@ Every host binding is identified by the triple:
|
||||
|
||||
Rules:
|
||||
|
||||
- `module` is the canonical host subsystem namespace, such as `gfx` or `audio`.
|
||||
- `module` is the canonical host subsystem namespace, such as `gfx2d` or `asset`.
|
||||
- `name` is the canonical host operation name within that module.
|
||||
- `version` is the canonical ABI version of that host operation.
|
||||
- This identity is stable across source languages and SDK naming styles.
|
||||
@@ -110,6 +118,9 @@ Rules:
|
||||
- `declare host` exists to define compile-time interface shape, not executable PBS bodies.
|
||||
- The compiler is responsible for mapping each host-backed member to its canonical host identity.
|
||||
- The PBX must not depend on source spellings such as `Gfx` for runtime resolution.
|
||||
- Host-backed source/API signatures MUST preserve their canonical parameter names in compiler semantic callable metadata.
|
||||
- Host-backed parameter names are public API surface and are compatibility-sensitive.
|
||||
- Loader-facing slot counts and canonical host identity do not license compiler or editor surfaces to publish generated parameter names such as `arg0` or `arg1`.
|
||||
|
||||
Example:
|
||||
|
||||
@@ -124,8 +135,8 @@ The source-level call may originate from an SDK declaration such as:
|
||||
|
||||
```pbs
|
||||
declare host Gfx {
|
||||
[Host(module = "gfx", name = "draw_pixel", version = 1)]
|
||||
[Capability(name = "gfx")]
|
||||
[Host(module = "gfx2d", name = "draw_pixel", version = 1)]
|
||||
[Capability(name = "gfx2d")]
|
||||
fn draw_pixel(x: int, y: int, c: color);
|
||||
}
|
||||
```
|
||||
@@ -142,15 +153,15 @@ For example, the PBS-facing declaration:
|
||||
```pbs
|
||||
declare host LowComposer {
|
||||
[Host(module = "composer", name = "bind_scene", version = 1)]
|
||||
[Capability(name = "gfx")]
|
||||
[Capability(name = "composer")]
|
||||
fn bind_scene(scene_bank_id: int) -> int;
|
||||
|
||||
[Host(module = "composer", name = "unbind_scene", version = 1)]
|
||||
[Capability(name = "gfx")]
|
||||
[Capability(name = "composer")]
|
||||
fn unbind_scene() -> int;
|
||||
|
||||
[Host(module = "composer", name = "emit_sprite", version = 1)]
|
||||
[Capability(name = "gfx")]
|
||||
[Capability(name = "composer")]
|
||||
fn emit_sprite(
|
||||
glyph_id: int,
|
||||
palette_id: int,
|
||||
@@ -307,7 +318,10 @@ Rules:
|
||||
- the loader resolves only against this canonical registry,
|
||||
- unknown identities are load errors,
|
||||
- successful resolution yields numeric syscall identifiers and associated metadata,
|
||||
- the resolved metadata is authoritative for capability gating and later runtime verification.
|
||||
- the resolved metadata is authoritative for capability gating and later runtime verification,
|
||||
- PBS `declare host` / `[Host]` shells MUST repeat identities from this registry,
|
||||
- PBS shells MUST NOT invent `(module, name, version)`,
|
||||
- this specification MUST NOT publish the syscall catalog; runtime spec 16 and `SyscallMeta` do.
|
||||
|
||||
For the current asset runtime surface, the canonical registry entries include:
|
||||
|
||||
@@ -450,7 +464,7 @@ The cartridge manifest is the current declarative source for requested runtime c
|
||||
Rules:
|
||||
|
||||
- cartridge capability declarations are external to `program.pbx`,
|
||||
- capability declarations are serializable nominal identifiers such as `gfx` or `audio`,
|
||||
- capability declarations are serializable nominal identifiers such as `gfx2d`, `composer`, or `audio`,
|
||||
- the loader converts that nominal declaration into the internal capability flag set used by the runtime,
|
||||
- the loader MUST NOT infer granted authority solely from the presence of `SYSC` entries.
|
||||
|
||||
|
||||
+7
-5
@@ -62,7 +62,7 @@ The current manifest shape relevant to this document is:
|
||||
"title": "Example",
|
||||
"app_version": "1.0.0",
|
||||
"app_mode": "game",
|
||||
"capabilities": ["gfx", "input"],
|
||||
"capabilities": ["gfx2d", "input"],
|
||||
"asset_table": [],
|
||||
"preload": []
|
||||
}
|
||||
@@ -96,7 +96,8 @@ Rules:
|
||||
The current nominal capability set is:
|
||||
|
||||
- `system`
|
||||
- `gfx`
|
||||
- `gfx2d`
|
||||
- `composer`
|
||||
- `input`
|
||||
- `audio`
|
||||
- `fs`
|
||||
@@ -123,7 +124,8 @@ The normative external model is:
|
||||
Canonical mapping:
|
||||
|
||||
- `system` -> `SYSTEM`
|
||||
- `gfx` -> `GFX`
|
||||
- `gfx2d` -> `GFX2D`
|
||||
- `composer` -> `COMPOSER`
|
||||
- `input` -> `INPUT`
|
||||
- `audio` -> `AUDIO`
|
||||
- `fs` -> `FS`
|
||||
@@ -221,7 +223,7 @@ Recommended JSON:
|
||||
|
||||
```json
|
||||
{
|
||||
"capabilities": ["gfx", "input", "audio"]
|
||||
"capabilities": ["gfx2d", "input", "audio"]
|
||||
}
|
||||
```
|
||||
|
||||
@@ -244,7 +246,7 @@ The current temporary contract is:
|
||||
|
||||
1. `manifest.json` is the cartridge-facing load descriptor.
|
||||
2. `capabilities` is declared in `manifest.json`, not in `prometeu.json`.
|
||||
3. `capabilities` uses nominal canonical names such as `gfx` and `audio`.
|
||||
3. `capabilities` uses nominal canonical names such as `gfx2d`, `composer`, and `audio`.
|
||||
4. The runtime may keep using internal `CapFlags`.
|
||||
5. The loader converts nominal manifest capabilities into internal flags.
|
||||
6. PBX `SYSC` declares required host bindings, not authority.
|
||||
|
||||
+52
-33
@@ -16,7 +16,11 @@ Its purpose is to make the stdlib:
|
||||
|
||||
This document complements the normative language-level model in:
|
||||
|
||||
- [5. Manifest, Stdlib, and SDK Resolution Specification.md](/Users/niltonconstantino/personal/workspace.personal/intrepid/prometeu/studio/docs/specs/pbs/5.%20Manifest,%20Stdlib,%20and%20SDK%20Resolution%20Specification.md)
|
||||
- [5. Manifest, Stdlib, and SDK Resolution Specification.md](5.%20Manifest%2C%20Stdlib%2C%20and%20SDK%20Resolution%20Specification.md)
|
||||
|
||||
This document is PBS packaging. It MUST NOT define console ABI. Intrinsic
|
||||
`final_id` values and host `SyscallMeta` remain runtime-owned. Physical stdlib
|
||||
path MUST NOT imply VM-owned versus host-backed ownership.
|
||||
|
||||
## 2. Scope
|
||||
|
||||
@@ -53,52 +57,66 @@ The recommended Studio layout is:
|
||||
```text
|
||||
prometeu-compiler/frontends/prometeu-frontend-pbs/
|
||||
src/main/resources/
|
||||
stdlib/
|
||||
1/
|
||||
sdk/
|
||||
composer/
|
||||
main.pbs
|
||||
mod.barrel
|
||||
gfx/
|
||||
main.pbs
|
||||
mod.barrel
|
||||
asset/
|
||||
main.pbs
|
||||
mod.barrel
|
||||
audio/
|
||||
main.pbs
|
||||
mod.barrel
|
||||
core/
|
||||
math/
|
||||
main.pbs
|
||||
mod.barrel
|
||||
<target>/
|
||||
stdlib/
|
||||
1/
|
||||
core/
|
||||
color/
|
||||
main.pbs
|
||||
mod.barrel
|
||||
sdk/
|
||||
asset/
|
||||
main.pbs
|
||||
mod.barrel
|
||||
composer/
|
||||
main.pbs
|
||||
mod.barrel
|
||||
gfx/
|
||||
main.pbs
|
||||
mod.barrel
|
||||
input/
|
||||
main.pbs
|
||||
mod.barrel
|
||||
log/
|
||||
main.pbs
|
||||
mod.barrel
|
||||
```
|
||||
|
||||
Interpretation:
|
||||
|
||||
- `stdlib/1` selects stdlib major line `1`,
|
||||
- `<target>` is the `AppMode` export name (`game` for the current line-1 environment),
|
||||
- `game/stdlib/1` selects stdlib major line `1` for that target,
|
||||
- `sdk` and `core` are reserved project spaces,
|
||||
- `composer`, `gfx`, `audio`, `math` are module paths within those reserved spaces,
|
||||
- current line `1` modules are `color`, `asset`, `composer`, `gfx`, `input`, and `log`,
|
||||
- `main.pbs` and `mod.barrel` form the interface module contents.
|
||||
|
||||
Current line `1` MUST NOT be documented as shipping `audio` or `@core:math`.
|
||||
Those names are not packaged in the current environment. `@sdk:input` is a
|
||||
VM-owned builtin shell; its path does not make it host-backed.
|
||||
|
||||
## 5. Logical Mapping
|
||||
|
||||
The compiler must treat the physical layout as a logical stdlib environment.
|
||||
|
||||
Required mapping:
|
||||
|
||||
- `stdlib/<N>/sdk/gfx` -> `@sdk:gfx`
|
||||
- `stdlib/<N>/sdk/composer` -> `@sdk:composer`
|
||||
- `stdlib/<N>/sdk/asset` -> `@sdk:asset`
|
||||
- `stdlib/<N>/sdk/audio` -> `@sdk:audio`
|
||||
- `stdlib/<N>/core/math` -> `@core:math`
|
||||
- `stdlib/<N>/core/math/vector` -> `@core:math/vector`
|
||||
- `<target>/stdlib/<N>/<space>/<module>` -> `@<space>:<module>`
|
||||
|
||||
Current line `1` (`game`) mapping:
|
||||
|
||||
- `game/stdlib/1/core/color` -> `@core:color`
|
||||
- `game/stdlib/1/sdk/asset` -> `@sdk:asset`
|
||||
- `game/stdlib/1/sdk/composer` -> `@sdk:composer`
|
||||
- `game/stdlib/1/sdk/gfx` -> `@sdk:gfx`
|
||||
- `game/stdlib/1/sdk/input` -> `@sdk:input`
|
||||
- `game/stdlib/1/sdk/log` -> `@sdk:log`
|
||||
|
||||
Rules:
|
||||
|
||||
- physical storage is an implementation detail,
|
||||
- logical module identity is authoritative,
|
||||
- callers of the resolver should work with logical addresses such as `@sdk:gfx` and `@sdk:composer`, not resource paths.
|
||||
- callers of the resolver should work with logical addresses such as `@sdk:gfx` and `@core:color`, not resource paths,
|
||||
- physical path MUST NOT imply VM-owned versus host-backed ownership.
|
||||
|
||||
## 6. Module File Convention
|
||||
|
||||
@@ -150,7 +168,8 @@ Minimum operations:
|
||||
|
||||
- `resolve(@sdk:gfx)`
|
||||
- `resolve(@sdk:composer)`
|
||||
- `resolve(@core:math/vector)`
|
||||
- `resolve(@sdk:input)`
|
||||
- `resolve(@core:color)`
|
||||
|
||||
### 7.3 `StdlibModuleSource`
|
||||
|
||||
@@ -208,7 +227,7 @@ Stdlib interface modules may contain reserved compile-time attributes such as:
|
||||
|
||||
```pbs
|
||||
declare host Gfx {
|
||||
[Host(module = "gfx", name = "draw_pixel", version = 1)]
|
||||
[Host(module = "gfx2d", name = "draw_pixel", version = 1)]
|
||||
fn draw_pixel(x: int, y: int, c: color);
|
||||
}
|
||||
```
|
||||
@@ -229,7 +248,7 @@ or:
|
||||
```pbs
|
||||
declare host LowComposer {
|
||||
[Host(module = "composer", name = "emit_sprite", version = 1)]
|
||||
[Capability(name = "gfx")]
|
||||
[Capability(name = "composer")]
|
||||
fn emit_sprite(
|
||||
glyph_id: int,
|
||||
palette_id: int,
|
||||
@@ -253,7 +272,7 @@ Rules:
|
||||
- later lowering stages may consume the extracted metadata to produce PBX host-binding declarations.
|
||||
- stdlib line `1` MUST expose the sprite-composition interface module at `@sdk:composer`,
|
||||
- that module MUST declare `LowComposer` and public service `Composer`,
|
||||
- that module MUST use runtime module `composer` and capability `gfx`,
|
||||
- that module MUST use runtime module `composer` and capability `composer`,
|
||||
- that module MUST expose `bind_scene(scene_bank_id: int) -> int`,
|
||||
- that module MUST expose `unbind_scene() -> int`,
|
||||
- that module MUST expose `emit_sprite(glyph_id: int, palette_id: int, x: int, y: int, layer: int, bank_id: int, flip_x: bool, flip_y: bool, priority: int) -> int`,
|
||||
|
||||
@@ -102,17 +102,21 @@ Executable PBS programs have a logical bootstrap sequence before ordinary frame
|
||||
Normative order:
|
||||
|
||||
1. materialize globals for each file according to dependency order,
|
||||
2. execute that file's `[Init]`, if present,
|
||||
2. execute that file's non-project `[Init]`, if present,
|
||||
3. compose those steps into one synthetic module init per module,
|
||||
4. execute project init, if present,
|
||||
4. execute project init exactly once, if present, after all module initializers,
|
||||
5. then invoke the userland callable marked with `[Frame]`.
|
||||
|
||||
The `[Init]` colocated with `[Frame]` is project init. It MUST NOT also run as a file-init fragment.
|
||||
|
||||
Lifecycle bootstrap is one-shot:
|
||||
|
||||
- no automatic retry occurs after boot failure,
|
||||
- failure during module init aborts boot,
|
||||
- failure during project init aborts boot.
|
||||
|
||||
Common lifecycle assembly materializes this order from the typed declaration. PBS remains the language source of marker meaning; it is not the owner of the published wrapper.
|
||||
|
||||
## 6.2 Logical frame root and physical wrapper
|
||||
|
||||
PBS distinguishes the logical frame root from the physical published entrypoint:
|
||||
|
||||
@@ -98,6 +98,18 @@ At minimum, each language corpus must retain:
|
||||
|
||||
Regression grouping by language is expected; one shared monolithic corpus is not required.
|
||||
|
||||
### 6.1 Callable parameter identity regressions
|
||||
|
||||
PBS conformance tests MUST protect user-visible callable parameter identity.
|
||||
|
||||
At minimum, tests MUST prove that:
|
||||
|
||||
1. user-authored callable parameters preserve canonical names, order, type when known, and origin in semantic metadata,
|
||||
2. stdlib, builtins, host-backed APIs, and visible intrinsics project parameter identity through the same semantic callable model,
|
||||
3. editor-facing compiler outputs for completion, signature help, hover, and parameter documentation do not leak generated ordinal placeholders such as `arg0` or `arg1`,
|
||||
4. missing canonical parameter names are represented as incomplete metadata rather than fabricated public names,
|
||||
5. and stdlib or host-backed parameter renames are treated as public API compatibility changes.
|
||||
|
||||
## 7. Claims and Evidence
|
||||
|
||||
For PBS quality claims at this stage:
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# PBS Bytecode and PBX Mapping Specification
|
||||
# Bytecode and PBX Mapping Specification
|
||||
|
||||
Status: Draft v1 (Backend Baseline)
|
||||
Applies to: mapping from lowered/optimized backend programs into PBX sections, bytecode-facing artifacts, and source-to-artifact invariants required by loader/verifier/runtime
|
||||
@@ -9,6 +9,10 @@ This document defines the normative mapping between backend-lowered semantics an
|
||||
|
||||
Its purpose is to keep artifact emission deterministic and compatible with runtime loader/verifier contracts.
|
||||
|
||||
PBX is the only executable boundary between the compiler and runtime. `IRVM`
|
||||
is a compiler-internal representation consumed by bytecode emission; it MUST
|
||||
NOT be exposed to or consumed by the runtime loader, verifier, or PVM.
|
||||
|
||||
## 2. Scope
|
||||
|
||||
This document defines:
|
||||
|
||||
@@ -7,6 +7,9 @@ Applies to: normative stdlib-facing API surface, reserved stdlib project spaces,
|
||||
|
||||
This document will define the normative user-facing standard-library surface for PBS.
|
||||
|
||||
This document is PBS delivery. It does not own console ABI. Intrinsic
|
||||
`final_id` values and host syscall metadata are runtime-owned.
|
||||
|
||||
## 2. Scope
|
||||
|
||||
This document is intended to define:
|
||||
@@ -28,15 +31,22 @@ This document does not define:
|
||||
|
||||
Normative precedence:
|
||||
|
||||
1. `5. Manifest, Stdlib, and SDK Resolution Specification.md`
|
||||
2. `8. Stdlib Environment Packaging and Loading Specification.md`
|
||||
3. `6. VM-owned vs Host-backed.md`
|
||||
4. `6.1. Intrinsics and Builtin Types Specification.md`
|
||||
5. `6.2. Host ABI Binding and Loader Resolution Specification.md`
|
||||
6. This document
|
||||
1. Runtime intrinsic catalog (`../runtime/docs/vm-arch/INTRINSICS.csv`; Studio mirror `docs/vm-arch/INTRINSICS.csv`)
|
||||
2. Runtime host ABI (`../runtime/docs/specs/runtime/16-host-abi-and-syscalls.md` and `SyscallMeta`)
|
||||
3. `5. Manifest, Stdlib, and SDK Resolution Specification.md`
|
||||
4. `8. Stdlib Environment Packaging and Loading Specification.md`
|
||||
5. `6. VM-owned vs Host-backed.md`
|
||||
6. `6.1. Intrinsics and Builtin Types Specification.md`
|
||||
7. `6.2. Host ABI Binding and Loader Resolution Specification.md`
|
||||
8. This document
|
||||
|
||||
If a rule here conflicts with higher-precedence specs, it is invalid.
|
||||
|
||||
This document MUST NOT define numeric syscall identifiers, intrinsic `final_id`
|
||||
values, or `SyscallMeta`. PBS `[Host]` and `[IntrinsicCall]` attributes MUST
|
||||
repeat identities already published by those runtime catalogs. They MUST NOT
|
||||
invent console ABI.
|
||||
|
||||
## 4. Normative Inputs
|
||||
|
||||
This document depends on, at minimum:
|
||||
@@ -57,6 +67,9 @@ The following inputs are already fixed elsewhere and must not be contradicted he
|
||||
- User code must import stdlib modules explicitly.
|
||||
- Canonical host identity comes from reserved host-binding metadata, not from source owner spelling.
|
||||
- VM-owned builtin type, builtin constant, and intrinsic surfaces may be exposed through reserved stdlib shells without transferring semantic ownership away from the VM.
|
||||
- Console ABI authority is runtime-owned. PBS stdlib is delivery.
|
||||
- Reserved project-space path (`@sdk:*` / `@core:*`) MUST NOT imply VM-owned versus host-backed ownership.
|
||||
- Current stdlib line `1` ships a VM-owned builtin input shell at `@sdk:input`. That exception does not make `@sdk:*` the VM-owned space.
|
||||
|
||||
## 6. Initial Section Targets
|
||||
|
||||
@@ -78,7 +91,10 @@ The following items remain to be closed in future agenda discussion.
|
||||
- Whether `@core:*` is specified as language-adjacent utility surface or as ordinary stdlib contract.
|
||||
- How stdlib API evolution is documented and conformance-tested.
|
||||
- Whether some interface modules remain toolchain-private and outside user-facing stdlib surface.
|
||||
- Whether builtin shells may appear in `@sdk:*` as well as `@core:*`, or whether `@sdk:*` should remain host-facing only by policy.
|
||||
|
||||
Settled by DEC-0048 and not reopened here:
|
||||
|
||||
- Builtin shells MAY appear in `@sdk:*` as well as `@core:*`. Path MUST NOT imply ownership. Current line `1` exception: `@sdk:input`.
|
||||
|
||||
## 8. Non-Goals
|
||||
|
||||
@@ -127,6 +143,12 @@ Rules:
|
||||
- but ownership remains governed by the VM-owned vs host-backed classification,
|
||||
- and placing a builtin shell in stdlib does not make it host-backed.
|
||||
|
||||
Current line `1` exception:
|
||||
|
||||
- `@sdk:input` exposes VM-owned builtin input types through `[BuiltinType]` and `[IntrinsicCall]`.
|
||||
- that module is not host-backed.
|
||||
- the `@sdk:*` preference for host-backed APIs still holds for new host modules.
|
||||
|
||||
## 11. Builtin Shell Surfaces
|
||||
|
||||
Reserved stdlib modules may expose builtin declarations as compile-time-only
|
||||
@@ -175,10 +197,12 @@ Rules:
|
||||
- `Composer.bind_scene(scene_bank_id: int)` MUST lower through canonical host identity `("composer", "bind_scene", 1)`.
|
||||
- `Composer.unbind_scene()` MUST lower through canonical host identity `("composer", "unbind_scene", 1)`.
|
||||
- `Composer.emit_sprite(...)` MUST lower through canonical host identity `("composer", "emit_sprite", 1)`.
|
||||
- `@sdk:composer` host bindings MUST require manifest capability `composer`.
|
||||
- `Composer.bind_scene(...)` MUST return a raw `int` in stdlib line `1`.
|
||||
- `Composer.unbind_scene()` MUST return a raw `int` in stdlib line `1`.
|
||||
- `Composer.emit_sprite(...)` MUST return a raw `int` in this wave.
|
||||
- `@sdk:gfx` MAY continue to expose primitive and overlay-oriented operations.
|
||||
- `@sdk:gfx` host bindings MUST require manifest capability `gfx2d`.
|
||||
- `@sdk:gfx` MUST NOT expose `set_sprite`.
|
||||
- `set_camera` may remain deferred if not yet exposed by the active stdlib line.
|
||||
|
||||
@@ -203,6 +227,10 @@ Their canonical runtime-facing identities still come from builtin metadata such
|
||||
as `BuiltinType(name="vec2", version=1)` and
|
||||
`BuiltinConst(target="vec2", name="zero", version=1)`.
|
||||
|
||||
Current stdlib line `1` ships `Color` at `@core:color`. The `@core:math` import
|
||||
above is an identity illustration, not a claim that `@core:math` is packaged in
|
||||
line `1`.
|
||||
|
||||
## 14. Deterministic Stdlib Surface Failures
|
||||
|
||||
At minimum, a conforming implementation must reject:
|
||||
@@ -212,3 +240,15 @@ At minimum, a conforming implementation must reject:
|
||||
3. a user-facing stdlib module that exports executable PBS bodies for builtin semantics,
|
||||
4. a stdlib line that exposes conflicting canonical builtin identities through the same resolved environment,
|
||||
5. a stdlib line that exposes conflicting canonical host identities through the same resolved environment.
|
||||
|
||||
## 15. Console ABI Non-Ownership
|
||||
|
||||
This specification MUST NOT:
|
||||
|
||||
1. define numeric syscall identifiers,
|
||||
2. define intrinsic `final_id` values,
|
||||
3. publish `SyscallMeta`,
|
||||
4. or treat PBS `[Host]` / `[IntrinsicCall]` attributes as the ABI catalog.
|
||||
|
||||
PBS shells MUST repeat identities already published by the runtime catalogs
|
||||
named in section 3.
|
||||
|
||||
@@ -1,18 +1,21 @@
|
||||
# PBS Verification and Safety Checks Specification
|
||||
# Compiler Verification and Safety Checks Specification
|
||||
|
||||
Status: Draft v1 (Quality-Gate Baseline)
|
||||
Applies to: test-backed safety gates for backend compiler stages and integration regression safety checks against runtime
|
||||
Applies to: test-backed safety gates for common compiler stages, validation ownership across executable frontends, and integration regression safety checks against runtime
|
||||
|
||||
## 1. Purpose
|
||||
|
||||
This document defines the minimum safety/verification quality gates that must be enforced for executable backend pipelines.
|
||||
This document defines the minimum safety/verification quality gates that must be enforced for executable compiler pipelines, and the ownership rule that separates language validation from platform validation.
|
||||
|
||||
Its purpose is to keep safety measurable and deterministic across:
|
||||
|
||||
- lowering,
|
||||
- optimization,
|
||||
- emission,
|
||||
- and runtime integration boundaries.
|
||||
- runtime integration boundaries,
|
||||
- and the classification of diagnostics that every executable frontend must obey.
|
||||
|
||||
PBS is the current executable frontend. It is an example, not the owner of this specification.
|
||||
|
||||
## 2. Scope
|
||||
|
||||
@@ -20,37 +23,41 @@ This document defines:
|
||||
|
||||
- mandatory compiler-stage safety checks for executable pipeline stages,
|
||||
- conditional integration safety regression checks against runtime line,
|
||||
- and evidence requirements for safety-related support claims.
|
||||
- evidence requirements for safety-related support claims,
|
||||
- and validation-ownership rules that apply to all executable frontends.
|
||||
|
||||
This document does not define:
|
||||
|
||||
- full runtime verifier algorithm internals,
|
||||
- formal proof of all runtime safety properties,
|
||||
- or one mandatory verifier/optimizer architecture.
|
||||
- one mandatory verifier/optimizer architecture,
|
||||
- PBS syntax or static-semantics catalogs,
|
||||
- or a generic validator-core package.
|
||||
|
||||
## 3. Authority and Precedence
|
||||
|
||||
Normative precedence:
|
||||
|
||||
1. `docs/pbs/specs/2. Governance and Versioning.md`
|
||||
2. `docs/pbs/specs/12. Diagnostics Specification.md`
|
||||
1. Runtime authority (`docs/specs/hardware/topics/chapter-2.md`, `chapter-3.md`, `chapter-9.md`, `chapter-12.md`, `chapter-16.md`)
|
||||
2. Bytecode authority (`docs/specs/bytecode/ISA_CORE.md`)
|
||||
3. `20. IRBackend to IRVM Lowering Specification.md`
|
||||
4. `21. IRVM Optimization Pipeline Specification.md`
|
||||
5. `15. Bytecode and PBX Mapping Specification.md`
|
||||
6. `13. Conformance Test Specification.md`
|
||||
7. This document
|
||||
8. Frontend diagnostics specifications, including `docs/specs/compiler-languages/pbs/12. Diagnostics Specification.md`, for language-owned coverage only
|
||||
|
||||
If a rule here conflicts with higher-precedence authorities, it is invalid.
|
||||
If a rule here conflicts with a higher-precedence authority, it is invalid. Frontend diagnostics documents MUST NOT redefine compiler-general safety gates or platform validation ownership.
|
||||
|
||||
## 4. Normative Inputs
|
||||
|
||||
This document depends on:
|
||||
|
||||
- `docs/pbs/specs/12. Diagnostics Specification.md`
|
||||
- `13. Conformance Test Specification.md`
|
||||
- `15. Bytecode and PBX Mapping Specification.md`
|
||||
- `20. IRBackend to IRVM Lowering Specification.md`
|
||||
- `21. IRVM Optimization Pipeline Specification.md`
|
||||
- `docs/specs/compiler-languages/pbs/12. Diagnostics Specification.md` as the current frontend diagnostics catalog, not as the owner of this specification
|
||||
|
||||
## 5. Safety Gate Model
|
||||
|
||||
@@ -133,3 +140,74 @@ This document is healthy when:
|
||||
2. executable backends have explicit S-I status (`pass`/`fail`/`deferred`),
|
||||
3. integration safety regressions are preserved in tests,
|
||||
4. and safety-related support claims remain evidence-backed.
|
||||
|
||||
## 11. Validation Ownership
|
||||
|
||||
A validation MUST live at the lowest layer that understands the failure without knowing the source language.
|
||||
|
||||
- A check is language-owned if it needs AST, tokens, a language marker, a barrel, or another source-language rule.
|
||||
- A check is platform-owned if it can be performed on `IRBackend`, `IRLifecycleDeclaration`, IRVM, PBX, host/capability tables, or ids.
|
||||
|
||||
Adding a validation MUST record:
|
||||
|
||||
1. the input artifact the check reads;
|
||||
2. whether that artifact is language source/AST/marker or a common contract;
|
||||
3. the matrix owner;
|
||||
4. the code family (`E_PARSE_*` / `E_SEM_*` / `E_LINK_*` / `E_HOST_*` versus `COMMON_*` / `LOWER_IRVM_*` / `MARSHAL_*`);
|
||||
5. whether the span comes from a common-contract origin or from language tokens/AST.
|
||||
|
||||
If item 2 is both, the implementation MUST emit two diagnostics with distinct identities, not one hybrid.
|
||||
|
||||
### 11.1 Diagnostic identity and span
|
||||
|
||||
Platform diagnostics MUST use `COMMON_*`, `LOWER_IRVM_*`, or `MARSHAL_*` codes and the phase of the pipeline stage that reports them.
|
||||
|
||||
PBS MUST keep its current `E_PARSE_*`, `E_SEM_*`, `E_LINK_*`, and `E_HOST_*` codes.
|
||||
|
||||
This specification MUST NOT rewrite diagnostic messages or renumber existing codes.
|
||||
|
||||
Common code MUST copy origin/span when the declaration, instruction, or metadata carries one. A missing origin MUST be a structural error. Implementations MUST NOT invent a span.
|
||||
|
||||
The same fact MAY exist on both sides. PBS explains the language rule; the common layer rejects an invalid handoff even when the frontend has no PBS markers. The two errors MUST keep distinct identities. Example: `E_SEM_MISSING_PROJECT_FRAME` and a missing frame root on an executable `IRLifecycleDeclaration`.
|
||||
|
||||
### 11.2 Initial ownership matrix
|
||||
|
||||
| Family | Owner | Status | Notes |
|
||||
| --- | --- | --- | --- |
|
||||
| Parse / syntax (`ParseErrors`) | `compiler/pbs` | language | remains |
|
||||
| Type, flow, declaration, const, and source-form global semantics | `compiler/pbs` | language | remains |
|
||||
| Markers `[Init]`, `[Frame]`, `InitAllowed`, signature, colocation | `compiler/pbs` | language | already split by lifecycle assembly |
|
||||
| `host call not allowed during init` | `compiler/pbs` | language | marker/source rule |
|
||||
| PBS linking (`PbsLinkErrors`, barrel, import, visibility) | `compiler/pbs` | language | do not extract |
|
||||
| Source shape of `[Host]` / `[Capability]` | `compiler/pbs` | language | host-admission split |
|
||||
| Canonical host-binding identity and capability over `IRReservedMetadata` | `compiler/general` | platform | classified; validator remains in the PBS package until a later plan |
|
||||
| Lifecycle assembler | `compiler/general` | platform | already implemented |
|
||||
| IRVM preconditions for wrapper, boot guard, origin | `compiler/general` | platform | already implemented |
|
||||
| `IRVMValidator`, lowering, marshal/bytecode | `compiler/general` | platform | already implemented |
|
||||
| `Addressable` / asset path | `compiler/general` | platform | classified; no extra migration in this specification |
|
||||
| Gates S-U/S-I | `compiler/general` | platform | this document |
|
||||
|
||||
### 11.3 Host admission, assets, and linking
|
||||
|
||||
Host admission is split:
|
||||
|
||||
- language owns the source shape of `[Host]` and `[Capability]`;
|
||||
- platform owns canonical binding identity `(module, name, version)`, unknown capability, undeclared capability, and inconsistent binding once those facts exist on `IRReservedMetadata`.
|
||||
|
||||
`PbsHostAdmissionValidator` MAY remain in the PBS package until a later plan. `E_HOST_*` MUST NOT be treated as eternal PBS semantics.
|
||||
|
||||
`Addressable` / asset-path resolution is platform-owned. This specification classifies it and MUST NOT move additional asset code.
|
||||
|
||||
PBS linking, barrel files, and `PbsLinkErrors` remain language-owned. `ResolveDeps` does not authorize extracting them.
|
||||
|
||||
### 11.4 What this section does not authorize
|
||||
|
||||
This specification MUST NOT be read as authorizing:
|
||||
|
||||
- a generic validator-core package;
|
||||
- moving `PbsHostAdmissionValidator` into a common package;
|
||||
- moving asset-resolution production code;
|
||||
- extracting PBS linking;
|
||||
- or reopening lifecycle-assembly ownership.
|
||||
|
||||
Platform validators MUST NOT depend on types from the PBS frontend module (`prometeu-frontend-pbs`). The package `p.studio.compiler.pbs` is not the complete boundary; facades shipped by that module remain PBS-owned. Platform validators MUST NOT discover roles from `__pbs.` prefixes.
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
# PBS IRBackend to IRVM Lowering Specification
|
||||
# IRBackend to IRVM Lowering Specification
|
||||
|
||||
Status: Draft v1 (Backend Baseline)
|
||||
Applies to: executable-backend lowering from `IRBackend` handoff into `IRVM`
|
||||
Applies to: executable-backend lowering from the common `IRBackend` handoff into `IRVM`
|
||||
|
||||
## 1. Purpose
|
||||
|
||||
@@ -9,11 +9,20 @@ This document defines the normative lowering contract from executable `IRBackend
|
||||
|
||||
Its purpose is to make backend lowering deterministic, reviewable, and compatible with runtime ISA/verification authority.
|
||||
|
||||
`IRBackend` is the common frontend-to-backend executable handoff. It is emitted by frontends and consumed by common backend stages. Backend lowering MUST NOT require PBS AST nodes, PBS tokens, PBS parser structures, PBS semantic objects, PBS editorial objects, or equivalent language-owned objects from future frontends.
|
||||
|
||||
`IRVM` is an internal compiler representation. It MUST be consumed by common
|
||||
compiler optimization and PBX emission stages, and it MUST NOT cross the
|
||||
compiler/runtime boundary or become an input, dependency, public type, or
|
||||
operational concept of the runtime loader, verifier, or PVM. PBX is the only
|
||||
executable artifact boundary between compiler and runtime.
|
||||
|
||||
## 2. Scope
|
||||
|
||||
This document defines:
|
||||
|
||||
- required backend preconditions before `IRBackend -> IRVM` starts,
|
||||
- allowed language-neutral `IRBackend` contract concepts at the backend boundary,
|
||||
- `IRVM` structural obligations needed before optimization/emission,
|
||||
- deterministic function-id assignment and control-flow lowering obligations,
|
||||
- callsite lowering obligations across function, host-backed, and VM-owned intrinsic paths,
|
||||
@@ -25,7 +34,8 @@ This document does not define:
|
||||
- binary PBX layout details,
|
||||
- loader patching internals,
|
||||
- runtime execution internals,
|
||||
- or one mandatory optimizer implementation.
|
||||
- one mandatory optimizer implementation,
|
||||
- or frontend-specific lowering rules before `IRBackend` emission.
|
||||
|
||||
## 3. Authority and Precedence
|
||||
|
||||
@@ -33,8 +43,8 @@ Normative precedence:
|
||||
|
||||
1. Runtime authority (`docs/specs/hardware/topics/chapter-2.md`, `chapter-3.md`, `chapter-9.md`, `chapter-12.md`, `chapter-16.md`)
|
||||
2. Bytecode authority (`docs/specs/bytecode/ISA_CORE.md`)
|
||||
3. `docs/specs/compiler-languages/pbs/13. Lowering IRBackend Specification.md`
|
||||
4. This document
|
||||
3. This document
|
||||
4. Frontend-specific lowering specifications, including `docs/specs/compiler-languages/pbs/13. Lowering IRBackend Specification.md`
|
||||
|
||||
If a rule here conflicts with higher-precedence authorities, it is invalid.
|
||||
|
||||
@@ -42,22 +52,106 @@ If a rule here conflicts with higher-precedence authorities, it is invalid.
|
||||
|
||||
This document depends on:
|
||||
|
||||
- `docs/specs/compiler-languages/pbs/13. Lowering IRBackend Specification.md`
|
||||
- `docs/specs/compiler-languages/pbs/6.1. Intrinsics and Builtin Types Specification.md`
|
||||
- `docs/specs/compiler-languages/pbs/6.2. Host ABI Binding and Loader Resolution Specification.md`
|
||||
- frontend-specific lowering specifications that emit the common `IRBackend` handoff
|
||||
- `15. Bytecode and PBX Mapping Specification.md`
|
||||
- `21. IRVM Optimization Pipeline Specification.md`
|
||||
|
||||
## 4.1 Common IRBackend Contract
|
||||
|
||||
At this boundary, `IRBackend` may contain only language-neutral compiler concepts required by executable backend lowering:
|
||||
|
||||
1. source identity and spans,
|
||||
2. modules and module identifiers,
|
||||
3. callable identities, signatures, names, arity, and type-shape surfaces,
|
||||
4. executable functions,
|
||||
5. instruction kinds and instruction metadata,
|
||||
6. globals and global origins,
|
||||
7. synthetic executable functions and synthetic origins,
|
||||
8. host-call metadata,
|
||||
9. intrinsic metadata,
|
||||
10. reserved metadata required for backend lowering,
|
||||
11. required runtime or platform capabilities,
|
||||
12. and an optional typed `IRLifecycleDeclaration` used as lifecycle provenance after common assembly.
|
||||
|
||||
The common backend contract MUST express these concepts as backend obligations, not as PBS syntax or PBS semantic rules. When a concept currently originates from PBS, the backend contract still owns only the language-neutral obligation carried by `IRBackend`.
|
||||
|
||||
### 4.3 IRLifecycleDeclaration
|
||||
|
||||
`IRLifecycleDeclaration` is the typed, immutable, serializable-by-design lifecycle provenance carried by `IRBackend`.
|
||||
|
||||
An executable handoff MUST contain exactly one declaration before common assembly. A deliberately non-executable handoff MAY omit it; absence MUST NOT synthesize a default `main` or published wrapper.
|
||||
|
||||
The declaration MUST represent, using ordered collections and typed ids:
|
||||
|
||||
1. modules in explicit dependency order,
|
||||
2. each module's ordered file-init fragment references,
|
||||
3. an optional project-init callable reference,
|
||||
4. and exactly one frame-root callable reference.
|
||||
|
||||
References MUST use `ModuleId`, `FileId`, `CallableId`, a typed role, and source attribution. The public shape MUST NOT expose maps, sets, callbacks, compiler services, or frontend-owned types.
|
||||
|
||||
`AssembleLifecyclePipelineStage` MUST run after `FrontendPhasePipelineStage` and before `LowerToIRVMPipelineStage`. `LifecycleAssemblerService` is the only owner of derived lifecycle artifacts: module init, project-init wrapper, published frame wrapper, physical entrypoint, and hidden boot guard. Those artifacts MUST use deterministic neutral internal identities. Common code MUST NOT discover roles from `__pbs.*` prefixes or depend on types from the PBS frontend module (`prometeu-frontend-pbs`). The package `p.studio.compiler.pbs` is not the complete boundary.
|
||||
|
||||
The declaration MUST remain available on the assembled `IRBackend` as typed provenance. Downstream inspection MUST use roles, ids, and origins rather than synthetic names.
|
||||
|
||||
Project init MUST be absent from file-init fragments and MUST execute exactly once, after all module initializers and before the frame root. Bootstrap failure MUST abort without retry. The boot guard MUST prevent a second bootstrap after successful completion. The published wrapper owns the final frame return.
|
||||
|
||||
The common backend contract MUST NOT expose or require:
|
||||
|
||||
1. `PbsExpression`, `PbsStatement`, `PbsToken`, or equivalent PBS-owned syntax objects,
|
||||
2. PBS parser cursors, parse contexts, parse nodes, or token kinds,
|
||||
3. PBS semantic validator internals,
|
||||
4. PBS editorial or language-service objects,
|
||||
5. or any type from the PBS frontend module (`prometeu-frontend-pbs`) or an equivalent language frontend module as part of the public backend handoff.
|
||||
|
||||
## 4.2 Serializable-by-Design Contract Shape
|
||||
|
||||
The public `IRBackend` handoff MUST remain serializable by design. This requirement does not select a wire format, schema language, RPC mechanism, process boundary, plugin runtime, or external frontend transport. It only constrains the public data shape so those choices remain possible later without redesigning the handoff.
|
||||
|
||||
Public `IRBackend` contract types MUST be modelable as an acyclic, deterministic data graph made of:
|
||||
|
||||
1. primitive values and strings,
|
||||
2. enums,
|
||||
3. immutable value objects,
|
||||
4. ordered lists,
|
||||
5. nullable or optional scalar fields only where absence is part of the contract,
|
||||
6. explicit identifier values for cross-references,
|
||||
7. and source attribution values such as file ids and spans.
|
||||
|
||||
The public handoff MUST NOT expose, require, or rely on:
|
||||
|
||||
1. callbacks, lambdas, service objects, registries, visitors, or live compiler services,
|
||||
2. frontend AST, parser, token, semantic, or editorial objects,
|
||||
3. mutable global state as part of interpretation,
|
||||
4. object identity equality as a semantic key,
|
||||
5. unordered collections where iteration order affects output,
|
||||
6. cyclic references between public handoff objects,
|
||||
7. lazy values whose result depends on current process state,
|
||||
8. or a selected wire format.
|
||||
|
||||
Cross-object references MUST use explicit ids or stable symbolic keys. Existing table-scoped identifiers such as `FileId`, `ModuleId`, `CallableId`, and `IntrinsicId` are valid handoff values when their table scope is explicit and deterministic. New typed ids SHOULD be introduced only when a concrete public handoff field would otherwise depend on textual identity, object identity, or a direct object reference.
|
||||
|
||||
Ordered collections MUST preserve deterministic order. Any map-like data that becomes part of the handoff MUST either be represented as an ordered list of entries or define deterministic key ordering before it reaches the public contract.
|
||||
|
||||
Initial enforcement for this contract SHOULD be audit and guardrail based: specs, reflection tests over public handoff surfaces, deterministic ordering tests, and targeted fixes for concrete leaks. A serializer or schema implementation is not required for conformance to this subsection.
|
||||
|
||||
## 5. Backend Entry Preconditions
|
||||
|
||||
Lowering from `IRBackend` to `IRVM` may start only when:
|
||||
|
||||
1. frontend admission to `IRBackend` is complete for the active slice,
|
||||
2. required callsite categories (`CALL_FUNC`/`CALL_HOST`/`CALL_INTRINSIC`) are available,
|
||||
3. required canonical host/intrinsic metadata is available for admitted callsites,
|
||||
4. dependency-scoped fail-fast exclusions have already been applied at the `IRBackend` boundary,
|
||||
5. compiler-selected published-wrapper entrypoint identity is present and unambiguous,
|
||||
6. and target `vm_profile` is selected deterministically.
|
||||
2. common lifecycle assembly has already materialized derived artifacts for an executable handoff,
|
||||
3. required callsite categories (`CALL_FUNC`/`CALL_HOST`/`CALL_INTRINSIC`) are available,
|
||||
4. required canonical host/intrinsic metadata is available for admitted callsites,
|
||||
5. dependency-scoped fail-fast exclusions have already been applied at the `IRBackend` boundary,
|
||||
6. compiler-selected published-wrapper entrypoint identity is present and unambiguous,
|
||||
7. and target `vm_profile` is selected deterministically.
|
||||
|
||||
Declaration validation, role uniqueness, explicit order, and rejection of frontend-preassembled derived artifacts belong to `LifecycleAssemblerService`. `IRBackend -> IRVM` MUST keep only backend preconditions on the assembled graph, such as published-wrapper identity, synthetic origin presence, and hidden boot-guard presence. It MUST NOT reconstruct lifecycle order from callable names.
|
||||
|
||||
Those common structural diagnostics are compiler-general. Classification, code families, and dual language/platform reporting are owned by `docs/specs/compiler/19. Verification and Safety Checks Specification.md` section 11. They MUST NOT be catalogued as PBS-facing required coverage.
|
||||
|
||||
## 6. IRVM Model Obligations
|
||||
|
||||
@@ -98,12 +192,15 @@ Function indexing must be deterministic:
|
||||
4. manifest-owned or name-only entrypoint fallback is forbidden,
|
||||
5. and identical admitted input graphs must produce identical function-id assignments.
|
||||
|
||||
For PBS executable lowering:
|
||||
For executable lowering:
|
||||
|
||||
- the userland callable marked with `[Frame]` remains the logical frame root,
|
||||
- the wrapper path must contain final `FRAME_RET`,
|
||||
- the declared frame-root callable remains the logical frame root,
|
||||
- the assembled published wrapper is the physical entrypoint,
|
||||
- the wrapper path must contain the final frame return,
|
||||
- and lowering must preserve that distinction through `IRVM`.
|
||||
|
||||
PBS `[Init]`/`[Frame]` markers are a frontend source of the declaration. The backend-owned obligation is the neutral requirement that the compiler-selected published wrapper be the physical entrypoint and that lifecycle provenance remain explicit in `IRBackend` through typed roles and ids. Neutral synthetic names are internal and are not a public ABI.
|
||||
|
||||
## 9. Callsite Lowering Obligations
|
||||
|
||||
### 9.1 Function calls
|
||||
@@ -150,7 +247,7 @@ Before bytecode emission, backend must run structural pre-verification on lowere
|
||||
7. and structural validity of host/intrinsic call forms.
|
||||
8. and structural validity of backend-owned symbolic-to-operational rewrites such as `Addressable -> asset_id`.
|
||||
|
||||
For PBS host-backed asset calls in v1, this validation includes the rewrite selected by preserved host metadata such as `[AssetLowering(param = N)]`.
|
||||
For host-backed asset calls in v1, this validation includes backend-owned symbolic-to-operational rewrites selected by preserved host metadata. PBS currently emits this designation from metadata such as `[AssetLowering(param = N)]`, but final operational resolution is a common backend obligation.
|
||||
|
||||
This pre-verification does not replace runtime verifier authority.
|
||||
|
||||
@@ -184,4 +281,6 @@ This document is healthy when:
|
||||
1. `IRBackend -> IRVM` obligations are explicit and testable,
|
||||
2. deterministic function/call/control-flow lowering rules are explicit,
|
||||
3. mandatory pre-verification boundary is explicit,
|
||||
4. and scope boundaries with optimization/emission specs are explicit.
|
||||
4. common backend obligations are not described as owned by PBS,
|
||||
5. frontend-specific lowering specs only own emission into `IRBackend`,
|
||||
6. and scope boundaries with optimization/emission specs are explicit.
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# PBS IRVM Optimization Pipeline Specification
|
||||
# IRVM Optimization Pipeline Specification
|
||||
|
||||
Status: Draft v1 (Pipeline Baseline)
|
||||
Applies to: placement and invariants of the `OptimizeIRVM` stage between lowering and bytecode emission
|
||||
@@ -9,6 +9,10 @@ This document defines the normative placement and safety invariants of the `Opti
|
||||
|
||||
Its purpose is to allow optimization in the backend pipeline without transferring semantic optimization responsibility to runtime.
|
||||
|
||||
`IRVM` is internal to the compiler. Optimization output MUST flow to PBX
|
||||
emission and MUST NOT be exposed as a runtime input or protocol. PBX remains the
|
||||
only executable boundary consumed by the runtime loader, verifier, and PVM.
|
||||
|
||||
## 2. Scope
|
||||
|
||||
This document defines:
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
Status: Draft v1 (Traceability Baseline)
|
||||
Applies to: compiler/backend conformance traceability for canonical stage order and entrypoint-specific contracts
|
||||
|
||||
Last Updated: 2026-03-30
|
||||
Last Updated: 2026-09-19
|
||||
|
||||
## 1. Purpose
|
||||
|
||||
@@ -13,7 +13,7 @@ This matrix maps each normative backend MUST from:
|
||||
2. `docs/specs/compiler/20. IRBackend to IRVM Lowering Specification.md`
|
||||
3. `docs/specs/compiler/21. IRVM Optimization Pipeline Specification.md`
|
||||
4. `docs/specs/compiler/23. Compiler Pipeline Entry Points Specification.md`
|
||||
5. `docs/specs/compiler-languages/pbs/13. Lowering IRBackend Specification.md` (Section 12 addendum only)
|
||||
5. `docs/specs/compiler-languages/pbs/13. Lowering IRBackend Specification.md` (PBS lowering obligations only)
|
||||
|
||||
to concrete positive/negative test evidence and current status.
|
||||
|
||||
@@ -40,6 +40,22 @@ to concrete positive/negative test evidence and current status.
|
||||
| G19-5.2.6 | Gate S-I MUST reject missing capability at load-time. | N/A | `BackendGateIIntegrationTest#gateI_rejectMissingCapability` | pass | |
|
||||
| G19-5.2.7 | Gate S-I MUST cover valid VM-owned intrinsic path. | `BackendGateIIntegrationTest#gateI_validIntrinsicPath` | N/A | pass | |
|
||||
| G19-5.2.8 | Gate S-I MUST cover repeatability across runtime line. | `RuntimeBackedCompatibilityAdapterTest#checkMustPassInStrictModeWhenRuntimeCommandIsValid`; `RuntimeBackedCompatibilityAdapterTest#checkMustBeRepeatableAcrossDeclaredRuntimeLinesInStrictMode` | `RuntimeBackedCompatibilityAdapterTest#checkMustFailInStrictModeWhenRuntimeCommandIsUnavailable` | pass | Multi-line repeatability is asserted with strict runtime-backed checks over distinct declared runtime lines. |
|
||||
| G19-11.1 | A validation MUST live at the lowest layer that understands the failure without knowing the source language. | `ValidationOwnershipSpecTest#spec19MustBeCompilerGeneralAndPublishValidationOwnership` | N/A | pass | Spec 19 section 11 states the classification rule. |
|
||||
| G19-11.2 | Spec 19 MUST publish the validation ownership matrix. | `ValidationOwnershipSpecTest#spec19MustBeCompilerGeneralAndPublishValidationOwnership` | N/A | pass | Matrix families include parse/syntax, PBS linking, and lifecycle assembler. |
|
||||
| G19-11.3 | Platform diagnostics MUST use `COMMON_*` / `LOWER_IRVM_*` / `MARSHAL_*` and MUST copy origin/span when present. | `ValidationOwnershipSpecTest#spec19MustBeCompilerGeneralAndPublishValidationOwnership`; `LifecycleAssemblerServiceTest#assembleMustRejectMissingFrameRootWithoutRepair` | N/A | pass | Code families and span policy are normative in spec 19 section 11.1. |
|
||||
| G19-11.4 | The same fact MAY exist as a language diagnostic and a platform diagnostic with distinct identities. | `ValidationOwnershipSpecTest#spec19MustBeCompilerGeneralAndPublishValidationOwnership` | N/A | pass | Dual reporting is required when a check reads both source and common contract. |
|
||||
| G19-11.5 | Host admission MUST split source attribute shape from canonical `IRReservedMetadata` identity without moving the PBS validator in this plan. | `ValidationOwnershipSpecTest#spec19MustBeCompilerGeneralAndPublishValidationOwnership` | N/A | pass | Classified as platform; validator remains in the PBS package. |
|
||||
| G19-11.6 | Platform validators MUST NOT depend on PBS frontend module types or match `__pbs.` prefixes. | `PbsModuleBoundaryArchTest#productionOutsideAllowlistMustNotDependOnPbsModuleTypes`; `CommonBackendPbsPrefixScanTest#commonLifecycleAndBackendMustNotDiscoverRolesFromPbsNamePrefixes` | N/A | pass | ArchUnit covers PBS module origin, including facades outside `p.studio.compiler.pbs`; source scan still rejects `__pbs.` in backend, lifecycle, and common pipeline stages. |
|
||||
| PBS12-11 | PBS diagnostics MUST NOT claim common structural lifecycle/IRVM failures as PBS required coverage. | `ValidationOwnershipSpecTest#pbsDiagnosticsMustNotClaimCommonStructuralFailures` | N/A | pass | PBS spec 12 points those failures at spec 19 section 11 and spec 20. |
|
||||
| G20-4.1.1 | `IRBackend` MUST be the common frontend-to-backend executable handoff. | `LowerToIRVMServiceTest#lowerMustAcceptManuallyConstructedCommonIRBackend` | N/A | pass | Direct backend lowering from manually constructed common IRBackend proves PBS parser/frontend services are not required. |
|
||||
| G20-4.1.2 | Common backend code MUST NOT depend on types from the PBS frontend module. | `PbsModuleBoundaryArchTest#productionOutsideAllowlistMustNotDependOnPbsModuleTypes`; `PbsModuleBoundaryArchTest#irBackendModelsMustNotDependOnPbsModuleTypes` | N/A | pass | ArchUnit rejects PBS-module origin types in common production code, including facades outside `p.studio.compiler.pbs`. |
|
||||
| G20-4.1.3 | Public `IRBackend` contract MUST NOT expose PBS AST, token, parser, semantic, or editorial types. | `IRBackendExecutableContractTest#publicIRBackendContractMustNotExposePbsTypes` | N/A | pass | Reflection guard covers public contract fields, constructors, methods, and record components. |
|
||||
| G20-4.2.1 | Public `IRBackend` contract types MUST remain modelable as an acyclic, deterministic data graph. | `IRBackendExecutableContractTest#publicIRBackendContractMustExposeOnlySerializableShapes`; `IRBackendExecutableContractTest#aggregatorMustEmitDeterministicOrderedPublicContractShape` | N/A | pass | Covers public shape guardrails, generic type arguments, ordered aggregate emission, table remapping, and capability de-duplication order. |
|
||||
| G20-4.2.2 | Public `IRBackend` contract types MUST NOT expose callbacks, services, mutable/unordered collection contracts, frontend-owned objects, process-dependent lazy values, cyclic public references, or wire-format commitments. | `IRBackendExecutableContractTest#publicIRBackendContractMustExposeOnlySerializableShapes` | N/A | pass | Reflection guard covers public contract fields, constructors, methods, record components, and generic type arguments. |
|
||||
| G20-4.2.3 | Public `IRBackend` cross-object references MUST use explicit ids or stable symbolic keys. | `IRBackendExecutableContractTest#publicIRBackendContractAuditMustClassifyAllowedSupportTypes`; `IRBackendExecutableContractTest#publicIRBackendContractMustUseExplicitIdsOrStableKeysForKnownReferences` | N/A | pass | Current audit found no concrete public serialization leak requiring model correction. Existing `FileId`, `ModuleId`, `CallableId`, and `IntrinsicId` remain explicit table-scoped identifiers. |
|
||||
| G20-4.3.1 | Executable `IRBackend` MUST carry a typed, ordered, id-based `IRLifecycleDeclaration` as provenance. | `IRBackendExecutableContractTest#aggregatorMustRemapTypedLifecycleReferencesAndPreserveDeclaredModuleOrder`; `LifecycleAssemblerServiceTest#assembleMustMaterializeNeutralLifecycleArtifactsInDeclaredOrder` | `IRBackendExecutableContractTest#aggregatorMustOmitLifecycleDeclarationWhenNoFileContributesOne` | pass | Declaration uses `ReadOnlyList`, typed ids, roles, and source attribution; aggregator remaps ids with explicit module order. |
|
||||
| G20-4.3.2 | Missing lifecycle declaration MUST mean a deliberately non-executable handoff and MUST NOT synthesize entrypoints. | `LifecycleAssemblerServiceTest#assembleMustNoOpWhenLifecycleDeclarationIsAbsent`; `AssembleLifecyclePipelineStageTest#runMustNoOpForDeliberatelyNonExecutableHandoff` | N/A | pass | Assembler and stage leave the backend unchanged when the declaration is absent. |
|
||||
| G20-4.3.3 | Common lifecycle assembly MUST be the exclusive owner of derived artifacts and MUST use neutral identities. | `LifecycleAssemblerServiceTest#assembleMustMaterializeNeutralLifecycleArtifactsInDeclaredOrder`; `CommonBackendPbsPrefixScanTest#commonLifecycleAndBackendMustNotDiscoverRolesFromPbsNamePrefixes`; `PbsModuleBoundaryArchTest#productionOutsideAllowlistMustNotDependOnPbsModuleTypes` | `LifecycleAssemblerServiceTest#assembleMustRejectPreMaterializedDerivedArtifacts` | pass | Derived wrappers and boot guard are common-owned; ArchUnit rejects PBS-module types and the source scan rejects `__pbs.` prefix matching. |
|
||||
| G20-6.2 | `IRVM_EXT` MUST declare structural metadata (`pops/pushes/is_branch/is_terminator`). | `IRVMValidatorTest#validateMustApplyStructuralMetadataForCustomInternalExtension`; `IRVMValidatorTest#validateMustRejectCustomInternalExtensionWhenStructuralMetadataUnderflowsStack`; `IRVMOp` record contract (`pops/pushes/branch/terminator/internal`) | N/A | pass | Dedicated extension fixtures now assert structural metadata is consumed by validation behavior. |
|
||||
| G20-6.3 | `IRVM_EXT` MUST be eliminable before bytecode emission. | `OptimizeIRVMServiceTest#optimizeDefaultPassesMustEliminateUnreachableInternalExtensionBeforeEmission` | `EmitBytecodePipelineStageTest#runMustFailWhenInternalOpcodesRemain`; `EmitBytecodePipelineStageTest#runMustFailWhenInternalOpcodesRemainEvenWithNonEmptyEmissionPlan`; `IRVMValidatorTest#validateMustRejectInternalOpcodeWhenConfigured` | pass | Optimizer elimination path and emit-stage hard rejection path are both covered. |
|
||||
| G20-6.4 | IRVM MUST preserve per-function slot and identity headers. | `IRVMProgramTest#constructorMustRejectModuleAndEmissionPlanMismatch` | `IRVMProgramTest#constructorMustRejectModuleAndEmissionPlanMismatch` | pass | Header mismatch is rejected deterministically. |
|
||||
@@ -67,14 +83,19 @@ to concrete positive/negative test evidence and current status.
|
||||
| G21-9.1 | Validation MUST include optimized-vs-non-optimized equivalence fixtures. | `OptimizeIRVMEquivalenceHarnessTest#optimizeOnOffMustPreserveObservableTraceForLoweredHostIntrinsicFixture`; `OptimizeIRVMEquivalenceHarnessTest#optimizeOnOffMustPreserveObservableTraceForConditionalJoinFixture`; `OptimizeIRVMEquivalenceHarnessTest#optimizeOnOffMustPreserveObservableTraceForSimpleLoopFixture`; `OptimizeIRVMEquivalenceHarnessTest#optimizeOnOffMustPreserveObservableTraceForLinearCallFixture` | N/A | pass | Dedicated opt on/off harness with reusable interpreter and deterministic trace assertions is in place. |
|
||||
| G21-9.2 | Validation MUST preserve known negative loader/verifier behavior. | `BackendSafetyGateSUTest#emitStageMustExposeMarshalingLinkageFailureDeterministically`; `BackendGateIIntegrationTest` rejection suite | N/A | pass | |
|
||||
| G21-9.3 | Validation MUST preserve deterministic artifact-level invariants. | `BackendSafetyGateSUTest#fullPipelineMustProduceDeterministicBytecodeForSameInput`; `BytecodeEmitterTest#emitMustRemainDeterministicAfterInterning` | N/A | pass | |
|
||||
| G23-5.1 | Canonical compiler pipeline MUST preserve the shared stage order through `WriteBytecodeArtifact`. | `MainProjectPipelineIntegrationTest#analyzeShouldNotWriteProgramBytecode`; `MainProjectPipelineIntegrationTest#compileShouldProduceInMemoryBytecodeWithoutWritingProgramBytecode`; `MainProjectPipelineIntegrationTest#buildShouldWriteProgramBytecode` | N/A | partial | Entrypoint execution now covers the full analyze -> compile -> build path, but a dedicated order-only assertion for every terminal boundary is still missing. |
|
||||
| G23-6.1 | `analyze` MUST terminate after `FrontendPhase` and MUST NOT execute backend artifact stages. | `MainProjectPipelineIntegrationTest#analyzeShouldNotWriteProgramBytecode` | N/A | pass | The integration fixture asserts the analysis snapshot contract and proves `program.pbx` is not written on the analysis path. |
|
||||
| G23-5.1 | Canonical compiler pipeline MUST preserve the shared stage order through `WriteBytecodeArtifact`. | `BuilderPipelineServiceOrderTest#canonicalOrderMustContainOptimizeBetweenLowerAndEmit`; `MainProjectPipelineIntegrationTest#analyzeShouldNotWriteProgramBytecode`; `MainProjectPipelineIntegrationTest#compileShouldProduceInMemoryBytecodeWithoutWritingProgramBytecode`; `MainProjectPipelineIntegrationTest#buildShouldWriteProgramBytecode` | N/A | pass | Dedicated order assertion now covers analyses, compile, and build stage lists, including `AssembleLifecyclePipelineStage`. |
|
||||
| G23-5.2 | `AssembleLifecyclePipelineStage` MUST run immediately after `FrontendPhasePipelineStage` and before IRVM lowering. | `BuilderPipelineServiceOrderTest#canonicalOrderMustContainOptimizeBetweenLowerAndEmit`; `BuilderPipelineServiceOrderTest#analyzeMustTerminateAfterLifecycleAssemblyWithoutBackendArtifacts` | N/A | pass | Analyses terminate at lifecycle assembly; compile stages begin at `LowerToIRVMPipelineStage`. |
|
||||
| G23-6.1 | `analyze` MUST terminate after `AssembleLifecycle` and MUST NOT execute backend artifact stages. | `BuilderPipelineServiceOrderTest#analyzeMustTerminateAfterLifecycleAssemblyWithoutBackendArtifacts`; `MainProjectPipelineIntegrationTest#analyzeShouldNotWriteProgramBytecode` | N/A | pass | Analyze returns an assembled executable `IRBackend` with no IRVM, bytecode, or file output. |
|
||||
| G23-6.2 | `compile` MUST terminate after `VerifyBytecode` and MUST return a validated in-memory executable result without disk write. | `MainProjectPipelineIntegrationTest#compileShouldProduceInMemoryBytecodeWithoutWritingProgramBytecode`; `BuilderPipelinePublicSurfaceTest#compileResultMustExposeValidatedInMemoryArtifacts` | N/A | pass | Coverage asserts validated in-memory bytecode artifacts and the no-write boundary for `compile`. |
|
||||
| G23-6.3 | `build` MUST extend `compile` only with terminal artifact persistence. | `MainProjectPipelineIntegrationTest#buildShouldWriteProgramBytecode`; `BuilderPipelinePublicSurfaceTest#buildResultMustExposeArtifactPathAndCompilePayload` | N/A | pass | Coverage asserts that `build` retains the compile payload and writes the filesystem artifact path expected by callers. |
|
||||
| G23-7.1 | `AnalysisSnapshot` MUST expose the minimum shared analysis contract. | `MainProjectPipelineIntegrationTest#analyzeShouldNotWriteProgramBytecode`; `BuilderPipelinePublicSurfaceTest#analysisSnapshotMustExposeMinimumSharedContract` | N/A | pass | Both executable and structural contract checks now cover the shared minimum analysis payload. |
|
||||
| G23-8.1 | Caller-specific configs/contexts MUST NOT redefine canonical stage semantics. | N/A | N/A | missing | Requires explicit multi-entrypoint composition tests once non-filesystem contexts are implemented. |
|
||||
| G23-8.3 | A compile-only `FrontendProvider` registered by `languageId` MUST traverse `compile()` to verified bytecode without PBS, `.pbs` sources, or PBS stdlib. | `SyntheticFrontendPipelineTest#compileMustEmitVerifiedBytecodeWithoutPbs` | `FrontendRegistryServiceTest#unregisterMustRefuseToRemoveDefaultPbs` | pass | Synthetic `synth` provider is test-only; common pipeline must not require PBS types, PBS sources, or PBS stdlib. |
|
||||
| G23-9.1 | Legacy public `run` MUST be removed as the normative entrypoint and filesystem-default behavior MUST be expressed through `build`. | `BuilderPipelinePublicSurfaceTest#publicServiceSurfaceMustExposeExplicitEntrypointsAndNoPublicRun`; `MainProjectPipelineIntegrationTest#buildShouldWriteProgramBytecode` | N/A | partial | Public service coverage now proves `run` is no longer public and `build` is the filesystem artifact path, but the CLI composition path is not yet exercised by a dedicated automated test. |
|
||||
| PBS13-12.0 | Executable backend handoff MUST satisfy addendum obligations. | `IRBackendExecutableContractTest` suite; `PBSFrontendPhaseServiceTest#shouldSynthesizePositiveTopic19FixtureAcrossFileInitProjectInitAndFrame` | `LowerToIRVMServiceTest#lowerMustRejectWhenSyntheticWrapperEntrypointIsMissing`; `LowerToIRVMServiceTest#lowerMustRejectWhenHiddenBootGuardIsMissing`; `LowerToIRVMServiceTest#lowerMustRejectWhenSyntheticCallableOriginIsMissing` | pass | Row group `PBS13-12.x` details each obligation; topic 19 closure now includes lifecycle wrapper/guard/origin evidence. |
|
||||
| PBS13-12.0 | PBS executable lowering MUST emit `IRBackend` satisfying frontend handoff obligations before common backend lowering. | `IRBackendExecutableContractTest` suite; `PBSFrontendPhaseServiceTest#shouldSynthesizePositiveTopic19FixtureAcrossFileInitProjectInitAndFrame` | `LowerToIRVMServiceTest#lowerMustRejectWhenSyntheticWrapperEntrypointIsMissing`; `LowerToIRVMServiceTest#lowerMustRejectWhenHiddenBootGuardIsMissing`; `LowerToIRVMServiceTest#lowerMustRejectWhenSyntheticCallableOriginIsMissing` | pass | Row group `PBS13-12.x` verifies PBS emission into the common handoff; common backend ownership is covered by G20 rows. |
|
||||
| PBS13-12.7 | PBS executable lowering MUST emit a typed lifecycle declaration and MUST NOT assemble derived wrappers. | `PBSFrontendPhaseServiceTest#shouldSynthesizePositiveTopic19FixtureAcrossFileInitProjectInitAndFrame`; `PbsFrontendCompilerTest#shouldExposeGlobalsAndTypedLifecycleDeclarationInBackendFile` | N/A | pass | Frontend tests assert declaration roles and the absence of module init, published wrapper, and boot guard. |
|
||||
| PBS13-12.8 | Project init MUST be excluded from file-init fragments and MUST execute exactly once after module initializers. | `PbsFrontendCompilerTest#shouldExposeGlobalsAndTypedLifecycleDeclarationInBackendFile`; `LifecycleAssemblerServiceTest#assembleMustInvokeProjectInitExactlyOnceAndExcludeItFromFileInit` | N/A | pass | Colocated `[Init]` is declared as project init and invoked once by the assembled wrapper. |
|
||||
| PBS13-12.9 | Lifecycle module order MUST propagate resolved dependency order without name or `FileId` inference. | `PBSFrontendPhaseServiceTest#shouldPublishDependencyOrderedLifecycleModulesInsteadOfNameOrFileIdOrder`; `IRBackendExecutableContractTest#aggregatorMustRemapTypedLifecycleReferencesAndPreserveDeclaredModuleOrder` | N/A | pass | Adversarial module names and file registration order do not change declared dependency order. |
|
||||
| PBS13-12.1.1 | Callable identity MUST be preserved at handoff. | `IRBackendExecutableContractTest#aggregatorMustPreserveExecutableFunctionOrderDeterministically` | N/A | pass | |
|
||||
| PBS13-12.1.2 | Observable callable signature MUST be preserved at handoff. | `IRBackendExecutableContractTest#functionContractMustRejectInvalidSlotAndSpanBounds` | N/A | pass | |
|
||||
| PBS13-12.1.3 | Callable category MUST be preserved at handoff. | `PbsFrontendCompilerTest#shouldLowerExecutableFunctionsWithCallsiteCategories` | N/A | pass | |
|
||||
@@ -103,7 +124,7 @@ to concrete positive/negative test evidence and current status.
|
||||
|
||||
1. Any backend PR that changes conformance-relevant behavior in FE/BE pipeline MUST update this matrix.
|
||||
2. If requirement coverage changes, update: mapped tests, status, and `Last Updated` date.
|
||||
3. New normative MUSTs in specs `19/20/21` or PBS `13` addendum MUST add a new matrix row before merge.
|
||||
3. New normative MUSTs in specs `19/20/21` or PBS `13` lowering obligations MUST add a new matrix row before merge.
|
||||
4. Conformance-relevant FE/BE code paths for hard-gate are:
|
||||
- `prometeu-compiler/prometeu-build-pipeline/`
|
||||
- `prometeu-compiler/frontends/prometeu-frontend-pbs/`
|
||||
|
||||
@@ -14,6 +14,7 @@ Its purpose is to make the compiler usable through explicit entrypoints instead
|
||||
This document defines:
|
||||
|
||||
- the canonical stage order shared by compiler entrypoints,
|
||||
- the frontend provider and registry boundary used by shared compiler composition,
|
||||
- the terminal stage and mandatory behavior of `analyze`,
|
||||
- the terminal stage and mandatory behavior of `compile`,
|
||||
- the terminal stage and mandatory behavior of `build`,
|
||||
@@ -25,6 +26,7 @@ This document does not define:
|
||||
- one mandatory Java class or package layout,
|
||||
- editor-specific source providers or document-session providers,
|
||||
- frontend-specific semantic facts beyond the minimum shared `AnalysisSnapshot` contract,
|
||||
- dynamic frontend plugin discovery,
|
||||
- or one mandatory CLI architecture.
|
||||
|
||||
## 3. Authority and Precedence
|
||||
@@ -63,12 +65,13 @@ The canonical stage order is:
|
||||
1. `ResolveDepsPipelineStage`
|
||||
2. `LoadSourcesPipelineStage`
|
||||
3. `FrontendPhasePipelineStage`
|
||||
4. `LowerToIRVMPipelineStage`
|
||||
5. `OptimizeIRVMPipelineStage`
|
||||
6. `EmitBytecodePipelineStage`
|
||||
7. `LinkBytecodePipelineStage`
|
||||
8. `VerifyBytecodePipelineStage`
|
||||
9. `WriteBytecodeArtifactPipelineStage`
|
||||
4. `AssembleLifecyclePipelineStage`
|
||||
5. `LowerToIRVMPipelineStage`
|
||||
6. `OptimizeIRVMPipelineStage`
|
||||
7. `EmitBytecodePipelineStage`
|
||||
8. `LinkBytecodePipelineStage`
|
||||
9. `VerifyBytecodePipelineStage`
|
||||
10. `WriteBytecodeArtifactPipelineStage`
|
||||
|
||||
Public entrypoints MAY terminate early according to this document, but they MUST NOT:
|
||||
|
||||
@@ -80,21 +83,23 @@ Public entrypoints MAY terminate early according to this document, but they MUST
|
||||
|
||||
### 6.1 `analyze`
|
||||
|
||||
`analyze` MUST terminate at `FrontendPhasePipelineStage`.
|
||||
`analyze` MUST terminate at `AssembleLifecyclePipelineStage`.
|
||||
|
||||
`analyze` is defined as:
|
||||
|
||||
1. `ResolveDeps`
|
||||
2. `LoadSources`
|
||||
3. `FrontendPhase`
|
||||
4. `AssembleLifecycle`
|
||||
|
||||
`analyze` MUST:
|
||||
|
||||
1. resolve workspace/dependency inputs needed by the frontend,
|
||||
2. load source surfaces admitted by the selected compiler configuration,
|
||||
3. run frontend semantic analysis,
|
||||
4. return an `AnalysisSnapshot` or equivalent result contract,
|
||||
5. and remain free of backend artifact side effects.
|
||||
3. run frontend semantic analysis and emit a declarative `IRBackend`,
|
||||
4. assemble the common lifecycle from `IRLifecycleDeclaration` when present,
|
||||
5. return an `AnalysisSnapshot` or equivalent result contract whose `IRBackend` is fully assembled when the handoff is executable,
|
||||
6. and remain free of backend artifact side effects.
|
||||
|
||||
`analyze` MUST NOT:
|
||||
|
||||
@@ -229,6 +234,64 @@ This authority model MUST NOT:
|
||||
2. move semantic inline hint policy into LSP,
|
||||
3. or imply that the host editor may synthesize semantic hints when the frontend did not publish them.
|
||||
|
||||
## 8.3 Frontend Provider and Registry Contract
|
||||
|
||||
The shared compiler composition surface MUST represent each registered frontend through a `FrontendProvider` or equivalent provider contract.
|
||||
|
||||
At minimum, each provider MUST expose:
|
||||
|
||||
1. `specification()`, returning the frontend-owned static contract, including its stable `languageId`;
|
||||
2. `compiler()`, returning the compiler-facing frontend service used by the shared build pipeline;
|
||||
3. `languageService()`, returning an optional editor-facing language-service capability for tooling consumers.
|
||||
|
||||
`compiler()` is the only required executable frontend capability. It MUST be sufficient for `analyze`, `compile`, `build`, and backend-facing pipeline flows.
|
||||
|
||||
`languageService()` MUST be optional. A frontend that supports compilation but does not provide editor services MUST remain a valid provider. Absence of `languageService()` MUST NOT prevent project analysis, compilation, backend lowering, bytecode emission, verification, or artifact writing.
|
||||
|
||||
The first shared editor-facing contract SHOULD remain an aggregated language-service capability surface. The common compiler contract MUST NOT require separate top-level service interfaces for each editor feature until a future accepted decision and plan identify a real lifecycle, ownership, or testing boundary that requires that split.
|
||||
|
||||
When exposed, editor-facing capabilities MAY include:
|
||||
|
||||
1. diagnostics intended for live editor sessions,
|
||||
2. completion,
|
||||
3. hover,
|
||||
4. definition and navigation,
|
||||
5. signature help,
|
||||
6. semantic tokens for a live document,
|
||||
7. formatting,
|
||||
8. rename,
|
||||
9. code actions,
|
||||
10. and other host-facing editor assistance.
|
||||
|
||||
These capabilities are optional unless a future frontend- or host-specific decision makes one of them mandatory for a narrower surface. Tooling consumers MUST query capability availability before invoking editor-specific behavior.
|
||||
|
||||
Absent editor capabilities MUST have deterministic fallback behavior at tooling boundaries:
|
||||
|
||||
1. collection-shaped responses SHOULD be empty;
|
||||
2. scalar optional responses SHOULD be absent or use a documented neutral response;
|
||||
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.
|
||||
|
||||
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.
|
||||
|
||||
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.
|
||||
|
||||
The frontend registry MUST resolve providers by `languageId`. A lookup for an unknown `languageId` MUST fail explicitly with a diagnostic-friendly error. Unknown languages MUST NOT silently fall back to PBS or to any other frontend.
|
||||
|
||||
Common compiler, build pipeline, and Studio-facing consumers MUST obtain frontend behavior through provider lookup. They MUST NOT directly instantiate frontend-specific compiler services, except inside the frontend provider itself or inside an approved application composition root.
|
||||
|
||||
Provider registration MUST be explicit in v1. The registry contract MUST NOT use dynamic plugin discovery, reflection-based discovery, classpath scanning, external JAR loading, or runtime plugin installation to discover frontends.
|
||||
|
||||
PBS is the only initial real provider for this contract. PBS MAY be registered by an application composition root, but PBS MUST NOT become an exclusive semantic owner of the shared compiler pipeline.
|
||||
|
||||
A compile-only `FrontendProvider` registered by `languageId` MUST be a valid participant of `analyze`, `compile`, and `build`. The shared pipeline MUST NOT require PBS frontend types, `.pbs` or `.barrel` sources, or PBS stdlib in order to emit verified bytecode. Test-only frontends MAY exist solely as fixtures. They MUST NOT be product languages, MUST NOT be registered by default bootstrap or Studio composition, and MUST NOT be discovered by plugin scanning, classpath scanning, or external JAR loading.
|
||||
|
||||
The frontend registry MUST expose explicit `register` and `unregister` operations. `unregister` MUST refuse to remove the default PBS provider. Lookup of an unknown `languageId` MUST fail explicitly. `unregister` of an unknown `languageId` MUST be a no-op.
|
||||
|
||||
## 9. Public Surface Rule
|
||||
|
||||
The shared compiler public surface MUST expose explicit entrypoints equivalent in meaning to:
|
||||
|
||||
@@ -118,6 +118,14 @@ Rules:
|
||||
- collections such as `output.pipeline.palettes` may remain JSON arrays for authoring ergonomics;
|
||||
- when a collection member has runtime- or packing-relevant identity, each entry must carry an explicit `index`;
|
||||
- `output.pipeline.palettes` entries must use the shape `{ "index": <int>, "palette": { ... } }`;
|
||||
- glyph-bank palette payloads must expose canonical `rgba8888` color values in runtime RGBA channel order;
|
||||
- ARGB values produced by host image APIs are import-side implementation details, not canonical declaration or projection fields;
|
||||
- `convertedRgb565` is not part of the normal palette contract;
|
||||
- glyph-bank `palette_count` is an effective runtime metadata field and means
|
||||
the number of serialized and resident RGBA8888 palettes for the bank;
|
||||
- glyph-bank `palette_count` must be in the inclusive range `1..=64`;
|
||||
- `palette_authored`, when present, is informative tooling metadata only and
|
||||
must not be treated as runtime-effective metadata;
|
||||
- the packer must sort such entries by numeric `index`, not by physical array position;
|
||||
- duplicate or malformed indices are structural errors;
|
||||
- missing or malformed `palette` payloads are structural errors;
|
||||
@@ -133,8 +141,7 @@ Example:
|
||||
{
|
||||
"index": 0,
|
||||
"palette": {
|
||||
"originalArgb8888": [4294901760, 4278255360],
|
||||
"convertedRgb565": [63488, 2016]
|
||||
"rgba8888": [4294901760, 16711935]
|
||||
}
|
||||
}
|
||||
]
|
||||
@@ -143,6 +150,19 @@ Example:
|
||||
}
|
||||
```
|
||||
|
||||
For glyph-bank palettes, each `rgba8888` integer is interpreted as
|
||||
`0xRRGGBBAA`.
|
||||
|
||||
Rules:
|
||||
|
||||
- palette index `0` is an ordinary palette slot;
|
||||
- glyph palettes expose 16 usable colors;
|
||||
- transparency and partial transparency are represented only by the alpha byte
|
||||
in the RGBA8888 palette value;
|
||||
- alpha values from `0` through `255` are valid;
|
||||
- magenta color-key behavior is not supported as a normal declaration,
|
||||
projection, or publication rule.
|
||||
|
||||
## Metadata Source Segmentation and Runtime Sink
|
||||
|
||||
`asset.json` may keep metadata segmented by concern during authoring.
|
||||
|
||||
@@ -147,7 +147,8 @@ Offset ambiguity guardrail:
|
||||
|
||||
## Format-Specific Baseline: `GLYPH/indexed_v1`
|
||||
|
||||
The first-wave producer contract for `GLYPH/indexed_v1` is fixed and runtime-aligned.
|
||||
The producer contract for `GLYPH/indexed_v1` is runtime-aligned and uses a
|
||||
variable RGBA8888 palette block.
|
||||
|
||||
### Tile Selection and Identity
|
||||
|
||||
@@ -178,10 +179,10 @@ Rules:
|
||||
|
||||
- the serialized payload for `GLYPH/indexed_v1` is:
|
||||
1. one packed `u4` pixel plane for the full emitted sheet;
|
||||
2. one palette block of `64 * 16 * 2 = 2048` bytes;
|
||||
2. one palette block of `palette_count * 16 * 4` bytes;
|
||||
- packed pixel bytes must be emitted by the packer, not inferred later by the runtime;
|
||||
- the palette block is serialized as `RGB565` `u16` values;
|
||||
- palette bytes must be emitted in little-endian order;
|
||||
- the palette block is serialized as RGBA8888 values in runtime RGBA channel order;
|
||||
- each palette entry is emitted as four bytes in `R`, `G`, `B`, `A` order;
|
||||
- payload interpretation must not depend on incidental per-artifact boundaries.
|
||||
|
||||
### Runtime Entry Derivation
|
||||
@@ -196,10 +197,15 @@ Rules:
|
||||
- `width`
|
||||
- `height`
|
||||
- `palette_count`
|
||||
- tile-bank v1 requires `palette_count = 64`;
|
||||
- tile-bank v1 requires `palette_count` in the inclusive range `1..=64`;
|
||||
- `palette_count` is the number of serialized palettes and resident runtime
|
||||
palettes for the bank;
|
||||
- tile-bank v1 size formulas are:
|
||||
- `size = ceil(width * height / 2) + 2048`
|
||||
- `decoded_size = (width * height) + 2048`
|
||||
- `size = ceil(width * height / 2) + palette_count * 16 * 4`
|
||||
- `decoded_size = (width * height) + palette_count * 16 * 4`
|
||||
- fixed 64-palette padding is not a compatibility mode unless
|
||||
`palette_count = 64` and the payload directly satisfies the v1 contract;
|
||||
- `GLYPH/indexed_v2` must not be introduced for this palette-count correction.
|
||||
|
||||
### Palette Contract
|
||||
|
||||
@@ -207,8 +213,14 @@ Rules:
|
||||
|
||||
- bank palettes are declared under `output.pipeline.palettes`;
|
||||
- each palette declaration uses the shape `{ "index": <int>, "palette": { ... } }`;
|
||||
- each palette payload uses canonical `rgba8888` entries interpreted as `0xRRGGBBAA`;
|
||||
- palette ordering is ascending numeric `index`, never raw array position;
|
||||
- palette ids in the emitted glyph bank are the normalized declared palette indices;
|
||||
- palette ids in the emitted glyph bank are direct declared palette indices;
|
||||
- v1 has no sparse-to-dense palette remapping metadata;
|
||||
- palette index `0` is ordinary and may carry any RGBA8888 value;
|
||||
- glyph palettes have 16 usable entries;
|
||||
- transparency and partial transparency are encoded only by RGBA alpha;
|
||||
- magenta color-key behavior is not part of the normal glyph-bank contract;
|
||||
- any tile in the bank may be rendered with any palette in the bank at runtime;
|
||||
- palette selection is a runtime draw concern, not a tile-payload embedding concern.
|
||||
|
||||
|
||||
@@ -224,6 +224,15 @@ Rules:
|
||||
- `output.format`
|
||||
- `codec`
|
||||
- `preload`
|
||||
- Glyph-bank palette projections must use canonical `rgba8888` values when
|
||||
palette data is shown.
|
||||
- Glyph-bank runtime output projections must present `palette_count`, when
|
||||
shown, as the runtime-effective serialized and resident palette count in
|
||||
`1..=64`.
|
||||
- Studio-facing glyph palette views must not present `palette_authored` as the
|
||||
runtime-effective count.
|
||||
- Studio-facing glyph palette views must not expose `convertedRgb565` as normal
|
||||
runtime or tooling truth.
|
||||
- Runtime-facing output information must not require raw JSON inspection.
|
||||
|
||||
### Inputs / Preview
|
||||
@@ -328,6 +337,10 @@ Rules:
|
||||
- `glyph_asset_id` is derived from the glyph asset selected for the layer;
|
||||
- `parallax_factor_x` and `parallax_factor_y` are layer-owned editorial fields in Studio;
|
||||
- `palette_id` has a layer-owned default and may be overridden per tile when the supported editorial surface provides an explicit override;
|
||||
- `palette_id` remains an index into the referenced glyph palette and does not
|
||||
imply a color format change in the scene request;
|
||||
- referenced glyph palettes resolve to RGBA8888 entries, with palette index `0`
|
||||
treated as an ordinary palette slot;
|
||||
- layer `active` determines whether the layer participates in publication output;
|
||||
- tile `active` determines whether the tile contributes an active tile record to the published request;
|
||||
- canonical scene persistence must not depend on `TMX`, `TSX`, or any other external file format remaining present on disk.
|
||||
|
||||
@@ -9,7 +9,7 @@ Scope boundary:
|
||||
- PROMETEU itself is a fantasy handheld / fantasy console with a broader machine model, firmware model, cartridge model, and virtual hardware surface.
|
||||
- This document does not define the whole PROMETEU machine.
|
||||
- This document defines the VM/runtime subsystem that executes bytecode inside that machine.
|
||||
- For broader machine-level framing, see [`../specs/README.md`](../specs/README.md).
|
||||
- For broader machine-level framing, see [`../specs/README.md`](../specs/runtime/README.md).
|
||||
|
||||
Document roles:
|
||||
|
||||
@@ -149,6 +149,7 @@ The verifier statically checks bytecode for structural safety and stack‑shape
|
||||
- `SyscallMeta` defines expected arity and return slot counts. The loader resolves `HOSTCALL` against this metadata and rejects raw `SYSCALL` in PBX pre-load artifacts; the verifier checks final IDs/arity/return‑slot counts against the same metadata.
|
||||
- Arguments and returns
|
||||
- Arguments are taken from the operand stack in the order defined by the ABI. Returns use multi‑slot results via a host‑side return buffer (`HostReturn`) which the VM copies back onto the stack, or zero slots for “void”. A mismatch in result counts is a fault/panic per current hardening logic.
|
||||
- Example: the canonical asset runtime load surface is `asset.load(asset_id, slot) -> (status, handle)`. The caller does not supply `asset_name` or `asset_type`; bank kind is derived from `asset_table` using `asset_id`.
|
||||
- Capabilities
|
||||
- Cartridge capability flags are applied before load-time host resolution. Missing required capability aborts load; invoking a syscall without the required capability also traps defensively at runtime.
|
||||
|
||||
|
||||
@@ -1,6 +1,25 @@
|
||||
final_id_hex,final_id_dec,canonical_name,canonical_version,owner,name,arg_slots,ret_slots,arg_layout,ret_layout,deterministic,may_allocate
|
||||
0x1000,4096,vec2.dot,1,vec2,dot,4,1,float|float|float|float,float,true,false
|
||||
0x1001,4097,vec2.length,1,vec2,length,2,1,float|float,float,true,false
|
||||
0x1100,4352,color.from_raw,1,color,from_raw,1,1,int,builtin:color,true,false
|
||||
0x1101,4353,color.rgb,1,color,rgb,3,1,int|int|int,builtin:color,true,false
|
||||
0x1102,4354,color.rgba,1,color,rgba,4,1,int|int|int|int,builtin:color,true,false
|
||||
0x1103,4355,color.html_rgba,1,color,html_rgba,1,1,str,builtin:color,true,false
|
||||
0x1104,4356,color.gray_scale,1,color,gray_scale,1,1,int,builtin:color,true,false
|
||||
0x1105,4357,color.hex,1,color,hex,1,1,builtin:color,int,true,false
|
||||
0x1106,4358,color.alpha,1,color,alpha,1,1,builtin:color,int,true,false
|
||||
0x1120,4384,color.black,1,color,black,0,1,,builtin:color,true,false
|
||||
0x1121,4385,color.white,1,color,white,0,1,,builtin:color,true,false
|
||||
0x1122,4386,color.red,1,color,red,0,1,,builtin:color,true,false
|
||||
0x1123,4387,color.green,1,color,green,0,1,,builtin:color,true,false
|
||||
0x1124,4388,color.blue,1,color,blue,0,1,,builtin:color,true,false
|
||||
0x1125,4389,color.yellow,1,color,yellow,0,1,,builtin:color,true,false
|
||||
0x1126,4390,color.orange,1,color,orange,0,1,,builtin:color,true,false
|
||||
0x1127,4391,color.indigo,1,color,indigo,0,1,,builtin:color,true,false
|
||||
0x1128,4392,color.gray,1,color,gray,0,1,,builtin:color,true,false
|
||||
0x1129,4393,color.cyan,1,color,cyan,0,1,,builtin:color,true,false
|
||||
0x112A,4394,color.magenta,1,color,magenta,0,1,,builtin:color,true,false
|
||||
0x112B,4395,color.transparent,1,color,transparent,0,1,,builtin:color,true,false
|
||||
0x2000,8192,input.pad,1,input,pad,0,1,,builtin:input.pad,true,false
|
||||
0x2001,8193,input.touch,1,input,touch,0,1,,builtin:input.touch,true,false
|
||||
0x2010,8208,input.pad.up,1,input.pad,up,1,1,builtin:input.pad,builtin:input.button,true,false
|
||||
|
||||
|
@@ -78,6 +78,17 @@ Authority rule:
|
||||
- `INTRINSIC u32` — final numeric VM-owned intrinsic call.
|
||||
- `FRAME_SYNC` — yield until the next frame boundary (e.g., vblank); explicit safepoint.
|
||||
|
||||
Host service arity is not encoded in the opcode itself. It is defined by resolved syscall metadata.
|
||||
|
||||
Example:
|
||||
|
||||
- `asset.load` currently resolves with `arg_slots = 2` and `ret_slots = 2`.
|
||||
- The canonical stack contract is `asset_id, slot -> status, handle`.
|
||||
- Callers do not provide an explicit asset kind; the runtime derives it from `asset_table`.
|
||||
- `composer.bind_scene` resolves with `arg_slots = 1` and `ret_slots = 1`.
|
||||
- The canonical stack contract is `bank_id -> status`.
|
||||
- `composer.emit_sprite` resolves with `arg_slots = 9` and `ret_slots = 1`.
|
||||
|
||||
#### Canonical Intrinsic Registry Artifact
|
||||
|
||||
- Final intrinsic IDs and intrinsic stack metadata are published in [`INTRINSICS.csv`](INTRINSICS.csv).
|
||||
|
||||
@@ -0,0 +1,32 @@
|
||||
# VM Architecture Mirror Policy
|
||||
|
||||
The Prometeu runtime repository is the normative authority for PBX binary
|
||||
layout, Core ISA, loader behavior, verification, and PVM execution semantics.
|
||||
The files in this directory are convenience mirrors for Studio-side compiler
|
||||
and integration work; they are not an independent architectural authority.
|
||||
|
||||
Canonical runtime sources:
|
||||
|
||||
- `../runtime/docs/vm-arch/ARCHITECTURE.md`
|
||||
- `../runtime/docs/vm-arch/ISA_CORE.md`
|
||||
- `../runtime/docs/vm-arch/INTRINSICS.csv`
|
||||
|
||||
When these mirrors are retained, an integration change that updates a canonical
|
||||
runtime source MUST update the corresponding Studio mirror in the same logical
|
||||
change. Verify synchronization from the Studio repository root with:
|
||||
|
||||
```bash
|
||||
diff -u docs/vm-arch/ARCHITECTURE.md ../runtime/docs/vm-arch/ARCHITECTURE.md
|
||||
diff -u docs/vm-arch/ISA_CORE.md ../runtime/docs/vm-arch/ISA_CORE.md
|
||||
diff -u docs/vm-arch/INTRINSICS.csv ../runtime/docs/vm-arch/INTRINSICS.csv
|
||||
```
|
||||
|
||||
All three commands MUST exit successfully with no output before a change claims
|
||||
that the mirrors are synchronized. If the runtime repository is not available
|
||||
in the same checkout, synchronization evidence must be produced against the
|
||||
canonical runtime revision before merging.
|
||||
|
||||
Compiler-owned transformation contracts remain under `docs/specs/compiler`.
|
||||
Those specifications define `IRBackend -> IRVM -> PBX` emission, but they MUST
|
||||
conform to the runtime-owned PBX and ISA contracts and MUST NOT redefine runtime
|
||||
execution semantics.
|
||||
@@ -5,6 +5,7 @@ jackson = "2.18.2"
|
||||
jacoco = "0.8.12"
|
||||
lombok = "1.18.32"
|
||||
junit-jupiter = "5.12.1"
|
||||
archunit = "1.4.2"
|
||||
slf4j = "2.0.7"
|
||||
lsp4j = "1.0.0"
|
||||
|
||||
@@ -19,6 +20,7 @@ apache-commons-collections = { group = "org.apache.commons", name = "commons-col
|
||||
jacoco-core = { group = "org.jacoco", name = "org.jacoco.core", version.ref = "jacoco" }
|
||||
lombok = { group = "org.projectlombok", name = "lombok", version.ref = "lombok" }
|
||||
junit-jupiter = { group = "org.junit.jupiter", name = "junit-jupiter", version.ref = "junit-jupiter" }
|
||||
archunit-junit5 = { group = "com.tngtech.archunit", name = "archunit-junit5", version.ref = "archunit" }
|
||||
slf4j-api = { group = "org.slf4j", name = "slf4j-api", version.ref = "slf4j" }
|
||||
slf4j-simple = { group = "org.slf4j", name = "slf4j-simple", version.ref = "slf4j" }
|
||||
lsp4j = { group = "org.eclipse.lsp4j", name = "org.eclipse.lsp4j", version.ref = "lsp4j" }
|
||||
|
||||
@@ -7,6 +7,7 @@ dependencies {
|
||||
implementation(project(":prometeu-infra"))
|
||||
implementation(project(":prometeu-lsp:prometeu-lsp-api"))
|
||||
implementation(project(":prometeu-lsp:prometeu-lsp-v1"))
|
||||
implementation(project(":prometeu-compiler:prometeu-frontend-registry"))
|
||||
implementation(project(":prometeu-packer:prometeu-packer-api"))
|
||||
implementation(project(":prometeu-packer:prometeu-packer-v1"))
|
||||
implementation(project(":prometeu-studio"))
|
||||
|
||||
@@ -2,6 +2,7 @@ package p.studio;
|
||||
|
||||
import com.fasterxml.jackson.databind.ObjectMapper;
|
||||
import p.packer.Packer;
|
||||
import p.studio.compiler.FrontendRegistryService;
|
||||
import p.studio.lsp.api.LspServerLifecycle;
|
||||
import p.studio.lsp.events.StudioEventBus;
|
||||
import p.studio.lsp.events.StudioPackerEventAdapter;
|
||||
@@ -24,6 +25,7 @@ public final class AppContainer implements Container {
|
||||
private final LspServerLifecycle lspServerLifecycle;
|
||||
|
||||
public AppContainer() {
|
||||
FrontendRegistryService.bootstrapDefaults();
|
||||
this.i18nService = new I18nService();
|
||||
this.themeService = new ThemeService();
|
||||
this.studioEventBus = new StudioEventBus();
|
||||
|
||||
@@ -0,0 +1,23 @@
|
||||
plugins {
|
||||
id("gradle.java-library-conventions")
|
||||
}
|
||||
|
||||
dependencies {
|
||||
testImplementation(libs.archunit.junit5)
|
||||
|
||||
testImplementation(project(":prometeu-compiler:frontends:prometeu-frontend-pbs"))
|
||||
testImplementation(project(":prometeu-compiler:prometeu-frontend-registry"))
|
||||
testImplementation(project(":prometeu-compiler:prometeu-compiler-core"))
|
||||
testImplementation(project(":prometeu-compiler:prometeu-frontend-api"))
|
||||
testImplementation(project(":prometeu-compiler:prometeu-build-pipeline"))
|
||||
testImplementation(project(":prometeu-compiler:prometeu-deps"))
|
||||
testImplementation(project(":prometeu-infra"))
|
||||
testImplementation(project(":prometeu-lsp:prometeu-lsp-api"))
|
||||
testImplementation(project(":prometeu-lsp:prometeu-lsp-v1"))
|
||||
testImplementation(project(":prometeu-studio"))
|
||||
testImplementation(project(":prometeu-app"))
|
||||
}
|
||||
|
||||
tasks.named<JacocoReport>("jacocoTestReport") {
|
||||
enabled = false
|
||||
}
|
||||
+63
@@ -0,0 +1,63 @@
|
||||
package p.studio.architecture;
|
||||
|
||||
import org.junit.jupiter.api.Test;
|
||||
|
||||
import java.io.IOException;
|
||||
import java.nio.file.Files;
|
||||
import java.nio.file.Path;
|
||||
import java.util.ArrayList;
|
||||
import java.util.List;
|
||||
|
||||
import static org.junit.jupiter.api.Assertions.assertTrue;
|
||||
import static org.junit.jupiter.api.Assertions.fail;
|
||||
|
||||
class CommonBackendPbsPrefixScanTest {
|
||||
private static final String COMPILER_SOURCE_ROOT =
|
||||
"prometeu-compiler/prometeu-build-pipeline/src/main/java/p/studio/compiler";
|
||||
private static final List<String> GUARDED_RELATIVE_ROOTS = List.of(
|
||||
"backend",
|
||||
"lifecycle",
|
||||
"workspaces/stages");
|
||||
private static final String FORBIDDEN_PBS_PREFIX = "__pbs.";
|
||||
|
||||
@Test
|
||||
void commonLifecycleAndBackendMustNotDiscoverRolesFromPbsNamePrefixes() throws IOException {
|
||||
final var violations = new ArrayList<String>();
|
||||
final var repoRoot = locateRepoRoot();
|
||||
final var compilerRoot = repoRoot.resolve(COMPILER_SOURCE_ROOT);
|
||||
for (final var relativeRoot : GUARDED_RELATIVE_ROOTS) {
|
||||
final var root = compilerRoot.resolve(relativeRoot);
|
||||
if (!Files.exists(root)) {
|
||||
fail("guarded source root is missing: " + root);
|
||||
}
|
||||
try (final var paths = Files.walk(root)) {
|
||||
paths.filter(path -> path.toString().endsWith(".java")).forEach(path -> {
|
||||
try {
|
||||
if (Files.readString(path).contains(FORBIDDEN_PBS_PREFIX)) {
|
||||
violations.add(repoRoot.relativize(path).toString());
|
||||
}
|
||||
} catch (IOException e) {
|
||||
throw new IllegalStateException("failed to read source file: " + path, e);
|
||||
}
|
||||
});
|
||||
}
|
||||
}
|
||||
assertTrue(
|
||||
violations.isEmpty(),
|
||||
"common lifecycle/backend code must not inspect __pbs. prefixes: " + violations);
|
||||
}
|
||||
|
||||
private static Path locateRepoRoot() {
|
||||
var cursor = Path.of(System.getProperty("user.dir")).toAbsolutePath().normalize();
|
||||
while (cursor != null) {
|
||||
final var hasDocs = Files.isDirectory(cursor.resolve("docs/specs/compiler"));
|
||||
final var hasCompiler = Files.isDirectory(cursor.resolve("prometeu-compiler"));
|
||||
if (hasDocs && hasCompiler) {
|
||||
return cursor;
|
||||
}
|
||||
cursor = cursor.getParent();
|
||||
}
|
||||
fail("could not locate repository root from working directory");
|
||||
throw new IllegalStateException("unreachable");
|
||||
}
|
||||
}
|
||||
+22
@@ -0,0 +1,22 @@
|
||||
package p.studio.architecture;
|
||||
|
||||
import com.tngtech.archunit.base.DescribedPredicate;
|
||||
import com.tngtech.archunit.core.domain.JavaClass;
|
||||
|
||||
import java.util.Arrays;
|
||||
import java.util.Set;
|
||||
import java.util.stream.Collectors;
|
||||
|
||||
final class DescribedPredicates {
|
||||
private DescribedPredicates() {
|
||||
}
|
||||
|
||||
static DescribedPredicate<JavaClass> notBelongingTo(final Class<?>... allowed) {
|
||||
final Set<String> allowedNames = Arrays.stream(allowed)
|
||||
.map(Class::getName)
|
||||
.collect(Collectors.toUnmodifiableSet());
|
||||
return DescribedPredicate.describe(
|
||||
"do not belong to " + allowedNames,
|
||||
javaClass -> !allowedNames.contains(javaClass.getName()));
|
||||
}
|
||||
}
|
||||
+85
@@ -0,0 +1,85 @@
|
||||
package p.studio.architecture;
|
||||
|
||||
import org.junit.jupiter.api.Test;
|
||||
|
||||
import java.io.IOException;
|
||||
import java.nio.file.Files;
|
||||
import java.nio.file.Path;
|
||||
import java.util.ArrayList;
|
||||
import java.util.Map;
|
||||
import java.util.Set;
|
||||
import java.util.regex.Pattern;
|
||||
|
||||
import static org.junit.jupiter.api.Assertions.assertTrue;
|
||||
import static org.junit.jupiter.api.Assertions.fail;
|
||||
|
||||
class PbsGradleDependencyAllowlistTest {
|
||||
private static final Pattern PBS_PROJECT_DEP = Pattern.compile(
|
||||
"(\\w+)\\(\\s*project\\(\\s*\"" + Pattern.quote(PbsModuleOrigins.PBS_GRADLE_PATH) + "\"\\s*\\)");
|
||||
private static final Map<String, Set<String>> ALLOWED_CONFIGURATIONS = Map.of(
|
||||
":prometeu-compiler:prometeu-frontend-registry", Set.of("implementation", "api"),
|
||||
":prometeu-architecture-tests", Set.of("testImplementation"));
|
||||
|
||||
@Test
|
||||
void onlyAllowlistedProjectsMayDependOnThePbsFrontendModule() throws IOException {
|
||||
final var repoRoot = locateRepoRoot();
|
||||
final var violations = new ArrayList<String>();
|
||||
|
||||
try (final var paths = Files.walk(repoRoot)) {
|
||||
paths.filter(path -> path.getFileName().toString().equals("build.gradle.kts"))
|
||||
.filter(path -> !path.toString().contains("/buildSrc/"))
|
||||
.filter(path -> !path.toString().contains("/build/"))
|
||||
.forEach(path -> collectViolations(repoRoot, path, violations));
|
||||
}
|
||||
|
||||
assertTrue(violations.isEmpty(), "PBS Gradle project dependency allowlist violated: " + violations);
|
||||
}
|
||||
|
||||
private static void collectViolations(
|
||||
final Path repoRoot,
|
||||
final Path buildFile,
|
||||
final ArrayList<String> violations) {
|
||||
final var projectPath = toProjectPath(repoRoot, buildFile);
|
||||
if (PbsModuleOrigins.PBS_GRADLE_PATH.equals(projectPath)) {
|
||||
return;
|
||||
}
|
||||
|
||||
final String content;
|
||||
try {
|
||||
content = Files.readString(buildFile);
|
||||
} catch (IOException e) {
|
||||
throw new IllegalStateException("failed to read " + buildFile, e);
|
||||
}
|
||||
|
||||
final var matcher = PBS_PROJECT_DEP.matcher(content);
|
||||
while (matcher.find()) {
|
||||
final var configuration = matcher.group(1);
|
||||
final var allowed = ALLOWED_CONFIGURATIONS.getOrDefault(projectPath, Set.of());
|
||||
if (!allowed.contains(configuration)) {
|
||||
violations.add(projectPath + " " + configuration + " " + PbsModuleOrigins.PBS_GRADLE_PATH);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
private static String toProjectPath(final Path repoRoot, final Path buildFile) {
|
||||
final var relative = repoRoot.relativize(buildFile.getParent()).toString().replace('\\', '/');
|
||||
if (relative.isEmpty() || ".".equals(relative)) {
|
||||
return ":";
|
||||
}
|
||||
return ":" + relative.replace('/', ':');
|
||||
}
|
||||
|
||||
private static Path locateRepoRoot() {
|
||||
var cursor = Path.of(System.getProperty("user.dir")).toAbsolutePath().normalize();
|
||||
while (cursor != null) {
|
||||
final var hasDocs = Files.isDirectory(cursor.resolve("docs/specs/compiler"));
|
||||
final var hasCompiler = Files.isDirectory(cursor.resolve("prometeu-compiler"));
|
||||
if (hasDocs && hasCompiler) {
|
||||
return cursor;
|
||||
}
|
||||
cursor = cursor.getParent();
|
||||
}
|
||||
fail("could not locate repository root from working directory");
|
||||
throw new IllegalStateException("unreachable");
|
||||
}
|
||||
}
|
||||
+43
@@ -0,0 +1,43 @@
|
||||
package p.studio.architecture;
|
||||
|
||||
import com.tngtech.archunit.core.importer.ImportOption;
|
||||
import com.tngtech.archunit.junit.AnalyzeClasses;
|
||||
import com.tngtech.archunit.junit.ArchTest;
|
||||
import com.tngtech.archunit.lang.ArchRule;
|
||||
import p.studio.compiler.PBSDefinitions;
|
||||
import p.studio.compiler.PBSFrontendProvider;
|
||||
|
||||
import static com.tngtech.archunit.lang.syntax.ArchRuleDefinition.noClasses;
|
||||
import static p.studio.architecture.PbsModuleOrigins.fromFrontendApiModule;
|
||||
import static p.studio.architecture.PbsModuleOrigins.fromPbsModule;
|
||||
import static p.studio.architecture.PbsModuleOrigins.fromRegistryModule;
|
||||
|
||||
@AnalyzeClasses(packages = "p.studio", importOptions = ImportOption.DoNotIncludeTests.class)
|
||||
class PbsModuleBoundaryArchTest {
|
||||
|
||||
@ArchTest
|
||||
static final ArchRule productionOutsideAllowlistMustNotDependOnPbsModuleTypes = noClasses()
|
||||
.that(fromPbsModule().negate())
|
||||
.and(fromRegistryModule().negate())
|
||||
.should()
|
||||
.dependOnClassesThat(fromPbsModule())
|
||||
.because("DEC-0050: only prometeu-frontend-pbs and prometeu-frontend-registry may depend on PBS module types");
|
||||
|
||||
@ArchTest
|
||||
static final ArchRule registryMustOnlyDependOnPbsProviderFacade = noClasses()
|
||||
.that(fromRegistryModule())
|
||||
.should()
|
||||
.dependOnClassesThat(
|
||||
fromPbsModule()
|
||||
.and(DescribedPredicates.notBelongingTo(PBSFrontendProvider.class, PBSDefinitions.class)))
|
||||
.because("DEC-0050: registry may depend only on PBSFrontendProvider and PBSDefinitions");
|
||||
|
||||
@ArchTest
|
||||
static final ArchRule irBackendModelsMustNotDependOnPbsModuleTypes = noClasses()
|
||||
.that(fromFrontendApiModule())
|
||||
.and()
|
||||
.resideInAPackage("p.studio.compiler.models..")
|
||||
.should()
|
||||
.dependOnClassesThat(fromPbsModule())
|
||||
.because("DEC-0050: public IRBackend contract types must not depend on PBS module types");
|
||||
}
|
||||
+36
@@ -0,0 +1,36 @@
|
||||
package p.studio.architecture;
|
||||
|
||||
import com.tngtech.archunit.core.importer.ClassFileImporter;
|
||||
import com.tngtech.archunit.core.importer.ImportOption;
|
||||
import org.junit.jupiter.api.Test;
|
||||
|
||||
import static org.junit.jupiter.api.Assertions.assertTrue;
|
||||
import static org.junit.jupiter.api.Assertions.fail;
|
||||
|
||||
class PbsModuleClasspathTest {
|
||||
|
||||
@Test
|
||||
void importerMustSeePbsAndRegistryModuleOrigins() {
|
||||
final var classes = new ClassFileImporter()
|
||||
.withImportOption(ImportOption.Predefined.DO_NOT_INCLUDE_TESTS)
|
||||
.importPackages("p.studio");
|
||||
|
||||
final var pbsSample = classes.stream()
|
||||
.filter(PbsModuleOrigins::isPbsModule)
|
||||
.findFirst();
|
||||
final var registrySample = classes.stream()
|
||||
.filter(PbsModuleOrigins::isRegistryModule)
|
||||
.findFirst();
|
||||
|
||||
if (pbsSample.isEmpty() || registrySample.isEmpty()) {
|
||||
final var uris = classes.stream()
|
||||
.limit(20)
|
||||
.map(javaClass -> javaClass.getName() + " -> " + PbsModuleOrigins.sourceUri(javaClass))
|
||||
.toList();
|
||||
fail("PBS/registry module origins were not visible to ArchUnit. sample URIs: " + uris);
|
||||
}
|
||||
|
||||
assertTrue(pbsSample.isPresent());
|
||||
assertTrue(registrySample.isPresent());
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,60 @@
|
||||
package p.studio.architecture;
|
||||
|
||||
import com.tngtech.archunit.base.DescribedPredicate;
|
||||
import com.tngtech.archunit.core.domain.JavaClass;
|
||||
|
||||
final class PbsModuleOrigins {
|
||||
static final String PBS_GRADLE_PATH = ":prometeu-compiler:frontends:prometeu-frontend-pbs";
|
||||
|
||||
private PbsModuleOrigins() {
|
||||
}
|
||||
|
||||
static boolean isPbsModule(final JavaClass javaClass) {
|
||||
return uriContains(javaClass, "/prometeu-frontend-pbs/")
|
||||
|| uriContains(javaClass, "prometeu-frontend-pbs.jar");
|
||||
}
|
||||
|
||||
static boolean isRegistryModule(final JavaClass javaClass) {
|
||||
return uriContains(javaClass, "/prometeu-frontend-registry/")
|
||||
|| uriContains(javaClass, "prometeu-frontend-registry.jar");
|
||||
}
|
||||
|
||||
static boolean isFrontendApiModule(final JavaClass javaClass) {
|
||||
return uriContains(javaClass, "/prometeu-frontend-api/")
|
||||
|| uriContains(javaClass, "prometeu-frontend-api.jar");
|
||||
}
|
||||
|
||||
static DescribedPredicate<JavaClass> fromPbsModule() {
|
||||
return DescribedPredicate.describe(
|
||||
"originate from the PBS frontend module",
|
||||
PbsModuleOrigins::isPbsModule);
|
||||
}
|
||||
|
||||
static DescribedPredicate<JavaClass> fromRegistryModule() {
|
||||
return DescribedPredicate.describe(
|
||||
"originate from the frontend registry module",
|
||||
PbsModuleOrigins::isRegistryModule);
|
||||
}
|
||||
|
||||
static DescribedPredicate<JavaClass> fromFrontendApiModule() {
|
||||
return DescribedPredicate.describe(
|
||||
"originate from the frontend-api module",
|
||||
PbsModuleOrigins::isFrontendApiModule);
|
||||
}
|
||||
|
||||
static String sourceUri(final JavaClass javaClass) {
|
||||
return javaClass.getSource()
|
||||
.map(source -> normalize(source.getUri().toString()))
|
||||
.orElse("<no source>");
|
||||
}
|
||||
|
||||
private static boolean uriContains(final JavaClass javaClass, final String fragment) {
|
||||
return javaClass.getSource()
|
||||
.map(source -> normalize(source.getUri().toString()).contains(fragment))
|
||||
.orElse(false);
|
||||
}
|
||||
|
||||
private static String normalize(final String uri) {
|
||||
return uri.replace('\\', '/');
|
||||
}
|
||||
}
|
||||
+415
@@ -0,0 +1,415 @@
|
||||
package p.studio.compiler;
|
||||
|
||||
import p.studio.compiler.messages.FESurfaceContext;
|
||||
import p.studio.compiler.messages.BuildingIssueSink;
|
||||
import p.studio.compiler.messages.FrontendPhaseContext;
|
||||
import p.studio.compiler.models.FrontendSemanticToken;
|
||||
import p.studio.compiler.pbs.ast.PbsAst;
|
||||
import p.studio.compiler.pbs.semantics.PbsEditorialCompletionCandidate;
|
||||
import p.studio.compiler.pbs.semantics.PbsEditorialLocation;
|
||||
import p.studio.compiler.pbs.semantics.PbsEditorialResolvedSymbol;
|
||||
import p.studio.compiler.pbs.semantics.PbsEditorialSignatureHelp;
|
||||
import p.studio.compiler.pbs.semantics.PbsEditorialSymbolKind;
|
||||
import p.studio.compiler.pbs.semantics.PbsEditorialSupportService;
|
||||
import p.studio.compiler.pbs.semantics.PbsEditorialSupportService.EditorialDocument;
|
||||
import p.studio.compiler.services.PBSFrontendPhaseService.PbsSemanticReadSurface;
|
||||
import p.studio.compiler.services.FrontendCompletionCandidate;
|
||||
import p.studio.compiler.services.FrontendDefinitionLocation;
|
||||
import p.studio.compiler.services.FrontendDocumentRequest;
|
||||
import p.studio.compiler.services.FrontendDocumentation;
|
||||
import p.studio.compiler.services.FrontendEditorialContext;
|
||||
import p.studio.compiler.services.FrontendHover;
|
||||
import p.studio.compiler.services.FrontendLanguageService;
|
||||
import p.studio.compiler.services.FrontendSignature;
|
||||
import p.studio.compiler.services.FrontendSignatureHelp;
|
||||
import p.studio.compiler.services.FrontendSymbolKind;
|
||||
import p.studio.compiler.services.PBSFrontendPhaseService;
|
||||
import p.studio.compiler.source.Span;
|
||||
import p.studio.compiler.source.diagnostics.DiagnosticSink;
|
||||
import p.studio.compiler.source.identifiers.FileId;
|
||||
import p.studio.compiler.source.tables.FileTableReader;
|
||||
import p.studio.utilities.structures.ReadOnlyList;
|
||||
|
||||
import java.nio.file.Files;
|
||||
import java.nio.file.Path;
|
||||
import java.util.ArrayList;
|
||||
import java.util.LinkedHashMap;
|
||||
import java.util.List;
|
||||
import java.util.Objects;
|
||||
import java.util.Optional;
|
||||
|
||||
public final class PBSFrontendLanguageService implements FrontendLanguageService {
|
||||
private final PbsEditorialSupportService editorialSupportService;
|
||||
private final PBSSemanticTokenProvider semanticTokenProvider;
|
||||
|
||||
public PBSFrontendLanguageService() {
|
||||
this(new PbsEditorialSupportService(), new PBSSemanticTokenProvider());
|
||||
}
|
||||
|
||||
PBSFrontendLanguageService(
|
||||
final PbsEditorialSupportService editorialSupportService,
|
||||
final PBSSemanticTokenProvider semanticTokenProvider) {
|
||||
this.editorialSupportService = Objects.requireNonNull(editorialSupportService, "editorialSupportService");
|
||||
this.semanticTokenProvider = Objects.requireNonNull(semanticTokenProvider, "semanticTokenProvider");
|
||||
}
|
||||
|
||||
@Override
|
||||
public Optional<FrontendEditorialContext> prepareEditorialContext(
|
||||
final FrontendPhaseContext phaseContext,
|
||||
final FileId fileId) {
|
||||
if (phaseContext == null || fileId == null) {
|
||||
return Optional.empty();
|
||||
}
|
||||
final var semanticReadSurface = PBSFrontendPhaseService.semanticReadSurface(
|
||||
phaseContext,
|
||||
DiagnosticSink.empty(),
|
||||
BuildingIssueSink.empty());
|
||||
final var ast = semanticReadSurface.astByFile().get(fileId);
|
||||
if (ast == null) {
|
||||
return Optional.empty();
|
||||
}
|
||||
return Optional.of(new FrontendEditorialContext(
|
||||
ast,
|
||||
semanticReadSurface.supplementalTopDeclsByFile().getOrDefault(fileId, ReadOnlyList.empty()),
|
||||
phaseContext.feSurfaceContext(),
|
||||
phaseContext.fileTable,
|
||||
semanticReadSurface));
|
||||
}
|
||||
|
||||
public List<PbsEditorialCompletionCandidate> completion(
|
||||
final String sourceText,
|
||||
final PbsAst.File ast,
|
||||
final ReadOnlyList<PbsAst.TopDecl> supplementalTopDecls,
|
||||
final FESurfaceContext feSurfaceContext,
|
||||
final int offset) {
|
||||
return editorialSupportService.completion(sourceText, ast, supplementalTopDecls, feSurfaceContext, offset);
|
||||
}
|
||||
|
||||
@Override
|
||||
public List<FrontendCompletionCandidate> completion(
|
||||
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)) {
|
||||
return List.of();
|
||||
}
|
||||
|
||||
@SuppressWarnings("unchecked")
|
||||
final ReadOnlyList<PbsAst.TopDecl> typedSupplementalTopDecls =
|
||||
(ReadOnlyList<PbsAst.TopDecl>) supplementalTopDecls;
|
||||
return completion(
|
||||
request.documentText(),
|
||||
ast,
|
||||
typedSupplementalTopDecls,
|
||||
feSurfaceContext,
|
||||
offset).stream()
|
||||
.map(this::toFrontendCompletionCandidate)
|
||||
.toList();
|
||||
}
|
||||
|
||||
public Optional<PbsEditorialResolvedSymbol> hover(
|
||||
final String sourceText,
|
||||
final PbsAst.File ast,
|
||||
final ReadOnlyList<PbsAst.TopDecl> supplementalTopDecls,
|
||||
final FESurfaceContext feSurfaceContext,
|
||||
final int offset) {
|
||||
return editorialSupportService.hover(sourceText, ast, supplementalTopDecls, feSurfaceContext, offset);
|
||||
}
|
||||
|
||||
@Override
|
||||
public Optional<FrontendHover> hover(
|
||||
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)) {
|
||||
return Optional.empty();
|
||||
}
|
||||
|
||||
@SuppressWarnings("unchecked")
|
||||
final ReadOnlyList<PbsAst.TopDecl> typedSupplementalTopDecls =
|
||||
(ReadOnlyList<PbsAst.TopDecl>) supplementalTopDecls;
|
||||
return hover(
|
||||
request.documentText(),
|
||||
ast,
|
||||
typedSupplementalTopDecls,
|
||||
feSurfaceContext,
|
||||
offset).map(this::toFrontendHover);
|
||||
}
|
||||
|
||||
public Optional<PbsEditorialSignatureHelp> signatureHelp(
|
||||
final String sourceText,
|
||||
final PbsAst.File ast,
|
||||
final ReadOnlyList<PbsAst.TopDecl> supplementalTopDecls,
|
||||
final FESurfaceContext feSurfaceContext,
|
||||
final int offset) {
|
||||
return editorialSupportService.signatureHelp(sourceText, ast, supplementalTopDecls, feSurfaceContext, offset);
|
||||
}
|
||||
|
||||
@Override
|
||||
public FrontendSignatureHelp signatureHelp(
|
||||
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)) {
|
||||
return FrontendSignatureHelp.empty();
|
||||
}
|
||||
|
||||
@SuppressWarnings("unchecked")
|
||||
final ReadOnlyList<PbsAst.TopDecl> typedSupplementalTopDecls =
|
||||
(ReadOnlyList<PbsAst.TopDecl>) supplementalTopDecls;
|
||||
return signatureHelp(
|
||||
request.documentText(),
|
||||
ast,
|
||||
typedSupplementalTopDecls,
|
||||
feSurfaceContext,
|
||||
offset)
|
||||
.map(this::toFrontendSignatureHelp)
|
||||
.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<FrontendSemanticToken> semanticTokens(final FrontendDocumentRequest request) {
|
||||
return semanticTokens(request == null ? "" : request.documentText());
|
||||
}
|
||||
|
||||
public List<FrontendSemanticToken> semanticTokens(final String documentText) {
|
||||
return semanticTokenProvider.tokenize(documentText == null ? "" : documentText);
|
||||
}
|
||||
|
||||
private FrontendCompletionCandidate toFrontendCompletionCandidate(final PbsEditorialCompletionCandidate candidate) {
|
||||
return new FrontendCompletionCandidate(
|
||||
candidate.label(),
|
||||
toFrontendSymbolKind(candidate.kind()),
|
||||
candidate.detail(),
|
||||
candidate.documentation(),
|
||||
candidate.origin());
|
||||
}
|
||||
|
||||
private FrontendHover toFrontendHover(final PbsEditorialResolvedSymbol symbol) {
|
||||
return new FrontendHover(
|
||||
symbol.displayName(),
|
||||
toFrontendSymbolKind(symbol.kind()),
|
||||
symbol.detail(),
|
||||
symbol.origin(),
|
||||
symbol.signatures().stream()
|
||||
.map(this::toFrontendSignature)
|
||||
.toList(),
|
||||
FrontendDocumentation.markdown(symbol.documentation()));
|
||||
}
|
||||
|
||||
private FrontendSignatureHelp toFrontendSignatureHelp(final PbsEditorialSignatureHelp signatureHelp) {
|
||||
return new FrontendSignatureHelp(
|
||||
signatureHelp.signatures().stream()
|
||||
.map(this::toFrontendSignature)
|
||||
.toList(),
|
||||
signatureHelp.activeSignature(),
|
||||
signatureHelp.activeParameter());
|
||||
}
|
||||
|
||||
private FrontendSignature toFrontendSignature(final p.studio.compiler.pbs.semantics.PbsEditorialSignature signature) {
|
||||
return new FrontendSignature(signature.label(), signature.parameterLabels(), "");
|
||||
}
|
||||
|
||||
private FrontendSymbolKind toFrontendSymbolKind(final PbsEditorialSymbolKind kind) {
|
||||
return FrontendSymbolKind.valueOf(kind.name());
|
||||
}
|
||||
|
||||
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 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);
|
||||
}
|
||||
}
|
||||
+44
@@ -0,0 +1,44 @@
|
||||
package p.studio.compiler;
|
||||
|
||||
import p.studio.compiler.models.FrontendSpec;
|
||||
import p.studio.compiler.services.FrontendLanguageService;
|
||||
import p.studio.compiler.services.FrontendPhaseService;
|
||||
import p.studio.compiler.services.FrontendProvider;
|
||||
import p.studio.compiler.services.PBSFrontendPhaseService;
|
||||
|
||||
import java.util.Optional;
|
||||
|
||||
public final class PBSFrontendProvider implements FrontendProvider {
|
||||
private final FrontendPhaseService compiler;
|
||||
private final PBSFrontendLanguageService languageService;
|
||||
|
||||
public PBSFrontendProvider() {
|
||||
this(new PBSFrontendPhaseService(), new PBSFrontendLanguageService());
|
||||
}
|
||||
|
||||
PBSFrontendProvider(final FrontendPhaseService compiler) {
|
||||
this(compiler, new PBSFrontendLanguageService());
|
||||
}
|
||||
|
||||
PBSFrontendProvider(
|
||||
final FrontendPhaseService compiler,
|
||||
final PBSFrontendLanguageService languageService) {
|
||||
this.compiler = compiler;
|
||||
this.languageService = languageService;
|
||||
}
|
||||
|
||||
@Override
|
||||
public FrontendSpec specification() {
|
||||
return PBSDefinitions.PBS;
|
||||
}
|
||||
|
||||
@Override
|
||||
public FrontendPhaseService compiler() {
|
||||
return compiler;
|
||||
}
|
||||
|
||||
@Override
|
||||
public Optional<FrontendLanguageService> languageService() {
|
||||
return Optional.of(languageService);
|
||||
}
|
||||
}
|
||||
+3
-1
@@ -1,5 +1,6 @@
|
||||
package p.studio.compiler;
|
||||
|
||||
import p.studio.AppMode;
|
||||
import p.studio.compiler.models.FrontendSemanticToken;
|
||||
import p.studio.compiler.models.FrontendSemanticTokenProvider;
|
||||
import p.studio.compiler.pbs.ast.PbsAst;
|
||||
@@ -26,6 +27,7 @@ import java.util.Set;
|
||||
public final class PBSSemanticTokenProvider implements FrontendSemanticTokenProvider {
|
||||
private static final Set<String> BUILTIN_TYPE_NAMES = Set.of("int", "float", "bool", "string", "i32", "i64", "f32", "f64");
|
||||
private static final int DEFAULT_STDLIB_VERSION = 1;
|
||||
private static final AppMode DEFAULT_TARGET = AppMode.Game;
|
||||
private static final ResourceStdlibEnvironmentResolver STDLIB_RESOLVER = new ResourceStdlibEnvironmentResolver();
|
||||
private static final Map<PbsTokenKind, PbsSemanticKind> DECLARATION_KINDS = declarationKinds();
|
||||
|
||||
@@ -210,7 +212,7 @@ public final class PBSSemanticTokenProvider implements FrontendSemanticTokenProv
|
||||
}
|
||||
|
||||
private Map<String, PbsSemanticKind> resolveStdlibExportKinds(final PbsAst.ModuleRef moduleRef) {
|
||||
final var stdlibEnvironment = STDLIB_RESOLVER.resolve(DEFAULT_STDLIB_VERSION);
|
||||
final var stdlibEnvironment = STDLIB_RESOLVER.resolve(DEFAULT_STDLIB_VERSION, DEFAULT_TARGET);
|
||||
return stdlibEnvironment.resolveModule(moduleRef.project(), moduleRef.pathSegments())
|
||||
.map(this::parseStdlibVisibleKinds)
|
||||
.orElseGet(Map::of);
|
||||
|
||||
+72
@@ -0,0 +1,72 @@
|
||||
package p.studio.compiler.pbs;
|
||||
|
||||
import java.util.ArrayList;
|
||||
import java.util.List;
|
||||
|
||||
public final class PbsDocumentationTextBlockNormalizer {
|
||||
private static final String DELIMITER = "\"\"\"";
|
||||
|
||||
private PbsDocumentationTextBlockNormalizer() {
|
||||
}
|
||||
|
||||
public static String normalizeLexeme(final String lexeme) {
|
||||
if (lexeme == null || !lexeme.startsWith(DELIMITER) || !lexeme.endsWith(DELIMITER) || lexeme.length() < 6) {
|
||||
return "";
|
||||
}
|
||||
return normalizeContent(lexeme.substring(DELIMITER.length(), lexeme.length() - DELIMITER.length()));
|
||||
}
|
||||
|
||||
public static String normalizeContent(final String rawContent) {
|
||||
final var lines = splitLines(rawContent == null ? "" : rawContent.replace("\r\n", "\n").replace('\r', '\n'));
|
||||
removeIncidentalBoundaryLines(lines);
|
||||
final int commonIndent = commonIndent(lines);
|
||||
if (commonIndent > 0) {
|
||||
for (int i = 0; i < lines.size(); i++) {
|
||||
final var line = lines.get(i);
|
||||
if (line.isBlank()) {
|
||||
lines.set(i, "");
|
||||
} else {
|
||||
lines.set(i, line.substring(Math.min(commonIndent, leadingWhitespace(line))));
|
||||
}
|
||||
}
|
||||
}
|
||||
return String.join("\n", lines);
|
||||
}
|
||||
|
||||
private static List<String> splitLines(final String text) {
|
||||
final var lines = new ArrayList<String>();
|
||||
final var parts = text.split("\n", -1);
|
||||
for (final var part : parts) {
|
||||
lines.add(part);
|
||||
}
|
||||
return lines;
|
||||
}
|
||||
|
||||
private static void removeIncidentalBoundaryLines(final List<String> lines) {
|
||||
if (!lines.isEmpty() && lines.getFirst().isBlank()) {
|
||||
lines.removeFirst();
|
||||
}
|
||||
if (!lines.isEmpty() && lines.getLast().isBlank()) {
|
||||
lines.removeLast();
|
||||
}
|
||||
}
|
||||
|
||||
private static int commonIndent(final List<String> lines) {
|
||||
var common = Integer.MAX_VALUE;
|
||||
for (final var line : lines) {
|
||||
if (line.isBlank()) {
|
||||
continue;
|
||||
}
|
||||
common = Math.min(common, leadingWhitespace(line));
|
||||
}
|
||||
return common == Integer.MAX_VALUE ? 0 : common;
|
||||
}
|
||||
|
||||
private static int leadingWhitespace(final String line) {
|
||||
var count = 0;
|
||||
while (count < line.length() && Character.isWhitespace(line.charAt(count))) {
|
||||
count++;
|
||||
}
|
||||
return count;
|
||||
}
|
||||
}
|
||||
+76
-47
@@ -8,6 +8,9 @@ import p.studio.compiler.models.IRFunction;
|
||||
import p.studio.compiler.models.IRGlobal;
|
||||
import p.studio.compiler.models.IRGlobalOrigin;
|
||||
import p.studio.compiler.models.IRGlobalVisibility;
|
||||
import p.studio.compiler.models.IRLifecycleCallableReference;
|
||||
import p.studio.compiler.models.IRLifecycleCallableRole;
|
||||
import p.studio.compiler.models.IRLifecycleFileDeclaration;
|
||||
import p.studio.compiler.models.IRReservedMetadata;
|
||||
import p.studio.compiler.models.IRSyntheticCallableKind;
|
||||
import p.studio.compiler.models.IRSyntheticFunction;
|
||||
@@ -215,6 +218,12 @@ public final class PbsFrontendCompiler {
|
||||
if (fileInitExecutable != null) {
|
||||
executableFunctions.add(fileInitExecutable);
|
||||
}
|
||||
final var lifecycleDeclaration = lowerLifecycleDeclaration(
|
||||
fileId,
|
||||
effectiveModuleId,
|
||||
lifecycleArtifacts,
|
||||
fileInitExecutable,
|
||||
executableFunctions);
|
||||
return new IRBackendFile(
|
||||
fileId,
|
||||
functions,
|
||||
@@ -224,7 +233,8 @@ public final class PbsFrontendCompiler {
|
||||
reservedMetadata,
|
||||
effectiveModulePool,
|
||||
ReadOnlyList.wrap(callableSignatures),
|
||||
executableLowering.intrinsicPool());
|
||||
executableLowering.intrinsicPool(),
|
||||
lifecycleDeclaration);
|
||||
}
|
||||
|
||||
public String callableShapeSurfaceOf(final PbsAst.FunctionDecl functionDecl) {
|
||||
@@ -306,33 +316,19 @@ public final class PbsFrontendCompiler {
|
||||
final var frameDecl = lifecycleArtifacts.frameDecl();
|
||||
final var firstGlobalDecl = lifecycleArtifacts.firstGlobalDecl();
|
||||
|
||||
final var fileInitAnchorSpan = initDecl != null ? initDecl.span() : firstGlobalDecl == null ? null : firstGlobalDecl.span();
|
||||
final var fileInitAnchorName = initDecl != null ? initDecl.name() : firstGlobalDecl == null ? "" : firstGlobalDecl.name();
|
||||
final var ordinaryFileInit = frameDecl == null ? initDecl : null;
|
||||
final var fileInitAnchorSpan = ordinaryFileInit != null
|
||||
? ordinaryFileInit.span()
|
||||
: firstGlobalDecl == null ? null : firstGlobalDecl.span();
|
||||
final var fileInitAnchorName = ordinaryFileInit != null
|
||||
? ordinaryFileInit.name()
|
||||
: firstGlobalDecl == null ? "" : firstGlobalDecl.name();
|
||||
if (fileInitAnchorSpan != null) {
|
||||
syntheticFunctions.add(new IRSyntheticFunction(
|
||||
moduleId,
|
||||
fileInitCallableName(fileId),
|
||||
IRSyntheticCallableKind.FILE_INIT_FRAGMENT,
|
||||
new IRSyntheticOrigin(fileId, fileInitAnchorName, fileInitAnchorSpan)));
|
||||
syntheticFunctions.add(new IRSyntheticFunction(
|
||||
moduleId,
|
||||
moduleInitCallableName(moduleId),
|
||||
IRSyntheticCallableKind.MODULE_INIT,
|
||||
new IRSyntheticOrigin(fileId, fileInitAnchorName, fileInitAnchorSpan)));
|
||||
}
|
||||
if (initDecl != null && frameDecl != null) {
|
||||
syntheticFunctions.add(new IRSyntheticFunction(
|
||||
moduleId,
|
||||
projectInitCallableName(moduleId),
|
||||
IRSyntheticCallableKind.PROJECT_INIT,
|
||||
new IRSyntheticOrigin(fileId, initDecl.name(), initDecl.span())));
|
||||
}
|
||||
if (frameDecl != null) {
|
||||
syntheticFunctions.add(new IRSyntheticFunction(
|
||||
moduleId,
|
||||
frameWrapperCallableName(moduleId),
|
||||
IRSyntheticCallableKind.PUBLISHED_FRAME_WRAPPER,
|
||||
new IRSyntheticOrigin(fileId, frameDecl.name(), frameDecl.span())));
|
||||
}
|
||||
return ReadOnlyList.wrap(syntheticFunctions);
|
||||
}
|
||||
@@ -343,8 +339,10 @@ public final class PbsFrontendCompiler {
|
||||
final PbsLifecycleArtifacts lifecycleArtifacts,
|
||||
final ArrayList<IRBackendExecutableFunction> executableFunctions,
|
||||
final ArrayList<CallableSignatureRef> callableSignatures) {
|
||||
if (lifecycleArtifacts.firstGlobalDecl() == null
|
||||
&& lifecycleArtifacts.initDecl() == null) {
|
||||
final var ordinaryFileInit = lifecycleArtifacts.frameDecl() == null
|
||||
? lifecycleArtifacts.initDecl()
|
||||
: null;
|
||||
if (lifecycleArtifacts.firstGlobalDecl() == null && ordinaryFileInit == null) {
|
||||
return null;
|
||||
}
|
||||
final var syntheticCallableName = fileInitCallableName(fileId);
|
||||
@@ -352,8 +350,8 @@ public final class PbsFrontendCompiler {
|
||||
callableSignatures.add(new CallableSignatureRef(moduleId, syntheticCallableName, 0, "() -> unit"));
|
||||
|
||||
final var instructions = new ArrayList<IRBackendExecutableFunction.Instruction>();
|
||||
final var moduleInitSource = lifecycleArtifacts.initDecl();
|
||||
if (moduleInitSource != null && moduleInitSource != lifecycleArtifacts.frameDecl()) {
|
||||
final var moduleInitSource = ordinaryFileInit;
|
||||
if (moduleInitSource != null) {
|
||||
final var initExecutable = resolveLifecycleExecutable(executableFunctions, moduleId, moduleInitSource.name());
|
||||
if (initExecutable != null) {
|
||||
instructions.add(new IRBackendExecutableFunction.Instruction(
|
||||
@@ -390,6 +388,58 @@ public final class PbsFrontendCompiler {
|
||||
span);
|
||||
}
|
||||
|
||||
private IRLifecycleFileDeclaration lowerLifecycleDeclaration(
|
||||
final FileId fileId,
|
||||
final ModuleId moduleId,
|
||||
final PbsLifecycleArtifacts lifecycleArtifacts,
|
||||
final IRBackendExecutableFunction fileInitExecutable,
|
||||
final ArrayList<IRBackendExecutableFunction> executableFunctions) {
|
||||
final var fileInitReference = fileInitExecutable == null
|
||||
? null
|
||||
: new IRLifecycleCallableReference(
|
||||
moduleId,
|
||||
fileId,
|
||||
fileInitExecutable.callableId(),
|
||||
IRLifecycleCallableRole.FILE_INIT_FRAGMENT,
|
||||
fileInitExecutable.span());
|
||||
|
||||
final var projectInitSource = lifecycleArtifacts.frameDecl() == null
|
||||
? null
|
||||
: lifecycleArtifacts.initDecl();
|
||||
final var projectInitExecutable = projectInitSource == null
|
||||
? null
|
||||
: resolveLifecycleExecutable(executableFunctions, moduleId, projectInitSource.name());
|
||||
final var projectInitReference = projectInitExecutable == null
|
||||
? null
|
||||
: new IRLifecycleCallableReference(
|
||||
moduleId,
|
||||
fileId,
|
||||
projectInitExecutable.callableId(),
|
||||
IRLifecycleCallableRole.PROJECT_INIT,
|
||||
projectInitSource.span());
|
||||
|
||||
final var frameSource = lifecycleArtifacts.frameDecl();
|
||||
final var frameExecutable = frameSource == null
|
||||
? null
|
||||
: resolveLifecycleExecutable(executableFunctions, moduleId, frameSource.name());
|
||||
final var frameReference = frameExecutable == null
|
||||
? null
|
||||
: new IRLifecycleCallableReference(
|
||||
moduleId,
|
||||
fileId,
|
||||
frameExecutable.callableId(),
|
||||
IRLifecycleCallableRole.FRAME_ROOT,
|
||||
frameSource.span());
|
||||
|
||||
final var declaration = new IRLifecycleFileDeclaration(
|
||||
moduleId,
|
||||
fileId,
|
||||
fileInitReference,
|
||||
projectInitReference,
|
||||
frameReference);
|
||||
return declaration.isEmpty() ? null : declaration;
|
||||
}
|
||||
|
||||
private IRBackendExecutableFunction resolveLifecycleExecutable(
|
||||
final ArrayList<IRBackendExecutableFunction> executableFunctions,
|
||||
final ModuleId moduleId,
|
||||
@@ -443,27 +493,6 @@ public final class PbsFrontendCompiler {
|
||||
return "__pbs.file_init$f" + fileId.getId();
|
||||
}
|
||||
|
||||
public static String moduleInitCallableName(final ModuleId moduleId) {
|
||||
return "__pbs.module_init$m" + normalizedModuleIndex(moduleId);
|
||||
}
|
||||
|
||||
public static String projectInitCallableName(final ModuleId moduleId) {
|
||||
return "__pbs.project_init$m" + normalizedModuleIndex(moduleId);
|
||||
}
|
||||
|
||||
public static String frameWrapperCallableName(final ModuleId moduleId) {
|
||||
return "__pbs.frame_wrapper$m" + normalizedModuleIndex(moduleId);
|
||||
}
|
||||
|
||||
public static String bootGuardGlobalName(final ModuleId moduleId) {
|
||||
return "__pbs.boot_guard$m" + normalizedModuleIndex(moduleId);
|
||||
}
|
||||
|
||||
private static int normalizedModuleIndex(final ModuleId moduleId) {
|
||||
final var normalized = moduleId == null ? ModuleId.none() : moduleId;
|
||||
return normalized.isNone() ? -1 : normalized.getIndex();
|
||||
}
|
||||
|
||||
private int safeToInt(final long value) {
|
||||
if (value > Integer.MAX_VALUE) {
|
||||
return Integer.MAX_VALUE;
|
||||
|
||||
+1
-1
@@ -50,7 +50,7 @@ public enum PbsSemanticKind {
|
||||
public static PbsSemanticKind forToken(final PbsToken token) {
|
||||
return switch (token.kind()) {
|
||||
case COMMENT -> COMMENT;
|
||||
case STRING_LITERAL -> STRING;
|
||||
case STRING_LITERAL, DOC_TEXT_BLOCK -> STRING;
|
||||
case INT_LITERAL, FLOAT_LITERAL, BOUNDED_LITERAL -> NUMBER;
|
||||
case TRUE, FALSE, NONE, SOME, OK, ERR -> LITERAL;
|
||||
case VOID, OPTIONAL, RESULT -> BUILTIN_TYPE;
|
||||
|
||||
+14
@@ -78,6 +78,7 @@ public final class PbsAst {
|
||||
}
|
||||
|
||||
public sealed interface AttributeValue permits AttributeStringValue,
|
||||
AttributeDocTextBlockValue,
|
||||
AttributeIntValue,
|
||||
AttributeBoolValue,
|
||||
AttributeErrorValue {
|
||||
@@ -89,6 +90,11 @@ public final class PbsAst {
|
||||
Span span) implements AttributeValue {
|
||||
}
|
||||
|
||||
public record AttributeDocTextBlockValue(
|
||||
String value,
|
||||
Span span) implements AttributeValue {
|
||||
}
|
||||
|
||||
public record AttributeIntValue(
|
||||
long value,
|
||||
Span span) implements AttributeValue {
|
||||
@@ -132,6 +138,7 @@ public final class PbsAst {
|
||||
ReturnKind returnKind,
|
||||
TypeRef returnType,
|
||||
TypeRef resultErrorType,
|
||||
ReadOnlyList<Attribute> attributes,
|
||||
LifecycleMarker lifecycleMarker,
|
||||
Block body,
|
||||
Span span) implements TopDecl {
|
||||
@@ -143,18 +150,21 @@ public final class PbsAst {
|
||||
ReadOnlyList<FunctionDecl> methods,
|
||||
ReadOnlyList<CtorDecl> ctors,
|
||||
boolean hasBody,
|
||||
ReadOnlyList<Attribute> attributes,
|
||||
Span span) implements TopDecl {
|
||||
}
|
||||
|
||||
public record ContractDecl(
|
||||
String name,
|
||||
ReadOnlyList<FunctionSignature> signatures,
|
||||
ReadOnlyList<Attribute> attributes,
|
||||
Span span) implements TopDecl {
|
||||
}
|
||||
|
||||
public record HostDecl(
|
||||
String name,
|
||||
ReadOnlyList<FunctionSignature> signatures,
|
||||
ReadOnlyList<Attribute> attributes,
|
||||
Span span) implements TopDecl {
|
||||
}
|
||||
|
||||
@@ -169,18 +179,21 @@ public final class PbsAst {
|
||||
public record ServiceDecl(
|
||||
String name,
|
||||
ReadOnlyList<FunctionDecl> methods,
|
||||
ReadOnlyList<Attribute> attributes,
|
||||
Span span) implements TopDecl {
|
||||
}
|
||||
|
||||
public record ErrorDecl(
|
||||
String name,
|
||||
ReadOnlyList<String> cases,
|
||||
ReadOnlyList<Attribute> attributes,
|
||||
Span span) implements TopDecl {
|
||||
}
|
||||
|
||||
public record EnumDecl(
|
||||
String name,
|
||||
ReadOnlyList<EnumCase> cases,
|
||||
ReadOnlyList<Attribute> attributes,
|
||||
Span span) implements TopDecl {
|
||||
}
|
||||
|
||||
@@ -190,6 +203,7 @@ public final class PbsAst {
|
||||
ReturnKind returnKind,
|
||||
TypeRef returnType,
|
||||
TypeRef resultErrorType,
|
||||
ReadOnlyList<Attribute> attributes,
|
||||
Span span) implements TopDecl {
|
||||
}
|
||||
|
||||
|
||||
+1
@@ -3,5 +3,6 @@ package p.studio.compiler.pbs.lexer;
|
||||
public enum LexErrors {
|
||||
E_LEX_INVALID_CHAR,
|
||||
E_LEX_UNTERMINATED_STRING,
|
||||
E_LEX_UNTERMINATED_DOC_TEXT_BLOCK,
|
||||
E_LEX_INVALID_STRING_ESCAPE,
|
||||
}
|
||||
|
||||
+39
-1
@@ -17,6 +17,7 @@ public final class PbsLexer {
|
||||
IDENTIFIER,
|
||||
NUMBER,
|
||||
STRING,
|
||||
DOC_TEXT_BLOCK,
|
||||
LINE_COMMENT
|
||||
}
|
||||
|
||||
@@ -52,6 +53,7 @@ public final class PbsLexer {
|
||||
case IDENTIFIER -> scanIdentifierState();
|
||||
case NUMBER -> scanNumberState();
|
||||
case STRING -> scanStringState();
|
||||
case DOC_TEXT_BLOCK -> scanDocTextBlockState();
|
||||
case LINE_COMMENT -> scanLineCommentState();
|
||||
}
|
||||
}
|
||||
@@ -123,7 +125,15 @@ public final class PbsLexer {
|
||||
}
|
||||
addToken(match('=') ? PbsTokenKind.SLASH_EQUAL : PbsTokenKind.SLASH);
|
||||
}
|
||||
case '"' -> state = LexerState.STRING;
|
||||
case '"' -> {
|
||||
if (peek() == '"' && peekNext() == '"') {
|
||||
advance();
|
||||
advance();
|
||||
state = LexerState.DOC_TEXT_BLOCK;
|
||||
return;
|
||||
}
|
||||
state = LexerState.STRING;
|
||||
}
|
||||
default -> {
|
||||
if (isDigit(c)) {
|
||||
state = LexerState.NUMBER;
|
||||
@@ -206,6 +216,23 @@ public final class PbsLexer {
|
||||
state = LexerState.DEFAULT;
|
||||
}
|
||||
|
||||
private void scanDocTextBlockState() {
|
||||
while (!isAtEnd()) {
|
||||
if (peek() == '"' && peekNext() == '"' && peekAfterNext() == '"') {
|
||||
advance();
|
||||
advance();
|
||||
advance();
|
||||
addToken(PbsTokenKind.DOC_TEXT_BLOCK);
|
||||
state = LexerState.DEFAULT;
|
||||
return;
|
||||
}
|
||||
advance();
|
||||
}
|
||||
|
||||
report(LexErrors.E_LEX_UNTERMINATED_DOC_TEXT_BLOCK, "Unterminated documentation text block");
|
||||
state = LexerState.DEFAULT;
|
||||
}
|
||||
|
||||
private void scanLineCommentState() {
|
||||
while (!isAtEnd() && peek() != '\n') {
|
||||
advance();
|
||||
@@ -250,6 +277,17 @@ public final class PbsLexer {
|
||||
return source.codePointAt(nextIndex);
|
||||
}
|
||||
|
||||
private int peekAfterNext() {
|
||||
if (isAtEnd()) return '\0';
|
||||
final int first = source.codePointAt(current);
|
||||
final int secondIndex = current + Character.charCount(first);
|
||||
if (secondIndex >= source.length()) return '\0';
|
||||
final int second = source.codePointAt(secondIndex);
|
||||
final int thirdIndex = secondIndex + Character.charCount(second);
|
||||
if (thirdIndex >= source.length()) return '\0';
|
||||
return source.codePointAt(thirdIndex);
|
||||
}
|
||||
|
||||
private boolean isAtEnd() {
|
||||
return current >= source.length();
|
||||
}
|
||||
|
||||
+1
@@ -17,6 +17,7 @@ public enum PbsTokenKind {
|
||||
FLOAT_LITERAL,
|
||||
BOUNDED_LITERAL,
|
||||
STRING_LITERAL,
|
||||
DOC_TEXT_BLOCK,
|
||||
COMMENT,
|
||||
|
||||
// Import keywords.
|
||||
|
||||
+23
@@ -574,7 +574,30 @@ final class PbsExecutableBodyLowerer {
|
||||
final var constDecl = context.resolveConstDecl(identifierExpr.name());
|
||||
if (constDecl != null && constDecl.initializer() != null) {
|
||||
lowerConstExpression(constDecl.initializer(), context);
|
||||
return;
|
||||
}
|
||||
final var builtinConst = context.builtinConstByNameId().get(context.nameTable().register(identifierExpr.name()));
|
||||
if (builtinConst != null) {
|
||||
emitBuiltinConstFetch(builtinConst, identifierExpr.span(), context);
|
||||
}
|
||||
}
|
||||
|
||||
private void emitBuiltinConstFetch(
|
||||
final p.studio.compiler.models.IRReservedMetadata.BuiltinConstSurface builtinConst,
|
||||
final p.studio.compiler.source.Span span,
|
||||
final PbsExecutableLoweringContext context) {
|
||||
final var canonicalName = builtinConst.canonicalTarget() + "." + builtinConst.canonicalName();
|
||||
context.instructions().add(new IRBackendExecutableFunction.Instruction(
|
||||
IRBackendExecutableFunction.InstructionKind.CALL_INTRINSIC,
|
||||
"",
|
||||
null,
|
||||
new IRBackendExecutableFunction.IntrinsicCallMetadata(
|
||||
canonicalName,
|
||||
builtinConst.canonicalVersion(),
|
||||
context.intrinsicIdTable().register(canonicalName, builtinConst.canonicalVersion())),
|
||||
0,
|
||||
1,
|
||||
span));
|
||||
}
|
||||
|
||||
private String flattenAssetReference(final PbsAst.Expression expression) {
|
||||
|
||||
+4
@@ -326,6 +326,10 @@ final class PbsExecutableCallsiteEmitter {
|
||||
if (!localOwner.isBlank()) {
|
||||
return localOwner;
|
||||
}
|
||||
final var builtinOwner = context.builtinCanonicalBySourceType().getOrDefault(identifier, "");
|
||||
if (!builtinOwner.isBlank()) {
|
||||
return builtinOwner;
|
||||
}
|
||||
return context.builtinConstOwnerByNameId().getOrDefault(context.nameTable().register(identifier), "");
|
||||
}
|
||||
|
||||
|
||||
+4
@@ -60,6 +60,10 @@ final class PbsExecutableLoweringContext {
|
||||
return metadataIndex.builtinConstOwnerByNameId();
|
||||
}
|
||||
|
||||
Map<NameId, p.studio.compiler.models.IRReservedMetadata.BuiltinConstSurface> builtinConstByNameId() {
|
||||
return metadataIndex.builtinConstByNameId();
|
||||
}
|
||||
|
||||
Map<NameId, Integer> globalSlotByNameId() {
|
||||
return metadataIndex.globalSlotByNameId();
|
||||
}
|
||||
|
||||
+1
@@ -45,6 +45,7 @@ public class PbsExecutableLoweringModels {
|
||||
Map<NameId, List<IRReservedMetadata.HostMethodBinding>> hostByMethodName,
|
||||
Map<String, String> builtinCanonicalBySourceType,
|
||||
Map<NameId, String> builtinConstOwnerByNameId,
|
||||
Map<NameId, IRReservedMetadata.BuiltinConstSurface> builtinConstByNameId,
|
||||
Map<NameId, Integer> globalSlotByNameId,
|
||||
Map<NameId, PbsAst.ConstDecl> constDeclByNameId,
|
||||
Map<String, Addressable> addressableByAddress,
|
||||
|
||||
+15
@@ -30,6 +30,7 @@ final class PbsExecutableMetadataIndexFactory {
|
||||
final var hostByMethodName = indexHostBindingsByMethodName(reservedMetadata, nameTable);
|
||||
final var builtinCanonicalBySourceType = indexBuiltinCanonicalBySourceType(reservedMetadata);
|
||||
final var builtinConstOwnerByNameId = indexBuiltinConstOwners(reservedMetadata, nameTable);
|
||||
final var builtinConstByNameId = indexBuiltinConstSurfaces(reservedMetadata, nameTable);
|
||||
final var globalSlotByNameId = indexGlobalSlots(ast, nameTable);
|
||||
final var constDeclByNameId = indexConstDecls(ast, nameTable);
|
||||
final var addressableByAddress = indexAddressables(feSurfaceContext);
|
||||
@@ -50,6 +51,7 @@ final class PbsExecutableMetadataIndexFactory {
|
||||
hostByMethodName,
|
||||
builtinCanonicalBySourceType,
|
||||
builtinConstOwnerByNameId,
|
||||
builtinConstByNameId,
|
||||
globalSlotByNameId,
|
||||
constDeclByNameId,
|
||||
addressableByAddress,
|
||||
@@ -90,6 +92,19 @@ final class PbsExecutableMetadataIndexFactory {
|
||||
return builtinConstOwnerByNameId;
|
||||
}
|
||||
|
||||
private Map<NameId, IRReservedMetadata.BuiltinConstSurface> indexBuiltinConstSurfaces(
|
||||
final IRReservedMetadata reservedMetadata,
|
||||
final NameTable nameTable) {
|
||||
final var builtinConstByNameId = new HashMap<NameId, IRReservedMetadata.BuiltinConstSurface>();
|
||||
for (final var builtinConst : reservedMetadata.builtinConstSurfaces()) {
|
||||
if (builtinConst.sourceConstName().isBlank() || builtinConst.canonicalTarget().isBlank()) {
|
||||
continue;
|
||||
}
|
||||
builtinConstByNameId.put(nameTable.register(builtinConst.sourceConstName()), builtinConst);
|
||||
}
|
||||
return builtinConstByNameId;
|
||||
}
|
||||
|
||||
private Map<NameId, Integer> indexGlobalSlots(
|
||||
final PbsAst.File ast,
|
||||
final NameTable nameTable) {
|
||||
|
||||
+4
@@ -84,6 +84,10 @@ final class PbsAttributeParser {
|
||||
final var token = cursor.previous();
|
||||
return new PbsAst.AttributeStringValue(token.lexeme(), context.span(token.start(), token.end()));
|
||||
}
|
||||
if (cursor.match(PbsTokenKind.DOC_TEXT_BLOCK)) {
|
||||
final var token = cursor.previous();
|
||||
return new PbsAst.AttributeDocTextBlockValue(token.lexeme(), context.span(token.start(), token.end()));
|
||||
}
|
||||
if (cursor.match(PbsTokenKind.INT_LITERAL)) {
|
||||
final var token = cursor.previous();
|
||||
final var parsedLong = parseLongOrNull(token.lexeme());
|
||||
|
||||
+88
-40
@@ -108,28 +108,28 @@ final class PbsDeclarationParser {
|
||||
final PbsToken declareToken,
|
||||
final ReadOnlyList<PbsAst.Attribute> pendingAttributes) {
|
||||
if (cursor.match(PbsTokenKind.STRUCT)) {
|
||||
rejectAttributesBeforeUnsupportedTopDecl(pendingAttributes, "struct declarations");
|
||||
return parseStructDeclaration(declareToken);
|
||||
rejectUnsupportedDeclarationAttributes(pendingAttributes, "struct declarations");
|
||||
return parseStructDeclaration(declareToken, pendingAttributes);
|
||||
}
|
||||
if (cursor.match(PbsTokenKind.CONTRACT)) {
|
||||
rejectAttributesBeforeUnsupportedTopDecl(pendingAttributes, "contract declarations");
|
||||
return parseContractDeclaration(declareToken);
|
||||
rejectUnsupportedDeclarationAttributes(pendingAttributes, "contract declarations");
|
||||
return parseContractDeclaration(declareToken, pendingAttributes);
|
||||
}
|
||||
if (cursor.match(PbsTokenKind.SERVICE)) {
|
||||
rejectAttributesBeforeUnsupportedTopDecl(pendingAttributes, "service declarations");
|
||||
return parseServiceDeclaration(declareToken);
|
||||
rejectUnsupportedDeclarationAttributes(pendingAttributes, "service declarations");
|
||||
return parseServiceDeclaration(declareToken, pendingAttributes);
|
||||
}
|
||||
if (cursor.match(PbsTokenKind.ERROR)) {
|
||||
rejectAttributesBeforeUnsupportedTopDecl(pendingAttributes, "error declarations");
|
||||
return parseErrorDeclaration(declareToken);
|
||||
rejectUnsupportedDeclarationAttributes(pendingAttributes, "error declarations");
|
||||
return parseErrorDeclaration(declareToken, pendingAttributes);
|
||||
}
|
||||
if (cursor.match(PbsTokenKind.ENUM)) {
|
||||
rejectAttributesBeforeUnsupportedTopDecl(pendingAttributes, "enum declarations");
|
||||
return parseEnumDeclaration(declareToken);
|
||||
rejectUnsupportedDeclarationAttributes(pendingAttributes, "enum declarations");
|
||||
return parseEnumDeclaration(declareToken, pendingAttributes);
|
||||
}
|
||||
if (cursor.match(PbsTokenKind.CALLBACK)) {
|
||||
rejectAttributesBeforeUnsupportedTopDecl(pendingAttributes, "callback declarations");
|
||||
return parseCallbackDeclaration(declareToken);
|
||||
rejectUnsupportedDeclarationAttributes(pendingAttributes, "callback declarations");
|
||||
return parseCallbackDeclaration(declareToken, pendingAttributes);
|
||||
}
|
||||
if (cursor.match(PbsTokenKind.GLOBAL)) {
|
||||
rejectAttributesBeforeUnsupportedTopDecl(pendingAttributes, "global declarations");
|
||||
@@ -139,14 +139,14 @@ final class PbsDeclarationParser {
|
||||
return parseConstDeclaration(declareToken, pendingAttributes);
|
||||
}
|
||||
if (cursor.match(PbsTokenKind.HOST)) {
|
||||
rejectAttributesBeforeUnsupportedTopDecl(pendingAttributes, "host declarations");
|
||||
rejectUnsupportedDeclarationAttributes(pendingAttributes, "host declarations");
|
||||
if (isNotInterfaceMode()) {
|
||||
final var end = declarationTerminatorDelegate.consume();
|
||||
report(cursor.previous(), ParseErrors.E_PARSE_RESERVED_DECLARATION,
|
||||
"'declare host' is reserved and not supported in ordinary source modules");
|
||||
return new PbsAst.InvalidDecl("reserved declare host", span(declareToken.start(), end));
|
||||
}
|
||||
return parseHostDeclaration(declareToken);
|
||||
return parseHostDeclaration(declareToken, pendingAttributes);
|
||||
}
|
||||
if (cursor.match(PbsTokenKind.BUILTIN)) {
|
||||
consume(PbsTokenKind.TYPE, "Expected 'type' in 'declare builtin type' declaration");
|
||||
@@ -211,14 +211,16 @@ final class PbsDeclarationParser {
|
||||
span(implementsToken.start(), end));
|
||||
}
|
||||
|
||||
private PbsAst.HostDecl parseHostDeclaration(final PbsToken declareToken) {
|
||||
private PbsAst.HostDecl parseHostDeclaration(
|
||||
final PbsToken declareToken,
|
||||
final ReadOnlyList<PbsAst.Attribute> attributes) {
|
||||
final var name = consume(PbsTokenKind.IDENTIFIER, "Expected host declaration name");
|
||||
consume(PbsTokenKind.LEFT_BRACE, "Expected '{' to start host declaration body");
|
||||
final var signatures = new ArrayList<PbsAst.FunctionSignature>();
|
||||
while (!cursor.check(PbsTokenKind.RIGHT_BRACE) && !cursor.isAtEnd()) {
|
||||
var attributes = ReadOnlyList.<PbsAst.Attribute>empty();
|
||||
var signatureAttributes = ReadOnlyList.<PbsAst.Attribute>empty();
|
||||
if (cursor.check(PbsTokenKind.LEFT_BRACKET)) {
|
||||
attributes = attributeParser.parseAttributeList();
|
||||
signatureAttributes = attributeParser.parseAttributeList();
|
||||
}
|
||||
if (!cursor.match(PbsTokenKind.FN)) {
|
||||
report(cursor.peek(), ParseErrors.E_PARSE_INVALID_DECL_SHAPE,
|
||||
@@ -226,12 +228,13 @@ final class PbsDeclarationParser {
|
||||
cursor.advance();
|
||||
continue;
|
||||
}
|
||||
signatures.add(parseFunctionSignature(cursor.previous(), attributes));
|
||||
signatures.add(parseFunctionSignature(cursor.previous(), signatureAttributes));
|
||||
}
|
||||
final var rightBrace = consume(PbsTokenKind.RIGHT_BRACE, "Expected '}' to end host declaration body");
|
||||
return new PbsAst.HostDecl(
|
||||
name.lexeme(),
|
||||
ReadOnlyList.wrap(signatures),
|
||||
attributes,
|
||||
span(declareToken.start(), rightBrace.end()));
|
||||
}
|
||||
|
||||
@@ -308,7 +311,9 @@ final class PbsDeclarationParser {
|
||||
return fields;
|
||||
}
|
||||
|
||||
private PbsAst.StructDecl parseStructDeclaration(final PbsToken declareToken) {
|
||||
private PbsAst.StructDecl parseStructDeclaration(
|
||||
final PbsToken declareToken,
|
||||
final ReadOnlyList<PbsAst.Attribute> attributes) {
|
||||
final var name = consume(PbsTokenKind.IDENTIFIER, "Expected struct name");
|
||||
consume(PbsTokenKind.LEFT_PAREN, "Expected '(' in struct declaration");
|
||||
final var fields = parseStructFields();
|
||||
@@ -340,6 +345,7 @@ final class PbsDeclarationParser {
|
||||
ReadOnlyList.wrap(methods),
|
||||
ReadOnlyList.wrap(ctors),
|
||||
hasBody,
|
||||
attributes,
|
||||
span(declareToken.start(), end));
|
||||
}
|
||||
|
||||
@@ -382,10 +388,17 @@ final class PbsDeclarationParser {
|
||||
final var methods = new ArrayList<PbsAst.FunctionDecl>();
|
||||
final var ctors = new ArrayList<PbsAst.CtorDecl>();
|
||||
while (!cursor.check(PbsTokenKind.RIGHT_BRACE) && !cursor.isAtEnd()) {
|
||||
var attributes = ReadOnlyList.<PbsAst.Attribute>empty();
|
||||
if (cursor.check(PbsTokenKind.LEFT_BRACKET)) {
|
||||
attributes = attributeParser.parseAttributeList();
|
||||
}
|
||||
if (cursor.match(PbsTokenKind.FN)) {
|
||||
methods.add(parseFunctionLike(cursor.previous(), ReadOnlyList.empty()));
|
||||
methods.add(parseFunctionLike(cursor.previous(), attributes));
|
||||
continue;
|
||||
}
|
||||
if (!attributes.isEmpty()) {
|
||||
reportAttributesNotAllowed(attributes, "Attributes are valid only on struct methods in struct bodies");
|
||||
}
|
||||
if (cursor.match(PbsTokenKind.CTOR)) {
|
||||
ctors.add(parseCtorDeclarationInBody(cursor.previous()));
|
||||
continue;
|
||||
@@ -411,17 +424,19 @@ final class PbsDeclarationParser {
|
||||
span(ctorToken.start(), body.span().getEnd()));
|
||||
}
|
||||
|
||||
private PbsAst.ContractDecl parseContractDeclaration(final PbsToken declareToken) {
|
||||
private PbsAst.ContractDecl parseContractDeclaration(
|
||||
final PbsToken declareToken,
|
||||
final ReadOnlyList<PbsAst.Attribute> attributes) {
|
||||
final var name = consume(PbsTokenKind.IDENTIFIER, "Expected contract name");
|
||||
consume(PbsTokenKind.LEFT_BRACE, "Expected '{' to start contract body");
|
||||
final var signatures = new ArrayList<PbsAst.FunctionSignature>();
|
||||
while (!cursor.check(PbsTokenKind.RIGHT_BRACE) && !cursor.isAtEnd()) {
|
||||
var attributes = ReadOnlyList.<PbsAst.Attribute>empty();
|
||||
var signatureAttributes = ReadOnlyList.<PbsAst.Attribute>empty();
|
||||
if (cursor.check(PbsTokenKind.LEFT_BRACKET)) {
|
||||
attributes = attributeParser.parseAttributeList();
|
||||
signatureAttributes = attributeParser.parseAttributeList();
|
||||
if (isOrdinaryMode()) {
|
||||
reportAttributesNotAllowed(attributes, "Attributes are not allowed in ordinary .pbs source modules");
|
||||
attributes = ReadOnlyList.empty();
|
||||
reportAttributesNotAllowed(signatureAttributes, "Attributes are not allowed in ordinary .pbs source modules");
|
||||
signatureAttributes = ReadOnlyList.empty();
|
||||
}
|
||||
}
|
||||
if (!cursor.match(PbsTokenKind.FN)) {
|
||||
@@ -430,30 +445,41 @@ final class PbsDeclarationParser {
|
||||
cursor.advance();
|
||||
continue;
|
||||
}
|
||||
signatures.add(parseFunctionSignature(cursor.previous(), attributes));
|
||||
signatures.add(parseFunctionSignature(cursor.previous(), signatureAttributes));
|
||||
}
|
||||
final var rightBrace = consume(PbsTokenKind.RIGHT_BRACE, "Expected '}' to end contract body");
|
||||
return new PbsAst.ContractDecl(name.lexeme(), ReadOnlyList.wrap(signatures), span(declareToken.start(), rightBrace.end()));
|
||||
return new PbsAst.ContractDecl(name.lexeme(), ReadOnlyList.wrap(signatures), attributes, span(declareToken.start(), rightBrace.end()));
|
||||
}
|
||||
|
||||
private PbsAst.ServiceDecl parseServiceDeclaration(final PbsToken declareToken) {
|
||||
private PbsAst.ServiceDecl parseServiceDeclaration(
|
||||
final PbsToken declareToken,
|
||||
final ReadOnlyList<PbsAst.Attribute> attributes) {
|
||||
final var name = consume(PbsTokenKind.IDENTIFIER, "Expected service name");
|
||||
consume(PbsTokenKind.LEFT_BRACE, "Expected '{' to start service body");
|
||||
final var methods = new ArrayList<PbsAst.FunctionDecl>();
|
||||
while (!cursor.check(PbsTokenKind.RIGHT_BRACE) && !cursor.isAtEnd()) {
|
||||
var methodAttributes = ReadOnlyList.<PbsAst.Attribute>empty();
|
||||
if (cursor.check(PbsTokenKind.LEFT_BRACKET)) {
|
||||
methodAttributes = attributeParser.parseAttributeList();
|
||||
}
|
||||
if (!cursor.match(PbsTokenKind.FN)) {
|
||||
if (!methodAttributes.isEmpty()) {
|
||||
reportAttributesNotAllowed(methodAttributes, "Attributes are valid only on service methods in service bodies");
|
||||
}
|
||||
report(cursor.peek(), ParseErrors.E_PARSE_INVALID_DECL_SHAPE,
|
||||
"Service body accepts only method declarations");
|
||||
cursor.advance();
|
||||
continue;
|
||||
}
|
||||
methods.add(parseFunctionLike(cursor.previous(), ReadOnlyList.empty()));
|
||||
methods.add(parseFunctionLike(cursor.previous(), methodAttributes));
|
||||
}
|
||||
final var rightBrace = consume(PbsTokenKind.RIGHT_BRACE, "Expected '}' to end service body");
|
||||
return new PbsAst.ServiceDecl(name.lexeme(), ReadOnlyList.wrap(methods), span(declareToken.start(), rightBrace.end()));
|
||||
return new PbsAst.ServiceDecl(name.lexeme(), ReadOnlyList.wrap(methods), attributes, span(declareToken.start(), rightBrace.end()));
|
||||
}
|
||||
|
||||
private PbsAst.ErrorDecl parseErrorDeclaration(final PbsToken declareToken) {
|
||||
private PbsAst.ErrorDecl parseErrorDeclaration(
|
||||
final PbsToken declareToken,
|
||||
final ReadOnlyList<PbsAst.Attribute> attributes) {
|
||||
final var name = consume(PbsTokenKind.IDENTIFIER, "Expected error name");
|
||||
consume(PbsTokenKind.LEFT_BRACE, "Expected '{' to start error body");
|
||||
final var cases = new ArrayList<String>();
|
||||
@@ -463,10 +489,12 @@ final class PbsDeclarationParser {
|
||||
consume(PbsTokenKind.SEMICOLON, "Expected ';' after error case label");
|
||||
}
|
||||
final var rightBrace = consume(PbsTokenKind.RIGHT_BRACE, "Expected '}' to end error body");
|
||||
return new PbsAst.ErrorDecl(name.lexeme(), ReadOnlyList.wrap(cases), span(declareToken.start(), rightBrace.end()));
|
||||
return new PbsAst.ErrorDecl(name.lexeme(), ReadOnlyList.wrap(cases), attributes, span(declareToken.start(), rightBrace.end()));
|
||||
}
|
||||
|
||||
private PbsAst.EnumDecl parseEnumDeclaration(final PbsToken declareToken) {
|
||||
private PbsAst.EnumDecl parseEnumDeclaration(
|
||||
final PbsToken declareToken,
|
||||
final ReadOnlyList<PbsAst.Attribute> attributes) {
|
||||
final var name = consume(PbsTokenKind.IDENTIFIER, "Expected enum name");
|
||||
consume(PbsTokenKind.LEFT_PAREN, "Expected '(' after enum name");
|
||||
|
||||
@@ -522,7 +550,7 @@ final class PbsDeclarationParser {
|
||||
|
||||
final var rightParen = consume(PbsTokenKind.RIGHT_PAREN, "Expected ')' after enum cases");
|
||||
final var semicolon = consume(PbsTokenKind.SEMICOLON, "Expected ';' after enum declaration");
|
||||
return new PbsAst.EnumDecl(name.lexeme(), ReadOnlyList.wrap(cases), span(declareToken.start(), Math.max(rightParen.end(), semicolon.end())));
|
||||
return new PbsAst.EnumDecl(name.lexeme(), ReadOnlyList.wrap(cases), attributes, span(declareToken.start(), Math.max(rightParen.end(), semicolon.end())));
|
||||
}
|
||||
|
||||
private PbsAst.FunctionDecl parseFunctionLike(
|
||||
@@ -543,6 +571,7 @@ final class PbsDeclarationParser {
|
||||
returnSpec.kind(),
|
||||
returnSpec.returnType(),
|
||||
returnSpec.resultErrorType(),
|
||||
pendingAttributes,
|
||||
lifecycleMarker,
|
||||
body,
|
||||
span(fnToken.start(), body.span().getEnd()));
|
||||
@@ -585,7 +614,9 @@ final class PbsDeclarationParser {
|
||||
return token;
|
||||
}
|
||||
|
||||
private PbsAst.CallbackDecl parseCallbackDeclaration(final PbsToken declareToken) {
|
||||
private PbsAst.CallbackDecl parseCallbackDeclaration(
|
||||
final PbsToken declareToken,
|
||||
final ReadOnlyList<PbsAst.Attribute> attributes) {
|
||||
final var name = consume(PbsTokenKind.IDENTIFIER, "Expected callback name");
|
||||
consume(PbsTokenKind.LEFT_PAREN, "Expected '(' after callback name");
|
||||
final var parameters = typeParser.parseParametersUntilRightParen();
|
||||
@@ -600,6 +631,7 @@ final class PbsDeclarationParser {
|
||||
returnSpec.kind(),
|
||||
returnSpec.returnType(),
|
||||
returnSpec.resultErrorType(),
|
||||
attributes,
|
||||
span(declareToken.start(), semicolon.end()));
|
||||
}
|
||||
|
||||
@@ -651,6 +683,20 @@ final class PbsDeclarationParser {
|
||||
reportAttributesNotAllowed(attributes, "Attributes are not allowed before " + targetSurface);
|
||||
}
|
||||
|
||||
private void rejectUnsupportedDeclarationAttributes(
|
||||
final ReadOnlyList<PbsAst.Attribute> attributes,
|
||||
final String targetSurface) {
|
||||
for (final var attribute : attributes) {
|
||||
if ("Doc".equals(attribute.name())) {
|
||||
continue;
|
||||
}
|
||||
p.studio.compiler.source.diagnostics.Diagnostics.error(context.diagnostics(),
|
||||
ParseErrors.E_PARSE_ATTRIBUTES_NOT_ALLOWED.name(),
|
||||
"Only [Doc] is allowed before " + targetSurface,
|
||||
attribute.span());
|
||||
}
|
||||
}
|
||||
|
||||
private void reportAttributesNotAllowed(
|
||||
final ReadOnlyList<PbsAst.Attribute> attributes,
|
||||
final String message) {
|
||||
@@ -676,14 +722,16 @@ final class PbsDeclarationParser {
|
||||
return PbsAst.LifecycleMarker.NONE;
|
||||
}
|
||||
|
||||
if (!isOrdinaryMode()) {
|
||||
reportAttributesNotAllowed(attributes, "Attributes are not allowed before top-level functions");
|
||||
return PbsAst.LifecycleMarker.NONE;
|
||||
}
|
||||
|
||||
PbsAst.LifecycleMarker marker = PbsAst.LifecycleMarker.NONE;
|
||||
for (final var attribute : attributes) {
|
||||
final PbsAst.LifecycleMarker nextMarker;
|
||||
if ("Doc".equals(attribute.name())) {
|
||||
continue;
|
||||
}
|
||||
if (!isOrdinaryMode()) {
|
||||
reportAttributesNotAllowed(attributes, "Only [Doc] is allowed before interface executable methods");
|
||||
return PbsAst.LifecycleMarker.NONE;
|
||||
}
|
||||
if ("Init".equals(attribute.name())) {
|
||||
nextMarker = PbsAst.LifecycleMarker.INIT;
|
||||
} else if ("Frame".equals(attribute.name())) {
|
||||
|
||||
+81
-6
@@ -1,6 +1,7 @@
|
||||
package p.studio.compiler.pbs.semantics;
|
||||
|
||||
import p.studio.compiler.models.SourceKind;
|
||||
import p.studio.compiler.pbs.PbsDocumentationTextBlockNormalizer;
|
||||
import p.studio.compiler.pbs.PbsFrontendCompiler;
|
||||
import p.studio.compiler.pbs.ast.PbsAst;
|
||||
import p.studio.compiler.source.Span;
|
||||
@@ -19,6 +20,7 @@ public final class PbsDeclarationSemanticsValidator {
|
||||
private static final String ATTR_INTRINSIC_CALL = "IntrinsicCall";
|
||||
private static final String ATTR_INIT_ALLOWED = "InitAllowed";
|
||||
private static final String ATTR_ASSET_LOWERING = "AssetLowering";
|
||||
private static final String ATTR_DOC = "Doc";
|
||||
|
||||
private static final Set<String> RESERVED_ATTRIBUTES = Set.of(
|
||||
ATTR_HOST,
|
||||
@@ -27,7 +29,8 @@ public final class PbsDeclarationSemanticsValidator {
|
||||
ATTR_BUILTIN_CONST,
|
||||
ATTR_INTRINSIC_CALL,
|
||||
ATTR_INIT_ALLOWED,
|
||||
ATTR_ASSET_LOWERING);
|
||||
ATTR_ASSET_LOWERING,
|
||||
ATTR_DOC);
|
||||
|
||||
private final NameTable nameTable;
|
||||
private final PbsConstSemanticsValidator constSemanticsValidator = new PbsConstSemanticsValidator();
|
||||
@@ -60,6 +63,7 @@ public final class PbsDeclarationSemanticsValidator {
|
||||
|
||||
for (final var topDecl : ast.topDecls()) {
|
||||
if (topDecl instanceof PbsAst.FunctionDecl functionDecl) {
|
||||
validateDocAttributes(functionDecl.attributes(), "function declarations", diagnostics);
|
||||
if (interfaceModule) {
|
||||
reportInterfaceNonDeclarativeDecl(
|
||||
functionDecl.span(),
|
||||
@@ -82,6 +86,7 @@ public final class PbsDeclarationSemanticsValidator {
|
||||
}
|
||||
|
||||
if (topDecl instanceof PbsAst.StructDecl structDecl) {
|
||||
validateDocAttributes(structDecl.attributes(), "struct declarations", diagnostics);
|
||||
binder.registerType(structDecl.name(), structDecl.span(), "struct");
|
||||
if (interfaceModule && (structDecl.hasBody() || !structDecl.methods().isEmpty() || !structDecl.ctors().isEmpty())) {
|
||||
reportInterfaceNonDeclarativeDecl(
|
||||
@@ -94,6 +99,7 @@ public final class PbsDeclarationSemanticsValidator {
|
||||
}
|
||||
|
||||
if (topDecl instanceof PbsAst.ServiceDecl serviceDecl) {
|
||||
validateDocAttributes(serviceDecl.attributes(), "service declarations", diagnostics);
|
||||
binder.registerType(serviceDecl.name(), serviceDecl.span(), "service");
|
||||
binder.registerValue(serviceDecl.name(), serviceDecl.span(), "service singleton");
|
||||
binder.registerVisibleTopLevelSurface(serviceDecl.name(), serviceDecl.span(), "service");
|
||||
@@ -102,10 +108,12 @@ public final class PbsDeclarationSemanticsValidator {
|
||||
}
|
||||
|
||||
if (topDecl instanceof PbsAst.ContractDecl contractDecl) {
|
||||
validateDocAttributes(contractDecl.attributes(), "contract declarations", diagnostics);
|
||||
binder.registerType(contractDecl.name(), contractDecl.span(), "contract");
|
||||
if (interfaceModule) {
|
||||
for (final var signature : contractDecl.signatures()) {
|
||||
validateReservedAttributeTarget(signature.attributes(), "contract signature", diagnostics);
|
||||
validateDocAttributes(signature.attributes(), "contract signatures", diagnostics);
|
||||
validateReservedAttributeTargetExceptDoc(signature.attributes(), "contract signature", diagnostics);
|
||||
}
|
||||
}
|
||||
validateContractDeclaration(contractDecl, binder, rules);
|
||||
@@ -113,6 +121,7 @@ public final class PbsDeclarationSemanticsValidator {
|
||||
}
|
||||
|
||||
if (topDecl instanceof PbsAst.HostDecl hostDecl) {
|
||||
validateDocAttributes(hostDecl.attributes(), "host declarations", diagnostics);
|
||||
binder.registerHostOwner(hostDecl.name(), hostDecl.span(), "host owner");
|
||||
validateHostDeclaration(hostDecl, binder, rules, interfaceModule, diagnostics);
|
||||
continue;
|
||||
@@ -125,18 +134,21 @@ public final class PbsDeclarationSemanticsValidator {
|
||||
}
|
||||
|
||||
if (topDecl instanceof PbsAst.ErrorDecl errorDecl) {
|
||||
validateDocAttributes(errorDecl.attributes(), "error declarations", diagnostics);
|
||||
binder.registerType(errorDecl.name(), errorDecl.span(), "error");
|
||||
rules.validateErrorDeclaration(errorDecl);
|
||||
continue;
|
||||
}
|
||||
|
||||
if (topDecl instanceof PbsAst.EnumDecl enumDecl) {
|
||||
validateDocAttributes(enumDecl.attributes(), "enum declarations", diagnostics);
|
||||
binder.registerType(enumDecl.name(), enumDecl.span(), "enum");
|
||||
rules.validateEnumDeclaration(enumDecl);
|
||||
continue;
|
||||
}
|
||||
|
||||
if (topDecl instanceof PbsAst.CallbackDecl callbackDecl) {
|
||||
validateDocAttributes(callbackDecl.attributes(), "callback declarations", diagnostics);
|
||||
binder.registerType(callbackDecl.name(), callbackDecl.span(), "callback");
|
||||
rules.validateCallbackDeclaration(callbackDecl);
|
||||
continue;
|
||||
@@ -187,6 +199,7 @@ public final class PbsDeclarationSemanticsValidator {
|
||||
false);
|
||||
final var methodScope = PbsCallableScope.structMethods(ownerNameId);
|
||||
for (final var method : structDecl.methods()) {
|
||||
validateDocAttributes(method.attributes(), "struct methods", diagnostics);
|
||||
validateCallable(
|
||||
methodScope,
|
||||
method.name(),
|
||||
@@ -226,6 +239,7 @@ public final class PbsDeclarationSemanticsValidator {
|
||||
final DiagnosticSink diagnostics) {
|
||||
final var methodScope = PbsCallableScope.serviceMethods(nameTable.register(serviceDecl.name()));
|
||||
for (final var method : serviceDecl.methods()) {
|
||||
validateDocAttributes(method.attributes(), "service methods", diagnostics);
|
||||
validateCallable(
|
||||
methodScope,
|
||||
method.name(),
|
||||
@@ -494,12 +508,13 @@ public final class PbsDeclarationSemanticsValidator {
|
||||
final PbsAst.ConstDecl constDecl,
|
||||
final boolean interfaceModule,
|
||||
final DiagnosticSink diagnostics) {
|
||||
validateDocAttributes(constDecl.attributes(), "const declarations", diagnostics);
|
||||
final var builtinConstAttributes = attributesNamed(constDecl.attributes(), ATTR_BUILTIN_CONST);
|
||||
for (final var attribute : constDecl.attributes()) {
|
||||
if (!isReservedAttribute(attribute.name())) {
|
||||
continue;
|
||||
}
|
||||
if (ATTR_BUILTIN_CONST.equals(attribute.name())) {
|
||||
if (ATTR_BUILTIN_CONST.equals(attribute.name()) || ATTR_DOC.equals(attribute.name())) {
|
||||
continue;
|
||||
}
|
||||
reportInvalidReservedAttributeTarget(
|
||||
@@ -540,6 +555,7 @@ public final class PbsDeclarationSemanticsValidator {
|
||||
private void validateHostSignatureAttributes(
|
||||
final PbsAst.FunctionSignature signature,
|
||||
final DiagnosticSink diagnostics) {
|
||||
validateDocAttributes(signature.attributes(), "host signatures", diagnostics);
|
||||
final var hostAttributes = attributesNamed(signature.attributes(), ATTR_HOST);
|
||||
final var initAllowedAttributes = attributesNamed(signature.attributes(), ATTR_INIT_ALLOWED);
|
||||
final var assetLoweringAttributes = attributesNamed(signature.attributes(), ATTR_ASSET_LOWERING);
|
||||
@@ -550,7 +566,8 @@ public final class PbsDeclarationSemanticsValidator {
|
||||
if (ATTR_HOST.equals(attribute.name())
|
||||
|| ATTR_CAPABILITY.equals(attribute.name())
|
||||
|| ATTR_INIT_ALLOWED.equals(attribute.name())
|
||||
|| ATTR_ASSET_LOWERING.equals(attribute.name())) {
|
||||
|| ATTR_ASSET_LOWERING.equals(attribute.name())
|
||||
|| ATTR_DOC.equals(attribute.name())) {
|
||||
continue;
|
||||
}
|
||||
reportInvalidReservedAttributeTarget(
|
||||
@@ -597,12 +614,13 @@ public final class PbsDeclarationSemanticsValidator {
|
||||
private void validateBuiltinTypeAttribute(
|
||||
final PbsAst.BuiltinTypeDecl builtinTypeDecl,
|
||||
final DiagnosticSink diagnostics) {
|
||||
validateDocAttributes(builtinTypeDecl.attributes(), "builtin type declarations", diagnostics);
|
||||
final var builtinTypeAttributes = attributesNamed(builtinTypeDecl.attributes(), ATTR_BUILTIN_TYPE);
|
||||
for (final var attribute : builtinTypeDecl.attributes()) {
|
||||
if (!isReservedAttribute(attribute.name())) {
|
||||
continue;
|
||||
}
|
||||
if (ATTR_BUILTIN_TYPE.equals(attribute.name())) {
|
||||
if (ATTR_BUILTIN_TYPE.equals(attribute.name()) || ATTR_DOC.equals(attribute.name())) {
|
||||
continue;
|
||||
}
|
||||
reportInvalidReservedAttributeTarget(
|
||||
@@ -645,12 +663,13 @@ public final class PbsDeclarationSemanticsValidator {
|
||||
private void validateIntrinsicCallAttributes(
|
||||
final PbsAst.FunctionSignature signature,
|
||||
final DiagnosticSink diagnostics) {
|
||||
validateDocAttributes(signature.attributes(), "builtin method signatures", diagnostics);
|
||||
final var intrinsicAttributes = attributesNamed(signature.attributes(), ATTR_INTRINSIC_CALL);
|
||||
for (final var attribute : signature.attributes()) {
|
||||
if (!isReservedAttribute(attribute.name())) {
|
||||
continue;
|
||||
}
|
||||
if (ATTR_INTRINSIC_CALL.equals(attribute.name())) {
|
||||
if (ATTR_INTRINSIC_CALL.equals(attribute.name()) || ATTR_DOC.equals(attribute.name())) {
|
||||
continue;
|
||||
}
|
||||
reportInvalidReservedAttributeTarget(
|
||||
@@ -770,6 +789,47 @@ public final class PbsDeclarationSemanticsValidator {
|
||||
}
|
||||
}
|
||||
|
||||
private void validateDocAttributes(
|
||||
final ReadOnlyList<PbsAst.Attribute> attributes,
|
||||
final String targetSurface,
|
||||
final DiagnosticSink diagnostics) {
|
||||
final var docAttributes = attributesNamed(attributes, ATTR_DOC);
|
||||
if (docAttributes.isEmpty()) {
|
||||
return;
|
||||
}
|
||||
if (docAttributes.size() > 1) {
|
||||
for (int i = 1; i < docAttributes.size(); i++) {
|
||||
reportDuplicateReservedAttribute(docAttributes.get(i), ATTR_DOC, diagnostics);
|
||||
}
|
||||
}
|
||||
validateDocAttributeShape(docAttributes.getFirst(), targetSurface, diagnostics);
|
||||
}
|
||||
|
||||
private void validateDocAttributeShape(
|
||||
final PbsAst.Attribute attribute,
|
||||
final String targetSurface,
|
||||
final DiagnosticSink diagnostics) {
|
||||
final var args = validateNamedArguments(attribute, Set.of("markdown"), Set.of(), diagnostics);
|
||||
if (args == null) {
|
||||
return;
|
||||
}
|
||||
final var value = args.get("markdown");
|
||||
if (!(value instanceof PbsAst.AttributeDocTextBlockValue docValue)) {
|
||||
p.studio.compiler.source.diagnostics.Diagnostics.error(diagnostics,
|
||||
PbsSemanticsErrors.E_SEM_MALFORMED_RESERVED_ATTRIBUTE.name(),
|
||||
"Doc.markdown on %s must be a documentation text block".formatted(targetSurface),
|
||||
attribute.span());
|
||||
return;
|
||||
}
|
||||
final var normalized = PbsDocumentationTextBlockNormalizer.normalizeLexeme(docValue.value());
|
||||
if (normalized.isBlank()) {
|
||||
p.studio.compiler.source.diagnostics.Diagnostics.error(diagnostics,
|
||||
PbsSemanticsErrors.E_SEM_MALFORMED_RESERVED_ATTRIBUTE.name(),
|
||||
"Doc.markdown on %s must not be empty".formatted(targetSurface),
|
||||
attribute.span());
|
||||
}
|
||||
}
|
||||
|
||||
private Map<String, PbsAst.AttributeValue> validateNamedArguments(
|
||||
final PbsAst.Attribute attribute,
|
||||
final Set<String> requiredNames,
|
||||
@@ -911,6 +971,21 @@ public final class PbsDeclarationSemanticsValidator {
|
||||
}
|
||||
}
|
||||
|
||||
private void validateReservedAttributeTargetExceptDoc(
|
||||
final ReadOnlyList<PbsAst.Attribute> attributes,
|
||||
final String targetSurface,
|
||||
final DiagnosticSink diagnostics) {
|
||||
for (final var attribute : attributes) {
|
||||
if (!isReservedAttribute(attribute.name()) || ATTR_DOC.equals(attribute.name())) {
|
||||
continue;
|
||||
}
|
||||
reportInvalidReservedAttributeTarget(
|
||||
attribute,
|
||||
"Attribute '%s' is not valid on %s".formatted(attribute.name(), targetSurface),
|
||||
diagnostics);
|
||||
}
|
||||
}
|
||||
|
||||
private void reportInvalidReservedAttributeTarget(
|
||||
final PbsAst.Attribute attribute,
|
||||
final String message,
|
||||
|
||||
+11
-1
@@ -6,12 +6,22 @@ public record PbsEditorialCompletionCandidate(
|
||||
String label,
|
||||
PbsEditorialSymbolKind kind,
|
||||
String detail,
|
||||
String origin) {
|
||||
String origin,
|
||||
String documentation) {
|
||||
public PbsEditorialCompletionCandidate(
|
||||
final String label,
|
||||
final PbsEditorialSymbolKind kind,
|
||||
final String detail,
|
||||
final String origin) {
|
||||
this(label, kind, detail, origin, "");
|
||||
}
|
||||
|
||||
public PbsEditorialCompletionCandidate {
|
||||
label = requireText(label, "label");
|
||||
kind = Objects.requireNonNull(kind, "kind");
|
||||
detail = normalize(detail);
|
||||
origin = normalize(origin);
|
||||
documentation = normalize(documentation);
|
||||
}
|
||||
|
||||
private static String requireText(
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user