Lua可以調(diào)用C函數(shù)的能力將極大的提高Lua的可擴(kuò)展性和可用性。對(duì)于有些和操作系統(tǒng)相關(guān)的功能,或者是對(duì)效率要求較高的模塊,我們完全可以通過C函數(shù)來實(shí)現(xiàn),之后再通過Lua調(diào)用指定的C函數(shù)。對(duì)于那些可被Lua調(diào)用的C函數(shù)而言,其接口必須遵循Lua要求的形式,即typedef int (*lua_CFunction)(lua_State* L)。簡單說明一下,該函數(shù)類型僅僅包含一個(gè)表示Lua環(huán)境的指針作為其唯一的參數(shù),實(shí)現(xiàn)者可以通過該指針進(jìn)一步獲取Lua代碼中實(shí)際傳入的參數(shù)。返回值是整型,表示該C函數(shù)將返回給Lua代碼的返回值數(shù)量,如果沒有返回值,則return 0即可。需要說明的是,C函數(shù)無法直接將真正的返回值返回給Lua代碼,而是通過虛擬棧來傳遞Lua代碼和C函數(shù)之間的調(diào)用參數(shù)和返回值的。這里我們將介紹兩種Lua調(diào)用C函數(shù)的規(guī)則。
#include stdio.h>
#include string.h>
#include lua.hpp>
#include lauxlib.h>
#include lualib.h>
//待Lua調(diào)用的C注冊(cè)函數(shù)。
static int add2(lua_State* L)
{
//檢查棧中的參數(shù)是否合法,1表示Lua調(diào)用時(shí)的第一個(gè)參數(shù)(從左到右),依此類推。
//如果Lua代碼在調(diào)用時(shí)傳遞的參數(shù)不為number,該函數(shù)將報(bào)錯(cuò)并終止程序的執(zhí)行。
double op1 = luaL_checknumber(L,1);
double op2 = luaL_checknumber(L,2);
//將函數(shù)的結(jié)果壓入棧中。如果有多個(gè)返回值,可以在這里多次壓入棧中。
lua_pushnumber(L,op1 + op2);
//返回值用于提示該C函數(shù)的返回值數(shù)量,即壓入棧中的返回值數(shù)量。
return 1;
}
//另一個(gè)待Lua調(diào)用的C注冊(cè)函數(shù)。
static int sub2(lua_State* L)
{
double op1 = luaL_checknumber(L,1);
double op2 = luaL_checknumber(L,2);
lua_pushnumber(L,op1 - op2);
return 1;
}
const char* testfunc = "print(add2(1.0,2.0)) print(sub2(20.1,19))";
int main()
{
lua_State* L = luaL_newstate();
luaL_openlibs(L);
//將指定的函數(shù)注冊(cè)為Lua的全局函數(shù)變量,其中第一個(gè)字符串參數(shù)為Lua代碼
//在調(diào)用C函數(shù)時(shí)使用的全局函數(shù)名,第二個(gè)參數(shù)為實(shí)際C函數(shù)的指針。
lua_register(L, "add2", add2);
lua_register(L, "sub2", sub2);
//在注冊(cè)完所有的C函數(shù)之后,即可在Lua的代碼塊中使用這些已經(jīng)注冊(cè)的C函數(shù)了。
if (luaL_dostring(L,testfunc))
printf("Failed to invoke.\n");
lua_close(L);
return 0;
}
將包含C函數(shù)的代碼生成庫文件,如Linux的so,或Windows的DLL,同時(shí)拷貝到Lua代碼所在的當(dāng)前目錄,或者是LUA_CPATH環(huán)境變量所指向的目錄,以便于Lua解析器可以正確定位到他們。在我當(dāng)前的Windows系統(tǒng)中,我將其copy到"C:\Program Files\Lua\5.1\clibs\",這里包含了所有Lua可調(diào)用的C庫。見如下C語言代碼和關(guān)鍵性注釋:
#include stdio.h>
#include string.h>
#include lua.hpp>
#include lauxlib.h>
#include lualib.h>
//待注冊(cè)的C函數(shù),該函數(shù)的聲明形式在上面的例子中已經(jīng)給出。
//需要說明的是,該函數(shù)必須以C的形式被導(dǎo)出,因此extern "C"是必須的。
//函數(shù)代碼和上例相同,這里不再贅述。
extern "C" int add(lua_State* L)
{
double op1 = luaL_checknumber(L,1);
double op2 = luaL_checknumber(L,2);
lua_pushnumber(L,op1 + op2);
return 1;
}
extern "C" int sub(lua_State* L)
{
double op1 = luaL_checknumber(L,1);
double op2 = luaL_checknumber(L,2);
lua_pushnumber(L,op1 - op2);
return 1;
}
//luaL_Reg結(jié)構(gòu)體的第一個(gè)字段為字符串,在注冊(cè)時(shí)用于通知Lua該函數(shù)的名字。
//第一個(gè)字段為C函數(shù)指針。
//結(jié)構(gòu)體數(shù)組中的最后一個(gè)元素的兩個(gè)字段均為NULL,用于提示Lua注冊(cè)函數(shù)已經(jīng)到達(dá)數(shù)組的末尾。
static luaL_Reg mylibs[] = {
{"add", add},
{"sub", sub},
{NULL, NULL}
};
//該C庫的唯一入口函數(shù)。其函數(shù)簽名等同于上面的注冊(cè)函數(shù)。見如下幾點(diǎn)說明:
//1. 我們可以將該函數(shù)簡單的理解為模塊的工廠函數(shù)。
//2. 其函數(shù)名必須為luaopen_xxx,其中xxx表示library名稱。Lua代碼require "xxx"需要與之對(duì)應(yīng)。
//3. 在luaL_register的調(diào)用中,其第一個(gè)字符串參數(shù)為模塊名"xxx",第二個(gè)參數(shù)為待注冊(cè)函數(shù)的數(shù)組。
//4. 需要強(qiáng)調(diào)的是,所有需要用到"xxx"的代碼,不論C還是Lua,都必須保持一致,這是Lua的約定,
// 否則將無法調(diào)用。
extern "C" __declspec(dllexport)
int luaopen_mytestlib(lua_State* L)
{
const char* libName = "mytestlib";
luaL_register(L,libName,mylibs);
return 1;
}