Merge lp:~3v1n0/unity/super-tab-switcher into lp:unity

[Marco Trevisan (Treviño)]

Fixed bug #891620 to support the Super+Tab switcher.

Added a new launcher key switcher that matches design bug #891620, the key bindings are set to default to Super+Tab and Super+Shift+Tab by default, but they can be changed from compiz settings.

I've added some new functions to Launcher to manage the KeySwitcher and others to share the code between the switcher and the key navigation.

[Mirco Müller (macslow)]

The patch works as described in the manual test. Code looks ok too. But again the wording of the manual-test can be improved...

1.) State that the launcher should be filled with enough sticky (bamf/launcher) icons so the icons collapse in the folding layout and they are forced to expand when in keyboard-navigation.

2.) Note the term "sticky" meaning stickyness within the scope of bamf/launcher and not window workspace-stickyness. That way testers are not confused when reading through and reproducing the manual tests.

review: Needs Fixing

[Marco Trevisan (Treviño) (3v1n0)]

Manual test fixed as requested, so: approving the branch for merging.

[Unity Merger (unity-merger)]

Attempt to merge into lp:unity failed due to conflicts:

text conflict in plugins/unityshell/src/unityshell.cpp

=== added file 'manual-tests/SuperTab.txt'
--- manual-tests/SuperTab.txt	1970-01-01 00:00:00 +0000
+++ manual-tests/SuperTab.txt	2012-01-14 13:17:25 +0000
@@ -0,0 +1,22 @@
+Super Tab Launcher Switcher
+---------------------------
+This test shows how the Super+Tab launcher switcher works
+
+#. Open some applications pinned to the launcher
+#. Press Super+Tab
+#. Release and Press again Tab some times
+#. Press also the Shift key and press again Tab
+#. Release all the keys
+
+Outcome:
+  The first launcher item should be highlighted.
+  Pressing Tab multiple times makes the next launcher icon to be highlighted.
+  If clicking on the launcher while the Super+Tab switcher is active, the switcher
+  should terminate and the standard click action should be done.
+  When also the Shift modifier is pressed, pressing Tab highlights the previous
+  icon.
+  When releasing Super the highlighted launcher icon should be activated, and
+  the default launcher icon action should be performed.
+  If in the launcher there are many icons and they are shown as collapsed,
+  when the Super+Tab is activated and the icons should be expanded when
+  neeeded.

=== modified file 'plugins/unityshell/src/Launcher.cpp'
--- plugins/unityshell/src/Launcher.cpp	2012-01-07 17:15:49 +0000
+++ plugins/unityshell/src/Launcher.cpp	2012-01-14 13:17:25 +0000
@@ -247,6 +247,7 @@
   _render_drag_window     = false;
   _drag_edge_touching     = false;
   _keynav_activated       = false;
+  _key_switcher_activated = false;
   _backlight_mode         = BACKLIGHT_NORMAL;
   _last_button_press      = 0;
   _selection_atom         = 0;
@@ -1459,10 +1460,13 @@
 {
   Launcher* self = (Launcher*) data;
 
-  self->_shortcuts_shown = true;
-  self->_hover_machine->SetQuirk(LauncherHoverMachine::SHORTCUT_KEYS_VISIBLE, true);
+  if (!self->_key_switcher_activated)
+  {
+    self->_shortcuts_shown = true;
+    self->_hover_machine->SetQuirk(LauncherHoverMachine::SHORTCUT_KEYS_VISIBLE, true);
 
-  self->QueueDraw();
+    self->QueueDraw();
+  }
 
   self->_super_show_shortcuts_handle = 0;
   return false;
@@ -1920,7 +1924,8 @@
   Launcher* self = (Launcher*) data;
   nux::Geometry geo = self->GetGeometry();
 
-  if (self->_keynav_activated || !self->_hovered || self->GetActionState() == ACTION_DRAG_LAUNCHER)
+  if (self->_keynav_activated || self->_key_switcher_activated || !self->_hovered ||
+      self->GetActionState() == ACTION_DRAG_LAUNCHER)
     return TRUE;
 
   if (self->MouseOverTopScrollArea())
@@ -2597,6 +2602,122 @@
   _hide_machine->SetQuirk(LauncherHideMachine::MOUSE_MOVE_POST_REVEAL, true);
 }
 
