把Lua函數(shù)傳遞到C/C++中實(shí)例

2024-07-21 23:04:17

字體：大中小

供稿：網(wǎng)友

問(wèn)題

在Lua中，因?yàn)楹瘮?shù)也是第一類值，所以會(huì)出現(xiàn)將函數(shù)作為另一個(gè)函數(shù)的參數(shù)，或者函數(shù)作為函數(shù)的返回值。這種機(jī)制在很多地方都能代碼更靈活更簡(jiǎn)潔，例如:

復(fù)制代碼代碼如下:

table.sort(table [,comp])

這里的comp就要求傳入一個(gè)函數(shù)，我們?cè)谡{(diào)用時(shí)，大概會(huì)有如下形式:

復(fù)制代碼代碼如下:

	
	table.sort(t, comp) -- 直接寫函數(shù)名
	    table.sort(t, local_comp) -- 某個(gè)局部函數(shù)
	    table.sort(t, function (a, b) xxx end ) -- 臨時(shí)構(gòu)造一個(gè)匿名函數(shù)

其中最后一種方式最為靈活，任意時(shí)候在需要的時(shí)候構(gòu)造一個(gè)匿名函數(shù)。這種在Lua自身的環(huán)境中使用，自然沒(méi)有問(wèn)題。但是，當(dāng)我們?cè)贑/C++中注冊(cè)一些函數(shù)到Lua環(huán)境中，而這些函數(shù)也需要使用函數(shù)參數(shù)的時(shí)候，問(wèn)題就出來(lái)了。

Lua本身是不支持將Lua函數(shù)作為函數(shù)參數(shù)傳入C/C++的，不管這個(gè)想要傳入的函數(shù)是全局的、局部的、或者匿名的（匿名的本質(zhì)上也算局部的）。一般情況下，我們唯一的交互方式，不是傳入一個(gè)函數(shù)，而是一個(gè)全局函數(shù)名。C/C++保存這個(gè)函數(shù)名，在需要回調(diào)Lua的時(shí)候，就在Lua全局表中找到這個(gè)函數(shù)（根據(jù)函數(shù)名），然后再調(diào)用之。情況大致如下:

復(fù)制代碼代碼如下:

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

我們這回的腳本模塊，策劃會(huì)大量使用需要回調(diào)函數(shù)的C/C++函數(shù)。顯然，創(chuàng)建大量的全局函數(shù)，先是從寫代碼的角度看，就是很傷神的。

解決

我們最終需要的方式，大概如下:

復(fù)制代碼代碼如下:

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

要解決這個(gè)問(wèn)題，我的思路是直接在Lua層做一些包裝。因?yàn)镃/C++那邊僅支持傳入一個(gè)全局函數(shù)名（當(dāng)然不一定得全局的，根據(jù)實(shí)際情況，可能在其他自己構(gòu)造的表里也行），也就是一個(gè)字符串，所以我的思路就是將Lua函數(shù)和一個(gè)唯一的字符串做映射。

復(fù)制代碼代碼如下:

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

這個(gè)wrap函數(shù)，就是將一個(gè)函數(shù)在全局表里映射到一個(gè)字符串上，那么在使用時(shí):

復(fù)制代碼代碼如下:

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

cfunc是C/C++方注冊(cè)進(jìn)Lua的函數(shù)，它的原型很中規(guī)中矩，即：只接收一個(gè)函數(shù)名，一個(gè)字符串，如之前所說(shuō)，C/C++要調(diào)用這個(gè)回調(diào)函數(shù)時(shí)，就根據(jù)這個(gè)字符串去查找對(duì)應(yīng)的函數(shù)。腳本方在調(diào)用時(shí)，如果想傳入一個(gè)匿名函數(shù)了，就調(diào)用wrap函數(shù)包裝一下即可。

一個(gè)改進(jìn)

