Lua教程(四):在Lua中調(diào)用C語(yǔ)言、C++的函數(shù)
本教程將介紹如何在Lua里面調(diào)用c/c++函數(shù)。
在Lua里面調(diào)用c/c++函數(shù)其實(shí)是比較簡(jiǎn)單,本文將通過(guò)兩個(gè)示例演示具體的做法:一個(gè)是求平均數(shù),另一個(gè)是打印lua函數(shù)的一些參數(shù)信息。
最后,本文會(huì)介紹如何把這兩個(gè)函數(shù)定義成一個(gè)模塊,這樣lua代碼里面就可以不再使用全局的名字空間了。
前言
當(dāng)我們需要在Lua里面調(diào)用c/c++函數(shù)時(shí),所有的函數(shù)都必須滿足以下函數(shù)簽名:
typedef int (*lua_CFunction) (lua_State *L);
換句話說(shuō),所有的函數(shù)必須接收一個(gè)lua_State作為參數(shù),同時(shí)返回一個(gè)整數(shù)值。因?yàn)檫@個(gè)函數(shù)使用Lua棧作為參數(shù),所以它可以從棧里面讀取任意數(shù)量和任意類型的參數(shù)。而這個(gè)函數(shù)的返回值則表示函數(shù)返回時(shí)有多少返回值被壓入Lua棧。(因?yàn)長(zhǎng)ua的函數(shù)是可以返回多個(gè)值的)
示例一
定義C++函數(shù)指針
int average(lua_State *L)
{
// get number of arguments
int n = lua_gettop(L);
double sum = 0;
int i;
// loop through each argument
for (i = 1; i <= n; i++)
{
// total the arguments
sum += lua_tonumber(L, i);
}
// push the average
lua_pushnumber(L, sum / n);
// push the sum
lua_pushnumber(L, sum);
// return the number of results
return 2;
}
注冊(cè)此函數(shù)給Lua
lua_register(L, "average", average);
Lua里面調(diào)用此函數(shù)
avg, sum = average(10, 20, 30, 40, 50)
print("The average is ", avg)
print("The sum is ", sum)
示例二
定義C++函數(shù)
int displayLuaFunction(lua_State *l)
{
// number of input arguments
int argc = lua_gettop(l);
// print input arguments
std::cout << "[C++] Function called from Lua with " << argc
<< " input arguments" << std::endl;
for(int i=0; i<argc; i++)
{
std::cout << " input argument #" << argc-i << ": "
<< lua_tostring(l, lua_gettop(l)) << std::endl;
lua_pop(l, 1);
}
// push to the stack the multiple return values
std::cout << "[C++] Returning some values" << std::endl;
lua_pushnumber(l, 12);
lua_pushstring(l, "See you space cowboy");
// number of return values
return 2;
}
注冊(cè)此Lua函數(shù)
// push the C++ function to be called from Lua
std::cout << "[C++] Pushing the C++ function" << std::endl;
lua_pushcfunction(L, displayLuaFunction);
lua_setglobal(L, "displayLuaFunction");
注意,上一個(gè)示例,我們使用的是函數(shù)是
lua_register(L, "average", average);
它其實(shí)只是一個(gè)宏定義,其實(shí)現(xiàn)也是上面兩個(gè)函數(shù)組成的。
在Lua里調(diào)用此函數(shù)
io.write('[Lua] Calling the C functionn')
a,b = displayLuaFunction(12, 3.141592, 'hola')
-- print the return values
io.write('[Lua] The C function returned <' .. a .. '> and <' .. b .. '>\n')
實(shí)現(xiàn)一個(gè)Lua模塊
首先,我們把這兩個(gè)C函數(shù)封裝到一個(gè)數(shù)組里面:
static const luaL_Reg mylibs[]=
{
{"average", average},
{"displayLuaFunction", displayLuaFunction},
{NULL, NULL}
};
接下來(lái),我們定義另一個(gè)C函數(shù),讓它注冊(cè)我們的Lua模塊:
int lua_openmylib(lua_State *L)
{
luaL_newlib(L, mylibs);
return 1;
};
這里的luaL_newlib會(huì)生成一個(gè)table,并把所有的mylibs里面的函數(shù)填充進(jìn)去。最后,lua_openmylib返回值為1,表示會(huì)把剛剛生成的table壓入棧。
最后,我們像之前注冊(cè)Lua的標(biāo)準(zhǔn)庫(kù)一樣,注冊(cè)我們新的庫(kù),并給它起名字為mylib:
static const luaL_Reg lualibs[] =
{
{"base", luaopen_base},
{"io", luaopen_io},
{"mylib", lua_openmylib},
{NULL, NULL}
};
此時(shí),我們?cè)贚ua里面調(diào)用之前的兩個(gè)函數(shù)就需要帶上模塊名字前綴了:
avg, sum = mylib.average(10, 20, 30, 40, 50)
a,b = mylib.displayLuaFunction(12, 3.141592, 'hola')
結(jié)語(yǔ)
注意:這里C函數(shù)參數(shù)里的Lua棧是私有的,每一個(gè)函數(shù)都有自己的棧。當(dāng)一個(gè)c/c++函數(shù)把返回值壓入Lua棧以后,該棧會(huì)自動(dòng)被清空。
相關(guān)文章
C++中調(diào)用Lua配置文件和響應(yīng)函數(shù)示例
這篇文章主要介紹了C++中調(diào)用Lua配置文件和響應(yīng)函數(shù)示例,本文使用Lua文件作為配置文件,并寫了幾個(gè)響應(yīng)函數(shù)以便在C++中使用,需要的朋友可以參考下2015-07-07