+void Launcher::SelectPreviousIcon()
+{
+  if (_current_icon_index > 0)
+  {
+    LauncherModel::iterator it;
+    int temp_current_icon_index = _current_icon_index;
+    do
+    {
+      temp_current_icon_index --;
+      it = _model->at(temp_current_icon_index);
+    }
+    while (it != (LauncherModel::iterator)NULL && !(*it)->GetQuirk(LauncherIcon::QUIRK_VISIBLE));
+
+    if (it != (LauncherModel::iterator)NULL)
+    {
+      _current_icon_index = temp_current_icon_index;
+
+      if ((*it)->GetCenter().y + - _icon_size/ 2 < GetGeometry().y)
+        _launcher_drag_delta += (_icon_size + _space_between_icons);
+    }
+    EnsureAnimation();
+    selection_change.emit();
+  }
+}
+
+void Launcher::SelectNextIcon()
+{
+  if (_current_icon_index < _model->Size() - 1)
+  {
+    LauncherModel::iterator it;
+    int temp_current_icon_index = _current_icon_index;
+
+    do
+    {
+      temp_current_icon_index ++;
+      it = _model->at(temp_current_icon_index);
+    }
+    while (it != (LauncherModel::iterator)nullptr &&
+           !(*it)->GetQuirk(LauncherIcon::QUIRK_VISIBLE));
+
+    if (it != (LauncherModel::iterator)nullptr)
+    {
+      _current_icon_index = temp_current_icon_index;
+
+      if ((*it)->GetCenter().y + _icon_size / 2 > GetGeometry().height)
+        _launcher_drag_delta -= (_icon_size + _space_between_icons);
+    }
+
+    EnsureAnimation();
+    selection_change.emit();
+  }
+}
+
+void Launcher::KeySwitcherActivate()
+{
+  if (_key_switcher_activated)
+    return;
+
+  _hide_machine->SetQuirk(LauncherHideMachine::KEY_NAV_ACTIVE, true);
+  _hover_machine->SetQuirk(LauncherHoverMachine::KEY_NAV_ACTIVE, true);
+
+  _key_switcher_activated = true;
+
+  ubus_server_send_message(ubus_server_get_default(),
+                           UBUS_LAUNCHER_START_KEY_SWTICHER,
+                           g_variant_new_boolean(true));
+
+  KeySwitcherNext();
+}
+
+void Launcher::KeySwitcherTerminate()
+{
+  if (!_key_switcher_activated)
+    return;
+
+  LauncherModel::iterator it = _model->at(_current_icon_index);
+
+  if (it != (LauncherModel::iterator)NULL)
+    (*it)->Activate(ActionArg(ActionArg::LAUNCHER, 0));
+
+  _hide_machine->SetQuirk(LauncherHideMachine::KEY_NAV_ACTIVE, false);
+  _hover_machine->SetQuirk(LauncherHoverMachine::KEY_NAV_ACTIVE, false);
+
+  ubus_server_send_message(ubus_server_get_default(),
+                           UBUS_LAUNCHER_END_KEY_SWTICHER,
+                           g_variant_new_boolean(true));
+
+  _key_switcher_activated = false;
+  _current_icon_index = -1;
+  _last_icon_index = -1;
+  QueueDraw();
+
+  selection_change.emit();
+}
+
+bool Launcher::KeySwitcherIsActive()
+{
+  return _key_switcher_activated;
+}
+
+void Launcher::KeySwitcherNext()
+{
+  if (!_key_switcher_activated)
+    return;
+
+  SelectNextIcon();
+}
+
+void Launcher::KeySwitcherPrevious()
+{
+  if (!_key_switcher_activated)
+    return;
+
+  SelectPreviousIcon();
+}
+
 void
 Launcher::RecvKeyPressed(unsigned long    eventType,
                          unsigned long    key_sym,
@@ -2619,53 +2740,13 @@
       // up (move selection up or go to global-menu if at top-most icon)
     case NUX_VK_UP:
     case NUX_KP_UP:
-      if (_current_icon_index > 0)
-      {
-        int temp_current_icon_index = _current_icon_index;
-        do
-        {
-          temp_current_icon_index --;
-          it = _model->at(temp_current_icon_index);
-        }
-        while (it != (LauncherModel::iterator)NULL && !(*it)->GetQuirk(LauncherIcon::QUIRK_VISIBLE));
-
-        if (it != (LauncherModel::iterator)NULL)
-        {
-          _current_icon_index = temp_current_icon_index;
-
-          if ((*it)->GetCenter().y + - _icon_size/ 2 < GetGeometry().y)
-            _launcher_drag_delta += (_icon_size + _space_between_icons);
-        }
-        EnsureAnimation();
-        selection_change.emit();
-      }
+      SelectPreviousIcon();
       break;
 
       // down (move selection down and unfold launcher if needed)
     case NUX_VK_DOWN:
     case NUX_KP_DOWN:
-      if (_current_icon_index < _model->Size() - 1)
-      {
-        int temp_current_icon_index = _current_icon_index;
-
-        do
-        {
-          temp_current_icon_index ++;
-          it = _model->at(temp_current_icon_index);
-        }
-        while (it != (LauncherModel::iterator)NULL && !(*it)->GetQuirk(LauncherIcon::QUIRK_VISIBLE));
-
-        if (it != (LauncherModel::iterator)NULL)
-        {
-          _current_icon_index = temp_current_icon_index;
-
-          if ((*it)->GetCenter().y + _icon_size / 2 > GetGeometry().height)
-            _launcher_drag_delta -= (_icon_size + _space_between_icons);
-        }
-
-        EnsureAnimation();
-        selection_change.emit();
-      }
+      SelectNextIcon();
       break;
 
       // esc/left (close quicklist or exit laucher key-focus)
@@ -2793,6 +2874,12 @@
     _start_dragicon_handle = g_timeout_add(START_DRAGICON_DURATION, &Launcher::StartIconDragTimeout, this);
 
     launcher_icon->mouse_down.emit(nux::GetEventButton(button_flags));
+
+    if (_key_switcher_activated)
+    {
+      _current_icon_index = -1;
+      KeySwitcherTerminate();
+    }
   }
 }
 

