Merge lp:~3v1n0/unity/overlays-grabs-handling into lp:unity

[Marco Trevisan (Treviño)]

UnityScreen: don't try to show Dash/Hud if the screen is grabbed

Also move the dash opening out from LauncherController, and get rid of UBus
as first initialization source, as it can only slow things down here.

Try to get the grab to double-check if something is already grabbing the keyboard (we could also check for pointer grabs, but here I don't see it much needed).

Although this is a round-trip request to the X server from my measurements it seems to take less than 1ms, and thus it seems acceptable.

Now we only try to show our overlays if there are no grabs around, and if there are we give 2 seconds for an ungrab-event to arrive (since we might need to wait a scale animation or a key-ungrab to happen), before giving up for good.

Also, in case we are unable to show them, we pass the key press trough.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:3792
http://jenkins.qa.ubuntu.com/job/unity-ci/897/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-trusty-amd64-ci/433
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-trusty-armhf-ci/429
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-trusty-i386-ci/431

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/unity-ci/897/rebuild

review: Approve (continuous-integration)

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:3793
http://jenkins.qa.ubuntu.com/job/unity-ci/898/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-trusty-amd64-ci/434
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-trusty-armhf-ci/430
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-trusty-i386-ci/432

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/unity-ci/898/rebuild

review: Approve (continuous-integration)

[Brandon Schaefer (brandontschaefer)]

Whats the best way to test this outside of a WM/Cirtrix?

[Brandon Schaefer (brandontschaefer)]

Code wise, looks fine, just want to test :)

[Brandon Schaefer (brandontschaefer)]

For anyone wanting to test this change, i've uploaded to a ppa:
https://code.launchpad.net/~brandontschaefer/+archive/unity-testing

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:3794
http://jenkins.qa.ubuntu.com/job/unity-ci/906/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-trusty-amd64-ci/442
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-trusty-armhf-ci/438
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-trusty-i386-ci/440/console

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/unity-ci/906/rebuild

review: Needs Fixing (continuous-integration)

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:3794
http://jenkins.qa.ubuntu.com/job/unity-ci/909/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-trusty-amd64-ci/445
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-trusty-armhf-ci/441
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-trusty-i386-ci/443

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/unity-ci/909/rebuild

review: Approve (continuous-integration)

[Brandon Schaefer (brandontschaefer)]

LGTM

review: Approve

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:3795
http://jenkins.qa.ubuntu.com/job/unity-ci/911/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-trusty-amd64-ci/447
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-trusty-armhf-ci/443
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-trusty-i386-ci/445

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/unity-ci/911/rebuild

review: Approve (continuous-integration)

=== modified file 'dash/DashController.cpp'
--- dash/DashController.cpp	2014-03-21 05:23:42 +0000
+++ dash/DashController.cpp	2014-05-02 15:06:05 +0000
@@ -66,7 +66,6 @@
   , create_window_(create_window)
   , monitor_(0)
   , visible_(false)
-  , need_show_(false)
   , dbus_server_(dbus::BUS_NAME)
   , ensure_timeout_(PRELOAD_TIMEOUT_LENGTH)
   , timeline_animator_(90)
@@ -262,20 +261,14 @@
   HideDash();
 }
 
-void Controller::OnScreenUngrabbed()
+void Controller::OnExternalShowDash(GVariant* variant)
 {
-  LOG_DEBUG(logger) << "On Screen Ungrabbed called";
-  if (need_show_)
-  {
-    EnsureDash();
+  EnsureDash();
+
+  if (!visible_)
     ShowDash();
-  }
-}
-
-void Controller::OnExternalShowDash(GVariant* variant)
-{
-  EnsureDash();
-  visible_ ? HideDash() : ShowDash();
+  else
+    HideDash();
 }
 
 void Controller::OnExternalHideDash(GVariant* variant)
@@ -283,31 +276,44 @@
   HideDash();
 }
 
