在Lua中可以通過(guò)自定義類型的方式與C語(yǔ)言代碼更高效、更靈活的交互。這里我們通過(guò)一個(gè)簡(jiǎn)單完整的示例來(lái)學(xué)習(xí)一下Lua中userdata的使用方式。需要說(shuō)明的是,該示例完全來(lái)自于Programming in Lua。其功能是用C程序?qū)崿F(xiàn)一個(gè)Lua的布爾數(shù)組,以提供程序的執(zhí)行效率。見(jiàn)下面的代碼和關(guān)鍵性注釋。
#include lua.hpp>
#include lauxlib.h>
#include lualib.h>
#include limits.h>
#define BITS_PER_WORD (CHAR_BIT * sizeof(int))
#define I_WORD(i) ((unsigned int)(i))/BITS_PER_WORD
#define I_BIT(i) (1 ((unsigned int)(i)%BITS_PER_WORD))
typedef struct NumArray {
int size;
unsigned int values[1];
} NumArray;
extern "C" int newArray(lua_State* L)
{
//1. 檢查第一個(gè)參數(shù)是否為整型。以及該參數(shù)的值是否大于等于1.
int n = luaL_checkint(L,1);
luaL_argcheck(L, n >= 1, 1, "invalid size.");
size_t nbytes = sizeof(NumArray) + I_WORD(n - 1) * sizeof(int);
//2. 參數(shù)表示Lua為userdata分配的字節(jié)數(shù)。同時(shí)將分配后的userdata對(duì)象壓入棧中。
NumArray* a = (NumArray*)lua_newuserdata(L,nbytes);
a->size = n;
for (int i = 0; i I_WORD(n - 1); ++i)
a->values[i] = 0;
//獲取注冊(cè)表變量myarray,該key的值為metatable。
luaL_getmetatable(L,"myarray");
//將userdata的元表設(shè)置為和myarray關(guān)聯(lián)的table。同時(shí)將棧頂元素彈出。
lua_setmetatable(L,-2);
return 1;
}
extern "C" int setArray(lua_State* L)
{
//1. Lua傳給該函數(shù)的第一個(gè)參數(shù)必須是userdata,該對(duì)象的元表也必須是注冊(cè)表中和myarray關(guān)聯(lián)的table。
//否則該函數(shù)報(bào)錯(cuò)并終止程序。
NumArray* a = (NumArray*)luaL_checkudata(L,1,"myarray");
int index = luaL_checkint(L,2) - 1;
//2. 由于任何類型的數(shù)據(jù)都可以成為布爾值,因此這里使用any只是為了確保有3個(gè)參數(shù)。
luaL_checkany(L,3);
luaL_argcheck(L,a != NULL,1,"'array' expected.");
luaL_argcheck(L,0 = index index a->size,2,"index out of range.");
if (lua_toboolean(L,3))
a->values[I_WORD(index)] |= I_BIT(index);
else
a->values[I_WORD(index)] = ~I_BIT(index);
return 0;
}
extern "C" int getArray(lua_State* L)
{
NumArray* a = (NumArray*)luaL_checkudata(L,1,"myarray");
int index = luaL_checkint(L,2) - 1;
luaL_argcheck(L, a != NULL, 1, "'array' expected.");
luaL_argcheck(L, 0 = index index a->size,2,"index out of range");
lua_pushboolean(L,a->values[I_WORD(index)] I_BIT(index));
return 1;
}
extern "C" int getSize(lua_State* L)
{
NumArray* a = (NumArray*)luaL_checkudata(L,1,"myarray");
luaL_argcheck(L,a != NULL,1,"'array' expected.");
lua_pushinteger(L,a->size);
return 1;
}
extern "C" int array2string(lua_State* L)
{
NumArray* a = (NumArray*)luaL_checkudata(L,1,"myarray");
lua_pushfstring(L,"array(%d)",a->size);
return 1;
}
static luaL_Reg arraylib_f [] = {
{"new", newArray},
{NULL, NULL}
};
static luaL_Reg arraylib_m [] = {
{"set", setArray},
{"get", getArray},
{"size", getSize},
{"__tostring", array2string}, //print(a)時(shí)Lua會(huì)調(diào)用該元方法。
{NULL, NULL}
};
extern "C" __declspec(dllexport)
int luaopen_testuserdata(lua_State* L)
{
//1. 創(chuàng)建元表,并將該元表指定給newArray函數(shù)新創(chuàng)建的userdata。在Lua中userdata也是以table的身份表現(xiàn)的。
//這樣在調(diào)用對(duì)象函數(shù)時(shí),可以通過(guò)驗(yàn)證其metatable的名稱來(lái)確定參數(shù)userdata是否合法。
luaL_newmetatable(L,"myarray");
lua_pushvalue(L,-1);
//2. 為了實(shí)現(xiàn)面對(duì)對(duì)象的調(diào)用方式,需要將元表的__index字段指向自身,同時(shí)再將arraylib_m數(shù)組中的函數(shù)注冊(cè)到
//元表中,之后基于這些注冊(cè)函數(shù)的調(diào)用就可以以面向?qū)ο蟮男问秸{(diào)用了。
//lua_setfield在執(zhí)行后會(huì)將棧頂?shù)膖able彈出。
lua_setfield(L,-2,"__index");
//將這些成員函數(shù)注冊(cè)給元表,以保證Lua在尋找方法時(shí)可以定位。NULL參數(shù)表示將用棧頂?shù)膖able代替第二個(gè)參數(shù)。
luaL_register(L,NULL,arraylib_m);
//這里只注冊(cè)的工廠方法。
luaL_register(L,"testuserdata",arraylib_f);
return 1;
}
之前介紹的是full userdata,Lua還提供了另一種輕量級(jí)userdata(light userdata)。事實(shí)上,輕量級(jí)userdata僅僅表示的是C指針的值,即(void*)。由于它只是一個(gè)值,所以不用創(chuàng)建。如果需要將一個(gè)輕量級(jí)userdata放入棧中,調(diào)用lua_pushlightuserdata即可。full userdata和light userdata之間最大的區(qū)別來(lái)自于相等性判斷,對(duì)于一個(gè)full userdata,它只是與自身相等,而light userdata則表示為一個(gè)C指針,因此,它與所有表示同一指針的light userdata相等。再有就是light userdata不會(huì)受到垃圾收集器的管理,使用時(shí)就像一個(gè)普通的整型數(shù)字一樣。