=== modified file 'plugins/unityshell/src/Launcher.h'
--- plugins/unityshell/src/Launcher.h	2011-12-08 01:23:11 +0000
+++ plugins/unityshell/src/Launcher.h	2012-01-14 13:17:25 +0000
@@ -199,12 +199,20 @@
   sigc::signal<void> selection_change;
   sigc::signal<void> hidden_changed;
 
-
   // Key navigation
   virtual bool InspectKeyEvent(unsigned int eventType,
                                unsigned int keysym,
                                const char* character);
 
+  void SelectPreviousIcon();
+  void SelectNextIcon();
+
+  void KeySwitcherActivate();
+  void KeySwitcherTerminate();
+  bool KeySwitcherIsActive();
+  void KeySwitcherNext();
+  void KeySwitcherPrevious();
+
 protected:
   // Introspectable methods
   std::string GetName() const;
@@ -403,6 +411,7 @@
 
   bool          _shortcuts_shown;
   bool          _keynav_activated;
+  bool          _key_switcher_activated;
   guint64       _latest_shortcut;
 
   BacklightMode _backlight_mode;

=== modified file 'plugins/unityshell/src/UBusMessages.h'
--- plugins/unityshell/src/UBusMessages.h	2012-01-08 14:02:45 +0000
+++ plugins/unityshell/src/UBusMessages.h	2012-01-14 13:17:25 +0000
@@ -44,6 +44,8 @@
 // get rid of keyboard-input-focus
 #define UBUS_LAUNCHER_START_KEY_NAV  "LAUNCHER_START_KEY_NAV"
 #define UBUS_LAUNCHER_END_KEY_NAV    "LAUNCHER_END_KEY_NAV"