-void Controller::ShowDash()
+bool Controller::ShowDash()
 {
-  EnsureDash();
+  // Don't want to show at the wrong time
+  if (visible_)
+    return false;
+
   WindowManager& wm = WindowManager::Default();
-  // Don't want to show at the wrong time
-  if (visible_ || wm.IsExpoActive() || wm.IsScaleActive())
-    return;
+
+  if (wm.IsExpoActive())
+    wm.TerminateExpo();
 
   // We often need to wait for the mouse/keyboard to be available while a plugin
   // is finishing it's animations/cleaning up. In these cases, we patiently wait
   // for the screen to be available again before honouring the request.
   if (wm.IsScreenGrabbed())
   {
-    screen_ungrabbed_slot_ = wm.screen_ungrabbed.connect(sigc::mem_fun(this, &Controller::OnScreenUngrabbed));
-    need_show_ = true;
-    return;
+    screen_ungrabbed_slot_ = wm.screen_ungrabbed.connect([this] {
+      grab_wait_.reset();
+      ShowDash();
+    });
+
+    // Let's wait ungrab event for maximum a couple of seconds...
+    grab_wait_.reset(new glib::TimeoutSeconds(2, [this] {
+      screen_ungrabbed_slot_->disconnect();
+      return false;
+    }));
+
+    return false;
   }
 
+  EnsureDash();
   monitor_ = GetIdealMonitor();
+  screen_ungrabbed_slot_->disconnect();
   int launcher_width = unity::Settings::Instance().LauncherWidth(monitor_);
   view_->SetMonitorOffset(launcher_width, panel::Style::Instance().PanelHeight(monitor_));
   view_->AboutToShow(monitor_);
   FocusWindow();
 
-  need_show_ = false;
   visible_ = true;
 
   StartShowHideTimeline();
@@ -316,6 +322,7 @@
 
   GVariant* info = g_variant_new(UBUS_OVERLAY_FORMAT_STRING, "dash", TRUE, monitor_, view_content_geo.width, view_content_geo.height);
   ubus_manager_.SendMessage(UBUS_OVERLAY_SHOWN, info);
+  return true;
 }
 
 void Controller::FocusWindow()
@@ -347,8 +354,6 @@
   if (!visible_)
    return;
 
-  screen_ungrabbed_slot_->disconnect();
-
   EnsureDash();
 
   view_->AboutToHide();
@@ -394,7 +399,7 @@
   view_->OnActivateRequest(variant);
 }
 
-gboolean Controller::CheckShortcutActivation(const char* key_string)
+bool Controller::CheckShortcutActivation(const char* key_string)
 {
   if (!key_string)
     return false;

=== modified file 'dash/DashController.h'
--- dash/DashController.h	2014-03-21 05:23:42 +0000
+++ dash/DashController.h	2014-05-02 15:06:05 +0000
@@ -51,7 +51,7 @@
 
   nux::BaseWindow* window() const;
 
-  gboolean CheckShortcutActivation(const char* key_string);
+  bool CheckShortcutActivation(const char* key_string);
   std::vector<char> GetAllShortcuts();
 
   nux::Property<bool> use_primary;
@@ -60,7 +60,7 @@
 
   void HideDash();
   void QuicklyHideDash();
-  void ShowDash();
+  bool ShowDash();
 
   void ReFocusKeyInput();
 
@@ -86,7 +86,6 @@
   void Relayout(bool check_monitor =false);
 
   void OnMouseDownOutsideWindow(int x, int y, unsigned long bflags, unsigned long kflags);
-  void OnScreenUngrabbed();
   void OnExternalShowDash(GVariant* variant);
   void OnExternalHideDash(GVariant* variant);
   void OnActivateRequest(GVariant* variant);
@@ -103,14 +102,13 @@
   nux::ObjectPtr<ResizingBaseWindow> window_;
   nux::ObjectPtr<DashView> view_;
   int monitor_;
-
   bool visible_;
-  bool need_show_;
 
   connection::Wrapper screen_ungrabbed_slot_;
   connection::Wrapper form_factor_changed_;
   glib::DBusServer dbus_server_;
   glib::TimeoutSeconds ensure_timeout_;
+  glib::Source::UniquePtr grab_wait_;
   nux::animation::AnimateValue<double> timeline_animator_;
   UBusManager ubus_manager_;
 };

=== modified file 'dash/DashView.cpp'
--- dash/DashView.cpp	2014-03-21 23:08:47 +0000
+++ dash/DashView.cpp	2014-05-02 15:06:05 +0000
@@ -1457,8 +1457,8 @@
   {
     for (Scope::Ptr scope: scopes_->GetScopes())
     {
-      std::string shortcut = scope->shortcut;
-      if(shortcut.size() > 0)
+      std::string const& shortcut = scope->shortcut;
+      if (!shortcut.empty())
         result.push_back(shortcut.at(0));
     }
   }

=== modified file 'launcher/LauncherController.cpp'
--- launcher/LauncherController.cpp	2014-03-20 00:11:08 +0000
+++ launcher/LauncherController.cpp	2014-05-02 15:06:05 +0000
@@ -1199,18 +1199,6 @@
 void Controller::HandleLauncherKeyRelease(bool was_tap, int when)
 {
   int tap_duration = when - pimpl->launcher_key_press_time_;
-  WindowManager& wm = WindowManager::Default();
-
-  if (tap_duration < options()->super_tap_duration && was_tap &&
-      !wm.IsTopWindowFullscreenOnMonitorWithMouse())
-  {
-    LOG_DEBUG(logger) << "Quick tap, sending activation request.";
-    pimpl->SendHomeActivationRequest();
-  }
-  else
-  {
-    LOG_DEBUG(logger) << "Tap too long: " << tap_duration;
-  }
 
   pimpl->sources_.Remove(local::LABELS_TIMEOUT);
   pimpl->sources_.Remove(local::KEYPRESS_TIMEOUT);

=== modified file 'plugins/unityshell/src/unityshell.cpp'
--- plugins/unityshell/src/unityshell.cpp	2014-04-30 04:29:00 +0000
+++ plugins/unityshell/src/unityshell.cpp	2014-05-02 15:06:05 +0000
@@ -143,6 +143,7 @@
 const RawPixel SCALE_PADDING = 40_em;
 const RawPixel SCALE_SPACING = 20_em;
 const std::string RELAYOUT_TIMEOUT = "relayout-timeout";
+const std::string HUD_UNGRAB_WAIT = "hud-ungrab-wait";
 const std::string FIRST_RUN_STAMP = "first_run.stamp";
 const std::string LOCKED_STAMP = "locked.stamp";
 } // namespace local
