Xlua Wrap

鉴于上个对xlua与C#的各方面初探有些笼统,本次只在一个方面进行较深层次的解释和讨论:xlua的wrap系统。

xlua的wrap系统

首先需要明确一点:lua和C#之间一定有一个桥梁使其能够正常通信,无非两种手段:

要么将C#转成lua代码然后在lua侧,只保留一小部分C#代码控制其运转;

Xlua Wrap_第1张图片

要么生成中间层文件,lua代码通过C#端的这些中间层文件进行交互。然后在C#侧控制其运转。

Xlua Wrap_第2张图片

对于第一种手段遇到的问题显然很多,比如委托、接口、抽象类等等C#这种解释性语言才有的机制,转成非常轻量的脚本语言,这其中的映射建立是非常困难的。

xlua采用了第二种机制,将lua要用到的C#以wrap文件的形式转至中间层,再由xlua的其他控制系统控制运作。

xlua之外:tolua的机制和xlua很类似,通过ToLuaExport.cs实现对C#代码的中间文件生成操作。

Generate wrap

对于创建wrap相关的文件应该从Generator.GenAll()开始看。

Xlua Wrap_第3张图片

Xlua Wrap_第4张图片

在这里可以看到非常重要的几个函数:

GenDelegateBridges(args);
GenEnumWraps();
GenCodeForClass();
GenLuaRegister();

顾名思义,分别是生成需要导出的委托、枚举、接口、类对应的wrap文件以及中央控制器Register,用于运行时找到对应类型的wrap文件,并执行该文件的__Registera方法,这个方法会把这个类的静态方法、成员方法注册到lua表里。

在这里多说一下具有代表性的函数GenCodeForClass(),看名称应当是类的转换,但实际上还包括interface类型的转换,因其里面有一句:

var itf_bridges_types = CSharpCallLua.Where(type => type.IsInterface).Distinct();

当然,内部依然还有结构体的封装转换等等:

GenPackUnpack(args); 
GenInterfaceBridge(args);

Xlua Wrap_第5张图片

注册标签:看到LuaCallCSharp了吗?没错,在做生成类wrap文件操作的时候会做一次筛选,只生成那些注册了这个标签的结构。

以上提到的生成不同类型的函数,最终都会设置好参数然后走入核心函数GenOne:

Xlua Wrap_第6张图片

红框标记部分意味着写入文件,自此生成部分结束。

wrap格式

xlua如何做到C#到wrap的映射的(它最起码得分明啥是代码啥是注释才对)?它什么时候开始做的映射?

由此引出了另一个C#文件:TemplateEngine.cs。这个文件做的最大的一个工作就是正则表达式匹配:

Xlua Wrap_第7张图片

直接当成字符串的内容

可执行代码

用lua变量代替的内容

如下图诠释的:

Xlua Wrap_第8张图片

Xlua Wrap_第9张图片

wrap文件内容

有关类的模板文件参考LuaClassWrap.tpl.txt

Xlua Wrap_第10张图片

之后会根据这个模板生成相关的类wrap文件(enum、接口等等同样如此)

Xlua Wrap_第11张图片

如果想看到生成wrap的效果,可以点击xlua给我们的窗口:XLua->Generate Code。

仔细看源码可以发现,xlua的中央控制器生成的注册表是放在XLuaGenAutoRegister.cs中:

Xlua Wrap_第12张图片

Xlua Wrap_第13张图片

generate后可看到一系列wrap.cs:

Xlua Wrap_第14张图片

这些文件以类似dictionary的管理形式在XLuaGenAutoRegister.cs中出现:

Xlua Wrap_第15张图片

在这里直接贴出生成的LuaBehaviour.cs的wrap代码XluaToolLuaBehaviourWrap.cs:

Xlua Wrap_第16张图片

简单可以理解成RegisterFunc(指针,位置,C#的函数名,翻译后的函数),我们随便挑一个函数看看:

Xlua Wrap_第17张图片

注意,wrap文件只翻译public类型的function,protected和private因其私密性不被外界调用所以直接优化成不“翻译”了。看上图一段简单的return语句,实际上就是找到真实的函数所在栈空间,调用后返回相应值传回lua侧即可。如若是带参数的情况下则多添加几行lua参数的定位+翻译即可。

Xlua Wrap_第18张图片

总结

说到这里,就已经很大程度地告诉大家lua侧能调用c#端的函数或者变量的原因了。

你可能感兴趣的:(unity,游戏,lua,lua5.4)