为SWIG创建类型映射,以便C函数可以返回Lua表

时间:2018-05-28 09:16:15

标签: c lua swig lua-table typemaps

我正在尝试包装一个创建float数组的C函数,然后将此数组作为Lua表返回,以便它可以在Lua中使用。

这是返回带有4个元素的float数组的C函数。

static void getArray(int size, float values[4]) {

    for (int i=0; i<size; ++i)
        values[i] = (float)i;
}

这是.i文件中的打字部分。

// using typemaps
%include <typemaps.i>
%apply (float OUTPUT[ANY]) {(float values[4])}; 

在Lua中,我可以使用以下函数,

arr = my.getArray(4); //table "arr" is now {0,1,2,3}

虽然这很好用,但我想知道是否可以创建一个可以返回可变浮点数组的C函数。

所以我觉得这个功能看起来像这样。

static void getArray(int size, float **values) {

    //create a float array and then return this as a table in Lua. 
}

但是,我不知道如何将此功能与SWIG接口(.i)绑定。

我尝试了所有我能做的事情,但到目前为止无法使它发挥作用。

任何人都可以指导我如何使用SWIG包装此函数,以便我可以将一个可变浮点数组作为Lua中的表返回吗?

P.S:这是Lua SWIG文档的链接。 http://www.swig.org/Doc1.3/Lua.html

------------------------以下添加------------------ ------

@Flexo根据您更新的解决方案,我可以成功绑定getArray功能,如下所示。

static void getArray(const string &name, int *size, t_word **values) {

        t_garray *a;
        int vecsize;
        t_word *vec;

        if (getArrayData(name, &a, &vecsize, &vec)) {

            *values = vec;
            *size = vecsize;
        }
    }

这是我的SWIG界面。

%typemap(in,numinputs=0) (int *size, t_word **values) (t_word *tmp=NULL, int tsize=0) %{
  $2 = &tmp; // Use the temporary we setup
  $1 = &tsize;
%}

%typemap(argout) (int *size, t_word **values) {

  int i;
  lua_newtable(L);
  for (i = 0; i < *$1; i++){
    lua_pushnumber(L,(lua_Number)(*$2)[i].w_float);
    lua_rawseti(L,-2,i+1);/* -1 is the number, -2 is the table*/
  }
  SWIG_arg++;
}

t_word是一个用于数组的结构,它有一个浮点数据w_float

我不需要释放任何东西,因为我没有分配新的记忆,它看起来像一个魅力。

非常感谢你的帮助。我从你的代码中学到了很多东西。

1 个答案:

答案 0 :(得分:2)

您可以使用多参数类型图执行此操作。我基于typemaps.i中的OUTPUT [ANY]的基础,并进行快速测试以显示它如何工作:

%module test

%typemap(in,numinputs=1) (int size, float **values) (float *tmp=NULL) %{
  $2 = &tmp; // Use the temporary we setup
  // Either of the next two lines are equivalent 
  //$1 = (int)lua_tonumber(L,$input);
  $typemap(in,int);
%}

%typemap(freearg) (int size, float **values) %{
  free(tmp$argnum); // Assuming this is the right semantics here
%}

%typemap(argout) (int size, float **values) {
  // Adapted from OUTPUT[ANY] argout in typemaps.i 
  int i;
  lua_newtable(L);
  for (i = 0; i < $1; i++){
    lua_pushnumber(L,(lua_Number)(*$2)[i]);
    lua_rawseti(L,-2,i+1);/* -1 is the number, -2 is the table*/ \
  }
  SWIG_arg++;
}

%inline %{
static void getArray(int size, float **values) {
    //create a float array and then return this as a table in Lua.
    float *arr = malloc(sizeof *arr * size);
    for (int i = 0; i < size; ++i) {
        arr[i] = i;
    } 
    *values = arr;
}

从Lua我们可以像这样使用这个函数:

Lua 5.3.3  Copyright (C) 1994-2016 Lua.org, PUC-Rio
> l=require('test')
> l
table: 0xcb87de8
> l.getArray()
stdin:1: Error in getArray expected 1..1 args, got 0
stack traceback:
        [C]: in function 'test.getArray'
        stdin:1: in main chunk
        [C]: in ?
> l.getArray(1)
table: 0xcb86d48
> l.getArray(1)
table: 0xcb88b50
> l.getArray(1)[0]
nil
> l.getArray(1)[1]
0.0
> l.getArray(1)[2]
nil
> l.getArray(3)[2]
1.0
> l.getArray(3)[3]
2.0
> l.getArray(3)[4]
nil
> 

这里的大部分工作都在argout typemap中,它创建了一个新表,并使用我们的getArray()函数放入float **输出参数的值填充它。

如果getArray()的真实版本实际上没有让您指定或找出输出的长度,那么您最好不要包装那个并专注于包装{{1本身。 (如果需要,您可以使用getArrayData()使已经熟悉C ++ API的用户感觉更加相似。要换%rename,我将其更改为:

getArrayData()

主要变化:

  • 现在不需要freearg typemap,因为我们实际上没有分配任何内存
  • numinputs = 0,因为%module test %include <std_string.i> %typemap(in,numinputs=0) (int *size, float **values) (float *tmp=NULL,int tsize=0) %{ $2 = &tmp; $1 = &tsize; %} %typemap(argout) (int *size, float **values) { // Adapted from OUTPUT[ANY] argout in typemaps.i int i; lua_newtable(L); for (i = 0; i < *$1; i++){ lua_pushnumber(L,(lua_Number)(*$2)[i]); lua_rawseti(L,-2,i+1);/* -1 is the number, -2 is the table*/ \ } SWIG_arg++; } %inline %{ static void getArrayData(const std::string& name, void *something_else, int *size, float **values) { // pretend like someone already owns this memory static float arr[100]; *size = sizeof arr / sizeof *arr; for (int i = 0; i < *size; ++i) { arr[i] = i; } *values = arr; } %} int *size都是输出
  • typemap内输出大小的额外局部变量