Compare commits
21
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
b8f27c7a18 | ||
|
|
6a6de83972 | ||
|
|
a3b8dbd9d8 | ||
|
|
c63d643469 | ||
|
|
f592689631 | ||
|
|
834f3118c8 | ||
|
|
d285335e1c | ||
|
|
2e17297355 | ||
|
|
fbea13570e | ||
|
|
067970b80c | ||
|
|
c52e132dcc | ||
|
|
53f00e6c6c | ||
|
|
ec49bbbf52 | ||
|
|
06e8e1579d | ||
|
|
9c342c5c72 | ||
|
|
59055ace8c | ||
|
|
2005f405e4 | ||
|
|
062f344676 | ||
|
|
438e48959e | ||
|
|
41746f22e5 | ||
|
|
e584c7aa63 |
No files matched your search
@@ -0,0 +1 @@
|
||||
*.zip filter=lfs diff=lfs merge=lfs -text
|
||||
@@ -1,8 +1,6 @@
|
||||
# Lyng: modern scripting for kotlin multiplatform
|
||||
|
||||
Please visit the project homepage: [https://lynglang.com](https://lynglang.com)
|
||||
|
||||
A KMP library and a standalone interpreter. v1.0.0-SNAPSHOT is now available.
|
||||
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:
|
||||
|
||||
@@ -39,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
|
||||
@@ -136,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" - done!
|
||||
|
||||
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:
|
||||
|
||||
@@ -176,22 +163,30 @@ Ready features:
|
||||
- [x] regular exceptions + extended `when`
|
||||
- [x] multiple inheritance for user classes
|
||||
|
||||
## plan: v1.0 - v1.5 Stability, integration, optimizations
|
||||
## 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
|
||||
- [ ] JVM bytecode 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.
|
||||
- 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
|
||||
+66
-4
@@ -27,6 +27,58 @@ function checkState() {
|
||||
|
||||
}
|
||||
|
||||
# Update docs/idea_plugin.md to point to the latest built IDEA plugin zip
|
||||
# from ./distributables before building the site. The change is temporary and
|
||||
# the original file is restored right after the build.
|
||||
DOC_IDEA_PLUGIN="docs/idea_plugin.md"
|
||||
DOC_IDEA_PLUGIN_BACKUP="${DOC_IDEA_PLUGIN}.deploy_backup"
|
||||
|
||||
function updateIdeaPluginDownloadLink() {
|
||||
if [[ ! -f "$DOC_IDEA_PLUGIN" ]]; then
|
||||
echo "WARN: $DOC_IDEA_PLUGIN not found; skipping plugin link update"
|
||||
return 0
|
||||
fi
|
||||
|
||||
# Find the most recently modified plugin zip
|
||||
local latest
|
||||
latest=$(ls -t distributables/lyng-idea-*.zip 2>/dev/null | head -n 1)
|
||||
if [[ -z "$latest" ]]; then
|
||||
echo "WARN: no distributables/lyng-idea-*.zip found; leaving $DOC_IDEA_PLUGIN unchanged"
|
||||
return 0
|
||||
fi
|
||||
|
||||
local base
|
||||
base=$(basename "$latest")
|
||||
local version
|
||||
version="${base#lyng-idea-}"
|
||||
version="${version%.zip}"
|
||||
local url
|
||||
url="https://lynglang.com/distributables/${base}"
|
||||
local newline
|
||||
newline="### [Download plugin v${version}](${url})"
|
||||
|
||||
# Backup and rewrite the specific markdown line if present
|
||||
cp "$DOC_IDEA_PLUGIN" "$DOC_IDEA_PLUGIN_BACKUP" || {
|
||||
echo "ERROR: can't backup $DOC_IDEA_PLUGIN"; return 1; }
|
||||
|
||||
# Replace the line that starts with the download header; if not found, append it
|
||||
awk -v repl="$newline" 'BEGIN{done=0} \
|
||||
/^### \[Download plugin v/ { print repl; done=1; next } \
|
||||
{ print } \
|
||||
END { if (done==0) exit 42 }' "$DOC_IDEA_PLUGIN_BACKUP" > "$DOC_IDEA_PLUGIN"
|
||||
|
||||
local rc=$?
|
||||
if [[ $rc -eq 42 ]]; then
|
||||
echo "WARN: download link not found in $DOC_IDEA_PLUGIN; appending generated link"
|
||||
echo >> "$DOC_IDEA_PLUGIN"
|
||||
echo "$newline" >> "$DOC_IDEA_PLUGIN"
|
||||
elif [[ $rc -ne 0 ]]; then
|
||||
echo "ERROR: failed to update $DOC_IDEA_PLUGIN; restoring original"
|
||||
mv -f "$DOC_IDEA_PLUGIN_BACKUP" "$DOC_IDEA_PLUGIN" 2>/dev/null
|
||||
return 1
|
||||
fi
|
||||
}
|
||||
|
||||
# default target settings
|
||||
case "com" in
|
||||
com)
|
||||
@@ -46,15 +98,25 @@ esac
|
||||
|
||||
die() { echo "ERROR: $*" 1>&2 ; exit 1; }
|
||||
|
||||
./gradlew site:clean site:jsBrowserDistribution || die "compilation failed"
|
||||
# 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"
|
||||
|
||||
if [[ $? != 0 ]]; then
|
||||
./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
|
||||
@@ -77,8 +139,8 @@ rsync -e "ssh -p ${SSH_PORT}" -avz -r -d --delete ${SRC}/* ${SSH_HOST}:${ROOT}/b
|
||||
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 private_data/* ${SSH_HOST}:${ROOT}/build/private_data
|
||||
#checkState
|
||||
rsync -e "ssh -p ${SSH_PORT}" -avz -r -d --delete distributables/* ${SSH_HOST}:${ROOT}/build/dist/distributables
|
||||
checkState
|
||||
|
||||
echo
|
||||
echo finalizing the deploy...
|
||||
|
||||
+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.
+6
-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
|
||||
|
||||
|
||||
@@ -1,5 +1,7 @@
|
||||
# Declaring arguments in Lyng
|
||||
|
||||
[//]: # (topMenu)
|
||||
|
||||
It is a common thing that occurs in many places in Lyng, function declarations,
|
||||
lambdas and class declarations.
|
||||
|
||||
|
||||
@@ -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.
|
||||
+3
-1
@@ -1,4 +1,6 @@
|
||||
# Parallelism in Lyng
|
||||
# Multithreading/parallel execution
|
||||
|
||||
[//]: # (topMenu)
|
||||
|
||||
Lyng is built to me multithreaded where possible (e.g. all targets byt JS and wasmJS as for now)
|
||||
and cooperatively parallel (coroutine based) everywhere.
|
||||
|
||||
@@ -1,6 +1,8 @@
|
||||
|
||||
# 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:
|
||||
|
||||
@@ -1,4 +1,7 @@
|
||||
# Named arguments proposal
|
||||
# Named arguments in calls
|
||||
|
||||
[//]: # (excludeFromIndex)
|
||||
|
||||
|
||||
Extend function/method calls to allow setting arguments by name using colon syntax at call sites. This is especially convenient with many parameters and default values.
|
||||
|
||||
|
||||
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()) )
|
||||
}
|
||||
|
||||
|
||||
Executable
+10
@@ -0,0 +1,10 @@
|
||||
#!/bin/env lyng
|
||||
|
||||
val переменная = "значение"
|
||||
|
||||
val data = { greeting: "привет", переменная:, поле: "содержимое" }
|
||||
|
||||
assertEquals(data["переменная"], "значение")
|
||||
assertEquals(data["поле"], "содержимое")
|
||||
|
||||
println(data)
|
||||
@@ -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.
|
||||
|
||||
@@ -1,5 +1,7 @@
|
||||
# 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.
|
||||
|
||||
+4
-1
@@ -34,4 +34,7 @@ kotlin.native.cacheKind.linuxX64=none
|
||||
# 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
|
||||
#org.gradle.java.home=/usr/lib/jvm/java-17-openjdk-amd64
|
||||
android.experimental.lint.migrateToK2=false
|
||||
android.lint.useK2Uast=false
|
||||
kotlin.mpp.applyDefaultHierarchyTemplate=true
|
||||
@@ -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,375 @@
|
||||
/*
|
||||
* 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 cached = file.getUserData(CACHE_KEY)
|
||||
// Fast fix (1): reuse cached spans only if they were computed for the same modification stamp
|
||||
val prev = if (cached != null && cached.modStamp == doc.modificationStamp) cached.spans else null
|
||||
return Input(doc.text, doc.modificationStamp, prev)
|
||||
}
|
||||
|
||||
override fun doAnnotate(collectedInfo: Input?): Result? {
|
||||
if (collectedInfo == null) return null
|
||||
ProgressManager.checkCanceled()
|
||||
val text = collectedInfo.text
|
||||
// Build Mini-AST using the same mechanism as web highlighter
|
||||
val sink = MiniAstBuilder()
|
||||
val source = Source("<ide>", text)
|
||||
try {
|
||||
// Call suspend API from blocking context
|
||||
val provider = IdeLenientImportProvider.create()
|
||||
runBlocking { Compiler.compileWithMini(source, provider, sink) }
|
||||
} catch (e: Throwable) {
|
||||
if (e is com.intellij.openapi.progress.ProcessCanceledException) throw e
|
||||
// On script parse error: keep previous spans and report the error location
|
||||
if (e is ScriptError) {
|
||||
val off = try { source.offsetOf(e.pos) } catch (_: Throwable) { -1 }
|
||||
val start0 = off.coerceIn(0, text.length.coerceAtLeast(0))
|
||||
val (start, end) = expandErrorRange(text, start0)
|
||||
// Fast fix (5): clear cached highlighting after the error start position
|
||||
val trimmed = collectedInfo.previousSpans?.filter { it.end <= start } ?: emptyList()
|
||||
return Result(
|
||||
collectedInfo.modStamp,
|
||||
trimmed,
|
||||
Error(start, end, e.errorMessage)
|
||||
)
|
||||
}
|
||||
// Other failures: keep previous spans without error
|
||||
return Result(collectedInfo.modStamp, collectedInfo.previousSpans ?: emptyList(), null)
|
||||
}
|
||||
ProgressManager.checkCanceled()
|
||||
val mini = sink.build() ?: return Result(collectedInfo.modStamp, collectedInfo.previousSpans ?: emptyList())
|
||||
|
||||
val out = ArrayList<Span>(256)
|
||||
|
||||
fun putRange(start: Int, end: Int, key: com.intellij.openapi.editor.colors.TextAttributesKey) {
|
||||
if (start in 0..end && end <= text.length && start < end) out += Span(start, end, key)
|
||||
}
|
||||
fun putName(startPos: net.sergeych.lyng.Pos, name: String, key: com.intellij.openapi.editor.colors.TextAttributesKey) {
|
||||
val s = source.offsetOf(startPos)
|
||||
putRange(s, (s + name.length).coerceAtMost(text.length), key)
|
||||
}
|
||||
fun putMiniRange(r: MiniRange, key: com.intellij.openapi.editor.colors.TextAttributesKey) {
|
||||
val s = source.offsetOf(r.start)
|
||||
val e = source.offsetOf(r.end)
|
||||
putRange(s, e, key)
|
||||
}
|
||||
|
||||
// Declarations
|
||||
for (d in mini.declarations) {
|
||||
when (d) {
|
||||
is MiniFunDecl -> putName(d.nameStart, d.name, LyngHighlighterColors.FUNCTION_DECLARATION)
|
||||
is MiniClassDecl -> putName(d.nameStart, d.name, LyngHighlighterColors.TYPE)
|
||||
is MiniValDecl -> putName(
|
||||
d.nameStart,
|
||||
d.name,
|
||||
if (d.mutable) LyngHighlighterColors.VARIABLE else LyngHighlighterColors.VALUE
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
// 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,608 @@
|
||||
/*
|
||||
* Copyright 2025 Sergey S. Chernov real.sergeych@gmail.com
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*
|
||||
*/
|
||||
|
||||
/*
|
||||
* Grazie-backed annotator for Lyng files.
|
||||
*
|
||||
* It consumes the MiniAst-driven LyngSpellIndex and, when Grazie is present,
|
||||
* tries to run Grazie checks on the extracted TextContent. Results are painted
|
||||
* as warnings in the editor. If the Grazie API changes, we use reflection and
|
||||
* fail softly with INFO logs (no errors shown to users).
|
||||
*/
|
||||
package net.sergeych.lyng.idea.grazie
|
||||
|
||||
import com.intellij.codeInsight.daemon.DaemonCodeAnalyzer
|
||||
import com.intellij.grazie.text.TextContent
|
||||
import com.intellij.grazie.text.TextContent.TextDomain
|
||||
import com.intellij.ide.plugins.PluginManagerCore
|
||||
import com.intellij.lang.annotation.AnnotationHolder
|
||||
import com.intellij.lang.annotation.ExternalAnnotator
|
||||
import com.intellij.lang.annotation.HighlightSeverity
|
||||
import com.intellij.openapi.application.ApplicationManager
|
||||
import com.intellij.openapi.diagnostic.Logger
|
||||
import com.intellij.openapi.editor.Document
|
||||
import com.intellij.openapi.editor.colors.TextAttributesKey
|
||||
import com.intellij.openapi.project.DumbAware
|
||||
import com.intellij.openapi.util.Key
|
||||
import com.intellij.openapi.util.TextRange
|
||||
import com.intellij.psi.PsiFile
|
||||
import net.sergeych.lyng.idea.settings.LyngFormatterSettings
|
||||
import net.sergeych.lyng.idea.spell.LyngSpellIndex
|
||||
|
||||
class LyngGrazieAnnotator : ExternalAnnotator<LyngGrazieAnnotator.Input, LyngGrazieAnnotator.Result>(), DumbAware {
|
||||
private val log = Logger.getInstance(LyngGrazieAnnotator::class.java)
|
||||
|
||||
companion object {
|
||||
// Cache GrammarChecker availability to avoid repeated reflection + noisy logs
|
||||
@Volatile
|
||||
private var grammarCheckerAvailable: Boolean? = null
|
||||
|
||||
@Volatile
|
||||
private var grammarCheckerMissingLogged: Boolean = false
|
||||
|
||||
private fun isGrammarCheckerKnownMissing(): Boolean = (grammarCheckerAvailable == false)
|
||||
|
||||
private fun markGrammarCheckerMissingOnce(log: Logger, message: String) {
|
||||
if (!grammarCheckerMissingLogged) {
|
||||
// Downgrade to debug to reduce log noise across projects/sessions
|
||||
log.debug(message)
|
||||
grammarCheckerMissingLogged = true
|
||||
}
|
||||
}
|
||||
|
||||
private val RETRY_KEY: Key<Long> = Key.create("LYNG_GRAZIE_ANN_RETRY_STAMP")
|
||||
}
|
||||
|
||||
data class Input(val modStamp: Long)
|
||||
data class Finding(val range: TextRange, val message: String)
|
||||
data class Result(val modStamp: Long, val findings: List<Finding>)
|
||||
|
||||
override fun collectInformation(file: PsiFile): Input? {
|
||||
val doc: Document = file.viewProvider.document ?: return null
|
||||
// Only require Grazie presence; index readiness is checked in apply with a retry.
|
||||
val grazie = isGrazieInstalled()
|
||||
if (!grazie) {
|
||||
log.info("LyngGrazieAnnotator.collectInformation: skip (grazie=false) file='${file.name}'")
|
||||
return null
|
||||
}
|
||||
log.info("LyngGrazieAnnotator.collectInformation: file='${file.name}', modStamp=${doc.modificationStamp}")
|
||||
return Input(doc.modificationStamp)
|
||||
}
|
||||
|
||||
override fun doAnnotate(collectedInfo: Input?): Result? {
|
||||
// All heavy lifting is done in apply where we have the file context
|
||||
return collectedInfo?.let { Result(it.modStamp, emptyList()) }
|
||||
}
|
||||
|
||||
override fun apply(file: PsiFile, annotationResult: Result?, holder: AnnotationHolder) {
|
||||
if (annotationResult == null || !isGrazieInstalled()) return
|
||||
val doc = file.viewProvider.document ?: return
|
||||
val idx = LyngSpellIndex.getUpToDate(file) ?: run {
|
||||
log.info("LyngGrazieAnnotator.apply: index not ready for '${file.name}', scheduling one-shot restart")
|
||||
scheduleOneShotRestart(file, annotationResult.modStamp)
|
||||
return
|
||||
}
|
||||
|
||||
val settings = LyngFormatterSettings.getInstance(file.project)
|
||||
|
||||
// Build TextContent fragments for comments/strings/identifiers according to settings
|
||||
val fragments = mutableListOf<Pair<TextContent, TextRange>>()
|
||||
try {
|
||||
fun addFragments(ranges: List<TextRange>, domain: TextDomain) {
|
||||
for (r in ranges) {
|
||||
val local = rangeToTextContent(file, domain, r) ?: continue
|
||||
fragments += local to r
|
||||
}
|
||||
}
|
||||
// Comments always via COMMENTS
|
||||
addFragments(idx.comments, TextDomain.COMMENTS)
|
||||
// Strings: LITERALS if requested, else COMMENTS if fallback enabled
|
||||
if (settings.spellCheckStringLiterals) {
|
||||
val domain = if (settings.grazieTreatLiteralsAsComments) TextDomain.COMMENTS else TextDomain.LITERALS
|
||||
addFragments(idx.strings, domain)
|
||||
}
|
||||
// Identifiers via COMMENTS to force painting in 243 unless user disables fallback
|
||||
val idsDomain = if (settings.grazieTreatIdentifiersAsComments) TextDomain.COMMENTS else TextDomain.DOCUMENTATION
|
||||
addFragments(idx.identifiers, idsDomain)
|
||||
log.info(
|
||||
"LyngGrazieAnnotator.apply: file='${file.name}', idxCounts ids=${idx.identifiers.size}, comments=${idx.comments.size}, strings=${idx.strings.size}, builtFragments=${fragments.size}"
|
||||
)
|
||||
} catch (e: Throwable) {
|
||||
log.info("LyngGrazieAnnotator: failed to build TextContent fragments: ${e.javaClass.simpleName}: ${e.message}")
|
||||
return
|
||||
}
|
||||
|
||||
if (fragments.isEmpty()) return
|
||||
|
||||
val findings = mutableListOf<Finding>()
|
||||
var totalReturned = 0
|
||||
var chosenEntry: String? = null
|
||||
for ((content, hostRange) in fragments) {
|
||||
try {
|
||||
val (typos, entryNote) = runGrazieChecksWithTracing(file, content)
|
||||
if (chosenEntry == null) chosenEntry = entryNote
|
||||
if (typos != null) {
|
||||
totalReturned += typos.size
|
||||
for (t in typos) {
|
||||
val rel = extractRangeFromTypo(t) ?: continue
|
||||
// Map relative range inside fragment to host file range
|
||||
val abs = TextRange(hostRange.startOffset + rel.startOffset, hostRange.startOffset + rel.endOffset)
|
||||
findings += Finding(abs, extractMessageFromTypo(t) ?: "Spelling/Grammar")
|
||||
}
|
||||
}
|
||||
} catch (e: Throwable) {
|
||||
log.info("LyngGrazieAnnotator: Grazie check failed: ${e.javaClass.simpleName}: ${e.message}")
|
||||
}
|
||||
}
|
||||
log.info("LyngGrazieAnnotator.apply: used=${chosenEntry ?: "<none>"}, totalFindings=$totalReturned, painting=${findings.size}")
|
||||
|
||||
// IMPORTANT: Do NOT fallback to the tiny bundled vocabulary on modern IDEs.
|
||||
// If Grazie/Natural Languages processing returned nothing, we simply exit here
|
||||
// to avoid low‑quality results from the legacy dictionary.
|
||||
if (findings.isEmpty()) return
|
||||
|
||||
for (f in findings) {
|
||||
val ab = holder.newAnnotation(HighlightSeverity.INFORMATION, f.message).range(f.range)
|
||||
applyTypoStyleIfRequested(file, ab)
|
||||
ab.create()
|
||||
}
|
||||
}
|
||||
|
||||
private fun scheduleOneShotRestart(file: PsiFile, modStamp: Long) {
|
||||
try {
|
||||
val last = file.getUserData(RETRY_KEY)
|
||||
if (last == modStamp) {
|
||||
log.info("LyngGrazieAnnotator.restart: already retried for modStamp=$modStamp, skip")
|
||||
return
|
||||
}
|
||||
file.putUserData(RETRY_KEY, modStamp)
|
||||
ApplicationManager.getApplication().invokeLater({
|
||||
try {
|
||||
DaemonCodeAnalyzer.getInstance(file.project).restart(file)
|
||||
log.info("LyngGrazieAnnotator.restart: daemon restarted for '${file.name}'")
|
||||
} catch (e: Throwable) {
|
||||
log.info("LyngGrazieAnnotator.restart failed: ${e.javaClass.simpleName}: ${e.message}")
|
||||
}
|
||||
})
|
||||
} catch (e: Throwable) {
|
||||
log.info("LyngGrazieAnnotator.scheduleOneShotRestart failed: ${e.javaClass.simpleName}: ${e.message}")
|
||||
}
|
||||
}
|
||||
|
||||
private fun isGrazieInstalled(): Boolean {
|
||||
return PluginManagerCore.isPluginInstalled(com.intellij.openapi.extensions.PluginId.getId("com.intellij.grazie")) ||
|
||||
PluginManagerCore.isPluginInstalled(com.intellij.openapi.extensions.PluginId.getId("tanvd.grazi"))
|
||||
}
|
||||
|
||||
private fun rangeToTextContent(file: PsiFile, domain: TextDomain, range: TextRange): TextContent? {
|
||||
// Build TextContent via reflection: prefer psiFragment(domain, element)
|
||||
return try {
|
||||
// Try to find an element that fully covers the target range
|
||||
var element = file.findElementAt(range.startOffset) ?: return null
|
||||
val start = range.startOffset
|
||||
val end = range.endOffset
|
||||
while (element.parent != null && (element.textRange.startOffset > start || element.textRange.endOffset < end)) {
|
||||
element = element.parent
|
||||
}
|
||||
if (element.textRange.startOffset > start || element.textRange.endOffset < end) return null
|
||||
// In many cases, the element may not span the whole range; use file + range via suitable factory
|
||||
val methods = TextContent::class.java.methods.filter { it.name == "psiFragment" }
|
||||
val byElementDomain = methods.firstOrNull { it.parameterCount == 2 && it.parameterTypes[0].name.endsWith("PsiElement") }
|
||||
if (byElementDomain != null) {
|
||||
@Suppress("UNCHECKED_CAST")
|
||||
return (byElementDomain.invoke(null, element, domain) as? TextContent)?.let { tc ->
|
||||
val relStart = start - element.textRange.startOffset
|
||||
val relEnd = end - element.textRange.startOffset
|
||||
if (relStart < 0 || relEnd > tc.length || relStart >= relEnd) return null
|
||||
tc.subText(TextRange(relStart, relEnd))
|
||||
}
|
||||
}
|
||||
val byDomainElement = methods.firstOrNull { it.parameterCount == 2 && it.parameterTypes[0].name.endsWith("TextDomain") }
|
||||
if (byDomainElement != null) {
|
||||
@Suppress("UNCHECKED_CAST")
|
||||
return (byDomainElement.invoke(null, domain, element) as? TextContent)?.let { tc ->
|
||||
val relStart = start - element.textRange.startOffset
|
||||
val relEnd = end - element.textRange.startOffset
|
||||
if (relStart < 0 || relEnd > tc.length || relStart >= relEnd) return null
|
||||
tc.subText(TextRange(relStart, relEnd))
|
||||
}
|
||||
}
|
||||
null
|
||||
} catch (e: Throwable) {
|
||||
log.info("LyngGrazieAnnotator: rangeToTextContent failed: ${e.javaClass.simpleName}: ${e.message}")
|
||||
null
|
||||
}
|
||||
}
|
||||
|
||||
private fun runGrazieChecksWithTracing(file: PsiFile, content: TextContent): Pair<Collection<Any>?, String?> {
|
||||
// Try known entry points via reflection to avoid hard dependencies on Grazie internals
|
||||
if (isGrammarCheckerKnownMissing()) return null to null
|
||||
try {
|
||||
// 1) Static GrammarChecker.check(TextContent)
|
||||
val checkerCls = try {
|
||||
Class.forName("com.intellij.grazie.grammar.GrammarChecker").also { grammarCheckerAvailable = true }
|
||||
} catch (t: Throwable) {
|
||||
grammarCheckerAvailable = false
|
||||
markGrammarCheckerMissingOnce(log, "LyngGrazieAnnotator: GrammarChecker class not found: ${t.javaClass.simpleName}: ${t.message}")
|
||||
null
|
||||
}
|
||||
if (checkerCls != null) {
|
||||
// Diagnostic: list available 'check' methods once
|
||||
runCatching {
|
||||
val checks = checkerCls.methods.filter { it.name == "check" }
|
||||
val sig = checks.joinToString { m ->
|
||||
val params = m.parameterTypes.joinToString(prefix = "(", postfix = ")") { it.simpleName }
|
||||
"${m.name}$params static=${java.lang.reflect.Modifier.isStatic(m.modifiers)}"
|
||||
}
|
||||
log.info("LyngGrazieAnnotator: GrammarChecker.check candidates: ${if (sig.isEmpty()) "<none>" else sig}")
|
||||
}
|
||||
checkerCls.methods.firstOrNull { it.name == "check" && it.parameterCount == 1 && it.parameterTypes[0].name.endsWith("TextContent") }?.let { m ->
|
||||
@Suppress("UNCHECKED_CAST")
|
||||
val res = m.invoke(null, content) as? Collection<Any>
|
||||
return res to "GrammarChecker.check(TextContent) static"
|
||||
}
|
||||
// 2) GrammarChecker.getInstance().check(TextContent)
|
||||
val getInstance = checkerCls.methods.firstOrNull { it.name == "getInstance" && it.parameterCount == 0 }
|
||||
val inst = getInstance?.invoke(null)
|
||||
if (inst != null) {
|
||||
val m = checkerCls.methods.firstOrNull { it.name == "check" && it.parameterCount == 1 && it.parameterTypes[0].name.endsWith("TextContent") }
|
||||
if (m != null) {
|
||||
@Suppress("UNCHECKED_CAST")
|
||||
val res = m.invoke(inst, content) as? Collection<Any>
|
||||
return res to "GrammarChecker.getInstance().check(TextContent)"
|
||||
}
|
||||
}
|
||||
// 3) GrammarChecker.getDefault().check(TextContent)
|
||||
val getDefault = checkerCls.methods.firstOrNull { it.name == "getDefault" && it.parameterCount == 0 }
|
||||
val def = getDefault?.invoke(null)
|
||||
if (def != null) {
|
||||
val m = checkerCls.methods.firstOrNull { it.name == "check" && it.parameterCount == 1 && it.parameterTypes[0].name.endsWith("TextContent") }
|
||||
if (m != null) {
|
||||
@Suppress("UNCHECKED_CAST")
|
||||
val res = m.invoke(def, content) as? Collection<Any>
|
||||
return res to "GrammarChecker.getDefault().check(TextContent)"
|
||||
}
|
||||
}
|
||||
// 4) Service from project/application: GrammarChecker as a service
|
||||
runCatching {
|
||||
val app = com.intellij.openapi.application.ApplicationManager.getApplication()
|
||||
val getService = app::class.java.methods.firstOrNull { it.name == "getService" && it.parameterCount == 1 }
|
||||
val svc = getService?.invoke(app, checkerCls)
|
||||
if (svc != null) {
|
||||
val m = checkerCls.methods.firstOrNull { it.name == "check" && it.parameterCount == 1 && it.parameterTypes[0].name.endsWith("TextContent") }
|
||||
if (m != null) {
|
||||
@Suppress("UNCHECKED_CAST")
|
||||
val res = m.invoke(svc, content) as? Collection<Any>
|
||||
if (res != null) return res to "Application.getService(GrammarChecker).check(TextContent)"
|
||||
}
|
||||
}
|
||||
}
|
||||
runCatching {
|
||||
val getService = file.project::class.java.methods.firstOrNull { it.name == "getService" && it.parameterCount == 1 }
|
||||
val svc = getService?.invoke(file.project, checkerCls)
|
||||
if (svc != null) {
|
||||
val m = checkerCls.methods.firstOrNull { it.name == "check" && it.parameterCount == 1 && it.parameterTypes[0].name.endsWith("TextContent") }
|
||||
if (m != null) {
|
||||
@Suppress("UNCHECKED_CAST")
|
||||
val res = m.invoke(svc, content) as? Collection<Any>
|
||||
if (res != null) return res to "Project.getService(GrammarChecker).check(TextContent)"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
// 5) Fallback: search any public method named check that accepts TextContent in any Grazie class (static)
|
||||
val candidateClasses = listOf(
|
||||
"com.intellij.grazie.grammar.GrammarChecker",
|
||||
"com.intellij.grazie.grammar.GrammarRunner",
|
||||
"com.intellij.grazie.grammar.Grammar" // historical names
|
||||
)
|
||||
for (cn in candidateClasses) {
|
||||
val cls = try { Class.forName(cn) } catch (_: Throwable) { continue }
|
||||
val m = cls.methods.firstOrNull { it.name == "check" && it.parameterTypes.any { p -> p.name.endsWith("TextContent") } }
|
||||
if (m != null) {
|
||||
val args = arrayOfNulls<Any>(m.parameterCount)
|
||||
// place content to the first TextContent parameter; others left null (common defaults)
|
||||
for (i in 0 until m.parameterCount) if (m.parameterTypes[i].name.endsWith("TextContent")) { args[i] = content; break }
|
||||
@Suppress("UNCHECKED_CAST")
|
||||
val res = m.invoke(null, *args) as? Collection<Any>
|
||||
if (res != null) return res to "$cn.${m.name}(TextContent)"
|
||||
}
|
||||
}
|
||||
// 6) Kotlin top-level function: GrammarCheckerKt.check(TextContent)
|
||||
runCatching {
|
||||
val kt = Class.forName("com.intellij.grazie.grammar.GrammarCheckerKt")
|
||||
val m = kt.methods.firstOrNull { it.name == "check" && it.parameterTypes.any { p -> p.name.endsWith("TextContent") } }
|
||||
if (m != null) {
|
||||
val args = arrayOfNulls<Any>(m.parameterCount)
|
||||
for (i in 0 until m.parameterCount) if (m.parameterTypes[i].name.endsWith("TextContent")) { args[i] = content; break }
|
||||
@Suppress("UNCHECKED_CAST")
|
||||
val res = m.invoke(null, *args) as? Collection<Any>
|
||||
if (res != null) return res to "GrammarCheckerKt.check(TextContent)"
|
||||
}
|
||||
}
|
||||
} catch (e: Throwable) {
|
||||
log.info("LyngGrazieAnnotator: runGrazieChecks reflection failed: ${e.javaClass.simpleName}: ${e.message}")
|
||||
}
|
||||
return null to null
|
||||
}
|
||||
|
||||
private fun extractRangeFromTypo(typo: Any): TextRange? {
|
||||
// Try to get a relative range from returned Grazie issue/typo via common accessors
|
||||
return try {
|
||||
// Common getters
|
||||
val m1 = typo.javaClass.methods.firstOrNull { it.name == "getRange" && it.parameterCount == 0 }
|
||||
val r1 = if (m1 != null) m1.invoke(typo) else null
|
||||
when (r1) {
|
||||
is TextRange -> return r1
|
||||
is IntRange -> return TextRange(r1.first, r1.last + 1)
|
||||
}
|
||||
val m2 = typo.javaClass.methods.firstOrNull { it.name == "getHighlightRange" && it.parameterCount == 0 }
|
||||
val r2 = if (m2 != null) m2.invoke(typo) else null
|
||||
when (r2) {
|
||||
is TextRange -> return r2
|
||||
is IntRange -> return TextRange(r2.first, r2.last + 1)
|
||||
}
|
||||
// Separate from/to ints
|
||||
val fromM = typo.javaClass.methods.firstOrNull { it.name == "getFrom" && it.parameterCount == 0 && it.returnType == Int::class.javaPrimitiveType }
|
||||
val toM = typo.javaClass.methods.firstOrNull { it.name == "getTo" && it.parameterCount == 0 && it.returnType == Int::class.javaPrimitiveType }
|
||||
if (fromM != null && toM != null) {
|
||||
val s = (fromM.invoke(typo) as? Int) ?: return null
|
||||
val e = (toM.invoke(typo) as? Int) ?: return null
|
||||
if (e > s) return TextRange(s, e)
|
||||
}
|
||||
null
|
||||
} catch (_: Throwable) { null }
|
||||
}
|
||||
|
||||
private fun extractMessageFromTypo(typo: Any): String? {
|
||||
return try {
|
||||
val m = typo.javaClass.methods.firstOrNull { it.name == "getMessage" && it.parameterCount == 0 }
|
||||
(m?.invoke(typo) as? String)
|
||||
} catch (_: Throwable) { null }
|
||||
}
|
||||
|
||||
|
||||
// Fallback that uses legacy SpellCheckerManager (if present) via reflection to validate words in fragments.
|
||||
// Returns number of warnings painted.
|
||||
private fun fallbackWithLegacySpellcheckerIfAvailable(
|
||||
file: PsiFile,
|
||||
fragments: List<Pair<TextContent, TextRange>>,
|
||||
holder: AnnotationHolder
|
||||
): Int {
|
||||
return try {
|
||||
val mgrCls = Class.forName("com.intellij.spellchecker.SpellCheckerManager")
|
||||
val getInstance = mgrCls.methods.firstOrNull { it.name == "getInstance" && it.parameterCount == 1 }
|
||||
val isCorrect = mgrCls.methods.firstOrNull { it.name == "isCorrect" && it.parameterCount == 1 && it.parameterTypes[0] == String::class.java }
|
||||
if (getInstance == null || isCorrect == null) {
|
||||
// No legacy spellchecker API available — fall back to naive painter
|
||||
return naiveFallbackPaint(file, fragments, holder)
|
||||
}
|
||||
val mgr = getInstance.invoke(null, file.project)
|
||||
if (mgr == null) {
|
||||
// Legacy manager not present for this project — use naive fallback
|
||||
return naiveFallbackPaint(file, fragments, holder)
|
||||
}
|
||||
var painted = 0
|
||||
val docText = file.viewProvider.document?.text ?: return 0
|
||||
val tokenRegex = Regex("[A-Za-z][A-Za-z0-9_']{2,}")
|
||||
for ((content, hostRange) in fragments) {
|
||||
val text = try { docText.substring(hostRange.startOffset, hostRange.endOffset) } catch (_: Throwable) { null } ?: continue
|
||||
var seen = 0
|
||||
var flagged = 0
|
||||
for (m in tokenRegex.findAll(text)) {
|
||||
val token = m.value
|
||||
if ('%' in token) continue // skip printf fragments defensively
|
||||
// Split snake_case and camelCase within the token
|
||||
val parts = splitIdentifier(token)
|
||||
for (part in parts) {
|
||||
if (part.length <= 2) continue
|
||||
if (isAllowedWord(part)) continue
|
||||
// Quick allowlist for very common words to reduce noise if dictionaries differ
|
||||
val ok = try { isCorrect.invoke(mgr, part) as? Boolean } catch (_: Throwable) { null }
|
||||
if (ok == false) {
|
||||
// Map part back to original token occurrence within this hostRange
|
||||
val localStart = m.range.first + token.indexOf(part)
|
||||
val localEnd = localStart + part.length
|
||||
val abs = TextRange(hostRange.startOffset + localStart, hostRange.startOffset + localEnd)
|
||||
paintTypoAnnotation(file, holder, abs, part)
|
||||
painted++
|
||||
flagged++
|
||||
}
|
||||
seen++
|
||||
}
|
||||
}
|
||||
log.info("LyngGrazieAnnotator.fallback: fragment words=$seen, flagged=$flagged")
|
||||
}
|
||||
painted
|
||||
} catch (_: Throwable) {
|
||||
// If legacy manager is not available, fall back to a very naive heuristic (no external deps)
|
||||
return naiveFallbackPaint(file, fragments, holder)
|
||||
}
|
||||
}
|
||||
|
||||
private fun naiveFallbackPaint(
|
||||
file: PsiFile,
|
||||
fragments: List<Pair<TextContent, TextRange>>,
|
||||
holder: AnnotationHolder
|
||||
): Int {
|
||||
var painted = 0
|
||||
val docText = file.viewProvider.document?.text
|
||||
val tokenRegex = Regex("[A-Za-z][A-Za-z0-9_']{2,}")
|
||||
val baseWords = setOf(
|
||||
// small, common vocabulary to catch near-miss typos in typical code/comments
|
||||
"comment","comments","error","errors","found","file","not","word","words","count","value","name","class","function","string"
|
||||
)
|
||||
for ((content, hostRange) in fragments) {
|
||||
val text: String? = docText?.let { dt ->
|
||||
try { dt.substring(hostRange.startOffset, hostRange.endOffset) } catch (_: Throwable) { null }
|
||||
}
|
||||
if (text.isNullOrBlank()) continue
|
||||
var seen = 0
|
||||
var flagged = 0
|
||||
for (m in tokenRegex.findAll(text)) {
|
||||
val token = m.value
|
||||
if ('%' in token) continue
|
||||
val parts = splitIdentifier(token)
|
||||
for (part in parts) {
|
||||
seen++
|
||||
val lower = part.lowercase()
|
||||
if (lower.length <= 2 || isAllowedWord(part)) continue
|
||||
// Heuristic: no vowels OR 3 repeated chars OR ends with unlikely double consonants
|
||||
val noVowel = lower.none { it in "aeiouy" }
|
||||
val triple = Regex("(.)\\1\\1").containsMatchIn(lower)
|
||||
val dblCons = Regex("[bcdfghjklmnpqrstvwxyz]{2}$").containsMatchIn(lower)
|
||||
var looksWrong = noVowel || triple || dblCons
|
||||
// Additional: low vowel ratio for length>=4
|
||||
if (!looksWrong && lower.length >= 4) {
|
||||
val vowels = lower.count { it in "aeiouy" }
|
||||
val ratio = if (lower.isNotEmpty()) vowels.toDouble() / lower.length else 1.0
|
||||
if (ratio < 0.25) looksWrong = true
|
||||
}
|
||||
// Additional: near-miss to a small base vocabulary (edit distance 1, or 2 for words >=6)
|
||||
if (!looksWrong) {
|
||||
for (bw in baseWords) {
|
||||
val d = editDistance(lower, bw)
|
||||
if (d == 1 || (d == 2 && lower.length >= 6)) { looksWrong = true; break }
|
||||
}
|
||||
}
|
||||
if (looksWrong) {
|
||||
val localStart = m.range.first + token.indexOf(part)
|
||||
val localEnd = localStart + part.length
|
||||
val abs = TextRange(hostRange.startOffset + localStart, hostRange.startOffset + localEnd)
|
||||
paintTypoAnnotation(file, holder, abs, part)
|
||||
painted++
|
||||
flagged++
|
||||
}
|
||||
}
|
||||
}
|
||||
log.info("LyngGrazieAnnotator.fallback(naive): fragment words=$seen, flagged=$flagged")
|
||||
}
|
||||
return painted
|
||||
}
|
||||
|
||||
private fun paintTypoAnnotation(file: PsiFile, holder: AnnotationHolder, range: TextRange, word: String) {
|
||||
val settings = LyngFormatterSettings.getInstance(file.project)
|
||||
val ab = holder.newAnnotation(HighlightSeverity.INFORMATION, "Possible typo")
|
||||
.range(range)
|
||||
applyTypoStyleIfRequested(file, ab)
|
||||
if (settings.offerLyngTypoQuickFixes) {
|
||||
// Offer lightweight fixes; for 243 provide Add-to-dictionary always
|
||||
ab.withFix(net.sergeych.lyng.idea.grazie.AddToLyngDictionaryFix(word))
|
||||
// Offer "Replace with…" candidates (top 7)
|
||||
val cands = suggestReplacements(file, word).take(7)
|
||||
for (c in cands) {
|
||||
ab.withFix(net.sergeych.lyng.idea.grazie.ReplaceWordFix(range, word, c))
|
||||
}
|
||||
}
|
||||
ab.create()
|
||||
}
|
||||
|
||||
private fun applyTypoStyleIfRequested(file: PsiFile, ab: com.intellij.lang.annotation.AnnotationBuilder) {
|
||||
val settings = LyngFormatterSettings.getInstance(file.project)
|
||||
if (!settings.showTyposWithGreenUnderline) return
|
||||
// Use the standard TYPO text attributes key used by the platform
|
||||
val TYPO: TextAttributesKey = TextAttributesKey.createTextAttributesKey("TYPO")
|
||||
try {
|
||||
ab.textAttributes(TYPO)
|
||||
} catch (_: Throwable) {
|
||||
// some IDEs may not allow setting attributes on INFORMATION; ignore gracefully
|
||||
}
|
||||
}
|
||||
|
||||
private fun suggestReplacements(file: PsiFile, word: String): List<String> {
|
||||
val lower = word.lowercase()
|
||||
val fromProject = collectProjectWords(file)
|
||||
val fromTech = TechDictionary.allWords()
|
||||
val fromEnglish = EnglishDictionary.allWords()
|
||||
// Merge with priority: project (p=0), tech (p=1), english (p=2)
|
||||
val all = LinkedHashSet<String>()
|
||||
all.addAll(fromProject)
|
||||
all.addAll(fromTech)
|
||||
all.addAll(fromEnglish)
|
||||
data class Cand(val w: String, val d: Int, val p: Int)
|
||||
val cands = ArrayList<Cand>(32)
|
||||
for (w in all) {
|
||||
if (w == lower) continue
|
||||
if (kotlin.math.abs(w.length - lower.length) > 2) continue
|
||||
val d = editDistance(lower, w)
|
||||
val p = when {
|
||||
w in fromProject -> 0
|
||||
w in fromTech -> 1
|
||||
else -> 2
|
||||
}
|
||||
cands += Cand(w, d, p)
|
||||
}
|
||||
cands.sortWith(compareBy<Cand> { it.d }.thenBy { it.p }.thenBy { it.w })
|
||||
// Return a larger pool so callers can choose desired display count
|
||||
return cands.take(16).map { it.w }
|
||||
}
|
||||
|
||||
private fun collectProjectWords(file: PsiFile): Set<String> {
|
||||
// Simple approach: use current file text; can be extended to project scanning later
|
||||
val text = file.viewProvider.document?.text ?: return emptySet()
|
||||
val out = LinkedHashSet<String>()
|
||||
val tokenRegex = Regex("[A-Za-z][A-Za-z0-9_']{2,}")
|
||||
for (m in tokenRegex.findAll(text)) {
|
||||
val parts = splitIdentifier(m.value)
|
||||
parts.forEach { out += it.lowercase() }
|
||||
}
|
||||
// Include learned words
|
||||
val settings = LyngFormatterSettings.getInstance(file.project)
|
||||
out.addAll(settings.learnedWords.map { it.lowercase() })
|
||||
return out
|
||||
}
|
||||
|
||||
private fun splitIdentifier(token: String): List<String> {
|
||||
// Split on underscores and camelCase boundaries
|
||||
val unders = token.split('_').filter { it.isNotBlank() }
|
||||
val out = mutableListOf<String>()
|
||||
val camelBoundary = Regex("(?<=[a-z])(?=[A-Z])")
|
||||
for (u in unders) out += u.split(camelBoundary).filter { it.isNotBlank() }
|
||||
return out
|
||||
}
|
||||
|
||||
private fun isAllowedWord(w: String): Boolean {
|
||||
val s = w.lowercase()
|
||||
return s in setOf(
|
||||
// common code words / language keywords to avoid noise
|
||||
"val","var","fun","class","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 |
@@ -57,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"))
|
||||
@@ -72,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,6 +91,52 @@ 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
|
||||
|
||||
@@ -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()
|
||||
)
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,152 @@
|
||||
/*
|
||||
* 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.
|
||||
*
|
||||
*/
|
||||
|
||||
/*
|
||||
* LyngIO: Compose Multiplatform library module depending on :lynglib
|
||||
*/
|
||||
|
||||
import org.jetbrains.kotlin.gradle.ExperimentalKotlinGradlePluginApi
|
||||
import org.jetbrains.kotlin.gradle.ExperimentalWasmDsl
|
||||
import org.jetbrains.kotlin.gradle.dsl.JvmTarget
|
||||
|
||||
plugins {
|
||||
alias(libs.plugins.kotlinMultiplatform)
|
||||
alias(libs.plugins.androidLibrary)
|
||||
`maven-publish`
|
||||
}
|
||||
|
||||
group = "net.sergeych"
|
||||
version = "0.0.1-SNAPSHOT"
|
||||
|
||||
kotlin {
|
||||
jvm()
|
||||
androidTarget {
|
||||
publishLibraryVariants("release")
|
||||
@OptIn(ExperimentalKotlinGradlePluginApi::class)
|
||||
compilerOptions {
|
||||
jvmTarget.set(JvmTarget.JVM_11)
|
||||
}
|
||||
}
|
||||
iosX64()
|
||||
iosArm64()
|
||||
iosSimulatorArm64()
|
||||
macosX64()
|
||||
macosArm64()
|
||||
mingwX64()
|
||||
linuxX64()
|
||||
linuxArm64()
|
||||
js {
|
||||
browser()
|
||||
nodejs()
|
||||
}
|
||||
@OptIn(ExperimentalWasmDsl::class)
|
||||
wasmJs() {
|
||||
browser()
|
||||
nodejs()
|
||||
}
|
||||
|
||||
// Keep expect/actual warning suppressed consistently with other modules
|
||||
targets.configureEach {
|
||||
compilations.configureEach {
|
||||
compilerOptions.configure {
|
||||
freeCompilerArgs.add("-Xexpect-actual-classes")
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
sourceSets {
|
||||
all {
|
||||
languageSettings.optIn("kotlin.ExperimentalUnsignedTypes")
|
||||
// languageSettings.optIn("kotlinx.coroutines.ExperimentalCoroutinesApi")
|
||||
// Correct opt-in markers for coroutines
|
||||
// languageSettings.optIn("kotlinx.coroutines.DelicateCoroutinesApi")
|
||||
// languageSettings.optIn("kotlin.contracts.ExperimentalContracts")
|
||||
// languageSettings.optIn("kotlinx.coroutines.FlowPreview")
|
||||
}
|
||||
val commonMain by getting {
|
||||
dependencies {
|
||||
api(project(":lynglib"))
|
||||
api(libs.okio)
|
||||
api(libs.kotlinx.coroutines.core)
|
||||
}
|
||||
}
|
||||
val commonTest by getting {
|
||||
dependencies {
|
||||
implementation(libs.kotlin.test)
|
||||
}
|
||||
}
|
||||
|
||||
// JS: use runtime detection in jsMain to select Node vs Browser implementation
|
||||
val jsMain by getting {
|
||||
dependencies {
|
||||
api(libs.okio)
|
||||
implementation(libs.okio.fakefilesystem)
|
||||
implementation("com.squareup.okio:okio-nodefilesystem:${libs.versions.okioVersion.get()}")
|
||||
}
|
||||
}
|
||||
// For Wasm we use in-memory VFS for now
|
||||
val wasmJsMain by getting {
|
||||
dependencies {
|
||||
api(libs.okio)
|
||||
implementation(libs.okio.fakefilesystem)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
android {
|
||||
namespace = "net.sergeych.lyngio"
|
||||
compileSdk = libs.versions.android.compileSdk.get().toInt()
|
||||
defaultConfig {
|
||||
minSdk = libs.versions.android.minSdk.get().toInt()
|
||||
}
|
||||
compileOptions {
|
||||
sourceCompatibility = JavaVersion.VERSION_11
|
||||
targetCompatibility = JavaVersion.VERSION_11
|
||||
}
|
||||
lint {
|
||||
// Prevent Android Lint from failing the build due to Kotlin toolchain
|
||||
// version mismatches in the environment. This keeps CI green while
|
||||
// still generating lint reports locally.
|
||||
abortOnError = false
|
||||
checkReleaseBuilds = false
|
||||
}
|
||||
}
|
||||
|
||||
// Disable Android Lint tasks for this module to avoid toolchain incompatibility
|
||||
// until AGP and Kotlin versions align perfectly in the environment.
|
||||
tasks.matching { it.name.startsWith("lint", ignoreCase = true) }.configureEach {
|
||||
this.enabled = false
|
||||
}
|
||||
|
||||
publishing {
|
||||
val mavenToken by lazy {
|
||||
File("${System.getProperty("user.home")}/.gitea_token").readText()
|
||||
}
|
||||
repositories {
|
||||
maven {
|
||||
credentials(HttpHeaderCredentials::class) {
|
||||
name = "Authorization"
|
||||
value = mavenToken
|
||||
}
|
||||
url = uri("https://gitea.sergeych.net/api/packages/SergeychWorks/maven")
|
||||
authentication {
|
||||
create("Authorization", HttpHeaderAuthentication::class)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -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.lyngio.fs
|
||||
|
||||
import kotlinx.coroutines.CoroutineDispatcher
|
||||
import kotlinx.coroutines.Dispatchers
|
||||
import okio.FileSystem
|
||||
|
||||
actual fun platformAsyncFs(): LyngFs = OkioAsyncFs(FileSystem.SYSTEM)
|
||||
actual val LyngIoDispatcher: CoroutineDispatcher = Dispatchers.IO
|
||||
@@ -0,0 +1,683 @@
|
||||
/*
|
||||
* 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.
|
||||
*
|
||||
*/
|
||||
|
||||
/*
|
||||
* Lyng FS module installer and bindings
|
||||
*/
|
||||
|
||||
package net.sergeych.lyng.io.fs
|
||||
|
||||
import net.sergeych.lyng.ModuleScope
|
||||
import net.sergeych.lyng.Scope
|
||||
import net.sergeych.lyng.miniast.*
|
||||
import net.sergeych.lyng.obj.*
|
||||
import net.sergeych.lyng.pacman.ImportManager
|
||||
import net.sergeych.lyngio.fs.LyngFS
|
||||
import net.sergeych.lyngio.fs.LyngFs
|
||||
import net.sergeych.lyngio.fs.LyngPath
|
||||
import net.sergeych.lyngio.fs.security.AccessDeniedException
|
||||
import net.sergeych.lyngio.fs.security.FsAccessPolicy
|
||||
import net.sergeych.lyngio.fs.security.LyngFsSecured
|
||||
import okio.Path.Companion.toPath
|
||||
|
||||
/**
|
||||
* Install Lyng module `lyng.io.fs` into the given scope's ImportManager.
|
||||
* Returns true if installed, false if it was already registered in this manager.
|
||||
*/
|
||||
fun createFsModule(policy: FsAccessPolicy, scope: Scope): Boolean =
|
||||
createFsModule(policy, scope.importManager)
|
||||
|
||||
// Alias as requested earlier in discussions
|
||||
fun createFs(policy: FsAccessPolicy, scope: Scope): Boolean = createFsModule(policy, scope)
|
||||
|
||||
/** Same as [createFsModule] but with explicit [ImportManager]. */
|
||||
fun createFsModule(policy: FsAccessPolicy, manager: ImportManager): Boolean {
|
||||
val name = "lyng.io.fs"
|
||||
// Avoid re-registering in this ImportManager
|
||||
if (manager.packageNames.contains(name)) return false
|
||||
|
||||
manager.addPackage(name) { module ->
|
||||
buildFsModule(module, policy)
|
||||
}
|
||||
return true
|
||||
}
|
||||
|
||||
// Alias overload for ImportManager
|
||||
fun createFs(policy: FsAccessPolicy, manager: ImportManager): Boolean = createFsModule(policy, manager)
|
||||
|
||||
// --- Module builder ---
|
||||
|
||||
private suspend fun buildFsModule(module: ModuleScope, policy: FsAccessPolicy) {
|
||||
// Per-module secured FS, captured by all factories and methods
|
||||
val base: LyngFs = LyngFS.system()
|
||||
val secured = LyngFsSecured(base, policy)
|
||||
|
||||
// Path class bound to this module
|
||||
val pathType = object : ObjClass("Path") {
|
||||
override suspend fun callOn(scope: Scope): Obj {
|
||||
val arg = scope.requireOnlyArg<ObjString>()
|
||||
val str = arg.value
|
||||
return ObjPath(this, secured, str.toPath())
|
||||
}
|
||||
}.apply {
|
||||
addFnDoc(
|
||||
name = "name",
|
||||
doc = "Base name of the path (last segment).",
|
||||
returns = type("lyng.String"),
|
||||
moduleName = module.packageName
|
||||
) {
|
||||
val self = thisAs<ObjPath>()
|
||||
self.path.name.toObj()
|
||||
}
|
||||
addFnDoc(
|
||||
name = "parent",
|
||||
doc = "Parent directory as a Path or null if none.",
|
||||
returns = type("Path", nullable = true),
|
||||
moduleName = module.packageName
|
||||
) {
|
||||
val self = thisAs<ObjPath>()
|
||||
self.path.parent?.let {
|
||||
ObjPath( this@apply, self.secured, it)
|
||||
} ?: ObjNull
|
||||
}
|
||||
addFnDoc(
|
||||
name = "segments",
|
||||
doc = "List of path segments.",
|
||||
// returns: List<String>
|
||||
returns = TypeGenericDoc(type("lyng.List"), listOf(type("lyng.String"))),
|
||||
moduleName = module.packageName
|
||||
) {
|
||||
val self = thisAs<ObjPath>()
|
||||
ObjList(self.path.segments.map { ObjString(it) }.toMutableList())
|
||||
}
|
||||
// exists(): Bool
|
||||
addFnDoc(
|
||||
name = "exists",
|
||||
doc = "Check whether this path exists.",
|
||||
returns = type("lyng.Bool"),
|
||||
moduleName = module.packageName
|
||||
) {
|
||||
fsGuard {
|
||||
val self = this.thisObj as ObjPath
|
||||
(self.secured.exists(self.path)).toObj()
|
||||
}
|
||||
}
|
||||
// isFile(): Bool — cached metadata
|
||||
addFnDoc(
|
||||
name = "isFile",
|
||||
doc = "True if this path is a regular file (based on cached metadata).",
|
||||
returns = type("lyng.Bool"),
|
||||
moduleName = module.packageName
|
||||
) {
|
||||
fsGuard {
|
||||
val self = this.thisObj as ObjPath
|
||||
self.ensureMetadata().let { ObjBool(it.isRegularFile) }
|
||||
}
|
||||
}
|
||||
// isDirectory(): Bool — cached metadata
|
||||
addFnDoc(
|
||||
name = "isDirectory",
|
||||
doc = "True if this path is a directory (based on cached metadata).",
|
||||
returns = type("lyng.Bool"),
|
||||
moduleName = module.packageName
|
||||
) {
|
||||
fsGuard {
|
||||
val self = this.thisObj as ObjPath
|
||||
self.ensureMetadata().let { ObjBool(it.isDirectory) }
|
||||
}
|
||||
}
|
||||
// size(): Int? — null when unavailable
|
||||
addFnDoc(
|
||||
name = "size",
|
||||
doc = "File size in bytes, or null when unavailable.",
|
||||
returns = type("lyng.Int", nullable = true),
|
||||
moduleName = module.packageName
|
||||
) {
|
||||
fsGuard {
|
||||
val self = this.thisObj as ObjPath
|
||||
val m = self.ensureMetadata()
|
||||
m.size?.let { ObjInt(it) } ?: ObjNull
|
||||
}
|
||||
}
|
||||
// createdAt(): Instant? — Lyng Instant, null when unavailable
|
||||
addFnDoc(
|
||||
name = "createdAt",
|
||||
doc = "Creation time as `Instant`, or null when unavailable.",
|
||||
returns = type("lyng.Instant", nullable = true),
|
||||
moduleName = module.packageName
|
||||
) {
|
||||
fsGuard {
|
||||
val self = this.thisObj as ObjPath
|
||||
val m = self.ensureMetadata()
|
||||
m.createdAtMillis?.let { ObjInstant(kotlinx.datetime.Instant.fromEpochMilliseconds(it)) } ?: ObjNull
|
||||
}
|
||||
}
|
||||
// createdAtMillis(): Int? — milliseconds since epoch or null
|
||||
addFnDoc(
|
||||
name = "createdAtMillis",
|
||||
doc = "Creation time in milliseconds since epoch, or null when unavailable.",
|
||||
returns = type("lyng.Int", nullable = true),
|
||||
moduleName = module.packageName
|
||||
) {
|
||||
fsGuard {
|
||||
val self = this.thisObj as ObjPath
|
||||
val m = self.ensureMetadata()
|
||||
m.createdAtMillis?.let { ObjInt(it) } ?: ObjNull
|
||||
}
|
||||
}
|
||||
// modifiedAt(): Instant? — Lyng Instant, null when unavailable
|
||||
addFnDoc(
|
||||
name = "modifiedAt",
|
||||
doc = "Last modification time as `Instant`, or null when unavailable.",
|
||||
returns = type("lyng.Instant", nullable = true),
|
||||
moduleName = module.packageName
|
||||
) {
|
||||
fsGuard {
|
||||
val self = this.thisObj as ObjPath
|
||||
val m = self.ensureMetadata()
|
||||
m.modifiedAtMillis?.let { ObjInstant(kotlinx.datetime.Instant.fromEpochMilliseconds(it)) } ?: ObjNull
|
||||
}
|
||||
}
|
||||
// modifiedAtMillis(): Int? — milliseconds since epoch or null
|
||||
addFnDoc(
|
||||
name = "modifiedAtMillis",
|
||||
doc = "Last modification time in milliseconds since epoch, or null when unavailable.",
|
||||
returns = type("lyng.Int", nullable = true),
|
||||
moduleName = module.packageName
|
||||
) {
|
||||
fsGuard {
|
||||
val self = this.thisObj as ObjPath
|
||||
val m = self.ensureMetadata()
|
||||
m.modifiedAtMillis?.let { ObjInt(it) } ?: ObjNull
|
||||
}
|
||||
}
|
||||
// list(): List<Path>
|
||||
addFnDoc(
|
||||
name = "list",
|
||||
doc = "List directory entries as `Path` objects.",
|
||||
returns = TypeGenericDoc(type("lyng.List"), listOf(type("Path"))),
|
||||
moduleName = module.packageName
|
||||
) {
|
||||
fsGuard {
|
||||
val self = this.thisObj as ObjPath
|
||||
val items = self.secured.list(self.path).map { ObjPath(self.objClass, self.secured, it) }
|
||||
ObjList(items.toMutableList())
|
||||
}
|
||||
}
|
||||
// readBytes(): Buffer
|
||||
addFnDoc(
|
||||
name = "readBytes",
|
||||
doc = "Read the file into a binary buffer.",
|
||||
returns = type("lyng.Buffer"),
|
||||
moduleName = module.packageName
|
||||
) {
|
||||
fsGuard {
|
||||
val self = this.thisObj as ObjPath
|
||||
val bytes = self.secured.readBytes(self.path)
|
||||
ObjBuffer(bytes.asUByteArray())
|
||||
}
|
||||
}
|
||||
// writeBytes(bytes: Buffer)
|
||||
addFnDoc(
|
||||
name = "writeBytes",
|
||||
doc = "Write a binary buffer to the file, replacing content.",
|
||||
params = listOf(ParamDoc("bytes", type("lyng.Buffer"))),
|
||||
moduleName = module.packageName
|
||||
) {
|
||||
fsGuard {
|
||||
val self = this.thisObj as ObjPath
|
||||
val buf = requiredArg<ObjBuffer>(0)
|
||||
self.secured.writeBytes(self.path, buf.byteArray.asByteArray(), append = false)
|
||||
ObjVoid
|
||||
}
|
||||
}
|
||||
// appendBytes(bytes: Buffer)
|
||||
addFnDoc(
|
||||
name = "appendBytes",
|
||||
doc = "Append a binary buffer to the end of the file.",
|
||||
params = listOf(ParamDoc("bytes", type("lyng.Buffer"))),
|
||||
moduleName = module.packageName
|
||||
) {
|
||||
fsGuard {
|
||||
val self = this.thisObj as ObjPath
|
||||
val buf = requiredArg<ObjBuffer>(0)
|
||||
self.secured.writeBytes(self.path, buf.byteArray.asByteArray(), append = true)
|
||||
ObjVoid
|
||||
}
|
||||
}
|
||||
// readUtf8(): String
|
||||
addFnDoc(
|
||||
name = "readUtf8",
|
||||
doc = "Read the file as a UTF-8 string.",
|
||||
returns = type("lyng.String"),
|
||||
moduleName = module.packageName
|
||||
) {
|
||||
fsGuard {
|
||||
val self = this.thisObj as ObjPath
|
||||
self.secured.readUtf8(self.path).toObj()
|
||||
}
|
||||
}
|
||||
// writeUtf8(text: String)
|
||||
addFnDoc(
|
||||
name = "writeUtf8",
|
||||
doc = "Write a UTF-8 string to the file, replacing content.",
|
||||
params = listOf(ParamDoc("text", type("lyng.String"))),
|
||||
moduleName = module.packageName
|
||||
) {
|
||||
fsGuard {
|
||||
val self = this.thisObj as ObjPath
|
||||
val text = requireOnlyArg<ObjString>().value
|
||||
self.secured.writeUtf8(self.path, text, append = false)
|
||||
ObjVoid
|
||||
}
|
||||
}
|
||||
// appendUtf8(text: String)
|
||||
addFnDoc(
|
||||
name = "appendUtf8",
|
||||
doc = "Append UTF-8 text to the end of the file.",
|
||||
params = listOf(ParamDoc("text", type("lyng.String"))),
|
||||
moduleName = module.packageName
|
||||
) {
|
||||
fsGuard {
|
||||
val self = this.thisObj as ObjPath
|
||||
val text = requireOnlyArg<ObjString>().value
|
||||
self.secured.writeUtf8(self.path, text, append = true)
|
||||
ObjVoid
|
||||
}
|
||||
}
|
||||
// metadata(): Map
|
||||
addFnDoc(
|
||||
name = "metadata",
|
||||
doc = "Fetch cached metadata as a map of fields: `isFile`, `isDirectory`, `size`, `createdAtMillis`, `modifiedAtMillis`, `isSymlink`.",
|
||||
returns = TypeGenericDoc(type("lyng.Map"), listOf(type("lyng.String"), type("lyng.Any"))),
|
||||
moduleName = module.packageName
|
||||
) {
|
||||
fsGuard {
|
||||
val self = this.thisObj as ObjPath
|
||||
val m = self.secured.metadata(self.path)
|
||||
ObjMap(mutableMapOf(
|
||||
ObjString("isFile") to ObjBool(m.isRegularFile),
|
||||
ObjString("isDirectory") to ObjBool(m.isDirectory),
|
||||
ObjString("size") to (m.size?.toLong() ?: 0L).toObj(),
|
||||
ObjString("createdAtMillis") to ((m.createdAtMillis ?: 0L)).toObj(),
|
||||
ObjString("modifiedAtMillis") to ((m.modifiedAtMillis ?: 0L)).toObj(),
|
||||
ObjString("isSymlink") to ObjBool(m.isSymlink),
|
||||
))
|
||||
}
|
||||
}
|
||||
// mkdirs(mustCreate: Bool=false)
|
||||
addFnDoc(
|
||||
name = "mkdirs",
|
||||
doc = "Create directories (like `mkdir -p`). Optional `mustCreate` enforces error if target exists.",
|
||||
params = listOf(ParamDoc("mustCreate", type("lyng.Bool"))),
|
||||
moduleName = module.packageName
|
||||
) {
|
||||
fsGuard {
|
||||
val self = this.thisObj as ObjPath
|
||||
val mustCreate = args.list.getOrNull(0)?.toBool() ?: false
|
||||
self.secured.createDirectories(self.path, mustCreate)
|
||||
ObjVoid
|
||||
}
|
||||
}
|
||||
// move(to: Path|String, overwrite: Bool=false)
|
||||
addFnDoc(
|
||||
name = "move",
|
||||
doc = "Move this path to a new location. `to` may be a `Path` or `String`. Use `overwrite` to replace existing target.",
|
||||
// types vary; keep generic description in doc
|
||||
params = listOf(ParamDoc("to"), ParamDoc("overwrite", type("lyng.Bool"))),
|
||||
moduleName = module.packageName
|
||||
) {
|
||||
fsGuard {
|
||||
val self = this.thisObj as ObjPath
|
||||
val toPath = parsePathArg(this, self, requiredArg<Obj>(0))
|
||||
val overwrite = args.list.getOrNull(1)?.toBool() ?: false
|
||||
self.secured.move(self.path, toPath, overwrite)
|
||||
ObjVoid
|
||||
}
|
||||
}
|
||||
// delete(mustExist: Bool=false, recursively: Bool=false)
|
||||
addFnDoc(
|
||||
name = "delete",
|
||||
doc = "Delete this path. Optional flags: `mustExist` and `recursively`.",
|
||||
params = listOf(ParamDoc("mustExist", type("lyng.Bool")), ParamDoc("recursively", type("lyng.Bool"))),
|
||||
moduleName = module.packageName
|
||||
) {
|
||||
fsGuard {
|
||||
val self = this.thisObj as ObjPath
|
||||
val mustExist = args.list.getOrNull(0)?.toBool() ?: false
|
||||
val recursively = args.list.getOrNull(1)?.toBool() ?: false
|
||||
self.secured.delete(self.path, mustExist, recursively)
|
||||
ObjVoid
|
||||
}
|
||||
}
|
||||
// copy(to: Path|String, overwrite: Bool=false)
|
||||
addFnDoc(
|
||||
name = "copy",
|
||||
doc = "Copy this path to a new location. `to` may be a `Path` or `String`. Use `overwrite` to replace existing target.",
|
||||
params = listOf(ParamDoc("to"), ParamDoc("overwrite", type("lyng.Bool"))),
|
||||
moduleName = module.packageName
|
||||
) {
|
||||
fsGuard {
|
||||
val self = this.thisObj as ObjPath
|
||||
val toPath = parsePathArg(this, self, requiredArg<Obj>(0))
|
||||
val overwrite = args.list.getOrNull(1)?.toBool() ?: false
|
||||
self.secured.copy(self.path, toPath, overwrite)
|
||||
ObjVoid
|
||||
}
|
||||
}
|
||||
// glob(pattern: String): List<Path>
|
||||
addFnDoc(
|
||||
name = "glob",
|
||||
doc = "List entries matching a glob pattern (no recursion).",
|
||||
params = listOf(ParamDoc("pattern", type("lyng.String"))),
|
||||
returns = TypeGenericDoc(type("lyng.List"), listOf(type("Path"))),
|
||||
moduleName = module.packageName
|
||||
) {
|
||||
fsGuard {
|
||||
val self = this.thisObj as ObjPath
|
||||
val pattern = requireOnlyArg<ObjString>().value
|
||||
val matches = self.secured.glob(self.path, pattern)
|
||||
ObjList(matches.map { ObjPath(self.objClass, self.secured, it) }.toMutableList())
|
||||
}
|
||||
}
|
||||
|
||||
// --- streaming readers (initial version: chunk from whole content, API stable) ---
|
||||
|
||||
// readChunks(size: Int = 65536) -> Iterator<Buffer>
|
||||
addFnDoc(
|
||||
name = "readChunks",
|
||||
doc = "Read file in fixed-size chunks as an iterator of `Buffer`.",
|
||||
params = listOf(ParamDoc("size", type("lyng.Int"))),
|
||||
returns = TypeGenericDoc(type("lyng.Iterator"), listOf(type("lyng.Buffer"))),
|
||||
moduleName = module.packageName
|
||||
) {
|
||||
fsGuard {
|
||||
val self = this.thisObj as ObjPath
|
||||
val size = args.list.getOrNull(0)?.toInt() ?: 65536
|
||||
val bytes = self.secured.readBytes(self.path)
|
||||
ObjFsBytesIterator(bytes, size)
|
||||
}
|
||||
}
|
||||
|
||||
// readUtf8Chunks(size: Int = 65536) -> Iterator<String>
|
||||
addFnDoc(
|
||||
name = "readUtf8Chunks",
|
||||
doc = "Read UTF-8 text in fixed-size chunks as an iterator of `String`.",
|
||||
params = listOf(ParamDoc("size", type("lyng.Int"))),
|
||||
returns = TypeGenericDoc(type("lyng.Iterator"), listOf(type("lyng.String"))),
|
||||
moduleName = module.packageName
|
||||
) {
|
||||
fsGuard {
|
||||
val self = this.thisObj as ObjPath
|
||||
val size = args.list.getOrNull(0)?.toInt() ?: 65536
|
||||
val text = self.secured.readUtf8(self.path)
|
||||
ObjFsStringChunksIterator(text, size)
|
||||
}
|
||||
}
|
||||
|
||||
// lines() -> Iterator<String>, implemented via readUtf8Chunks
|
||||
addFnDoc(
|
||||
name = "lines",
|
||||
doc = "Iterate lines of the file as `String` values.",
|
||||
returns = TypeGenericDoc(type("lyng.Iterator"), listOf(type("lyng.String"))),
|
||||
moduleName = module.packageName
|
||||
) {
|
||||
fsGuard {
|
||||
val chunkIt = thisObj.invokeInstanceMethod(this, "readUtf8Chunks")
|
||||
ObjFsLinesIterator(chunkIt)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Export into the module scope with docs
|
||||
module.addConstDoc(
|
||||
name = "Path",
|
||||
value = pathType,
|
||||
doc = "Filesystem path class. Construct with a string: `Path(\"/tmp\")`.",
|
||||
type = type("Path"),
|
||||
moduleName = module.packageName
|
||||
)
|
||||
// Alias as requested (Path(s) style)
|
||||
module.addConstDoc(
|
||||
name = "Paths",
|
||||
value = pathType,
|
||||
doc = "Alias of `Path` for those who prefer plural form.",
|
||||
type = type("Path"),
|
||||
moduleName = module.packageName
|
||||
)
|
||||
}
|
||||
|
||||
// --- Helper classes and utilities ---
|
||||
|
||||
private fun parsePathArg(scope: Scope, self: ObjPath, arg: Obj): LyngPath {
|
||||
return when (arg) {
|
||||
is ObjString -> arg.value.toPath()
|
||||
is ObjPath -> arg.path
|
||||
else -> scope.raiseIllegalArgument("expected Path or String argument")
|
||||
}
|
||||
}
|
||||
|
||||
// Map Fs access denials to Lyng runtime exceptions for script-friendly errors
|
||||
private suspend inline fun Scope.fsGuard(crossinline block: suspend () -> Obj): Obj {
|
||||
return try {
|
||||
block()
|
||||
} catch (e: AccessDeniedException) {
|
||||
raiseError(ObjIllegalOperationException(this, e.reasonDetail ?: "access denied"))
|
||||
}
|
||||
}
|
||||
|
||||
/** Kotlin-side instance backing the Lyng class `Path`. */
|
||||
class ObjPath(
|
||||
private val klass: ObjClass,
|
||||
val secured: LyngFs,
|
||||
val path: LyngPath,
|
||||
) : Obj() {
|
||||
// Cache for metadata to avoid repeated FS calls within the same object instance usage
|
||||
private var _metadata: net.sergeych.lyngio.fs.LyngMetadata? = null
|
||||
|
||||
override val objClass: ObjClass get() = klass
|
||||
override fun toString(): String = path.toString()
|
||||
|
||||
suspend fun ensureMetadata(): net.sergeych.lyngio.fs.LyngMetadata {
|
||||
val cached = _metadata
|
||||
if (cached != null) return cached
|
||||
val m = secured.metadata(path)
|
||||
_metadata = m
|
||||
return m
|
||||
}
|
||||
}
|
||||
|
||||
/** Iterator over byte chunks as Buffers. */
|
||||
class ObjFsBytesIterator(
|
||||
private val data: ByteArray,
|
||||
private val chunkSize: Int,
|
||||
) : Obj() {
|
||||
private var pos = 0
|
||||
|
||||
override val objClass: ObjClass = BytesIteratorType
|
||||
|
||||
companion object {
|
||||
val BytesIteratorType = object : ObjClass("BytesIterator", ObjIterator) {
|
||||
init {
|
||||
// make it usable in for-loops
|
||||
addFnDoc(
|
||||
name = "iterator",
|
||||
doc = "Return this iterator instance (enables `for` loops).",
|
||||
returns = type("BytesIterator"),
|
||||
moduleName = "lyng.io.fs"
|
||||
) { thisObj }
|
||||
addFnDoc(
|
||||
name = "hasNext",
|
||||
doc = "Whether there is another chunk available.",
|
||||
returns = type("lyng.Bool"),
|
||||
moduleName = "lyng.io.fs"
|
||||
) {
|
||||
val self = thisAs<ObjFsBytesIterator>()
|
||||
(self.pos < self.data.size).toObj()
|
||||
}
|
||||
addFnDoc(
|
||||
name = "next",
|
||||
doc = "Return the next chunk as a `Buffer`.",
|
||||
returns = type("lyng.Buffer"),
|
||||
moduleName = "lyng.io.fs"
|
||||
) {
|
||||
val self = thisAs<ObjFsBytesIterator>()
|
||||
if (self.pos >= self.data.size) raiseIllegalState("iterator exhausted")
|
||||
val end = minOf(self.pos + self.chunkSize, self.data.size)
|
||||
val chunk = self.data.copyOfRange(self.pos, end)
|
||||
self.pos = end
|
||||
ObjBuffer(chunk.asUByteArray())
|
||||
}
|
||||
addFnDoc(
|
||||
name = "cancelIteration",
|
||||
doc = "Stop the iteration early; subsequent `hasNext` returns false.",
|
||||
moduleName = "lyng.io.fs"
|
||||
) {
|
||||
val self = thisAs<ObjFsBytesIterator>()
|
||||
self.pos = self.data.size
|
||||
ObjVoid
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/** Iterator over utf-8 text chunks (character-counted chunks). */
|
||||
class ObjFsStringChunksIterator(
|
||||
private val text: String,
|
||||
private val chunkChars: Int,
|
||||
) : Obj() {
|
||||
private var pos = 0
|
||||
|
||||
override val objClass: ObjClass = StringChunksIteratorType
|
||||
|
||||
companion object {
|
||||
val StringChunksIteratorType = object : ObjClass("StringChunksIterator", ObjIterator) {
|
||||
init {
|
||||
// make it usable in for-loops
|
||||
addFnDoc(
|
||||
name = "iterator",
|
||||
doc = "Return this iterator instance (enables `for` loops).",
|
||||
returns = type("StringChunksIterator"),
|
||||
moduleName = "lyng.io.fs"
|
||||
) { thisObj }
|
||||
addFnDoc(
|
||||
name = "hasNext",
|
||||
doc = "Whether there is another chunk available.",
|
||||
returns = type("lyng.Bool"),
|
||||
moduleName = "lyng.io.fs"
|
||||
) {
|
||||
val self = thisAs<ObjFsStringChunksIterator>()
|
||||
(self.pos < self.text.length).toObj()
|
||||
}
|
||||
addFnDoc(
|
||||
name = "next",
|
||||
doc = "Return the next UTF-8 chunk as a `String`.",
|
||||
returns = type("lyng.String"),
|
||||
moduleName = "lyng.io.fs"
|
||||
) {
|
||||
val self = thisAs<ObjFsStringChunksIterator>()
|
||||
if (self.pos >= self.text.length) raiseIllegalState("iterator exhausted")
|
||||
val end = minOf(self.pos + self.chunkChars, self.text.length)
|
||||
val chunk = self.text.substring(self.pos, end)
|
||||
self.pos = end
|
||||
ObjString(chunk)
|
||||
}
|
||||
addFnDoc(
|
||||
name = "cancelIteration",
|
||||
doc = "Stop the iteration early; subsequent `hasNext` returns false.",
|
||||
moduleName = "lyng.io.fs"
|
||||
) { ObjVoid }
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/** Iterator that yields lines using an underlying chunks iterator. */
|
||||
class ObjFsLinesIterator(
|
||||
private val chunksIterator: Obj,
|
||||
) : Obj() {
|
||||
private var buffer: String = ""
|
||||
private var exhausted = false
|
||||
|
||||
override val objClass: ObjClass = LinesIteratorType
|
||||
|
||||
companion object {
|
||||
val LinesIteratorType = object : ObjClass("LinesIterator", ObjIterator) {
|
||||
init {
|
||||
// make it usable in for-loops
|
||||
addFnDoc(
|
||||
name = "iterator",
|
||||
doc = "Return this iterator instance (enables `for` loops).",
|
||||
returns = type("LinesIterator"),
|
||||
moduleName = "lyng.io.fs"
|
||||
) { thisObj }
|
||||
addFnDoc(
|
||||
name = "hasNext",
|
||||
doc = "Whether another line is available.",
|
||||
returns = type("lyng.Bool"),
|
||||
moduleName = "lyng.io.fs"
|
||||
) {
|
||||
val self = thisAs<ObjFsLinesIterator>()
|
||||
self.ensureBufferFilled(this)
|
||||
(self.buffer.isNotEmpty() || !self.exhausted).toObj()
|
||||
}
|
||||
addFnDoc(
|
||||
name = "next",
|
||||
doc = "Return the next line as `String`.",
|
||||
returns = type("lyng.String"),
|
||||
moduleName = "lyng.io.fs"
|
||||
) {
|
||||
val self = thisAs<ObjFsLinesIterator>()
|
||||
self.ensureBufferFilled(this)
|
||||
if (self.buffer.isEmpty() && self.exhausted) raiseIllegalState("iterator exhausted")
|
||||
val idx = self.buffer.indexOf('\n')
|
||||
val line = if (idx >= 0) {
|
||||
val l = self.buffer.substring(0, idx)
|
||||
self.buffer = self.buffer.substring(idx + 1)
|
||||
l
|
||||
} else {
|
||||
// last line without trailing newline
|
||||
val l = self.buffer
|
||||
self.buffer = ""
|
||||
self.exhausted = true
|
||||
l
|
||||
}
|
||||
ObjString(line)
|
||||
}
|
||||
addFnDoc(
|
||||
name = "cancelIteration",
|
||||
doc = "Stop the iteration early; subsequent `hasNext` returns false.",
|
||||
moduleName = "lyng.io.fs"
|
||||
) { ObjVoid }
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
private suspend fun ensureBufferFilled(scope: Scope) {
|
||||
if (buffer.contains('\n') || exhausted) return
|
||||
// Pull next chunk from the underlying iterator
|
||||
val it = chunksIterator.invokeInstanceMethod(scope, "iterator")
|
||||
val hasNext = it.invokeInstanceMethod(scope, "hasNext").toBool()
|
||||
if (!hasNext) {
|
||||
exhausted = true
|
||||
return
|
||||
}
|
||||
val next = it.invokeInstanceMethod(scope, "next")
|
||||
buffer += next.toString()
|
||||
}
|
||||
}
|
||||
@@ -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.
|
||||
*
|
||||
*/
|
||||
|
||||
package net.sergeych.lyngio
|
||||
|
||||
/**
|
||||
* LyngIO: foundation for uniform file access APIs across JVM, Native and JS.
|
||||
*
|
||||
* This module depends on `:lynglib` and is configured as a Compose Multiplatform
|
||||
* library, but it does not require Compose at runtime. Actual file system APIs
|
||||
* will be added after we agree on the backend choices (Okio, NodeJS FS, browser VFS).
|
||||
*/
|
||||
object LyngIoInfo {
|
||||
val name: String = "LyngIO"
|
||||
val version: String = "0.0.1-SNAPSHOT"
|
||||
}
|
||||
@@ -0,0 +1,201 @@
|
||||
/*
|
||||
* 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.lyngio.fs
|
||||
|
||||
import kotlinx.coroutines.CoroutineDispatcher
|
||||
import kotlinx.coroutines.withContext
|
||||
import okio.*
|
||||
|
||||
/**
|
||||
* Async-first FS API (intermediate public surface).
|
||||
* Note: this is an interim step on the way to final exported entities; names/types may evolve,
|
||||
* but these APIs will stay public to ease migration.
|
||||
*/
|
||||
typealias LyngPath = Path
|
||||
|
||||
/** Metadata snapshot for a filesystem node. */
|
||||
data class LyngMetadata(
|
||||
val isRegularFile: Boolean,
|
||||
val isDirectory: Boolean,
|
||||
val size: Long?,
|
||||
val createdAtMillis: Long?,
|
||||
val modifiedAtMillis: Long?,
|
||||
val isSymlink: Boolean,
|
||||
)
|
||||
|
||||
/**
|
||||
* Suspend-first, uniform filesystem. Heavy ops must not block the main thread or event loop.
|
||||
*/
|
||||
interface LyngFs {
|
||||
suspend fun exists(path: LyngPath): Boolean
|
||||
suspend fun list(dir: LyngPath): List<LyngPath>
|
||||
suspend fun readBytes(path: LyngPath): ByteArray
|
||||
suspend fun writeBytes(path: LyngPath, data: ByteArray, append: Boolean = false)
|
||||
suspend fun readUtf8(path: LyngPath): String
|
||||
suspend fun writeUtf8(path: LyngPath, text: String, append: Boolean = false)
|
||||
suspend fun metadata(path: LyngPath): LyngMetadata
|
||||
suspend fun createDirectories(dir: LyngPath, mustCreate: Boolean = false)
|
||||
suspend fun move(from: LyngPath, to: LyngPath, overwrite: Boolean = false)
|
||||
suspend fun delete(path: LyngPath, mustExist: Boolean = false, recursively: Boolean = false)
|
||||
|
||||
/** Default implementation: naive read-all + write; backends may override for efficiency. */
|
||||
suspend fun copy(from: LyngPath, to: LyngPath, overwrite: Boolean = false) {
|
||||
if (!overwrite && exists(to)) error("Target exists: $to")
|
||||
val data = readBytes(from)
|
||||
writeBytes(to, data, append = false)
|
||||
}
|
||||
|
||||
/** Glob search starting at [dir], matching [pattern] with `**`, `*`, and `?`. */
|
||||
suspend fun glob(dir: LyngPath, pattern: String): List<LyngPath> {
|
||||
val regex = globToRegex(pattern)
|
||||
val base = dir
|
||||
val out = mutableListOf<LyngPath>()
|
||||
suspend fun walk(d: LyngPath, rel: String) {
|
||||
for (child in list(d)) {
|
||||
val relPath = if (rel.isEmpty()) child.name else "$rel/${child.name}"
|
||||
if (regex.matches(relPath)) out += child
|
||||
if (metadata(child).isDirectory) walk(child, relPath)
|
||||
}
|
||||
}
|
||||
walk(base, "")
|
||||
return out
|
||||
}
|
||||
}
|
||||
|
||||
/** Okio-backed async implementation used on JVM/Android/Native and in-memory browser. */
|
||||
class OkioAsyncFs(private val fs: FileSystem) : LyngFs {
|
||||
override suspend fun exists(path: LyngPath): Boolean = withContext(LyngIoDispatcher) {
|
||||
try { fs.metadataOrNull(path) != null } catch (_: Throwable) { false }
|
||||
}
|
||||
|
||||
override suspend fun list(dir: LyngPath): List<LyngPath> = withContext(LyngIoDispatcher) {
|
||||
fs.list(dir)
|
||||
}
|
||||
|
||||
override suspend fun readBytes(path: LyngPath): ByteArray = withContext(LyngIoDispatcher) {
|
||||
val buffer = Buffer()
|
||||
fs.source(path).buffer().use { it.readAll(buffer) }
|
||||
buffer.readByteArray()
|
||||
}
|
||||
|
||||
override suspend fun writeBytes(path: LyngPath, data: ByteArray, append: Boolean) {
|
||||
withContext(LyngIoDispatcher) {
|
||||
val sink = if (append) fs.appendingSink(path) else fs.sink(path)
|
||||
sink.buffer().use { it.write(data) }
|
||||
}
|
||||
}
|
||||
|
||||
override suspend fun readUtf8(path: LyngPath): String = withContext(LyngIoDispatcher) {
|
||||
val buffer = Buffer()
|
||||
fs.source(path).buffer().use { it.readAll(buffer) }
|
||||
buffer.readUtf8()
|
||||
}
|
||||
|
||||
override suspend fun writeUtf8(path: LyngPath, text: String, append: Boolean) {
|
||||
withContext(LyngIoDispatcher) {
|
||||
val sink = if (append) fs.appendingSink(path) else fs.sink(path)
|
||||
sink.buffer().use { it.writeUtf8(text) }
|
||||
}
|
||||
}
|
||||
|
||||
override suspend fun metadata(path: LyngPath): LyngMetadata = withContext(LyngIoDispatcher) {
|
||||
val m = fs.metadata(path)
|
||||
LyngMetadata(
|
||||
isRegularFile = m.isRegularFile,
|
||||
isDirectory = m.isDirectory,
|
||||
size = m.size,
|
||||
createdAtMillis = m.createdAtMillis,
|
||||
modifiedAtMillis = m.lastModifiedAtMillis,
|
||||
isSymlink = m.symlinkTarget != null,
|
||||
)
|
||||
}
|
||||
|
||||
override suspend fun createDirectories(dir: LyngPath, mustCreate: Boolean) = withContext(LyngIoDispatcher) {
|
||||
fs.createDirectories(dir, mustCreate)
|
||||
}
|
||||
|
||||
override suspend fun move(from: LyngPath, to: LyngPath, overwrite: Boolean) = withContext(LyngIoDispatcher) {
|
||||
if (overwrite) fs.delete(to, mustExist = false)
|
||||
fs.atomicMove(from, to)
|
||||
}
|
||||
|
||||
override suspend fun delete(path: LyngPath, mustExist: Boolean, recursively: Boolean) = withContext(LyngIoDispatcher) {
|
||||
if (!recursively) {
|
||||
fs.delete(path, mustExist)
|
||||
return@withContext
|
||||
}
|
||||
fun deleteRec(p: Path) {
|
||||
val meta = fs.metadataOrNull(p)
|
||||
if (meta == null) {
|
||||
if (mustExist) throw IllegalStateException("No such file or directory: $p")
|
||||
return
|
||||
}
|
||||
if (meta.isDirectory) for (child in fs.list(p)) deleteRec(child)
|
||||
fs.delete(p, mustExist = false)
|
||||
}
|
||||
deleteRec(path)
|
||||
if (mustExist && fs.metadataOrNull(path) != null) error("Failed to delete: $path")
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Default system FS selector per platform.
|
||||
* - JVM/Android/Native: Okio `FileSystem.SYSTEM`
|
||||
* - Node: native fs/promises implementation (non-blocking)
|
||||
* - Browser/Wasm: in-memory Okio `FakeFileSystem`
|
||||
*/
|
||||
expect fun platformAsyncFs(): LyngFs
|
||||
expect val LyngIoDispatcher: CoroutineDispatcher
|
||||
|
||||
object LyngFS { // factory holder (interim name)
|
||||
fun system(): LyngFs = platformAsyncFs()
|
||||
}
|
||||
|
||||
// --- helpers ---
|
||||
|
||||
private fun globToRegex(pattern: String): Regex {
|
||||
// Convert glob with **, *, ? into a Regex that matches relative POSIX paths
|
||||
val sb = StringBuilder()
|
||||
var i = 0
|
||||
sb.append('^')
|
||||
while (i < pattern.length) {
|
||||
when (val c = pattern[i]) {
|
||||
'*' -> {
|
||||
val isDouble = i + 1 < pattern.length && pattern[i + 1] == '*'
|
||||
if (isDouble) {
|
||||
// ** → match across directories
|
||||
// Consume optional following slash
|
||||
val nextIsSlash = i + 2 < pattern.length && (pattern[i + 2] == '/' || pattern[i + 2] == '\\')
|
||||
sb.append(".*")
|
||||
if (nextIsSlash) i += 1 // skip one extra to consume slash later via i+=2 below
|
||||
i += 1
|
||||
} else {
|
||||
// * within a segment (no slash)
|
||||
sb.append("[^/]*")
|
||||
}
|
||||
}
|
||||
'?' -> sb.append("[^/]")
|
||||
'.', '(', ')', '+', '|', '^', '$', '{', '}', '[', ']', '\\' -> sb.append('\\').append(c)
|
||||
'/' , '\\' -> sb.append('/')
|
||||
else -> sb.append(c)
|
||||
}
|
||||
i += 1
|
||||
}
|
||||
sb.append('$')
|
||||
return Regex(sb.toString())
|
||||
}
|
||||
@@ -0,0 +1,105 @@
|
||||
/*
|
||||
* 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.lyngio.fs.security
|
||||
|
||||
import net.sergeych.lyngio.fs.LyngPath
|
||||
|
||||
/**
|
||||
* Primitive filesystem operations for access control decisions.
|
||||
* Keep this sealed hierarchy minimal and extensible.
|
||||
*/
|
||||
sealed interface AccessOp {
|
||||
data class ListDir(val path: LyngPath) : AccessOp
|
||||
data class CreateFile(val path: LyngPath) : AccessOp
|
||||
data class OpenRead(val path: LyngPath) : AccessOp
|
||||
data class OpenWrite(val path: LyngPath) : AccessOp
|
||||
data class OpenAppend(val path: LyngPath) : AccessOp
|
||||
data class Delete(val path: LyngPath) : AccessOp
|
||||
data class Rename(val from: LyngPath, val to: LyngPath) : AccessOp
|
||||
|
||||
/** Update file metadata/attributes (times, permissions, flags, etc.). */
|
||||
data class UpdateAttributes(val path: LyngPath) : AccessOp
|
||||
}
|
||||
|
||||
/**
|
||||
* Optional contextual information for access decisions (principal, tags, attributes).
|
||||
* This is intentionally generic to avoid coupling with specific auth models.
|
||||
*/
|
||||
data class AccessContext(
|
||||
val principal: String? = null,
|
||||
val attributes: Map<String, Any?> = emptyMap(),
|
||||
)
|
||||
|
||||
enum class Decision { Allow, Deny }
|
||||
|
||||
data class AccessDecision(
|
||||
val decision: Decision,
|
||||
val reason: String? = null,
|
||||
) {
|
||||
fun isAllowed(): Boolean = decision == Decision.Allow
|
||||
}
|
||||
|
||||
class AccessDeniedException(
|
||||
val op: AccessOp,
|
||||
val reasonDetail: String? = null,
|
||||
) : IllegalStateException("Access denied for $op" + (reasonDetail?.let { ": $it" } ?: ""))
|
||||
|
||||
/**
|
||||
* Policy interface that decides whether a specific filesystem operation is allowed.
|
||||
*
|
||||
* Note: by convention, updating file attributes should be treated as equivalent to
|
||||
* write permission unless a stricter policy is desired. I.e., policies may implement
|
||||
* [AccessOp.UpdateAttributes] by delegating to [AccessOp.OpenWrite] for the same path.
|
||||
*/
|
||||
interface FsAccessPolicy {
|
||||
suspend fun check(op: AccessOp, ctx: AccessContext = AccessContext()): AccessDecision
|
||||
|
||||
// Convenience helpers
|
||||
suspend fun require(op: AccessOp, ctx: AccessContext = AccessContext()) {
|
||||
val res = check(op, ctx)
|
||||
if (!res.isAllowed()) throw AccessDeniedException(op, res.reason)
|
||||
}
|
||||
|
||||
suspend fun canList(path: LyngPath, ctx: AccessContext = AccessContext()) =
|
||||
check(AccessOp.ListDir(path), ctx).isAllowed()
|
||||
|
||||
suspend fun canCreateFile(path: LyngPath, ctx: AccessContext = AccessContext()) =
|
||||
check(AccessOp.CreateFile(path), ctx).isAllowed()
|
||||
|
||||
suspend fun canOpenRead(path: LyngPath, ctx: AccessContext = AccessContext()) =
|
||||
check(AccessOp.OpenRead(path), ctx).isAllowed()
|
||||
|
||||
suspend fun canOpenWrite(path: LyngPath, ctx: AccessContext = AccessContext()) =
|
||||
check(AccessOp.OpenWrite(path), ctx).isAllowed()
|
||||
|
||||
suspend fun canOpenAppend(path: LyngPath, ctx: AccessContext = AccessContext()) =
|
||||
check(AccessOp.OpenAppend(path), ctx).isAllowed()
|
||||
|
||||
suspend fun canDelete(path: LyngPath, ctx: AccessContext = AccessContext()) =
|
||||
check(AccessOp.Delete(path), ctx).isAllowed()
|
||||
|
||||
suspend fun canRename(from: LyngPath, to: LyngPath, ctx: AccessContext = AccessContext()) =
|
||||
check(AccessOp.Rename(from, to), ctx).isAllowed()
|
||||
|
||||
/**
|
||||
* Updating file attributes defaults to the same access level as opening for write
|
||||
* in typical policies. Policies may override that to be stricter/looser.
|
||||
*/
|
||||
suspend fun canUpdateAttributes(path: LyngPath, ctx: AccessContext = AccessContext()) =
|
||||
check(AccessOp.UpdateAttributes(path), ctx).isAllowed()
|
||||
}
|
||||
@@ -0,0 +1,110 @@
|
||||
/*
|
||||
* 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.lyngio.fs.security
|
||||
|
||||
import net.sergeych.lyngio.fs.LyngFs
|
||||
import net.sergeych.lyngio.fs.LyngMetadata
|
||||
import net.sergeych.lyngio.fs.LyngPath
|
||||
|
||||
/**
|
||||
* Decorator that applies an [FsAccessPolicy] to a delegate [LyngFs].
|
||||
* Composite operations are checked as a set of primitive [AccessOp]s.
|
||||
*
|
||||
* Note: attribute update operations are covered by [AccessOp.UpdateAttributes] which
|
||||
* by convention defaults to write permission in policy implementations.
|
||||
*/
|
||||
class LyngFsSecured(
|
||||
private val delegate: LyngFs,
|
||||
private val policy: FsAccessPolicy,
|
||||
private val ctx: AccessContext = AccessContext(),
|
||||
) : LyngFs {
|
||||
|
||||
override suspend fun exists(path: LyngPath): Boolean {
|
||||
// Existence check is safe; do not guard to allow probing. Policies may tighten later.
|
||||
return delegate.exists(path)
|
||||
}
|
||||
|
||||
override suspend fun list(dir: LyngPath): List<LyngPath> {
|
||||
policy.require(AccessOp.ListDir(dir), ctx)
|
||||
return delegate.list(dir)
|
||||
}
|
||||
|
||||
override suspend fun readBytes(path: LyngPath): ByteArray {
|
||||
policy.require(AccessOp.OpenRead(path), ctx)
|
||||
return delegate.readBytes(path)
|
||||
}
|
||||
|
||||
override suspend fun writeBytes(path: LyngPath, data: ByteArray, append: Boolean) {
|
||||
if (append) {
|
||||
policy.require(AccessOp.OpenAppend(path), ctx)
|
||||
} else {
|
||||
policy.require(AccessOp.OpenWrite(path), ctx)
|
||||
}
|
||||
// Also require create-file to cover cases when the file does not exist yet.
|
||||
policy.require(AccessOp.CreateFile(path), ctx)
|
||||
return delegate.writeBytes(path, data, append)
|
||||
}
|
||||
|
||||
override suspend fun readUtf8(path: LyngPath): String {
|
||||
policy.require(AccessOp.OpenRead(path), ctx)
|
||||
return delegate.readUtf8(path)
|
||||
}
|
||||
|
||||
override suspend fun writeUtf8(path: LyngPath, text: String, append: Boolean) {
|
||||
if (append) {
|
||||
policy.require(AccessOp.OpenAppend(path), ctx)
|
||||
} else {
|
||||
policy.require(AccessOp.OpenWrite(path), ctx)
|
||||
}
|
||||
policy.require(AccessOp.CreateFile(path), ctx)
|
||||
return delegate.writeUtf8(path, text, append)
|
||||
}
|
||||
|
||||
override suspend fun metadata(path: LyngPath): LyngMetadata {
|
||||
// Not specified in v1; treat as read access for now (can be revised later).
|
||||
// policy.require(AccessOp.OpenRead(path), ctx)
|
||||
return delegate.metadata(path)
|
||||
}
|
||||
|
||||
override suspend fun createDirectories(dir: LyngPath, mustCreate: Boolean) {
|
||||
// Model directory creation using CreateFile on the path to be created.
|
||||
policy.require(AccessOp.CreateFile(dir), ctx)
|
||||
return delegate.createDirectories(dir, mustCreate)
|
||||
}
|
||||
|
||||
override suspend fun move(from: LyngPath, to: LyngPath, overwrite: Boolean) {
|
||||
// Prefer Rename primitive; also check target deletion if overwrite.
|
||||
policy.require(AccessOp.Rename(from, to), ctx)
|
||||
if (overwrite) policy.require(AccessOp.Delete(to), ctx)
|
||||
return delegate.move(from, to, overwrite)
|
||||
}
|
||||
|
||||
override suspend fun delete(path: LyngPath, mustExist: Boolean, recursively: Boolean) {
|
||||
policy.require(AccessOp.Delete(path), ctx)
|
||||
return delegate.delete(path, mustExist, recursively)
|
||||
}
|
||||
|
||||
override suspend fun copy(from: LyngPath, to: LyngPath, overwrite: Boolean) {
|
||||
// Composite checks: read from source, create+write to dest, optional delete target first.
|
||||
policy.require(AccessOp.OpenRead(from), ctx)
|
||||
if (overwrite) policy.require(AccessOp.Delete(to), ctx)
|
||||
policy.require(AccessOp.CreateFile(to), ctx)
|
||||
policy.require(AccessOp.OpenWrite(to), ctx)
|
||||
return delegate.copy(from, to, overwrite)
|
||||
}
|
||||
}
|
||||
@@ -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.lyngio.fs.security
|
||||
|
||||
/**
|
||||
* Minimal policy that allows every operation. Useful as a default or for tests.
|
||||
*/
|
||||
object PermitAllAccessPolicy : FsAccessPolicy {
|
||||
private val allow = AccessDecision(Decision.Allow)
|
||||
|
||||
override suspend fun check(op: AccessOp, ctx: AccessContext): AccessDecision = allow
|
||||
}
|
||||
@@ -0,0 +1,20 @@
|
||||
/*
|
||||
* Copyright 2025 Sergey S. Chernov real.sergeych@gmail.com
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*
|
||||
*/
|
||||
|
||||
package net.sergeych.lyngio.fs
|
||||
|
||||
// Browser-specific actuals are provided in jsMain to avoid duplicate actuals per JS target.
|
||||
@@ -0,0 +1,33 @@
|
||||
/*
|
||||
* 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.lyngio.fs
|
||||
|
||||
import kotlinx.coroutines.CoroutineDispatcher
|
||||
import kotlinx.coroutines.Dispatchers
|
||||
import okio.FileSystem
|
||||
import okio.fakefilesystem.FakeFileSystem
|
||||
|
||||
@Suppress("UnsafeCastFromDynamic")
|
||||
private fun systemFsOrNull(): FileSystem? = try {
|
||||
FileSystem.asDynamic().SYSTEM.unsafeCast<FileSystem>()
|
||||
} catch (e: Throwable) {
|
||||
null
|
||||
}
|
||||
|
||||
actual fun platformAsyncFs(): LyngFs = OkioAsyncFs(systemFsOrNull() ?: FakeFileSystem())
|
||||
actual val LyngIoDispatcher: CoroutineDispatcher = Dispatchers.Default
|
||||
@@ -0,0 +1,20 @@
|
||||
/*
|
||||
* Copyright 2025 Sergey S. Chernov real.sergeych@gmail.com
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*
|
||||
*/
|
||||
|
||||
package net.sergeych.lyngio.fs
|
||||
|
||||
// Node-specific implementations are provided dynamically in jsMain via FileSystem.SYSTEM detection.
|
||||
@@ -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.lyngio.fs
|
||||
|
||||
import kotlinx.coroutines.CoroutineDispatcher
|
||||
import kotlinx.coroutines.Dispatchers
|
||||
import okio.FileSystem
|
||||
|
||||
actual fun platformAsyncFs(): LyngFs = OkioAsyncFs(FileSystem.SYSTEM)
|
||||
actual val LyngIoDispatcher: CoroutineDispatcher = Dispatchers.IO
|
||||
@@ -0,0 +1,219 @@
|
||||
/*
|
||||
* 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.lyngio.fs
|
||||
|
||||
import kotlinx.coroutines.runBlocking
|
||||
import net.sergeych.lyng.ExecutionError
|
||||
import net.sergeych.lyng.Scope
|
||||
import net.sergeych.lyng.io.fs.createFs
|
||||
import net.sergeych.lyng.obj.ObjIllegalOperationException
|
||||
import net.sergeych.lyngio.fs.security.*
|
||||
import kotlin.io.path.createTempDirectory
|
||||
import kotlin.io.path.writeText
|
||||
import kotlin.test.Test
|
||||
import kotlin.test.assertFailsWith
|
||||
import kotlin.test.assertTrue
|
||||
|
||||
class FsModuleJvmScriptStyleTest {
|
||||
|
||||
private fun newScope(): Scope = Scope.new()
|
||||
|
||||
private suspend fun installModule(scope: Scope) {
|
||||
createFs(PermitAllAccessPolicy, scope)
|
||||
scope.eval("import lyng.io.fs")
|
||||
}
|
||||
|
||||
@Test
|
||||
fun basicTextIoScript() {
|
||||
runBlocking {
|
||||
val scope = newScope()
|
||||
installModule(scope)
|
||||
|
||||
val dir = createTempDirectory("lyngio_script_basic_")
|
||||
try {
|
||||
val file = dir.resolve("hello.txt")
|
||||
scope.eval(
|
||||
"""
|
||||
import lyng.io.fs
|
||||
import lyng.stdlib
|
||||
|
||||
val p = Path("${file}")
|
||||
assertEquals(false, p.exists())
|
||||
p.writeUtf8("Hello from Lyng")
|
||||
assertEquals(true, p.exists())
|
||||
assertEquals("Hello from Lyng", p.readUtf8())
|
||||
println(p.name)
|
||||
assertEquals("hello.txt", p.name)
|
||||
assert(p.segments is List )
|
||||
assert(p.parent is Path)
|
||||
""".trimIndent()
|
||||
)
|
||||
} finally {
|
||||
dir.toFile().deleteRecursively()
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@Test
|
||||
fun listGlobAndMetadataScript() {
|
||||
runBlocking {
|
||||
val scope = newScope()
|
||||
installModule(scope)
|
||||
|
||||
val dir = createTempDirectory("lyngio_script_glob_")
|
||||
try {
|
||||
val a = dir.resolve("a").toFile().apply { mkdirs() }
|
||||
dir.resolve("a/b").toFile().apply { mkdirs() }
|
||||
dir.resolve("a/one.txt").writeText("1")
|
||||
dir.resolve("a/b/two.txt").writeText("2")
|
||||
dir.resolve("a/b/three.md").writeText("3")
|
||||
|
||||
scope.eval(
|
||||
"""
|
||||
import lyng.io.fs
|
||||
val root = Path("${a}")
|
||||
val list = root.list().toList()
|
||||
val names = list.map { it.toString() }
|
||||
var hasOne = false
|
||||
var hasB = false
|
||||
val it1 = names.iterator()
|
||||
while (it1.hasNext()) {
|
||||
val n = it1.next()
|
||||
if (n.endsWith("one.txt")) hasOne = true
|
||||
if (n.endsWith("/b") || n.endsWith("\\b") || n.endsWith("b")) hasB = true
|
||||
}
|
||||
assertEquals(true, hasOne)
|
||||
assertEquals(true, hasB)
|
||||
|
||||
val matches = root.glob("**/*.txt").toList()
|
||||
val mnames = matches.map { it.toString() }
|
||||
var hasOneTxt = false
|
||||
var hasTwoTxt = false
|
||||
val it2 = mnames.iterator()
|
||||
while (it2.hasNext()) {
|
||||
val n = it2.next()
|
||||
if (n.endsWith("one.txt")) hasOneTxt = true
|
||||
if (n.endsWith("two.txt")) hasTwoTxt = true
|
||||
}
|
||||
assertEquals(true, hasOneTxt)
|
||||
assertEquals(true, hasTwoTxt)
|
||||
|
||||
val f = Path("${dir.resolve("a/one.txt")}")
|
||||
val m = f.metadata()
|
||||
assertEquals(true, m["isFile"])
|
||||
""".trimIndent()
|
||||
)
|
||||
} finally {
|
||||
dir.toFile().deleteRecursively()
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@Test
|
||||
fun streamingUtf8ChunksAndLinesScript() {
|
||||
runBlocking {
|
||||
val scope = newScope()
|
||||
installModule(scope)
|
||||
|
||||
val dir = createTempDirectory("lyngio_script_stream_")
|
||||
try {
|
||||
val text = buildString {
|
||||
repeat(5000) { append("строка-").append(it).append('\n') }
|
||||
}
|
||||
val tf = dir.resolve("big.txt"); tf.writeText(text)
|
||||
|
||||
scope.eval(
|
||||
"""
|
||||
import lyng.io.fs
|
||||
val p = Path("${tf}")
|
||||
var total = 0
|
||||
val it = p.readUtf8Chunks(4096)
|
||||
val iter = it.iterator()
|
||||
while (iter.hasNext()) {
|
||||
val chunk = iter.next()
|
||||
total = total + chunk.size()
|
||||
}
|
||||
assertEquals(${text.length}, total)
|
||||
|
||||
var n = 0
|
||||
var first = ""
|
||||
var last = ""
|
||||
val lit = p.lines()
|
||||
val liter = lit.iterator()
|
||||
while (liter.hasNext()) {
|
||||
val ln = liter.next()
|
||||
if (n == 0) first = ln
|
||||
last = ln
|
||||
n = n + 1
|
||||
}
|
||||
assertEquals(5000, n)
|
||||
assertEquals("строка-0", first)
|
||||
assertEquals("строка-4999", last)
|
||||
""".trimIndent()
|
||||
)
|
||||
} finally {
|
||||
dir.toFile().deleteRecursively()
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@Test
|
||||
fun denyingPolicyMappingScript() {
|
||||
runBlocking {
|
||||
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 = "denied by test policy")
|
||||
}
|
||||
}
|
||||
|
||||
val prep = newScope()
|
||||
installModule(prep)
|
||||
val dir = createTempDirectory("lyngio_script_deny_")
|
||||
try {
|
||||
val file = dir.resolve("ro.txt"); file.writeText("ro")
|
||||
|
||||
val scope = newScope()
|
||||
createFs(denyWrites, scope)
|
||||
scope.eval("import lyng.io.fs")
|
||||
|
||||
// reading should succeed
|
||||
scope.eval(
|
||||
"""
|
||||
import lyng.io.fs
|
||||
val p = Path("${file}")
|
||||
assertEquals("ro", p.readUtf8())
|
||||
""".trimIndent()
|
||||
)
|
||||
|
||||
// writing should throw ExecutionError(ObjIllegalOperationException)
|
||||
val err = assertFailsWith<ExecutionError> {
|
||||
scope.eval(
|
||||
"""
|
||||
import lyng.io.fs
|
||||
// don't redeclare `p` to avoid same-scope conflicts across eval calls
|
||||
Path("${file}").writeUtf8("x")
|
||||
""".trimIndent()
|
||||
)
|
||||
}
|
||||
assertTrue((err as ExecutionError).errorObject is ObjIllegalOperationException)
|
||||
} finally {
|
||||
dir.toFile().deleteRecursively()
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,254 @@
|
||||
/*
|
||||
* 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.
|
||||
*
|
||||
*/
|
||||
|
||||
/*
|
||||
* JVM tests for lyng.io.fs module bindings.
|
||||
*/
|
||||
package net.sergeych.lyngio.fs
|
||||
|
||||
import kotlinx.coroutines.runBlocking
|
||||
import net.sergeych.lyng.ExecutionError
|
||||
import net.sergeych.lyng.Scope
|
||||
import net.sergeych.lyng.io.fs.createFs
|
||||
import net.sergeych.lyng.obj.*
|
||||
import net.sergeych.lyngio.fs.security.*
|
||||
import kotlin.io.path.*
|
||||
import kotlin.test.*
|
||||
|
||||
class FsModuleJvmTest {
|
||||
|
||||
private fun newScope(): Scope = Scope.new()
|
||||
|
||||
private suspend fun importFs(scope: Scope) {
|
||||
// Ensure module is installed and imported into the scope
|
||||
val installed = createFs(PermitAllAccessPolicy, scope)
|
||||
// ok to be false if already installed for this manager, but in tests we create a fresh scope
|
||||
scope.eval("import lyng.io.fs")
|
||||
}
|
||||
|
||||
private suspend fun pathObj(scope: Scope, path: String): Obj {
|
||||
val pathClass = scope.get("Path")!!.value as ObjClass
|
||||
return pathClass.callWithArgs(scope, ObjString(path))
|
||||
}
|
||||
|
||||
@Test
|
||||
fun installerIdempotence() = runBlocking {
|
||||
val scope = newScope()
|
||||
val m = scope.importManager
|
||||
assertTrue(createFs(PermitAllAccessPolicy, m))
|
||||
assertFalse(createFs(PermitAllAccessPolicy, m))
|
||||
}
|
||||
|
||||
@Test
|
||||
fun basicReadWriteUtf8AndExists() = runBlocking {
|
||||
val scope = newScope()
|
||||
importFs(scope)
|
||||
|
||||
val tmpDir = kotlin.io.path.createTempDirectory("lyngio_test_")
|
||||
try {
|
||||
val file = tmpDir.resolve("hello.txt")
|
||||
val p = pathObj(scope, file.toString())
|
||||
// Initially doesn't exist
|
||||
assertFalse(p.invokeInstanceMethod(scope, "exists").toBool())
|
||||
// Write and read
|
||||
p.invokeInstanceMethod(scope, "writeUtf8", ObjString("Hello Lyng!"))
|
||||
assertTrue(p.invokeInstanceMethod(scope, "exists").toBool())
|
||||
val read = p.invokeInstanceMethod(scope, "readUtf8") as ObjString
|
||||
assertEquals("Hello Lyng!", read.value)
|
||||
} finally {
|
||||
tmpDir.toFile().deleteRecursively()
|
||||
}
|
||||
}
|
||||
|
||||
@Test
|
||||
fun bytesReadWriteAndMetadata() = runBlocking {
|
||||
val scope = newScope()
|
||||
importFs(scope)
|
||||
|
||||
val tmpDir = kotlin.io.path.createTempDirectory("lyngio_test_bytes_")
|
||||
try {
|
||||
val file = tmpDir.resolve("data.bin")
|
||||
val dirPath = pathObj(scope, tmpDir.toString())
|
||||
val p = pathObj(scope, file.toString())
|
||||
|
||||
// mkdirs on parent dir is no-op but should succeed
|
||||
dirPath.invokeInstanceMethod(scope, "mkdirs")
|
||||
|
||||
val bytes = (0 until 256).map { it.toByte() }.toByteArray().asUByteArray()
|
||||
p.invokeInstanceMethod(scope, "writeBytes", ObjBuffer(bytes))
|
||||
|
||||
val readBuf = p.invokeInstanceMethod(scope, "readBytes") as ObjBuffer
|
||||
assertContentEquals(bytes.asByteArray(), readBuf.byteArray.asByteArray())
|
||||
|
||||
val meta = p.invokeInstanceMethod(scope, "metadata") as ObjMap
|
||||
assertEquals(ObjBool(true), meta.map[ObjString("isFile")])
|
||||
assertEquals(ObjBool(false), meta.map[ObjString("isDirectory")])
|
||||
} finally {
|
||||
tmpDir.toFile().deleteRecursively()
|
||||
}
|
||||
}
|
||||
|
||||
@Test
|
||||
fun listAndGlob() = runBlocking {
|
||||
val scope = newScope()
|
||||
importFs(scope)
|
||||
|
||||
val tmpDir = kotlin.io.path.createTempDirectory("lyngio_test_glob_")
|
||||
try {
|
||||
// prepare dirs/files
|
||||
val sub1 = tmpDir.resolve("a"); sub1.createDirectories()
|
||||
val sub2 = tmpDir.resolve("a/b"); sub2.createDirectories()
|
||||
val f1 = tmpDir.resolve("a/one.txt"); f1.writeText("1")
|
||||
val f2 = tmpDir.resolve("a/b/two.txt"); f2.writeText("2")
|
||||
val f3 = tmpDir.resolve("a/b/three.md"); f3.writeText("3")
|
||||
|
||||
val root = pathObj(scope, sub1.toString())
|
||||
|
||||
// list should contain children: one.txt and b
|
||||
val list = root.invokeInstanceMethod(scope, "list") as ObjList
|
||||
val names = list.list.map { it.toString() }
|
||||
assertTrue(names.any { it.endsWith("one.txt") })
|
||||
assertTrue(names.any { it.endsWith("b") })
|
||||
|
||||
// glob **/*.txt
|
||||
val matches = root.invokeInstanceMethod(scope, "glob", ObjString("**/*.txt")) as ObjList
|
||||
val mnames = matches.list.map { it.toString() }
|
||||
assertTrue(mnames.any { it.endsWith("one.txt") })
|
||||
assertTrue(mnames.any { it.endsWith("two.txt") })
|
||||
assertFalse(mnames.any { it.endsWith("three.md") })
|
||||
} finally {
|
||||
tmpDir.toFile().deleteRecursively()
|
||||
}
|
||||
}
|
||||
|
||||
@Test
|
||||
fun copyMoveDelete() = runBlocking {
|
||||
val scope = newScope()
|
||||
importFs(scope)
|
||||
|
||||
val tmpDir = kotlin.io.path.createTempDirectory("lyngio_test_cmd_")
|
||||
try {
|
||||
val f1 = tmpDir.resolve("src.txt"); f1.writeText("abc")
|
||||
val f2 = tmpDir.resolve("dst.txt")
|
||||
val p1 = pathObj(scope, f1.toString())
|
||||
val p2 = pathObj(scope, f2.toString())
|
||||
|
||||
// copy
|
||||
p1.invokeInstanceMethod(scope, "copy", p2)
|
||||
assertTrue(f2.exists())
|
||||
assertEquals("abc", f2.readText())
|
||||
|
||||
// move with overwrite
|
||||
val f3 = tmpDir.resolve("moved.txt"); f3.writeText("x")
|
||||
val p3 = pathObj(scope, f3.toString())
|
||||
p2.invokeInstanceMethod(scope, "move", p3, ObjBool(true))
|
||||
assertFalse(f2.exists())
|
||||
assertEquals("abc", f3.readText())
|
||||
|
||||
// delete
|
||||
p3.invokeInstanceMethod(scope, "delete")
|
||||
assertFalse(f3.exists())
|
||||
} finally {
|
||||
tmpDir.toFile().deleteRecursively()
|
||||
}
|
||||
}
|
||||
|
||||
@Test
|
||||
fun streamingReaders() = runBlocking {
|
||||
val scope = newScope()
|
||||
importFs(scope)
|
||||
|
||||
val tmpDir = kotlin.io.path.createTempDirectory("lyngio_test_stream_")
|
||||
try {
|
||||
val large = ByteArray(2 * 1024 * 1024) { (it % 251).toByte() }
|
||||
val file = tmpDir.resolve("big.bin"); file.writeBytes(large)
|
||||
val p = pathObj(scope, file.toString())
|
||||
|
||||
// readChunks
|
||||
val it = p.invokeInstanceMethod(scope, "readChunks", ObjInt(131072)) // 128KB
|
||||
var total = 0
|
||||
val iter = it.invokeInstanceMethod(scope, "iterator")
|
||||
while (iter.invokeInstanceMethod(scope, "hasNext").toBool()) {
|
||||
val chunk = iter.invokeInstanceMethod(scope, "next") as ObjBuffer
|
||||
total += chunk.byteArray.size
|
||||
if (total >= 512 * 1024) {
|
||||
// test cancellation early
|
||||
iter.invokeInstanceMethod(scope, "cancelIteration")
|
||||
break
|
||||
}
|
||||
}
|
||||
assertTrue(total >= 512 * 1024)
|
||||
|
||||
// readUtf8Chunks + lines
|
||||
val text = buildString {
|
||||
repeat(10000) { append("line-").append(it).append('\n') }
|
||||
}
|
||||
val tf = tmpDir.resolve("big.txt"); tf.writeText(text)
|
||||
val tp = pathObj(scope, tf.toString())
|
||||
|
||||
val lit = tp.invokeInstanceMethod(scope, "lines")
|
||||
val lines = mutableListOf<String>()
|
||||
val lIter = lit.invokeInstanceMethod(scope, "iterator")
|
||||
while (lIter.invokeInstanceMethod(scope, "hasNext").toBool()) {
|
||||
val s = lIter.invokeInstanceMethod(scope, "next") as ObjString
|
||||
lines += s.value
|
||||
}
|
||||
assertEquals(10000, lines.size)
|
||||
assertEquals("line-0", lines.first())
|
||||
assertEquals("line-9999", lines.last())
|
||||
} finally {
|
||||
tmpDir.toFile().deleteRecursively()
|
||||
}
|
||||
}
|
||||
|
||||
@Test
|
||||
fun forbiddenOperationsRaiseLyngErrors() = runBlocking {
|
||||
// Policy that denies everything except read and list
|
||||
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 = "denied by test policy")
|
||||
}
|
||||
}
|
||||
|
||||
// Prepare a file with PermitAll first (separate manager/scope)
|
||||
val prepScope = newScope()
|
||||
importFs(prepScope)
|
||||
val tmpDir = kotlin.io.path.createTempDirectory("lyngio_test_deny_")
|
||||
try {
|
||||
val file = tmpDir.resolve("ro.txt"); file.writeText("ro")
|
||||
|
||||
// New scope with denying policy
|
||||
val scope = newScope()
|
||||
assertTrue(net.sergeych.lyng.io.fs.createFs(denyWrites, scope))
|
||||
scope.eval("import lyng.io.fs")
|
||||
|
||||
val p = pathObj(scope, file.toString())
|
||||
// Read should work
|
||||
val text = p.invokeInstanceMethod(scope, "readUtf8") as ObjString
|
||||
assertEquals("ro", text.value)
|
||||
|
||||
// Write should throw ExecutionError with ObjIllegalOperationException
|
||||
val err = assertFailsWith<ExecutionError> {
|
||||
p.invokeInstanceMethod(scope, "writeUtf8", ObjString("x"))
|
||||
}
|
||||
assertTrue(err.errorObject is ObjIllegalOperationException)
|
||||
} finally {
|
||||
tmpDir.toFile().deleteRecursively()
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -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.lyngio.fs
|
||||
|
||||
import kotlinx.coroutines.CoroutineDispatcher
|
||||
import kotlinx.coroutines.Dispatchers
|
||||
import okio.FileSystem
|
||||
|
||||
actual fun platformAsyncFs(): LyngFs = OkioAsyncFs(FileSystem.SYSTEM)
|
||||
actual val LyngIoDispatcher: CoroutineDispatcher = Dispatchers.Default
|
||||
@@ -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.lyngio.fs
|
||||
|
||||
import kotlinx.coroutines.CoroutineDispatcher
|
||||
import kotlinx.coroutines.Dispatchers
|
||||
import okio.fakefilesystem.FakeFileSystem
|
||||
|
||||
actual fun platformAsyncFs(): LyngFs = OkioAsyncFs(FakeFileSystem())
|
||||
actual val LyngIoDispatcher: CoroutineDispatcher = Dispatchers.Default
|
||||
@@ -110,6 +110,72 @@ kotlin {
|
||||
}
|
||||
}
|
||||
|
||||
// ---- Build-time generation of stdlib text from .lyng files into a Kotlin constant ----
|
||||
// The .lyng source of the stdlib lives here (module-relative path):
|
||||
val lyngStdlibDir = layout.projectDirectory.dir("stdlib/lyng")
|
||||
// The generated Kotlin source will be placed here and added to commonMain sources:
|
||||
val generatedLyngStdlibDir = layout.buildDirectory.dir("generated/source/lyngStdlib/commonMain/kotlin")
|
||||
|
||||
val generateLyngStdlib by tasks.registering {
|
||||
group = "build"
|
||||
description = "Generate Kotlin source with embedded lyng stdlib text"
|
||||
inputs.dir(lyngStdlibDir)
|
||||
outputs.dir(generatedLyngStdlibDir)
|
||||
// Simpler: opt out of configuration cache for this ad-hoc generator task
|
||||
notCompatibleWithConfigurationCache("Uses dynamic file IO in doLast; trivial generator")
|
||||
|
||||
doLast {
|
||||
val targetPkg = "net.sergeych.lyng.stdlib_included"
|
||||
val targetDir = generatedLyngStdlibDir.get().asFile.resolve(targetPkg.replace('.', '/'))
|
||||
targetDir.mkdirs()
|
||||
|
||||
val files = lyngStdlibDir.asFileTree.matching { include("**/*.lyng") }.files.sortedBy { it.name }
|
||||
val content = if (files.isEmpty()) "" else buildString {
|
||||
files.forEachIndexed { idx, f ->
|
||||
val text = f.readText()
|
||||
if (idx > 0) append("\n\n")
|
||||
append(text)
|
||||
}
|
||||
}
|
||||
|
||||
// Emit as a regular quoted Kotlin string to avoid triple-quote edge cases
|
||||
fun escapeForQuoted(s: String): String = buildString {
|
||||
for (ch in s) when (ch) {
|
||||
'\\' -> append("\\\\")
|
||||
'"' -> append("\\\"")
|
||||
'\n' -> append("\\n")
|
||||
'\r' -> {} // drop CR
|
||||
'\t' -> append("\\t")
|
||||
else -> append(ch)
|
||||
}
|
||||
}
|
||||
val body = escapeForQuoted(content)
|
||||
|
||||
val sb = StringBuilder()
|
||||
sb.append("package ").append(targetPkg).append("\n\n")
|
||||
sb.append("@Suppress(\"Unused\", \"MemberVisibilityCanBePrivate\")\n")
|
||||
sb.append("internal val rootLyng = \"")
|
||||
sb.append(body)
|
||||
sb.append("\"\n")
|
||||
|
||||
targetDir.resolve("root_lyng.generated.kt").writeText(sb.toString())
|
||||
}
|
||||
}
|
||||
|
||||
// Add the generated directory to commonMain sources
|
||||
kotlin.sourceSets.named("commonMain") {
|
||||
kotlin.srcDir(generatedLyngStdlibDir)
|
||||
}
|
||||
|
||||
// Ensure ALL Kotlin compilations (all targets/variants) depend on the generator
|
||||
kotlin.targets.configureEach {
|
||||
compilations.configureEach {
|
||||
compileTaskProvider.configure {
|
||||
dependsOn(generateLyngStdlib)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
android {
|
||||
namespace = "org.jetbrains.kotlinx.multiplatform.library.template"
|
||||
compileSdk = libs.versions.android.compileSdk.get().toInt()
|
||||
|
||||
@@ -494,9 +494,25 @@ class Compiler(
|
||||
when (t.value) {
|
||||
in stopKeywords -> {
|
||||
if (operand != null) throw ScriptError(t.pos, "unexpected keyword")
|
||||
cc.previous()
|
||||
val s = parseStatement() ?: throw ScriptError(t.pos, "Expecting valid statement")
|
||||
operand = StatementRef(s)
|
||||
// Allow certain statement-like constructs to act as expressions
|
||||
// when they appear in expression position (e.g., `if (...) ... else ...`).
|
||||
// Other keywords should be handled by the outer statement parser.
|
||||
when (t.value) {
|
||||
"if" -> {
|
||||
val s = parseIfStatement()
|
||||
operand = StatementRef(s)
|
||||
}
|
||||
"when" -> {
|
||||
val s = parseWhenStatement()
|
||||
operand = StatementRef(s)
|
||||
}
|
||||
else -> {
|
||||
// Do not consume the keyword as part of a term; backtrack
|
||||
// and return null so outer parser handles it.
|
||||
cc.previous()
|
||||
return null
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
"else", "break", "continue" -> {
|
||||
@@ -722,8 +738,12 @@ class Compiler(
|
||||
val startAfterLbrace = cc.savePos()
|
||||
// Peek first non-ws token to decide whether it's likely a map literal
|
||||
val first = cc.peekNextNonWhitespace()
|
||||
// Empty {} should NOT be taken as a map literal to preserve block/lambda semantics
|
||||
if (first.type == Token.Type.RBRACE) return null
|
||||
// Empty {} should be parsed as an empty map literal in expression context
|
||||
if (first.type == Token.Type.RBRACE) {
|
||||
// consume '}' and return empty map literal
|
||||
cc.next() // consume the RBRACE
|
||||
return MapLiteralRef(emptyList())
|
||||
}
|
||||
if (first.type !in listOf(Token.Type.STRING, Token.Type.ID, Token.Type.ELLIPSIS)) return null
|
||||
|
||||
// Commit to map literal parsing
|
||||
@@ -1916,7 +1936,11 @@ class Compiler(
|
||||
val tOp = cc.next()
|
||||
if (tOp.value == "in") {
|
||||
// in loop
|
||||
val source = parseStatement() ?: throw ScriptError(start, "Bad for statement: expected expression")
|
||||
// We must parse an expression here. Using parseStatement() would treat a leading '{'
|
||||
// as a block, breaking inline map literals like: for (i in {foo: "bar"}) { ... }
|
||||
// So we parse an expression explicitly and wrap it into a StatementRef.
|
||||
val exprAfterIn = parseExpression() ?: throw ScriptError(start, "Bad for statement: expected expression")
|
||||
val source: Statement = exprAfterIn
|
||||
ensureRparen()
|
||||
|
||||
// Expose the loop variable name to the parser so identifiers inside the loop body
|
||||
@@ -2922,7 +2946,11 @@ class Compiler(
|
||||
// assigner.generate(context.pos, left, right)
|
||||
// }
|
||||
|
||||
val lastLevel = lastPriority + 1
|
||||
// Compute levels from the actual operator table rather than relying on
|
||||
// the mutable construction counter. This prevents accidental inflation
|
||||
// of precedence depth that could lead to deep recursive descent and
|
||||
// StackOverflowError during parsing.
|
||||
val lastLevel = (allOps.maxOf { it.priority }) + 1
|
||||
|
||||
val byLevel: List<Map<Token.Type, Operator>> = (0..<lastLevel).map { l ->
|
||||
allOps.filter { it.priority == l }.associateBy { it.tokenType }
|
||||
|
||||
@@ -0,0 +1,39 @@
|
||||
/*
|
||||
* 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
|
||||
|
||||
/**
|
||||
* Lightweight documentation payload for symbols defined from Kotlin code (built-ins, stdlib, host bindings).
|
||||
*
|
||||
* The [summary] is optional; if not provided, it will be derived as the first non-empty line of [raw].
|
||||
* Simple tag lines like "@since 1.0" can be stored in [tags] when needed.
|
||||
*/
|
||||
data class DocString(
|
||||
val raw: String,
|
||||
val summary: String? = null,
|
||||
val tags: Map<String, List<String>> = emptyMap()
|
||||
) {
|
||||
val effectiveSummary: String? by lazy {
|
||||
summary ?: raw.lineSequence().map { it.trim() }.firstOrNull { it.isNotEmpty() }
|
||||
}
|
||||
|
||||
companion object {
|
||||
/** Convenience to create a [DocString] taking the first non-empty line as a summary. */
|
||||
fun of(text: String, tags: Map<String, List<String>> = emptyMap()): DocString = DocString(text, null, tags)
|
||||
}
|
||||
}
|
||||
@@ -340,8 +340,11 @@ open class Scope(
|
||||
}
|
||||
}
|
||||
|
||||
// --- removed doc-aware overloads to keep runtime lean ---
|
||||
|
||||
fun addConst(name: String, value: Obj) = addItem(name, false, value)
|
||||
|
||||
|
||||
suspend fun eval(code: String): Obj =
|
||||
eval(code.toSource())
|
||||
|
||||
|
||||
@@ -198,6 +198,58 @@ object Binder {
|
||||
}
|
||||
}
|
||||
|
||||
// Extra pass: detect local val/var declarations that are not present in mini.declarations
|
||||
// (e.g., locals inside blocks and top-level statements). Use token stream heuristics.
|
||||
run {
|
||||
val spans = highlighter.highlight(text)
|
||||
var iTok = 0
|
||||
while (iTok < spans.size) {
|
||||
val t = spans[iTok]
|
||||
if (t.kind == HighlightKind.Keyword) {
|
||||
val kw = try { text.substring(t.range.start, t.range.endExclusive) } catch (_: Throwable) { "" }
|
||||
if (kw.equals("val", ignoreCase = true) || kw.equals("var", ignoreCase = true)) {
|
||||
// Find the next Identifier span which should be the declared name
|
||||
var j = iTok + 1
|
||||
var nameStart = -1
|
||||
var nameEnd = -1
|
||||
while (j < spans.size) {
|
||||
val s = spans[j]
|
||||
if (s.kind == HighlightKind.Identifier) {
|
||||
nameStart = s.range.start
|
||||
nameEnd = s.range.endExclusive
|
||||
break
|
||||
}
|
||||
// Stop if we hit newline/comment too far ahead (avoid wide scans)
|
||||
if (s.kind == HighlightKind.Comment) break
|
||||
j++
|
||||
}
|
||||
if (nameStart >= 0 && nameEnd > nameStart) {
|
||||
// Skip if a symbol with exactly this decl range already exists
|
||||
val exists = symbols.any { it.declStart == nameStart && it.declEnd == nameEnd }
|
||||
if (!exists) {
|
||||
// Determine enclosing function body (if any) to attach as local; else treat as top-level
|
||||
val inFn = functions.asSequence()
|
||||
.filter { it.rangeEnd > it.rangeStart && nameStart >= it.rangeStart && nameStart <= it.rangeEnd }
|
||||
.maxByOrNull { it.rangeEnd - it.rangeStart }
|
||||
val kind = if (kw.equals("var", true)) SymbolKind.Var else SymbolKind.Val
|
||||
if (inFn != null) {
|
||||
val localSym = Symbol(nextId++, text.substring(nameStart, nameEnd), kind, nameStart, nameEnd, containerId = inFn.id)
|
||||
symbols += localSym
|
||||
inFn.locals += localSym.id
|
||||
} else {
|
||||
val localSym = Symbol(nextId++, text.substring(nameStart, nameEnd), kind, nameStart, nameEnd, containerId = null)
|
||||
symbols += localSym
|
||||
topLevelByName.getOrPut(localSym.name) { mutableListOf() }.add(localSym.id)
|
||||
}
|
||||
}
|
||||
}
|
||||
iTok = j // continue from the name or comment
|
||||
}
|
||||
}
|
||||
iTok++
|
||||
}
|
||||
}
|
||||
|
||||
// Build name -> symbol ids index per function (locals+params) and per class (fields) for faster resolution
|
||||
data class Idx(val byName: Map<String, List<Int>>)
|
||||
fun buildIndex(ids: List<Int>): Idx {
|
||||
|
||||
Loaded 100 of 125 files, more files were not shown because too many files have changed in this diff.
Show more
Reference in new issue
Block a user