Merge lp:~dyams/unity-2d/centralized-superkey into lp:~dyams/unity-2d/Shell-MultiMonitor

[Lohith D Shivamurthy]

[shell] Move super key handling stuff to shellmanager.cpp

[lp:~dyams/unity-2d/centralized-superkey]

921. By Lohith D Shivamurthy on 2012-02-15

Added a TODO to handle Dash in every shell

[Albert Astals Cid (aacid)]

Approved, makes sense

review: Approve

=== modified file 'shell/app/shelldeclarativeview.cpp'
--- shell/app/shelldeclarativeview.cpp	2012-02-14 11:01:49 +0000
+++ shell/app/shelldeclarativeview.cpp	2012-02-15 09:37:18 +0000
@@ -22,11 +22,6 @@
 // libunity-2d-private
 #include <debug_p.h>
 #include <hotkey.h>
-#include <hotkeymonitor.h>
-#include <keyboardmodifiersmonitor.h>
-#include <keymonitor.h>
-#include <dashclient.h>
-#include <launcherclient.h>
 #include <screeninfo.h>
 #include <strutmanager.h>
 
@@ -47,8 +42,6 @@
 #include <X11/Xlib.h>
 #include <X11/Xatom.h>
 
-static const int KEY_HOLD_THRESHOLD = 250;
-
 static const char* COMMANDS_LENS_ID = "commands.lens";
 
 ShellDeclarativeView::ShellDeclarativeView(const QUrl &sourceFileUrl, bool isTopLeftShell, int screen)
@@ -56,8 +49,6 @@
     , m_mode(DesktopMode)
     , m_expanded(true)
     , m_active(false)
-    , m_superKeyPressed(false)
-    , m_superKeyHeld(false)
     , m_isTopLeftShell(isTopLeftShell)
     , m_sourceFileUrl(sourceFileUrl)
 {
@@ -66,14 +57,6 @@
 
     m_screenInfo = new ScreenInfo(screen, this);
 
-    m_superKeyHoldTimer.setSingleShot(true);
-    m_superKeyHoldTimer.setInterval(KEY_HOLD_THRESHOLD);
-    connect(&m_superKeyHoldTimer, SIGNAL(timeout()), SLOT(updateSuperKeyHoldState()));
-    connect(this, SIGNAL(superKeyTapped()), SLOT(toggleDash()));
-
-    connect(&launcher2dConfiguration(), SIGNAL(superKeyEnableChanged(bool)), SLOT(updateSuperKeyMonitoring()));
-    updateSuperKeyMonitoring();
-
     connect(m_screenInfo, SIGNAL(availableGeometryChanged(QRect)), SLOT(updateShellPosition()));
     updateShellPosition();
 }
@@ -268,93 +251,6 @@
     }
 }
 
