Lua 中 C 用户自定义类型：让 Lua 与 C/C++ 类型无缝衔接

2023-10-03 18:54:46

userdata：Lua 中的类型交互之桥

在 Lua 中，userdata 是一种强大且灵活的机制，它使我们能够在 Lua 脚本和 C/C++ 类型之间建立无缝的通信桥梁。

userdata 是什么？

本质上，userdata 是 Lua 中的一块内存，它存储着 C/C++ 类型实例的地址。通过使用元表（一种定义如何访问和操作userdata中的数据的表），我们可以将特定元方法与userdata关联起来。这些元方法规定了如何通过 Lua 代码访问和操作 C/C++ 实例。

userdata 的工作原理

userdata 的工作原理类似于指针。通过将 C/C++ 类型实例的地址存储在userdata中，我们创建了该实例在 Lua 中的表示。元表充当一个中介者，定义了如何通过元方法（例如 __index 和 __newindex）访问和操作userdata中的数据。

例如，假设我们有一个表示复数的 C++ 结构体。我们可以为该结构体创建一个元表，其中包含元方法来访问其实部和虚部：

struct Complex {
    double real;
    double imag;
};

static int get_real(lua_State *L) {
    Complex *complex = (Complex *)lua_touserdata(L, 1);
    lua_pushnumber(L, complex->real);
    return 1;
}

static int get_imag(lua_State *L) {
    Complex *complex = (Complex *)lua_touserdata(L, 1);
    lua_pushnumber(L, complex->imag);
    return 1;
}

static const luaL_Reg complex_metamethods[] = {
    {"__index", get_real},
    {"__newindex", get_imag},
    {NULL, NULL}
};

通过将此元表与userdata关联起来，我们赋予了 Lua 脚本访问和操作 C++ Complex 结构体实例的能力。

创建和使用userdata

创建userdata的过程如下：

使用 lua_newuserdata 分配一块内存。
将 C/C++ 类型实例的地址存储到分配的内存中。
创建一个元表，定义操作userdata的元方法。
将元表与userdata关联起来。

以下是 Lua 脚本的示例，演示如何创建和使用userdata：

-- 创建一个 userdata，其中存储了一个 Complex 结构体的地址
local complex_userdata = lua_newuserdata(L)

-- 获取 Complex 结构体的地址
local complex_ptr = complex_userdata:ptr()

-- 将元表与 userdata 关联
luaL_setmetatable(L, complex_userdata, complex_metamethods)

-- 访问 Complex 结构体的实部和虚部
local real_part = complex_userdata:__index()
local imag_part = complex_userdata:__newindex()