python - SWIG:需要可变字符串类型映射帮助

Question

这(我希望)是一个非常简单的问题，但是尽管做了一些阅读(我是 SWIG 的新手，而且在 C 方面相当绿色)我还是无法在我的头。

我有一个来自库的函数(遗留代码，不愿编辑):

extern int myfunction(char *infile, char *maskfile, int check, float *median, char *msg)

我的目标是使用 SWIG 在 Python 中为此创建一个包装器。

median 和msg 变量的值由 C 函数更改。当返回 int != 0 时，msg arg 中会有一些错误信息。如果返回 int == 0，则 median 变量将包含一个 float ，其值从 myfunction 分配。

这通常在返回值为 0 的情况下运行正常。我使用 %array_functions 和 %pointer_functions 来创建需要传递的指针，按照这个 .i 文件:

%module test
%include "cpointer.i"
%include "carrays.i"
%{
 #include <stdint.h>
%}

extern int myfunction(char *infile, char *maskfile, int check, float *median, char *msg)

%pointer_functions(float, floatp);
%pointer_functions(char, charp);
%array_functions(char, charArray);

在 swig-ing、编译和链接之后，我可以在 python 中调用函数:

import test
errmsg_buffer = 1024
_infile = 'test2.dat'
infile  = imstat.new_charArray(len(_infile))
for i in xrange(len(_infile)):
    imstat.charArray_setitem(infile,i,_infile[i])
maskfile = imstat.new_charArray(1)
imstat.charArray_setitem(maskfile,0,'')
check = 0
med = imstat.new_floatp()
errmsg = imstat.new_charArray(errmsg_buffer)

out = test.myfunction(infile,maskfile,check,med,errmsg)
median = test.floatp_value(med)

这有时有效，但通常无效 - 我遇到了很多段错误，这些错误通常通过更改 errmsg_buffer 长度来修复(显然不是一个有用的修复!)。更改 msg 字符串的 C 代码是:

(void)sprintf(errmsg,"file not found");

我的主要问题是正确处理 msg 字符串，我怀疑这是导致段错误的原因(并且可能是由于通过 new_charArray 实现不正确？)。

最好的方法是什么？

我可以向 .i 添加一些东西，将 char *msg 转换为 python str 吗？

这可以在不使用 new_CharArray 进行“预初始化”的情况下完成吗？如果 errmsg_buffer 太小，我可能会遇到缓冲区溢出。

我希望这是清楚的 - 很高兴为进一步讨论添加评论。

Answer 1

使用 SWIG 可以大大简化您的包装器。试试这个 SWIG 接口(interface)文件(详情如下):

%module test
%include "typemaps.i"
%include "cstring.i"
%apply float *OUTPUT { float *median };
%cstring_bounded_output(char *msg, 1024);
extern int myfunction(char *infile, char *maskfile, int check, float *median, char *msg);

然后，从 python 中，按以下方式使用该模块:

import test
infile = 'test2.dat'
maskfile = ''
check = 0
out, median, errmsg = test.myfunction(infile,maskfile,check)
if out == 0: print(errmsg)
...

但是，根据您所写的内容，我不太清楚为什么您的方法会出现段错误。

详情

• typemaps.i 文件包含 float *OUTPUT 类型映射，然后应用于 float *median 参数和将其从参数转换为 float 输出值。请参阅 argument handling 上的 SWIG 文档了解详情。

• cstrings.i 文件包含用于处理 C 字符串的 SWIG 宏。在这里，我使用了 %cstring_bounded_output 宏。这将创建一个给定大小为 1024 的 char * 缓冲区，并将其作为参数自动传递给 char *msg。然后，函数完成后的内容被转换为 python 字符串并附加到输出中。参见 here了解详情。

• SWIG 默认处理前两个 char * 参数，即将 python 字符串转换为适当的 char * 并传递它们。请注意，为这些参数传递的 char * 是不可变的，即，如果您的 myfunction 试图修改这些参数，就会发生不好的事情。了解 SWIG 如何处理 C 字符串 here .

• 因此，您包装的 myfunction 将如上所示使用，并在 python 中具有以下签名:myfunction(infile, maskfile, check) -> (out, median, msg)

编辑:

关于 carrays.i 的 SWIG 文档状态:

Note: %array_functions() and %array_class() should not be used with types of char or char *.

我认为您的代码没有正确创建以 NULL 结尾的 C char *，所以这可能会导致段错误。