SergeychWorks/lyng
1
0
Fork 0
Code Issues 7 Pull Requests Actions Packages Projects 1 Releases 11 Wiki Activity

refining the readme

Browse Source
This commit is contained in:
Sergey Chernov 2025-08-11 10:36:29 +03:00
parent 62461c09cc
commit 299738cffd
2 changed files with 16 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@ -26,12 +26,13 @@ and it is multithreaded on platforms supporting it (automatically, no code chang
`launch` more coroutines and they will be executed concurrently if possible). See [parallelism] `launch` more coroutines and they will be executed concurrently if possible). See [parallelism]
- functional style and OOP together, multiple inheritance, implementing interfaces for existing classes, writing extensions. - functional style and OOP together, multiple inheritance, implementing interfaces for existing classes, writing extensions.
- Any unicode letters can be used as identifiers: `assert( sin(π/2) == 1 )`. - Any Unicode letters can be used as identifiers: `assert( sin(π/2) == 1 )`.
## Resources: ## Resources:
- [introduction and tutorial](docs/tutorial.md) - start here please - [introduction and tutorial](docs/tutorial.md) - start here please
- [Samples directory](docs/samples) - [Samples directory](docs/samples)
- [Books directory](docs)
## Integration in Kotlin multiplatform ## Integration in Kotlin multiplatform
@ -84,8 +85,8 @@ import com.sun.source.tree.Scope
import new.sergeych.lyng.* import new.sergeych.lyng.*
// simple function // simple function
val scope = Scope().apply { val scope = Script.newScope().apply {
addFn("addArgs") { addFn("sumOf") {
var sum = 0.0 var sum = 0.0
for (a in args) sum += a.toDouble() for (a in args) sum += a.toDouble()
ObjReal(sum) ObjReal(sum)
@ -96,12 +97,14 @@ val scope = Scope().apply {
// suspend fun doSomeWork(text: String): Int // suspend fun doSomeWork(text: String): Int
addFn("doSomeWork") { addFn("doSomeWork") {
// this _is_ a suspend lambda, we can call suspend function, // this _is_ a suspend lambda, we can call suspend function,
// and it won't consume the thread: // and it won't consume the thread.
doSomeWork(args[0].toString()).toObj() // note that in kotlin handler, `args` is a list of `Obj` arguments
// and return value from this lambda should be Obj too:
doSomeWork(args[0]).toObj()
} }
} }
// adding constant: // adding constant:
scope.eval("addArgs(1,2,3)") // <- 6 scope.eval("sumOf(1,2,3)") // <- 6
``` ```
Note that the scope stores all changes in it so you can make calls on a single scope to preserve state between calls. Note that the scope stores all changes in it so you can make calls on a single scope to preserve state between calls.
@ -119,7 +122,7 @@ Designed to add scripting to kotlin multiplatform application in easy and effici
- Javascript, WasmJS, native, JVM, android - batteries included. - Javascript, WasmJS, native, JVM, android - batteries included.
- dynamic types in most elegant and concise way - dynamic types in most elegant and concise way
- async, 100% coroutines, supports multiple cores where platofrm supports thread - async, 100% coroutines, supports multiple cores where platform supports thread
- good for functional an object-oriented style - good for functional an object-oriented style
# Language Roadmap # Language Roadmap
@ -166,7 +169,7 @@ Planned features.
Further Further
- [ ] client with GUI support based on compose multiplatform somehow - [ ] client with GUI support based on compose multiplatform somehow
- [ ] notebook - style workbooks with graphs, formulaes, etc. - [ ] notebook - style workbooks with graphs, formulae, etc.
- [ ] language server or compose-based lyng-aware editor - [ ] language server or compose-based lyng-aware editor
[parallelism]: docs/parallelism.md [parallelism]: docs/parallelism.md

5
lynglib/src/commonMain/kotlin/net/sergeych/lyng/Script.kt
View File

@ -29,6 +29,11 @@ class Script(
companion object { companion object {
/**
* Create new scope using standard safe set of modules, using [defaultImportManager]. It is
* suspended as first time calls requires compilation of standard library or other
* asynchronous initialization.
*/
suspend fun newScope(pos: Pos = Pos.builtIn) = defaultImportManager.newStdScope(pos) suspend fun newScope(pos: Pos = Pos.builtIn) = defaultImportManager.newStdScope(pos)
internal val rootScope: Scope = Scope(null).apply { internal val rootScope: Scope = Scope(null).apply {