如何从 Lua 中提取 C++ 对象指针

Question

我在 C++ 中有一个名为“Point”的类：

class Point
{
public:
  int x, y;

  //constructor
  Point(int x, int y)
  {
    this->x = x;
    this->y = y;
  }
};

我的目标是能够用 Lua 脚本实例化一个 Point 对象，并从 Lua 堆栈中提取指向该对象的指针。

这是我（目前不工作）的尝试，希望能澄清我到底想要做什么；请注意，此代码本质上是从 this tutorial 修改的复制/粘贴，并且我使用的是 Lua 5.2：

static int newPoint(lua_State *L) 
{
    int n = lua_gettop(L);
    if (n != 2) 
       return luaL_error(L, "expected 2 args for Point.new()", n); 

    // Allocate memory for a pointer to object
    Point **p = (Point **)lua_newuserdata(L, sizeof(Point *));  

    double x = luaL_checknumber (L, 1);      
    double y = luaL_checknumber (L, 2); 

    //I want to access this pointer in C++ outside this function
    *p = new Point(x, y);

    luaL_getmetatable(L, "Point"); // Use global table 'Point' as metatable
    lua_setmetatable(L, -2); 

  return 1; 
}

static const luaL_Reg pointFuncs[] = {
  {"new", newPoint},
  {NULL, NULL}
};

//register Point to Lua
void registerPoint(lua_State *L)
{
    lua_createtable(L, 0, 0);
    // Register metatable for user data in registry
    luaL_newmetatable(L, "Point");
    luaL_setfuncs(L, pointFuncs, 0);           
    lua_pushvalue(L,-1);
    lua_setfield(L,-2, "__index");
    lua_setglobal(L, "Point");
}

Point* checkPoint(lua_State* L, int index)
{
  void* ud = 0;
  luaL_checktype(L, index, LUA_TTABLE); 
  lua_getfield(L, index, "__index");
  ud = luaL_checkudata(L, index, "Point");;  

  return *((Point**)ud);     
 }

 int main()
 {
    lua_State *L = luaL_newstate();
    luaL_openlibs(L);
        registerPoint(L);
    luaL_dofile(L, "testz.lua");
    lua_getglobal(L, "Point");
    Point *foo = checkPoint(L, lua_gettop(L));
        std::cout << "x: " << foo->x << " y: " << foo->y;
    lua_close(L);
    return 0;
 }

这是 Lua 脚本：

local point = Point.new(10,20)

运行此代码，我在该行收到以下错误：“bad argument #3 (Point expected, got table)”： ud = luaL_checkudata(L, index, "Point") 在 checkPoint() 函数中。

如果有人能引导我朝着正确的方向前进，将不胜感激。

Answer 1

我建议不要编写自己的绑定，而是使用经过测试和记录的绑定，例如 luabridge 或 luabind

您的绑定将简化为：

getGlobalNamespace (L)
    .beginClass<Point>("Point")
     .addConstructor<void (*) (int,int)>()
     .addData("X", &Point::x)
     .addData("Y", &Point::y)
    .endClass()
;

你的 lua 看起来像

local point = Point(10,20)

使用 luabridge。

对于提取值，请参阅例如 LuaRef in luabridge。如果你使用 c++11，还有其他一些非常漂亮的 lua 绑定库。

Answer 2

您的上述用法和绑定存在几个问题。

在您的测试脚本中，local point 不会被您的主机 c++ 程序看到。这是因为，嗯，它是该脚本的本地文件。如果您希望从 C++ 中访问它，要么将 point 作为脚本的值返回，要么将其设为全局并使用 lua_getglobal(L, "point") 检索它。

checkPoint 函数有一些不必要的代码。如果您查看 Lua C API 提供的其他 luaL_check* 函数，它们主要检查堆栈索引处的给定值是否是正确的类型。如果是，则将该类型转换为 C++ 可以使用的类型。

因此，在您的“检查点”功能中，您真正需要做的就是：

Point* checkPoint(lua_State* L, int index)
{
  return *((Point **) luaL_checkudata(L, index, "Point"));
}

如果你把你的脚本改成这样，例如：

local point = Point.new(10,20)
return point

您应该能够通过以下方式从 C++ 访问 point：

// ...
luaL_dofile(L, "testz.lua");

Point *foo = checkPoint(L, -1);
std::cout << "x: " << foo->x << " y: " << foo->y;
// ...

另一个重要的一点是关于暴露给 lua 的 C++ 对象的生命周期。因为每当从脚本中调用 Point.new 时，您都在使用 C++ 'new' 运算符进行分配和构造，所以您间接地说 让 lua 处理这个暴露的 C++ 对象的生命周期。这意味着您还需要实现__gc 元方法来充当“终结器”或非确定性析构函数。如果没有这个，你将无法“删除”point 对象并在 lua 垃圾收集相应的用户数据时回收空间。

为此，您可以按如下方式扩充您的代码：

• 编写一个 deletePoint 函数，由 lua 在 userdata gc 上调用。

  static int deletePoint(lua_State *L)
  {
    Pointer **p = checkPoint(L, 1);
    delete *p;
    *p = NULL;  // probably not needed but to be safe
    return 0;
  }
  

• 将它添加到您的pointFuncs 以便 lua 知道它。

  static const luaL_Reg pointFuncs[] =
  {
    {"new", newPoint},
    {"__gc", deletePoint},
    {NULL, NULL}
  };