Merge lp:~unity-team/unity/fixes.unityshell-overlay into lp:unity

[Brandon Schaefer]

Fixes unityshell.cpp not taking into account of the hud overlay being active.

== Problem ==
The hud being open in the unityshell wasn't taken into account. As it is an overlay there were somethings not happening for it. One big thing was input focus, now switching from the dash->hud works correctly!

The problem being is if you have the dash open then open the hud it opens the hud THEN closes the dash. This caused the dash to set key focus to NULL, which would remove key focus from the hud that had already been opened.

Also switching workspace didn't close the hud for me.

Along with make sure alt+f1 is disabled when the hud is opened.

== Fix ==
Exposed HideDash, so when the hud is about to show we can correctly close the dash BEFORE we open the hud.

Made an IsOverlayOpen function for LauncherController, which checks if any launchers have an overlay open. Using this in unityshell.cpp instead of keeping track of a boolean dash_is_open, which wasn't getting updated correctly.

== Test ==
Lots of autopilot!
-Make sure Alt+F1 is disabled
-Open Hud->Dash, make sure Alt+F1 is disabled
-Open Dash->Hud and make sure we have key focus
-Make sure the Hud closes when you switch workspaces

[Tim Penhey (thumper)]

launcher_controller_->launcher() doesn't give the active launcher, but the launcher for window 0, so perhaps not best to use it that way :(

[Tim Penhey (thumper)]

Perhaps a better way is to add a method to LauncherController, for IsOverlayOpen, which traverses all its launchers, and returns true if any are true.

[Brandon Schaefer (brandontschaefer)]

Thanks, good catch. Plus it looks better when used. As opposed to launcher_controller->launcher().IsOverlayOpen()...

[Tim Penhey (thumper)]

Much better.

[Thomi Richards (thomir)]

Approved, thanks!

review: Approve

[Unity Merger (unity-merger)]

No commit message specified.

[Unity Merger (unity-merger)]

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

text conflict in plugins/unityshell/src/unityshell.cpp
text conflict in tests/autopilot/autopilot/emulators/unity/hud.py
text conflict in tests/autopilot/autopilot/tests/test_hud.py

[lp:~unity-team/unity/fixes.unityshell-overlay]

2180. By Brandon Schaefer on 2012-03-30

* merged trunk, conficts resolved

[Brandon Schaefer (brandontschaefer)]

Ran 42 tests in 158.498s
OK

All Hud ap test pass.

[Brandon Schaefer (brandontschaefer)]

Opps, wrong mp...

=== modified file 'plugins/unityshell/src/DashController.h'
--- plugins/unityshell/src/DashController.h	2012-03-21 12:31:11 +0000
+++ plugins/unityshell/src/DashController.h	2012-03-30 04:03:19 +0000
@@ -56,6 +56,8 @@
 
   sigc::signal<void> on_realize;
 
+  void HideDash(bool restore_focus = true);
+
 protected:
   std::string GetName() const;
   void AddProperties(GVariantBuilder* builder);
@@ -78,7 +80,6 @@
   void OnActivateRequest(GVariant* variant);
 
   void ShowDash();
-  void HideDash(bool restore_focus = true);
 
   void StartShowHideTimeline();
   static gboolean OnViewShowHideFrame(Controller* self);

=== modified file 'plugins/unityshell/src/Launcher.h'
--- plugins/unityshell/src/Launcher.h	2012-03-28 02:42:13 +0000
+++ plugins/unityshell/src/Launcher.h	2012-03-30 04:03:19 +0000
@@ -130,6 +130,8 @@
   void ExitKeyNavMode();
   bool IsInKeyNavMode() const;
 
+  bool IsOverlayOpen() const;
+
   static const int ANIM_DURATION_SHORT;
 
   void RenderIconToTexture(nux::GraphicsEngine& GfxContext, AbstractLauncherIcon::Ptr icon, nux::ObjectPtr<nux::IOpenGLBaseTexture> texture);
@@ -274,7 +276,6 @@
 
   void OnOverlayHidden(GVariant* data);
   void OnOverlayShown(GVariant* data);
-  bool IsOverlayOpen() const;
 
   void DesaturateIcons();
   void SaturateIcons();

=== modified file 'plugins/unityshell/src/LauncherController.cpp'
--- plugins/unityshell/src/LauncherController.cpp	2012-03-28 02:42:13 +0000
+++ plugins/unityshell/src/LauncherController.cpp	2012-03-30 04:03:19 +0000
@@ -1142,6 +1142,16 @@
   return pimpl->launcher_keynav;
 }
 
