loop_in_codes

低调做技术__欢迎移步我的独立博客 codemaro.com 微博 kevinlynx

传递Lua函数到C/C++中

传递Lua函数到C/C++中

问题

在Lua中,因为函数也是第一类值,所以会出现将函数作为另一个函数的参数,或者函数作 为函数的返回值。这种机制在很多地方都能代码更灵活更简洁,例如:

table.sort(table [,comp])

这里的comp就要求传入一个函数,我们在调用时,大概会有如下形式:

table.sort(t, comp) -- 直接写函数名
table.sort(t, local_comp) -- 某个局部函数
table.sort(t, function (a, b) xxx end ) -- 临时构造一个匿名函数

其中最后一种方式最为灵活,任意时候在需要的时候构造一个匿名函数。这种在Lua自身的 环境中使用,自然没有问题。但是,当我们在C/C++中注册一些函数到Lua环境中,而这些 函数也需要使用函数参数的时候,问题就出来了。

Lua本身是不支持将Lua函数作为函数参数传入C/C++的,不管这个想要传入的函数是全局的 、局部的、或者匿名的(匿名的本质上也算局部的)。一般情况下,我们唯一的交互方式, 不是传入一个函数,而是一个全局函数名。C/C++保存这个函数名,在需要回调Lua的时候, 就在Lua全局表中找到这个函数(根据函数名),然后再调用之。情况大致如下:

function lua_func () xxx end
cfunc(lua_func) -- wrong
cfunc("lua_func") -- right

我们这回的脚本模块,策划会大量使用需要回调函数的C/C++函数。显然,创建大量的全局 函数,先是从写代码的角度看,就是很伤神的。

解决

我们最终需要的方式,大概如下:

cfunc(lua_func) -- ok
cfunc(function () xxx end) -- ok
local xxx = function () xxx end
cfunc(xxx) -- ok

要解决这个问题,我的思路是直接在Lua层做一些包装。因为C/C++那边仅支持传入一个全局 函数名(当然不一定得全局的,根据实际情况,可能在其他自己构造的表里也行),也就是 一个字符串,所以我的思路就是将Lua函数和一个唯一的字符串做映射。:

function wrap (fn)
    local id = generate_id()
    local fn_s = "__callback_fn"..id
    _G[fn_s] = fn
    return fn_s
end

这个wrap函数,就是将一个函数在全局表里映射到一个字符串上,那么在使用时:

cfunc(wrap(function () xxx end))
cfunc(const char *fn_name, xxx); -- cfunc的原型

cfunc是C/C++方注册进Lua的函数,它的原型很中规中矩,即:只接收一个函数名,一个字 符串,如之前所说,C/C++要调用这个回调函数时,就根据这个字符串去查找对应的函数。 脚本方在调用时,如果想传入一个匿名函数了,就调用wrap函数包装一下即可。

一个改进

上面的方法有个很严重的问题,在多次调用wrap函数后,将导致全局表也随之膨胀。我们需 要想办法在C/C++完成回调后,来清除wrap建立的数据。这个工作当然可以放到C/C++来进行 ,例如每次发生回调后,就设置下全局表。但这明显是不对的,因为违背了接口的设计原则 ,这个额外的机制是在Lua里添加的,那么责任也最好由Lua来负。要解决这个问题,就可以 使用Lua的metamethods机制。这个机制可以在Lua内部发生特定事件时,让应用层得到通知。 这里,我们需要关注__call事件。

Lua中只要有__call metamethod的值,均可被当作函数调用。例如:

ab(1, 2)

这里这个函数调用形式,Lua就会去找ab是否有__call metamethod,如果有,则调用它。这 个事实暗示我们,一个table也可以被调用。一个改进的wrap函数如下:

local function create_callback_table (fn, name)
    local t = {}
    t.callback = fn
    setmetatable (t, {__call =  -- 关注__call
        function (func, ...) -- 在t(xx)时,将调用到这个函数
            func.callback (...) -- 真正的回调
            del_callback (name) -- 回调完毕,清除wrap建立的数据
        end })
    return t
end

function wrap (fn)
    local id = generate_func_id() -- 产生唯一的id
    local fn_s = "_callback_fn"..id
    _G[fn_s] = create_callback_table(fn, fn_s) -- _G[fn_s]对应的是一个表
    return fn_s
end

在我们的C/C++程序中,依然如往常一样,先是从_G里取出函数名对应的对象。虽然这个对 象现在已经是一个table。然后lua_call。

上面的代码是否会在原有基础上增加不可接受的性能代价?虽然我没有做过实际测试,但是 从表明看来,排除meta table在Lua里的代价,也就多了几次Lua函数调用。

最后,感叹一下,Lua里的table及metatable机制,实在非常强大。这种强大不是功能堆砌 出来的强大,而是简单东西组合出来的强大。其背后的设计思想,着实让人佩服。

4.26.2011 Update

之前的文中说“Lua本身是不支持将Lua函数作为函数参数传入C/C++的“,这句话严格来说不 正确(由某网友评论)。假设函数cfun由c/c++注册,我们是可以编写如下代码的:

cfunc(print) -- 传入Lua函数

