SWIG 类型映射以返回输出参数 char*/size_t

Question

我有一个使用字符串输出参数的 C API。 （为了保护无辜者，实际签名已更改。这是一个简单的例子。）

void func( char* buf, size_t buflen, char* buf2, size_t buf2len );

buf 和buflen 是有效的输出参数，其中buflen 和buf2len 是这些缓冲区（已经）分配的大小。

在调用代码中，我不想传入任何参数。相反，我希望返回字符串。

result1,result2 = func()

我不希望将缓冲区/大小传递给包装器函数，而是让它由包装器分配，转换为 Python 字符串，并在返回 Python 字符串之前解除分配。

我看到的大多数与此相关的cstring.i 类型映射都要求我为包装函数提供一个字符串。分配类型映射都需要char**。

我正在寻找类似于使用 OUTPUT 作为外参数名称的行为，但缓冲区/大小对是（单个）外参数。

我无权更改 API。我只是想让它易于使用。

是否已经有一个用于此的类型映射，或者你能帮我构建一个吗？

试用 1（仅限 Python）

我得到了这个功能（没有测试性能或内存使用情况）。

%typemap(in,numinputs=0)(char* mutable_buffer, size_t mutable_buffer_size) {
    $1 = malloc(sizeof(char)*4096);
    $1[0] = 0x0;
    $2 = 4096;
}
%typemap(argout)(char* mutable_buffer, size_t mutable_buffer_size) {
#ifdef SWIGPYTHON
    PyObject *o;
    $1[4095] = 0x0; // null-terminate it, just in case
    o = PyUnicode_FromString($1);
    resultobj = SWIG_Python_AppendOutput(resultobj,o);
#endif
}
%typemap(freearg)(char* mutable_buffer, size_t mutable_buffer_size) {
    free($1);
}

我更愿意在不求助于特定语言的修复的情况下解决这个问题。

Answer 1

由于您特别要求不需要任何特定语言来支持的解决方案，我建议使用%inline 来提供具有您喜欢的语法的func 的替代形式。应该这样做：

%module test

%rename(func) func_adjusted; 
%newobject func_adjusted();

%inline %{
  struct func1_out {
    // can make tuple syntax work here if you would rather, but likely having names is clearer anyway
    char buf1[4096];
    size_t buf1len;
    char buf2[4096];
    size_t buf2len;
  };

  // with the rename we pretend this is the C function, but really it is specific to our wrapper module.
  struct func1_out *func_adjusted() {
    struct func1_out *ret = malloc(sizeof *ret);
    // could also dynamically allocate buf1 and buf2 instead of fixed max size.
    func(buf1, &buf1len, buf2, &buf2len);
    return ret;
  }
%}

%ignore func;
%include "blahblah.h"

您可能希望对该结构中的 char buf1 和 buf2 数组做更多的工作，以使其对 Python 用户更自然，但这可以通过 carrays.i 或 @987654326 完成@ 将其全部保存在 C/SWIG 中，而不是 Python 特定的。

---

您还可以使用多参数类型映射来做一些不特定于您要包装的函数的事情。为避免特定于 Python，您可以使用 %append_output 从一个函数返回多个项目。虽然这不适用于 Java 或 C# 等静态类型语言，但它应该适用于大多数/所有动态类型语言。

为了进一步避免需要额外的、特定于语言的代码，我们可以使用 carrays.i，它会为我们定义的每种类型生成一些额外的函数。特别是我们使用ByteArray_cast、new_ByteArray 和delete_ByteArray 来处理我们可能遇到的相当多的情况。这应该适用于 C 和 C++ 情况。

%module test

%include <carrays.i>
%array_class(char, ByteArray);

%typemap(in,numinputs=0) (char* mutable_buffer, size_t mutable_buffer_size) (ByteArray *tmp=NULL) {
    // N.B. using new_ByteArray() here makes this work well with both C and C++ code
    tmp = new_ByteArray(4096);
    $1 = ByteArray_cast(tmp);
    $1[0] = 0x0;
    $2 = 4096;
}

%typemap(freearg) (char* mutable_buffer, size_t mutable_buffer_size) {
    // conditional is needed here as in some cases delete_ByteArray would dereference a null pointer
    if (tmp$argnum) delete_ByteArray(tmp$argnum);
}

%typemap(argout) (char* mutable_buffer, size_t mutable_buffer_size) {
   // Take ownership from in typemap
   %append_output(SWIG_NewPointerObj(SWIG_as_voidptr(tmp$argnum), $descriptor(ByteArray*), SWIG_POINTER_NEW));
   tmp$argnum = NULL;
}

%apply (char *mutable_buffer, size_t mutable_buffer_size) { (char *buf, size_t buflen), (char *buf2, size_t buf2len) };

%inline %{
void func(char* buf, size_t buflen, char* buf2, size_t buf2len) {
  strncpy(buf, "this is buffer1", buflen);
  strncpy(buf2, "this is buffer2", buf2len);
}
%}

在我的测试中，这与 Python 3.7 的预期效果一样。请注意，您需要使用 -builtin 参数运行 swig 以获得您在此处寻找的确切行为，或者需要额外的用户代码来解决问题：

a,b = test.func()
# needed for the non builtin case, I can't see a way to avoid that without Python specific code
aa=test.ByteArray_frompointer(a)
# for the -builtin case it just works though

---

这里没有太多简洁的界面选择，因为您的要求非常严格：

1. 无需求助于特定于语言的修复程序。
2. 我无权更改 API。我只是想让它易于使用。

考虑到这两个，没有多少可以使用。

虽然我个人倾向于编写一些特定于 Python 的 C，如果它使 Python 用户看到的界面更自然，即使这意味着不能 100% 地用另一种语言复制相同的界面。对于一些额外的语言特定工作，这里有很多更简洁的解决方案，通常会得到回报。

我认为 SWIG 的强大之处不是“一次编写，随处导入”，而是帮助您抽象和模块化直观界面的语言特定部分。