Merge lp:~3v1n0/unity/alt+tab-scroll-wheel into lp:unity

[Marco Trevisan (Treviño)]

Partly fixes bug #824965 enabling scroll wheel on Alt+Tab to switch the active application.

[Thomi Richards (thomir-deactivatedaccount)]

Looks good, but with a few things that need fixing.

1) The docstrings for next_icon_mouse and previous_icon_mouse should say: "icon" instead of "application".

2) If possible, we should use constsants to define the mouse buttons in unity. These must be defined in X somewhere?

3)Your tests need to be split up, like this:

107 + def test_switcher_scroll_next(self):
108 + self.set_timeout_setting(False)
109 + sleep(1)
110 +
111 + self.switcher.initiate()
112 + sleep(.2)
113 +
114 + start = self.switcher.get_selection_index()
115 + self.switcher.next_icon_mouse()
116 + sleep(.2)
117 +
118 + end = self.switcher.get_selection_index()
119 + self.assertThat(start, NotEquals(0))
120 + self.assertThat(end, Equals(start + 1))
121 +

def test_switcher_ignores_fast_wheel_down_events(self):
122 + # Quickly repeatead events should be ignored (except the first)
123 + start = self.switcher.get_selection_index()
124 + self.switcher.next_icon_mouse()
125 + self.switcher.next_icon_mouse()
126 + sleep(.2)
127 +
128 + end = self.switcher.get_selection_index()
129 + self.assertThat(end, Equals(start + 1))
130 +
131 + self.switcher.terminate()
132 +

133 + def test_switcher_scroll_prev(self):
134 + self.set_timeout_setting(False)
135 + sleep(1)
136 +
137 + self.switcher.initiate()
138 + sleep(.2)
139 +
140 + start = self.switcher.get_selection_index()
141 + self.switcher.previous_icon_mouse()
142 + sleep(.2)
143 +
144 + end = self.switcher.get_selection_index()
145 + self.assertThat(start, NotEquals(0))
146 + self.assertThat(end, Equals(start - 1))
147 +

def test_switcher_ignores_fast_wheel_down_events(self):
148 + # Quickly repeatead events should be ignored (except the first)
149 + start = self.switcher.get_selection_index()
150 + self.switcher.previous_icon_mouse()
151 + self.switcher.previous_icon_mouse()
152 + sleep(.2)
153 +
154 + end = self.switcher.get_selection_index()
155 + self.assertThat(end, Equals(start - 1))
156 +
157 + self.switcher.terminate()
158 + self.set_timeout_setting(True)
159 +

review: Needs Fixing

[Thomi Richards (thomir-deactivatedaccount)]

Looks good

review: Approve

[Alex Launi (alexlauni)]

This currently has conflicts with trunk in plugins/unityshell/src/unityshell.cpp

review: Needs Fixing

[Alex Launi (alexlauni)]

nice

review: Approve

[Unity Merger (unity-merger)]

The Jenkins job https://jenkins.qa.ubuntu.com/job/automerge-unity/431/console reported an error when processing this lp:~3v1n0/unity/alt+tab-scroll-wheel branch.
Not merging it.

=== modified file 'plugins/unityshell/src/unityshell.cpp'
--- plugins/unityshell/src/unityshell.cpp	2012-03-06 18:24:09 +0000
+++ plugins/unityshell/src/unityshell.cpp	2012-03-07 17:27:25 +0000
@@ -93,6 +93,8 @@
 {
 // Tap duration in milliseconds.
 const int ALT_TAP_DURATION = 250;
+const unsigned int SCROLL_DOWN_BUTTON = 6;
+const unsigned int SCROLL_UP_BUTTON = 7;
 } // namespace local
 } // anon namespace
 
@@ -124,6 +126,7 @@
   , dash_is_open_ (false)
   , grab_index_ (0)
   , painting_tray_ (false)
+  , last_scroll_event_(0)
   , last_hud_show_time_(0)
 {
   Timer timer;
@@ -1340,6 +1343,25 @@
         EnableCancelAction(false);
       }
       break;
+    case ButtonRelease:
+      if (switcher_controller_ && switcher_controller_->Visible())
+      {
+        XButtonEvent *bev = reinterpret_cast<XButtonEvent*>(event);
+        if (bev->time - last_scroll_event_ > 150)
+        {
+          if (bev->button == Button4 || bev->button == local::SCROLL_UP_BUTTON)
+          {
+            switcher_controller_->Prev();
+            last_scroll_event_ = bev->time;
+          }
+          else if (bev->button == Button5 || bev->button == local::SCROLL_DOWN_BUTTON)
+          {
+            switcher_controller_->Next();
+            last_scroll_event_ = bev->time;
+          }
+        }
+      }
+      break;
     case KeyPress:
     {
       KeySym key_sym;
@@ -1601,7 +1623,7 @@
   return true;
 }
 
