SWIG：如何包装 std::string&（通过引用传递的 std::string）

Question

我正在使用 SWIG 从 Java 访问 C++ 代码。

公开非常量引用传递的 std::string 参数的最简单方法是什么？

感谢 typemaps.i，我将通过引用传递的原语公开为 Java 数组，而 const std::string&s 公开为 java.lang.String，感谢 std_string.i。但是非常量 std::string& 暴露为不透明指针类型SWIGTYPE_p_std__string。

当前：

// C++ method                     -> // Java wrapper of C++ method
void foo( int & i )               -> public void foo( int[] i );    // OK
void bar( const std::string & s ) -> public void bar( String s );   // OK
void baz( std::string & s )       -> public void baz( SWIGTYPE_p_std__string s ); // :(

期望：

void foo( int & i )               -> public void foo( int[] i );    // OK
void bar( const std::string & s ) -> public void bar( String s );   // OK
void baz( std::string & s )       -> public void baz( String[] s ); // OK

更新：我找到了一个解决方案，如下所述。然而，这花费了比几秒钟更多的努力。我仍然有兴趣了解简单的方法。

Answer 1

我能找到的最佳方法是编写自己的类型图。我一直希望有一些琐碎的 SWIG 指令。

如果其他人需要这个，我就是这样做的。请记住，我不是 SWIG 专家。

首先，您需要定义一些类型映射以应用于 std::string& 参数。您只需定义一次。 （注意：在某些配置中可能需要额外的类型映射。）

%typemap(jni) std::string *INOUT, std::string &INOUT %{jobjectArray%}
%typemap(jtype) std::string *INOUT, std::string &INOUT "java.lang.String[]"
%typemap(jstype) std::string *INOUT, std::string &INOUT "java.lang.String[]"
%typemap(javain) std::string *INOUT, std::string &INOUT "$javainput"

%typemap(in) std::string *INOUT (std::string strTemp ), std::string &INOUT (std::string strTemp ) {
  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");
    return $null;
  }

  jobject oInput = JCALL2(GetObjectArrayElement, jenv, $input, 0); 
  if ( NULL != oInput ) {
    jstring sInput = static_cast<jstring>( oInput );

    const char * $1_pstr = (const char *)jenv->GetStringUTFChars(sInput, 0); 
    if (!$1_pstr) return $null;
    strTemp.assign( $1_pstr );
    jenv->ReleaseStringUTFChars( sInput, $1_pstr);  
  }

  $1 = &strTemp;
}

%typemap(freearg) std::string *INOUT, std::string &INOUT ""

%typemap(argout) std::string *INOUT, std::string &INOUT
{ 
  jstring jStrTemp = jenv->NewStringUTF( strTemp$argnum.c_str() );
  JCALL3(SetObjectArrayElement, jenv, $input, 0, jStrTemp ); 
}

接下来，对于每个这样的C++参数模式...

void foo( std::string & xyzzy );
void bar( std::string & xyzzy );
void baz( ..., std::string & xyzzy, ... );

...您使用此 SWIG 指令应用上面的类型映射：

%apply std::string &INOUT { std::string & xyzzy };

生成的绑定如下所示：

public void foo( java.lang.String[] xyzzy );
public void bar( java.lang.String[] xyzzy );
public void baz( ..., java.lang.String[] xyzzy, ... );

它们每个都需要一个单元素字符串数组。进入时，第一个元素可能为空。如果非空，则将其转换为 UTF-8 std::string 值并传递给 C++ 函数。退出时，通过引用传递的 std::string 的值从 UTF-8 转换回 Java 字符串。