@@ -1703,6 +1704,8 @@
         wm.OnScreenGrabbed();
       else if (event->xfocus.mode == NotifyUngrab)
         wm.OnScreenUngrabbed();
+      else if (!screen->grabbed() && event->xfocus.mode == NotifyWhileGrabbed)
+        wm.OnScreenGrabbed();
 
       if (_key_nav_mode_requested)
       {
@@ -2062,6 +2065,7 @@
     return false;
 
   bool was_tap = state & CompAction::StateTermTapped;
+  bool tap_handled = false;
   LOG_DEBUG(logger) << "Super released: " << (was_tap ? "tapped" : "released");
   int when = options[7].value().i();  // XEvent time in millisec
 
@@ -2090,6 +2094,24 @@
     {
       QuicklistManager::Default()->Current()->Hide();
     }
+
+    if (!dash_controller_->IsVisible())
+    {
+      if (!adapter.IsTopWindowFullscreenOnMonitorWithMouse())
+      {
+        if (dash_controller_->ShowDash())
+        {
+          tap_handled = true;
+          ubus_manager_.SendMessage(UBUS_PLACE_ENTRY_ACTIVATE_REQUEST,
+                                    g_variant_new("(sus)", "home.scope", dash::GOTO_DASH_URI, ""));
+        }
+      }
+    }
+    else
+    {
+      dash_controller_->HideDash();
+      tap_handled = true;
+    }
   }
 
   super_keypressed_ = false;
@@ -2103,7 +2125,7 @@
   EnableCancelAction(CancelActionTarget::SHORTCUT_HINT, false);
 
   action->setState (action->state() & (unsigned)~(CompAction::StateTermKey));
-  return true;
+  return (was_tap && tap_handled) || !was_tap;
 }
 
 bool UnityScreen::showPanelFirstMenuKeyInitiate(CompAction* action,
@@ -2471,32 +2493,45 @@
 {
   if (switcher_controller_->Visible())
   {
-    LOG_ERROR(logger) << "this should never happen";
+    LOG_ERROR(logger) << "Switcher is visible when showing HUD: this should never happen";
     return false; // early exit if the switcher is open
   }
 
-  if (PluginAdapter::Default().IsTopWindowFullscreenOnMonitorWithMouse())
-  {
-    return false;
-  }
-
   if (hud_controller_->IsVisible())
   {
-    ubus_manager_.SendMessage(UBUS_HUD_CLOSE_REQUEST);
+    hud_controller_->HideHud();
   }
   else
   {
+    auto& wm = WindowManager::Default();
+
+    if (wm.IsTopWindowFullscreenOnMonitorWithMouse())
+      return false;
+
+    if (wm.IsScreenGrabbed())
+    {
+      hud_ungrab_slot_ = wm.screen_ungrabbed.connect([this] { ShowHud(); });
+
+      // Let's wait ungrab event for maximum a couple of seconds...
+      sources_.AddTimeoutSeconds(2, [this] {
+        hud_ungrab_slot_->disconnect();
+        return false;
+      }, local::HUD_UNGRAB_WAIT);
+
+      return false;
+    }
+
     // 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())
+    if (dash_controller_->IsVisible())
       dash_controller_->HideDash();
 
     if (QuicklistManager::Default()->Current())
       QuicklistManager::Default()->Current()->Hide();
 
+    hud_ungrab_slot_->disconnect();
     hud_controller_->ShowHud();
   }
 

=== modified file 'plugins/unityshell/src/unityshell.h'
--- plugins/unityshell/src/unityshell.h	2014-04-29 00:22:03 +0000
+++ plugins/unityshell/src/unityshell.h	2014-05-02 15:06:05 +0000
@@ -421,6 +421,7 @@
 
   UBusManager ubus_manager_;
   glib::SourceManager sources_;
+  connection::Wrapper hud_ungrab_slot_;
 
   CompRegion buffered_compiz_damage_this_frame_;
   CompRegion buffered_compiz_damage_last_frame_;