为 SWIG 创建类型映射,以便 C 函数可以 return a Lua table
Creating typemaps for SWIG so C function can return a Lua table
我正在尝试包装一个创建浮点数组的 C 函数,然后 return 这个数组作为 Lua table 以便它可以在 Lua 中使用。
这是 return 具有 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}
虽然这工作正常,但我想知道是否可以创建一个可以 return mutable 浮点数组的 C 函数。
所以我认为函数应该是这样的。
static void getArray(int size, float **values) {
//create a float array and then return this as a table in Lua.
}
但是,我不知道如何将此函数与 SWIG 接口 (.i) 绑定。
我已尽我所能,但到目前为止无法正常工作。
任何人都可以指导我如何使用 SWIG 包装此函数,以便我可以 return mutable 浮点数组作为 Lua 中的 table?
P.S:这是 Lua SWIG 文档的 link。
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) %{
= &tmp; // Use the temporary we setup
= &tsize;
%}
%typemap(argout) (int *size, t_word **values) {
int i;
lua_newtable(L);
for (i = 0; i < *; i++){
lua_pushnumber(L,(lua_Number)(*)[i].w_float);
lua_rawseti(L,-2,i+1);/* -1 is the number, -2 is the table*/
}
SWIG_arg++;
}
t_word
是用于具有浮点数据的数组的结构 w_float
.
我不需要释放任何东西,因为我没有分配新内存,而且它看起来很有魅力。
非常感谢您的帮助。我从你的代码中学到了很多。
您可以使用多参数类型映射来做到这一点。我基于 typemaps.i 中 OUTPUT[ANY] 的那些,并进行了快速测试以显示它如何工作:
%module test
%typemap(in,numinputs=1) (int size, float **values) (float *tmp=NULL) %{
= &tmp; // Use the temporary we setup
// Either of the next two lines are equivalent
// = (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 < ; i++){
lua_pushnumber(L,(lua_Number)(*)[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 中,它创建一个新的 table 并用我们的 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) %{
= &tmp;
= &tsize;
%}
%typemap(argout) (int *size, float **values) {
// Adapted from OUTPUT[ANY] argout in typemaps.i
int i;
lua_newtable(L);
for (i = 0; i < *; i++){
lua_pushnumber(L,(lua_Number)(*)[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
都是输出
- typemap 中用于大小输出的额外局部变量
我正在尝试包装一个创建浮点数组的 C 函数,然后 return 这个数组作为 Lua table 以便它可以在 Lua 中使用。
这是 return 具有 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}
虽然这工作正常,但我想知道是否可以创建一个可以 return mutable 浮点数组的 C 函数。
所以我认为函数应该是这样的。
static void getArray(int size, float **values) {
//create a float array and then return this as a table in Lua.
}
但是,我不知道如何将此函数与 SWIG 接口 (.i) 绑定。
我已尽我所能,但到目前为止无法正常工作。
任何人都可以指导我如何使用 SWIG 包装此函数,以便我可以 return mutable 浮点数组作为 Lua 中的 table?
P.S:这是 Lua SWIG 文档的 link。 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) %{
= &tmp; // Use the temporary we setup
= &tsize;
%}
%typemap(argout) (int *size, t_word **values) {
int i;
lua_newtable(L);
for (i = 0; i < *; i++){
lua_pushnumber(L,(lua_Number)(*)[i].w_float);
lua_rawseti(L,-2,i+1);/* -1 is the number, -2 is the table*/
}
SWIG_arg++;
}
t_word
是用于具有浮点数据的数组的结构 w_float
.
我不需要释放任何东西,因为我没有分配新内存,而且它看起来很有魅力。
非常感谢您的帮助。我从你的代码中学到了很多。
您可以使用多参数类型映射来做到这一点。我基于 typemaps.i 中 OUTPUT[ANY] 的那些,并进行了快速测试以显示它如何工作:
%module test
%typemap(in,numinputs=1) (int size, float **values) (float *tmp=NULL) %{
= &tmp; // Use the temporary we setup
// Either of the next two lines are equivalent
// = (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 < ; i++){
lua_pushnumber(L,(lua_Number)(*)[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 中,它创建一个新的 table 并用我们的 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) %{
= &tmp;
= &tsize;
%}
%typemap(argout) (int *size, float **values) {
// Adapted from OUTPUT[ANY] argout in typemaps.i
int i;
lua_newtable(L);
for (i = 0; i < *; i++){
lua_pushnumber(L,(lua_Number)(*)[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
都是输出 - typemap 中用于大小输出的额外局部变量