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

Question

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

但问题是，我希望我编写的每个脚本，让程序中的每个实体都在它自己的 scope 中工作。

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

Answer 1

我不使用 lua 绑定，但这可能会有所帮助。 The idea is to register the lua functions in your C++ class and keep a reference to the lua function in your C++ class.

To define a lua function that is callable from C/C++ I use luaL_ref to store a reference to the callback function in my C++ object.

// 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);

现在您可以调用此 function 并将 self 设置为您之前保存的表。 hth

Answer 2

您可以调用 Lua function，例如

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

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

我很确定您可以根据需要制作任意数量的lua_State 。 只需将实体的正确传递给call_function 。

Answer 3

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

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

#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); 
        }
    }
};

现在您想将您的实体 class 公开给 Lua。 如果您不熟悉这是如何完成的，这里有一篇很好的文章。 本质上，我们正在将 Entity.new() 返回的用户数据设置为指向指针的指针。 这样 Lua 不会垃圾收集您的 object。 然后为“Entity”创建一个元表，它将包含所有暴露给 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 state 并创建实体表并创建测试。 该测试将创建一个实体并将其事件处理程序设置为传递给它的 Lua function。 最后测试Lua function被c++ ZA8CFDE6331BD59EB2AC96F8911C4B66调用。

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 的用户对 go 的影响很小。 它可能至少应该传递对调用事件的 object 的引用。 这可用于在 Lua 中创建非常强大且可用的 API。 祝你好运！