-/* ----------------- super key handling ---------------- */
-
-void
-ShellDeclarativeView::updateSuperKeyHoldState()
-{
-    /* If the key was released in the meantime, just do nothing, otherwise
-       consider the key being held, unless we're told to ignore it. */
-    if (m_superKeyPressed && !m_superPressIgnored) {
-        m_superKeyHeld = true;
-        Q_EMIT superKeyHeldChanged(m_superKeyHeld);
-    }
-}
-
-void
-ShellDeclarativeView::updateSuperKeyMonitoring()
-{
-    KeyboardModifiersMonitor *modifiersMonitor = KeyboardModifiersMonitor::instance();
-    KeyMonitor *keyMonitor = KeyMonitor::instance();
-    HotkeyMonitor& hotkeyMonitor = HotkeyMonitor::instance();
-
-    QVariant value = launcher2dConfiguration().property("superKeyEnable");
-    if (!value.isValid() || value.toBool() == true) {
-        hotkeyMonitor.enableModifiers(Qt::MetaModifier);
-        QObject::connect(modifiersMonitor,
-                         SIGNAL(keyboardModifiersChanged(Qt::KeyboardModifiers)),
-                         this, SLOT(setHotkeysForModifiers(Qt::KeyboardModifiers)));
-        /* Ignore Super presses if another key was pressed simultaneously
-           (i.e. a shortcut). https://bugs.launchpad.net/unity-2d/+bug/801073 */
-        QObject::connect(keyMonitor,
-                         SIGNAL(keyPressed()),
-                         this, SLOT(ignoreSuperPress()));
-        setHotkeysForModifiers(modifiersMonitor->keyboardModifiers());
-    } else {
-        hotkeyMonitor.disableModifiers(Qt::MetaModifier);
-        QObject::disconnect(modifiersMonitor,
-                            SIGNAL(keyboardModifiersChanged(Qt::KeyboardModifiers)),
-                            this, SLOT(setHotkeysForModifiers(Qt::KeyboardModifiers)));
-        QObject::disconnect(keyMonitor,
-                            SIGNAL(keyPressed()),
-                            this, SLOT(ignoreSuperPress()));
-        m_superKeyHoldTimer.stop();
-        m_superKeyPressed = false;
-        if (m_superKeyHeld) {
-            m_superKeyHeld = false;
-            Q_EMIT superKeyHeldChanged(false);
-        }
-    }
-}
-
-void
-ShellDeclarativeView::setHotkeysForModifiers(Qt::KeyboardModifiers modifiers)
-{
-    /* This is the new new state of the Super key (AKA Meta key), while
-       m_superKeyPressed is the previous state of the key at the last modifiers change. */
-    bool superKeyPressed = modifiers.testFlag(Qt::MetaModifier);
-
-    if (m_superKeyPressed != superKeyPressed) {
-        m_superKeyPressed = superKeyPressed;
-        if (superKeyPressed) {
-            m_superPressIgnored = false;
-            /* If the key is pressed, start up a timer to monitor if it's being held short
-               enough to qualify as just a "tap" or as a proper hold */
-            m_superKeyHoldTimer.start();
-        } else {
-            m_superKeyHoldTimer.stop();
-
-            /* If the key is released, and was not being held, it means that the user just
-               performed a "tap". Unless we're told to ignore that tap, that is. */
-            if (!m_superKeyHeld && !m_superPressIgnored) {
-                Q_EMIT superKeyTapped();
-            }
-            /* Otherwise the user just terminated a hold. */
-            else if(m_superKeyHeld){
-                m_superKeyHeld = false;
-                Q_EMIT superKeyHeldChanged(m_superKeyHeld);
-            }
-        }
-    }
-}
-
-void
-ShellDeclarativeView::ignoreSuperPress()
-{
-    /* There was a key pressed, ignore current super tap/hold */
-    m_superPressIgnored = true;
-}
-
 void
 ShellDeclarativeView::processNumericHotkey(Hotkey* hotkey)
 {

=== modified file 'shell/app/shelldeclarativeview.h'
--- shell/app/shelldeclarativeview.h	2012-02-14 11:01:49 +0000
+++ shell/app/shelldeclarativeview.h	2012-02-15 09:37:18 +0000
@@ -39,7 +39,6 @@
     Q_PROPERTY(DashMode dashMode READ dashMode WRITE setDashMode NOTIFY dashModeChanged)
     Q_PROPERTY(QString activeLens READ activeLens WRITE setActiveLens NOTIFY activeLensChanged)
     Q_PROPERTY(bool focus READ hasFocus NOTIFY focusChanged) // overridden to add notify
-    Q_PROPERTY(bool superKeyHeld READ superKeyHeld NOTIFY superKeyHeldChanged)
     Q_PROPERTY(bool isTopLeftShell READ isTopLeftShell WRITE setIsTopLeftShell NOTIFY isTopLeftShellChanged)
     Q_PROPERTY(bool haveCustomHomeShortcuts READ haveCustomHomeShortcuts)
 
@@ -66,7 +65,6 @@
     DashMode dashMode() const;
     const QString& activeLens() const;
     bool expanded() const;
-    bool superKeyHeld() const { return m_superKeyHeld; }
     QRect monitoredArea() const;
     bool monitoredAreaContainsMouse() const;
     bool isTopLeftShell() const { return m_isTopLeftShell; }
@@ -83,6 +81,7 @@
 
     virtual bool x11EventFilter(XEvent* event);
 
+    void toggleDash();
     void toggleLauncher();
     void showCommandsLens();
 
@@ -100,21 +99,11 @@
     void monitoredAreaContainsMouseChanged();
 
     void addWebFavoriteRequested(const QUrl& url);
-    void superKeyHeldChanged(bool superKeyHeld);
-    void superKeyTapped();
     void activateShortcutPressed(int itemIndex);
     void newInstanceShortcutPressed(int itemIndex);
     void launcherFocusRequested();
     void isTopLeftShellChanged(bool);
 
-private Q_SLOTS:
-    void updateSuperKeyMonitoring();
-    void updateSuperKeyHoldState();
-    void setHotkeysForModifiers(Qt::KeyboardModifiers modifiers);
-    void ignoreSuperPress();
-
-    void toggleDash();
-
 protected:
     virtual void showEvent(QShowEvent *event);
     virtual void mouseMoveEvent(QMouseEvent *event);
@@ -135,10 +124,6 @@
     QString m_activeLens; /* Lens id of the active lens */
     bool m_active;
 
-    bool m_superKeyPressed;
-    bool m_superKeyHeld;
-    bool m_superPressIgnored;
-    QTimer m_superKeyHoldTimer;
     QRect m_monitoredArea;
     bool m_monitoredAreaContainsMouse;
     bool m_isTopLeftShell;

=== modified file 'shell/app/shellmanager.cpp'
--- shell/app/shellmanager.cpp	2012-02-14 12:26:47 +0000
+++ shell/app/shellmanager.cpp	2012-02-15 09:37:18 +0000
@@ -33,6 +33,8 @@
 // libunity-2d-private
 #include <hotkeymonitor.h>
 #include <hotkey.h>
+#include <keyboardmodifiersmonitor.h>
+#include <keymonitor.h>
 #include <screeninfo.h>
 
 // Local
@@ -50,10 +52,16 @@
 // X11
 #include <X11/Xlib.h>
 
+static const int KEY_HOLD_THRESHOLD = 250;
+
 struct ShellManagerPrivate
 {
-    ShellManagerPrivate() :
-        q(0), m_dashDBus(0), m_launcherDBus(0)
+    ShellManagerPrivate()
+        : q(0)
+        , m_dashDBus(0)
+        , m_launcherDBus(0)
+        , m_superKeyPressed(false)
+        , m_superKeyHeld(false)
     {}
 
     ShellDeclarativeView* initShell(bool isTopLeft, int screen);
@@ -65,6 +73,11 @@
     DashDBus * m_dashDBus;
     LauncherDBus* m_launcherDBus;
     QUrl m_sourceFileUrl;
+
+    bool m_superKeyPressed;
+    bool m_superKeyHeld;
+    bool m_superPressIgnored;
+    QTimer m_superKeyHoldTimer;
 };
 
 
@@ -86,6 +99,7 @@
     /* Load the QML UI, focus and show the window */
     view->setResizeMode(QDeclarativeView::SizeViewToRootObject);
     view->rootContext()->setContextProperty("declarativeView", view);
+    view->rootContext()->setContextProperty("shellManager", q);
     // WARNING This declaration of dashClient used to be in Unity2d/plugin.cpp
     // but it lead to locks when both the shell and the spread were started
     // at the same time since SpreadMonitor QDBusServiceWatcher::serviceRegistered
@@ -190,6 +204,13 @@
 
     connect(desktop, SIGNAL(screenCountChanged(int)), SLOT(onScreenCountChanged(int)));
 
+    d->m_superKeyHoldTimer.setSingleShot(true);
+    d->m_superKeyHoldTimer.setInterval(KEY_HOLD_THRESHOLD);
+    connect(&d->m_superKeyHoldTimer, SIGNAL(timeout()), SLOT(updateSuperKeyHoldState()));
+
+    connect(&launcher2dConfiguration(), SIGNAL(superKeyEnableChanged(bool)), SLOT(updateSuperKeyMonitoring()));
+    updateSuperKeyMonitoring();
+
     /* Alt+F1 reveal the launcher and gives the keyboard focus to the Dash Button. */
     Hotkey* altF1 = HotkeyMonitor::instance().getHotkeyFor(Qt::Key_F1, Qt::AltModifier);
     connect(altF1, SIGNAL(pressed()), SLOT(onAltF1Pressed()));
@@ -219,6 +240,113 @@
     d->updateScreenCount(newCount);
 }
 
