https://github.com/ousttrue/yazls
Yet another zig language server.
https://github.com/ousttrue/yazls
Last synced: about 2 months ago
JSON representation
Yet another zig language server.
- Host: GitHub
- URL: https://github.com/ousttrue/yazls
- Owner: ousttrue
- License: mit
- Created: 2022-08-13T02:15:45.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2022-10-20T16:53:30.000Z (over 3 years ago)
- Last Synced: 2025-12-31T04:59:20.805Z (6 months ago)
- Language: Zig
- Size: 147 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# yazls
Yet another zig language server.
を fork して改造した を整理したものです。
zls の zls.exe のみを置き換えて使います。
## vscode の設定
```json:settings.json
"zls.path": "PATH_TO_HERE/zig-out/bin/yazls.exe",
// Linux
"zls.path": "PATH_TO_HERE/zig-out/bin/yazls",
```
Windows11 の WSL2 ArchLinux 上で VSCode で開発中・・・
# TODO
* [ ] 0.1: 改造版の zls を移植。 @cImport の初期実装。
| | zls | yazls | |
|----------------------------------|-----|-------|-------------------------------------------------|
| initialized | | ✅ | 何もしてない |
| $/cancelRequest | | ✅ | 何もしてない |
| initialize | ✅ | ✅ | |
| shutdown | ✅ | ✅ | |
| textDocument/didOpen | ✅ | ✅ | |
| textDocument/didChange | ✅ | ✅ | |
| textDocument/didSave | ✅ | ✅ | BuildFile 再評価無し |
| textDocument/didClose | ✅ | ✅ | 何もしてない |
| textDocument/publishDiagnostics | ✅ | ✅ | camel_case, snake_case 等のスタイルチェック無し |
| textDocument/semanticTokens/full | ✅ | ✅ | |
| textDocument/formatting | ✅ | ✅ | |
| textDocument/documentSymbol | ✅ | ✅ | |
| textDocument/declaration | ✅ | | declaration と definition の区別 |
| textDocument/definition | ✅ | ✅ | 不完全 |
| textDocument/completion | ✅ | ✅ | 不完全 |
| textDocument/signatureHelp | ✅ | ✅ | 不完全 |
| textDocument/hover | ✅ | ✅ | Debug情報 |
| textDocument/rename | ✅ | | TODO |
| textDocument/references | ✅ | | |
| textDocument/codeLens | | | 実験 |
| codeLens/resolve | | | よくわからん |
| @import("builtin") サポート | ✅ | | 停止中・・・ |
| @cImport | | ✅ | /c.zig 決め打ち |
| gyro.zzz から pkg マップをロード | | | build 時依存を解決 |
## @cImport サポート
決まった作法で `@cImport` を記述することで扱えるようにする。
* プロジェクトルートに `c.zig` を配置
```zig
pub usingnamespace @cImport({
// 任意の cInclude など
});
```
* `build.zig` で `c.zig` を Pkg "c" に隔離
```zig
// build.zig
const c_pkg = std.build.Pkg{
.name = "c", // 固定名
.source = .{ .path = "c.zig" }, // 固定ファイル
};
fn main(b: Build)
{
exe.addPackage(c_pkg);
}
```
以上の作法で c.zig を配置する。
yazls 起動時に `zig build-lib c.zig -lc --verbose-cimport` を実行して zig-cache 内の translate-c された zig のパスを得る。
`@import("c")` を zig-cache のファイルで置き換えるという動作をする。
### 決まった作法に固定している理由
* `zig build-lib c.zig -lc --verbose-cimport` を実行するファイルを決定する必要がある
* c.zig に他の要素があると、依存などで `zig build-lib c.zig -lc --verbose-cimport` が失敗する場合がある
* `usingnamespace` に対処するのがめんどくさい
* @cImport が複数あっても zig-cache は1ファイルにまとまるっぽい
## textDocument/declaration textDocument/definition
* [ ] textDocument/declaration => struct_decl まで飛ぶ
* [ ] textDocument/definition => var_decl, container_field まで飛ぶ
* [x] call => fn_decl
* [x] field_access => container_field
* [ ] type from fn that return type
## textDocument/completion
* [ ] builtin 関数
* [x] member field 列挙
* [x] package, *.zig 列挙
* [ ] struct_init 時の field 入力
* [ ] enum
## textDocument/signatureHelp
* [ ] builtin 関数
## textDocument/hover
* [ ] builtin 関数
## builtin 関数
から python で加工している。
正規表現 `{#header_open\|(@\S+?)#}(.+?){#header_close#}` で `@` 始まる関数を抽出している。
## simple 化
* Config ない
* Document の reference カウントしない
* BuildFile は workspace/build.zig ひとつに決め打ち
* import の 参照記録していない。ファイル外からの references を実装してない
* usingnamespace を処理しない
# 実装メモ
`std.zig.parse` から `std.zig.Ast` を得られる。
この Ast 内で identifier Token の symbol 名の解決ができる。
symbol 名は、 local変数, container変数 の何れかである。
local 変数は関数ボディ内で、関数引数、ブロック、if_payload, while_payload, switch_case_payload である。
container 変数は struct の static 変数である。
一番外のスコープは、暗黙的に struct (root container) である。
`@import` は外部の `zig` ファイルの `root` container を表す。
変数宣言の型を解決したい。
変数宣言 `const val : TYPE = EXPR`, 関数引数 `param: TYPE`, ifなどの条件式 `if(EXPR)` から解決する。
TYPE 、無ければ EXPR の型を再帰的に解決する。
関数呼び出し `call` は返り値の型、ポインタ, `optional` 型, `error_union` 型, `try` 式, array の index 参照などは適当に中身の型に参照を解除する。
`field_access` は左辺の struct を取得し、struct のメンバー変数、関数、フィールドから右辺の名前を検索する。
この過程で `@import` の解決が必要になる。
最終的に `u32, type` などの primitive か, `array`, `slice` などの複合型、`fn` もしくは `struct_decl` を得る。
`struct_decl` の場合は `field_acess` が可能で、コンテキストによって、型か値としてふるまうのだが、lsp 用途では区別しなくてもよさそう(手抜き)。
## 課題
* 型解決が多段で起こるので、途中で止まったり間違ったりするのをデバッグ可能にしたい
* completion を解決するときの AST が入力途中で不完全な状態になるので、コンテキストを決定する方法(dicChange の追跡？)