SWIG: 如何包装 std::string& (std::string 通过引用传递)

2022-09-04 22:26:03

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

公开由非 const 引用传递的 std::string 参数的最简单方法是什么?

由于typemaps.i,我通过引用传递的原语公开为Java数组,并且由于std_string.i,s公开为,则作为。但是一个非 const std::string& 被公开为不透明的指针类型 。const std::string&java.lang.StringSWIGTYPE_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

更新:我找到了一个解决方案,如下所述。但是,它花费了比几秒钟更多的努力。我仍然有兴趣听到简单的方法。


答案 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::字符串的值将从 UTF-8 转换回 Java 字符串。


答案 2

推荐