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

Question

我正在尝试包装一个创建浮点数组的 C 函数，然后将该数组作为 Lua 表返回，以便在 Lua 中使用。

这是返回具有 4 个元素的浮点数组的 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。

我不需要释放任何东西，因为我没有分配新内存，而且它看起来就像一个魅力。

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

Answer 1

您可以使用多参数类型映射来做到这一点。我基于 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 类型映射中，它创建一个新表并使用我们的 getArray() 函数放入 float ** 输出参数中的值填充它。

如果getArray() 的真实版本实际上不允许您指定或找出输出的长度，那么您最好不要包装它，而是专注于包装getArrayData() 本身。 （如果需要，您可以使用%rename 让已经熟悉 C++ API 的用户感觉界面更相似）。要包装getArrayData()，我会将其更改为：

%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;
}
%}

关键变化：

• 现在不需要 freearg 类型映射，因为我们实际上并没有分配任何内存
• numinputs=0 因为int *size 和float **values 都是输出
• 一个额外的局部变量，用于类型映射内的大小输出