Step By Step(Lua調用C函數)

    Lua可以調用C函數的能力將極大的提高Lua的可擴充性和可用性。對於有些和作業系統相關的功能，或者是對效率要求較高的模組，我們完全可以通過C函數來實現，之後再通過Lua調用指定的C函數。對於那些可被Lua調用的C函數而言，其介面必須遵循Lua要求的形式，即typedef int (*lua_CFunction)(lua_State* L)。簡單說明一下，該函數類型僅僅包含一個表示Lua環境的指標作為其唯一的參數，實現者可以通過該指標進一步擷取Lua代碼中實際傳入的參數。傳回值是整型，表示該C函數將返回給Lua代碼的傳回值數量，如果沒有傳回值，則return 0即可。需要說明的是，C函數無法直接將真正的傳回值返回給Lua代碼，而是通過虛擬棧來傳遞Lua代碼和C函數之間的調用參數和傳回值的。這裡我們將介紹兩種Lua調用C函數的規則。
    1. C函數作為應用程式的一部分。

 1 #include <stdio.h> 2 #include <string.h> 3 #include <lua.hpp> 4 #include <lauxlib.h> 5 #include <lualib.h> 6  7 //待Lua調用的C註冊函數。 8 static int add2(lua_State* L) 9 {10     //檢查棧中的參數是否合法，1表示Lua調用時的第一個參數(從左至右)，依此類推。11     //如果Lua代碼在調用時傳遞的參數不為number，該函數將報錯並終止程式的執行。12     double op1 = luaL_checknumber(L,1);13     double op2 = luaL_checknumber(L,2);14     //將函數的結果壓入棧中。如果有多個傳回值，可以在這裡多次壓入棧中。15     lua_pushnumber(L,op1 + op2);16     //傳回值用於提示該C函數的傳回值數量，即壓入棧中的傳回值數量。17     return 1;18 }19 20 //另一個待Lua調用的C註冊函數。21 static int sub2(lua_State* L)22 {23     double op1 = luaL_checknumber(L,1);24     double op2 = luaL_checknumber(L,2);25     lua_pushnumber(L,op1 - op2);26     return 1;27 }28 29 const char* testfunc = "print(add2(1.0,2.0)) print(sub2(20.1,19))";30 31 int main()32 {33     lua_State* L = luaL_newstate();34     luaL_openlibs(L);35     //將指定的函數註冊為Lua的全域函數變數，其中第一個字串參數為Lua代碼36     //在調用C函數時使用的全域函數名，第二個參數為實際C函數的指標。37     lua_register(L, "add2", add2);38     lua_register(L, "sub2", sub2);39     //在註冊完所有的C函數之後，即可在Lua的代碼塊中使用這些已經註冊的C函數了。40     if (luaL_dostring(L,testfunc))41         printf("Failed to invoke.\n");42     lua_close(L);43     return 0;44 }

    2. C函數庫成為Lua的模組。
    將包含C函數的代碼產生庫檔案，如Linux的so，或Windows的DLL，同時拷貝到Lua代碼所在的目前的目錄，或者是LUA_CPATH環境變數所指向的目錄，以便於Lua解析器可以正確定位到他們。在我當前的Windows系統中，我將其copy到"C:\Program Files\Lua\5.1\clibs\"，這裡包含了所有Lua可調用的C庫。見如下C語言代碼和關鍵性注釋：

 1 #include <stdio.h> 2 #include <string.h> 3 #include <lua.hpp> 4 #include <lauxlib.h> 5 #include <lualib.h> 6  7 //待註冊的C函數，該函數的聲明形式在上面的例子中已經給出。 8 //需要說明的是，該函數必須以C的形式被匯出，因此extern "C"是必須的。 9 //函數代碼和上例相同，這裡不再贅述。10 extern "C" int add(lua_State* L) 11 {12     double op1 = luaL_checknumber(L,1);13     double op2 = luaL_checknumber(L,2);14     lua_pushnumber(L,op1 + op2);15     return 1;16 }17 18 extern "C" int sub(lua_State* L)19 {20     double op1 = luaL_checknumber(L,1);21     double op2 = luaL_checknumber(L,2);22     lua_pushnumber(L,op1 - op2);23     return 1;24 }25 26 //luaL_Reg結構體的第一個欄位為字串，在註冊時用於通知Lua該函數的名字。27 //第一個欄位為C函數指標。28 //結構體數組中的最後一個元素的兩個欄位均為NULL，用於提示Lua註冊函數已經到達數組的末尾。29 static luaL_Reg mylibs[] = { 30     {"add", add},31     {"sub", sub},32     {NULL, NULL} 33 }; 34 35 //該C庫的唯一入口函數。其函數簽名等同於上面的註冊函數。見如下幾點說明：36 //1. 我們可以將該函數簡單的理解為模組的工廠函數。37 //2. 其函數名必須為luaopen_xxx，其中xxx表示library名稱。Lua代碼require "xxx"需要與之對應。38 //3. 在luaL_register的調用中，其第一個字串參數為模組名"xxx"，第二個參數為待註冊函數的數組。39 //4. 需要強調的是，所有需要用到"xxx"的代碼，不論C還是Lua，都必須保持一致，這是Lua的約定，40 //   否則將無法調用。41 extern "C" __declspec(dllexport)42 int luaopen_mytestlib(lua_State* L) 43 {44     const char* libName = "mytestlib";45     luaL_register(L,libName,mylibs);46     return 1;47 }

    見如下Lua代碼：

1 require "mytestlib"  --指定包名稱2 3 --在調用時，必須是package.function4 print(mytestlib.add(1.0,2.0))5 print(mytestlib.sub(20.1,19))