+/* ----------------- super key handling ---------------- */
+
+void
+ShellManager::updateSuperKeyHoldState()
+{
+    /* If the key was released in the meantime, just do nothing, otherwise
+       consider the key being held, unless we're told to ignore it. */
+    if (d->m_superKeyPressed && !d->m_superPressIgnored) {
+        d->m_superKeyHeld = true;
+        Q_EMIT superKeyHeldChanged(d->m_superKeyHeld);
+    }
+}
+
+void
+ShellManager::updateSuperKeyMonitoring()
+{
+    KeyboardModifiersMonitor *modifiersMonitor = KeyboardModifiersMonitor::instance();
+    KeyMonitor *keyMonitor = KeyMonitor::instance();
+    HotkeyMonitor& hotkeyMonitor = HotkeyMonitor::instance();
+
+    QVariant value = launcher2dConfiguration().property("superKeyEnable");
+    if (!value.isValid() || value.toBool() == true) {
+        hotkeyMonitor.enableModifiers(Qt::MetaModifier);
+        QObject::connect(modifiersMonitor,
+                         SIGNAL(keyboardModifiersChanged(Qt::KeyboardModifiers)),
+                         this, SLOT(setHotkeysForModifiers(Qt::KeyboardModifiers)));
+        /* Ignore Super presses if another key was pressed simultaneously
+           (i.e. a shortcut). https://bugs.launchpad.net/unity-2d/+bug/801073 */
+        QObject::connect(keyMonitor,
+                         SIGNAL(keyPressed()),
+                         this, SLOT(ignoreSuperPress()));
+        setHotkeysForModifiers(modifiersMonitor->keyboardModifiers());
+    } else {
+        hotkeyMonitor.disableModifiers(Qt::MetaModifier);
+        QObject::disconnect(modifiersMonitor,
+                            SIGNAL(keyboardModifiersChanged(Qt::KeyboardModifiers)),
+                            this, SLOT(setHotkeysForModifiers(Qt::KeyboardModifiers)));
+        QObject::disconnect(keyMonitor,
+                            SIGNAL(keyPressed()),
+                            this, SLOT(ignoreSuperPress()));
+        d->m_superKeyHoldTimer.stop();
+        d->m_superKeyPressed = false;
+        if (d->m_superKeyHeld) {
+            d->m_superKeyHeld = false;
+            Q_EMIT superKeyHeldChanged(false);
+        }
+    }
+}
+
+void
+ShellManager::setHotkeysForModifiers(Qt::KeyboardModifiers modifiers)
+{
+    /* This is the new new state of the Super key (AKA Meta key), while
+       d->m_superKeyPressed is the previous state of the key at the last modifiers change. */
+    bool superKeyPressed = modifiers.testFlag(Qt::MetaModifier);
+
+    if (d->m_superKeyPressed != superKeyPressed) {
+        d->m_superKeyPressed = superKeyPressed;
+        if (superKeyPressed) {
+            d->m_superPressIgnored = false;
+            /* If the key is pressed, start up a timer to monitor if it's being held short
+               enough to qualify as just a "tap" or as a proper hold */
+            d->m_superKeyHoldTimer.start();
+        } else {
+            d->m_superKeyHoldTimer.stop();
+
+            /* If the key is released, and was not being held, it means that the user just
+               performed a "tap". Unless we're told to ignore that tap, that is. */
+            if (!d->m_superKeyHeld && !d->m_superPressIgnored) {
+                onSuperKeyTapped();
+            }
+            /* Otherwise the user just terminated a hold. */
+            else if(d->m_superKeyHeld){
+                d->m_superKeyHeld = false;
+                Q_EMIT superKeyHeldChanged(d->m_superKeyHeld);
+            }
+        }
+    }
+}
+
+void
+ShellManager::ignoreSuperPress()
+{
+    /* There was a key pressed, ignore current super tap/hold */
+    d->m_superPressIgnored = true;
+}
+
+void
+ShellManager::onSuperKeyTapped()
+{
+    // TODO : In future, All shells should be able to handle the Dash
+    // Note: Always, first item in the list is the topLeft shell
+    // In any case, just iterate through the list
+    Q_FOREACH(ShellDeclarativeView *shell, d->m_viewList) {
+        if (shell->isTopLeftShell()) {
+            shell->toggleDash();
+            break;
+        }
+    }
+}
+
+bool
+ShellManager::superKeyHeld() const
+{
+    return d->m_superKeyHeld;
+}
+
 /*------------------ Hotkeys Handling -----------------------*/
 
 void

