lua_tinker源码笔记1

本篇仅简单介绍使用lua_tinker让lua调用C++函数的过程, C++调用lua函数可以参见博客Lua脚本和C++交互（一）.

未完待续.

(一) lua调用C++全局函数

这里以lua_tinker自带的sample1作为分析例子.C++源码如下:

// sample1.cpp
#include "stdafx.h"
#include "../lua_tinker/lua_tinker.h"

int cpp_func(int arg1, int arg2)
{
    return arg1 + arg2;
}

int _tmain(int argc, _TCHAR* argv[])
{    
    lua_State* L = lua_open();
    luaopen_base(L);
    lua_tinker::def(L, "cpp_func", cpp_func);
    lua_tinker::dofile(L, "sample1.lua");
    int result = lua_tinker::call<int>(L, "lua_func", 3, 4);
    printf("lua_func(3,4) = %d
", result);
    lua_close(L);

    return 0;
}

lua文件源码如下:

-- sample1.lua
result = cpp_func(1, 2)

print("cpp_func(1,2) = "..result)

function lua_func(arg1, arg2)
    return arg1 + arg2
end

从main函数开始分析. 首先通过lua_open获取lua栈对象,再打开lua库(luaopen_base). 接下来,lua_tinker::def注册一个C++全局函数,lua_tinker::dofile打开lua文件,通过lua_tinker::call调用到sample1.lua里面的lua函数.最后关闭释放lua栈对象(lua_close).本文重点在于探究ua_tinker::def如何完成C++全局函数的注册.

(1) lua_tinker只有一个.h和.cpp文件,在lua_tinker.h里面,我们找到了上面的函数调用,如下:

// global function
// lua_tinker::def(L, "cpp_func", cpp_func);
template<typename F> 
void def(lua_State* L, const char* name, F func)
{ 
    lua_pushstring(L, name);
    lua_pushlightuserdata(L, func);
    push_functor(L, func);
    lua_settable(L, LUA_GLOBALSINDEX);
}

在代码中,我们可以看到,首先将全局函数名称"cpp_func"压入lua栈(), 此时的lua栈只有这一个元素且为栈顶, 然后我们再将全局函数对应的函数指针压入栈(查lua_reference可以知道,如果是light userdata(而不是full userdata)的话,lua_pushlightuserdata只是简单地压入函数指针), 此时的lua栈有两个元素,栈顶为func函数指针,第2个元素是我们刚才压入的全局函数名称;第3步的push_functor是lua_tinker对压入cclosure(c闭包)函数lua_pushcclosure的一个封装,查看此函数:

template<typename RVal, typename T1, typename T2> 
void push_functor(lua_State *L, RVal (*func)(T1,T2))
{ 
    lua_pushcclosure(L, functor<T1,T2>::invoke<RVal>, 1);
}

这里涉及到模板函数的重载,模板相关知识参见系列博客C++ template —— 模板基础（一）.这里不做过多阐述.

上面我们的全局函数cpp_func是一个接受两个参数且有一个返回值的函数,所以我们找到了如上的模板函数, 从代码中可以看到,push_functor()只是简单地调用lua函数lua_pushcclosure,但是对参数做了一层封装.lua_pushcclosure接受三个参数,第2个参数表示要压入的c闭包函数体(此处为functor结构体的invoke函数),第3个参数表示此c闭包关联的upvalue个数(最大255).本例中只有一个(会获取到上面通过lua_pushlightuserdata压入的函数指针), lua_pushcclosure压入c闭包,同时会把所有的upvalue(这里只有函数指针)全都pop出栈.此时的lua栈只有两个元素,栈顶也就是刚刚压入的cclosure,下面一个元素是函数名称. 接下来,我们再看看functor如何封装此函数指针:

template<typename T1, typename T2>
struct functor<T1,T2> 
{
    template<typename RVal>
    static int invoke(lua_State *L) { push(L,upvalue_<RVal(*)(T1,T2)>(L)(read<T1>(L,1),read<T2>(L,2))); return 1; }
    template<>
    static int invoke<void>(lua_State *L) { upvalue_<void(*)(T1,T2)>(L)(read<T1>(L,1),read<T2>(L,2)); return 0; }
};

这里涉及到的是类(结构体)模板和类模板偏特化的内容,这里也不做过多阐述,感兴趣同样可以参见上面模板系列博客.

根据类模板偏特化,我们找到了上面接收两个模板参数的对应functor代码,可以看到,invoke执行的操作就是将全局函数压入栈. upvalue_获取闭包的upvalue,这里是全局函数cpp_func的指针,再通过read指定(cpp_func全局函数所需要的)两个参数,最后通过push压入lua栈.upvalue_代码如下:

// get value from cclosure
template<typename T>  
T upvalue_(lua_State *L)
{
    return user2type<T>::invoke(L, lua_upvalueindex(1));
}

lua_upvalueindex(1)获取cclosure中的第1个upvalue,也即全局函数地址.

最后,通过lua_settable(L, LUA_GLOBALSINDEX);找到全局表索引位置的全局表t,并以栈顶为value(cclosure),下一个元素为key(全局函数名称),设置t[key] = value;将封装过的元素函数指针设置进lua全局表里面,这样,在lua文件sample1.lua中,就可以直接通过全局函数名称"cpp_func"调用到C++的函数了.

本篇博文为个人分析,如发现错误,请留言指出,共同进步,谢谢!

 (二) lua调用C++ 的非全局函数

[参考]:lua 函数调用1 -- 闭包详解和C调用