如何定义 swig 类型映射以将 unsigned char* 返回到 java

Posted 2023-02-16

【中文标题】如何定义 swig 类型映射以将 unsigned char* 返回到 java

【英文标题】：How to define swig typemap for returning unsigned char* back to java

【发布时间】：2012-07-19 15:38:00

【问题描述】：

我有一个 Java 应用程序，它调用一个 c 库来执行加密功能。 这是一个用 c 实现的自定义库，我们需要从一些 Java 程序中使用它。 我需要一种方法来定义一个 SWIG 类型映射，它允许我调用一个从 Java 传递字节数组的函数，并将其视为 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 函数的调用会给我一个缓冲区，但根据生成的代码，它会给我一个“短”。 （见代码中的cmets）

---

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);

我想我应该将我的接口定义更改为如下所示，我将第三个参数设为 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);

【参考方案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，但它实际上是一个搜索和替换来改变它）。

【讨论】：

一个补充问题 - 在***.com/a/10949956/168175 的示例中，您提到我可以编写一个以长度为参数的类型映射 - 例如

@YogeshDevi - 希望稍后我会写一个答案

柔印，一个补充问题 - 在***.com/a/10949956/168175 的示例中，您提到我可以编写一个以长度为参数的类型图。你能否举一个类型映射的例子，它允许我从 java 调用一个 c 函数 foo( char * buf , int buflen) ，我使用 buflen 来定义我以任何一种方式复制多少字节（Java 到 c 和 C 到 Java ? 再次感谢 :-)

@YogeshDevi - 因为时间很长，我问并回答为here in my own Q&A。