=== modified file 'shell/app/shellmanager.h'
--- shell/app/shellmanager.h	2012-02-14 09:27:26 +0000
+++ shell/app/shellmanager.h	2012-02-15 09:37:18 +0000
@@ -26,12 +26,26 @@
 class ShellManager : public QObject
 {
     Q_OBJECT
+    Q_PROPERTY(bool superKeyHeld READ superKeyHeld NOTIFY superKeyHeldChanged)
+
 public:
     ShellManager(const QUrl &sourceFileUrl, QObject* parent = 0);
     ~ShellManager();
 
+    bool superKeyHeld() const;
+
+Q_SIGNALS:
+    void superKeyHeldChanged(bool superKeyHeld);
+
 private Q_SLOTS:
     void onScreenCountChanged(int);
+
+    void updateSuperKeyMonitoring();
+    void updateSuperKeyHoldState();
+    void setHotkeysForModifiers(Qt::KeyboardModifiers modifiers);
+    void ignoreSuperPress();
+    void onSuperKeyTapped();
+
     void onAltF1Pressed();
     void onAltF2Pressed();
     void onNumericHotkeyPressed();

=== modified file 'shell/launcher/LauncherList.qml'
--- shell/launcher/LauncherList.qml	2012-02-09 11:59:16 +0000
+++ shell/launcher/LauncherList.qml	2012-02-15 09:37:18 +0000
@@ -125,7 +125,7 @@
         emblemVisible: item.emblemVisible
 
         /* Launcher of index 0 is the so-called BFB or Dash launcher */
-        shortcutVisible: declarativeView.superKeyHeld &&
+        shortcutVisible: shellManager.superKeyHeld &&
                          ((item.toString().indexOf("LauncherApplication") == 0 && index > 0 && index <= 10) ||
                           item.shortcutKey != 0)
         shortcutText: {

=== modified file 'shell/launcher/LauncherLoader.qml'
--- shell/launcher/LauncherLoader.qml	2012-02-10 11:17:36 +0000
+++ shell/launcher/LauncherLoader.qml	2012-02-15 09:37:18 +0000
@@ -70,7 +70,7 @@
     }
 
     Connections {
-        target: declarativeView
+        target: shellManager
         onSuperKeyHeldChanged: {
             if (superKeyHeld) visibilityController.beginForceVisible()
             else visibilityController.endForceVisible()