Merge lp:~canonical-dx-team/unity/unity.intellihide into lp:unity

[Jason Smith]

Implements intellihide yo

[Sam Spilsbury (smspillaz)]

Hi Jason,

I'm not able to test since nux doesn't work on both of my systems at the moment *COUGH* but some small ideas for improvement before you merge.

1) ::resizeNotify will only tell you of the new window geometry once the geometry has actually changed, not while the window is resizing, in the case that we are using the "outline, rectangle or stretch" modes. In that case you'll want to wrap handle event and listen for the "_COMPIZ_RESIZE_NOTIFY" atom and use that to determine the *current* resize geometry. Have a look at group.cpp:1827 on how this is done.

2) Your current approach wraps resizeNotify and moveNotify for every single window in the stack. This is a little bit inefficient IMO - maybe you should wrap grabNotify () to determine which window was grabbed in the first place and then enable moveNotify and resizeNotify on the window (moveNotifySetEnabled, resizeNotifySetEnabled) depending on the grab type. Also enabled ungrabNotify at this point and when that comes you can disable all of those functions. That way you aren't being pinged all the time every single time a window moves or resizes for other reasons, eg because the wall plugin shifted the screen to the left or something.

3) You should not use w->frameRegion (). Use w->inputRegion () instead. w->frameRegion () includes only the geometry of the window frame itself, eg a big region with a hole cut in the middle. In situations where the frame size is bigger than the dock size, this could lead to an awkward race condition where the two regions won't intersect because of that hole.

4) For unit testing it might not be such a good idea to bring Compiz specific definitions into Launcher.cpp such as CompScreen and CompWindow. Maybe instead of checking the entire window list there you can just call OnWindowMoved or OnWindowResized with the X Region of the inputRegion for the window on moveNotify or grabNotify and save a count of "currently intersecting regions". (To get the X region you can call someRegion->handle ()). That way you can just XIntersectRegion like normal.

Other than that it looks good.

review: Needs Fixing

[Jason Smith (jassmith)]

1) Dont care about that, we are okay to update intellihide *after* a resize is completed

2) resize notify and grab notify should be relatively infrequent callers. The cost of them should be a tiny fraction compared to our wrapping of the paint call. Using grab notify then means we only respond to user generated results.

3) fixed

4) Not a problem for testing since these calls are input only. If we relied on them for state generation I would be more concerned.

[Alex Launi (alexlauni)]

1) It's much nicer to hide during resize, rather than just after. It makes the experience just a little bit nicer to be able to interactively show/hide the launcher while performing the resize.

think of the children

=== modified file 'src/Launcher.cpp'
--- src/Launcher.cpp	2010-12-06 22:11:41 +0000
+++ src/Launcher.cpp	2010-12-07 03:25:11 +0000
@@ -168,7 +168,7 @@
                                        float FarClipPlane,
                                        float Fovy);
 
-Launcher::Launcher(nux::BaseWindow *parent, NUX_FILE_LINE_DECL)
+Launcher::Launcher(nux::BaseWindow *parent, CompScreen *screen, NUX_FILE_LINE_DECL)
 :   View(NUX_FILE_LINE_PARAM)
 ,   m_ContentOffsetY(0)
 ,   m_RunningIndicator(0)
