awtk/docs/script_binding.md
2018-08-13 06:47:38 +08:00

29 lines
2.0 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# AWTK脚本绑定的实现原理 - lua绑定
脚本化是[AWTK](https://github.com/zlgopen/awtk)的一个基本功能。[AWTK](https://github.com/zlgopen/awtk)计划支持嵌入式系统中常用的脚本如lua、python和jerryscript。脚本绑定说简单也简单说复杂也复杂采用FFI(calling external C functions)和SWIG绑定一些简单的函数是很方便的但绑定一个复杂的GUI系统还是很有挑战的。之所以不采用通用的工具而是实现自己的代码产生器主要有以下考虑
* 我使用FFI和SWIG的经验很有限觉得有些功能不太好实现至少目前我还不知道实现这些功能的方法和思路。
* 担心FFI和SWIG的运行环境的可移植性。在Windows、Linux和Macos上肯定是没有问题的但是在嵌入式系统特别是RTOS和裸系统中支持像动态库等功能可能有些困难的。
* 对jerryscript没有支持。jerryscript是三星开源的javascript实现在嵌入式系统中用得比较多通用的绑定机制对jerryscript没有支持。
* 代码风格。不同语言有不同的代码风格特别是命名风格直接把C言语的风格映射过去对于开发者不太友好。FFI和SWIG都需要做额外的工作才能实现这个功能。
* AWTK采用面向对象设计并用C实现面向对象编程的。而通用的绑定机制对此并不友好实现起来非常困难。
* 自定义的代码产生器并不复杂,而且具有更大的灵活性。
基于以上这些原因,我决定自己实现[AWTK](https://github.com/zlgopen/awtk)的脚本绑定机制。它的实现原理如下用特定格式的API注释来描述要脚本化的API用一个名为gen\_idl的工具把注释提取出来生成JSON的接口描述文件然后用不同的代码产生器生成对应语言的绑定
![1](images/script_binding.png)
### 参考
1.[API注释格式](api_doc.md)
2.[JS绑定](https://github.com/zlgopen/awtk-lua)
3.[Lua绑定](https://github.com/zlgopen/awtk-js)