上面的方法有個(gè)很嚴(yán)重的問(wèn)題，在多次調(diào)用wrap函數(shù)后，將導(dǎo)致全局表也隨之膨脹。我們需要想辦法在C/C++完成回調(diào)后，來(lái)清除wrap建立的數(shù)據(jù)。這個(gè)工作當(dāng)然可以放到C/C++來(lái)進(jìn)行，例如每次發(fā)生回調(diào)后，就設(shè)置下全局表。但這明顯是不對(duì)的，因?yàn)檫`背了接口的設(shè)計(jì)原則，這個(gè)額外的機(jī)制是在Lua里添加的，那么責(zé)任也最好由Lua來(lái)負(fù)。要解決這個(gè)問(wèn)題，就可以使用Lua的metamethods機(jī)制。這個(gè)機(jī)制可以在Lua內(nèi)部發(fā)生特定事件時(shí)，讓應(yīng)用層得到通知。這里，我們需要關(guān)注__call事件。

Lua中只要有__call metamethod的值，均可被當(dāng)作函數(shù)調(diào)用。例如:

復(fù)制代碼代碼如下:

ab(1, 2)

這里這個(gè)函數(shù)調(diào)用形式，Lua就會(huì)去找ab是否有__call metamethod，如果有，則調(diào)用它。這個(gè)事實(shí)暗示我們，一個(gè)table也可以被調(diào)用。一個(gè)改進(jìn)的wrap函數(shù)如下:

復(fù)制代碼代碼如下:

	
	local function create_callback_table (fn, name)
	        local t = {}
	        t.callback = fn
	        setmetatable (t, {__call =  -- 關(guān)注__call
	            function (func, ...) -- 在t(xx)時(shí)，將調(diào)用到這個(gè)函數(shù)
	                func.callback (...) -- 真正的回調(diào)
	                del_callback (name) -- 回調(diào)完畢，清除wrap建立的數(shù)據(jù)
	            end })
	        return t
	    end
	   
	    function wrap (fn)
	        local id = generate_func_id() -- 產(chǎn)生唯一的id
	        local fn_s = "_callback_fn"..id
	        _G[fn_s] = create_callback_table(fn, fn_s) -- _G[fn_s]對(duì)應(yīng)的是一個(gè)表
	        return fn_s
	    end

在我們的C/C++程序中，依然如往常一樣，先是從_G里取出函數(shù)名對(duì)應(yīng)的對(duì)象。雖然這個(gè)對(duì) 象現(xiàn)在已經(jīng)是一個(gè)table。然后lua_call。

上面的代碼是否會(huì)在原有基礎(chǔ)上增加不可接受的性能代價(jià)？雖然我沒(méi)有做過(guò)實(shí)際測(cè)試，但是從表明看來(lái)，排除meta table在Lua里的代價(jià)，也就多了幾次Lua函數(shù)調(diào)用。

最后，感嘆一下，Lua里的table及metatable機(jī)制，實(shí)在非常強(qiáng)大。這種強(qiáng)大不是功能堆砌出來(lái)的強(qiáng)大，而是簡(jiǎn)單東西組合出來(lái)的強(qiáng)大。其背后的設(shè)計(jì)思想，著實(shí)讓人佩服。

4.26.2011 Update

之前的文中說(shuō)“Lua本身是不支持將Lua函數(shù)作為函數(shù)參數(shù)傳入C/C++的“，這句話嚴(yán)格來(lái)說(shuō)不正確（由某網(wǎng)友評(píng)論）。假設(shè)函數(shù)cfun由c/c++注冊(cè)，我們是可以編寫如下代碼的:

復(fù)制代碼代碼如下:

cfunc(print) -- 傳入Lua函數(shù)

但是問(wèn)題在于，我們無(wú)法取出這個(gè)函數(shù)并保存在c/c++方。Lua提供了一些接口用于取cfunc 的參數(shù)，例如luaL_checknumber（封裝lua_tonumber）。但沒(méi)有類似luaL_checkfunction的接口。Lua中的table有同樣的問(wèn)題。究其原因，主要是Lua中的函數(shù)沒(méi)有直接的c/c++數(shù)據(jù)結(jié) 構(gòu)對(duì)應(yīng)。

上一篇：使用lua實(shí)現(xiàn)split字符串分隔

下一篇：Lua中實(shí)現(xiàn)StringBuffer功能