注冊(cè)C++函數(shù)

當(dāng)Lua 調(diào)用C 函數(shù)的時(shí)候， 使用和C 調(diào)用Lua 相同類型的棧來(lái)交互。C 函數(shù)從棧中獲取她的參數(shù)， 調(diào)用結(jié)束后將返回結(jié)果放到棧中。為了區(qū)分返回結(jié)果和棧中的其他的值， 每個(gè)C函數(shù)還會(huì)返回結(jié)果的個(gè)數(shù) 。這兒有一個(gè)重要的概念：用來(lái)交互的棧不是全局變量， 每一個(gè)函數(shù)都有他自己的私有棧。當(dāng)Lua 調(diào)用C 函數(shù)的時(shí)候，第一個(gè)參數(shù)總是在這個(gè)私有棧的index=1 的位置

LUA中可注冊(cè)的C函數(shù)類型

任何在Lua 中注冊(cè)的函數(shù)必須有同樣的原型，這個(gè)原型聲明定義就是lua.h 中的

lua_CFunction ：typedef int (*lua_CFunction) (lua_State *L);

 例子

lua_pushcfunction(l, l_sin);

lua_setglobal(l, "mysin");

第一行將類型為function 的值入棧， 第二行將

function 賦值給全局變量mysin

 
注冊(cè)任意類型的C函數(shù)：

如果要向lua注冊(cè)一個(gè)非lua_CFunction類型的函數(shù)，需要：
1． 為該函數(shù)實(shí)現(xiàn)一個(gè)封裝調(diào)用。
2． 在封裝調(diào)用函數(shù)中從lua棧中取得提供的參數(shù)。
3． 使用參數(shù)調(diào)用該函數(shù)。
4． 向lua傳遞其結(jié)果。

 
首先必須有一個(gè)LUA規(guī)定類型的C函數(shù)，例如：

template<typename Func>
int TempCallFun(lua_State* L)

注意這里有個(gè)typename Func，是函數(shù)的類型，稍后會(huì)講這個(gè)的作用

 
然后必須在這個(gè)函數(shù)中調(diào)用真正的C函數(shù)，這個(gè)函數(shù)通過(guò)棧來(lái)傳遞，LUA中提供了傳遞用戶數(shù)據(jù)的接口

用戶數(shù)據(jù)

Lua提供了一個(gè)函數(shù)可以存儲(chǔ)用戶數(shù)據(jù)：

在適當(dāng)?shù)臅r(shí)刻，我們可以通過(guò)這個(gè)函數(shù)再取出這個(gè)數(shù)據(jù)：

這樣我們可以在注冊(cè)C++函數(shù)時(shí)，把這個(gè)函數(shù)指針當(dāng)作用戶數(shù)據(jù)壓棧，然后在調(diào)用TempCallFun時(shí)把這個(gè)函數(shù)取出

這里有個(gè)關(guān)鍵就是在調(diào)用時(shí)必須得到正確的參數(shù)類型和個(gè)數(shù)，以正確調(diào)用函數(shù)并向LUA傳遞結(jié)果，在網(wǎng)上流傳的LUA的C++封裝中，實(shí)現(xiàn)這一功能都是用模板，在TempCallFun中，可以這樣調(diào)用從棧中取出的函數(shù)指針：

buffer = (unsigned char*)lua_touserdata(L,lua_upvalueindex1));//取出用戶數(shù)據(jù)

return Call((*(Func*)buffer),L,1);//調(diào)用

注意這個(gè)Func就是我們要調(diào)用的C++的函數(shù)類型，也就是上面說(shuō)的要把函數(shù)指針類型傳進(jìn)來(lái)的目的

接下來(lái)是Call的其中兩個(gè)定義

template <typename RT>
int Call(RT (*func)(), lua_State*  L, int index)//匹配沒(méi)有參數(shù)的C++函數(shù)
{
     return ReturnType<RT>::Call(func, L, index);
}

template <typename RT, typename P1>
int Call(RT (*func)(P1), lua_State*  L, int index)//匹配有一個(gè)參數(shù)的C++函數(shù)
{
     return ReturnType<RT>::Call(func, L, index);
}

假如有一個(gè) int Test(int a)的C++函數(shù)，那么在調(diào)用時(shí)，就會(huì)轉(zhuǎn)到int Call(RT (*func)(P1), lua_State*  L, int index)里面，這樣我們就可以在這個(gè)函數(shù)具體處理有一個(gè)參數(shù)的C++函數(shù)的情況，因?yàn)閰?shù)類型也已經(jīng)通過(guò)模板傳進(jìn)來(lái)了，所以可以繼續(xù)通過(guò)模板來(lái)取得把棧中的參數(shù)轉(zhuǎn)為正確的類型以供C++函數(shù)調(diào)用，這里有個(gè)技巧是封裝棧操作：

template<class T> struct TypeWrapper {};

inline char             Get(TypeWrapper<char>, lua_State*  L, int idx)

inline short            Get(TypeWrapper<short>, lua_State*  L, int idx)

這里的TypeWrapper<typename T>只是為了傳遞棧中的參數(shù)類型

