Merge lp:~pete-woods/libdbusmenu-qt/sync-mode-option into lp:libdbusmenu-qt

[Pete Woods]

Add option to make DBus calls synchronous

* Is your branch in sync with latest trunk (e.g. bzr pull lp:trunk -> no changes)
  * Yes
 * Did you build your software in a clean sbuild/pbuilder chroot or ppa?
  * Yes
 * Did you build your software in a clean sbuild/pbuilder armhf chroot or ppa?
  * Yes
 * Has your component "TestPlan” been executed successfully on emulator, N4?
  * Yes
 * Has a 5 minute exploratory testing run been executed on N4?
  * Yes
 * If you changed the packaging (debian), did you subscribe a core-dev to this MP?
  * N/A
 * If you changed the UI, did you subscribe the design-reviewers to this MP?
  * No change
 * What components might get impacted by your changes?
  * Unity HUD
 * Have you requested review by the teams of these owning components?
  * Yes

Check List:
https://wiki.ubuntu.com/Process/Merges/Checklists/libdbusmenu-qt

Test Plan:
https://wiki.ubuntu.com/Process/Merges/TestPlan/libdbusmenu-qt

Silo:
https://launchpad.net/~ci-train-ppa-service/+archive/landing-002/

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:261
http://jenkins.qa.ubuntu.com/job/libdbusmenu-qt-ci/16/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/libdbusmenu-qt-trusty-amd64-ci/11
    SUCCESS: http://jenkins.qa.ubuntu.com/job/libdbusmenu-qt-trusty-armhf-ci/11
        deb: http://jenkins.qa.ubuntu.com/job/libdbusmenu-qt-trusty-armhf-ci/11/artifact/work/output/*zip*/output.zip

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/libdbusmenu-qt-ci/16/rebuild

review: Approve (continuous-integration)

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:263
http://jenkins.qa.ubuntu.com/job/libdbusmenu-qt-ci/17/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/libdbusmenu-qt-trusty-amd64-ci/12
    SUCCESS: http://jenkins.qa.ubuntu.com/job/libdbusmenu-qt-trusty-armhf-ci/12
        deb: http://jenkins.qa.ubuntu.com/job/libdbusmenu-qt-trusty-armhf-ci/12/artifact/work/output/*zip*/output.zip

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/libdbusmenu-qt-ci/17/rebuild

review: Approve (continuous-integration)

[Antti Kaijanmäki (kaijanmaki)]

LGTM. Waiting for silo.

[Antti Kaijanmäki (kaijanmaki)]

 * Are any changes against your component pending/needed to land the MP under review in a functional state and are those called out explicitly by the submitter?
YES.

 * Did you do exploratory testing related to the component you own with the MP changeset included?
YES.

 * Has the submitter requested review by all the relevant teams/reviewres?
YES.

 * If you are the reviewer owning the component the MP is against, have you checked that submitter has accurately filled out the submitter checklist and has taken no shortcut?
YES.

review: Approve

=== modified file 'debian/changelog'
--- debian/changelog	2014-02-18 14:33:02 +0000
+++ debian/changelog	2014-03-14 14:12:57 +0000
@@ -1,3 +1,16 @@
+libdbusmenu-qt (0.9.3-0ubuntu1) UNRELEASED; urgency=medium
+
+  [ Pete Woods ]
+  * Add importer parameter to allow control over DBus behavior.
+
+ -- Pete Woods <[e-mail]>  Wed, 05 Mar 2014 09:36:46 +0000
+
+libdbusmenu-qt (0.9.2+14.04.20140305-0ubuntu1) trusty; urgency=low
+
+  * New rebuild forced
+
+ -- Ubuntu daily release <[e-mail]>  Wed, 05 Mar 2014 09:29:14 +0000
+
 libdbusmenu-qt (0.9.2+14.04.20140218.2-0ubuntu1) trusty; urgency=low
 
   [ Pete Woods ]
 
=== modified file 'src/dbusmenuimporter.cpp'
--- src/dbusmenuimporter.cpp	2014-02-18 11:52:15 +0000
+++ src/dbusmenuimporter.cpp	2014-03-14 14:12:57 +0000
@@ -89,6 +89,8 @@
 
     bool m_mustEmitMenuUpdated;
 
+    DBusMenuImporterType m_type;
+
     QDBusPendingCallWatcher *refresh(int id)
     {
         #ifdef BENCHMARK
@@ -279,9 +281,51 @@
         QVariant empty = QVariant::fromValue(QDBusVariant(QString()));
         m_interface->asyncCall("Event", id, eventId, empty, 0u);
     }
