]> sigrok.org Git - libsigrok.git/blobdiff - bindings/java/org/sigrok/core/classes/classes.i
Java: Fix leaking global refs
[libsigrok.git] / bindings / java / org / sigrok / core / classes / classes.i
index 7e1919e2dce0b1864272dd6d9e5de4df604d5362..dda333df09dc7762a6057779f93abede14995e91 100644 (file)
@@ -72,7 +72,7 @@ namespace Glib {
   jclass Value = jenv->FindClass("org/sigrok/core/classes/" #JValue);
   jmethodID Value_init = jenv->GetMethodID(Value, "<init>", "(JZ)V");
   $result = jenv->NewObject(Vector, Vector_init);
-  jlong value;
+  jlong value = 0;
   for (auto entry : $1)
   {
     *(CValue **) &value = new CValue(entry);
@@ -146,7 +146,7 @@ MAP_COMMON(std::string, std::shared_ptr<sigrok::ClassName>, String, ClassName)
   jclass Value = jenv->FindClass("org/sigrok/core/classes/" #ClassName);
   jmethodID Value_init = jenv->GetMethodID(Value, "<init>", "(JZ)V");
   $result = jenv->NewObject(HashMap, HashMap_init);
-  jlong value;
+  jlong value = 0;
   for (auto entry : $1)
   {
     *(std::shared_ptr< sigrok::ClassName > **)&value =
@@ -181,8 +181,8 @@ MAP_COMMON(const sigrok::ConfigKey *, Glib::VariantBase, ConfigKey, Variant)
   jclass Variant = jenv->FindClass("org/sigrok/core/classes/Variant");
   jmethodID Variant_init = jenv->GetMethodID(Variant, "<init>", "(JZ)V");
   $result = jenv->NewObject(HashMap, HashMap_init);
-  jlong key;
-  jlong value;
+  jlong key = 0;
+  jlong value = 0;
   for (auto entry : $1)
   {
     *(const sigrok::ConfigKey **) &key = entry.first;
@@ -193,77 +193,117 @@ MAP_COMMON(const sigrok::ConfigKey *, Glib::VariantBase, ConfigKey, Variant)
   }
 }
 
-/* Support Driver.scan() with no arguments. */
-%ignore sigrok::Driver::scan;
+/* Specialisation for ConfigKey->set<Capability> maps */
 
-%extend sigrok::Driver {
-  std::vector<std::shared_ptr<sigrok::HardwareDevice> > scan()
-  {
-    std::map<const sigrok::ConfigKey *, Glib::VariantBase> options;
-    return $self->scan(options);
-  }
+MAP_COMMON(const sigrok::ConfigKey *, std::set<enum sigrok::Capability>,
+  ConfigKey, java.util.Set<Capability>)
+
+%typemap(jni) std::map<const sigrok::ConfigKey *, std::set<enum sigrok::Capability> > "jobject"
+%typemap(jtype) std::map<const sigrok::ConfigKey *, std::set<enum sigrok::Capability> >
+  "java.util.Map<ConfigKey,java.util.Set<Capability>>"
 
-  std::vector<std::shared_ptr<sigrok::HardwareDevice> > scan(
-    std::map<const sigrok::ConfigKey *, Glib::VariantBase> options)
+%typemap(out) std::map<const sigrok::ConfigKey *, std::set<enum sigrok::Capability> > {
+  jclass HashMap = jenv->FindClass("java/util/HashMap");
+  jmethodID HashMap_init = jenv->GetMethodID(HashMap, "<init>", "()V");
+  jmethodID HashMap_put = jenv->GetMethodID(HashMap, "put",
+    "(Ljava/lang/Object;Ljava/lang/Object;)Ljava/lang/Object;");
+  jclass HashSet = jenv->FindClass("java/util/HashSet");
+  jmethodID HashSet_init = jenv->GetMethodID(HashSet, "<init>", "()V");
+  jmethodID HashSet_add = jenv->GetMethodID(HashSet, "add",
+    "(Ljava/lang/Object;Ljava/lang/Object;)Ljava/lang/Object;");
+  jclass ConfigKey = jenv->FindClass("org/sigrok/core/classes/ConfigKey");
+  jmethodID ConfigKey_init = jenv->GetMethodID(ConfigKey, "<init>", "(JZ)V");
+  jclass Capability = jenv->FindClass("org/sigrok/core/classes/Capability");
+  jmethodID Capability_swigToEnum = jenv->GetStaticMethodID(Capability,
+    "swigToEnum", "(I)Lorg/sigrok/core/classes/Capability;");
+  $result = jenv->NewObject(HashMap, HashMap_init);
+  jlong key = 0;
+  for (auto map_entry : $1)
   {
-    return $self->scan(options);
+    *(const sigrok::ConfigKey **) &key = map_entry.first;
+    jobject value = jenv->NewObject(HashSet, HashSet_init);
+    for (auto &set_entry : map_entry.second)
+      jenv->CallObjectMethod(value, HashSet_add,
+        jenv->CallStaticObjectMethod(Capability,
+          Capability_swigToEnum, set_entry));
+    jenv->CallObjectMethod($result, HashMap_put,
+      jenv->NewObject(ConfigKey, ConfigKey_init, key, false), value);
   }
 }
 
-/* Support InputFormat.create_input() with or without options. */
-%ignore sigrok::InputFormat::create_input;
+/* Pass JNIEnv parameter to C++ extension methods requiring it. */
 
-%extend sigrok::InputFormat {
-  std::shared_ptr<sigrok::Input> create_input()
-  {
-    return $self->create_input();
-  }
+%typemap(in, numinputs=0) JNIEnv * %{
+   $1 = jenv;
+%} 
 
-  std::shared_ptr<sigrok::Input> create_input(
-    std::map<std::string, Glib::VariantBase> options)
-  {
-    return $self->create_input(options);
+/* Thread safe JNIEnv handling */
+
+%inline {
+namespace {
+  class ScopedEnv {
+    public:
+      ScopedEnv(JavaVM *jvm);
+      ScopedEnv(const ScopedEnv &ref) = delete;
+      ~ScopedEnv();
+      JNIEnv* operator-> () { return env; }
+      operator bool () const { return (bool)env; }
+    private:
+      JavaVM *jvm;
+      JNIEnv *env;
+      int env_status;
+  };
+  ScopedEnv::ScopedEnv(JavaVM *jvm) : jvm(jvm), env(NULL) {
+    env_status = jvm->GetEnv((void **)&env, JNI_VERSION_1_2);
+    if (env_status == JNI_EDETACHED) {
+%#if defined(__ANDROID__)
+      jvm->AttachCurrentThread(&env, NULL);
+%#else
+      jvm->AttachCurrentThread((void **)&env, NULL);
+%#endif
+    }
+  }
+  ScopedEnv::~ScopedEnv() {
+    if (env_status == JNI_EDETACHED) {
+      jvm->DetachCurrentThread();
+    }
   }
 }
+}
 
-/* Support OutputFormat.create_output() with or without options. */
-%ignore sigrok::OutputFormat::create_output;
+/* "Smartpointer" for Java references. */
 
-%extend sigrok::OutputFormat {
-  std::shared_ptr<sigrok::Output> create_output(
-    std::shared_ptr<sigrok::Device> device)
+%inline {
+namespace {
+  class GlobalRefBase
   {
-    return $self->create_output(device);
+    protected:
+      GlobalRefBase (JavaVM *jvm, jobject ref);
+      GlobalRefBase (const GlobalRefBase &ref) = delete;
+      ~GlobalRefBase ();
+      JavaVM *jvm;
+      jobject jref;
+  };
+  GlobalRefBase::GlobalRefBase (JavaVM *jvm, jobject ref) : jvm(jvm), jref(0) {
+    ScopedEnv env(jvm);
+    if (env && ref)
+      jref = env->NewGlobalRef(ref);
   }
-
-  std::shared_ptr<sigrok::Output> create_output(
-    std::shared_ptr<sigrok::Device> device,
-    std::map<std::string, Glib::VariantBase> options)
-  {
-    return $self->create_output(device, options);
+  GlobalRefBase::~GlobalRefBase () {
+    ScopedEnv env(jvm);
+    if(env && jref)
+      env->DeleteGlobalRef(jref);
   }
-
-  std::shared_ptr<sigrok::Output> create_output(
-    std::string filename,
-    std::shared_ptr<sigrok::Device> device)
+  template <class Jtype>
+  class GlobalRef : private GlobalRefBase
   {
-    return $self->create_output(filename, device);
-  }
-
-  std::shared_ptr<sigrok::Output> create_output(
-    std::string filename,
-    std::shared_ptr<sigrok::Device> device,
-    std::map<std::string, Glib::VariantBase> options)
-  {
-    return $self->create_output(filename, device, options);
-  }
+    public:
+      GlobalRef (JavaVM *jvm, Jtype ref) : GlobalRefBase(jvm, ref) {}
+      GlobalRef (const GlobalRef &ref) : GlobalRefBase(ref.jvm, ref.jref) {}
+      operator Jtype () const { return static_cast<Jtype>(jref); }
+  };
+}
 }
-
-/* Pass JNIEnv parameter to C++ extension methods requiring it. */
-
-%typemap(in, numinputs=0) JNIEnv * %{
-   $1 = jenv;
-%} 
 
 /* Support Java log callbacks. */
 
@@ -283,19 +323,23 @@ typedef jobject jlogcallback;
 {
   void add_log_callback(JNIEnv *env, jlogcallback obj)
   {
+    JavaVM *jvm = NULL;
+    env->GetJavaVM(&jvm);
     jclass obj_class = env->GetObjectClass(obj);
     jmethodID method = env->GetMethodID(obj_class, "run",
       "(Lorg/sigrok/core/classes/LogLevel;Ljava/lang/String;)V");
-    jclass LogLevel = (jclass) env->NewGlobalRef(
-        env->FindClass("org/sigrok/core/classes/LogLevel"));
+    GlobalRef<jclass> LogLevel(jvm, env->FindClass("org/sigrok/core/classes/LogLevel"));
     jmethodID LogLevel_init = env->GetMethodID(LogLevel, "<init>", "(JZ)V");
-    jobject obj_ref = env->NewGlobalRef(obj);
+    GlobalRef<jobject> obj_ref(jvm, obj);
 
     $self->set_log_callback([=] (
       const sigrok::LogLevel *loglevel,
       std::string message)
     {
-      jlong loglevel_addr;
+      ScopedEnv env(jvm);
+      if (!env)
+        throw sigrok::Error(SR_ERR);
+      jlong loglevel_addr = 0;
       *(const sigrok::LogLevel **) &loglevel_addr = loglevel;
       jobject loglevel_obj = env->NewObject(
         LogLevel, LogLevel_init, loglevel_addr, false);
@@ -325,23 +369,26 @@ typedef jobject jdatafeedcallback;
 {
   void add_datafeed_callback(JNIEnv *env, jdatafeedcallback obj)
   {
+    JavaVM *jvm = NULL;
+    env->GetJavaVM(&jvm);
     jclass obj_class = env->GetObjectClass(obj);
     jmethodID method = env->GetMethodID(obj_class, "run",
       "(Lorg/sigrok/core/classes/Device;Lorg/sigrok/core/classes/Packet;)V");
-    jclass Device = (jclass) env->NewGlobalRef(
-        env->FindClass("org/sigrok/core/classes/Device"));
+    GlobalRef<jclass> Device(jvm, env->FindClass("org/sigrok/core/classes/Device"));
     jmethodID Device_init = env->GetMethodID(Device, "<init>", "(JZ)V");
-    jclass Packet = (jclass) env->NewGlobalRef(
-       env->FindClass("org/sigrok/core/classes/Packet"));
+    GlobalRef<jclass> Packet(jvm, env->FindClass("org/sigrok/core/classes/Packet"));
     jmethodID Packet_init = env->GetMethodID(Packet, "<init>", "(JZ)V");
-    jobject obj_ref = env->NewGlobalRef(obj);
+    GlobalRef<jobject> obj_ref(jvm, obj);
 
     $self->add_datafeed_callback([=] (
       std::shared_ptr<sigrok::Device> device,
       std::shared_ptr<sigrok::Packet> packet)
     {
-      jlong device_addr;
-      jlong packet_addr;
+      ScopedEnv env(jvm);
+      if (!env)
+        throw sigrok::Error(SR_ERR);
+      jlong device_addr = 0;
+      jlong packet_addr = 0;
       *(std::shared_ptr<sigrok::Device> **) &device_addr =
         new std::shared_ptr<sigrok::Device>(device);
       *(std::shared_ptr<sigrok::Packet> **) &packet_addr =
@@ -359,20 +406,13 @@ typedef jobject jdatafeedcallback;
 
 %include "doc.i"
 
-%define %attributevector(Class, Type, Name, Get)
-%attributeval(sigrok::Class, Type, Name, Get);
-%enddef
-
-%define %attributemap(Class, Type, Name, Get)
-%attributeval(sigrok::Class, Type, Name, Get);
-%enddef
-
 %define %enumextras(Class)
 %enddef
 
 /* Ignore these for now, need fixes. */
 %ignore sigrok::Context::create_analog_packet;
 %ignore sigrok::Context::create_meta_packet;
+%ignore sigrok::Meta::config;
 
 %include "bindings/swig/classes.i"