Convert plugin-related classes to use scoped helpers (see issue chromiumembedded#167)

magreenblatt · magreenblatt · commit e8e7b8270068 · 2019-08-28T13:53:05.000-04:00
- CefWebPluginManager does not need to implement CefNative.
diff --git a/java/org/cef/callback/CefWebPluginInfoVisitor.java b/java/org/cef/callback/CefWebPluginInfoVisitor.java
@@ -7,15 +7,19 @@
 import org.cef.network.CefWebPluginInfo;
 
 /**
- * Interface to implement for visiting web plugin information. The methods of
- * this class will be called on the browser process UI thread.
+ * Interface to implement for visiting web plugin information. The methods of this class will be
+ * called on the browser process UI thread.
  */
 public interface CefWebPluginInfoVisitor {
     /**
-     * Method that will be called once for each plugin. |count| is the 0-based
-     * index for the current plugin. |total| is the total number of plugins.
-     * Return false to stop visiting plugins. This method may never be called if
-     * no plugins are found.
+     * Method that will be called once for each plugin. This method may never be called if no
+     * plugins are found.
+     *
+     * @param info Information for the current plugin. Instance only valid within the scope of this
+     *         method.
+     * @param count The 0-based index for the current plugin.
+     * @param total The total number of plugins.
+     * @return True to continue visiting plugins or false to stop.
      */
     public boolean visit(CefWebPluginInfo info, int count, int total);
 }
diff --git a/java/org/cef/callback/CefWebPluginUnstableCallback.java b/java/org/cef/callback/CefWebPluginUnstableCallback.java
@@ -5,14 +5,16 @@
 package org.cef.callback;
 
 /**
- * Interface to implement for receiving unstable plugin information. The methods
- * of this class will be called on the browser process IO thread.
+ * Interface to implement for receiving unstable plugin information. The methods of this class will
+ * be called on the browser process IO thread.
  */
 public interface CefWebPluginUnstableCallback {
     /**
-     * Method that will be called for the requested plugin. |unstable| will be
-     * true if the plugin has reached the crash count threshold of 3 times in 120
-     * seconds.
+     * Method that will be called for the requested plugin.
+     *
+     * @param path Plugin file path (DLL/bundle/library).
+     * @param unstable True if the plugin has reached the crash count threshold of 3 times in 120
+     *         seconds.
      */
     public void isUnstable(String path, boolean unstable);
 }
diff --git a/java/org/cef/network/CefWebPluginInfo_N.java b/java/org/cef/network/CefWebPluginInfo_N.java
@@ -7,10 +7,12 @@
 import org.cef.callback.CefNativeAdapter;
 
 class CefWebPluginInfo_N extends CefNativeAdapter implements CefWebPluginInfo {
+    CefWebPluginInfo_N() {}
+
     @Override
     public String getName() {
         try {
-            return N_GetName();
+            return N_GetName(getNativeRef(null));
         } catch (UnsatisfiedLinkError ule) {
             ule.printStackTrace();
         }
@@ -20,7 +22,7 @@ public String getName() {
     @Override
     public String getPath() {
         try {
-            return N_GetPath();
+            return N_GetPath(getNativeRef(null));
         } catch (UnsatisfiedLinkError ule) {
             ule.printStackTrace();
         }
@@ -30,7 +32,7 @@ public String getPath() {
     @Override
     public String getVersion() {
         try {
-            return N_GetVersion();
+            return N_GetVersion(getNativeRef(null));
         } catch (UnsatisfiedLinkError ule) {
             ule.printStackTrace();
         }
@@ -40,15 +42,15 @@ public String getVersion() {
     @Override
     public String getDescription() {
         try {
-            return N_GetDescription();
+            return N_GetDescription(getNativeRef(null));
         } catch (UnsatisfiedLinkError ule) {
             ule.printStackTrace();
         }
         return null;
     }
 
-    private final native String N_GetName();
-    private final native String N_GetPath();
-    private final native String N_GetVersion();
-    private final native String N_GetDescription();
+    private final native String N_GetName(long self);
+    private final native String N_GetPath(long self);
+    private final native String N_GetVersion(long self);
+    private final native String N_GetDescription(long self);
 }
diff --git a/java/org/cef/network/CefWebPluginManager.java b/java/org/cef/network/CefWebPluginManager.java
@@ -11,7 +11,7 @@
  * Class used to manage web plugins.
  */
 public abstract class CefWebPluginManager {
-    // This CTOR can't be called directly. Call method create() instead.
+    // This CTOR can't be called directly. Call method getGlobalManager() instead.
     CefWebPluginManager() {}
 
     /**
@@ -22,35 +22,39 @@ public static final CefWebPluginManager getGlobalManager() {
     }
 
     /**
-     * Visit web plugin information. Can be called on any thread in the browser
-     * process.
+     * Visit web plugin information. Can be called on any thread in the browser process.
+     *
      * @param visitor Called with plugin information when available.
      */
     public abstract void visitPlugins(CefWebPluginInfoVisitor visitor);
 
     /**
-     * Cause the plugin list to refresh the next time it is accessed regardless
-     * of whether it has already been loaded. Can be called on any thread in the
-     * browser process.
+     * Cause the plugin list to refresh the next time it is accessed regardless of whether it has
+     * already been loaded. Can be called on any thread in the browser process.
      */
     public abstract void refreshPlugins();
 
     /**
-     * Unregister an internal plugin. This may be undone the next time
-     * CefRefreshWebPlugins() is called. Can be called on any thread in the browser
-     * process.
+     * Unregister an internal plugin. This may be undone the next time refreshPlugins() is called.
+     * Can be called on any thread in the browser process.
+     *
+     * @param path Plugin file path (DLL/bundle/library).
      */
     public abstract void unregisterInternalPlugin(String path);
 
     /**
-     * Register a plugin crash. Can be called on any thread in the browser process
-     * but will be executed on the IO thread.
+     * Register a plugin crash. Can be called on any thread in the browser process but will be
+     * executed on the IO thread.
+     *
+     * @param path Plugin file path (DLL/bundle/library).
      */
     public abstract void registerPluginCrash(String path);
 
     /**
-     * Query if a plugin is unstable. Can be called on any thread in the browser
-     * process.
+     * Query if a plugin is unstable. Can be called on any thread in the browser process.
+     *
+     * @param path Plugin file path (DLL/bundle/library).
+     * @param callback Called when plugin information is available.
      */
     public abstract void isWebPluginUnstable(String path, CefWebPluginUnstableCallback callback);
 }
diff --git a/java/org/cef/network/CefWebPluginManager_N.java b/java/org/cef/network/CefWebPluginManager_N.java
@@ -8,21 +8,9 @@
 import org.cef.callback.CefWebPluginInfoVisitor;
 import org.cef.callback.CefWebPluginUnstableCallback;
 
-class CefWebPluginManager_N extends CefWebPluginManager implements CefNative {
-    // Used internally to store a pointer to the CEF object.
-    private long N_CefHandle = 0;
+class CefWebPluginManager_N extends CefWebPluginManager {
     private static CefWebPluginManager_N instance = null;
 
-    @Override
-    public void setNativeRef(String identifer, long nativeRef) {
-        N_CefHandle = nativeRef;
-    }
-
-    @Override
-    public long getNativeRef(String identifer) {
-        return N_CefHandle;
-    }
-
     CefWebPluginManager_N() {
         super();
     }
diff --git a/native/CefWebPluginInfo_N.cpp b/native/CefWebPluginInfo_N.cpp
@@ -7,40 +7,50 @@
 
 #include "include/cef_web_plugin.h"
 
+namespace {
+
+CefRefPtr<CefWebPluginInfo> GetSelf(jlong self) {
+  return reinterpret_cast<CefWebPluginInfo*>(self);
+}
+
+}  // namespace
+
 JNIEXPORT jstring JNICALL
-Java_org_cef_network_CefWebPluginInfo_1N_N_1GetName(JNIEnv* env, jobject obj) {
-  CefRefPtr<CefWebPluginInfo> info =
-      GetCefFromJNIObject<CefWebPluginInfo>(env, obj, "CefWebPluginInfo");
-  if (!info.get())
+Java_org_cef_network_CefWebPluginInfo_1N_N_1GetName(JNIEnv* env,
+                                                    jobject obj,
+                                                    jlong self) {
+  CefRefPtr<CefWebPluginInfo> info = GetSelf(self);
+  if (!info)
     return NULL;
   return NewJNIString(env, info->GetName());
 }
 
 JNIEXPORT jstring JNICALL
-Java_org_cef_network_CefWebPluginInfo_1N_N_1GetPath(JNIEnv* env, jobject obj) {
-  CefRefPtr<CefWebPluginInfo> info =
-      GetCefFromJNIObject<CefWebPluginInfo>(env, obj, "CefWebPluginInfo");
-  if (!info.get())
+Java_org_cef_network_CefWebPluginInfo_1N_N_1GetPath(JNIEnv* env,
+                                                    jobject obj,
+                                                    jlong self) {
+  CefRefPtr<CefWebPluginInfo> info = GetSelf(self);
+  if (!info)
     return NULL;
   return NewJNIString(env, info->GetPath());
 }
 
 JNIEXPORT jstring JNICALL
 Java_org_cef_network_CefWebPluginInfo_1N_N_1GetVersion(JNIEnv* env,
-                                                       jobject obj) {
-  CefRefPtr<CefWebPluginInfo> info =
-      GetCefFromJNIObject<CefWebPluginInfo>(env, obj, "CefWebPluginInfo");
-  if (!info.get())
+                                                       jobject obj,
+                                                       jlong self) {
+  CefRefPtr<CefWebPluginInfo> info = GetSelf(self);
+  if (!info)
     return NULL;
   return NewJNIString(env, info->GetVersion());
 }
 
 JNIEXPORT jstring JNICALL
 Java_org_cef_network_CefWebPluginInfo_1N_N_1GetDescription(JNIEnv* env,
-                                                           jobject obj) {
-  CefRefPtr<CefWebPluginInfo> info =
-      GetCefFromJNIObject<CefWebPluginInfo>(env, obj, "CefWebPluginInfo");
-  if (!info.get())
+                                                           jobject obj,
+                                                           jlong self) {
+  CefRefPtr<CefWebPluginInfo> info = GetSelf(self);
+  if (!info)
     return NULL;
   return NewJNIString(env, info->GetDescription());
 }
diff --git a/native/CefWebPluginInfo_N.h b/native/CefWebPluginInfo_N.h
diff --git a/native/web_plugin_unstable_callback.cpp b/native/web_plugin_unstable_callback.cpp
@@ -8,22 +8,17 @@
 #include "util.h"
 
 WebPluginUnstableCallback::WebPluginUnstableCallback(JNIEnv* env,
-                                                     jobject jcallback) {
-  jcallback_ = env->NewGlobalRef(jcallback);
-}
-
-WebPluginUnstableCallback::~WebPluginUnstableCallback() {
-  JNIEnv* env = GetJNIEnv();
-  env->DeleteGlobalRef(jcallback_);
-}
+                                                     jobject jcallback)
+    : handle_(env, jcallback) {}
 
 void WebPluginUnstableCallback::IsUnstable(const CefString& path,
                                            bool unstable) {
   JNIEnv* env = GetJNIEnv();
   if (!env)
     return;
-  jstring jpath = NewJNIString(env, path);
-  JNI_CALL_VOID_METHOD(env, jcallback_, "isUnstable", "(Ljava/lang/String;Z)V",
-                       jpath, (unstable ? JNI_TRUE : JNI_FALSE));
-  env->DeleteLocalRef(jpath);
+
+  ScopedJNIString jpath(env, path);
+
+  JNI_CALL_VOID_METHOD(env, handle_, "isUnstable", "(Ljava/lang/String;Z)V",
+                       jpath.get(), (unstable ? JNI_TRUE : JNI_FALSE));
 }
diff --git a/native/web_plugin_unstable_callback.h b/native/web_plugin_unstable_callback.h
@@ -7,19 +7,21 @@
 #pragma once
 
 #include <jni.h>
+
 #include "include/cef_web_plugin.h"
 
+#include "jni_scoped_helpers.h"
+
 // WebPluginUnstableCallback implementation.
 class WebPluginUnstableCallback : public CefWebPluginUnstableCallback {
  public:
   WebPluginUnstableCallback(JNIEnv* env, jobject jcallback);
-  virtual ~WebPluginUnstableCallback();
 
   // WebPluginUnstableCallback methods
   virtual void IsUnstable(const CefString& path, bool unstable) OVERRIDE;
 
  protected:
-  jobject jcallback_;
+  ScopedJNIObjectGlobal handle_;
 
   // Include the default reference counting implementation.
   IMPLEMENT_REFCOUNTING(WebPluginUnstableCallback);
diff --git a/native/web_plugin_visitor.cpp b/native/web_plugin_visitor.cpp
@@ -7,14 +7,8 @@
 #include "jni_util.h"
 #include "util.h"
 
-WebPluginInfoVisitor::WebPluginInfoVisitor(JNIEnv* env, jobject jvisitor) {
-  jvisitor_ = env->NewGlobalRef(jvisitor);
-}
-
-WebPluginInfoVisitor::~WebPluginInfoVisitor() {
-  JNIEnv* env = GetJNIEnv();
-  env->DeleteGlobalRef(jvisitor_);
-}
+WebPluginInfoVisitor::WebPluginInfoVisitor(JNIEnv* env, jobject jvisitor)
+    : handle_(env, jvisitor) {}
 
 bool WebPluginInfoVisitor::Visit(CefRefPtr<CefWebPluginInfo> info,
                                  int count,
@@ -23,17 +17,14 @@ bool WebPluginInfoVisitor::Visit(CefRefPtr<CefWebPluginInfo> info,
   if (!env)
     return false;
 
-  jobject jinfo = NewJNIObject(env, "org/cef/network/CefWebPluginInfo_N");
-  if (!jinfo)
-    return false;
-  SetCefForJNIObject(env, jinfo, info.get(), "CefWebPluginInfo");
+  ScopedJNIObject<CefWebPluginInfo> jinfo(
+      env, info, "org/cef/network/CefWebPluginInfo_N", "CefWebPluginInfo");
+  jinfo.SetTemporary();
 
   jboolean jresult = JNI_FALSE;
-  JNI_CALL_METHOD(env, jvisitor_, "visit",
+  JNI_CALL_METHOD(env, handle_, "visit",
                   "(Lorg/cef/network/CefWebPluginInfo;II)Z", Boolean, jresult,
-                  jinfo, (jint)count, (jint)total);
+                  jinfo.get(), (jint)count, (jint)total);
 
-  SetCefForJNIObject<CefWebPluginInfo>(env, jinfo, NULL, "CefWebPluginInfo");
-  env->DeleteLocalRef(jinfo);
   return jresult != JNI_FALSE;
 }
diff --git a/native/web_plugin_visitor.h b/native/web_plugin_visitor.h
