Merge lp:~docky-core/plank/workspace-only into lp:plank

[Rico Tzschichholz]

Adds optional ability to show windows of current workspace only

DockItems: removed signals which aren't used in their desired way which makes them useless it this condition, and add a common changed signal instead

[lp:~docky-core/plank/workspace-only]

688. By Rico Tzschichholz on 2012-10-05

build: dbusmenu is optional so enable it conditionally by default

don't force this dependency and make it more clear it is optional

689. By Rico Tzschichholz on 2012-10-05

build: Stop including pregenerated c-sources in tarballs

Shipping c-sources results in problems with custom configure flags and
conditional compile options. So drop them for good!

690. By Robert Dyer on 2012-10-08

plank.desktop was invalid - bug 1063970

691. By Rico Tzschichholz on 2012-10-09

Revert r690

692. By Robert Dyer on 2012-10-09

Reinstating rev 690 - Plank does not directly support any specific window manager or DE. IF a specific DE has a problem with our packages, they are welcome to package it themselves.

693. By Robert Dyer on 2012-10-10

fix theme files - bug 1034755

694. By Rico Tzschichholz on 2012-10-12

dockwindow: Restrict amount of hover-repositions using a Timeout

This is suppose to avoid spamming the WM with lots of window repositions
while fast hovering dockitems.

695. By Robert Dyer on 2012-10-12

stop timers when destructing objects

696. By Rico Tzschichholz on 2012-10-13

Move symbols generation in separate target and add non-fatal check rule

697. By Rico Tzschichholz on 2012-10-21

hoverwindow: wait for move/show/hide to be executed before continuing

This fixes the appearance of hovers with metacity (introduced with r653)

698. By Rico Tzschichholz on 2012-10-21

vapi: update Bamf bindings

699. By Rico Tzschichholz on 2012-10-22

window-control: output name of current window-manager and on its change

700. By Rico Tzschichholz on 2012-10-27

lib: make sure not to show the hoverwindow while a menu is visible

701. By Rico Tzschichholz on 2012-10-30

misc: remove custom bamf vapi generation

we are using a patched upstream generated vapi now

702. By Rico Tzschichholz on 2012-10-30

Use statically sized Gtk.Window and improve non-compositing support

Avoids visually corruptions on adding/removing items caused by set_size
and move operation on Gtk.Window

703. By Rico Tzschichholz on 2012-10-31

drawing: small optimization and add some convenience methods in Color

704. By Rico Tzschichholz on 2012-11-01

Fix visual clitch on initially showing the dockwindow

Make the dockwindow invisible until its content is fully drawn the first
time. (Reworked patch from Tom Beckmann)

705. By Rico Tzschichholz on 2012-11-01

Don't delay initial positioning of the dockwindow

706. By Rico Tzschichholz on 2012-11-06

Revert r704

It introduced problems with openbox and a race condition with metacity
resulting in the dock not showing at all.

707. By Rico Tzschichholz on 2012-11-07

update_regions: force triggering a redraw with active compositing support

A changed static_dock_region doesn't implicate the window-size changed
and DockWindow.set_size() won't trigger a redraw.

708. By Rico Tzschichholz on 2012-11-12

build: Rename libplank.pc to plank.pc

It is more common to have a matching name for vapi, header and pkg-config
files.

709. By Rico Tzschichholz on 2012-11-15

Fix size/position updates while switching screen-resolution

With enabled compositing support those updates weren't properly handled
after the introduction of "static-window" changes.

Refactor DockWindow.set_size to handle resize and reposition separately.

Move parts of PositionManager.reset_caches into update_dimensions and
cache all needed theme-values.

711. By Rico Tzschichholz on 2012-10-23

items: pass actual changed items with items_changed

712. By Rico Tzschichholz on 2012-10-30

reuse wnck.screen reference

[Robert Dyer (psybers)]

Line 318 - typo in comment 'wether'

[Robert Dyer (psybers)]

Has this been tested on multiple WMs? Compiz, Mutter, Pantheon, etc?

[Rico Tzschichholz (ricotz)]

> Has this been tested on multiple WMs? Compiz, Mutter, Pantheon, etc?

I am testing it with Gnome-Shell/Mutter with is comparable with Patheon (aka Gala/Mutter). So I am hoping you can give it a spin on compiz?

[lp:~docky-core/plank/workspace-only]

713. By Rico Tzschichholz on 2012-11-16

Fix typo in blurb

[Robert Dyer (psybers)]

In my experience Gala isn't equal to Mutter. Can you get Cassidy to test?

I'll test it on Compiz.

[Robert Dyer (psybers)]

Fails entirely on Compiz.

review: Needs Fixing

[Rico Tzschichholz (ricotz)]

> Fails entirely on Compiz.

Right, compiz doesn't use real workspaces but viewports.

[lp:~docky-core/plank/workspace-only]

714. By Rico Tzschichholz on 2012-11-16

add support for viewports which are used in compiz

[Rico Tzschichholz (ricotz)]

Please give it another try.

[Robert Dyer (psybers)]

Closer! At least now it does things.

I think I found a bug (probably not just with Compiz) though.

If an app is pinned, it will show on the dock regardless of which workspace its open window is on.

If an app is not pinned, it only shows on the dock if its window is on the current workspace.

review: Needs Fixing

[Rico Tzschichholz (ricotz)]

This is the behavior I intended since pinned means pinned ;)

[Robert Dyer (psybers)]

I think this is not what we want. Most people are only going to run apps that are pinned. So what use would this be - it would act the same as without.

[Rico Tzschichholz (ricotz)]

Depends on how you use the dock which works if you want to manage open windows.

But how would one handle this another way?
So if you filter pinned apps too what happens with not running pinned apps? Should they show up all the time and disappear if they are already running on another workspace? This could be quite confusing.

The how it works now it was handled in docky too.

[Robert Dyer (psybers)]

review: Approve

