java - 如何定义 swig typemap 以将 unsigned char* 返回给 java

Question

我有一个 Java 应用程序调用 c 库来执行加密功能。这是一个用 c 实现的自定义库，我们需要从一些 Java 程序中使用它。我需要一种方法来定义 SWIG 类型映射，它允许我从 Java 调用一个传递 bytearray 的函数，并将其视为 C 函数中的无符号字符指针，其中 c 函数填充数据并将其返回给 java

我目前不开心的界面文件摘录如下

%module  CryptoFacade

%pointer_functions(int, intp);
%pointer_functions(unsigned char, unsigned_charp);

int enCrypt(char* clearText, int clearLen,unsigned char* retCipherText, int *retCipherLen);

---

我不开心的 Java 代码摘录如下。在下面的代码中，我预计对 enCrypt 函数的调用会给我一个缓冲区，但它会根据生成的代码给我一个“短”。 (见代码中的注释)

---

class MainLoader {
static {
     System.loadLibrary("dccasecuJ"); //Load my crypto library
}

 public static void main(String[] args) {

 // Define the parameters to be passed by reference 
 SWIGTYPE_p_int retCipherLen=CryptoFacade.new_intp();
 SWIGTYPE_p_unsigned_char retCipherText =
            CryptoFacade.new_unsigned_charp();

CryptoFacade myFacade=new CryptoFacade();   

// Call crypto library function. First two are value parameters, next two are return
myFacade.enCrypt("STRING-TO-ENCRYPT", 17, retCipherText, retCipherLen);

// The length I get back in fourth parameter is just fine 
int gotLen= CryptoFacade.intp_value(retCipherLen); 

//The value I get for the Ciphertext though is a "short" ... no good 
// I need a byte[] in java that has the ciphertext
short gotText= CryptoFacade.unsigned_charp_value(retCipherText);

我想我应该将我的接口(interface)定义更改为如下所示，其中我将第三个参数设置为 jbytearray，然后我必须实现一个类型映射，它将 C 程序中无符号字符指针指向的内容复制到 java bytearray。

如果我必须将内容的长度指定为 256 字节，我完全没问题，因为处理任意长度可能很棘手。

有人能告诉我在哪里可以找到这样的类型图吗(我是 SWIG 的新手，没有编写类型图的经验)

%module  CryptoFacade

%pointer_functions(int, intp);
%pointer_functions(unsigned char, unsigned_charp);

int enCrypt(char* clearText, int clearLen, jbyteArray retCipherText, int *retCipherLen);

Answer 1

在 Java 中处理字节数组的最简单方法是使用 %array_class(或 %array_functions)，类似于 %pointer_functions但对于整个数组，而不仅仅是单个元素。我为您整理了一个完整的示例，使用这个头文件作为测试:

inline void foo(unsigned char *bytearr) {
  bytearr[0] = 1;
  bytearr[1] = 2;
  bytearr[2] = 3;
  bytearr[3] = 100;
}

我们可以用 SWIG 包装它:

%module test

%{
#include "test.h"
%}

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

%include "test.h"

// Emit Java code to automatically load the shared library
%pragma(java) jniclasscode=%{
  static {
    try {
        System.loadLibrary("test");
    } catch (UnsatisfiedLinkError e) {
      System.err.println("Native code library failed to load. \n" + e);
      System.exit(1);
    }
  }
%}

我也整理了一些Java来练习这个功能:

public class run {
  public static void main(String[] argv) {
    ByteArr arr = new ByteArr(4); // Initial size 4
    // You could set some values before passing in if you wanted to.
    test.foo(arr.cast());
    System.out.println(arr.getitem(0) + ", " + arr.getitem(1) + ", " + arr.getitem(2) + ", " + arr.getitem(3));
  }
}

编译并运行。请注意，C 或 C++ 中的 unsigned char 在 Java 中表示为 short - Java 没有任何无符号类型，因此适合 0-255 范围的最小类型是短。 byte 默认不覆盖它。 (您可以通过其他方式将 unsigned char 重新映射到 byte 来玩游戏，但这远非直观，因此默认情况下不这样做)。

如果你愿意，你可以做更高级的事情。例如if you know the size of the array you can use arrays_java.i . This example使用 JNI 创建类型映射以返回 unsigned char 数组。 This example展示了如何使用 JNI 类型映射将数组传递给函数。 (它使用 long 而不是 byte，但它实际上是一种搜索和替换来改变它)。