我应该如何将 lua 函数绑定到 C++功能？

Question

我有一个名为 Entity 的类，它有许多函数，如 onPickup、onDrop、onUse 等。我想要做的是编写一个脚本来定义所有这些函数并使它们可以从 C++ 函数调用。因此，C++ 中定义的函数只会调用具有某些功能的相应 Lua 函数。

但这是问题，我希望我编写的每个脚本，程序中的每个实体都在其自己的范围内工作。

我正在使用 LuaBind，并且我之前没有使用 Lua 的经验，所以我在这里有点迷失。

Answer 1

我不使用 lua 绑定，但这可能会有所帮助。这个想法是在 C++ 类中注册 lua 函数，并在 C++ 类中保留对 lua 函数的引用。

为了定义可从 C/C++ 调用的 lua 函数，我使用 luaL_ref 在我的 C++ 对象中存储对回调函数的引用。

// a little helper function
template <typename T>
T *Lua_getUserData(lua_State *L) {
    assert(lua_isuserdata(L, 1) == 1);
    T **v = (T **) lua_touserdata(L, 1);
    assert(v != NULL);
    return *v;
}

int lua_FormRegisterMethods(lua_State *L) {
    Entity *f = Lua_getUserData<Entity>(L);
    assert(lua_istable(L, 2) == 1); // check the next parameter is a table
    lua_pushvalue(L,2); // dup the table
    f->LuaTable = luaL_ref(L, LUA_REGISTRYINDEX); // keep a reference to the table
    lua_getmetatable(L, 2); // get the metatable
    lua_pushstring(L, "OnClick"); 
    lua_rawget(L, -2); // get the OnClick Lua Function
    f->LuaMethod = luaL_ref(L, LUA_REGISTRYINDEX); // save a reference to it
    return 0;
}

然后您可以在 C++ 事件中获取 lua 方法，

lua_rawgeti( LuaInstance->L, LUA_REGISTRYINDEX, LuaMethod );
assert(lua_isfunction(LuaInstance->L, -1) == 1);

现在您可以调用此函数，并将 self 设置为您之前保存的表。哈

Answer 2

您可以调用 Lua 函数，例如，

int callLuaFunction(lua_State* lua_state) {
    return luabind::call_function<int>(lua_state, "myluafunction", param1);
}

如果 Lua 函数返回一个 int 并采用 1 个参数。

我非常确定您可以根据需要创建任意数量的 lua_State。只需将实体的正确值传递给 call_function 即可。

Answer 3

要以您可能想要的方式完全实现这一点，需要深入研究 Lua 的一些更深奥的部分。不过，这是非常值得的。我将展示我如何处理这个问题的一个非常精简的版本。请注意，这里有很多小部分一起工作 - 主要是保存和调用保存的函数以及使用 C++ 对象作为 Lua 用户数据。

首先我们需要一个 C++ 类，它将事件处理程序（lua 函数）存储为简单整数的 lua 引用。我在这里使用一个数组，但你可以使用任何有意义的东西。这里发生的主要事情是你希望能够调用由 int 引用引用的 lua 函数。

#include "lua.h"
#include "lauxlib.h"
#include "lualib.h"
#include <string>
#include <iostream>
#include <assert.h>
using namespace std;

enum enum_event_types {
    ON_USE, ON_DROP, ON_WHATEVER, EVENT_COUNT
};

class Entity {
  private:  
    int events[EVENT_COUNT];
  public: 
    lua_State* lua;
    void setEventHandler(int event, int ref) {
        assert(event < EVENT_COUNT);
        events[event] = ref;
    }
    void callEventHandler(int event) {
        int error;
        assert(event < EVENT_COUNT);
            // to call the function we need to get it from the registry index
        lua_rawgeti(lua, LUA_REGISTRYINDEX, events[event]);
        error = lua_pcall(lua, 0, 0, 0); // use protected call for errors
        if (error) {
            printf("error: %s", lua_tostring(lua, -1));
            lua_pop(lua, 1); 
        }
    }
};

现在您想要向 Lua 公开您的实体类。如果您不熟悉这是如何完成的，有一篇很好的文章

int L_newEntity(lua_State* L) {
    Entity **e = (Entity **)lua_newuserdata(L, sizeof(Entity *));
    *e = new Entity(); 
    (*e)->lua = L;
    lua_getglobal(L, "Entity");
    lua_setmetatable(L, -2); 
    return 1;
}

int L_setOnUse(lua_State* L) {
    Entity** e = (Entity**) lua_touserdata(L, 1);
    lua_pushvalue(L, 2);
    int ref = luaL_ref(L, LUA_REGISTRYINDEX);
    (*e)->setEventHandler(ON_USE, ref);
    return 0;
}

// this will be exposed to Lua as a table called Entity
static const luaL_Reg L_entityMethods[] = {
    {"new", L_newEntity},{"setOnUse", L_setOnUse},{NULL, NULL}
};

现在设置 Lua 状态并创建实体表并创建测试。该测试将创建一个实体并将其事件处理程序设置为传递给它的 Lua 函数。最后测试Lua函数是否被c++对象调用。

int main() {
    Entity** e;
    int error;
    lua_State* L=lua_open();
    luaL_openlibs(L);
    luaL_register(L, "Entity", L_entityMethods); 
    lua_pushvalue(L,-1);
    lua_setfield(L, -2, "__index"); 
    lua_pop(L, 1);

    luaL_loadstring(L, 
    "e = Entity.new(); "
    "e:setOnUse(function()"
    "   print('Some of them want to use you')"
    "end);");
    error = lua_pcall(L, 0, 0, 0);
    if (error) {
        printf("error: %s", lua_tostring(L, -1));
        lua_pop(L, 1); /* errors must be popped from stack */
    }   
    lua_getglobal(L, "e");
    if (lua_isuserdata(L, 1)) {
        e = (Entity**) lua_touserdata(L, 1);
        (*e)->callEventHandler(ON_USE);
    }
    return 0;
}

这还远未完成。首先，如果您需要两次设置事件处理程序，则需要先使用 luaL_unref 清除旧引用。其次，您可能希望将有关发生的事件的一些数据传递给事件处理程序。当前的事件处理程序不获取任何数据，因此 API 用户几乎无法继续操作。它可能至少应该传递对调用事件的对象的引用。这可以用来在 Lua 中创建非常强大且可用的 API。祝你好运！