但是问题在于,我们无法取出这个函数并保存在c/c++方。Lua提供了一些接口用于取cfunc 的参数,例如luaL_checknumber(封装lua_tonumber)。但没有类似luaL_checkfunction的 接口。Lua中的table有同样的问题。究其原因,主要是Lua中的函数没有直接的c/c++数据结 构对应。

;; END

posted on 2011-04-24 17:28 Kevin Lynx 阅读(10919) 评论(9)  编辑 收藏 引用 所属分类: lua

评论

# re: 传递Lua函数到C/C++中 2011-04-24 20:40 dourgulf

收藏,一直没有下决心来好好学习一下LUA  回复  更多评论   

# re: 传递Lua函数到C/C++中 2011-04-25 11:36 oo

"Lua本身是不支持将Lua函数作为函数参数传入C/C++的"
???

===============================================================================
test.c
===============================================================================

static int ctest(lua_State * L)
{
lua_pushstring(L, "hello");
lua_call(L, 1, 0);
return 0;
}

int main()
{
lua_State * L = luaL_newstate();
luaL_openlibs(L);
luaL_Reg funs [] = {
{"ctest", ctest},
{NULL, NULL}
};
luaL_register(L, "_G", funs);
luaL_dofile(L, "test.lua");
lua_close(L);
}
===============================================================================

===============================================================================
test.lua
===============================================================================
ctest(print)
===============================================================================
  回复  更多评论   

# re: 传递Lua函数到C/C++中 2011-04-25 13:19 Kevin Lynx

@oo
这句话是欠妥,3Q。不过,因为在c/c++里没有映射Lua函数的类型,所以没有办法把传入的print取出来。这无法满足回调的需求。  回复  更多评论   

# re: 传递Lua函数到C/C++中 2011-05-08 03:44 thelONE

"在我们的C/C++程序中,依然如往常一样,先是从_G里取出函数名对应的对象。虽然这个对象现在已经是一个table。然后lua_call"

这么做的效果不好, 你可以考虑用在C++里用lua_ref引用你在lua里创建的函数, 在调用的时候可以提高性能.  回复  更多评论   

# re: 传递Lua函数到C/C++中 2011-05-08 19:36 Kevin Lynx

@thelONE
有没有做过这方面的测试?  回复  更多评论   

# re: 传递Lua函数到C/C++中 2013-04-21 19:32 fy

=.= 我发现当个纯伸手党也挺困难的,有人指路的情况下generate_func_id神马的都不想自己写啊。。。

话说那个改进型只是考虑了函数被调用一次,如果是比如 KeyInput 这种多次回调,就完全无用了啊。

同样,在多次回调的时候,能不能通过某种方式得到相当于函数引用的一个全局唯一的id,这样就不用每次通过name来lua_getglobal了?
  回复  更多评论   

# re: 传递Lua函数到C/C++中 2013-04-21 21:38 fy

@fy

补上一个自己撸出来的版本:


math.randomseed(os.time())

function generate_id(length)
local rand = ""
length = length or 13
local allchars = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789'

for i=1,length do
code = string.char(math.random(48, 122))
while string.find(allchars, code) == nil do
code = string.char(math.random(48, 122))
end
rand = rand .. code
end

rand = '__callback_fn_' .. rand
while _G[rand] do
rand = generate_id(length)
end
return rand
end

function wrap (fn)
local id = generate_id()
local fn_s = "__callback_fn_" .. id
_G[fn_s] = fn
return fn_s
end
  回复  更多评论   

# re: 传递Lua函数到C/C++中 2013-04-22 22:30 fy

@fy

由于对 lua 不太了解险些出了大事...
上面那个程序有时候会报 lua: test.lua:12: malformed pattern (missing ']')
错误,这是因为随机随到了 [ 字符!
于是 string.find 就把这一个字符当成了不完整的正则,从而导致错误。。。

下面是修改后的版本:


function generate_id(length)
local rand = ""
length = length or 13
local allchars = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ'

for i=1,length do
code = string.char(math.random(65, 90))
rand = rand .. code
end

rand = '_' .. rand
while _G[rand] do
rand = generate_id(length)
end

return rand
end
  回复  更多评论   

# re: 传递Lua函数到C/C++中 2013-04-24 20:00 Kevin Lynx

@fy
谢谢有价值的回复。
距离这篇博客的写作时间太久了,我只能简单说明下。实际上我们项目中最后使用的方式是@thelONE在评论中提到的方法。即,在lua中直接传递函数对象(全局函数、局部函数、匿名函数),C/C++中先通过luaL_ref将这个函数对象建立索引并保存进注册表,在luaL_unref之前,这个函数对象由于存在“引用”所以不会被垃圾回收。那么,程序里就可以保存luaL_ref这个索引值。当要调用这个函数时,就根据该索引从注册表中取出(大概是lua_gettable)。实际操作你可以自己查查。这种方式感觉上效率应该会高不少,对于脚本方的使用也更自由。但是有个严重的问题,就是当我们进行效率检查时,定位脚本不太容易,因为C/C++这边没有有效的方式去标识一个lua函数对象(当然后面还是使用了些其他方法,例如使用debug库获得函数对象的位置信息)。
  回复  更多评论   


只有注册用户登录后才能发表评论。
【推荐】超50万行VC++源码: 大型组态工控、电力仿真CAD与GIS源码库
网站导航: 博客园   IT新闻   BlogJava   知识库   博问   管理