定義所有類型可能的類型的Get函數(shù)，就能方便的取得棧中的元素了，在上面的ReturnType<RT>::Call(func, L, index)里面，可以這樣調(diào)用真正的C++函數(shù)，

最后把返回值壓棧傳給LUA，這樣就實(shí)現(xiàn)了任意C++函數(shù)類型的注冊(cè)。 注冊(cè)C++類的成員函數(shù)方法一樣，只是要把這個(gè)類的某個(gè)實(shí)例也當(dāng)作用戶數(shù)據(jù)壓棧

 
注冊(cè)C++類

實(shí)現(xiàn)這個(gè)要比較復(fù)雜，因?yàn)長(zhǎng)UA并不支持面向?qū)ο蟮奶匦裕獙?shí)現(xiàn)這個(gè)必須通過(guò)一些技巧擴(kuò)展，LUA中的表就是實(shí)現(xiàn)這個(gè)功能的媒介，也就是用表模擬C++中類的行為，具體實(shí)現(xiàn)方法就不詳細(xì)說(shuō)了，大家可以去看LuaTinker的代碼，這里只說(shuō)一下要點(diǎn)

表其實(shí)就是一種數(shù)據(jù)元素的集合，每個(gè)元素都有一個(gè)索引，用戶可通過(guò)索引來(lái)訪問(wèn)表里的元素

 要注冊(cè)類，關(guān)鍵要做到兩點(diǎn)

1、  LUA中的表跟C++中的類的關(guān)聯(lián)，也就是在LUA中構(gòu)造一個(gè)表相應(yīng)在C++中也必須構(gòu)造一個(gè)類

2、  表中元素跟類中的元素的映射，以得到LUA中的表跟C++中的類的行為的一致性

因?yàn)轭愂亲约憾x的類型，要實(shí)現(xiàn)一個(gè)通用的注冊(cè)類的功能的話，還必須對(duì)傳遞給LUA中的類做一個(gè)封裝，在LuaTinker中，這個(gè)類是：

struct user
{ 
     user(void* p) : m_p(p) {}

  virtual ~user() {}

   void* m_p;

};

template<typename T>
struct val2user : user
{
     val2user() : user(new T) {} //構(gòu)造函數(shù)沒(méi)有參數(shù)的類

   template<typename T1>      //構(gòu)造函數(shù)有一個(gè)參數(shù)的類
  
      val2user(T1 t1) : user(new T(t1)) {}

   //以此類推。。。。。。。

    ~val2user() { delete ((T*)m_p); }

};

與LUA中的表關(guān)聯(lián)的只是這個(gè)val2user，構(gòu)造一個(gè)表就構(gòu)造一個(gè)val2user，在val2user中再構(gòu)造具體的類

下面是幾個(gè)在ＬＵＡ中預(yù)定義的事件

The __call Metamethod

這是在創(chuàng)建一個(gè)表的時(shí)候會(huì)觸發(fā)的事件，可以通過(guò)在此事件的元方法中調(diào)用類的構(gòu)造函數(shù)，以達(dá)到在LUA中創(chuàng)建元表的同時(shí)在C++中創(chuàng)建類

 
LUA中的表有幾個(gè)比較重要的預(yù)定義的錯(cuò)誤行為的事件

The __index Metamethod

當(dāng)我們?cè)L問(wèn)一個(gè)表的不存在的域， 返回結(jié)果為nil ， 這是正確的， 但并不一定正確。實(shí)際上， 這種訪問(wèn)觸發(fā)lua 解釋器去查找__index metamethod ： 如果不存在， 返回結(jié)果為nil ,如果存在則由__index metamethod 返回結(jié)果。

The  __newindex metamethod

用來(lái)對(duì)表更新， __index 則用來(lái)對(duì)表訪問(wèn)。當(dāng)你給表的一個(gè)缺少的域賦值，解釋器就會(huì)查找__newindex metamethod ： 如果存在則調(diào)用這個(gè)函數(shù)而不進(jìn)行賦值操作。像__index 一樣， 如果metamethod 是一個(gè)表,解釋器對(duì)指定的那個(gè)表， 而不是原始的表進(jìn)行賦值操作。

可以通過(guò)定義這兩個(gè)特性的元方法來(lái)實(shí)現(xiàn)對(duì)類中變量的訪問(wèn)和設(shè)置，因?yàn)閡serdata是沒(méi)有元素的，所以訪問(wèn)時(shí)一定會(huì)觸發(fā)__index，_newindex元方法，通過(guò)設(shè)置此元方法既可實(shí)現(xiàn)對(duì)類以及其基類中變量的訪問(wèn)

The  __gc Metamethod

這個(gè)元方法只對(duì)userdata 類型的值有效。當(dāng)一個(gè)userdatum 將被收集的時(shí)候， 并且usedatum 有一個(gè)__gc 域， Lua 會(huì)調(diào)用這個(gè)域的值（ 應(yīng)該是一個(gè)函數(shù)）：以u(píng)serdatum作為這個(gè)函數(shù)的參數(shù)調(diào)用。這個(gè)函數(shù)負(fù)責(zé)釋放與userdatum 相關(guān)的所有資源。

 
可以設(shè)置此事件的元方法來(lái)析構(gòu)類