+#define UBUS_LAUNCHER_START_KEY_SWTICHER "LAUNCHER_START_KEY_SWITCHER"
+#define UBUS_LAUNCHER_END_KEY_SWTICHER   "LAUNCHER_END_KEY_SWITCHER"
 #define UBUS_LAUNCHER_ICON_URGENT_CHANGED "LAUNCHER_ICON_URGENT_CHANGED"
 #define UBUS_QUICKLIST_START_KEY_NAV "QUICKLIST_START_KEY_NAV"
 #define UBUS_QUICKLIST_END_KEY_NAV   "QUICKLIST_END_KEY_NAV"

=== modified file 'plugins/unityshell/src/unity-root-accessible.cpp'
--- plugins/unityshell/src/unity-root-accessible.cpp	2011-09-22 13:08:52 +0000
+++ plugins/unityshell/src/unity-root-accessible.cpp	2012-01-14 13:17:25 +0000
@@ -352,8 +352,8 @@
 }
 
 static void
-ubus_launcher_start_key_nav_cb(GVariant* variant,
-                               UnityRootAccessible* self)
+ubus_launcher_register_interest_cb(GVariant* variant,
+                                   UnityRootAccessible* self)
 {
   //launcher window is the same during all the life of Unity
   if (self->priv->launcher_window == NULL)
@@ -392,7 +392,12 @@
   static unity::UBusManager ubus_manager;
 
   ubus_manager.RegisterInterest(UBUS_LAUNCHER_START_KEY_NAV,
-                                sigc::bind(sigc::ptr_fun(ubus_launcher_start_key_nav_cb), self));
+                                sigc::bind(sigc::ptr_fun(ubus_launcher_register_interest_cb),
+                                self));
+
+  ubus_manager.RegisterInterest(UBUS_LAUNCHER_START_KEY_SWTICHER,
+                                sigc::bind(sigc::ptr_fun(ubus_launcher_register_interest_cb),
+                                self));
 
   nux::GetWindowCompositor().sigVisibleViewWindow.
   connect(sigc::bind(sigc::ptr_fun(wc_change_visibility_window_cb), self, TRUE));

=== modified file 'plugins/unityshell/src/unityshell.cpp'
--- plugins/unityshell/src/unityshell.cpp	2012-01-13 15:35:44 +0000
+++ plugins/unityshell/src/unityshell.cpp	2012-01-14 13:17:25 +0000
@@ -287,8 +287,13 @@
 
      optionSetAltTabPrevWindowInitiate(boost::bind(&UnityScreen::altTabPrevWindowInitiate, this, _1, _2, _3));
 
-     optionSetAltTabLeftInitiate (boost::bind (&UnityScreen::altTabPrevInitiate, this, _1, _2, _3));
-     optionSetAltTabRightInitiate (boost::bind (&UnityScreen::altTabForwardInitiate, this, _1, _2, _3));
+     optionSetAltTabLeftInitiate(boost::bind (&UnityScreen::altTabPrevInitiate, this, _1, _2, _3));
+     optionSetAltTabRightInitiate(boost::bind (&UnityScreen::altTabForwardInitiate, this, _1, _2, _3));
+
+     optionSetLauncherSwitcherForwardInitiate(boost::bind(&UnityScreen::launcherSwitcherForwardInitiate, this, _1, _2, _3));
+     optionSetLauncherSwitcherPrevInitiate(boost::bind(&UnityScreen::launcherSwitcherPrevInitiate, this, _1, _2, _3));
+     optionSetLauncherSwitcherForwardTerminate(boost::bind(&UnityScreen::launcherSwitcherTerminate, this, _1, _2, _3));
+
      optionSetShowMinimizedWindowsNotify (boost::bind (&UnityScreen::optionChanged, this, _1, _2));
 
      for (unsigned int i = 0; i < G_N_ELEMENTS(_ubus_handles); i++)
@@ -1121,10 +1126,12 @@
         // we should just say "key_string[1] = 0" because that is the only
         // thing that could possibly make sense here.
         key_string[result] = 0;
