SWIG Java保留從C ++反彈的對象的類信息

Question

好的，有一個關鍵字，我故意遠離標簽和標題。 這是“Android”，但那是因為即使該項目是在Android中，我也不認為我的問題與它有任何關系，我不想在沒有Android經驗的情況下嚇唬人。

所以，swig的常見問題。 我在C ++類中有一個虛方法，我通過在類中添加director功能使其在Java中可重載，並且它可以工作。 問題是該方法接收的多態參數也在java端擴展，並且在Java中的虛方法調用期間，該對象帶有所有多態信息被剝離。

提出確切的情況; 我正在用C ++編寫游戲引擎，我想在Java中愉快地使用它。 游戲引擎有一個GameObject類，它注冊CollisionListener ，當碰撞引擎檢測到碰撞事件時，它會調用所有已注冊的collisionListener的collidedWith(GameObject & collidee)方法，並將它們與它們碰撞的對象一起傳遞。

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

我揭露這個類，與一起GameObject使用下面的接口文件類的Java Bridge.i

%module(directors="1") Bridge

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

現在，當我從java中的CollisionListener繼承並重載collidedWith ，它會被一個java端GameObject對象調用。 例如，如果我從java端繼承GameObject類並定義一個Bullet類，當這個項目符號與另一個帶有監聽器的對象collidedWith ，在collidedWith方法調用中，我收到的只是一個裸GameObject (object instanceof Bullet) ，因此(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 master可以幫助我對swig生成的文件進行修改。

我的小黑客是在每個C ++端GameObject對象中保留一個jobject * self ，並在構造真正的java端GameObject期間分配真實java對象的地址（而不是僅僅包裝指針的那個）。 這樣，我可以定義一個多態getSelf在C ++側方法GameObject和在Java愉快地使用的結果。 有沒有辦法將必要的代碼注入swig生成的文件？

謝謝

注意：如果您在Android上嘗試過導演但他們沒有工作，那是因為當前的穩定版本不支持它。 從swig網站下載Bleeding Edge。 但是我在2012年3月22日寫這篇文章很快就沒必要了。 析構函數不是虛擬的原因是Bleeding Edge版本使程序在析構函數中崩潰，並使其成為非虛擬似乎現在可以控制它。

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派生實例。 然后在調度導演時調用它只是在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 typemap）。