+bool Controller::IsOverlayOpen() const
+{
+  for (auto launcher_ptr : pimpl->launchers)
+  {
+    if (launcher_ptr->IsOverlayOpen())
+      return true;
+  } 
+  return false;
+}
+
 std::string
 Controller::GetName() const
 {

=== modified file 'plugins/unityshell/src/LauncherController.h'
--- plugins/unityshell/src/LauncherController.h	2012-03-21 12:31:11 +0000
+++ plugins/unityshell/src/LauncherController.h	2012-03-30 04:03:19 +0000
@@ -75,6 +75,8 @@
   void KeyNavPrevious();
   bool KeyNavIsActive() const;
 
+  bool IsOverlayOpen() const;
+
 protected:
   // Introspectable methods
   std::string GetName() const;

=== modified file 'plugins/unityshell/src/LauncherIcon.cpp'
--- plugins/unityshell/src/LauncherIcon.cpp	2012-03-27 15:00:59 +0000
+++ plugins/unityshell/src/LauncherIcon.cpp	2012-03-30 04:03:19 +0000
@@ -77,6 +77,7 @@
   , _present_time_handle(0)
   , _time_delay_handle(0)
   , _sort_priority(0)
+  , _last_monitor(0)
   , _background_color(nux::color::White)
   , _glow_color(nux::color::White)
   , _shortcut(0)

=== modified file 'plugins/unityshell/src/unityshell.cpp'
--- plugins/unityshell/src/unityshell.cpp	2012-03-29 14:31:40 +0000
+++ plugins/unityshell/src/unityshell.cpp	2012-03-30 04:03:19 +0000
@@ -124,7 +124,6 @@
 #ifndef USE_GLES
   , _active_fbo (0)
 #endif
-  , dash_is_open_ (false)
   , grab_index_ (0)
   , painting_tray_ (false)
   , last_scroll_event_(0)
@@ -360,12 +359,10 @@
 
      BackgroundEffectHelper::updates_enabled = true;
 
-     ubus_manager_.RegisterInterest(UBUS_OVERLAY_SHOWN, [&](GVariant * args) {
-       dash_is_open_ = true;
+     ubus_manager_.RegisterInterest(UBUS_OVERLAY_SHOWN, [&](GVariant * args) { 
        dash_monitor_ = g_variant_get_int32(args);
        RaiseInputWindows();
      });
-     ubus_manager_.RegisterInterest(UBUS_OVERLAY_HIDDEN, [&](GVariant * args) { dash_is_open_ = false; });
       LOG_INFO(logger) << "UnityScreen constructed: " << timer.ElapsedSeconds() << "s";
   }
 }
@@ -572,7 +569,8 @@
     i++;
   }
 
