為SWIG創建類型映射，以便C函數可以返回Lua表

Question

我試圖包裝一個C函數，該函數創建float數組，然后將此數組作為Lua表返回，以便可以在Lua中使用。

這是C函數，它返回包含4個元素的float數組。

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

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

這是.i文件中的typemaps部分。

// 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 interface（.i）綁定。

我嘗試了我能做的所有事情，但到目前為止還無法完成。

誰能指導我如何使用SWIG包裝此函數，以便在Lua中將可變浮點數組作為表返回？

PS：這是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 Typemap，因為我們實際上並未分配任何內存
• numinputs = 0，因為int *size和float **values都是輸出float **values
• 類型映射內輸出的大小的額外局部變量