Merge lp:~townsend/unity/fix_lp765732 into lp:unity

[Christopher Townsend]

Add the ability to progressively autoscroll the Launcher when there are stacked icons.

This adds to ability to progressively autoscroll when there are enough icons to be stacked and the mouse cursor is within the 24 pixel high autoscroll zone at the bottom and top of the Launcher.

Also added new autoscrolling AP tests for testing autoscrolling at the top and bottom of the Launcher.

[Thomi Richards (thomir-deactivatedaccount)]

Hi,

146 + def open_apps_in_launcher(self):
147 + """Opens some apps in order to get icon stacking in the Launcher"""
148 + apps = [
149 + ("Calculator"),
150 + ("Mahjongg"),
151 + ("Text Editor"),
152 + ("Character Map"),
153 + ("Terminal"),
154 + ("Remmina")
155 + ]
156 + for app in apps:
157 + self.start_app_window(app)

I think this is better expressed as:

apps = ("Calculator", "Mahjongg", "Text Editor", "Character Map", "Terminal", "Remina")
for app in apps:
    self.start_app_window(app)

i.e.- don't need the parenthesis around each app name, and using a tuple is better than a list, since we don't need to modify the contents.

I'm also a bit worried that the unity code might break existing autopilot tests. We've kicked off an autopilot run here:

http://10.97.0.6:8080/view/autopilot/job/autopilot-run-custom-branch/35/

So please don't merge this until those tests pass (or at least, don't show serious regressions compared to trunk).

Cheers,

review: Needs Fixing

[Brandon Schaefer (brandontschaefer)]

Awesome, this works waaaay better then trunk atm. Just a few things:

Wait for AP tests to check out
Fix thomis comment above
Add an int const for the FPS (the 30)
Check the launcher standalone for any bugs

Once those are done we are ready for a merge :).

review: Needs Fixing

[Brandon Schaefer (brandontschaefer)]

Ignore these results, a new one will be starting soon....the login screen got stuck on!
http://10.97.0.6:8080/view/autopilot/job/autopilot-run-custom-branch/35/

Im guessing it'll be branch 36, but we'll see :)

[Christopher Townsend (townsend)]

Thanks Thomi and Brandon!

I made the suggested changes to the code.

Looks like the AP tests finally completed, so we are good there.

And the weirdness seen in standalone is not due to my change, but due to the fact that the Launcher is taller than the standalone window it's drawn in, so scrolling from the bottom doesn't work since it's off the window:( The same thing happened with unity-standalone built from trunk.

[Brandon Schaefer (brandontschaefer)]

For reference, here is the AP tests running:
http://10.97.0.6:8080/view/autopilot/job/autopilot-run-custom-branch/41/

Nothing that this branch is causing, so Im happy with the changes (and works waay better then trunk :)

review: Approve

[PS Jenkins bot (ps-jenkins)]

review: Approve (continuous-integration)

=== modified file 'launcher/Launcher.cpp'
--- launcher/Launcher.cpp	2013-03-06 16:38:17 +0000
+++ launcher/Launcher.cpp	2013-03-13 18:53:21 +0000
@@ -91,6 +91,9 @@
 const int MOUSE_DEADZONE = 15;
 const float DRAG_OUT_PIXELS = 300.0f;
 
+const int SCROLL_AREA_HEIGHT = 24;
+const int SCROLL_FPS = 30;
+
 const std::string START_DRAGICON_TIMEOUT = "start-dragicon-timeout";
 const std::string SCROLL_TIMEOUT = "scroll-timeout";
 const std::string ANIMATION_IDLE = "animation-idle";