-  if (!(dash_is_open_ && current_monitor == dash_monitor_) && panel_controller_->opacity() > 0.0f)
+  if (!(launcher_controller_->IsOverlayOpen() && current_monitor == dash_monitor_) 
+      && panel_controller_->opacity() > 0.0f)
   {
     foreach(GLTexture * tex, _shadow_texture)
     {
@@ -650,7 +648,8 @@
     i++;
   }
 
-  if (!(dash_is_open_ && current_monitor == dash_monitor_) && panel_controller_->opacity() > 0.0f)
+  if (!(launcher_controller_->IsOverlayOpen() && current_monitor == dash_monitor_) 
+      && panel_controller_->opacity() > 0.0f)
   {
     foreach(GLTexture * tex, _shadow_texture)
     {
@@ -853,8 +852,8 @@
 bool UnityScreen::forcePaintOnTop ()
 {
     return !allowWindowPaint ||
-      ((switcher_controller_->Visible() ||
-        dash_is_open_) && !fullscreen_windows_.empty () && (!(screen->grabbed () && !screen->otherGrabExist (NULL))));
+      ((switcher_controller_->Visible() || launcher_controller_->IsOverlayOpen())
+       && !fullscreen_windows_.empty () && (!(screen->grabbed () && !screen->otherGrabExist (NULL))));
 }
 
 void UnityWindow::paintThumbnail (nux::Geometry const& bounding, float alpha)
@@ -1341,7 +1340,7 @@
 #ifndef USE_GLES
       cScreen->damageScreen();  // evil hack
 #endif
-      if (_key_nav_mode_requested && !dash_is_open_)
+      if (_key_nav_mode_requested && !launcher_controller_->IsOverlayOpen())
         launcher_controller_->KeyNavGrab();
       _key_nav_mode_requested = false;
       break;
@@ -1521,7 +1520,7 @@
   PluginAdapter::Default()->NotifyCompizEvent(plugin, event, option);
   compiz::CompizMinimizedWindowHandler<UnityScreen, UnityWindow>::handleCompizEvent (plugin, event, option);
 
-  if (dash_is_open_ && g_strcmp0(event, "start_viewport_switch") == 0)
+  if (launcher_controller_->IsOverlayOpen() && g_strcmp0(event, "start_viewport_switch") == 0)
   {
     ubus_manager_.SendMessage(UBUS_PLACE_VIEW_CLOSE_REQUEST);
   }
@@ -1638,6 +1637,10 @@
 
 void UnityScreen::SendExecuteCommand()
 {
+  if (hud_controller_->IsVisible())
+  {
+    hud_controller_->HideHud();
+  } 
   ubus_manager_.SendMessage(UBUS_PLACE_ENTRY_ACTIVATE_REQUEST,
                             g_variant_new("(sus)", "commands.lens", 0, ""));
 }
@@ -1978,9 +1981,12 @@
   {
     // Handles closing KeyNav (Alt+F1) if the hud is about to show
     if (launcher_controller_->KeyNavIsActive())
-    {
       launcher_controller_->KeyNavTerminate(false);
-    }
+  
+    // If an overlay is open, it must be the dash! Close it!
+    if (launcher_controller_->IsOverlayOpen())
+      dash_controller_->HideDash();
+
     hud_controller_->ShowHud();
   }
 
@@ -2357,7 +2363,7 @@
     UnityScreen* us = UnityScreen::get(screen);
     CompWindow *lw;
 
-    if (us->dash_is_open_)
+    if (us->launcher_controller_->IsOverlayOpen())
     {
       lw = screen->findWindow(us->launcher_controller_->LauncherWindowId(0));
       lw->moveInputFocusTo();

=== modified file 'plugins/unityshell/src/unityshell.h'
--- plugins/unityshell/src/unityshell.h	2012-03-29 05:14:03 +0000
+++ plugins/unityshell/src/unityshell.h	2012-03-30 04:03:19 +0000
@@ -330,7 +330,6 @@
   bool   queryForShader ();
 
   UBusManager ubus_manager_;
-  bool dash_is_open_;
   int dash_monitor_;
   CompScreen::GrabHandle grab_index_;
   CompWindowList         fullscreen_windows_;

=== modified file 'tests/autopilot/autopilot/emulators/unity/hud.py'
--- tests/autopilot/autopilot/emulators/unity/hud.py	2012-03-27 22:48:34 +0000
+++ tests/autopilot/autopilot/emulators/unity/hud.py	2012-03-30 04:03:19 +0000
@@ -9,10 +9,16 @@
 
 from autopilot.keybindings import KeybindingsHelper
 from autopilot.emulators.unity import UnityIntrospectionObject
+from autopilot.emulators.unity.dash import SearchBar
 
 
 class HudView(UnityIntrospectionObject):
     """Proxy object for the hud view child of the controller."""
+  
+    @property
+    def searchbar(self):
+        """Get the search bar attached to this hud view."""
+        return self.get_children_by_type(SearchBar)[0]
 
     @property
     def geometry(self):
@@ -59,6 +65,10 @@
         return views[0] if views else None
 
     @property
+    def searchbar(self):
+        """Returns the searchbar attached to the hud."""
+        return self._get_view().searchbar;
+
     def geometry(self):
         return (self.x, self.y, self.width, self.height)
 

=== modified file 'tests/autopilot/autopilot/tests/test_hud.py'
--- tests/autopilot/autopilot/tests/test_hud.py	2012-03-29 20:25:35 +0000
+++ tests/autopilot/autopilot/tests/test_hud.py	2012-03-30 04:03:19 +0000
@@ -205,6 +205,45 @@
         contents = open("/tmp/autopilot_gedit_undo_test_temp_file.txt").read().strip('\n')
         self.assertEqual("0 ", contents)
 
+    def test_disabled_alt_f1(self):
+        """This test shows that Alt+F1 mode is disabled for the hud."""
+        self.hud.toggle_reveal()
+
+        launcher = self.launcher.get_launcher_for_monitor(0)
+        launcher.key_nav_start()
+
+        self.assertThat(self.launcher.key_nav_is_active, Equals(False))
+
+    def test_hud_to_dash_disabled_alt_f1(self):
+        """When switching from the hud to the dash alt+f1 is disabled."""
+        self.hud.toggle_reveal()
+        sleep(1)
+
+        self.dash.ensure_visible()
+
+        launcher = self.launcher.get_launcher_for_monitor(0)
+        launcher.key_nav_start()
+
+        self.dash.ensure_hidden()
+        self.assertThat(self.launcher.key_nav_is_active, Equals(False))
+
+    def test_dash_to_hud_has_key_focus(self):
+        """When switching from the dash to the hud you don't lose key focus."""
+        self.dash.ensure_visible()
+        self.hud.toggle_reveal()
+        sleep(1)
+
+        self.keyboard.type('focus')
+        
+        self.assertEqual(self.hud.searchbar.search_string, 'focus')
+
+    def test_hud_closes_on_workspace_switch(self):
+        """This test shows that when you switch to another workspace the hud closes."""
+        self.hud.toggle_reveal()
+        sleep(1)
+
+        self.workspace.switch_to(1)
+        self.workspace.switch_to(2)
 
 class HudLauncherInteractionsTests(HudTestsBase):