Compare commits
121
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
aec4a3766e | ||
|
|
5f819dc87a | ||
|
|
8e766490d9 | ||
|
|
514ad96148 | ||
|
|
e0a59c8db6 | ||
|
|
75e2b63923 | ||
|
|
5f1e6564d5 | ||
|
|
f5a3fbe9a3 | ||
|
|
11eadc1d9f | ||
|
|
96e1ffc7d5 | ||
|
|
aad7c9619b | ||
|
|
9e138367ef | ||
|
|
1d9befe101 | ||
|
|
abb262d9cf | ||
|
|
eca451b5a3 | ||
|
|
54af50d6d6 | ||
|
|
ce0fc3650d | ||
|
|
ce021e85f4 | ||
|
|
bc6613ec01 | ||
|
|
59aefc5bc2 | ||
|
|
fac58675d5 | ||
|
|
22f6c149db | ||
|
|
6d8b60fcfa | ||
|
|
54ecffc803 | ||
|
|
0731d63adf | ||
|
|
434d74b07f | ||
|
|
55b27f831f | ||
|
|
5586e027ea | ||
|
|
cd2b1a9cb7 | ||
|
|
3b6504d3b1 | ||
|
|
357585d3ba | ||
|
|
3a9c567c32 | ||
|
|
8300c2a3ab | ||
|
|
17b4904ae3 | ||
|
|
7e8f1406b5 | ||
|
|
3f235878c0 | ||
|
|
5f3a54d08f | ||
|
|
157b716eb7 | ||
|
|
c9f96464f3 | ||
|
|
0732202c80 | ||
|
|
1e18a162c4 | ||
|
|
0dbfb473bf | ||
|
|
0add0ab54c | ||
|
|
3acd56f55a | ||
|
|
b7838b45ec | ||
|
|
92cb088f36 | ||
|
|
3dfe98a93d | ||
|
|
f6d51e9b94 | ||
|
|
3ac7fd7ceb | ||
|
|
99f883cfc7 | ||
|
|
76a1804dc1 | ||
|
|
35cc8fa930 | ||
|
|
6f86e6ff97 | ||
|
|
fa91afa92b | ||
|
|
00503fa105 | ||
|
|
f7a4497f3f | ||
|
|
1aef64e0fa | ||
|
|
5d8fdce637 | ||
|
|
5a8881bfd5 | ||
|
|
d487886c8f | ||
|
|
180471e4cd | ||
|
|
71a37a2906 | ||
|
|
ab05f83e77 | ||
|
|
9e11519608 | ||
|
|
a2d26fc777 | ||
|
|
dd1a1544c6 | ||
|
|
fba44622e5 | ||
|
|
2737aaa14e | ||
|
|
bce88ced43 | ||
|
|
fd473a32d8 | ||
|
|
d15dfb6087 | ||
|
|
b953282251 | ||
|
|
bcabfc8962 | ||
|
|
c0fab3d60e | ||
|
|
55caa65f97 | ||
|
|
b73891d19b | ||
|
|
8750040926 | ||
|
|
708b908415 | ||
|
|
c35d684df1 | ||
|
|
678cfbf45e | ||
|
|
bfffea7e69 | ||
|
|
40f11b6f29 | ||
|
|
e25fc95cbf | ||
|
|
a6085b11a1 | ||
|
|
819fdd82b3 | ||
|
|
2e96d75b9f | ||
|
|
f616326383 | ||
|
|
1e2bbe1fc5 | ||
|
|
b630d69186 | ||
|
|
20f4e54a02 | ||
|
|
e58896f087 | ||
|
|
080eac2e1a | ||
|
|
a31befef0b | ||
|
|
65a7555e93 | ||
|
|
84f2f8fac4 | ||
|
|
0c31ec63ee | ||
|
|
603023962e | ||
|
|
e765784170 | ||
|
|
171e413c5f | ||
|
|
5cfc15cf17 | ||
|
|
b8f27c7a18 | ||
|
|
6a6de83972 | ||
|
|
a3b8dbd9d8 | ||
|
|
c63d643469 | ||
|
|
f592689631 | ||
|
|
834f3118c8 | ||
|
|
d285335e1c | ||
|
|
2e17297355 | ||
|
|
fbea13570e | ||
|
|
067970b80c | ||
|
|
c52e132dcc | ||
|
|
53f00e6c6c | ||
|
|
ec49bbbf52 | ||
|
|
06e8e1579d | ||
|
|
9c342c5c72 | ||
|
|
59055ace8c | ||
|
|
2005f405e4 | ||
|
|
062f344676 | ||
|
|
438e48959e | ||
|
|
41746f22e5 | ||
|
|
e584c7aa63 |
No files matched your search
@@ -0,0 +1 @@
|
|||||||
|
*.zip filter=lfs diff=lfs merge=lfs -text
|
||||||
@@ -16,3 +16,8 @@ xcuserdata
|
|||||||
/test.lyng
|
/test.lyng
|
||||||
/sample_texts/1.txt.gz
|
/sample_texts/1.txt.gz
|
||||||
/kotlin-js-store/wasm/yarn.lock
|
/kotlin-js-store/wasm/yarn.lock
|
||||||
|
/distributables
|
||||||
|
.output*.txt
|
||||||
|
debug.log
|
||||||
|
/build.log
|
||||||
|
/test.md
|
||||||
@@ -0,0 +1,28 @@
|
|||||||
|
<component name="ProjectRunConfigurationManager">
|
||||||
|
<configuration default="false" name="Tests in 'lyng.lynglib.jvmTest'" type="GradleRunConfiguration" factoryName="Gradle">
|
||||||
|
<ExternalSystemSettings>
|
||||||
|
<option name="executionName" />
|
||||||
|
<option name="externalProjectPath" value="$PROJECT_DIR$" />
|
||||||
|
<option name="externalSystemIdString" value="GRADLE" />
|
||||||
|
<option name="scriptParameters" value="" />
|
||||||
|
<option name="taskDescriptions">
|
||||||
|
<list />
|
||||||
|
</option>
|
||||||
|
<option name="taskNames">
|
||||||
|
<list>
|
||||||
|
<option value=":lynglib:cleanJvmTest" />
|
||||||
|
<option value=":lynglib:jvmTest" />
|
||||||
|
</list>
|
||||||
|
</option>
|
||||||
|
<option name="vmOptions" />
|
||||||
|
</ExternalSystemSettings>
|
||||||
|
<ExternalSystemDebugServerProcess>false</ExternalSystemDebugServerProcess>
|
||||||
|
<ExternalSystemReattachDebugProcess>true</ExternalSystemReattachDebugProcess>
|
||||||
|
<ExternalSystemDebugDisabled>false</ExternalSystemDebugDisabled>
|
||||||
|
<DebugAllEnabled>false</DebugAllEnabled>
|
||||||
|
<RunAsTest>true</RunAsTest>
|
||||||
|
<GradleProfilingDisabled>false</GradleProfilingDisabled>
|
||||||
|
<GradleCoverageDisabled>false</GradleCoverageDisabled>
|
||||||
|
<method v="2" />
|
||||||
|
</configuration>
|
||||||
|
</component>
|
||||||
@@ -1,3 +1,20 @@
|
|||||||
|
<!--
|
||||||
|
~ Copyright 2025 Sergey S. Chernov real.sergeych@gmail.com
|
||||||
|
~
|
||||||
|
~ Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
~ you may not use this file except in compliance with the License.
|
||||||
|
~ You may obtain a copy of the License at
|
||||||
|
~
|
||||||
|
~ http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
~
|
||||||
|
~ Unless required by applicable law or agreed to in writing, software
|
||||||
|
~ distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
~ See the License for the specific language governing permissions and
|
||||||
|
~ limitations under the License.
|
||||||
|
~
|
||||||
|
-->
|
||||||
|
|
||||||
<component name="ProjectRunConfigurationManager">
|
<component name="ProjectRunConfigurationManager">
|
||||||
<configuration default="false" name="lyng:site [jsBrowserDevelopmentRun]" type="GradleRunConfiguration" factoryName="Gradle">
|
<configuration default="false" name="lyng:site [jsBrowserDevelopmentRun]" type="GradleRunConfiguration" factoryName="Gradle">
|
||||||
<ExternalSystemSettings>
|
<ExternalSystemSettings>
|
||||||
@@ -17,8 +34,11 @@
|
|||||||
</ExternalSystemSettings>
|
</ExternalSystemSettings>
|
||||||
<ExternalSystemDebugServerProcess>true</ExternalSystemDebugServerProcess>
|
<ExternalSystemDebugServerProcess>true</ExternalSystemDebugServerProcess>
|
||||||
<ExternalSystemReattachDebugProcess>true</ExternalSystemReattachDebugProcess>
|
<ExternalSystemReattachDebugProcess>true</ExternalSystemReattachDebugProcess>
|
||||||
|
<ExternalSystemDebugDisabled>false</ExternalSystemDebugDisabled>
|
||||||
<DebugAllEnabled>false</DebugAllEnabled>
|
<DebugAllEnabled>false</DebugAllEnabled>
|
||||||
<RunAsTest>false</RunAsTest>
|
<RunAsTest>false</RunAsTest>
|
||||||
|
<GradleProfilingDisabled>true</GradleProfilingDisabled>
|
||||||
|
<GradleCoverageDisabled>true</GradleCoverageDisabled>
|
||||||
<method v="2" />
|
<method v="2" />
|
||||||
</configuration>
|
</configuration>
|
||||||
</component>
|
</component>
|
||||||
@@ -2,6 +2,53 @@
|
|||||||
|
|
||||||
### Unreleased
|
### Unreleased
|
||||||
|
|
||||||
|
- Language: Abstract Classes and Interfaces
|
||||||
|
- Support for `abstract` modifier on classes, methods, and variables.
|
||||||
|
- Introduced `interface` as a synonym for `abstract class`, supporting full state (constructors, fields, `init` blocks) and implementation by parts via MI.
|
||||||
|
- New `closed` modifier (antonym to `open`) to prevent overriding class members.
|
||||||
|
- Refined `override` logic: mandatory keyword when re-declaring members that exist in the ancestor chain (MRO).
|
||||||
|
- MI Satisfaction: Abstract requirements are automatically satisfied by matching concrete members found later in the C3 MRO chain without requiring explicit proxy methods.
|
||||||
|
- Integration: Updated highlighters (lynglib, lyngweb, IDEA plugin), IDEA completion, and Grazie grammar checking.
|
||||||
|
- Documentation: Updated `docs/OOP.md` with sections on "Abstract Classes and Members", "Interfaces", and "Overriding and Virtual Dispatch".
|
||||||
|
|
||||||
|
- Language: Class properties with accessors
|
||||||
|
- Support for `val` (read-only) and `var` (read-write) properties in classes.
|
||||||
|
- Syntax: `val name [ : Type ] get() { body }` or `var name [ : Type ] get() { body } set(value) { body }`.
|
||||||
|
- Laconic Expression Shorthand: `val prop get() = expression` and `var prop get() = read set(v) = write`.
|
||||||
|
- Properties are pure accessors and do **not** have automatic backing fields.
|
||||||
|
- Validation: `var` properties must have both accessors; `val` must have only a getter.
|
||||||
|
- Integration: Updated TextMate grammar and IntelliJ plugin (highlighting + keywords).
|
||||||
|
- Documentation: New "Properties" section in `docs/OOP.md`.
|
||||||
|
|
||||||
|
- Language: Restricted Setter Visibility
|
||||||
|
- Support for `private set` and `protected set` modifiers on `var` fields and properties.
|
||||||
|
- Allows members to be publicly readable but only writable from within the declaring class or its subclasses.
|
||||||
|
- Enforcement at runtime: throws `AccessException` on unauthorized writes.
|
||||||
|
- Supported only for declarations in class bodies (fields and properties).
|
||||||
|
- Documentation: New "Restricted Setter Visibility" section in `docs/OOP.md`.
|
||||||
|
|
||||||
|
- Language: Late-initialized `val` fields in classes
|
||||||
|
- Support for declaring `val` without an immediate initializer in class bodies.
|
||||||
|
- Compulsory initialization: every late-init `val` must be assigned at least once within the class body or an `init` block.
|
||||||
|
- Write-once enforcement: assigning to a `val` is allowed only if its current value is `Unset`.
|
||||||
|
- Access protection: reading a late-init `val` before it is assigned returns the `Unset` singleton; using `Unset` for most operations throws an `UnsetException`.
|
||||||
|
- Extension properties do not support late-init.
|
||||||
|
- Documentation: New "Late-initialized `val` fields" and "The `Unset` singleton" sections in `docs/OOP.md`.
|
||||||
|
|
||||||
|
- Docs: OOP improvements
|
||||||
|
- New page: `docs/scopes_and_closures.md` detailing `ClosureScope` resolution order, recursion‑safe helpers (`chainLookupIgnoreClosure`, `chainLookupWithMembers`, `baseGetIgnoreClosure`), cycle prevention, and capturing lexical environments for callbacks (`snapshotForClosure`).
|
||||||
|
- Updated: `docs/advanced_topics.md` (link to the new page), `docs/parallelism.md` (closures in `launch`/`flow`), `docs/OOP.md` (visibility from closures with preserved `currentClassCtx`), `docs/exceptions_handling.md` (compatibility alias `SymbolNotFound`).
|
||||||
|
- Tutorial: added quick link to Scopes and Closures.
|
||||||
|
|
||||||
|
- IDEA plugin: Lightweight autocompletion (experimental)
|
||||||
|
- Global completion: local declarations, in‑scope parameters, imported modules, and stdlib symbols.
|
||||||
|
- Member completion: after a dot, suggests only members of the inferred receiver type (incl. chained calls like `Path(".." ).lines().` → `Iterator` methods). No global identifiers appear after a dot.
|
||||||
|
- Inheritance-aware: direct class members first, then inherited (e.g., `List` includes `Collection`/`Iterable` methods).
|
||||||
|
- Heuristics: handles literals (`"…"` → `String`, numbers → `Int/Real`, `[...]` → `List`, `{...}` → `Dict`) and static `Namespace.` members.
|
||||||
|
- Performance: capped results, early prefix filtering, per‑document MiniAst cache, cancellation checks.
|
||||||
|
- Toggle: Settings | Lyng Formatter → "Enable Lyng autocompletion (experimental)" (default ON).
|
||||||
|
- Stabilization: DEBUG completion/Quick Doc logs are OFF by default; behavior aligned between IDE and isolated engine tests.
|
||||||
|
|
||||||
- Language: Named arguments and named splats
|
- Language: Named arguments and named splats
|
||||||
- New call-site syntax for named arguments using colon: `name: value`.
|
- New call-site syntax for named arguments using colon: `name: value`.
|
||||||
- Positional arguments must come before named; positionals after a named argument inside parentheses are rejected.
|
- Positional arguments must come before named; positionals after a named argument inside parentheses are rejected.
|
||||||
@@ -43,3 +90,30 @@
|
|||||||
Notes:
|
Notes:
|
||||||
- Existing single-inheritance code continues to work; resolution reduces to the single base.
|
- Existing single-inheritance code continues to work; resolution reduces to the single base.
|
||||||
- If code previously relied on non-deterministic parent set iteration, C3 MRO provides a predictable order; disambiguate explicitly if needed using `this@Type`/casts.
|
- If code previously relied on non-deterministic parent set iteration, C3 MRO provides a predictable order; disambiguate explicitly if needed using `this@Type`/casts.
|
||||||
|
|
||||||
|
# Changelog
|
||||||
|
|
||||||
|
All notable changes to this project will be documented in this file.
|
||||||
|
|
||||||
|
## Unreleased
|
||||||
|
|
||||||
|
- CLI: Added `fmt` as a first-class Clikt subcommand.
|
||||||
|
- Default behavior: formats files to stdout (no in-place edits by default).
|
||||||
|
- Options:
|
||||||
|
- `--check`: check only; print files that would change; exit with code 2 if any changes are needed.
|
||||||
|
- `-i, --in-place`: write formatted result back to files.
|
||||||
|
- `--spacing`: apply spacing normalization.
|
||||||
|
- `--wrap`, `--wrapping`: enable line wrapping.
|
||||||
|
- Mutually exclusive: `--check` and `--in-place` together now produce an error and exit with code 1.
|
||||||
|
- Multi-file stdout prints headers `--- <path> ---` per file.
|
||||||
|
- `lyng --help` shows `fmt`; `lyng fmt --help` displays dedicated help.
|
||||||
|
- Fix: Property accessors (`get`, `set`, `private set`, `protected set`) are now correctly indented relative to the property declaration.
|
||||||
|
- Fix: Indentation now correctly carries over into blocks that start on extra‑indented lines (e.g., nested `if` statements or property accessor bodies).
|
||||||
|
- Fix: Formatting Markdown files no longer deletes content in `.lyng` code fences and works correctly with injected files (resolves clobbering, `StringIndexOutOfBoundsException`, and `nonempty text is not covered by block` errors).
|
||||||
|
|
||||||
|
- CLI: Preserved legacy script invocation fast-paths:
|
||||||
|
- `lyng script.lyng [args...]` executes the script directly.
|
||||||
|
- `lyng -- -file.lyng [args...]` executes a script whose name begins with `-`.
|
||||||
|
|
||||||
|
- CLI: Fixed a regression where the root help banner could print before subcommands.
|
||||||
|
- Root command no longer prints help when a subcommand (e.g., `fmt`) is invoked.
|
||||||
@@ -1,16 +1,18 @@
|
|||||||
# Lyng: modern scripting for kotlin multiplatform
|
# Lyng: modern scripting for kotlin multiplatform
|
||||||
|
|
||||||
Please visit the project homepage: [https://lynglang.com](https://lynglang.com)
|
Please visit the project homepage: [https://lynglang.com](https://lynglang.com) and a [telegram channel](https://t.me/lynglang) for updates.
|
||||||
|
|
||||||
A KMP library and a standalone interpreter. v1.0.0-SNAPSHOT is now available.
|
|
||||||
|
|
||||||
- simple, compact, intuitive and elegant modern code:
|
- simple, compact, intuitive and elegant modern code:
|
||||||
|
|
||||||
```
|
```lyng
|
||||||
class Point(x, y) {
|
class Point(x, y) {
|
||||||
fun dist() { sqrt(x*x + y*y) }
|
fun dist() { sqrt(x*x + y*y) }
|
||||||
}
|
}
|
||||||
Point(3,4).dist() //< 5
|
|
||||||
|
// Auto-named arguments shorthand (x: is x: x):
|
||||||
|
val x = 3
|
||||||
|
val y = 4
|
||||||
|
Point(x:, y:).dist() //< 5
|
||||||
|
|
||||||
fun swapEnds(first, args..., last, f) {
|
fun swapEnds(first, args..., last, f) {
|
||||||
f( last, ...args, first)
|
f( last, ...args, first)
|
||||||
@@ -39,8 +41,12 @@ and it is multithreaded on platforms supporting it (automatically, no code chang
|
|||||||
|
|
||||||
## Resources:
|
## Resources:
|
||||||
|
|
||||||
|
- [Language home](https://lynglang.com)
|
||||||
- [introduction and tutorial](docs/tutorial.md) - start here please
|
- [introduction and tutorial](docs/tutorial.md) - start here please
|
||||||
|
- [Testing and Assertions](docs/Testing.md)
|
||||||
|
- [Efficient Iterables in Kotlin Interop](docs/EfficientIterables.md)
|
||||||
- [Samples directory](docs/samples)
|
- [Samples directory](docs/samples)
|
||||||
|
- [Formatter (core + CLI + IDE)](docs/formatter.md)
|
||||||
- [Books directory](docs)
|
- [Books directory](docs)
|
||||||
|
|
||||||
## Integration in Kotlin multiplatform
|
## Integration in Kotlin multiplatform
|
||||||
@@ -117,6 +123,28 @@ scope.eval("sumOf(1,2,3)") // <- 6
|
|||||||
```
|
```
|
||||||
Note that the scope stores all changes in it so you can make calls on a single scope to preserve state between calls.
|
Note that the scope stores all changes in it so you can make calls on a single scope to preserve state between calls.
|
||||||
|
|
||||||
|
## IntelliJ IDEA plugin: Lightweight autocompletion (experimental)
|
||||||
|
|
||||||
|
The IDEA plugin provides a fast, lightweight BASIC completion for Lyng code (IntelliJ IDEA 2024.3+).
|
||||||
|
|
||||||
|
What it does:
|
||||||
|
- Global suggestions: in-scope parameters, same-file declarations (functions/classes/vals), imported modules, and stdlib symbols.
|
||||||
|
- Member completion after dot: offers only members of the inferred receiver type. It works for chained calls like `Path(".." ).lines().` (suggests `Iterator` methods), and for literals like `"abc".` (String methods) or `[1,2,3].` (List/Iterable methods).
|
||||||
|
- Inheritance-aware: shows direct class members first, then inherited. For example, `List` also exposes common `Collection`/`Iterable` methods.
|
||||||
|
- Static/namespace members: `Name.` lists only static members when `Name` is a known class or container (e.g., `Math`).
|
||||||
|
- Performance: suggestions are capped; prefix filtering is early; parsing is cached; computation is cancellation-friendly.
|
||||||
|
|
||||||
|
What it does NOT do (yet):
|
||||||
|
- No heavy resolve or project-wide indexing. It’s best-effort, driven by a tiny MiniAst + built-in docs registry.
|
||||||
|
- No control/data-flow type inference.
|
||||||
|
|
||||||
|
Enable/disable:
|
||||||
|
- Settings | Lyng Formatter → "Enable Lyng autocompletion (experimental)" (default: ON).
|
||||||
|
|
||||||
|
Tips:
|
||||||
|
- After a dot, globals are intentionally suppressed (e.g., `lines().Path` is not valid), only the receiver’s members are suggested.
|
||||||
|
- If completion seems sparse, make sure related modules are imported (e.g., `import lyng.io.fs` so that `Path` and its methods are known).
|
||||||
|
|
||||||
## Why?
|
## Why?
|
||||||
|
|
||||||
Designed to add scripting to kotlin multiplatform application in easy and efficient way. This is attempt to achieve what Lua is for C/++.
|
Designed to add scripting to kotlin multiplatform application in easy and efficient way. This is attempt to achieve what Lua is for C/++.
|
||||||
@@ -136,21 +164,8 @@ Designed to add scripting to kotlin multiplatform application in easy and effici
|
|||||||
|
|
||||||
# Language Roadmap
|
# Language Roadmap
|
||||||
|
|
||||||
```mermaid
|
We are now at **v1.0**: basic optimization performed, battery included: standard library is 90% here, initial
|
||||||
flowchart
|
support in HTML, popular editors, and IDEA; tools to syntax highlight and format code are ready. It was released closed to schedule.
|
||||||
v0([the idea])
|
|
||||||
v1([v1: make it happen])
|
|
||||||
v2([v1.5: testmake it fasted and rich featured])
|
|
||||||
v3([v2: ideal script language])
|
|
||||||
v0 --code MVP--> v1
|
|
||||||
v1 --refine and extend--> v2
|
|
||||||
v2 -- optimize --> v3
|
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
## v1.0.0 "Make it happen" - done!
|
|
||||||
|
|
||||||
Planned autumn 2025. Complete dynamic language with sufficient standard library:
|
|
||||||
|
|
||||||
Ready features:
|
Ready features:
|
||||||
|
|
||||||
@@ -175,23 +190,32 @@ Ready features:
|
|||||||
- [x] better stack reporting
|
- [x] better stack reporting
|
||||||
- [x] regular exceptions + extended `when`
|
- [x] regular exceptions + extended `when`
|
||||||
- [x] multiple inheritance for user classes
|
- [x] multiple inheritance for user classes
|
||||||
|
- [x] class properties (accessors)
|
||||||
|
|
||||||
## plan: v1.0 - v1.5 Stability, integration, optimizations
|
## plan: towards v1.5 Enhancing
|
||||||
|
|
||||||
- [x] site with integrated interpreter to give a try
|
- [x] site with integrated interpreter to give a try
|
||||||
- [x] kotlin part public API good docs, integration focused
|
- [x] kotlin part public API good docs, integration focused
|
||||||
- [ ] type specifications
|
- [ ] type specifications
|
||||||
- [ ] language server or compose-based lyng-aware editor
|
- [x] Textmate Bundle
|
||||||
|
- [x] IDEA plugin
|
||||||
- [ ] source docs and maybe lyng.md to a standard
|
- [ ] source docs and maybe lyng.md to a standard
|
||||||
- [ ] metadata first class access from lyng
|
- [ ] metadata first class access from lyng
|
||||||
- [x] aggressive optimizations
|
- [x] aggressive optimizations
|
||||||
- [ ] JVM bytecode optimizations
|
- [ ] compile to JVM bytecode optimization
|
||||||
|
|
||||||
## After 1.5 "Ideal scripting"
|
## After 1.5 "Ideal scripting"
|
||||||
|
|
||||||
Estimated winter 2027
|
Estimated summer 2026
|
||||||
|
|
||||||
- [ ] client with GUI support based on compose multiplatform somehow
|
- propose your feature!
|
||||||
- [ ] notebook - style workbooks with graphs, formulae, etc.
|
|
||||||
|
## Authors
|
||||||
|
|
||||||
|
@-links are for contacting authors on [project home](https://gitea.sergeych.net/SergeychWorks/lyng): this simplest s to open issue for the person you need to convey any information about this project.
|
||||||
|
|
||||||
|
__Sergey Chernov__ @sergeych: Initial idea and architecture, language concept, design, implementation.
|
||||||
|
|
||||||
|
__Yulia Nezhinskaya__ @AlterEgoJuliaN: System analysis, math and features design.
|
||||||
|
|
||||||
[parallelism]: docs/parallelism.md
|
[parallelism]: docs/parallelism.md
|
||||||
+77
-5
@@ -27,10 +27,62 @@ function checkState() {
|
|||||||
|
|
||||||
}
|
}
|
||||||
|
|
||||||
|
# Update docs/idea_plugin.md to point to the latest built IDEA plugin zip
|
||||||
|
# from ./distributables before building the site. The change is temporary and
|
||||||
|
# the original file is restored right after the build.
|
||||||
|
DOC_IDEA_PLUGIN="docs/idea_plugin.md"
|
||||||
|
DOC_IDEA_PLUGIN_BACKUP="${DOC_IDEA_PLUGIN}.deploy_backup"
|
||||||
|
|
||||||
|
function updateIdeaPluginDownloadLink() {
|
||||||
|
if [[ ! -f "$DOC_IDEA_PLUGIN" ]]; then
|
||||||
|
echo "WARN: $DOC_IDEA_PLUGIN not found; skipping plugin link update"
|
||||||
|
return 0
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Find the most recently modified plugin zip
|
||||||
|
local latest
|
||||||
|
latest=$(ls -t distributables/lyng-idea-*.zip 2>/dev/null | head -n 1)
|
||||||
|
if [[ -z "$latest" ]]; then
|
||||||
|
echo "WARN: no distributables/lyng-idea-*.zip found; leaving $DOC_IDEA_PLUGIN unchanged"
|
||||||
|
return 0
|
||||||
|
fi
|
||||||
|
|
||||||
|
local base
|
||||||
|
base=$(basename "$latest")
|
||||||
|
local version
|
||||||
|
version="${base#lyng-idea-}"
|
||||||
|
version="${version%.zip}"
|
||||||
|
local url
|
||||||
|
url="https://lynglang.com/distributables/${base}"
|
||||||
|
local newline
|
||||||
|
newline="### [Download plugin v${version}](${url})"
|
||||||
|
|
||||||
|
# Backup and rewrite the specific markdown line if present
|
||||||
|
cp "$DOC_IDEA_PLUGIN" "$DOC_IDEA_PLUGIN_BACKUP" || {
|
||||||
|
echo "ERROR: can't backup $DOC_IDEA_PLUGIN"; return 1; }
|
||||||
|
|
||||||
|
# Replace the line that starts with the download header; if not found, append it
|
||||||
|
awk -v repl="$newline" 'BEGIN{done=0} \
|
||||||
|
/^### \[Download plugin v/ { print repl; done=1; next } \
|
||||||
|
{ print } \
|
||||||
|
END { if (done==0) exit 42 }' "$DOC_IDEA_PLUGIN_BACKUP" > "$DOC_IDEA_PLUGIN"
|
||||||
|
|
||||||
|
local rc=$?
|
||||||
|
if [[ $rc -eq 42 ]]; then
|
||||||
|
echo "WARN: download link not found in $DOC_IDEA_PLUGIN; appending generated link"
|
||||||
|
echo >> "$DOC_IDEA_PLUGIN"
|
||||||
|
echo "$newline" >> "$DOC_IDEA_PLUGIN"
|
||||||
|
elif [[ $rc -ne 0 ]]; then
|
||||||
|
echo "ERROR: failed to update $DOC_IDEA_PLUGIN; restoring original"
|
||||||
|
mv -f "$DOC_IDEA_PLUGIN_BACKUP" "$DOC_IDEA_PLUGIN" 2>/dev/null
|
||||||
|
return 1
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
# default target settings
|
# default target settings
|
||||||
case "com" in
|
case "com" in
|
||||||
com)
|
com)
|
||||||
SSH_HOST=sergeych@lynglang.com # host to deploy to
|
SSH_HOST=sergeych@d.lynglang.com # host to deploy to
|
||||||
SSH_PORT=22 # ssh port on it
|
SSH_PORT=22 # ssh port on it
|
||||||
ROOT=/bigstore/sergeych_pub/lyng # directory to rsync to
|
ROOT=/bigstore/sergeych_pub/lyng # directory to rsync to
|
||||||
;;
|
;;
|
||||||
@@ -46,15 +98,35 @@ esac
|
|||||||
|
|
||||||
die() { echo "ERROR: $*" 1>&2 ; exit 1; }
|
die() { echo "ERROR: $*" 1>&2 ; exit 1; }
|
||||||
|
|
||||||
./gradlew site:clean site:jsBrowserDistribution || die "compilation failed"
|
function refreshTextmateZip() {
|
||||||
|
echo "Refreshing distributables/lyng-textmate.zip from editors/..."
|
||||||
|
mkdir -p distributables
|
||||||
|
# We use -r for recursive and -q for quiet (optional)
|
||||||
|
# -j can be used if we want to junk paths, but the request says "contents of editors/"
|
||||||
|
# usually we want to preserve the structure inside editors/
|
||||||
|
(cd editors && zip -rq ../distributables/lyng-textmate.zip .)
|
||||||
|
}
|
||||||
|
|
||||||
if [[ $? != 0 ]]; then
|
# Update the IDEA plugin download link in docs (temporarily), then build, then restore the doc
|
||||||
|
refreshTextmateZip
|
||||||
|
updateIdeaPluginDownloadLink || echo "WARN: proceeding without updating IDEA plugin download link"
|
||||||
|
|
||||||
|
./gradlew site:jsBrowserDistribution
|
||||||
|
BUILD_RC=$?
|
||||||
|
|
||||||
|
# Always restore original doc if backup exists
|
||||||
|
if [[ -f "$DOC_IDEA_PLUGIN_BACKUP" ]]; then
|
||||||
|
mv -f "$DOC_IDEA_PLUGIN_BACKUP" "$DOC_IDEA_PLUGIN"
|
||||||
|
fi
|
||||||
|
|
||||||
|
if [[ $BUILD_RC -ne 0 ]]; then
|
||||||
echo
|
echo
|
||||||
echo -- build failed. deploy aborted.
|
echo -- build failed. deploy aborted.
|
||||||
echo
|
echo
|
||||||
exit 100
|
exit 100
|
||||||
fi
|
fi
|
||||||
|
|
||||||
|
|
||||||
#exit 0
|
#exit 0
|
||||||
|
|
||||||
# Prepare working dir
|
# Prepare working dir
|
||||||
@@ -77,8 +149,8 @@ rsync -e "ssh -p ${SSH_PORT}" -avz -r -d --delete ${SRC}/* ${SSH_HOST}:${ROOT}/b
|
|||||||
checkState
|
checkState
|
||||||
#rsync -e "ssh -p ${SSH_PORT}" -avz ./static/* ${SSH_HOST}:${ROOT}/build/dist
|
#rsync -e "ssh -p ${SSH_PORT}" -avz ./static/* ${SSH_HOST}:${ROOT}/build/dist
|
||||||
#checkState
|
#checkState
|
||||||
#rsync -e "ssh -p ${SSH_PORT}" -avz -r -d --delete private_data/* ${SSH_HOST}:${ROOT}/build/private_data
|
rsync -e "ssh -p ${SSH_PORT}" -avz -r -d --delete distributables/* ${SSH_HOST}:${ROOT}/build/dist/distributables
|
||||||
#checkState
|
checkState
|
||||||
|
|
||||||
echo
|
echo
|
||||||
echo finalizing the deploy...
|
echo finalizing the deploy...
|
||||||
|
|||||||
Executable
+256
@@ -0,0 +1,256 @@
|
|||||||
|
#!/bin/bash
|
||||||
|
#
|
||||||
|
# Copyright 2026 Sergey S. Chernov real.sergeych@gmail.com
|
||||||
|
#
|
||||||
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
# you may not use this file except in compliance with the License.
|
||||||
|
# You may obtain a copy of the License at
|
||||||
|
#
|
||||||
|
# http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
#
|
||||||
|
# Unless required by applicable law or agreed to in writing, software
|
||||||
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
# See the License for the specific language governing permissions and
|
||||||
|
# limitations under the License.
|
||||||
|
#
|
||||||
|
#
|
||||||
|
|
||||||
|
set -e
|
||||||
|
|
||||||
|
# Configuration
|
||||||
|
DOCS_DIR="docs"
|
||||||
|
OUTPUT_DIR="distributables"
|
||||||
|
TEMP_DIR="build/temp_docs"
|
||||||
|
MERGED_MD="$TEMP_DIR/merged.md"
|
||||||
|
OUTPUT_HTML="$OUTPUT_DIR/lyng_documentation.html"
|
||||||
|
|
||||||
|
mkdir -p "$OUTPUT_DIR"
|
||||||
|
mkdir -p "$TEMP_DIR"
|
||||||
|
|
||||||
|
# Files that should come first in specific order
|
||||||
|
PRIORITY_FILES=(
|
||||||
|
"tutorial.md"
|
||||||
|
"OOP.md"
|
||||||
|
"advanced_topics.md"
|
||||||
|
"declaring_arguments.md"
|
||||||
|
"scopes_and_closures.md"
|
||||||
|
"exceptions_handling.md"
|
||||||
|
"when.md"
|
||||||
|
"parallelism.md"
|
||||||
|
"Testing.md"
|
||||||
|
)
|
||||||
|
|
||||||
|
# Files that should come next (reference)
|
||||||
|
REFERENCE_FILES=(
|
||||||
|
"Collection.md"
|
||||||
|
"Iterable.md"
|
||||||
|
"Iterator.md"
|
||||||
|
"List.md"
|
||||||
|
"Set.md"
|
||||||
|
"Map.md"
|
||||||
|
"Array.md"
|
||||||
|
"Buffer.md"
|
||||||
|
"RingBuffer.md"
|
||||||
|
"Range.md"
|
||||||
|
"Real.md"
|
||||||
|
"Regex.md"
|
||||||
|
"math.md"
|
||||||
|
"time.md"
|
||||||
|
)
|
||||||
|
|
||||||
|
# Files that are about integration/tools
|
||||||
|
INTEGRATION_FILES=(
|
||||||
|
"serialization.md"
|
||||||
|
"json_and_kotlin_serialization.md"
|
||||||
|
"embedding.md"
|
||||||
|
"lyng_cli.md"
|
||||||
|
"lyng.io.fs.md"
|
||||||
|
"formatter.md"
|
||||||
|
"EfficientIterables.md"
|
||||||
|
)
|
||||||
|
|
||||||
|
# Tracking processed files to avoid duplicates
|
||||||
|
PROCESSED_PATHS=()
|
||||||
|
|
||||||
|
is_excluded() {
|
||||||
|
local full_path="$1"
|
||||||
|
if grep -q "excludeFromIndex" "$full_path"; then
|
||||||
|
return 0 # true in bash
|
||||||
|
fi
|
||||||
|
return 1 # false
|
||||||
|
}
|
||||||
|
|
||||||
|
process_file() {
|
||||||
|
local rel_path="$1"
|
||||||
|
local full_path="$DOCS_DIR/$rel_path"
|
||||||
|
|
||||||
|
if [[ ! -f "$full_path" ]]; then
|
||||||
|
return
|
||||||
|
fi
|
||||||
|
|
||||||
|
if is_excluded "$full_path"; then
|
||||||
|
echo "Skipping excluded: $rel_path"
|
||||||
|
return
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Check for duplicates
|
||||||
|
for p in "${PROCESSED_PATHS[@]}"; do
|
||||||
|
if [[ "$p" == "$rel_path" ]]; then
|
||||||
|
return
|
||||||
|
fi
|
||||||
|
done
|
||||||
|
PROCESSED_PATHS+=("$rel_path")
|
||||||
|
|
||||||
|
echo "Processing: $rel_path"
|
||||||
|
|
||||||
|
# 1. Add an anchor for the file based on its path
|
||||||
|
local anchor_name=$(echo "$rel_path" | sed 's/\//_/g')
|
||||||
|
echo "<div id=\"$anchor_name\"></div>" >> "$MERGED_MD"
|
||||||
|
echo "" >> "$MERGED_MD"
|
||||||
|
|
||||||
|
# 2. Append content with fixed links
|
||||||
|
# - [text](file.md) -> [text](#file.md)
|
||||||
|
# - [text](dir/file.md) -> [text](#dir_file.md)
|
||||||
|
# - [text](file.md#anchor) -> [text](#anchor)
|
||||||
|
# - Fix image links: [alt](../images/...) -> [alt](images/...) if needed, but none found yet.
|
||||||
|
|
||||||
|
cat "$full_path" | \
|
||||||
|
perl -pe 's/\[([^\]]+)\]\(([^)]+)\.md\)/"[$1](#" . ($2 =~ s|\/|_|gr) . ".md)"/ge' | \
|
||||||
|
perl -pe 's/\[([^\]]+)\]\(([^)]+)\.md#([^)]+)\)/[$1](#$3)/g' >> "$MERGED_MD"
|
||||||
|
|
||||||
|
echo -e "\n\n---\n\n" >> "$MERGED_MD"
|
||||||
|
}
|
||||||
|
|
||||||
|
# Start with an empty merged file
|
||||||
|
echo "% Lyng Language Documentation" > "$MERGED_MD"
|
||||||
|
echo "" >> "$MERGED_MD"
|
||||||
|
|
||||||
|
# 1. Process priority files
|
||||||
|
for f in "${PRIORITY_FILES[@]}"; do
|
||||||
|
process_file "$f"
|
||||||
|
done
|
||||||
|
|
||||||
|
# 2. Process reference files
|
||||||
|
for f in "${REFERENCE_FILES[@]}"; do
|
||||||
|
process_file "$f"
|
||||||
|
done
|
||||||
|
|
||||||
|
# 3. Process integration files
|
||||||
|
for f in "${INTEGRATION_FILES[@]}"; do
|
||||||
|
process_file "$f"
|
||||||
|
done
|
||||||
|
|
||||||
|
# 4. Process remaining files in docs root
|
||||||
|
for f in "$DOCS_DIR"/*.md; do
|
||||||
|
rel_f=${f#"$DOCS_DIR/"}
|
||||||
|
process_file "$rel_f"
|
||||||
|
done
|
||||||
|
|
||||||
|
# 5. Process remaining files in subdirs (like samples)
|
||||||
|
find "$DOCS_DIR" -name "*.md" | sort | while read -r f; do
|
||||||
|
rel_f=${f#"$DOCS_DIR/"}
|
||||||
|
process_file "$rel_f"
|
||||||
|
done
|
||||||
|
|
||||||
|
echo "Running pandoc to generate $OUTPUT_HTML..."
|
||||||
|
|
||||||
|
# Use a basic but clean CSS
|
||||||
|
pandoc "$MERGED_MD" -o "$OUTPUT_HTML" \
|
||||||
|
--toc --toc-depth=2 \
|
||||||
|
--standalone \
|
||||||
|
--embed-resources \
|
||||||
|
--metadata title="Lyng Language Documentation" \
|
||||||
|
--css <(echo "
|
||||||
|
body {
|
||||||
|
font-family: -apple-system, BlinkMacSystemFont, \"Segoe UI\", Helvetica, Arial, sans-serif;
|
||||||
|
line-height: 1.6;
|
||||||
|
max-width: 1000px;
|
||||||
|
margin: 0 auto;
|
||||||
|
padding: 2em;
|
||||||
|
color: #24292e;
|
||||||
|
background-color: #fff;
|
||||||
|
}
|
||||||
|
code {
|
||||||
|
background-color: rgba(27,31,35,0.05);
|
||||||
|
padding: 0.2em 0.4em;
|
||||||
|
border-radius: 3px;
|
||||||
|
font-family: SFMono-Regular, Consolas, \"Liberation Mono\", Menlo, monospace;
|
||||||
|
font-size: 85%;
|
||||||
|
}
|
||||||
|
pre {
|
||||||
|
background-color: #f6f8fa;
|
||||||
|
padding: 16px;
|
||||||
|
overflow: auto;
|
||||||
|
border-radius: 3px;
|
||||||
|
line-height: 1.45;
|
||||||
|
}
|
||||||
|
pre code {
|
||||||
|
background-color: transparent;
|
||||||
|
padding: 0;
|
||||||
|
font-size: 100%;
|
||||||
|
}
|
||||||
|
h1 {
|
||||||
|
border-bottom: 1px solid #eaecef;
|
||||||
|
padding-bottom: 0.3em;
|
||||||
|
margin-top: 24px;
|
||||||
|
margin-bottom: 16px;
|
||||||
|
font-weight: 600;
|
||||||
|
}
|
||||||
|
h2 {
|
||||||
|
border-bottom: 1px solid #eaecef;
|
||||||
|
padding-bottom: 0.3em;
|
||||||
|
margin-top: 24px;
|
||||||
|
margin-bottom: 16px;
|
||||||
|
font-weight: 600;
|
||||||
|
}
|
||||||
|
hr {
|
||||||
|
height: 0.25em;
|
||||||
|
padding: 0;
|
||||||
|
margin: 24px 0;
|
||||||
|
background-color: #e1e4e8;
|
||||||
|
border: 0;
|
||||||
|
}
|
||||||
|
blockquote {
|
||||||
|
padding: 0 1em;
|
||||||
|
color: #6a737d;
|
||||||
|
border-left: 0.25em solid #dfe2e5;
|
||||||
|
margin: 0 0 16px 0;
|
||||||
|
}
|
||||||
|
nav#TOC {
|
||||||
|
background: #f9f9f9;
|
||||||
|
padding: 1em;
|
||||||
|
border: 1px solid #eee;
|
||||||
|
margin-bottom: 2.5em;
|
||||||
|
border-radius: 6px;
|
||||||
|
}
|
||||||
|
nav#TOC ul {
|
||||||
|
list-style: none;
|
||||||
|
padding-left: 1.5em;
|
||||||
|
}
|
||||||
|
nav#TOC > ul {
|
||||||
|
padding-left: 0;
|
||||||
|
}
|
||||||
|
table {
|
||||||
|
border-spacing: 0;
|
||||||
|
border-collapse: collapse;
|
||||||
|
margin-top: 0;
|
||||||
|
margin-bottom: 16px;
|
||||||
|
}
|
||||||
|
table th, table td {
|
||||||
|
padding: 6px 13px;
|
||||||
|
border: 1px solid #dfe2e5;
|
||||||
|
}
|
||||||
|
table tr {
|
||||||
|
background-color: #fff;
|
||||||
|
border-top: 1px solid #c6cbd1;
|
||||||
|
}
|
||||||
|
table tr:nth-child(2n) {
|
||||||
|
background-color: #f6f8fa;
|
||||||
|
}
|
||||||
|
")
|
||||||
|
|
||||||
|
echo "-------------------------------------------------------"
|
||||||
|
echo "Done! Documentation generated successfully."
|
||||||
|
echo "Location: $OUTPUT_HTML"
|
||||||
|
echo "-------------------------------------------------------"
|
||||||
@@ -25,3 +25,6 @@ file=./lyng/build/bin/linuxX64/releaseExecutable/lyng.kexe
|
|||||||
strip $file
|
strip $file
|
||||||
upx $file
|
upx $file
|
||||||
cp $file ~/bin/lyng
|
cp $file ~/bin/lyng
|
||||||
|
cp $file ./distributables/lyng
|
||||||
|
zip ./distributables/lyng-linuxX64 ./distributables/lyng
|
||||||
|
rm ./distributables/lyng
|
||||||
+16
-1
@@ -1,5 +1,5 @@
|
|||||||
/*
|
/*
|
||||||
* Copyright 2025 Sergey S. Chernov real.sergeych@gmail.com
|
* Copyright 2026 Sergey S. Chernov real.sergeych@gmail.com
|
||||||
*
|
*
|
||||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
* you may not use this file except in compliance with the License.
|
* you may not use this file except in compliance with the License.
|
||||||
@@ -20,3 +20,18 @@ plugins {
|
|||||||
alias(libs.plugins.kotlinMultiplatform) apply false
|
alias(libs.plugins.kotlinMultiplatform) apply false
|
||||||
alias(libs.plugins.vanniktech.mavenPublish) apply false
|
alias(libs.plugins.vanniktech.mavenPublish) apply false
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Convenience alias to run the IntelliJ IDE with the Lyng plugin from the project root.
|
||||||
|
// Usage: ./gradlew runIde
|
||||||
|
// It simply delegates to :lyng-idea:runIde provided by the Gradle IntelliJ Plugin.
|
||||||
|
tasks.register<org.gradle.api.DefaultTask>("runIde") {
|
||||||
|
group = "intellij"
|
||||||
|
description = "Run IntelliJ IDEA with the Lyng plugin (:lyng-idea)"
|
||||||
|
dependsOn(":lyng-idea:runIde")
|
||||||
|
}
|
||||||
|
|
||||||
|
tasks.register<Exec>("generateDocs") {
|
||||||
|
group = "documentation"
|
||||||
|
description = "Generates a single-file documentation HTML using bin/generate_docs.sh"
|
||||||
|
commandLine("./bin/generate_docs.sh")
|
||||||
|
}
|
||||||
+1
-1
@@ -12,7 +12,7 @@ Is a [Iterable] with known `size`, a finite [Iterable]:
|
|||||||
(1)
|
(1)
|
||||||
: `comparator(a,b)` should return -1 if `a < b`, +1 if `a > b` or zero.
|
: `comparator(a,b)` should return -1 if `a < b`, +1 if `a > b` or zero.
|
||||||
|
|
||||||
See [List], [Set] and [Iterable]
|
See [List], [Set], [Iterable] and [Efficient Iterables in Kotlin Interop](EfficientIterables.md)
|
||||||
|
|
||||||
[Iterable]: Iterable.md
|
[Iterable]: Iterable.md
|
||||||
[List]: List.md
|
[List]: List.md
|
||||||
|
|||||||
@@ -0,0 +1,92 @@
|
|||||||
|
# Efficient Iterables in Kotlin Interop
|
||||||
|
|
||||||
|
Lyng provides high-performance iteration mechanisms that allow Kotlin-side code to interact with Lyng iterables efficiently and vice versa.
|
||||||
|
|
||||||
|
## 1. Enumerating Lyng Objects from Kotlin
|
||||||
|
|
||||||
|
To iterate over a Lyng object (like a `List`, `Set`, or `Range`) from Kotlin code, use the virtual `enumerate` method:
|
||||||
|
|
||||||
|
```kotlin
|
||||||
|
val lyngList: Obj = ...
|
||||||
|
lyngList.enumerate(scope) { item ->
|
||||||
|
println("Processing $item")
|
||||||
|
true // return true to continue, false to break
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Why it's efficient:
|
||||||
|
- **Zero allocation**: Unlike traditional iterators, it doesn't create a `LyngIterator` object or any intermediate wrappers.
|
||||||
|
- **Direct access**: Subclasses like `ObjList` override `enumerate` to iterate directly over their internal Kotlin collections.
|
||||||
|
- **Reduced overhead**: It avoids multiple `invokeInstanceMethod` calls for `hasNext()` and `next()` on every step, which would normally involve dynamic dispatch and scope overhead.
|
||||||
|
|
||||||
|
## 2. Reactive Enumeration with Flow
|
||||||
|
|
||||||
|
If you prefer a reactive approach or need to integrate with Kotlin Coroutines flows, use `toFlow()`:
|
||||||
|
|
||||||
|
```kotlin
|
||||||
|
lyngList.toFlow(scope).collect { item ->
|
||||||
|
// ...
|
||||||
|
}
|
||||||
|
```
|
||||||
|
*Note: `toFlow()` internally uses the Lyng iterator protocol (`iterator()`, `hasNext()`, `next()`), so it's slightly less efficient than `enumerate()` for performance-critical loops, but more idiomatic for flow-based processing.*
|
||||||
|
|
||||||
|
## 3. Creating Efficient Iterables for Lyng in Kotlin
|
||||||
|
|
||||||
|
When implementing a custom object in Kotlin that should be iterable in Lyng (e.g., usable in `for (x in myObj) { ... }`), follow these steps to ensure maximum performance.
|
||||||
|
|
||||||
|
### A. Inherit from `Obj` and use `ObjIterable`
|
||||||
|
Ensure your object's class has `ObjIterable` as a parent so the Lyng compiler recognizes it as an iterable.
|
||||||
|
|
||||||
|
```kotlin
|
||||||
|
class MyCollection(val items: List<Obj>) : Obj() {
|
||||||
|
override val objClass = MyCollection.type
|
||||||
|
|
||||||
|
companion object {
|
||||||
|
val type = ObjClass("MyCollection", ObjIterable).apply {
|
||||||
|
// Provide a Lyng-side iterator for compatibility with
|
||||||
|
// manual iterator usage in Lyng scripts.
|
||||||
|
// Using ObjKotlinObjIterator if items are already Obj instances:
|
||||||
|
addFn("iterator") {
|
||||||
|
ObjKotlinObjIterator(thisAs<MyCollection>().items.iterator())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### B. Override `enumerate` for Maximum Performance
|
||||||
|
The Lyng compiler's `for` loops use the `enumerate` method. By overriding it in your Kotlin class, you provide a "fast path" for iteration.
|
||||||
|
|
||||||
|
```kotlin
|
||||||
|
class MyCollection(val items: List<Obj>) : Obj() {
|
||||||
|
// ...
|
||||||
|
override suspend fun enumerate(scope: Scope, callback: suspend (Obj) -> Boolean) {
|
||||||
|
for (item in items) {
|
||||||
|
// If callback returns false, it means 'break' was called in Lyng
|
||||||
|
if (!callback(item)) break
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### C. Use `ObjInt.of()` for Numeric Data
|
||||||
|
If your iterable contains integers, always use `ObjInt.of(Long)` instead of the `ObjInt(Long)` constructor. Lyng maintains a cache for small integers (-128 to 127), which significantly reduces object allocations and GC pressure during tight loops.
|
||||||
|
|
||||||
|
```kotlin
|
||||||
|
// Efficiently creating an integer object
|
||||||
|
val obj = ObjInt.of(42L)
|
||||||
|
|
||||||
|
// Or using extension methods which also use the cache:
|
||||||
|
val obj2 = 42.toObj()
|
||||||
|
val obj3 = 42L.toObj()
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Note on `toObj()` extensions:
|
||||||
|
While `<reified T> T.toObj()` is convenient, using specific extensions like `Int.toObj()` or `Long.toObj()` is slightly more efficient as they use the `ObjInt` cache.
|
||||||
|
|
||||||
|
## 4. Summary of Best Practices
|
||||||
|
|
||||||
|
- **To Consume**: Use `enumerate(scope) { item -> ... true }`.
|
||||||
|
- **To Implement**: Override `enumerate` in your `Obj` subclass.
|
||||||
|
- **To Register**: Use `ObjIterable` (or `ObjCollection`) as a parent class in your `ObjClass` definition.
|
||||||
|
- **To Optimize**: Use `ObjInt.of()` (or `.toObj()`) for all integer object allocations.
|
||||||
+102
-22
@@ -40,13 +40,13 @@ available, for example
|
|||||||
## joinToString
|
## joinToString
|
||||||
|
|
||||||
This methods convert any iterable to a string joining string representation of each element, optionally transforming it
|
This methods convert any iterable to a string joining string representation of each element, optionally transforming it
|
||||||
and joining using specified suffix.
|
and joining using specified separator.
|
||||||
|
|
||||||
Iterable.joinToString(suffux=' ', transform=null)
|
Iterable.joinToString(separator=' ', transformer=null)
|
||||||
|
|
||||||
- if `Iterable` `isEmpty`, the empty string `""` is returned.
|
- if `Iterable` `isEmpty`, the empty string `""` is returned.
|
||||||
- `suffix` is inserted between items when there are more than one.
|
- `separator` is inserted between items when there are more than one.
|
||||||
- `transform` of specified is applied to each element, otherwise its `toString()` method is used.
|
- `transformer` of specified is applied to each element, otherwise its `toString()` method is used.
|
||||||
|
|
||||||
Here is the sample:
|
Here is the sample:
|
||||||
|
|
||||||
@@ -55,7 +55,7 @@ Here is the sample:
|
|||||||
assertEquals( (1..3).joinToString { it * 10 }, "10 20 30")
|
assertEquals( (1..3).joinToString { it * 10 }, "10 20 30")
|
||||||
>>> void
|
>>> void
|
||||||
|
|
||||||
## `sum` and `sumBy`
|
## `sum` and `sumOf`
|
||||||
|
|
||||||
These, again, does the thing:
|
These, again, does the thing:
|
||||||
|
|
||||||
@@ -68,6 +68,80 @@ These, again, does the thing:
|
|||||||
|
|
||||||
>>> void
|
>>> void
|
||||||
|
|
||||||
|
## map, filter and their variations
|
||||||
|
|
||||||
|
Used to transform or filter the whole iterable stream:
|
||||||
|
|
||||||
|
val source = [1,2,3,4]
|
||||||
|
|
||||||
|
// map: transform every element to something else
|
||||||
|
assertEquals(["n1", "n2", "n3", "n4"], source.map { "n"+it } )
|
||||||
|
|
||||||
|
// filter: keep only elements matching the predicate
|
||||||
|
assertEquals([2, 4], source.filter { it % 2 == 0 } )
|
||||||
|
|
||||||
|
// count: count elements matching the predicate
|
||||||
|
assertEquals(2, source.count { it % 2 == 0 } )
|
||||||
|
|
||||||
|
// mapNotNull: transform every element, skipping null results:
|
||||||
|
assertEquals(["n1", "n2", "n4"], source.mapNotNull { if( it == 3 ) null else "n"+it } )
|
||||||
|
|
||||||
|
// filterNotNull: skip all null elements:
|
||||||
|
assertEquals([1, 2, 4], [1, 2, null, 4].filterNotNull())
|
||||||
|
|
||||||
|
>>> void
|
||||||
|
|
||||||
|
You can also use flow variations that return a cold `Flow` instead of a `List`, which is useful for large or infinite sequences:
|
||||||
|
|
||||||
|
val source = [1, 2, 3, 4]
|
||||||
|
|
||||||
|
// filterFlow: returns a Flow of filtered elements
|
||||||
|
assert( source.filterFlow { it % 2 == 0 } is Flow )
|
||||||
|
|
||||||
|
// filterFlowNotNull: returns a Flow of non-null elements
|
||||||
|
assert( [1, null, 2].filterFlowNotNull() is Flow )
|
||||||
|
|
||||||
|
>>> void
|
||||||
|
|
||||||
|
## minOf and maxOf
|
||||||
|
|
||||||
|
Find the minimum or maximum value of a function applied to each element:
|
||||||
|
|
||||||
|
val source = ["abc", "de", "fghi"]
|
||||||
|
assertEquals(2, source.minOf { it.length })
|
||||||
|
assertEquals(4, source.maxOf { it.length })
|
||||||
|
>>> void
|
||||||
|
|
||||||
|
## flatten and flatMap
|
||||||
|
|
||||||
|
Work with nested collections:
|
||||||
|
|
||||||
|
val nested = [[1, 2], [3, 4]]
|
||||||
|
|
||||||
|
// flatten: combine nested collections into one list
|
||||||
|
assertEquals([1, 2, 3, 4], nested.flatten())
|
||||||
|
|
||||||
|
// flatMap: map each element to a collection and flatten the result
|
||||||
|
assertEquals([1, 10, 2, 20], [1, 2].flatMap { [it, it*10] })
|
||||||
|
|
||||||
|
>>> void
|
||||||
|
|
||||||
|
## findFirst and findFirstOrNull
|
||||||
|
|
||||||
|
Search for the first element that satisfies the given predicate:
|
||||||
|
|
||||||
|
val source = [1, 2, 3, 4]
|
||||||
|
assertEquals( 2, source.findFirst { it % 2 == 0 } )
|
||||||
|
assertEquals( 2, source.findFirstOrNull { it % 2 == 0 } )
|
||||||
|
|
||||||
|
// findFirst throws if not found:
|
||||||
|
assertThrows( NoSuchElementException ) { source.findFirst { it > 10 } }
|
||||||
|
|
||||||
|
// findFirstOrNull returns null if not found:
|
||||||
|
assertEquals( null, source.findFirstOrNull { it > 10 } )
|
||||||
|
|
||||||
|
>>> void
|
||||||
|
|
||||||
## Instance methods:
|
## Instance methods:
|
||||||
|
|
||||||
| fun/method | description |
|
| fun/method | description |
|
||||||
@@ -75,52 +149,56 @@ These, again, does the thing:
|
|||||||
| toList() | create a list from iterable |
|
| toList() | create a list from iterable |
|
||||||
| toSet() | create a set from iterable |
|
| toSet() | create a set from iterable |
|
||||||
| contains(i) | check that iterable contains `i` |
|
| contains(i) | check that iterable contains `i` |
|
||||||
| `i in iterator` | same as `contains(i)` |
|
| `i in iterable` | same as `contains(i)` |
|
||||||
| isEmpty() | check iterable is empty |
|
| isEmpty() | check iterable is empty |
|
||||||
| forEach(f) | call f for each element |
|
| forEach(f) | call f for each element |
|
||||||
| toMap() | create a map from list of key-value pairs (arrays of 2 items or like) |
|
| toMap() | create a map from list of key-value pairs (arrays of 2 items or like) |
|
||||||
|
| any(p) | true if any element matches predicate `p` |
|
||||||
|
| all(p) | true if all elements match predicate `p` |
|
||||||
| map(f) | create a list of values returned by `f` called for each element of the iterable |
|
| map(f) | create a list of values returned by `f` called for each element of the iterable |
|
||||||
| indexOf(i) | return index if the first encounter of i or a negative value if not found |
|
| indexOf(i) | return index if the first encounter of i or a negative value if not found |
|
||||||
| associateBy(kf) | create a map where keys are returned by kf that will be called for each element |
|
| associateBy(kf) | create a map where keys are returned by kf that will be called for each element |
|
||||||
|
| filter(p) | create a list of elements matching predicate `p` |
|
||||||
|
| count(p) | count elements matching predicate `p` |
|
||||||
|
| filterFlow(p) | create a [Flow] of elements matching predicate `p` |
|
||||||
|
| filterNotNull() | create a list of non-null elements |
|
||||||
|
| filterFlowNotNull() | create a [Flow] of non-null elements |
|
||||||
|
| minOf(f) | return minimum value of `f` applied to elements |
|
||||||
|
| maxOf(f) | return maximum value of `f` applied to elements |
|
||||||
|
| flatten() | flatten nested collections into a single [List] |
|
||||||
|
| flatMap(f) | map each element with `f` and flatten results into a [List] |
|
||||||
|
| findFirst(p) | return first element matching predicate `p` or throw (1) |
|
||||||
|
| findFirstOrNull(p) | return first element matching predicate `p` or `null` |
|
||||||
| first | first element (1) |
|
| first | first element (1) |
|
||||||
| last | last element (1) |
|
| last | last element (1) |
|
||||||
| take(n) | return [Iterable] of up to n first elements |
|
| take(n) | return [Iterable] of up to n first elements |
|
||||||
| taleLast(n) | return [Iterable] of up to n last elements |
|
| takeLast(n) | return [Iterable] of up to n last elements |
|
||||||
| drop(n) | return new [Iterable] without first n elements |
|
| drop(n) | return new [Iterable] without first n elements |
|
||||||
| dropLast(n) | return new [Iterable] without last n elements |
|
| dropLast(n) | return new [Iterable] without last n elements |
|
||||||
| sum() | return sum of the collection applying `+` to its elements (3) |
|
| sum() | return sum of the collection applying `+` to its elements (3) |
|
||||||
| sumOf(predicate) | sum of the modified collection items (3) |
|
| sumOf(f) | sum of the modified collection items (3) |
|
||||||
| sorted() | return [List] with collection items sorted naturally |
|
| sorted() | return [List] with collection items sorted naturally |
|
||||||
| sortedWith(comparator) | sort using a comparator that compares elements (1) |
|
| sortedWith(comparator) | sort using a comparator that compares elements (1) |
|
||||||
| sortedBy(predicate) | sort by comparing results of the predicate function |
|
| sortedBy(predicate) | sort by comparing results of the predicate function |
|
||||||
| joinToString(s,t) | convert iterable to string, see (2) |
|
| joinToString(s,t) | convert iterable to string, see (2) |
|
||||||
| reversed() | create a list containing items from this in reverse order |
|
| reversed() | create a list containing items from this in reverse order |
|
||||||
| shuffled() | create a listof shiffled elements |
|
| shuffled() | create a list of shuffled elements |
|
||||||
|
|
||||||
(1)
|
(1)
|
||||||
: throws `NoSuchElementException` if there is no such element
|
:: throws `NoSuchElementException` if there is no such element
|
||||||
|
|
||||||
(2)
|
(2)
|
||||||
: `joinToString(suffix=" ",transform=null)`: suffix is inserted between items if there are more than one, trasnfom is
|
:: `joinToString(separator=" ", transformer=null)`: separator is inserted between items if there are more than one, transformer is
|
||||||
optional function applied to each item that must return result string for an item, otherwise `item.toString()` is used.
|
optional function applied to each item that must return result string for an item, otherwise `item.toString()` is used.
|
||||||
|
|
||||||
(3)
|
(3)
|
||||||
: sum of empty collection is `null`
|
:: sum of empty collection is `null`
|
||||||
|
|
||||||
fun Iterable.toList(): List
|
|
||||||
fun Iterable.toSet(): Set
|
|
||||||
fun Iterable.indexOf(element): Int
|
|
||||||
fun Iterable.contains(element): Bool
|
|
||||||
fun Iterable.isEmpty(element): Bool
|
|
||||||
fun Iterable.forEach(block: (Any?)->Void ): Void
|
|
||||||
fun Iterable.map(block: (Any?)->Void ): List
|
|
||||||
fun Iterable.associateBy( keyMaker: (Any?)->Any): Map
|
|
||||||
|
|
||||||
## Abstract methods:
|
## Abstract methods:
|
||||||
|
|
||||||
fun iterator(): Iterator
|
fun iterator(): Iterator
|
||||||
|
|
||||||
Creates a list by iterating to the end. So, the Iterator should be finite to be used with it.
|
For high-performance Kotlin-side interop and custom iterable implementation details, see [Efficient Iterables in Kotlin Interop](EfficientIterables.md).
|
||||||
|
|
||||||
## Included in interfaces:
|
## Included in interfaces:
|
||||||
|
|
||||||
@@ -134,6 +212,8 @@ Creates a list by iterating to the end. So, the Iterator should be finite to be
|
|||||||
|
|
||||||
[List]: List.md
|
[List]: List.md
|
||||||
|
|
||||||
|
[Flow]: parallelism.md#flow
|
||||||
|
|
||||||
[Range]: Range.md
|
[Range]: Range.md
|
||||||
|
|
||||||
[Set]: Set.md
|
[Set]: Set.md
|
||||||
|
|||||||
@@ -23,6 +23,8 @@ must throw `ObjIterationFinishedError`.
|
|||||||
|
|
||||||
Iterators are returned when implementing [Iterable] interface.
|
Iterators are returned when implementing [Iterable] interface.
|
||||||
|
|
||||||
|
For high-performance Kotlin-side interop and custom iterable implementation details, see [Efficient Iterables in Kotlin Interop](EfficientIterables.md).
|
||||||
|
|
||||||
## Implemented for classes:
|
## Implemented for classes:
|
||||||
|
|
||||||
- [List], [Range]
|
- [List], [Range]
|
||||||
|
|||||||
+30
-1
@@ -92,6 +92,34 @@ Open end ranges remove head and tail elements:
|
|||||||
assert( [1, 2, 3] !== [1, 2, 3])
|
assert( [1, 2, 3] !== [1, 2, 3])
|
||||||
>>> void
|
>>> void
|
||||||
|
|
||||||
|
## Destructuring
|
||||||
|
|
||||||
|
Lists can be used as L-values for destructuring assignments. This allows you to unpack list elements into multiple variables.
|
||||||
|
|
||||||
|
### Basic Destructuring
|
||||||
|
```lyng
|
||||||
|
val [a, b, c] = [1, 2, 3]
|
||||||
|
```
|
||||||
|
|
||||||
|
### With Splats (Variadic)
|
||||||
|
A single ellipsis `...` can be used to capture remaining elements into a list. It can be placed at the beginning, middle, or end of the pattern.
|
||||||
|
```lyng
|
||||||
|
val [head, rest...] = [1, 2, 3] // head=1, rest=[2, 3]
|
||||||
|
val [first, middle..., last] = [1, 2, 3, 4, 5] // first=1, middle=[2, 3, 4], last=5
|
||||||
|
```
|
||||||
|
|
||||||
|
### Nested Patterns
|
||||||
|
Destructuring patterns can be nested to unpack multi-dimensional lists.
|
||||||
|
```lyng
|
||||||
|
val [a, [b, c...], d] = [1, [2, 3, 4], 5]
|
||||||
|
```
|
||||||
|
|
||||||
|
### Reassignment
|
||||||
|
Destructuring can also be used to reassign existing variables:
|
||||||
|
```lyng
|
||||||
|
[x, y] = [y, x] // Swap values
|
||||||
|
```
|
||||||
|
|
||||||
## In-place sort
|
## In-place sort
|
||||||
|
|
||||||
List could be sorted in place, just like [Collection] provide sorted copies, in a very like way:
|
List could be sorted in place, just like [Collection] provide sorted copies, in a very like way:
|
||||||
@@ -130,7 +158,8 @@ List could be sorted in place, just like [Collection] provide sorted copies, in
|
|||||||
| `sort()` | in-place sort, natural order | void |
|
| `sort()` | in-place sort, natural order | void |
|
||||||
| `sortBy(predicate)` | in-place sort bu `predicate` call result (3) | void |
|
| `sortBy(predicate)` | in-place sort bu `predicate` call result (3) | void |
|
||||||
| `sortWith(comparator)` | in-place sort using `comarator` function (4) | void |
|
| `sortWith(comparator)` | in-place sort using `comarator` function (4) | void |
|
||||||
| `shiffle()` | in-place shiffle contents | |
|
| `shuffle()` | in-place shuffle contents | |
|
||||||
|
| `toString()` | string representation like `[a,b,c]` | |
|
||||||
|
|
||||||
(1)
|
(1)
|
||||||
: optimized implementation that override `Array` one
|
: optimized implementation that override `Array` one
|
||||||
|
|||||||
+2
-2
@@ -172,7 +172,7 @@ Maps and entries can also be merged with `+` and `+=`:
|
|||||||
|
|
||||||
Notes:
|
Notes:
|
||||||
- Map literals always use string keys (identifier keys are converted to strings).
|
- Map literals always use string keys (identifier keys are converted to strings).
|
||||||
- Spreads inside map literals and `+`/`+=` merges require string keys on the right-hand side; this aligns with named-argument splats.
|
- Spreads inside map literals and `+`/`+=` merges allow any objects as keys.
|
||||||
- When you need computed or non-string keys, use the constructor form `Map(...)` or build entries with `=>` and then merge.
|
- When you need computed or non-string keys, use the constructor form `Map(...)`, map literals with computed keys (if supported), or build entries with `=>` and then merge.
|
||||||
|
|
||||||
[Collection](Collection.md)
|
[Collection](Collection.md)
|
||||||
+553
-18
@@ -1,6 +1,10 @@
|
|||||||
# OO implementation in Lyng
|
# Object-oriented programming
|
||||||
|
|
||||||
## Declaration
|
[//]: # (topMenu)
|
||||||
|
|
||||||
|
Lyng supports first class OOP constructs, based on classes with multiple inheritance.
|
||||||
|
|
||||||
|
## Class Declaration
|
||||||
|
|
||||||
The class clause looks like
|
The class clause looks like
|
||||||
|
|
||||||
@@ -38,6 +42,176 @@ a _constructor_ that requires two parameters for fields. So when creating it wit
|
|||||||
Form now on `Point` is a class, it's type is `Class`, and we can create instances with it as in the
|
Form now on `Point` is a class, it's type is `Class`, and we can create instances with it as in the
|
||||||
example above.
|
example above.
|
||||||
|
|
||||||
|
## Singleton Objects
|
||||||
|
|
||||||
|
Singleton objects are declared using the `object` keyword. An `object` declaration defines both a class and a single instance of that class at the same time. This is perfect for stateless utilities, global configuration, or shared delegates.
|
||||||
|
|
||||||
|
```lyng
|
||||||
|
object Config {
|
||||||
|
val version = "1.0.0"
|
||||||
|
val debug = true
|
||||||
|
|
||||||
|
fun printInfo() {
|
||||||
|
println("App version: " + version)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Usage:
|
||||||
|
println(Config.version)
|
||||||
|
Config.printInfo()
|
||||||
|
```
|
||||||
|
|
||||||
|
Objects can also inherit from classes or interfaces:
|
||||||
|
|
||||||
|
```lyng
|
||||||
|
object DefaultLogger : Logger("Default") {
|
||||||
|
override fun log(msg) {
|
||||||
|
println("[DEFAULT] " + msg)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
Properties allow you to define member accessors that look like fields but execute code when read or written. Unlike regular fields, properties in Lyng do **not** have automatic backing fields; they are pure accessors.
|
||||||
|
|
||||||
|
### Basic Syntax
|
||||||
|
|
||||||
|
Properties are declared using `val` (read-only) or `var` (read-write) followed by a name and `get()`/`set()` blocks:
|
||||||
|
|
||||||
|
```lyng
|
||||||
|
class Person(private var _age: Int) {
|
||||||
|
// Read-only property
|
||||||
|
val ageCategory
|
||||||
|
get() {
|
||||||
|
if (_age < 18) "Minor" else "Adult"
|
||||||
|
}
|
||||||
|
|
||||||
|
// Read-write property
|
||||||
|
var age: Int
|
||||||
|
get() { _age }
|
||||||
|
set(value) {
|
||||||
|
if (value >= 0) _age = value
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
val p = Person(15)
|
||||||
|
assertEquals("Minor", p.ageCategory)
|
||||||
|
p.age = 20
|
||||||
|
assertEquals("Adult", p.ageCategory)
|
||||||
|
```
|
||||||
|
|
||||||
|
### Laconic Expression Shorthand
|
||||||
|
|
||||||
|
For simple accessors and methods, you can use the `=` shorthand for a more elegant and laconic form:
|
||||||
|
|
||||||
|
```lyng
|
||||||
|
class Circle(val radius: Real) {
|
||||||
|
val area get() = π * radius * radius
|
||||||
|
val circumference get() = 2 * π * radius
|
||||||
|
|
||||||
|
fun diameter() = radius * 2
|
||||||
|
}
|
||||||
|
|
||||||
|
fun median(a, b) = (a + b) / 2
|
||||||
|
|
||||||
|
class Counter {
|
||||||
|
private var _count = 0
|
||||||
|
var count get() = _count set(v) = _count = v
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Key Rules
|
||||||
|
|
||||||
|
- **`val` properties** must have a `get()` accessor and cannot have a `set()`.
|
||||||
|
- **`var` properties** must have both `get()` and `set()` accessors.
|
||||||
|
- **Functions and methods** can use the `=` shorthand to return the result of a single expression.
|
||||||
|
- **No Backing Fields**: There is no magic `field` identifier. If you need to store state, you must declare a separate (usually `private`) field.
|
||||||
|
- **Type Inference**: You can omit the type declaration if it can be inferred or if you don't need strict typing.
|
||||||
|
|
||||||
|
### Lazy Properties with `cached`
|
||||||
|
|
||||||
|
When you want to define a property that is computed only once (on demand) and then remembered, use the built-in `cached` function. This is more efficient than a regular property with `get()` if the computation is expensive, as it avoids re-calculating the value on every access.
|
||||||
|
|
||||||
|
```lyng
|
||||||
|
class DataService(val id: Int) {
|
||||||
|
// The lambda passed to cached is only executed once, the first time data() is called.
|
||||||
|
val data = cached {
|
||||||
|
println("Fetching data for " + id)
|
||||||
|
// Perform expensive operation
|
||||||
|
"Record " + id
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
val service = DataService(42)
|
||||||
|
// No printing yet
|
||||||
|
println(service.data()) // Prints "Fetching data for 42", then returns "Record 42"
|
||||||
|
println(service.data()) // Returns "Record 42" immediately (no second fetch)
|
||||||
|
```
|
||||||
|
|
||||||
|
Note that `cached` returns a lambda, so you access the value by calling it like a method: `service.data()`. This is a powerful pattern for lazy-loading resources, caching results of database queries, or delaying expensive computations until they are truly needed.
|
||||||
|
|
||||||
|
## Delegation
|
||||||
|
|
||||||
|
Delegation allows you to hand over the logic of a property or function to another object. This is done using the `by` keyword.
|
||||||
|
|
||||||
|
### Property Delegation
|
||||||
|
|
||||||
|
Instead of providing `get()` and `set()` accessors, you can delegate them to an object that implements the `getValue` and `setValue` methods.
|
||||||
|
|
||||||
|
```lyng
|
||||||
|
class User {
|
||||||
|
var name by MyDelegate()
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Function Delegation
|
||||||
|
|
||||||
|
You can also delegate a whole function to an object. When the function is called, it will invoke the delegate's `invoke` method.
|
||||||
|
|
||||||
|
```lyng
|
||||||
|
fun remoteAction by RemoteProxy("actionName")
|
||||||
|
```
|
||||||
|
|
||||||
|
### The Unified Delegate Interface
|
||||||
|
|
||||||
|
A delegate is any object that provides the following methods (all optional depending on usage):
|
||||||
|
|
||||||
|
- `getValue(thisRef, name)`: Called when a delegated `val` or `var` is read.
|
||||||
|
- `setValue(thisRef, name, newValue)`: Called when a delegated `var` is written.
|
||||||
|
- `invoke(thisRef, name, args...)`: Called when a delegated `fun` is invoked.
|
||||||
|
- `bind(name, access, thisRef)`: Called once during initialization to configure or validate the delegate.
|
||||||
|
|
||||||
|
For more details and advanced patterns (like `lazy`, `observable`, and shared stateless delegates), see the [Delegation Guide](delegation.md).
|
||||||
|
|
||||||
|
## Instance initialization: init block
|
||||||
|
|
||||||
|
In addition to the primary constructor arguments, you can provide an `init` block that runs on each instance creation. This is useful for more complex initializations, side effects, or setting up fields that depend on multiple constructor parameters.
|
||||||
|
|
||||||
|
class Point(val x, val y) {
|
||||||
|
var magnitude
|
||||||
|
|
||||||
|
init {
|
||||||
|
magnitude = Math.sqrt(x*x + y*y)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
Key features of `init` blocks:
|
||||||
|
- **Scope**: They have full access to `this` members and all primary constructor parameters.
|
||||||
|
- **Order**: In a single-inheritance scenario, `init` blocks run immediately after the instance fields are prepared but before the primary constructor body logic.
|
||||||
|
- **Multiple blocks**: You can have multiple `init` blocks; they will be executed in the order they appear in the class body.
|
||||||
|
|
||||||
|
### Initialization in Multiple Inheritance
|
||||||
|
|
||||||
|
In cases of multiple inheritance, `init` blocks are executed following the constructor chaining rule:
|
||||||
|
1. All ancestors are initialized first, following the inheritance hierarchy (diamond-safe: each ancestor is initialized exactly once).
|
||||||
|
2. The `init` blocks of each class are executed after its parents have been fully initialized.
|
||||||
|
3. For a hierarchy `class D : B, C`, the initialization order is: `B`'s chain, then `C`'s chain (skipping common ancestors with `B`), and finally `D`'s own `init` blocks.
|
||||||
|
|
||||||
|
### Initialization during Deserialization
|
||||||
|
|
||||||
|
When an object is restored from a serialized form (e.g., using `Lynon`), `init` blocks are **re-executed**. This ensures that transient state or derived fields are correctly recalculated upon restoration. However, primary constructors are **not** re-called during deserialization; only the `init` blocks and field initializers are executed to restore the instance state.
|
||||||
|
|
||||||
Class point has a _method_, or a _member function_ `length()` that uses its _fields_ `x` and `y` to
|
Class point has a _method_, or a _member function_ `length()` that uses its _fields_ `x` and `y` to
|
||||||
calculate the magnitude. Length is called
|
calculate the magnitude. Length is called
|
||||||
|
|
||||||
@@ -49,8 +223,58 @@ statements discussed later, there could be default values, ellipsis, etc.
|
|||||||
class Point(x=0,y=0)
|
class Point(x=0,y=0)
|
||||||
val p = Point()
|
val p = Point()
|
||||||
assert( p.x == 0 && p.y == 0 )
|
assert( p.x == 0 && p.y == 0 )
|
||||||
|
|
||||||
|
// Named arguments in constructor calls use colon syntax:
|
||||||
|
val p2 = Point(y: 10, x: 5)
|
||||||
|
assert( p2.x == 5 && p2.y == 10 )
|
||||||
|
|
||||||
|
// Auto-substitution shorthand for named arguments:
|
||||||
|
val x = 1
|
||||||
|
val y = 2
|
||||||
|
val p3 = Point(x:, y:)
|
||||||
|
assert( p3.x == 1 && p3.y == 2 )
|
||||||
>>> void
|
>>> void
|
||||||
|
|
||||||
|
Note that unlike **Kotlin**, which uses `=` for named arguments, Lyng uses `:` to avoid ambiguity with assignment expressions.
|
||||||
|
|
||||||
|
### Late-initialized `val` fields
|
||||||
|
|
||||||
|
You can declare a `val` field without an immediate initializer if you provide an assignment for it within an `init` block or the class body. This is useful when the initial value depends on logic that cannot be expressed in a single expression.
|
||||||
|
|
||||||
|
```lyng
|
||||||
|
class DataProcessor(data: Object) {
|
||||||
|
val result: Object
|
||||||
|
|
||||||
|
init {
|
||||||
|
// Complex initialization logic
|
||||||
|
result = transform(data)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
Key rules for late-init `val`:
|
||||||
|
- **Compile-time Check**: The compiler ensures that every `val` declared without an initializer in a class body has at least one assignment within that class body (including `init` blocks). Failing to do so results in a syntax error.
|
||||||
|
- **Write-Once**: A `val` can only be assigned once. Even if it was declared without an initializer, once it is assigned a value (e.g., in `init`), any subsequent assignment will throw an `IllegalAssignmentException`.
|
||||||
|
- **Access before Initialization**: If you attempt to read a late-init `val` before it has been assigned (for example, by calling a method in `init` that reads the field before its assignment), it will hold a special `Unset` value. Using `Unset` for most operations (like arithmetic or method calls) will throw an `UnsetException`.
|
||||||
|
- **No Extensions**: Extension properties do not support late initialization as they do not have per-instance storage. Extension `val`s must always have an initializer or a `get()` accessor.
|
||||||
|
|
||||||
|
### The `Unset` singleton
|
||||||
|
|
||||||
|
The `Unset` singleton represents a field that has been declared but not yet initialized. While it can be compared and converted to a string, most other operations on it are forbidden to prevent accidental use of uninitialized data.
|
||||||
|
|
||||||
|
```lyng
|
||||||
|
class T {
|
||||||
|
val x
|
||||||
|
fun check() {
|
||||||
|
if (x == Unset) println("Not ready")
|
||||||
|
}
|
||||||
|
init {
|
||||||
|
check() // Prints "Not ready"
|
||||||
|
x = 42
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
## Methods
|
## Methods
|
||||||
|
|
||||||
Functions defined inside a class body are methods, and unless declared
|
Functions defined inside a class body are methods, and unless declared
|
||||||
@@ -75,7 +299,7 @@ Functions defined inside a class body are methods, and unless declared
|
|||||||
|
|
||||||
Lyng supports declaring a class with multiple direct base classes. The syntax is:
|
Lyng supports declaring a class with multiple direct base classes. The syntax is:
|
||||||
|
|
||||||
```
|
```lyng
|
||||||
class Foo(val a) {
|
class Foo(val a) {
|
||||||
var tag = "F"
|
var tag = "F"
|
||||||
fun runA() { "ResultA:" + a }
|
fun runA() { "ResultA:" + a }
|
||||||
@@ -124,16 +348,16 @@ Key rules and features:
|
|||||||
|
|
||||||
- Syntax
|
- Syntax
|
||||||
- `class Derived(args) : Base1(b1Args), Base2(b2Args)`
|
- `class Derived(args) : Base1(b1Args), Base2(b2Args)`
|
||||||
- Each direct base may receive constructor arguments specified in the header. Only direct bases receive header args; indirect bases must either be default‑constructible or receive their args through their direct child (future extensions may add more control).
|
- Each direct base may receive constructor arguments specified in the header. Only direct bases receive header args; indirect bases must either be default‑constructible or receive their args through their direct child.
|
||||||
|
|
||||||
- Resolution order (C3 MRO — active)
|
- Resolution order (C3 MRO)
|
||||||
- Member lookup is deterministic and follows C3 linearization (Python‑like), which provides a monotonic, predictable order for complex hierarchies and diamonds.
|
- Member lookup is deterministic and follows C3 linearization (Python‑like), which provides a monotonic, predictable order for complex hierarchies and diamonds.
|
||||||
- Intuition: for `class D() : B(), C()` where `B()` and `C()` both derive from `A()`, the C3 order is `D → B → C → A`.
|
- Intuition: for `class D() : B(), C()` where `B()` and `C()` both derive from `A()`, the C3 order is `D → B → C → A`.
|
||||||
- The first visible match along this order wins.
|
- The first visible match along this order wins.
|
||||||
|
|
||||||
- Qualified dispatch
|
- Qualified dispatch
|
||||||
- Inside a class body, use `this@Type.member(...)` to start lookup at the specified ancestor.
|
- Inside a class body, use `this@Type.member(...)` to start lookup at the specified ancestor.
|
||||||
- For arbitrary receivers, use casts: `(expr as Type).member(...)` or `(expr as? Type)?.member(...)` (safe‑call `?.` is already available in Lyng).
|
- For arbitrary receivers, use casts: `(expr as Type).member(...)` or `(expr as? Type)?.member(...)`.
|
||||||
- Qualified access does not relax visibility.
|
- Qualified access does not relax visibility.
|
||||||
|
|
||||||
- Field inheritance (`val`/`var`) and collisions
|
- Field inheritance (`val`/`var`) and collisions
|
||||||
@@ -150,10 +374,120 @@ Key rules and features:
|
|||||||
- `private`: accessible only inside the declaring class body; not visible in subclasses and cannot be accessed via `this@Type` or casts.
|
- `private`: accessible only inside the declaring class body; not visible in subclasses and cannot be accessed via `this@Type` or casts.
|
||||||
- `protected`: accessible in the declaring class and in any of its transitive subclasses (including MI), but not from unrelated contexts; qualification/casts do not bypass it.
|
- `protected`: accessible in the declaring class and in any of its transitive subclasses (including MI), but not from unrelated contexts; qualification/casts do not bypass it.
|
||||||
|
|
||||||
- Diagnostics
|
## Abstract Classes and Members
|
||||||
- When a member/field is not found, error messages include the receiver class name and the considered linearization order, with suggestions to disambiguate using `this@Type` or casts if appropriate.
|
|
||||||
- Qualifying with a non‑ancestor in `this@Type` reports a clear error mentioning the receiver lineage.
|
An `abstract` class is a class that cannot be instantiated and is intended to be inherited by other classes. It can contain `abstract` members that have no implementation and must be implemented by concrete subclasses.
|
||||||
- `as`/`as?` cast errors mention the actual and target types.
|
|
||||||
|
### Abstract Classes
|
||||||
|
|
||||||
|
To declare an abstract class, use the `abstract` modifier:
|
||||||
|
|
||||||
|
```lyng
|
||||||
|
abstract class Shape {
|
||||||
|
abstract fun area(): Real
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
Abstract classes can have constructors, fields, and concrete methods, just like regular classes.
|
||||||
|
|
||||||
|
### Abstract Members
|
||||||
|
|
||||||
|
Methods and variables (`val`/`var`) can be marked as `abstract`. Abstract members must not have a body or initializer.
|
||||||
|
|
||||||
|
```lyng
|
||||||
|
abstract class Base {
|
||||||
|
abstract fun foo(): Int
|
||||||
|
abstract var bar: String
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
- **Safety**: `abstract` members cannot be `private`, as they must be visible to subclasses for implementation.
|
||||||
|
- **Contract of Capability**: An `abstract val/var` represents a requirement for a capability. It can be implemented by either a **field** (storage) or a **property** (logic) in a subclass.
|
||||||
|
|
||||||
|
## Interfaces
|
||||||
|
|
||||||
|
An `interface` in Lyng is a synonym for an `abstract class`. Following the principle that Lyng's Multiple Inheritance system is powerful enough to handle stateful contracts, interfaces support everything classes do, including constructors, fields, and `init` blocks.
|
||||||
|
|
||||||
|
```lyng
|
||||||
|
interface Named(val name: String) {
|
||||||
|
fun greet() { "Hello, " + name }
|
||||||
|
}
|
||||||
|
|
||||||
|
class Person(name) : Named(name)
|
||||||
|
```
|
||||||
|
|
||||||
|
Using `interface` instead of `abstract class` is a matter of semantic intent, signaling that the class is primarily intended to be used as a contract in MI.
|
||||||
|
|
||||||
|
### Implementation by Parts
|
||||||
|
|
||||||
|
One of the most powerful benefits of Lyng's Multiple Inheritance and C3 MRO is the ability to satisfy an interface's requirements "by parts" from different parent classes. Since an `interface` can have state and requirements, a subclass can inherit these requirements and satisfy them using members inherited from other parents in the MRO chain.
|
||||||
|
|
||||||
|
Example:
|
||||||
|
|
||||||
|
```lyng
|
||||||
|
// Interface with state (id) and abstract requirements
|
||||||
|
interface Character(val id) {
|
||||||
|
var health
|
||||||
|
var mana
|
||||||
|
|
||||||
|
fun isAlive() = health > 0
|
||||||
|
fun status() = name + " (#" + id + "): " + health + " HP, " + mana + " MP"
|
||||||
|
}
|
||||||
|
|
||||||
|
// Parent class 1: provides health
|
||||||
|
class HealthPool(var health)
|
||||||
|
|
||||||
|
// Parent class 2: provides mana and name
|
||||||
|
class ManaPool(var mana) {
|
||||||
|
val name = "Hero"
|
||||||
|
}
|
||||||
|
|
||||||
|
// Composite class: implements Character by combining HealthPool and ManaPool
|
||||||
|
class Warrior(id, h, m) : HealthPool(h), ManaPool(m), Character(id)
|
||||||
|
|
||||||
|
val w = Warrior(1, 100, 50)
|
||||||
|
assertEquals("Hero (#1): 100 HP, 50 MP", w.status())
|
||||||
|
```
|
||||||
|
|
||||||
|
In this example, `Warrior` inherits from `HealthPool`, `ManaPool`, and `Character`. The abstract requirements `health` and `mana` from `Character` are automatically satisfied by the matching members inherited from `HealthPool` and `ManaPool`. The `status()` method also successfully finds the `name` field from `ManaPool`. This pattern allows for highly modular and reusable "trait-like" classes that can be combined to fulfill complex contracts without boilerplate proxy methods.
|
||||||
|
|
||||||
|
## Overriding and Virtual Dispatch
|
||||||
|
|
||||||
|
When a class defines a member that already exists in one of its parents, it is called **overriding**.
|
||||||
|
|
||||||
|
### The `override` Keyword
|
||||||
|
|
||||||
|
In Lyng, the `override` keyword is **mandatory when declaring a member** that exists in the ancestor chain (MRO).
|
||||||
|
|
||||||
|
```lyng
|
||||||
|
class Parent {
|
||||||
|
fun foo() = 1
|
||||||
|
}
|
||||||
|
|
||||||
|
class Child : Parent() {
|
||||||
|
override fun foo() = 2 // Mandatory override keyword
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
- **Implicit Satisfaction**: If a class inherits an abstract requirement and a matching implementation from different parents, the requirement is satisfied automatically without needing an explicit `override` proxy.
|
||||||
|
- **No Accidental Overrides**: If you define a member that happens to match a parent's member but you didn't use `override`, the compiler will throw an error. This prevents the "Fragile Base Class" problem.
|
||||||
|
- **Private Members**: Private members in parent classes are NOT part of the virtual interface and cannot be overridden. Defining a member with the same name in a subclass is allowed without `override` and is treated as a new, independent member.
|
||||||
|
|
||||||
|
### Visibility Widening
|
||||||
|
|
||||||
|
A subclass can increase the visibility of an overridden member (e.g., `protected` → `public`), but it is strictly forbidden from narrowing it (e.g., `public` → `protected`).
|
||||||
|
|
||||||
|
### The `closed` Modifier
|
||||||
|
|
||||||
|
To prevent a member from being overridden in subclasses, use the `closed` modifier (equivalent to `final` in other languages).
|
||||||
|
|
||||||
|
```lyng
|
||||||
|
class Critical {
|
||||||
|
closed fun secureStep() { ... }
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
Attempting to override a `closed` member results in a compile-time error.
|
||||||
|
|
||||||
Compatibility notes:
|
Compatibility notes:
|
||||||
|
|
||||||
@@ -164,6 +498,80 @@ Compatibility notes:
|
|||||||
|
|
||||||
Earlier drafts and docs described a declaration‑order depth‑first linearization. Lyng now uses C3 MRO for member lookup and disambiguation. Most code should continue to work unchanged, but in rare edge cases involving diamonds or complex multiple inheritance, the chosen base for an ambiguous member may change to reflect C3. If needed, disambiguate explicitly using `this@Type.member(...)` inside class bodies or casts `(expr as Type).member(...)` from outside.
|
Earlier drafts and docs described a declaration‑order depth‑first linearization. Lyng now uses C3 MRO for member lookup and disambiguation. Most code should continue to work unchanged, but in rare edge cases involving diamonds or complex multiple inheritance, the chosen base for an ambiguous member may change to reflect C3. If needed, disambiguate explicitly using `this@Type.member(...)` inside class bodies or casts `(expr as Type).member(...)` from outside.
|
||||||
|
|
||||||
|
## Enums
|
||||||
|
|
||||||
|
Lyng provides lightweight enums for representing a fixed set of named constants. Enums are classes whose instances are predefined and singletons.
|
||||||
|
|
||||||
|
Current syntax supports simple enum declarations with just entry names:
|
||||||
|
|
||||||
|
enum Color {
|
||||||
|
RED, GREEN, BLUE
|
||||||
|
}
|
||||||
|
|
||||||
|
Usage:
|
||||||
|
|
||||||
|
- Type of entries: every entry is an instance of its enum type.
|
||||||
|
|
||||||
|
assert( Color.RED is Color )
|
||||||
|
|
||||||
|
- Order and names: each entry has zero‑based `ordinal` and string `name`.
|
||||||
|
|
||||||
|
assertEquals(0, Color.RED.ordinal)
|
||||||
|
assertEquals("BLUE", Color.BLUE.name)
|
||||||
|
|
||||||
|
- All entries as a list in declaration order: `EnumType.entries`.
|
||||||
|
|
||||||
|
assertEquals([Color.RED, Color.GREEN, Color.BLUE], Color.entries)
|
||||||
|
|
||||||
|
- Lookup by name: `EnumType.valueOf("NAME")` → entry.
|
||||||
|
|
||||||
|
assertEquals(Color.GREEN, Color.valueOf("GREEN"))
|
||||||
|
|
||||||
|
- Equality and comparison:
|
||||||
|
- Equality uses identity of entries, e.g., `Color.RED == Color.valueOf("RED")`.
|
||||||
|
- Cross‑enum comparisons are not allowed.
|
||||||
|
- Ordering comparisons use `ordinal`.
|
||||||
|
|
||||||
|
assert( Color.RED == Color.valueOf("RED") )
|
||||||
|
assert( Color.RED.ordinal < Color.BLUE.ordinal )
|
||||||
|
>>> void
|
||||||
|
|
||||||
|
### Enums with `when`
|
||||||
|
|
||||||
|
Use `when(subject)` with equality branches for enums. See full `when` guide: [The `when` statement](when.md).
|
||||||
|
|
||||||
|
enum Color { RED, GREEN, BLUE }
|
||||||
|
|
||||||
|
fun describe(c) {
|
||||||
|
when(c) {
|
||||||
|
Color.RED, Color.GREEN -> "primary-like"
|
||||||
|
Color.BLUE -> "blue"
|
||||||
|
else -> "unknown" // if you pass something that is not a Color
|
||||||
|
}
|
||||||
|
}
|
||||||
|
assertEquals("primary-like", describe(Color.RED))
|
||||||
|
assertEquals("blue", describe(Color.BLUE))
|
||||||
|
>>> void
|
||||||
|
|
||||||
|
### Serialization
|
||||||
|
|
||||||
|
Enums are serialized compactly with Lynon: the encoded value stores just the entry ordinal within the enum type, which is both space‑efficient and fast.
|
||||||
|
|
||||||
|
import lyng.serialization
|
||||||
|
|
||||||
|
enum Color { RED, GREEN, BLUE }
|
||||||
|
|
||||||
|
val e = Lynon.encode(Color.BLUE)
|
||||||
|
val decoded = Lynon.decode(e)
|
||||||
|
assertEquals(Color.BLUE, decoded)
|
||||||
|
>>> void
|
||||||
|
|
||||||
|
Notes and limitations (current version):
|
||||||
|
|
||||||
|
- Enum declarations support only simple entry lists: no per‑entry bodies, no custom constructors, and no user‑defined methods/fields on the enum itself yet.
|
||||||
|
- `name` and `ordinal` are read‑only properties of an entry.
|
||||||
|
- `entries` is a read‑only list owned by the enum type.
|
||||||
|
|
||||||
## fields and visibility
|
## fields and visibility
|
||||||
|
|
||||||
It is possible to add non-constructor fields:
|
It is possible to add non-constructor fields:
|
||||||
@@ -196,6 +604,69 @@ Are declared with var
|
|||||||
assert( p.isSpecial == true )
|
assert( p.isSpecial == true )
|
||||||
>>> void
|
>>> void
|
||||||
|
|
||||||
|
### Restricted Setter Visibility
|
||||||
|
|
||||||
|
You can restrict the visibility of a `var` field's or property's setter by using `private set` or `protected set` modifiers. This allows the member to be publicly readable but only writable from within the class or its subclasses.
|
||||||
|
|
||||||
|
#### On Fields
|
||||||
|
|
||||||
|
```lyng
|
||||||
|
class SecretCounter {
|
||||||
|
var count = 0
|
||||||
|
private set // Can be read anywhere, but written only in SecretCounter
|
||||||
|
|
||||||
|
fun increment() { count++ }
|
||||||
|
}
|
||||||
|
|
||||||
|
val c = SecretCounter()
|
||||||
|
println(c.count) // OK
|
||||||
|
c.count = 10 // Throws IllegalAccessException
|
||||||
|
c.increment() // OK
|
||||||
|
```
|
||||||
|
|
||||||
|
#### On Properties
|
||||||
|
|
||||||
|
You can also apply restricted visibility to custom property setters:
|
||||||
|
|
||||||
|
```lyng
|
||||||
|
class Person(private var _age: Int) {
|
||||||
|
var age
|
||||||
|
get() = _age
|
||||||
|
private set(v) { if (v >= 0) _age = v }
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Protected Setters and Inheritance
|
||||||
|
|
||||||
|
A `protected set` allows subclasses to modify a field that is otherwise read-only to the public:
|
||||||
|
|
||||||
|
```lyng
|
||||||
|
class Base {
|
||||||
|
var state = "initial"
|
||||||
|
protected set
|
||||||
|
}
|
||||||
|
|
||||||
|
class Derived : Base() {
|
||||||
|
fun changeState(newVal) {
|
||||||
|
state = newVal // OK: protected access from subclass
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
val d = Derived()
|
||||||
|
println(d.state) // OK: "initial"
|
||||||
|
d.changeState("updated")
|
||||||
|
println(d.state) // OK: "updated"
|
||||||
|
d.state = "bad" // Throws IllegalAccessException: public write not allowed
|
||||||
|
```
|
||||||
|
|
||||||
|
### Key Rules and Limitations
|
||||||
|
|
||||||
|
- **Only for `var`**: Restricted setter visibility cannot be used with `val` declarations, as they are inherently read-only. Attempting to use it with `val` results in a syntax error.
|
||||||
|
- **Class Body Only**: These modifiers can only be used on members declared within the class body. They are not supported for primary constructor parameters.
|
||||||
|
- **`private set`**: The setter is only accessible within the same class context (specifically, when `this` is an instance of that class).
|
||||||
|
- **`protected set`**: The setter is accessible within the declaring class and all its transitive subclasses.
|
||||||
|
- **Multiple Inheritance**: In MI scenarios, visibility is checked against the class that actually declared the member. Qualified access (e.g., `this@Base.field = value`) also respects restricted setter visibility.
|
||||||
|
|
||||||
### Private fields
|
### Private fields
|
||||||
|
|
||||||
Private fields are visible only _inside the class instance_:
|
Private fields are visible only _inside the class instance_:
|
||||||
@@ -315,9 +786,11 @@ As usual, private statics are not accessible from the outside:
|
|||||||
|
|
||||||
# Extending classes
|
# Extending classes
|
||||||
|
|
||||||
It sometimes happen that the class is missing some particular functionality that can be _added to it_ without rewriting its inner logic and using its private state. In this case _extension methods_ could be used, for example. we want to create an extension method
|
It sometimes happen that the class is missing some particular functionality that can be _added to it_ without rewriting its inner logic and using its private state. In this case _extension members_ could be used.
|
||||||
that would test if some object of unknown type contains something that can be interpreted
|
|
||||||
as an integer. In this case we _extend_ class `Object`, as it is the parent class for any instance of any type:
|
## Extension methods
|
||||||
|
|
||||||
|
For example, we want to create an extension method that would test if some object of unknown type contains something that can be interpreted as an integer. In this case we _extend_ class `Object`, as it is the parent class for any instance of any type:
|
||||||
|
|
||||||
fun Object.isInteger() {
|
fun Object.isInteger() {
|
||||||
when(this) {
|
when(this) {
|
||||||
@@ -342,10 +815,67 @@ as an integer. In this case we _extend_ class `Object`, as it is the parent clas
|
|||||||
assert( ! "5.2".isInteger() )
|
assert( ! "5.2".isInteger() )
|
||||||
>>> void
|
>>> void
|
||||||
|
|
||||||
__Important note__ as for version 0.6.9, extensions are in __global scope__. It means, that once applied to a global type (Int in our sample), they will be available for _all_ contexts, even new created,
|
## Extension properties
|
||||||
as they are modifying the type, not the context.
|
|
||||||
|
|
||||||
Beware of it. We might need to reconsider it later.
|
Just like methods, you can extend existing classes with properties. These can be defined using simple initialization (for `val` only) or with custom accessors.
|
||||||
|
|
||||||
|
### Simple val extension
|
||||||
|
|
||||||
|
A read-only extension can be defined by assigning an expression:
|
||||||
|
|
||||||
|
```lyng
|
||||||
|
val String.isLong = length > 10
|
||||||
|
|
||||||
|
val s = "Hello, world!"
|
||||||
|
assert(s.isLong)
|
||||||
|
```
|
||||||
|
|
||||||
|
### Properties with accessors
|
||||||
|
|
||||||
|
For more complex logic, use `get()` and `set()` blocks:
|
||||||
|
|
||||||
|
```lyng
|
||||||
|
class Box(var value: Int)
|
||||||
|
|
||||||
|
var Box.doubledValue
|
||||||
|
get() = value * 2
|
||||||
|
set(v) = value = v / 2
|
||||||
|
|
||||||
|
val b = Box(10)
|
||||||
|
assertEquals(20, b.doubledValue)
|
||||||
|
b.doubledValue = 30
|
||||||
|
assertEquals(15, b.value)
|
||||||
|
```
|
||||||
|
|
||||||
|
Extension members are strictly barred from accessing private members of the class they extend, maintaining encapsulation.
|
||||||
|
|
||||||
|
### Extension Scoping and Isolation
|
||||||
|
|
||||||
|
Extensions in Lyng are **scope-isolated**. This means an extension is only visible within the scope where it is defined and its child scopes. This reduces the "attack surface" and prevents extensions from polluting the global space or other modules.
|
||||||
|
|
||||||
|
#### Scope Isolation Example
|
||||||
|
|
||||||
|
You can define different extensions with the same name in different scopes:
|
||||||
|
|
||||||
|
```lyng
|
||||||
|
fun scopeA() {
|
||||||
|
val Int.description = "Number: " + toString()
|
||||||
|
assertEquals("Number: 42", 42.description)
|
||||||
|
}
|
||||||
|
|
||||||
|
fun scopeB() {
|
||||||
|
val Int.description = "Value: " + toString()
|
||||||
|
assertEquals("Value: 42", 42.description)
|
||||||
|
}
|
||||||
|
|
||||||
|
scopeA()
|
||||||
|
scopeB()
|
||||||
|
|
||||||
|
// Outside those scopes, Int.description is not defined
|
||||||
|
assertThrows { 42.description }
|
||||||
|
```
|
||||||
|
|
||||||
|
This isolation ensures that libraries can use extensions internally without worrying about name collisions with other libraries or the user's code. When a module is imported using `use`, its top-level extensions become available in the importing scope.
|
||||||
|
|
||||||
## dynamic symbols
|
## dynamic symbols
|
||||||
|
|
||||||
@@ -464,12 +994,12 @@ request](https://gitea.sergeych.net/SergeychWorks/lyng/issues).
|
|||||||
- ObjClass sole parent is Obj
|
- ObjClass sole parent is Obj
|
||||||
- ObjClass contains code for instance methods, class fields, hierarchy information.
|
- ObjClass contains code for instance methods, class fields, hierarchy information.
|
||||||
- Class information is also scoped.
|
- Class information is also scoped.
|
||||||
- We acoid imported classes duplication using packages and import caching, so the same imported module is the same object in all its classes.
|
- We avoid imported classes duplication using packages and import caching, so the same imported module is the same object in all its classes.
|
||||||
|
|
||||||
## Instances
|
## Instances
|
||||||
|
|
||||||
Result of executing of any expression or statement in the Lyng is the object that
|
Result of executing of any expression or statement in the Lyng is the object that
|
||||||
inherits `Obj`, but is not `Obj`. For example it could be Int, void, null, real, string, bool, etc.
|
inherits `Obj`, but is not `Obj`. For example, it could be Int, void, null, real, string, bool, etc.
|
||||||
|
|
||||||
This means whatever expression returns or the variable holds, is the first-class
|
This means whatever expression returns or the variable holds, is the first-class
|
||||||
object, no differenes. For example:
|
object, no differenes. For example:
|
||||||
@@ -526,3 +1056,8 @@ Regular methods are called on instances as usual `instance.method()`. The method
|
|||||||
TBD
|
TBD
|
||||||
|
|
||||||
[argument list](declaring_arguments.md)
|
[argument list](declaring_arguments.md)
|
||||||
|
### Visibility from within closures and instance scopes
|
||||||
|
|
||||||
|
When a closure executes within a method, the closure retains the lexical class context of its creation site. This means private/protected members of that class remain accessible where expected (subject to usual visibility rules). Field resolution checks the declaring class and validates access using the preserved `currentClassCtx`.
|
||||||
|
|
||||||
|
See also: [Scopes and Closures: resolution and safety](scopes_and_closures.md)
|
||||||
+121
@@ -0,0 +1,121 @@
|
|||||||
|
# Testing and Assertions
|
||||||
|
|
||||||
|
Lyng provides several built-in functions for testing and verifying code behavior. These are available in all scripts.
|
||||||
|
|
||||||
|
## Basic Assertions
|
||||||
|
|
||||||
|
### `assert`
|
||||||
|
|
||||||
|
Assert that a condition is true.
|
||||||
|
|
||||||
|
assert(condition, message=null)
|
||||||
|
|
||||||
|
- `condition`: A boolean expression.
|
||||||
|
- `message` (optional): A string message to include in the exception if the assertion fails.
|
||||||
|
|
||||||
|
If the condition is false, it throws an `AssertionFailedException`.
|
||||||
|
|
||||||
|
```lyng
|
||||||
|
assert(1 + 1 == 2)
|
||||||
|
assert(true, "This should be true")
|
||||||
|
```
|
||||||
|
|
||||||
|
### `assertEquals` and `assertEqual`
|
||||||
|
|
||||||
|
Assert that two values are equal. `assertEqual` is an alias for `assertEquals`.
|
||||||
|
|
||||||
|
assertEquals(expected, actual)
|
||||||
|
assertEqual(expected, actual)
|
||||||
|
|
||||||
|
If `expected != actual`, it throws an `AssertionFailedException` with a message showing both values.
|
||||||
|
|
||||||
|
```lyng
|
||||||
|
assertEquals(4, 2 * 2)
|
||||||
|
assertEqual("hello", "hel" + "lo")
|
||||||
|
```
|
||||||
|
|
||||||
|
### `assertNotEquals`
|
||||||
|
|
||||||
|
Assert that two values are not equal.
|
||||||
|
|
||||||
|
assertNotEquals(unexpected, actual)
|
||||||
|
|
||||||
|
If `unexpected == actual`, it throws an `AssertionFailedException`.
|
||||||
|
|
||||||
|
```lyng
|
||||||
|
assertNotEquals(5, 2 * 2)
|
||||||
|
```
|
||||||
|
|
||||||
|
## Exception Testing
|
||||||
|
|
||||||
|
### `assertThrows`
|
||||||
|
|
||||||
|
Assert that a block of code throws an exception.
|
||||||
|
|
||||||
|
assertThrows(code)
|
||||||
|
assertThrows(expectedExceptionClass, code)
|
||||||
|
|
||||||
|
- `expectedExceptionClass` (optional): The class of the exception that is expected to be thrown.
|
||||||
|
- `code`: A lambda block or statement to execute.
|
||||||
|
|
||||||
|
If the code does not throw an exception, an `AssertionFailedException` is raised.
|
||||||
|
If an `expectedExceptionClass` is provided, the thrown exception must be of that class (or its subclass), otherwise an error is raised.
|
||||||
|
|
||||||
|
`assertThrows` returns the caught exception object if successful.
|
||||||
|
|
||||||
|
```lyng
|
||||||
|
// Just assert that something is thrown
|
||||||
|
assertThrows { 1 / 0 }
|
||||||
|
|
||||||
|
// Assert that a specific exception class is thrown
|
||||||
|
assertThrows(NoSuchElementException) {
|
||||||
|
[1, 2, 3].findFirst { it > 10 }
|
||||||
|
}
|
||||||
|
|
||||||
|
// You can use the returned exception
|
||||||
|
val ex = assertThrows { throw Exception("custom error") }
|
||||||
|
assertEquals("custom error", ex.message)
|
||||||
|
```
|
||||||
|
|
||||||
|
## Other Validation Functions
|
||||||
|
|
||||||
|
While not strictly for testing, these functions help in defensive programming:
|
||||||
|
|
||||||
|
### `require`
|
||||||
|
|
||||||
|
require(condition, message="requirement not met")
|
||||||
|
|
||||||
|
Throws an `IllegalArgumentException` if the condition is false. Use this for validating function arguments.
|
||||||
|
|
||||||
|
If we want to evaluate the message lazily:
|
||||||
|
|
||||||
|
require(condition) { "requirement not met: %s"(someData) }
|
||||||
|
|
||||||
|
In this case, formatting will only occur if the condition is not met.
|
||||||
|
|
||||||
|
### `check`
|
||||||
|
|
||||||
|
check(condition, message="check failed")
|
||||||
|
|
||||||
|
Throws an `IllegalStateException` if the condition is false. Use this for validating internal state.
|
||||||
|
|
||||||
|
With lazy message evaluation:
|
||||||
|
|
||||||
|
check(condition) { "check failed: %s"(someData) }
|
||||||
|
|
||||||
|
In this case, formatting will only occur if the condition is not met.
|
||||||
|
|
||||||
|
### TODO
|
||||||
|
|
||||||
|
It is easy to mark some code and make it throw a special exception at cone with:
|
||||||
|
|
||||||
|
TODO()
|
||||||
|
|
||||||
|
or
|
||||||
|
|
||||||
|
TODO("some message")
|
||||||
|
|
||||||
|
It raises an `NotImplementedException` with the given message. You can catch it
|
||||||
|
as any other exception when necessary.
|
||||||
|
|
||||||
|
Many IDE and editors have built-in support for marking code with TODOs.
|
||||||
@@ -158,3 +158,9 @@ Function annotation can have more args specified at call time. There arguments m
|
|||||||
>>> void
|
>>> void
|
||||||
|
|
||||||
[parallelism]: parallelism.md
|
[parallelism]: parallelism.md
|
||||||
|
|
||||||
|
## Scopes and Closures: resolution and safety
|
||||||
|
|
||||||
|
Closures and dynamic scope graphs require care to avoid accidental recursion and to keep name resolution predictable. See the dedicated page for detailed rules, helper APIs, and best practices:
|
||||||
|
|
||||||
|
- Scopes and Closures: resolution and safety → [scopes_and_closures.md](scopes_and_closures.md)
|
||||||
@@ -0,0 +1,15 @@
|
|||||||
|
# AI notes: avoid Kotlin/Wasm invalid IR with suspend lambdas
|
||||||
|
|
||||||
|
## Do
|
||||||
|
- Prefer explicit `object : Statement()` with `override suspend fun execute(...)` when building compiler statements.
|
||||||
|
- Keep `Statement` objects non-lambda, especially in compiler hot paths like parsing/var declarations.
|
||||||
|
- If you need conditional behavior, return early in `execute` instead of wrapping `parseExpression()` with `statement(...) { ... }`.
|
||||||
|
- When wasmJs tests hang in the browser, first check `wasmJsNodeTest` for a compile error; hangs often mean module instantiation failed.
|
||||||
|
|
||||||
|
## Don't
|
||||||
|
- Do not create suspend lambdas inside `Statement` factories (`statement { ... }`) for wasm targets.
|
||||||
|
- Do not "fix" hangs by increasing browser timeouts; it masks invalid wasm generation.
|
||||||
|
|
||||||
|
## Debugging tips
|
||||||
|
- Look for `$invokeCOROUTINE$` in wasm function names when mapping failures.
|
||||||
|
- If node test logs a wasm compile error, the browser hang is likely the same root cause.
|
||||||
+36
-14
@@ -1,5 +1,7 @@
|
|||||||
# Declaring arguments in Lyng
|
# Declaring arguments in Lyng
|
||||||
|
|
||||||
|
[//]: # (topMenu)
|
||||||
|
|
||||||
It is a common thing that occurs in many places in Lyng, function declarations,
|
It is a common thing that occurs in many places in Lyng, function declarations,
|
||||||
lambdas and class declarations.
|
lambdas and class declarations.
|
||||||
|
|
||||||
@@ -73,6 +75,13 @@ destructuring arrays when calling functions and lambdas:
|
|||||||
getFirstAndLast( ...(1..10) ) // see "splats" section below
|
getFirstAndLast( ...(1..10) ) // see "splats" section below
|
||||||
>>> [1,10]
|
>>> [1,10]
|
||||||
|
|
||||||
|
Note that array destructuring can also be used in assignments:
|
||||||
|
|
||||||
|
val [first, middle..., last] = [1, 2, 3, 4, 5]
|
||||||
|
[x, y] = [y, x] // Swap
|
||||||
|
|
||||||
|
See [tutorial] and [List] documentation for more details on destructuring assignments.
|
||||||
|
|
||||||
# Splats
|
# Splats
|
||||||
|
|
||||||
Ellipsis allows to convert argument lists to lists. The inversa algorithm that converts [List],
|
Ellipsis allows to convert argument lists to lists. The inversa algorithm that converts [List],
|
||||||
@@ -98,41 +107,53 @@ There could be any number of splats at any positions. You can splat any other [I
|
|||||||
|
|
||||||
## Named arguments in calls
|
## Named arguments in calls
|
||||||
|
|
||||||
Lyng supports named arguments at call sites using colon syntax `name: value`:
|
Lyng supports named arguments at call sites using colon syntax `name: value`.
|
||||||
|
|
||||||
|
### Shorthand for Named Arguments
|
||||||
|
|
||||||
|
If you want to pass a variable as a named argument and the variable has the same name as the parameter, you can omit the value and use the shorthand `name:`. This is highly readable and matches the shorthand for map literals.
|
||||||
|
|
||||||
```lyng
|
```lyng
|
||||||
fun test(a="foo", b="bar", c="bazz") { [a, b, c] }
|
fun test(a, b, c) { [a, b, c] }
|
||||||
|
|
||||||
assertEquals(["foo", "b", "bazz"], test(b: "b"))
|
val a = 1
|
||||||
assertEquals(["a", "bar", "c"], test("a", c: "c"))
|
val b = 2
|
||||||
|
val c = 3
|
||||||
|
|
||||||
|
// Explicit:
|
||||||
|
assertEquals([1, 2, 3], test(a: a, b: b, c: c))
|
||||||
|
|
||||||
|
// Shorthand (preferred):
|
||||||
|
assertEquals([1, 2, 3], test(a:, b:, c:))
|
||||||
```
|
```
|
||||||
|
|
||||||
Rules:
|
This shorthand is elegant, reduces boilerplate, and is consistent with Lyng's map literal syntax. It works for both function calls and class constructors.
|
||||||
|
|
||||||
|
Rules for named arguments:
|
||||||
|
|
||||||
- Named arguments must follow positional arguments. After the first named argument, no positional arguments may appear inside the parentheses.
|
- Named arguments must follow positional arguments. After the first named argument, no positional arguments may appear inside the parentheses.
|
||||||
- The only exception is the syntactic trailing block after the call: `f(args) { ... }`. This block is outside the parentheses and is handled specially (see below).
|
- The only exception is the syntactic trailing block after the call: `f(args) { ... }`. This block is outside the parentheses and is handled specially (see below).
|
||||||
- A named argument cannot reassign a parameter already set positionally.
|
- A named argument cannot reassign a parameter already set positionally.
|
||||||
- If the last parameter has already been assigned by a named argument (or named splat), a trailing block is not allowed and results in an error.
|
- If the last parameter has already been assigned by a named argument (or named splat), a trailing block is not allowed and results in an error.
|
||||||
|
|
||||||
Why `:` and not `=` at call sites? In Lyng, `=` is an expression (assignment), so we use `:` to avoid ambiguity. Declarations continue to use `:` for types, while call sites use `as` / `as?` for type operations.
|
Why `:` and not `=` at call sites? In Lyng, `=` is an expression (assignment), so we use `:` to avoid ambiguity. This is a key difference from **Kotlin**, which uses `=` for named arguments. Declarations in Lyng continue to use `:` for types, while call sites use `as` / `as?` for type operations.
|
||||||
|
|
||||||
## Named splats (map splats)
|
## Named splats (map splats)
|
||||||
|
|
||||||
Splat (`...`) of a Map provides named arguments to the call. Only string keys are allowed:
|
Splat (`...`) of a Map provides named arguments to the call. Only string keys are allowed. You can use the same auto-substitution shorthand inside map literals used for splats:
|
||||||
|
|
||||||
```lyng
|
```lyng
|
||||||
fun test(a="a", b="b", c="c", d="d") { [a, b, c, d] }
|
fun test(a="a", b="b", c="c", d="d") { [a, b, c, d] }
|
||||||
val r = test("A?", ...Map("d" => "D!", "b" => "B!"))
|
|
||||||
assertEquals(["A?","B!","c","D!"], r)
|
|
||||||
```
|
|
||||||
|
|
||||||
The same with a map literal is often more concise. Define the literal, then splat the variable:
|
val b = "B!"
|
||||||
|
val d = "D!"
|
||||||
|
|
||||||
|
// Auto-substitution in map literal:
|
||||||
|
val patch = { d:, b: }
|
||||||
|
|
||||||
fun test(a="a", b="b", c="c", d="d") { [a, b, c, d] }
|
|
||||||
val patch = { d: "D!", b: "B!" }
|
|
||||||
val r = test("A?", ...patch)
|
val r = test("A?", ...patch)
|
||||||
assertEquals(["A?","B!","c","D!"], r)
|
assertEquals(["A?","B!","c","D!"], r)
|
||||||
>>> void
|
```
|
||||||
|
|
||||||
Constraints:
|
Constraints:
|
||||||
|
|
||||||
@@ -153,3 +174,4 @@ If a call is immediately followed by a block `{ ... }`, it is treated as an extr
|
|||||||
|
|
||||||
|
|
||||||
[tutorial]: tutorial.md
|
[tutorial]: tutorial.md
|
||||||
|
[List]: List.md
|
||||||
@@ -0,0 +1,175 @@
|
|||||||
|
# Delegation in Lyng
|
||||||
|
|
||||||
|
Delegation is a powerful pattern that allows you to outsource the logic of properties (`val`, `var`) and functions (`fun`) to another object. This enables code reuse, separation of concerns, and the implementation of common patterns like lazy initialization, observable properties, and remote procedure calls (RPC) with minimal boilerplate.
|
||||||
|
|
||||||
|
## The `by` Keyword
|
||||||
|
|
||||||
|
Delegation is triggered using the `by` keyword in a declaration. The expression following `by` is evaluated once when the member is initialized, and the resulting object becomes the **delegate**.
|
||||||
|
|
||||||
|
```lyng
|
||||||
|
val x by MyDelegate()
|
||||||
|
var y by MyDelegate()
|
||||||
|
fun f by MyDelegate()
|
||||||
|
```
|
||||||
|
|
||||||
|
## The Unified Delegate Model
|
||||||
|
|
||||||
|
A delegate object can implement any of the following methods to intercept member access. All methods receive the `thisRef` (the instance containing the member) and the `name` of the member.
|
||||||
|
|
||||||
|
```lyng
|
||||||
|
interface Delegate {
|
||||||
|
// Called when a 'val' or 'var' is read
|
||||||
|
fun getValue(thisRef, name)
|
||||||
|
|
||||||
|
// Called when a 'var' is assigned
|
||||||
|
fun setValue(thisRef, name, newValue)
|
||||||
|
|
||||||
|
// Called when a 'fun' is invoked
|
||||||
|
fun invoke(thisRef, name, args...)
|
||||||
|
|
||||||
|
// Optional: Called once during initialization to "bind" the delegate
|
||||||
|
// Can be used for validation or to return a different delegate instance
|
||||||
|
fun bind(name, access, thisRef) = this
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Delegate Access Types
|
||||||
|
|
||||||
|
The `bind` method receives an `access` parameter of type `DelegateAccess`, which can be one of:
|
||||||
|
- `DelegateAccess.Val`
|
||||||
|
- `DelegateAccess.Var`
|
||||||
|
- `DelegateAccess.Callable` (for `fun`)
|
||||||
|
|
||||||
|
## Usage Cases and Examples
|
||||||
|
|
||||||
|
### 1. Lazy Initialization
|
||||||
|
|
||||||
|
The classic `lazy` pattern ensures a value is computed only when first accessed and then cached. In Lyng, `lazy` is implemented as a class that follows this pattern. While classes typically start with an uppercase letter, `lazy` is an exception to make its usage feel like a native language feature.
|
||||||
|
|
||||||
|
```lyng
|
||||||
|
class lazy(val creator) : Delegate {
|
||||||
|
private var value = Unset
|
||||||
|
|
||||||
|
override fun bind(name, access, thisRef) {
|
||||||
|
if (access != DelegateAccess.Val) throw "lazy delegate can only be used with 'val'"
|
||||||
|
this
|
||||||
|
}
|
||||||
|
|
||||||
|
override fun getValue(thisRef, name) {
|
||||||
|
if (value == Unset) {
|
||||||
|
value = creator()
|
||||||
|
}
|
||||||
|
value
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Usage:
|
||||||
|
val expensiveData by lazy {
|
||||||
|
println("Performing expensive computation...")
|
||||||
|
42
|
||||||
|
}
|
||||||
|
|
||||||
|
println(expensiveData) // Computes and prints 42
|
||||||
|
println(expensiveData) // Returns 42 immediately
|
||||||
|
```
|
||||||
|
|
||||||
|
### 2. Observable Properties
|
||||||
|
|
||||||
|
Delegates can be used to react to property changes.
|
||||||
|
|
||||||
|
```lyng
|
||||||
|
class Observable(initialValue, val onChange) {
|
||||||
|
private var value = initialValue
|
||||||
|
|
||||||
|
fun getValue(thisRef, name) = value
|
||||||
|
|
||||||
|
fun setValue(thisRef, name, newValue) {
|
||||||
|
val oldValue = value
|
||||||
|
value = newValue
|
||||||
|
onChange(name, oldValue, newValue)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
class User {
|
||||||
|
var name by Observable("Guest") { name, old, new ->
|
||||||
|
println("Property %s changed from %s to %s"(name, old, new))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
val u = User()
|
||||||
|
u.name = "Alice" // Prints: Property name changed from Guest to Alice
|
||||||
|
```
|
||||||
|
|
||||||
|
### 3. Function Delegation (Proxies)
|
||||||
|
|
||||||
|
You can delegate an entire function to an object. This is particularly useful for implementing decorators or RPC clients.
|
||||||
|
|
||||||
|
```lyng
|
||||||
|
object LoggerDelegate {
|
||||||
|
fun invoke(thisRef, name, args...) {
|
||||||
|
println("Calling function: " + name + " with args: " + args)
|
||||||
|
// Logic here...
|
||||||
|
"Result of " + name
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
fun remoteAction by LoggerDelegate
|
||||||
|
|
||||||
|
println(remoteAction(1, 2, 3))
|
||||||
|
// Prints: Calling function: remoteAction with args: [1, 2, 3]
|
||||||
|
// Prints: Result of remoteAction
|
||||||
|
```
|
||||||
|
|
||||||
|
### 4. Stateless Delegates (Shared Singletons)
|
||||||
|
|
||||||
|
Because `getValue`, `setValue`, and `invoke` receive `thisRef`, a single object can act as a delegate for multiple properties across many instances without any per-property memory overhead.
|
||||||
|
|
||||||
|
```lyng
|
||||||
|
object Constant42 {
|
||||||
|
fun getValue(thisRef, name) = 42
|
||||||
|
}
|
||||||
|
|
||||||
|
class Foo {
|
||||||
|
val a by Constant42
|
||||||
|
val b by Constant42
|
||||||
|
}
|
||||||
|
|
||||||
|
val f = Foo()
|
||||||
|
assertEquals(42, f.a)
|
||||||
|
assertEquals(42, f.b)
|
||||||
|
```
|
||||||
|
|
||||||
|
### 5. Local Delegation
|
||||||
|
|
||||||
|
Delegation is not limited to class members; you can also use it for local variables inside functions.
|
||||||
|
|
||||||
|
```lyng
|
||||||
|
fun test() {
|
||||||
|
val x by LocalProxy(123)
|
||||||
|
println(x)
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## The `bind` Hook
|
||||||
|
|
||||||
|
The `bind(name, access, thisRef)` method is called exactly once when the member is being initialized. It allows the delegate to:
|
||||||
|
1. **Validate usage**: Throw an error if the delegate is used with the wrong member type (e.g., `lazy` on a `var`).
|
||||||
|
2. **Initialize state**: Set up internal state based on the property name or the containing instance.
|
||||||
|
3. **Substitute itself**: Return a different object that will act as the actual delegate.
|
||||||
|
|
||||||
|
```lyng
|
||||||
|
class ValidatedDelegate() {
|
||||||
|
fun bind(name, access, thisRef) {
|
||||||
|
if (access == DelegateAccess.Var) {
|
||||||
|
throw "This delegate cannot be used with 'var'"
|
||||||
|
}
|
||||||
|
this
|
||||||
|
}
|
||||||
|
|
||||||
|
fun getValue(thisRef, name) = "Validated"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## Summary
|
||||||
|
|
||||||
|
Delegation in Lyng combines the elegance of Kotlin-style properties with the flexibility of dynamic function interception. By unifying `val`, `var`, and `fun` delegation into a single model, Lyng provides a consistent and powerful tool for meta-programming and code reuse.
|
||||||
+60
-5
@@ -109,7 +109,62 @@ scope.eval("val y = inc(41); log('Answer:', y)")
|
|||||||
|
|
||||||
You can register multiple names (aliases) at once: `addFn<ObjInt>("inc", "increment") { ... }`.
|
You can register multiple names (aliases) at once: `addFn<ObjInt>("inc", "increment") { ... }`.
|
||||||
|
|
||||||
### 5) Read variable values back in Kotlin
|
### 5) Add Kotlin‑backed fields
|
||||||
|
|
||||||
|
If you need a simple field (with a value) instead of a computed property, use `createField`. This adds a field to the class that will be present in all its instances.
|
||||||
|
|
||||||
|
```kotlin
|
||||||
|
val myClass = ObjClass("MyClass")
|
||||||
|
|
||||||
|
// Add a read-only field (constant)
|
||||||
|
myClass.createField("version", ObjString("1.0.0"), isMutable = false)
|
||||||
|
|
||||||
|
// Add a mutable field with an initial value
|
||||||
|
myClass.createField("count", ObjInt(0), isMutable = true)
|
||||||
|
|
||||||
|
scope.addConst("MyClass", myClass)
|
||||||
|
```
|
||||||
|
|
||||||
|
In Lyng:
|
||||||
|
```lyng
|
||||||
|
val instance = MyClass()
|
||||||
|
println(instance.version) // -> "1.0.0"
|
||||||
|
instance.count = 5
|
||||||
|
println(instance.count) // -> 5
|
||||||
|
```
|
||||||
|
|
||||||
|
### 6) Add Kotlin‑backed properties
|
||||||
|
|
||||||
|
Properties in Lyng are pure accessors (getters and setters) and do not have automatic backing fields. You can add them to a class using `addProperty`.
|
||||||
|
|
||||||
|
```kotlin
|
||||||
|
val myClass = ObjClass("MyClass")
|
||||||
|
var internalValue: Long = 10
|
||||||
|
|
||||||
|
myClass.addProperty(
|
||||||
|
name = "value",
|
||||||
|
getter = {
|
||||||
|
// Return current value as a Lyng object
|
||||||
|
ObjInt(internalValue)
|
||||||
|
},
|
||||||
|
setter = { newValue ->
|
||||||
|
// newValue is passed as a Lyng object (the first and only argument)
|
||||||
|
internalValue = (newValue as ObjInt).value
|
||||||
|
}
|
||||||
|
)
|
||||||
|
|
||||||
|
scope.addConst("MyClass", myClass)
|
||||||
|
```
|
||||||
|
|
||||||
|
Usage in Lyng:
|
||||||
|
```lyng
|
||||||
|
val instance = MyClass()
|
||||||
|
println(instance.value) // -> 10
|
||||||
|
instance.value = 42
|
||||||
|
println(instance.value) // -> 42
|
||||||
|
```
|
||||||
|
|
||||||
|
### 7) Read variable values back in Kotlin
|
||||||
|
|
||||||
The simplest approach: evaluate an expression that yields the value and convert it.
|
The simplest approach: evaluate an expression that yields the value and convert it.
|
||||||
|
|
||||||
@@ -124,7 +179,7 @@ val kotlinName = scope.eval("name").toKotlin(scope) // -> "Lyng rocks!"
|
|||||||
|
|
||||||
Advanced: you can also grab a variable record directly via `scope.get(name)` and work with its `Obj` value, but evaluating `"name"` is often clearer and enforces Lyng semantics consistently.
|
Advanced: you can also grab a variable record directly via `scope.get(name)` and work with its `Obj` value, but evaluating `"name"` is often clearer and enforces Lyng semantics consistently.
|
||||||
|
|
||||||
### 6) Execute scripts with parameters; call Lyng functions from Kotlin
|
### 8) Execute scripts with parameters; call Lyng functions from Kotlin
|
||||||
|
|
||||||
There are two convenient patterns.
|
There are two convenient patterns.
|
||||||
|
|
||||||
@@ -157,7 +212,7 @@ val result = resultObj.toKotlin(scope) // -> 42
|
|||||||
|
|
||||||
If you need to pass complex data (lists, maps), construct the corresponding Lyng `Obj` types (`ObjList`, `ObjMap`, etc.) and pass them in `Arguments`.
|
If you need to pass complex data (lists, maps), construct the corresponding Lyng `Obj` types (`ObjList`, `ObjMap`, etc.) and pass them in `Arguments`.
|
||||||
|
|
||||||
### 7) Create your own packages and import them in Lyng
|
### 9) Create your own packages and import them in Lyng
|
||||||
|
|
||||||
Lyng supports packages that are imported from scripts. You can register packages programmatically via `ImportManager` or by providing source texts that declare `package ...`.
|
Lyng supports packages that are imported from scripts. You can register packages programmatically via `ImportManager` or by providing source texts that declare `package ...`.
|
||||||
|
|
||||||
@@ -212,7 +267,7 @@ val s = scope.eval("s").toKotlin(scope) // -> 144
|
|||||||
|
|
||||||
You can also register from parsed `Source` instances via `addSourcePackages(source)`.
|
You can also register from parsed `Source` instances via `addSourcePackages(source)`.
|
||||||
|
|
||||||
### 8) Executing from files, security, and isolation
|
### 10) Executing from files, security, and isolation
|
||||||
|
|
||||||
- To run code from a file, read it and pass to `scope.eval(text)` or compile with `Compiler.compile(Source(fileName, text))`.
|
- To run code from a file, read it and pass to `scope.eval(text)` or compile with `Compiler.compile(Source(fileName, text))`.
|
||||||
- `ImportManager` takes an optional `SecurityManager` if you need to restrict what packages or operations are available. By default, `Script.defaultImportManager` allows everything suitable for embedded use; clamp it down in sandboxed environments.
|
- `ImportManager` takes an optional `SecurityManager` if you need to restrict what packages or operations are available. By default, `Script.defaultImportManager` allows everything suitable for embedded use; clamp it down in sandboxed environments.
|
||||||
@@ -223,7 +278,7 @@ You can also register from parsed `Source` instances via `addSourcePackages(sour
|
|||||||
val isolated = net.sergeych.lyng.Scope.new()
|
val isolated = net.sergeych.lyng.Scope.new()
|
||||||
```
|
```
|
||||||
|
|
||||||
### 9) Tips and troubleshooting
|
### 11) Tips and troubleshooting
|
||||||
|
|
||||||
- All values that cross the boundary must be Lyng `Obj` instances. Convert Kotlin values explicitly (e.g., `ObjInt`, `ObjReal`, `ObjString`).
|
- All values that cross the boundary must be Lyng `Obj` instances. Convert Kotlin values explicitly (e.g., `ObjInt`, `ObjReal`, `ObjString`).
|
||||||
- Use `toKotlin(scope)` to get Kotlin values back. Collections convert to Kotlin collections recursively.
|
- Use `toKotlin(scope)` to get Kotlin values back. Collections convert to Kotlin collections recursively.
|
||||||
|
|||||||
@@ -136,7 +136,7 @@ Serializable class that conveys information about the exception. Important membe
|
|||||||
|
|
||||||
A simple structire that stores single entry in Lyng stack, it is created automatically on exception creation:
|
A simple structire that stores single entry in Lyng stack, it is created automatically on exception creation:
|
||||||
|
|
||||||
```kotlin
|
```lyng
|
||||||
class StackTraceEntry(
|
class StackTraceEntry(
|
||||||
val sourceName: String,
|
val sourceName: String,
|
||||||
val line: Int,
|
val line: Int,
|
||||||
@@ -165,7 +165,22 @@ _this functionality is not yet released_
|
|||||||
| IllegalAssignmentException | assigning to val, etc. |
|
| IllegalAssignmentException | assigning to val, etc. |
|
||||||
| SymbolNotDefinedException | |
|
| SymbolNotDefinedException | |
|
||||||
| IterationEndException | attempt to read iterator past end, `hasNext == false` |
|
| IterationEndException | attempt to read iterator past end, `hasNext == false` |
|
||||||
| AccessException | attempt to access private members or like |
|
| IllegalAccessException | attempt to access private members or like |
|
||||||
| UnknownException | unexpected kotlin exception caught |
|
| UnknownException | unexpected kotlin exception caught |
|
||||||
| | |
|
| | |
|
||||||
|
|
||||||
|
|
||||||
|
### Symbol resolution errors
|
||||||
|
|
||||||
|
For compatibility, `SymbolNotFound` is an alias of `SymbolNotDefinedException`. You can catch either name in examples and tests.
|
||||||
|
|
||||||
|
Example:
|
||||||
|
|
||||||
|
```lyng
|
||||||
|
try {
|
||||||
|
nonExistingMethod()
|
||||||
|
}
|
||||||
|
catch(e: SymbolNotFound) {
|
||||||
|
// handle
|
||||||
|
}
|
||||||
|
```
|
||||||
@@ -0,0 +1,34 @@
|
|||||||
|
## Fix: prevent cycles in scope parent chain during pooled frame reuse
|
||||||
|
|
||||||
|
### What changed
|
||||||
|
- Scope.resetForReuse now fully detaches a reused scope from its previous chain/state before re-parenting:
|
||||||
|
- sets `parent = null` and regenerates `frameId`
|
||||||
|
- clears locals/slots/bindings caches
|
||||||
|
- only after that, validates the new parent with `ensureNoCycle` and assigns it
|
||||||
|
- ScopePool.borrow on all targets (JVM, Android, JS, Native, Wasm) now has a defensive fallback:
|
||||||
|
- if `resetForReuse` throws `IllegalStateException` indicating a parent-chain cycle, the pool allocates a fresh `Scope` instead of failing.
|
||||||
|
|
||||||
|
### Why
|
||||||
|
In some nested call patterns (notably instance method calls where an instance is produced by another function and immediately used), the same pooled `Scope` object can be rebound into a chain that already (transitively) contains it. Reassigning `parent` in that case forms a structural cycle, which `ensureNoCycle` correctly detects and throws. This could surface as:
|
||||||
|
|
||||||
|
```
|
||||||
|
IllegalStateException: cycle detected in scope parent chain assignment
|
||||||
|
at net.sergeych.lyng.Scope.ensureNoCycle(...)
|
||||||
|
at net.sergeych.lyng.Scope.resetForReuse(...)
|
||||||
|
at net.sergeych.lyng.ScopePool.borrow(...)
|
||||||
|
... during instance method invocation
|
||||||
|
```
|
||||||
|
|
||||||
|
The fix removes the failure mode by:
|
||||||
|
1) Detaching the reused frame from its prior chain/state before validating and assigning the new parent.
|
||||||
|
2) Falling back to a new frame allocation if a cycle is still detected (extremely rare and cheap vs. a crash).
|
||||||
|
|
||||||
|
### Expected effects
|
||||||
|
- Eliminates sporadic `cycle detected in scope parent chain` crashes during instance method invocation.
|
||||||
|
- No change to public API or normal semantics.
|
||||||
|
- Pooling remains enabled by default; the fallback only triggers on the detected cycle edge case.
|
||||||
|
- Negligible performance impact: fresh allocation is used only when a cycle would have crashed the VM previously.
|
||||||
|
|
||||||
|
### Notes
|
||||||
|
- The fix is platform-wide (all ScopePool actuals are covered).
|
||||||
|
- We recommend adding/keeping a regression test that exercises: a class with a method, a function returning an instance, and an exported function calling the instance method. The test should pass without exceptions.
|
||||||
@@ -0,0 +1,62 @@
|
|||||||
|
# Lyng formatter (core, CLI, and IDE)
|
||||||
|
|
||||||
|
This document describes the Lyng code formatter included in this repository. The formatter lives in the core library (`:lynglib`), is available from the CLI (`lyng fmt`), and is used by the IntelliJ plugin.
|
||||||
|
|
||||||
|
## Core library
|
||||||
|
|
||||||
|
Package: `net.sergeych.lyng.format`
|
||||||
|
|
||||||
|
- `LyngFormatConfig`
|
||||||
|
- `indentSize` (default 4)
|
||||||
|
- `useTabs` (default false)
|
||||||
|
- `continuationIndentSize` (default 8)
|
||||||
|
- `maxLineLength` (default 120)
|
||||||
|
- `applySpacing` (default false)
|
||||||
|
- `applyWrapping` (default false)
|
||||||
|
- `LyngFormatter`
|
||||||
|
- `reindent(text, config)` — recomputes indentation from scratch (braces, `else/catch/finally` alignment, continuation indent under `(` `)` and `[` `]`), idempotent.
|
||||||
|
- `format(text, config)` — runs `reindent` and, depending on `config`, optionally applies:
|
||||||
|
- a safe spacing pass (commas/operators/colons/keyword parens; member access `.` remains tight; no changes to strings/comments), and
|
||||||
|
- a controlled wrapping pass for long call arguments (no trailing commas).
|
||||||
|
|
||||||
|
Both passes are designed to be idempotent. Extensive tests live under `:lynglib/src/commonTest/.../format`.
|
||||||
|
|
||||||
|
## CLI formatter
|
||||||
|
|
||||||
|
```
|
||||||
|
lyng fmt [--check] [--in-place|-i] [--spacing] [--wrap] <file1.lyng> [file2.lyng ...]
|
||||||
|
```
|
||||||
|
|
||||||
|
- Defaults: indent-only; spacing and wrapping are OFF unless flags are provided.
|
||||||
|
- `--check` prints files that would change and exits with code 2 if any changes are detected.
|
||||||
|
- `--in-place`/`-i` rewrites files in place (default if not using `--check`).
|
||||||
|
- `--spacing` enables the safe spacing pass (commas/operators/colons/keyword parens).
|
||||||
|
- `--wrap` enables controlled wrapping of long call argument lists (respects `maxLineLength`, no trailing commas).
|
||||||
|
|
||||||
|
Examples:
|
||||||
|
|
||||||
|
```
|
||||||
|
# check formatting without modifying files
|
||||||
|
lyng fmt --check docs/samples/fs_sample.lyng
|
||||||
|
|
||||||
|
# format in place with spacing rules enabled
|
||||||
|
lyng fmt --spacing -i docs/samples/fs_sample.lyng
|
||||||
|
|
||||||
|
# format in place with spacing + wrapping
|
||||||
|
lyng fmt --spacing --wrap -i src/**/*.lyng
|
||||||
|
```
|
||||||
|
|
||||||
|
## IntelliJ plugin
|
||||||
|
|
||||||
|
- Indentation: always enabled, idempotent; the plugin computes per-line indent via the core formatter.
|
||||||
|
- Spacing/wrapping: optional and OFF by default.
|
||||||
|
- Settings/Preferences → Lyng Formatter provides toggles:
|
||||||
|
- "Enable spacing normalization (commas/operators/colons/keyword parens)"
|
||||||
|
- "Enable line wrapping (120 cols) [experimental]"
|
||||||
|
- Reformat Code applies: indentation first, then spacing, then wrapping if toggled.
|
||||||
|
|
||||||
|
## Design notes
|
||||||
|
|
||||||
|
- Single source of truth: The core formatter is used by CLI and IDE to keep behavior consistent.
|
||||||
|
- Stability first: Spacing/wrapping are gated by flags/toggles; indentation from scratch is always safe and idempotent.
|
||||||
|
- Non-destructive: The formatter carefully avoids changing string/char literals and comment contents.
|
||||||
@@ -0,0 +1,29 @@
|
|||||||
|
# Plugin for IntelliJ IDEA
|
||||||
|
|
||||||
|
[//]: # (excludeFromIndex)
|
||||||
|
|
||||||
|
We introduce the alpha version of the plugin for IntelliJ IDEA 2024.3.x+ IDE variants. It is compatible with 2025.x and
|
||||||
|
should be compatible with other IDEA flavors, notably [OpenIDE](https://openide.ru/). It supports the following features:
|
||||||
|
|
||||||
|
- syntax highlighting (2 stage, fast and more accurate that analyses in background)
|
||||||
|
- reformat code (indents, spaces)
|
||||||
|
- reformat on paste
|
||||||
|
- smart enter key
|
||||||
|
|
||||||
|
Features are configurable via the plugin settings page, in system settings.
|
||||||
|
|
||||||
|
> Recommended for IntelliJ-based IDEs: While IntelliJ can import TextMate bundles
|
||||||
|
> (Settings/Preferences → Editor → TextMate Bundles), the native Lyng plugin provides
|
||||||
|
> better support (formatting, smart enter, background analysis, etc.). Prefer installing
|
||||||
|
> this plugin over using a TextMate bundle.
|
||||||
|
|
||||||
|
### Install
|
||||||
|
|
||||||
|
- From ZIP: download the archive below, then in IntelliJ IDEA open Settings/Preferences → Plugins →
|
||||||
|
gear icon → Install Plugin from Disk… and select the downloaded ZIP. Restart IDE if prompted.
|
||||||
|
- Alternatively, if/when the plugin is published to a marketplace, you will be able to install it
|
||||||
|
directly from the “Marketplace” tab (not yet available).
|
||||||
|
|
||||||
|
### [Download plugin v0.0.2-SNAPSHOT](https://lynglang.com/distributables/lyng-idea-0.0.2-SNAPSHOT.zip)
|
||||||
|
|
||||||
|
Your ideas and bugreports are welcome on the [project gitea page](https://gitea.sergeych.net/SergeychWorks/lyng/issues)
|
||||||
@@ -0,0 +1,167 @@
|
|||||||
|
# Json support
|
||||||
|
|
||||||
|
Since 1.0.5 we start adding JSON support. Versions 1,0,6* support serialization of the basic types, including lists and
|
||||||
|
maps, and simple classes. Multiple inheritance may produce incorrect results, it is work in progress.
|
||||||
|
|
||||||
|
## Serialization in Lyng
|
||||||
|
|
||||||
|
// in lyng
|
||||||
|
assertEquals("{\"a\":1}", {a: 1}.toJsonString())
|
||||||
|
void
|
||||||
|
>>> void
|
||||||
|
|
||||||
|
Simple classes serialization is supported:
|
||||||
|
|
||||||
|
import lyng.serialization
|
||||||
|
class Point(foo,bar) {
|
||||||
|
val t = 42
|
||||||
|
}
|
||||||
|
// val is not serialized
|
||||||
|
assertEquals( "{\"foo\":1,\"bar\":2}", Point(1,2).toJsonString() )
|
||||||
|
>>> void
|
||||||
|
|
||||||
|
Note that mutable members are serialized:
|
||||||
|
|
||||||
|
import lyng.serialization
|
||||||
|
|
||||||
|
class Point2(foo,bar) {
|
||||||
|
var reason = 42
|
||||||
|
// but we override json serialization:
|
||||||
|
fun toJsonObject() {
|
||||||
|
{ "custom": true }
|
||||||
|
}
|
||||||
|
}
|
||||||
|
// var is serialized instead
|
||||||
|
assertEquals( "{\"custom\":true}", Point2(1,2).toJsonString() )
|
||||||
|
>>> void
|
||||||
|
|
||||||
|
Custom serialization of user classes is possible by overriding `toJsonObject` method. It must return an object which is
|
||||||
|
serializable to Json. Most often it is a map, but any object is accepted, that makes it very flexible:
|
||||||
|
|
||||||
|
import lyng.serialization
|
||||||
|
|
||||||
|
class Point2(foo,bar) {
|
||||||
|
var reason = 42
|
||||||
|
// but we override json serialization:
|
||||||
|
fun toJsonObject() {
|
||||||
|
{ "custom": true }
|
||||||
|
}
|
||||||
|
}
|
||||||
|
class Custom {
|
||||||
|
fun toJsonObject() {
|
||||||
|
"full freedom"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
// var is serialized instead
|
||||||
|
assertEquals( "\"full freedom\"", Custom().toJsonString() )
|
||||||
|
>>> void
|
||||||
|
|
||||||
|
Please note that `toJsonString` should be used to get serialized string representation of the object. Don't call
|
||||||
|
`toJsonObject` directly, it is not intended to be used outside the serialization library.
|
||||||
|
|
||||||
|
## Kotlin side interfaces
|
||||||
|
|
||||||
|
The "Batteries included" principle is also applied to serialization.
|
||||||
|
|
||||||
|
- `Obj.toJson()` provides Kotlin `JsonElement`
|
||||||
|
- `Obj.toJsonString()` provides Json string representation
|
||||||
|
- `Obj.decodeSerializableWith()` and `Obj.decodeSerializable()` allows to decode Lyng classes as Kotlin objects using
|
||||||
|
`kotlinx.serialization`:
|
||||||
|
|
||||||
|
```kotlin
|
||||||
|
/**
|
||||||
|
* Decodes the current object into a deserialized form using the provided deserialization strategy.
|
||||||
|
* It is based on [Obj.toJson] and uses existing Kotlin Json serialization, without string representation
|
||||||
|
* (only `JsonElement` to carry information between Kotlin and Lyng serialization worlds), thus efficient.
|
||||||
|
*
|
||||||
|
* @param strategy The deserialization strategy that defines how the object should be decoded.
|
||||||
|
* @param scope An optional scope used during deserialization to define the context. Defaults to a new instance of Scope.
|
||||||
|
* @return The deserialized object of type T.
|
||||||
|
*/
|
||||||
|
suspend fun <T> Obj.decodeSerializableWith(strategy: DeserializationStrategy<T>, scope: Scope = Scope()): T =
|
||||||
|
Json.decodeFromJsonElement(strategy, toJson(scope))
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Decodes a serializable object of type [T] using the provided decoding scope. The deserialization uses
|
||||||
|
* [Obj.toJson] and existing Json based serialization ithout using actual string representation, thus
|
||||||
|
* efficient.
|
||||||
|
*
|
||||||
|
* @param T The type of the object to be decoded. Must be a reified type.
|
||||||
|
* @param scope The scope used during decoding. Defaults to a new instance of [Scope].
|
||||||
|
*/
|
||||||
|
suspend inline fun <reified T> Obj.decodeSerializable(scope: Scope = Scope()) =
|
||||||
|
decodeSerializableWith<T>(serializer<T>(), scope)
|
||||||
|
```
|
||||||
|
|
||||||
|
Note that lyng-2-kotlin deserialization with `kotlinx.serialization` uses JsonElement as information carrier without
|
||||||
|
formatting and parsing actual Json strings. This is why we use `Json.decodeFromJsonElement` instead of
|
||||||
|
`Json.decodeFromString`. Such an approach gives satisfactory performance without writing and supporting custom
|
||||||
|
`kotlinx.serialization` codecs.
|
||||||
|
|
||||||
|
### Pitfall: JSON objects and Map<String, Any?>
|
||||||
|
|
||||||
|
Kotlin serialization does not support `Map<String, Any?>` as a serializable type, more general, it can't serialize `Any`. This in particular means that you can deserialize Kotlin `Map<String, T>` as long as `T` is `@Serializable` in Kotlin:
|
||||||
|
|
||||||
|
```kotlin
|
||||||
|
@Serializable
|
||||||
|
data class TestJson2(
|
||||||
|
val value: Int,
|
||||||
|
val inner: Map<String,Int>
|
||||||
|
)
|
||||||
|
|
||||||
|
@Test
|
||||||
|
fun deserializeMapWithJsonTest() = runTest {
|
||||||
|
val x = eval("""
|
||||||
|
import lyng.serialization
|
||||||
|
{ value: 1, inner: { "foo": 1, "bar": 2 }}
|
||||||
|
""".trimIndent()).decodeSerializable<TestJson2>()
|
||||||
|
// That works perfectly well:
|
||||||
|
assertEquals(TestJson2(1, mapOf("foo" to 1, "bar" to 2)), x)
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
But what if your map has objects of different types? The approach of using polymorphism is partially applicable, but what to do with `{ one: 1, two: "two" }`?
|
||||||
|
|
||||||
|
The answer is pretty simple: use `JsonObject` in your deserializable object. This class is capable of holding any JSON types and structures and is sort of a silver bullet for such cases:
|
||||||
|
|
||||||
|
~~~kotlin
|
||||||
|
@Serializable
|
||||||
|
data class TestJson3(
|
||||||
|
val value: Int,
|
||||||
|
val inner: JsonObject
|
||||||
|
)
|
||||||
|
@Test
|
||||||
|
fun deserializeAnyMapWithJsonTest() = runTest {
|
||||||
|
val x = eval("""
|
||||||
|
import lyng.serialization
|
||||||
|
{ value: 12, inner: { "foo": 1, "bar": "two" }}
|
||||||
|
""".trimIndent()).decodeSerializable<TestJson3>()
|
||||||
|
assertEquals(TestJson3(12, JsonObject(mapOf("foo" to JsonPrimitive(1), "bar" to Json.encodeToJsonElement("two")))), x)
|
||||||
|
}
|
||||||
|
~~~
|
||||||
|
|
||||||
|
|
||||||
|
# List of supported types
|
||||||
|
|
||||||
|
| Lyng type | JSON type | notes |
|
||||||
|
|-----------|-----------|-------------|
|
||||||
|
| `Int` | number | |
|
||||||
|
| `Real` | number | |
|
||||||
|
| `String` | string | |
|
||||||
|
| `Bool` | boolean | |
|
||||||
|
| `null` | null | |
|
||||||
|
| `Instant` | string | ISO8601 (1) |
|
||||||
|
| `List` | array | (2) |
|
||||||
|
| `Map` | object | (2) |
|
||||||
|
|
||||||
|
|
||||||
|
(1)
|
||||||
|
: ISO8601 flavor 1970-05-06T06:00:00.000Z in used; number of fractional digits depends on the truncation
|
||||||
|
on [Instant](time.md), see `Instant.truncateTo...` functions.
|
||||||
|
|
||||||
|
(2)
|
||||||
|
: List may contain any objects serializable to Json.
|
||||||
|
|
||||||
|
(3)
|
||||||
|
: Map keys must be strings, map values may be any objects serializable to Json.
|
||||||
|
|
||||||
@@ -0,0 +1,228 @@
|
|||||||
|
### lyng.io.fs — async filesystem access for Lyng scripts
|
||||||
|
|
||||||
|
This module provides a uniform, suspend-first filesystem API to Lyng scripts, backed by Kotlin Multiplatform implementations.
|
||||||
|
|
||||||
|
- JVM/Android/Native: Okio `FileSystem.SYSTEM` (non-blocking via coroutine dispatcher)
|
||||||
|
- JS/Node: Node filesystem (currently via Okio node backend; a native `fs/promises` backend is planned)
|
||||||
|
- JS/Browser and Wasm: in-memory virtual filesystem for now
|
||||||
|
|
||||||
|
It exposes a Lyng class `Path` with methods for file and directory operations, including streaming readers for large files.
|
||||||
|
|
||||||
|
It is a separate library because access to teh filesystem is a security risk we compensate with a separate API that user must explicitly include to the dependency and allow. Together with `FsAceessPolicy` that is required to `createFs()` which actually adds the filesystem to the scope, the security risk is isolated.
|
||||||
|
|
||||||
|
Also, it helps keep Lyng core small and focused.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
#### Add the library to your project (Gradle)
|
||||||
|
|
||||||
|
If you use this repository as a multi-module project, add a dependency on `:lyngio`:
|
||||||
|
|
||||||
|
```kotlin
|
||||||
|
dependencies {
|
||||||
|
implementation("net.sergeych:lyngio:0.0.1-SNAPSHOT")
|
||||||
|
}
|
||||||
|
```
|
||||||
|
Note on maven repository. Lyngio uses ths same maven as Lyng code (`lynglib`) so it is most likely already in your project. If ont, add it to the proper section of your `build.gradle.kts` or settings.gradle.kts:
|
||||||
|
|
||||||
|
```kotlin
|
||||||
|
repositories {
|
||||||
|
maven("https://gitea.sergeych.net/api/packages/SergeychWorks/maven")
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
This brings in:
|
||||||
|
|
||||||
|
- `:lynglib` (Lyng engine)
|
||||||
|
- Okio (`okio`, `okio-fakefilesystem`, and `okio-nodefilesystem` for JS)
|
||||||
|
- Kotlin coroutines
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
#### Install the module into a Lyng Scope
|
||||||
|
|
||||||
|
The filesystem module is not installed automatically. You must explicitly register it in the scope’s `ImportManager` using the installer. You can customize access control via `FsAccessPolicy`.
|
||||||
|
|
||||||
|
Kotlin (host) bootstrap example (imports omitted for brevity):
|
||||||
|
|
||||||
|
```kotlin
|
||||||
|
val scope: Scope = Scope.new()
|
||||||
|
val installed: Boolean = createFs(PermitAllAccessPolicy, scope)
|
||||||
|
// installed == true on first registration in this ImportManager, false on repeats
|
||||||
|
|
||||||
|
// In scripts (or via scope.eval), import the module to use its symbols:
|
||||||
|
scope.eval("import lyng.io.fs")
|
||||||
|
```
|
||||||
|
|
||||||
|
You can install with a custom policy too (see Access policy below).
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
#### Using from Lyng scripts
|
||||||
|
|
||||||
|
```lyng
|
||||||
|
val p = Path("/tmp/hello.txt")
|
||||||
|
|
||||||
|
// Text I/O
|
||||||
|
p.writeUtf8("Hello Lyng!\n")
|
||||||
|
println(p.readUtf8())
|
||||||
|
|
||||||
|
// Binary I/O
|
||||||
|
val data = Buffer.fromHex("deadbeef")
|
||||||
|
p.writeBytes(data)
|
||||||
|
|
||||||
|
// Existence and directories
|
||||||
|
assertTrue(p.exists())
|
||||||
|
Path("/tmp/work").mkdirs()
|
||||||
|
|
||||||
|
// Listing
|
||||||
|
for (entry in Path("/tmp").list()) {
|
||||||
|
println(entry)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Globbing
|
||||||
|
val txts = Path("/tmp").glob("**/*.txt").toList()
|
||||||
|
|
||||||
|
// Copy / Move / Delete
|
||||||
|
Path("/tmp/a.txt").copy("/tmp/b.txt", overwrite=true)
|
||||||
|
Path("/tmp/b.txt").move("/tmp/c.txt", overwrite=true)
|
||||||
|
Path("/tmp/c.txt").delete()
|
||||||
|
|
||||||
|
// Streaming large files (does not load whole file into memory)
|
||||||
|
var bytes = 0
|
||||||
|
val it = Path("/tmp/big.bin").readChunks(1_048_576) // 1MB chunks
|
||||||
|
val iter = it.iterator()
|
||||||
|
while (iter.hasNext()) {
|
||||||
|
val chunk = iter.next()
|
||||||
|
bytes = bytes + chunk.size()
|
||||||
|
}
|
||||||
|
|
||||||
|
// Text chunks and lines
|
||||||
|
for (s in Path("/tmp/big.txt").readUtf8Chunks(64_000)) {
|
||||||
|
// process each string chunk
|
||||||
|
}
|
||||||
|
|
||||||
|
for (ln in Path("/tmp/big.txt").lines()) {
|
||||||
|
// process line by line
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
#### API (Lyng class `Path`)
|
||||||
|
|
||||||
|
Constructor:
|
||||||
|
- `Path(path: String)` — creates a Path object
|
||||||
|
- `Paths(path: String)` — alias
|
||||||
|
|
||||||
|
File and directory operations (all suspend under the hood):
|
||||||
|
- `name`: name, `String`
|
||||||
|
- `segments`: list of parsed path segments (directories)
|
||||||
|
- `parent`: parent directory, `Path?`; null if root
|
||||||
|
- `exists(): Bool`
|
||||||
|
- `isFile(): Bool` — true if the path points to a regular file (cached metadata)
|
||||||
|
- `isDirectory(): Bool` — true if the path points to a directory (cached metadata)
|
||||||
|
- `size(): Int?` — size in bytes or null if unknown (cached metadata)
|
||||||
|
- `createdAt(): Instant?` — creation time as Lyng `Instant`, or null (cached metadata)
|
||||||
|
- `createdAtMillis(): Int?` — creation time in epoch milliseconds, or null (cached metadata)
|
||||||
|
- `modifiedAt(): Instant?` — last modification time as Lyng `Instant`, or null (cached metadata)
|
||||||
|
- `modifiedAtMillis(): Int?` — last modification time in epoch milliseconds, or null (cached metadata)
|
||||||
|
- `list(): List<Path>` — children of a directory
|
||||||
|
- `readBytes(): Buffer`
|
||||||
|
- `writeBytes(bytes: Buffer)`
|
||||||
|
- `appendBytes(bytes: Buffer)`
|
||||||
|
- `readUtf8(): String`
|
||||||
|
- `writeUtf8(text: String)`
|
||||||
|
- `appendUtf8(text: String)`
|
||||||
|
- `metadata(): Map` — keys: `isFile`, `isDirectory`, `size`, `createdAtMillis`, `modifiedAtMillis`, `isSymlink`
|
||||||
|
- `mkdirs(mustCreate: Bool = false)`
|
||||||
|
- `move(to: Path|String, overwrite: Bool = false)`
|
||||||
|
- `delete(mustExist: Bool = false, recursively: Bool = false)`
|
||||||
|
- `copy(to: Path|String, overwrite: Bool = false)`
|
||||||
|
- `glob(pattern: String): List<Path>` — supports `**`, `*`, `?` (POSIX-style)
|
||||||
|
|
||||||
|
Streaming readers for big files:
|
||||||
|
- `readChunks(size: Int = 65536): Iterator<Buffer>` — iterate fixed-size byte chunks
|
||||||
|
- `readUtf8Chunks(size: Int = 65536): Iterator<String>` — iterate text chunks by character count
|
||||||
|
- `lines(): Iterator<String>` — line iterator built on `readUtf8Chunks`
|
||||||
|
|
||||||
|
Notes:
|
||||||
|
- Iterators implement Lyng iterator protocol. If you break early from a loop, the runtime will attempt to call `cancelIteration()` when available.
|
||||||
|
- Current implementations chunk in memory. The public API is stable; internals will evolve to true streaming on all platforms.
|
||||||
|
- Attribute accessors (`isFile`, `isDirectory`, `size`, `createdAt*`, `modifiedAt*`) cache a metadata snapshot inside the `Path` instance to avoid repeated filesystem calls during a sequence of queries. `metadata()` remains available for bulk access.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
#### Access policy (security)
|
||||||
|
|
||||||
|
Access control is enforced by `FsAccessPolicy`. You pass a policy at installation time. The module wraps the filesystem with a secured decorator that consults the policy for each primitive operation.
|
||||||
|
|
||||||
|
Main types:
|
||||||
|
- `FsAccessPolicy` — your policy implementation
|
||||||
|
- `PermitAllAccessPolicy` — allows all operations (default for testing)
|
||||||
|
- `AccessOp` (sealed) — operations the policy can decide on:
|
||||||
|
- `ListDir(path)`
|
||||||
|
- `CreateFile(path)`
|
||||||
|
- `OpenRead(path)`
|
||||||
|
- `OpenWrite(path)`
|
||||||
|
- `OpenAppend(path)`
|
||||||
|
- `Delete(path)`
|
||||||
|
- `Rename(from, to)`
|
||||||
|
- `UpdateAttributes(path)` — defaults to write-level semantics
|
||||||
|
|
||||||
|
Minimal denying policy example (imports omitted for brevity):
|
||||||
|
|
||||||
|
```kotlin
|
||||||
|
val denyWrites = object : FsAccessPolicy {
|
||||||
|
override suspend fun check(op: AccessOp, ctx: AccessContext): AccessDecision = when (op) {
|
||||||
|
is AccessOp.OpenRead, is AccessOp.ListDir -> AccessDecision(Decision.Allow)
|
||||||
|
else -> AccessDecision(Decision.Deny, reason = "read-only policy")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
createFs(denyWrites, scope)
|
||||||
|
scope.eval("import lyng.io.fs")
|
||||||
|
```
|
||||||
|
|
||||||
|
Composite operations like `copy` and `move` are checked as a set of primitives (e.g., `OpenRead(src)` + `Delete(dst)` if overwriting + `CreateFile(dst)` + `OpenWrite(dst)`).
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
#### Errors and exceptions
|
||||||
|
|
||||||
|
Policy denials are surfaced as Lyng runtime errors, not raw Kotlin exceptions:
|
||||||
|
- Internally, a denial throws `AccessDeniedException`. The module maps it to `ObjIllegalOperationException` wrapped into an `ExecutionError` visible to scripts.
|
||||||
|
|
||||||
|
Examples (Lyng):
|
||||||
|
|
||||||
|
```lyng
|
||||||
|
import lyng.io.fs
|
||||||
|
val p = Path("/protected/file.txt")
|
||||||
|
try {
|
||||||
|
p.writeUtf8("x")
|
||||||
|
fail("expected error")
|
||||||
|
} catch (e) {
|
||||||
|
// e is an ExecutionError; message contains the policy reason
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
Other I/O failures (e.g., not found, not a directory) are also raised as Lyng errors (`ObjIllegalStateException`, `ObjIllegalArgumentException`, etc.) depending on context.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
#### Platform notes
|
||||||
|
|
||||||
|
- JVM/Android/Native: synchronous Okio calls are executed on `Dispatchers.IO` (JVM/Android) or `Dispatchers.Default` (Native) to avoid blocking the main thread.
|
||||||
|
- NodeJS: currently uses Okio’s Node backend. For heavy I/O, a native `fs/promises` backend is planned to fully avoid event-loop blocking.
|
||||||
|
- Browser/Wasm: uses an in-memory filesystem for now. Persistent backends (IndexedDB or File System Access API) are planned.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
#### Roadmap
|
||||||
|
|
||||||
|
- Native NodeJS backend using `fs/promises`
|
||||||
|
- Browser persistent storage (IndexedDB)
|
||||||
|
- Streaming readers/writers over real OS streams
|
||||||
|
- Attribute setters and richer metadata
|
||||||
|
|
||||||
|
If you have specific needs (e.g., sandboxing, virtual roots), implement a custom `FsAccessPolicy` or ask us to add a helper.
|
||||||
@@ -0,0 +1,141 @@
|
|||||||
|
### Lyng CLI (`lyng`)
|
||||||
|
|
||||||
|
The Lyng CLI is the reference command-line tool for the Lyng language. It lets you:
|
||||||
|
|
||||||
|
- Run Lyng scripts from files or inline strings (shebangs accepted)
|
||||||
|
- Use standard argument passing (`ARGV`) to your scripts.
|
||||||
|
- Format Lyng source files via the built-in `fmt` subcommand.
|
||||||
|
|
||||||
|
|
||||||
|
#### Building on Linux
|
||||||
|
|
||||||
|
Requirements:
|
||||||
|
- JDK 17+ (for Gradle and the JVM distribution)
|
||||||
|
- GNU zip utilities (for packaging the native executable)
|
||||||
|
- upx tool (executable in-place compression)
|
||||||
|
|
||||||
|
The repository provides convenience scripts in `bin/` for local builds and installation into `~/bin`.
|
||||||
|
|
||||||
|
Note: In this repository the scripts are named `bin/local_release` and `bin/local_jrelease`. In some environments these may be aliased as `bin/release` and `bin/jrelease`. The steps below use the actual file names present here.
|
||||||
|
|
||||||
|
|
||||||
|
##### Option A: Native linuxX64 executable (`lyng`)
|
||||||
|
|
||||||
|
1) Build the native binary:
|
||||||
|
|
||||||
|
```
|
||||||
|
./gradlew :lyng:linkReleaseExecutableLinuxX64
|
||||||
|
```
|
||||||
|
|
||||||
|
2) Install and package locally:
|
||||||
|
|
||||||
|
```
|
||||||
|
bin/local_release
|
||||||
|
```
|
||||||
|
|
||||||
|
What this does:
|
||||||
|
- Copies the built executable to `~/bin/lyng` for easy use in your shell.
|
||||||
|
- Produces `distributables/lyng-linuxX64.zip` containing the `lyng` executable.
|
||||||
|
|
||||||
|
|
||||||
|
##### Option B: JVM distribution (`jlyng` launcher)
|
||||||
|
|
||||||
|
This creates a JVM distribution with a launcher script and links it to `~/bin/jlyng`.
|
||||||
|
|
||||||
|
```
|
||||||
|
bin/local_jrelease
|
||||||
|
```
|
||||||
|
|
||||||
|
What this does:
|
||||||
|
- Runs `./gradlew :lyng:installJvmDist` to build the JVM app distribution to `lyng/build/install/lyng-jvm`.
|
||||||
|
- Copies the distribution under `~/bin/jlyng-jvm`.
|
||||||
|
- Creates a symlink `~/bin/jlyng` pointing to the launcher script.
|
||||||
|
|
||||||
|
|
||||||
|
#### Usage
|
||||||
|
|
||||||
|
Once installed, ensure `~/bin` is on your `PATH`. You can then use either the native `lyng` or the JVM `jlyng` launcher (both have the same CLI surface).
|
||||||
|
|
||||||
|
|
||||||
|
##### Running scripts
|
||||||
|
|
||||||
|
- Run a script by file name and pass arguments to `ARGV`:
|
||||||
|
|
||||||
|
```
|
||||||
|
lyng path/to/script.lyng arg1 arg2
|
||||||
|
```
|
||||||
|
|
||||||
|
- Run a script whose name starts with `-` using `--` to stop option parsing:
|
||||||
|
|
||||||
|
```
|
||||||
|
lyng -- -my-script.lyng arg1 arg2
|
||||||
|
```
|
||||||
|
|
||||||
|
- Execute inline code with `-x/--execute` and pass positional args to `ARGV`:
|
||||||
|
|
||||||
|
```
|
||||||
|
lyng -x "println(\"Hello\")" more args
|
||||||
|
```
|
||||||
|
|
||||||
|
- Print version/help:
|
||||||
|
|
||||||
|
```
|
||||||
|
lyng --version
|
||||||
|
lyng --help
|
||||||
|
```
|
||||||
|
|
||||||
|
### Use in shell scripts
|
||||||
|
|
||||||
|
Standard unix shebangs (`#!`) are supported, so you can make Lyng scripts directly executable on Unix-like systems. For example:
|
||||||
|
|
||||||
|
#!/usr/bin/env lyng
|
||||||
|
println("Hello, world!")
|
||||||
|
|
||||||
|
|
||||||
|
##### Formatting source: `fmt` subcommand
|
||||||
|
|
||||||
|
Format Lyng files with the built-in formatter.
|
||||||
|
|
||||||
|
Basic usage:
|
||||||
|
|
||||||
|
```
|
||||||
|
lyng fmt [OPTIONS] FILE...
|
||||||
|
```
|
||||||
|
|
||||||
|
Options:
|
||||||
|
- `--check` — Check-only mode. Prints file paths that would change and exits with code 2 if any changes are needed, 0 otherwise.
|
||||||
|
- `-i, --in-place` — Write formatted content back to the source files (off by default).
|
||||||
|
- `--spacing` — Apply spacing normalization.
|
||||||
|
- `--wrap`, `--wrapping` — Enable line wrapping.
|
||||||
|
|
||||||
|
Semantics and exit codes:
|
||||||
|
- Default behavior is to write formatted content to stdout. When multiple files are provided, the output is separated with `--- <path> ---` headers.
|
||||||
|
- `--check` and `--in-place` are mutually exclusive; using both results in an error and exit code 1.
|
||||||
|
- `--check` exits with 2 if any file would change, with 0 otherwise.
|
||||||
|
- Other errors (e.g., I/O issues) result in a non-zero exit code.
|
||||||
|
|
||||||
|
Examples:
|
||||||
|
|
||||||
|
```
|
||||||
|
# Print formatted content to stdout
|
||||||
|
lyng fmt src/file.lyng
|
||||||
|
|
||||||
|
# Format multiple files to stdout with headers
|
||||||
|
lyng fmt src/a.lyng src/b.lyng
|
||||||
|
|
||||||
|
# Check mode: list files that would change; exit 2 if changes are needed
|
||||||
|
lyng fmt --check src/**/*.lyng
|
||||||
|
|
||||||
|
# In-place formatting
|
||||||
|
lyng fmt -i src/**/*.lyng
|
||||||
|
|
||||||
|
# Enable spacing normalization and wrapping
|
||||||
|
lyng fmt --spacing --wrap src/file.lyng
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
#### Notes
|
||||||
|
|
||||||
|
- Both native and JVM distributions expose the same CLI interface. Use whichever best fits your environment.
|
||||||
|
- When executing scripts, all positional arguments after the script name are available in Lyng as `ARGV`.
|
||||||
|
- The interpreter recognizes shebang lines (`#!`) at the beginning of a script file and ignores them at runtime, so you can make Lyng scripts directly executable on Unix-like systems.
|
||||||
@@ -0,0 +1,25 @@
|
|||||||
|
# Migration of Instant and Clock
|
||||||
|
|
||||||
|
## History
|
||||||
|
|
||||||
|
Before kotlin 2.0, there was an excellent library, kotlinx.datetime, which was widely used everywhere, also in Lyng and its dependencies.
|
||||||
|
|
||||||
|
When kotlin 2.0 was released, or soon after, JetBrains made an exptic decision to remove `Instant` and `Clock` from kotlinx.datetime and replace it with _yet experimental_ analogs in `kotlin.time`.
|
||||||
|
|
||||||
|
The problem is, these were not quite the same (these weren't `@Serializable`!), so people didn't migrate with ease. Okay, then JetBrains decided to not only deprecate it but also make them unusable on Apple targets. It sort of split auditories of many published libraries to those who hate JetBrains and Apple and continue to use 1.9-2.0 compatible versions that no longer work with Kotlin 2.2 on Apple targets (but work pretty well with earlier Kotlin or on other platforms).
|
||||||
|
|
||||||
|
Later JetBrains added serializers for their new `Instant` and `Clock` types, but strangely not in the stdlib, but in newer versions of `kotlinx.serialization`. This means that plain upgrade of dependencies to 2.2 is not enough to make them work.
|
||||||
|
|
||||||
|
## Solution
|
||||||
|
|
||||||
|
We hereby publish a new version of Lyng, 1.0.8-SNAPSHOT, which uses `ktlin.time.Instant` and `kotlin.time.Clock` instead of `kotlinx.datetime.Instant` and `kotlinx.datetime.Clock; it is in other aspects compatible also with Lynon encoded binaries. Still you might need to migrate your code to use `kotlinx.datetime` types.
|
||||||
|
|
||||||
|
So, if you are getting errors with new version, plase do:
|
||||||
|
|
||||||
|
- upgrade to Kotlin 2.2
|
||||||
|
- upgrade to Lyng 1.0.8-SNAPSHOT
|
||||||
|
- replace in your code imports (or other uses) of`kotlinx.datetime.Clock` to `kotlin.time.Clock` and `kotlinx.datetime.Instant` to `kotlin.time.Instant`.
|
||||||
|
|
||||||
|
This should solve the problem and hopefully we'll see no more suh a brillant ideas from IDEA ideologspersons.
|
||||||
|
|
||||||
|
Sorry for inconvenicence and send a ray of hate to JetBrains ;)
|
||||||
+22
-1
@@ -1,4 +1,6 @@
|
|||||||
# Parallelism in Lyng
|
# Multithreading/parallel execution
|
||||||
|
|
||||||
|
[//]: # (topMenu)
|
||||||
|
|
||||||
Lyng is built to me multithreaded where possible (e.g. all targets byt JS and wasmJS as for now)
|
Lyng is built to me multithreaded where possible (e.g. all targets byt JS and wasmJS as for now)
|
||||||
and cooperatively parallel (coroutine based) everywhere.
|
and cooperatively parallel (coroutine based) everywhere.
|
||||||
@@ -219,3 +221,22 @@ Lyng includes an optional optimization for function/method calls on JVM: scope f
|
|||||||
- Expected effect (from our JVM micro‑benchmarks): in deep call loops, enabling pooling reduced total time by about 1.38× in a dedicated pooling benchmark; mileage may vary depending on workload.
|
- Expected effect (from our JVM micro‑benchmarks): in deep call loops, enabling pooling reduced total time by about 1.38× in a dedicated pooling benchmark; mileage may vary depending on workload.
|
||||||
|
|
||||||
Future work: introduce thread‑safe pooling (e.g., per‑thread pools or confinement strategies) before considering enabling it by default in multi‑threaded environments.
|
Future work: introduce thread‑safe pooling (e.g., per‑thread pools or confinement strategies) before considering enabling it by default in multi‑threaded environments.
|
||||||
|
|
||||||
|
### Closures inside coroutine helpers (launch/flow)
|
||||||
|
|
||||||
|
Closures executed by `launch { ... }` and `flow { ... }` resolve names using the `ClosureScope` rules:
|
||||||
|
|
||||||
|
1. Closure frame locals/arguments
|
||||||
|
2. Captured receiver instance/class members
|
||||||
|
3. Closure ancestry locals + each frame’s `this` members (cycle‑safe)
|
||||||
|
4. Caller `this` members
|
||||||
|
5. Caller ancestry locals + each frame’s `this` members (cycle‑safe)
|
||||||
|
6. Module pseudo‑symbols (e.g., `__PACKAGE__`)
|
||||||
|
7. Direct module/global fallback (nearest `ModuleScope` and its parent/root)
|
||||||
|
|
||||||
|
Implications:
|
||||||
|
- Outer locals (e.g., `counter`) stay visible across suspension points.
|
||||||
|
- Global helpers like `delay(ms)` and `yield()` are available from inside closures.
|
||||||
|
- If you write your own async helpers, execute user lambdas under `ClosureScope(callScope, capturedCreatorScope)` and avoid manual ancestry walking.
|
||||||
|
|
||||||
|
See also: [Scopes and Closures: resolution and safety](scopes_and_closures.md)
|
||||||
@@ -1,6 +1,8 @@
|
|||||||
|
|
||||||
# Map literals — refined proposal
|
# Map literals — refined proposal
|
||||||
|
|
||||||
|
[//]: # (excludeFromIndex)
|
||||||
|
|
||||||
Implement JavaScript-like literals for maps. The syntax and semantics align with named arguments in function calls, but map literals are expressions that construct `Map` values.
|
Implement JavaScript-like literals for maps. The syntax and semantics align with named arguments in function calls, but map literals are expressions that construct `Map` values.
|
||||||
|
|
||||||
Keys can be either:
|
Keys can be either:
|
||||||
|
|||||||
@@ -1,4 +1,7 @@
|
|||||||
# Named arguments proposal
|
# Named arguments in calls
|
||||||
|
|
||||||
|
[//]: # (excludeFromIndex)
|
||||||
|
|
||||||
|
|
||||||
Extend function/method calls to allow setting arguments by name using colon syntax at call sites. This is especially convenient with many parameters and default values.
|
Extend function/method calls to allow setting arguments by name using colon syntax at call sites. This is especially convenient with many parameters and default values.
|
||||||
|
|
||||||
|
|||||||
Executable
+25
@@ -0,0 +1,25 @@
|
|||||||
|
#!/bin/env lyng
|
||||||
|
|
||||||
|
import lyng.io.fs
|
||||||
|
import lyng.stdlib
|
||||||
|
|
||||||
|
val files = Path("../..").list().toList()
|
||||||
|
// most long is longest?
|
||||||
|
val longestNameLength = files.maxOf { it.name.length }
|
||||||
|
|
||||||
|
// testdoc
|
||||||
|
fun test() {
|
||||||
|
22
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
val format = "%"+(longestNameLength+1) +"s %d"
|
||||||
|
for( f in files )
|
||||||
|
{
|
||||||
|
var name = f.name
|
||||||
|
if( f.isDirectory() )
|
||||||
|
name += "/"
|
||||||
|
println( format(name, f.size()) )
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
Executable
+10
@@ -0,0 +1,10 @@
|
|||||||
|
#!/bin/env lyng
|
||||||
|
|
||||||
|
val переменная = "значение"
|
||||||
|
|
||||||
|
val data = { greeting: "привет", переменная:, поле: "содержимое" }
|
||||||
|
|
||||||
|
assertEquals(data["переменная"], "значение")
|
||||||
|
assertEquals(data["поле"], "содержимое")
|
||||||
|
|
||||||
|
println(data)
|
||||||
@@ -0,0 +1,95 @@
|
|||||||
|
# Scopes and Closures: resolution and safety
|
||||||
|
|
||||||
|
This page documents how name resolution works with `ClosureScope`, how to avoid recursion pitfalls, and how to safely capture and execute callbacks that need access to outer locals.
|
||||||
|
|
||||||
|
## Why this matters
|
||||||
|
Name lookup across nested scopes and closures can accidentally form recursive resolution paths or hide expected symbols (outer locals, module/global functions). The rules below ensure predictable resolution and prevent infinite recursion.
|
||||||
|
|
||||||
|
## Resolution order in ClosureScope
|
||||||
|
When evaluating an identifier `name` inside a closure, `ClosureScope.get(name)` resolves in this order:
|
||||||
|
|
||||||
|
1. Closure frame locals and arguments
|
||||||
|
2. Captured receiver (`closureScope.thisObj`) instance/class members
|
||||||
|
3. Closure ancestry locals + each frame’s `thisObj` members (cycle‑safe)
|
||||||
|
4. Caller `this` members
|
||||||
|
5. Caller ancestry locals + each frame’s `thisObj` members (cycle‑safe)
|
||||||
|
6. Module pseudo‑symbols (e.g., `__PACKAGE__`) from the nearest `ModuleScope`
|
||||||
|
7. Direct module/global fallback (nearest `ModuleScope` and its parent/root scope)
|
||||||
|
8. Final fallback: base local/parent lookup for the current frame
|
||||||
|
|
||||||
|
This preserves intuitive visibility (locals → captured receiver → closure chain → caller members → caller chain → module/root) while preventing infinite recursion between scope types.
|
||||||
|
|
||||||
|
## Use raw‑chain helpers for ancestry walks
|
||||||
|
When authoring new scope types or advanced lookups, avoid calling virtual `get` while walking parents. Instead, use the non‑dispatch helpers on `Scope`:
|
||||||
|
|
||||||
|
- `chainLookupIgnoreClosure(name)`
|
||||||
|
- Walk raw `parent` chain and check only per‑frame locals/bindings/slots.
|
||||||
|
- Ignores overridden `get` (e.g., in `ClosureScope`). Cycle‑safe.
|
||||||
|
- `chainLookupWithMembers(name)`
|
||||||
|
- Like above, but after locals/bindings it also checks each frame’s `thisObj` members.
|
||||||
|
- Ignores overridden `get`. Cycle‑safe.
|
||||||
|
- `baseGetIgnoreClosure(name)`
|
||||||
|
- For the current frame only: check locals/bindings, then walk raw parents (locals/bindings), then fallback to this frame’s `thisObj` members.
|
||||||
|
|
||||||
|
These helpers avoid ping‑pong recursion and make structural cycles harmless (lookups terminate).
|
||||||
|
|
||||||
|
## Preventing structural cycles
|
||||||
|
- Don’t construct parent chains that can point back to a descendant.
|
||||||
|
- A debug‑time guard throws if assigning a parent would create a cycle; keep it enabled for development builds.
|
||||||
|
- Even with a cycle, chain helpers break out via a small `visited` set keyed by `frameId`.
|
||||||
|
|
||||||
|
## Capturing lexical environments for callbacks
|
||||||
|
For dynamic objects or custom builders, capture the creator’s lexical scope so callbacks can see outer locals/parameters:
|
||||||
|
|
||||||
|
1. Use `snapshotForClosure()` on the caller scope to capture locals/bindings/slots and parent.
|
||||||
|
2. Store this snapshot and run callbacks under `ClosureScope(callScope, captured)`.
|
||||||
|
|
||||||
|
Kotlin sketch:
|
||||||
|
```kotlin
|
||||||
|
val captured = scope.snapshotForClosure()
|
||||||
|
val execScope = ClosureScope(currentCallScope, captured)
|
||||||
|
callback.execute(execScope)
|
||||||
|
```
|
||||||
|
|
||||||
|
This ensures expressions like `contractName` used inside dynamic `get { name -> ... }` resolve to outer variables defined at the creation site.
|
||||||
|
|
||||||
|
## Closures in coroutines (launch/flow)
|
||||||
|
- The closure frame still prioritizes its own locals/args.
|
||||||
|
- Outer locals declared before suspension points remain visible through slot‑aware ancestry lookups.
|
||||||
|
- Global functions like `delay(ms)` and `yield()` are resolved via module/root fallbacks from within closures.
|
||||||
|
|
||||||
|
Tip: If a closure unexpectedly cannot see an outer local, check whether an intermediate runtime helper introduced an extra call frame; the built‑in lookup already traverses caller ancestry, so prefer the standard helpers rather than custom dispatch.
|
||||||
|
|
||||||
|
## Local variable references and missing symbols
|
||||||
|
- Unqualified identifier resolution first prefers locals/bindings/slots before falling back to `this` members.
|
||||||
|
- If neither locals nor members contain the symbol, missing field lookups map to `SymbolNotFound` (compatibility alias for `SymbolNotDefinedException`).
|
||||||
|
|
||||||
|
## Performance notes
|
||||||
|
- The `visited` sets used for cycle detection are tiny and short‑lived; in typical scripts the overhead is negligible.
|
||||||
|
- If profiling shows hotspots, consider limiting ancestry depth in your custom helpers or using small fixed arrays instead of hash sets—only for extremely hot code paths.
|
||||||
|
|
||||||
|
## Practical Example: `cached`
|
||||||
|
|
||||||
|
The `cached` function (defined in `lyng.stdlib`) is a classic example of using closures to maintain state. It wraps a builder into a zero-argument function that computes once and remembers the result:
|
||||||
|
|
||||||
|
```lyng
|
||||||
|
fun cached(builder) {
|
||||||
|
var calculated = false
|
||||||
|
var value = null
|
||||||
|
{ // This lambda captures `calculated`, `value`, and `builder`
|
||||||
|
if( !calculated ) {
|
||||||
|
value = builder()
|
||||||
|
calculated = true
|
||||||
|
}
|
||||||
|
value
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
Because Lyng now correctly isolates closures for each evaluation of a lambda literal, using `cached` inside a class instance works as expected: each instance maintains its own private `calculated` and `value` state, even if they share the same property declaration.
|
||||||
|
|
||||||
|
## Dos and Don’ts
|
||||||
|
- Do use `chainLookupIgnoreClosure` / `chainLookupWithMembers` for ancestry traversals.
|
||||||
|
- Do maintain the resolution order above for predictable behavior.
|
||||||
|
- Don’t call virtual `get` while walking parents; it risks recursion across scope types.
|
||||||
|
- Don’t attach instance scopes to transient/pool frames; bind to a stable parent scope instead.
|
||||||
@@ -0,0 +1,77 @@
|
|||||||
|
# TextMate bundle
|
||||||
|
|
||||||
|
[//]: # (excludeFromIndex)
|
||||||
|
|
||||||
|
The TextMate-format bundle contains a syntax definition for initial language support in
|
||||||
|
popular editors that understand TextMate grammars: TextMate, Visual Studio Code, Sublime Text, etc.
|
||||||
|
|
||||||
|
- [Download TextMate Bundle for Lyng](https://lynglang.com/distributables/lyng-textmate.zip)
|
||||||
|
|
||||||
|
> Note for IntelliJ-based IDEs (IntelliJ IDEA, Fleet, etc.): although you can import TextMate
|
||||||
|
> bundles there (Settings/Preferences → Editor → TextMate Bundles), we strongly recommend using the
|
||||||
|
> dedicated plugin instead — it provides much better support (formatting, smart enter, background
|
||||||
|
> analysis, etc.). See: [IDEA Plugin](#/docs/idea_plugin.md).
|
||||||
|
|
||||||
|
## Visual Studio Code
|
||||||
|
|
||||||
|
VS Code uses TextMate grammars packaged as extensions. A minimal local extension is easy to set up:
|
||||||
|
|
||||||
|
1) Download and unzip the bundle above. Inside you will find the grammar file (usually
|
||||||
|
`*.tmLanguage.json` or `*.tmLanguage` plist).
|
||||||
|
2) Create a new folder somewhere, e.g. `lyng-textmate-vscode/` with the following structure:
|
||||||
|
|
||||||
|
```
|
||||||
|
lyng-textmate-vscode/
|
||||||
|
package.json
|
||||||
|
syntaxes/
|
||||||
|
lyng.tmLanguage.json # copy the grammar file here (rename if needed)
|
||||||
|
```
|
||||||
|
|
||||||
|
3) Put this minimal `package.json` into that folder (adjust file names if needed):
|
||||||
|
|
||||||
|
```
|
||||||
|
{
|
||||||
|
"name": "lyng-textmate",
|
||||||
|
"displayName": "Lyng (TextMate grammar)",
|
||||||
|
"publisher": "local",
|
||||||
|
"version": "0.0.1",
|
||||||
|
"engines": { "vscode": "^1.70.0" },
|
||||||
|
"contributes": {
|
||||||
|
"languages": [
|
||||||
|
{ "id": "lyng", "aliases": ["Lyng"], "extensions": [".lyng"] }
|
||||||
|
],
|
||||||
|
"grammars": [
|
||||||
|
{
|
||||||
|
"language": "lyng",
|
||||||
|
"scopeName": "source.lyng",
|
||||||
|
"path": "./syntaxes/lyng.tmLanguage.json"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
4) Open a terminal in `lyng-textmate-vscode/` and run:
|
||||||
|
|
||||||
|
```
|
||||||
|
code --install-extension .
|
||||||
|
```
|
||||||
|
|
||||||
|
Alternatively, open the folder in VS Code and press F5 to run an Extension Development Host.
|
||||||
|
5) Reload VS Code. Files with the `.lyng` extension should now get Lyng highlighting.
|
||||||
|
|
||||||
|
## Sublime Text 3/4
|
||||||
|
|
||||||
|
1) Download and unzip the bundle.
|
||||||
|
2) In Sublime Text, use “Preferences → Browse Packages…”, then copy the unzipped bundle
|
||||||
|
to a folder like `Packages/Lyng/`.
|
||||||
|
3) Open a `.lyng` file; Sublime should pick up the syntax automatically. If not, use
|
||||||
|
“View → Syntax → Lyng”.
|
||||||
|
|
||||||
|
## TextMate 2
|
||||||
|
|
||||||
|
1) Download and unzip the bundle.
|
||||||
|
2) Double‑click the `.tmBundle`/grammar package or drag it onto TextMate to install, or place
|
||||||
|
it into `~/Library/Application Support/TextMate/Bundles/`.
|
||||||
|
3) Restart TextMate if needed and open a `.lyng` file.
|
||||||
|
|
||||||
+172
-11
@@ -6,9 +6,10 @@ In other word, the code usually works as expected when you see it. So, nothing u
|
|||||||
|
|
||||||
__Other documents to read__ maybe after this one:
|
__Other documents to read__ maybe after this one:
|
||||||
|
|
||||||
- [Advanced topics](advanced_topics.md), [declaring arguments](declaring_arguments.md)
|
- [Advanced topics](advanced_topics.md), [declaring arguments](declaring_arguments.md), [Scopes and Closures](scopes_and_closures.md)
|
||||||
- [OOP notes](OOP.md), [exception handling](exceptions_handling.md)
|
- [OOP notes](OOP.md), [exception handling](exceptions_handling.md)
|
||||||
- [math in Lyng](math.md), [the `when` statement](when.md)
|
- [math in Lyng](math.md), [the `when` statement](when.md)
|
||||||
|
- [Testing and Assertions](Testing.md)
|
||||||
- [time](time.md) and [parallelism](parallelism.md)
|
- [time](time.md) and [parallelism](parallelism.md)
|
||||||
- [parallelism] - multithreaded code, coroutines, etc.
|
- [parallelism] - multithreaded code, coroutines, etc.
|
||||||
- Some class
|
- Some class
|
||||||
@@ -66,6 +67,47 @@ You can use blocks in if statement, as expected:
|
|||||||
limited
|
limited
|
||||||
>>> 120.0
|
>>> 120.0
|
||||||
|
|
||||||
|
## Enums (quick intro)
|
||||||
|
|
||||||
|
Lyng supports simple enums for a fixed set of named constants. Declare with `enum Name { ... }` and use entries as `Name.ENTRY`.
|
||||||
|
|
||||||
|
enum Color {
|
||||||
|
RED, GREEN, BLUE
|
||||||
|
}
|
||||||
|
|
||||||
|
assert( Color.RED is Color )
|
||||||
|
assertEquals( 0, Color.RED.ordinal )
|
||||||
|
assertEquals( "BLUE", Color.BLUE.name )
|
||||||
|
|
||||||
|
// All entries as a list, in order:
|
||||||
|
assertEquals( [Color.RED, Color.GREEN, Color.BLUE], Color.entries )
|
||||||
|
|
||||||
|
// Lookup by name:
|
||||||
|
assertEquals( Color.GREEN, Color.valueOf("GREEN") )
|
||||||
|
|
||||||
|
For more details (usage patterns, `when` switching, serialization), see OOP notes: [Enums in detail](OOP.md#enums).
|
||||||
|
|
||||||
|
## Singleton Objects
|
||||||
|
|
||||||
|
Singleton objects are declared using the `object` keyword. They define a class and create its single instance immediately.
|
||||||
|
|
||||||
|
object Logger {
|
||||||
|
fun log(msg) { println("[LOG] " + msg) }
|
||||||
|
}
|
||||||
|
|
||||||
|
Logger.log("Hello singleton!")
|
||||||
|
|
||||||
|
## Delegation (briefly)
|
||||||
|
|
||||||
|
You can delegate properties and functions to other objects using the `by` keyword. This is perfect for patterns like `lazy` initialization.
|
||||||
|
|
||||||
|
val expensiveData by lazy {
|
||||||
|
// computed only once on demand
|
||||||
|
"computed"
|
||||||
|
}
|
||||||
|
|
||||||
|
For more details on these features, see [Delegation in Lyng](delegation.md) and [OOP notes](OOP.md).
|
||||||
|
|
||||||
When putting multiple statments in the same line it is convenient and recommended to use `;`:
|
When putting multiple statments in the same line it is convenient and recommended to use `;`:
|
||||||
|
|
||||||
var from; var to
|
var from; var to
|
||||||
@@ -86,6 +128,41 @@ Assignemnt is an expression that changes its lvalue and return assigned value:
|
|||||||
>>> 11
|
>>> 11
|
||||||
>>> 6
|
>>> 6
|
||||||
|
|
||||||
|
### Destructuring assignments
|
||||||
|
|
||||||
|
Lyng supports destructuring assignments for lists. This allows you to unpack list elements into multiple variables at once:
|
||||||
|
|
||||||
|
val [a, b, c] = [1, 2, 3]
|
||||||
|
assertEquals(1, a)
|
||||||
|
assertEquals(2, b)
|
||||||
|
assertEquals(3, c)
|
||||||
|
|
||||||
|
It also supports *splats* (ellipsis) to capture multiple elements into a list:
|
||||||
|
|
||||||
|
val [head, rest...] = [1, 2, 3]
|
||||||
|
assertEquals(1, head)
|
||||||
|
assertEquals([2, 3], rest)
|
||||||
|
|
||||||
|
val [first, middle..., last] = [1, 2, 3, 4, 5]
|
||||||
|
assertEquals(1, first)
|
||||||
|
assertEquals([2, 3, 4], middle)
|
||||||
|
assertEquals(5, last)
|
||||||
|
|
||||||
|
Destructuring can be nested:
|
||||||
|
|
||||||
|
val [x, [y, z...]] = [1, [2, 3, 4]]
|
||||||
|
assertEquals(1, x)
|
||||||
|
assertEquals(2, y)
|
||||||
|
assertEquals([3, 4], z)
|
||||||
|
|
||||||
|
And it can be used for reassigning existing variables, for example, to swap values:
|
||||||
|
|
||||||
|
var x = 5
|
||||||
|
var y = 10
|
||||||
|
[x, y] = [y, x]
|
||||||
|
assertEquals(10, x)
|
||||||
|
assertEquals(5, y)
|
||||||
|
|
||||||
As the assignment itself is an expression, you can use it in strange ways. Just remember
|
As the assignment itself is an expression, you can use it in strange ways. Just remember
|
||||||
to use parentheses as assignment operation insofar is left-associated and will not
|
to use parentheses as assignment operation insofar is left-associated and will not
|
||||||
allow chained assignments (we might fix it later). Use parentheses insofar:
|
allow chained assignments (we might fix it later). Use parentheses insofar:
|
||||||
@@ -205,7 +282,7 @@ Much like let, but it does not alter returned value:
|
|||||||
>>> void
|
>>> void
|
||||||
|
|
||||||
While it is not altering return value, the source object could be changed:
|
While it is not altering return value, the source object could be changed:
|
||||||
|
also
|
||||||
class Point(x,y)
|
class Point(x,y)
|
||||||
val p = Point(1,2).also { it.x++ }
|
val p = Point(1,2).also { it.x++ }
|
||||||
assertEquals(p.x, 2)
|
assertEquals(p.x, 2)
|
||||||
@@ -291,8 +368,6 @@ Reference quality and object equality example:
|
|||||||
assert( null == null) // singletons
|
assert( null == null) // singletons
|
||||||
assert( null === null)
|
assert( null === null)
|
||||||
// but, for non-singletons:
|
// but, for non-singletons:
|
||||||
assert( 5 == 5)
|
|
||||||
assert( 5 !== 5)
|
|
||||||
assert( "foo" !== "foo" )
|
assert( "foo" !== "foo" )
|
||||||
>>> void
|
>>> void
|
||||||
|
|
||||||
@@ -309,7 +384,7 @@ will be thrown:
|
|||||||
// WRONG! Exception will be thrown at next line:
|
// WRONG! Exception will be thrown at next line:
|
||||||
foo + "bar"
|
foo + "bar"
|
||||||
|
|
||||||
Correct pattern is:
|
The correct pattern is:
|
||||||
|
|
||||||
foo = "foo"
|
foo = "foo"
|
||||||
// now is OK:
|
// now is OK:
|
||||||
@@ -383,6 +458,19 @@ It is possible to define also vararg using ellipsis:
|
|||||||
|
|
||||||
See the [arguments reference](declaring_arguments.md) for more details.
|
See the [arguments reference](declaring_arguments.md) for more details.
|
||||||
|
|
||||||
|
## Named arguments
|
||||||
|
|
||||||
|
When calling functions, you can use named arguments with the colon syntax `name: value`. This is particularly useful when you have many parameters with default values.
|
||||||
|
|
||||||
|
```lyng
|
||||||
|
fun test(a="foo", b="bar", c="bazz") { [a, b, c] }
|
||||||
|
|
||||||
|
assertEquals(["foo", "b", "bazz"], test(b: "b"))
|
||||||
|
assertEquals(["a", "bar", "c"], test("a", c: "c"))
|
||||||
|
```
|
||||||
|
|
||||||
|
**Note for Kotlin users:** Lyng uses `:` instead of `=` for named arguments at call sites. This is because in Lyng, `=` is an expression that returns the assigned value, and using it in an argument list would create ambiguity.
|
||||||
|
|
||||||
## Closures
|
## Closures
|
||||||
|
|
||||||
Each __block has an isolated context that can be accessed from closures__. For example:
|
Each __block has an isolated context that can be accessed from closures__. For example:
|
||||||
@@ -458,6 +546,8 @@ one could be with ellipsis that means "the rest pf arguments as List":
|
|||||||
|
|
||||||
### Using lambda as the parameter
|
### Using lambda as the parameter
|
||||||
|
|
||||||
|
See also: [Testing and Assertions](Testing.md)
|
||||||
|
|
||||||
// note that fun returns its last calculated value,
|
// note that fun returns its last calculated value,
|
||||||
// in our case, result after in-place addition:
|
// in our case, result after in-place addition:
|
||||||
fun mapValues(iterable, transform) {
|
fun mapValues(iterable, transform) {
|
||||||
@@ -1359,12 +1449,13 @@ Part match:
|
|||||||
Typical set of String functions includes:
|
Typical set of String functions includes:
|
||||||
|
|
||||||
| fun/prop | description / notes |
|
| fun/prop | description / notes |
|
||||||
|--------------------|------------------------------------------------------------|
|
|----------------------|------------------------------------------------------------|
|
||||||
| lower() | change case to unicode upper |
|
| lower(), lowercase() | change case to unicode upper |
|
||||||
| upper() | change case to unicode lower |
|
| upper(), uppercase() | change case to unicode lower |
|
||||||
| trim() | trim space chars from both ends |
|
| trim() | trim space chars from both ends |
|
||||||
| startsWith(prefix) | true if starts with a prefix |
|
| startsWith(prefix) | true if starts with a prefix |
|
||||||
| endsWith(prefix) | true if ends with a prefix |
|
| endsWith(prefix) | true if ends with a prefix |
|
||||||
|
| last() | get last character of a string or throw |
|
||||||
| take(n) | get a new string from up to n first characters |
|
| take(n) | get a new string from up to n first characters |
|
||||||
| takeLast(n) | get a new string from up to n last characters |
|
| takeLast(n) | get a new string from up to n last characters |
|
||||||
| drop(n) | get a new string dropping n first chars, or empty string |
|
| drop(n) | get a new string dropping n first chars, or empty string |
|
||||||
@@ -1427,7 +1518,7 @@ See [math functions](math.md). Other general purpose functions are:
|
|||||||
| print(args...) | Open for overriding, it prints to stdout without newline. |
|
| print(args...) | Open for overriding, it prints to stdout without newline. |
|
||||||
| flow {} | create flow sequence, see [parallelism] |
|
| flow {} | create flow sequence, see [parallelism] |
|
||||||
| delay, launch, yield | see [parallelism] |
|
| delay, launch, yield | see [parallelism] |
|
||||||
| cached(builder) | remembers builder() on first invocation and return it then |
|
| cached(builder) | [Lazy evaluation with `cached`](#lazy-evaluation-with-cached) |
|
||||||
| let, also, apply, run | see above, flow controls |
|
| let, also, apply, run | see above, flow controls |
|
||||||
|
|
||||||
(1)
|
(1)
|
||||||
@@ -1445,6 +1536,8 @@ Lambda avoid unnecessary execution if assertion is not failed. for example:
|
|||||||
|
|
||||||
[List]: List.md
|
[List]: List.md
|
||||||
|
|
||||||
|
[Testing]: Testing.md
|
||||||
|
|
||||||
[Iterable]: Iterable.md
|
[Iterable]: Iterable.md
|
||||||
|
|
||||||
[Iterator]: Iterator.md
|
[Iterator]: Iterator.md
|
||||||
@@ -1473,6 +1566,50 @@ Lambda avoid unnecessary execution if assertion is not failed. for example:
|
|||||||
|
|
||||||
[Regex]: Regex.md
|
[Regex]: Regex.md
|
||||||
|
|
||||||
|
## Lazy evaluation with `cached`
|
||||||
|
|
||||||
|
Sometimes you have an expensive computation that you only want to perform if and when it is actually needed, and then remember (cache) the result for all future calls. Lyng provides the `cached(builder)` function for this purpose.
|
||||||
|
|
||||||
|
It is extremely simple to use: you pass it a block (lambda) that performs the computation, and it returns a zero-argument function that manages the caching for you.
|
||||||
|
|
||||||
|
### Basic Example
|
||||||
|
|
||||||
|
```lyng
|
||||||
|
val expensive = cached {
|
||||||
|
println("Performing expensive calculation...")
|
||||||
|
2 + 2
|
||||||
|
}
|
||||||
|
|
||||||
|
println(expensive()) // Prints "Performing expensive calculation...") then "4"
|
||||||
|
println(expensive()) // Prints only "4" (result is cached)
|
||||||
|
```
|
||||||
|
|
||||||
|
### Benefits and Simplicity
|
||||||
|
|
||||||
|
1. **Lazy Execution:** The code inside the `cached` block doesn't run until you actually call the resulting function.
|
||||||
|
2. **Automatic State Management:** You don't need to manually check if a value has been computed or store it in a separate variable.
|
||||||
|
3. **Closures and Class Support:** `cached` works perfectly with closures. If you use it inside a class, it will correctly capture the instance variables, and each instance will have its own independent cache.
|
||||||
|
|
||||||
|
### Use Case: Lazy Properties in Classes
|
||||||
|
|
||||||
|
This is the most common use case for `cached`. It allows you to define expensive "fields" that are only computed if someone actually uses them:
|
||||||
|
|
||||||
|
```lyng
|
||||||
|
class User(val id: Int) {
|
||||||
|
// The details will be fetched only once, on demand
|
||||||
|
val details = cached {
|
||||||
|
println("Fetching details for user " + id)
|
||||||
|
// Db.query is a hypothetical example
|
||||||
|
Db.query("SELECT * FROM users WHERE id = " + id)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
val u = User(101)
|
||||||
|
// ... nothing happens yet ...
|
||||||
|
val d = u.details() // Computation happens here
|
||||||
|
val sameD = u.details() // Returns the same result immediately
|
||||||
|
```
|
||||||
|
|
||||||
## Multiple Inheritance (quick start)
|
## Multiple Inheritance (quick start)
|
||||||
|
|
||||||
Lyng supports multiple inheritance (MI) with simple, predictable rules. For a full reference see OOP notes, this is a quick, copy‑paste friendly overview.
|
Lyng supports multiple inheritance (MI) with simple, predictable rules. For a full reference see OOP notes, this is a quick, copy‑paste friendly overview.
|
||||||
@@ -1533,7 +1670,31 @@ assertEquals(null, (buzz as? Foo)?.runA())
|
|||||||
|
|
||||||
Notes:
|
Notes:
|
||||||
- Resolution order uses C3 MRO (active): deterministic, monotonic order suitable for diamonds and complex hierarchies. Example: for `class D() : B(), C()` where both `B()` and `C()` derive from `A()`, the C3 order is `D → B → C → A`. The first visible match wins.
|
- Resolution order uses C3 MRO (active): deterministic, monotonic order suitable for diamonds and complex hierarchies. Example: for `class D() : B(), C()` where both `B()` and `C()` derive from `A()`, the C3 order is `D → B → C → A`. The first visible match wins.
|
||||||
- `private` is visible only inside the declaring class; `protected` is visible from the declaring class and any of its transitive subclasses. Qualification (`this@Type`) or casts do not bypass visibility.
|
- `private` is visible only inside the declaring class; `protected` is visible from the declaring class and any of its transitive subclasses. Qualialsofication (`this@Type`) or casts do not bypass visibility.
|
||||||
- Safe‑call `?.` works with `as?` for optional dispatch.
|
- Safe‑call `?.` works with `as?` for optional dispatch.
|
||||||
|
|
||||||
To get details on OOP in Lyng, see [OOP notes](oop.md).
|
## Extension members
|
||||||
|
|
||||||
|
You can add new methods and properties to existing classes without modifying them.
|
||||||
|
|
||||||
|
### Extension functions
|
||||||
|
|
||||||
|
fun String.shout() = this.upper() + "!!!"
|
||||||
|
"hello".shout()
|
||||||
|
>>> "HELLO!!!"
|
||||||
|
|
||||||
|
### Extension properties
|
||||||
|
|
||||||
|
val Int.isEven = this % 2 == 0
|
||||||
|
4.isEven
|
||||||
|
>>> true
|
||||||
|
|
||||||
|
Example with custom accessors:
|
||||||
|
|
||||||
|
val String.firstChar get() = this[0]
|
||||||
|
"abc".firstChar
|
||||||
|
>>> 'a'
|
||||||
|
|
||||||
|
Extension members are **scope-isolated**: they are visible only in the scope where they are defined and its children. This prevents name collisions and improves security.
|
||||||
|
|
||||||
|
To get details on OOP in Lyng, see [OOP notes](OOP.md).
|
||||||
@@ -0,0 +1,27 @@
|
|||||||
|
# Wasm generation hang in wasmJs browser tests
|
||||||
|
|
||||||
|
## Summary
|
||||||
|
The wasmJs browser test runner hung after commit 5f819dc. The root cause was invalid WebAssembly generated by the Kotlin/Wasm backend when certain compiler paths emitted suspend lambdas for `Statement` execution. The invalid module failed to instantiate in the browser, and Karma kept the browser connected but never ran tests.
|
||||||
|
|
||||||
|
## Symptoms
|
||||||
|
- `:lynglib:wasmJsBrowserTest` hangs indefinitely in ChromeHeadless.
|
||||||
|
- `:lynglib:wasmJsNodeTest` fails with a WebAssembly compile error similar to:
|
||||||
|
- `struct.set expected type (ref null XXXX), found global.get of type (ref null YYYY)`
|
||||||
|
- The failing function name in the wasm name section looks like:
|
||||||
|
- `net.sergeych.lyng.$invokeCOROUTINE$.doResume`
|
||||||
|
|
||||||
|
## Root cause
|
||||||
|
The delegation/var-declaration changes introduced compiler-generated suspend lambdas inside `Statement` construction (e.g., `statement { ... }` wrappers). Kotlin/Wasm generates extra coroutine state for those suspend lambdas, which in this case produced invalid wasm IR (mismatched GC reference types). The browser loader then waits forever because the module fails to instantiate.
|
||||||
|
|
||||||
|
## Fix
|
||||||
|
Avoid suspend-lambda `Statement` construction in compiler code paths. Replace `statement { ... }` and other anonymous suspend lambdas with explicit `object : Statement()` implementations and move logic into `override suspend fun execute(...)`. This keeps the resulting wasm IR valid while preserving behavior.
|
||||||
|
|
||||||
|
## Where it was fixed
|
||||||
|
- `lynglib/src/commonMain/kotlin/net/sergeych/lyng/Compiler.kt`
|
||||||
|
- `lynglib/src/commonMain/kotlin/net/sergeych/lyng/Scope.kt`
|
||||||
|
|
||||||
|
## Verification
|
||||||
|
- `./gradlew :lynglib:wasmJsNodeTest --info`
|
||||||
|
- `./gradlew :lynglib:wasmJsBrowserTest --info`
|
||||||
|
|
||||||
|
Both tests finish quickly after the change.
|
||||||
@@ -0,0 +1,140 @@
|
|||||||
|
# What's New in Lyng
|
||||||
|
|
||||||
|
This document highlights the latest additions and improvements to the Lyng language and its ecosystem.
|
||||||
|
|
||||||
|
## Language Features
|
||||||
|
|
||||||
|
### Class Properties with Accessors
|
||||||
|
Classes now support properties with custom `get()` and `set()` accessors. Properties in Lyng do **not** have automatic backing fields; they are pure accessors.
|
||||||
|
|
||||||
|
```lyng
|
||||||
|
class Person(private var _age: Int) {
|
||||||
|
// Read-only property
|
||||||
|
val ageCategory get() = if (_age < 18) "Minor" else "Adult"
|
||||||
|
|
||||||
|
// Read-write property
|
||||||
|
var age: Int
|
||||||
|
get() = _age
|
||||||
|
set(v) {
|
||||||
|
if (v >= 0) _age = v
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Private and Protected Setters
|
||||||
|
You can now restrict the visibility of a property's or field's setter using `private set` or `protected set`. This allows members to be publicly readable but only writable from within the declaring class or its subclasses.
|
||||||
|
|
||||||
|
```lyng
|
||||||
|
class Counter {
|
||||||
|
var count = 0
|
||||||
|
private set // Field with private setter
|
||||||
|
|
||||||
|
fun increment() { count++ }
|
||||||
|
}
|
||||||
|
|
||||||
|
class AdvancedCounter : Counter {
|
||||||
|
var totalOperations = 0
|
||||||
|
protected set // Settable here and in further subclasses
|
||||||
|
}
|
||||||
|
|
||||||
|
let c = Counter()
|
||||||
|
c.increment() // OK
|
||||||
|
// c.count = 10 // Error: setter is private
|
||||||
|
```
|
||||||
|
|
||||||
|
### Late-initialized `val` Fields
|
||||||
|
`val` fields in classes can be declared without an immediate initializer, provided they are assigned exactly once. If accessed before initialization, they hold the special `Unset` singleton.
|
||||||
|
|
||||||
|
```lyng
|
||||||
|
class Service {
|
||||||
|
val logger
|
||||||
|
|
||||||
|
fun check() {
|
||||||
|
if (logger == Unset) println("Not initialized yet")
|
||||||
|
}
|
||||||
|
|
||||||
|
init {
|
||||||
|
logger = Logger("Service")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Named Arguments and Named Splats
|
||||||
|
Function calls now support named arguments using the `name: value` syntax. If the variable name matches the parameter name, you can use the `name:` shorthand.
|
||||||
|
|
||||||
|
```lyng
|
||||||
|
fun greet(name, greeting = "Hello") {
|
||||||
|
println("$greeting, $name!")
|
||||||
|
}
|
||||||
|
|
||||||
|
val name = "Alice"
|
||||||
|
greet(name:) // Shorthand for greet(name: name)
|
||||||
|
greet(greeting: "Hi", name: "Bob")
|
||||||
|
|
||||||
|
let params = { name: "Charlie", greeting: "Hey")
|
||||||
|
greet(...params) // Named splat expansion
|
||||||
|
```
|
||||||
|
|
||||||
|
### Multiple Inheritance (MI)
|
||||||
|
Lyng now supports multiple inheritance using the C3 Method Resolution Order (MRO). Use `this@Type` or casts for disambiguation.
|
||||||
|
|
||||||
|
```lyng
|
||||||
|
class A { fun foo() = "A" }
|
||||||
|
class B { fun foo() = "B" }
|
||||||
|
|
||||||
|
class Derived : A, B {
|
||||||
|
fun test() {
|
||||||
|
println(foo()) // Resolves to A.foo (leftmost)
|
||||||
|
println(this@B.foo()) // Qualified dispatch to B.foo
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
let d = Derived()
|
||||||
|
println((d as B).foo()) // Disambiguation via cast
|
||||||
|
```
|
||||||
|
|
||||||
|
### Singleton Objects
|
||||||
|
Singleton objects are declared using the `object` keyword. They provide a convenient way to define a class and its single instance in one go.
|
||||||
|
|
||||||
|
```lyng
|
||||||
|
object Config {
|
||||||
|
val version = "1.2.3"
|
||||||
|
fun show() = println("Config version: " + version)
|
||||||
|
}
|
||||||
|
|
||||||
|
Config.show()
|
||||||
|
```
|
||||||
|
|
||||||
|
### Unified Delegation Model
|
||||||
|
A powerful new delegation system allows `val`, `var`, and `fun` members to delegate their logic to other objects using the `by` keyword.
|
||||||
|
|
||||||
|
```lyng
|
||||||
|
// Property delegation
|
||||||
|
val lazyValue by lazy { "expensive" }
|
||||||
|
|
||||||
|
// Function delegation
|
||||||
|
fun remoteAction by myProxy
|
||||||
|
|
||||||
|
// Observable properties
|
||||||
|
var name by Observable("initial") { n, old, new ->
|
||||||
|
println("Changed!")
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
The system features a unified interface (`getValue`, `setValue`, `invoke`) and a `bind` hook for initialization-time validation and configuration. See the [Delegation Guide](delegation.md) for more.
|
||||||
|
|
||||||
|
## Tooling and Infrastructure
|
||||||
|
|
||||||
|
### CLI: Formatting Command
|
||||||
|
A new `fmt` subcommand has been added to the Lyng CLI.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
lyng fmt MyFile.lyng # Print formatted code to stdout
|
||||||
|
lyng fmt --in-place MyFile.lyng # Format file in-place
|
||||||
|
lyng fmt --check MyFile.lyng # Check if file needs formatting
|
||||||
|
```
|
||||||
|
|
||||||
|
### IDEA Plugin: Autocompletion
|
||||||
|
Experimental lightweight autocompletion is now available in the IntelliJ plugin. It features type-aware member suggestions and inheritance-aware completion.
|
||||||
|
|
||||||
|
You can enable it in **Settings | Lyng Formatter | Enable Lyng autocompletion**.
|
||||||
@@ -1,5 +1,7 @@
|
|||||||
# The `when` statement (expression)
|
# The `when` statement (expression)
|
||||||
|
|
||||||
|
[//]: # (topMenu)
|
||||||
|
|
||||||
Lyng provides a concise multi-branch selection with `when`, heavily inspired by Kotlin. In Lyng, `when` is an expression: it evaluates to a value. If the selected branch contains no value (e.g., it ends with `void` or calls a void function like `println`), the whole `when` expression evaluates to `void`.
|
Lyng provides a concise multi-branch selection with `when`, heavily inspired by Kotlin. In Lyng, `when` is an expression: it evaluates to a value. If the selected branch contains no value (e.g., it ends with `void` or calls a void function like `println`), the whole `when` expression evaluates to `void`.
|
||||||
|
|
||||||
Currently, Lyng implements the "subject" form: `when(value) { ... }`. The subject-less form `when { condition -> ... }` is not implemented yet.
|
Currently, Lyng implements the "subject" form: `when(value) { ... }`. The subject-less form `when { condition -> ... }` is not implemented yet.
|
||||||
|
|||||||
@@ -20,7 +20,7 @@ Files
|
|||||||
- Constants: `true`, `false`, `null`, `this`
|
- Constants: `true`, `false`, `null`, `this`
|
||||||
- Annotations: `@name` (Unicode identifiers supported)
|
- Annotations: `@name` (Unicode identifiers supported)
|
||||||
- Labels: `name:` (Unicode identifiers supported)
|
- Labels: `name:` (Unicode identifiers supported)
|
||||||
- Declarations: highlights declared names in `fun|fn name`, `class|enum Name`, `val|var name`
|
- Declarations: highlights declared names in `fun|fn name`, `class|enum|interface Name`, `val|var name`
|
||||||
- Types: built-ins (`Int|Real|String|Bool|Char|Regex`) and Capitalized identifiers (heuristic)
|
- Types: built-ins (`Int|Real|String|Bool|Char|Regex`) and Capitalized identifiers (heuristic)
|
||||||
- Operators including ranges (`..`, `..<`, `...`), null-safe (`?.`, `?[`, `?(`, `?{`, `?:`, `??`), arrows (`->`, `=>`, `::`), match operators (`=~`, `!~`), bitwise, arithmetic, etc.
|
- Operators including ranges (`..`, `..<`, `...`), null-safe (`?.`, `?[`, `?(`, `?{`, `?:`, `??`), arrows (`->`, `=>`, `::`), match operators (`=~`, `!~`), bitwise, arithmetic, etc.
|
||||||
- Shuttle operator `<=>`
|
- Shuttle operator `<=>`
|
||||||
|
|||||||
@@ -2,7 +2,7 @@
|
|||||||
"name": "lyng-textmate",
|
"name": "lyng-textmate",
|
||||||
"displayName": "Lyng",
|
"displayName": "Lyng",
|
||||||
"description": "TextMate grammar for the Lyng language (for JetBrains IDEs via TextMate Bundles and VS Code).",
|
"description": "TextMate grammar for the Lyng language (for JetBrains IDEs via TextMate Bundles and VS Code).",
|
||||||
"version": "0.0.3",
|
"version": "0.1.0",
|
||||||
"publisher": "lyng",
|
"publisher": "lyng",
|
||||||
"license": "Apache-2.0",
|
"license": "Apache-2.0",
|
||||||
"engines": { "vscode": "^1.0.0" },
|
"engines": { "vscode": "^1.0.0" },
|
||||||
|
|||||||
@@ -76,8 +76,8 @@
|
|||||||
},
|
},
|
||||||
"labels": { "patterns": [ { "name": "entity.name.label.lyng", "match": "[\\p{L}_][\\p{L}\\p{N}_]*:" } ] },
|
"labels": { "patterns": [ { "name": "entity.name.label.lyng", "match": "[\\p{L}_][\\p{L}\\p{N}_]*:" } ] },
|
||||||
"directives": { "patterns": [ { "name": "meta.directive.lyng", "match": "^\\s*#[_A-Za-z][_A-Za-z0-9]*" } ] },
|
"directives": { "patterns": [ { "name": "meta.directive.lyng", "match": "^\\s*#[_A-Za-z][_A-Za-z0-9]*" } ] },
|
||||||
"declarations": { "patterns": [ { "name": "meta.function.declaration.lyng", "match": "\\b(?:fun|fn)\\s+([\\p{L}_][\\p{L}\\p{N}_]*)", "captures": { "1": { "name": "entity.name.function.lyng" } } }, { "name": "meta.type.declaration.lyng", "match": "\\b(?:class|enum)\\s+([\\p{L}_][\\p{L}\\p{N}_]*)", "captures": { "1": { "name": "entity.name.type.lyng" } } }, { "name": "meta.variable.declaration.lyng", "match": "\\b(?:val|var)\\s+([\\p{L}_][\\p{L}\\p{N}_]*)", "captures": { "1": { "name": "variable.other.declaration.lyng" } } } ] },
|
"declarations": { "patterns": [ { "name": "meta.function.declaration.lyng", "match": "\\b(fun|fn)\\s+(?:([\\p{L}_][\\p{L}\\p{N}_]*)\\.)?([\\p{L}_][\\p{L}\\p{N}_]*)", "captures": { "1": { "name": "keyword.declaration.lyng" }, "2": { "name": "entity.name.type.lyng" }, "3": { "name": "entity.name.function.lyng" } } }, { "name": "meta.type.declaration.lyng", "match": "\\b(?:class|enum|interface)\\s+([\\p{L}_][\\p{L}\\p{N}_]*)", "captures": { "1": { "name": "entity.name.type.lyng" } } }, { "name": "meta.variable.declaration.lyng", "match": "\\b(val|var)\\s+(?:([\\p{L}_][\\p{L}\\p{N}_]*)\\.)?([\\p{L}_][\\p{L}\\p{N}_]*)", "captures": { "1": { "name": "keyword.declaration.lyng" }, "2": { "name": "entity.name.type.lyng" }, "3": { "name": "variable.other.declaration.lyng" } } } ] },
|
||||||
"keywords": { "patterns": [ { "name": "keyword.control.lyng", "match": "\\b(?:if|else|when|while|do|for|try|catch|finally|throw|return|break|continue)\\b" }, { "name": "keyword.declaration.lyng", "match": "\\b(?:fun|fn|class|enum|val|var|import|package|constructor|property|open|extern|private|protected|static)\\b" }, { "name": "keyword.operator.word.lyng", "match": "\\bnot\\s+(?:in|is)\\b" }, { "name": "keyword.operator.word.lyng", "match": "\\b(?:and|or|not|in|is|as|as\\?)\\b" } ] },
|
"keywords": { "patterns": [ { "name": "keyword.control.lyng", "match": "\\b(?:if|else|when|while|do|for|try|catch|finally|throw|return|break|continue)\\b" }, { "name": "keyword.declaration.lyng", "match": "\\b(?:fun|fn|class|enum|interface|val|var|import|package|constructor|property|abstract|override|open|closed|extern|private|protected|static|get|set)\\b" }, { "name": "keyword.operator.word.lyng", "match": "\\bnot\\s+(?:in|is)\\b" }, { "name": "keyword.operator.word.lyng", "match": "\\b(?:and|or|not|in|is|as|as\\?)\\b" } ] },
|
||||||
"constants": { "patterns": [ { "name": "constant.language.lyng", "match": "(?:\\b(?:true|false|null|this)\\b|π)" } ] },
|
"constants": { "patterns": [ { "name": "constant.language.lyng", "match": "(?:\\b(?:true|false|null|this)\\b|π)" } ] },
|
||||||
"types": { "patterns": [ { "name": "storage.type.lyng", "match": "\\b(?:Int|Real|String|Bool|Char|Regex)\\b" }, { "name": "entity.name.type.lyng", "match": "\\b[A-Z][A-Za-z0-9_]*\\b(?!\\s*\\()" } ] },
|
"types": { "patterns": [ { "name": "storage.type.lyng", "match": "\\b(?:Int|Real|String|Bool|Char|Regex)\\b" }, { "name": "entity.name.type.lyng", "match": "\\b[A-Z][A-Za-z0-9_]*\\b(?!\\s*\\()" } ] },
|
||||||
"operators": { "patterns": [ { "name": "keyword.operator.comparison.lyng", "match": "===|!==|==|!=|<=|>=|<|>" }, { "name": "keyword.operator.shuttle.lyng", "match": "<=>" }, { "name": "keyword.operator.arrow.lyng", "match": "=>|->|::" }, { "name": "keyword.operator.range.lyng", "match": "\\.\\.\\.|\\.\\.<|\\.\\." }, { "name": "keyword.operator.nullsafe.lyng", "match": "\\?\\.|\\?\\[|\\?\\(|\\?\\{|\\?:|\\?\\?" }, { "name": "keyword.operator.assignment.lyng", "match": "(?:\\+=|-=|\\*=|/=|%=|=)" }, { "name": "keyword.operator.logical.lyng", "match": "&&|\\|\\|" }, { "name": "keyword.operator.bitwise.lyng", "match": "<<|>>|&|\\||\\^|~" }, { "name": "keyword.operator.match.lyng", "match": "=~|!~" }, { "name": "keyword.operator.arithmetic.lyng", "match": "\\+\\+|--|[+\\-*/%]" }, { "name": "keyword.operator.other.lyng", "match": "[!?]" } ] },
|
"operators": { "patterns": [ { "name": "keyword.operator.comparison.lyng", "match": "===|!==|==|!=|<=|>=|<|>" }, { "name": "keyword.operator.shuttle.lyng", "match": "<=>" }, { "name": "keyword.operator.arrow.lyng", "match": "=>|->|::" }, { "name": "keyword.operator.range.lyng", "match": "\\.\\.\\.|\\.\\.<|\\.\\." }, { "name": "keyword.operator.nullsafe.lyng", "match": "\\?\\.|\\?\\[|\\?\\(|\\?\\{|\\?:|\\?\\?" }, { "name": "keyword.operator.assignment.lyng", "match": "(?:\\+=|-=|\\*=|/=|%=|=)" }, { "name": "keyword.operator.logical.lyng", "match": "&&|\\|\\|" }, { "name": "keyword.operator.bitwise.lyng", "match": "<<|>>|&|\\||\\^|~" }, { "name": "keyword.operator.match.lyng", "match": "=~|!~" }, { "name": "keyword.operator.arithmetic.lyng", "match": "\\+\\+|--|[+\\-*/%]" }, { "name": "keyword.operator.other.lyng", "match": "[!?]" } ] },
|
||||||
|
|||||||
+5
-2
@@ -32,6 +32,9 @@ kotlin.native.cacheKind.linuxX64=none
|
|||||||
|
|
||||||
# Workaround: Ensure Gradle uses a JDK with `jlink` available for AGP's JDK image transform.
|
# Workaround: Ensure Gradle uses a JDK with `jlink` available for AGP's JDK image transform.
|
||||||
# On this environment, the system JDK 21 installation lacks `jlink`, causing
|
# On this environment, the system JDK 21 installation lacks `jlink`, causing
|
||||||
# :lynglib:androidJdkImage to fail. Point Gradle to JDK 17 which includes `jlink`.
|
# :lynglib:androidJdkImage to fail. Point Gradle to a JDK that includes `jlink`.
|
||||||
# This affects only the JDK Gradle runs with; Kotlin/JVM target remains compatible.
|
# This affects only the JDK Gradle runs with; Kotlin/JVM target remains compatible.
|
||||||
#org.gradle.java.home=/usr/lib/jvm/java-17-openjdk-amd64
|
#org.gradle.java.home=/home/sergeych/.jdks/corretto-21.0.9
|
||||||
|
android.experimental.lint.migrateToK2=false
|
||||||
|
android.lint.useK2Uast=false
|
||||||
|
kotlin.mpp.applyDefaultHierarchyTemplate=true
|
||||||
@@ -1,11 +1,11 @@
|
|||||||
[versions]
|
[versions]
|
||||||
agp = "8.5.2"
|
agp = "8.5.2"
|
||||||
clikt = "5.0.3"
|
clikt = "5.0.3"
|
||||||
kotlin = "2.2.21"
|
kotlin = "2.3.0"
|
||||||
android-minSdk = "24"
|
android-minSdk = "24"
|
||||||
android-compileSdk = "34"
|
android-compileSdk = "34"
|
||||||
kotlinx-coroutines = "1.10.2"
|
kotlinx-coroutines = "1.10.2"
|
||||||
mp_bintools = "0.1.12"
|
mp_bintools = "0.3.2"
|
||||||
firebaseCrashlyticsBuildtools = "3.0.3"
|
firebaseCrashlyticsBuildtools = "3.0.3"
|
||||||
okioVersion = "3.10.2"
|
okioVersion = "3.10.2"
|
||||||
compiler = "3.2.0-alpha11"
|
compiler = "3.2.0-alpha11"
|
||||||
@@ -20,6 +20,7 @@ mp_bintools = { module = "net.sergeych:mp_bintools", version.ref = "mp_bintools"
|
|||||||
firebase-crashlytics-buildtools = { group = "com.google.firebase", name = "firebase-crashlytics-buildtools", version.ref = "firebaseCrashlyticsBuildtools" }
|
firebase-crashlytics-buildtools = { group = "com.google.firebase", name = "firebase-crashlytics-buildtools", version.ref = "firebaseCrashlyticsBuildtools" }
|
||||||
okio = { module = "com.squareup.okio:okio", version.ref = "okioVersion" }
|
okio = { module = "com.squareup.okio:okio", version.ref = "okioVersion" }
|
||||||
okio-fakefilesystem = { module = "com.squareup.okio:okio-fakefilesystem", version.ref = "okioVersion" }
|
okio-fakefilesystem = { module = "com.squareup.okio:okio-fakefilesystem", version.ref = "okioVersion" }
|
||||||
|
okio-nodefilesystem = { module = "com.squareup.okio:okio-nodefilesystem", version.ref = "okioVersion" }
|
||||||
compiler = { group = "androidx.databinding", name = "compiler", version.ref = "compiler" }
|
compiler = { group = "androidx.databinding", name = "compiler", version.ref = "compiler" }
|
||||||
|
|
||||||
[plugins]
|
[plugins]
|
||||||
|
|||||||
@@ -0,0 +1,32 @@
|
|||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<!--
|
||||||
|
- Copyright 2025 Sergey S. Chernov real.sergeych@gmail.com
|
||||||
|
-
|
||||||
|
- Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
- you may not use this file except in compliance with the License.
|
||||||
|
- You may obtain a copy of the License at
|
||||||
|
-
|
||||||
|
- http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
-
|
||||||
|
- Unless required by applicable law or agreed to in writing, software
|
||||||
|
- distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
- See the License for the specific language governing permissions and
|
||||||
|
- limitations under the License.
|
||||||
|
-
|
||||||
|
-->
|
||||||
|
|
||||||
|
<svg width="16" height="16" viewBox="0 0 16 16" xmlns="http://www.w3.org/2000/svg" aria-labelledby="title" role="img">
|
||||||
|
<title>Lyng File Icon (temporary λ)</title>
|
||||||
|
<defs>
|
||||||
|
<style>
|
||||||
|
.g { fill: none; stroke: currentColor; stroke-width: 1.6; stroke-linecap: round; stroke-linejoin: round; }
|
||||||
|
</style>
|
||||||
|
</defs>
|
||||||
|
<!-- Keep shapes crisp on small canvas; slight inset to avoid clipping -->
|
||||||
|
<g transform="translate(0.5,0.5)">
|
||||||
|
<!-- Stylized lambda fitted to 14x14 -->
|
||||||
|
<path class="g" d="M4.5 2.5 L7 9.5 C7.6 11.2 9.0 12.5 11.0 12.5 L14.5 12.5"/>
|
||||||
|
<path class="g" d="M7 9.5 L2.5 14.5"/>
|
||||||
|
</g>
|
||||||
|
</svg>
|
||||||
|
After Width: | Height: | Size: 1.3 KiB |
@@ -0,0 +1,33 @@
|
|||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<!--
|
||||||
|
- Copyright 2025 Sergey S. Chernov real.sergeych@gmail.com
|
||||||
|
-
|
||||||
|
- Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
- you may not use this file except in compliance with the License.
|
||||||
|
- You may obtain a copy of the License at
|
||||||
|
-
|
||||||
|
- http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
-
|
||||||
|
- Unless required by applicable law or agreed to in writing, software
|
||||||
|
- distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
- See the License for the specific language governing permissions and
|
||||||
|
- limitations under the License.
|
||||||
|
-
|
||||||
|
-->
|
||||||
|
|
||||||
|
<svg width="40" height="40" viewBox="0 0 40 40" xmlns="http://www.w3.org/2000/svg" aria-labelledby="title" role="img">
|
||||||
|
<title>Lyng Plugin Icon (temporary λ)</title>
|
||||||
|
<defs>
|
||||||
|
<!-- Monochrome, theme-friendly -->
|
||||||
|
<style>
|
||||||
|
.glyph { fill: none; stroke: currentColor; stroke-width: 3; stroke-linecap: round; stroke-linejoin: round; }
|
||||||
|
</style>
|
||||||
|
</defs>
|
||||||
|
<!-- Safe inset to avoid edge clipping in 40x40 canvas -->
|
||||||
|
<g transform="translate(2,2)">
|
||||||
|
<!-- Stylized lambda: rising stem + curved tail -->
|
||||||
|
<path class="glyph" d="M12 6 L18 22 C19.2 25.5 22.2 28 26 28 L32 28"/>
|
||||||
|
<path class="glyph" d="M18 22 L8 34"/>
|
||||||
|
</g>
|
||||||
|
</svg>
|
||||||
|
After Width: | Height: | Size: 1.3 KiB |
@@ -0,0 +1,88 @@
|
|||||||
|
/*
|
||||||
|
* Copyright 2026 Sergey S. Chernov real.sergeych@gmail.com
|
||||||
|
*
|
||||||
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
* you may not use this file except in compliance with the License.
|
||||||
|
* You may obtain a copy of the License at
|
||||||
|
*
|
||||||
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
*
|
||||||
|
* Unless required by applicable law or agreed to in writing, software
|
||||||
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
* See the License for the specific language governing permissions and
|
||||||
|
* limitations under the License.
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
|
plugins {
|
||||||
|
kotlin("jvm")
|
||||||
|
id("org.jetbrains.intellij") version "1.17.3"
|
||||||
|
}
|
||||||
|
|
||||||
|
group = "net.sergeych.lyng"
|
||||||
|
version = "0.0.5-SNAPSHOT"
|
||||||
|
|
||||||
|
kotlin {
|
||||||
|
jvmToolchain(17)
|
||||||
|
}
|
||||||
|
|
||||||
|
repositories {
|
||||||
|
mavenCentral()
|
||||||
|
// Use the same repositories as the rest of the project so plugin runtime deps resolve
|
||||||
|
maven("https://maven.universablockchain.com/")
|
||||||
|
maven("https://gitea.sergeych.net/api/packages/SergeychWorks/maven")
|
||||||
|
mavenLocal()
|
||||||
|
}
|
||||||
|
|
||||||
|
dependencies {
|
||||||
|
implementation(project(":lynglib"))
|
||||||
|
// Include lyngio so Quick Docs can reflectively load fs docs registrar (FsBuiltinDocs)
|
||||||
|
implementation(project(":lyngio"))
|
||||||
|
// Rich Markdown renderer for Quick Docs
|
||||||
|
implementation("com.vladsch.flexmark:flexmark-all:0.64.8")
|
||||||
|
|
||||||
|
// Tests for IntelliJ Platform fixtures rely on JUnit 3/4 API (junit.framework.TestCase)
|
||||||
|
// Add JUnit 4 which contains the JUnit 3 compatibility classes used by BasePlatformTestCase/UsefulTestCase
|
||||||
|
testImplementation("junit:junit:4.13.2")
|
||||||
|
}
|
||||||
|
|
||||||
|
intellij {
|
||||||
|
type.set("IC")
|
||||||
|
// Build against a modern baseline. Install range is controlled by since/until below.
|
||||||
|
version.set("2024.3.1")
|
||||||
|
// We manage <idea-version> ourselves in plugin.xml to keep it open-ended (no upper cap)
|
||||||
|
updateSinceUntilBuild.set(false)
|
||||||
|
// Include only available bundled plugins for this IDE build
|
||||||
|
plugins.set(listOf(
|
||||||
|
"com.intellij.java",
|
||||||
|
// Provide Grazie API on compile classpath (bundled in 2024.3+, but add here for compilation)
|
||||||
|
"tanvd.grazi"
|
||||||
|
// Do not list com.intellij.spellchecker here: it is expected to be bundled with the IDE.
|
||||||
|
// Listing it causes Gradle to search for a separate plugin artifact and fail on IC 2024.3.
|
||||||
|
))
|
||||||
|
}
|
||||||
|
|
||||||
|
tasks {
|
||||||
|
patchPluginXml {
|
||||||
|
// Keep version and other metadata patched by Gradle, but since/until are controlled in plugin.xml.
|
||||||
|
// (intellij.updateSinceUntilBuild=false prevents Gradle from injecting an until-build cap)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Build an installable plugin zip and copy it to $PROJECT_ROOT/distributables
|
||||||
|
// Usage: ./gradlew :lyng-idea:buildInstallablePlugin
|
||||||
|
// It depends on buildPlugin and overwrites any existing file with the same name
|
||||||
|
register<Copy>("buildInstallablePlugin") {
|
||||||
|
dependsOn("buildPlugin")
|
||||||
|
|
||||||
|
// The Gradle IntelliJ Plugin produces: build/distributions/<project.name>-<version>.zip
|
||||||
|
val zipName = "${project.name}-${project.version}.zip"
|
||||||
|
val sourceZip = layout.buildDirectory.file("distributions/$zipName")
|
||||||
|
|
||||||
|
from(sourceZip)
|
||||||
|
into(rootProject.layout.projectDirectory.dir("distributables"))
|
||||||
|
|
||||||
|
// Overwrite if a file with the same name exists
|
||||||
|
duplicatesStrategy = DuplicatesStrategy.INCLUDE
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,27 @@
|
|||||||
|
/*
|
||||||
|
* Copyright 2025 Sergey S. Chernov real.sergeych@gmail.com
|
||||||
|
*
|
||||||
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
* you may not use this file except in compliance with the License.
|
||||||
|
* You may obtain a copy of the License at
|
||||||
|
*
|
||||||
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
*
|
||||||
|
* Unless required by applicable law or agreed to in writing, software
|
||||||
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
* See the License for the specific language governing permissions and
|
||||||
|
* limitations under the License.
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
package net.sergeych.lyng.idea
|
||||||
|
|
||||||
|
import com.intellij.openapi.fileTypes.LanguageFileType
|
||||||
|
import javax.swing.Icon
|
||||||
|
|
||||||
|
object LyngFileType : LanguageFileType(LyngLanguage) {
|
||||||
|
override fun getName(): String = "Lyng"
|
||||||
|
override fun getDescription(): String = "Lyng language file"
|
||||||
|
override fun getDefaultExtension(): String = "lyng"
|
||||||
|
override fun getIcon(): Icon? = LyngIcons.FILE
|
||||||
|
}
|
||||||
@@ -0,0 +1,24 @@
|
|||||||
|
/*
|
||||||
|
* Copyright 2025 Sergey S. Chernov real.sergeych@gmail.com
|
||||||
|
*
|
||||||
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
* you may not use this file except in compliance with the License.
|
||||||
|
* You may obtain a copy of the License at
|
||||||
|
*
|
||||||
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
*
|
||||||
|
* Unless required by applicable law or agreed to in writing, software
|
||||||
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
* See the License for the specific language governing permissions and
|
||||||
|
* limitations under the License.
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
package net.sergeych.lyng.idea
|
||||||
|
|
||||||
|
import com.intellij.openapi.util.IconLoader
|
||||||
|
import javax.swing.Icon
|
||||||
|
|
||||||
|
object LyngIcons {
|
||||||
|
val FILE: Icon = IconLoader.getIcon("/icons/lyng_file.svg", LyngIcons::class.java)
|
||||||
|
}
|
||||||
@@ -0,0 +1,21 @@
|
|||||||
|
/*
|
||||||
|
* Copyright 2025 Sergey S. Chernov real.sergeych@gmail.com
|
||||||
|
*
|
||||||
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
* you may not use this file except in compliance with the License.
|
||||||
|
* You may obtain a copy of the License at
|
||||||
|
*
|
||||||
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
*
|
||||||
|
* Unless required by applicable law or agreed to in writing, software
|
||||||
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
* See the License for the specific language governing permissions and
|
||||||
|
* limitations under the License.
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
package net.sergeych.lyng.idea
|
||||||
|
|
||||||
|
import com.intellij.lang.Language
|
||||||
|
|
||||||
|
object LyngLanguage : Language("Lyng")
|
||||||
@@ -0,0 +1,393 @@
|
|||||||
|
/*
|
||||||
|
* Copyright 2026 Sergey S. Chernov real.sergeych@gmail.com
|
||||||
|
*
|
||||||
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
* you may not use this file except in compliance with the License.
|
||||||
|
* You may obtain a copy of the License at
|
||||||
|
*
|
||||||
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
*
|
||||||
|
* Unless required by applicable law or agreed to in writing, software
|
||||||
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
* See the License for the specific language governing permissions and
|
||||||
|
* limitations under the License.
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
|
package net.sergeych.lyng.idea.annotators
|
||||||
|
|
||||||
|
import com.intellij.lang.annotation.AnnotationHolder
|
||||||
|
import com.intellij.lang.annotation.ExternalAnnotator
|
||||||
|
import com.intellij.lang.annotation.HighlightSeverity
|
||||||
|
import com.intellij.openapi.editor.Document
|
||||||
|
import com.intellij.openapi.progress.ProgressManager
|
||||||
|
import com.intellij.openapi.util.Key
|
||||||
|
import com.intellij.openapi.util.TextRange
|
||||||
|
import com.intellij.psi.PsiFile
|
||||||
|
import kotlinx.coroutines.runBlocking
|
||||||
|
import net.sergeych.lyng.Compiler
|
||||||
|
import net.sergeych.lyng.ScriptError
|
||||||
|
import net.sergeych.lyng.Source
|
||||||
|
import net.sergeych.lyng.binding.Binder
|
||||||
|
import net.sergeych.lyng.binding.SymbolKind
|
||||||
|
import net.sergeych.lyng.highlight.HighlightKind
|
||||||
|
import net.sergeych.lyng.highlight.SimpleLyngHighlighter
|
||||||
|
import net.sergeych.lyng.highlight.offsetOf
|
||||||
|
import net.sergeych.lyng.idea.highlight.LyngHighlighterColors
|
||||||
|
import net.sergeych.lyng.idea.util.IdeLenientImportProvider
|
||||||
|
import net.sergeych.lyng.miniast.*
|
||||||
|
|
||||||
|
/**
|
||||||
|
* ExternalAnnotator that runs Lyng MiniAst on the document text in background
|
||||||
|
* and applies semantic highlighting comparable with the web highlighter.
|
||||||
|
*/
|
||||||
|
class LyngExternalAnnotator : ExternalAnnotator<LyngExternalAnnotator.Input, LyngExternalAnnotator.Result>() {
|
||||||
|
data class Input(val text: String, val modStamp: Long, val previousSpans: List<Span>?)
|
||||||
|
|
||||||
|
data class Span(val start: Int, val end: Int, val key: com.intellij.openapi.editor.colors.TextAttributesKey)
|
||||||
|
data class Error(val start: Int, val end: Int, val message: String)
|
||||||
|
data class Result(val modStamp: Long, val spans: List<Span>, val error: Error? = null,
|
||||||
|
val spellIdentifiers: List<IntRange> = emptyList(),
|
||||||
|
val spellComments: List<IntRange> = emptyList(),
|
||||||
|
val spellStrings: List<IntRange> = emptyList())
|
||||||
|
|
||||||
|
override fun collectInformation(file: PsiFile): Input? {
|
||||||
|
val doc: Document = file.viewProvider.document ?: return null
|
||||||
|
val cached = file.getUserData(CACHE_KEY)
|
||||||
|
// Fast fix (1): reuse cached spans only if they were computed for the same modification stamp
|
||||||
|
val prev = if (cached != null && cached.modStamp == doc.modificationStamp) cached.spans else null
|
||||||
|
return Input(doc.text, doc.modificationStamp, prev)
|
||||||
|
}
|
||||||
|
|
||||||
|
override fun doAnnotate(collectedInfo: Input?): Result? {
|
||||||
|
if (collectedInfo == null) return null
|
||||||
|
ProgressManager.checkCanceled()
|
||||||
|
val text = collectedInfo.text
|
||||||
|
// Build Mini-AST using the same mechanism as web highlighter
|
||||||
|
val sink = MiniAstBuilder()
|
||||||
|
val source = Source("<ide>", text)
|
||||||
|
try {
|
||||||
|
// Call suspend API from blocking context
|
||||||
|
val provider = IdeLenientImportProvider.create()
|
||||||
|
runBlocking { Compiler.compileWithMini(source, provider, sink) }
|
||||||
|
} catch (e: Throwable) {
|
||||||
|
if (e is com.intellij.openapi.progress.ProcessCanceledException) throw e
|
||||||
|
// On script parse error: keep previous spans and report the error location
|
||||||
|
if (e is ScriptError) {
|
||||||
|
val off = try { source.offsetOf(e.pos) } catch (_: Throwable) { -1 }
|
||||||
|
val start0 = off.coerceIn(0, text.length.coerceAtLeast(0))
|
||||||
|
val (start, end) = expandErrorRange(text, start0)
|
||||||
|
// Fast fix (5): clear cached highlighting after the error start position
|
||||||
|
val trimmed = collectedInfo.previousSpans?.filter { it.end <= start } ?: emptyList()
|
||||||
|
return Result(
|
||||||
|
collectedInfo.modStamp,
|
||||||
|
trimmed,
|
||||||
|
Error(start, end, e.errorMessage)
|
||||||
|
)
|
||||||
|
}
|
||||||
|
// Other failures: keep previous spans without error
|
||||||
|
return Result(collectedInfo.modStamp, collectedInfo.previousSpans ?: emptyList(), null)
|
||||||
|
}
|
||||||
|
ProgressManager.checkCanceled()
|
||||||
|
val mini = sink.build() ?: return Result(collectedInfo.modStamp, collectedInfo.previousSpans ?: emptyList())
|
||||||
|
|
||||||
|
val out = ArrayList<Span>(256)
|
||||||
|
|
||||||
|
fun putRange(start: Int, end: Int, key: com.intellij.openapi.editor.colors.TextAttributesKey) {
|
||||||
|
if (start in 0..end && end <= text.length && start < end) out += Span(start, end, key)
|
||||||
|
}
|
||||||
|
fun putName(startPos: net.sergeych.lyng.Pos, name: String, key: com.intellij.openapi.editor.colors.TextAttributesKey) {
|
||||||
|
val s = source.offsetOf(startPos)
|
||||||
|
putRange(s, (s + name.length).coerceAtMost(text.length), key)
|
||||||
|
}
|
||||||
|
fun putMiniRange(r: MiniRange, key: com.intellij.openapi.editor.colors.TextAttributesKey) {
|
||||||
|
val s = source.offsetOf(r.start)
|
||||||
|
val e = source.offsetOf(r.end)
|
||||||
|
putRange(s, e, key)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Declarations
|
||||||
|
for (d in mini.declarations) {
|
||||||
|
when (d) {
|
||||||
|
is MiniFunDecl -> putName(d.nameStart, d.name, LyngHighlighterColors.FUNCTION_DECLARATION)
|
||||||
|
is MiniClassDecl -> putName(d.nameStart, d.name, LyngHighlighterColors.TYPE)
|
||||||
|
is MiniValDecl -> putName(
|
||||||
|
d.nameStart,
|
||||||
|
d.name,
|
||||||
|
if (d.mutable) LyngHighlighterColors.VARIABLE else LyngHighlighterColors.VALUE
|
||||||
|
)
|
||||||
|
is MiniEnumDecl -> putName(d.nameStart, d.name, LyngHighlighterColors.TYPE)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Imports: each segment as namespace/path
|
||||||
|
for (imp in mini.imports) {
|
||||||
|
for (seg in imp.segments) putMiniRange(seg.range, LyngHighlighterColors.NAMESPACE)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Parameters
|
||||||
|
for (fn in mini.declarations.filterIsInstance<MiniFunDecl>()) {
|
||||||
|
for (p in fn.params) putName(p.nameStart, p.name, LyngHighlighterColors.PARAMETER)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Type name segments (including generics base & args)
|
||||||
|
fun addTypeSegments(t: MiniTypeRef?) {
|
||||||
|
when (t) {
|
||||||
|
is MiniTypeName -> t.segments.forEach { seg ->
|
||||||
|
val s = source.offsetOf(seg.range.start)
|
||||||
|
putRange(s, (s + seg.name.length).coerceAtMost(text.length), LyngHighlighterColors.TYPE)
|
||||||
|
}
|
||||||
|
is MiniGenericType -> {
|
||||||
|
addTypeSegments(t.base)
|
||||||
|
t.args.forEach { addTypeSegments(it) }
|
||||||
|
}
|
||||||
|
is MiniFunctionType -> {
|
||||||
|
t.receiver?.let { addTypeSegments(it) }
|
||||||
|
t.params.forEach { addTypeSegments(it) }
|
||||||
|
addTypeSegments(t.returnType)
|
||||||
|
}
|
||||||
|
is MiniTypeVar -> { /* name is in range; could be highlighted as TYPE as well */
|
||||||
|
putMiniRange(t.range, LyngHighlighterColors.TYPE)
|
||||||
|
}
|
||||||
|
null -> {}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
for (d in mini.declarations) {
|
||||||
|
when (d) {
|
||||||
|
is MiniFunDecl -> {
|
||||||
|
addTypeSegments(d.returnType)
|
||||||
|
d.params.forEach { addTypeSegments(it.type) }
|
||||||
|
addTypeSegments(d.receiver)
|
||||||
|
}
|
||||||
|
is MiniValDecl -> {
|
||||||
|
addTypeSegments(d.type)
|
||||||
|
addTypeSegments(d.receiver)
|
||||||
|
}
|
||||||
|
is MiniClassDecl -> {
|
||||||
|
d.ctorFields.forEach { addTypeSegments(it.type) }
|
||||||
|
d.classFields.forEach { addTypeSegments(it.type) }
|
||||||
|
}
|
||||||
|
is MiniEnumDecl -> {}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
ProgressManager.checkCanceled()
|
||||||
|
|
||||||
|
// Semantic usages via Binder (best-effort)
|
||||||
|
try {
|
||||||
|
val binding = Binder.bind(text, mini)
|
||||||
|
|
||||||
|
// Map declaration ranges to avoid duplicating them as usages
|
||||||
|
val declKeys = HashSet<Pair<Int, Int>>(binding.symbols.size * 2)
|
||||||
|
for (sym in binding.symbols) declKeys += (sym.declStart to sym.declEnd)
|
||||||
|
|
||||||
|
fun keyForKind(k: SymbolKind) = when (k) {
|
||||||
|
SymbolKind.Function -> LyngHighlighterColors.FUNCTION
|
||||||
|
SymbolKind.Class, SymbolKind.Enum -> LyngHighlighterColors.TYPE
|
||||||
|
SymbolKind.Parameter -> LyngHighlighterColors.PARAMETER
|
||||||
|
SymbolKind.Value -> LyngHighlighterColors.VALUE
|
||||||
|
SymbolKind.Variable -> LyngHighlighterColors.VARIABLE
|
||||||
|
}
|
||||||
|
|
||||||
|
// Track covered ranges to not override later heuristics
|
||||||
|
val covered = HashSet<Pair<Int, Int>>()
|
||||||
|
|
||||||
|
for (ref in binding.references) {
|
||||||
|
val key = ref.start to ref.end
|
||||||
|
if (declKeys.contains(key)) continue
|
||||||
|
val sym = binding.symbols.firstOrNull { it.id == ref.symbolId } ?: continue
|
||||||
|
val color = keyForKind(sym.kind)
|
||||||
|
putRange(ref.start, ref.end, color)
|
||||||
|
covered += key
|
||||||
|
}
|
||||||
|
|
||||||
|
// Heuristics on top of binder: function call-sites and simple name-based roles
|
||||||
|
ProgressManager.checkCanceled()
|
||||||
|
|
||||||
|
val tokens = try { SimpleLyngHighlighter().highlight(text) } catch (_: Throwable) { emptyList() }
|
||||||
|
|
||||||
|
fun isFollowedByParenOrBlock(rangeEnd: Int): Boolean {
|
||||||
|
var i = rangeEnd
|
||||||
|
while (i < text.length) {
|
||||||
|
val ch = text[i]
|
||||||
|
if (ch == ' ' || ch == '\t' || ch == '\r' || ch == '\n') { i++; continue }
|
||||||
|
return ch == '(' || ch == '{'
|
||||||
|
}
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
// Build simple name -> role map for top-level vals/vars and parameters
|
||||||
|
val nameRole = HashMap<String, com.intellij.openapi.editor.colors.TextAttributesKey>(8)
|
||||||
|
for (d in mini.declarations) when (d) {
|
||||||
|
is MiniValDecl -> nameRole[d.name] = if (d.mutable) LyngHighlighterColors.VARIABLE else LyngHighlighterColors.VALUE
|
||||||
|
is MiniFunDecl -> d.params.forEach { p -> nameRole[p.name] = LyngHighlighterColors.PARAMETER }
|
||||||
|
else -> {}
|
||||||
|
}
|
||||||
|
|
||||||
|
for (s in tokens) if (s.kind == HighlightKind.Identifier) {
|
||||||
|
val start = s.range.start
|
||||||
|
val end = s.range.endExclusive
|
||||||
|
val key = start to end
|
||||||
|
if (key in covered || key in declKeys) continue
|
||||||
|
|
||||||
|
// Call-site detection first so it wins over var/param role
|
||||||
|
if (isFollowedByParenOrBlock(end)) {
|
||||||
|
putRange(start, end, LyngHighlighterColors.FUNCTION)
|
||||||
|
covered += key
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
// Simple role by known names
|
||||||
|
val ident = try { text.substring(start, end) } catch (_: Throwable) { null }
|
||||||
|
if (ident != null) {
|
||||||
|
val roleKey = nameRole[ident]
|
||||||
|
if (roleKey != null) {
|
||||||
|
putRange(start, end, roleKey)
|
||||||
|
covered += key
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
} catch (e: Throwable) {
|
||||||
|
// Must rethrow cancellation; otherwise ignore binder failures (best-effort)
|
||||||
|
if (e is com.intellij.openapi.progress.ProcessCanceledException) throw e
|
||||||
|
}
|
||||||
|
|
||||||
|
// Add annotation coloring using token highlighter (treat @Label as annotation)
|
||||||
|
run {
|
||||||
|
val tokens = try { SimpleLyngHighlighter().highlight(text) } catch (_: Throwable) { emptyList() }
|
||||||
|
for (s in tokens) if (s.kind == HighlightKind.Label) {
|
||||||
|
val start = s.range.start
|
||||||
|
val end = s.range.endExclusive
|
||||||
|
if (start in 0..end && end <= text.length && start < end) {
|
||||||
|
val lexeme = try { text.substring(start, end) } catch (_: Throwable) { null }
|
||||||
|
if (lexeme != null && lexeme.startsWith("@")) {
|
||||||
|
putRange(start, end, LyngHighlighterColors.ANNOTATION)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Map Enum constants from token highlighter to IDEA enum constant color
|
||||||
|
run {
|
||||||
|
val tokens = try { SimpleLyngHighlighter().highlight(text) } catch (_: Throwable) { emptyList() }
|
||||||
|
for (s in tokens) if (s.kind == HighlightKind.EnumConstant) {
|
||||||
|
val start = s.range.start
|
||||||
|
val end = s.range.endExclusive
|
||||||
|
if (start in 0..end && end <= text.length && start < end) {
|
||||||
|
putRange(start, end, LyngHighlighterColors.ENUM_CONSTANT)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Build spell index payload: identifiers from symbols + references; comments/strings from simple highlighter
|
||||||
|
val idRanges = mutableSetOf<IntRange>()
|
||||||
|
try {
|
||||||
|
val binding = Binder.bind(text, mini)
|
||||||
|
for (sym in binding.symbols) {
|
||||||
|
val s = sym.declStart; val e = sym.declEnd
|
||||||
|
if (s in 0..e && e <= text.length && s < e) idRanges += (s until e)
|
||||||
|
}
|
||||||
|
for (ref in binding.references) {
|
||||||
|
val s = ref.start; val e = ref.end
|
||||||
|
if (s in 0..e && e <= text.length && s < e) idRanges += (s until e)
|
||||||
|
}
|
||||||
|
} catch (_: Throwable) {
|
||||||
|
// Best-effort; no identifiers if binder fails
|
||||||
|
}
|
||||||
|
val tokens = try { SimpleLyngHighlighter().highlight(text) } catch (_: Throwable) { emptyList() }
|
||||||
|
val commentRanges = tokens.filter { it.kind == HighlightKind.Comment }.map { it.range.start until it.range.endExclusive }
|
||||||
|
val stringRanges = tokens.filter { it.kind == HighlightKind.String }.map { it.range.start until it.range.endExclusive }
|
||||||
|
|
||||||
|
return Result(collectedInfo.modStamp, out, null,
|
||||||
|
spellIdentifiers = idRanges.toList(),
|
||||||
|
spellComments = commentRanges,
|
||||||
|
spellStrings = stringRanges)
|
||||||
|
}
|
||||||
|
|
||||||
|
override fun apply(file: PsiFile, annotationResult: Result?, holder: AnnotationHolder) {
|
||||||
|
if (annotationResult == null) return
|
||||||
|
// Skip if cache is up-to-date
|
||||||
|
val doc = file.viewProvider.document
|
||||||
|
val currentStamp = doc?.modificationStamp
|
||||||
|
val cached = file.getUserData(CACHE_KEY)
|
||||||
|
val result = if (cached != null && currentStamp != null && cached.modStamp == currentStamp) cached else annotationResult
|
||||||
|
file.putUserData(CACHE_KEY, result)
|
||||||
|
|
||||||
|
// Store spell index for spell/grammar engines to consume (suspend until ready)
|
||||||
|
val ids = result.spellIdentifiers.map { TextRange(it.first, it.last + 1) }
|
||||||
|
val coms = result.spellComments.map { TextRange(it.first, it.last + 1) }
|
||||||
|
val strs = result.spellStrings.map { TextRange(it.first, it.last + 1) }
|
||||||
|
net.sergeych.lyng.idea.spell.LyngSpellIndex.store(file,
|
||||||
|
net.sergeych.lyng.idea.spell.LyngSpellIndex.Data(
|
||||||
|
modStamp = result.modStamp,
|
||||||
|
identifiers = ids,
|
||||||
|
comments = coms,
|
||||||
|
strings = strs
|
||||||
|
)
|
||||||
|
)
|
||||||
|
|
||||||
|
// Optional diagnostic overlay: visualize the ranges we will feed to spellcheckers
|
||||||
|
val settings = net.sergeych.lyng.idea.settings.LyngFormatterSettings.getInstance(file.project)
|
||||||
|
if (settings.debugShowSpellFeed) {
|
||||||
|
fun paint(r: TextRange, label: String) {
|
||||||
|
holder.newAnnotation(HighlightSeverity.WEAK_WARNING, "spell-feed: $label")
|
||||||
|
.range(r)
|
||||||
|
.create()
|
||||||
|
}
|
||||||
|
ids.forEach { paint(it, "id") }
|
||||||
|
coms.forEach { paint(it, "comment") }
|
||||||
|
if (settings.spellCheckStringLiterals) strs.forEach { paint(it, "string") }
|
||||||
|
}
|
||||||
|
|
||||||
|
for (s in result.spans) {
|
||||||
|
holder.newSilentAnnotation(HighlightSeverity.INFORMATION)
|
||||||
|
.range(TextRange(s.start, s.end))
|
||||||
|
.textAttributes(s.key)
|
||||||
|
.create()
|
||||||
|
}
|
||||||
|
|
||||||
|
// Show syntax error if present
|
||||||
|
val err = result.error
|
||||||
|
if (err != null) {
|
||||||
|
val start = err.start.coerceIn(0, (doc?.textLength ?: 0))
|
||||||
|
val end = err.end.coerceIn(start, (doc?.textLength ?: start))
|
||||||
|
if (end > start) {
|
||||||
|
holder.newAnnotation(HighlightSeverity.ERROR, err.message)
|
||||||
|
.range(TextRange(start, end))
|
||||||
|
.create()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
companion object {
|
||||||
|
private val CACHE_KEY: Key<Result> = Key.create("LYNG_SEMANTIC_CACHE")
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Make the error highlight a bit wider than a single character so it is easier to see and click.
|
||||||
|
* Strategy:
|
||||||
|
* - If the offset points inside an identifier-like token (letters/digits/underscore), expand to the full token.
|
||||||
|
* - Otherwise select a small range starting at the offset with a minimum width, but not crossing the line end.
|
||||||
|
*/
|
||||||
|
private fun expandErrorRange(text: String, rawStart: Int): Pair<Int, Int> {
|
||||||
|
if (text.isEmpty()) return 0 to 0
|
||||||
|
val len = text.length
|
||||||
|
val start = rawStart.coerceIn(0, len)
|
||||||
|
fun isWord(ch: Char) = ch == '_' || ch.isLetterOrDigit()
|
||||||
|
|
||||||
|
if (start < len && isWord(text[start])) {
|
||||||
|
var s = start
|
||||||
|
var e = start
|
||||||
|
while (s > 0 && isWord(text[s - 1])) s--
|
||||||
|
while (e < len && isWord(text[e])) e++
|
||||||
|
return s to e
|
||||||
|
}
|
||||||
|
|
||||||
|
// Not inside a word: select a short, visible range up to EOL
|
||||||
|
val lineEnd = text.indexOf('\n', start).let { if (it == -1) len else it }
|
||||||
|
val minWidth = 4
|
||||||
|
val end = (start + minWidth).coerceAtMost(lineEnd).coerceAtLeast((start + 1).coerceAtMost(lineEnd))
|
||||||
|
return start to end
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,27 @@
|
|||||||
|
/*
|
||||||
|
* Copyright 2025 Sergey S. Chernov real.sergeych@gmail.com
|
||||||
|
*
|
||||||
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
* you may not use this file except in compliance with the License.
|
||||||
|
* You may obtain a copy of the License at
|
||||||
|
*
|
||||||
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
*
|
||||||
|
* Unless required by applicable law or agreed to in writing, software
|
||||||
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
* See the License for the specific language governing permissions and
|
||||||
|
* limitations under the License.
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
package net.sergeych.lyng.idea.comment
|
||||||
|
|
||||||
|
import com.intellij.lang.Commenter
|
||||||
|
|
||||||
|
class LyngCommenter : Commenter {
|
||||||
|
override fun getLineCommentPrefix(): String = "//"
|
||||||
|
override fun getBlockCommentPrefix(): String = "/*"
|
||||||
|
override fun getBlockCommentSuffix(): String = "*/"
|
||||||
|
override fun getCommentedBlockCommentPrefix(): String? = null
|
||||||
|
override fun getCommentedBlockCommentSuffix(): String? = null
|
||||||
|
}
|
||||||
+597
@@ -0,0 +1,597 @@
|
|||||||
|
/*
|
||||||
|
* Copyright 2026 Sergey S. Chernov real.sergeych@gmail.com
|
||||||
|
*
|
||||||
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
* you may not use this file except in compliance with the License.
|
||||||
|
* You may obtain a copy of the License at
|
||||||
|
*
|
||||||
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
*
|
||||||
|
* Unless required by applicable law or agreed to in writing, software
|
||||||
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
* See the License for the specific language governing permissions and
|
||||||
|
* limitations under the License.
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
|
/*
|
||||||
|
* Lightweight BASIC completion for Lyng, MVP version.
|
||||||
|
* Uses MiniAst (best-effort) + BuiltinDocRegistry to suggest symbols.
|
||||||
|
*/
|
||||||
|
package net.sergeych.lyng.idea.completion
|
||||||
|
|
||||||
|
import com.intellij.codeInsight.completion.*
|
||||||
|
import com.intellij.codeInsight.lookup.LookupElementBuilder
|
||||||
|
import com.intellij.icons.AllIcons
|
||||||
|
import com.intellij.openapi.diagnostic.Logger
|
||||||
|
import com.intellij.openapi.editor.Document
|
||||||
|
import com.intellij.patterns.PlatformPatterns
|
||||||
|
import com.intellij.psi.PsiFile
|
||||||
|
import com.intellij.util.ProcessingContext
|
||||||
|
import kotlinx.coroutines.runBlocking
|
||||||
|
import net.sergeych.lyng.highlight.offsetOf
|
||||||
|
import net.sergeych.lyng.idea.LyngLanguage
|
||||||
|
import net.sergeych.lyng.idea.highlight.LyngTokenTypes
|
||||||
|
import net.sergeych.lyng.idea.settings.LyngFormatterSettings
|
||||||
|
import net.sergeych.lyng.idea.util.DocsBootstrap
|
||||||
|
import net.sergeych.lyng.idea.util.LyngAstManager
|
||||||
|
import net.sergeych.lyng.idea.util.TextCtx
|
||||||
|
import net.sergeych.lyng.miniast.*
|
||||||
|
|
||||||
|
class LyngCompletionContributor : CompletionContributor() {
|
||||||
|
init {
|
||||||
|
extend(
|
||||||
|
CompletionType.BASIC,
|
||||||
|
PlatformPatterns.psiElement().withLanguage(LyngLanguage),
|
||||||
|
Provider
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
private object Provider : CompletionProvider<CompletionParameters>() {
|
||||||
|
private val log = Logger.getInstance(LyngCompletionContributor::class.java)
|
||||||
|
private const val DEBUG_COMPLETION = false
|
||||||
|
|
||||||
|
override fun addCompletions(
|
||||||
|
parameters: CompletionParameters,
|
||||||
|
context: ProcessingContext,
|
||||||
|
result: CompletionResultSet
|
||||||
|
) {
|
||||||
|
// Ensure external/bundled docs are registered (e.g., lyng.io.fs with Path)
|
||||||
|
DocsBootstrap.ensure()
|
||||||
|
// Ensure stdlib Obj*-defined docs (e.g., String methods via ObjString.addFnDoc) are initialized
|
||||||
|
StdlibDocsBootstrap.ensure()
|
||||||
|
val file: PsiFile = parameters.originalFile
|
||||||
|
if (file.language != LyngLanguage) return
|
||||||
|
|
||||||
|
// Disable completion inside comments
|
||||||
|
val pos = parameters.position
|
||||||
|
val et = pos.node.elementType
|
||||||
|
if (et == LyngTokenTypes.LINE_COMMENT || et == LyngTokenTypes.BLOCK_COMMENT) return
|
||||||
|
|
||||||
|
// Feature toggle: allow turning completion off from settings
|
||||||
|
val settings = LyngFormatterSettings.getInstance(file.project)
|
||||||
|
if (!settings.enableLyngCompletionExperimental) return
|
||||||
|
val document: Document = file.viewProvider.document ?: return
|
||||||
|
val text = document.text
|
||||||
|
val caret = parameters.offset.coerceIn(0, text.length)
|
||||||
|
|
||||||
|
val prefix = TextCtx.prefixAt(text, caret)
|
||||||
|
val withPrefix = result.withPrefixMatcher(prefix).caseInsensitive()
|
||||||
|
|
||||||
|
// Emission with cap
|
||||||
|
val cap = 200
|
||||||
|
var added = 0
|
||||||
|
val emit: (com.intellij.codeInsight.lookup.LookupElement) -> Unit = { le ->
|
||||||
|
if (added < cap) {
|
||||||
|
withPrefix.addElement(le)
|
||||||
|
added++
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Determine if we are in member context (dot before caret or before word start)
|
||||||
|
val wordRange = TextCtx.wordRangeAt(text, caret)
|
||||||
|
val memberDotPos = (wordRange?.let { TextCtx.findDotLeft(text, it.startOffset) })
|
||||||
|
?: TextCtx.findDotLeft(text, caret)
|
||||||
|
if (DEBUG_COMPLETION) {
|
||||||
|
log.info("[LYNG_DEBUG] Completion: caret=$caret prefix='${prefix}' memberDotPos=${memberDotPos} file='${file.name}'")
|
||||||
|
}
|
||||||
|
|
||||||
|
// Build MiniAst (cached) for both global and member contexts to enable local class/val inference
|
||||||
|
val mini = LyngAstManager.getMiniAst(file)
|
||||||
|
val binding = LyngAstManager.getBinding(file)
|
||||||
|
|
||||||
|
// Delegate computation to the shared engine to keep behavior in sync with tests
|
||||||
|
val engineItems = try {
|
||||||
|
runBlocking { CompletionEngineLight.completeSuspend(text, caret) }
|
||||||
|
} catch (t: Throwable) {
|
||||||
|
if (DEBUG_COMPLETION) log.warn("[LYNG_DEBUG] Engine completion failed: ${t.message}")
|
||||||
|
emptyList()
|
||||||
|
}
|
||||||
|
if (DEBUG_COMPLETION) {
|
||||||
|
val preview = engineItems.take(10).joinToString { it.name }
|
||||||
|
log.info("[LYNG_DEBUG] Engine items: count=${engineItems.size} preview=[${preview}]")
|
||||||
|
}
|
||||||
|
|
||||||
|
// If we are in member context and the engine produced nothing, try a guarded local fallback
|
||||||
|
if (memberDotPos != null && engineItems.isEmpty()) {
|
||||||
|
if (DEBUG_COMPLETION) log.info("[LYNG_DEBUG] Fallback: engine returned 0 in member context; trying local inference")
|
||||||
|
// Build imported modules from text (lenient) + stdlib; avoid heavy MiniAst here
|
||||||
|
val fromText = extractImportsFromText(text)
|
||||||
|
val imported = LinkedHashSet<String>().apply {
|
||||||
|
fromText.forEach { add(it) }
|
||||||
|
add("lyng.stdlib")
|
||||||
|
}.toList()
|
||||||
|
|
||||||
|
// Try inferring return/receiver class around the dot
|
||||||
|
val inferred =
|
||||||
|
// Prefer MiniAst-based inference (return type from member call or receiver type)
|
||||||
|
DocLookupUtils.guessReturnClassFromMemberCallBeforeMini(mini, text, memberDotPos, imported, binding)
|
||||||
|
?: DocLookupUtils.guessReceiverClassViaMini(mini, text, memberDotPos, imported, binding)
|
||||||
|
?:
|
||||||
|
DocLookupUtils.guessReturnClassFromMemberCallBefore(text, memberDotPos, imported, mini)
|
||||||
|
?: DocLookupUtils.guessReturnClassFromTopLevelCallBefore(text, memberDotPos, imported, mini)
|
||||||
|
?: DocLookupUtils.guessReturnClassAcrossKnownCallees(text, memberDotPos, imported, mini)
|
||||||
|
?: DocLookupUtils.guessReceiverClass(text, memberDotPos, imported, mini)
|
||||||
|
|
||||||
|
if (inferred != null) {
|
||||||
|
if (DEBUG_COMPLETION) log.info("[LYNG_DEBUG] Fallback inferred receiver/return class='$inferred' — offering its members")
|
||||||
|
offerMembers(emit, imported, inferred, sourceText = text, mini = mini)
|
||||||
|
return
|
||||||
|
} else {
|
||||||
|
if (DEBUG_COMPLETION) log.info("[LYNG_DEBUG] Fallback could not infer class; keeping list empty (no globals after dot)")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// In global context, add params in scope first (engine does not include them)
|
||||||
|
if (memberDotPos == null && mini != null) {
|
||||||
|
offerParamsInScope(emit, mini, text, caret)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Render engine items
|
||||||
|
for (ci in engineItems) {
|
||||||
|
val builder = when (ci.kind) {
|
||||||
|
Kind.Function -> LookupElementBuilder.create(ci.name)
|
||||||
|
.withIcon(AllIcons.Nodes.Function)
|
||||||
|
.let { b -> if (!ci.tailText.isNullOrBlank()) b.withTailText(ci.tailText, true) else b }
|
||||||
|
.let { b -> if (!ci.typeText.isNullOrBlank()) b.withTypeText(ci.typeText, true) else b }
|
||||||
|
.withInsertHandler(ParenInsertHandler)
|
||||||
|
Kind.Method -> LookupElementBuilder.create(ci.name)
|
||||||
|
.withIcon(AllIcons.Nodes.Method)
|
||||||
|
.let { b -> if (!ci.tailText.isNullOrBlank()) b.withTailText(ci.tailText, true) else b }
|
||||||
|
.let { b -> if (!ci.typeText.isNullOrBlank()) b.withTypeText(ci.typeText, true) else b }
|
||||||
|
.withInsertHandler(ParenInsertHandler)
|
||||||
|
Kind.Class_ -> LookupElementBuilder.create(ci.name)
|
||||||
|
.withIcon(AllIcons.Nodes.Class)
|
||||||
|
Kind.Enum -> LookupElementBuilder.create(ci.name)
|
||||||
|
.withIcon(AllIcons.Nodes.Enum)
|
||||||
|
Kind.Value -> LookupElementBuilder.create(ci.name)
|
||||||
|
.withIcon(AllIcons.Nodes.Field)
|
||||||
|
.let { b -> if (!ci.typeText.isNullOrBlank()) b.withTypeText(ci.typeText, true) else b }
|
||||||
|
Kind.Field -> LookupElementBuilder.create(ci.name)
|
||||||
|
.withIcon(AllIcons.Nodes.Field)
|
||||||
|
.let { b -> if (!ci.typeText.isNullOrBlank()) b.withTypeText(ci.typeText, true) else b }
|
||||||
|
}
|
||||||
|
emit(builder)
|
||||||
|
}
|
||||||
|
// In member context, ensure stdlib extension-like methods (e.g., String.re) are present
|
||||||
|
if (memberDotPos != null) {
|
||||||
|
val existing = engineItems.map { it.name }.toMutableSet()
|
||||||
|
val fromText = extractImportsFromText(text)
|
||||||
|
val imported = LinkedHashSet<String>().apply {
|
||||||
|
fromText.forEach { add(it) }
|
||||||
|
add("lyng.stdlib")
|
||||||
|
}.toList()
|
||||||
|
val inferredClass =
|
||||||
|
DocLookupUtils.guessReturnClassFromMemberCallBeforeMini(mini, text, memberDotPos, imported, binding)
|
||||||
|
?: DocLookupUtils.guessReceiverClassViaMini(mini, text, memberDotPos, imported, binding)
|
||||||
|
?: DocLookupUtils.guessReturnClassFromMemberCallBefore(text, memberDotPos, imported, mini)
|
||||||
|
?: DocLookupUtils.guessReturnClassFromTopLevelCallBefore(text, memberDotPos, imported, mini)
|
||||||
|
?: DocLookupUtils.guessReturnClassAcrossKnownCallees(text, memberDotPos, imported, mini)
|
||||||
|
?: DocLookupUtils.guessReceiverClass(text, memberDotPos, imported, mini)
|
||||||
|
if (!inferredClass.isNullOrBlank()) {
|
||||||
|
val ext = BuiltinDocRegistry.extensionMemberNamesFor(inferredClass)
|
||||||
|
if (DEBUG_COMPLETION) log.info("[LYNG_DEBUG] Post-engine extension check for $inferredClass: ${'$'}{ext}")
|
||||||
|
for (name in ext) {
|
||||||
|
if (existing.contains(name)) continue
|
||||||
|
val resolved = DocLookupUtils.resolveMemberWithInheritance(imported, inferredClass, name, mini)
|
||||||
|
if (resolved != null) {
|
||||||
|
when (val member = resolved.second) {
|
||||||
|
is MiniMemberFunDecl -> {
|
||||||
|
val params = member.params.joinToString(", ") { it.name }
|
||||||
|
val ret = typeOf(member.returnType)
|
||||||
|
val builder = LookupElementBuilder.create(name)
|
||||||
|
.withIcon(AllIcons.Nodes.Method)
|
||||||
|
.withTailText("(${ '$' }params)", true)
|
||||||
|
.withTypeText(ret, true)
|
||||||
|
.withInsertHandler(ParenInsertHandler)
|
||||||
|
emit(builder)
|
||||||
|
existing.add(name)
|
||||||
|
}
|
||||||
|
is MiniMemberValDecl -> {
|
||||||
|
val builder = LookupElementBuilder.create(name)
|
||||||
|
.withIcon(if (member.mutable) AllIcons.Nodes.Variable else AllIcons.Nodes.Field)
|
||||||
|
.withTypeText(typeOf(member.type), true)
|
||||||
|
emit(builder)
|
||||||
|
existing.add(name)
|
||||||
|
}
|
||||||
|
is MiniInitDecl -> {}
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
// Fallback: emit simple method name without detailed types
|
||||||
|
val builder = LookupElementBuilder.create(name)
|
||||||
|
.withIcon(AllIcons.Nodes.Method)
|
||||||
|
.withTailText("()", true)
|
||||||
|
.withInsertHandler(ParenInsertHandler)
|
||||||
|
emit(builder)
|
||||||
|
existing.add(name)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
// If in member context and engine items are suspiciously sparse, try to enrich via local inference + offerMembers
|
||||||
|
if (memberDotPos != null && engineItems.size < 3) {
|
||||||
|
if (DEBUG_COMPLETION) log.info("[LYNG_DEBUG] Engine produced only ${engineItems.size} items in member context — trying enrichment")
|
||||||
|
val fromText = extractImportsFromText(text)
|
||||||
|
val imported = LinkedHashSet<String>().apply {
|
||||||
|
fromText.forEach { add(it) }
|
||||||
|
add("lyng.stdlib")
|
||||||
|
}.toList()
|
||||||
|
val inferred =
|
||||||
|
DocLookupUtils.guessReturnClassFromMemberCallBeforeMini(mini, text, memberDotPos, imported, binding)
|
||||||
|
?: DocLookupUtils.guessReceiverClassViaMini(mini, text, memberDotPos, imported, binding)
|
||||||
|
?: DocLookupUtils.guessReturnClassFromMemberCallBefore(text, memberDotPos, imported, mini)
|
||||||
|
?: DocLookupUtils.guessReturnClassFromTopLevelCallBefore(text, memberDotPos, imported, mini)
|
||||||
|
?: DocLookupUtils.guessReturnClassAcrossKnownCallees(text, memberDotPos, imported, mini)
|
||||||
|
?: DocLookupUtils.guessReceiverClass(text, memberDotPos, imported, mini)
|
||||||
|
if (inferred != null) {
|
||||||
|
if (DEBUG_COMPLETION) log.info("[LYNG_DEBUG] Enrichment inferred class='$inferred' — offering its members")
|
||||||
|
offerMembers(emit, imported, inferred, sourceText = text, mini = mini)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
private fun offerDecl(emit: (com.intellij.codeInsight.lookup.LookupElement) -> Unit, d: MiniDecl) {
|
||||||
|
val name = d.name
|
||||||
|
val builder = when (d) {
|
||||||
|
is MiniFunDecl -> {
|
||||||
|
val params = d.params.joinToString(", ") { it.name }
|
||||||
|
val ret = typeOf(d.returnType)
|
||||||
|
val tail = "(${params})"
|
||||||
|
LookupElementBuilder.create(name)
|
||||||
|
.withIcon(AllIcons.Nodes.Function)
|
||||||
|
.withTailText(tail, true)
|
||||||
|
.withTypeText(ret, true)
|
||||||
|
.withInsertHandler(ParenInsertHandler)
|
||||||
|
}
|
||||||
|
is MiniClassDecl -> LookupElementBuilder.create(name)
|
||||||
|
.withIcon(AllIcons.Nodes.Class)
|
||||||
|
is MiniValDecl -> {
|
||||||
|
val kindIcon = if (d.mutable) AllIcons.Nodes.Variable else AllIcons.Nodes.Field
|
||||||
|
LookupElementBuilder.create(name)
|
||||||
|
.withIcon(kindIcon)
|
||||||
|
.withTypeText(typeOf(d.type), true)
|
||||||
|
}
|
||||||
|
is MiniEnumDecl -> LookupElementBuilder.create(name)
|
||||||
|
.withIcon(AllIcons.Nodes.Enum)
|
||||||
|
}
|
||||||
|
emit(builder)
|
||||||
|
}
|
||||||
|
|
||||||
|
private object ParenInsertHandler : InsertHandler<com.intellij.codeInsight.lookup.LookupElement> {
|
||||||
|
override fun handleInsert(context: InsertionContext, item: com.intellij.codeInsight.lookup.LookupElement) {
|
||||||
|
val doc = context.document
|
||||||
|
val tailOffset = context.tailOffset
|
||||||
|
val nextChar = doc.charsSequence.getOrNull(tailOffset)
|
||||||
|
if (nextChar != '(') {
|
||||||
|
doc.insertString(tailOffset, "()")
|
||||||
|
context.editor.caretModel.moveToOffset(tailOffset + 1)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// --- Member completion helpers ---
|
||||||
|
|
||||||
|
private fun offerMembers(
|
||||||
|
emit: (com.intellij.codeInsight.lookup.LookupElement) -> Unit,
|
||||||
|
imported: List<String>,
|
||||||
|
className: String,
|
||||||
|
staticOnly: Boolean = false
|
||||||
|
, sourceText: String,
|
||||||
|
mini: MiniScript? = null
|
||||||
|
) {
|
||||||
|
val classes = DocLookupUtils.aggregateClasses(imported, mini)
|
||||||
|
if (DEBUG_COMPLETION) {
|
||||||
|
val keys = classes.keys.joinToString(", ")
|
||||||
|
log.info("[LYNG_DEBUG] offerMembers: imported=${imported} classes=[${keys}] target=${className}")
|
||||||
|
}
|
||||||
|
val visited = mutableSetOf<String>()
|
||||||
|
// Collect separated to keep tiers: direct first, then inherited
|
||||||
|
val directMap = LinkedHashMap<String, MutableList<MiniMemberDecl>>()
|
||||||
|
val inheritedMap = LinkedHashMap<String, MutableList<MiniMemberDecl>>()
|
||||||
|
|
||||||
|
// 0) Prefer locally-declared class members (same-file) when available
|
||||||
|
val localClass = mini?.declarations?.filterIsInstance<MiniClassDecl>()?.firstOrNull { it.name == className }
|
||||||
|
if (localClass != null) {
|
||||||
|
for (m in localClass.members) {
|
||||||
|
val list = directMap.getOrPut(m.name) { mutableListOf() }
|
||||||
|
list.add(m)
|
||||||
|
}
|
||||||
|
// If MiniAst didn't populate members (empty), try to scan class body text for member signatures
|
||||||
|
if (localClass.members.isEmpty()) {
|
||||||
|
val scanned = DocLookupUtils.scanLocalClassMembersFromText(mini, text = sourceText, cls = localClass)
|
||||||
|
if (DEBUG_COMPLETION) log.info("[LYNG_DEBUG] Local scan for class ${localClass.name}: found ${scanned.size} members -> ${scanned.keys}")
|
||||||
|
for ((name, sig) in scanned) {
|
||||||
|
when (sig.kind) {
|
||||||
|
"fun" -> {
|
||||||
|
val builder = LookupElementBuilder.create(name)
|
||||||
|
.withIcon(AllIcons.Nodes.Method)
|
||||||
|
.withTailText("(" + (sig.params?.joinToString(", ") ?: "") + ")", true)
|
||||||
|
.let { b -> sig.typeText?.let { b.withTypeText(": $it", true) } ?: b }
|
||||||
|
.withInsertHandler(ParenInsertHandler)
|
||||||
|
emit(builder)
|
||||||
|
}
|
||||||
|
"val", "var" -> {
|
||||||
|
val builder = LookupElementBuilder.create(name)
|
||||||
|
.withIcon(if (sig.kind == "var") AllIcons.Nodes.Variable else AllIcons.Nodes.Field)
|
||||||
|
.let { b -> sig.typeText?.let { b.withTypeText(": $it", true) } ?: b }
|
||||||
|
emit(builder)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
fun addMembersOf(clsName: String, tierDirect: Boolean) {
|
||||||
|
val cls = classes[clsName] ?: return
|
||||||
|
val target = if (tierDirect) directMap else inheritedMap
|
||||||
|
for (m in cls.members) {
|
||||||
|
if (staticOnly) {
|
||||||
|
// Filter only static members in namespace/static context
|
||||||
|
when (m) {
|
||||||
|
is MiniMemberFunDecl -> if (!m.isStatic) continue
|
||||||
|
is MiniMemberValDecl -> if (!m.isStatic) continue
|
||||||
|
is MiniInitDecl -> continue
|
||||||
|
}
|
||||||
|
}
|
||||||
|
val list = target.getOrPut(m.name) { mutableListOf() }
|
||||||
|
list.add(m)
|
||||||
|
}
|
||||||
|
// Then inherited
|
||||||
|
for (base in cls.bases) {
|
||||||
|
if (visited.add(base)) addMembersOf(base, false)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
visited.add(className)
|
||||||
|
addMembersOf(className, true)
|
||||||
|
if (DEBUG_COMPLETION) {
|
||||||
|
log.info("[LYNG_DEBUG] offerMembers: direct=${directMap.size} inherited=${inheritedMap.size} for ${className}")
|
||||||
|
}
|
||||||
|
|
||||||
|
// If the docs model lacks explicit bases for some core container classes,
|
||||||
|
// conservatively supplement with preferred parents to expose common ops.
|
||||||
|
fun supplementPreferredBases(receiver: String) {
|
||||||
|
// Preference/known lineage map kept tiny and safe
|
||||||
|
val extras = when (receiver) {
|
||||||
|
"List" -> listOf("Collection", "Iterable")
|
||||||
|
"Array" -> listOf("Collection", "Iterable")
|
||||||
|
// In practice, many high-level ops users expect on iteration live on Iterable.
|
||||||
|
// For editor assistance, expose Iterable ops for Iterator receivers too.
|
||||||
|
"Iterator" -> listOf("Iterable")
|
||||||
|
else -> emptyList()
|
||||||
|
}
|
||||||
|
for (base in extras) {
|
||||||
|
if (visited.add(base)) addMembersOf(base, false)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
supplementPreferredBases(className)
|
||||||
|
|
||||||
|
fun emitGroup(map: LinkedHashMap<String, MutableList<MiniMemberDecl>>) {
|
||||||
|
val keys = map.keys.sortedBy { it.lowercase() }
|
||||||
|
for (name in keys) {
|
||||||
|
val list = map[name] ?: continue
|
||||||
|
// Choose a representative for display:
|
||||||
|
// 1) Prefer a method with a known return type
|
||||||
|
// 2) Else any method
|
||||||
|
// 3) Else the first variant
|
||||||
|
val rep =
|
||||||
|
list.asSequence()
|
||||||
|
.filterIsInstance<MiniMemberFunDecl>()
|
||||||
|
.firstOrNull { it.returnType != null }
|
||||||
|
?: list.firstOrNull { it is MiniMemberFunDecl }
|
||||||
|
?: list.first()
|
||||||
|
when (rep) {
|
||||||
|
is MiniMemberFunDecl -> {
|
||||||
|
val params = rep.params.joinToString(", ") { it.name }
|
||||||
|
val ret = typeOf(rep.returnType)
|
||||||
|
val extra = list.count { it is MiniMemberFunDecl } - 1
|
||||||
|
val overloads = if (extra > 0) " (+$extra overloads)" else ""
|
||||||
|
val tail = "(${params})$overloads"
|
||||||
|
val icon = AllIcons.Nodes.Method
|
||||||
|
val builder = LookupElementBuilder.create(name)
|
||||||
|
.withIcon(icon)
|
||||||
|
.withTailText(tail, true)
|
||||||
|
.withTypeText(ret, true)
|
||||||
|
.withInsertHandler(ParenInsertHandler)
|
||||||
|
emit(builder)
|
||||||
|
}
|
||||||
|
is MiniMemberValDecl -> {
|
||||||
|
val icon = if (rep.mutable) AllIcons.Nodes.Variable else AllIcons.Nodes.Field
|
||||||
|
// Prefer a field variant with known type if available
|
||||||
|
val chosen = list.asSequence()
|
||||||
|
.filterIsInstance<MiniMemberValDecl>()
|
||||||
|
.firstOrNull { it.type != null } ?: rep
|
||||||
|
val builder = LookupElementBuilder.create(name)
|
||||||
|
.withIcon(icon)
|
||||||
|
.withTypeText(typeOf(chosen.type), true)
|
||||||
|
emit(builder)
|
||||||
|
}
|
||||||
|
is MiniInitDecl -> {}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Emit what we have first
|
||||||
|
emitGroup(directMap)
|
||||||
|
emitGroup(inheritedMap)
|
||||||
|
|
||||||
|
// If suggestions are suspiciously sparse for known container classes,
|
||||||
|
// try to conservatively supplement using a curated list resolved via docs registry.
|
||||||
|
val totalSuggested = directMap.size + inheritedMap.size
|
||||||
|
val isContainer = className in setOf("Iterator", "Iterable", "Collection", "List", "Array")
|
||||||
|
if (isContainer && totalSuggested < 3) {
|
||||||
|
if (DEBUG_COMPLETION) log.info("[LYNG_DEBUG] Supplementing members for $className; had=$totalSuggested")
|
||||||
|
val common = when (className) {
|
||||||
|
"Iterator" -> listOf(
|
||||||
|
"hasNext", "next", "forEach", "map", "filter", "take", "drop", "toList", "count", "any", "all"
|
||||||
|
)
|
||||||
|
else -> listOf(
|
||||||
|
// Iterable/Collection/List/Array common ops
|
||||||
|
"size", "isEmpty", "map", "flatMap", "filter", "first", "last", "contains",
|
||||||
|
"any", "all", "count", "forEach", "toList", "toSet"
|
||||||
|
)
|
||||||
|
}
|
||||||
|
val already = (directMap.keys + inheritedMap.keys).toMutableSet()
|
||||||
|
for (name in common) {
|
||||||
|
if (name in already) continue
|
||||||
|
// Try resolve across classes first to get types/params; if it fails, emit a synthetic safe suggestion.
|
||||||
|
val resolved = DocLookupUtils.findMemberAcrossClasses(imported, name)
|
||||||
|
if (resolved != null) {
|
||||||
|
val member = resolved.second
|
||||||
|
when (member) {
|
||||||
|
is MiniMemberFunDecl -> {
|
||||||
|
val params = member.params.joinToString(", ") { it.name }
|
||||||
|
val ret = typeOf(member.returnType)
|
||||||
|
val builder = LookupElementBuilder.create(name)
|
||||||
|
.withIcon(AllIcons.Nodes.Method)
|
||||||
|
.withTailText("(${params})", true)
|
||||||
|
.withTypeText(ret, true)
|
||||||
|
.withInsertHandler(ParenInsertHandler)
|
||||||
|
emit(builder)
|
||||||
|
already.add(name)
|
||||||
|
}
|
||||||
|
is MiniMemberValDecl -> {
|
||||||
|
val builder = LookupElementBuilder.create(name)
|
||||||
|
.withIcon(AllIcons.Nodes.Field)
|
||||||
|
.withTypeText(typeOf(member.type), true)
|
||||||
|
emit(builder)
|
||||||
|
already.add(name)
|
||||||
|
}
|
||||||
|
is MiniInitDecl -> {}
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
// Synthetic fallback: method without detailed params/types to improve UX in absence of docs
|
||||||
|
val isProperty = name in setOf("size", "length")
|
||||||
|
val builder = if (isProperty) {
|
||||||
|
LookupElementBuilder.create(name)
|
||||||
|
.withIcon(AllIcons.Nodes.Field)
|
||||||
|
} else {
|
||||||
|
LookupElementBuilder.create(name)
|
||||||
|
.withIcon(AllIcons.Nodes.Method)
|
||||||
|
.withTailText("()", true)
|
||||||
|
.withInsertHandler(ParenInsertHandler)
|
||||||
|
}
|
||||||
|
emit(builder)
|
||||||
|
already.add(name)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Supplement with stdlib extension members defined in root.lyng (e.g., fun String.trim(...))
|
||||||
|
run {
|
||||||
|
val already = (directMap.keys + inheritedMap.keys).toMutableSet()
|
||||||
|
val ext = BuiltinDocRegistry.extensionMemberNamesFor(className)
|
||||||
|
if (DEBUG_COMPLETION) log.info("[LYNG_DEBUG] Extensions for $className: count=${ext.size} -> ${ext}")
|
||||||
|
for (name in ext) {
|
||||||
|
if (already.contains(name)) continue
|
||||||
|
// Try to resolve full signature via registry first to get params and return type
|
||||||
|
val resolved = DocLookupUtils.resolveMemberWithInheritance(imported, className, name)
|
||||||
|
if (resolved != null) {
|
||||||
|
when (val member = resolved.second) {
|
||||||
|
is MiniMemberFunDecl -> {
|
||||||
|
val params = member.params.joinToString(", ") { it.name }
|
||||||
|
val ret = typeOf(member.returnType)
|
||||||
|
val builder = LookupElementBuilder.create(name)
|
||||||
|
.withIcon(AllIcons.Nodes.Method)
|
||||||
|
.withTailText("(${params})", true)
|
||||||
|
.withTypeText(ret, true)
|
||||||
|
.withInsertHandler(ParenInsertHandler)
|
||||||
|
emit(builder)
|
||||||
|
already.add(name)
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
is MiniMemberValDecl -> {
|
||||||
|
val builder = LookupElementBuilder.create(name)
|
||||||
|
.withIcon(if (member.mutable) AllIcons.Nodes.Variable else AllIcons.Nodes.Field)
|
||||||
|
.withTypeText(typeOf(member.type), true)
|
||||||
|
emit(builder)
|
||||||
|
already.add(name)
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
is MiniInitDecl -> {}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
// Fallback: emit without detailed types if we couldn't resolve
|
||||||
|
val builder = LookupElementBuilder.create(name)
|
||||||
|
.withIcon(AllIcons.Nodes.Method)
|
||||||
|
.withTailText("()", true)
|
||||||
|
.withInsertHandler(ParenInsertHandler)
|
||||||
|
emit(builder)
|
||||||
|
already.add(name)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// --- MiniAst-based inference helpers ---
|
||||||
|
|
||||||
|
private fun offerParamsInScope(emit: (com.intellij.codeInsight.lookup.LookupElement) -> Unit, mini: MiniScript, text: String, caret: Int) {
|
||||||
|
val src = mini.range.start.source
|
||||||
|
// Find function whose body contains caret or whose whole range contains caret
|
||||||
|
val fns = mini.declarations.filterIsInstance<MiniFunDecl>()
|
||||||
|
for (fn in fns) {
|
||||||
|
val start = src.offsetOf(fn.range.start)
|
||||||
|
val end = src.offsetOf(fn.range.end).coerceAtMost(text.length)
|
||||||
|
if (caret in start..end) {
|
||||||
|
for (p in fn.params) {
|
||||||
|
val builder = LookupElementBuilder.create(p.name)
|
||||||
|
.withIcon(AllIcons.Nodes.Variable)
|
||||||
|
.withTypeText(typeOf(p.type), true)
|
||||||
|
emit(builder)
|
||||||
|
}
|
||||||
|
return
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Lenient textual import extractor (duplicated from QuickDoc privately)
|
||||||
|
private fun extractImportsFromText(text: String): List<String> {
|
||||||
|
val result = LinkedHashSet<String>()
|
||||||
|
val re = Regex("^\\s*import\\s+([a-zA-Z_][a-zA-Z0-9_]*(?:\\.[a-zA-Z_][a-zA-Z0-9_]*)*)", RegexOption.MULTILINE)
|
||||||
|
re.findAll(text).forEach { m ->
|
||||||
|
val raw = m.groupValues.getOrNull(1)?.trim().orEmpty()
|
||||||
|
if (raw.isNotEmpty()) {
|
||||||
|
val canon = if (raw.startsWith("lyng.")) raw else "lyng.$raw"
|
||||||
|
result.add(canon)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return result.toList()
|
||||||
|
}
|
||||||
|
|
||||||
|
private fun typeOf(t: MiniTypeRef?): String {
|
||||||
|
return when (t) {
|
||||||
|
null -> ""
|
||||||
|
is MiniTypeName -> t.segments.lastOrNull()?.name?.let { ": $it" } ?: ""
|
||||||
|
is MiniGenericType -> {
|
||||||
|
val base = typeOf(t.base).removePrefix(": ")
|
||||||
|
val args = t.args.joinToString(",") { typeOf(it).removePrefix(": ") }
|
||||||
|
": ${base}<${args}>"
|
||||||
|
}
|
||||||
|
is MiniFunctionType -> ": (fn)"
|
||||||
|
is MiniTypeVar -> ": ${t.name}"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,55 @@
|
|||||||
|
/*
|
||||||
|
* Minimal fallback docs seeding for `lyng.io.fs` used only inside the IDEA plugin
|
||||||
|
* when external docs module (lyngio) is not present on the classpath.
|
||||||
|
*
|
||||||
|
* We keep it tiny and plugin-local to avoid coupling core library to external packages.
|
||||||
|
*/
|
||||||
|
package net.sergeych.lyng.idea.docs
|
||||||
|
|
||||||
|
import net.sergeych.lyng.miniast.BuiltinDocRegistry
|
||||||
|
import net.sergeych.lyng.miniast.ParamDoc
|
||||||
|
import net.sergeych.lyng.miniast.TypeGenericDoc
|
||||||
|
import net.sergeych.lyng.miniast.type
|
||||||
|
|
||||||
|
internal object FsDocsFallback {
|
||||||
|
@Volatile
|
||||||
|
private var seeded = false
|
||||||
|
|
||||||
|
fun ensureOnce(): Boolean {
|
||||||
|
if (seeded) return true
|
||||||
|
synchronized(this) {
|
||||||
|
if (seeded) return true
|
||||||
|
BuiltinDocRegistry.module("lyng.io.fs") {
|
||||||
|
// Class Path summary and a few commonly used methods
|
||||||
|
classDoc(name = "Path", doc = "Filesystem path class. Construct with a string: `Path(\"/tmp\")`.") {
|
||||||
|
method(name = "exists", doc = "Whether the path exists on the filesystem.", returns = type("lyng.Bool"))
|
||||||
|
method(name = "isFile", doc = "Whether the path exists and is a file.", returns = type("lyng.Bool"))
|
||||||
|
method(name = "isDir", doc = "Whether the path exists and is a directory.", returns = type("lyng.Bool"))
|
||||||
|
method(name = "readUtf8", doc = "Read the entire file as UTF-8 string.", returns = type("lyng.String"))
|
||||||
|
method(
|
||||||
|
name = "writeUtf8",
|
||||||
|
doc = "Write UTF-8 string to the file (overwrite).",
|
||||||
|
params = listOf(ParamDoc("text", type("lyng.String")))
|
||||||
|
)
|
||||||
|
method(
|
||||||
|
name = "bytes",
|
||||||
|
doc = "Iterate file content as `Buffer` chunks.",
|
||||||
|
params = listOf(ParamDoc("size", type("lyng.Int"))),
|
||||||
|
returns = TypeGenericDoc(type("lyng.Iterator"), listOf(type("lyng.Buffer")))
|
||||||
|
)
|
||||||
|
method(
|
||||||
|
name = "lines",
|
||||||
|
doc = "Iterate file as lines of text.",
|
||||||
|
returns = TypeGenericDoc(type("lyng.Iterator"), listOf(type("lyng.String")))
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Top-level exported constants
|
||||||
|
valDoc(name = "Path", doc = "Filesystem path class. Construct with a string: `Path(\"/tmp\")`.", type = type("Path"))
|
||||||
|
valDoc(name = "Paths", doc = "Alias of `Path` for those who prefer plural form.", type = type("Path"))
|
||||||
|
}
|
||||||
|
seeded = true
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,670 @@
|
|||||||
|
/*
|
||||||
|
* Copyright 2026 Sergey S. Chernov real.sergeych@gmail.com
|
||||||
|
*
|
||||||
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
* you may not use this file except in compliance with the License.
|
||||||
|
* You may obtain a copy of the License at
|
||||||
|
*
|
||||||
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
*
|
||||||
|
* Unless required by applicable law or agreed to in writing, software
|
||||||
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
* See the License for the specific language governing permissions and
|
||||||
|
* limitations under the License.
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
|
package net.sergeych.lyng.idea.docs
|
||||||
|
|
||||||
|
import com.intellij.lang.documentation.AbstractDocumentationProvider
|
||||||
|
import com.intellij.openapi.diagnostic.Logger
|
||||||
|
import com.intellij.openapi.editor.Document
|
||||||
|
import com.intellij.openapi.editor.Editor
|
||||||
|
import com.intellij.openapi.util.TextRange
|
||||||
|
import com.intellij.psi.PsiElement
|
||||||
|
import com.intellij.psi.PsiFile
|
||||||
|
import kotlinx.coroutines.runBlocking
|
||||||
|
import net.sergeych.lyng.Compiler
|
||||||
|
import net.sergeych.lyng.Pos
|
||||||
|
import net.sergeych.lyng.Source
|
||||||
|
import net.sergeych.lyng.highlight.offsetOf
|
||||||
|
import net.sergeych.lyng.idea.LyngLanguage
|
||||||
|
import net.sergeych.lyng.idea.util.IdeLenientImportProvider
|
||||||
|
import net.sergeych.lyng.idea.util.TextCtx
|
||||||
|
import net.sergeych.lyng.miniast.*
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Quick Docs backed by MiniAst: when caret is on an identifier that corresponds
|
||||||
|
* to a declaration name or parameter, render a simple HTML with kind, signature,
|
||||||
|
* and doc summary if present.
|
||||||
|
*/
|
||||||
|
class LyngDocumentationProvider : AbstractDocumentationProvider() {
|
||||||
|
private val log = Logger.getInstance(LyngDocumentationProvider::class.java)
|
||||||
|
// Toggle to trace inheritance-based resolutions in Quick Docs. Keep false for normal use.
|
||||||
|
private val DEBUG_INHERITANCE = false
|
||||||
|
// Global Quick Doc debug toggle (OFF by default). When false, [LYNG_DEBUG] logs are suppressed.
|
||||||
|
private val DEBUG_LOG = false
|
||||||
|
override fun generateDoc(element: PsiElement?, originalElement: PsiElement?): String? {
|
||||||
|
// Try load external docs registrars (e.g., lyngio) if present on classpath
|
||||||
|
ensureExternalDocsRegistered()
|
||||||
|
// Ensure stdlib Obj*-defined docs (e.g., String methods via ObjString.addFnDoc) are initialized
|
||||||
|
try {
|
||||||
|
net.sergeych.lyng.miniast.StdlibDocsBootstrap.ensure()
|
||||||
|
} catch (_: Throwable) {
|
||||||
|
// best-effort; absence must not break Quick Doc
|
||||||
|
}
|
||||||
|
if (element == null) return null
|
||||||
|
val file: PsiFile = element.containingFile ?: return null
|
||||||
|
val document: Document = file.viewProvider.document ?: return null
|
||||||
|
val text = document.text
|
||||||
|
|
||||||
|
// Determine caret/lookup offset from the element range
|
||||||
|
val offset = originalElement?.textRange?.startOffset ?: element.textRange.startOffset
|
||||||
|
val idRange = TextCtx.wordRangeAt(text, offset) ?: run {
|
||||||
|
if (DEBUG_LOG) log.info("[LYNG_DEBUG] QuickDoc: no word at offset=$offset in ${file.name}")
|
||||||
|
return null
|
||||||
|
}
|
||||||
|
if (idRange.isEmpty) return null
|
||||||
|
val ident = text.substring(idRange.startOffset, idRange.endOffset)
|
||||||
|
if (DEBUG_LOG) log.info("[LYNG_DEBUG] QuickDoc: ident='$ident' at ${idRange.startOffset}..${idRange.endOffset} in ${file.name}")
|
||||||
|
|
||||||
|
// Build MiniAst for this file (fast and resilient). Best-effort; on failure continue with partial AST.
|
||||||
|
val sink = MiniAstBuilder()
|
||||||
|
val provider = IdeLenientImportProvider.create()
|
||||||
|
val src = Source("<ide>", text)
|
||||||
|
val mini = try {
|
||||||
|
runBlocking { Compiler.compileWithMini(src, provider, sink) }
|
||||||
|
sink.build()
|
||||||
|
} catch (t: Throwable) {
|
||||||
|
if (DEBUG_LOG) log.warn("[LYNG_DEBUG] QuickDoc: compileWithMini produced partial AST: ${t.message}")
|
||||||
|
sink.build()
|
||||||
|
} ?: MiniScript(MiniRange(Pos(src, 1, 1), Pos(src, 1, 1)))
|
||||||
|
val source = src
|
||||||
|
|
||||||
|
// Try resolve to: function param at position, function/class/val declaration at position
|
||||||
|
// 1) Use unified declaration detection
|
||||||
|
DocLookupUtils.findDeclarationAt(mini, offset, ident)?.let { (name, kind) ->
|
||||||
|
if (DEBUG_LOG) log.info("[LYNG_DEBUG] QuickDoc: matched declaration '$name' kind=$kind")
|
||||||
|
// Find the actual declaration object to render
|
||||||
|
for (d in mini.declarations) {
|
||||||
|
if (d.name == name && source.offsetOf(d.nameStart) <= offset && source.offsetOf(d.nameStart) + d.name.length > offset) {
|
||||||
|
return renderDeclDoc(d)
|
||||||
|
}
|
||||||
|
// Handle members if it was a member
|
||||||
|
if (d is MiniClassDecl) {
|
||||||
|
for (m in d.members) {
|
||||||
|
if (m.name == name && source.offsetOf(m.nameStart) <= offset && source.offsetOf(m.nameStart) + m.name.length > offset) {
|
||||||
|
return when (m) {
|
||||||
|
is MiniMemberFunDecl -> renderMemberFunDoc(d.name, m)
|
||||||
|
is MiniMemberValDecl -> renderMemberValDoc(d.name, m)
|
||||||
|
is MiniInitDecl -> null
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
for (cf in d.ctorFields) {
|
||||||
|
if (cf.name == name && source.offsetOf(cf.nameStart) <= offset && source.offsetOf(cf.nameStart) + cf.name.length > offset) {
|
||||||
|
// Render as a member val
|
||||||
|
val mv = MiniMemberValDecl(
|
||||||
|
range = MiniRange(cf.nameStart, cf.nameStart), // dummy
|
||||||
|
name = cf.name,
|
||||||
|
mutable = cf.mutable,
|
||||||
|
type = cf.type,
|
||||||
|
doc = null,
|
||||||
|
nameStart = cf.nameStart
|
||||||
|
)
|
||||||
|
return renderMemberValDoc(d.name, mv)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
for (cf in d.classFields) {
|
||||||
|
if (cf.name == name && source.offsetOf(cf.nameStart) <= offset && source.offsetOf(cf.nameStart) + cf.name.length > offset) {
|
||||||
|
// Render as a member val
|
||||||
|
val mv = MiniMemberValDecl(
|
||||||
|
range = MiniRange(cf.nameStart, cf.nameStart), // dummy
|
||||||
|
name = cf.name,
|
||||||
|
mutable = cf.mutable,
|
||||||
|
type = cf.type,
|
||||||
|
doc = null,
|
||||||
|
nameStart = cf.nameStart
|
||||||
|
)
|
||||||
|
return renderMemberValDoc(d.name, mv)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if (d is MiniEnumDecl) {
|
||||||
|
if (d.entries.contains(name) && offset >= source.offsetOf(d.range.start) && offset <= source.offsetOf(d.range.end)) {
|
||||||
|
// For enum constant, we don't have detailed docs in MiniAst yet, but we can render a title
|
||||||
|
return "<div class='doc-title'>enum constant ${d.name}.${name}</div>"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
// Check parameters
|
||||||
|
for (fn in mini.declarations.filterIsInstance<MiniFunDecl>()) {
|
||||||
|
for (p in fn.params) {
|
||||||
|
if (p.name == name && source.offsetOf(p.nameStart) <= offset && source.offsetOf(p.nameStart) + p.name.length > offset) {
|
||||||
|
return renderParamDoc(fn, p)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// 3) usages in current file via Binder (resolves local variables, parameters, and classes)
|
||||||
|
try {
|
||||||
|
val binding = net.sergeych.lyng.binding.Binder.bind(text, mini)
|
||||||
|
val ref = binding.references.firstOrNull { offset in it.start until it.end }
|
||||||
|
if (ref != null) {
|
||||||
|
val sym = binding.symbols.firstOrNull { it.id == ref.symbolId }
|
||||||
|
if (sym != null) {
|
||||||
|
// Find local declaration that matches this symbol
|
||||||
|
val ds = mini.declarations.firstOrNull { decl ->
|
||||||
|
val s = source.offsetOf(decl.nameStart)
|
||||||
|
decl.name == sym.name && s == sym.declStart
|
||||||
|
}
|
||||||
|
if (ds != null) return renderDeclDoc(ds)
|
||||||
|
|
||||||
|
// Check parameters
|
||||||
|
for (fn in mini.declarations.filterIsInstance<MiniFunDecl>()) {
|
||||||
|
for (p in fn.params) {
|
||||||
|
val s = source.offsetOf(p.nameStart)
|
||||||
|
if (p.name == sym.name && s == sym.declStart) {
|
||||||
|
return renderParamDoc(fn, p)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Check class members (fields/functions)
|
||||||
|
for (cls in mini.declarations.filterIsInstance<MiniClassDecl>()) {
|
||||||
|
for (m in cls.members) {
|
||||||
|
val s = source.offsetOf(m.nameStart)
|
||||||
|
if (m.name == sym.name && s == sym.declStart) {
|
||||||
|
return when (m) {
|
||||||
|
is MiniMemberFunDecl -> renderMemberFunDoc(cls.name, m)
|
||||||
|
is MiniMemberValDecl -> renderMemberValDoc(cls.name, m)
|
||||||
|
is MiniInitDecl -> null
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
for (cf in cls.ctorFields) {
|
||||||
|
val s = source.offsetOf(cf.nameStart)
|
||||||
|
if (cf.name == sym.name && s == sym.declStart) {
|
||||||
|
// Render as a member val
|
||||||
|
val mv = MiniMemberValDecl(
|
||||||
|
range = MiniRange(cf.nameStart, cf.nameStart), // dummy
|
||||||
|
name = cf.name,
|
||||||
|
mutable = cf.mutable,
|
||||||
|
type = cf.type,
|
||||||
|
doc = null,
|
||||||
|
nameStart = cf.nameStart
|
||||||
|
)
|
||||||
|
return renderMemberValDoc(cls.name, mv)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
for (cf in cls.classFields) {
|
||||||
|
val s = source.offsetOf(cf.nameStart)
|
||||||
|
if (cf.name == sym.name && s == sym.declStart) {
|
||||||
|
// Render as a member val
|
||||||
|
val mv = MiniMemberValDecl(
|
||||||
|
range = MiniRange(cf.nameStart, cf.nameStart), // dummy
|
||||||
|
name = cf.name,
|
||||||
|
mutable = cf.mutable,
|
||||||
|
type = cf.type,
|
||||||
|
doc = null,
|
||||||
|
nameStart = cf.nameStart
|
||||||
|
)
|
||||||
|
return renderMemberValDoc(cls.name, mv)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
} catch (e: Throwable) {
|
||||||
|
if (DEBUG_LOG) log.warn("[LYNG_DEBUG] QuickDoc: local binder resolution failed: ${e.message}")
|
||||||
|
}
|
||||||
|
// 4) Member-context resolution first (dot immediately before identifier): handle literals and calls
|
||||||
|
run {
|
||||||
|
val dotPos = TextCtx.findDotLeft(text, idRange.startOffset)
|
||||||
|
?: TextCtx.findDotLeft(text, offset)
|
||||||
|
if (dotPos != null) {
|
||||||
|
// Build imported modules (MiniAst-derived if available, else lenient from text) and ensure stdlib is present
|
||||||
|
val importedModules = DocLookupUtils.canonicalImportedModules(mini, text)
|
||||||
|
|
||||||
|
// Try literal and call-based receiver inference around the dot
|
||||||
|
val i = TextCtx.prevNonWs(text, dotPos - 1)
|
||||||
|
val className: String? = when {
|
||||||
|
i >= 0 && text[i] == '"' -> "String"
|
||||||
|
i >= 0 && text[i] == ']' -> "List"
|
||||||
|
i >= 0 && text[i] == '}' -> "Dict"
|
||||||
|
i >= 0 && text[i] == ')' -> {
|
||||||
|
// Parenthesized expression: walk back to matching '(' and inspect the inner expression
|
||||||
|
var j = i - 1
|
||||||
|
var depth = 0
|
||||||
|
while (j >= 0) {
|
||||||
|
when (text[j]) {
|
||||||
|
')' -> depth++
|
||||||
|
'(' -> if (depth == 0) break else depth--
|
||||||
|
}
|
||||||
|
j--
|
||||||
|
}
|
||||||
|
if (j >= 0 && text[j] == '(') {
|
||||||
|
val innerS = (j + 1).coerceAtLeast(0)
|
||||||
|
val innerE = i.coerceAtMost(text.length)
|
||||||
|
if (innerS < innerE) {
|
||||||
|
val inner = text.substring(innerS, innerE).trim()
|
||||||
|
when {
|
||||||
|
inner.startsWith('"') && inner.endsWith('"') -> "String"
|
||||||
|
inner.startsWith('[') && inner.endsWith(']') -> "List"
|
||||||
|
inner.startsWith('{') && inner.endsWith('}') -> "Dict"
|
||||||
|
else -> null
|
||||||
|
}
|
||||||
|
} else null
|
||||||
|
} else null
|
||||||
|
}
|
||||||
|
else -> {
|
||||||
|
val guessed = DocLookupUtils.guessClassFromCallBefore(text, dotPos, importedModules)
|
||||||
|
if (guessed != null) guessed
|
||||||
|
else {
|
||||||
|
// handle this@Type or as Type
|
||||||
|
val i2 = TextCtx.prevNonWs(text, dotPos - 1)
|
||||||
|
if (i2 >= 0) {
|
||||||
|
val identRange = TextCtx.wordRangeAt(text, i2 + 1)
|
||||||
|
if (identRange != null) {
|
||||||
|
val id = text.substring(identRange.startOffset, identRange.endOffset)
|
||||||
|
val k = TextCtx.prevNonWs(text, identRange.startOffset - 1)
|
||||||
|
if (k >= 1 && text[k] == 's' && text[k-1] == 'a' && (k-1 == 0 || !text[k-2].isLetterOrDigit())) {
|
||||||
|
id
|
||||||
|
} else if (k >= 0 && text[k] == '@') {
|
||||||
|
val k2 = TextCtx.prevNonWs(text, k - 1)
|
||||||
|
if (k2 >= 3 && text.substring(k2 - 3, k2 + 1) == "this") id else null
|
||||||
|
} else null
|
||||||
|
} else null
|
||||||
|
} else null
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if (DEBUG_LOG) log.info("[LYNG_DEBUG] QuickDoc: memberCtx dotPos=${dotPos} chBeforeDot='${if (dotPos>0) text[dotPos-1] else ' '}' classGuess=${className} imports=${importedModules}")
|
||||||
|
if (className != null) {
|
||||||
|
DocLookupUtils.resolveMemberWithInheritance(importedModules, className, ident)?.let { (owner, member) ->
|
||||||
|
if (DEBUG_INHERITANCE) log.info("[LYNG_DEBUG] QuickDoc: literal/call '$ident' resolved to $owner.${member.name}")
|
||||||
|
return when (member) {
|
||||||
|
is MiniMemberFunDecl -> renderMemberFunDoc(owner, member)
|
||||||
|
is MiniMemberValDecl -> renderMemberValDoc(owner, member)
|
||||||
|
is MiniInitDecl -> null
|
||||||
|
}
|
||||||
|
}
|
||||||
|
log.info("[LYNG_DEBUG] QuickDoc: resolve failed for ${className}.${ident}")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// 4) As a fallback, if the caret is on an identifier text that matches any declaration name, show that
|
||||||
|
mini.declarations.firstOrNull { it.name == ident }?.let {
|
||||||
|
log.info("[LYNG_DEBUG] QuickDoc: fallback by name '${it.name}' kind=${it::class.simpleName}")
|
||||||
|
return renderDeclDoc(it)
|
||||||
|
}
|
||||||
|
|
||||||
|
// 4) Consult BuiltinDocRegistry for imported modules (top-level and class members)
|
||||||
|
// Canonicalize import names using ImportManager, as users may write shortened names (e.g., "io.fs")
|
||||||
|
var importedModules = DocLookupUtils.canonicalImportedModules(mini, text)
|
||||||
|
// Always include stdlib as a fallback context
|
||||||
|
if (!importedModules.contains("lyng.stdlib")) importedModules = importedModules + "lyng.stdlib"
|
||||||
|
// 4a) try top-level decls
|
||||||
|
importedModules.forEach { mod ->
|
||||||
|
val docs = BuiltinDocRegistry.docsForModule(mod)
|
||||||
|
val matches = docs.filterIsInstance<MiniFunDecl>().filter { it.name == ident }
|
||||||
|
if (matches.isNotEmpty()) {
|
||||||
|
// Prefer overload by arity when caret is in a call position; otherwise show first
|
||||||
|
val arity = callArity(text, idRange.endOffset)
|
||||||
|
val chosen = arity?.let { a -> matches.firstOrNull { it.params.size == a } } ?: matches.first()
|
||||||
|
// If multiple and none matched arity, consider showing an overloads list
|
||||||
|
if (arity != null && chosen.params.size != arity && matches.size > 1) {
|
||||||
|
return renderOverloads(ident, matches)
|
||||||
|
}
|
||||||
|
return renderDeclDoc(chosen)
|
||||||
|
}
|
||||||
|
// Also allow values/consts
|
||||||
|
docs.filterIsInstance<MiniValDecl>().firstOrNull { it.name == ident }?.let { return renderDeclDoc(it) }
|
||||||
|
// And classes/enums
|
||||||
|
docs.filterIsInstance<MiniClassDecl>().firstOrNull { it.name == ident }?.let { return renderDeclDoc(it) }
|
||||||
|
docs.filterIsInstance<MiniEnumDecl>().firstOrNull { it.name == ident }?.let { return renderDeclDoc(it) }
|
||||||
|
}
|
||||||
|
// Defensive fallback: if nothing found and it's a well-known stdlib function, render minimal inline docs
|
||||||
|
if (ident == "println" || ident == "print") {
|
||||||
|
val fallback = if (ident == "println")
|
||||||
|
"Print values to the standard output and append a newline. Accepts any number of arguments." else
|
||||||
|
"Print values to the standard output without a trailing newline. Accepts any number of arguments."
|
||||||
|
val title = "function $ident(values)"
|
||||||
|
return "<div class='doc-title'>${htmlEscape(title)}</div>" + styledMarkdown(htmlEscape(fallback))
|
||||||
|
}
|
||||||
|
// 4b) try class members like ClassName.member with inheritance fallback
|
||||||
|
val lhs = previousWordBefore(text, idRange.startOffset)
|
||||||
|
if (lhs != null && hasDotBetween(text, lhs.endOffset, idRange.startOffset)) {
|
||||||
|
val className = text.substring(lhs.startOffset, lhs.endOffset)
|
||||||
|
DocLookupUtils.resolveMemberWithInheritance(importedModules, className, ident)?.let { (owner, member) ->
|
||||||
|
if (DEBUG_INHERITANCE) log.info("[LYNG_DEBUG] Inheritance resolved $className.$ident to $owner.${member.name}")
|
||||||
|
return when (member) {
|
||||||
|
is MiniMemberFunDecl -> renderMemberFunDoc(owner, member)
|
||||||
|
is MiniMemberValDecl -> renderMemberValDoc(owner, member)
|
||||||
|
is MiniInitDecl -> null
|
||||||
|
}
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
// Heuristics when LHS is not an identifier (literals or call results):
|
||||||
|
// - List literal like [..].member → assume class List
|
||||||
|
// - Otherwise, try to find a unique class across imported modules that defines this member
|
||||||
|
val dotPos = findDotLeft(text, idRange.startOffset)
|
||||||
|
if (dotPos != null) {
|
||||||
|
val guessed = when {
|
||||||
|
looksLikeListLiteralBefore(text, dotPos) -> "List"
|
||||||
|
else -> DocLookupUtils.guessClassFromCallBefore(text, dotPos, importedModules)
|
||||||
|
}
|
||||||
|
if (guessed != null) {
|
||||||
|
DocLookupUtils.resolveMemberWithInheritance(importedModules, guessed, ident)?.let { (owner, member) ->
|
||||||
|
if (DEBUG_INHERITANCE) log.info("[LYNG_DEBUG] Heuristic '$guessed.$ident' resolved via inheritance to $owner.${member.name}")
|
||||||
|
return when (member) {
|
||||||
|
is MiniMemberFunDecl -> renderMemberFunDoc(owner, member)
|
||||||
|
is MiniMemberValDecl -> renderMemberValDoc(owner, member)
|
||||||
|
is MiniInitDecl -> null
|
||||||
|
}
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
// Extra fallback: try a small set of known receiver classes (covers literals when guess failed)
|
||||||
|
run {
|
||||||
|
val candidates = listOf("String", "Iterable", "Iterator", "List", "Collection", "Array", "Dict", "Regex")
|
||||||
|
for (c in candidates) {
|
||||||
|
DocLookupUtils.resolveMemberWithInheritance(importedModules, c, ident)?.let { (owner, member) ->
|
||||||
|
if (DEBUG_INHERITANCE) log.info("[LYNG_DEBUG] Candidate '$c.$ident' resolved via inheritance to $owner.${member.name}")
|
||||||
|
return when (member) {
|
||||||
|
is MiniMemberFunDecl -> renderMemberFunDoc(owner, member)
|
||||||
|
is MiniMemberValDecl -> renderMemberValDoc(owner, member)
|
||||||
|
is MiniInitDecl -> null
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
// As a last resort try aggregated String members (extensions from stdlib text)
|
||||||
|
run {
|
||||||
|
val classes = DocLookupUtils.aggregateClasses(importedModules)
|
||||||
|
val stringCls = classes["String"]
|
||||||
|
val m = stringCls?.members?.firstOrNull { it.name == ident }
|
||||||
|
if (m != null) {
|
||||||
|
if (DEBUG_INHERITANCE) log.info("[LYNG_DEBUG] Aggregated fallback resolved String.$ident")
|
||||||
|
return when (m) {
|
||||||
|
is MiniMemberFunDecl -> renderMemberFunDoc("String", m)
|
||||||
|
is MiniMemberValDecl -> renderMemberValDoc("String", m)
|
||||||
|
is MiniInitDecl -> null
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
// Search across classes; prefer Iterable, then Iterator, then List for common ops
|
||||||
|
DocLookupUtils.findMemberAcrossClasses(importedModules, ident)?.let { (owner, member) ->
|
||||||
|
if (DEBUG_INHERITANCE) log.info("[LYNG_DEBUG] Cross-class '$ident' resolved to $owner.${member.name}")
|
||||||
|
return when (member) {
|
||||||
|
is MiniMemberFunDecl -> renderMemberFunDoc(owner, member)
|
||||||
|
is MiniMemberValDecl -> renderMemberValDoc(owner, member)
|
||||||
|
is MiniInitDecl -> null
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if (DEBUG_LOG) log.info("[LYNG_DEBUG] QuickDoc: nothing found for ident='$ident'")
|
||||||
|
return null
|
||||||
|
}
|
||||||
|
|
||||||
|
private val externalDocsLoaded: Boolean by lazy { tryLoadExternalDocs() }
|
||||||
|
|
||||||
|
private fun ensureExternalDocsRegistered() { @Suppress("UNUSED_EXPRESSION") externalDocsLoaded }
|
||||||
|
|
||||||
|
private fun tryLoadExternalDocs(): Boolean {
|
||||||
|
return try {
|
||||||
|
// Try known registrars; ignore failures if module is absent
|
||||||
|
val cls = Class.forName("net.sergeych.lyngio.docs.FsBuiltinDocs")
|
||||||
|
val m = cls.getMethod("ensure")
|
||||||
|
m.invoke(null)
|
||||||
|
log.info("[LYNG_DEBUG] QuickDoc: external docs loaded: net.sergeych.lyngio.docs.FsBuiltinDocs.ensure() OK")
|
||||||
|
true
|
||||||
|
} catch (_: Throwable) {
|
||||||
|
// Seed a minimal plugin-local fallback so Path docs still work without lyngio
|
||||||
|
val seeded = try {
|
||||||
|
FsDocsFallback.ensureOnce()
|
||||||
|
} catch (_: Throwable) { false }
|
||||||
|
if (seeded) {
|
||||||
|
log.info("[LYNG_DEBUG] QuickDoc: external docs NOT found; seeded plugin fallback for lyng.io.fs")
|
||||||
|
} else {
|
||||||
|
log.info("[LYNG_DEBUG] QuickDoc: external docs NOT found (lyngio absent on classpath)")
|
||||||
|
}
|
||||||
|
seeded
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
override fun getCustomDocumentationElement(
|
||||||
|
editor: Editor,
|
||||||
|
file: PsiFile,
|
||||||
|
contextElement: PsiElement?,
|
||||||
|
targetOffset: Int
|
||||||
|
): PsiElement? {
|
||||||
|
// Ensure our provider gets a chance for Lyng files regardless of PSI sophistication
|
||||||
|
if (file.language != LyngLanguage) return null
|
||||||
|
return contextElement ?: file.findElementAt(targetOffset)
|
||||||
|
}
|
||||||
|
|
||||||
|
private fun renderDeclDoc(d: MiniDecl): String {
|
||||||
|
val title = when (d) {
|
||||||
|
is MiniFunDecl -> "function ${d.name}${signatureOf(d)}"
|
||||||
|
is MiniClassDecl -> "class ${d.name}"
|
||||||
|
is MiniEnumDecl -> "enum ${d.name} { ${d.entries.joinToString(", ")} }"
|
||||||
|
is MiniValDecl -> if (d.mutable) "var ${d.name}${typeOf(d.type)}" else "val ${d.name}${typeOf(d.type)}"
|
||||||
|
}
|
||||||
|
// Show full detailed documentation, not just the summary
|
||||||
|
val raw = d.doc?.raw
|
||||||
|
val doc: String? = if (raw.isNullOrBlank()) null else MarkdownRenderer.render(raw)
|
||||||
|
val sb = StringBuilder()
|
||||||
|
sb.append("<div class='doc-title'>").append(htmlEscape(title)).append("</div>")
|
||||||
|
if (!doc.isNullOrBlank()) sb.append(styledMarkdown(doc))
|
||||||
|
return sb.toString()
|
||||||
|
}
|
||||||
|
|
||||||
|
private fun renderParamDoc(fn: MiniFunDecl, p: MiniParam): String {
|
||||||
|
val title = "parameter ${p.name}${typeOf(p.type)} in ${fn.name}${signatureOf(fn)}"
|
||||||
|
return "<div class='doc-title'>${htmlEscape(title)}</div>"
|
||||||
|
}
|
||||||
|
|
||||||
|
private fun renderMemberFunDoc(className: String, m: MiniMemberFunDecl): String {
|
||||||
|
val params = m.params.joinToString(", ") { p ->
|
||||||
|
val ts = typeOf(p.type)
|
||||||
|
if (ts.isNotBlank()) "${p.name}${ts}" else p.name
|
||||||
|
}
|
||||||
|
val ret = typeOf(m.returnType)
|
||||||
|
val staticStr = if (m.isStatic) "static " else ""
|
||||||
|
val title = "${staticStr}method $className.${m.name}(${params})${ret}"
|
||||||
|
val raw = m.doc?.raw
|
||||||
|
val doc: String? = if (raw.isNullOrBlank()) null else MarkdownRenderer.render(raw)
|
||||||
|
val sb = StringBuilder()
|
||||||
|
sb.append("<div class='doc-title'>").append(htmlEscape(title)).append("</div>")
|
||||||
|
if (!doc.isNullOrBlank()) sb.append(styledMarkdown(doc))
|
||||||
|
return sb.toString()
|
||||||
|
}
|
||||||
|
|
||||||
|
private fun renderMemberValDoc(className: String, m: MiniMemberValDecl): String {
|
||||||
|
val ts = typeOf(m.type)
|
||||||
|
val kind = if (m.mutable) "var" else "val"
|
||||||
|
val staticStr = if (m.isStatic) "static " else ""
|
||||||
|
val title = "${staticStr}${kind} $className.${m.name}${ts}"
|
||||||
|
val raw = m.doc?.raw
|
||||||
|
val doc: String? = if (raw.isNullOrBlank()) null else MarkdownRenderer.render(raw)
|
||||||
|
val sb = StringBuilder()
|
||||||
|
sb.append("<div class='doc-title'>").append(htmlEscape(title)).append("</div>")
|
||||||
|
if (!doc.isNullOrBlank()) sb.append(styledMarkdown(doc))
|
||||||
|
return sb.toString()
|
||||||
|
}
|
||||||
|
|
||||||
|
private fun typeOf(t: MiniTypeRef?): String = when (t) {
|
||||||
|
is MiniTypeName -> ": ${t.segments.joinToString(".") { it.name }}${if (t.nullable) "?" else ""}"
|
||||||
|
is MiniGenericType -> {
|
||||||
|
val base = typeOf(t.base).removePrefix(": ")
|
||||||
|
val args = t.args.joinToString(", ") { typeOf(it).removePrefix(": ") }
|
||||||
|
": ${base}<${args}>${if (t.nullable) "?" else ""}"
|
||||||
|
}
|
||||||
|
is MiniFunctionType -> ": (..) -> ..${if (t.nullable) "?" else ""}"
|
||||||
|
is MiniTypeVar -> ": ${t.name}${if (t.nullable) "?" else ""}"
|
||||||
|
null -> ""
|
||||||
|
}
|
||||||
|
|
||||||
|
private fun signatureOf(fn: MiniFunDecl): String {
|
||||||
|
val params = fn.params.joinToString(", ") { p ->
|
||||||
|
val ts = typeOf(p.type)
|
||||||
|
if (ts.isNotBlank()) "${p.name}${ts}" else p.name
|
||||||
|
}
|
||||||
|
val ret = typeOf(fn.returnType)
|
||||||
|
return "(${params})${ret}"
|
||||||
|
}
|
||||||
|
|
||||||
|
private fun htmlEscape(s: String): String = buildString(s.length) {
|
||||||
|
for (ch in s) append(
|
||||||
|
when (ch) {
|
||||||
|
'<' -> "<"
|
||||||
|
'>' -> ">"
|
||||||
|
'&' -> "&"
|
||||||
|
'"' -> """
|
||||||
|
else -> ch
|
||||||
|
}
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
private fun styledMarkdown(html: String): String {
|
||||||
|
// IntelliJ doc renderer sanitizes and may surface <style> content as text.
|
||||||
|
// Strip any style tags defensively and keep markup lean; rely on platform defaults.
|
||||||
|
val safe = stripStyleTags(html)
|
||||||
|
return """
|
||||||
|
<div class="lyng-doc-md" style="max-width:72ch; line-height:1.4; font-size:0.96em;">
|
||||||
|
$safe
|
||||||
|
</div>
|
||||||
|
""".trimIndent()
|
||||||
|
}
|
||||||
|
|
||||||
|
private fun stripStyleTags(src: String): String {
|
||||||
|
// Remove any <style>...</style> blocks (case-insensitive, dotall)
|
||||||
|
val styleRegex = Regex("(?is)<style[^>]*>.*?</style>")
|
||||||
|
return src.replace(styleRegex, "")
|
||||||
|
}
|
||||||
|
|
||||||
|
// --- Simple helpers to support overload selection and heuristics ---
|
||||||
|
/**
|
||||||
|
* If identifier at [rightAfterIdent] is followed by a call like `(a, b)`,
|
||||||
|
* return the argument count; otherwise return null. Nested parentheses are
|
||||||
|
* handled conservatively to skip commas inside lambdas/parentheses.
|
||||||
|
*/
|
||||||
|
private fun callArity(text: String, rightAfterIdent: Int): Int? {
|
||||||
|
var i = rightAfterIdent
|
||||||
|
// Skip whitespace
|
||||||
|
while (i < text.length && text[i].isWhitespace()) i++
|
||||||
|
if (i >= text.length || text[i] != '(') return null
|
||||||
|
i++
|
||||||
|
var depth = 0
|
||||||
|
var commas = 0
|
||||||
|
var hasToken = false
|
||||||
|
while (i < text.length) {
|
||||||
|
val ch = text[i]
|
||||||
|
when (ch) {
|
||||||
|
'(' -> { depth++; hasToken = true }
|
||||||
|
')' -> {
|
||||||
|
if (depth == 0) {
|
||||||
|
// Empty parentheses => arity 0 if no token and no commas
|
||||||
|
if (!hasToken && commas == 0) return 0
|
||||||
|
return commas + 1
|
||||||
|
} else depth--
|
||||||
|
}
|
||||||
|
',' -> if (depth == 0) { commas++; hasToken = false }
|
||||||
|
'\n' -> {}
|
||||||
|
else -> if (!ch.isWhitespace()) hasToken = true
|
||||||
|
}
|
||||||
|
i++
|
||||||
|
}
|
||||||
|
return null
|
||||||
|
}
|
||||||
|
|
||||||
|
private fun renderOverloads(name: String, overloads: List<MiniFunDecl>): String {
|
||||||
|
val sb = StringBuilder()
|
||||||
|
sb.append("<div class='doc-title'>Overloads for ").append(htmlEscape(name)).append("</div>")
|
||||||
|
sb.append("<ul>")
|
||||||
|
overloads.forEach { fn ->
|
||||||
|
sb.append("<li><code>")
|
||||||
|
.append(htmlEscape("fun ${fn.name}${signatureOf(fn)}"))
|
||||||
|
.append("</code>")
|
||||||
|
fn.doc?.summary?.let { sum -> sb.append(" — ").append(htmlEscape(sum)) }
|
||||||
|
sb.append("</li>")
|
||||||
|
}
|
||||||
|
sb.append("</ul>")
|
||||||
|
return sb.toString()
|
||||||
|
}
|
||||||
|
|
||||||
|
private fun wordRangeAt(text: String, offset: Int): TextRange? {
|
||||||
|
if (text.isEmpty()) return null
|
||||||
|
var s = offset.coerceIn(0, text.length)
|
||||||
|
var e = s
|
||||||
|
while (s > 0 && isIdentChar(text[s - 1])) s--
|
||||||
|
while (e < text.length && isIdentChar(text[e])) e++
|
||||||
|
return if (e > s) TextRange(s, e) else null
|
||||||
|
}
|
||||||
|
|
||||||
|
private fun previousWordBefore(text: String, offset: Int): TextRange? {
|
||||||
|
// skip spaces and dots to the left, but stop after hitting a non-identifier or dot boundary
|
||||||
|
var i = (offset - 1).coerceAtLeast(0)
|
||||||
|
// first, move left past spaces
|
||||||
|
while (i > 0 && text[i].isWhitespace()) i--
|
||||||
|
// remember position to check for dot between words
|
||||||
|
val end = i + 1
|
||||||
|
// now find the start of the identifier
|
||||||
|
while (i >= 0 && isIdentChar(text[i])) i--
|
||||||
|
val start = (i + 1)
|
||||||
|
return if (start < end && start >= 0) TextRange(start, end) else null
|
||||||
|
}
|
||||||
|
|
||||||
|
private fun hasDotBetween(text: String, leftEnd: Int, rightStart: Int): Boolean {
|
||||||
|
val s = leftEnd.coerceAtLeast(0)
|
||||||
|
val e = rightStart.coerceAtMost(text.length)
|
||||||
|
if (e <= s) return false
|
||||||
|
for (i in s until e) if (text[i] == '.') return true
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
private fun isIdentChar(c: Char): Boolean = c == '_' || c.isLetterOrDigit()
|
||||||
|
|
||||||
|
// --- Helpers for inheritance-aware and heuristic member lookup ---
|
||||||
|
|
||||||
|
// Removed: member/class resolution helpers moved to lynglib DocLookupUtils for reuse
|
||||||
|
|
||||||
|
private fun findDotLeft(text: String, rightStart: Int): Int? {
|
||||||
|
var i = (rightStart - 1).coerceAtLeast(0)
|
||||||
|
while (i >= 0 && text[i].isWhitespace()) i--
|
||||||
|
while (i >= 0) {
|
||||||
|
val ch = text[i]
|
||||||
|
if (ch == '.') return i
|
||||||
|
if (ch == '\n') return null
|
||||||
|
i--
|
||||||
|
}
|
||||||
|
return null
|
||||||
|
}
|
||||||
|
|
||||||
|
private fun looksLikeListLiteralBefore(text: String, dotPos: Int): Boolean {
|
||||||
|
// Look left for a closing ']' possibly with spaces, then a matching '[' before a comma or assignment
|
||||||
|
var i = (dotPos - 1).coerceAtLeast(0)
|
||||||
|
while (i >= 0 && text[i].isWhitespace()) i--
|
||||||
|
if (i < 0 || text[i] != ']') return false
|
||||||
|
var depth = 0
|
||||||
|
i--
|
||||||
|
while (i >= 0) {
|
||||||
|
val ch = text[i]
|
||||||
|
when (ch) {
|
||||||
|
']' -> depth++
|
||||||
|
'[' -> if (depth == 0) return true else depth--
|
||||||
|
'\n' -> return false
|
||||||
|
}
|
||||||
|
i--
|
||||||
|
}
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
// Removed: guessClassFromCallBefore moved to DocLookupUtils
|
||||||
|
}
|
||||||
@@ -0,0 +1,21 @@
|
|||||||
|
/*
|
||||||
|
* Copyright 2025 Sergey S. Chernov real.sergeych@gmail.com
|
||||||
|
*
|
||||||
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
* you may not use this file except in compliance with the License.
|
||||||
|
* You may obtain a copy of the License at
|
||||||
|
*
|
||||||
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
*
|
||||||
|
* Unless required by applicable law or agreed to in writing, software
|
||||||
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
* See the License for the specific language governing permissions and
|
||||||
|
* limitations under the License.
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
package net.sergeych.lyng.idea.docs
|
||||||
|
|
||||||
|
// 243: We do not use DocumentationTarget API here. Quick Docs works via
|
||||||
|
// AbstractDocumentationProvider registered as lang.documentationProvider.
|
||||||
|
internal object LyngDocumentationTargetsPlaceholder
|
||||||
@@ -0,0 +1,64 @@
|
|||||||
|
/*
|
||||||
|
* Copyright 2025 Sergey S. Chernov real.sergeych@gmail.com
|
||||||
|
*
|
||||||
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
* you may not use this file except in compliance with the License.
|
||||||
|
* You may obtain a copy of the License at
|
||||||
|
*
|
||||||
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
*
|
||||||
|
* Unless required by applicable law or agreed to in writing, software
|
||||||
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
* See the License for the specific language governing permissions and
|
||||||
|
* limitations under the License.
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
|
package net.sergeych.lyng.idea.docs
|
||||||
|
|
||||||
|
import com.vladsch.flexmark.ext.autolink.AutolinkExtension
|
||||||
|
import com.vladsch.flexmark.ext.gfm.strikethrough.StrikethroughExtension
|
||||||
|
import com.vladsch.flexmark.ext.tables.TablesExtension
|
||||||
|
import com.vladsch.flexmark.html.HtmlRenderer
|
||||||
|
import com.vladsch.flexmark.parser.Parser
|
||||||
|
import com.vladsch.flexmark.util.data.MutableDataSet
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Rich Markdown renderer for the IDEA Quick Docs using Flexmark.
|
||||||
|
*
|
||||||
|
* - Supports fenced code blocks (with language class "language-xyz")
|
||||||
|
* - Autolinks, tables, strikethrough
|
||||||
|
* - Converts soft breaks to <br/>
|
||||||
|
* - Tiny in-memory cache to avoid repeated parsing of the same doc blocks
|
||||||
|
*/
|
||||||
|
object MarkdownRenderer {
|
||||||
|
private val options = MutableDataSet().apply {
|
||||||
|
set(Parser.EXTENSIONS, listOf(
|
||||||
|
AutolinkExtension.create(),
|
||||||
|
TablesExtension.create(),
|
||||||
|
StrikethroughExtension.create(),
|
||||||
|
))
|
||||||
|
// Add CSS class for code fences like ```lyng → class="language-lyng"
|
||||||
|
set(HtmlRenderer.FENCED_CODE_LANGUAGE_CLASS_PREFIX, "language-")
|
||||||
|
// Treat single newlines as a space (soft break) so consecutive lines remain one paragraph.
|
||||||
|
// Real paragraph breaks require an empty line, hard breaks still work via Markdown (two spaces + \n).
|
||||||
|
set(HtmlRenderer.SOFT_BREAK, " ")
|
||||||
|
}
|
||||||
|
|
||||||
|
private val parser: Parser = Parser.builder(options).build()
|
||||||
|
private val renderer: HtmlRenderer = HtmlRenderer.builder(options).build()
|
||||||
|
|
||||||
|
private val cache = object : LinkedHashMap<String, String>(256, 0.75f, true) {
|
||||||
|
override fun removeEldestEntry(eldest: MutableMap.MutableEntry<String, String>?): Boolean = size > 256
|
||||||
|
}
|
||||||
|
|
||||||
|
fun render(markdown: String): String {
|
||||||
|
// Fast path: cache
|
||||||
|
synchronized(cache) { cache[markdown]?.let { return it } }
|
||||||
|
val node = parser.parse(markdown)
|
||||||
|
val html = renderer.render(node)
|
||||||
|
synchronized(cache) { cache[markdown] = html }
|
||||||
|
return html
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,36 @@
|
|||||||
|
/*
|
||||||
|
* Copyright 2025 Sergey S. Chernov real.sergeych@gmail.com
|
||||||
|
*
|
||||||
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
* you may not use this file except in compliance with the License.
|
||||||
|
* You may obtain a copy of the License at
|
||||||
|
*
|
||||||
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
*
|
||||||
|
* Unless required by applicable law or agreed to in writing, software
|
||||||
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
* See the License for the specific language governing permissions and
|
||||||
|
* limitations under the License.
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
package net.sergeych.lyng.idea.editor
|
||||||
|
|
||||||
|
import com.intellij.codeInsight.editorActions.BackspaceHandlerDelegate
|
||||||
|
import com.intellij.openapi.editor.Editor
|
||||||
|
import com.intellij.psi.PsiFile
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Backspace handler (currently inactive, not registered). Minimal stub to keep build green.
|
||||||
|
* We will enable and implement smart behavior after API verification on the target IDE.
|
||||||
|
*/
|
||||||
|
class LyngBackspaceHandler : BackspaceHandlerDelegate() {
|
||||||
|
override fun beforeCharDeleted(c: Char, file: PsiFile, editor: Editor) {
|
||||||
|
// no-op
|
||||||
|
}
|
||||||
|
|
||||||
|
override fun charDeleted(c: Char, file: PsiFile, editor: Editor): Boolean {
|
||||||
|
// no-op; let default behavior stand
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,23 @@
|
|||||||
|
/*
|
||||||
|
* Copyright 2025 Sergey S. Chernov real.sergeych@gmail.com
|
||||||
|
*
|
||||||
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
* you may not use this file except in compliance with the License.
|
||||||
|
* You may obtain a copy of the License at
|
||||||
|
*
|
||||||
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
*
|
||||||
|
* Unless required by applicable law or agreed to in writing, software
|
||||||
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
* See the License for the specific language governing permissions and
|
||||||
|
* limitations under the License.
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
package net.sergeych.lyng.idea.editor
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Disabled placeholder. We currently use the EditorPaste action handler (LyngPasteHandler)
|
||||||
|
* which works across IDE builds without relying on RawText API.
|
||||||
|
*/
|
||||||
|
class LyngCopyPastePreProcessorDisabled
|
||||||
+23
@@ -0,0 +1,23 @@
|
|||||||
|
/*
|
||||||
|
* Copyright 2025 Sergey S. Chernov real.sergeych@gmail.com
|
||||||
|
*
|
||||||
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
* you may not use this file except in compliance with the License.
|
||||||
|
* You may obtain a copy of the License at
|
||||||
|
*
|
||||||
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
*
|
||||||
|
* Unless required by applicable law or agreed to in writing, software
|
||||||
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
* See the License for the specific language governing permissions and
|
||||||
|
* limitations under the License.
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
package net.sergeych.lyng.idea.editor
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Placeholder for 2024.3+ RawText-based CopyPastePreProcessor.
|
||||||
|
* Not compiled against current SDK classpath; kept for future activation.
|
||||||
|
*/
|
||||||
|
class LyngCopyPastePreProcessor243Disabled
|
||||||
@@ -0,0 +1,200 @@
|
|||||||
|
/*
|
||||||
|
* Copyright 2026 Sergey S. Chernov real.sergeych@gmail.com
|
||||||
|
*
|
||||||
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
* you may not use this file except in compliance with the License.
|
||||||
|
* You may obtain a copy of the License at
|
||||||
|
*
|
||||||
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
*
|
||||||
|
* Unless required by applicable law or agreed to in writing, software
|
||||||
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
* See the License for the specific language governing permissions and
|
||||||
|
* limitations under the License.
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
package net.sergeych.lyng.idea.editor
|
||||||
|
|
||||||
|
import com.intellij.application.options.CodeStyle
|
||||||
|
import com.intellij.codeInsight.editorActions.enter.EnterHandlerDelegate
|
||||||
|
import com.intellij.codeInsight.editorActions.enter.EnterHandlerDelegate.Result
|
||||||
|
import com.intellij.openapi.actionSystem.DataContext
|
||||||
|
import com.intellij.openapi.command.WriteCommandAction
|
||||||
|
import com.intellij.openapi.diagnostic.Logger
|
||||||
|
import com.intellij.openapi.editor.Caret
|
||||||
|
import com.intellij.openapi.editor.Document
|
||||||
|
import com.intellij.openapi.editor.Editor
|
||||||
|
import com.intellij.openapi.editor.actionSystem.EditorActionHandler
|
||||||
|
import com.intellij.openapi.project.Project
|
||||||
|
import com.intellij.openapi.util.Ref
|
||||||
|
import com.intellij.openapi.util.TextRange
|
||||||
|
import com.intellij.psi.PsiDocumentManager
|
||||||
|
import com.intellij.psi.PsiFile
|
||||||
|
import com.intellij.psi.codeStyle.CodeStyleManager
|
||||||
|
import net.sergeych.lyng.format.LyngFormatConfig
|
||||||
|
import net.sergeych.lyng.format.LyngFormatter
|
||||||
|
import net.sergeych.lyng.idea.LyngLanguage
|
||||||
|
import net.sergeych.lyng.idea.util.FormattingUtils.computeDesiredIndent
|
||||||
|
import net.sergeych.lyng.idea.util.FormattingUtils.findFirstNonWs
|
||||||
|
|
||||||
|
class LyngEnterHandler : EnterHandlerDelegate {
|
||||||
|
private val log = Logger.getInstance(LyngEnterHandler::class.java)
|
||||||
|
override fun preprocessEnter(
|
||||||
|
file: PsiFile,
|
||||||
|
editor: Editor,
|
||||||
|
caretOffset: Ref<Int>,
|
||||||
|
caretAdvance: Ref<Int>,
|
||||||
|
dataContext: DataContext,
|
||||||
|
originalHandler: EditorActionHandler?
|
||||||
|
): Result {
|
||||||
|
if (file.language != LyngLanguage) return Result.Continue
|
||||||
|
if (log.isDebugEnabled) log.debug("[LyngEnter] preprocess in Lyng file at caretOffset=${caretOffset.get()}")
|
||||||
|
// Let the platform insert the newline; we will fix indentation in postProcessEnter.
|
||||||
|
return Result.Continue
|
||||||
|
}
|
||||||
|
|
||||||
|
override fun postProcessEnter(file: PsiFile, editor: Editor, dataContext: DataContext): Result {
|
||||||
|
if (file.language != LyngLanguage) return Result.Continue
|
||||||
|
val project = file.project
|
||||||
|
val doc = editor.document
|
||||||
|
val psiManager = PsiDocumentManager.getInstance(project)
|
||||||
|
psiManager.commitDocument(doc)
|
||||||
|
|
||||||
|
// Handle all carets independently to keep multi-caret scenarios sane
|
||||||
|
for (caret in editor.caretModel.allCarets) {
|
||||||
|
val line = doc.safeLineNumber(caret.offset)
|
||||||
|
if (line < 0) continue
|
||||||
|
if (log.isDebugEnabled) log.debug("[LyngEnter] postProcess at line=$line offset=${caret.offset}")
|
||||||
|
// Adjust previous '}' line if applicable, then indent the current line using our rules
|
||||||
|
adjustBraceAndCurrentIndent(project, file, doc, line)
|
||||||
|
|
||||||
|
// After indenting, ensure caret sits after the computed indent of this new line
|
||||||
|
moveCaretToIndentIfOnLeadingWs(editor, doc, file, line, caret)
|
||||||
|
}
|
||||||
|
return Result.Continue
|
||||||
|
}
|
||||||
|
|
||||||
|
private fun adjustBraceAndCurrentIndent(project: Project, file: PsiFile, doc: Document, currentLine: Int) {
|
||||||
|
val prevLine = currentLine - 1
|
||||||
|
if (prevLine >= 0) {
|
||||||
|
val prevText = doc.getLineText(prevLine)
|
||||||
|
val trimmed = prevText.trimStart()
|
||||||
|
// consider only code part before // comment
|
||||||
|
val code = trimmed.substringBefore("//").trim()
|
||||||
|
if (code == "}" || code == "*/") {
|
||||||
|
// Adjust indent for the previous line if it's a block or comment closer
|
||||||
|
val prevStart = doc.getLineStartOffset(prevLine)
|
||||||
|
if (file.context == null) {
|
||||||
|
try {
|
||||||
|
CodeStyleManager.getInstance(project).adjustLineIndent(file, prevStart)
|
||||||
|
} catch (e: Exception) {
|
||||||
|
log.warn("Failed to adjust line indent for previous line: ${e.message}")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Fallback for previous line: manual application
|
||||||
|
val desiredPrev = computeDesiredIndent(project, doc, prevLine)
|
||||||
|
val lineStartPrev = doc.getLineStartOffset(prevLine)
|
||||||
|
val lineEndPrev = doc.getLineEndOffset(prevLine)
|
||||||
|
val firstNonWsPrev = findFirstNonWs(doc, lineStartPrev, lineEndPrev)
|
||||||
|
val currentIndentLenPrev = firstNonWsPrev - lineStartPrev
|
||||||
|
if (doc.getText(TextRange(lineStartPrev, lineStartPrev + currentIndentLenPrev)) != desiredPrev) {
|
||||||
|
WriteCommandAction.runWriteCommandAction(project) {
|
||||||
|
doc.replaceString(lineStartPrev, lineStartPrev + currentIndentLenPrev, desiredPrev)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
// Adjust indent for the current (new) line
|
||||||
|
val currentStart = doc.getLineStartOffsetSafe(currentLine)
|
||||||
|
if (file.context == null) {
|
||||||
|
try {
|
||||||
|
CodeStyleManager.getInstance(project).adjustLineIndent(file, currentStart)
|
||||||
|
} catch (e: Exception) {
|
||||||
|
log.warn("Failed to adjust line indent for current line: ${e.message}")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Fallback: if the platform didn't physically insert indentation, compute it from our formatter and apply
|
||||||
|
val lineStart = doc.getLineStartOffset(currentLine)
|
||||||
|
val lineEnd = doc.getLineEndOffset(currentLine)
|
||||||
|
val desiredIndent = computeDesiredIndent(project, doc, currentLine)
|
||||||
|
val firstNonWs = findFirstNonWs(doc, lineStart, lineEnd)
|
||||||
|
val currentIndentLen = firstNonWs - lineStart
|
||||||
|
if (desiredIndent.isNotEmpty() || currentIndentLen != 0) {
|
||||||
|
// Replace existing leading whitespace to match desired indent exactly
|
||||||
|
val replaceFrom = lineStart
|
||||||
|
val replaceTo = lineStart + currentIndentLen
|
||||||
|
if (doc.getText(TextRange(replaceFrom, replaceTo)) != desiredIndent) {
|
||||||
|
com.intellij.openapi.command.WriteCommandAction.runWriteCommandAction(project) {
|
||||||
|
doc.replaceString(replaceFrom, replaceTo, desiredIndent)
|
||||||
|
}
|
||||||
|
PsiDocumentManager.getInstance(project).commitDocument(doc)
|
||||||
|
if (log.isDebugEnabled) {
|
||||||
|
val dbg = desiredIndent.replace("\t", "\\t")
|
||||||
|
log.debug("[LyngEnter] rewrote current line leading WS to '$dbg' at line=$currentLine")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
private fun reindentClosedBlockAroundBrace(project: Project, file: PsiFile, doc: Document, braceLine: Int) {
|
||||||
|
// Find the absolute index of the '}' at or before end of braceLine
|
||||||
|
val braceLineStart = doc.getLineStartOffset(braceLine)
|
||||||
|
val braceLineEnd = doc.getLineEndOffset(braceLine)
|
||||||
|
val rawBraceLine = doc.getText(TextRange(braceLineStart, braceLineEnd))
|
||||||
|
val codeBraceLine = rawBraceLine.substringBefore("//")
|
||||||
|
val closeRel = codeBraceLine.lastIndexOf('}')
|
||||||
|
if (closeRel < 0) return
|
||||||
|
val closeAbs = braceLineStart + closeRel
|
||||||
|
|
||||||
|
// Compute the enclosing block range in raw text (document char sequence)
|
||||||
|
val blockRange = net.sergeych.lyng.format.BraceUtils.findEnclosingBlockRange(doc.charsSequence, closeAbs, includeTrailingNewline = true)
|
||||||
|
?: return
|
||||||
|
|
||||||
|
val options = CodeStyle.getIndentOptions(project, doc)
|
||||||
|
val cfg = LyngFormatConfig(
|
||||||
|
indentSize = options.INDENT_SIZE.coerceAtLeast(1),
|
||||||
|
useTabs = options.USE_TAB_CHARACTER,
|
||||||
|
continuationIndentSize = options.CONTINUATION_INDENT_SIZE.coerceAtLeast(options.INDENT_SIZE.coerceAtLeast(1)),
|
||||||
|
)
|
||||||
|
|
||||||
|
// Run partial reindent over the slice and replace only if changed
|
||||||
|
val whole = doc.text
|
||||||
|
val updated = LyngFormatter.reindentRange(whole, blockRange, cfg, preserveBaseIndent = true)
|
||||||
|
if (updated != whole) {
|
||||||
|
WriteCommandAction.runWriteCommandAction(project) {
|
||||||
|
doc.replaceString(0, doc.textLength, updated)
|
||||||
|
}
|
||||||
|
PsiDocumentManager.getInstance(project).commitDocument(doc)
|
||||||
|
if (log.isDebugEnabled) log.debug("[LyngEnter] reindented closed block range=${'$'}blockRange")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
private fun moveCaretToIndentIfOnLeadingWs(editor: Editor, doc: Document, file: PsiFile, line: Int, caret: Caret) {
|
||||||
|
if (line < 0 || line >= doc.lineCount) return
|
||||||
|
val lineStart = doc.getLineStartOffset(line)
|
||||||
|
val lineEnd = doc.getLineEndOffset(line)
|
||||||
|
val desiredIndent = computeDesiredIndent(file.project, doc, line)
|
||||||
|
val firstNonWs = (lineStart + desiredIndent.length).coerceAtMost(doc.textLength)
|
||||||
|
val caretOffset = caret.offset
|
||||||
|
// If caret is at beginning of the line or still within the leading whitespace, move it after indent
|
||||||
|
val target = firstNonWs.coerceIn(lineStart, lineEnd)
|
||||||
|
caret.moveToOffset(target)
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
private fun Document.safeLineNumber(offset: Int): Int =
|
||||||
|
getLineNumber(offset.coerceIn(0, textLength))
|
||||||
|
|
||||||
|
private fun Document.getLineText(line: Int): String {
|
||||||
|
if (line < 0 || line >= lineCount) return ""
|
||||||
|
val start = getLineStartOffset(line)
|
||||||
|
val end = getLineEndOffset(line)
|
||||||
|
return getText(TextRange(start, end))
|
||||||
|
}
|
||||||
|
|
||||||
|
private fun Document.getLineStartOffsetSafe(line: Int): Int =
|
||||||
|
if (line < 0) 0 else getLineStartOffset(line.coerceAtMost(lineCount - 1).coerceAtLeast(0))
|
||||||
|
}
|
||||||
@@ -0,0 +1,22 @@
|
|||||||
|
/*
|
||||||
|
* Copyright 2025 Sergey S. Chernov real.sergeych@gmail.com
|
||||||
|
*
|
||||||
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
* you may not use this file except in compliance with the License.
|
||||||
|
* You may obtain a copy of the License at
|
||||||
|
*
|
||||||
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
*
|
||||||
|
* Unless required by applicable law or agreed to in writing, software
|
||||||
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
* See the License for the specific language governing permissions and
|
||||||
|
* limitations under the License.
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
package net.sergeych.lyng.idea.editor
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Disabled placeholder: we rely on LyngPasteHandler (EditorPaste action handler).
|
||||||
|
*/
|
||||||
|
class LyngOnPasteProcessorDisabled
|
||||||
@@ -0,0 +1,166 @@
|
|||||||
|
/*
|
||||||
|
* Copyright 2025 Sergey S. Chernov real.sergeych@gmail.com
|
||||||
|
*
|
||||||
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
* you may not use this file except in compliance with the License.
|
||||||
|
* You may obtain a copy of the License at
|
||||||
|
*
|
||||||
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
*
|
||||||
|
* Unless required by applicable law or agreed to in writing, software
|
||||||
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
* See the License for the specific language governing permissions and
|
||||||
|
* limitations under the License.
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
package net.sergeych.lyng.idea.editor
|
||||||
|
|
||||||
|
import com.intellij.application.options.CodeStyle
|
||||||
|
import com.intellij.openapi.actionSystem.DataContext
|
||||||
|
import com.intellij.openapi.command.WriteCommandAction
|
||||||
|
import com.intellij.openapi.editor.Caret
|
||||||
|
import com.intellij.openapi.editor.Editor
|
||||||
|
import com.intellij.openapi.editor.actionSystem.EditorWriteActionHandler
|
||||||
|
import com.intellij.openapi.ide.CopyPasteManager
|
||||||
|
import com.intellij.psi.PsiDocumentManager
|
||||||
|
import net.sergeych.lyng.format.LyngFormatConfig
|
||||||
|
import net.sergeych.lyng.format.LyngFormatter
|
||||||
|
import net.sergeych.lyng.idea.LyngLanguage
|
||||||
|
import net.sergeych.lyng.idea.settings.LyngFormatterSettings
|
||||||
|
import java.awt.datatransfer.DataFlavor
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Smart Paste using an editor action handler (avoids RawText API variance).
|
||||||
|
* Reindents pasted blocks when caret is in leading whitespace and the setting is enabled.
|
||||||
|
*/
|
||||||
|
class LyngPasteHandler : EditorWriteActionHandler(true) {
|
||||||
|
private val log = com.intellij.openapi.diagnostic.Logger.getInstance(LyngPasteHandler::class.java)
|
||||||
|
override fun doExecute(editor: Editor, caret: Caret?, dataContext: DataContext) {
|
||||||
|
val project = editor.project
|
||||||
|
if (project == null) return
|
||||||
|
|
||||||
|
val psiDocMgr = PsiDocumentManager.getInstance(project)
|
||||||
|
val file = psiDocMgr.getPsiFile(editor.document)
|
||||||
|
if (file == null || file.language != LyngLanguage) {
|
||||||
|
pasteAsIs(editor)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
val settings = LyngFormatterSettings.getInstance(project)
|
||||||
|
if (!settings.reindentPastedBlocks) {
|
||||||
|
pasteAsIs(editor)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
val text = CopyPasteManager.getInstance().getContents<String>(DataFlavor.stringFlavor)
|
||||||
|
if (text == null) {
|
||||||
|
pasteAsIs(editor)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
val caretModel = editor.caretModel
|
||||||
|
val effectiveCaret = caret ?: caretModel.currentCaret
|
||||||
|
val doc = editor.document
|
||||||
|
PsiDocumentManager.getInstance(project).commitDocument(doc)
|
||||||
|
|
||||||
|
// Paste the text as-is first, then compute the inserted range and reindent that slice
|
||||||
|
val options = CodeStyle.getIndentOptions(project, doc)
|
||||||
|
val cfg = LyngFormatConfig(
|
||||||
|
indentSize = options.INDENT_SIZE.coerceAtLeast(1),
|
||||||
|
useTabs = options.USE_TAB_CHARACTER,
|
||||||
|
continuationIndentSize = options.CONTINUATION_INDENT_SIZE.coerceAtLeast(options.INDENT_SIZE.coerceAtLeast(1)),
|
||||||
|
)
|
||||||
|
|
||||||
|
// Replace selection (if any) or insert at caret with original clipboard text
|
||||||
|
val selModel = editor.selectionModel
|
||||||
|
val replaceStart = if (selModel.hasSelection()) selModel.selectionStart else effectiveCaret.offset
|
||||||
|
val replaceEnd = if (selModel.hasSelection()) selModel.selectionEnd else effectiveCaret.offset
|
||||||
|
|
||||||
|
WriteCommandAction.runWriteCommandAction(project) {
|
||||||
|
log.info("[LyngPaste] handler invoked for Lyng file; setting ON=${settings.reindentPastedBlocks}")
|
||||||
|
// Step 1: paste as-is
|
||||||
|
val beforeLen = doc.textLength
|
||||||
|
doc.replaceString(replaceStart, replaceEnd, text)
|
||||||
|
psiDocMgr.commitDocument(doc)
|
||||||
|
|
||||||
|
// Step 2: compute the freshly inserted range robustly (account for line-separator normalization)
|
||||||
|
val insertedStart = replaceStart
|
||||||
|
val delta = doc.textLength - beforeLen + (replaceEnd - replaceStart)
|
||||||
|
val insertedEndExclusive = (insertedStart + delta).coerceIn(insertedStart, doc.textLength)
|
||||||
|
|
||||||
|
// Expand to full lines to let the formatter compute proper base/closing alignment
|
||||||
|
val lineStart = run {
|
||||||
|
var i = (insertedStart - 1).coerceAtLeast(0)
|
||||||
|
while (i >= 0 && doc.charsSequence[i] != '\n') i--
|
||||||
|
i + 1
|
||||||
|
}
|
||||||
|
var lineEndInclusive = run {
|
||||||
|
var i = insertedEndExclusive
|
||||||
|
val seq = doc.charsSequence
|
||||||
|
while (i < seq.length && seq[i] != '\n') i++
|
||||||
|
// include trailing newline if present
|
||||||
|
if (i < seq.length && seq[i] == '\n') i + 1 else i
|
||||||
|
}
|
||||||
|
|
||||||
|
// If the next non-whitespace char right after the insertion is a closing brace '}',
|
||||||
|
// include that brace line into the formatting slice for better block alignment.
|
||||||
|
run {
|
||||||
|
val seq = doc.charsSequence
|
||||||
|
var j = insertedEndExclusive
|
||||||
|
while (j < seq.length && (seq[j] == ' ' || seq[j] == '\t' || seq[j] == '\n' || seq[j] == '\r')) j++
|
||||||
|
if (j < seq.length && seq[j] == '}') {
|
||||||
|
var k = j
|
||||||
|
while (k < seq.length && seq[k] != '\n') k++
|
||||||
|
lineEndInclusive = if (k < seq.length && seq[k] == '\n') k + 1 else k
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
val fullTextBefore = doc.text
|
||||||
|
val expandedRange = (lineStart until lineEndInclusive)
|
||||||
|
log.info("[LyngPaste] inserted=[$insertedStart,$insertedEndExclusive) expanded=[$lineStart,$lineEndInclusive)")
|
||||||
|
val updatedFull = LyngFormatter.reindentRange(
|
||||||
|
fullTextBefore,
|
||||||
|
expandedRange,
|
||||||
|
cfg,
|
||||||
|
preserveBaseIndent = true,
|
||||||
|
baseIndentFrom = insertedStart
|
||||||
|
)
|
||||||
|
|
||||||
|
if (updatedFull != fullTextBefore) {
|
||||||
|
val delta = updatedFull.length - fullTextBefore.length
|
||||||
|
doc.replaceString(0, doc.textLength, updatedFull)
|
||||||
|
psiDocMgr.commitDocument(doc)
|
||||||
|
caretModel.moveToOffset((insertedEndExclusive + delta).coerceIn(0, doc.textLength))
|
||||||
|
log.info("[LyngPaste] applied reindent to expanded range")
|
||||||
|
} else {
|
||||||
|
// No changes after reindent — just move caret to end of the inserted text
|
||||||
|
caretModel.moveToOffset(insertedEndExclusive)
|
||||||
|
log.info("[LyngPaste] no changes after reindent")
|
||||||
|
}
|
||||||
|
selModel.removeSelection()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
private fun pasteAsIs(editor: Editor) {
|
||||||
|
val text = CopyPasteManager.getInstance().getContents<String>(DataFlavor.stringFlavor) ?: return
|
||||||
|
pasteText(editor, text)
|
||||||
|
}
|
||||||
|
|
||||||
|
private fun pasteText(editor: Editor, text: String) {
|
||||||
|
val project = editor.project ?: return
|
||||||
|
val doc = editor.document
|
||||||
|
val caretModel = editor.caretModel
|
||||||
|
val selModel = editor.selectionModel
|
||||||
|
WriteCommandAction.runWriteCommandAction(project) {
|
||||||
|
val replaceStart = if (selModel.hasSelection()) selModel.selectionStart else caretModel.offset
|
||||||
|
val replaceEnd = if (selModel.hasSelection()) selModel.selectionEnd else caretModel.offset
|
||||||
|
doc.replaceString(replaceStart, replaceEnd, text)
|
||||||
|
PsiDocumentManager.getInstance(project).commitDocument(doc)
|
||||||
|
caretModel.moveToOffset(replaceStart + text.length)
|
||||||
|
selModel.removeSelection()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// no longer used
|
||||||
|
}
|
||||||
@@ -0,0 +1,83 @@
|
|||||||
|
/*
|
||||||
|
* Copyright 2025 Sergey S. Chernov real.sergeych@gmail.com
|
||||||
|
*
|
||||||
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
* you may not use this file except in compliance with the License.
|
||||||
|
* You may obtain a copy of the License at
|
||||||
|
*
|
||||||
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
*
|
||||||
|
* Unless required by applicable law or agreed to in writing, software
|
||||||
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
* See the License for the specific language governing permissions and
|
||||||
|
* limitations under the License.
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
package net.sergeych.lyng.idea.editor
|
||||||
|
|
||||||
|
import com.intellij.application.options.CodeStyle
|
||||||
|
import com.intellij.openapi.editor.Editor
|
||||||
|
import com.intellij.openapi.project.Project
|
||||||
|
import com.intellij.psi.PsiDocumentManager
|
||||||
|
import com.intellij.psi.PsiFile
|
||||||
|
import net.sergeych.lyng.format.LyngFormatConfig
|
||||||
|
import net.sergeych.lyng.format.LyngFormatter
|
||||||
|
import net.sergeych.lyng.idea.LyngLanguage
|
||||||
|
import net.sergeych.lyng.idea.settings.LyngFormatterSettings
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Helper for preparing reindented pasted text. EP wiring is deferred until API
|
||||||
|
* signature is finalized for the target IDE build.
|
||||||
|
*/
|
||||||
|
object LyngPastePreProcessor {
|
||||||
|
fun reindentForPaste(
|
||||||
|
project: Project,
|
||||||
|
editor: Editor,
|
||||||
|
file: PsiFile,
|
||||||
|
text: String
|
||||||
|
): String {
|
||||||
|
if (file.language != LyngLanguage) return text
|
||||||
|
val settings = LyngFormatterSettings.getInstance(project)
|
||||||
|
if (!settings.reindentPastedBlocks) return text
|
||||||
|
|
||||||
|
val doc = editor.document
|
||||||
|
PsiDocumentManager.getInstance(project).commitDocument(doc)
|
||||||
|
val options = CodeStyle.getIndentOptions(project, doc)
|
||||||
|
val cfg = LyngFormatConfig(
|
||||||
|
indentSize = options.INDENT_SIZE.coerceAtLeast(1),
|
||||||
|
useTabs = options.USE_TAB_CHARACTER,
|
||||||
|
continuationIndentSize = options.CONTINUATION_INDENT_SIZE.coerceAtLeast(options.INDENT_SIZE.coerceAtLeast(1)),
|
||||||
|
)
|
||||||
|
|
||||||
|
// Only apply smart paste when caret is in leading whitespace position of its line
|
||||||
|
val caret = editor.caretModel.currentCaret
|
||||||
|
val line = doc.getLineNumber(caret.offset.coerceIn(0, doc.textLength))
|
||||||
|
if (line < 0 || line >= doc.lineCount) return text
|
||||||
|
val lineStart = doc.getLineStartOffset(line)
|
||||||
|
val firstNonWs = firstNonWhitespace(doc, lineStart, doc.getLineEndOffset(line))
|
||||||
|
if (caret.offset > firstNonWs) return text
|
||||||
|
|
||||||
|
val baseIndent = doc.charsSequence.subSequence(lineStart, caret.offset).toString()
|
||||||
|
val reindented = LyngFormatter.reindent(text, cfg)
|
||||||
|
// Prefix each non-empty line with base indent to preserve surrounding indentation
|
||||||
|
val lines = reindented.split('\n')
|
||||||
|
val sb = StringBuilder(reindented.length + lines.size * baseIndent.length)
|
||||||
|
for ((idx, ln) in lines.withIndex()) {
|
||||||
|
if (ln.isNotEmpty()) sb.append(baseIndent).append(ln) else sb.append(ln)
|
||||||
|
if (idx < lines.lastIndex) sb.append('\n')
|
||||||
|
}
|
||||||
|
return sb.toString()
|
||||||
|
}
|
||||||
|
|
||||||
|
private fun firstNonWhitespace(doc: com.intellij.openapi.editor.Document, from: Int, to: Int): Int {
|
||||||
|
val seq = doc.charsSequence
|
||||||
|
var i = from
|
||||||
|
while (i < to) {
|
||||||
|
val ch = seq[i]
|
||||||
|
if (ch != ' ' && ch != '\t') break
|
||||||
|
i++
|
||||||
|
}
|
||||||
|
return i
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,38 @@
|
|||||||
|
/*
|
||||||
|
* Copyright 2025 Sergey S. Chernov real.sergeych@gmail.com
|
||||||
|
*
|
||||||
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
* you may not use this file except in compliance with the License.
|
||||||
|
* You may obtain a copy of the License at
|
||||||
|
*
|
||||||
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
*
|
||||||
|
* Unless required by applicable law or agreed to in writing, software
|
||||||
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
* See the License for the specific language governing permissions and
|
||||||
|
* limitations under the License.
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
package net.sergeych.lyng.idea.editor
|
||||||
|
|
||||||
|
import com.intellij.openapi.editor.Editor
|
||||||
|
import com.intellij.openapi.project.Project
|
||||||
|
import com.intellij.psi.PsiDocumentManager
|
||||||
|
import com.intellij.psi.PsiFile
|
||||||
|
import net.sergeych.lyng.idea.LyngLanguage
|
||||||
|
import net.sergeych.lyng.idea.settings.LyngFormatterSettings
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Smart Paste helper for Lyng. Not registered as EP yet to keep build stable across IDE SDKs.
|
||||||
|
* Use `processOnPasteIfEnabled` from a CopyPastePreProcessor adapter once API signature is finalized.
|
||||||
|
*/
|
||||||
|
object LyngSmartPastePreProcessorHelper {
|
||||||
|
fun processOnPasteIfEnabled(project: Project, file: PsiFile, editor: Editor, text: String): String {
|
||||||
|
if (file.language != LyngLanguage) return text
|
||||||
|
val settings = LyngFormatterSettings.getInstance(project)
|
||||||
|
if (!settings.reindentPastedBlocks) return text
|
||||||
|
PsiDocumentManager.getInstance(project).commitDocument(editor.document)
|
||||||
|
return LyngPastePreProcessor.reindentForPaste(project, editor, file, text)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,138 @@
|
|||||||
|
/*
|
||||||
|
* Copyright 2026 Sergey S. Chernov real.sergeych@gmail.com
|
||||||
|
*
|
||||||
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
* you may not use this file except in compliance with the License.
|
||||||
|
* You may obtain a copy of the License at
|
||||||
|
*
|
||||||
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
*
|
||||||
|
* Unless required by applicable law or agreed to in writing, software
|
||||||
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
* See the License for the specific language governing permissions and
|
||||||
|
* limitations under the License.
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
package net.sergeych.lyng.idea.editor
|
||||||
|
|
||||||
|
import com.intellij.application.options.CodeStyle
|
||||||
|
import com.intellij.codeInsight.editorActions.TypedHandlerDelegate
|
||||||
|
import com.intellij.openapi.command.WriteCommandAction
|
||||||
|
import com.intellij.openapi.diagnostic.Logger
|
||||||
|
import com.intellij.openapi.editor.Document
|
||||||
|
import com.intellij.openapi.editor.Editor
|
||||||
|
import com.intellij.openapi.project.Project
|
||||||
|
import com.intellij.openapi.util.TextRange
|
||||||
|
import com.intellij.psi.PsiDocumentManager
|
||||||
|
import com.intellij.psi.PsiFile
|
||||||
|
import com.intellij.psi.codeStyle.CodeStyleManager
|
||||||
|
import net.sergeych.lyng.format.BraceUtils
|
||||||
|
import net.sergeych.lyng.format.LyngFormatConfig
|
||||||
|
import net.sergeych.lyng.format.LyngFormatter
|
||||||
|
import net.sergeych.lyng.idea.LyngLanguage
|
||||||
|
import net.sergeych.lyng.idea.settings.LyngFormatterSettings
|
||||||
|
import net.sergeych.lyng.idea.util.FormattingUtils.computeDesiredIndent
|
||||||
|
import net.sergeych.lyng.idea.util.FormattingUtils.findFirstNonWs
|
||||||
|
|
||||||
|
class LyngTypedHandler : TypedHandlerDelegate() {
|
||||||
|
private val log = Logger.getInstance(LyngTypedHandler::class.java)
|
||||||
|
|
||||||
|
override fun charTyped(c: Char, project: Project, editor: Editor, file: PsiFile): Result {
|
||||||
|
if (file.language != LyngLanguage) return Result.CONTINUE
|
||||||
|
|
||||||
|
if (c == '}') {
|
||||||
|
val doc = editor.document
|
||||||
|
PsiDocumentManager.getInstance(project).commitDocument(doc)
|
||||||
|
|
||||||
|
val offset = editor.caretModel.offset
|
||||||
|
val line = doc.getLineNumber((offset - 1).coerceAtLeast(0))
|
||||||
|
if (line < 0) return Result.CONTINUE
|
||||||
|
|
||||||
|
val rawLine = doc.getLineText(line)
|
||||||
|
val code = rawLine.substringBefore("//").trim()
|
||||||
|
if (code == "}") {
|
||||||
|
val settings = LyngFormatterSettings.getInstance(project)
|
||||||
|
if (settings.reindentClosedBlockOnEnter) {
|
||||||
|
reindentClosedBlockAroundBrace(project, file, doc, line)
|
||||||
|
}
|
||||||
|
// After block reindent, adjust line indent to what platform thinks (no-op in many cases)
|
||||||
|
val lineStart = doc.getLineStartOffset(line)
|
||||||
|
if (file.context == null) {
|
||||||
|
try {
|
||||||
|
CodeStyleManager.getInstance(project).adjustLineIndent(file, lineStart)
|
||||||
|
} catch (e: Exception) {
|
||||||
|
log.warn("Failed to adjust line indent for current line: ${e.message}")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
} else if (c == '/') {
|
||||||
|
val doc = editor.document
|
||||||
|
val offset = editor.caretModel.offset
|
||||||
|
if (offset >= 2 && doc.getText(TextRange(offset - 2, offset)) == "*/") {
|
||||||
|
PsiDocumentManager.getInstance(project).commitDocument(doc)
|
||||||
|
val line = doc.getLineNumber(offset - 1)
|
||||||
|
val lineStart = doc.getLineStartOffset(line)
|
||||||
|
if (file.context == null) {
|
||||||
|
try {
|
||||||
|
CodeStyleManager.getInstance(project).adjustLineIndent(file, lineStart)
|
||||||
|
} catch (e: Exception) {
|
||||||
|
log.warn("Failed to adjust line indent for comment: ${e.message}")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Manual application fallback
|
||||||
|
val desired = computeDesiredIndent(project, doc, line)
|
||||||
|
val lineEnd = doc.getLineEndOffset(line)
|
||||||
|
val firstNonWs = findFirstNonWs(doc, lineStart, lineEnd)
|
||||||
|
val currentIndentLen = firstNonWs - lineStart
|
||||||
|
if (doc.getText(TextRange(lineStart, lineStart + currentIndentLen)) != desired) {
|
||||||
|
WriteCommandAction.runWriteCommandAction(project) {
|
||||||
|
doc.replaceString(lineStart, lineStart + currentIndentLen, desired)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return Result.CONTINUE
|
||||||
|
}
|
||||||
|
|
||||||
|
private fun reindentClosedBlockAroundBrace(project: Project, file: PsiFile, doc: Document, braceLine: Int) {
|
||||||
|
val braceLineStart = doc.getLineStartOffset(braceLine)
|
||||||
|
val braceLineEnd = doc.getLineEndOffset(braceLine)
|
||||||
|
val rawBraceLine = doc.getText(TextRange(braceLineStart, braceLineEnd))
|
||||||
|
val codeBraceLine = rawBraceLine.substringBefore("//")
|
||||||
|
val closeRel = codeBraceLine.lastIndexOf('}')
|
||||||
|
if (closeRel < 0) return
|
||||||
|
val closeAbs = braceLineStart + closeRel
|
||||||
|
|
||||||
|
val blockRange = BraceUtils.findEnclosingBlockRange(
|
||||||
|
doc.charsSequence,
|
||||||
|
closeAbs,
|
||||||
|
includeTrailingNewline = true
|
||||||
|
) ?: return
|
||||||
|
|
||||||
|
val options = CodeStyle.getIndentOptions(project, doc)
|
||||||
|
val cfg = LyngFormatConfig(
|
||||||
|
indentSize = options.INDENT_SIZE.coerceAtLeast(1),
|
||||||
|
useTabs = options.USE_TAB_CHARACTER,
|
||||||
|
continuationIndentSize = options.CONTINUATION_INDENT_SIZE.coerceAtLeast(options.INDENT_SIZE.coerceAtLeast(1)),
|
||||||
|
)
|
||||||
|
|
||||||
|
val whole = doc.text
|
||||||
|
val updated = LyngFormatter.reindentRange(whole, blockRange, cfg, preserveBaseIndent = true)
|
||||||
|
if (updated != whole) {
|
||||||
|
WriteCommandAction.runWriteCommandAction(project) {
|
||||||
|
doc.replaceString(0, doc.textLength, updated)
|
||||||
|
}
|
||||||
|
PsiDocumentManager.getInstance(project).commitDocument(doc)
|
||||||
|
if (log.isDebugEnabled) log.debug("[LyngTyped] reindented closed block range=$blockRange")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
private fun Document.getLineText(line: Int): String {
|
||||||
|
if (line < 0 || line >= lineCount) return ""
|
||||||
|
val start = getLineStartOffset(line)
|
||||||
|
val end = getLineEndOffset(line)
|
||||||
|
return getText(TextRange(start, end))
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,58 @@
|
|||||||
|
/*
|
||||||
|
* Copyright 2026 Sergey S. Chernov real.sergeych@gmail.com
|
||||||
|
*
|
||||||
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
* you may not use this file except in compliance with the License.
|
||||||
|
* You may obtain a copy of the License at
|
||||||
|
*
|
||||||
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
*
|
||||||
|
* Unless required by applicable law or agreed to in writing, software
|
||||||
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
* See the License for the specific language governing permissions and
|
||||||
|
* limitations under the License.
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
package net.sergeych.lyng.idea.format
|
||||||
|
|
||||||
|
import com.intellij.formatting.*
|
||||||
|
import com.intellij.lang.ASTNode
|
||||||
|
import com.intellij.openapi.util.TextRange
|
||||||
|
import com.intellij.psi.PsiElement
|
||||||
|
import com.intellij.psi.PsiFile
|
||||||
|
import com.intellij.psi.codeStyle.CodeStyleSettings
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Minimal formatting model: enables Reformat Code to at least re-apply indentation via LineIndentProvider
|
||||||
|
* and normalize whitespace. We don’t implement a full PSI-based tree yet; this block treats the whole file
|
||||||
|
* as a single formatting region and lets platform query line indents.
|
||||||
|
*/
|
||||||
|
class LyngFormattingModelBuilder : FormattingModelBuilder {
|
||||||
|
override fun createModel(element: PsiElement, settings: CodeStyleSettings): FormattingModel {
|
||||||
|
val file = element.containingFile
|
||||||
|
val rootBlock = LineBlocksRootBlock(file, settings)
|
||||||
|
return FormattingModelProvider.createFormattingModelForPsiFile(file, rootBlock, settings)
|
||||||
|
}
|
||||||
|
|
||||||
|
override fun getRangeAffectingIndent(file: PsiFile, offset: Int, elementAtOffset: ASTNode?): TextRange? = null
|
||||||
|
}
|
||||||
|
|
||||||
|
private class LineBlocksRootBlock(
|
||||||
|
private val file: PsiFile,
|
||||||
|
private val settings: CodeStyleSettings
|
||||||
|
) : Block {
|
||||||
|
override fun getTextRange(): TextRange = TextRange(0, file.textLength)
|
||||||
|
|
||||||
|
override fun getSubBlocks(): List<Block> = emptyList()
|
||||||
|
|
||||||
|
override fun getWrap(): Wrap? = null
|
||||||
|
override fun getIndent(): Indent? = Indent.getNoneIndent()
|
||||||
|
override fun getAlignment(): Alignment? = null
|
||||||
|
override fun getSpacing(child1: Block?, child2: Block): Spacing? = null
|
||||||
|
override fun getChildAttributes(newChildIndex: Int): ChildAttributes = ChildAttributes(Indent.getNoneIndent(), null)
|
||||||
|
override fun isIncomplete(): Boolean = false
|
||||||
|
override fun isLeaf(): Boolean = true
|
||||||
|
}
|
||||||
|
|
||||||
|
// Intentionally no sub-blocks/spacing: indentation is handled by PreFormatProcessor + LineIndentProvider
|
||||||
@@ -0,0 +1,80 @@
|
|||||||
|
/*
|
||||||
|
* Copyright 2026 Sergey S. Chernov real.sergeych@gmail.com
|
||||||
|
*
|
||||||
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
* you may not use this file except in compliance with the License.
|
||||||
|
* You may obtain a copy of the License at
|
||||||
|
*
|
||||||
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
*
|
||||||
|
* Unless required by applicable law or agreed to in writing, software
|
||||||
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
* See the License for the specific language governing permissions and
|
||||||
|
* limitations under the License.
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
package net.sergeych.lyng.idea.format
|
||||||
|
|
||||||
|
import com.intellij.application.options.CodeStyle
|
||||||
|
import com.intellij.lang.Language
|
||||||
|
import com.intellij.openapi.editor.Document
|
||||||
|
import com.intellij.openapi.editor.Editor
|
||||||
|
import com.intellij.openapi.util.TextRange
|
||||||
|
import com.intellij.psi.PsiDocumentManager
|
||||||
|
import com.intellij.psi.codeStyle.CommonCodeStyleSettings.IndentOptions
|
||||||
|
import com.intellij.psi.codeStyle.lineIndent.LineIndentProvider
|
||||||
|
import net.sergeych.lyng.idea.LyngLanguage
|
||||||
|
import net.sergeych.lyng.idea.util.FormattingUtils
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Lightweight indentation provider for Lyng.
|
||||||
|
*
|
||||||
|
* Rules (heuristic, text-based):
|
||||||
|
* - New lines after an opening brace/paren increase indent level.
|
||||||
|
* - Lines starting with a closing brace/paren decrease indent level by one.
|
||||||
|
* - Keeps previous non-empty line's indent as baseline otherwise.
|
||||||
|
*/
|
||||||
|
class LyngLineIndentProvider : LineIndentProvider {
|
||||||
|
override fun getLineIndent(project: com.intellij.openapi.project.Project, editor: Editor, language: Language?, offset: Int): String? {
|
||||||
|
if (language != null && language != LyngLanguage) return null
|
||||||
|
val doc = editor.document
|
||||||
|
PsiDocumentManager.getInstance(project).commitDocument(doc)
|
||||||
|
|
||||||
|
val options = CodeStyle.getIndentOptions(project, doc)
|
||||||
|
|
||||||
|
val line = doc.getLineNumberSafe(offset)
|
||||||
|
return FormattingUtils.computeDesiredIndent(project, doc, line)
|
||||||
|
}
|
||||||
|
|
||||||
|
override fun isSuitableFor(language: Language?): Boolean = language == null || language == LyngLanguage
|
||||||
|
|
||||||
|
private fun Document.getLineNumberSafe(offset: Int): Int =
|
||||||
|
getLineNumber(offset.coerceIn(0, textLength))
|
||||||
|
|
||||||
|
private fun Document.getLineText(line: Int): String {
|
||||||
|
if (line < 0 || line >= lineCount) return ""
|
||||||
|
val start = getLineStartOffset(line)
|
||||||
|
val end = getLineEndOffset(line)
|
||||||
|
return getText(TextRange(start, end))
|
||||||
|
}
|
||||||
|
|
||||||
|
private fun indentUnit(options: IndentOptions): String =
|
||||||
|
if (options.USE_TAB_CHARACTER) "\t" else " ".repeat(options.INDENT_SIZE.coerceAtLeast(1))
|
||||||
|
|
||||||
|
private fun indentOfLine(doc: Document, line: Int): String {
|
||||||
|
val s = doc.getLineText(line)
|
||||||
|
val i = s.indexOfFirst { !it.isWhitespace() }
|
||||||
|
return if (i <= 0) s.takeWhile { it == ' ' || it == '\t' } else s.substring(0, i)
|
||||||
|
}
|
||||||
|
|
||||||
|
private fun countIndentUnits(indent: String, options: IndentOptions): Int {
|
||||||
|
if (indent.isEmpty()) return 0
|
||||||
|
if (options.USE_TAB_CHARACTER) return indent.count { it == '\t' }
|
||||||
|
val size = options.INDENT_SIZE.coerceAtLeast(1)
|
||||||
|
var spaces = 0
|
||||||
|
for (ch in indent) spaces += if (ch == '\t') size else 1
|
||||||
|
return spaces / size
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
@@ -0,0 +1,22 @@
|
|||||||
|
/*
|
||||||
|
* Copyright 2025 Sergey S. Chernov real.sergeych@gmail.com
|
||||||
|
*
|
||||||
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
* you may not use this file except in compliance with the License.
|
||||||
|
* You may obtain a copy of the License at
|
||||||
|
*
|
||||||
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
*
|
||||||
|
* Unless required by applicable law or agreed to in writing, software
|
||||||
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
* See the License for the specific language governing permissions and
|
||||||
|
* limitations under the License.
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
package net.sergeych.lyng.idea.format
|
||||||
|
|
||||||
|
// Placeholder: we planned a post-format processor fallback, but the 2024.3 platform
|
||||||
|
// does not expose the older PostFormatProcessor API in our current dependency set.
|
||||||
|
// Reformat Code will use the registered lang.formatter + LineIndentProvider.
|
||||||
|
internal object LyngPostFormatProcessorPlaceholder
|
||||||
@@ -0,0 +1,208 @@
|
|||||||
|
/*
|
||||||
|
* Copyright 2026 Sergey S. Chernov real.sergeych@gmail.com
|
||||||
|
*
|
||||||
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
* you may not use this file except in compliance with the License.
|
||||||
|
* You may obtain a copy of the License at
|
||||||
|
*
|
||||||
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
*
|
||||||
|
* Unless required by applicable law or agreed to in writing, software
|
||||||
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
* See the License for the specific language governing permissions and
|
||||||
|
* limitations under the License.
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
package net.sergeych.lyng.idea.format
|
||||||
|
|
||||||
|
import com.intellij.application.options.CodeStyle
|
||||||
|
import com.intellij.lang.ASTNode
|
||||||
|
import com.intellij.openapi.project.Project
|
||||||
|
import com.intellij.openapi.util.TextRange
|
||||||
|
import com.intellij.psi.codeStyle.CodeStyleManager
|
||||||
|
import com.intellij.psi.impl.source.codeStyle.PreFormatProcessor
|
||||||
|
import net.sergeych.lyng.format.LyngFormatConfig
|
||||||
|
import net.sergeych.lyng.format.LyngFormatter
|
||||||
|
import net.sergeych.lyng.idea.LyngLanguage
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Idempotent indentation fixer executed by Reformat Code before formatting.
|
||||||
|
* It walks all lines in the affected range and applies exact indentation using
|
||||||
|
* CodeStyleManager.adjustLineIndent(), which delegates to our LineIndentProvider.
|
||||||
|
*/
|
||||||
|
class LyngPreFormatProcessor : PreFormatProcessor {
|
||||||
|
override fun process(element: ASTNode, range: TextRange): TextRange {
|
||||||
|
val file = element.psi?.containingFile ?: return range
|
||||||
|
if (file.language != LyngLanguage) return range
|
||||||
|
val project: Project = file.project
|
||||||
|
val doc = file.viewProvider.document ?: return range
|
||||||
|
val psiDoc = com.intellij.psi.PsiDocumentManager.getInstance(project)
|
||||||
|
val options = CodeStyle.getIndentOptions(project, doc)
|
||||||
|
|
||||||
|
val settings = net.sergeych.lyng.idea.settings.LyngFormatterSettings.getInstance(project)
|
||||||
|
// When both spacing and wrapping are OFF, still fix indentation for the whole file to
|
||||||
|
// guarantee visible changes on Reformat Code.
|
||||||
|
val runFullFileIndent = !settings.enableSpacing && !settings.enableWrapping
|
||||||
|
var modified = false
|
||||||
|
|
||||||
|
val docW = doc as? com.intellij.injected.editor.DocumentWindow
|
||||||
|
// The host range of the entire injected fragment (or the whole file if not injected).
|
||||||
|
fun currentHostRange(): TextRange = if (docW != null) {
|
||||||
|
TextRange(docW.injectedToHost(0), docW.injectedToHost(doc.textLength))
|
||||||
|
} else {
|
||||||
|
file.textRange
|
||||||
|
}
|
||||||
|
|
||||||
|
// The range in 'doc' coordinate system (local 0..len for injections, host offsets for normal files).
|
||||||
|
fun currentLocalRange(): TextRange = if (docW != null) {
|
||||||
|
TextRange(0, doc.textLength)
|
||||||
|
} else {
|
||||||
|
file.textRange
|
||||||
|
}
|
||||||
|
|
||||||
|
val clr = currentLocalRange()
|
||||||
|
val chr = currentHostRange()
|
||||||
|
|
||||||
|
// Convert the input range to the coordinate system of 'doc'
|
||||||
|
var workingRangeLocal: TextRange = if (docW != null) {
|
||||||
|
val hostIntersection = range.intersection(chr)
|
||||||
|
if (hostIntersection != null) {
|
||||||
|
try {
|
||||||
|
val start = docW.hostToInjected(hostIntersection.startOffset)
|
||||||
|
val end = docW.hostToInjected(hostIntersection.endOffset)
|
||||||
|
TextRange(start.coerceAtMost(end), end.coerceAtLeast(start))
|
||||||
|
} catch (e: Exception) {
|
||||||
|
clr
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
range.intersection(clr) ?: clr
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
range.intersection(clr) ?: clr
|
||||||
|
}
|
||||||
|
|
||||||
|
val startLine = if (runFullFileIndent) {
|
||||||
|
doc.getLineNumber(currentLocalRange().startOffset)
|
||||||
|
} else {
|
||||||
|
doc.getLineNumber(workingRangeLocal.startOffset)
|
||||||
|
}
|
||||||
|
val endLine = if (runFullFileIndent) {
|
||||||
|
if (clr.endOffset <= clr.startOffset) doc.getLineNumber(clr.startOffset)
|
||||||
|
else doc.getLineNumber(clr.endOffset)
|
||||||
|
} else {
|
||||||
|
doc.getLineNumber(workingRangeLocal.endOffset.coerceAtMost(doc.textLength))
|
||||||
|
}
|
||||||
|
|
||||||
|
fun codePart(s: String): String {
|
||||||
|
val idx = s.indexOf("//")
|
||||||
|
return if (idx >= 0) s.substring(0, idx) else s
|
||||||
|
}
|
||||||
|
|
||||||
|
// Pre-scan to compute balances up to startLine.
|
||||||
|
val fragmentStartLine = doc.getLineNumber(currentLocalRange().startOffset)
|
||||||
|
var blockLevel = 0
|
||||||
|
var parenBalance = 0
|
||||||
|
var bracketBalance = 0
|
||||||
|
for (ln in fragmentStartLine until startLine) {
|
||||||
|
val text = doc.getText(TextRange(doc.getLineStartOffset(ln), doc.getLineEndOffset(ln)))
|
||||||
|
for (ch in codePart(text)) when (ch) {
|
||||||
|
'{' -> blockLevel++
|
||||||
|
'}' -> if (blockLevel > 0) blockLevel--
|
||||||
|
'(' -> parenBalance++
|
||||||
|
')' -> if (parenBalance > 0) parenBalance--
|
||||||
|
'[' -> bracketBalance++
|
||||||
|
']' -> if (bracketBalance > 0) bracketBalance--
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Re-indent each line deterministically (idempotent). We avoid any content
|
||||||
|
// rewriting here to prevent long-running passes or re-entrant formatting.
|
||||||
|
for (line in startLine..endLine) {
|
||||||
|
val lineStart = doc.getLineStartOffset(line)
|
||||||
|
// adjustLineIndent delegates to our LineIndentProvider which computes
|
||||||
|
// indentation from scratch; this is safe and idempotent
|
||||||
|
if (file.context == null) {
|
||||||
|
try {
|
||||||
|
CodeStyleManager.getInstance(project).adjustLineIndent(file, lineStart)
|
||||||
|
} catch (e: Exception) {
|
||||||
|
// Log as debug because this can be called many times during reformat
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// After indentation, update block/paren/bracket balances using the current line text
|
||||||
|
val lineEnd = doc.getLineEndOffset(line)
|
||||||
|
val text = doc.getText(TextRange(lineStart, lineEnd))
|
||||||
|
val code = codePart(text)
|
||||||
|
for (ch in code) when (ch) {
|
||||||
|
'{' -> blockLevel++
|
||||||
|
'}' -> if (blockLevel > 0) blockLevel--
|
||||||
|
'(' -> parenBalance++
|
||||||
|
')' -> if (parenBalance > 0) parenBalance--
|
||||||
|
'[' -> bracketBalance++
|
||||||
|
']' -> if (bracketBalance > 0) bracketBalance--
|
||||||
|
}
|
||||||
|
}
|
||||||
|
// If both spacing and wrapping are OFF, explicitly reindent the text using core formatter to
|
||||||
|
// guarantee indentation is fixed even when the platform doesn't rewrite whitespace by itself.
|
||||||
|
if (!settings.enableSpacing && !settings.enableWrapping) {
|
||||||
|
val cfg = LyngFormatConfig(
|
||||||
|
indentSize = options.INDENT_SIZE.coerceAtLeast(1),
|
||||||
|
useTabs = options.USE_TAB_CHARACTER,
|
||||||
|
continuationIndentSize = options.CONTINUATION_INDENT_SIZE.coerceAtLeast(options.INDENT_SIZE.coerceAtLeast(1)),
|
||||||
|
)
|
||||||
|
val r = if (runFullFileIndent) currentLocalRange() else workingRangeLocal.intersection(currentLocalRange()) ?: currentLocalRange()
|
||||||
|
val text = doc.getText(r)
|
||||||
|
val formatted = LyngFormatter.reindent(text, cfg)
|
||||||
|
if (formatted != text) {
|
||||||
|
doc.replaceString(r.startOffset, r.endOffset, formatted)
|
||||||
|
modified = true
|
||||||
|
psiDoc.commitDocument(doc)
|
||||||
|
workingRangeLocal = currentLocalRange()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Optionally apply spacing using the core formatter if enabled in settings (wrapping stays off)
|
||||||
|
if (settings.enableSpacing) {
|
||||||
|
val cfg = LyngFormatConfig(
|
||||||
|
indentSize = options.INDENT_SIZE.coerceAtLeast(1),
|
||||||
|
useTabs = options.USE_TAB_CHARACTER,
|
||||||
|
continuationIndentSize = options.CONTINUATION_INDENT_SIZE.coerceAtLeast(options.INDENT_SIZE.coerceAtLeast(1)),
|
||||||
|
applySpacing = true,
|
||||||
|
applyWrapping = false,
|
||||||
|
)
|
||||||
|
val r = if (runFullFileIndent) currentLocalRange() else workingRangeLocal.intersection(currentLocalRange()) ?: currentLocalRange()
|
||||||
|
val text = doc.getText(r)
|
||||||
|
val formatted = LyngFormatter.format(text, cfg)
|
||||||
|
if (formatted != text) {
|
||||||
|
doc.replaceString(r.startOffset, r.endOffset, formatted)
|
||||||
|
modified = true
|
||||||
|
psiDoc.commitDocument(doc)
|
||||||
|
workingRangeLocal = currentLocalRange()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
// Optionally apply wrapping (after spacing) when enabled
|
||||||
|
if (settings.enableWrapping) {
|
||||||
|
val cfg = LyngFormatConfig(
|
||||||
|
indentSize = options.INDENT_SIZE.coerceAtLeast(1),
|
||||||
|
useTabs = options.USE_TAB_CHARACTER,
|
||||||
|
continuationIndentSize = options.CONTINUATION_INDENT_SIZE.coerceAtLeast(options.INDENT_SIZE.coerceAtLeast(1)),
|
||||||
|
applySpacing = settings.enableSpacing,
|
||||||
|
applyWrapping = true,
|
||||||
|
)
|
||||||
|
val r = if (runFullFileIndent) currentLocalRange() else workingRangeLocal.intersection(currentLocalRange()) ?: currentLocalRange()
|
||||||
|
val text = doc.getText(r)
|
||||||
|
val wrapped = LyngFormatter.format(text, cfg)
|
||||||
|
if (wrapped != text) {
|
||||||
|
doc.replaceString(r.startOffset, r.endOffset, wrapped)
|
||||||
|
modified = true
|
||||||
|
psiDoc.commitDocument(doc)
|
||||||
|
workingRangeLocal = currentLocalRange()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
// Return a safe range for the formatter to continue with, preventing stale offsets.
|
||||||
|
// For injected files, ALWAYS return a range in local coordinates.
|
||||||
|
val finalRange = currentLocalRange()
|
||||||
|
return if (modified) finalRange else (range.intersection(finalRange) ?: finalRange)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,43 @@
|
|||||||
|
/*
|
||||||
|
* Copyright 2025 Sergey S. Chernov real.sergeych@gmail.com
|
||||||
|
*
|
||||||
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
* you may not use this file except in compliance with the License.
|
||||||
|
* You may obtain a copy of the License at
|
||||||
|
*
|
||||||
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
*
|
||||||
|
* Unless required by applicable law or agreed to in writing, software
|
||||||
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
* See the License for the specific language governing permissions and
|
||||||
|
* limitations under the License.
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
package net.sergeych.lyng.idea.grazie
|
||||||
|
|
||||||
|
import com.intellij.codeInsight.daemon.DaemonCodeAnalyzer
|
||||||
|
import com.intellij.codeInsight.intention.IntentionAction
|
||||||
|
import com.intellij.openapi.editor.Editor
|
||||||
|
import com.intellij.openapi.project.Project
|
||||||
|
import com.intellij.psi.PsiFile
|
||||||
|
import net.sergeych.lyng.idea.settings.LyngFormatterSettings
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Lightweight quick-fix that adds a word to the per-project Lyng dictionary.
|
||||||
|
*/
|
||||||
|
class AddToLyngDictionaryFix(private val word: String) : IntentionAction {
|
||||||
|
override fun getText(): String = "Add '$word' to Lyng dictionary"
|
||||||
|
override fun getFamilyName(): String = "Lyng Spelling"
|
||||||
|
override fun isAvailable(project: Project, editor: Editor?, file: PsiFile?): Boolean = word.isNotBlank()
|
||||||
|
override fun startInWriteAction(): Boolean = true
|
||||||
|
|
||||||
|
override fun invoke(project: Project, editor: Editor?, file: PsiFile?) {
|
||||||
|
val settings = LyngFormatterSettings.getInstance(project)
|
||||||
|
val learned = settings.learnedWords
|
||||||
|
learned.add(word.lowercase())
|
||||||
|
settings.learnedWords = learned
|
||||||
|
// Restart daemon to refresh highlights
|
||||||
|
if (file != null) DaemonCodeAnalyzer.getInstance(project).restart(file)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,83 @@
|
|||||||
|
/*
|
||||||
|
* Copyright 2025 Sergey S. Chernov real.sergeych@gmail.com
|
||||||
|
*
|
||||||
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
* you may not use this file except in compliance with the License.
|
||||||
|
* You may obtain a copy of the License at
|
||||||
|
*
|
||||||
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
*
|
||||||
|
* Unless required by applicable law or agreed to in writing, software
|
||||||
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
* See the License for the specific language governing permissions and
|
||||||
|
* limitations under the License.
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
package net.sergeych.lyng.idea.grazie
|
||||||
|
|
||||||
|
import com.intellij.openapi.diagnostic.Logger
|
||||||
|
import java.io.BufferedReader
|
||||||
|
import java.io.InputStreamReader
|
||||||
|
import java.util.zip.GZIPInputStream
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Very simple English dictionary loader for offline suggestions on IC-243.
|
||||||
|
* It loads a word list from classpath resources. Supports plain text (one word per line)
|
||||||
|
* and gzipped text if the resource ends with .gz.
|
||||||
|
*/
|
||||||
|
object EnglishDictionary {
|
||||||
|
private val log = Logger.getInstance(EnglishDictionary::class.java)
|
||||||
|
|
||||||
|
@Volatile private var loaded = false
|
||||||
|
@Volatile private var words: Set<String> = emptySet()
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Load dictionary from bundled resources (once).
|
||||||
|
* If multiple candidates exist, the first found is used.
|
||||||
|
*/
|
||||||
|
private fun ensureLoaded() {
|
||||||
|
if (loaded) return
|
||||||
|
synchronized(this) {
|
||||||
|
if (loaded) return
|
||||||
|
val candidates = listOf(
|
||||||
|
// preferred large bundles first (add en-basic.txt.gz ~3–5MB here)
|
||||||
|
"/dictionaries/en-basic.txt.gz",
|
||||||
|
"/dictionaries/en-large.txt.gz",
|
||||||
|
// plain text fallbacks
|
||||||
|
"/dictionaries/en-basic.txt",
|
||||||
|
"/dictionaries/en-large.txt",
|
||||||
|
)
|
||||||
|
val merged = HashSet<String>(128_000)
|
||||||
|
for (res in candidates) {
|
||||||
|
try {
|
||||||
|
val stream = javaClass.getResourceAsStream(res) ?: continue
|
||||||
|
val reader = if (res.endsWith(".gz"))
|
||||||
|
BufferedReader(InputStreamReader(GZIPInputStream(stream)))
|
||||||
|
else
|
||||||
|
BufferedReader(InputStreamReader(stream))
|
||||||
|
var loadedCount = 0
|
||||||
|
reader.useLines { seq -> seq.forEach { line ->
|
||||||
|
val w = line.trim()
|
||||||
|
if (w.isNotEmpty() && !w.startsWith("#")) { merged += w.lowercase(); loadedCount++ }
|
||||||
|
} }
|
||||||
|
log.info("EnglishDictionary: loaded $loadedCount words from $res (total=${merged.size})")
|
||||||
|
} catch (t: Throwable) {
|
||||||
|
log.info("EnglishDictionary: failed to load $res: ${t.javaClass.simpleName}: ${t.message}")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if (merged.isEmpty()) {
|
||||||
|
// Fallback minimal set
|
||||||
|
merged += setOf("comment","comments","error","errors","found","file","not","word","words","count","value","name","class","function","string")
|
||||||
|
log.info("EnglishDictionary: using minimal built-in set (${merged.size})")
|
||||||
|
}
|
||||||
|
words = merged
|
||||||
|
loaded = true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
fun allWords(): Set<String> {
|
||||||
|
ensureLoaded()
|
||||||
|
return words
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,609 @@
|
|||||||
|
/*
|
||||||
|
* Copyright 2025 Sergey S. Chernov real.sergeych@gmail.com
|
||||||
|
*
|
||||||
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
* you may not use this file except in compliance with the License.
|
||||||
|
* You may obtain a copy of the License at
|
||||||
|
*
|
||||||
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
*
|
||||||
|
* Unless required by applicable law or agreed to in writing, software
|
||||||
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
* See the License for the specific language governing permissions and
|
||||||
|
* limitations under the License.
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
|
/*
|
||||||
|
* Grazie-backed annotator for Lyng files.
|
||||||
|
*
|
||||||
|
* It consumes the MiniAst-driven LyngSpellIndex and, when Grazie is present,
|
||||||
|
* tries to run Grazie checks on the extracted TextContent. Results are painted
|
||||||
|
* as warnings in the editor. If the Grazie API changes, we use reflection and
|
||||||
|
* fail softly with INFO logs (no errors shown to users).
|
||||||
|
*/
|
||||||
|
package net.sergeych.lyng.idea.grazie
|
||||||
|
|
||||||
|
import com.intellij.codeInsight.daemon.DaemonCodeAnalyzer
|
||||||
|
import com.intellij.grazie.text.TextContent
|
||||||
|
import com.intellij.grazie.text.TextContent.TextDomain
|
||||||
|
import com.intellij.ide.plugins.PluginManagerCore
|
||||||
|
import com.intellij.lang.annotation.AnnotationHolder
|
||||||
|
import com.intellij.lang.annotation.ExternalAnnotator
|
||||||
|
import com.intellij.lang.annotation.HighlightSeverity
|
||||||
|
import com.intellij.openapi.application.ApplicationManager
|
||||||
|
import com.intellij.openapi.diagnostic.Logger
|
||||||
|
import com.intellij.openapi.editor.Document
|
||||||
|
import com.intellij.openapi.editor.colors.TextAttributesKey
|
||||||
|
import com.intellij.openapi.project.DumbAware
|
||||||
|
import com.intellij.openapi.util.Key
|
||||||
|
import com.intellij.openapi.util.TextRange
|
||||||
|
import com.intellij.psi.PsiFile
|
||||||
|
import net.sergeych.lyng.idea.settings.LyngFormatterSettings
|
||||||
|
import net.sergeych.lyng.idea.spell.LyngSpellIndex
|
||||||
|
|
||||||
|
class LyngGrazieAnnotator : ExternalAnnotator<LyngGrazieAnnotator.Input, LyngGrazieAnnotator.Result>(), DumbAware {
|
||||||
|
private val log = Logger.getInstance(LyngGrazieAnnotator::class.java)
|
||||||
|
|
||||||
|
companion object {
|
||||||
|
// Cache GrammarChecker availability to avoid repeated reflection + noisy logs
|
||||||
|
@Volatile
|
||||||
|
private var grammarCheckerAvailable: Boolean? = null
|
||||||
|
|
||||||
|
@Volatile
|
||||||
|
private var grammarCheckerMissingLogged: Boolean = false
|
||||||
|
|
||||||
|
private fun isGrammarCheckerKnownMissing(): Boolean = (grammarCheckerAvailable == false)
|
||||||
|
|
||||||
|
private fun markGrammarCheckerMissingOnce(log: Logger, message: String) {
|
||||||
|
if (!grammarCheckerMissingLogged) {
|
||||||
|
// Downgrade to debug to reduce log noise across projects/sessions
|
||||||
|
log.debug(message)
|
||||||
|
grammarCheckerMissingLogged = true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
private val RETRY_KEY: Key<Long> = Key.create("LYNG_GRAZIE_ANN_RETRY_STAMP")
|
||||||
|
}
|
||||||
|
|
||||||
|
data class Input(val modStamp: Long)
|
||||||
|
data class Finding(val range: TextRange, val message: String)
|
||||||
|
data class Result(val modStamp: Long, val findings: List<Finding>)
|
||||||
|
|
||||||
|
override fun collectInformation(file: PsiFile): Input? {
|
||||||
|
val doc: Document = file.viewProvider.document ?: return null
|
||||||
|
// Only require Grazie presence; index readiness is checked in apply with a retry.
|
||||||
|
val grazie = isGrazieInstalled()
|
||||||
|
if (!grazie) {
|
||||||
|
log.info("LyngGrazieAnnotator.collectInformation: skip (grazie=false) file='${file.name}'")
|
||||||
|
return null
|
||||||
|
}
|
||||||
|
log.info("LyngGrazieAnnotator.collectInformation: file='${file.name}', modStamp=${doc.modificationStamp}")
|
||||||
|
return Input(doc.modificationStamp)
|
||||||
|
}
|
||||||
|
|
||||||
|
override fun doAnnotate(collectedInfo: Input?): Result? {
|
||||||
|
// All heavy lifting is done in apply where we have the file context
|
||||||
|
return collectedInfo?.let { Result(it.modStamp, emptyList()) }
|
||||||
|
}
|
||||||
|
|
||||||
|
override fun apply(file: PsiFile, annotationResult: Result?, holder: AnnotationHolder) {
|
||||||
|
if (annotationResult == null || !isGrazieInstalled()) return
|
||||||
|
val doc = file.viewProvider.document ?: return
|
||||||
|
val idx = LyngSpellIndex.getUpToDate(file) ?: run {
|
||||||
|
log.info("LyngGrazieAnnotator.apply: index not ready for '${file.name}', scheduling one-shot restart")
|
||||||
|
scheduleOneShotRestart(file, annotationResult.modStamp)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
val settings = LyngFormatterSettings.getInstance(file.project)
|
||||||
|
|
||||||
|
// Build TextContent fragments for comments/strings/identifiers according to settings
|
||||||
|
val fragments = mutableListOf<Pair<TextContent, TextRange>>()
|
||||||
|
try {
|
||||||
|
fun addFragments(ranges: List<TextRange>, domain: TextDomain) {
|
||||||
|
for (r in ranges) {
|
||||||
|
val local = rangeToTextContent(file, domain, r) ?: continue
|
||||||
|
fragments += local to r
|
||||||
|
}
|
||||||
|
}
|
||||||
|
// Comments always via COMMENTS
|
||||||
|
addFragments(idx.comments, TextDomain.COMMENTS)
|
||||||
|
// Strings: LITERALS if requested, else COMMENTS if fallback enabled
|
||||||
|
if (settings.spellCheckStringLiterals) {
|
||||||
|
val domain = if (settings.grazieTreatLiteralsAsComments) TextDomain.COMMENTS else TextDomain.LITERALS
|
||||||
|
addFragments(idx.strings, domain)
|
||||||
|
}
|
||||||
|
// Identifiers via COMMENTS to force painting in 243 unless user disables fallback
|
||||||
|
val idsDomain = if (settings.grazieTreatIdentifiersAsComments) TextDomain.COMMENTS else TextDomain.DOCUMENTATION
|
||||||
|
addFragments(idx.identifiers, idsDomain)
|
||||||
|
log.info(
|
||||||
|
"LyngGrazieAnnotator.apply: file='${file.name}', idxCounts ids=${idx.identifiers.size}, comments=${idx.comments.size}, strings=${idx.strings.size}, builtFragments=${fragments.size}"
|
||||||
|
)
|
||||||
|
} catch (e: Throwable) {
|
||||||
|
log.info("LyngGrazieAnnotator: failed to build TextContent fragments: ${e.javaClass.simpleName}: ${e.message}")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
if (fragments.isEmpty()) return
|
||||||
|
|
||||||
|
val findings = mutableListOf<Finding>()
|
||||||
|
var totalReturned = 0
|
||||||
|
var chosenEntry: String? = null
|
||||||
|
for ((content, hostRange) in fragments) {
|
||||||
|
try {
|
||||||
|
val (typos, entryNote) = runGrazieChecksWithTracing(file, content)
|
||||||
|
if (chosenEntry == null) chosenEntry = entryNote
|
||||||
|
if (typos != null) {
|
||||||
|
totalReturned += typos.size
|
||||||
|
for (t in typos) {
|
||||||
|
val rel = extractRangeFromTypo(t) ?: continue
|
||||||
|
// Map relative range inside fragment to host file range
|
||||||
|
val abs = TextRange(hostRange.startOffset + rel.startOffset, hostRange.startOffset + rel.endOffset)
|
||||||
|
findings += Finding(abs, extractMessageFromTypo(t) ?: "Spelling/Grammar")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
} catch (e: Throwable) {
|
||||||
|
log.info("LyngGrazieAnnotator: Grazie check failed: ${e.javaClass.simpleName}: ${e.message}")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
log.info("LyngGrazieAnnotator.apply: used=${chosenEntry ?: "<none>"}, totalFindings=$totalReturned, painting=${findings.size}")
|
||||||
|
|
||||||
|
// IMPORTANT: Do NOT fallback to the tiny bundled vocabulary on modern IDEs.
|
||||||
|
// If Grazie/Natural Languages processing returned nothing, we simply exit here
|
||||||
|
// to avoid low‑quality results from the legacy dictionary.
|
||||||
|
if (findings.isEmpty()) return
|
||||||
|
|
||||||
|
for (f in findings) {
|
||||||
|
val ab = holder.newAnnotation(HighlightSeverity.INFORMATION, f.message).range(f.range)
|
||||||
|
applyTypoStyleIfRequested(file, ab)
|
||||||
|
ab.create()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
private fun scheduleOneShotRestart(file: PsiFile, modStamp: Long) {
|
||||||
|
try {
|
||||||
|
val last = file.getUserData(RETRY_KEY)
|
||||||
|
if (last == modStamp) {
|
||||||
|
log.info("LyngGrazieAnnotator.restart: already retried for modStamp=$modStamp, skip")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
file.putUserData(RETRY_KEY, modStamp)
|
||||||
|
ApplicationManager.getApplication().invokeLater({
|
||||||
|
try {
|
||||||
|
DaemonCodeAnalyzer.getInstance(file.project).restart(file)
|
||||||
|
log.info("LyngGrazieAnnotator.restart: daemon restarted for '${file.name}'")
|
||||||
|
} catch (e: Throwable) {
|
||||||
|
log.info("LyngGrazieAnnotator.restart failed: ${e.javaClass.simpleName}: ${e.message}")
|
||||||
|
}
|
||||||
|
})
|
||||||
|
} catch (e: Throwable) {
|
||||||
|
log.info("LyngGrazieAnnotator.scheduleOneShotRestart failed: ${e.javaClass.simpleName}: ${e.message}")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
private fun isGrazieInstalled(): Boolean {
|
||||||
|
return PluginManagerCore.isPluginInstalled(com.intellij.openapi.extensions.PluginId.getId("com.intellij.grazie")) ||
|
||||||
|
PluginManagerCore.isPluginInstalled(com.intellij.openapi.extensions.PluginId.getId("tanvd.grazi"))
|
||||||
|
}
|
||||||
|
|
||||||
|
private fun rangeToTextContent(file: PsiFile, domain: TextDomain, range: TextRange): TextContent? {
|
||||||
|
// Build TextContent via reflection: prefer psiFragment(domain, element)
|
||||||
|
return try {
|
||||||
|
// Try to find an element that fully covers the target range
|
||||||
|
var element = file.findElementAt(range.startOffset) ?: return null
|
||||||
|
val start = range.startOffset
|
||||||
|
val end = range.endOffset
|
||||||
|
while (element.parent != null && (element.textRange.startOffset > start || element.textRange.endOffset < end)) {
|
||||||
|
element = element.parent
|
||||||
|
}
|
||||||
|
if (element.textRange.startOffset > start || element.textRange.endOffset < end) return null
|
||||||
|
// In many cases, the element may not span the whole range; use file + range via suitable factory
|
||||||
|
val methods = TextContent::class.java.methods.filter { it.name == "psiFragment" }
|
||||||
|
val byElementDomain = methods.firstOrNull { it.parameterCount == 2 && it.parameterTypes[0].name.endsWith("PsiElement") }
|
||||||
|
if (byElementDomain != null) {
|
||||||
|
@Suppress("UNCHECKED_CAST")
|
||||||
|
return (byElementDomain.invoke(null, element, domain) as? TextContent)?.let { tc ->
|
||||||
|
val relStart = start - element.textRange.startOffset
|
||||||
|
val relEnd = end - element.textRange.startOffset
|
||||||
|
if (relStart < 0 || relEnd > tc.length || relStart >= relEnd) return null
|
||||||
|
tc.subText(TextRange(relStart, relEnd))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
val byDomainElement = methods.firstOrNull { it.parameterCount == 2 && it.parameterTypes[0].name.endsWith("TextDomain") }
|
||||||
|
if (byDomainElement != null) {
|
||||||
|
@Suppress("UNCHECKED_CAST")
|
||||||
|
return (byDomainElement.invoke(null, domain, element) as? TextContent)?.let { tc ->
|
||||||
|
val relStart = start - element.textRange.startOffset
|
||||||
|
val relEnd = end - element.textRange.startOffset
|
||||||
|
if (relStart < 0 || relEnd > tc.length || relStart >= relEnd) return null
|
||||||
|
tc.subText(TextRange(relStart, relEnd))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
null
|
||||||
|
} catch (e: Throwable) {
|
||||||
|
log.info("LyngGrazieAnnotator: rangeToTextContent failed: ${e.javaClass.simpleName}: ${e.message}")
|
||||||
|
null
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
private fun runGrazieChecksWithTracing(file: PsiFile, content: TextContent): Pair<Collection<Any>?, String?> {
|
||||||
|
// Try known entry points via reflection to avoid hard dependencies on Grazie internals
|
||||||
|
if (isGrammarCheckerKnownMissing()) return null to null
|
||||||
|
try {
|
||||||
|
// 1) Static GrammarChecker.check(TextContent)
|
||||||
|
val checkerCls = try {
|
||||||
|
Class.forName("com.intellij.grazie.grammar.GrammarChecker").also { grammarCheckerAvailable = true }
|
||||||
|
} catch (t: Throwable) {
|
||||||
|
grammarCheckerAvailable = false
|
||||||
|
markGrammarCheckerMissingOnce(log, "LyngGrazieAnnotator: GrammarChecker class not found: ${t.javaClass.simpleName}: ${t.message}")
|
||||||
|
null
|
||||||
|
}
|
||||||
|
if (checkerCls != null) {
|
||||||
|
// Diagnostic: list available 'check' methods once
|
||||||
|
runCatching {
|
||||||
|
val checks = checkerCls.methods.filter { it.name == "check" }
|
||||||
|
val sig = checks.joinToString { m ->
|
||||||
|
val params = m.parameterTypes.joinToString(prefix = "(", postfix = ")") { it.simpleName }
|
||||||
|
"${m.name}$params static=${java.lang.reflect.Modifier.isStatic(m.modifiers)}"
|
||||||
|
}
|
||||||
|
log.info("LyngGrazieAnnotator: GrammarChecker.check candidates: ${if (sig.isEmpty()) "<none>" else sig}")
|
||||||
|
}
|
||||||
|
checkerCls.methods.firstOrNull { it.name == "check" && it.parameterCount == 1 && it.parameterTypes[0].name.endsWith("TextContent") }?.let { m ->
|
||||||
|
@Suppress("UNCHECKED_CAST")
|
||||||
|
val res = m.invoke(null, content) as? Collection<Any>
|
||||||
|
return res to "GrammarChecker.check(TextContent) static"
|
||||||
|
}
|
||||||
|
// 2) GrammarChecker.getInstance().check(TextContent)
|
||||||
|
val getInstance = checkerCls.methods.firstOrNull { it.name == "getInstance" && it.parameterCount == 0 }
|
||||||
|
val inst = getInstance?.invoke(null)
|
||||||
|
if (inst != null) {
|
||||||
|
val m = checkerCls.methods.firstOrNull { it.name == "check" && it.parameterCount == 1 && it.parameterTypes[0].name.endsWith("TextContent") }
|
||||||
|
if (m != null) {
|
||||||
|
@Suppress("UNCHECKED_CAST")
|
||||||
|
val res = m.invoke(inst, content) as? Collection<Any>
|
||||||
|
return res to "GrammarChecker.getInstance().check(TextContent)"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
// 3) GrammarChecker.getDefault().check(TextContent)
|
||||||
|
val getDefault = checkerCls.methods.firstOrNull { it.name == "getDefault" && it.parameterCount == 0 }
|
||||||
|
val def = getDefault?.invoke(null)
|
||||||
|
if (def != null) {
|
||||||
|
val m = checkerCls.methods.firstOrNull { it.name == "check" && it.parameterCount == 1 && it.parameterTypes[0].name.endsWith("TextContent") }
|
||||||
|
if (m != null) {
|
||||||
|
@Suppress("UNCHECKED_CAST")
|
||||||
|
val res = m.invoke(def, content) as? Collection<Any>
|
||||||
|
return res to "GrammarChecker.getDefault().check(TextContent)"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
// 4) Service from project/application: GrammarChecker as a service
|
||||||
|
runCatching {
|
||||||
|
val app = com.intellij.openapi.application.ApplicationManager.getApplication()
|
||||||
|
val getService = app::class.java.methods.firstOrNull { it.name == "getService" && it.parameterCount == 1 }
|
||||||
|
val svc = getService?.invoke(app, checkerCls)
|
||||||
|
if (svc != null) {
|
||||||
|
val m = checkerCls.methods.firstOrNull { it.name == "check" && it.parameterCount == 1 && it.parameterTypes[0].name.endsWith("TextContent") }
|
||||||
|
if (m != null) {
|
||||||
|
@Suppress("UNCHECKED_CAST")
|
||||||
|
val res = m.invoke(svc, content) as? Collection<Any>
|
||||||
|
if (res != null) return res to "Application.getService(GrammarChecker).check(TextContent)"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
runCatching {
|
||||||
|
val getService = file.project::class.java.methods.firstOrNull { it.name == "getService" && it.parameterCount == 1 }
|
||||||
|
val svc = getService?.invoke(file.project, checkerCls)
|
||||||
|
if (svc != null) {
|
||||||
|
val m = checkerCls.methods.firstOrNull { it.name == "check" && it.parameterCount == 1 && it.parameterTypes[0].name.endsWith("TextContent") }
|
||||||
|
if (m != null) {
|
||||||
|
@Suppress("UNCHECKED_CAST")
|
||||||
|
val res = m.invoke(svc, content) as? Collection<Any>
|
||||||
|
if (res != null) return res to "Project.getService(GrammarChecker).check(TextContent)"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
// 5) Fallback: search any public method named check that accepts TextContent in any Grazie class (static)
|
||||||
|
val candidateClasses = listOf(
|
||||||
|
"com.intellij.grazie.grammar.GrammarChecker",
|
||||||
|
"com.intellij.grazie.grammar.GrammarRunner",
|
||||||
|
"com.intellij.grazie.grammar.Grammar" // historical names
|
||||||
|
)
|
||||||
|
for (cn in candidateClasses) {
|
||||||
|
val cls = try { Class.forName(cn) } catch (_: Throwable) { continue }
|
||||||
|
val m = cls.methods.firstOrNull { it.name == "check" && it.parameterTypes.any { p -> p.name.endsWith("TextContent") } }
|
||||||
|
if (m != null) {
|
||||||
|
val args = arrayOfNulls<Any>(m.parameterCount)
|
||||||
|
// place content to the first TextContent parameter; others left null (common defaults)
|
||||||
|
for (i in 0 until m.parameterCount) if (m.parameterTypes[i].name.endsWith("TextContent")) { args[i] = content; break }
|
||||||
|
@Suppress("UNCHECKED_CAST")
|
||||||
|
val res = m.invoke(null, *args) as? Collection<Any>
|
||||||
|
if (res != null) return res to "$cn.${m.name}(TextContent)"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
// 6) Kotlin top-level function: GrammarCheckerKt.check(TextContent)
|
||||||
|
runCatching {
|
||||||
|
val kt = Class.forName("com.intellij.grazie.grammar.GrammarCheckerKt")
|
||||||
|
val m = kt.methods.firstOrNull { it.name == "check" && it.parameterTypes.any { p -> p.name.endsWith("TextContent") } }
|
||||||
|
if (m != null) {
|
||||||
|
val args = arrayOfNulls<Any>(m.parameterCount)
|
||||||
|
for (i in 0 until m.parameterCount) if (m.parameterTypes[i].name.endsWith("TextContent")) { args[i] = content; break }
|
||||||
|
@Suppress("UNCHECKED_CAST")
|
||||||
|
val res = m.invoke(null, *args) as? Collection<Any>
|
||||||
|
if (res != null) return res to "GrammarCheckerKt.check(TextContent)"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
} catch (e: Throwable) {
|
||||||
|
log.info("LyngGrazieAnnotator: runGrazieChecks reflection failed: ${e.javaClass.simpleName}: ${e.message}")
|
||||||
|
}
|
||||||
|
return null to null
|
||||||
|
}
|
||||||
|
|
||||||
|
private fun extractRangeFromTypo(typo: Any): TextRange? {
|
||||||
|
// Try to get a relative range from returned Grazie issue/typo via common accessors
|
||||||
|
return try {
|
||||||
|
// Common getters
|
||||||
|
val m1 = typo.javaClass.methods.firstOrNull { it.name == "getRange" && it.parameterCount == 0 }
|
||||||
|
val r1 = if (m1 != null) m1.invoke(typo) else null
|
||||||
|
when (r1) {
|
||||||
|
is TextRange -> return r1
|
||||||
|
is IntRange -> return TextRange(r1.first, r1.last + 1)
|
||||||
|
}
|
||||||
|
val m2 = typo.javaClass.methods.firstOrNull { it.name == "getHighlightRange" && it.parameterCount == 0 }
|
||||||
|
val r2 = if (m2 != null) m2.invoke(typo) else null
|
||||||
|
when (r2) {
|
||||||
|
is TextRange -> return r2
|
||||||
|
is IntRange -> return TextRange(r2.first, r2.last + 1)
|
||||||
|
}
|
||||||
|
// Separate from/to ints
|
||||||
|
val fromM = typo.javaClass.methods.firstOrNull { it.name == "getFrom" && it.parameterCount == 0 && it.returnType == Int::class.javaPrimitiveType }
|
||||||
|
val toM = typo.javaClass.methods.firstOrNull { it.name == "getTo" && it.parameterCount == 0 && it.returnType == Int::class.javaPrimitiveType }
|
||||||
|
if (fromM != null && toM != null) {
|
||||||
|
val s = (fromM.invoke(typo) as? Int) ?: return null
|
||||||
|
val e = (toM.invoke(typo) as? Int) ?: return null
|
||||||
|
if (e > s) return TextRange(s, e)
|
||||||
|
}
|
||||||
|
null
|
||||||
|
} catch (_: Throwable) { null }
|
||||||
|
}
|
||||||
|
|
||||||
|
private fun extractMessageFromTypo(typo: Any): String? {
|
||||||
|
return try {
|
||||||
|
val m = typo.javaClass.methods.firstOrNull { it.name == "getMessage" && it.parameterCount == 0 }
|
||||||
|
(m?.invoke(typo) as? String)
|
||||||
|
} catch (_: Throwable) { null }
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
// Fallback that uses legacy SpellCheckerManager (if present) via reflection to validate words in fragments.
|
||||||
|
// Returns number of warnings painted.
|
||||||
|
private fun fallbackWithLegacySpellcheckerIfAvailable(
|
||||||
|
file: PsiFile,
|
||||||
|
fragments: List<Pair<TextContent, TextRange>>,
|
||||||
|
holder: AnnotationHolder
|
||||||
|
): Int {
|
||||||
|
return try {
|
||||||
|
val mgrCls = Class.forName("com.intellij.spellchecker.SpellCheckerManager")
|
||||||
|
val getInstance = mgrCls.methods.firstOrNull { it.name == "getInstance" && it.parameterCount == 1 }
|
||||||
|
val isCorrect = mgrCls.methods.firstOrNull { it.name == "isCorrect" && it.parameterCount == 1 && it.parameterTypes[0] == String::class.java }
|
||||||
|
if (getInstance == null || isCorrect == null) {
|
||||||
|
// No legacy spellchecker API available — fall back to naive painter
|
||||||
|
return naiveFallbackPaint(file, fragments, holder)
|
||||||
|
}
|
||||||
|
val mgr = getInstance.invoke(null, file.project)
|
||||||
|
if (mgr == null) {
|
||||||
|
// Legacy manager not present for this project — use naive fallback
|
||||||
|
return naiveFallbackPaint(file, fragments, holder)
|
||||||
|
}
|
||||||
|
var painted = 0
|
||||||
|
val docText = file.viewProvider.document?.text ?: return 0
|
||||||
|
val tokenRegex = Regex("[A-Za-z][A-Za-z0-9_']{2,}")
|
||||||
|
for ((content, hostRange) in fragments) {
|
||||||
|
val text = try { docText.substring(hostRange.startOffset, hostRange.endOffset) } catch (_: Throwable) { null } ?: continue
|
||||||
|
var seen = 0
|
||||||
|
var flagged = 0
|
||||||
|
for (m in tokenRegex.findAll(text)) {
|
||||||
|
val token = m.value
|
||||||
|
if ('%' in token) continue // skip printf fragments defensively
|
||||||
|
// Split snake_case and camelCase within the token
|
||||||
|
val parts = splitIdentifier(token)
|
||||||
|
for (part in parts) {
|
||||||
|
if (part.length <= 2) continue
|
||||||
|
if (isAllowedWord(part)) continue
|
||||||
|
// Quick allowlist for very common words to reduce noise if dictionaries differ
|
||||||
|
val ok = try { isCorrect.invoke(mgr, part) as? Boolean } catch (_: Throwable) { null }
|
||||||
|
if (ok == false) {
|
||||||
|
// Map part back to original token occurrence within this hostRange
|
||||||
|
val localStart = m.range.first + token.indexOf(part)
|
||||||
|
val localEnd = localStart + part.length
|
||||||
|
val abs = TextRange(hostRange.startOffset + localStart, hostRange.startOffset + localEnd)
|
||||||
|
paintTypoAnnotation(file, holder, abs, part)
|
||||||
|
painted++
|
||||||
|
flagged++
|
||||||
|
}
|
||||||
|
seen++
|
||||||
|
}
|
||||||
|
}
|
||||||
|
log.info("LyngGrazieAnnotator.fallback: fragment words=$seen, flagged=$flagged")
|
||||||
|
}
|
||||||
|
painted
|
||||||
|
} catch (_: Throwable) {
|
||||||
|
// If legacy manager is not available, fall back to a very naive heuristic (no external deps)
|
||||||
|
return naiveFallbackPaint(file, fragments, holder)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
private fun naiveFallbackPaint(
|
||||||
|
file: PsiFile,
|
||||||
|
fragments: List<Pair<TextContent, TextRange>>,
|
||||||
|
holder: AnnotationHolder
|
||||||
|
): Int {
|
||||||
|
var painted = 0
|
||||||
|
val docText = file.viewProvider.document?.text
|
||||||
|
val tokenRegex = Regex("[A-Za-z][A-Za-z0-9_']{2,}")
|
||||||
|
val baseWords = setOf(
|
||||||
|
// small, common vocabulary to catch near-miss typos in typical code/comments
|
||||||
|
"comment","comments","error","errors","found","file","not","word","words","count","value","name","class","function","string"
|
||||||
|
)
|
||||||
|
for ((content, hostRange) in fragments) {
|
||||||
|
val text: String? = docText?.let { dt ->
|
||||||
|
try { dt.substring(hostRange.startOffset, hostRange.endOffset) } catch (_: Throwable) { null }
|
||||||
|
}
|
||||||
|
if (text.isNullOrBlank()) continue
|
||||||
|
var seen = 0
|
||||||
|
var flagged = 0
|
||||||
|
for (m in tokenRegex.findAll(text)) {
|
||||||
|
val token = m.value
|
||||||
|
if ('%' in token) continue
|
||||||
|
val parts = splitIdentifier(token)
|
||||||
|
for (part in parts) {
|
||||||
|
seen++
|
||||||
|
val lower = part.lowercase()
|
||||||
|
if (lower.length <= 2 || isAllowedWord(part)) continue
|
||||||
|
// Heuristic: no vowels OR 3 repeated chars OR ends with unlikely double consonants
|
||||||
|
val noVowel = lower.none { it in "aeiouy" }
|
||||||
|
val triple = Regex("(.)\\1\\1").containsMatchIn(lower)
|
||||||
|
val dblCons = Regex("[bcdfghjklmnpqrstvwxyz]{2}$").containsMatchIn(lower)
|
||||||
|
var looksWrong = noVowel || triple || dblCons
|
||||||
|
// Additional: low vowel ratio for length>=4
|
||||||
|
if (!looksWrong && lower.length >= 4) {
|
||||||
|
val vowels = lower.count { it in "aeiouy" }
|
||||||
|
val ratio = if (lower.isNotEmpty()) vowels.toDouble() / lower.length else 1.0
|
||||||
|
if (ratio < 0.25) looksWrong = true
|
||||||
|
}
|
||||||
|
// Additional: near-miss to a small base vocabulary (edit distance 1, or 2 for words >=6)
|
||||||
|
if (!looksWrong) {
|
||||||
|
for (bw in baseWords) {
|
||||||
|
val d = editDistance(lower, bw)
|
||||||
|
if (d == 1 || (d == 2 && lower.length >= 6)) { looksWrong = true; break }
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if (looksWrong) {
|
||||||
|
val localStart = m.range.first + token.indexOf(part)
|
||||||
|
val localEnd = localStart + part.length
|
||||||
|
val abs = TextRange(hostRange.startOffset + localStart, hostRange.startOffset + localEnd)
|
||||||
|
paintTypoAnnotation(file, holder, abs, part)
|
||||||
|
painted++
|
||||||
|
flagged++
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
log.info("LyngGrazieAnnotator.fallback(naive): fragment words=$seen, flagged=$flagged")
|
||||||
|
}
|
||||||
|
return painted
|
||||||
|
}
|
||||||
|
|
||||||
|
private fun paintTypoAnnotation(file: PsiFile, holder: AnnotationHolder, range: TextRange, word: String) {
|
||||||
|
val settings = LyngFormatterSettings.getInstance(file.project)
|
||||||
|
val ab = holder.newAnnotation(HighlightSeverity.INFORMATION, "Possible typo")
|
||||||
|
.range(range)
|
||||||
|
applyTypoStyleIfRequested(file, ab)
|
||||||
|
if (settings.offerLyngTypoQuickFixes) {
|
||||||
|
// Offer lightweight fixes; for 243 provide Add-to-dictionary always
|
||||||
|
ab.withFix(net.sergeych.lyng.idea.grazie.AddToLyngDictionaryFix(word))
|
||||||
|
// Offer "Replace with…" candidates (top 7)
|
||||||
|
val cands = suggestReplacements(file, word).take(7)
|
||||||
|
for (c in cands) {
|
||||||
|
ab.withFix(net.sergeych.lyng.idea.grazie.ReplaceWordFix(range, word, c))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
ab.create()
|
||||||
|
}
|
||||||
|
|
||||||
|
private fun applyTypoStyleIfRequested(file: PsiFile, ab: com.intellij.lang.annotation.AnnotationBuilder) {
|
||||||
|
val settings = LyngFormatterSettings.getInstance(file.project)
|
||||||
|
if (!settings.showTyposWithGreenUnderline) return
|
||||||
|
// Use the standard TYPO text attributes key used by the platform
|
||||||
|
val TYPO: TextAttributesKey = TextAttributesKey.createTextAttributesKey("TYPO")
|
||||||
|
try {
|
||||||
|
ab.textAttributes(TYPO)
|
||||||
|
} catch (_: Throwable) {
|
||||||
|
// some IDEs may not allow setting attributes on INFORMATION; ignore gracefully
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
private fun suggestReplacements(file: PsiFile, word: String): List<String> {
|
||||||
|
val lower = word.lowercase()
|
||||||
|
val fromProject = collectProjectWords(file)
|
||||||
|
val fromTech = TechDictionary.allWords()
|
||||||
|
val fromEnglish = EnglishDictionary.allWords()
|
||||||
|
// Merge with priority: project (p=0), tech (p=1), english (p=2)
|
||||||
|
val all = LinkedHashSet<String>()
|
||||||
|
all.addAll(fromProject)
|
||||||
|
all.addAll(fromTech)
|
||||||
|
all.addAll(fromEnglish)
|
||||||
|
data class Cand(val w: String, val d: Int, val p: Int)
|
||||||
|
val cands = ArrayList<Cand>(32)
|
||||||
|
for (w in all) {
|
||||||
|
if (w == lower) continue
|
||||||
|
if (kotlin.math.abs(w.length - lower.length) > 2) continue
|
||||||
|
val d = editDistance(lower, w)
|
||||||
|
val p = when {
|
||||||
|
w in fromProject -> 0
|
||||||
|
w in fromTech -> 1
|
||||||
|
else -> 2
|
||||||
|
}
|
||||||
|
cands += Cand(w, d, p)
|
||||||
|
}
|
||||||
|
cands.sortWith(compareBy<Cand> { it.d }.thenBy { it.p }.thenBy { it.w })
|
||||||
|
// Return a larger pool so callers can choose desired display count
|
||||||
|
return cands.take(16).map { it.w }
|
||||||
|
}
|
||||||
|
|
||||||
|
private fun collectProjectWords(file: PsiFile): Set<String> {
|
||||||
|
// Simple approach: use current file text; can be extended to project scanning later
|
||||||
|
val text = file.viewProvider.document?.text ?: return emptySet()
|
||||||
|
val out = LinkedHashSet<String>()
|
||||||
|
val tokenRegex = Regex("[A-Za-z][A-Za-z0-9_']{2,}")
|
||||||
|
for (m in tokenRegex.findAll(text)) {
|
||||||
|
val parts = splitIdentifier(m.value)
|
||||||
|
parts.forEach { out += it.lowercase() }
|
||||||
|
}
|
||||||
|
// Include learned words
|
||||||
|
val settings = LyngFormatterSettings.getInstance(file.project)
|
||||||
|
out.addAll(settings.learnedWords.map { it.lowercase() })
|
||||||
|
return out
|
||||||
|
}
|
||||||
|
|
||||||
|
private fun splitIdentifier(token: String): List<String> {
|
||||||
|
// Split on underscores and camelCase boundaries
|
||||||
|
val unders = token.split('_').filter { it.isNotBlank() }
|
||||||
|
val out = mutableListOf<String>()
|
||||||
|
val camelBoundary = Regex("(?<=[a-z])(?=[A-Z])")
|
||||||
|
for (u in unders) out += u.split(camelBoundary).filter { it.isNotBlank() }
|
||||||
|
return out
|
||||||
|
}
|
||||||
|
|
||||||
|
private fun isAllowedWord(w: String): Boolean {
|
||||||
|
val s = w.lowercase()
|
||||||
|
return s in setOf(
|
||||||
|
// common code words / language keywords to avoid noise
|
||||||
|
"val","var","fun","class","interface","enum","type","import","package","return","if","else","when","while","for","try","catch","finally","true","false","null",
|
||||||
|
"abstract","closed","override",
|
||||||
|
// very common English words
|
||||||
|
"the","and","or","not","with","from","into","this","that","file","found","count","name","value","object"
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
private fun editDistance(a: String, b: String): Int {
|
||||||
|
if (a == b) return 0
|
||||||
|
if (a.isEmpty()) return b.length
|
||||||
|
if (b.isEmpty()) return a.length
|
||||||
|
val dp = IntArray(b.length + 1) { it }
|
||||||
|
for (i in 1..a.length) {
|
||||||
|
var prev = dp[0]
|
||||||
|
dp[0] = i
|
||||||
|
for (j in 1..b.length) {
|
||||||
|
val temp = dp[j]
|
||||||
|
dp[j] = minOf(
|
||||||
|
dp[j] + 1, // deletion
|
||||||
|
dp[j - 1] + 1, // insertion
|
||||||
|
prev + if (a[i - 1] == b[j - 1]) 0 else 1 // substitution
|
||||||
|
)
|
||||||
|
prev = temp
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return dp[b.length]
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,139 @@
|
|||||||
|
/*
|
||||||
|
* Copyright 2025 Sergey S. Chernov real.sergeych@gmail.com
|
||||||
|
*
|
||||||
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
* you may not use this file except in compliance with the License.
|
||||||
|
* You may obtain a copy of the License at
|
||||||
|
*
|
||||||
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
*
|
||||||
|
* Unless required by applicable law or agreed to in writing, software
|
||||||
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
* See the License for the specific language governing permissions and
|
||||||
|
* limitations under the License.
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
package net.sergeych.lyng.idea.grazie
|
||||||
|
|
||||||
|
import com.intellij.grazie.grammar.strategy.GrammarCheckingStrategy
|
||||||
|
import com.intellij.grazie.grammar.strategy.GrammarCheckingStrategy.TextDomain
|
||||||
|
import com.intellij.ide.plugins.PluginManagerCore
|
||||||
|
import com.intellij.openapi.diagnostic.Logger
|
||||||
|
import com.intellij.openapi.extensions.PluginId
|
||||||
|
import com.intellij.openapi.util.TextRange
|
||||||
|
import com.intellij.psi.PsiElement
|
||||||
|
import net.sergeych.lyng.idea.highlight.LyngTokenTypes
|
||||||
|
import net.sergeych.lyng.idea.settings.LyngFormatterSettings
|
||||||
|
import net.sergeych.lyng.idea.spell.LyngSpellIndex
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Grazie/Natural Languages strategy for Lyng.
|
||||||
|
*
|
||||||
|
* - Comments: checked as natural language (TextDomain.COMMENTS)
|
||||||
|
* - String literals: optionally checked (setting), skipping printf-like specifiers via stealth ranges (TextDomain.LITERALS)
|
||||||
|
* - Identifiers (non-keywords): checked under TextDomain.CODE so "Process code" controls apply
|
||||||
|
* - Keywords: skipped
|
||||||
|
*/
|
||||||
|
class LyngGrazieStrategy : GrammarCheckingStrategy {
|
||||||
|
|
||||||
|
private val log = Logger.getInstance(LyngGrazieStrategy::class.java)
|
||||||
|
@Volatile private var loggedOnce = false
|
||||||
|
@Volatile private var loggedFirstMatch = false
|
||||||
|
private val seenTypes: MutableSet<String> = java.util.Collections.synchronizedSet(mutableSetOf())
|
||||||
|
|
||||||
|
private fun legacySpellcheckerInstalled(): Boolean =
|
||||||
|
PluginManagerCore.isPluginInstalled(PluginId.getId("com.intellij.spellchecker"))
|
||||||
|
|
||||||
|
// Regex for printf-style specifiers: %[flags][width][.precision][length]type
|
||||||
|
private val spec = Regex("%(?:[-+ #0]*(?:\\d+)?(?:\\.\\d+)?[a-zA-Z%])")
|
||||||
|
|
||||||
|
override fun isMyContextRoot(element: PsiElement): Boolean {
|
||||||
|
val type = element.node?.elementType
|
||||||
|
val settings = LyngFormatterSettings.getInstance(element.project)
|
||||||
|
val legacyPresent = legacySpellcheckerInstalled()
|
||||||
|
if (type != null && seenTypes.size < 10) {
|
||||||
|
val name = type.toString()
|
||||||
|
if (seenTypes.add(name)) {
|
||||||
|
log.info("LyngGrazieStrategy: saw PSI type=$name")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if (!loggedOnce) {
|
||||||
|
loggedOnce = true
|
||||||
|
log.info("LyngGrazieStrategy activated: legacyPresent=$legacyPresent, preferGrazieForCommentsAndLiterals=${settings.preferGrazieForCommentsAndLiterals}, spellCheckStringLiterals=${settings.spellCheckStringLiterals}, grazieChecksIdentifiers=${settings.grazieChecksIdentifiers}")
|
||||||
|
}
|
||||||
|
|
||||||
|
val file = element.containingFile ?: return false
|
||||||
|
val index = LyngSpellIndex.getUpToDate(file) ?: return false // Suspend until ready
|
||||||
|
// To ensure Grazie asks TextExtractor for all leafs, accept any Lyng element once index is ready.
|
||||||
|
// The extractor will decide per-range/domain what to actually provide.
|
||||||
|
if (!loggedFirstMatch) {
|
||||||
|
loggedFirstMatch = true
|
||||||
|
log.info("LyngGrazieStrategy: enabling Grazie on all Lyng elements (index ready)")
|
||||||
|
}
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
|
||||||
|
override fun getContextRootTextDomain(root: PsiElement): TextDomain {
|
||||||
|
val type = root.node?.elementType
|
||||||
|
val settings = LyngFormatterSettings.getInstance(root.project)
|
||||||
|
val file = root.containingFile
|
||||||
|
val index = if (file != null) LyngSpellIndex.getUpToDate(file) else null
|
||||||
|
val r = root.textRange
|
||||||
|
|
||||||
|
fun overlaps(list: List<TextRange>): Boolean = r != null && list.any { it.intersects(r) }
|
||||||
|
|
||||||
|
return when (type) {
|
||||||
|
LyngTokenTypes.LINE_COMMENT, LyngTokenTypes.BLOCK_COMMENT -> TextDomain.COMMENTS
|
||||||
|
LyngTokenTypes.STRING -> if (settings.grazieTreatLiteralsAsComments) TextDomain.COMMENTS else TextDomain.LITERALS
|
||||||
|
LyngTokenTypes.IDENTIFIER -> {
|
||||||
|
// For Grazie-only reliability in 243, route identifiers via COMMENTS when configured
|
||||||
|
if (settings.grazieTreatIdentifiersAsComments && index != null && r != null && overlaps(index.identifiers))
|
||||||
|
TextDomain.COMMENTS
|
||||||
|
else TextDomain.PLAIN_TEXT
|
||||||
|
}
|
||||||
|
else -> TextDomain.PLAIN_TEXT
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Note: do not override getLanguageSupport to keep compatibility with 243 API
|
||||||
|
|
||||||
|
override fun getStealthyRanges(root: PsiElement, text: CharSequence): java.util.LinkedHashSet<IntRange> {
|
||||||
|
val result = LinkedHashSet<IntRange>()
|
||||||
|
val type = root.node?.elementType
|
||||||
|
if (type == LyngTokenTypes.STRING) {
|
||||||
|
if (!shouldCheckLiterals(root)) {
|
||||||
|
// Hide the entire string when literals checking is disabled by settings
|
||||||
|
result += (0 until text.length)
|
||||||
|
return result
|
||||||
|
}
|
||||||
|
// Hide printf-like specifiers in strings
|
||||||
|
val (start, end) = stripQuotesBounds(text)
|
||||||
|
if (end > start) {
|
||||||
|
val content = text.subSequence(start, end)
|
||||||
|
for (m in spec.findAll(content)) {
|
||||||
|
val ms = start + m.range.first
|
||||||
|
val me = start + m.range.last
|
||||||
|
result += (ms..me)
|
||||||
|
}
|
||||||
|
if (result.isNotEmpty()) {
|
||||||
|
log.debug("LyngGrazieStrategy: hidden ${result.size} printf specifier ranges in string literal")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return result
|
||||||
|
}
|
||||||
|
|
||||||
|
override fun isEnabledByDefault(): Boolean = true
|
||||||
|
|
||||||
|
private fun shouldCheckLiterals(root: PsiElement): Boolean =
|
||||||
|
LyngFormatterSettings.getInstance(root.project).spellCheckStringLiterals
|
||||||
|
|
||||||
|
private fun stripQuotesBounds(text: CharSequence): Pair<Int, Int> {
|
||||||
|
if (text.length < 2) return 0 to text.length
|
||||||
|
val first = text.first()
|
||||||
|
val last = text.last()
|
||||||
|
return if ((first == '"' && last == '"') || (first == '\'' && last == '\''))
|
||||||
|
1 to (text.length - 1) else (0 to text.length)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,104 @@
|
|||||||
|
/*
|
||||||
|
* Copyright 2025 Sergey S. Chernov real.sergeych@gmail.com
|
||||||
|
*
|
||||||
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
* you may not use this file except in compliance with the License.
|
||||||
|
* You may obtain a copy of the License at
|
||||||
|
*
|
||||||
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
*
|
||||||
|
* Unless required by applicable law or agreed to in writing, software
|
||||||
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
* See the License for the specific language governing permissions and
|
||||||
|
* limitations under the License.
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
package net.sergeych.lyng.idea.grazie
|
||||||
|
|
||||||
|
import com.intellij.grazie.text.TextContent
|
||||||
|
import com.intellij.grazie.text.TextContent.TextDomain
|
||||||
|
import com.intellij.grazie.text.TextExtractor
|
||||||
|
import com.intellij.openapi.diagnostic.Logger
|
||||||
|
import com.intellij.psi.PsiElement
|
||||||
|
import net.sergeych.lyng.idea.highlight.LyngTokenTypes
|
||||||
|
import net.sergeych.lyng.idea.settings.LyngFormatterSettings
|
||||||
|
import net.sergeych.lyng.idea.spell.LyngSpellIndex
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Provides Grazie with extractable text for Lyng PSI elements.
|
||||||
|
* We return text for identifiers, comments, and (optionally) string literals.
|
||||||
|
* printf-like specifiers are filtered by the Grammar strategy via stealth ranges.
|
||||||
|
*/
|
||||||
|
class LyngTextExtractor : TextExtractor() {
|
||||||
|
private val log = Logger.getInstance(LyngTextExtractor::class.java)
|
||||||
|
@Volatile private var loggedOnce = false
|
||||||
|
private val seen: MutableSet<String> = java.util.Collections.synchronizedSet(mutableSetOf())
|
||||||
|
|
||||||
|
override fun buildTextContent(element: PsiElement, allowedDomains: Set<TextDomain>): TextContent? {
|
||||||
|
val type = element.node?.elementType ?: return null
|
||||||
|
if (!loggedOnce) {
|
||||||
|
loggedOnce = true
|
||||||
|
log.info("LyngTextExtractor active; allowedDomains=${allowedDomains.joinToString()}")
|
||||||
|
}
|
||||||
|
val settings = LyngFormatterSettings.getInstance(element.project)
|
||||||
|
val file = element.containingFile
|
||||||
|
val index = if (file != null) LyngSpellIndex.getUpToDate(file) else null
|
||||||
|
val r = element.textRange
|
||||||
|
|
||||||
|
fun overlaps(list: List<com.intellij.openapi.util.TextRange>): Boolean = r != null && list.any { it.intersects(r) }
|
||||||
|
|
||||||
|
// Decide target domain by intersection with our MiniAst-driven index; prefer comments > strings > identifiers
|
||||||
|
var domain: TextDomain? = null
|
||||||
|
if (index != null && r != null) {
|
||||||
|
if (overlaps(index.comments)) domain = TextDomain.COMMENTS
|
||||||
|
else if (overlaps(index.strings) && settings.spellCheckStringLiterals) domain = TextDomain.LITERALS
|
||||||
|
else if (overlaps(index.identifiers)) domain = if (settings.grazieTreatIdentifiersAsComments) TextDomain.COMMENTS else TextDomain.DOCUMENTATION
|
||||||
|
} else {
|
||||||
|
// Fallback to token type if index is not ready (rare timing), mostly for comments
|
||||||
|
domain = when (type) {
|
||||||
|
LyngTokenTypes.LINE_COMMENT, LyngTokenTypes.BLOCK_COMMENT -> TextDomain.COMMENTS
|
||||||
|
else -> null
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if (domain == null) return null
|
||||||
|
|
||||||
|
// If literals aren't requested but fallback is enabled, route strings as COMMENTS
|
||||||
|
if (domain == TextDomain.LITERALS && !allowedDomains.contains(TextDomain.LITERALS) && settings.grazieTreatLiteralsAsComments) {
|
||||||
|
domain = TextDomain.COMMENTS
|
||||||
|
}
|
||||||
|
if (!allowedDomains.contains(domain)) {
|
||||||
|
if (seen.add("deny-${domain.name}")) {
|
||||||
|
log.info("LyngTextExtractor: domain ${domain.name} not in allowedDomains; skipping")
|
||||||
|
}
|
||||||
|
return null
|
||||||
|
}
|
||||||
|
return try {
|
||||||
|
// Try common factory names across versions
|
||||||
|
val methods = TextContent::class.java.methods.filter { it.name == "psiFragment" }
|
||||||
|
val built: TextContent? = when {
|
||||||
|
// Try psiFragment(PsiElement, TextDomain)
|
||||||
|
methods.any { it.parameterCount == 2 && it.parameterTypes[0].name.contains("PsiElement") } -> {
|
||||||
|
val m = methods.first { it.parameterCount == 2 && it.parameterTypes[0].name.contains("PsiElement") }
|
||||||
|
@Suppress("UNCHECKED_CAST")
|
||||||
|
(m.invoke(null, element, domain) as? TextContent)?.also {
|
||||||
|
if (seen.add("ok-${domain.name}")) log.info("LyngTextExtractor: provided ${domain.name} for ${type} via psiFragment(element, domain)")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
// Try psiFragment(TextDomain, PsiElement)
|
||||||
|
methods.any { it.parameterCount == 2 && it.parameterTypes[0].name.endsWith("TextDomain") } -> {
|
||||||
|
val m = methods.first { it.parameterCount == 2 && it.parameterTypes[0].name.endsWith("TextDomain") }
|
||||||
|
@Suppress("UNCHECKED_CAST")
|
||||||
|
(m.invoke(null, domain, element) as? TextContent)?.also {
|
||||||
|
if (seen.add("ok-${domain.name}")) log.info("LyngTextExtractor: provided ${domain.name} for ${type} via psiFragment(domain, element)")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
else -> null
|
||||||
|
}
|
||||||
|
built
|
||||||
|
} catch (e: Throwable) {
|
||||||
|
log.info("LyngTextExtractor: failed to build TextContent: ${e.javaClass.simpleName}: ${e.message}")
|
||||||
|
null
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,86 @@
|
|||||||
|
/*
|
||||||
|
* Copyright 2025 Sergey S. Chernov real.sergeych@gmail.com
|
||||||
|
*
|
||||||
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
* you may not use this file except in compliance with the License.
|
||||||
|
* You may obtain a copy of the License at
|
||||||
|
*
|
||||||
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
*
|
||||||
|
* Unless required by applicable law or agreed to in writing, software
|
||||||
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
* See the License for the specific language governing permissions and
|
||||||
|
* limitations under the License.
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
package net.sergeych.lyng.idea.grazie
|
||||||
|
|
||||||
|
import com.intellij.codeInsight.daemon.DaemonCodeAnalyzer
|
||||||
|
import com.intellij.codeInsight.intention.IntentionAction
|
||||||
|
import com.intellij.openapi.command.WriteCommandAction
|
||||||
|
import com.intellij.openapi.editor.CaretModel
|
||||||
|
import com.intellij.openapi.editor.Document
|
||||||
|
import com.intellij.openapi.editor.Editor
|
||||||
|
import com.intellij.openapi.project.Project
|
||||||
|
import com.intellij.openapi.util.TextRange
|
||||||
|
import com.intellij.psi.PsiFile
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Lightweight quick-fix to replace a misspelled word (subrange) with a suggested alternative.
|
||||||
|
* Works without the legacy Spell Checker. The replacement is applied directly to the file text.
|
||||||
|
*/
|
||||||
|
class ReplaceWordFix(
|
||||||
|
private val range: TextRange,
|
||||||
|
private val original: String,
|
||||||
|
private val replacementRaw: String
|
||||||
|
) : IntentionAction {
|
||||||
|
|
||||||
|
override fun getText(): String = "Replace '$original' with '$replacementRaw'"
|
||||||
|
override fun getFamilyName(): String = "Lyng Spelling"
|
||||||
|
override fun isAvailable(project: Project, editor: Editor?, file: PsiFile?): Boolean =
|
||||||
|
editor != null && file != null && range.startOffset in 0..range.endOffset
|
||||||
|
|
||||||
|
override fun startInWriteAction(): Boolean = true
|
||||||
|
|
||||||
|
override fun invoke(project: Project, editor: Editor?, file: PsiFile?) {
|
||||||
|
if (editor == null) return
|
||||||
|
val doc: Document = editor.document
|
||||||
|
val safeRange = range.constrainTo(doc)
|
||||||
|
val current = doc.getText(safeRange)
|
||||||
|
// Preserve basic case style based on the original token
|
||||||
|
val replacement = adaptCaseStyle(current, replacementRaw)
|
||||||
|
WriteCommandAction.runWriteCommandAction(project, "Replace word", null, Runnable {
|
||||||
|
doc.replaceString(safeRange.startOffset, safeRange.endOffset, replacement)
|
||||||
|
}, file)
|
||||||
|
// Move caret to end of replacement for convenience
|
||||||
|
try {
|
||||||
|
val caret: CaretModel = editor.caretModel
|
||||||
|
caret.moveToOffset(safeRange.startOffset + replacement.length)
|
||||||
|
} catch (_: Throwable) {}
|
||||||
|
// Restart daemon to refresh highlights
|
||||||
|
if (file != null) DaemonCodeAnalyzer.getInstance(project).restart(file)
|
||||||
|
}
|
||||||
|
|
||||||
|
private fun TextRange.constrainTo(doc: Document): TextRange {
|
||||||
|
val start = startOffset.coerceIn(0, doc.textLength)
|
||||||
|
val end = endOffset.coerceIn(start, doc.textLength)
|
||||||
|
return TextRange(start, end)
|
||||||
|
}
|
||||||
|
|
||||||
|
private fun adaptCaseStyle(sample: String, suggestion: String): String {
|
||||||
|
if (suggestion.isEmpty()) return suggestion
|
||||||
|
return when {
|
||||||
|
sample.all { it.isUpperCase() } -> suggestion.uppercase()
|
||||||
|
// PascalCase / Capitalized single word
|
||||||
|
sample.firstOrNull()?.isUpperCase() == true && sample.drop(1).any { it.isLowerCase() } ->
|
||||||
|
suggestion.replaceFirstChar { if (it.isLowerCase()) it.titlecase() else it.toString() }
|
||||||
|
// snake_case -> lower
|
||||||
|
sample.contains('_') -> suggestion.lowercase()
|
||||||
|
// camelCase -> lower first
|
||||||
|
sample.firstOrNull()?.isLowerCase() == true && sample.any { it.isUpperCase() } ->
|
||||||
|
suggestion.replaceFirstChar { it.lowercase() }
|
||||||
|
else -> suggestion
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,77 @@
|
|||||||
|
/*
|
||||||
|
* Copyright 2025 Sergey S. Chernov real.sergeych@gmail.com
|
||||||
|
*
|
||||||
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
* you may not use this file except in compliance with the License.
|
||||||
|
* You may obtain a copy of the License at
|
||||||
|
*
|
||||||
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
*
|
||||||
|
* Unless required by applicable law or agreed to in writing, software
|
||||||
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
* See the License for the specific language governing permissions and
|
||||||
|
* limitations under the License.
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
package net.sergeych.lyng.idea.grazie
|
||||||
|
|
||||||
|
import com.intellij.openapi.diagnostic.Logger
|
||||||
|
import java.io.BufferedReader
|
||||||
|
import java.io.InputStreamReader
|
||||||
|
import java.util.zip.GZIPInputStream
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Lightweight technical/Lyng vocabulary dictionary.
|
||||||
|
* Loaded from classpath resources; supports .txt and .txt.gz. Merged with EnglishDictionary.
|
||||||
|
*/
|
||||||
|
object TechDictionary {
|
||||||
|
private val log = Logger.getInstance(TechDictionary::class.java)
|
||||||
|
@Volatile private var loaded = false
|
||||||
|
@Volatile private var words: Set<String> = emptySet()
|
||||||
|
|
||||||
|
private fun ensureLoaded() {
|
||||||
|
if (loaded) return
|
||||||
|
synchronized(this) {
|
||||||
|
if (loaded) return
|
||||||
|
val candidates = listOf(
|
||||||
|
"/dictionaries/tech-lyng.txt.gz",
|
||||||
|
"/dictionaries/tech-lyng.txt"
|
||||||
|
)
|
||||||
|
val merged = HashSet<String>(8_000)
|
||||||
|
for (res in candidates) {
|
||||||
|
try {
|
||||||
|
val stream = javaClass.getResourceAsStream(res) ?: continue
|
||||||
|
val reader = if (res.endsWith(".gz"))
|
||||||
|
BufferedReader(InputStreamReader(GZIPInputStream(stream)))
|
||||||
|
else
|
||||||
|
BufferedReader(InputStreamReader(stream))
|
||||||
|
var n = 0
|
||||||
|
reader.useLines { seq -> seq.forEach { line ->
|
||||||
|
val w = line.trim()
|
||||||
|
if (w.isNotEmpty() && !w.startsWith("#")) { merged += w.lowercase(); n++ }
|
||||||
|
} }
|
||||||
|
log.info("TechDictionary: loaded $n words from $res (total=${merged.size})")
|
||||||
|
} catch (t: Throwable) {
|
||||||
|
log.info("TechDictionary: failed to load $res: ${t.javaClass.simpleName}: ${t.message}")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if (merged.isEmpty()) {
|
||||||
|
merged += setOf(
|
||||||
|
// minimal Lyng/tech seeding to avoid empty dictionary
|
||||||
|
"lyng","miniast","binder","printf","specifier","specifiers","regex","token","tokens",
|
||||||
|
"identifier","identifiers","keyword","keywords","comment","comments","string","strings",
|
||||||
|
"literal","literals","formatting","formatter","grazie","typo","typos","dictionary","dictionaries"
|
||||||
|
)
|
||||||
|
log.info("TechDictionary: using minimal built-in set (${merged.size})")
|
||||||
|
}
|
||||||
|
words = merged
|
||||||
|
loaded = true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
fun allWords(): Set<String> {
|
||||||
|
ensureLoaded()
|
||||||
|
return words
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,72 @@
|
|||||||
|
/*
|
||||||
|
* Copyright 2025 Sergey S. Chernov real.sergeych@gmail.com
|
||||||
|
*
|
||||||
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
* you may not use this file except in compliance with the License.
|
||||||
|
* You may obtain a copy of the License at
|
||||||
|
*
|
||||||
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
*
|
||||||
|
* Unless required by applicable law or agreed to in writing, software
|
||||||
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
* See the License for the specific language governing permissions and
|
||||||
|
* limitations under the License.
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
|
package net.sergeych.lyng.idea.highlight
|
||||||
|
|
||||||
|
import com.intellij.openapi.editor.colors.TextAttributesKey
|
||||||
|
import com.intellij.openapi.fileTypes.SyntaxHighlighter
|
||||||
|
import com.intellij.openapi.options.colors.AttributesDescriptor
|
||||||
|
import com.intellij.openapi.options.colors.ColorDescriptor
|
||||||
|
import com.intellij.openapi.options.colors.ColorSettingsPage
|
||||||
|
import javax.swing.Icon
|
||||||
|
|
||||||
|
class LyngColorSettingsPage : ColorSettingsPage {
|
||||||
|
override fun getDisplayName(): String = "Lyng"
|
||||||
|
|
||||||
|
override fun getIcon(): Icon? = null
|
||||||
|
|
||||||
|
override fun getHighlighter(): SyntaxHighlighter = LyngSyntaxHighlighter()
|
||||||
|
|
||||||
|
override fun getDemoText(): String = """
|
||||||
|
// Lyng demo
|
||||||
|
import lyng.stdlib as std
|
||||||
|
|
||||||
|
class Sample {
|
||||||
|
fun greet(name: String): String {
|
||||||
|
val message = "Hello, " + name
|
||||||
|
return message
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
var counter = 0
|
||||||
|
counter = counter + 1
|
||||||
|
""".trimIndent()
|
||||||
|
|
||||||
|
override fun getAdditionalHighlightingTagToDescriptorMap(): MutableMap<String, TextAttributesKey>? = null
|
||||||
|
|
||||||
|
override fun getAttributeDescriptors(): Array<AttributesDescriptor> = arrayOf(
|
||||||
|
AttributesDescriptor("Keyword", LyngHighlighterColors.KEYWORD),
|
||||||
|
AttributesDescriptor("String", LyngHighlighterColors.STRING),
|
||||||
|
AttributesDescriptor("Number", LyngHighlighterColors.NUMBER),
|
||||||
|
AttributesDescriptor("Line comment", LyngHighlighterColors.LINE_COMMENT),
|
||||||
|
AttributesDescriptor("Block comment", LyngHighlighterColors.BLOCK_COMMENT),
|
||||||
|
AttributesDescriptor("Identifier", LyngHighlighterColors.IDENTIFIER),
|
||||||
|
AttributesDescriptor("Punctuation", LyngHighlighterColors.PUNCT),
|
||||||
|
// Semantic
|
||||||
|
AttributesDescriptor("Annotation (semantic)", LyngHighlighterColors.ANNOTATION),
|
||||||
|
AttributesDescriptor("Variable (semantic)", LyngHighlighterColors.VARIABLE),
|
||||||
|
AttributesDescriptor("Value (semantic)", LyngHighlighterColors.VALUE),
|
||||||
|
AttributesDescriptor("Function (semantic)", LyngHighlighterColors.FUNCTION),
|
||||||
|
AttributesDescriptor("Function declaration (semantic)", LyngHighlighterColors.FUNCTION_DECLARATION),
|
||||||
|
AttributesDescriptor("Type (semantic)", LyngHighlighterColors.TYPE),
|
||||||
|
AttributesDescriptor("Namespace (semantic)", LyngHighlighterColors.NAMESPACE),
|
||||||
|
AttributesDescriptor("Parameter (semantic)", LyngHighlighterColors.PARAMETER),
|
||||||
|
AttributesDescriptor("Enum constant (semantic)", LyngHighlighterColors.ENUM_CONSTANT),
|
||||||
|
)
|
||||||
|
|
||||||
|
override fun getColorDescriptors(): Array<ColorDescriptor> = ColorDescriptor.EMPTY_ARRAY
|
||||||
|
}
|
||||||
@@ -0,0 +1,85 @@
|
|||||||
|
/*
|
||||||
|
* Copyright 2025 Sergey S. Chernov real.sergeych@gmail.com
|
||||||
|
*
|
||||||
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
* you may not use this file except in compliance with the License.
|
||||||
|
* You may obtain a copy of the License at
|
||||||
|
*
|
||||||
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
*
|
||||||
|
* Unless required by applicable law or agreed to in writing, software
|
||||||
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
* See the License for the specific language governing permissions and
|
||||||
|
* limitations under the License.
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
|
/*
|
||||||
|
* Text attribute keys for Lyng token and semantic highlighting
|
||||||
|
*/
|
||||||
|
package net.sergeych.lyng.idea.highlight
|
||||||
|
|
||||||
|
import com.intellij.openapi.editor.DefaultLanguageHighlighterColors
|
||||||
|
import com.intellij.openapi.editor.colors.TextAttributesKey
|
||||||
|
|
||||||
|
object LyngHighlighterColors {
|
||||||
|
val KEYWORD: TextAttributesKey = TextAttributesKey.createTextAttributesKey(
|
||||||
|
"LYNG_KEYWORD", DefaultLanguageHighlighterColors.KEYWORD
|
||||||
|
)
|
||||||
|
val STRING: TextAttributesKey = TextAttributesKey.createTextAttributesKey(
|
||||||
|
"LYNG_STRING", DefaultLanguageHighlighterColors.STRING
|
||||||
|
)
|
||||||
|
val NUMBER: TextAttributesKey = TextAttributesKey.createTextAttributesKey(
|
||||||
|
"LYNG_NUMBER", DefaultLanguageHighlighterColors.NUMBER
|
||||||
|
)
|
||||||
|
val LINE_COMMENT: TextAttributesKey = TextAttributesKey.createTextAttributesKey(
|
||||||
|
"LYNG_LINE_COMMENT", DefaultLanguageHighlighterColors.LINE_COMMENT
|
||||||
|
)
|
||||||
|
val BLOCK_COMMENT: TextAttributesKey = TextAttributesKey.createTextAttributesKey(
|
||||||
|
"LYNG_BLOCK_COMMENT", DefaultLanguageHighlighterColors.BLOCK_COMMENT
|
||||||
|
)
|
||||||
|
val IDENTIFIER: TextAttributesKey = TextAttributesKey.createTextAttributesKey(
|
||||||
|
"LYNG_IDENTIFIER", DefaultLanguageHighlighterColors.IDENTIFIER
|
||||||
|
)
|
||||||
|
val PUNCT: TextAttributesKey = TextAttributesKey.createTextAttributesKey(
|
||||||
|
"LYNG_PUNCT", DefaultLanguageHighlighterColors.DOT
|
||||||
|
)
|
||||||
|
|
||||||
|
// Semantic layer keys
|
||||||
|
val VARIABLE: TextAttributesKey = TextAttributesKey.createTextAttributesKey(
|
||||||
|
// Use a distinctive default to ensure visibility across common themes.
|
||||||
|
// Users can still customize it separately from VALUE.
|
||||||
|
"LYNG_VARIABLE", DefaultLanguageHighlighterColors.INSTANCE_FIELD
|
||||||
|
)
|
||||||
|
val VALUE: TextAttributesKey = TextAttributesKey.createTextAttributesKey(
|
||||||
|
"LYNG_VALUE", DefaultLanguageHighlighterColors.INSTANCE_FIELD
|
||||||
|
)
|
||||||
|
val FUNCTION: TextAttributesKey = TextAttributesKey.createTextAttributesKey(
|
||||||
|
// Primary approach: make function calls as visible as declarations by default
|
||||||
|
// (users can still customize separately in the color scheme UI).
|
||||||
|
"LYNG_FUNCTION", DefaultLanguageHighlighterColors.FUNCTION_DECLARATION
|
||||||
|
)
|
||||||
|
val FUNCTION_DECLARATION: TextAttributesKey = TextAttributesKey.createTextAttributesKey(
|
||||||
|
"LYNG_FUNCTION_DECLARATION", DefaultLanguageHighlighterColors.FUNCTION_DECLARATION
|
||||||
|
)
|
||||||
|
val TYPE: TextAttributesKey = TextAttributesKey.createTextAttributesKey(
|
||||||
|
"LYNG_TYPE", DefaultLanguageHighlighterColors.CLASS_REFERENCE
|
||||||
|
)
|
||||||
|
val NAMESPACE: TextAttributesKey = TextAttributesKey.createTextAttributesKey(
|
||||||
|
"LYNG_NAMESPACE", DefaultLanguageHighlighterColors.PREDEFINED_SYMBOL
|
||||||
|
)
|
||||||
|
val PARAMETER: TextAttributesKey = TextAttributesKey.createTextAttributesKey(
|
||||||
|
"LYNG_PARAMETER", DefaultLanguageHighlighterColors.PARAMETER
|
||||||
|
)
|
||||||
|
|
||||||
|
// Annotations (@Something) — use Kotlin/Java metadata default color
|
||||||
|
val ANNOTATION: TextAttributesKey = TextAttributesKey.createTextAttributesKey(
|
||||||
|
"LYNG_ANNOTATION", DefaultLanguageHighlighterColors.METADATA
|
||||||
|
)
|
||||||
|
|
||||||
|
// Enum constant (declaration or usage)
|
||||||
|
val ENUM_CONSTANT: TextAttributesKey = TextAttributesKey.createTextAttributesKey(
|
||||||
|
"LYNG_ENUM_CONSTANT", DefaultLanguageHighlighterColors.STATIC_FIELD
|
||||||
|
)
|
||||||
|
}
|
||||||
@@ -0,0 +1,164 @@
|
|||||||
|
/*
|
||||||
|
* Copyright 2025 Sergey S. Chernov real.sergeych@gmail.com
|
||||||
|
*
|
||||||
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
* you may not use this file except in compliance with the License.
|
||||||
|
* You may obtain a copy of the License at
|
||||||
|
*
|
||||||
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
*
|
||||||
|
* Unless required by applicable law or agreed to in writing, software
|
||||||
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
* See the License for the specific language governing permissions and
|
||||||
|
* limitations under the License.
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
|
/*
|
||||||
|
* Minimal hand-written lexer for Lyng token highlighting
|
||||||
|
*/
|
||||||
|
package net.sergeych.lyng.idea.highlight
|
||||||
|
|
||||||
|
import com.intellij.lexer.LexerBase
|
||||||
|
import com.intellij.psi.tree.IElementType
|
||||||
|
|
||||||
|
class LyngLexer : LexerBase() {
|
||||||
|
private var buffer: CharSequence = ""
|
||||||
|
private var startOffset: Int = 0
|
||||||
|
private var endOffset: Int = 0
|
||||||
|
private var myTokenStart: Int = 0
|
||||||
|
private var myTokenEnd: Int = 0
|
||||||
|
private var myTokenType: IElementType? = null
|
||||||
|
|
||||||
|
private val keywords = setOf(
|
||||||
|
"fun", "val", "var", "class", "interface", "type", "import", "as",
|
||||||
|
"abstract", "closed", "override",
|
||||||
|
"if", "else", "for", "while", "return", "true", "false", "null",
|
||||||
|
"when", "in", "is", "break", "continue", "try", "catch", "finally",
|
||||||
|
"get", "set"
|
||||||
|
)
|
||||||
|
|
||||||
|
override fun start(buffer: CharSequence, startOffset: Int, endOffset: Int, initialState: Int) {
|
||||||
|
this.buffer = buffer
|
||||||
|
this.startOffset = startOffset
|
||||||
|
this.endOffset = endOffset
|
||||||
|
this.myTokenStart = startOffset
|
||||||
|
this.myTokenEnd = startOffset
|
||||||
|
this.myTokenType = null
|
||||||
|
advance()
|
||||||
|
}
|
||||||
|
|
||||||
|
override fun getState(): Int = 0
|
||||||
|
|
||||||
|
override fun getTokenType(): IElementType? = myTokenType
|
||||||
|
|
||||||
|
override fun getTokenStart(): Int = myTokenStart
|
||||||
|
|
||||||
|
override fun getTokenEnd(): Int = myTokenEnd
|
||||||
|
|
||||||
|
override fun getBufferSequence(): CharSequence = buffer
|
||||||
|
|
||||||
|
override fun getBufferEnd(): Int = endOffset
|
||||||
|
|
||||||
|
override fun advance() {
|
||||||
|
if (myTokenEnd >= endOffset) {
|
||||||
|
myTokenType = null
|
||||||
|
return
|
||||||
|
}
|
||||||
|
var i = if (myTokenEnd == 0) startOffset else myTokenEnd
|
||||||
|
// Skip nothing; set start
|
||||||
|
myTokenStart = i
|
||||||
|
if (i >= endOffset) { myTokenType = null; return }
|
||||||
|
|
||||||
|
val ch = buffer[i]
|
||||||
|
|
||||||
|
// Whitespace
|
||||||
|
if (ch.isWhitespace()) {
|
||||||
|
i++
|
||||||
|
while (i < endOffset && buffer[i].isWhitespace()) i++
|
||||||
|
myTokenEnd = i
|
||||||
|
myTokenType = LyngTokenTypes.WHITESPACE
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
// Line comment //...
|
||||||
|
if (ch == '/' && i + 1 < endOffset && buffer[i + 1] == '/') {
|
||||||
|
i += 2
|
||||||
|
while (i < endOffset && buffer[i] != '\n' && buffer[i] != '\r') i++
|
||||||
|
myTokenEnd = i
|
||||||
|
myTokenType = LyngTokenTypes.LINE_COMMENT
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
// Block comment /* ... */
|
||||||
|
if (ch == '/' && i + 1 < endOffset && buffer[i + 1] == '*') {
|
||||||
|
i += 2
|
||||||
|
while (i + 1 < endOffset && !(buffer[i] == '*' && buffer[i + 1] == '/')) i++
|
||||||
|
if (i + 1 < endOffset) i += 2 // consume */
|
||||||
|
myTokenEnd = i
|
||||||
|
myTokenType = LyngTokenTypes.BLOCK_COMMENT
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
// String "..." with simple escape handling
|
||||||
|
if (ch == '"') {
|
||||||
|
i++
|
||||||
|
while (i < endOffset) {
|
||||||
|
val c = buffer[i]
|
||||||
|
if (c == '\\') { // escape
|
||||||
|
i += 2
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if (c == '"') { i++; break }
|
||||||
|
i++
|
||||||
|
}
|
||||||
|
myTokenEnd = i
|
||||||
|
myTokenType = LyngTokenTypes.STRING
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
// Number
|
||||||
|
if (ch.isDigit()) {
|
||||||
|
i++
|
||||||
|
var hasDot = false
|
||||||
|
while (i < endOffset) {
|
||||||
|
val c = buffer[i]
|
||||||
|
if (c.isDigit()) { i++; continue }
|
||||||
|
if (c == '.' && !hasDot) { hasDot = true; i++; continue }
|
||||||
|
break
|
||||||
|
}
|
||||||
|
myTokenEnd = i
|
||||||
|
myTokenType = LyngTokenTypes.NUMBER
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
// Identifier / keyword
|
||||||
|
if (ch.isIdentifierStart()) {
|
||||||
|
i++
|
||||||
|
while (i < endOffset && buffer[i].isIdentifierPart()) i++
|
||||||
|
myTokenEnd = i
|
||||||
|
val text = buffer.subSequence(myTokenStart, myTokenEnd).toString()
|
||||||
|
myTokenType = if (text in keywords) LyngTokenTypes.KEYWORD else LyngTokenTypes.IDENTIFIER
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
// Punctuation
|
||||||
|
if (isPunct(ch)) {
|
||||||
|
i++
|
||||||
|
myTokenEnd = i
|
||||||
|
myTokenType = LyngTokenTypes.PUNCT
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
// Fallback bad char
|
||||||
|
myTokenEnd = i + 1
|
||||||
|
myTokenType = LyngTokenTypes.BAD_CHAR
|
||||||
|
}
|
||||||
|
|
||||||
|
private fun Char.isWhitespace(): Boolean = this == ' ' || this == '\t' || this == '\n' || this == '\r' || this == '\u000C'
|
||||||
|
private fun Char.isDigit(): Boolean = this in '0'..'9'
|
||||||
|
private fun Char.isIdentifierStart(): Boolean = this == '_' || this.isLetter()
|
||||||
|
private fun Char.isIdentifierPart(): Boolean = this.isIdentifierStart() || this.isDigit()
|
||||||
|
private fun isPunct(c: Char): Boolean = c in setOf('(', ')', '{', '}', '[', ']', '.', ',', ';', ':', '+', '-', '*', '/', '%', '=', '<', '>', '!', '?', '&', '|', '^', '~')
|
||||||
|
}
|
||||||
@@ -0,0 +1,40 @@
|
|||||||
|
/*
|
||||||
|
* Copyright 2025 Sergey S. Chernov real.sergeych@gmail.com
|
||||||
|
*
|
||||||
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
* you may not use this file except in compliance with the License.
|
||||||
|
* You may obtain a copy of the License at
|
||||||
|
*
|
||||||
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
*
|
||||||
|
* Unless required by applicable law or agreed to in writing, software
|
||||||
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
* See the License for the specific language governing permissions and
|
||||||
|
* limitations under the License.
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
|
package net.sergeych.lyng.idea.highlight
|
||||||
|
|
||||||
|
import com.intellij.lexer.Lexer
|
||||||
|
import com.intellij.openapi.editor.colors.TextAttributesKey
|
||||||
|
import com.intellij.openapi.fileTypes.SyntaxHighlighter
|
||||||
|
import com.intellij.psi.tree.IElementType
|
||||||
|
|
||||||
|
class LyngSyntaxHighlighter : SyntaxHighlighter {
|
||||||
|
override fun getHighlightingLexer(): Lexer = LyngLexer()
|
||||||
|
|
||||||
|
override fun getTokenHighlights(tokenType: IElementType): Array<TextAttributesKey> = when (tokenType) {
|
||||||
|
LyngTokenTypes.KEYWORD -> pack(LyngHighlighterColors.KEYWORD)
|
||||||
|
LyngTokenTypes.STRING -> pack(LyngHighlighterColors.STRING)
|
||||||
|
LyngTokenTypes.NUMBER -> pack(LyngHighlighterColors.NUMBER)
|
||||||
|
LyngTokenTypes.LINE_COMMENT -> pack(LyngHighlighterColors.LINE_COMMENT)
|
||||||
|
LyngTokenTypes.BLOCK_COMMENT -> pack(LyngHighlighterColors.BLOCK_COMMENT)
|
||||||
|
LyngTokenTypes.PUNCT -> pack(LyngHighlighterColors.PUNCT)
|
||||||
|
LyngTokenTypes.IDENTIFIER -> pack(LyngHighlighterColors.IDENTIFIER)
|
||||||
|
else -> emptyArray()
|
||||||
|
}
|
||||||
|
|
||||||
|
private fun pack(vararg keys: TextAttributesKey): Array<TextAttributesKey> = arrayOf(*keys)
|
||||||
|
}
|
||||||
+25
@@ -0,0 +1,25 @@
|
|||||||
|
/*
|
||||||
|
* Copyright 2025 Sergey S. Chernov real.sergeych@gmail.com
|
||||||
|
*
|
||||||
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
* you may not use this file except in compliance with the License.
|
||||||
|
* You may obtain a copy of the License at
|
||||||
|
*
|
||||||
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
*
|
||||||
|
* Unless required by applicable law or agreed to in writing, software
|
||||||
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
* See the License for the specific language governing permissions and
|
||||||
|
* limitations under the License.
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
|
package net.sergeych.lyng.idea.highlight
|
||||||
|
|
||||||
|
import com.intellij.openapi.fileTypes.SingleLazyInstanceSyntaxHighlighterFactory
|
||||||
|
import com.intellij.openapi.fileTypes.SyntaxHighlighter
|
||||||
|
|
||||||
|
class LyngSyntaxHighlighterFactory : SingleLazyInstanceSyntaxHighlighterFactory() {
|
||||||
|
override fun createHighlighter(): SyntaxHighlighter = LyngSyntaxHighlighter()
|
||||||
|
}
|
||||||
@@ -0,0 +1,34 @@
|
|||||||
|
/*
|
||||||
|
* Copyright 2025 Sergey S. Chernov real.sergeych@gmail.com
|
||||||
|
*
|
||||||
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
* you may not use this file except in compliance with the License.
|
||||||
|
* You may obtain a copy of the License at
|
||||||
|
*
|
||||||
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
*
|
||||||
|
* Unless required by applicable law or agreed to in writing, software
|
||||||
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
* See the License for the specific language governing permissions and
|
||||||
|
* limitations under the License.
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
package net.sergeych.lyng.idea.highlight
|
||||||
|
|
||||||
|
import com.intellij.psi.tree.IElementType
|
||||||
|
import net.sergeych.lyng.idea.LyngLanguage
|
||||||
|
|
||||||
|
class LyngTokenType(debugName: String) : IElementType(debugName, LyngLanguage)
|
||||||
|
|
||||||
|
object LyngTokenTypes {
|
||||||
|
val WHITESPACE = LyngTokenType("WHITESPACE")
|
||||||
|
val LINE_COMMENT = LyngTokenType("LINE_COMMENT")
|
||||||
|
val BLOCK_COMMENT = LyngTokenType("BLOCK_COMMENT")
|
||||||
|
val STRING = LyngTokenType("STRING")
|
||||||
|
val NUMBER = LyngTokenType("NUMBER")
|
||||||
|
val KEYWORD = LyngTokenType("KEYWORD")
|
||||||
|
val IDENTIFIER = LyngTokenType("IDENTIFIER")
|
||||||
|
val PUNCT = LyngTokenType("PUNCT")
|
||||||
|
val BAD_CHAR = LyngTokenType("BAD_CHAR")
|
||||||
|
}
|
||||||
+109
@@ -0,0 +1,109 @@
|
|||||||
|
/*
|
||||||
|
* Copyright 2026 Sergey S. Chernov real.sergeych@gmail.com
|
||||||
|
*
|
||||||
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
* you may not use this file except in compliance with the License.
|
||||||
|
* You may obtain a copy of the License at
|
||||||
|
*
|
||||||
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
*
|
||||||
|
* Unless required by applicable law or agreed to in writing, software
|
||||||
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
* See the License for the specific language governing permissions and
|
||||||
|
* limitations under the License.
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
|
package net.sergeych.lyng.idea.navigation
|
||||||
|
|
||||||
|
import com.intellij.icons.AllIcons
|
||||||
|
import com.intellij.navigation.ItemPresentation
|
||||||
|
import com.intellij.openapi.util.TextRange
|
||||||
|
import com.intellij.psi.PsiDocumentManager
|
||||||
|
import com.intellij.psi.PsiElement
|
||||||
|
import com.intellij.psi.PsiFile
|
||||||
|
import com.intellij.psi.PsiNameIdentifierOwner
|
||||||
|
import com.intellij.psi.impl.light.LightElement
|
||||||
|
import com.intellij.util.IncorrectOperationException
|
||||||
|
import net.sergeych.lyng.idea.LyngLanguage
|
||||||
|
import javax.swing.Icon
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A light PSI element representing a Lyng declaration (function, class, enum, or variable).
|
||||||
|
* Used for navigation and to provide a stable anchor for "Find Usages".
|
||||||
|
*/
|
||||||
|
class LyngDeclarationElement(
|
||||||
|
private val nameElement: PsiElement,
|
||||||
|
private val name: String,
|
||||||
|
val kind: String = "declaration"
|
||||||
|
) : LightElement(nameElement.manager, LyngLanguage), PsiNameIdentifierOwner {
|
||||||
|
|
||||||
|
override fun getName(): String = name
|
||||||
|
|
||||||
|
override fun setName(name: String): PsiElement {
|
||||||
|
throw IncorrectOperationException("Renaming is not yet supported")
|
||||||
|
}
|
||||||
|
|
||||||
|
override fun getNameIdentifier(): PsiElement = nameElement
|
||||||
|
|
||||||
|
override fun getNavigationElement(): PsiElement = nameElement
|
||||||
|
|
||||||
|
override fun getTextRange(): TextRange = nameElement.textRange
|
||||||
|
|
||||||
|
override fun getContainingFile(): PsiFile = nameElement.containingFile
|
||||||
|
|
||||||
|
override fun isValid(): Boolean = nameElement.isValid
|
||||||
|
|
||||||
|
override fun getPresentation(): ItemPresentation {
|
||||||
|
return object : ItemPresentation {
|
||||||
|
override fun getPresentableText(): String = name
|
||||||
|
override fun getLocationString(): String {
|
||||||
|
val file = containingFile
|
||||||
|
val document = PsiDocumentManager.getInstance(file.project).getDocument(file)
|
||||||
|
val line = if (document != null) document.getLineNumber(textRange.startOffset) + 1 else "?"
|
||||||
|
val column = if (document != null) {
|
||||||
|
val lineStart = document.getLineStartOffset(document.getLineNumber(textRange.startOffset))
|
||||||
|
textRange.startOffset - lineStart + 1
|
||||||
|
} else "?"
|
||||||
|
return "${file.name}:$line:$column"
|
||||||
|
}
|
||||||
|
override fun getIcon(unused: Boolean): Icon {
|
||||||
|
return when (kind) {
|
||||||
|
"Function" -> AllIcons.Nodes.Function
|
||||||
|
"Class" -> AllIcons.Nodes.Class
|
||||||
|
"Enum" -> AllIcons.Nodes.Enum
|
||||||
|
"EnumConstant" -> AllIcons.Nodes.Enum
|
||||||
|
"Variable" -> AllIcons.Nodes.Variable
|
||||||
|
"Value" -> AllIcons.Nodes.Field
|
||||||
|
"Parameter" -> AllIcons.Nodes.Parameter
|
||||||
|
"Initializer" -> AllIcons.Nodes.Method
|
||||||
|
else -> AllIcons.Nodes.Property
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
override fun toString(): String = "$kind:$name"
|
||||||
|
|
||||||
|
override fun equals(other: Any?): Boolean {
|
||||||
|
if (this === other) return true
|
||||||
|
if (other !is LyngDeclarationElement) return false
|
||||||
|
return name == other.name && nameElement == other.nameElement
|
||||||
|
}
|
||||||
|
|
||||||
|
override fun isEquivalentTo(another: PsiElement?): Boolean {
|
||||||
|
if (this === another) return true
|
||||||
|
if (another == nameElement) return true
|
||||||
|
if (another is LyngDeclarationElement) {
|
||||||
|
return name == another.name && nameElement == another.nameElement
|
||||||
|
}
|
||||||
|
return super.isEquivalentTo(another)
|
||||||
|
}
|
||||||
|
|
||||||
|
override fun hashCode(): Int {
|
||||||
|
var result = nameElement.hashCode()
|
||||||
|
result = 31 * result + name.hashCode()
|
||||||
|
return result
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,92 @@
|
|||||||
|
/*
|
||||||
|
* Copyright 2026 Sergey S. Chernov real.sergeych@gmail.com
|
||||||
|
*
|
||||||
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
* you may not use this file except in compliance with the License.
|
||||||
|
* You may obtain a copy of the License at
|
||||||
|
*
|
||||||
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
*
|
||||||
|
* Unless required by applicable law or agreed to in writing, software
|
||||||
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
* See the License for the specific language governing permissions and
|
||||||
|
* limitations under the License.
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
|
package net.sergeych.lyng.idea.navigation
|
||||||
|
|
||||||
|
import com.intellij.lang.cacheBuilder.DefaultWordsScanner
|
||||||
|
import com.intellij.lang.cacheBuilder.WordsScanner
|
||||||
|
import com.intellij.lang.findUsages.FindUsagesProvider
|
||||||
|
import com.intellij.psi.PsiDocumentManager
|
||||||
|
import com.intellij.psi.PsiElement
|
||||||
|
import com.intellij.psi.tree.TokenSet
|
||||||
|
import net.sergeych.lyng.idea.highlight.LyngLexer
|
||||||
|
import net.sergeych.lyng.idea.highlight.LyngTokenTypes
|
||||||
|
import net.sergeych.lyng.idea.util.LyngAstManager
|
||||||
|
import net.sergeych.lyng.miniast.DocLookupUtils
|
||||||
|
|
||||||
|
class LyngFindUsagesProvider : FindUsagesProvider {
|
||||||
|
override fun getWordsScanner(): WordsScanner {
|
||||||
|
return DefaultWordsScanner(
|
||||||
|
LyngLexer(),
|
||||||
|
TokenSet.create(LyngTokenTypes.IDENTIFIER),
|
||||||
|
TokenSet.create(LyngTokenTypes.LINE_COMMENT, LyngTokenTypes.BLOCK_COMMENT),
|
||||||
|
TokenSet.create(LyngTokenTypes.STRING)
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
override fun canFindUsagesFor(psiElement: PsiElement): Boolean {
|
||||||
|
return psiElement is LyngDeclarationElement || isDeclaration(psiElement)
|
||||||
|
}
|
||||||
|
|
||||||
|
private fun isDeclaration(element: PsiElement): Boolean {
|
||||||
|
val file = element.containingFile ?: return false
|
||||||
|
val mini = LyngAstManager.getMiniAst(file) ?: return false
|
||||||
|
val offset = element.textRange.startOffset
|
||||||
|
val name = element.text ?: ""
|
||||||
|
return DocLookupUtils.findDeclarationAt(mini, offset, name) != null
|
||||||
|
}
|
||||||
|
|
||||||
|
override fun getHelpId(psiElement: PsiElement): String? = null
|
||||||
|
|
||||||
|
override fun getType(element: PsiElement): String {
|
||||||
|
if (element is LyngDeclarationElement) return element.kind
|
||||||
|
val file = element.containingFile ?: return "Lyng declaration"
|
||||||
|
val mini = LyngAstManager.getMiniAst(file) ?: return "Lyng declaration"
|
||||||
|
val info = DocLookupUtils.findDeclarationAt(mini, element.textRange.startOffset, element.text ?: "")
|
||||||
|
return info?.second ?: "Lyng declaration"
|
||||||
|
}
|
||||||
|
|
||||||
|
override fun getDescriptiveName(element: PsiElement): String {
|
||||||
|
if (element is LyngDeclarationElement) {
|
||||||
|
val file = element.containingFile
|
||||||
|
val document = PsiDocumentManager.getInstance(file.project).getDocument(file)
|
||||||
|
val line = if (document != null) document.getLineNumber(element.textRange.startOffset) + 1 else "?"
|
||||||
|
val column = if (document != null) {
|
||||||
|
val lineStart = document.getLineStartOffset(document.getLineNumber(element.textRange.startOffset))
|
||||||
|
element.textRange.startOffset - lineStart + 1
|
||||||
|
} else "?"
|
||||||
|
return "${element.name} (${file.name}:$line:$column)"
|
||||||
|
}
|
||||||
|
val file = element.containingFile ?: return element.text ?: "unknown"
|
||||||
|
val mini = LyngAstManager.getMiniAst(file) ?: return element.text ?: "unknown"
|
||||||
|
val info = DocLookupUtils.findDeclarationAt(mini, element.textRange.startOffset, element.text ?: "")
|
||||||
|
|
||||||
|
val document = PsiDocumentManager.getInstance(file.project).getDocument(file)
|
||||||
|
val line = if (document != null) document.getLineNumber(element.textRange.startOffset) + 1 else "?"
|
||||||
|
val column = if (document != null) {
|
||||||
|
val lineStart = document.getLineStartOffset(document.getLineNumber(element.textRange.startOffset))
|
||||||
|
element.textRange.startOffset - lineStart + 1
|
||||||
|
} else "?"
|
||||||
|
|
||||||
|
val name = info?.first ?: element.text ?: "unknown"
|
||||||
|
return "$name (${file.name}:$line:$column)"
|
||||||
|
}
|
||||||
|
|
||||||
|
override fun getNodeText(element: PsiElement, useFullName: Boolean): String {
|
||||||
|
return (element as? LyngDeclarationElement)?.name ?: element.text ?: "unknown"
|
||||||
|
}
|
||||||
|
}
|
||||||
+58
@@ -0,0 +1,58 @@
|
|||||||
|
/*
|
||||||
|
* Copyright 2026 Sergey S. Chernov real.sergeych@gmail.com
|
||||||
|
*
|
||||||
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
* you may not use this file except in compliance with the License.
|
||||||
|
* You may obtain a copy of the License at
|
||||||
|
*
|
||||||
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
*
|
||||||
|
* Unless required by applicable law or agreed to in writing, software
|
||||||
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
* See the License for the specific language governing permissions and
|
||||||
|
* limitations under the License.
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
|
package net.sergeych.lyng.idea.navigation
|
||||||
|
|
||||||
|
import com.intellij.codeInsight.navigation.actions.GotoDeclarationHandler
|
||||||
|
import com.intellij.openapi.editor.Editor
|
||||||
|
import com.intellij.psi.PsiElement
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Ensures Ctrl+B (Go to Definition) works on Lyng identifiers by resolving through LyngPsiReference.
|
||||||
|
*/
|
||||||
|
class LyngGotoDeclarationHandler : GotoDeclarationHandler {
|
||||||
|
override fun getGotoDeclarationTargets(sourceElement: PsiElement?, offset: Int, editor: Editor?): Array<PsiElement>? {
|
||||||
|
if (sourceElement == null) return null
|
||||||
|
|
||||||
|
val allTargets = mutableListOf<PsiElement>()
|
||||||
|
|
||||||
|
// Find reference at the element or its parent (sometimes the identifier token is wrapped)
|
||||||
|
val ref = sourceElement.reference ?: sourceElement.parent?.reference
|
||||||
|
if (ref is LyngPsiReference) {
|
||||||
|
val resolved = ref.multiResolve(false)
|
||||||
|
allTargets.addAll(resolved.mapNotNull { it.element })
|
||||||
|
} else {
|
||||||
|
// Manual check if not picked up by reference (e.g. if contributor didn't run yet)
|
||||||
|
val manualRef = LyngPsiReference(sourceElement)
|
||||||
|
val manualResolved = manualRef.multiResolve(false)
|
||||||
|
allTargets.addAll(manualResolved.mapNotNull { it.element })
|
||||||
|
}
|
||||||
|
|
||||||
|
if (allTargets.isEmpty()) return null
|
||||||
|
|
||||||
|
// If there is only one target and it's equivalent to the source, return null.
|
||||||
|
// This allows IDEA to treat it as a declaration site and trigger "Show Usages".
|
||||||
|
if (allTargets.size == 1) {
|
||||||
|
val target = allTargets[0]
|
||||||
|
if (target == sourceElement || target.isEquivalentTo(sourceElement)) {
|
||||||
|
return null
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return allTargets.toTypedArray()
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,48 @@
|
|||||||
|
/*
|
||||||
|
* Copyright 2026 Sergey S. Chernov real.sergeych@gmail.com
|
||||||
|
*
|
||||||
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
* you may not use this file except in compliance with the License.
|
||||||
|
* You may obtain a copy of the License at
|
||||||
|
*
|
||||||
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
*
|
||||||
|
* Unless required by applicable law or agreed to in writing, software
|
||||||
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
* See the License for the specific language governing permissions and
|
||||||
|
* limitations under the License.
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
|
package net.sergeych.lyng.idea.navigation
|
||||||
|
|
||||||
|
import com.intellij.icons.AllIcons
|
||||||
|
import com.intellij.ide.IconProvider
|
||||||
|
import com.intellij.psi.PsiElement
|
||||||
|
import net.sergeych.lyng.idea.util.LyngAstManager
|
||||||
|
import net.sergeych.lyng.miniast.DocLookupUtils
|
||||||
|
import javax.swing.Icon
|
||||||
|
|
||||||
|
class LyngIconProvider : IconProvider() {
|
||||||
|
override fun getIcon(element: PsiElement, flags: Int): Icon? {
|
||||||
|
val file = element.containingFile ?: return null
|
||||||
|
val mini = LyngAstManager.getMiniAst(file) ?: return null
|
||||||
|
|
||||||
|
val info = DocLookupUtils.findDeclarationAt(mini, element.textRange.startOffset, element.text ?: "")
|
||||||
|
if (info != null) {
|
||||||
|
return when (info.second) {
|
||||||
|
"Function" -> AllIcons.Nodes.Function
|
||||||
|
"Class" -> AllIcons.Nodes.Class
|
||||||
|
"Enum" -> AllIcons.Nodes.Enum
|
||||||
|
"EnumConstant" -> AllIcons.Nodes.Enum
|
||||||
|
"Variable" -> AllIcons.Nodes.Variable
|
||||||
|
"Value" -> AllIcons.Nodes.Field
|
||||||
|
"Parameter" -> AllIcons.Nodes.Parameter
|
||||||
|
"Initializer" -> AllIcons.Nodes.Method
|
||||||
|
else -> null
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return null
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,204 @@
|
|||||||
|
/*
|
||||||
|
* Copyright 2026 Sergey S. Chernov real.sergeych@gmail.com
|
||||||
|
*
|
||||||
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
* you may not use this file except in compliance with the License.
|
||||||
|
* You may obtain a copy of the License at
|
||||||
|
*
|
||||||
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
*
|
||||||
|
* Unless required by applicable law or agreed to in writing, software
|
||||||
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
* See the License for the specific language governing permissions and
|
||||||
|
* limitations under the License.
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
|
package net.sergeych.lyng.idea.navigation
|
||||||
|
|
||||||
|
import com.intellij.openapi.project.Project
|
||||||
|
import com.intellij.openapi.util.TextRange
|
||||||
|
import com.intellij.psi.*
|
||||||
|
import com.intellij.psi.search.FilenameIndex
|
||||||
|
import com.intellij.psi.search.GlobalSearchScope
|
||||||
|
import net.sergeych.lyng.highlight.offsetOf
|
||||||
|
import net.sergeych.lyng.idea.util.LyngAstManager
|
||||||
|
import net.sergeych.lyng.idea.util.TextCtx
|
||||||
|
import net.sergeych.lyng.miniast.*
|
||||||
|
|
||||||
|
class LyngPsiReference(element: PsiElement) : PsiPolyVariantReferenceBase<PsiElement>(element, TextRange(0, element.textLength)) {
|
||||||
|
|
||||||
|
override fun multiResolve(incompleteCode: Boolean): Array<ResolveResult> {
|
||||||
|
val file = element.containingFile
|
||||||
|
val text = file.text
|
||||||
|
val offset = element.textRange.startOffset
|
||||||
|
val name = element.text ?: ""
|
||||||
|
val results = mutableListOf<ResolveResult>()
|
||||||
|
|
||||||
|
val mini = LyngAstManager.getMiniAst(file) ?: return emptyArray()
|
||||||
|
val binding = LyngAstManager.getBinding(file)
|
||||||
|
|
||||||
|
// 1. Member resolution (obj.member)
|
||||||
|
val dotPos = TextCtx.findDotLeft(text, offset)
|
||||||
|
if (dotPos != null) {
|
||||||
|
val imported = DocLookupUtils.canonicalImportedModules(mini, text)
|
||||||
|
val receiverClass = DocLookupUtils.guessReceiverClassViaMini(mini, text, dotPos, imported, binding)
|
||||||
|
?: DocLookupUtils.guessReceiverClass(text, dotPos, imported, mini)
|
||||||
|
|
||||||
|
if (receiverClass != null) {
|
||||||
|
val resolved = DocLookupUtils.resolveMemberWithInheritance(imported, receiverClass, name, mini)
|
||||||
|
if (resolved != null) {
|
||||||
|
val owner = resolved.first
|
||||||
|
val member = resolved.second
|
||||||
|
|
||||||
|
// We need to find the actual PSI element for this member
|
||||||
|
val targetFile = findFileForClass(file.project, owner) ?: file
|
||||||
|
val targetMini = LyngAstManager.getMiniAst(targetFile)
|
||||||
|
if (targetMini != null) {
|
||||||
|
val targetSrc = targetMini.range.start.source
|
||||||
|
val off = targetSrc.offsetOf(member.nameStart)
|
||||||
|
targetFile.findElementAt(off)?.let {
|
||||||
|
val kind = when(member) {
|
||||||
|
is MiniMemberFunDecl -> "Function"
|
||||||
|
is MiniMemberValDecl -> if (member.mutable) "Variable" else "Value"
|
||||||
|
is MiniInitDecl -> "Initializer"
|
||||||
|
}
|
||||||
|
results.add(PsiElementResolveResult(LyngDeclarationElement(it, member.name, kind)))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
// If we couldn't resolve exactly, we might still want to search globally but ONLY for members
|
||||||
|
if (results.isEmpty()) {
|
||||||
|
results.addAll(resolveGlobally(file.project, name, membersOnly = true))
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
// 2. Local resolution via Binder
|
||||||
|
if (binding != null) {
|
||||||
|
val ref = binding.references.firstOrNull { offset >= it.start && offset < it.end }
|
||||||
|
if (ref != null) {
|
||||||
|
val sym = binding.symbols.firstOrNull { it.id == ref.symbolId }
|
||||||
|
if (sym != null && sym.declStart >= 0) {
|
||||||
|
file.findElementAt(sym.declStart)?.let {
|
||||||
|
results.add(PsiElementResolveResult(LyngDeclarationElement(it, sym.name, sym.kind.name)))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// 3. Global project scan
|
||||||
|
// Only search globally if we haven't found a strong local match
|
||||||
|
if (results.isEmpty()) {
|
||||||
|
results.addAll(resolveGlobally(file.project, name))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// 4. Filter results to exclude duplicates
|
||||||
|
// Use a more robust de-duplication that prefers the raw element if multiple refer to the same thing
|
||||||
|
val filtered = mutableListOf<ResolveResult>()
|
||||||
|
for (res in results) {
|
||||||
|
val el = res.element ?: continue
|
||||||
|
val nav = if (el is LyngDeclarationElement) el.navigationElement else el
|
||||||
|
if (filtered.none { existing ->
|
||||||
|
val exEl = existing.element
|
||||||
|
val exNav = if (exEl is LyngDeclarationElement) exEl.navigationElement else exEl
|
||||||
|
exNav == nav || (exNav != null && exNav.isEquivalentTo(nav))
|
||||||
|
}) {
|
||||||
|
filtered.add(res)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return filtered.toTypedArray()
|
||||||
|
}
|
||||||
|
|
||||||
|
private fun findFileForClass(project: Project, className: String): PsiFile? {
|
||||||
|
val psiManager = PsiManager.getInstance(project)
|
||||||
|
|
||||||
|
// 1. Try file with matching name first (optimization)
|
||||||
|
val matchingFiles = FilenameIndex.getFilesByName(project, "$className.lyng", GlobalSearchScope.projectScope(project))
|
||||||
|
for (file in matchingFiles) {
|
||||||
|
val mini = LyngAstManager.getMiniAst(file) ?: continue
|
||||||
|
if (mini.declarations.any { (it is MiniClassDecl && it.name == className) || (it is MiniEnumDecl && it.name == className) }) {
|
||||||
|
return file
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// 2. Fallback to full project scan
|
||||||
|
val allFiles = FilenameIndex.getAllFilesByExt(project, "lyng", GlobalSearchScope.projectScope(project))
|
||||||
|
for (vFile in allFiles) {
|
||||||
|
val file = psiManager.findFile(vFile) ?: continue
|
||||||
|
if (matchingFiles.contains(file)) continue // already checked
|
||||||
|
val mini = LyngAstManager.getMiniAst(file) ?: continue
|
||||||
|
if (mini.declarations.any { (it is MiniClassDecl && it.name == className) || (it is MiniEnumDecl && it.name == className) }) {
|
||||||
|
return file
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return null
|
||||||
|
}
|
||||||
|
|
||||||
|
override fun resolve(): PsiElement? {
|
||||||
|
val results = multiResolve(false)
|
||||||
|
if (results.isEmpty()) return null
|
||||||
|
val target = results[0].element ?: return null
|
||||||
|
// If the target is equivalent to our source element, return the source element itself.
|
||||||
|
// This is crucial for IDEA to recognize we are already at the declaration site
|
||||||
|
// and trigger "Show Usages" instead of performing a no-op navigation.
|
||||||
|
if (target == element || target.isEquivalentTo(element)) {
|
||||||
|
return element
|
||||||
|
}
|
||||||
|
return target
|
||||||
|
}
|
||||||
|
|
||||||
|
private fun resolveGlobally(project: Project, name: String, membersOnly: Boolean = false): List<ResolveResult> {
|
||||||
|
val results = mutableListOf<ResolveResult>()
|
||||||
|
val files = FilenameIndex.getAllFilesByExt(project, "lyng", GlobalSearchScope.projectScope(project))
|
||||||
|
val psiManager = PsiManager.getInstance(project)
|
||||||
|
|
||||||
|
for (vFile in files) {
|
||||||
|
val file = psiManager.findFile(vFile) ?: continue
|
||||||
|
val mini = LyngAstManager.getMiniAst(file) ?: continue
|
||||||
|
val src = mini.range.start.source
|
||||||
|
|
||||||
|
fun addIfMatch(dName: String, nameStart: net.sergeych.lyng.Pos, dKind: String) {
|
||||||
|
if (dName == name) {
|
||||||
|
val off = src.offsetOf(nameStart)
|
||||||
|
file.findElementAt(off)?.let {
|
||||||
|
results.add(PsiElementResolveResult(LyngDeclarationElement(it, dName, dKind)))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
for (d in mini.declarations) {
|
||||||
|
if (!membersOnly) {
|
||||||
|
val dKind = when(d) {
|
||||||
|
is net.sergeych.lyng.miniast.MiniFunDecl -> "Function"
|
||||||
|
is net.sergeych.lyng.miniast.MiniClassDecl -> "Class"
|
||||||
|
is net.sergeych.lyng.miniast.MiniEnumDecl -> "Enum"
|
||||||
|
is net.sergeych.lyng.miniast.MiniValDecl -> if (d.mutable) "Variable" else "Value"
|
||||||
|
}
|
||||||
|
addIfMatch(d.name, d.nameStart, dKind)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Check members of classes and enums
|
||||||
|
val members = when(d) {
|
||||||
|
is MiniClassDecl -> d.members
|
||||||
|
is MiniEnumDecl -> DocLookupUtils.enumToSyntheticClass(d).members
|
||||||
|
else -> emptyList()
|
||||||
|
}
|
||||||
|
|
||||||
|
for (m in members) {
|
||||||
|
val mKind = when(m) {
|
||||||
|
is net.sergeych.lyng.miniast.MiniMemberFunDecl -> "Function"
|
||||||
|
is net.sergeych.lyng.miniast.MiniMemberValDecl -> if (m.mutable) "Variable" else "Value"
|
||||||
|
is net.sergeych.lyng.miniast.MiniInitDecl -> "Initializer"
|
||||||
|
}
|
||||||
|
addIfMatch(m.name, m.nameStart, mKind)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return results
|
||||||
|
}
|
||||||
|
|
||||||
|
override fun getVariants(): Array<Any> = emptyArray()
|
||||||
|
}
|
||||||
+54
@@ -0,0 +1,54 @@
|
|||||||
|
/*
|
||||||
|
* Copyright 2026 Sergey S. Chernov real.sergeych@gmail.com
|
||||||
|
*
|
||||||
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
* you may not use this file except in compliance with the License.
|
||||||
|
* You may obtain a copy of the License at
|
||||||
|
*
|
||||||
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
*
|
||||||
|
* Unless required by applicable law or agreed to in writing, software
|
||||||
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
* See the License for the specific language governing permissions and
|
||||||
|
* limitations under the License.
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
|
package net.sergeych.lyng.idea.navigation
|
||||||
|
|
||||||
|
import com.intellij.patterns.PlatformPatterns
|
||||||
|
import com.intellij.psi.*
|
||||||
|
import com.intellij.util.ProcessingContext
|
||||||
|
import net.sergeych.lyng.idea.LyngLanguage
|
||||||
|
import net.sergeych.lyng.idea.highlight.LyngTokenTypes
|
||||||
|
import net.sergeych.lyng.idea.util.LyngAstManager
|
||||||
|
import net.sergeych.lyng.miniast.DocLookupUtils
|
||||||
|
|
||||||
|
class LyngPsiReferenceContributor : PsiReferenceContributor() {
|
||||||
|
override fun registerReferenceProviders(registrar: PsiReferenceRegistrar) {
|
||||||
|
registrar.registerReferenceProvider(
|
||||||
|
PlatformPatterns.psiElement().withLanguage(LyngLanguage),
|
||||||
|
object : PsiReferenceProvider() {
|
||||||
|
override fun getReferencesByElement(
|
||||||
|
element: PsiElement,
|
||||||
|
context: ProcessingContext
|
||||||
|
): Array<PsiReference> {
|
||||||
|
if (element.node.elementType == LyngTokenTypes.IDENTIFIER) {
|
||||||
|
val file = element.containingFile
|
||||||
|
val mini = LyngAstManager.getMiniAst(file)
|
||||||
|
if (mini != null) {
|
||||||
|
val offset = element.textRange.startOffset
|
||||||
|
val name = element.text ?: ""
|
||||||
|
if (DocLookupUtils.findDeclarationAt(mini, offset, name) != null) {
|
||||||
|
return PsiReference.EMPTY_ARRAY
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return arrayOf(LyngPsiReference(element))
|
||||||
|
}
|
||||||
|
return PsiReference.EMPTY_ARRAY
|
||||||
|
}
|
||||||
|
}
|
||||||
|
)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,28 @@
|
|||||||
|
/*
|
||||||
|
* Copyright 2025 Sergey S. Chernov real.sergeych@gmail.com
|
||||||
|
*
|
||||||
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
* you may not use this file except in compliance with the License.
|
||||||
|
* You may obtain a copy of the License at
|
||||||
|
*
|
||||||
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
*
|
||||||
|
* Unless required by applicable law or agreed to in writing, software
|
||||||
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
* See the License for the specific language governing permissions and
|
||||||
|
* limitations under the License.
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
package net.sergeych.lyng.idea.psi
|
||||||
|
|
||||||
|
import com.intellij.extapi.psi.PsiFileBase
|
||||||
|
import com.intellij.openapi.fileTypes.FileType
|
||||||
|
import com.intellij.psi.FileViewProvider
|
||||||
|
import net.sergeych.lyng.idea.LyngFileType
|
||||||
|
import net.sergeych.lyng.idea.LyngLanguage
|
||||||
|
|
||||||
|
class LyngFile(viewProvider: FileViewProvider) : PsiFileBase(viewProvider, LyngLanguage) {
|
||||||
|
override fun getFileType(): FileType = LyngFileType
|
||||||
|
override fun toString(): String = "Lyng File"
|
||||||
|
}
|
||||||
@@ -0,0 +1,67 @@
|
|||||||
|
/*
|
||||||
|
* Copyright 2025 Sergey S. Chernov real.sergeych@gmail.com
|
||||||
|
*
|
||||||
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
* you may not use this file except in compliance with the License.
|
||||||
|
* You may obtain a copy of the License at
|
||||||
|
*
|
||||||
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
*
|
||||||
|
* Unless required by applicable law or agreed to in writing, software
|
||||||
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
* See the License for the specific language governing permissions and
|
||||||
|
* limitations under the License.
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
package net.sergeych.lyng.idea.psi
|
||||||
|
|
||||||
|
import com.intellij.extapi.psi.ASTWrapperPsiElement
|
||||||
|
import com.intellij.lang.ASTNode
|
||||||
|
import com.intellij.lang.ParserDefinition
|
||||||
|
import com.intellij.lang.PsiBuilder
|
||||||
|
import com.intellij.lang.PsiParser
|
||||||
|
import com.intellij.lexer.Lexer
|
||||||
|
import com.intellij.openapi.project.Project
|
||||||
|
import com.intellij.psi.FileViewProvider
|
||||||
|
import com.intellij.psi.PsiElement
|
||||||
|
import com.intellij.psi.PsiFile
|
||||||
|
import com.intellij.psi.TokenType
|
||||||
|
import com.intellij.psi.tree.IFileElementType
|
||||||
|
import com.intellij.psi.tree.TokenSet
|
||||||
|
import net.sergeych.lyng.idea.LyngLanguage
|
||||||
|
import net.sergeych.lyng.idea.highlight.LyngLexer
|
||||||
|
import net.sergeych.lyng.idea.highlight.LyngTokenTypes
|
||||||
|
|
||||||
|
class LyngParserDefinition : ParserDefinition {
|
||||||
|
companion object {
|
||||||
|
val FILE: IFileElementType = IFileElementType(LyngLanguage)
|
||||||
|
private val WHITE_SPACES: TokenSet = TokenSet.create(LyngTokenTypes.WHITESPACE, TokenType.WHITE_SPACE)
|
||||||
|
private val COMMENTS: TokenSet = TokenSet.create(LyngTokenTypes.LINE_COMMENT, LyngTokenTypes.BLOCK_COMMENT)
|
||||||
|
private val STRINGS: TokenSet = TokenSet.create(LyngTokenTypes.STRING)
|
||||||
|
}
|
||||||
|
|
||||||
|
override fun createLexer(project: Project?): Lexer = LyngLexer()
|
||||||
|
|
||||||
|
override fun createParser(project: Project?): PsiParser = PsiParser { root, builder ->
|
||||||
|
val mark: PsiBuilder.Marker = builder.mark()
|
||||||
|
while (!builder.eof()) builder.advanceLexer()
|
||||||
|
mark.done(root)
|
||||||
|
builder.treeBuilt
|
||||||
|
}
|
||||||
|
|
||||||
|
override fun getFileNodeType(): IFileElementType = FILE
|
||||||
|
|
||||||
|
override fun getWhitespaceTokens(): TokenSet = WHITE_SPACES
|
||||||
|
|
||||||
|
override fun getCommentTokens(): TokenSet = COMMENTS
|
||||||
|
|
||||||
|
override fun getStringLiteralElements(): TokenSet = STRINGS
|
||||||
|
|
||||||
|
override fun createElement(node: ASTNode): PsiElement = ASTWrapperPsiElement(node)
|
||||||
|
|
||||||
|
override fun createFile(viewProvider: FileViewProvider): PsiFile = LyngFile(viewProvider)
|
||||||
|
|
||||||
|
override fun spaceExistenceTypeBetweenTokens(left: ASTNode, right: ASTNode): ParserDefinition.SpaceRequirements =
|
||||||
|
ParserDefinition.SpaceRequirements.MAY
|
||||||
|
}
|
||||||
@@ -0,0 +1,129 @@
|
|||||||
|
/*
|
||||||
|
* Copyright 2025 Sergey S. Chernov real.sergeych@gmail.com
|
||||||
|
*
|
||||||
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
* you may not use this file except in compliance with the License.
|
||||||
|
* You may obtain a copy of the License at
|
||||||
|
*
|
||||||
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
*
|
||||||
|
* Unless required by applicable law or agreed to in writing, software
|
||||||
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
* See the License for the specific language governing permissions and
|
||||||
|
* limitations under the License.
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
package net.sergeych.lyng.idea.settings
|
||||||
|
|
||||||
|
import com.intellij.openapi.components.PersistentStateComponent
|
||||||
|
import com.intellij.openapi.components.Service
|
||||||
|
import com.intellij.openapi.components.State
|
||||||
|
import com.intellij.openapi.components.Storage
|
||||||
|
import com.intellij.openapi.project.Project
|
||||||
|
|
||||||
|
@Service(Service.Level.PROJECT)
|
||||||
|
@State(name = "LyngFormatterSettings", storages = [Storage("lyng_idea.xml")])
|
||||||
|
class LyngFormatterSettings(private val project: Project) : PersistentStateComponent<LyngFormatterSettings.State> {
|
||||||
|
|
||||||
|
data class State(
|
||||||
|
var enableSpacing: Boolean = false,
|
||||||
|
var enableWrapping: Boolean = false,
|
||||||
|
var reindentClosedBlockOnEnter: Boolean = true,
|
||||||
|
var reindentPastedBlocks: Boolean = true,
|
||||||
|
var normalizeBlockCommentIndent: Boolean = false,
|
||||||
|
var spellCheckStringLiterals: Boolean = true,
|
||||||
|
// When Grazie/Natural Languages is present, prefer it for comments and literals (avoid legacy duplicates)
|
||||||
|
var preferGrazieForCommentsAndLiterals: Boolean = true,
|
||||||
|
// When Grazie is available, also check identifiers via Grazie.
|
||||||
|
// Default OFF because Grazie typically doesn't flag code identifiers; legacy Spellchecker is better for code.
|
||||||
|
var grazieChecksIdentifiers: Boolean = false,
|
||||||
|
// Grazie-only fallback: treat identifiers as comments domain so Grazie applies spelling rules
|
||||||
|
var grazieTreatIdentifiersAsComments: Boolean = true,
|
||||||
|
// Grazie-only fallback: treat string literals as comments domain when LITERALS domain is not requested
|
||||||
|
var grazieTreatLiteralsAsComments: Boolean = true,
|
||||||
|
// Debug helper: show the exact ranges we feed to Grazie/legacy as weak warnings
|
||||||
|
var debugShowSpellFeed: Boolean = false,
|
||||||
|
// Visuals: render Lyng typos using the standard Typo green underline styling
|
||||||
|
var showTyposWithGreenUnderline: Boolean = true,
|
||||||
|
// Enable lightweight quick-fixes (Replace..., Add to dictionary) without legacy Spell Checker
|
||||||
|
var offerLyngTypoQuickFixes: Boolean = true,
|
||||||
|
// Per-project learned words (do not flag again)
|
||||||
|
var learnedWords: MutableSet<String> = mutableSetOf(),
|
||||||
|
// Experimental: enable Lyng autocompletion (can be disabled if needed)
|
||||||
|
var enableLyngCompletionExperimental: Boolean = true,
|
||||||
|
)
|
||||||
|
|
||||||
|
private var myState: State = State()
|
||||||
|
|
||||||
|
override fun getState(): State = myState
|
||||||
|
|
||||||
|
override fun loadState(state: State) {
|
||||||
|
myState = state
|
||||||
|
}
|
||||||
|
|
||||||
|
var enableSpacing: Boolean
|
||||||
|
get() = myState.enableSpacing
|
||||||
|
set(value) { myState.enableSpacing = value }
|
||||||
|
|
||||||
|
var enableWrapping: Boolean
|
||||||
|
get() = myState.enableWrapping
|
||||||
|
set(value) { myState.enableWrapping = value }
|
||||||
|
|
||||||
|
var reindentClosedBlockOnEnter: Boolean
|
||||||
|
get() = myState.reindentClosedBlockOnEnter
|
||||||
|
set(value) { myState.reindentClosedBlockOnEnter = value }
|
||||||
|
|
||||||
|
var reindentPastedBlocks: Boolean
|
||||||
|
get() = myState.reindentPastedBlocks
|
||||||
|
set(value) { myState.reindentPastedBlocks = value }
|
||||||
|
|
||||||
|
var normalizeBlockCommentIndent: Boolean
|
||||||
|
get() = myState.normalizeBlockCommentIndent
|
||||||
|
set(value) { myState.normalizeBlockCommentIndent = value }
|
||||||
|
|
||||||
|
var spellCheckStringLiterals: Boolean
|
||||||
|
get() = myState.spellCheckStringLiterals
|
||||||
|
set(value) { myState.spellCheckStringLiterals = value }
|
||||||
|
|
||||||
|
var preferGrazieForCommentsAndLiterals: Boolean
|
||||||
|
get() = myState.preferGrazieForCommentsAndLiterals
|
||||||
|
set(value) { myState.preferGrazieForCommentsAndLiterals = value }
|
||||||
|
|
||||||
|
var grazieChecksIdentifiers: Boolean
|
||||||
|
get() = myState.grazieChecksIdentifiers
|
||||||
|
set(value) { myState.grazieChecksIdentifiers = value }
|
||||||
|
|
||||||
|
var grazieTreatIdentifiersAsComments: Boolean
|
||||||
|
get() = myState.grazieTreatIdentifiersAsComments
|
||||||
|
set(value) { myState.grazieTreatIdentifiersAsComments = value }
|
||||||
|
|
||||||
|
var grazieTreatLiteralsAsComments: Boolean
|
||||||
|
get() = myState.grazieTreatLiteralsAsComments
|
||||||
|
set(value) { myState.grazieTreatLiteralsAsComments = value }
|
||||||
|
|
||||||
|
var debugShowSpellFeed: Boolean
|
||||||
|
get() = myState.debugShowSpellFeed
|
||||||
|
set(value) { myState.debugShowSpellFeed = value }
|
||||||
|
|
||||||
|
var showTyposWithGreenUnderline: Boolean
|
||||||
|
get() = myState.showTyposWithGreenUnderline
|
||||||
|
set(value) { myState.showTyposWithGreenUnderline = value }
|
||||||
|
|
||||||
|
var offerLyngTypoQuickFixes: Boolean
|
||||||
|
get() = myState.offerLyngTypoQuickFixes
|
||||||
|
set(value) { myState.offerLyngTypoQuickFixes = value }
|
||||||
|
|
||||||
|
var learnedWords: MutableSet<String>
|
||||||
|
get() = myState.learnedWords
|
||||||
|
set(value) { myState.learnedWords = value }
|
||||||
|
|
||||||
|
var enableLyngCompletionExperimental: Boolean
|
||||||
|
get() = myState.enableLyngCompletionExperimental
|
||||||
|
set(value) { myState.enableLyngCompletionExperimental = value }
|
||||||
|
|
||||||
|
companion object {
|
||||||
|
@JvmStatic
|
||||||
|
fun getInstance(project: Project): LyngFormatterSettings = project.getService(LyngFormatterSettings::class.java)
|
||||||
|
}
|
||||||
|
}
|
||||||
+149
@@ -0,0 +1,149 @@
|
|||||||
|
/*
|
||||||
|
* Copyright 2025 Sergey S. Chernov real.sergeych@gmail.com
|
||||||
|
*
|
||||||
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
* you may not use this file except in compliance with the License.
|
||||||
|
* You may obtain a copy of the License at
|
||||||
|
*
|
||||||
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
*
|
||||||
|
* Unless required by applicable law or agreed to in writing, software
|
||||||
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
* See the License for the specific language governing permissions and
|
||||||
|
* limitations under the License.
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
package net.sergeych.lyng.idea.settings
|
||||||
|
|
||||||
|
import com.intellij.openapi.options.Configurable
|
||||||
|
import com.intellij.openapi.project.Project
|
||||||
|
import javax.swing.BoxLayout
|
||||||
|
import javax.swing.JCheckBox
|
||||||
|
import javax.swing.JComponent
|
||||||
|
import javax.swing.JPanel
|
||||||
|
|
||||||
|
class LyngFormatterSettingsConfigurable(private val project: Project) : Configurable {
|
||||||
|
private var panel: JPanel? = null
|
||||||
|
private var spacingCb: JCheckBox? = null
|
||||||
|
private var wrappingCb: JCheckBox? = null
|
||||||
|
private var reindentClosedBlockCb: JCheckBox? = null
|
||||||
|
private var reindentPasteCb: JCheckBox? = null
|
||||||
|
private var normalizeBlockCommentIndentCb: JCheckBox? = null
|
||||||
|
private var spellCheckLiteralsCb: JCheckBox? = null
|
||||||
|
private var preferGrazieCommentsLiteralsCb: JCheckBox? = null
|
||||||
|
private var grazieChecksIdentifiersCb: JCheckBox? = null
|
||||||
|
private var grazieIdsAsCommentsCb: JCheckBox? = null
|
||||||
|
private var grazieLiteralsAsCommentsCb: JCheckBox? = null
|
||||||
|
private var debugShowSpellFeedCb: JCheckBox? = null
|
||||||
|
private var showTyposGreenCb: JCheckBox? = null
|
||||||
|
private var offerQuickFixesCb: JCheckBox? = null
|
||||||
|
private var enableCompletionCb: JCheckBox? = null
|
||||||
|
|
||||||
|
override fun getDisplayName(): String = "Lyng Formatter"
|
||||||
|
|
||||||
|
override fun createComponent(): JComponent {
|
||||||
|
val p = JPanel()
|
||||||
|
p.layout = BoxLayout(p, BoxLayout.Y_AXIS)
|
||||||
|
spacingCb = JCheckBox("Enable spacing normalization (commas/operators/colons/keyword parens)")
|
||||||
|
wrappingCb = JCheckBox("Enable line wrapping (120 cols) [experimental]")
|
||||||
|
reindentClosedBlockCb = JCheckBox("Reindent enclosed block on Enter after '}'")
|
||||||
|
reindentPasteCb = JCheckBox("Reindent pasted blocks (align pasted code to current indent)")
|
||||||
|
normalizeBlockCommentIndentCb = JCheckBox("Normalize block comment indentation [experimental]")
|
||||||
|
spellCheckLiteralsCb = JCheckBox("Spell check string literals (skip % specifiers like %s, %d, %-12s)")
|
||||||
|
preferGrazieCommentsLiteralsCb = JCheckBox("Prefer Natural Languages/Grazie for comments and string literals (avoid duplicates)")
|
||||||
|
grazieChecksIdentifiersCb = JCheckBox("Check identifiers via Natural Languages/Grazie when available")
|
||||||
|
grazieIdsAsCommentsCb = JCheckBox("Natural Languages/Grazie: treat identifiers as comments (forces spelling checks in 2024.3)")
|
||||||
|
grazieLiteralsAsCommentsCb = JCheckBox("Natural Languages/Grazie: treat string literals as comments when literals are not processed")
|
||||||
|
debugShowSpellFeedCb = JCheckBox("Debug: show spell-feed ranges (weak warnings)")
|
||||||
|
showTyposGreenCb = JCheckBox("Show Lyng typos with green underline (TYPO styling)")
|
||||||
|
offerQuickFixesCb = JCheckBox("Offer Lyng typo quick fixes (Replace…, Add to dictionary) without Spell Checker")
|
||||||
|
enableCompletionCb = JCheckBox("Enable Lyng autocompletion (experimental)")
|
||||||
|
|
||||||
|
// Tooltips / short help
|
||||||
|
spacingCb?.toolTipText = "Applies minimal, safe spacing (e.g., around commas/operators, control-flow parens)."
|
||||||
|
wrappingCb?.toolTipText = "Experimental: wrap long argument lists to keep lines under ~120 columns."
|
||||||
|
reindentClosedBlockCb?.toolTipText = "On Enter after a closing '}', reindent the just-closed {…} block using formatter rules."
|
||||||
|
reindentPasteCb?.toolTipText = "When caret is in leading whitespace, reindent the pasted text and align it to the caret's indent."
|
||||||
|
normalizeBlockCommentIndentCb?.toolTipText = "Experimental: normalize indentation inside /* … */ comments (code is not modified)."
|
||||||
|
preferGrazieCommentsLiteralsCb?.toolTipText = "When ON and Natural Languages/Grazie is installed, comments and string literals are checked by Grazie. Turn OFF to force legacy Spellchecker to check them."
|
||||||
|
grazieChecksIdentifiersCb?.toolTipText = "When ON and Natural Languages/Grazie is installed, identifiers (non-keywords) are checked by Grazie too."
|
||||||
|
grazieIdsAsCommentsCb?.toolTipText = "Grazie-only fallback: route identifiers as COMMENTS domain so Grazie applies spelling in 2024.3."
|
||||||
|
grazieLiteralsAsCommentsCb?.toolTipText = "Grazie-only fallback: when Grammar doesn't process literals, route strings as COMMENTS so they are checked."
|
||||||
|
debugShowSpellFeedCb?.toolTipText = "Show the exact ranges we feed to spellcheckers (ids/comments/strings) as weak warnings."
|
||||||
|
showTyposGreenCb?.toolTipText = "Render Lyng typos using the platform's green TYPO underline instead of generic warnings."
|
||||||
|
offerQuickFixesCb?.toolTipText = "Provide lightweight Replace… and Add to dictionary quick-fixes without requiring the legacy Spell Checker."
|
||||||
|
enableCompletionCb?.toolTipText = "Turn on/off the lightweight Lyng code completion (BASIC)."
|
||||||
|
p.add(spacingCb)
|
||||||
|
p.add(wrappingCb)
|
||||||
|
p.add(reindentClosedBlockCb)
|
||||||
|
p.add(reindentPasteCb)
|
||||||
|
p.add(normalizeBlockCommentIndentCb)
|
||||||
|
p.add(spellCheckLiteralsCb)
|
||||||
|
p.add(preferGrazieCommentsLiteralsCb)
|
||||||
|
p.add(grazieChecksIdentifiersCb)
|
||||||
|
p.add(grazieIdsAsCommentsCb)
|
||||||
|
p.add(grazieLiteralsAsCommentsCb)
|
||||||
|
p.add(debugShowSpellFeedCb)
|
||||||
|
p.add(showTyposGreenCb)
|
||||||
|
p.add(offerQuickFixesCb)
|
||||||
|
p.add(enableCompletionCb)
|
||||||
|
panel = p
|
||||||
|
reset()
|
||||||
|
return p
|
||||||
|
}
|
||||||
|
|
||||||
|
override fun isModified(): Boolean {
|
||||||
|
val s = LyngFormatterSettings.getInstance(project)
|
||||||
|
return spacingCb?.isSelected != s.enableSpacing ||
|
||||||
|
wrappingCb?.isSelected != s.enableWrapping ||
|
||||||
|
reindentClosedBlockCb?.isSelected != s.reindentClosedBlockOnEnter ||
|
||||||
|
reindentPasteCb?.isSelected != s.reindentPastedBlocks ||
|
||||||
|
normalizeBlockCommentIndentCb?.isSelected != s.normalizeBlockCommentIndent ||
|
||||||
|
spellCheckLiteralsCb?.isSelected != s.spellCheckStringLiterals ||
|
||||||
|
preferGrazieCommentsLiteralsCb?.isSelected != s.preferGrazieForCommentsAndLiterals ||
|
||||||
|
grazieChecksIdentifiersCb?.isSelected != s.grazieChecksIdentifiers ||
|
||||||
|
grazieIdsAsCommentsCb?.isSelected != s.grazieTreatIdentifiersAsComments ||
|
||||||
|
grazieLiteralsAsCommentsCb?.isSelected != s.grazieTreatLiteralsAsComments ||
|
||||||
|
debugShowSpellFeedCb?.isSelected != s.debugShowSpellFeed ||
|
||||||
|
showTyposGreenCb?.isSelected != s.showTyposWithGreenUnderline ||
|
||||||
|
offerQuickFixesCb?.isSelected != s.offerLyngTypoQuickFixes ||
|
||||||
|
enableCompletionCb?.isSelected != s.enableLyngCompletionExperimental
|
||||||
|
}
|
||||||
|
|
||||||
|
override fun apply() {
|
||||||
|
val s = LyngFormatterSettings.getInstance(project)
|
||||||
|
s.enableSpacing = spacingCb?.isSelected == true
|
||||||
|
s.enableWrapping = wrappingCb?.isSelected == true
|
||||||
|
s.reindentClosedBlockOnEnter = reindentClosedBlockCb?.isSelected == true
|
||||||
|
s.reindentPastedBlocks = reindentPasteCb?.isSelected == true
|
||||||
|
s.normalizeBlockCommentIndent = normalizeBlockCommentIndentCb?.isSelected == true
|
||||||
|
s.spellCheckStringLiterals = spellCheckLiteralsCb?.isSelected == true
|
||||||
|
s.preferGrazieForCommentsAndLiterals = preferGrazieCommentsLiteralsCb?.isSelected == true
|
||||||
|
s.grazieChecksIdentifiers = grazieChecksIdentifiersCb?.isSelected == true
|
||||||
|
s.grazieTreatIdentifiersAsComments = grazieIdsAsCommentsCb?.isSelected == true
|
||||||
|
s.grazieTreatLiteralsAsComments = grazieLiteralsAsCommentsCb?.isSelected == true
|
||||||
|
s.debugShowSpellFeed = debugShowSpellFeedCb?.isSelected == true
|
||||||
|
s.showTyposWithGreenUnderline = showTyposGreenCb?.isSelected == true
|
||||||
|
s.offerLyngTypoQuickFixes = offerQuickFixesCb?.isSelected == true
|
||||||
|
s.enableLyngCompletionExperimental = enableCompletionCb?.isSelected == true
|
||||||
|
}
|
||||||
|
|
||||||
|
override fun reset() {
|
||||||
|
val s = LyngFormatterSettings.getInstance(project)
|
||||||
|
spacingCb?.isSelected = s.enableSpacing
|
||||||
|
wrappingCb?.isSelected = s.enableWrapping
|
||||||
|
reindentClosedBlockCb?.isSelected = s.reindentClosedBlockOnEnter
|
||||||
|
reindentPasteCb?.isSelected = s.reindentPastedBlocks
|
||||||
|
normalizeBlockCommentIndentCb?.isSelected = s.normalizeBlockCommentIndent
|
||||||
|
spellCheckLiteralsCb?.isSelected = s.spellCheckStringLiterals
|
||||||
|
preferGrazieCommentsLiteralsCb?.isSelected = s.preferGrazieForCommentsAndLiterals
|
||||||
|
grazieChecksIdentifiersCb?.isSelected = s.grazieChecksIdentifiers
|
||||||
|
grazieIdsAsCommentsCb?.isSelected = s.grazieTreatIdentifiersAsComments
|
||||||
|
grazieLiteralsAsCommentsCb?.isSelected = s.grazieTreatLiteralsAsComments
|
||||||
|
debugShowSpellFeedCb?.isSelected = s.debugShowSpellFeed
|
||||||
|
showTyposGreenCb?.isSelected = s.showTyposWithGreenUnderline
|
||||||
|
offerQuickFixesCb?.isSelected = s.offerLyngTypoQuickFixes
|
||||||
|
enableCompletionCb?.isSelected = s.enableLyngCompletionExperimental
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,50 @@
|
|||||||
|
/*
|
||||||
|
* Copyright 2025 Sergey S. Chernov real.sergeych@gmail.com
|
||||||
|
*
|
||||||
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
* you may not use this file except in compliance with the License.
|
||||||
|
* You may obtain a copy of the License at
|
||||||
|
*
|
||||||
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
*
|
||||||
|
* Unless required by applicable law or agreed to in writing, software
|
||||||
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
* See the License for the specific language governing permissions and
|
||||||
|
* limitations under the License.
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
package net.sergeych.lyng.idea.spell
|
||||||
|
|
||||||
|
import com.intellij.openapi.diagnostic.Logger
|
||||||
|
import com.intellij.openapi.util.Key
|
||||||
|
import com.intellij.openapi.util.TextRange
|
||||||
|
import com.intellij.psi.PsiFile
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Per-file cached spellcheck index built from MiniAst-based highlighting and the lynglib highlighter.
|
||||||
|
* It exposes identifier, comment, and string literal ranges. Strategies should suspend until data is ready.
|
||||||
|
*/
|
||||||
|
object LyngSpellIndex {
|
||||||
|
private val LOG = Logger.getInstance(LyngSpellIndex::class.java)
|
||||||
|
|
||||||
|
data class Data(
|
||||||
|
val modStamp: Long,
|
||||||
|
val identifiers: List<TextRange>,
|
||||||
|
val comments: List<TextRange>,
|
||||||
|
val strings: List<TextRange>,
|
||||||
|
)
|
||||||
|
|
||||||
|
private val KEY: Key<Data> = Key.create("LYNG_SPELL_INDEX")
|
||||||
|
|
||||||
|
fun getUpToDate(file: PsiFile): Data? {
|
||||||
|
val doc = file.viewProvider.document ?: return null
|
||||||
|
val d = file.getUserData(KEY) ?: return null
|
||||||
|
return if (d.modStamp == doc.modificationStamp) d else null
|
||||||
|
}
|
||||||
|
|
||||||
|
fun store(file: PsiFile, data: Data) {
|
||||||
|
file.putUserData(KEY, data)
|
||||||
|
LOG.info("LyngSpellIndex built: ids=${data.identifiers.size}, comments=${data.comments.size}, strings=${data.strings.size}")
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,155 @@
|
|||||||
|
/*
|
||||||
|
* Copyright 2025 Sergey S. Chernov real.sergeych@gmail.com
|
||||||
|
*
|
||||||
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
* you may not use this file except in compliance with the License.
|
||||||
|
* You may obtain a copy of the License at
|
||||||
|
*
|
||||||
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
*
|
||||||
|
* Unless required by applicable law or agreed to in writing, software
|
||||||
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
* See the License for the specific language governing permissions and
|
||||||
|
* limitations under the License.
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
package net.sergeych.lyng.idea.spell
|
||||||
|
|
||||||
|
// Avoid Tokenizers helper to keep compatibility; implement our own tokenizers
|
||||||
|
import com.intellij.ide.plugins.PluginManagerCore
|
||||||
|
import com.intellij.openapi.diagnostic.Logger
|
||||||
|
import com.intellij.openapi.extensions.PluginId
|
||||||
|
import com.intellij.openapi.util.TextRange
|
||||||
|
import com.intellij.psi.PsiElement
|
||||||
|
import com.intellij.spellchecker.inspections.PlainTextSplitter
|
||||||
|
import com.intellij.spellchecker.tokenizer.SpellcheckingStrategy
|
||||||
|
import com.intellij.spellchecker.tokenizer.TokenConsumer
|
||||||
|
import com.intellij.spellchecker.tokenizer.Tokenizer
|
||||||
|
import net.sergeych.lyng.idea.settings.LyngFormatterSettings
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Spellchecking strategy for Lyng:
|
||||||
|
* - Identifiers: checked as identifiers
|
||||||
|
* - Comments: checked as plain text
|
||||||
|
* - Keywords: skipped
|
||||||
|
* - String literals: optional (controlled by settings), and we exclude printf-style format specifiers like
|
||||||
|
* %s, %d, %-12s, %0.2f, etc.
|
||||||
|
*/
|
||||||
|
class LyngSpellcheckingStrategy : SpellcheckingStrategy() {
|
||||||
|
|
||||||
|
private val log = Logger.getInstance(LyngSpellcheckingStrategy::class.java)
|
||||||
|
@Volatile private var loggedOnce = false
|
||||||
|
|
||||||
|
private fun grazieInstalled(): Boolean {
|
||||||
|
// Support both historical and bundled IDs
|
||||||
|
return PluginManagerCore.isPluginInstalled(PluginId.getId("com.intellij.grazie")) ||
|
||||||
|
PluginManagerCore.isPluginInstalled(PluginId.getId("tanvd.grazi"))
|
||||||
|
}
|
||||||
|
|
||||||
|
private fun grazieApiAvailable(): Boolean = try {
|
||||||
|
// If this class is absent (as in IC-243), third-party plugins can't run Grazie programmatically
|
||||||
|
Class.forName("com.intellij.grazie.grammar.GrammarChecker")
|
||||||
|
true
|
||||||
|
} catch (_: Throwable) { false }
|
||||||
|
|
||||||
|
override fun getTokenizer(element: PsiElement): Tokenizer<*> {
|
||||||
|
val hasGrazie = grazieInstalled()
|
||||||
|
val hasGrazieApi = grazieApiAvailable()
|
||||||
|
val settings = LyngFormatterSettings.getInstance(element.project)
|
||||||
|
if (!loggedOnce) {
|
||||||
|
loggedOnce = true
|
||||||
|
log.info("LyngSpellcheckingStrategy activated: hasGrazie=$hasGrazie, grazieApi=$hasGrazieApi, preferGrazieForCommentsAndLiterals=${settings.preferGrazieForCommentsAndLiterals}, spellCheckStringLiterals=${settings.spellCheckStringLiterals}, grazieChecksIdentifiers=${settings.grazieChecksIdentifiers}")
|
||||||
|
}
|
||||||
|
|
||||||
|
val file = element.containingFile ?: return EMPTY_TOKENIZER
|
||||||
|
val index = LyngSpellIndex.getUpToDate(file) ?: run {
|
||||||
|
// Suspend legacy spellcheck until MiniAst-based index is ready
|
||||||
|
return EMPTY_TOKENIZER
|
||||||
|
}
|
||||||
|
val elRange = element.textRange ?: return EMPTY_TOKENIZER
|
||||||
|
|
||||||
|
fun overlaps(list: List<TextRange>) = list.any { it.intersects(elRange) }
|
||||||
|
|
||||||
|
// Decide responsibility per settings
|
||||||
|
// If Grazie is present but its public API is not available (IC-243), do NOT delegate to it.
|
||||||
|
val preferGrazie = hasGrazie && hasGrazieApi && settings.preferGrazieForCommentsAndLiterals
|
||||||
|
val grazieIds = hasGrazie && hasGrazieApi && settings.grazieChecksIdentifiers
|
||||||
|
|
||||||
|
// Identifiers: only if range is within identifiers index and not delegated to Grazie
|
||||||
|
if (overlaps(index.identifiers) && !grazieIds) return IDENTIFIER_TOKENIZER
|
||||||
|
|
||||||
|
// Comments: only if not delegated to Grazie and overlapping indexed comments
|
||||||
|
if (!preferGrazie && overlaps(index.comments)) return COMMENT_TEXT_TOKENIZER
|
||||||
|
|
||||||
|
// Strings: only if not delegated to Grazie, literals checking enabled, and overlapping indexed strings
|
||||||
|
if (!preferGrazie && settings.spellCheckStringLiterals && overlaps(index.strings)) return STRING_WITH_PRINTF_EXCLUDES
|
||||||
|
|
||||||
|
return EMPTY_TOKENIZER
|
||||||
|
}
|
||||||
|
|
||||||
|
private object EMPTY_TOKENIZER : Tokenizer<PsiElement>() {
|
||||||
|
override fun tokenize(element: PsiElement, consumer: TokenConsumer) {}
|
||||||
|
}
|
||||||
|
|
||||||
|
private object IDENTIFIER_TOKENIZER : Tokenizer<PsiElement>() {
|
||||||
|
private val splitter = PlainTextSplitter.getInstance()
|
||||||
|
override fun tokenize(element: PsiElement, consumer: TokenConsumer) {
|
||||||
|
val text = element.text
|
||||||
|
if (text.isNullOrEmpty()) return
|
||||||
|
consumer.consumeToken(element, text, false, 0, TextRange(0, text.length), splitter)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
private object COMMENT_TEXT_TOKENIZER : Tokenizer<PsiElement>() {
|
||||||
|
private val splitter = PlainTextSplitter.getInstance()
|
||||||
|
override fun tokenize(element: PsiElement, consumer: TokenConsumer) {
|
||||||
|
val text = element.text
|
||||||
|
if (text.isNullOrEmpty()) return
|
||||||
|
consumer.consumeToken(element, text, false, 0, TextRange(0, text.length), splitter)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
private object STRING_WITH_PRINTF_EXCLUDES : Tokenizer<PsiElement>() {
|
||||||
|
private val splitter = PlainTextSplitter.getInstance()
|
||||||
|
|
||||||
|
// Regex for printf-style specifiers: %[flags][width][.precision][length]type
|
||||||
|
// This is intentionally permissive to skip common cases like %s, %d, %-12s, %08x, %.2f, %%
|
||||||
|
private val SPEC = Regex("%(?:[-+ #0]*(?:\\d+)?(?:\\.\\d+)?[a-zA-Z%])")
|
||||||
|
|
||||||
|
override fun tokenize(element: PsiElement, consumer: TokenConsumer) {
|
||||||
|
// Check project settings whether literals should be spell-checked
|
||||||
|
val settings = LyngFormatterSettings.getInstance(element.project)
|
||||||
|
if (!settings.spellCheckStringLiterals) return
|
||||||
|
|
||||||
|
val text = element.text
|
||||||
|
if (text.isEmpty()) return
|
||||||
|
|
||||||
|
// Try to strip surrounding quotes (simple lexer token for Lyng strings)
|
||||||
|
var startOffsetInElement = 0
|
||||||
|
var endOffsetInElement = text.length
|
||||||
|
if (text.length >= 2 && (text.first() == '"' && text.last() == '"' || text.first() == '\'' && text.last() == '\'')) {
|
||||||
|
startOffsetInElement = 1
|
||||||
|
endOffsetInElement = text.length - 1
|
||||||
|
}
|
||||||
|
if (endOffsetInElement <= startOffsetInElement) return
|
||||||
|
|
||||||
|
val content = text.substring(startOffsetInElement, endOffsetInElement)
|
||||||
|
|
||||||
|
var last = 0
|
||||||
|
for (m in SPEC.findAll(content)) {
|
||||||
|
val ms = m.range.first
|
||||||
|
val me = m.range.last + 1
|
||||||
|
if (ms > last) {
|
||||||
|
val range = TextRange(startOffsetInElement + last, startOffsetInElement + ms)
|
||||||
|
consumer.consumeToken(element, text, false, 0, range, splitter)
|
||||||
|
}
|
||||||
|
last = me
|
||||||
|
}
|
||||||
|
if (last < content.length) {
|
||||||
|
val range = TextRange(startOffsetInElement + last, startOffsetInElement + content.length)
|
||||||
|
consumer.consumeToken(element, text, false, 0, range, splitter)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,44 @@
|
|||||||
|
/*
|
||||||
|
* Ensure external/bundled docs are registered in BuiltinDocRegistry
|
||||||
|
* so completion/quickdoc can resolve things like lyng.io.fs.Path.
|
||||||
|
*/
|
||||||
|
package net.sergeych.lyng.idea.util
|
||||||
|
|
||||||
|
import com.intellij.openapi.diagnostic.Logger
|
||||||
|
import net.sergeych.lyng.idea.docs.FsDocsFallback
|
||||||
|
|
||||||
|
object DocsBootstrap {
|
||||||
|
private val log = Logger.getInstance(DocsBootstrap::class.java)
|
||||||
|
@Volatile private var ensured = false
|
||||||
|
|
||||||
|
fun ensure() {
|
||||||
|
if (ensured) return
|
||||||
|
synchronized(this) {
|
||||||
|
if (ensured) return
|
||||||
|
val loaded = tryLoadExternal() || trySeedFallback()
|
||||||
|
if (loaded) ensured = true else ensured = true // mark done to avoid repeated attempts
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
private fun tryLoadExternal(): Boolean = try {
|
||||||
|
val cls = Class.forName("net.sergeych.lyngio.docs.FsBuiltinDocs")
|
||||||
|
val m = cls.getMethod("ensure")
|
||||||
|
m.invoke(null)
|
||||||
|
log.info("[LYNG_DEBUG] DocsBootstrap: external docs loaded: net.sergeych.lyngio.docs.FsBuiltinDocs.ensure() OK")
|
||||||
|
true
|
||||||
|
} catch (_: Throwable) {
|
||||||
|
false
|
||||||
|
}
|
||||||
|
|
||||||
|
private fun trySeedFallback(): Boolean = try {
|
||||||
|
val seeded = FsDocsFallback.ensureOnce()
|
||||||
|
if (seeded) {
|
||||||
|
log.info("[LYNG_DEBUG] DocsBootstrap: external docs not found; seeded plugin fallback for lyng.io.fs")
|
||||||
|
} else {
|
||||||
|
log.info("[LYNG_DEBUG] DocsBootstrap: external docs not found; no fallback seeded")
|
||||||
|
}
|
||||||
|
seeded
|
||||||
|
} catch (_: Throwable) {
|
||||||
|
false
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,62 @@
|
|||||||
|
/*
|
||||||
|
* Copyright 2026 Sergey S. Chernov real.sergeych@gmail.com
|
||||||
|
*
|
||||||
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
* you may not use this file except in compliance with the License.
|
||||||
|
* You may obtain a copy of the License at
|
||||||
|
*
|
||||||
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
*
|
||||||
|
* Unless required by applicable law or agreed to in writing, software
|
||||||
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
* See the License for the specific language governing permissions and
|
||||||
|
* limitations under the License.
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
|
package net.sergeych.lyng.idea.util
|
||||||
|
|
||||||
|
import com.intellij.application.options.CodeStyle
|
||||||
|
import com.intellij.openapi.editor.Document
|
||||||
|
import com.intellij.openapi.project.Project
|
||||||
|
import com.intellij.openapi.util.TextRange
|
||||||
|
import net.sergeych.lyng.format.LyngFormatConfig
|
||||||
|
import net.sergeych.lyng.format.LyngFormatter
|
||||||
|
|
||||||
|
object FormattingUtils {
|
||||||
|
fun computeDesiredIndent(project: Project, doc: Document, line: Int): String {
|
||||||
|
val options = CodeStyle.getIndentOptions(project, doc)
|
||||||
|
val start = 0
|
||||||
|
val end = doc.getLineEndOffset(line)
|
||||||
|
val snippet = doc.getText(TextRange(start, end))
|
||||||
|
val lineText = if (line < doc.lineCount) {
|
||||||
|
val ls = doc.getLineStartOffset(line)
|
||||||
|
val le = doc.getLineEndOffset(line)
|
||||||
|
doc.getText(TextRange(ls, le))
|
||||||
|
} else ""
|
||||||
|
val isBlankLine = lineText.trim().isEmpty()
|
||||||
|
val snippetForCalc = if (isBlankLine) snippet + "x" else snippet
|
||||||
|
val cfg = LyngFormatConfig(
|
||||||
|
indentSize = options.INDENT_SIZE.coerceAtLeast(1),
|
||||||
|
useTabs = options.USE_TAB_CHARACTER,
|
||||||
|
continuationIndentSize = options.CONTINUATION_INDENT_SIZE.coerceAtLeast(options.INDENT_SIZE.coerceAtLeast(1)),
|
||||||
|
)
|
||||||
|
val formatted = LyngFormatter.reindent(snippetForCalc, cfg)
|
||||||
|
val lastNl = formatted.lastIndexOf('\n')
|
||||||
|
val lastLine = if (lastNl >= 0) formatted.substring(lastNl + 1) else formatted
|
||||||
|
val wsLen = lastLine.indexOfFirst { it != ' ' && it != '\t' }.let { if (it < 0) lastLine.length else it }
|
||||||
|
return lastLine.substring(0, wsLen)
|
||||||
|
}
|
||||||
|
|
||||||
|
fun findFirstNonWs(doc: Document, start: Int, end: Int): Int {
|
||||||
|
var i = start
|
||||||
|
val text = doc.charsSequence
|
||||||
|
while (i < end) {
|
||||||
|
val ch = text[i]
|
||||||
|
if (ch != ' ' && ch != '\t') break
|
||||||
|
i++
|
||||||
|
}
|
||||||
|
return i
|
||||||
|
}
|
||||||
|
}
|
||||||
Loaded 100 of 247 files, more files were not shown because too many files have changed in this diff.
Show more
Reference in new issue
Block a user