-bool UnityScreen::altTabInitiateCommon(switcher::ShowMode show_mode)
+bool UnityScreen::altTabInitiateCommon(CompAction* action, switcher::ShowMode show_mode)
 {
   if (!grab_index_)
     grab_index_ = screen->pushGrab (screen->invisibleCursor(), "unity-switcher");
@@ -1619,6 +1641,14 @@
   screen->addAction(&optionGetAltTabDetailStop());
   screen->addAction(&optionGetAltTabLeft());
 
+  /* Create a new keybinding for scroll buttons and current modifiers */
+  CompAction scroll_up;
+  CompAction scroll_down;
+  scroll_up.setButton(CompAction::ButtonBinding(local::SCROLL_UP_BUTTON, action->key().modifiers()));
+  scroll_down.setButton(CompAction::ButtonBinding(local::SCROLL_DOWN_BUTTON, action->key().modifiers()));
+  screen->addAction(&scroll_up);
+  screen->addAction(&scroll_down);
+
   // maybe check launcher position/hide state?
 
   int device = screen->outputDeviceForPoint (pointerX, pointerY);
@@ -1655,10 +1685,18 @@
     screen->removeGrab(grab_index_, NULL);
     grab_index_ = 0;
 
-    screen->removeAction (&optionGetAltTabRight ());
-    screen->removeAction (&optionGetAltTabDetailStart ());
-    screen->removeAction (&optionGetAltTabDetailStop ());
-    screen->removeAction (&optionGetAltTabLeft ());
+    screen->removeAction(&optionGetAltTabRight ());
+    screen->removeAction(&optionGetAltTabDetailStart ());
+    screen->removeAction(&optionGetAltTabDetailStop ());
+    screen->removeAction(&optionGetAltTabLeft ());
+
+    /* Removing the scroll actions */
+    CompAction scroll_up;
+    CompAction scroll_down;
+    scroll_up.setButton(CompAction::ButtonBinding(local::SCROLL_UP_BUTTON, action->key().modifiers()));
+    scroll_down.setButton(CompAction::ButtonBinding(local::SCROLL_DOWN_BUTTON, action->key().modifiers()));
+    screen->removeAction(&scroll_up);
+    screen->removeAction(&scroll_down);
 
     bool accept_state = (state & CompAction::StateCancel) == 0;
     switcher_controller_->Hide(accept_state);
@@ -1675,7 +1713,7 @@
   if (switcher_controller_->Visible())
     switcher_controller_->Next();
   else
-    altTabInitiateCommon(switcher::ShowMode::CURRENT_VIEWPORT);
+    altTabInitiateCommon(action, switcher::ShowMode::CURRENT_VIEWPORT);
 
   action->setState(action->state() | CompAction::StateTermKey);
   return true;
@@ -1688,7 +1726,7 @@
   if (switcher_controller_->Visible())
     switcher_controller_->Next();
   else
-    altTabInitiateCommon(switcher::ShowMode::ALL);
+    altTabInitiateCommon(action, switcher::ShowMode::ALL);
 
   action->setState(action->state() | CompAction::StateTermKey);
   return true;
@@ -1730,7 +1768,7 @@
 {
   if (!switcher_controller_->Visible())
   {
-    altTabInitiateCommon(switcher::ShowMode::CURRENT_VIEWPORT);
+    altTabInitiateCommon(action, switcher::ShowMode::CURRENT_VIEWPORT);
     switcher_controller_->Select(1); // always select the current application
   }
 

=== modified file 'plugins/unityshell/src/unityshell.h'
--- plugins/unityshell/src/unityshell.h	2012-03-06 18:24:09 +0000
+++ plugins/unityshell/src/unityshell.h	2012-03-07 17:27:25 +0000
@@ -192,7 +192,7 @@
   bool executeCommand(CompAction* action, CompAction::State state, CompOption::Vector& options);
   bool setKeyboardFocusKeyInitiate(CompAction* action, CompAction::State state, CompOption::Vector& options);
 
-  bool altTabInitiateCommon(switcher::ShowMode mode);
+  bool altTabInitiateCommon(CompAction* action, switcher::ShowMode mode);
   bool altTabTerminateCommon(CompAction* action,
                              CompAction::State state,
                              CompOption::Vector& options);
@@ -331,6 +331,7 @@
   CompWindowList         fullscreen_windows_;
   bool                   painting_tray_;
   unsigned int           tray_paint_mask_;
+  unsigned int           last_scroll_event_;
   gint64                 last_hud_show_time_;
 
   GLMatrix panel_shadow_matrix_;

=== modified file 'tests/autopilot/autopilot/emulators/unity/switcher.py'
--- tests/autopilot/autopilot/emulators/unity/switcher.py	2012-03-06 19:03:00 +0000
+++ tests/autopilot/autopilot/emulators/unity/switcher.py	2012-03-07 17:27:25 +0000
@@ -12,7 +12,7 @@
 
 from autopilot.keybindings import KeybindingsHelper
 from autopilot.emulators.unity import get_state_by_path, make_introspection_object
-from autopilot.emulators.X11 import Keyboard
+from autopilot.emulators.X11 import Keyboard, Mouse
 
 # even though we don't use these directly, we need to make sure they've been
 # imported so the classes contained are registered with the introspection API.
@@ -29,6 +29,7 @@
     def __init__(self):
         super(Switcher, self).__init__()
         self._keyboard = Keyboard()
+        self._mouse = Mouse()
 
     def initiate(self):
         """Start the switcher with alt+tab."""
@@ -78,15 +79,27 @@
         self.keybinding_release("switcher/reveal_normal")
 
     def next_icon(self):
-        """Move to the next application."""
+        """Move to the next icon."""
         logger.debug("Selecting next item in switcher.")
         self.keybinding("switcher/next")
 
     def previous_icon(self):
-        """Move to the previous application."""
+        """Move to the previous icon."""
         logger.debug("Selecting previous item in switcher.")
         self.keybinding("switcher/prev")
 
+    def next_icon_mouse(self):
+        """Move to the next icon using the mouse scroll wheel"""
+        logger.debug("Selecting next item in switcher with mouse scroll wheel.")
+        self._mouse.press(6)
+        self._mouse.release(6)
+
+    def previous_icon_mouse(self):
+        """Move to the previous icon using the mouse scroll wheel"""
+        logger.debug("Selecting previous item in switcher with mouse scroll wheel.")
+        self._mouse.press(7)
+        self._mouse.release(7)
+
     def show_details(self):
         """Show detail mode."""
         logger.debug("Showing details view.")

=== modified file 'tests/autopilot/autopilot/tests/test_switcher.py'
--- tests/autopilot/autopilot/tests/test_switcher.py	2012-03-06 19:03:00 +0000
+++ tests/autopilot/autopilot/tests/test_switcher.py	2012-03-07 17:27:25 +0000
@@ -65,7 +65,79 @@
 
         self.assertThat(start, NotEquals(0))
         self.assertThat(end, Equals(start - 1))
-        self.set_timeout_setting(True)
+
+    def test_switcher_scroll_next(self):
+        self.set_timeout_setting(False)
+        sleep(1)
+
+        self.switcher.initiate()
+        sleep(.2)
+
+        start = self.switcher.get_selection_index()
+        self.switcher.next_icon_mouse()
+        sleep(.2)
+
+        end = self.switcher.get_selection_index()
+        self.assertThat(start, NotEquals(0))
+        self.assertThat(end, Equals(start + 1))
+
+        self.switcher.terminate()
+
+    def test_switcher_scroll_prev(self):
+        self.set_timeout_setting(False)
+        sleep(1)
+
+        self.switcher.initiate()
+        sleep(.2)
+
+        start = self.switcher.get_selection_index()
+        self.switcher.previous_icon_mouse()
+        sleep(.2)
+
+        end = self.switcher.get_selection_index()
+        self.assertThat(start, NotEquals(0))
+        self.assertThat(end, Equals(start - 1))
+
+        self.switcher.terminate()
+
+    def test_switcher_scroll_next_ignores_fast_events(self):
+        self.set_timeout_setting(False)
+        sleep(1)
+
+        self.switcher.initiate()
+        sleep(.2)
+
+        # Quickly repeatead events should be ignored (except the first)
+        start = self.switcher.get_selection_index()
+        self.switcher.next_icon_mouse()
+        self.switcher.next_icon_mouse()
+        self.switcher.next_icon_mouse()
+        sleep(.2)
+
+        end = self.switcher.get_selection_index()
+        self.assertThat(start, NotEquals(0))
+        self.assertThat(end, Equals(start + 1))
+
+        self.switcher.terminate()
+
+    def test_switcher_scroll_prev_ignores_fast_events(self):
+        self.set_timeout_setting(False)
+        sleep(1)
+
+        self.switcher.initiate()
+        sleep(.2)
+
+        # Quickly repeatead events should be ignored (except the first)
+        start = self.switcher.get_selection_index()
+        self.switcher.previous_icon_mouse()
+        self.switcher.previous_icon_mouse()
+        self.switcher.previous_icon_mouse()
+        sleep(.2)
+
+        end = self.switcher.get_selection_index()
+        self.assertThat(end, Equals(start - 1))
+
+        self.switcher.terminate()
 
     def test_switcher_arrow_key_does_not_init(self):
         self.set_timeout_setting(False)