mirror of
https://gitcode.com/JianFeeeee/LuaCangjia_api.git
synced 2026-09-20 00:48:47 +00:00
74 lines
3.8 KiB
Markdown
74 lines
3.8 KiB
Markdown
# Lua Runner for Cangjie
|
||
|
||
[](LICENSE)
|
||
[](https://www.lua.org/)
|
||
[](https://cangjie-lang.cn/)
|
||
|
||
|
||
Lua Runner for Cangjie 是一个专为仓颉语言设计的轻量级、高性能 Lua 脚本执行引擎。它通过 C FFI 桥接 C++，提供了稳定且易用的 Lua 虚拟机管理能力。
|
||
**注：本项目是开发原生鸿蒙应用时产生的副产物，当前版本依然存在局限性与不足，请详细检查后再使用。**。
|
||
|
||
除了基础的脚本嵌入功能外，该引擎的核心特色在于支持一种独特的 **"栈式管道执行模式"**，能够实现脚本间的隐式参数传递，非常适合构建数据处理管道、游戏脚本系统或插件化架构。同时，它提供了完善的异常处理机制、灵活的 I/O 重定向功能，以及直接执行 Lua 代码片段的 `doString` 方法。
|
||
|
||
详细 API 文档请查看 [doc/api.md](doc/api.md)。
|
||
|
||
## 特性
|
||
|
||
- **轻量级集成**：基于 Lua 5.4，通过 FFI 直接与仓颉语言交互，性能损耗小。
|
||
- **栈式管道模式**：支持脚本间基于栈的数据隐式传递，实现类似函数式管道的调用链。
|
||
- **doString**：直接执行 Lua 代码字符串，无需写入文件。
|
||
- **I/O 重定向**：可自定义 Lua 标准输入/输出（`print`, `io.read`）的回调函数，支持文件交换目录重定向。
|
||
- **模块化管理**：提供 `load` 和 `unload` 方法，支持按名称动态加载和卸载 Lua 脚本模块，避免全局污染。
|
||
- **完善的异常处理**：定义了详细的错误码体系，通过 `LuaError` 类统一抛出，便于调试和逻辑控制。
|
||
- **链式调用**：大部分操作方法返回实例本身，支持流畅的调用风格。
|
||
|
||
## 快速开始
|
||
|
||
### 环境要求
|
||
|
||
- Cangjie 语言环境
|
||
- 底层 C++ 库（需要预先编译好与 Lua 5.4 链接的动态库）
|
||
|
||
### 基本用法
|
||
|
||
```cangjie
|
||
import luaRunner.*
|
||
|
||
main(): Int64 {
|
||
try {
|
||
// 1. 创建 Lua 运行实例
|
||
let runner = LuaRunner()
|
||
|
||
// 2. 执行 Lua 代码片段
|
||
let res = runner.doString("return 1 + 1")
|
||
println("Result: ${res}") // 输出: Result: 2
|
||
|
||
// 3. 加载并执行脚本
|
||
runner.load("./scripts/hello.lua", "myScript")
|
||
let result = runner.runScript("", "World")
|
||
println("Script result: ${result}")
|
||
|
||
} catch (e: LuaError) {
|
||
println("Lua Error [${e.code}]: ${e.getMessage()}")
|
||
}
|
||
|
||
return 0
|
||
}
|
||
```
|
||
|
||
## 当前局限性
|
||
|
||
- **数据类型限制**：当前版本在仓颉与 Lua 交互层仅支持**字符串**类型。虽然 Lua 内部可以处理复杂数据结构，但传递给仓颉或从仓颉传入时必须进行序列化/反序列化（如 JSON）。
|
||
- **容量限制**：内部使用固定数组管理加载的库，上限为 **20 个**，超过将报错 `5016`。
|
||
- **I/O 性能**：I/O 重定向依赖于文件系统交换，相对于纯内存交互存在微小的性能开销。
|
||
|
||
## 第三方组件与合规说明
|
||
|
||
- 本项目仓库内包含 Lua 5.4.8 源码副本，用于构建底层原生运行时。
|
||
- Lua 5.4.8 使用 MIT License；其原始版权与许可声明可在 `lib/lua/` 对应源码中查看。
|
||
- 本项目自身以 `LGPL-3.0-or-later` 方式发布，使用或分发时请同时遵守项目本身以及所包含第三方组件的许可证要求。
|
||
|
||
## 许可证
|
||
|
||
本项目基于 LGPL-3.0-or-later 协议开源。仓库同时包含 Lua 5.4.8 的 MIT Licensed 源码副本，用于构建底层原生运行时。分发和集成时，请一并检查 [LICENSE](LICENSE) 以及 `lib/lua/` 中随源码附带的许可声明。
|