@@ -1503,27 +1506,18 @@
 
 bool Launcher::MouseOverTopScrollArea()
 {
-  return _mouse_position.y < panel::Style::Instance().panel_height;
-}
-
-bool Launcher::MouseOverTopScrollExtrema()
-{
-  return _mouse_position.y == 0;
+  return _mouse_position.y < SCROLL_AREA_HEIGHT;
 }
 
 bool Launcher::MouseOverBottomScrollArea()
 {
-  return _mouse_position.y > GetGeometry().height - panel::Style::Instance().panel_height;
-}
-
-bool Launcher::MouseOverBottomScrollExtrema()
-{
-  return _mouse_position.y == GetGeometry().height - 1;
+  return _mouse_position.y >= GetGeometry().height - SCROLL_AREA_HEIGHT;
 }
 
 bool Launcher::OnScrollTimeout()
 {
   bool continue_animation = true;
+  int speed = 0;
 
   if (IsInKeyNavMode() || !_hovered ||
       GetActionState() == ACTION_DRAG_LAUNCHER)
@@ -1534,19 +1528,21 @@
   {
     if (_launcher_drag_delta >= _launcher_drag_delta_max)
       continue_animation = false;
-    else if (MouseOverTopScrollExtrema())
-      _launcher_drag_delta += 6;
     else
-      _launcher_drag_delta += 3;
+    {
+        speed = (SCROLL_AREA_HEIGHT - _mouse_position.y) / SCROLL_AREA_HEIGHT * SCROLL_FPS;
+        _launcher_drag_delta += speed;
+    }
   }
   else if (MouseOverBottomScrollArea())
   {
     if (_launcher_drag_delta <= _launcher_drag_delta_min)
       continue_animation = false;
-    else if (MouseOverBottomScrollExtrema())
-      _launcher_drag_delta -= 6;
     else
-      _launcher_drag_delta -= 3;
+    {
+        speed = ((_mouse_position.y + 1) - (GetGeometry().height - SCROLL_AREA_HEIGHT)) / SCROLL_AREA_HEIGHT * SCROLL_FPS;
+        _launcher_drag_delta -= speed;
+    } 
   }
   else
   {

=== modified file 'launcher/Launcher.h'
--- launcher/Launcher.h	2013-03-05 19:11:25 +0000
+++ launcher/Launcher.h	2013-03-13 18:53:21 +0000
@@ -243,10 +243,8 @@
   void EnsureScrollTimer();
 
   bool MouseOverTopScrollArea();
-  bool MouseOverTopScrollExtrema();
 
   bool MouseOverBottomScrollArea();
-  bool MouseOverBottomScrollExtrema();
 
   float DnDStartProgress(struct timespec const& current) const;
   float DnDExitProgress(struct timespec const& current) const;

=== modified file 'tests/autopilot/unity/emulators/launcher.py'
--- tests/autopilot/unity/emulators/launcher.py	2013-02-28 17:38:29 +0000
+++ tests/autopilot/unity/emulators/launcher.py	2013-03-13 18:53:21 +0000
@@ -419,6 +419,27 @@
         pin_item = quicklist.get_quicklist_item_by_text('Unlock from Launcher')
         quicklist.click_item(pin_item)
 
+    def autoscroll_to_icon(self, icon, autoscroll_offset=0):
+        """Moves the mouse to the autoscroll zone to scroll the Launcher to the icon
+           in question.
+
+           autoscroll_offet is the offset, in number of pixels, from the end of the
+           autoscroll zone where is the autoscroll zone is currently 24 pixels high.
+        """
+        (x, y, w, h) = self.geometry
+
+        while 1:
+            mouse_x = target_x = icon.center_x + self.x
+            mouse_y = target_y = icon.center_y
+            if target_y > h:
+                mouse_y = h + y - autoscroll_offset
+            elif target_y < 0:
+                mouse_y = y + autoscroll_offset
+            if self._mouse.x == target_x and self._mouse.y == target_y:
+                break
+            self._mouse.move(mouse_x, mouse_y)
+            sleep(0.5)
+
     @property
     def geometry(self):
         """Returns a tuple of (x,y,w,h) for the current launcher."""

=== added file 'tests/autopilot/unity/tests/launcher/test_scroll.py'
--- tests/autopilot/unity/tests/launcher/test_scroll.py	1970-01-01 00:00:00 +0000
+++ tests/autopilot/unity/tests/launcher/test_scroll.py	2013-03-13 18:53:21 +0000
@@ -0,0 +1,92 @@
+# -*- Mode: Python; coding: utf-8; indent-tabs-mode: nil; tab-width: 4 -*-
+# Copyright 2013 Canonical
+# Authors: Chris Townsend
+#
+# This program is free software: you can redistribute it and/or modify it
+# under the terms of the GNU General Public License version 3, as published
+# by the Free Software Foundation.
+
+from __future__ import absolute_import
+
+from autopilot.matchers import Eventually
+import logging
+from testtools.matchers import Equals, GreaterThan, LessThan
+from time import sleep
+
+from unity.tests.launcher import LauncherTestCase
+
+logger = logging.getLogger(__name__)
+
+class LauncherScrollTests(LauncherTestCase):
+    """Tests for scrolling behavior of the Launcher"""
+
+    def open_apps_in_launcher(self):
+        """Opens some apps in order to get icon stacking in the Launcher"""
+        apps = ("Calculator", "Mahjongg", "Text Editor", "Character Map", "Terminal", "Remmina")
+        
+        for app in apps:
+            self.start_app_window(app)
+   
+    def test_autoscrolling_from_bottom(self):
+        """Tests the autoscrolling from the bottom of the Launcher"""
+        self.open_apps_in_launcher()
+
+        # Set the autoscroll_offset to 10 (this is arbitrary for this test).
+        autoscroll_offset = 10
+
+        launcher_instance = self.get_launcher()
+        (x, y, w, h) = launcher_instance.geometry
+
+        icons = self.unity.launcher.model.get_launcher_icons()
+        num_icons = self.unity.launcher.model.num_launcher_icons()
+
+        last_icon = icons[num_icons - 1]
+
+        # Move mouse to the middle of the Launcher in order to expand all
+        # of the icons for scrolling
+        launcher_instance.move_mouse_over_launcher()
+
+        # Make sure the last icon is off the screen or else there is no
+        # scrolling.
+        self.assertThat(last_icon.center_y, Eventually(GreaterThan(h)))
+
+        # Autoscroll to the last icon
+        launcher_instance.autoscroll_to_icon(last_icon, autoscroll_offset)
+        
+        (x_fin, y_fin) = self.mouse.position()
+
+        # Make sure we ended up in the center of the last icon
+        self.assertThat(x_fin, Equals(last_icon.center_x))
+        self.assertThat(y_fin, Equals(last_icon.center_y))
+
+    def test_autoscrolling_from_top(self):
+        """Test the autoscrolling from the top of the Launcher"""
+        self.open_apps_in_launcher()
+
+        # Set the autoscroll_offset to 10 (this is arbitrary for this test).
+        autoscroll_offset = 10
+
+        launcher_instance = self.get_launcher()
+        (x, y, w, h) = launcher_instance.geometry
+
+        icons = self.unity.launcher.model.get_launcher_icons()
+        num_icons = self.unity.launcher.model.num_launcher_icons()
+
+        first_icon = icons[0]
+        last_icon = icons[num_icons - 1]
+
+        # Move to the last icon in order to expand the top of the Launcher
+        launcher_instance.move_mouse_to_icon(last_icon)
+
+        # Make sure the first icon is off the screen or else there is no
+        # scrolling.
+        self.assertThat(first_icon.center_y, Eventually(LessThan(y)))
+        
+        # Autoscroll to the first icon
+        launcher_instance.autoscroll_to_icon(first_icon, autoscroll_offset)
+
+        (x_fin, y_fin) = self.mouse.position()
+
+        # Make sure we ended up in the center of the first icon
+        self.assertThat(x_fin, Equals(first_icon.center_x))
+        self.assertThat(y_fin, Equals(first_icon.center_y))