+
+    bool waitForWatcher(QDBusPendingCallWatcher * _watcher, int maxWait)
+    {
+        QPointer<QDBusPendingCallWatcher> watcher(_watcher);
+
+        if(m_type == ASYNCHRONOUS) {
+            QTimer timer;
+            timer.setSingleShot(true);
+            QEventLoop loop;
+            loop.connect(&timer, SIGNAL(timeout()), SLOT(quit()));
+            loop.connect(watcher, SIGNAL(finished(QDBusPendingCallWatcher *)), SLOT(quit()));
+            timer.start(maxWait);
+            loop.exec();
+            timer.stop();
+
+            if (!watcher) {
+                // Watcher died. This can happen if importer got deleted while we were
+                // waiting. See:
+                // https://bugs.kde.org/show_bug.cgi?id=237156
+                return false;
+            }
+
+            if(!watcher->isFinished()) {
+                // Timed out
+                return false;
+            }
+        } else {
+            watcher->waitForFinished();
+        }
+
+        if (watcher->isError()) {
+            DMWARNING << watcher->error().message();
+            return false;
+        }
+
+        return true;
+    }
 };
 
 DBusMenuImporter::DBusMenuImporter(const QString &service, const QString &path, QObject *parent)
+: DBusMenuImporter(service, path, ASYNCHRONOUS, parent)
+{
+}
+
+DBusMenuImporter::DBusMenuImporter(const QString &service, const QString &path, DBusMenuImporterType type, QObject *parent)
 : QObject(parent)
 , d(new DBusMenuImporterPrivate)
 {
@@ -292,6 +336,8 @@
     d->m_menu = 0;
     d->m_mustEmitMenuUpdated = false;
 
+    d->m_type = type;
+
     connect(&d->m_mapper, SIGNAL(mapped(int)), SLOT(sendClickedEvent(int)));
 
     d->m_pendingLayoutUpdateTimer = new QTimer(this);
@@ -443,41 +489,6 @@
     QMetaObject::invokeMethod(menu(), "aboutToShow");
 }
 
-static bool waitForWatcher(QDBusPendingCallWatcher * _watcher, int maxWait)
-{
-    QPointer<QDBusPendingCallWatcher> watcher(_watcher);
-
-    {
-        QTimer timer;
-        timer.setSingleShot(true);
-        QEventLoop loop;
-        loop.connect(&timer, SIGNAL(timeout()), SLOT(quit()));
-        loop.connect(watcher, SIGNAL(finished(QDBusPendingCallWatcher *)), SLOT(quit()));
-        timer.start(maxWait);
-        loop.exec();
-        timer.stop();
-    }
-
-    if (!watcher) {
-        // Watcher died. This can happen if importer got deleted while we were
-        // waiting. See:
-        // https://bugs.kde.org/show_bug.cgi?id=237156
-        return false;
-    }
-
-    if(!watcher->isFinished()) {
-        // Timed out
-        return false;
-    }
-
-    if (watcher->isError()) {
-        DMWARNING << watcher->error().message();
-        return false;
-    }
-
-    return true;
-}
-
 void DBusMenuImporter::slotMenuAboutToShow()
 {
     QMenu *menu = qobject_cast<QMenu*>(sender());
@@ -501,7 +512,7 @@
 
     QPointer<QObject> guard(this);
 
-    if (!waitForWatcher(watcher, ABOUT_TO_SHOW_TIMEOUT)) {
+    if (!d->waitForWatcher(watcher, ABOUT_TO_SHOW_TIMEOUT)) {
         DMWARNING << "Application did not answer to AboutToShow() before timeout";
     }
 
@@ -541,7 +552,7 @@
     if (needRefresh || menu->actions().isEmpty()) {
         d->m_idsRefreshedByAboutToShow << id;
         watcher = d->refresh(id);
-        if (!waitForWatcher(watcher, REFRESH_TIMEOUT)) {
+        if (!d->waitForWatcher(watcher, REFRESH_TIMEOUT)) {
             DMWARNING << "Application did not refresh before timeout";
         }
     }
 
=== modified file 'src/dbusmenuimporter.h'
--- src/dbusmenuimporter.h	2013-12-18 09:29:06 +0000
+++ src/dbusmenuimporter.h	2014-03-14 14:12:57 +0000
@@ -35,6 +35,16 @@
 class QMenu;
 
 class DBusMenuImporterPrivate;
+
+/**
+ * Determine whether internal method calls should allow the Qt event loop
+ * to execute or not
+ */
+enum DBusMenuImporterType {
+    ASYNCHRONOUS,
+    SYNCHRONOUS
+};
+
 /**
  * A DBusMenuImporter instance can recreate a menu serialized over DBus by
  * DBusMenuExporter
@@ -48,6 +58,12 @@
      */
     DBusMenuImporter(const QString &service, const QString &path, QObject *parent = 0);
 
+    /**
+     * Creates a DBusMenuImporter listening over DBus on service, path, with either async
+     * or sync DBus calls
+     */
+    DBusMenuImporter(const QString &service, const QString &path, DBusMenuImporterType type, QObject *parent = 0);
+
     virtual ~DBusMenuImporter();
 
     /**