如何在 Lua 中注册 C++ 嵌套类

我目前能够将 C++ 类绑定到 Lua 上,通过使用 luaL_requiref 加载带有正确静态打开函数的模块来处理 luaL_newmetatableluaL_setfuncs 等。非常好用。

但是,如果我想绑定一个嵌套类呢?

考虑以下 C++ 代码:

class Foo {
public:
    Foo(){}
    void do_something();

    class Bar {
    public:
        Bar(){}
        void do_something_else();
    };
};

以及 Lua 注册代码:

int foo_new(lua_State* L) {
    new(lua_newuserdata(L, sizeof(foo)))foo();
    luaL_setmetatable(L, "Foo");
    return 1;
}
int foo_do_something(lua_State* L) {
    Foo* foo = (Foo*)luaL_checkudata(L, 1, "Foo");
    foo->do_something();
    return 0;
}
int luaopen_foo(lua_State* L) {
    const luaL_Reg functions[] = {
        {"__index", foo_new},
        {"do_something", foo_do_something},
        {nullptr, nullptr}
    };
    if( luaL_newmetatable(L, "Foo") ) {
        luaL_setfuncs(L, functions, 0);
        lua_pushvalue(L, -1);
        lua_setfield(L, -2, "__index");
    }
    return 1;
}

...

luaL_requiref(L, "Foo", luaopen_foo, 1);

我可以像这样在 Lua 中访问 Foo::do_something()

foo = Foo()
foo:do_something()

现在的问题是:如何在 Lua 中注册 Foo::Bar 嵌套类,以便我可以像这样访问它:

bar = Foo.Bar()
bar:do_something_else()

基本上,我想在 Foo 的元表中注册 Bar 方法,而不是在全局范围内注册。我需要另一个对 luaL_requiref 的调用,还是可以在单个 luaL_requiref 中完成?

谢谢!

点赞
用户3203765
用户3203765

是的,你可以用一个函数调用实现。

luaL_requiref 函数只是带有一些额外功能的传递函数,例如检查模块是否已被加载(并更新 package.loaded 表)、注册对应的全局值等等。

我假设你不想将 Bar 独立于 Foo 加载,或者将 Foo 单独加载,因此在 package.loaded 表中只需要一个 "Foo" 条目就够了。同理,在全局中也不需要 Bar 变量。

因此,只需将其作为 Foo 的一个字段即可。

附言:确保你的析构函数被调用。通常,如果你使用 lua_newuserdata 与放置的新变量,你需要使用 __gc 的元方法。

修改 luaopen_Foo 方法(注意构造函数使用的是__call,而不是 __index。个人比较喜欢使用 new 名称,但如果你想将其作为 local f = Foo() 创建,则需要用 __call):

int luaopen_foo(lua_State* L)
{
    static const luaL_Reg functions[] =
    {
        {"__call"       , foo_new},
        {"do_something" , foo_do_something},
        {nullptr        , nullptr}
    };

    if (luaL_newmetatable(L, "Foo"))
    {
        luaL_setfuncs(L, functions, 0);
        lua_pushvalue(L, -1);
        lua_setfield(L, -2, "__index");

        // =================
        // 在此处,你的 "Foo" 元表在栈顶,
        // 即将作为 luaopen_Foo 的结果返回。
        // 只需在其上面放置另一个表并设置为 Foo.Bar 即可
        if (luaopen_FooBar(L))
            lua_setfield(L, -2, "Bar");
    }
    return 1;
}

int luaopen_FooBar(lua_State * L)
{
    static const luaL_Reg functions[] =
    {
        {"__call"            , foo_bar_new},
        {"do_something_else" , foo_bar_do_something_else},
        {nullptr             , nullptr}
    };

    // luaL_newmetatable 将其结果放在栈的顶部,
    // 正是我们想要的结果,适合用于 lua_setfield
    if (luaL_newmetatable(L, "Foo::Bar"))
    {
        luaL_setfuncs(L, functions, 0);
        lua_pushvalue(L, -1);
        lua_setfield(L, -2, "__index");
    }
    return 1; // 表示结果在栈顶
}

如果你曾好奇 luaL_requiref 函数是如何实现(伪代码):

void luaL_requiref(lua_State *L, const char *name, lua_CFunction openf, int set_global)
{
    if (!try_get_already_loaded_module(modname))
    {
        lua_pushcfunction(L, openf); // 调用 openf 函数
        lua_pushstring(L, modname);  // 以 modname 作为其参数
        lua_call(L, 1, 1);

        memorize_the_result_for_future(modname);
    }
    if (set_global)
    {
        lua_pushvalue(L, -1);       // 复制模块
        lua_setglobal(L, modname);  // 设置 _G[modname] = module
    }
}

请注意区别:luaL_requiref 从 Lua 中调用您的函数,这可以确保其执行后进行适当的栈清理,例如您可以将一些垃圾放在那里,唯一要确保的就是顶层值与 return 1 要一致。如果直接调用该函数,则没有这种奢侈,因此请确保它 _只添加一个值在栈的顶部_。

2016-07-02 22:02:31