如何使用SWIG从Lua中的C ++类继承

Question

例如，有一个用C ++编写的类：

//Say.h
#pragma once

#include <iostream>

class Say
{
public:
    Say() {}
    virtual ~Say() {}
    virtual void SaySomething() { std::cout << "It should not be show..\n"; };
};

inline void CallCppFun(Say& intf) {
    intf.SaySomething();
}

我写了Say.i：

//Say.i
%module Test

%{
#include "Say.h"
%}

%include "Say.h"

%inline %{
inline void CallCppFun(Say& intf);
%}

和main.cpp：

//main.cpp
#include <iostream>

extern "C"
{
#include <lua.h>
#include <lauxlib.h>
#include <lualib.h>
}

/* the SWIG wrappered library */
extern "C" int luaopen_Test(lua_State*L);

using namespace std;

int main()
{
    lua_State *L;
    L = luaL_newstate();
    luaL_openlibs(L);
    printf("[C] now loading the SWIG wrapped library\n");
    luaopen_Test(L);
    if (luaL_loadfile(L, "Test.lua") || lua_pcall(L, 0, 0, 0)) {
        printf("[C] ERROR: cannot run lua file: %s", lua_tostring(L, -1));
        exit(3);
    }

    return 0;
}

然后运行命令：

swig -c++ -lua say.i

我编译自动生成的文件example_wrap.cxx和其他cpp文件并成功链接。

我想在Test.lua中做的是从lua中的C ++ Say类继承：

-- Test.lua
Test.Say.SaySomething = function(self)
    print("Inherit from C++ in Lua")
end

my = Test.Say()

my:SaySomething() -- doesn't appear to inherit successfully in lua call

Test.CallCppFun(my) -- doesn't appear to inherit successfully in c++ call

在lua调用和c ++调用中，打印结果似乎都无法成功继承：

[C] now loading the SWIG wrapped library
It should not be show..
It should not be show..

我知道它支持从Java中的C ++继承： 生成带有斜杠的java-interface-with

我知道这里有一个类似的问题，但是没有给出我要面对的具体问题的答案： 在Lua中使用Cwig实现和继承C类

Lua是否支持使用SWIG从lua中的C ++类继承，甚至仅使用纯lua？ 请显示一些代码示例。 如果SWIG无法完成这项工作，那么它是否具有一些第三方库支持来轻松​​完成此工作？

Answer 1

带有Lua的SWIG似乎实际上并不支持Director ，这是跨语言多态性起作用所必需的。 不过，这还不是世界末日，看起来您的SaySomething方法是Say类中唯一的虚拟方法，因此您可以替代单个回调函数。 （如果是我，我会在C ++接口设计中使用std::function ，从而简化了其余工作）。

为了展示它是如何工作的（并向我学习一些Lua！），我整理了一个演示，该演示相对于问题中的测试用例略有简化。

本质上，我最终要做的是修改Callback类的“ in”类型luaL_ref以使用luaL_ref保留对匿名函数的“引用”， luaL_ref是输入的内容不是回调类型的开始用。 因此，我的类型映射检查了给定的类型，并构造了一个临时的本地类型的实例，该实例从Callback类型继承，保留并使用对Lua定义的代码的引用，直到我们使用lua_pcall对其进行lua_pcall为止。 由于我们仅在调用期间保留该实例，因此我们稍后将其在argfree类型图中清除。 （我从Lua邮件列表帖子中得到了这个主意）

因此，我的界面可以在一处展示所有内容，如下所示：

%module test

%{
#include <iostream>
%}

%typemap(in) const Callback& (Callback *tmp=NULL) %{
  if(lua_isuserdata(L,$argnum)) {
    if (!SWIG_IsOK(SWIG_ConvertPtr(L,$input,(void**)&$1,$descriptor,$disown))){
      SWIG_fail_ptr("$symname",$argnum,$descriptor);
    }
  }
  else if (lua_isfunction(L,$argnum)) {
    struct Lua$basetype : $basetype {
      Lua$basetype(lua_State* L, int idx) : L(L) {
        lua_pushvalue(L, idx); // This gets popped by luaL_ref
        // retain our argument
        ref = luaL_ref(L, LUA_REGISTRYINDEX);
      }
      virtual ~Lua$basetype() {
        // release our reference
        luaL_unref(L, LUA_REGISTRYINDEX, ref);
      }
      virtual void run(const std::string& str) const {
         // push our 'reference' onto the stack
         lua_rawgeti(L, LUA_REGISTRYINDEX, ref);
         // manually prepare the function arguments
         lua_pushstring(L, str.c_str());
         // make the actual calll
         lua_pcall(L, 1, 0, 0);
         // TODO: catch error and throw as C++ exception?
      }
    private:
      lua_State* L; // Uh, is keeping this around bad?
      int ref;
    };
    tmp = new Lua$basetype(L,$input);
    $1 = tmp;
  }
  else {
    SWIG_fail_arg("$symname",$argnum,"$1_type");
  }
%}

%typemap(freearg) const Callback& %{
  delete tmp$argnum; // Fine, even if NULL remember
%}

%inline %{
  struct Callback {
    virtual ~Callback() {}
    virtual void run(const std::string& str) const { std::cout << "Got string: " << str << "\n"; }
  };

  void call_me(const Callback& cb) {
    std::cout << "Hello World:\n";
    cb.run("DO IT NOW");
  }
%}

这足以将其与以下Lua代码一起使用：

require("test")
cb=test.Callback()
test.call_me(cb)
cb=function(s) print("Lua got string: "..s) end
test.call_me(cb)

我可以编译并运行：

swig3.0 -lua -c++ test.i
g++ -Wall -Wextra test_wrap.cxx -shared -o test.so -I /usr/include/lua5.1/
lua run.lua 
Hello World:
Got string: DO IT NOW
Hello World:
Lua got string: DO IT NOW

请注意，此示例将我编写的Lua总量增加了几乎一倍，因此您真的应该在将其用于生产之前检查我所做的事情是否合理。 可能可以使用类似这样的方法在SWIG中添加适当的Director支持，或者如果您更熟悉Lua，则可以更好地模拟它（即，一个类型中有多个虚拟函数）。