java - SWIG Java 保留从 C++ 弹回的对象的类信息

Question

好吧，有一个关键字我特意避开了标签和标题。那是“Android”，但那是因为即使该项目是在 Android 中，我认为我的问题与它无关，我不想吓到没有 Android 经验的人。

所以，swig 的常见问题。我在 C++ 类中有一个虚拟方法，我通过添加 director 使其在 Java 中可重载类的功能并且有效。问题在于该方法接收一个多态参数，该参数也在 Java 端进行了扩展，并且在 Java 中的虚方法调用期间，该对象附带了所有多态信息。

呈现确切的情况；我正在用C++写一个游戏引擎，我想在Java中愉快地使用它。游戏引擎有一个 GameObject类，注册 CollisionListener s，当碰撞引擎检测到碰撞事件时，它会调用 collidedWith(GameObject & collidee)所有注册的方法collisionListener让他们与他们碰撞的物体一起传递。

class CollisionListener {
public:
    virtual bool collidedWith(GameObject &){};
    ~CollisionListener(){} // I know this needs to be virtual but let's forget about that now
};

我公开了这个类，连同 GameObject使用以下接口(interface)文件将类添加到 java Bridge.i

%module(directors="1") Bridge

%feature("director") CollisionListener;
%include "CollisionListener";
%feature("director") GameObject;
%include "GameObject.h"

现在，当我从 CollisionListener 继承时在 Java 中重载 collidedWith , 它被称为 java 端 GameObject目的。例如，如果我从 java 端继承 GameObject类并定义一个 Bullet类，当此子弹与另一个带有监听器的对象碰撞时，在 collidedWith 中方法调用，我收到的只是一个空的 GameObject ，所以 (object instanceof Bullet)不起作用。毫不奇怪，我深入研究了生成的 swig BridgeJNI.java并发现了这个:

  public static boolean SwigDirector_CollisionListener_collidedWith(CollisionListener self, long arg0) {
    return self.collidedWith(new GameObject(arg0, false));
  }

因此它在调用 java 重载之前围绕指针包装了一个新对象。

所以，主要问题是如何接收 Bullet碰撞时的对象？

我想出了一个轻松实现该目标的方法，但我需要修改自动生成的文件，这是个坏主意。所以我希望一些 swig 大师可以帮助我将修改注入(inject)到 swig 生成的文件中。

我的小窍门是保留一个 jobject * self在每个 C++ 端 GameObject object，并在real java端构造时赋值real java对象的地址GameObject (而不是仅仅包装指针的那个)。这样，我可以定义一个多态的 getSelf C++ 端的方法 GameObject并在java中愉快地使用结果。有没有办法将必要的代码注入(inject)到 swig 生成的文件中？

谢谢

注意:如果您在 Android 上尝试过 directors 但没有成功，那是因为当前的稳定版本不支持它。从 swig 网站下载 Bleeding Edge。但我是在 2012 年 3 月 22 日写这篇文章的，很快就不需要这篇笔记了。析构函数不是虚拟的原因是出血边缘版本使程序在析构函数中崩溃，并且将其非虚拟化似乎暂时可以控制它。

Answer 1

我已经为这个问题制定了一个解决方案。不过，这并不是您在问题中建议的解决方案，它是 Java 端的更多代码，而 JNI/C++ 端没有额外的代码。 (我发现按照您建议的方式进行操作很难在所有可能的情况下都正确)。

我将您的类简化为单个头文件:

class GameObject {
};

class CollisionListener {
public:
    virtual bool collidedWith(GameObject &) { return false; }
    virtual ~CollisionListener() {} 
};

inline void makeCall(GameObject& o, CollisionListener& c) {
    c.collidedWith(o);
}

其中还添加了 makeCall 以实际使问题变得明显。

我使用的技巧是在创建时自动在 HashMap 中注册 GameObject 的所有 Java 派生实例。然后在调度 director 调用时，只需在 HashMap 中查找它即可。

然后是模块文件:

%module(directors="1") Test

%{
#include "test.hh"
%}

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

/* Pretty standard so far, loading the shared object 
   automatically, enabling directors and giving the module a name. */    

// An import for the hashmap type
%typemap(javaimports) GameObject %{
import java.util.HashMap;
import java.lang.ref.WeakReference;
%}

// Provide a static hashmap, 
// replace the constructor to add to it for derived Java types
%typemap(javabody) GameObject %{
  private static HashMap<Long, WeakReference<$javaclassname>> instances 
                        = new HashMap<Long, WeakReference<$javaclassname>>();

  private long swigCPtr;
  protected boolean swigCMemOwn;

  public $javaclassname(long cPtr, boolean cMemoryOwn) {
    swigCMemOwn = cMemoryOwn;
    swigCPtr = cPtr;
    // If derived add it.
    if (getClass() != $javaclassname.class) {
      instances.put(swigCPtr, new WeakReference<$javaclassname>(this));
    }
  }

  // Just the default one
  public static long getCPtr($javaclassname obj) {
    return (obj == null) ? 0 : obj.swigCPtr;
  }

  // Helper function that looks up given a pointer and 
  // either creates or returns it
  static $javaclassname createOrLookup(long arg) {
    if (instances.containsKey(arg)) {
      return instances.get(arg).get();
    }
    return new $javaclassname(arg,false);
  }
%}

// Remove from the map when we release the C++ memory
%typemap(javadestruct, methodname="delete", 
         methodmodifiers="public synchronized") GameObject {
  if (swigCPtr != 0) {
    // Unregister instance
    instances.remove(swigCPtr);
    if (swigCMemOwn) {
      swigCMemOwn = false;
      $imclassname.delete_GameObject(swigCPtr);
    }
    swigCPtr = 0;
  }
}

// Tell SWIG to use the createOrLookup function in director calls.
%typemap(javadirectorin) GameObject& %{
    $javaclassname.createOrLookup($jniinput)
%}
%feature("director") GameObject;

// Finally enable director for CollisionListener and include the header
%feature("director") CollisionListener;    
%include "test.hh"

请注意，由于所有 Java 实例都存储在 HashMap 中，我们需要使用 WeakReference 来确保我们不会延长它们的生命并阻止垃圾收集从发生。如果您关心线程，请酌情添加同步。

我测试了这个:

public class main {
  public static void main(String[] argv) {
    JCollisionListener c = new JCollisionListener();
    JGameObject o = new JGameObject();
    c.collidedWith(o);  
    Test.makeCall(o,c);
  }
}

JCollisionListener 是:

public class JCollisionListener extends CollisionListener {
  public boolean collidedWith(GameObject i) {
    System.out.println("In collide");
    if (i instanceof JGameObject) {
       System.out.println("Is J");
    }
    else {
       System.out.println("Not j");
    }
    JGameObject o = (JGameObject)i;
    return false;
  }
}

和JGameObject是:

public class JGameObject extends GameObject {
}

(作为引用，如果您想采用其他方法，您可以考虑编写一个 directorin 类型映射)。