Создание раскладок для SWIG, чтобы функция C могла возвращать таблицу Lua - PullRequest
Новая
       51

Создание раскладок для SWIG, чтобы функция C могла возвращать таблицу Lua

0 голосов
/ 28 мая 2018

Я пытаюсь обернуть функцию C, которая создает массив с плавающей точкой, а затем возвращает этот массив в виде таблицы Lua, чтобы его можно было использовать в Lua.

Вот функция C, которая возвращает массив с 4 элементами.

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?

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.

Мне не нужно было ничего освобождатьпоскольку я не выделил новую память, и она, кажется, работает как шарм.

Большое спасибо за вашу помощь.Я многому научился из вашего кода.

1 Ответ

0 голосов
/ 04 июня 2018

Вы можете сделать это с помощью таблицы параметров с несколькими аргументами.Я основал свои на тех для OUTPUT [ANY] в typemaps.i и собрал быстрый тест, чтобы показать, как это может работать: 

%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, поскольку мы фактически не выделяем какие-либоmemory
  • numinputs = 0, потому что и int *size, и float **values являются выходами
  • Дополнительная локальная переменная для размера, выводимого внутри карты типов
...