Bug 563737 - [QT] Detect when Qt plugins enter a nested event loop. r=cjones

dom/plugins/Makefile.in

@@ -95,7 +95,19 @@ FORCE_STATIC_LIB = 1
 EXPORT_LIBRARY = 1
 ENABLE_CXX_EXCEPTIONS = 1
 
+ifeq ($(MOZ_ENABLE_QT),1)
+MOCSRCS = \
+  moc_NestedLoopTimer.cpp \
+  $(NULL)
+
+QTSRCS = \
+  NestedLoopTimer.cpp \
+  $(NULL)
+endif
+
 CPPSRCS = \
+  $(MOCSRCS) \
+  $(QTSRCS) \
   ChildAsyncCall.cpp \
   ChildTimer.cpp \
   PluginMessageUtils.cpp \

dom/plugins/NestedLoopTimer.cpp

@@ -0,0 +1,80 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
+ * vim: sw=4 ts=4 et :
+ * ***** BEGIN LICENSE BLOCK *****
+ * Version: MPL 1.1/GPL 2.0/LGPL 2.1
+ *
+ * The contents of this file are subject to the Mozilla Public License Version
+ * 1.1 (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ * http://www.mozilla.org/MPL/
+ *
+ * Software distributed under the License is distributed on an "AS IS" basis,
+ * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
+ * for the specific language governing rights and limitations under the
+ * License.
+ *
+ * The Original Code is Mozilla Plugin App.
+ *
+ * The Initial Developer of the Original Code is mozilla.org code.
+ * Portions created by the Initial Developer are Copyright (C) 2010
+ * the Initial Developer. All Rights Reserved.
+ *
+ * Contributors(s):
+ *  Tero Koskinen <tero.koskinen@iki.fi>  (Original Author)
+ *
+ * Alternatively, the contents of this file may be used under the terms of
+ * either the GNU General Public License Version 2 or later (the "GPL"), or
+ * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
+ * in which case the provisions of the GPL or the LGPL are applicable instead
+ * of those above. If you wish to allow use of your version of this file only
+ * under the terms of either the GPL or the LGPL, and not to allow others to
+ * use your version of this file under the terms of the MPL, indicate your
+ * decision by deleting the provisions above and replace them with the notice
+ * and other provisions required by the GPL or the LGPL. If you do not delete
+ * the provisions above, a recipient may use your version of this file under
+ * the terms of any one of the MPL, the GPL or the LGPL.
+ *
+ * ***** END LICENSE BLOCK ***** */
+
+#include <QtCore/QTimer>
+
+#include "NestedLoopTimer.h"
+#include "mozilla/plugins/PluginModuleChild.h"
+
+namespace mozilla {
+namespace plugins {
+
+NestedLoopTimer::NestedLoopTimer(PluginModuleChild *pmc):
+     QObject(), mModule(pmc), mQTimer(NULL)
+{
+}
+
+NestedLoopTimer::~NestedLoopTimer()
+{
+    if (mQTimer) {
+        mQTimer->stop();
+        delete mQTimer;
+        mQTimer = NULL;
+    }
+}
+
+void NestedLoopTimer::timeOut()
+{
+    // just detected a nested loop; start a timer that will
+    // periodically rpc-call back into the browser and process some
+    // events
+    mQTimer = new QTimer(this);
+    QObject::connect(mQTimer, SIGNAL(timeout()), this,
+                     SLOT(processSomeEvents()));
+    mQTimer->setInterval(kNestedLoopDetectorIntervalMs);
+    mQTimer->start();
+}
+
+void NestedLoopTimer::processSomeEvents()
+{
+    if (mModule)
+        mModule->CallProcessSomeEvents();
+}
+
+} /* namespace plugins */
+} /* namespace mozilla */

dom/plugins/NestedLoopTimer.h

@@ -0,0 +1,71 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
+ * vim: sw=4 ts=4 et :
+ * ***** BEGIN LICENSE BLOCK *****
+ * Version: MPL 1.1/GPL 2.0/LGPL 2.1
+ *
+ * The contents of this file are subject to the Mozilla Public License Version
+ * 1.1 (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ * http://www.mozilla.org/MPL/
+ *
+ * Software distributed under the License is distributed on an "AS IS" basis,
+ * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
+ * for the specific language governing rights and limitations under the
+ * License.
+ *
+ * The Original Code is Mozilla Plugin App.
+ *
+ * The Initial Developer of the Original Code is mozilla.org code.
+ * Portions created by the Initial Developer are Copyright (C) 2010
+ * the Initial Developer. All Rights Reserved.
+ *
+ * Contributors(s):
+ *  Tero Koskinen <tero.koskinen@iki.fi>  (Original Author)
+ *
+ * Alternatively, the contents of this file may be used under the terms of
+ * either the GNU General Public License Version 2 or later (the "GPL"), or
+ * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
+ * in which case the provisions of the GPL or the LGPL are applicable instead
+ * of those above. If you wish to allow use of your version of this file only
+ * under the terms of either the GPL or the LGPL, and not to allow others to
+ * use your version of this file under the terms of the MPL, indicate your
+ * decision by deleting the provisions above and replace them with the notice
+ * and other provisions required by the GPL or the LGPL. If you do not delete
+ * the provisions above, a recipient may use your version of this file under
+ * the terms of any one of the MPL, the GPL or the LGPL.
+ *
+ * ***** END LICENSE BLOCK ***** */
+
+#ifndef NESTEDLOOPTIMER_H
+#define NESTEDLOOPTIMER_H
+
+#include <QtCore/QObject>
+
+class QTimer;
+
+namespace mozilla {
+namespace plugins {
+
+class PluginModuleChild;
+
+class NestedLoopTimer: public QObject
+{
+    Q_OBJECT
+public:
+    NestedLoopTimer(PluginModuleChild *pmc);
+
+    virtual ~NestedLoopTimer();
+
+public Q_SLOTS:
+    virtual void timeOut();
+    virtual void processSomeEvents();
+   
+private:
+    PluginModuleChild *mModule;
+    QTimer *mQTimer;
+};
+
+} /* namespace plugins */
+} /* namespace mozilla */
+
+#endif

dom/plugins/PluginModuleChild.cpp

@@ -38,7 +38,9 @@
  * ***** END LICENSE BLOCK ***** */
 
 #ifdef MOZ_WIDGET_QT
+#include <QtCore/QTimer>
 #include "nsQAppInstance.h"
+#include "NestedLoopTimer.h"
 #endif
 
 #include "mozilla/plugins/PluginModuleChild.h"
@@ -96,6 +98,8 @@ PluginModuleChild::PluginModuleChild() :
   , mGetEntryPointsFunc(0)
 #elif defined(MOZ_WIDGET_GTK2)
   , mNestedLoopTimerId(0)
+#elif defined(MOZ_WIDGET_QT)
+  , mNestedLoopTimerObject(0)
 #endif
 #ifdef OS_WIN
   , mNestedEventHook(NULL)
@@ -446,6 +450,26 @@ PluginModuleChild::ExitedCxxStack()
     g_source_remove(mNestedLoopTimerId);
     mNestedLoopTimerId = 0;
 }
+#elif defined (MOZ_WIDGET_QT)
+
+void
+PluginModuleChild::EnteredCxxStack()
+{
+    NS_ABORT_IF_FALSE(mNestedLoopTimerObject == NULL,
+                      "previous timer not descheduled");
+    mNestedLoopTimerObject = new NestedLoopTimer(this);
+    QTimer::singleShot(kNestedLoopDetectorIntervalMs,
+                       mNestedLoopTimerObject, SLOT(timeOut()));
+}
+
+void
+PluginModuleChild::ExitedCxxStack()
+{
+    NS_ABORT_IF_FALSE(mNestedLoopTimerObject != NULL,
+                      "nested loop timeout not scheduled");
+    delete mNestedLoopTimerObject;
+    mNestedLoopTimerObject = NULL;
+}
 
 #endif
 

dom/plugins/PluginModuleChild.h

@@ -89,6 +89,11 @@ typedef NS_NPAPIPLUGIN_CALLBACK(NPError, NP_PLUGINSHUTDOWN) (void);
 namespace mozilla {
 namespace plugins {
 
+#ifdef MOZ_WIDGET_QT
+class NestedLoopTimer;
+static const int kNestedLoopDetectorIntervalMs = 90;
+#endif
+
 class PluginScriptableObjectChild;
 class PluginInstanceChild;
 
@@ -194,6 +199,12 @@ private:
     static gboolean DetectNestedEventLoop(gpointer data);
     static gboolean ProcessBrowserEvents(gpointer data);
 
+    NS_OVERRIDE
+    virtual void EnteredCxxStack();
+    NS_OVERRIDE
+    virtual void ExitedCxxStack();
+#elif defined(MOZ_WIDGET_QT)
+
     NS_OVERRIDE
     virtual void EnteredCxxStack();
     NS_OVERRIDE
@@ -254,6 +265,8 @@ private:
     // MessagePumpForUI.
     int mTopLoopDepth;
 #  endif
+#elif defined (MOZ_WIDGET_QT)
+    NestedLoopTimer *mNestedLoopTimerObject;
 #endif
 
     struct NPObjectData : public nsPtrHashKey<NPObject>

dom/plugins/PluginModuleParent.cpp

@@ -39,6 +39,10 @@
 #ifdef MOZ_WIDGET_GTK2
 #include <glib.h>
 #endif
+#ifdef MOZ_WIDGET_QT
+#include <QtCore/QCoreApplication>
+#include <QtCore/QEventLoop>
+#endif
 
 #include "base/process_util.h"
 
@@ -754,7 +758,20 @@ PluginModuleParent::AnswerNPN_GetValue_WithBoolReturn(const NPNVariable& aVariab
     return true;
 }
 
-#if !defined(MOZ_WIDGET_GTK2)
+#if defined(MOZ_WIDGET_QT)
+static const int kMaxtimeToProcessEvents = 30;
+bool
+PluginModuleParent::AnswerProcessSomeEvents()
+{
+    PLUGIN_LOG_DEBUG(("Spinning mini nested loop ..."));
+    QCoreApplication::processEvents(QEventLoop::AllEvents, kMaxtimeToProcessEvents);
+
+    PLUGIN_LOG_DEBUG(("... quitting mini nested loop"));
+
+    return true;
+}
+
+#elif !defined(MOZ_WIDGET_GTK2)
 bool
 PluginModuleParent::AnswerProcessSomeEvents()
 {