@@ -177,6 +177,7 @@
 ,   _model (0)
 {
     _parent = parent;
+    _screen = screen;
     _active_quicklist = 0;
     
     m_Layout = new nux::HLayout(NUX_TRACKER_LOCATION);
@@ -252,6 +253,8 @@
     _autohide               = false;
     _hidden                 = false;
     _mouse_inside_launcher  = false;
+    _mouse_inside_trigger   = false;
+    _window_over_launcher   = false;
     
     // 0 out timers to avoid wonky startups
     _enter_time.tv_sec = 0;
@@ -827,7 +830,7 @@
         return;
         
     _hidden = hidden;
-    SetTimeStruct (&_autohide_time, &_autohide_time, ANIM_DURATION);
+    SetTimeStruct (&_autohide_time, &_autohide_time, ANIM_DURATION_SHORT);
     
     _parent->EnableInputWindow(!hidden);
     
@@ -838,36 +841,80 @@
 {
     Launcher *self = (Launcher*) data;
  
-    if (self->_hovered || self->_hidden)
-        return false;
-    
-    self->SetHidden (true);
-
+    self->EnsureHiddenState ();
     self->_autohide_handle = 0;
     return false;
 }
 
+void
+Launcher::EnsureHiddenState ()
+{
+  if (!_mouse_inside_trigger && !_mouse_inside_launcher && _window_over_launcher)
+    SetHidden (true);
+  else
+    SetHidden (false);
+}
+
+void
+Launcher::CheckWindowOverLauncher ()
+{
+  CompWindowList window_list = _screen->windows ();
+  CompWindowList::iterator it;
+  nux::Geometry geo = GetGeometry ();
+  
+  for (it = window_list.begin (); it != window_list.end (); it++)
+  {
+    CompWindow *window = *it;
+    
+    if (window->type () != CompWindowTypeNormalMask || window->invisible ())
+      continue;
+    
+    if (CompRegion (window->inputRect ()).intersects (CompRect (geo.x, geo.y, geo.width, geo.height)))
+    {
+      _window_over_launcher = true;
+      EnsureHiddenState ();
+      return;
+    }
+  }
+  
+  _window_over_launcher = false;
+  EnsureHiddenState ();
+}
+
+void
+Launcher::OnWindowMoved (CompWindow *window)
+{
+  if (_autohide)
+    CheckWindowOverLauncher ();
+}
+
+void
+Launcher::OnWindowResized (CompWindow *window)
+{
+  if (_autohide)
+    CheckWindowOverLauncher ();
+}
+
 void Launcher::OnTriggerMouseEnter (int x, int y, unsigned long button_flags, unsigned long key_flags)
 {
-    if (!_autohide || !_hidden)
-        return;
-    
-    SetHidden (false);
+  _mouse_inside_trigger = true;
+  EnsureHiddenState ();
 }
 
 void Launcher::SetupAutohideTimer ()
 {
-    if (_autohide)
-    {
-        if (_autohide_handle > 0)
-            g_source_remove (_autohide_handle);
-        _autohide_handle = g_timeout_add (1000, &Launcher::OnAutohideTimeout, this);
-    }
+  if (_autohide)
+  {
+    if (_autohide_handle > 0)
+      g_source_remove (_autohide_handle);
+    _autohide_handle = g_timeout_add (1000, &Launcher::OnAutohideTimeout, this);
+  }
 }
 
 void Launcher::OnTriggerMouseLeave (int x, int y, unsigned long button_flags, unsigned long key_flags)
 {
-    SetupAutohideTimer ();
+  _mouse_inside_trigger = false;
+  SetupAutohideTimer ();
 }
 
 bool Launcher::AutohideEnabled ()

=== modified file 'src/Launcher.h'
--- src/Launcher.h	2010-12-06 22:11:41 +0000
+++ src/Launcher.h	2010-12-07 03:25:11 +0000
@@ -21,6 +21,7 @@
 #define LAUNCHER_H
 
 #include <sys/time.h>
+#include <core/core.h>
 
 #include <Nux/View.h>
 #include <Nux/BaseWindow.h>
@@ -35,7 +36,7 @@
 class Launcher : public Introspectable, public nux::View
 {
 public:
-    Launcher(nux::BaseWindow *parent, NUX_FILE_LINE_PROTO);
+    Launcher(nux::BaseWindow *parent, CompScreen *screen, NUX_FILE_LINE_PROTO);
     ~Launcher();
 
     virtual long ProcessEvent(nux::IEvent &ievent, long TraverseInfo, long ProcessEventInfo);
@@ -59,6 +60,9 @@
     void SetAutohide (bool autohide, nux::View *show_trigger);
     bool AutohideEnabled ();
     
+    void OnWindowMoved   (CompWindow *window);
+    void OnWindowResized (CompWindow *window);
+    
     virtual void RecvMouseUp(int x, int y, unsigned long button_flags, unsigned long key_flags);
     virtual void RecvMouseDown(int x, int y, unsigned long button_flags, unsigned long key_flags);
     virtual void RecvMouseDrag(int x, int y, int dx, int dy, unsigned long button_flags, unsigned long key_flags);
@@ -121,9 +125,12 @@
   bool AnimationInProgress ();
   void SetTimeStruct       (struct timespec *timer, struct timespec *sister = 0, int sister_relation = 0);
   
+  void EnsureHiddenState ();
   void EnsureAnimation    ();
   void SetupAutohideTimer ();
   
+  void CheckWindowOverLauncher ();
+  
   float DnDExitProgress  (struct timespec const &current);
   float GetHoverProgress (struct timespec const &current);
   float AutohideProgress (struct timespec const &current);
@@ -195,6 +202,8 @@
   bool  _autohide;
   bool  _hidden;
   bool  _mouse_inside_launcher;
+  bool  _mouse_inside_trigger;
+  bool  _window_over_launcher;
 
   float _folded_angle;
   float _neg_folded_angle;
@@ -239,6 +248,8 @@
   nux::View* _autohide_trigger;
   LauncherModel* _model;
   
+  CompScreen* _screen;
+  
   /* event times */
   struct timespec _enter_time;
   struct timespec _exit_time;

=== modified file 'src/unity.cpp'
--- src/unity.cpp	2010-12-04 04:55:25 +0000
+++ src/unity.cpp	2010-12-07 03:25:11 +0000
@@ -292,6 +292,20 @@
   window->windowNotify (n);
 }
 
+void 
+UnityWindow::moveNotify (int x, int y, bool immediate)
+{
+  uScreen->launcher->OnWindowMoved (window);
+  window->moveNotify (x, y, immediate);
+}
+
+void 
+UnityWindow::resizeNotify (int x, int y, int w, int h)
+{
+  uScreen->launcher->OnWindowResized (window);
+  window->resizeNotify (x, y, w, h);
+}
+
 /* Configure callback for the launcher window */
 void 
 UnityScreen::launcherWindowConfigureCallback(int WindowWidth, int WindowHeight, nux::Geometry& geo, void *user_data)
@@ -413,7 +427,7 @@
   UnityScreen *self = (UnityScreen*) InitData;
   
   self->launcherWindow = new nux::BaseWindow(TEXT(""));
-  self->launcher = new Launcher(self->launcherWindow);
+  self->launcher = new Launcher(self->launcherWindow, self->screen);
   self->AddChild (self->launcher);
 
   nux::HLayout* layout = new nux::HLayout();

=== modified file 'src/unity.h'
--- src/unity.h	2010-12-04 04:55:25 +0000
+++ src/unity.h	2010-12-07 03:25:11 +0000
@@ -171,6 +171,9 @@
 
 	void windowNotify (CompWindowNotify n);
 
+  void moveNotify (int x, int y, bool immediate);
+  
+  void resizeNotify (int x, int y, int w, int h);
 };
 
 #define EX_SCREEN (screen) \