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

更新時間：2014年11月06日 11:19:36 投稿：junjie

這篇文章主要介紹了把Lua函數(shù)傳遞到C/C++中實例,本文先是分析了需求,然后給出解決方法,需要的朋友可以參考下

問題

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

復制代碼代碼如下:

table.sort(table [,comp])

這里的comp就要求傳入一個函數(shù)，我們在調用時，大概會有如下形式:

復制代碼代碼如下:

table.sort(t, comp) -- 直接寫函數(shù)名

    table.sort(t, local_comp) -- 某個局部函數(shù)

    table.sort(t, function (a, b) xxx end ) -- 臨時構造一個匿名函數(shù)

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

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

復制代碼代碼如下:

function lua_func () xxx end

    cfunc(lua_func) -- wrong

    cfunc("lua_func") -- right

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

解決

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

復制代碼代碼如下:

cfunc(lua_func) -- ok

    cfunc(function () xxx end) -- ok

    local xxx = function () xxx end

    cfunc(xxx) -- ok

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

復制代碼代碼如下:

function wrap (fn)

        local id = generate_id()

        local fn_s = "__callback_fn"..id

        _G[fn_s] = fn

        return fn_s

    end

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

復制代碼代碼如下:

cfunc(wrap(function () xxx end))

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

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

一個改進

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

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

復制代碼代碼如下:

ab(1, 2)

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

復制代碼代碼如下:

local function create_callback_table (fn, name)

        local t = {}

        t.callback = fn

        setmetatable (t, {__call =  -- 關注__call

            function (func, ...) -- 在t(xx)時，將調用到這個函數(shù)

                func.callback (...) -- 真正的回調

                del_callback (name) -- 回調完畢，清除wrap建立的數(shù)據(jù)

            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里取出函數(shù)名對應的對象。雖然這個對象現(xiàn)在已經是一個table。然后lua_call。

上面的代碼是否會在原有基礎上增加不可接受的性能代價？雖然我沒有做過實際測試，但是從表明看來，排除meta table在Lua里的代價，也就多了幾次Lua函數(shù)調用。

最后，感嘆一下，Lua里的table及metatable機制，實在非常強大。這種強大不是功能堆砌出來的強大，而是簡單東西組合出來的強大。其背后的設計思想，著實讓人佩服。

4.26.2011 Update

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

復制代碼代碼如下:

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

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

您可能感興趣的文章: