Merge lp:~3v1n0/unity/manage-user-invisible-windows into lp:unity

[Marco Trevisan (Treviño)]

Making unity be aware of user-invisible windows, and manage them correctly.

Fixed bug #784804, but after a discussion with Jason I followed his guidelines to get the things fixed.
Basically now user-invisible windows (i.e. the ones with the skip-taskbar flag) are ignored by unity unless they don't belong to a sticky application. In that case the application is shown as running, but clicking on it makes the application to run a new instance (while the alt+tab allows to select the user-invisible windows).
When an application as both user visible and invisible windows, clicking on the launcher icon or the alt+tab gives priority to the visible windows when bringing them to focus, while when closing all the visible windows, the application is hidden from launcher and alt+tab unless it's sticky (and in this case it behaves as explained above).
Also the user-invisible windows, never increment the count of the running windows (i.e. the launcher "pips").

Read more cases in the provided manual-tests.

This branch also fixes the management of the urgent windows, that with some latest commits were not managed anymore as they should (now they get again priority when the parent application is focused).

[Mirco Müller (macslow)]

+1 code looks ok and the manual tests work as described. I used cairo-clock and nautilus (copy large amounts of data around my disk) to reproduce the manual-tests. For future testers I strongly recommend to add these explicit hints to the manuals tests description of what applications to use for the manual-tests. Otherwise other testers will have a hard time with reproducing them.

review: Approve

[Unity Merger (unity-merger)]

The Jenkins job https://jenkins.qa.ubuntu.com/job/automerge-unity/117/console reported an error when processing this lp:~3v1n0/unity/manage-user-invisible-windows branch.
Not merging it.

=== added file 'manual-tests/UserInvisibleWindows.txt'
--- manual-tests/UserInvisibleWindows.txt	1970-01-01 00:00:00 +0000
+++ manual-tests/UserInvisibleWindows.txt	2012-01-06 01:50:28 +0000
@@ -0,0 +1,47 @@
+Management of user-invisible windows
+------------------------------------
+This test shows how unity should manage the user-invisible windows (i.e the
+windows with the skip-taskbar flag on).
+
+#. Start on a clean screen
+#. Open a window of an unsticky application with the skip-taskbar flag set to ON
+
+Outcome
+  Unity should ignore it, not showing it both on the launcher and on the Alt+Tab.
+
+
+Pinned Application user-invisible window
+----------------------------------------
+This test shows how unity should manage the user-invisible windows (i.e the
+windows with the skip-taskbar flag on) that belongs to an application sticked
+to launcher.
+
+#. Start on a clean screen
+#. Open one or more windows of a sticky application with the skip-taskbar flag
+   set to ON
+
+Outcome
+  Unity should show the pinned application icon in the running state with only
+  one left indicator (pip), but clicking on it should make a new instance of the
+  application to run.
+  Otherwise, selecting that application in the Alt+Tab should bring the user-invisible
+  window(s) to focus.
+
+
+Running Application with both visible and invisible windows
+-----------------------------------------------------------
+This test shows how unity should manage applications with both user visible
+and invisible windows.
+
+#. Start on a clean screen
+#. Open one or more windows of an application with the skip-taskbar flag set to OFF
+#. Open one or more windows of that application with the skip-taskbar flag set to ON
+
+Outcome
+  The launcher icon should count with left icon indicators (pips) only the visible
+  window(s); when clicking on it or selecting it via Alt+Tab unity should bring
+  to focus only the visible windows, while at the second click over the launcher
+  the spread with both visible and invisible windows should be activated.
+  When all the user-visible windows are closed, the application should stay in
+  the launcher or in the Alt+Tab (and show as running) only if is sticky,
+  otherwise the icon should hide.

=== modified file 'plugins/unityshell/src/BamfLauncherIcon.cpp'
--- plugins/unityshell/src/BamfLauncherIcon.cpp	2011-12-14 01:47:53 +0000
+++ plugins/unityshell/src/BamfLauncherIcon.cpp	2012-01-06 01:50:28 +0000
@@ -65,9 +65,10 @@
   GList    *l;
   BamfView *view;
 
-  bool active, running;
+  bool active, running, user_visible;
   active = bamf_view_is_active(BAMF_VIEW(m_App));
   running = bamf_view_is_running(BAMF_VIEW(m_App));
