用户登录
用户注册

分享至

Lua教程(二十二):userdata

  • 作者: 森屿暖树Autism
  • 来源: 51数据库
  • 2021-08-16

在lua中可以通过自定义类型的方式与c语言代码更高效、更灵活的交互。这里我们通过一个简单完整的示例来学习一下lua中userdata的使用方式。需要说明的是,该示例完全来自于programming in lua。其功能是用c程序实现一个lua的布尔数组,以提供程序的执行效率。见下面的代码和关键性注释。  

复制代码 代码如下:

#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. 检查第一个参数是否为整型。以及该参数的值是否大于等于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. 参数表示lua为userdata分配的字节数。同时将分配后的userdata对象压入栈中。
    numarray* a = (numarray*)lua_newuserdata(l,nbytes);
    a->size = n;
    for (int i = 0; i < i_word(n - 1); ++i)
        a->values[i] = 0;
    //获取注册表变量myarray,该key的值为metatable。
    lual_getmetatable(l,"myarray");
    //将userdata的元表设置为和myarray关联的table。同时将栈顶元素弹出。
    lua_setmetatable(l,-2);
    return 1;
}

extern "c" int setarray(lua_state* l)
{
    //1. lua传给该函数的第一个参数必须是userdata,该对象的元表也必须是注册表中和myarray关联的table。
    //否则该函数报错并终止程序。
    numarray* a = (numarray*)lual_checkudata(l,1,"myarray");
    int index = lual_checkint(l,2) - 1;
    //2. 由于任何类型的数据都可以成为布尔值,因此这里使用any只是为了确保有3个参数。
    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)时lua会调用该元方法。
    {null, null}
};

extern "c" __declspec(dllexport)
int luaopen_testuserdata(lua_state* l)
{
    //1. 创建元表,并将该元表指定给newarray函数新创建的userdata。在lua中userdata也是以table的身份表现的。
    //这样在调用对象函数时,可以通过验证其metatable的名称来确定参数userdata是否合法。
    lual_newmetatable(l,"myarray");
    lua_pushvalue(l,-1);
    //2. 为了实现面对对象的调用方式,需要将元表的__index字段指向自身,同时再将arraylib_m数组中的函数注册到
    //元表中,之后基于这些注册函数的调用就可以以面向对象的形式调用了。
    //lua_setfield在执行后会将栈顶的table弹出。
    lua_setfield(l,-2,"__index");
    //将这些成员函数注册给元表,以保证lua在寻找方法时可以定位。null参数表示将用栈顶的table代替第二个参数。
    lual_register(l,null,arraylib_m);
    //这里只注册的工厂方法。
    lual_register(l,"testuserdata",arraylib_f);
    return 1;
}


 
轻量级userdata:

  之前介绍的是full userdata,lua还提供了另一种轻量级userdata(light userdata)。事实上,轻量级userdata仅仅表示的是c指针的值,即(void*)。由于它只是一个值,所以不用创建。如果需要将一个轻量级userdata放入栈中,调用lua_pushlightuserdata即可。full userdata和light userdata之间最大的区别来自于相等性判断,对于一个full userdata,它只是与自身相等,而light userdata则表示为一个c指针,因此,它与所有表示同一指针的light userdata相等。再有就是light userdata不会受到垃圾收集器的管理,使用时就像一个普通的整型数字一样。

软件
前端设计
程序设计
Java相关