使用SWIG处理C函数，将指针返回Java中的结构数组

Question

我试图弄清楚需要更改什么SWIG接口文件才能处理getFoo返回一个指向自定义结构数组（sender_id_t）的指针。没有任何特殊的SWIG接口代码，我只得到Java端的指针。如何将指针转换为可以循环或迭代的内容（在Java中），以便获取每个sender_id_t
id值？感谢任何建议。

C结构：

typedef unsigned char id_v1_t[32];
typedef id_v1_t id_t;
%rename (Sample) sender_id_t_;
struct sender_id_t_ {
    id_t       id;
    uint32_t   phy_idx;
};

C函数：

//This will return a pointer to an array of sender_id_t data.  The number of elements is retrieved from a separate call. 
sender_id_t* getFoo(resultset_t* resultset);

例外：

 [exec] test_wrap.c: In function `new_foo_array':
 [exec] test_wrap.c:785: error: invalid application of `sizeof' to incomplete type `sender_id_t_' 
 [exec] test_wrap.c: At top level:
 [exec] test_wrap.c:792: error: return type is an incomplete type
 [exec] test_wrap.c: In function `foo_array_getitem':
 [exec] test_wrap.c:793: error: invalid use of undefined type `struct sender_id_t_'
 [exec] test_wrap.c:793: error: dereferencing pointer to incomplete type
 [exec] test_wrap.c:793: warning: `return' with a value, in function returning void
 [exec] test_wrap.c: At top level:
 [exec] test_wrap.c:795: error: parameter `value' has incomplete type
 [exec] test_wrap.c: In function `foo_array_setitem':

Answer 1

最简单的解决方案不涉及编写任何JNI，实际上是方法2。因此，我要做的是使用carrays.i公开一个非常基本的接口，然后编写一点点Java以使它的public视图更实用/更直观。关键是您需要提供一种将数组知识
及其 长度汇总在一起的方法。我整理了一个最小的完整示例来说明，它返回一个Java数组，但它同样可以用于ArrayList您喜欢的一个或任何集合。

首先是头文件，其内联实现紧凑性：

#ifndef TEST_H
#define TEST_H

struct Foo {
   int v;
};

inline static struct Foo *getFoo() {
  static struct Foo r[] = {{0},{1},{2}};
  return r;
}

inline static unsigned short numFoo() {
  return 3;
}

#endif

然后将其包装为：

%module test

%{
#include "test.h"
%}

%include <carrays.i>
%array_functions(struct Foo, foo_array);

%rename(getFooImpl) getFoo;
%javamethodmodifiers getFoo() "private";
%javamethodmodifiers numFoo() "private";
%include "test.h"

%pragma(java) modulecode=%{
  public static Foo[] getFoo() {
    final int num = numFoo();
    Foo ret[] = new Foo[num];
    Foo result = getFooImpl();
    for (int i = 0; i < num; ++i) {
      ret[i] = foo_array_getitem(result, i);
    }
    return ret;
  }  
%}

我们getFoo()从头文件重命名，并使其与相应的numFoo() private，即实现细节。

然后，使用这两个私有函数，我们可以编写一个真正的，public Foo[] getFoo()调用这两个函数，然后将结果复制到已知大小的实际数组中。

我用以下方法对此进行了测试：

public class main {
  public static void main(String[] argv) {
    System.loadLibrary("test");
    Foo[] foos = test.getFoo();
    System.out.println(foos[2].getV());
  }
}

在我看来，该解决方案比相应的基于JNI的示例更干净-编写起来更简单，更难以引入错误，从而使其更易于维护。任何看过它的Java 或
C程序员几乎都能看到发生了什么。就性能而言，这可能并不太糟，并且在某些关键路径上可能不会花费大量时间-
如果基准测试表明这是一个问题，那么以后继续沿用JNI仍然很容易。

为了“制作private”方面的完整性，您可能还需要执行以下操作：

%javamethodmodifiers foo_array_getitem "private";
%ignore foo_array_setitem;
%ignore delete_foo_array;
%ignore new_foo_array;
%include <carrays.i>
%array_functions(struct Foo, foo_array);

隐藏所有由%array_functions宏生成的函数。