如何让Lua中C导出函数返回结构体指针并直接访问其成员？

现有问题 #

目前C端的GetStruct函数返回一个包含结构体指针和成员值的table，Lua需要通过table字段分别访问指针和成员。现在需要调整为：GetStruct直接返回结构体指针，Lua中可以通过指针变量直接用.mid、.mpos这种方式访问成员。

解决方案 #

核心思路是给Lua中的lightuserdata（即结构体指针）绑定元表，利用Lua的__index元方法拦截成员访问操作，当Lua尝试访问指针的.mid等字段时，由C端的回调函数去读取结构体对应成员的值并返回。

具体实现步骤 #

1. 定义并注册元表：在Lua虚拟机初始化时，创建一个元表，给它设置__index元方法，这个方法负责处理成员访问逻辑。
2. 修改GetStruct函数：不再创建table，直接把结构体指针作为lightuserdata压入Lua栈，然后给这个lightuserdata设置之前定义的元表。
3. 实现__index回调函数：当Lua访问指针的某个字段时，该函数根据字段名匹配结构体的成员，返回对应的值。

修改后的C代码 #

#include <lua.h>
#include <lauxlib.h>
#include <string.h>

// 假设这是你的结构体定义
struct member {
    int mid;
    int mpos;
    int mtime;
};

// 模拟获取结构体的函数（实际根据业务逻辑实现）
struct member* get_member(int id) {
    static struct member test_member = {1, 100, 1620000000};
    return &test_member;
}

// __index元方法的回调函数，处理成员访问请求
static int member_index(lua_State *ls) {
    struct member *mb = (struct member*)lua_touserdata(ls, 1);
    const char *key = lua_tostring(ls, 2);

    if (mb == NULL) {
        lua_pushnil(ls);
        return 1;
    }

    // 根据字段名返回对应结构体成员的值
    if (strcmp(key, "mid") == 0) {
        lua_pushinteger(ls, mb->mid);
    } else if (strcmp(key, "mpos") == 0) {
        lua_pushinteger(ls, mb->mpos);
    } else if (strcmp(key, "mtime") == 0) {
        lua_pushinteger(ls, mb->mtime);
    } else {
        // 未知字段返回nil
        lua_pushnil(ls);
    }
    return 1;
}

// 初始化元表，在Lua虚拟机启动时调用
static void register_member_metatable(lua_State *ls) {
    luaL_newmetatable(ls, "member_metatable");
    // 将__index元方法绑定到member_index函数
    lua_pushcfunction(ls, member_index);
    lua_setfield(ls, -2, "__index");
    lua_pop(ls, 1);
}

// 修改后的GetStruct函数
int GetStruct(lua_State *ls) {
    lua_Integer id = (int)luaL_checkinteger(ls, 1);
    struct member *mb = get_member(id); 

    if (mb == NULL) {
        return 0;
    }

    // 压入结构体指针作为lightuserdata
    lua_pushlightuserdata(ls, mb);
    // 获取注册表中的元表
    luaL_getmetatable(ls, "member_metatable");
    // 给lightuserdata设置元表
    lua_setmetatable(ls, -2);

    return 1;
}

// 模块注册入口（如果需要打包成Lua模块）
int luaopen_member(lua_State *ls) {
    register_member_metatable(ls);
    lua_register(ls, "GetStruct", GetStruct);
    return 0;
}

对应的Lua用法 #

local mystruct = GetStruct(1)
print(mystruct.mid)   -- 输出1
print(mystruct.mpos)  -- 输出100
print(mystruct.mtime) -- 输出1620000000

内容的提问来源于stack exchange，提问作者alberto silva