+  user_visible = running;
 
   if (arg.target && OwnsWindow (arg.target))
   {
@@ -81,6 +82,8 @@
 
   if (arg.source != ActionArg::SWITCHER)
   {
+    user_visible = bamf_view_user_visible(BAMF_VIEW(m_App));
+
     bool any_visible = false;
     for (l = bamf_view_get_children(BAMF_VIEW(m_App)); l; l = l->next)
     {
@@ -90,9 +93,11 @@
       {
         Window xid = bamf_window_get_xid(BAMF_WINDOW(view));
 
-        if (WindowManager::Default ()->IsWindowOnCurrentDesktop(xid))
+        if (!any_visible && WindowManager::Default()->IsWindowOnCurrentDesktop(xid))
+        {
           any_visible = true;
-        if (!WindowManager::Default ()->IsWindowMapped(xid))
+        }
+        if (active && !WindowManager::Default()->IsWindowMapped(xid))
         {
           active = false;
         }
@@ -104,14 +109,14 @@
   }
 
   /* Behaviour:
-   * 1) Nothing running -> launch application
+   * 1) Nothing running, or nothing visible -> launch application
    * 2) Running and active -> spread application
    * 3) Running and not active -> focus application
    * 4) Spread is active and different icon pressed -> change spread
    * 5) Spread is active -> Spread de-activated, and fall through
    */
 
-  if (!running) // #1 above
+  if (!running || (running && !user_visible)) // #1 above
   {
     if (GetQuirk(QUIRK_STARTING))
       return;
@@ -122,7 +127,7 @@
     }
 
     SetQuirk(QUIRK_STARTING, true);
-    OpenInstanceLauncherIcon(ActionArg ());
+    OpenInstanceLauncherIcon(ActionArg());
   }
   else // app is running
   {
@@ -136,7 +141,9 @@
       else // #2 above
       {
         if (arg.source != ActionArg::SWITCHER)
+        {
           Spread(0, false);
+        }
       }
     }
     else
@@ -283,7 +290,7 @@
   std::vector<Window> results;
   GList* children, *l;
   BamfView* view;
-  WindowManager *wm = WindowManager::Default ();
+  WindowManager *wm = WindowManager::Default();
 
   children = bamf_view_get_children(BAMF_VIEW(m_App));
   for (l = children; l; l = l->next)
@@ -294,7 +301,9 @@
       guint32 xid = bamf_window_get_xid(BAMF_WINDOW(view));
 
       if (wm->IsWindowMapped(xid))
-        results.push_back ((Window) xid);
+      {
+        results.push_back (xid);
+      }
     }
   }
 
@@ -574,6 +583,7 @@
   BamfView* view;
   bool any_urgent = false;
   bool any_visible = false;
+  bool any_user_visible = false;
 
   children = bamf_view_get_children(BAMF_VIEW(m_App));
 
@@ -588,30 +598,40 @@
     {
       Window xid = bamf_window_get_xid(BAMF_WINDOW(view));
       bool urgent = bamf_view_is_urgent(view);
-
-      if (WindowManager::Default ()->IsWindowOnCurrentDesktop (xid) &&
-          WindowManager::Default ()->IsWindowVisible (xid))
-        any_visible = true;
+      bool user_visible = bamf_view_user_visible(view);
 
       if (any_urgent)
       {
         if (urgent)
           windows.push_back(xid);
       }
+      else if (any_user_visible && !urgent)
+      {
+        if (user_visible)
+          windows.push_back(xid);
+      }
       else
       {
-        if (urgent)
+        if (urgent || user_visible)
         {
           windows.clear();
           any_visible = false;
-          any_urgent = true;
+          any_urgent = (any_urgent || urgent);
+          any_user_visible = (any_user_visible || user_visible);
         }
-      }
-      windows.push_back(xid);
+
+        windows.push_back(xid);
+      }
+
+      if (WindowManager::Default()->IsWindowOnCurrentDesktop(xid) &&
+          WindowManager::Default()->IsWindowVisible(xid))
+      {
+        any_visible = true;
+      }
     }
   }
-
   g_list_free(children);
+
   if (arg.source != ActionArg::SWITCHER)
   {
     if (any_visible)
@@ -626,8 +646,10 @@
     }
   }
   else
+  {
     WindowManager::Default()->FocusWindowGroup(windows,
       WindowManager::FocusVisibility::OnlyVisible);
+  }
 }
 
 bool BamfLauncherIcon::Spread(int state, bool force)
@@ -697,7 +719,8 @@
 void BamfLauncherIcon::EnsureWindowState()
 {
   GList* children, *l;
-  int count = 0;
+  unsigned int children_count = 0;
+  unsigned int user_visible_count = 0;
   bool has_visible = false;
 
   children = bamf_view_get_children(BAMF_VIEW(m_App));
@@ -713,10 +736,23 @@
         has_visible = true;
     }
 
-    count++;
-  }
-
-  SetRelatedWindows(count);
+    if (bamf_view_user_visible (BAMF_VIEW (l->data)))
+    {
+      user_visible_count++;
+    }
+
+    children_count++;
+  }
+
+  if (user_visible_count > 0)
+  {
+    SetRelatedWindows(user_visible_count);
+  }
+  else if (children_count > 0)
+  {
+    SetRelatedWindows(1);
+  }
+
   SetHasWindowOnViewport(has_visible);
 
   g_list_free(children);
@@ -892,10 +928,11 @@
 
   const gchar* desktop_file = DesktopFile();
   bamf_view_set_sticky(view, false);
-  if (bamf_view_is_closed(view))
+
+  if (bamf_view_is_closed(view) || !bamf_view_user_visible(view))
     this->Remove();
 
-  if (desktop_file && strlen(desktop_file) > 0)
+  if (desktop_file && desktop_file[0] != '\0')
     FavoriteStore::GetDefault().RemoveFavorite(desktop_file);
 }