使用 SWIG 用两个双向参数包装 function 以在 java [foo(char ** strs, unsigned int& size)] 中使用

Question

我正在使用 SWIG 4.0.2 包装一个 C++ 库，以便从 Java 代码中使用。 其中一个类有一个棘手的 function 我很难包装：

class Bar {
...
public:
    Status foo(char **strs, unsigned int& size);
    ...
}

打算使用“foo”的方式是分配一个字符串数组并调用 function 给它数组和其中的元素数量。 function 将用 null 终止的字符串填充数组，并修改“size”参数以匹配它填充的元素数量（如果它写入的元素数量少于最大元素数量）。

使用示例：

#define MAX_STR_LENGTH 16 // Max string length is known

unsigned int numElements = 5;
char** strs= new char*[numElements];
for (unsigned int i=0; i<numElements; ++i) {
    strs[i] = new char[MAX_STR_LENGTH];
}

Status status = bar.foo(strs, numElements);

if (status == Success) {
    for (unsigned int i=0; i<numElements; ++i) {
        std::cout << strs[i] << std::endl;
    }
}

对于 Java function 签名的外观，我很灵活，但我需要能够在调用 foo() 后以某种方式提取字符串。

PS：“Bar”实际上是一个大的 class，到目前为止 SWIG 为我做了很好的包装，所以我不想不得不手动将它包装在 JNI 代码中。

Answer 1

我终于找到了解决方案。 完整的解决方案实际上是从 SWIG 自己的various.i文件中提取的代码的混合，稍加调整以处理“char **strs”参数并为其他参数应用现有类型映射。

以下是来自.i 文件的相关代码：

%typemap(jni) char **STRING_IN_OUT "jobjectArray"
%typemap(jtype) char **STRING_IN_OUT "String[]"
%typemap(jstype) char **STRING_IN_OUT "String[]"
%typemap(in) char **STRING_IN_OUT (jint size) {
  int i = 0;
  if ($input) {
    size = JCALL1(GetArrayLength, jenv, $input);
#ifdef __cplusplus
    $1 = new char*[size+1];
#else
    $1 = (char **)malloc((size+1) * sizeof(char *));
#endif
    for (i = 0; i<size; i++) {
      jstring j_string = (jstring)JCALL2(GetObjectArrayElement, jenv, $input, i);
      const char *c_string = JCALL2(GetStringUTFChars, jenv, j_string, 0);
#ifdef __cplusplus
      $1[i] = new char [strlen(c_string)+1];
#else
      $1[i] = (char *)malloc((strlen(c_string)+1) * sizeof(const char *));
#endif
      strcpy($1[i], c_string);
      JCALL2(ReleaseStringUTFChars, jenv, j_string, c_string);
      JCALL1(DeleteLocalRef, jenv, j_string);
    }
    $1[i] = 0;
  } else {
    $1 = 0;
    size = 0;
  }
}

%typemap(argout) char **STRING_IN_OUT {
  for (int i=0; i< (int) size$argnum; i++) {
    jstring jnewstring = NULL;
    jnewstring = JCALL1(NewStringUTF, jenv, $1[i]);
    JCALL3(SetObjectArrayElement, jenv, $input, i, jnewstring); 
  }
}

%typemap(freearg) char **STRING_IN_OUT {
  int i;
  for (i=0; i<size$argnum; i++)
#ifdef __cplusplus
    delete[] $1[i];
  delete[] $1;
#else
  free($1[i]);
  free($1);
#endif
}

%typemap(out) char **STRING_IN_OUT {
  if ($1) {
    int i;
    jsize len=0;
    jstring temp_string;
    const jclass clazz = JCALL1(FindClass, jenv, "java/lang/String");

    while ($1[len]) len++;
    $result = JCALL3(NewObjectArray, jenv, len, clazz, NULL);
    /* exception checking omitted */

    for (i=0; i<len; i++) {
      temp_string = JCALL1(NewStringUTF, jenv, *$1++);
      JCALL3(SetObjectArrayElement, jenv, $result, i, temp_string);
      JCALL1(DeleteLocalRef, jenv, temp_string);
    }
  }
}

%typemap(javain) char **STRING_IN_OUT "$javainput"
%typemap(javaout) char **STRING_IN_OUT {
    return $jnicall;
  }

%apply char **STRING_IN_OUT { char** strs}

%include "typemaps.i"
%apply unsigned int& INOUT { unsigned int& size}

这是我从 Java 中调用它的方式：

// For now, this is how I tell the JNI how many buffers to allocate and their length
// I Will probably look for a way to work around this useless allocation in the future.
String[] strs = new String[MAX_NUMBER_STRINGS];
for (int i = 0 ; i < strs.length ; ++i) {
  strs[i] = new String(new char[BUFFER_LENGTH]);
}

long[] numOfIds = new long[]{MAX_NUMBER_STRINGS};
Status s = m_faceAuthenticator.QueryUserIds(strs, numOfIds);

我花了很多时间来解决它。