=== modified file 'lib/DockItems.vala'
--- lib/DockItems.vala	2012-08-07 19:38:29 +0000
+++ lib/DockItems.vala	2012-11-16 19:21:20 +0000
@@ -31,27 +31,29 @@
 	public class DockItems : GLib.Object
 	{
 		/**
+		 * Triggered when the items collection has changed.
+		 *
+		 * @param added the list of added items
+		 * @param removed the list of removed items
+		 */
+		public signal void items_changed (Gee.List<DockItem> added, Gee.List<DockItem> removed);
+		
+		/**
 		 * Triggered when the state of an item changes.
 		 */
 		public signal void item_state_changed ();
 		
 		/**
-		 * Triggered when a new item is added to the collection.
-		 *
-		 * @param item the dockitem which was added
-		 */
-		public signal void item_added (DockItem item);
-		/**
-		 * Triggered when an item is removed from the collection.
-		 *
-		 * @param item the dockitem which was removed
-		 */
-		public signal void item_removed (DockItem item);
-		
-		/**
 		 * A list of the dock items.
 		 */
-		public ArrayList<DockItem> Items = new ArrayList<DockItem> ();
+		public unowned ArrayList<DockItem> Items {
+			get {
+				return visible_items;
+			}
+		}
+		
+		ArrayList<DockItem> visible_items = new ArrayList<DockItem> ();
+		ArrayList<DockItem> internal_items = new ArrayList<DockItem> ();
 		
 		FileMonitor? items_monitor = null;
 		
@@ -84,20 +86,36 @@
 			
 			load_items ();
 			add_running_apps ();
-			set_item_positions ();
+			update_visible_items ();
+			
+			controller.prefs.changed["CurrentWorkspaceOnly"].connect (handle_setting_changed);
 			
 			Matcher.get_default ().app_opened.connect (app_opened);
+			
+			var wnck_screen = Wnck.Screen.get_default ();
+			wnck_screen.active_window_changed.connect (handle_window_changed);
+			wnck_screen.active_workspace_changed.connect (handle_workspace_changed);
+			wnck_screen.viewports_changed.connect (handle_viewports_changed);
 		}
 		
 		~DockItems ()
 		{
+			controller.prefs.changed["CurrentWorkspaceOnly"].disconnect (handle_setting_changed);
+			
 			Matcher.get_default ().app_opened.disconnect (app_opened);
 			
+			var wnck_screen = Wnck.Screen.get_default ();
+			wnck_screen.active_window_changed.disconnect (handle_window_changed);
+			wnck_screen.active_workspace_changed.disconnect (handle_workspace_changed);
+			wnck_screen.viewports_changed.disconnect (handle_viewports_changed);
+			
+			visible_items.clear ();
+			
 			var items = new HashSet<DockItem> ();
-			items.add_all (Items);
+			items.add_all (internal_items);
 			foreach (var item in items)
 				remove_item_without_signaling (item);
-			Items.clear ();
+			internal_items.clear ();
 			
 			if (items_monitor != null) {
 				items_monitor.changed.disconnect (handle_items_dir_changed);
@@ -114,9 +132,8 @@
 		public void add_item (DockItem item)
 		{
 			add_item_without_signaling (item);
-			set_item_positions ();
-
-			item_added (item);
+			
+			update_visible_items ();
 		}
 		
 		/**
@@ -127,9 +144,8 @@
 		public void remove_item (DockItem item)
 		{
 			remove_item_without_signaling (item);
-			set_item_positions ();
 			
-			item_removed (item);
+			update_visible_items ();
 		}
 		
 		void signal_item_state_changed ()
@@ -139,7 +155,7 @@
 		
 		ApplicationDockItem? item_for_application (Bamf.Application app)
 		{
-			foreach (var item in Items) {
+			foreach (var item in internal_items) {
 				unowned ApplicationDockItem? appitem = (item as ApplicationDockItem);
 				if (appitem == null)
 					continue;
@@ -164,7 +180,7 @@
 						var item = Factory.item_factory.make_item (file);
 						
 						if (item.ValidItem)
-							add_item (item);
+							add_item_without_signaling (item);
 						else
 							warning ("The launcher '%s' in dock item '%s' does not exist", item.Launcher, file.get_path ());
 					}
@@ -174,7 +190,7 @@
 			
 			var favs = new ArrayList<string> ();
 			
-			foreach (var item in Items)
+			foreach (var item in internal_items)
 				if ((item is ApplicationDockItem) && !(item is TransientDockItem))
 					favs.add (item.Launcher);
 			
@@ -183,6 +199,41 @@
 			debug ("done.");
 		}
 		
+		void update_visible_items ()
+		{
+			Logger.verbose ("DockItems.update_visible_items ()");
+			
+			var old_items = new ArrayList<DockItem> ();
+			old_items.add_all (visible_items);
+			
+			visible_items.clear ();
+			
+			if (controller.prefs.CurrentWorkspaceOnly) {
+				var active_workspace = Wnck.Screen.get_default ().get_active_workspace ();
+				foreach (var item in internal_items) {
+					var transient = (item as TransientDockItem);
+					if (transient != null
+						&& !WindowControl.has_window_on_workspace (transient.App, active_workspace))
+						continue;
+					visible_items.add (item);
+				}
+			} else {
+				visible_items.add_all (internal_items);
+			}
+			
+			set_item_positions ();
+			
+			var added_items = new ArrayList<DockItem> ();
+			added_items.add_all (visible_items);
+			added_items.remove_all (old_items);
+			
+			var removed_items = old_items;
+			removed_items.remove_all (visible_items);
+			
+			if (added_items.size > 0 || removed_items.size > 0)
+				items_changed (added_items, removed_items);
+		}
+		
 		void add_running_apps ()
 		{
 			// do this a better more efficient way
@@ -194,7 +245,7 @@
 		{
 			var last_sort = 1000;
 			
-			foreach (var item in Items)
+			foreach (var item in internal_items)
 				if (item is TransientDockItem)
 					last_sort = item.Sort;
 			
@@ -217,7 +268,7 @@
 		void set_item_positions ()
 		{
 			int pos = 0;
-			foreach (var i in Items)
+			foreach (var i in visible_items)
 				i.Position = pos++;
 		}
 		
@@ -242,7 +293,7 @@
 			
 			// remove peristent and invalid items
 			var remove = new ArrayList<DockItem> ();
-			foreach (var item in Items)
+			foreach (var item in internal_items)
 				if (!(item is TransientDockItem) || !item.ValidItem)
 					remove.add (item);
 			foreach (var item in remove)
@@ -250,15 +301,48 @@
 			
 			load_items ();
 			add_running_apps ();
-			set_item_positions ();
-			
-			item_state_changed ();
+			update_visible_items ();
+		}
+		
+		void handle_setting_changed ()
+		{
+			update_visible_items ();
+		}
+		
+		void handle_window_changed (Wnck.Window? previous)
+		{
+			if (!controller.prefs.CurrentWorkspaceOnly)
+				return;
+			
+			if (previous == null
+				|| previous.get_workspace () == previous.get_screen ().get_active_workspace ())
+				return;
+			
+			update_visible_items ();
+		}
+		
+		void handle_workspace_changed (Wnck.Screen screen, Wnck.Workspace previously_active_space)
+		{
+			if (!controller.prefs.CurrentWorkspaceOnly
+				|| screen.get_active_workspace ().is_virtual ())
+				return;
+			
+			update_visible_items ();
+		}
+		
+		void handle_viewports_changed (Wnck.Screen screen)
+		{
+			if (!controller.prefs.CurrentWorkspaceOnly
+				|| !screen.get_active_workspace ().is_virtual ())
+				return;
+			
+			update_visible_items ();
 		}
 		
 		void add_item_without_signaling (DockItem item)
 		{
-			Items.add (item);
-			Items.sort ((CompareFunc) compare_items);
+			internal_items.add (item);
+			internal_items.sort ((CompareFunc) compare_items);
 			
 			item.AddTime = new DateTime.now_utc ();
 			item.notify["Icon"].connect (signal_item_state_changed);
@@ -289,7 +373,7 @@
 				(item as ApplicationDockItem).pin_launcher.disconnect (pin_item);
 			}
 			
-			Items.remove (item);
+			internal_items.remove (item);
 			controller.unity.remove_entry (item);
 		}
 		
@@ -304,12 +388,19 @@
 				return;
 			}
 			
+			var index = internal_items.index_of (item);
+			
 			remove_item_without_signaling (item);
-			
 			var new_item = new TransientDockItem.with_application (app);
 			new_item.Position = item.Position;
-			
 			add_item_without_signaling (new_item);
+			
+			if (index >= 0) {
+				internal_items.remove (new_item);
+				internal_items.insert (index, new_item);
+			}
+			
+			update_visible_items ();
 			item_state_changed ();
 		}
 		
@@ -318,7 +409,7 @@
 			if (item is TransientDockItem) {
 				var last_sort = 0;
 				
-				foreach (var i in Items) {
+				foreach (var i in internal_items) {
 					if (i == item)
 						break;
 					if (!(i is TransientDockItem))
@@ -329,12 +420,19 @@
 				if (dockitem_file == null)
 					return;
 				
+				var index = visible_items.index_of (item);
+				
 				remove_item_without_signaling (item);
 				var new_item = new ApplicationDockItem.with_dockitem_file (dockitem_file);
 				new_item.Position = item.Position;
 				add_item_without_signaling (new_item);
 				
-				item_state_changed ();
+				if (index >= 0) {
+					visible_items.insert (index, new_item);
+					item_state_changed ();
+				} else {
+					update_visible_items ();
+				}
 			} else {
 				item.delete ();
 			}

=== modified file 'lib/DockPreferences.vala'
--- lib/DockPreferences.vala	2012-09-26 00:34:22 +0000
+++ lib/DockPreferences.vala	2012-11-16 19:21:20 +0000
@@ -31,6 +31,9 @@
 		const int MIN_ICON_SIZE = 24;
 		const int MAX_ICON_SIZE = 128;
 		
+		[Description(nick = "current-workspace-only", blurb = "Whether to show only windows of the current workspace.")]
+		public bool CurrentWorkspaceOnly { get; set; }
+		
 		[Description(nick = "icon-size", blurb = "The size of dock icons (in pixels).")]
 		public int IconSize { get; set; }
 		
@@ -79,6 +82,7 @@
 		{
 			Logger.verbose ("DockPreferences.reset_properties ()");
 			
+			CurrentWorkspaceOnly = false;
 			IconSize = 48;
 			HideMode = HideType.INTELLIGENT;
 			UnhideDelay = 0;
@@ -138,6 +142,9 @@
 		protected override void verify (string prop)
 		{
 			switch (prop) {
+			case "CurrentWorkspaceOnly":
+				break;
+			
 			case "IconSize":
 				if (IconSize < MIN_ICON_SIZE)
 					IconSize = MIN_ICON_SIZE;

=== modified file 'lib/DockRenderer.vala'
--- lib/DockRenderer.vala	2012-10-04 11:54:18 +0000
+++ lib/DockRenderer.vala	2012-11-16 19:21:20 +0000
@@ -86,9 +86,8 @@
 			controller.prefs.notify.connect (prefs_changed);
 			theme.changed.connect (theme_changed);
 			
-			controller.items.item_removed.connect (items_changed);
-			controller.items.item_added.connect (items_changed);
 			controller.items.item_state_changed.connect (item_state_changed);
+			controller.items.items_changed.connect (items_changed);
 			
 			screen_is_composited = Gdk.Screen.get_default ().is_composited ();
 			Gdk.Screen.get_default ().composited_changed.connect (composited_changed);
@@ -113,9 +112,8 @@
 			controller.prefs.notify.disconnect (prefs_changed);
 			theme.changed.disconnect (theme_changed);
 			
-			controller.items.item_removed.disconnect (items_changed);
-			controller.items.item_added.disconnect (items_changed);
 			controller.items.item_state_changed.disconnect (item_state_changed);
+			controller.items.items_changed.disconnect (items_changed);
 			
 			Gdk.Screen.get_default ().composited_changed.disconnect (composited_changed);
 

=== modified file 'lib/Services/WindowControl.vala'
--- lib/Services/WindowControl.vala	2012-10-22 06:21:06 +0000
+++ lib/Services/WindowControl.vala	2012-11-16 19:21:20 +0000
@@ -134,6 +134,32 @@
 			return false;
 		}
 		
+		public static bool has_window_on_workspace (Bamf.Application app, Wnck.Workspace workspace)
+		{
+			Screen.get_default ();
+			Array<uint32>? xids = app.get_xids ();
+			
+			warn_if_fail (xids != null);
+			
+			var is_virtual = workspace.is_virtual ();
+			
+			for (var i = 0; xids != null && i < xids.length; i++) {
+				var window = Wnck.Window.@get (xids.index (i));
+				if (window == null)
+					continue;
+				
+				if (!is_virtual) {
+					if (window.is_on_workspace (workspace))
+						return true;
+				} else {
+					if (window.is_in_viewport (workspace))
+						return true;
+				}
+			}
+			
+			return false;
+		}
+		
 		public static ArrayList<Bamf.Window> get_windows (Bamf.Application app)
 		{
 			var windows = new ArrayList<Bamf.Window> ();

=== modified file 'lib/libplank.symbols'
--- lib/libplank.symbols	2012-11-15 11:26:39 +0000
+++ lib/libplank.symbols	2012-11-16 19:21:20 +0000
@@ -3,12 +3,14 @@
 plank_dock_controller_new
 plank_dock_items_add_item
 plank_dock_items_construct
+plank_dock_items_get_Items
 plank_dock_items_get_type
 plank_dock_items_new
 plank_dock_items_remove_item
 plank_dock_preferences_construct
 plank_dock_preferences_construct_with_filename
 plank_dock_preferences_decrease_icon_size
+plank_dock_preferences_get_CurrentWorkspaceOnly
 plank_dock_preferences_get_HideMode
 plank_dock_preferences_get_IconSize
 plank_dock_preferences_get_monitor
@@ -21,6 +23,7 @@
 plank_dock_preferences_is_horizontal_dock
 plank_dock_preferences_new
 plank_dock_preferences_new_with_filename
+plank_dock_preferences_set_CurrentWorkspaceOnly
 plank_dock_preferences_set_HideMode
 plank_dock_preferences_set_IconSize
 plank_dock_preferences_set_Monitor