-        if (super_keypressed_) {
+        if (super_keypressed_)
+        {
           shortcut_controller_->Hide();
           skip_other_plugins = launcher.CheckSuperShortcutPressed(screen->dpy(), key_sym, event->xkey.keycode, event->xkey.state, key_string);
-          if (!skip_other_plugins) {
+          if (!skip_other_plugins)
+          {
             skip_other_plugins = dash_controller_->CheckShortcutActivation(key_string);
             if (skip_other_plugins)
               launcher.SetLatestShortcut(key_string[0]);
@@ -1273,6 +1280,7 @@
 {
   super_keypressed_ = false;
   launcher_controller_->launcher().EndKeyShowLauncher();
+  launcher_controller_->launcher().KeySwitcherTerminate();
   shortcut_controller_->Hide();
   return false;
 }
@@ -1530,6 +1538,30 @@
   return false;
 }
 
+bool UnityScreen::launcherSwitcherForwardInitiate(CompAction* action, CompAction::State state, CompOption::Vector& options)
+{
+  Launcher& launcher = launcher_controller_->launcher();
+
+  if (!launcher.KeySwitcherIsActive())
+    launcher.KeySwitcherActivate();
+  else
+    launcher.KeySwitcherNext();
+
+  return false;
+}
+bool UnityScreen::launcherSwitcherPrevInitiate(CompAction* action, CompAction::State state, CompOption::Vector& options)
+{
+  launcher_controller_->launcher().KeySwitcherPrevious();
+
+  return false;
+}
+bool UnityScreen::launcherSwitcherTerminate(CompAction* action, CompAction::State state, CompOption::Vector& options)
+{
+  launcher_controller_->launcher().KeySwitcherTerminate();
+
+  return false;
+}
+
 void UnityScreen::OnLauncherStartKeyNav(GVariant* data, void* value)
 {
   UnityScreen* self = reinterpret_cast<UnityScreen*>(value);

=== modified file 'plugins/unityshell/src/unityshell.h'
--- plugins/unityshell/src/unityshell.h	2012-01-13 15:35:44 +0000
+++ plugins/unityshell/src/unityshell.h	2012-01-14 13:17:25 +0000
@@ -192,6 +192,10 @@
   bool altTabNextWindowInitiate(CompAction* action, CompAction::State state, CompOption::Vector& options);
   bool altTabPrevWindowInitiate(CompAction* action, CompAction::State state, CompOption::Vector& options);
 
+  bool launcherSwitcherForwardInitiate(CompAction* action, CompAction::State state, CompOption::Vector& options);
+  bool launcherSwitcherPrevInitiate(CompAction* action, CompAction::State state, CompOption::Vector& options);
+  bool launcherSwitcherTerminate(CompAction* action, CompAction::State state, CompOption::Vector& options);
+
   /* handle option changes and change settings inside of the
    * panel and dock views */
   void optionChanged(CompOption*, Options num);

=== modified file 'plugins/unityshell/unityshell.xml.in'
--- plugins/unityshell/unityshell.xml.in	2011-12-19 22:18:53 +0000
+++ plugins/unityshell/unityshell.xml.in	2012-01-14 13:17:25 +0000
@@ -97,6 +97,16 @@
                         <_long>Open the first menu on the panel, allowing keyboard navigation thereafter.</_long>
                         <default>F10</default>
                   </option> 
+                  <option name="launcher_switcher_forward" type="key">
+                    <_short>Key to start the launcher application switcher</_short>
+                    <_long>Switch the applications using the launcher</_long>
+                    <default>&lt;Super&gt;Tab</default>
+                  </option>
+                  <option name="launcher_switcher_prev" type="key">
+                    <_short>Key to start the launcher application switcher in reverse</_short>
+                    <_long>Switch the applications using the launcher, in reverse order</_long>
+                    <default>&lt;Super&gt;&lt;Shift&gt;Tab</default>
+                  </option>
               </group>
               <group>
                 <_short>Switcher</_short>