Compare commits
76
Commits
0.9.3
..
c63d643469
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
c63d643469 | ||
|
|
f592689631 | ||
|
|
834f3118c8 | ||
|
|
d285335e1c | ||
|
|
2e17297355 | ||
|
|
fbea13570e | ||
|
|
067970b80c | ||
|
|
c52e132dcc | ||
|
|
53f00e6c6c | ||
|
|
ec49bbbf52 | ||
|
|
06e8e1579d | ||
|
|
9c342c5c72 | ||
|
|
59055ace8c | ||
|
|
2005f405e4 | ||
|
|
062f344676 | ||
|
|
438e48959e | ||
|
|
41746f22e5 | ||
|
|
e584c7aa63 | ||
|
|
26ddb94f5d | ||
|
|
cbca8cacb5 | ||
|
|
8fae4709ed | ||
|
|
d118d29429 | ||
|
|
cb9df79ce3 | ||
|
|
d9a26dd467 | ||
|
|
813ebebddd | ||
|
|
2d721101dd | ||
|
|
d6e6d68b18 | ||
|
|
83825a9272 | ||
|
|
f0fc7ddd84 | ||
|
|
ea0ecb1db3 | ||
|
|
28b961d339 | ||
|
|
4d1cd491e0 | ||
|
|
5fbb1d5393 | ||
|
|
9a4131ee3d | ||
|
|
391e200f19 | ||
|
|
32e739ab8f | ||
|
|
f4375ad627 | ||
|
|
faead76688 | ||
|
|
72c6dc2bde | ||
|
|
a229f227e1 | ||
|
|
01632dc6d7 | ||
|
|
4e37d0be26 | ||
|
|
fa3fda144b | ||
|
|
2b320ab52a | ||
|
|
f1e978599c | ||
|
|
215c7245a0 | ||
|
|
d307ed2a04 | ||
|
|
b82af3dceb | ||
|
|
1fadc42414 | ||
|
|
918534afb5 | ||
|
|
646a676b3e | ||
|
|
f4d1a77496 | ||
|
|
67e4d76f59 | ||
|
|
beb462fd62 | ||
|
|
88f035beb6 | ||
|
|
41657b3558 | ||
|
|
1e6dd89778 | ||
|
|
6eabcc315f | ||
|
|
aeeec2d417 | ||
|
|
882df67909 | ||
|
|
0798bbee9b | ||
|
|
5df923920c | ||
|
|
76d89b43db | ||
|
|
852383e3b1 | ||
|
|
28e8648794 | ||
|
|
d2a930c0e8 | ||
|
|
0eea73c118 | ||
|
|
fdb056e78e | ||
|
|
dc3000e9f7 | ||
|
|
e8f0846840 | ||
|
|
2af5852d44 | ||
|
|
38c1b3c209 | ||
|
|
029fde2883 | ||
|
|
1498140892 | ||
|
|
0b9e94c6e9 | ||
|
|
6ca3e4589e |
No files matched your search
@@ -0,0 +1 @@
|
||||
*.zip filter=lfs diff=lfs merge=lfs -text
|
||||
@@ -15,3 +15,4 @@ xcuserdata
|
||||
/kotlin-js-store/yarn.lock
|
||||
/test.lyng
|
||||
/sample_texts/1.txt.gz
|
||||
/kotlin-js-store/wasm/yarn.lock
|
||||
@@ -0,0 +1,24 @@
|
||||
<component name="ProjectRunConfigurationManager">
|
||||
<configuration default="false" name="lyng:site [jsBrowserDevelopmentRun]" type="GradleRunConfiguration" factoryName="Gradle">
|
||||
<ExternalSystemSettings>
|
||||
<option name="executionName" />
|
||||
<option name="externalProjectPath" value="$PROJECT_DIR$/site" />
|
||||
<option name="externalSystemIdString" value="GRADLE" />
|
||||
<option name="scriptParameters" value="--continuous" />
|
||||
<option name="taskDescriptions">
|
||||
<list />
|
||||
</option>
|
||||
<option name="taskNames">
|
||||
<list>
|
||||
<option value="jsBrowserDevelopmentRun" />
|
||||
</list>
|
||||
</option>
|
||||
<option name="vmOptions" />
|
||||
</ExternalSystemSettings>
|
||||
<ExternalSystemDebugServerProcess>true</ExternalSystemDebugServerProcess>
|
||||
<ExternalSystemReattachDebugProcess>true</ExternalSystemReattachDebugProcess>
|
||||
<DebugAllEnabled>false</DebugAllEnabled>
|
||||
<RunAsTest>false</RunAsTest>
|
||||
<method v="2" />
|
||||
</configuration>
|
||||
</component>
|
||||
@@ -0,0 +1,45 @@
|
||||
## Changelog
|
||||
|
||||
### Unreleased
|
||||
|
||||
- Language: Named arguments and named splats
|
||||
- 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.
|
||||
- Trailing-lambda interaction: if the last parameter is already assigned by name (or via a named splat), a trailing `{ ... }` block is illegal.
|
||||
- Named splats: `...` can now expand a Map into named arguments.
|
||||
- Only string keys are allowed; non-string keys raise a clear error.
|
||||
- Duplicate assignment across named args and named splats is an error.
|
||||
- Ellipsis (variadic) parameters remain positional-only and cannot be named.
|
||||
- Rationale: `=` is assignment and an expression in Lyng; `:` at call sites avoids ambiguity. Declarations keep `name: Type`; call-site casts continue to use `as` / `as?`.
|
||||
- Documentation updated: proposals and declaring-arguments sections now cover named args/splats and error cases.
|
||||
- Tests added covering success cases and errors for named args/splats and trailing-lambda interactions.
|
||||
|
||||
- Tooling: Highlighters and TextMate bundle updated for named args
|
||||
- Website/editor highlighter (lyngweb + site) works with `name: value` and `...Map("k" => v)`; added JS tests covering punctuation/operator spans for `:` and `...`.
|
||||
- TextMate grammar updated to recognize named call arguments: `name: value` after `(` or `,` with `name` highlighted as `variable.parameter.named.lyng` and `:` as punctuation; excludes `::`.
|
||||
- TextMate bundle version bumped to 0.0.3; README updated with details and guidance.
|
||||
|
||||
- Multiple Inheritance (MI) completed and enabled by default:
|
||||
- Active C3 Method Resolution Order (MRO) for deterministic, monotonic lookup across complex hierarchies and diamonds.
|
||||
- Qualified dispatch:
|
||||
- `this@Type.member(...)` inside class bodies starts lookup at the specified ancestor.
|
||||
- Cast-based disambiguation: `(expr as Type).member(...)`, `(expr as? Type)?.member(...)` (works with existing safe-call `?.`).
|
||||
- Field inheritance (`val`/`var`) under MI:
|
||||
- Instance storage is disambiguated per declaring class; unqualified read/write resolves to the first match in MRO.
|
||||
- Qualified read/write targets the chosen ancestor’s storage.
|
||||
- Constructors and initialization:
|
||||
- Direct bases are initialized left-to-right; each ancestor is initialized at most once (diamond-safe de-duplication).
|
||||
- Header-specified constructor arguments are passed to direct bases.
|
||||
- Visibility enforcement under MI:
|
||||
- `private` visible only inside the declaring class body.
|
||||
- `protected` visible inside the declaring class and any of its transitive subclasses; unrelated contexts cannot access it (qualification/casts do not bypass).
|
||||
- Diagnostics improvements:
|
||||
- Missing member/field messages include receiver class and linearization order; hints for `this@Type` or casts when helpful.
|
||||
- Invalid `this@Type` reports that the qualifier is not an ancestor and shows the receiver lineage.
|
||||
- `as`/`as?` cast errors include actual and target type names.
|
||||
|
||||
- Documentation updated (docs/OOP.md and tutorial quick-start) to reflect MI with active C3 MRO.
|
||||
|
||||
Notes:
|
||||
- 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.
|
||||
@@ -1,6 +1,6 @@
|
||||
# Lyng: modern scripting for kotlin multiplatform
|
||||
|
||||
A KMP library and a standalone interpreter
|
||||
Please visit the project homepage: [https://lynglang.com](https://lynglang.com) and a [telegram channel](https://t.me/lynglang) for updates.
|
||||
|
||||
- simple, compact, intuitive and elegant modern code:
|
||||
|
||||
@@ -37,8 +37,10 @@ and it is multithreaded on platforms supporting it (automatically, no code chang
|
||||
|
||||
## Resources:
|
||||
|
||||
- [Language home](https://lynglang.com)
|
||||
- [introduction and tutorial](docs/tutorial.md) - start here please
|
||||
- [Samples directory](docs/samples)
|
||||
- [Formatter (core + CLI + IDE)](docs/formatter.md)
|
||||
- [Books directory](docs)
|
||||
|
||||
## Integration in Kotlin multiplatform
|
||||
@@ -134,21 +136,8 @@ Designed to add scripting to kotlin multiplatform application in easy and effici
|
||||
|
||||
# Language Roadmap
|
||||
|
||||
```mermaid
|
||||
flowchart
|
||||
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"
|
||||
|
||||
Planned autumn 2025. Complete dynamic language with sufficient standard library:
|
||||
We are now at **v1.0**: basic optimization performed, battery included: standard library is 90% here, initial
|
||||
support in HTML, popular editors, and IDEA; tools to syntax highlight and format code are ready. It was released closed to schedule.
|
||||
|
||||
Ready features:
|
||||
|
||||
@@ -171,31 +160,33 @@ Ready features:
|
||||
- [x] dynamic fields
|
||||
- [x] function annotations
|
||||
- [x] better stack reporting
|
||||
- [x] regular exceptions + extended `when`
|
||||
- [x] multiple inheritance for user classes
|
||||
|
||||
### Under way:
|
||||
|
||||
- [ ] regular exceptions + extended `when`
|
||||
- [ ] multiple inheritance for user classes
|
||||
- [ ] site with integrated interpreter to give a try
|
||||
- [ ] kotlin part public API good docs, integration focused
|
||||
|
||||
## plan: v1.0 - v1.5 "Rich and stable"
|
||||
|
||||
Estimated spring of 2026
|
||||
|
||||
Planned features.
|
||||
## plan: towards v1.5 Enhancing
|
||||
|
||||
- [x] site with integrated interpreter to give a try
|
||||
- [x] kotlin part public API good docs, integration focused
|
||||
- [ ] 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
|
||||
- [ ] metadata first class access from lyng
|
||||
- [x] aggressive optimizations
|
||||
- [ ] compile to JVM bytecode optimization
|
||||
|
||||
## After 1.5 "Ideal scripting"
|
||||
|
||||
Estimated winter 2027
|
||||
Estimated summer 2026
|
||||
|
||||
- [ ] client with GUI support based on compose multiplatform somehow
|
||||
- [ ] notebook - style workbooks with graphs, formulae, etc.
|
||||
- [ ] aggressive optimizations
|
||||
- propose your feature!
|
||||
|
||||
## 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
|
||||
Executable
+167
@@ -0,0 +1,167 @@
|
||||
#!/bin/bash
|
||||
|
||||
#
|
||||
# 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.
|
||||
#
|
||||
#
|
||||
|
||||
function checkState() {
|
||||
if [[ $? != 0 ]]; then
|
||||
echo
|
||||
echo -- rsync failed. deploy was not finished. deployed version has not been affected
|
||||
echo
|
||||
exit 100
|
||||
fi
|
||||
|
||||
}
|
||||
|
||||
# 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
|
||||
case "com" in
|
||||
com)
|
||||
SSH_HOST=sergeych@lynglang.com # host to deploy to
|
||||
SSH_PORT=22 # ssh port on it
|
||||
ROOT=/bigstore/sergeych_pub/lyng # directory to rsync to
|
||||
;;
|
||||
# com)
|
||||
# SSH_HOST=vvk@front-01.neurodatalab.com
|
||||
# ROOT=/home/vvk
|
||||
# ;;
|
||||
*)
|
||||
echo "*** ERROR: target not specified (use deploy com | dev)"
|
||||
echo "*** stop"
|
||||
exit 101
|
||||
esac
|
||||
|
||||
die() { echo "ERROR: $*" 1>&2 ; exit 1; }
|
||||
|
||||
# Update the IDEA plugin download link in docs (temporarily), then build, then restore the doc
|
||||
updateIdeaPluginDownloadLink || echo "WARN: proceeding without updating IDEA plugin download link"
|
||||
|
||||
./gradlew site:clean 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 -- build failed. deploy aborted.
|
||||
echo
|
||||
exit 100
|
||||
fi
|
||||
|
||||
|
||||
#exit 0
|
||||
|
||||
# Prepare working dir
|
||||
ssh -p ${SSH_PORT} ${SSH_HOST} "
|
||||
cd ${ROOT}
|
||||
rm -rd build 2>/dev/null
|
||||
if [ -d release ]; then
|
||||
echo copying current release
|
||||
cp -r release build
|
||||
else
|
||||
echo creating first release
|
||||
mkdir release
|
||||
mkdir build
|
||||
fi
|
||||
";
|
||||
|
||||
# sync files
|
||||
SRC=./site/build/dist/js/productionExecutable
|
||||
rsync -e "ssh -p ${SSH_PORT}" -avz -r -d --delete ${SRC}/* ${SSH_HOST}:${ROOT}/build/dist
|
||||
checkState
|
||||
#rsync -e "ssh -p ${SSH_PORT}" -avz ./static/* ${SSH_HOST}:${ROOT}/build/dist
|
||||
#checkState
|
||||
rsync -e "ssh -p ${SSH_PORT}" -avz -r -d --delete distributables/* ${SSH_HOST}:${ROOT}/build/dist/distributables
|
||||
checkState
|
||||
|
||||
echo
|
||||
echo finalizing the deploy...
|
||||
ssh -p ${SSH_PORT} ${SSH_HOST} "
|
||||
cd ${ROOT}
|
||||
rm -rd release~
|
||||
mv release release~
|
||||
mv build release
|
||||
cd release
|
||||
# in this project we needn't restart back when we deploy the front
|
||||
# ~/bin/restart_service
|
||||
";
|
||||
|
||||
if [[ $? != 0 ]]; then
|
||||
echo
|
||||
echo -- finalization failed. the rease might be corrupt. rolling back is not yet implemented.
|
||||
echo
|
||||
exit 100
|
||||
fi
|
||||
|
||||
echo
|
||||
echo Deploy successful
|
||||
echo
|
||||
|
||||
+7
-4
@@ -21,7 +21,10 @@ set -e
|
||||
|
||||
file=./lyng/build/bin/linuxX64/releaseExecutable/lyng.kexe
|
||||
|
||||
./gradlew :lyng:linkReleaseExecutableLinuxX64
|
||||
strip $file
|
||||
upx $file
|
||||
cp $file ~/bin/lyng
|
||||
#./gradlew :lyng:linkReleaseExecutableLinuxX64
|
||||
#strip $file
|
||||
#upx $file
|
||||
cp $file ~/bin/lyng
|
||||
cp $file ./distributables/lyng
|
||||
zip ./distributables/lyng-linuxX64 ./distributables/lyng
|
||||
rm ./distributables/lyng
|
||||
Binary file not shown.
Binary file not shown.
Binary file not shown.
@@ -9,6 +9,9 @@ To implement the iterator you need to implement only two abstract methods:
|
||||
|
||||
### hasNext(): Bool
|
||||
|
||||
// lets test
|
||||
// offset
|
||||
|
||||
Should return `true` if call to `next()` will return valid next element.
|
||||
|
||||
### next(): Obj
|
||||
|
||||
+73
-8
@@ -1,19 +1,22 @@
|
||||
# Map
|
||||
|
||||
Map is a mutable collection of key-value pars, where keys are unique. Maps could be created with
|
||||
constructor or `.toMap` methods. When constructing from a list, each list item must be a [Collection] with exactly 2 elements, for example, a [List].
|
||||
Map is a mutable collection of key-value pairs, where keys are unique. You can create maps in two ways:
|
||||
- with the constructor `Map(...)` or `.toMap()` helpers; and
|
||||
- with map literals using braces: `{ "key": value, id: expr, id: }`.
|
||||
|
||||
When constructing from a list, each list item must be a [Collection] with exactly 2 elements, for example, a [List].
|
||||
|
||||
Important thing is that maps can't contain `null`: it is used to return from missing elements.
|
||||
|
||||
Constructed map instance is of class `Map` and implements `Collection` (and therefore `Iterable`)
|
||||
Constructed map instance is of class `Map` and implements `Collection` (and therefore `Iterable`).
|
||||
|
||||
val map = Map( "foo" => 1, "bar" => "buzz" )
|
||||
assert(map is Map)
|
||||
assert(map.size == 2)
|
||||
assert(map is Iterable)
|
||||
val oldForm = Map( "foo" => 1, "bar" => "buzz" )
|
||||
assert(oldForm is Map)
|
||||
assert(oldForm.size == 2)
|
||||
assert(oldForm is Iterable)
|
||||
>>> void
|
||||
|
||||
Notice usage of the `=>` operator that creates `MapEntry`, which implements also [Collection] of
|
||||
Notice usage of the `=>` operator that creates `MapEntry`, which also implements [Collection] of
|
||||
two items, first, at index zero, is a key, second, at index 1, is the value. You can use lists too.
|
||||
Map keys could be any objects (hashable, e.g. with reasonable hashCode, most of standard types are). You can access elements with indexing operator:
|
||||
|
||||
@@ -29,6 +32,36 @@ Map keys could be any objects (hashable, e.g. with reasonable hashCode, most of
|
||||
assert( map["foo"] == -1)
|
||||
>>> void
|
||||
|
||||
## Map literals { ... }
|
||||
|
||||
Lyng supports JavaScript-like map literals. Keys can be string literals or identifiers, and there is a handy identifier shorthand:
|
||||
|
||||
- String key: `{ "a": 1 }`
|
||||
- Identifier key: `{ foo: 2 }` is the same as `{ "foo": 2 }`
|
||||
- Identifier shorthand: `{ foo: }` is the same as `{ "foo": foo }`
|
||||
|
||||
Access uses brackets: `m["a"]`.
|
||||
|
||||
val x = 10
|
||||
val y = 10
|
||||
val m = { "a": 1, x: x * 2, y: }
|
||||
assertEquals(1, m["a"]) // string-literal key
|
||||
assertEquals(20, m["x"]) // identifier key
|
||||
assertEquals(10, m["y"]) // identifier shorthand expands to y: y
|
||||
>>> void
|
||||
|
||||
Trailing commas are allowed for nicer diffs and multiline formatting:
|
||||
|
||||
val m = {
|
||||
"a": 1,
|
||||
b: 2,
|
||||
}
|
||||
assertEquals(1, m["a"])
|
||||
assertEquals(2, m["b"])
|
||||
>>> void
|
||||
|
||||
Empty `{}` is reserved for blocks/lambdas; use `Map()` for an empty map.
|
||||
|
||||
To remove item from the collection. use `remove`. It returns last removed item or null. Be careful if you
|
||||
hold nulls in the map - this is not a recommended practice when using `remove` returned value. `clear()`
|
||||
removes all.
|
||||
@@ -110,4 +143,36 @@ is equal.
|
||||
assert( m1 != m3 )
|
||||
>>> void
|
||||
|
||||
## Spreads and merging
|
||||
|
||||
Inside map literals you can spread another map with `...` and items will be merged left-to-right; rightmost wins:
|
||||
|
||||
val base = { a: 1, b: 2 }
|
||||
val m = { a: 0, ...base, b: 3, c: 4 }
|
||||
assertEquals(1, m["a"]) // base overwrites a:0
|
||||
assertEquals(3, m["b"]) // literal overwrites spread
|
||||
assertEquals(4, m["c"]) // new key
|
||||
>>> void
|
||||
|
||||
Maps and entries can also be merged with `+` and `+=`:
|
||||
|
||||
val m1 = ("x" => 1) + ("y" => 2)
|
||||
assertEquals(1, m1["x"])
|
||||
assertEquals(2, m1["y"])
|
||||
|
||||
val m2 = { "a": 10 } + ("b" => 20)
|
||||
assertEquals(10, m2["a"])
|
||||
assertEquals(20, m2["b"])
|
||||
|
||||
var m3 = { a: 1 }
|
||||
m3 += ("b" => 2)
|
||||
assertEquals(1, m3["a"])
|
||||
assertEquals(2, m3["b"])
|
||||
>>> void
|
||||
|
||||
Notes:
|
||||
- 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.
|
||||
- When you need computed or non-string keys, use the constructor form `Map(...)` or build entries with `=>` and then merge.
|
||||
|
||||
[Collection](Collection.md)
|
||||
+118
-2
@@ -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
|
||||
|
||||
@@ -71,6 +75,99 @@ Functions defined inside a class body are methods, and unless declared
|
||||
void
|
||||
>>> void
|
||||
|
||||
## Multiple Inheritance (MI)
|
||||
|
||||
Lyng supports declaring a class with multiple direct base classes. The syntax is:
|
||||
|
||||
```
|
||||
class Foo(val a) {
|
||||
var tag = "F"
|
||||
fun runA() { "ResultA:" + a }
|
||||
fun common() { "CommonA" }
|
||||
private fun privateInFoo() {}
|
||||
protected fun protectedInFoo() {}
|
||||
}
|
||||
|
||||
class Bar(val b) {
|
||||
var tag = "B"
|
||||
fun runB() { "ResultB:" + b }
|
||||
fun common() { "CommonB" }
|
||||
}
|
||||
|
||||
// Multiple inheritance with per‑base constructor arguments
|
||||
class FooBar(a, b) : Foo(a), Bar(b) {
|
||||
// You can disambiguate via qualified this or casts
|
||||
fun fromFoo() { this@Foo.common() }
|
||||
fun fromBar() { this@Bar.common() }
|
||||
}
|
||||
|
||||
val fb = FooBar(1, 2)
|
||||
assertEquals("ResultA:1", fb.runA())
|
||||
assertEquals("ResultB:2", fb.runB())
|
||||
// Unqualified ambiguous member resolves to the first base (leftmost)
|
||||
assertEquals("CommonA", fb.common())
|
||||
// Disambiguation via casts
|
||||
assertEquals("CommonB", (fb as Bar).common())
|
||||
assertEquals("CommonA", (fb as Foo).common())
|
||||
|
||||
// Field inheritance with name collisions
|
||||
assertEquals("F", fb.tag) // unqualified: leftmost base
|
||||
assertEquals("F", (fb as Foo).tag) // qualified read: Foo.tag
|
||||
assertEquals("B", (fb as Bar).tag) // qualified read: Bar.tag
|
||||
|
||||
fb.tag = "X" // unqualified write updates leftmost base
|
||||
assertEquals("X", (fb as Foo).tag)
|
||||
assertEquals("B", (fb as Bar).tag)
|
||||
|
||||
(fb as Bar).tag = "Y" // qualified write updates Bar.tag
|
||||
assertEquals("X", (fb as Foo).tag)
|
||||
assertEquals("Y", (fb as Bar).tag)
|
||||
```
|
||||
|
||||
Key rules and features:
|
||||
|
||||
- Syntax
|
||||
- `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).
|
||||
|
||||
- Resolution order (C3 MRO — active)
|
||||
- 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`.
|
||||
- The first visible match along this order wins.
|
||||
|
||||
- Qualified dispatch
|
||||
- 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).
|
||||
- Qualified access does not relax visibility.
|
||||
|
||||
- Field inheritance (`val`/`var`) and collisions
|
||||
- Instance storage is kept per declaring class, internally disambiguated; unqualified read/write resolves to the first match in the resolution order (leftmost base).
|
||||
- Qualified read/write (via `this@Type` or casts) targets the chosen ancestor’s storage.
|
||||
- `val` remains read‑only; attempting to write raises an error as usual.
|
||||
|
||||
- Constructors and initialization
|
||||
- During construction, direct bases are initialized left‑to‑right in the declaration order. Each ancestor is initialized at most once (diamond‑safe de‑duplication).
|
||||
- Arguments in the header are evaluated in the instance scope and passed to the corresponding direct base constructor.
|
||||
- The most‑derived class’s constructor runs after the bases.
|
||||
|
||||
- Visibility
|
||||
- `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.
|
||||
|
||||
- Diagnostics
|
||||
- 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.
|
||||
- `as`/`as?` cast errors mention the actual and target types.
|
||||
|
||||
Compatibility notes:
|
||||
|
||||
- Existing single‑inheritance code continues to work unchanged; its resolution order reduces to the single base.
|
||||
- If your previous code accidentally relied on non‑deterministic parent set iteration, it may change behavior — the new deterministic order is a correctness fix.
|
||||
|
||||
### Migration note (declaration‑order → C3)
|
||||
|
||||
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.
|
||||
|
||||
## fields and visibility
|
||||
|
||||
It is possible to add non-constructor fields:
|
||||
@@ -130,6 +227,25 @@ Private fields are visible only _inside the class instance_:
|
||||
void
|
||||
>>> void
|
||||
|
||||
### Protected members
|
||||
|
||||
Protected members are available to the declaring class and all of its transitive subclasses (including via MI), but not from unrelated contexts:
|
||||
|
||||
```
|
||||
class A() {
|
||||
protected fun ping() { "pong" }
|
||||
}
|
||||
class B() : A() {
|
||||
fun call() { this@A.ping() }
|
||||
}
|
||||
|
||||
val b = B()
|
||||
assertEquals("pong", b.call())
|
||||
|
||||
// Unrelated access is forbidden, even via cast
|
||||
assertThrows { (b as A).ping() }
|
||||
```
|
||||
|
||||
It is possible to provide private constructor parameters so they can be
|
||||
set at construction but not available outside the class:
|
||||
|
||||
|
||||
@@ -1,24 +0,0 @@
|
||||
# Classes
|
||||
|
||||
## Declaring
|
||||
|
||||
class Foo1
|
||||
class Foo2() // same, empty constructor
|
||||
class Foo3() { // full
|
||||
}
|
||||
class Foo4 { // Only body
|
||||
}
|
||||
|
||||
```
|
||||
class_declaration = ["abstract",] "class" [, constructor] [, body]
|
||||
constructor = "(", [field [, field]] ")
|
||||
field = [visibility ,] [access ,] name [, typedecl]
|
||||
body = [visibility] ("var", vardecl) | ("val", vardecl) | ("fun", fundecl)
|
||||
visibility = "private" | "protected" | "internal"
|
||||
```
|
||||
|
||||
### Abstract classes
|
||||
|
||||
Contain one pr more abstract methods which must be implemented; though they
|
||||
can have constructors, the instances of the abstract classes could not be
|
||||
created independently
|
||||
@@ -1,11 +1,13 @@
|
||||
# Declaring arguments in Lyng
|
||||
|
||||
[//]: # (topMenu)
|
||||
|
||||
It is a common thing that occurs in many places in Lyng, function declarations,
|
||||
lambdas and class declarations.
|
||||
|
||||
## Regular
|
||||
|
||||
## default values
|
||||
## Default values
|
||||
|
||||
Default parameters should not be mixed with mandatory ones:
|
||||
|
||||
@@ -95,6 +97,61 @@ There could be any number of splats at any positions. You can splat any other [I
|
||||
testSplat("start", ...range, "end")
|
||||
>>> [start,1,2,3,end]
|
||||
>>> void
|
||||
|
||||
## Named arguments in calls
|
||||
|
||||
Lyng supports named arguments at call sites using colon syntax `name: value`:
|
||||
|
||||
```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"))
|
||||
```
|
||||
|
||||
Rules:
|
||||
|
||||
- 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).
|
||||
- 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.
|
||||
|
||||
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.
|
||||
|
||||
## Named splats (map splats)
|
||||
|
||||
Splat (`...`) of a Map provides named arguments to the call. Only string keys are allowed:
|
||||
|
||||
```lyng
|
||||
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:
|
||||
|
||||
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)
|
||||
assertEquals(["A?","B!","c","D!"], r)
|
||||
>>> void
|
||||
|
||||
Constraints:
|
||||
|
||||
- Map splat keys must be strings; otherwise, a clean error is thrown.
|
||||
- Named splats cannot duplicate parameters already assigned (by positional or named arguments).
|
||||
- Named splats must follow all positional arguments and positional splats.
|
||||
- Ellipsis parameters (variadic) remain positional-only and cannot be assigned by name.
|
||||
|
||||
## Trailing-lambda rule interaction
|
||||
|
||||
If a call is immediately followed by a block `{ ... }`, it is treated as an extra last argument and bound to the last parameter. However, if the last parameter is already assigned by a named argument or a named splat, using a trailing block is an error:
|
||||
|
||||
```lyng
|
||||
fun f(x, onDone) { onDone(x) }
|
||||
f(x: 1) { 42 } // ERROR
|
||||
f(1) { 42 } // OK
|
||||
```
|
||||
|
||||
|
||||
[tutorial]: tutorial.md
|
||||
@@ -1,3 +1,5 @@
|
||||
[//]: # (excludeFromIndex)
|
||||
|
||||
# String
|
||||
|
||||
# This document is for developer notes only
|
||||
|
||||
@@ -1,5 +1,7 @@
|
||||
# Modules inclusion
|
||||
|
||||
[//]: # (excludeFromIndex)
|
||||
|
||||
Module is, at the low level, a statement that modifies a given context by adding
|
||||
here local and exported symbols, performing some tasks and even returning some value
|
||||
we don't need for now.
|
||||
|
||||
@@ -1,3 +1,4 @@
|
||||
[//]: # (excludeFromIndex)
|
||||
|
||||
|
||||
Provide:
|
||||
|
||||
@@ -0,0 +1,236 @@
|
||||
# Embedding Lyng in your Kotlin project
|
||||
|
||||
Lyng is a tiny, embeddable, Kotlin‑first scripting language. This page shows, step by step, how to:
|
||||
|
||||
- add Lyng to your build
|
||||
- create a runtime and execute scripts
|
||||
- define functions and variables from Kotlin
|
||||
- read variable values back in Kotlin
|
||||
- call Lyng functions from Kotlin
|
||||
- create your own packages and import them in Lyng
|
||||
|
||||
All snippets below use idiomatic Kotlin and rely on Lyng public APIs. They work on JVM and other Kotlin Multiplatform targets supported by `lynglib`.
|
||||
|
||||
Note: all Lyng APIs shown are `suspend`, because script evaluation is coroutine‑friendly and can suspend.
|
||||
|
||||
### 1) Add Lyng to your build
|
||||
|
||||
Add the repository where you publish Lyng artifacts and the dependency on the core library `lynglib`.
|
||||
|
||||
Gradle Kotlin DSL (build.gradle.kts):
|
||||
|
||||
```kotlin
|
||||
repositories {
|
||||
// Your standard repos
|
||||
mavenCentral()
|
||||
|
||||
// If you publish to your own Maven (example: Gitea packages). Adjust URL/token as needed.
|
||||
maven(url = uri("https://gitea.sergeych.net/api/packages/SergeychWorks/maven"))
|
||||
}
|
||||
|
||||
dependencies {
|
||||
// Multiplatform: place in appropriate source set if needed
|
||||
implementation("net.sergeych:lynglib:1.0.0-SNAPSHOT")
|
||||
}
|
||||
```
|
||||
|
||||
If you use Kotlin Multiplatform, add the dependency in the `commonMain` source set (and platform‑specific sets if you need platform APIs).
|
||||
|
||||
### 2) Create a runtime (Scope) and execute scripts
|
||||
|
||||
The easiest way to get a ready‑to‑use scope with standard packages is via `Script.newScope()`.
|
||||
|
||||
```kotlin
|
||||
fun main() = kotlinx.coroutines.runBlocking {
|
||||
val scope = Script.newScope() // suspends on first init
|
||||
|
||||
// Evaluate a one‑liner
|
||||
val result = scope.eval("1 + 2 * 3")
|
||||
println("Lyng result: $result") // ObjReal/ObjInt etc.
|
||||
}
|
||||
```
|
||||
|
||||
You can also pre‑compile a script and execute it multiple times:
|
||||
|
||||
```kotlin
|
||||
val script = Compiler.compile("""
|
||||
// any Lyng code
|
||||
val x = 40 + 2
|
||||
x
|
||||
""")
|
||||
|
||||
val run1 = script.execute(scope)
|
||||
val run2 = script.execute(scope)
|
||||
```
|
||||
|
||||
`Scope.eval("...")` is a shortcut that compiles and executes on the given scope.
|
||||
|
||||
### 3) Define variables from Kotlin
|
||||
|
||||
To expose data to Lyng, add constants (read‑only) or mutable variables to the scope. All values in Lyng are `Obj` instances; the core types live in `net.sergeych.lyng.obj`.
|
||||
|
||||
```kotlin
|
||||
// Read‑only constant
|
||||
scope.addConst("pi", ObjReal(3.14159))
|
||||
|
||||
// Mutable variable: create or update
|
||||
scope.addOrUpdateItem("counter", ObjInt(0))
|
||||
|
||||
// Use it from Lyng
|
||||
scope.eval("counter = counter + 1")
|
||||
```
|
||||
|
||||
Tip: Lyng values can be converted back to Kotlin with `toKotlin(scope)`:
|
||||
|
||||
```kotlin
|
||||
val current = (scope.eval("counter")).toKotlin(scope) // Any? (e.g., Int/Double/String/List)
|
||||
```
|
||||
|
||||
### 4) Add Kotlin‑backed functions
|
||||
|
||||
Use `Scope.addFn`/`addVoidFn` to register functions implemented in Kotlin. Inside the lambda, use `this.args` to access arguments and return an `Obj`.
|
||||
|
||||
```kotlin
|
||||
// A function returning value
|
||||
scope.addFn<ObjInt>("inc") {
|
||||
val x = args.firstAndOnly() as ObjInt
|
||||
ObjInt(x.value + 1)
|
||||
}
|
||||
|
||||
// A void function (returns Lyng Void)
|
||||
scope.addVoidFn("log") {
|
||||
val items = args.list // List<Obj>
|
||||
println(items.joinToString(" ") { it.toString(this).value })
|
||||
}
|
||||
|
||||
// Call them from Lyng
|
||||
scope.eval("val y = inc(41); log('Answer:', y)")
|
||||
```
|
||||
|
||||
You can register multiple names (aliases) at once: `addFn<ObjInt>("inc", "increment") { ... }`.
|
||||
|
||||
### 5) Read variable values back in Kotlin
|
||||
|
||||
The simplest approach: evaluate an expression that yields the value and convert it.
|
||||
|
||||
```kotlin
|
||||
val kotlinAnswer = scope.eval("(1 + 2) * 3").toKotlin(scope) // -> 9 (Int)
|
||||
|
||||
// After scripts manipulate your vars:
|
||||
scope.addOrUpdateItem("name", ObjString("Lyng"))
|
||||
scope.eval("name = name + ' rocks!'")
|
||||
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.
|
||||
|
||||
### 6) Execute scripts with parameters; call Lyng functions from Kotlin
|
||||
|
||||
There are two convenient patterns.
|
||||
|
||||
1) Evaluate a Lyng call expression directly:
|
||||
|
||||
```kotlin
|
||||
// Suppose Lyng defines: fun add(a, b) = a + b
|
||||
scope.eval("fun add(a, b) = a + b")
|
||||
|
||||
val sum = scope.eval("add(20, 22)").toKotlin(scope) // -> 42
|
||||
```
|
||||
|
||||
2) Call a Lyng function by name via a prepared call scope:
|
||||
|
||||
```kotlin
|
||||
// Ensure the function exists in the scope
|
||||
scope.eval("fun add(a, b) = a + b")
|
||||
|
||||
// Look up the function object
|
||||
val addFn = scope.get("add")!!.value as Statement
|
||||
|
||||
// Create a child scope with arguments (as Lyng Objs)
|
||||
val callScope = scope.createChildScope(
|
||||
args = Arguments(listOf(ObjInt(20), ObjInt(22)))
|
||||
)
|
||||
|
||||
val resultObj = addFn.execute(callScope)
|
||||
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`.
|
||||
|
||||
### 7) 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 ...`.
|
||||
|
||||
Key concepts:
|
||||
|
||||
- `ImportManager` holds package registrations and lazily builds `ModuleScope`s when first imported.
|
||||
- Every `Scope` has `currentImportProvider` and (if it’s an `ImportManager`) a convenience `importManager` to register packages.
|
||||
|
||||
Register a Kotlin‑built package:
|
||||
|
||||
```kotlin
|
||||
val scope = Script.newScope()
|
||||
|
||||
// Access the import manager behind this scope
|
||||
val im: ImportManager = scope.importManager
|
||||
|
||||
// Register a package "my.tools"
|
||||
im.addPackage("my.tools") { module: ModuleScope ->
|
||||
// Expose symbols inside the module scope
|
||||
module.addConst("version", ObjString("1.0"))
|
||||
module.addFn<ObjInt>("triple") {
|
||||
val x = args.firstAndOnly() as ObjInt
|
||||
ObjInt(x.value * 3)
|
||||
}
|
||||
}
|
||||
|
||||
// Use it from Lyng
|
||||
scope.eval("""
|
||||
import my.tools.*
|
||||
val v = triple(14)
|
||||
""")
|
||||
val v = scope.eval("v").toKotlin(scope) // -> 42
|
||||
```
|
||||
|
||||
Register a package from Lyng source text:
|
||||
|
||||
```kotlin
|
||||
val pkgText = """
|
||||
package math.extra
|
||||
|
||||
fun sqr(x) = x * x
|
||||
""".trimIndent()
|
||||
|
||||
scope.importManager.addTextPackages(pkgText)
|
||||
|
||||
scope.eval("""
|
||||
import math.extra.*
|
||||
val s = sqr(12)
|
||||
""")
|
||||
val s = scope.eval("s").toKotlin(scope) // -> 144
|
||||
```
|
||||
|
||||
You can also register from parsed `Source` instances via `addSourcePackages(source)`.
|
||||
|
||||
### 8) 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))`.
|
||||
- `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.
|
||||
- For isolation, create fresh modules/scopes via `Scope.new()` or `Script.newScope()` when you need a clean environment per request.
|
||||
|
||||
```kotlin
|
||||
// Fresh module based on the default manager, without the standard prelude
|
||||
val isolated = net.sergeych.lyng.Scope.new()
|
||||
```
|
||||
|
||||
### 9) Tips and troubleshooting
|
||||
|
||||
- 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.
|
||||
- Most public API in Lyng is suspendable. If you are not already in a coroutine, wrap calls in `runBlocking { ... }` on the JVM for quick tests.
|
||||
- When registering packages, names must be unique. Register before you compile/evaluate scripts that import them.
|
||||
- To debug scope content, `scope.toString()` and `scope.trace()` can help during development.
|
||||
|
||||
---
|
||||
|
||||
That’s it. You now have Lyng embedded in your Kotlin app: you can expose your app’s API, evaluate user scripts, and organize your own packages to import from Lyng code.
|
||||
@@ -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,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.
|
||||
+25
-5
@@ -9,17 +9,37 @@ Same as in C++.
|
||||
| **Highest**<br>0 | power, not, calls, indexing, dot,... |
|
||||
| 1 | `%` `*` `/` |
|
||||
| 2 | `+` `-` |
|
||||
| 3 | bit shifts (NI) |
|
||||
| 3 | bit shifts `<<` `>>` |
|
||||
| 4 | `<=>` (1) |
|
||||
| 5 | `<=` `>=` `<` `>` |
|
||||
| 6 | `==` `!=` |
|
||||
| 7 | bitwise and `&` (NI) |
|
||||
| 9 | bitwise or `\|` (NI) |
|
||||
| 7 | bitwise and `&` |
|
||||
| 8 | bitwise xor `^` |
|
||||
| 9 | bitwise or `\|` |
|
||||
| 10 | `&&` |
|
||||
| 11<br/>lowest | `\|\|` |
|
||||
|
||||
(NI)
|
||||
: not yet implemented.
|
||||
Bitwise operators
|
||||
: available only for `Int` values. For mixed `Int`/`Real` numeric expressions, bitwise operators are not defined.
|
||||
|
||||
Bitwise NOT `~x`
|
||||
: unary operator that inverts all bits of a 64‑bit signed integer (`Int`). It follows two's‑complement rules, so
|
||||
`~x` is numerically equal to `-(x + 1)`. Examples: `~0 == -1`, `~1 == -2`, `~(-1) == 0`.
|
||||
|
||||
Examples:
|
||||
|
||||
```
|
||||
5 & 3 // -> 1
|
||||
5 | 3 // -> 7
|
||||
5 ^ 3 // -> 6
|
||||
~0 // -> -1
|
||||
1 << 3 // -> 8
|
||||
8 >> 3 // -> 1
|
||||
```
|
||||
|
||||
Notes:
|
||||
- Shifts operate on 64-bit signed integers (`Int` is 64-bit). Right shift `>>` is arithmetic (sign-propagating).
|
||||
- Shift count is masked to the range 0..63, similar to the JVM/Kotlin behavior (e.g., `1 << 65` equals `1 << 1`).
|
||||
|
||||
(1)
|
||||
: Shuttle operator: `a <=> b` returns 0 if a == b, negative Int if a < b and positive Int otherwise. It is necessary to
|
||||
|
||||
+22
-6
@@ -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)
|
||||
and cooperatively parallel (coroutine based) everywhere.
|
||||
@@ -36,19 +38,19 @@ Launch has the only argument which should be a callable (lambda usually) that is
|
||||
|
||||
## Synchronization: Mutex
|
||||
|
||||
Suppose we have a resource, that could be used concurrently, a coutner in our case. If we won'r protect it, concurrent usage cause RC, Race Condition, providing wrong result:
|
||||
Suppose we have a resource, that could be used concurrently, a counter in our case. If we won't protect it, concurrent usage cause RC, Race Condition, providing wrong result:
|
||||
|
||||
var counter = 0
|
||||
|
||||
(1..4).map {
|
||||
(1..50).map {
|
||||
launch {
|
||||
// slow increment:
|
||||
val c = counter
|
||||
delay(10)
|
||||
delay(100)
|
||||
counter = c + 1
|
||||
}
|
||||
}.forEach { it.await() }
|
||||
assert(counter < 4)
|
||||
assert(counter < 50) { "counter is "+counter }
|
||||
>>> void
|
||||
|
||||
The obviously wrong result is not 4, as all coroutines capture the counter value, which is 1, then sleep for 5ms, then save 1 + 1 as result. May some coroutines will pass, so it will be 1 or 2, most likely.
|
||||
@@ -204,4 +206,18 @@ Flows allow easy transforming of any [Iterable]. See how the standard Lyng libra
|
||||
}
|
||||
|
||||
|
||||
[Iterable]: Iterable.md
|
||||
[Iterable]: Iterable.md
|
||||
|
||||
## Scope frame pooling (JVM)
|
||||
|
||||
Lyng includes an optional optimization for function/method calls on JVM: scope frame pooling, toggled by the runtime flag `PerfFlags.SCOPE_POOL`.
|
||||
|
||||
- Default: `SCOPE_POOL` is OFF on JVM.
|
||||
- Rationale: the current `ScopePool` implementation is not thread‑safe. Lyng targets multi‑threaded execution on most platforms, therefore we keep pooling disabled by default until a thread‑safe design is introduced.
|
||||
- When safe to enable: single‑threaded runs (e.g., micro‑benchmarks or scripts executed on a single worker) where no scopes are shared across threads.
|
||||
- How to toggle at runtime (Kotlin/JVM tests):
|
||||
- `PerfFlags.SCOPE_POOL = true` to enable.
|
||||
- `PerfFlags.SCOPE_POOL = false` to disable.
|
||||
- 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.
|
||||
@@ -0,0 +1,622 @@
|
||||
|
||||
This document explains how to enable and measure the performance optimizations added to the Lyng interpreter. The focus is JVM‑first with safe, flag‑guarded rollouts and quick A/B testing. Other targets (JS/Wasm/Native) keep conservative defaults until validated.
|
||||
|
||||
[//]: # (excludeFromIndex)
|
||||
|
||||
## Overview
|
||||
|
||||
Optimizations are controlled by runtime‑mutable flags in `net.sergeych.lyng.PerfFlags`, initialized from platform‑specific static defaults `net.sergeych.lyng.PerfDefaults` (KMP `expect/actual`).
|
||||
|
||||
- JVM/Android defaults are aggressive (e.g. `RVAL_FASTPATH=true`).
|
||||
- Non‑JVM defaults are conservative (e.g. `RVAL_FASTPATH=false`).
|
||||
|
||||
All flags are `var` and can be flipped at runtime (e.g., from tests or host apps) for A/B comparisons.
|
||||
|
||||
### Workload presets (JVM‑first)
|
||||
|
||||
To simplify switching between recommended flag sets for different workloads, use `net.sergeych.lyng.PerfProfiles`:
|
||||
|
||||
```
|
||||
val snap = PerfProfiles.apply(PerfProfiles.Preset.BENCH) // or BASELINE / BOOKS
|
||||
// ... run workload ...
|
||||
PerfProfiles.restore(snap) // restore previous flags
|
||||
```
|
||||
|
||||
- BASELINE: restores platform defaults from `PerfDefaults` (good rollback point).
|
||||
- BENCH: expression‑heavy micro‑bench focus (aggressive R‑value and PIC optimizations on JVM).
|
||||
- BOOKS: documentation workloads (prefers simpler paths; disables some PIC/arg builder features shown neutral/negative for this load in A/B).
|
||||
|
||||
## Key flags
|
||||
|
||||
- `LOCAL_SLOT_PIC` — Runtime cache in `LocalVarRef` to avoid repeated name→slot lookups per frame (ON JVM default).
|
||||
- `EMIT_FAST_LOCAL_REFS` — Compiler emits `FastLocalVarRef` for identifiers known to be locals/params (ON JVM default).
|
||||
- `ARG_BUILDER` — Efficient argument building: small‑arity no‑alloc and pooled builder on JVM (ON JVM default).
|
||||
- `ARG_SMALL_ARITY_12` — Extends small‑arity no‑alloc call paths from 0–8 to 0–12 arguments (JVM‑first exploration; OFF by default). Use for codebases with many 9–12 arg calls; A/B before enabling.
|
||||
- `SKIP_ARGS_ON_NULL_RECEIVER` — Early return on optional‑null receivers before building args (semantics‑compatible). A/B only.
|
||||
- `SCOPE_POOL` — Scope frame pooling for calls (JVM, per‑thread ThreadLocal pool). ON by default on JVM; togglable at runtime.
|
||||
- `FIELD_PIC` — 2‑entry polymorphic inline cache for field reads/writes keyed by `(classId, layoutVersion)` (ON JVM default).
|
||||
- `METHOD_PIC` — 2‑entry PIC for instance method calls keyed by `(classId, layoutVersion)` (ON JVM default).
|
||||
- `FIELD_PIC_SIZE_4` — Increases Field PIC size from 2 to 4 entries (JVM-first tuning; OFF by default). Use for sites with >2 receiver shapes.
|
||||
- `METHOD_PIC_SIZE_4` — Increases Method PIC size from 2 to 4 entries (JVM-first tuning; OFF by default).
|
||||
- `PIC_ADAPTIVE_2_TO_4` — Adaptive growth of Field/Method PICs from 2→4 entries per-site when miss rate >20% over ≥256 accesses (JVM-first; OFF by default).
|
||||
- `INDEX_PIC` — Enables polymorphic inline cache for indexing (e.g., `a[i]`) and related fast paths. Defaults to follow `FIELD_PIC` on init; can be toggled independently.
|
||||
- `INDEX_PIC_SIZE_4` — Increases Index PIC size from 2 to 4 entries (JVM-first tuning). Default: ON for JVM; OFF elsewhere by default.
|
||||
- `PIC_DEBUG_COUNTERS` — Enable lightweight hit/miss counters via `PerfStats` (OFF by default).
|
||||
- `PRIMITIVE_FASTOPS` — Fast paths for `(ObjInt, ObjInt)` arithmetic/comparisons and `(ObjBool, ObjBool)` logic (ON JVM default).
|
||||
- `RVAL_FASTPATH` — Bypass `ObjRecord` in pure expression evaluation via `ObjRef.evalValue` (ON JVM default, OFF elsewhere).
|
||||
|
||||
See `src/commonMain/kotlin/net/sergeych/lyng/PerfFlags.kt` and `PerfDefaults.*.kt` for details and platform defaults.
|
||||
|
||||
## Where optimizations apply
|
||||
|
||||
- Locals: `FastLocalVarRef`, `LocalVarRef` per‑frame cache (PIC).
|
||||
- Calls: small‑arity zero‑alloc paths (0–8 args; optionally 0–12 with `ARG_SMALL_ARITY_12`), pooled builder (JVM), and child frame pooling (optional).
|
||||
- Properties/methods: Field/Method PICs with receiver shape `(classId, layoutVersion)` and handle‑aware caches; configurable 2→4 entries under flags.
|
||||
- Expressions: R‑value fast paths in hot nodes (`UnaryOpRef`, `BinaryOpRef`, `ElvisRef`, logical ops, `RangeRef`, `IndexRef` read, `FieldRef` receiver eval, `ListLiteralRef` elements, `CallRef` callee, `MethodCallRef` receiver, assignment RHS).
|
||||
- Primitives: Direct boolean/int ops where safe.
|
||||
|
||||
### Compiler constant folding (conservative)
|
||||
- The compiler folds a safe subset of literal‑only expressions at compile time to reduce runtime work:
|
||||
- Integer arithmetic: `+ - * / %` (division/modulo only when divisor ≠ 0).
|
||||
- Bitwise integer ops: `& ^ | << >>`.
|
||||
- Comparisons and equality for ints/strings/chars: `== != < <= > >=`.
|
||||
- Boolean logic for literal booleans: `|| &&` and unary `!`.
|
||||
- String concatenation of literal strings: `"a" + "b"`.
|
||||
- Non‑literal operands or side‑effecting constructs are not folded.
|
||||
- Semantics remain unchanged; tests verify parity.
|
||||
|
||||
## Running JVM micro‑benchmarks
|
||||
|
||||
Each benchmark prints timings with `[DEBUG_LOG]` and includes correctness assertions to prevent dead‑code elimination.
|
||||
|
||||
Run individual tests to avoid multiplatform matrices:
|
||||
|
||||
```
|
||||
./gradlew :lynglib:jvmTest --tests LocalVarBenchmarkTest
|
||||
./gradlew :lynglib:jvmTest --tests CallBenchmarkTest
|
||||
./gradlew :lynglib:jvmTest --tests CallMixedArityBenchmarkTest
|
||||
./gradlew :lynglib:jvmTest --tests CallSplatBenchmarkTest
|
||||
./gradlew :lynglib:jvmTest --tests PicBenchmarkTest
|
||||
./gradlew :lynglib:jvmTest --tests PicInvalidationJvmTest
|
||||
./gradlew :lynglib:jvmTest --tests PicAdaptiveABTest
|
||||
./gradlew :lynglib:jvmTest --tests ArithmeticBenchmarkTest
|
||||
./gradlew :lynglib:jvmTest --tests ExpressionBenchmarkTest
|
||||
./gradlew :lynglib:jvmTest --tests IndexPicABTest
|
||||
./gradlew :lynglib:jvmTest --tests IndexWritePathABTest
|
||||
./gradlew :lynglib:jvmTest --tests CallPoolingBenchmarkTest
|
||||
./gradlew :lynglib:jvmTest --tests MethodPoolingBenchmarkTest
|
||||
./gradlew :lynglib:jvmTest --tests MixedBenchmarkTest
|
||||
./gradlew :lynglib:jvmTest --tests DeepPoolingStressJvmTest
|
||||
```
|
||||
|
||||
Typical output (example):
|
||||
|
||||
```
|
||||
[DEBUG_LOG] [BENCH] mixed-arity x200000 [ARG_BUILDER=ON]: 85.7 ms
|
||||
```
|
||||
|
||||
Lower time is better. Run the same bench with a flag OFF vs ON to compare.
|
||||
|
||||
### Optional JFR allocation profiling (JVM)
|
||||
|
||||
When running end‑to‑end “book” workloads or heavier benches, you can enable JFR to capture allocation and GC details:
|
||||
|
||||
```
|
||||
./gradlew :lynglib:jvmTest --tests BookAllocationProfileTest -Dlyng.jfr=true \
|
||||
-Dlyng.profile.warmup=1 -Dlyng.profile.repeats=3 -Dlyng.profile.shuffle=true
|
||||
```
|
||||
|
||||
- Dumps are saved to `lynglib/build/jfr_*.jfr` if the JVM supports Flight Recorder.
|
||||
- The test also records GC counts/time and median time/heap deltas to `lynglib/build/book_alloc_profile.txt`.
|
||||
|
||||
## Toggling flags in tests
|
||||
|
||||
Flags are mutable at runtime, e.g.:
|
||||
|
||||
```kotlin
|
||||
PerfFlags.ARG_BUILDER = false
|
||||
val r1 = (Scope().eval(script) as ObjInt).value
|
||||
PerfFlags.ARG_BUILDER = true
|
||||
val r2 = (Scope().eval(script) as ObjInt).value
|
||||
```
|
||||
|
||||
Reset flags at the end of a test to avoid impacting other tests.
|
||||
|
||||
## PIC diagnostics (optional)
|
||||
|
||||
Enable counters:
|
||||
|
||||
```kotlin
|
||||
PerfFlags.PIC_DEBUG_COUNTERS = true
|
||||
PerfStats.resetAll()
|
||||
```
|
||||
|
||||
Available counters in `PerfStats`:
|
||||
|
||||
- Field PIC: `fieldPicHit`, `fieldPicMiss`, `fieldPicSetHit`, `fieldPicSetMiss`
|
||||
- Method PIC: `methodPicHit`, `methodPicMiss`
|
||||
- Index PIC: `indexPicHit`, `indexPicMiss`
|
||||
- Locals: `localVarPicHit`, `localVarPicMiss`, `fastLocalHit`, `fastLocalMiss`
|
||||
- Primitive ops: `primitiveFastOpsHit`
|
||||
|
||||
Print a summary at the end of a bench/test as needed. Remember to turn counters OFF after the test.
|
||||
|
||||
## A/B scenarios and guidance (JVM)
|
||||
|
||||
### Adaptive PIC (fields/methods)
|
||||
- Flags: `FIELD_PIC=true`, `METHOD_PIC=true`, `FIELD_PIC_SIZE_4=false`, `METHOD_PIC_SIZE_4=false`, toggle `PIC_ADAPTIVE_2_TO_4` OFF vs ON.
|
||||
- Benchmarks: `PicBenchmarkTest`, `MixedBenchmarkTest`, `PicAdaptiveABTest`.
|
||||
- Expect wins at sites with >2 receiver shapes; counters should show fewer misses with adaptivity ON.
|
||||
|
||||
### Index PIC and size
|
||||
- Flags: toggle `INDEX_PIC` OFF vs ON; then `INDEX_PIC_SIZE_4` OFF vs ON.
|
||||
- Benchmarks: `ExpressionBenchmarkTest` (list indexing) and `IndexPicABTest` (string/map indexing).
|
||||
- Expect wins when the same index shape recurs; counters should show higher `indexPicHit`.
|
||||
|
||||
### Index WRITE paths (Map and List)
|
||||
- Flags: toggle `INDEX_PIC` OFF vs ON; then `INDEX_PIC_SIZE_4` OFF vs ON.
|
||||
- Benchmark: `IndexWritePathABTest` (Map[String] put, List[Int] set) — writes results to `lynglib/build/index_write_ab_results.txt`.
|
||||
- Direct fast‑paths are used on R‑value paths where safe and semantics‑preserving (e.g., optional‑chaining no‑ops on null receivers; bounds exceptions unchanged).
|
||||
|
||||
## Guidance per flag (JVM)
|
||||
|
||||
- Keep `RVAL_FASTPATH = true` unless debugging a suspected expression‑semantics issue.
|
||||
- Use `SCOPE_POOL = true` only for benchmarks or once pooling passes the deep stress tests and broader validation; currently OFF by default.
|
||||
- `FIELD_PIC` and `METHOD_PIC` should remain ON; they are validated with invalidation tests.
|
||||
- Consider enabling `FIELD_PIC_SIZE_4`/`METHOD_PIC_SIZE_4` for sites with 3–4 receiver shapes; measure first.
|
||||
- `PIC_ADAPTIVE_2_TO_4` is useful on polymorphic sites and may outperform fixed size 2 on mixed-shape workloads. Validate with `PicAdaptiveABTest`.
|
||||
- `INDEX_PIC` is generally beneficial on JVM; leave ON when measuring index‑heavy workloads.
|
||||
- `INDEX_PIC_SIZE_4` is ON by default on JVM as A/B showed consistent wins on String[Int] and Map[String] workloads. You can disable it by setting `PerfFlags.INDEX_PIC_SIZE_4 = false` if needed.
|
||||
- `ARG_BUILDER` should remain ON; switch OFF only to get a baseline.
|
||||
- `ARG_SMALL_ARITY_12` is experimental and OFF by default. Enable it only if your workload frequently calls functions with 9–12 arguments and A/B shows consistent wins.
|
||||
|
||||
### Workload‑specific recommendations (JVM)
|
||||
|
||||
- “Books”/documentation loads (BookTest): prefer simpler paths; in A/B these often benefit from the BOOKS preset (e.g., `ARG_BUILDER=false`, `SCOPE_POOL=false`, `INDEX_PIC=false`). Use `PerfProfiles.apply(PerfProfiles.Preset.BOOKS)` before the run and `restore(...)` after.
|
||||
- Expression‑heavy benches: use the BENCH preset (PICs and R‑value fast‑paths enabled, `INDEX_PIC_SIZE_4=true`).
|
||||
- Always verify with local A/B on your environment; rollback is a flag flip or applying BASELINE.
|
||||
|
||||
## Notes on correctness & safety
|
||||
|
||||
- Optional chaining semantics are preserved across fast paths.
|
||||
- Visibility/mutability checks are enforced even on PIC fast‑paths.
|
||||
- `frameId` is regenerated on each pooled frame borrow; stress tests verify no leakage under deep nesting/recursion.
|
||||
|
||||
## Cross‑platform
|
||||
|
||||
- Non‑JVM defaults keep `RVAL_FASTPATH=false` for now; other low‑risk flags may be ON.
|
||||
- Once JVM path is fully validated and measured, add lightweight benches for JS/Wasm/Native and enable flags incrementally.
|
||||
|
||||
## Range fast iteration (experimental)
|
||||
|
||||
- Flag: `RANGE_FAST_ITER` (default OFF).
|
||||
- When enabled and applicable, simple ascending integer ranges (`0..n`, `0..<n`) use a specialized non‑allocating iterator (`ObjFastIntRangeIterator`).
|
||||
- Benchmark: `RangeIterationBenchmarkTest` records OFF/ON timings for inclusive, exclusive, reversed, negative, and empty ranges. Semantics are preserved; non‑int or complex ranges fall back to the generic iterator.
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
- If a benchmark shows regressions, flip related flags OFF to isolate the source (e.g., `ARG_BUILDER`, `RVAL_FASTPATH`, `FIELD_PIC`, `METHOD_PIC`).
|
||||
- Use `PIC_DEBUG_COUNTERS` to observe inline cache effectiveness.
|
||||
- Ensure tests do not accidentally keep flags ON for subsequent tests; reset after each test.
|
||||
|
||||
|
||||
## JVM micro-benchmark results (3× medians; OFF → ON)
|
||||
|
||||
Date: 2025-11-10 23:04 (local)
|
||||
|
||||
| Flag | Benchmark/Test | OFF median (ms) | ON median (ms) | Speedup | Notes |
|
||||
|--------------------|----------------------------------------------|-----------------:|----------------:|:-------:|-------|
|
||||
| ARG_BUILDER | CallMixedArityBenchmarkTest | 788.02 | 668.79 | 1.18× | Clear win on mixed arity |
|
||||
| ARG_BUILDER | CallBenchmarkTest (simple calls) | 423.87 | 425.47 | 1.00× | Neutral on repeated simple calls |
|
||||
| FIELD_PIC | PicBenchmarkTest::benchmarkFieldGetSetPic | 113.575 | 106.017 | 1.07× | Small but consistent win |
|
||||
| METHOD_PIC | PicBenchmarkTest::benchmarkMethodPic | 251.068 | 149.439 | 1.68× | Large consistent win |
|
||||
| RVAL_FASTPATH | ExpressionBenchmarkTest | 514.491 | 426.800 | 1.21× | Consistent win in expression chains |
|
||||
| PRIMITIVE_FASTOPS | ArithmeticBenchmarkTest (int-sum) | 243.420 | 128.146 | 1.90× | Big win for integer addition |
|
||||
| PRIMITIVE_FASTOPS | ArithmeticBenchmarkTest (int-cmp) | 210.385 | 168.534 | 1.25× | Moderate win for comparisons |
|
||||
| SCOPE_POOL | CallPoolingBenchmarkTest | 505.778 | 366.737 | 1.38× | Single-threaded bench; per-thread ThreadLocal pool; default ON on JVM |
|
||||
|
||||
Notes:
|
||||
- All results obtained from `[DEBUG_LOG] [BENCH]` outputs with three repeated Gradle test invocations per configuration; medians reported.
|
||||
- JVM defaults (current): `ARG_BUILDER=true`, `PRIMITIVE_FASTOPS=true`, `RVAL_FASTPATH=true`, `FIELD_PIC=true`, `METHOD_PIC=true`, `SCOPE_POOL=true` (per‑thread ThreadLocal pool), `REGEX_CACHE=true`.
|
||||
|
||||
|
||||
## Concurrency (multi‑core) pooling results (3× medians; OFF → ON)
|
||||
|
||||
Date: 2025-11-10 22:56 (local)
|
||||
|
||||
| Flag | Benchmark/Test | OFF median (ms) | ON median (ms) | Speedup | Notes |
|
||||
|------------|--------------------------------------|-----------------:|----------------:|:-------:|-------|
|
||||
| SCOPE_POOL | ConcurrencyCallBenchmarkTest (JVM) | 521.102 | 201.374 | 2.59× | Multithreaded workload on `Dispatchers.Default` with per‑thread ThreadLocal pool; workers=8, iters=15000/worker. |
|
||||
|
||||
Methodology:
|
||||
- The test toggles `PerfFlags.SCOPE_POOL` within a single run and executes the same script across N worker coroutines scheduled on `Dispatchers.Default`.
|
||||
- We executed the test three times via Gradle and computed medians from the printed `[DEBUG_LOG]` timings:
|
||||
- OFF runs (ms): 532.442 | 521.102 | 474.386 → median 521.102
|
||||
- ON runs (ms): 218.683 | 201.374 | 198.737 → median 201.374
|
||||
- Speedup = OFF/ON.
|
||||
|
||||
Reproduce:
|
||||
```
|
||||
./gradlew :lynglib:jvmTest --tests "ConcurrencyCallBenchmarkTest" --rerun-tasks
|
||||
```
|
||||
|
||||
|
||||
## Next optimization steps (JVM)
|
||||
|
||||
Date: 2025-11-10 23:04 (local)
|
||||
|
||||
- PICs
|
||||
- Widen METHOD_PIC to 3–4 entries with tiny LRU; keep invalidation on layout change; re-run `PicInvalidationJvmTest`.
|
||||
- Micro fast-path for FIELD_PIC read-then-write pairs (`x = x + 1`) to reuse the resolved slot within one step.
|
||||
- Locals and slots
|
||||
- Pre-size `Scope` slot structures when compiler knows local/param counts; audit `EMIT_FAST_LOCAL_REFS` coverage.
|
||||
- Re-run `LocalVarBenchmarkTest` to quantify gains.
|
||||
- RVAL_FASTPATH coverage
|
||||
- Cover primitive `ObjList` index reads, pure receivers in `FieldRef`, and assignment RHS where safe; add micro-benches to `ExpressionBenchmarkTest`.
|
||||
- Collections and ranges
|
||||
- Specialize `(Int..Int)` loops into tight counted loops (no intermediary objects).
|
||||
- Add primitive-specialized `ObjList` ops (`map`, `filter`, `sum`, `contains`) under `PRIMITIVE_FASTOPS`.
|
||||
- Regex and strings
|
||||
- Cache compiled regex for string literals at compile time; add a tiny LRU for dynamic patterns behind `REGEX_CACHE`.
|
||||
- Add `RegexBenchmarkTest` for repeated matches.
|
||||
- JIT friendliness (Kotlin/JVM)
|
||||
- Inline tiny helpers in hot paths, prefer arrays for internal buffers, finalize hot data structures where safe.
|
||||
|
||||
Validation matrix
|
||||
- Always re-run: `CallBenchmarkTest`, `CallMixedArityBenchmarkTest`, `PicBenchmarkTest`, `ExpressionBenchmarkTest`, `ArithmeticBenchmarkTest`, `CallPoolingBenchmarkTest`, `DeepPoolingStressJvmTest`, `ConcurrencyCallBenchmarkTest` (3× medians when comparing).
|
||||
- Keep full `:lynglib:jvmTest` green after each change.
|
||||
|
||||
|
||||
|
||||
## PIC update (4‑way METHOD_PIC) — JVM (3× medians; OFF → ON)
|
||||
|
||||
Date: 2025-11-11 00:16 (local)
|
||||
|
||||
| Flag | Benchmark/Test | OFF median (ms) | ON median (ms) | Speedup | Notes |
|
||||
|-----------|-----------------------------------------------|-----------------:|----------------:|:-------:|-------|
|
||||
| FIELD_PIC | PicBenchmarkTest::benchmarkFieldGetSetPic | 207.578 | 106.481 | 1.95× | Read→write loop; micro fast‑path groundwork present |
|
||||
| METHOD_PIC| PicBenchmarkTest::benchmarkMethodPic | 273.478 | 182.226 | 1.50× | 4‑way PIC with move‑to‑front (was 2‑way before) |
|
||||
|
||||
Medians computed from three Gradle runs in this session; see `[DEBUG_LOG] [BENCH]` lines in test output.
|
||||
|
||||
|
||||
## Locals/slots capacity (pre‑sizing hints) — JVM (3× medians; OFF → ON)
|
||||
|
||||
Date: 2025-11-11 13:19 (local)
|
||||
|
||||
| Optimization | Benchmark/Test | OFF config | ON config | OFF median (ms) | ON median (ms) | Speedup | Notes |
|
||||
|-------------------------|-----------------------------|------------------------------------|------------------------------------|-----------------:|----------------:|:-------:|-------|
|
||||
| Locals pre‑sizing + PIC | LocalVarBenchmarkTest | LOCAL_SLOT_PIC=OFF, FAST_LOCAL=OFF | LOCAL_SLOT_PIC=ON, FAST_LOCAL=ON | 472.129 | 370.871 | 1.27× | Compiler hint `params+4`; slot pre‑size; semantics unchanged |
|
||||
|
||||
Methodology:
|
||||
- Each configuration executed three times via `:lynglib:jvmTest --tests "…" --rerun-tasks`; medians reported.
|
||||
- Locals improvement stacks with per‑thread `SCOPE_POOL` and ARG fast paths.
|
||||
|
||||
|
||||
|
||||
|
||||
## RVAL fast paths update — JVM (IndexRef and FieldRef) [3× medians; OFF → ON]
|
||||
|
||||
Date: 2025-11-11 13:19 (local)
|
||||
|
||||
New micro-benchmarks have been added to quantify the latest `RVAL_FASTPATH` extensions:
|
||||
- Primitive `ObjList` index-read fast path in `IndexRef`.
|
||||
- Conservative “pure receiver” evaluation in `FieldRef` (monomorphic, immutable receiver), preserving visibility/mutability checks and optional chaining semantics.
|
||||
|
||||
Benchmarks to run (each 3× OFF → ON):
|
||||
- `ExpressionBenchmarkTest::benchmarkListIndexReads`
|
||||
- `ExpressionBenchmarkTest::benchmarkFieldReadPureReceiver`
|
||||
|
||||
Reproduce (3× each; collect `[DEBUG_LOG] [BENCH]` lines and compute medians):
|
||||
```
|
||||
./gradlew :lynglib:jvmTest --tests "ExpressionBenchmarkTest.benchmarkListIndexReads" --rerun-tasks
|
||||
./gradlew :lynglib:jvmTest --tests "ExpressionBenchmarkTest.benchmarkListIndexReads" --rerun-tasks
|
||||
./gradlew :lynglib:jvmTest --tests "ExpressionBenchmarkTest.benchmarkListIndexReads" --rerun-tasks
|
||||
|
||||
./gradlew :lynglib:jvmTest --tests "ExpressionBenchmarkTest.benchmarkFieldReadPureReceiver" --rerun-tasks
|
||||
./gradlew :lynglib:jvmTest --tests "ExpressionBenchmarkTest.benchmarkFieldReadPureReceiver" --rerun-tasks
|
||||
./gradlew :lynglib:jvmTest --tests "ExpressionBenchmarkTest.benchmarkFieldReadPureReceiver" --rerun-tasks
|
||||
```
|
||||
|
||||
Once collected, add medians and speedups to the table below:
|
||||
|
||||
| Flag | Benchmark/Test | OFF median (ms) | ON median (ms) | Speedup | Notes |
|
||||
|---------------|---------------------------------------------------|-----------------:|----------------:|:-------:|-------|
|
||||
| RVAL_FASTPATH | ExpressionBenchmarkTest::benchmarkListIndexReads | 305.243 | 230.942 | 1.32× | Fast path in `IndexRef` for `ObjList` + `ObjInt` index |
|
||||
| RVAL_FASTPATH | ExpressionBenchmarkTest::benchmarkFieldReadPureReceiver | 266.222 | 190.720 | 1.40× | Pure-receiver evaluation in `FieldRef` (monomorphic, immutable) |
|
||||
|
||||
Notes:
|
||||
- Both benches toggle `PerfFlags.RVAL_FASTPATH` within a single run to produce OFF and ON timings under identical conditions.
|
||||
- Correctness assertions ensure the loops are not optimized away.
|
||||
- All semantics (visibility/mutability checks, optional chaining) remain intact; fast paths only skip interim `ObjRecord` traffic when safe.
|
||||
|
||||
|
||||
## ARG_BUILDER — splat fast‑path (3× medians; OFF → ON)
|
||||
|
||||
Date: 2025-11-11 13:12 (local)
|
||||
|
||||
Environment: Gradle 8.7; JVM (JDK as configured by toolchain); single‑threaded test execution; stdout enabled.
|
||||
|
||||
| Flag | Benchmark/Test | OFF median (ms) | ON median (ms) | Speedup | Notes |
|
||||
|-------------|-----------------------------------|-----------------:|----------------:|:-------:|-------|
|
||||
| ARG_BUILDER | CallSplatBenchmarkTest (splat) | 613.689 | 463.593 | 1.32× | Single‑splat fast‑path returns underlying list directly; avoids intermediate copies |
|
||||
|
||||
Inputs (3×):
|
||||
- OFF runs (ms): 613.689 | 629.604 | 612.361 → median 613.689
|
||||
- ON runs (ms): 453.752 | 463.593 | 468.844 → median 463.593
|
||||
|
||||
Reproduce (3×):
|
||||
```
|
||||
./gradlew :lynglib:jvmTest --tests "CallSplatBenchmarkTest" --rerun-tasks
|
||||
```
|
||||
|
||||
|
||||
|
||||
## Phase A consolidation (JVM) — 3× medians updated
|
||||
|
||||
Date: 2025-11-11 13:48 (local)
|
||||
Environment:
|
||||
- JDK: OpenJDK 20.0.2.1 (Amazon Corretto 20.0.2.1+10-FR)
|
||||
- Gradle: 8.7
|
||||
- OS/Arch: macOS 14.8.1 (aarch64)
|
||||
|
||||
### ARG_BUILDER
|
||||
|
||||
| Benchmark/Test | OFF median (ms) | ON median (ms) | Speedup | Notes |
|
||||
|----------------------------------|-----------------:|----------------:|:-------:|-------|
|
||||
| CallMixedArityBenchmarkTest | 866.681 | 717.439 | 1.21× | Small-arity 0–8 fast path + builder; correctness preserved |
|
||||
| CallSplatBenchmarkTest (splat) | 600.880 | 459.706 | 1.31× | Single-splat fast path returns underlying list; avoids copies |
|
||||
|
||||
Inputs (3×):
|
||||
- Mixed arity OFF: 874.088291 | 866.680959 | 858.577125 → median 866.680959
|
||||
- Mixed arity ON: 731.308625 | 706.440125 | 717.438542 → median 717.438542
|
||||
- Splat OFF: 600.268625 | 607.849416 | 600.879666 → median 600.879666
|
||||
- Splat ON: 459.706375 | 449.950166 | 461.815167 → median 459.706375
|
||||
|
||||
### RVAL_FASTPATH (new coverage)
|
||||
|
||||
| Benchmark/Test | OFF median (ms) | ON median (ms) | Speedup | Notes |
|
||||
|--------------------------------------------------|-----------------:|----------------:|:-------:|-------|
|
||||
| ExpressionBenchmarkTest::benchmarkListIndexReads | 299.366 | 218.812 | 1.37× | IndexRef fast path for ObjList + ObjInt |
|
||||
| ExpressionBenchmarkTest::benchmarkFieldReadPureReceiver | 268.315 | 186.032 | 1.44× | Pure-receiver evaluation in FieldRef (monomorphic, immutable) |
|
||||
|
||||
Inputs (3×):
|
||||
- ListIndex OFF: 291.344 | 310.717167 | 299.365709 → median 299.365709
|
||||
- ListIndex ON: 217.795375 | 221.504166 | 218.812042 → median 218.812042
|
||||
- FieldRead OFF: 267.2775 | 274.355208 | 268.315125 → median 268.315125
|
||||
- FieldRead ON: 189.599333 | 186.031791 | 182.069167 → median 186.031791
|
||||
|
||||
### Locals/slots capacity (precise hints)
|
||||
|
||||
| Benchmark/Test | OFF config | ON config | OFF median (ms) | ON median (ms) | Speedup | Notes |
|
||||
|---------------------------|------------------------------------|------------------------------------|-----------------:|----------------:|:-------:|-------|
|
||||
| LocalVarBenchmarkTest | LOCAL_SLOT_PIC=OFF, FAST_LOCAL=OFF | LOCAL_SLOT_PIC=ON, FAST_LOCAL=ON | 446.018 | 347.964 | 1.28× | Precise capacity hints + fast-locals coverage |
|
||||
|
||||
Inputs (3×):
|
||||
- Locals OFF: 470.575041 | 441.89625 | 446.017833 → median 446.017833
|
||||
- Locals ON: 370.664208 | 345.615541 | 347.964291 → median 347.964291
|
||||
|
||||
Methodology:
|
||||
- Each test executed three times via Gradle with stdout enabled; medians computed from `[DEBUG_LOG] [BENCH]` lines.
|
||||
- Full JVM tests and stress benches remain green in this cycle.
|
||||
|
||||
|
||||
|
||||
## Phase B — List ops specialization (PRIMITIVE_FASTOPS) — 3× medians (OFF → ON)
|
||||
|
||||
Date: 2025-11-11 13:48 (local)
|
||||
Environment:
|
||||
- JDK: OpenJDK 20.0.2.1 (Amazon Corretto 20.0.2.1+10-FR)
|
||||
- Gradle: 8.7
|
||||
- OS/Arch: macOS 14.8.1 (aarch64)
|
||||
|
||||
| Optimization | Benchmark/Test | OFF median (ms) | ON median (ms) | Speedup | Notes |
|
||||
|---------------------|------------------------------------------|-----------------:|----------------:|:-------:|-------|
|
||||
| PRIMITIVE_FASTOPS | ListOpsBenchmarkTest::benchmarkSumInts | 324.805 | 144.908 | 2.24× | ObjList.sum fast path for int lists; generic fallback preserved |
|
||||
| PRIMITIVE_FASTOPS | ListOpsBenchmarkTest::benchmarkContainsInts | 440.414 | 415.476 | 1.06× | ObjList.contains fast path when searching ObjInt in int list |
|
||||
|
||||
Inputs (3×):
|
||||
- list-sum OFF: 332.863417 | 323.491625 | 324.804083 → median 324.804083
|
||||
- list-sum ON: 144.907833 | 148.870792 | 126.418542 → median 144.907833
|
||||
- list-contains OFF: 440.413709 | 440.368333 | 441.4365 → median 440.413709
|
||||
- list-contains ON: 416.465292 | 412.283291 | 415.475833 → median 415.475833
|
||||
|
||||
Methodology:
|
||||
- Each test executed three times via Gradle; medians computed from `[DEBUG_LOG] [BENCH]` lines.
|
||||
- Changes are fully guarded by `PerfFlags.PRIMITIVE_FASTOPS`; semantics preserved (null on empty sum; generic fallback on mixed types).
|
||||
|
||||
|
||||
|
||||
### Phase B — Ranges for-in lowering (PRIMITIVE_FASTOPS) — 3× medians (OFF → ON)
|
||||
|
||||
Date: 2025-11-11 13:48 (local)
|
||||
Environment:
|
||||
- JDK: OpenJDK 20.0.2.1 (Amazon Corretto 20.0.2.1+10-FR)
|
||||
- Gradle: 8.7
|
||||
- OS/Arch: macOS 14.8.1 (aarch64)
|
||||
|
||||
| Optimization | Benchmark/Test | OFF median (ms) | ON median (ms) | Speedup | Notes |
|
||||
|---------------------|------------------------------------------|-----------------:|----------------:|:-------:|-------|
|
||||
| PRIMITIVE_FASTOPS | RangeBenchmarkTest::benchmarkIntRangeForIn | 1705.299 | 788.974 | 2.16× | Tight counted loop for (Int..Int) for-in; preserves semantics |
|
||||
|
||||
Inputs (3×):
|
||||
- range-for-in OFF: 1705.298958 | 1684.357708 | 1735.880917 → median 1705.298958
|
||||
- range-for-in ON: 794.178458 | 778.741834 | 788.973625 → median 788.973625
|
||||
|
||||
Methodology:
|
||||
- Each configuration executed three times via Gradle; medians computed from `[DEBUG_LOG] [BENCH]` lines.
|
||||
- Lowering is guarded by `PerfFlags.PRIMITIVE_FASTOPS` and applies only when the source is an `ObjRange` with int bounds; otherwise falls back to generic iteration.
|
||||
|
||||
|
||||
|
||||
## Phase B — Regex caching (REGEX_CACHE) — 3× medians (OFF → ON)
|
||||
|
||||
Date: 2025-11-11 13:48 (local)
|
||||
Environment:
|
||||
- JDK: OpenJDK 20.0.2.1 (Amazon Corretto 20.0.2.1+10-FR)
|
||||
- Gradle: 8.7
|
||||
- OS/Arch: macOS 14.8.1 (aarch64)
|
||||
|
||||
| Flag | Benchmark/Test | OFF median (ms) | ON median (ms) | Speedup | Notes |
|
||||
|--------------|---------------------------------------------------|-----------------:|----------------:|:-------:|-------|
|
||||
| REGEX_CACHE | RegexBenchmarkTest::benchmarkLiteralPatternMatches | 378.246 | 275.890 | 1.37× | Caches compiled regex for identical literal pattern per iteration |
|
||||
| REGEX_CACHE | RegexBenchmarkTest::benchmarkDynamicPatternMatches | 514.944 | 229.006 | 2.25× | Two dynamic patterns alternate; cache size sufficient to retain both |
|
||||
|
||||
Inputs (1× here; can extend to 3× on request):
|
||||
- regex-literal OFF: 378.245916; ON: 275.889541
|
||||
- regex-dynamic OFF: 514.944167; ON: 229.005834
|
||||
|
||||
Methodology:
|
||||
- Each benchmark toggles `PerfFlags.REGEX_CACHE` inside a single test and prints `[DEBUG_LOG]` timings for OFF and ON runs under identical conditions. We recorded one set of OFF/ON timings here; we can extend to 3× medians if required for publication.
|
||||
- The cache is a tiny size-bounded map (64 entries) activated only when `PerfFlags.REGEX_CACHE` is true. Defaults remain OFF.
|
||||
|
||||
|
||||
|
||||
|
||||
## JIT tweaks (Round 1) — quick gains snapshot (locals, ranges, list ops)
|
||||
|
||||
Date: 2025-11-11 21:05 (local)
|
||||
|
||||
Scope: fast confirmation of overall gain using current configuration; focused on locals, ranges, and list ops. Each test prints OFF → ON timings in a single run. We executed the benches via Gradle with stdout enabled and single test fork.
|
||||
|
||||
Environment:
|
||||
- Gradle: 8.7 (stdout enabled, maxParallelForks=1)
|
||||
- JVM: as configured by toolchain for this project
|
||||
- OS/Arch: per developer machine (unchanged from prior sections)
|
||||
|
||||
Reproduce:
|
||||
```
|
||||
./gradlew :lynglib:jvmTest --tests LocalVarBenchmarkTest --rerun-tasks
|
||||
./gradlew :lynglib:jvmTest --tests RangeBenchmarkTest --rerun-tasks
|
||||
./gradlew :lynglib:jvmTest --tests ListOpsBenchmarkTest --rerun-tasks
|
||||
```
|
||||
|
||||
Results (representative runs; OFF → ON):
|
||||
- Local variables — LOCAL_SLOT_PIC + EMIT_FAST_LOCAL_REFS
|
||||
- Run 1: 468.407 ms → 367.277 ms (≈ 1.28×)
|
||||
- Run 2: 447.031 ms → 346.126 ms (≈ 1.29×)
|
||||
- Ranges for‑in — PRIMITIVE_FASTOPS (tight counted loop for (Int..Int))
|
||||
- 1731.780 ms → 799.023 ms (≈ 2.17×)
|
||||
- List ops — PRIMITIVE_FASTOPS
|
||||
- sum(int list): 318.943 ms → 148.571 ms (≈ 2.15×)
|
||||
- contains(int in int list): 440.013 ms → 412.450 ms (≈ 1.07×)
|
||||
|
||||
Summary: All three areas improved with optimizations ON; no regressions observed in these runs. For publication‑grade stability, run each test 3× and report medians (see sections below for methodology and previous median tables).
|
||||
|
||||
|
||||
## Additional tweaks — verification snapshot (Index write fast‑path, List literal pre‑size, Regex LRU)
|
||||
|
||||
Date: 2025-11-11 21:31 (local)
|
||||
|
||||
Scope: Implemented three semantics‑neutral optimizations and verified they are green across targeted and broader JVM benches.
|
||||
|
||||
What changed (guarded by flags where applicable):
|
||||
- RVAL_FASTPATH: Index write fast‑path
|
||||
- `IndexRef.setAt`: direct path for `ObjList` + `ObjInt` (`list[i] = value`) mirrors the read fast‑path. Optional chaining semantics preserved; bounds exceptions propagate unchanged.
|
||||
- RVAL_FASTPATH: List literal pre‑sizing
|
||||
- `ListLiteralRef.get`: pre‑counts element entries and uses `ArrayList` with capacity hint; for spreads of `ObjList`, uses `ensureCapacity` before bulk add. Evaluation order unchanged.
|
||||
- REGEX_CACHE: LRU‑like behavior
|
||||
- `RegexCache`: emulates access‑order LRU within a tiny bounded map (`MAX=64`) by moving accessed entries to the tail; improves alternating‑pattern scenarios. Only active when `PerfFlags.REGEX_CACHE` is true.
|
||||
|
||||
Reproduce quick verification (1× runs):
|
||||
```
|
||||
./gradlew :lynglib:jvmTest --tests ExpressionBenchmarkTest --rerun-tasks
|
||||
./gradlew :lynglib:jvmTest --tests ListOpsBenchmarkTest --rerun-tasks
|
||||
./gradlew :lynglib:jvmTest --tests RegexBenchmarkTest --rerun-tasks
|
||||
./gradlew :lynglib:jvmTest --tests PicBenchmarkTest --rerun-tasks
|
||||
./gradlew :lynglib:jvmTest --tests PicInvalidationJvmTest --rerun-tasks
|
||||
./gradlew :lynglib:jvmTest --tests LocalVarBenchmarkTest --rerun-tasks
|
||||
./gradlew :lynglib:jvmTest --tests ConcurrencyCallBenchmarkTest --rerun-tasks
|
||||
./gradlew :lynglib:jvmTest --tests DeepPoolingStressJvmTest --rerun-tasks
|
||||
./gradlew :lynglib:jvmTest --tests MultiThreadPoolingStressJvmTest --rerun-tasks
|
||||
```
|
||||
|
||||
Observation: All listed tests green in this cycle; no behavioral regressions observed. For the new paths (index write, list literal), performance was neutral‑to‑positive in smoke runs; Regex benches remained positive or neutral with the LRU behavior. For publication‑grade medians, extend to 3× per test as in earlier sections.
|
||||
|
||||
|
||||
## Sanity matrix (JVM) — quick OFF→ON runs
|
||||
|
||||
Date: 2025-11-11 21:59 (local)
|
||||
|
||||
Scope: Final Round 1 sanity sweep across JVM micro‑benches and stress tests to confirm that optimizations ON do not regress performance vs OFF in representative scenarios. Each benchmark prints `[DEBUG_LOG] [BENCH]` timings for OFF → ON within a single run. This section records a quick pass confirmation (not 3× medians) and reproduction commands.
|
||||
|
||||
Environment:
|
||||
- Gradle: 8.7 (stdout enabled, maxParallelForks=1)
|
||||
- JVM: as configured by the project toolchain
|
||||
- OS/Arch: macOS 14.x (aarch64)
|
||||
|
||||
Benches covered (all green; no regressions observed in these runs):
|
||||
- Calls/Args: `CallBenchmarkTest`, `CallMixedArityBenchmarkTest` (ARG_BUILDER)
|
||||
- PICs: `PicBenchmarkTest` (field/method); `PicInvalidationJvmTest` correctness reconfirmed
|
||||
- Expressions/Arithmetic: `ExpressionBenchmarkTest`, `ArithmeticBenchmarkTest` (RVAL_FASTPATH, PRIMITIVE_FASTOPS)
|
||||
- Ranges: `RangeBenchmarkTest` (PRIMITIVE_FASTOPS counted loop)
|
||||
- List ops: `ListOpsBenchmarkTest` (PRIMITIVE_FASTOPS specializations)
|
||||
- Regex: `RegexBenchmarkTest` (REGEX_CACHE with LRU behavior)
|
||||
- Locals: `LocalVarBenchmarkTest` (LOCAL_SLOT_PIC + FAST_LOCAL)
|
||||
- Concurrency/Pooling: `ConcurrencyCallBenchmarkTest`, `DeepPoolingStressJvmTest`, `MultiThreadPoolingStressJvmTest` (SCOPE_POOL per‑thread)
|
||||
|
||||
Reproduce (examples):
|
||||
```
|
||||
./gradlew :lynglib:jvmTest --tests CallBenchmarkTest --rerun-tasks
|
||||
./gradlew :lynglib:jvmTest --tests CallMixedArityBenchmarkTest --rerun-tasks
|
||||
./gradlew :lynglib:jvmTest --tests PicBenchmarkTest --rerun-tasks
|
||||
./gradlew :lynglib:jvmTest --tests PicInvalidationJvmTest --rerun-tasks
|
||||
./gradlew :lynglib:jvmTest --tests ExpressionBenchmarkTest --rerun-tasks
|
||||
./gradlew :lynglib:jvmTest --tests ArithmeticBenchmarkTest --rerun-tasks
|
||||
./gradlew :lynglib:jvmTest --tests RangeBenchmarkTest --rerun-tasks
|
||||
./gradlew :lynglib:jvmTest --tests ListOpsBenchmarkTest --rerun-tasks
|
||||
./gradlew :lynglib:jvmTest --tests RegexBenchmarkTest --rerun-tasks
|
||||
./gradlew :lynglib:jvmTest --tests LocalVarBenchmarkTest --rerun-tasks
|
||||
./gradlew :lynglib:jvmTest --tests ConcurrencyCallBenchmarkTest --rerun-tasks
|
||||
./gradlew :lynglib:jvmTest --tests DeepPoolingStressJvmTest --rerun-tasks
|
||||
./gradlew :lynglib:jvmTest --tests MultiThreadPoolingStressJvmTest --rerun-tasks
|
||||
```
|
||||
|
||||
Summary:
|
||||
- All listed tests passed in this sanity sweep.
|
||||
- For each benchmark’s OFF → ON printouts examined during this pass, ON was equal or faster than OFF; no ON<OFF regressions were observed.
|
||||
- For publication‑grade numbers, use the 3× medians methodology outlined earlier in this document. The existing median tables in previous sections remain representative, and the additional tweaks (Index write, List literal pre‑size, Regex LRU, Field PIC 4‑way + read→write reuse, mixed Int/Real fast‑ops) remained neutral‑to‑positive.
|
||||
|
||||
|
||||
## Quick snapshot — IndexRef PIC + negative miss cache (JVM) — 3× medians (OFF → ON)
|
||||
|
||||
Date: 2025-11-11 22:32 (local)
|
||||
|
||||
Scope
|
||||
- Confirm that the latest changes — IndexRef read/write PIC (stacked on RVAL_FASTPATH) and safe catch‑and‑cache negative entries for Field/Method PICs — do not regress performance. We collected 3× medians for the two expression sub‑benches that are most sensitive to RVAL paths and cross‑checked PICs and ranges.
|
||||
|
||||
Environment
|
||||
- Gradle: 8.7 (stdout enabled, maxParallelForks=1)
|
||||
- JVM: project toolchain default
|
||||
- OS/Arch: macOS 14.x (aarch64)
|
||||
|
||||
Results (3× medians)
|
||||
|
||||
| Area | Benchmark/Test | OFF median (ms) | ON median (ms) | Speedup | Notes |
|
||||
|------|-----------------|-----------------:|----------------:|:-------:|-------|
|
||||
| RVAL_FASTPATH | ExpressionBenchmarkTest::benchmarkListIndexReads | 304.282 | 229.168 | 1.33× | IndexRef direct fast‑path for ObjList+ObjInt; 4‑way Index PIC handles polymorphic cases |
|
||||
| RVAL_FASTPATH | ExpressionBenchmarkTest::benchmarkFieldReadPureReceiver | 275.122 | 194.876 | 1.41× | Monomorphic, immutable receiver path; preserves visibility/optional semantics |
|
||||
|
||||
Cross‑checks (from the same session, 1× quick)
|
||||
- PicBenchmarkTest::benchmarkFieldGetSetPic — OFF 203.701 ms → ON 117.129 ms (≈1.74×)
|
||||
- PicBenchmarkTest::benchmarkMethodPic — OFF 280.806 ms → ON 202.613 ms (≈1.39×)
|
||||
- RangeBenchmarkTest::benchmarkIntRangeForIn — OFF 1762.425 ms → ON 806.898 ms (≈2.18×)
|
||||
|
||||
Reproduce
|
||||
```
|
||||
./gradlew :lynglib:jvmTest --tests "ExpressionBenchmarkTest.benchmarkListIndexReads" --rerun-tasks
|
||||
./gradlew :lynglib:jvmTest --tests "ExpressionBenchmarkTest.benchmarkListIndexReads" --rerun-tasks
|
||||
./gradlew :lynglib:jvmTest --tests "ExpressionBenchmarkTest.benchmarkListIndexReads" --rerun-tasks
|
||||
|
||||
./gradlew :lynglib:jvmTest --tests "ExpressionBenchmarkTest.benchmarkFieldReadPureReceiver" --rerun-tasks
|
||||
./gradlew :lynglib:jvmTest --tests "ExpressionBenchmarkTest.benchmarkFieldReadPureReceiver" --rerun-tasks
|
||||
./gradlew :lynglib:jvmTest --tests "ExpressionBenchmarkTest.benchmarkFieldReadPureReceiver" --rerun-tasks
|
||||
|
||||
./gradlew :lynglib:jvmTest --tests PicBenchmarkTest --rerun-tasks
|
||||
./gradlew :lynglib:jvmTest --tests RangeBenchmarkTest --rerun-tasks
|
||||
```
|
||||
|
||||
Notes
|
||||
- Negative caches are installed only after a real miss throws (cache‑after‑miss), preserving error semantics and invalidation on `layoutVersion` changes.
|
||||
- IndexRef PIC augments the existing direct path and uses move‑to‑front promotion; it is keyed on `(classId, layoutVersion)` like other PICs.
|
||||
|
||||
@@ -0,0 +1,58 @@
|
||||
# JVM-only Performance Optimization Plan (Saved)
|
||||
|
||||
[//]: # (excludeFromIndex)
|
||||
|
||||
Date: 2025-11-10 22:14 (local)
|
||||
|
||||
This document captures the agreed next optimization steps so we can restore the plan later if needed.
|
||||
|
||||
## Objectives
|
||||
- Reduce overhead on the call/argument path.
|
||||
- Extend and harden PIC performance (fields/methods/locals).
|
||||
- Improve R-value fast paths and interpreter hot nodes (loops, ranges, lists).
|
||||
- Make scope frame pooling thread-safe on JVM so it can be enabled by default later.
|
||||
- Keep semantics correct and all JVM tests green.
|
||||
|
||||
## Prioritized tasks (now)
|
||||
1) Call/argument path: fewer allocs, tighter fast paths
|
||||
- Extend small-arity zero-alloc path to 6–8 args; benchmark with `CallMixedArityBenchmarkTest`.
|
||||
- Splat handling: fast-path single-list splats; benchmark with `CallSplatBenchmarkTest`.
|
||||
- Arg builder micro-optimizations: capacity hints, avoid redundant copies, inline simple branches.
|
||||
- Optional-chaining fast return (`SKIP_ARGS_ON_NULL_RECEIVER`) coverage audit, add A/B bench.
|
||||
|
||||
2) Scope frame pooling: per-thread safety on JVM
|
||||
- Replace global deque with ThreadLocal pool on JVM (and Android) actuals.
|
||||
- Keep `frameId` uniqueness and pool size cap.
|
||||
- Verify with `DeepPoolingStressJvmTest`, `CallPoolingBenchmarkTest`, and spot benches.
|
||||
- Do NOT flip default yet; keep `SCOPE_POOL=false` unless explicitly approved.
|
||||
|
||||
## Next tasks (queued)
|
||||
3) PICs: cheaper misses, broader hits
|
||||
- Method PIC 2→3/4 entries (tiny LRU); validate with `PicInvalidationJvmTest`.
|
||||
- Field PIC micro-fast path for read-then-write pairs.
|
||||
|
||||
4) Locals and slots
|
||||
- Ensure `EMIT_FAST_LOCAL_REFS` coverage across compiler sites.
|
||||
- Pre-size `slots`/`nameToSlot` when local counts are known; re-run `LocalVarBenchmarkTest`.
|
||||
|
||||
5) R-value fast path coverage
|
||||
- Cover index reads on primitive lists, pure receivers, assignment RHS where safe.
|
||||
- Add benches in `ExpressionBenchmarkTest`.
|
||||
|
||||
6) Collections & ranges
|
||||
- Tight counted loop for `(Int..Int)` in `for`.
|
||||
- Primitive-specialized `ObjList` ops (`map`, `filter`, `sum`, `contains`) under `PRIMITIVE_FASTOPS`.
|
||||
|
||||
7) Regex and string ops
|
||||
- Cache compiled regex for string literals at compile time; tiny LRU for dynamic patterns under a new `REGEX_CACHE` flag.
|
||||
|
||||
8) JIT micro-tweaks
|
||||
- Inline tiny helpers; prefer arrays for hot buffers; finalize hot classes where safe.
|
||||
|
||||
## Validation matrix
|
||||
- Always re-run: `CallBenchmarkTest`, `CallMixedArityBenchmarkTest`, `PicBenchmarkTest`, `ExpressionBenchmarkTest`, `ArithmeticBenchmarkTest`, `CallPoolingBenchmarkTest`, `DeepPoolingStressJvmTest`.
|
||||
- Use 3× medians where comparing flags; keep `:lynglib:jvmTest` green.
|
||||
|
||||
## Notes
|
||||
- All risky changes remain flag-guarded and JVM-only where applicable.
|
||||
- Documentation and perf tables updated after each cycle.
|
||||
@@ -0,0 +1,95 @@
|
||||
|
||||
# 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.
|
||||
|
||||
Keys can be either:
|
||||
- string literals: `{ "some key": value }`, or
|
||||
- identifiers: `{ name: expr }`, where the key becomes the string `"name"`.
|
||||
|
||||
Identifier shorthand inside map literals is supported:
|
||||
- `{ name: }` desugars to `{ "name": name }`.
|
||||
|
||||
Property access sugar is not provided for maps: use bracket access only, e.g. `m["a"]`, not `m.a`.
|
||||
|
||||
Examples:
|
||||
|
||||
```lyng
|
||||
val x = 2
|
||||
val m = { "a": 1, x: x*10, y: }
|
||||
assertEquals(1, m["a"]) // string-literal key
|
||||
assertEquals(20, m["x"]) // identifier key
|
||||
assertEquals(2, m["y"]) // identifier shorthand
|
||||
```
|
||||
|
||||
Spreads (splats) in map literals are allowed and merged left-to-right with “rightmost wins” semantics:
|
||||
|
||||
```lyng
|
||||
val base = { a: 1, b: 2 }
|
||||
val m = { a: 0, ...base, b: 3, c: 4 }
|
||||
assertEquals(1, m["a"]) // base overwrites a:0
|
||||
assertEquals(3, m["b"]) // literal overwrites spread
|
||||
assertEquals(4, m["c"]) // new key
|
||||
```
|
||||
|
||||
Trailing commas are allowed (optional):
|
||||
|
||||
```lyng
|
||||
val m = {
|
||||
"a": 1,
|
||||
b: 2,
|
||||
...other,
|
||||
}
|
||||
```
|
||||
|
||||
Duplicate keys among literal entries (including identifier shorthand) are a compile-time error:
|
||||
|
||||
```lyng
|
||||
{ foo: 1, "foo": 2 } // error: duplicate key "foo"
|
||||
{ foo:, foo: 2 } // error: duplicate key "foo"
|
||||
```
|
||||
|
||||
Spreads are evaluated at runtime. Overlaps from spreads are resolved by last write wins. If a spread is not a map, or yields a map with non-string keys, it’s a runtime error.
|
||||
|
||||
Merging with `+`/`+=` and entries:
|
||||
|
||||
```lyng
|
||||
("1" => 10) + ("2" => 20) // Map("1"=>10, "2"=>20)
|
||||
{ "1": 10 } + ("2" => 20) // same
|
||||
{ "1": 10 } + { "2": 20 } // same
|
||||
|
||||
var m = { "a": 1 }
|
||||
m += ("b" => 2) // m = { "a":1, "b":2 }
|
||||
```
|
||||
|
||||
Rightmost wins on duplicates consistently across spreads and merges. All map merging operations require string keys; encountering a non-string key during merge is a runtime error.
|
||||
|
||||
Empty map literal `{}` is not supported to avoid ambiguity with blocks/lambdas. Use `Map()` for an empty map.
|
||||
|
||||
Lambda disambiguation
|
||||
- A `{ ... }` with typed lambda parameters must have a top-level `->` in its header. The compiler disambiguates by looking for a top-level `->`. If none is found, it attempts to parse a map literal; if that fails, it is parsed as a lambda or block.
|
||||
|
||||
Grammar (EBNF)
|
||||
|
||||
```
|
||||
ws = zero or more whitespace (incl. newline/comments)
|
||||
map_literal = '{' ws map_entries ws '}'
|
||||
map_entries = map_entry ( ws ',' ws map_entry )* ( ws ',' )?
|
||||
map_entry = map_key ws ':' ws map_value_opt
|
||||
| '...' ws expression
|
||||
map_key = string_literal | ID
|
||||
map_value_opt = expression | ε // ε allowed only if map_key is ID
|
||||
```
|
||||
|
||||
Notes:
|
||||
- Identifier shorthand (`id:`) is allowed only for identifiers, not string-literal keys.
|
||||
- Spreads accept any expression; at runtime it must yield a `Map` with string keys.
|
||||
- Duplicate keys are detected at compile time among literal keys; spreads are merged at runtime with last-wins.
|
||||
|
||||
Rationale
|
||||
- The `{ name: value }` style is familiar and ergonomic.
|
||||
- Disambiguation with lambdas leverages the required `->` in typed lambda headers.
|
||||
- Avoiding `m.a` sidesteps method/field shadowing and keeps semantics clear.
|
||||
|
||||
@@ -0,0 +1,70 @@
|
||||
# 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.
|
||||
|
||||
Examples:
|
||||
|
||||
```lyng
|
||||
fun test(a="foo", b="bar", c="bazz") { [a, b, c] }
|
||||
|
||||
assertEquals(test(b: "b"), ["foo", "b", "bazz"])
|
||||
assertEquals(test("a", c: "c"), ["a", "bar", "c"])
|
||||
```
|
||||
|
||||
Rules:
|
||||
|
||||
- Named arguments are optional. If named arguments are present, their order is not important.
|
||||
- Named arguments must follow positional arguments; positional arguments cannot follow named ones (the only exception is the syntactic trailing block outside parentheses, see below).
|
||||
- A named argument cannot reassign a parameter already set positionally.
|
||||
- If the last parameter is already assigned by a named argument (or named splat), the trailing-lambda rule must NOT apply: a following `{ ... }` after the call is an error.
|
||||
|
||||
Rationale for using `:` instead of `=` in calls: in Lyng, assignment `=` is an expression; using `:` avoids ambiguity and keeps declarations (`name: Type`) distinct from call sites, where casting uses `as` / `as?`.
|
||||
|
||||
Migration note: earlier drafts/examples used `name = value`. The final syntax is `name: value` at call sites.
|
||||
|
||||
## Extended call argument splats: named splats
|
||||
|
||||
With named arguments, splats (`...`) are extended to support maps as named splats. When a splat evaluates to a Map, its entries provide name→value assignments:
|
||||
|
||||
```lyng
|
||||
fun test(a="a", b="b", c="c", d="d") { [a, b, c, d] }
|
||||
|
||||
assertEquals(test("A?", ...Map("d" => "D!", "b" => "B!")), ["A?", "B!", "c", "D!"])
|
||||
```
|
||||
|
||||
Constraints for named splats:
|
||||
|
||||
- Only string keys are allowed in map splats; otherwise, a clean error is thrown.
|
||||
- Named splats cannot reassign parameters already set (positionally or by earlier named arguments/splats).
|
||||
- Named splats follow the same ordering as named arguments: they must appear after all positional arguments and positional splats.
|
||||
|
||||
## Trailing-lambda interaction
|
||||
|
||||
Lyng supports a syntactic trailing block after a call: `f(args) { ... }`. With named args/splats, if the last parameter is already assigned by name, the trailing block must not apply and the call is an error:
|
||||
|
||||
```lyng
|
||||
fun f(x, onDone) { onDone(x) }
|
||||
f(x: 1) { 42 } // ERROR: last parameter already assigned by name
|
||||
f(1) { 42 } // OK
|
||||
```
|
||||
|
||||
## Errors (non-exhaustive)
|
||||
|
||||
- Positional argument after any named argument inside parentheses: error.
|
||||
- Positional splat after any named argument: error.
|
||||
- Duplicate named assignment (directly or via map splats): error.
|
||||
- Unknown parameter name in a named argument/splat: error.
|
||||
- Map splat with non-string keys: error.
|
||||
- Attempt to target the ellipsis parameter by name: error.
|
||||
|
||||
## Notes
|
||||
|
||||
- Declarations continue to use `:` for types, while call sites use `:` for named arguments and `as` / `as?` for type casts/checks.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Executable
+20
@@ -0,0 +1,20 @@
|
||||
#!/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 }
|
||||
|
||||
|
||||
val format = "%"+(longestNameLength+1) +"s %d"
|
||||
for( f in files )
|
||||
{
|
||||
var name = f.name
|
||||
if( f.isDirectory() )
|
||||
name += "/"
|
||||
println( format(name, f.size()) )
|
||||
}
|
||||
|
||||
|
||||
@@ -19,12 +19,13 @@ fun naiveCountHappyNumbers() {
|
||||
import lyng.time
|
||||
|
||||
//
|
||||
// After all optimizations it takes ~120ms.
|
||||
// After all optimizations it took ~120ms - before.
|
||||
//
|
||||
for( r in 1..100 ) {
|
||||
for( r in 1..900 ) {
|
||||
val start = Instant.now()
|
||||
val found = naiveCountHappyNumbers()
|
||||
println("Found happy numbers: %d time %s"(found, Instant.now() - start))
|
||||
assert( found == 55252 )
|
||||
delay(0.1)
|
||||
}
|
||||
delay(0.05)
|
||||
}
|
||||
|
||||
Executable
+10
@@ -0,0 +1,10 @@
|
||||
#!/bin/env lyng
|
||||
|
||||
val переменная = "значение"
|
||||
|
||||
val data = { greeting: "привет", переменная:, поле: "содержимое" }
|
||||
|
||||
assertEquals(data["переменная"], "значение")
|
||||
assertEquals(data["поле"], "содержимое")
|
||||
|
||||
println(data)
|
||||
Regular → Executable
+1
-1
@@ -1,7 +1,7 @@
|
||||
#!/bin/env lyng
|
||||
/*
|
||||
Calculate the limit of Sum( f(n) )
|
||||
until it reaches asymptotic limit 0.00001% change
|
||||
|
||||
return null or found limit
|
||||
*/
|
||||
fun findSumLimit(f) {
|
||||
|
||||
@@ -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.
|
||||
|
||||
+148
-33
@@ -1,8 +1,3 @@
|
||||
---
|
||||
gitea: none
|
||||
include_toc: true
|
||||
---
|
||||
|
||||
# Lyng tutorial
|
||||
|
||||
Lyng is a very simple language, where we take only most important and popular features from
|
||||
@@ -13,7 +8,7 @@ __Other documents to read__ maybe after this one:
|
||||
|
||||
- [Advanced topics](advanced_topics.md), [declaring arguments](declaring_arguments.md)
|
||||
- [OOP notes](OOP.md), [exception handling](exceptions_handling.md)
|
||||
- [math in Lyng](math.md)
|
||||
- [math in Lyng](math.md), [the `when` statement](when.md)
|
||||
- [time](time.md) and [parallelism](parallelism.md)
|
||||
- [parallelism] - multithreaded code, coroutines, etc.
|
||||
- Some class
|
||||
@@ -681,14 +676,63 @@ Please see [Set] for detailed description.
|
||||
|
||||
# Maps
|
||||
|
||||
Maps are unordered collection of key-value pairs, where keys are unique. See [Map] for details. Map also
|
||||
are [Iterable]:
|
||||
Maps are unordered collections of key-value pairs, where keys are unique. Maps are also [Iterable].
|
||||
|
||||
val m = Map( "foo" => 77, "bar" => "buzz" )
|
||||
assertEquals( m["foo"], 77 )
|
||||
You can create them either with the classic constructor (still supported):
|
||||
|
||||
val old = Map( "foo" => 77, "bar" => "buzz" )
|
||||
assertEquals( old["foo"], 77 )
|
||||
>>> void
|
||||
|
||||
Please see [Map] reference for detailed description on using Maps.
|
||||
…or with map literals, which are often more convenient:
|
||||
|
||||
val x = 10
|
||||
val y = 10
|
||||
val m = { "a": 1, x: x * 2, y: }
|
||||
// identifier keys become strings; `y:` is shorthand for y: y
|
||||
assertEquals(1, m["a"]) // string-literal key
|
||||
assertEquals(20, m["x"]) // identifier key
|
||||
assertEquals(10, m["y"]) // shorthand
|
||||
>>> void
|
||||
|
||||
Map literals support trailing commas for nicer diffs:
|
||||
|
||||
val m2 = {
|
||||
"a": 1,
|
||||
b: 2,
|
||||
}
|
||||
assertEquals(1, m2["a"])
|
||||
assertEquals(2, m2["b"])
|
||||
>>> void
|
||||
|
||||
You can spread other maps inside a literal with `...`. Items merge left-to-right and the rightmost value wins:
|
||||
|
||||
val base = { a: 1, b: 2 }
|
||||
val merged = { a: 0, ...base, b: 3, c: 4 }
|
||||
assertEquals(1, merged["a"]) // base overwrites a:0
|
||||
assertEquals(3, merged["b"]) // literal overwrites spread
|
||||
assertEquals(4, merged["c"]) // new key
|
||||
>>> void
|
||||
|
||||
Merging also works with `+` and `+=`, and you can combine maps and entries conveniently:
|
||||
|
||||
val m3 = { "a": 10 } + ("b" => 20)
|
||||
assertEquals(10, m3["a"])
|
||||
assertEquals(20, m3["b"])
|
||||
|
||||
var m4 = ("x" => 1) + ("y" => 2) // entry + entry → Map
|
||||
m4 += { z: 3 } // merge literal
|
||||
assertEquals(1, m4["x"])
|
||||
assertEquals(2, m4["y"])
|
||||
assertEquals(3, m4["z"])
|
||||
>>> void
|
||||
|
||||
Notes:
|
||||
- Access keys with brackets: `m["key"]`. There is no `m.key` sugar.
|
||||
- Empty `{}` remains a block/lambda; use `Map()` to create an empty map.
|
||||
- When you need computed (expression) keys or non-string keys, use `Map(...)` constructor with entries, e.g. `Map( ("a" + "b") => 1 )`, then merge with a literal if needed: `{ base: } + (computedKey => 42)`.
|
||||
|
||||
Please see the [Map] reference for a deeper guide.
|
||||
|
||||
# Flow control operators
|
||||
|
||||
@@ -717,6 +761,8 @@ Or, more neat:
|
||||
|
||||
## When
|
||||
|
||||
See also: [Comprehensive guide to `when`](when.md)
|
||||
|
||||
It is very much like the kotlin's:
|
||||
|
||||
fun type(x) {
|
||||
@@ -1217,13 +1263,13 @@ same as:
|
||||
|
||||
Are the same as in string literals with little difference:
|
||||
|
||||
| escape | ASCII value |
|
||||
|--------|-------------------|
|
||||
| \n | 0x10, newline |
|
||||
| escape | ASCII value |
|
||||
|--------|-----------------------|
|
||||
| \n | 0x10, newline |
|
||||
| \r | 0x13, carriage return |
|
||||
| \t | 0x07, tabulation |
|
||||
| \\ | \ slash character |
|
||||
| \' | ' apostrophe |
|
||||
| \t | 0x07, tabulation |
|
||||
| \\ | \ slash character |
|
||||
| \' | ' apostrophe |
|
||||
|
||||
### Char instance members
|
||||
|
||||
@@ -1290,7 +1336,6 @@ Open-ended ranges could be used to get start and end too:
|
||||
assertEquals( "pult", "catapult"[ 4.. ])
|
||||
>>> void
|
||||
|
||||
|
||||
### String operations
|
||||
|
||||
Concatenation is a `+`: `"hello " + name` works as expected. No confusion. There is also
|
||||
@@ -1338,7 +1383,6 @@ Typical set of String functions includes:
|
||||
| matches(re) | matches the regular expression (2) |
|
||||
| | |
|
||||
|
||||
|
||||
(1)
|
||||
: List is mutable therefore a new copy is created on each call.
|
||||
|
||||
@@ -1371,20 +1415,26 @@ if blank, will be removed too, for example:
|
||||
|
||||
See [math functions](math.md). Other general purpose functions are:
|
||||
|
||||
| name | description |
|
||||
|----------------------------------------------|------------------------------------------------------------|
|
||||
| assert(condition,message="assertion failed") | runtime code check. There will be an option to skip them |
|
||||
| assertEquals(a,b) | |
|
||||
| assertNotEquals(a,b) | |
|
||||
| assertTrows { /* block */ } | |
|
||||
| check(condition, message=<default>) | throws IllegalStateException" of condition isn't met |
|
||||
| require(condition, message=<default>) | throws IllegalArgumentException" of condition isn't met |
|
||||
| println(args...) | Open for overriding, it prints to stdout with newline. |
|
||||
| print(args...) | Open for overriding, it prints to stdout without newline. |
|
||||
| flow {} | create flow sequence, see [parallelism] |
|
||||
| delay, launch, yield | see [parallelism] |
|
||||
| cached(builder) | remembers builder() on first invocation and return it then |
|
||||
| let, also, apply, run | see above, flow controls |
|
||||
| name | description |
|
||||
|---------------------------------------|------------------------------------------------------------|
|
||||
| assert(condition, fn) | (1) runtime code check with generic or custom nessage `fn` |
|
||||
| assertEquals(a,b) | |
|
||||
| assertNotEquals(a,b) | |
|
||||
| assertTrows { /* block */ } | |
|
||||
| check(condition, message=<default>) | throws IllegalStateException" of condition isn't met |
|
||||
| require(condition, message=<default>) | throws IllegalArgumentException" of condition isn't met |
|
||||
| println(args...) | Open for overriding, it prints to stdout with newline. |
|
||||
| print(args...) | Open for overriding, it prints to stdout without newline. |
|
||||
| flow {} | create flow sequence, see [parallelism] |
|
||||
| delay, launch, yield | see [parallelism] |
|
||||
| cached(builder) | remembers builder() on first invocation and return it then |
|
||||
| let, also, apply, run | see above, flow controls |
|
||||
|
||||
(1)
|
||||
: `fn` is optional lambda returning string message to add to exception string.
|
||||
Lambda avoid unnecessary execution if assertion is not failed. for example:
|
||||
|
||||
assert( x < 10 ) { "x=%s should be < 10"(x) }
|
||||
|
||||
# Built-in constants
|
||||
|
||||
@@ -1422,3 +1472,68 @@ See [math functions](math.md). Other general purpose functions are:
|
||||
[Array]: Array.md
|
||||
|
||||
[Regex]: Regex.md
|
||||
|
||||
## 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.
|
||||
|
||||
Declare a class with multiple bases and pass constructor arguments to each base in the header:
|
||||
|
||||
```
|
||||
class Foo(val a) {
|
||||
var tag = "F"
|
||||
fun runA() { "ResultA:" + a }
|
||||
fun common() { "CommonA" }
|
||||
private fun privateInFoo() {}
|
||||
protected fun protectedInFoo() {}
|
||||
}
|
||||
|
||||
class Bar(val b) {
|
||||
var tag = "B"
|
||||
fun runB() { "ResultB:" + b }
|
||||
fun common() { "CommonB" }
|
||||
}
|
||||
|
||||
class FooBar(a, b) : Foo(a), Bar(b) {
|
||||
// Inside class bodies you can qualify with this@Type
|
||||
fun fromFoo() { this@Foo.common() }
|
||||
fun fromBar() { this@Bar.common() }
|
||||
}
|
||||
|
||||
val fb = FooBar(1, 2)
|
||||
assertEquals("ResultA:1", fb.runA())
|
||||
assertEquals("ResultB:2", fb.runB())
|
||||
|
||||
// Unqualified ambiguous member uses the first base (leftmost)
|
||||
assertEquals("CommonA", fb.common())
|
||||
|
||||
// Disambiguate with casts
|
||||
assertEquals("CommonB", (fb as Bar).common())
|
||||
assertEquals("CommonA", (fb as Foo).common())
|
||||
|
||||
// Field collisions: unqualified read/write uses the first in order
|
||||
assertEquals("F", fb.tag)
|
||||
fb.tag = "X"
|
||||
assertEquals("X", fb.tag) // Foo.tag updated
|
||||
assertEquals("X", (fb as Foo).tag) // qualified read: Foo.tag
|
||||
assertEquals("B", (fb as Bar).tag) // qualified read: Bar.tag
|
||||
|
||||
// Qualified write targets the chosen base storage
|
||||
(fb as Bar).tag = "Y"
|
||||
assertEquals("X", (fb as Foo).tag)
|
||||
assertEquals("Y", (fb as Bar).tag)
|
||||
|
||||
// Optional casts with safe call
|
||||
class Buzz : Bar(3)
|
||||
val buzz = Buzz()
|
||||
assertEquals("ResultB:3", buzz.runB())
|
||||
assertEquals("ResultB:3", (buzz as? Bar)?.runB())
|
||||
assertEquals(null, (buzz as? Foo)?.runA())
|
||||
```
|
||||
|
||||
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.
|
||||
- `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.
|
||||
- Safe‑call `?.` works with `as?` for optional dispatch.
|
||||
|
||||
To get details on OOP in Lyng, see [OOP notes](oop.md).
|
||||
+241
@@ -0,0 +1,241 @@
|
||||
# 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`.
|
||||
|
||||
Currently, Lyng implements the "subject" form: `when(value) { ... }`. The subject-less form `when { condition -> ... }` is not implemented yet.
|
||||
|
||||
## Quick examples
|
||||
|
||||
val r1 = when("a") {
|
||||
"a" -> "ok"
|
||||
else -> "nope"
|
||||
}
|
||||
assertEquals("ok", r1)
|
||||
|
||||
val r2 = when(5) {
|
||||
3 -> "no"
|
||||
4 -> "no"
|
||||
else -> "five"
|
||||
}
|
||||
assertEquals("five", r2)
|
||||
|
||||
val r3 = when(5) {
|
||||
3 -> "no"
|
||||
4 -> "no"
|
||||
}
|
||||
// no matching case and no else → `void`
|
||||
assert(r3 == void)
|
||||
>>> void
|
||||
|
||||
## Syntax
|
||||
|
||||
when(subject) {
|
||||
condition1 [, condition2, ...] -> resultExpressionOrBlock
|
||||
conditionN -> result
|
||||
else -> fallback
|
||||
}
|
||||
|
||||
- Commas group multiple conditions for one branch.
|
||||
- First matching branch wins; there is no fall‑through.
|
||||
- `else` is optional. If omitted and nothing matches, the result is `void`.
|
||||
|
||||
## Matching rules (conditions)
|
||||
|
||||
Within `when(subject)`, each condition is evaluated against the already evaluated `subject`. Lyng supports:
|
||||
|
||||
1) Equality match (default)
|
||||
- Any expression value can be used as a condition. It matches if it is equal to `subject`.
|
||||
- Equality relies on Lyng’s comparison (`compareTo(...) == 0`). For user types, implement comparison accordingly.
|
||||
|
||||
when(x) {
|
||||
0 -> "zero"
|
||||
"EUR" -> "currency"
|
||||
}
|
||||
>>> void
|
||||
|
||||
2) Type checks: `is` and `!is`
|
||||
- Check whether the subject is an instance of a class.
|
||||
- Works with built‑in classes and user classes.
|
||||
|
||||
fun typeOf(x) {
|
||||
when(x) {
|
||||
is Real, is Int -> "number"
|
||||
is String -> "string"
|
||||
else -> "other"
|
||||
}
|
||||
}
|
||||
assertEquals("number", typeOf(5))
|
||||
assertEquals("string", typeOf("hi"))
|
||||
>>> void
|
||||
|
||||
3) Containment checks: `in` and `!in`
|
||||
- `in container` matches if `container.contains(subject)` is true.
|
||||
- `!in container` matches if `contains(subject)` is false.
|
||||
- Any object that provides `contains(item)` can act as a container.
|
||||
|
||||
Common containers:
|
||||
- Ranges (e.g., `'a'..'z'`, `1..10`, `1..<10`, `..5`, `5..`)
|
||||
- Lists, Sets, Arrays, Buffers
|
||||
- Strings (character or substring containment)
|
||||
|
||||
Examples:
|
||||
|
||||
when('e') {
|
||||
in 'a'..'c' -> "small"
|
||||
in 'a'..'z' -> "letter"
|
||||
else -> "other"
|
||||
}
|
||||
>>> "letter"
|
||||
|
||||
when(5) {
|
||||
in [1,2,3,4,6] -> "no"
|
||||
in [7,0,9] -> "no"
|
||||
else -> "ok"
|
||||
}
|
||||
>>> "ok"
|
||||
|
||||
when(5) {
|
||||
in [1,2,3,4,6] -> "no"
|
||||
in [7,0,9] -> "no"
|
||||
in [-1,5,11] -> "yes"
|
||||
else -> "no"
|
||||
}
|
||||
>>> "yes"
|
||||
|
||||
when(5) {
|
||||
!in [1,2,3,4,6,5] -> "no"
|
||||
!in [7,0,9,5] -> "no"
|
||||
!in [-1,15,11] -> "ok"
|
||||
else -> "no"
|
||||
}
|
||||
>>> "ok"
|
||||
|
||||
// String containment
|
||||
"foo" in "foobar" // true (substring)
|
||||
'o' in "foobar" // true (character)
|
||||
>>> true
|
||||
|
||||
Notes on mixed String/Char ranges:
|
||||
- Prefer character ranges for characters: `'a'..'z'`.
|
||||
- `"a".."z"` is a String range and may not behave as you expect with `Char` subjects.
|
||||
|
||||
assert( "more" in "a".."z")
|
||||
assert( 'x' !in "a".."z") // Char vs String range: often not what you want
|
||||
assert( 'x' in 'a'..'z') // OK
|
||||
assert( "x" !in 'a'..'z') // String in Char range: likely not intended
|
||||
>>> void
|
||||
|
||||
## Grouping multiple conditions with commas
|
||||
|
||||
You can group values and/or `is`/`in` checks for a single result:
|
||||
|
||||
fun classify(x) {
|
||||
when(x) {
|
||||
"42", 42 -> "answer"
|
||||
is Real, is Int -> "number"
|
||||
in ['@', '#', '^'] -> "punct1"
|
||||
in "*&.," -> "punct2"
|
||||
else -> "unknown"
|
||||
}
|
||||
}
|
||||
assertEquals("number", classify(π/2))
|
||||
assertEquals("answer", classify(42))
|
||||
assertEquals("answer", classify("42"))
|
||||
>>> void
|
||||
|
||||
## Return value and blocks
|
||||
|
||||
- `when` returns the value of the matched branch result expression/block.
|
||||
- Branch bodies can be single expressions or blocks `{ ... }`.
|
||||
- If a matched branch produces `void` (e.g., only prints), the `when` result is `void`.
|
||||
|
||||
val res = when(2) {
|
||||
1 -> 10
|
||||
2 -> { println("two"); 20 }
|
||||
else -> 0
|
||||
}
|
||||
assertEquals(20, res)
|
||||
>>> void
|
||||
|
||||
## Else branch
|
||||
|
||||
- Optional but recommended when non‑exhaustive.
|
||||
- If omitted and nothing matches, `when` result is `void` (see r3 in the Quick examples).
|
||||
- Only one `else` is allowed.
|
||||
|
||||
## Subject‑less `when`
|
||||
|
||||
The Kotlin‑style subject‑less form `when { condition -> ... }` is not implemented yet in Lyng. Use `if/else` chains or structure your checks around a subject with `when(subject) { ... }`.
|
||||
|
||||
## Extending `when` for your own types
|
||||
|
||||
### Equality matches
|
||||
- Equality checks in `when(subject)` use Lyng comparison (`compareTo` semantics under the hood). For your own Lyng classes, implement comparison appropriately so that `subject == value` works as intended.
|
||||
|
||||
### `in` / `!in` containment
|
||||
- Provide a `contains(item)` method on your class to participate in `in` conditions.
|
||||
- Example: a custom `Box` that contains one specific item:
|
||||
|
||||
class Box(val item)
|
||||
fun Box.contains(x) { x == item }
|
||||
|
||||
val b = Box(10)
|
||||
when(10) { in b -> "hit" }
|
||||
>>> "hit"
|
||||
|
||||
Any built‑in collection (`List`, `Set`, `Array`), `Range`, `Buffer`, and other containers already implement `contains`.
|
||||
|
||||
### Type checks (`is` / `!is`)
|
||||
- Every value has a `::class` that yields its Lyng class object, e.g. `[1,2,3]::class` → `List`.
|
||||
- `is ClassName` in `when` uses Lyng’s class hierarchy. Ensure your class is declared and can be referenced by name.
|
||||
|
||||
[]::class == List
|
||||
>>> true
|
||||
|
||||
fun f(x) { when(x) { is List -> "list" else -> "other" } }
|
||||
assertEquals("list", f([1]))
|
||||
>>> void
|
||||
|
||||
## Kotlin‑backed classes (embedding)
|
||||
|
||||
When embedding Lyng in Kotlin, you may expose Kotlin‑backed objects and classes. Interactions inside `when` work as follows:
|
||||
- `is` checks use the Lyng class object you expose for your Kotlin type. Ensure your exposed class participates in the Lyng class hierarchy (see Embedding docs).
|
||||
- `in` checks call `contains(subject)`; if your Kotlin‑backed object wants to support `in`, expose a `contains(item)` method (mapped to Lyng) or implement the corresponding Lyng container wrapper.
|
||||
- Equality follows Lyng comparison rules. Ensure your Kotlin‑backed object’s Lyng adapter implements equality/compare correctly.
|
||||
|
||||
For details on exposing classes/methods from Kotlin, see: [Embedding Lyng in your Kotlin project](embedding.md).
|
||||
|
||||
## Gotchas and tips
|
||||
|
||||
- First match wins; there is no fall‑through. Order branches carefully.
|
||||
- Group related conditions with commas for readability and performance (a single branch evaluation).
|
||||
- Prefer character ranges for character tests; avoid mixing `String` and `Char` ranges.
|
||||
- If you rely on `in`, check that your container implements `contains(item)`.
|
||||
- Remember: `when` is an expression — you can assign its result to a variable or return it from a function.
|
||||
|
||||
## Additional examples
|
||||
|
||||
fun label(ch) {
|
||||
when(ch) {
|
||||
in '0'..'9' -> "digit"
|
||||
in 'a'..'z', in 'A'..'Z' -> "letter"
|
||||
'$' -> "dollar"
|
||||
else -> "other"
|
||||
}
|
||||
}
|
||||
assertEquals("digit", label('3'))
|
||||
assertEquals("dollar", label('$'))
|
||||
>>> void
|
||||
|
||||
fun normalize(x) {
|
||||
when(x) {
|
||||
is Int -> x
|
||||
is Real -> x.round()
|
||||
else -> 0
|
||||
}
|
||||
}
|
||||
assertEquals(12, normalize(12))
|
||||
assertEquals(3, normalize(2.6))
|
||||
>>> void
|
||||
@@ -0,0 +1,68 @@
|
||||
Lyng TextMate grammar
|
||||
======================
|
||||
|
||||
This folder contains a TextMate grammar for the Lyng language so you can get syntax highlighting quickly in:
|
||||
|
||||
- JetBrains IDEs (IntelliJ IDEA, Fleet, etc.) via “TextMate Bundles”
|
||||
- VS Code (via “Install from VSIX” or by adding as an extension folder)
|
||||
|
||||
Files
|
||||
-----
|
||||
- `package.json` — VS Code–style wrapper that JetBrains IDEs can import as a TextMate bundle.
|
||||
- `syntaxes/lyng.tmLanguage.json` — the grammar. It highlights:
|
||||
- Line and block comments (`//`, `/* */`)
|
||||
- Shebang line at file start (`#!...`)
|
||||
- Strings: single and double quotes with escapes
|
||||
- Char literals `'x'` with escapes
|
||||
- Numbers: decimal with underscores and exponents, and hex (`0x...`)
|
||||
- Keywords (control and declarations), boolean operator words (`and`, `or`, `not`, `in`, `is`, `as`, `as?`)
|
||||
- Composite textual operators: `not in`, `not is`
|
||||
- Constants: `true`, `false`, `null`, `this`
|
||||
- Annotations: `@name` (Unicode identifiers supported)
|
||||
- Labels: `name:` (Unicode identifiers supported)
|
||||
- Declarations: highlights declared names in `fun|fn name`, `class|enum Name`, `val|var name`
|
||||
- Types: built-ins (`Int|Real|String|Bool|Char|Regex`) and Capitalized identifiers (heuristic)
|
||||
- Operators including ranges (`..`, `..<`, `...`), null-safe (`?.`, `?[`, `?(`, `?{`, `?:`, `??`), arrows (`->`, `=>`, `::`), match operators (`=~`, `!~`), bitwise, arithmetic, etc.
|
||||
- Shuttle operator `<=>`
|
||||
- Division operator `/` (note: Lyng has no regex literal syntax; `/` is always division)
|
||||
- Named arguments at call sites `name: value` (the `name` part is highlighted as `variable.parameter.named.lyng` and the `:` as punctuation). The rule is anchored to `(` or `,` and excludes `::` to avoid conflicts.
|
||||
|
||||
Install in IntelliJ IDEA (and other JetBrains IDEs)
|
||||
---------------------------------------------------
|
||||
1. Open Settings / Preferences → Editor → TextMate Bundles.
|
||||
2. Click “+” and select this folder `editors/lyng-textmate/` (the folder that contains `package.json`).
|
||||
3. Ensure `*.lyng` is associated with the Lyng grammar (IntelliJ usually picks this up from `fileTypes`).
|
||||
4. Optional: customize colors with Settings → Editor → Color Scheme → TextMate.
|
||||
|
||||
Enable Markdown code-fence highlighting in IntelliJ
|
||||
--------------------------------------------------
|
||||
1. Settings / Preferences → Languages & Frameworks → Markdown → Code style → Code fences → Languages.
|
||||
2. Add mapping: language id `lyng` → “Lyng (TextMate)”.
|
||||
3. Now blocks like
|
||||
```
|
||||
```lyng
|
||||
// Lyng code here
|
||||
```
|
||||
```
|
||||
will be highlighted.
|
||||
|
||||
Install in VS Code
|
||||
------------------
|
||||
Fastest local install without packaging:
|
||||
1. Copy or symlink this folder somewhere stable (or keep it in your workspace).
|
||||
2. Use “Developer: Install Extension from Location…” (Insiders) or package with `vsce package` and install the resulting `.vsix`.
|
||||
3. VS Code will auto-associate `*.lyng` via this extension; if needed, check File Associations.
|
||||
|
||||
Notes and limitations
|
||||
---------------------
|
||||
- Type highlighting is heuristic (Capitalized identifiers). The IntelliJ plugin will use language semantics and avoid false positives.
|
||||
- If your language adds or changes tokens, please update patterns in `lyng.tmLanguage.json`. The Kotlin sources in `lynglib/src/commonMain/kotlin/net/sergeych/lyng/highlight/` are a good reference for token kinds.
|
||||
- Labels `name:` at statement level remain supported and are kept distinct from named call arguments by context. The grammar prefers named-argument matching when a `name:` appears right after `(` or `,`.
|
||||
|
||||
Lyng specifics
|
||||
--------------
|
||||
- There are no regex literal tokens in Lyng at the moment; the slash character `/` is always treated as the division operator. The grammar intentionally does not define a `/.../` regex rule to avoid mis-highlighting lines like `a / b`.
|
||||
|
||||
Contributing
|
||||
------------
|
||||
Pull requests to refine patterns and add tests/samples are welcome. You can place test snippets in `sample_texts/` and visually verify.
|
||||
@@ -0,0 +1,25 @@
|
||||
{
|
||||
"name": "lyng-textmate",
|
||||
"displayName": "Lyng",
|
||||
"description": "TextMate grammar for the Lyng language (for JetBrains IDEs via TextMate Bundles and VS Code).",
|
||||
"version": "0.0.3",
|
||||
"publisher": "lyng",
|
||||
"license": "Apache-2.0",
|
||||
"engines": { "vscode": "^1.0.0" },
|
||||
"contributes": {
|
||||
"languages": [
|
||||
{
|
||||
"id": "lyng",
|
||||
"aliases": ["Lyng", "lyng"],
|
||||
"extensions": [".lyng"]
|
||||
}
|
||||
],
|
||||
"grammars": [
|
||||
{
|
||||
"language": "lyng",
|
||||
"scopeName": "source.lyng",
|
||||
"path": "./syntaxes/lyng.tmLanguage.json"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,86 @@
|
||||
{
|
||||
"$schema": "https://raw.githubusercontent.com/martinring/tmlanguage/master/tmlanguage.json",
|
||||
"name": "Lyng",
|
||||
"scopeName": "source.lyng",
|
||||
"fileTypes": ["lyng"],
|
||||
"patterns": [
|
||||
{ "include": "#shebang" },
|
||||
{ "include": "#comments" },
|
||||
{ "include": "#strings" },
|
||||
{ "include": "#char" },
|
||||
{ "include": "#numbers" },
|
||||
{ "include": "#declarations" },
|
||||
{ "include": "#keywords" },
|
||||
{ "include": "#constants" },
|
||||
{ "include": "#types" },
|
||||
{ "include": "#mapLiterals" },
|
||||
{ "include": "#namedArgs" },
|
||||
{ "include": "#annotations" },
|
||||
{ "include": "#labels" },
|
||||
{ "include": "#directives" },
|
||||
{ "include": "#operators" },
|
||||
{ "include": "#punctuation" }
|
||||
],
|
||||
"repository": {
|
||||
"shebang": { "patterns": [ { "name": "comment.line.shebang.lyng", "match": "^#!.*$" } ] },
|
||||
"comments": {
|
||||
"patterns": [
|
||||
{ "name": "comment.line.double-slash.lyng", "match": "//.*$" },
|
||||
{ "name": "comment.block.lyng", "begin": "/\\*", "end": "\\*/" }
|
||||
]
|
||||
},
|
||||
"strings": {
|
||||
"patterns": [
|
||||
{ "name": "string.quoted.double.lyng", "begin": "\"", "end": "\"", "patterns": [ { "match": "\\\\.", "name": "constant.character.escape.lyng" } ] },
|
||||
{ "name": "string.quoted.single.lyng", "begin": "'", "end": "'", "patterns": [ { "match": "\\\\.", "name": "constant.character.escape.lyng" } ] }
|
||||
]
|
||||
},
|
||||
"char": { "patterns": [ { "name": "constant.character.lyng", "match": "'(?:[^\\\\']|\\\\.)'" } ] },
|
||||
"numbers": {
|
||||
"patterns": [
|
||||
{ "name": "constant.numeric.hex.lyng", "match": "0x[0-9A-Fa-f_]+" },
|
||||
{ "name": "constant.numeric.decimal.lyng", "match": "(?<![A-Za-z_])(?:[0-9][0-9_]*)\\.(?:[0-9_]+)(?:[eE][+-]?[0-9_]+)?|(?<![A-Za-z_])(?:[0-9][0-9_]*)(?:[eE][+-]?[0-9_]+)?" }
|
||||
]
|
||||
},
|
||||
"annotations": { "patterns": [ { "name": "entity.name.label.at.lyng", "match": "@[\\p{L}_][\\p{L}\\p{N}_]*:" }, { "name": "storage.modifier.annotation.lyng", "match": "@[\\p{L}_][\\p{L}\\p{N}_]*" } ] },
|
||||
"mapLiterals": {
|
||||
"patterns": [
|
||||
{
|
||||
"name": "meta.map.entry.lyng",
|
||||
"match": "(?:(?<=\\{|,))\\s*(\"[^\"]*\"|[\\p{L}_][\\p{L}\\p{N}_]*)\\s*(:)(?!:)",
|
||||
"captures": {
|
||||
"1": { "name": "variable.other.property.key.lyng" },
|
||||
"2": { "name": "punctuation.separator.colon.lyng" }
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "meta.map.spread.lyng",
|
||||
"match": "(?:(?<=\\{|,))\\s*(\\.\\.\\.)",
|
||||
"captures": {
|
||||
"1": { "name": "keyword.operator.spread.lyng" }
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"namedArgs": {
|
||||
"patterns": [
|
||||
{
|
||||
"name": "meta.argument.named.lyng",
|
||||
"match": "(?:(?<=\\()|(?<=,))\\s*([\\p{L}_][\\p{L}\\p{N}_]*)\\s*(:)(?!:)",
|
||||
"captures": {
|
||||
"1": { "name": "variable.parameter.named.lyng" },
|
||||
"2": { "name": "punctuation.separator.colon.lyng" }
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"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]*" } ] },
|
||||
"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" } } } ] },
|
||||
"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" } ] },
|
||||
"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*\\()" } ] },
|
||||
"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": "[!?]" } ] },
|
||||
"punctuation": { "patterns": [ { "name": "punctuation.separator.comma.lyng", "match": "," }, { "name": "punctuation.terminator.statement.lyng", "match": ";" }, { "name": "punctuation.section.block.begin.lyng", "match": "[(]{1}|[{]{1}|\\[" }, { "name": "punctuation.section.block.end.lyng", "match": "[)]{1}|[}]{1}|\\]" }, { "name": "punctuation.accessor.dot.lyng", "match": "\\." }, { "name": "punctuation.separator.colon.lyng", "match": ":" } ] }
|
||||
}
|
||||
}
|
||||
+10
-1
@@ -28,4 +28,13 @@ android.useAndroidX=true
|
||||
android.nonTransitiveRClass=true
|
||||
|
||||
# other
|
||||
kotlin.native.cacheKind.linuxX64=none
|
||||
kotlin.native.cacheKind.linuxX64=none
|
||||
|
||||
# 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
|
||||
# :lynglib:androidJdkImage to fail. Point Gradle to JDK 17 which includes `jlink`.
|
||||
# This affects only the JDK Gradle runs with; Kotlin/JVM target remains compatible.
|
||||
#org.gradle.java.home=/usr/lib/jvm/java-17-openjdk-amd64
|
||||
android.experimental.lint.migrateToK2=false
|
||||
android.lint.useK2Uast=false
|
||||
kotlin.mpp.applyDefaultHierarchyTemplate=true
|
||||
@@ -1,7 +1,7 @@
|
||||
[versions]
|
||||
agp = "8.5.2"
|
||||
clikt = "5.0.3"
|
||||
kotlin = "2.2.20"
|
||||
kotlin = "2.2.21"
|
||||
android-minSdk = "24"
|
||||
android-compileSdk = "34"
|
||||
kotlinx-coroutines = "1.10.2"
|
||||
@@ -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" }
|
||||
okio = { module = "com.squareup.okio:okio", 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" }
|
||||
|
||||
[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,82 @@
|
||||
/*
|
||||
* 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.
|
||||
*
|
||||
*/
|
||||
|
||||
plugins {
|
||||
kotlin("jvm")
|
||||
id("org.jetbrains.intellij") version "1.17.3"
|
||||
}
|
||||
|
||||
group = "net.sergeych.lyng"
|
||||
version = "0.0.3-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"))
|
||||
// Rich Markdown renderer for Quick Docs
|
||||
implementation("com.vladsch.flexmark:flexmark-all:0.64.8")
|
||||
}
|
||||
|
||||
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,371 @@
|
||||
/*
|
||||
* 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.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 prev = file.getUserData(CACHE_KEY)?.spans
|
||||
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)
|
||||
return Result(
|
||||
collectedInfo.modStamp,
|
||||
collectedInfo.previousSpans ?: emptyList(),
|
||||
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
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
// 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) }
|
||||
}
|
||||
is MiniValDecl -> addTypeSegments(d.type)
|
||||
is MiniClassDecl -> {
|
||||
d.ctorFields.forEach { addTypeSegments(it.type) }
|
||||
d.classFields.forEach { addTypeSegments(it.type) }
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
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.Param -> LyngHighlighterColors.PARAMETER
|
||||
SymbolKind.Val -> LyngHighlighterColors.VALUE
|
||||
SymbolKind.Var -> 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)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// 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
|
||||
}
|
||||
@@ -0,0 +1,436 @@
|
||||
/*
|
||||
* 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.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.Source
|
||||
import net.sergeych.lyng.highlight.offsetOf
|
||||
import net.sergeych.lyng.idea.LyngLanguage
|
||||
import net.sergeych.lyng.idea.util.IdeLenientImportProvider
|
||||
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
|
||||
override fun generateDoc(element: PsiElement?, originalElement: PsiElement?): String? {
|
||||
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 = wordRangeAt(text, offset) ?: run {
|
||||
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)
|
||||
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 return null.
|
||||
val sink = MiniAstBuilder()
|
||||
// Use lenient import provider so unresolved imports (e.g., lyng.io.fs) don't break docs
|
||||
val provider = IdeLenientImportProvider.create()
|
||||
try {
|
||||
val src = Source("<ide>", text)
|
||||
runBlocking { Compiler.compileWithMini(src, provider, sink) }
|
||||
} catch (t: Throwable) {
|
||||
log.warn("[LYNG_DEBUG] QuickDoc: compileWithMini failed: ${t.message}")
|
||||
return null
|
||||
}
|
||||
val mini = sink.build() ?: return null
|
||||
val source = Source("<ide>", text)
|
||||
|
||||
// Try resolve to: function param at position, function/class/val declaration at position
|
||||
// 1) Check declarations whose name range contains offset
|
||||
for (d in mini.declarations) {
|
||||
val s = source.offsetOf(d.nameStart)
|
||||
val e = (s + d.name.length).coerceAtMost(text.length)
|
||||
if (offset in s until e) {
|
||||
log.info("[LYNG_DEBUG] QuickDoc: matched decl '${d.name}' kind=${d::class.simpleName}")
|
||||
return renderDeclDoc(d)
|
||||
}
|
||||
}
|
||||
// 2) Check parameters of functions
|
||||
for (fn in mini.declarations.filterIsInstance<MiniFunDecl>()) {
|
||||
for (p in fn.params) {
|
||||
val s = source.offsetOf(p.nameStart)
|
||||
val e = (s + p.name.length).coerceAtMost(text.length)
|
||||
if (offset in s until e) {
|
||||
log.info("[LYNG_DEBUG] QuickDoc: matched param '${p.name}' in fun '${fn.name}'")
|
||||
return renderParamDoc(fn, p)
|
||||
}
|
||||
}
|
||||
}
|
||||
// 3) 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)
|
||||
var importedModules = mini.imports.map { it.segments.joinToString(".") { s -> s.name } }
|
||||
// Core-module fallback: in scratch/repl-like files without imports, consult stdlib by default
|
||||
if (importedModules.isEmpty()) importedModules = listOf("lyng.stdlib")
|
||||
// 4a) try top-level decls
|
||||
for (mod in importedModules) {
|
||||
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
|
||||
docs.filterIsInstance<MiniClassDecl>().firstOrNull { it.name == ident }?.let { return renderDeclDoc(it) }
|
||||
}
|
||||
// 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)
|
||||
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)
|
||||
}
|
||||
}
|
||||
} 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 -> null
|
||||
}
|
||||
if (guessed != null) {
|
||||
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)
|
||||
}
|
||||
}
|
||||
} else {
|
||||
// Search across classes; prefer Iterable, then Iterator, then List for common ops
|
||||
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)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
log.info("[LYNG_DEBUG] QuickDoc: nothing found for ident='$ident'")
|
||||
return null
|
||||
}
|
||||
|
||||
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 MiniValDecl -> if (d.mutable) "var ${d.name}${typeOf(d.type)}" else "val ${d.name}${typeOf(d.type)}"
|
||||
else -> d.name
|
||||
}
|
||||
// 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 ---
|
||||
|
||||
private fun aggregateClasses(importedModules: List<String>): Map<String, MiniClassDecl> {
|
||||
val map = LinkedHashMap<String, MiniClassDecl>()
|
||||
for (mod in importedModules) {
|
||||
val docs = BuiltinDocRegistry.docsForModule(mod)
|
||||
docs.filterIsInstance<MiniClassDecl>().forEach { cls ->
|
||||
// Prefer the first occurrence; allow later duplicates to be ignored
|
||||
map.putIfAbsent(cls.name, cls)
|
||||
}
|
||||
}
|
||||
return map
|
||||
}
|
||||
|
||||
private fun resolveMemberWithInheritance(importedModules: List<String>, className: String, member: String): Pair<String, MiniMemberDecl>? {
|
||||
val classes = aggregateClasses(importedModules)
|
||||
fun dfs(name: String, visited: MutableSet<String>): Pair<String, MiniMemberDecl>? {
|
||||
val cls = classes[name] ?: return null
|
||||
cls.members.firstOrNull { it.name == member }?.let { return name to it }
|
||||
if (!visited.add(name)) return null
|
||||
for (baseName in cls.bases) {
|
||||
dfs(baseName, visited)?.let { return it }
|
||||
}
|
||||
return null
|
||||
}
|
||||
return dfs(className, mutableSetOf())
|
||||
}
|
||||
|
||||
private fun findMemberAcrossClasses(importedModules: List<String>, member: String): Pair<String, MiniMemberDecl>? {
|
||||
val classes = aggregateClasses(importedModules)
|
||||
// Preferred order for ambiguous common ops
|
||||
val preference = listOf("Iterable", "Iterator", "List")
|
||||
// First, try preference order
|
||||
for (name in preference) {
|
||||
resolveMemberWithInheritance(importedModules, name, member)?.let { return it }
|
||||
}
|
||||
// Then, scan all
|
||||
for ((name, cls) in classes) {
|
||||
cls.members.firstOrNull { it.name == member }?.let { return name to it }
|
||||
}
|
||||
return null
|
||||
}
|
||||
|
||||
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
|
||||
}
|
||||
}
|
||||
@@ -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,204 @@
|
||||
/*
|
||||
* 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.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
|
||||
|
||||
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 == "}") {
|
||||
// Previously we reindented the enclosed block on Enter after a lone '}'.
|
||||
// Per new behavior, this action is now bound to typing '}' instead.
|
||||
// Keep Enter flow limited to indenting the new line only.
|
||||
}
|
||||
}
|
||||
// Adjust indent for the current (new) line
|
||||
val currentStart = doc.getLineStartOffsetSafe(currentLine)
|
||||
val csm = CodeStyleManager.getInstance(project)
|
||||
csm.adjustLineIndent(file, currentStart)
|
||||
|
||||
// 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 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 isBlankLine = doc.getLineText(line).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)
|
||||
}
|
||||
|
||||
private 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
|
||||
}
|
||||
|
||||
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,103 @@
|
||||
/*
|
||||
* 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.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
|
||||
|
||||
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 != '}') return Result.CONTINUE
|
||||
|
||||
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)
|
||||
CodeStyleManager.getInstance(project).adjustLineIndent(file, lineStart)
|
||||
}
|
||||
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 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
|
||||
|
||||
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 = file.textRange
|
||||
|
||||
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 = false
|
||||
}
|
||||
|
||||
// Intentionally no sub-blocks/spacing: indentation is handled by PreFormatProcessor + LineIndentProvider
|
||||
@@ -0,0 +1,103 @@
|
||||
/*
|
||||
* 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
|
||||
|
||||
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.format.LyngFormatConfig
|
||||
import net.sergeych.lyng.format.LyngFormatter
|
||||
import net.sergeych.lyng.idea.LyngLanguage
|
||||
|
||||
/**
|
||||
* 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)
|
||||
val indent = computeDesiredIndentFromCore(doc, line, options)
|
||||
return indent
|
||||
}
|
||||
|
||||
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
|
||||
}
|
||||
|
||||
private fun computeDesiredIndentFromCore(doc: Document, line: Int, options: IndentOptions): String {
|
||||
// Build a minimal text consisting of all previous lines and the current line.
|
||||
// Special case: when the current line is blank (newly created by Enter), compute the
|
||||
// indent as if there was a non-whitespace character at line start (append a sentinel).
|
||||
val start = 0
|
||||
val end = doc.getLineEndOffset(line)
|
||||
val snippet = doc.getText(TextRange(start, end))
|
||||
val isBlankLine = doc.getLineText(line).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)
|
||||
// Grab the last line's leading whitespace as the indent for the current line
|
||||
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)
|
||||
}
|
||||
}
|
||||
@@ -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,159 @@
|
||||
/*
|
||||
* 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
|
||||
|
||||
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
|
||||
// Maintain a working range and a modification flag to avoid stale offsets after replacements
|
||||
var modified = false
|
||||
fun fullRange(): TextRange = TextRange(0, doc.textLength)
|
||||
var workingRange: TextRange = range.intersection(fullRange()) ?: fullRange()
|
||||
|
||||
val startLine = if (runFullFileIndent) 0 else doc.getLineNumber(workingRange.startOffset)
|
||||
val endLine = if (runFullFileIndent) (doc.lineCount - 1).coerceAtLeast(0)
|
||||
else doc.getLineNumber(workingRange.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
|
||||
var blockLevel = 0
|
||||
var parenBalance = 0
|
||||
var bracketBalance = 0
|
||||
for (ln in 0 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
|
||||
CodeStyleManager.getInstance(project).adjustLineIndent(file, lineStart)
|
||||
|
||||
// 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 full = fullRange()
|
||||
val r = if (runFullFileIndent) full else workingRange.intersection(full) ?: full
|
||||
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)
|
||||
workingRange = fullRange()
|
||||
}
|
||||
}
|
||||
|
||||
// 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 safe = workingRange.intersection(fullRange()) ?: fullRange()
|
||||
val text = doc.getText(safe)
|
||||
val formatted = LyngFormatter.format(text, cfg)
|
||||
if (formatted != text) {
|
||||
doc.replaceString(safe.startOffset, safe.endOffset, formatted)
|
||||
modified = true
|
||||
psiDoc.commitDocument(doc)
|
||||
workingRange = fullRange()
|
||||
}
|
||||
}
|
||||
// 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 safe2 = workingRange.intersection(fullRange()) ?: fullRange()
|
||||
val text2 = doc.getText(safe2)
|
||||
val wrapped = LyngFormatter.format(text2, cfg)
|
||||
if (wrapped != text2) {
|
||||
doc.replaceString(safe2.startOffset, safe2.endOffset, wrapped)
|
||||
modified = true
|
||||
psiDoc.commitDocument(doc)
|
||||
workingRange = fullRange()
|
||||
}
|
||||
}
|
||||
// Return a safe range for the formatter to continue with, preventing stale offsets
|
||||
return if (modified) fullRange() else (range.intersection(fullRange()) ?: fullRange())
|
||||
}
|
||||
}
|
||||
@@ -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,586 @@
|
||||
/*
|
||||
* 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)
|
||||
|
||||
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
|
||||
try {
|
||||
// 1) Static GrammarChecker.check(TextContent)
|
||||
val checkerCls = try { Class.forName("com.intellij.grazie.grammar.GrammarChecker") } catch (t: Throwable) {
|
||||
log.info("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 }
|
||||
}
|
||||
|
||||
companion object {
|
||||
private val RETRY_KEY: Key<Long> = Key.create("LYNG_GRAZIE_ANN_RETRY_STAMP")
|
||||
}
|
||||
|
||||
// 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","enum","type","import","package","return","if","else","when","while","for","try","catch","finally","true","false","null",
|
||||
// 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,71 @@
|
||||
/*
|
||||
* 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),
|
||||
)
|
||||
|
||||
override fun getColorDescriptors(): Array<ColorDescriptor> = ColorDescriptor.EMPTY_ARRAY
|
||||
}
|
||||
@@ -0,0 +1,80 @@
|
||||
/*
|
||||
* 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
|
||||
)
|
||||
}
|
||||
@@ -0,0 +1,162 @@
|
||||
/*
|
||||
* 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", "type", "import", "as",
|
||||
"if", "else", "for", "while", "return", "true", "false", "null",
|
||||
"when", "in", "is", "break", "continue", "try", "catch", "finally"
|
||||
)
|
||||
|
||||
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")
|
||||
}
|
||||
@@ -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,123 @@
|
||||
/*
|
||||
* 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(),
|
||||
)
|
||||
|
||||
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 }
|
||||
|
||||
companion object {
|
||||
@JvmStatic
|
||||
fun getInstance(project: Project): LyngFormatterSettings = project.getService(LyngFormatterSettings::class.java)
|
||||
}
|
||||
}
|
||||
+142
@@ -0,0 +1,142 @@
|
||||
/*
|
||||
* 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
|
||||
|
||||
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")
|
||||
|
||||
// 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."
|
||||
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)
|
||||
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
|
||||
}
|
||||
|
||||
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
|
||||
}
|
||||
|
||||
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
|
||||
}
|
||||
}
|
||||
@@ -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,37 @@
|
||||
/*
|
||||
* 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.util
|
||||
|
||||
import net.sergeych.lyng.ModuleScope
|
||||
import net.sergeych.lyng.Pos
|
||||
import net.sergeych.lyng.Scope
|
||||
import net.sergeych.lyng.Script
|
||||
import net.sergeych.lyng.pacman.ImportProvider
|
||||
|
||||
/**
|
||||
* Import provider for IDE background features that never throws on missing modules.
|
||||
* It allows all imports and returns an empty [ModuleScope] for unknown packages so
|
||||
* the compiler can still build MiniAst for Quick Docs / highlighting.
|
||||
*/
|
||||
class IdeLenientImportProvider private constructor(root: Scope) : ImportProvider(root) {
|
||||
override suspend fun createModuleScope(pos: Pos, packageName: String): ModuleScope = ModuleScope(this, pos, packageName)
|
||||
|
||||
companion object {
|
||||
/** Create a provider based on the default manager's root scope. */
|
||||
fun create(): IdeLenientImportProvider = IdeLenientImportProvider(Script.defaultImportManager.rootScope)
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,29 @@
|
||||
<!--
|
||||
~ 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 (bundled Natural Languages) optional descriptor for Lyng. Loaded when plugin ID com.intellij.grazie is present.
|
||||
-->
|
||||
<idea-plugin>
|
||||
<extensions defaultExtensionNs="com.intellij">
|
||||
<grazie.grammar.strategy language="Lyng"
|
||||
implementationClass="net.sergeych.lyng.idea.grazie.LyngGrazieStrategy"/>
|
||||
<!-- Provide text extraction for Lyng PSI so Grazie (bundled Natural Languages) can check content -->
|
||||
<grazie.textExtractor language="Lyng"
|
||||
implementationClass="net.sergeych.lyng.idea.grazie.LyngTextExtractor"/>
|
||||
</extensions>
|
||||
</idea-plugin>
|
||||
@@ -0,0 +1,30 @@
|
||||
<!--
|
||||
~ 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 Lite/Pro optional descriptor for Lyng. Loaded when plugin ID tanvd.grazi is present.
|
||||
It delegates to the same strategy class as the bundled Natural Languages.
|
||||
-->
|
||||
<idea-plugin>
|
||||
<extensions defaultExtensionNs="com.intellij">
|
||||
<grazie.grammar.strategy language="Lyng"
|
||||
implementationClass="net.sergeych.lyng.idea.grazie.LyngGrazieStrategy"/>
|
||||
<!-- Provide text extraction for Lyng PSI so Grazie can actually check content -->
|
||||
<grazie.textExtractor language="Lyng"
|
||||
implementationClass="net.sergeych.lyng.idea.grazie.LyngTextExtractor"/>
|
||||
</extensions>
|
||||
</idea-plugin>
|
||||
@@ -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.
|
||||
~
|
||||
-->
|
||||
|
||||
<!--
|
||||
Grazie (Lite/Pro/bundled) grammar checker extensions for Lyng. Loaded only when
|
||||
the Grazie plugin is present. plugin.xml declares optional dependency with this config file.
|
||||
-->
|
||||
<idea-plugin>
|
||||
<extensions defaultExtensionNs="com.intellij">
|
||||
<!-- Register Lyng strategy for Grazie (Natural Languages). -->
|
||||
<grazie.grammar.strategy language="Lyng"
|
||||
implementationClass="net.sergeych.lyng.idea.grazie.LyngGrazieStrategy"/>
|
||||
</extensions>
|
||||
</idea-plugin>
|
||||
@@ -0,0 +1,99 @@
|
||||
<!--
|
||||
~ 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.
|
||||
~
|
||||
-->
|
||||
|
||||
<idea-plugin>
|
||||
<!-- Open-ended compatibility: 2024.3+ (build 243 and newer) -->
|
||||
<idea-version since-build="243"/>
|
||||
<id>net.sergeych.lyng.idea</id>
|
||||
<name>Lyng Language Support</name>
|
||||
<vendor email="real.sergeych@gmail.com">Sergey Chernov</vendor>
|
||||
|
||||
<description>
|
||||
<![CDATA[
|
||||
Basic Lyng language support: file type, syntax highlighting,
|
||||
editing assistance (on Enter indent), reformatting code (indents and spaces),
|
||||
and quick docs.
|
||||
]]>
|
||||
</description>
|
||||
|
||||
<depends>com.intellij.modules.platform</depends>
|
||||
<!-- Needed for editor language features (syntax highlighting, etc.) -->
|
||||
<depends>com.intellij.modules.lang</depends>
|
||||
<!-- Spellchecker support (optional). If present, load spellchecker.xml which registers our strategy. -->
|
||||
<depends optional="true" config-file="spellchecker.xml">com.intellij.spellchecker</depends>
|
||||
<!-- Grazie (Lite/Pro) grammar checker support (optional). If present, load grazie-lite.xml -->
|
||||
<depends optional="true" config-file="grazie-lite.xml">tanvd.grazi</depends>
|
||||
<!-- Some IDE builds may expose Grazie/Natural Languages under another ID; load grazie-bundled.xml -->
|
||||
<depends optional="true" config-file="grazie-bundled.xml">com.intellij.grazie</depends>
|
||||
|
||||
<extensions defaultExtensionNs="com.intellij">
|
||||
<!-- Language and file type -->
|
||||
<fileType implementationClass="net.sergeych.lyng.idea.LyngFileType" name="Lyng" extensions="lyng" fieldName="INSTANCE" language="Lyng"/>
|
||||
|
||||
<!-- Minimal parser/PSI to fully wire editor services for the language -->
|
||||
<lang.parserDefinition language="Lyng" implementationClass="net.sergeych.lyng.idea.psi.LyngParserDefinition"/>
|
||||
|
||||
<!-- Syntax highlighter: register under language EP -->
|
||||
<lang.syntaxHighlighterFactory language="Lyng" implementationClass="net.sergeych.lyng.idea.highlight.LyngSyntaxHighlighterFactory"/>
|
||||
|
||||
<!-- Color settings page -->
|
||||
<colorSettingsPage implementation="net.sergeych.lyng.idea.highlight.LyngColorSettingsPage"/>
|
||||
|
||||
<!-- External annotator for semantic highlighting -->
|
||||
<externalAnnotator language="Lyng" implementationClass="net.sergeych.lyng.idea.annotators.LyngExternalAnnotator"/>
|
||||
|
||||
<!-- Grazie-backed spell/grammar annotator (runs only when Grazie is installed) -->
|
||||
<externalAnnotator language="Lyng" implementationClass="net.sergeych.lyng.idea.grazie.LyngGrazieAnnotator"/>
|
||||
|
||||
<!-- Quick documentation provider bound to Lyng language -->
|
||||
<lang.documentationProvider language="Lyng" implementationClass="net.sergeych.lyng.idea.docs.LyngDocumentationProvider"/>
|
||||
|
||||
<!-- Comment toggling support -->
|
||||
<lang.commenter language="Lyng" implementationClass="net.sergeych.lyng.idea.comment.LyngCommenter"/>
|
||||
|
||||
<!-- Indentation provider to improve auto-indent and reformat behavior -->
|
||||
<lineIndentProvider implementation="net.sergeych.lyng.idea.format.LyngLineIndentProvider"/>
|
||||
|
||||
<!-- Formatting model so Reformat Code (Ctrl+Alt+L) applies indentation across the file -->
|
||||
<lang.formatter language="Lyng" implementationClass="net.sergeych.lyng.idea.format.LyngFormattingModelBuilder"/>
|
||||
|
||||
<!-- Ensure idempotent line indentation before formatting using our LineIndentProvider -->
|
||||
<preFormatProcessor implementation="net.sergeych.lyng.idea.format.LyngPreFormatProcessor"/>
|
||||
|
||||
<!-- Settings UI -->
|
||||
<projectConfigurable instance="net.sergeych.lyng.idea.settings.LyngFormatterSettingsConfigurable"
|
||||
displayName="Lyng Formatter"/>
|
||||
|
||||
<!-- Smart Enter handler -->
|
||||
<enterHandlerDelegate implementation="net.sergeych.lyng.idea.editor.LyngEnterHandler"/>
|
||||
|
||||
<!-- Trigger reindent of enclosed block when typing a standalone '}' -->
|
||||
<typedHandler implementation="net.sergeych.lyng.idea.editor.LyngTypedHandler"/>
|
||||
|
||||
<!-- Smart Backspace handler (deferred) -->
|
||||
<!-- <backspaceHandlerDelegate implementation="net.sergeych.lyng.idea.editor.LyngBackspaceHandler"/> -->
|
||||
|
||||
<!-- Smart Paste via action handler (ensure our handler participates first) -->
|
||||
<editorActionHandler action="EditorPaste" order="first" implementationClass="net.sergeych.lyng.idea.editor.LyngPasteHandler"/>
|
||||
|
||||
<!-- If targeting SDKs with stable RawText API, the EP below can be enabled instead: -->
|
||||
<!-- <copyPastePreProcessor implementation="net.sergeych.lyng.idea.editor.LyngCopyPastePreProcessor"/> -->
|
||||
|
||||
</extensions>
|
||||
|
||||
<actions/>
|
||||
</idea-plugin>
|
||||
@@ -0,0 +1,31 @@
|
||||
<?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 xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" role="img" aria-label="Lyng favicon">
|
||||
<style>
|
||||
:root { color-scheme: light dark; }
|
||||
.mark { fill: currentColor; }
|
||||
.math { font-family: 'STIX Two Math', 'Cambria Math', 'Times New Roman', serif; }
|
||||
</style>
|
||||
<g class="mark math">
|
||||
<!-- Keep favicon legible: lambda with superscript y only -->
|
||||
<text x="3" y="17" font-size="19" font-weight="700"
|
||||
color="#009000" stroke="#002000" stroke-width="0.3">λ</text>
|
||||
<text x="11.2" y="4" font-size="16" color="#009000" stroke="#002000"
|
||||
stroke-width="0.1">y</text>
|
||||
</g>
|
||||
</svg>
|
||||
|
After Width: | Height: | Size: 1.3 KiB |
@@ -0,0 +1,29 @@
|
||||
<!--
|
||||
~ 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.
|
||||
~
|
||||
-->
|
||||
|
||||
<!--
|
||||
Spellchecker extensions for Lyng are registered here and loaded only when
|
||||
the com.intellij.spellchecker plugin is available. The dependency is marked
|
||||
optional in plugin.xml with config-file="spellchecker.xml".
|
||||
-->
|
||||
<idea-plugin>
|
||||
<extensions defaultExtensionNs="com.intellij">
|
||||
<!-- Spellchecker strategy: identifiers + comments; literals configurable, skipping printf-like specs -->
|
||||
<spellchecker.support language="Lyng"
|
||||
implementationClass="net.sergeych.lyng.idea.spell.LyngSpellcheckingStrategy"/>
|
||||
</extensions>
|
||||
</idea-plugin>
|
||||
@@ -0,0 +1,466 @@
|
||||
the
|
||||
be
|
||||
to
|
||||
of
|
||||
and
|
||||
a
|
||||
in
|
||||
that
|
||||
have
|
||||
I
|
||||
it
|
||||
for
|
||||
not
|
||||
on
|
||||
with
|
||||
he
|
||||
as
|
||||
you
|
||||
do
|
||||
at
|
||||
this
|
||||
but
|
||||
his
|
||||
by
|
||||
from
|
||||
they
|
||||
we
|
||||
say
|
||||
her
|
||||
she
|
||||
or
|
||||
an
|
||||
will
|
||||
my
|
||||
one
|
||||
all
|
||||
would
|
||||
there
|
||||
their
|
||||
what
|
||||
so
|
||||
up
|
||||
out
|
||||
if
|
||||
about
|
||||
who
|
||||
get
|
||||
which
|
||||
go
|
||||
me
|
||||
when
|
||||
make
|
||||
can
|
||||
like
|
||||
time
|
||||
no
|
||||
just
|
||||
him
|
||||
know
|
||||
take
|
||||
people
|
||||
into
|
||||
year
|
||||
your
|
||||
good
|
||||
some
|
||||
could
|
||||
them
|
||||
see
|
||||
other
|
||||
than
|
||||
then
|
||||
now
|
||||
look
|
||||
only
|
||||
come
|
||||
its
|
||||
over
|
||||
think
|
||||
also
|
||||
back
|
||||
after
|
||||
use
|
||||
two
|
||||
how
|
||||
our
|
||||
work
|
||||
first
|
||||
well
|
||||
way
|
||||
even
|
||||
new
|
||||
want
|
||||
because
|
||||
any
|
||||
these
|
||||
give
|
||||
day
|
||||
most
|
||||
us
|
||||
is
|
||||
are
|
||||
was
|
||||
were
|
||||
been
|
||||
being
|
||||
does
|
||||
did
|
||||
done
|
||||
has
|
||||
had
|
||||
having
|
||||
may
|
||||
might
|
||||
must
|
||||
shall
|
||||
should
|
||||
ought
|
||||
need
|
||||
used
|
||||
here
|
||||
therefore
|
||||
where
|
||||
why
|
||||
while
|
||||
until
|
||||
since
|
||||
before
|
||||
afterward
|
||||
between
|
||||
among
|
||||
without
|
||||
within
|
||||
through
|
||||
across
|
||||
against
|
||||
toward
|
||||
upon
|
||||
above
|
||||
below
|
||||
under
|
||||
around
|
||||
near
|
||||
far
|
||||
early
|
||||
late
|
||||
often
|
||||
always
|
||||
never
|
||||
seldom
|
||||
sometimes
|
||||
usually
|
||||
really
|
||||
very
|
||||
quite
|
||||
rather
|
||||
almost
|
||||
already
|
||||
again
|
||||
still
|
||||
yet
|
||||
soon
|
||||
today
|
||||
tomorrow
|
||||
yesterday
|
||||
number
|
||||
string
|
||||
boolean
|
||||
true
|
||||
false
|
||||
null
|
||||
none
|
||||
file
|
||||
files
|
||||
path
|
||||
paths
|
||||
line
|
||||
lines
|
||||
word
|
||||
words
|
||||
count
|
||||
value
|
||||
values
|
||||
name
|
||||
names
|
||||
title
|
||||
text
|
||||
message
|
||||
error
|
||||
errors
|
||||
warning
|
||||
warnings
|
||||
info
|
||||
information
|
||||
debug
|
||||
trace
|
||||
format
|
||||
printf
|
||||
specifier
|
||||
specifiers
|
||||
pattern
|
||||
patterns
|
||||
match
|
||||
matches
|
||||
regex
|
||||
version
|
||||
versions
|
||||
module
|
||||
modules
|
||||
package
|
||||
packages
|
||||
import
|
||||
imports
|
||||
export
|
||||
exports
|
||||
class
|
||||
classes
|
||||
object
|
||||
objects
|
||||
function
|
||||
functions
|
||||
method
|
||||
methods
|
||||
parameter
|
||||
parameters
|
||||
argument
|
||||
arguments
|
||||
variable
|
||||
variables
|
||||
constant
|
||||
constants
|
||||
type
|
||||
types
|
||||
generic
|
||||
generics
|
||||
map
|
||||
maps
|
||||
list
|
||||
lists
|
||||
array
|
||||
arrays
|
||||
set
|
||||
sets
|
||||
queue
|
||||
stack
|
||||
graph
|
||||
tree
|
||||
node
|
||||
nodes
|
||||
edge
|
||||
edges
|
||||
pair
|
||||
pairs
|
||||
key
|
||||
keys
|
||||
value
|
||||
values
|
||||
index
|
||||
indices
|
||||
length
|
||||
size
|
||||
empty
|
||||
contains
|
||||
equals
|
||||
compare
|
||||
greater
|
||||
less
|
||||
minimum
|
||||
maximum
|
||||
average
|
||||
sum
|
||||
total
|
||||
random
|
||||
round
|
||||
floor
|
||||
ceil
|
||||
sin
|
||||
cos
|
||||
tan
|
||||
sqrt
|
||||
abs
|
||||
min
|
||||
max
|
||||
read
|
||||
write
|
||||
open
|
||||
close
|
||||
append
|
||||
create
|
||||
delete
|
||||
remove
|
||||
update
|
||||
save
|
||||
load
|
||||
start
|
||||
stop
|
||||
run
|
||||
execute
|
||||
return
|
||||
break
|
||||
continue
|
||||
try
|
||||
catch
|
||||
finally
|
||||
throw
|
||||
throws
|
||||
if
|
||||
else
|
||||
when
|
||||
while
|
||||
for
|
||||
loop
|
||||
range
|
||||
case
|
||||
switch
|
||||
default
|
||||
optional
|
||||
required
|
||||
enable
|
||||
disable
|
||||
enabled
|
||||
disabled
|
||||
visible
|
||||
hidden
|
||||
public
|
||||
private
|
||||
protected
|
||||
internal
|
||||
external
|
||||
inline
|
||||
override
|
||||
abstract
|
||||
sealed
|
||||
open
|
||||
final
|
||||
static
|
||||
const
|
||||
lazy
|
||||
late
|
||||
init
|
||||
initialize
|
||||
configuration
|
||||
settings
|
||||
option
|
||||
options
|
||||
preference
|
||||
preferences
|
||||
project
|
||||
projects
|
||||
module
|
||||
modules
|
||||
build
|
||||
builds
|
||||
compile
|
||||
compiles
|
||||
compiler
|
||||
test
|
||||
tests
|
||||
testing
|
||||
assert
|
||||
assertion
|
||||
result
|
||||
results
|
||||
success
|
||||
failure
|
||||
status
|
||||
state
|
||||
context
|
||||
scope
|
||||
scopes
|
||||
token
|
||||
tokens
|
||||
identifier
|
||||
identifiers
|
||||
keyword
|
||||
keywords
|
||||
comment
|
||||
comments
|
||||
string
|
||||
strings
|
||||
literal
|
||||
literals
|
||||
formatting
|
||||
formatter
|
||||
spell
|
||||
spelling
|
||||
dictionary
|
||||
dictionaries
|
||||
language
|
||||
languages
|
||||
natural
|
||||
grazie
|
||||
typo
|
||||
typos
|
||||
suggest
|
||||
suggestion
|
||||
suggestions
|
||||
replace
|
||||
replacement
|
||||
replacements
|
||||
learn
|
||||
learned
|
||||
learns
|
||||
filter
|
||||
filters
|
||||
exclude
|
||||
excludes
|
||||
include
|
||||
includes
|
||||
bundle
|
||||
bundled
|
||||
resource
|
||||
resources
|
||||
gzipped
|
||||
plain
|
||||
text
|
||||
editor
|
||||
editors
|
||||
inspection
|
||||
inspections
|
||||
highlight
|
||||
highlighting
|
||||
underline
|
||||
underlines
|
||||
style
|
||||
styles
|
||||
range
|
||||
ranges
|
||||
offset
|
||||
offsets
|
||||
position
|
||||
positions
|
||||
apply
|
||||
applies
|
||||
provides
|
||||
present
|
||||
absent
|
||||
available
|
||||
unavailable
|
||||
version
|
||||
build
|
||||
platform
|
||||
ide
|
||||
intellij
|
||||
plugin
|
||||
plugins
|
||||
sandbox
|
||||
gradle
|
||||
kotlin
|
||||
java
|
||||
linux
|
||||
macos
|
||||
windows
|
||||
unix
|
||||
system
|
||||
systems
|
||||
support
|
||||
supports
|
||||
compatible
|
||||
compatibility
|
||||
fallback
|
||||
native
|
||||
automatic
|
||||
autoswitch
|
||||
switch
|
||||
switches
|
||||
@@ -0,0 +1,282 @@
|
||||
# Lyng/tech vocabulary – one word per line, lowercase
|
||||
lyng
|
||||
miniast
|
||||
binder
|
||||
printf
|
||||
specifier
|
||||
specifiers
|
||||
regex
|
||||
regexp
|
||||
token
|
||||
tokens
|
||||
lexer
|
||||
parser
|
||||
syntax
|
||||
semantic
|
||||
highlight
|
||||
highlighting
|
||||
underline
|
||||
typo
|
||||
typos
|
||||
dictionary
|
||||
dictionaries
|
||||
grazie
|
||||
natural
|
||||
languages
|
||||
inspection
|
||||
inspections
|
||||
annotation
|
||||
annotator
|
||||
annotations
|
||||
quickfix
|
||||
quickfixes
|
||||
intention
|
||||
intentions
|
||||
replacement
|
||||
replacements
|
||||
identifier
|
||||
identifiers
|
||||
keyword
|
||||
keywords
|
||||
comment
|
||||
comments
|
||||
string
|
||||
strings
|
||||
literal
|
||||
literals
|
||||
formatting
|
||||
formatter
|
||||
splitter
|
||||
camelcase
|
||||
snakecase
|
||||
pascalcase
|
||||
uppercase
|
||||
lowercase
|
||||
titlecase
|
||||
case
|
||||
cases
|
||||
project
|
||||
module
|
||||
modules
|
||||
resource
|
||||
resources
|
||||
bundle
|
||||
bundled
|
||||
gzipped
|
||||
plaintext
|
||||
text
|
||||
range
|
||||
ranges
|
||||
offset
|
||||
offsets
|
||||
position
|
||||
positions
|
||||
apply
|
||||
applies
|
||||
runtime
|
||||
compile
|
||||
build
|
||||
artifact
|
||||
artifacts
|
||||
plugin
|
||||
plugins
|
||||
intellij
|
||||
idea
|
||||
sandbox
|
||||
gradle
|
||||
kotlin
|
||||
java
|
||||
jvm
|
||||
coroutines
|
||||
suspend
|
||||
scope
|
||||
scopes
|
||||
context
|
||||
contexts
|
||||
tokenizer
|
||||
tokenizers
|
||||
spell
|
||||
spelling
|
||||
spellcheck
|
||||
spellchecker
|
||||
fallback
|
||||
native
|
||||
autoswitch
|
||||
switch
|
||||
switching
|
||||
enable
|
||||
disable
|
||||
enabled
|
||||
disabled
|
||||
setting
|
||||
settings
|
||||
preference
|
||||
preferences
|
||||
editor
|
||||
filetype
|
||||
filetypes
|
||||
language
|
||||
languages
|
||||
psi
|
||||
psielement
|
||||
psifile
|
||||
textcontent
|
||||
textdomain
|
||||
stealth
|
||||
stealthy
|
||||
printfspec
|
||||
format
|
||||
formats
|
||||
pattern
|
||||
patterns
|
||||
match
|
||||
matches
|
||||
group
|
||||
groups
|
||||
node
|
||||
nodes
|
||||
tree
|
||||
graph
|
||||
edge
|
||||
edges
|
||||
pair
|
||||
pairs
|
||||
map
|
||||
maps
|
||||
list
|
||||
lists
|
||||
array
|
||||
arrays
|
||||
set
|
||||
sets
|
||||
queue
|
||||
stack
|
||||
index
|
||||
indices
|
||||
length
|
||||
size
|
||||
empty
|
||||
contains
|
||||
equals
|
||||
compare
|
||||
greater
|
||||
less
|
||||
minimum
|
||||
maximum
|
||||
average
|
||||
sum
|
||||
total
|
||||
random
|
||||
round
|
||||
floor
|
||||
ceil
|
||||
sin
|
||||
cos
|
||||
tan
|
||||
sqrt
|
||||
abs
|
||||
min
|
||||
max
|
||||
read
|
||||
write
|
||||
open
|
||||
close
|
||||
append
|
||||
create
|
||||
delete
|
||||
remove
|
||||
update
|
||||
save
|
||||
load
|
||||
start
|
||||
stop
|
||||
run
|
||||
execute
|
||||
return
|
||||
break
|
||||
continue
|
||||
try
|
||||
catch
|
||||
finally
|
||||
throw
|
||||
throws
|
||||
if
|
||||
else
|
||||
when
|
||||
while
|
||||
for
|
||||
loop
|
||||
rangeop
|
||||
caseop
|
||||
switchop
|
||||
default
|
||||
optional
|
||||
required
|
||||
public
|
||||
private
|
||||
protected
|
||||
internal
|
||||
external
|
||||
inline
|
||||
override
|
||||
abstract
|
||||
sealed
|
||||
open
|
||||
final
|
||||
static
|
||||
const
|
||||
lazy
|
||||
late
|
||||
init
|
||||
initialize
|
||||
configuration
|
||||
option
|
||||
options
|
||||
projectwide
|
||||
workspace
|
||||
crossplatform
|
||||
multiplatform
|
||||
commonmain
|
||||
jsmain
|
||||
native
|
||||
platform
|
||||
api
|
||||
implementation
|
||||
dependency
|
||||
dependencies
|
||||
classpath
|
||||
source
|
||||
sources
|
||||
document
|
||||
documents
|
||||
logging
|
||||
logger
|
||||
info
|
||||
debug
|
||||
trace
|
||||
warning
|
||||
error
|
||||
severity
|
||||
severitylevel
|
||||
intentionaction
|
||||
daemon
|
||||
daemoncodeanalyzer
|
||||
restart
|
||||
textattributes
|
||||
textattributeskey
|
||||
typostyle
|
||||
learned
|
||||
learn
|
||||
tech
|
||||
vocabulary
|
||||
domain
|
||||
term
|
||||
terms
|
||||
us
|
||||
uk
|
||||
american
|
||||
british
|
||||
colour
|
||||
color
|
||||
organisation
|
||||
organization
|
||||
@@ -0,0 +1,82 @@
|
||||
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
|
||||
<!--
|
||||
- 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
|
||||
viewBox="0 0 16.114843 20.543751"
|
||||
role="img"
|
||||
aria-label="Lyng favicon"
|
||||
version="1.1"
|
||||
id="svg2"
|
||||
sodipodi:docname="lyng_file.svg"
|
||||
width="16.114843"
|
||||
height="20.543751"
|
||||
inkscape:version="1.4.2 (1:1.4.2+202505120737+ebf0e940d0)"
|
||||
xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
|
||||
xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
|
||||
xmlns="http://www.w3.org/2000/svg"
|
||||
>
|
||||
<defs
|
||||
id="defs2" />
|
||||
<sodipodi:namedview
|
||||
id="namedview2"
|
||||
pagecolor="#ffffff"
|
||||
bordercolor="#000000"
|
||||
borderopacity="0.25"
|
||||
inkscape:showpageshadow="2"
|
||||
inkscape:pageopacity="0.0"
|
||||
inkscape:pagecheckerboard="0"
|
||||
inkscape:deskcolor="#d1d1d1"
|
||||
inkscape:zoom="49.791667"
|
||||
inkscape:cx="8.9271967"
|
||||
inkscape:cy="10.574059"
|
||||
inkscape:window-width="2512"
|
||||
inkscape:window-height="1403"
|
||||
inkscape:window-x="0"
|
||||
inkscape:window-y="0"
|
||||
inkscape:window-maximized="1"
|
||||
inkscape:current-layer="svg2" />
|
||||
<style
|
||||
id="style1">
|
||||
:root { color-scheme: light dark; }
|
||||
.mark { fill: currentColor; }
|
||||
.math { font-family: 'STIX Two Math', 'Cambria Math', 'Times New Roman', serif; }
|
||||
</style>
|
||||
<g
|
||||
class="mark math"
|
||||
id="g2"
|
||||
transform="translate(-3.0726562,3.39375)">
|
||||
<!-- Keep favicon legible: lambda with superscript y only -->
|
||||
<text
|
||||
x="3"
|
||||
y="17"
|
||||
font-size="19px"
|
||||
font-weight="700"
|
||||
color="#009000"
|
||||
stroke="#002000"
|
||||
stroke-width="0.3"
|
||||
id="text1">λ</text>
|
||||
<text
|
||||
x="11.2"
|
||||
y="4"
|
||||
font-size="16px"
|
||||
color="#009000"
|
||||
stroke="#002000"
|
||||
stroke-width="0.1"
|
||||
id="text2">y</text>
|
||||
</g>
|
||||
</svg>
|
||||
|
After Width: | Height: | Size: 2.4 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 25 KiB |
@@ -0,0 +1,94 @@
|
||||
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
|
||||
<!--
|
||||
- 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
|
||||
viewBox="0 0 32.129775 32.129776"
|
||||
role="img"
|
||||
aria-label="Lyng favicon"
|
||||
version="1.1"
|
||||
id="svg2"
|
||||
sodipodi:docname="lyngicon.svg"
|
||||
width="32.129776"
|
||||
height="32.129776"
|
||||
inkscape:version="1.4.2 (1:1.4.2+202505120737+ebf0e940d0)"
|
||||
inkscape:export-filename="lyngicon.png"
|
||||
inkscape:export-xdpi="1529.7959"
|
||||
inkscape:export-ydpi="1529.7959"
|
||||
xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
|
||||
xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
|
||||
xmlns="http://www.w3.org/2000/svg"
|
||||
>
|
||||
<defs
|
||||
id="defs2" />
|
||||
<sodipodi:namedview
|
||||
id="namedview2"
|
||||
pagecolor="#ffffff"
|
||||
bordercolor="#000000"
|
||||
borderopacity="0.25"
|
||||
inkscape:showpageshadow="2"
|
||||
inkscape:pageopacity="0.0"
|
||||
inkscape:pagecheckerboard="0"
|
||||
inkscape:deskcolor="#d1d1d1"
|
||||
inkscape:zoom="16"
|
||||
inkscape:cx="12.65625"
|
||||
inkscape:cy="5.90625"
|
||||
inkscape:window-width="2512"
|
||||
inkscape:window-height="1403"
|
||||
inkscape:window-x="0"
|
||||
inkscape:window-y="0"
|
||||
inkscape:window-maximized="1"
|
||||
inkscape:current-layer="svg2" />
|
||||
<style
|
||||
id="style1">
|
||||
:root { color-scheme: light dark; }
|
||||
.mark { fill: currentColor; }
|
||||
.math { font-family: 'STIX Two Math', 'Cambria Math', 'Times New Roman', serif; }
|
||||
</style>
|
||||
<circle
|
||||
style="fill:#2b0022;stroke:none;stroke-width:10.6332"
|
||||
id="path2"
|
||||
cx="16.064888"
|
||||
cy="16.064888"
|
||||
r="16.064888" />
|
||||
<g
|
||||
class="mark math"
|
||||
id="g2"
|
||||
transform="translate(4.8666825,8.3889988)"
|
||||
style="fill:#00aa44;stroke:#005522">
|
||||
<!-- Keep favicon legible: lambda with superscript y only -->
|
||||
<text
|
||||
x="3"
|
||||
y="17"
|
||||
font-size="19px"
|
||||
font-weight="700"
|
||||
color="#009000"
|
||||
stroke="#002000"
|
||||
stroke-width="0.3"
|
||||
id="text1"
|
||||
style="fill:#00aa44;stroke:#005522">λ</text>
|
||||
<text
|
||||
x="11.2"
|
||||
y="4"
|
||||
font-size="16px"
|
||||
color="#009000"
|
||||
stroke="#002000"
|
||||
stroke-width="0.1"
|
||||
id="text2"
|
||||
style="fill:#00aa44;stroke:#005522">y</text>
|
||||
</g>
|
||||
</svg>
|
||||
|
After Width: | Height: | Size: 2.8 KiB |
+19
-1
@@ -16,7 +16,7 @@
|
||||
*/
|
||||
|
||||
plugins {
|
||||
kotlin("multiplatform") version "2.2.20"
|
||||
alias(libs.plugins.kotlinMultiplatform)
|
||||
}
|
||||
|
||||
group = "net.sergeych"
|
||||
@@ -31,6 +31,15 @@ repositories {
|
||||
}
|
||||
|
||||
kotlin {
|
||||
// Suppress Beta warning for expect/actual classes across all targets in this module
|
||||
targets.configureEach {
|
||||
compilations.configureEach {
|
||||
compilerOptions.configure {
|
||||
freeCompilerArgs.add("-Xexpect-actual-classes")
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
jvm {
|
||||
binaries {
|
||||
executable {
|
||||
@@ -48,6 +57,9 @@ kotlin {
|
||||
dependencies {
|
||||
implementation(kotlin("stdlib-common"))
|
||||
implementation(project(":lynglib"))
|
||||
// Provide Lyng FS module to the CLI tool so it can install
|
||||
// filesystem access into the execution Scope by default.
|
||||
implementation(project(":lyngio"))
|
||||
implementation(libs.okio)
|
||||
implementation(libs.clikt)
|
||||
implementation(kotlin("stdlib-common"))
|
||||
@@ -63,6 +75,12 @@ kotlin {
|
||||
implementation(libs.okio.fakefilesystem)
|
||||
}
|
||||
}
|
||||
val jvmTest by getting {
|
||||
dependencies {
|
||||
implementation(kotlin("test"))
|
||||
implementation(kotlin("test-junit"))
|
||||
}
|
||||
}
|
||||
// val nativeMain by getting {
|
||||
// dependencies {
|
||||
// implementation(kotlin("stdlib-common"))
|
||||
|
||||
@@ -30,7 +30,9 @@ import net.sergeych.lyng.LyngVersion
|
||||
import net.sergeych.lyng.Script
|
||||
import net.sergeych.lyng.ScriptError
|
||||
import net.sergeych.lyng.Source
|
||||
import net.sergeych.lyng.io.fs.createFs
|
||||
import net.sergeych.lyng.obj.*
|
||||
import net.sergeych.lyngio.fs.security.PermitAllAccessPolicy
|
||||
import net.sergeych.mp_tools.globalDefer
|
||||
import okio.FileSystem
|
||||
import okio.Path.Companion.toPath
|
||||
@@ -62,11 +64,19 @@ val baseScopeDefer = globalDefer {
|
||||
exit(requireOnlyArg<ObjInt>().toInt())
|
||||
ObjVoid
|
||||
}
|
||||
// Install lyng.io.fs module with full access by default for the CLI tool's Scope.
|
||||
// Scripts still need to `import lyng.io.fs` to use Path API.
|
||||
createFs(PermitAllAccessPolicy, this)
|
||||
}
|
||||
}
|
||||
|
||||
fun runMain(args: Array<String>) {
|
||||
if(args.isNotEmpty()) {
|
||||
// CLI formatter: lyng fmt [--check] [--in-place] <files...>
|
||||
if (args[0] == "fmt") {
|
||||
formatCli(args.drop(1))
|
||||
return
|
||||
}
|
||||
if( args.size >= 2 && args[0] == "--" ) {
|
||||
// -- -file.lyng <args>
|
||||
executeFileWithArgs(args[1], args.drop(2))
|
||||
@@ -81,11 +91,58 @@ fun runMain(args: Array<String>) {
|
||||
Lyng { runBlocking { it() } }.main(args)
|
||||
}
|
||||
|
||||
private fun formatCli(args: List<String>) {
|
||||
var checkOnly = false
|
||||
var inPlace = true
|
||||
var enableSpacing = false
|
||||
var enableWrapping = false
|
||||
val files = mutableListOf<String>()
|
||||
for (a in args) {
|
||||
when (a) {
|
||||
"--check" -> { checkOnly = true; inPlace = false }
|
||||
"--in-place", "-i" -> inPlace = true
|
||||
"--spacing" -> enableSpacing = true
|
||||
"--wrap", "--wrapping" -> enableWrapping = true
|
||||
else -> files += a
|
||||
}
|
||||
}
|
||||
if (files.isEmpty()) {
|
||||
println("Usage: lyng fmt [--check] [--in-place|-i] [--spacing] [--wrap] <file1.lyng> [file2.lyng ...]")
|
||||
exit(1)
|
||||
return
|
||||
}
|
||||
var changed = false
|
||||
val cfg = net.sergeych.lyng.format.LyngFormatConfig(
|
||||
applySpacing = enableSpacing,
|
||||
applyWrapping = enableWrapping,
|
||||
)
|
||||
for (path in files) {
|
||||
val p = path.toPath()
|
||||
val original = FileSystem.SYSTEM.source(p).use { it.buffer().use { bs -> bs.readUtf8() } }
|
||||
val formatted = net.sergeych.lyng.format.LyngFormatter.format(original, cfg)
|
||||
if (formatted != original) {
|
||||
changed = true
|
||||
if (checkOnly) {
|
||||
println(path)
|
||||
} else if (inPlace) {
|
||||
FileSystem.SYSTEM.write(p) { writeUtf8(formatted) }
|
||||
} else {
|
||||
// default to stdout if not in-place and not --check
|
||||
println("--- $path (formatted) ---\n$formatted")
|
||||
}
|
||||
}
|
||||
}
|
||||
if (checkOnly) {
|
||||
exit(if (changed) 2 else 0)
|
||||
}
|
||||
}
|
||||
|
||||
private class Lyng(val launcher: (suspend () -> Unit) -> Unit) : CliktCommand() {
|
||||
|
||||
override val printHelpOnEmptyArgs = true
|
||||
|
||||
val version by option("-v", "--version", help = "Print version and exit").flag()
|
||||
val benchmark by option("--benchmark", help = "Run JVM microbenchmarks and exit").flag()
|
||||
val script by argument(help = "one or more scripts to execute").optional()
|
||||
val execute: String? by option(
|
||||
"-x", "--execute", help = """
|
||||
|
||||
@@ -0,0 +1,75 @@
|
||||
/*
|
||||
* 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_cli
|
||||
|
||||
import kotlinx.coroutines.runBlocking
|
||||
import net.sergeych.lyng.Compiler
|
||||
import net.sergeych.lyng.Script
|
||||
|
||||
object BenchmarkRunner {
|
||||
private fun format(nanos: Long, iters: Int): String {
|
||||
val secs = nanos / 1_000_000_000.0
|
||||
val ips = iters / secs
|
||||
return "%.3f s, %.0f ops/s".format(secs, ips)
|
||||
}
|
||||
|
||||
private suspend fun runCase(name: String, code: String, iters: Int): Pair<String, String> {
|
||||
val script = Compiler.compile(code)
|
||||
// warmup
|
||||
repeat(2) { script.execute(Script.newScope()) }
|
||||
val start = System.nanoTime()
|
||||
repeat(iters) { script.execute(Script.newScope()) }
|
||||
val end = System.nanoTime()
|
||||
return name to format(end - start, iters)
|
||||
}
|
||||
|
||||
fun runAll() = runBlocking {
|
||||
val iterations = 2000
|
||||
val cases = listOf(
|
||||
// Field get/set in a loop
|
||||
"field_inc" to """
|
||||
class C { var x = 0 }
|
||||
var c = C()
|
||||
var i = 0
|
||||
while( i < 1000 ) { c.x = c.x + 1; i = i + 1 }
|
||||
c.x
|
||||
""".trimIndent(),
|
||||
// Pure arithmetic with literals
|
||||
"arith_literals" to """
|
||||
var s = 0
|
||||
var i = 0
|
||||
while( i < 1000 ) { s = s + 1 + 2 + 3 + 4 + 5; i = i + 1 }
|
||||
s
|
||||
""".trimIndent(),
|
||||
// Method call overhead via instance method
|
||||
"method_call" to """
|
||||
class C { fun inc() { this.x = this.x + 1 } var x = 0 }
|
||||
var c = C()
|
||||
var i = 0
|
||||
while( i < 1000 ) { c.inc(); i = i + 1 }
|
||||
c.x
|
||||
""".trimIndent()
|
||||
)
|
||||
|
||||
println("[BENCHMARK] iterations per case: $iterations")
|
||||
for ((name, code) in cases) {
|
||||
val (n, res) = runCase(name, code, iterations)
|
||||
println("[BENCHMARK] $n: $res")
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -20,5 +20,9 @@ package net.sergeych.lyng_cli
|
||||
import net.sergeych.runMain
|
||||
|
||||
fun main(args: Array<String>) {
|
||||
if (args.contains("--benchmark")) {
|
||||
BenchmarkRunner.runAll()
|
||||
return
|
||||
}
|
||||
runMain(args)
|
||||
}
|
||||
@@ -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_cli
|
||||
|
||||
import kotlinx.coroutines.runBlocking
|
||||
import net.sergeych.baseScopeDefer
|
||||
import org.junit.Test
|
||||
import kotlin.io.path.createTempDirectory
|
||||
|
||||
class FsIntegrationJvmTest {
|
||||
|
||||
@Test
|
||||
fun scopeHasFsModuleInstalled() {
|
||||
runBlocking {
|
||||
val scope = baseScopeDefer.await()
|
||||
// Ensure we can import the FS module and use Path bindings from Lyng script
|
||||
val dir = createTempDirectory("lyng_cli_fs_test_")
|
||||
try {
|
||||
val file = dir.resolve("hello.txt")
|
||||
// Drive the operation via Lyng code to validate bindings end-to-end
|
||||
scope.eval(
|
||||
"""
|
||||
import lyng.io.fs
|
||||
val p = Path("${'$'}{file}")
|
||||
p.writeUtf8("hello from cli test")
|
||||
assertEquals(true, p.exists())
|
||||
assertEquals("hello from cli test", p.readUtf8())
|
||||
""".trimIndent()
|
||||
)
|
||||
} finally {
|
||||
dir.toFile().deleteRecursively()
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@Test
|
||||
fun scopeHasFsSeesRealFs() {
|
||||
runBlocking {
|
||||
val scope = baseScopeDefer.await()
|
||||
// Drive the operation via Lyng code to validate bindings end-to-end
|
||||
scope.eval(
|
||||
"""
|
||||
import lyng.io.fs
|
||||
// list current folder files
|
||||
println( Path(".").list().toList() )
|
||||
""".trimIndent()
|
||||
)
|
||||
}
|
||||
}
|
||||
}
|
||||
Loaded 100 of 286 files, more files were not shown because too many files have changed in this diff.
Show more
Reference in new issue
Block a user