java - C std::string 作为带有 SWIG 的 Java 中的输出参数

Question

<分区>

Answer 1

假设您想在不修改现有头文件的情况下包装它，可以想到两种方法。给定我用于测试的头文件:

#include <string>

inline bool method2(const std::string & name, const std::string & alias, std::string & resurnValue, std::string & returnType) {
  resurnValue = name;
  returnType = alias;
  return true;
}

包装它的最简单方法是使用 %inline 创建一个重载，将所有输出包装成一种类型:

%module test

%include <std_string.i>

%{
#include "test.h"
%}

%inline %{
  struct Method2Result {
    bool b;
    std::string s1;
    std::string s2;
  };

  Method2Result method2(const std::string& in1, const std::string& in2) {
    Method2Result ret;
    ret.b = method2(in1,in2,ret.s1,ret.s2);
    return ret;
  }
%}

// Optional: don't wrap the original form of method2 at all:
%ignore method2;

%include "test.h"

这适用于:

public class run {
  public static void main(String[] args) {
    System.loadLibrary("test");
    Method2Result ret = test.method2("foo", "bar");
    System.out.println(ret.getB() + " - " + ret.getS1() + ", " + ret.getS2());
  }
}

您可以将 std::pair 或 boost::tuple 与 %template 一起使用，但包装 boost::tuple 是非常重要的，我怀疑这样你就可以给成员命名一些你的图书馆的用户会理解的适当的东西，而不仅仅是 first 和 second，而不是使用%rename 这比在 %inline 中编写自定义结构更加冗长。

---

或者，SWIG 提供了 OUTPUT 类型映射，您可以将其与 %apply 一起使用来创建输出 argumnet。这些被包装为 1 个元素的数组 - 传递数组的语义与输出参数的语义相匹配。不幸的是，在 typemaps.i 中没有用于 std::string 的，所以我们必须自己编写。理想情况下，我会重新使用该文件中的 OUTPUT_TYPEMAP 宏，并且只是稍微修改了 argout 类型映射，但它得到了 #undefined，但这是不可能的。幸运的是，对于这种情况，只需复制和修改就相当简单:

%module test

%{
#include "test.h"
%}

%typemap(jstype) std::string& OUTPUT "String[]"
%typemap(jtype) std::string& OUTPUT "String[]"
%typemap(jni) std::string& OUTPUT "jobjectArray"
%typemap(javain)  std::string& OUTPUT "$javainput"
%typemap(in) std::string& OUTPUT (std::string temp) {
  if (!$input) {
    SWIG_JavaThrowException(jenv, SWIG_JavaNullPointerException, "array null");
    return $null;
  }
  if (JCALL1(GetArrayLength, jenv, $input) == 0) {
    SWIG_JavaThrowException(jenv, SWIG_JavaIndexOutOfBoundsException, "Array must contain at least 1 element");
  }
  $1 = &temp;
}
%typemap(argout) std::string& OUTPUT {
  jstring jvalue = JCALL1(NewStringUTF, jenv, temp$argnum.c_str()); 
  JCALL3(SetObjectArrayElement, jenv, $input, 0, jvalue);
}

%apply  std::string& OUTPUT { std::string & resurnValue }
%apply  std::string& OUTPUT { std::string & returnType }

%include "test.h"

这可以像这样使用:

public class run {
  public static void main(String[] args) {
    String[] out1 = new String[1];
    String[] out2 = new String[1];
    boolean retb = test.method2("foo", "bar", out1, out2);
    System.out.println(retb + " - " + out1[0] + ", " + out2[0]);
  }
}

这两个都在我的系统上进行了测试和工作。对于这个例子，我喜欢 %inline 方法。 (如果它是一个成员函数，您将使用 %extend 代替)。不过，在一般情况下，无需编写任何额外代码即可应用 OUTPUT 类型映射。