如何使用SWIG

时间:2016-09-27 09:55:16

标签: c++ inheritance lua swig

例如,有一个用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 ++调用中,print的结果似乎都没有成功继承:

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

我知道它是Java中继承C ++的支持:generating-java-interface-with-swig

我知道这里有类似的问题,但我没有回答我面临的具体问题:implementing-and-inheriting-from-c-classes-in-lua-using-swig

Lua是否支持使用SWIG从lua继承C ++类,甚至只使用纯lua?请显示一些代码示例。 如果SWIG无法完成这项工作,是否有一些第三方库支持可以轻松完成?

1 个答案:

答案 0 :(得分:0)

似乎SWIG with Lua doesn't actually support directors,这是跨语言多态性工作所必需的。但这不是世界末日,看起来SaySomething方法是Say类中唯一的虚方法,因此您可以替换单个回调函数。 (如果是我,我会在C ++界面设计中使用std::function,这简化了其余部分工作。)

要说明这可能是如何工作的(并在此过程中向我学习一些Lua!)我整理了一个演示,该演示稍微简化了问题中的测试用例。

从本质上讲,我最终做的是修改&#39; in&#39; Callback类使用luaL_ref来保留&#39;引用&#39;对于一个匿名函数,如果给出的输入不是回调类型的开头。因此,我的typemap检查它给出的类型,并构造一个继承自Callback类型的临时本地类型的实例,保留并使用对某些Lua定义代码的引用,直到我们用{{3}调用它为止}。由于我们只在调用期间持有该实例,因此我们稍后在argfree类型映射中清理它。 (我从lua_pcall

得到了这个想法

所以我在一个地方演示这一切的界面如下所示:

%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添加适当的导演支持,或者如果你更熟悉Lua,可以更好地模拟它(即一种类型中的多个虚函数)。