Merge lp:~psybers/do/gconf-notify into lp:do

[Robert Dyer]

[Robert Dyer (psybers)]

This lets the preferences objects be notified by GConf when things change.

A lot of places we cache the .get() from preferences in a field and then the property's get{} returns that. This is done for performance (in places) and makes perfect sense. However, we can now do that *and* be notified by GConf when a setting changed and thus update our cached copy! Horray!

[Robert Dyer (psybers)]

This lets the preferences objects be notified by GConf when things change.

A lot of places we cache the .get() from preferences in a field and then the property's get{} returns that. This is done for performance (in places) and makes perfect sense. However, we can now do that *and* be notified by GConf when a setting changed and thus update our cached copy! Horray!

Re-submitted after adding in proper usage of this new event for other classes such as the docklet service and the bezeled theme.

[Robert Dyer (psybers)]

Bah, pushed with some writelines. Removed in 1303. :-)

[lp:~psybers/do/gconf-notify]

1303. By Robert Dyer <rdyer@yamuna> on 2009-08-28

removing debug statements

1304. By Robert Dyer <rdyer@yamuna> on 2009-08-28

Fixing problem with the theme resetting to itself sometimes.

1305. By Robert Dyer <rdyer@yamuna> on 2009-08-29

adding some docs

[Alex Launi (alexlauni)]

looks good to me after our talk in irc

review: Approve

=== modified file 'Do.Interface.Linux.AnimationBase/src/Do.Interface/Do.Interface.AnimationBase/BezelDrawingArea.cs'
--- Do.Interface.Linux.AnimationBase/src/Do.Interface/Do.Interface.AnimationBase/BezelDrawingArea.cs	2009-06-24 03:58:55 +0000
+++ Do.Interface.Linux.AnimationBase/src/Do.Interface/Do.Interface.AnimationBase/BezelDrawingArea.cs	2009-08-28 08:53:14 +0000
@@ -56,6 +56,18 @@
 #region Static Area
 		static IPreferences prefs = Services.Preferences.Get<BezelDrawingArea> ();
 		public static event EventHandler ThemeChanged;
+
+		static BezelDrawingArea()
+		{
+			prefs.PreferencesChanged += HandlePreferencesChanged;
+		}
+		
+		static void HandlePreferencesChanged (object o, PreferencesChangedEventArgs e)
+		{
+			if (e.Key == "Animated" || e.Key == "WindowRadius")
+				return;
+			OnThemeChanged ();
+		}
 		
 		public static bool Animated {
 			get {
@@ -72,7 +84,6 @@
 			}
 			set {
 				prefs.Set<string> ("TitleRenderer", value);
-				OnThemeChanged ();
 			}
 		}
 		
@@ -82,7 +93,6 @@
 			}
 			set {
 				prefs.Set<string> ("PaneRenderer", value);
-				OnThemeChanged ();
 			}
 		}
 		
@@ -92,7 +102,6 @@
 			}
 			set {
 				prefs.Set<string> ("WindowRenderer", value);
-				OnThemeChanged ();
 			}
 		}
 		
@@ -102,7 +111,6 @@
 			}
 			set {
 				prefs.Set<string> ("BackgroundColor", value);
-				OnThemeChanged ();
 			}
 		}
 		
@@ -112,7 +120,6 @@
 			} 
 			set {
 				prefs.Set<int> ("WindowRadius", Math.Max (-1, value));
-				OnThemeChanged ();
 			}
 		}
 		
@@ -122,7 +129,6 @@
 			}
 			set {
 				prefs.Set<bool> ("Shadow", value);
-				OnThemeChanged ();
 			}
 		}
 		
@@ -135,7 +141,6 @@
 		public static void ResetBackgroundStyle ()
 		{
 			prefs.Set<string> ("BackgroundColor", "default");
-			OnThemeChanged ();
 		}
 		
 		private static void OnThemeChanged ()
@@ -404,7 +409,6 @@
 			TextUtility = new TextRenderer (this);
 			
 			DoubleBuffered = false;
-			prefs = Services.Preferences.Get<BezelDrawingArea> ();
 			this.preview = preview;
 			this.theme = theme;
 			

=== modified file 'Do.Interface.Linux.Docky/src/Docky.Core/Docky.Core.Default/DockletService.cs'
--- Do.Interface.Linux.Docky/src/Docky.Core/Docky.Core.Default/DockletService.cs	2009-05-19 18:51:02 +0000
+++ Do.Interface.Linux.Docky/src/Docky.Core/Docky.Core.Default/DockletService.cs	2009-08-28 09:09:09 +0000
@@ -50,6 +50,7 @@
 				docklet.Enable ();
 			
 			docklets [docklet] = !docklets [docklet];
+			SaveConfiguration ();
 			OnAppletVisibilityChanged ();
 			return true;
 		}
@@ -83,15 +84,27 @@
 		public DockletService()
 		{
 			prefs = Services.Preferences.Get<DockletService> ();
+			prefs.PreferencesChanged += HandlePreferencesChanged;
 			
 			AddinManager.AddExtensionNodeHandler (ExtensionPath, HandleDockletsChanged);
 			
 			BuildDocklets ();
 		}
 		
+		void HandlePreferencesChanged (object sender, PreferencesChangedEventArgs args)
+		{
+			Console.WriteLine("key = " + args.Key);
+			Console.WriteLine("val = " + args.Value);
+			if (args.Key != "ActiveApplets")
+				return;
+			BuildDocklets ();
+			OnAppletVisibilityChanged ();
+		}
+		
 		void HandleDockletsChanged (object sender, ExtensionNodeEventArgs args)
 		{
 			BuildDocklets ();
+			SaveConfiguration ();
 			OnAppletVisibilityChanged ();
 		}
 		
@@ -124,12 +137,12 @@
 			foreach (AbstractDockletItem abi in ActiveDocklets) {
 				s += abi.GetType ().Name + ";";
 			}
-			prefs.Set ("ActiveApplets", s);
+			if (s != prefs.Get ("ActiveApplets", "ClockDockItem;"))
+				prefs.Set ("ActiveApplets", s);
 		}
 		
 		void OnAppletVisibilityChanged ()
 		{
-			SaveConfiguration ();
 			if (AppletVisibilityChanged != null)
 				AppletVisibilityChanged (this, EventArgs.Empty);
 		}

=== modified file 'Do.Interface.Linux.Docky/src/Docky.Interface/Docky.Interface.Items/ClockDockItem.cs'
--- Do.Interface.Linux.Docky/src/Docky.Interface/Docky.Interface.Items/ClockDockItem.cs	2009-08-20 08:27:24 +0000
+++ Do.Interface.Linux.Docky/src/Docky.Interface/Docky.Interface.Items/ClockDockItem.cs	2009-08-28 05:42:11 +0000
@@ -107,6 +107,20 @@
 			cal_painter = new CalendarPainter (this);
 			Core.DockServices.PainterService.RegisterPainter (cal_painter);
 			GLib.Timeout.Add (1000, ClockUpdateTimer);
+			prefs.PreferencesChanged += HandlePreferencesChanged;
+		}
+		
+		void HandlePreferencesChanged (object o, PreferencesChangedEventArgs e)
+		{
+			if (e.Key == "ClockTheme")
+				current_theme = (string)e.OldValue;
+			if (e.Key == "ShowDate")
+				show_date = (bool)e.OldValue;
+			if (e.Key == "ShowDigital")
+				digital = (bool)e.OldValue;
+			if (e.Key == "ShowMilitary")
+				show_military = (bool)e.OldValue;
+			RedrawIcon();
 		}
 		
 		bool ClockUpdateTimer ()

=== modified file 'Do.Interface.Linux.Docky/src/Docky.Utilities/DockPreferences.cs'
--- Do.Interface.Linux.Docky/src/Docky.Utilities/DockPreferences.cs	2009-06-19 04:32:13 +0000
+++ Do.Interface.Linux.Docky/src/Docky.Utilities/DockPreferences.cs	2009-08-28 06:46:50 +0000
@@ -56,6 +56,28 @@
 					return true;
 				});
 			}
+			prefs.PreferencesChanged += HandlePreferencesChanged;
+		}
+		
+		static void HandlePreferencesChanged (object o, PreferencesChangedEventArgs e) {
+			if (e.Key == "IndicateMultipleWindows")
+				SetIndicateMultipleWindows ((bool)e.Value);
+			if (e.Key == "ZoomPercent")
+				SetZoomPercent ((double)e.Value);
+			if (e.Key == "EnableZoom")
+				SetZoomEnabled ((bool)e.Value);
+			if (e.Key == "IconSize")
+				SetIconSize ((int)e.Value);
+			if (e.Key == "SummonTime")
+				SetSummonTime (new TimeSpan (0, 0, 0, 0, (int)e.Value));
+			if (e.Key == "AutomaticIcons")
+				SetAutomaticIcons ((int)e.Value);
+			if (e.Key == "Monitor")
+				SetMonitor (Math.Max (0, (int)e.Value));
+			if (e.Key == "Orientation")
+				SetOrientation ((DockOrientation) Enum.Parse (typeof (DockOrientation), (string)e.Value));
+			if (e.Key == "AutohideType")
+				SetAutohideType ((AutohideType) Enum.Parse (typeof (AutohideType), (string)e.Value));
 		}
 		
 		public static int TextWidth {
@@ -70,34 +92,52 @@
 		public static bool IndicateMultipleWindows {
 			get { return indicate_multiple_windows; }
 			set { 
-				prefs.Set ("IndicateMultipleWindows", value); 
-				indicate_multiple_windows = value;
+				if (SetIndicateMultipleWindows (value))
+					prefs.Set ("IndicateMultipleWindows", value); 
 			}
 		}
+		static bool SetIndicateMultipleWindows (bool val)
+		{
+			if (indicate_multiple_windows == val) return false;
+			indicate_multiple_windows = val;
+			return true;
+		}
 		
 		static double zoom_percent = Math.Round (prefs.Get ("ZoomPercent", 2.0), 1);
 		public static double ZoomPercent {
 			get { return ZoomEnabled ? zoom_percent : 1; }
 			set {
-				if (value < 1)
-					value = 1;
-				prefs.Set ("ZoomPercent", value);
-				zoom_percent = value;
-				if (IconSizeChanged != null)
-					IconSizeChanged ();
+				if (SetZoomPercent (value))
+					prefs.Set ("ZoomPercent", value);
 			}
 		}
+		static bool SetZoomPercent (double val)
+		{
+			if (val < 1)
+				val = 1;
+			if (zoom_percent == val) return false;
+			zoom_percent = val;
+			if (IconSizeChanged != null)
+				IconSizeChanged ();
+			return true;
+		}
 		
 		static bool enable_zoom = prefs.Get ("EnableZoom", true);
 		public static bool ZoomEnabled {
 			get { return enable_zoom; }
 			set {
-				prefs.Set ("EnableZoom", value);
-				enable_zoom = value;
-				if (IconSizeChanged != null)
-					IconSizeChanged ();
+				if (SetZoomEnabled (value))
+					prefs.Set ("EnableZoom", value);
 			}
 		}
+		static bool SetZoomEnabled (bool val)
+		{
+			if (enable_zoom == val) return false;
+			enable_zoom = val;
+			if (IconSizeChanged != null)
+				IconSizeChanged ();
+			return true;
+		}
 		
 		public static int FullIconSize {
 			get {
@@ -120,20 +160,25 @@
 		public static int IconSize {
 			get { return Math.Min (icon_size, MaxIconSize); }
 			set {
-				if (value < 24)
-					value = 24;
-				if (value > 128)
-					value = 128;
-				
-				if (value == icon_size)
-					return;
-				
-				prefs.Set ("IconSize", value); 
-				icon_size = value;
-				if (IconSizeChanged != null)
-					IconSizeChanged ();
+				if (SetIconSize (value))
+					prefs.Set ("IconSize", value); 
 			}
 		}
+		static bool SetIconSize (int val)
+		{
+			if (val < 24)
+				val = 24;
+			if (val > 128)
+				val = 128;
+			
+			if (val == icon_size)
+				return false;
+			
+			icon_size = val;
+			if (IconSizeChanged != null)
+				IconSizeChanged ();
+			return true;
+		}
 		
 		/// <summary>
 		/// Currently returns ZoomPercent.  This is useful in the future case where we wish to optimize for best
@@ -151,24 +196,36 @@
 		public static TimeSpan SummonTime {
 			get { return summon_time; }
 			set {
-				prefs.Set ("SummonTime", value.TotalMilliseconds);
-				summon_time = value;
+				if (SetSummonTime (value))
+					prefs.Set ("SummonTime", value.TotalMilliseconds);
 			}
 		}
+		static bool SetSummonTime (TimeSpan val)
+		{
+			if (summon_time == val) return false;
+			summon_time = val;
+			return true;
+		}
 		
 		static int automatic_icons = prefs.Get ("AutomaticIcons", 5);
 		public static int AutomaticIcons {
 			get { return automatic_icons; }
 			set {
-				if (value < 0)
-					value = 0;
-				prefs.Set ("AutomaticIcons", value);
-				automatic_icons = value;
-				
-				if (AutomaticIconsChanged != null)
-					AutomaticIconsChanged ();
+				if (SetAutomaticIcons (value))
+					prefs.Set ("AutomaticIcons", value);
 			}
 		}
+		static bool SetAutomaticIcons (int val)
+		{
+			if (val < 0)
+				val = 0;
+			if (automatic_icons == val) return false;
+			automatic_icons = val;
+			
+			if (AutomaticIconsChanged != null)
+				AutomaticIconsChanged ();
+			return true;
+		}
 
 		static int monitor = Math.Max (0, prefs.Get ("Monitor", 0));
 		public static int Monitor {
@@ -177,19 +234,25 @@
 				return monitor;
 			}
 			set {
-				if (monitor == value)
-					return;
-				
-				if (value >= Gdk.Screen.Default.NMonitors || value < 0)
-					value = 0;
-				monitor = value;
-				prefs.Set ("Monitor", value);
-
-				Interface.LayoutUtils.Recalculate ();
-				if (MonitorChanged != null)
-					MonitorChanged ();
+				if (SetMonitor (value))
+					prefs.Set ("Monitor", value);
 			}
 		}
+		static bool SetMonitor (int val)
+		{
+			if (val >= Gdk.Screen.Default.NMonitors || val < 0)
+				val = 0;
+
+			if (monitor == val)
+				return false;
+			
+			monitor = val;
+
+			Interface.LayoutUtils.Recalculate ();
+			if (MonitorChanged != null)
+				MonitorChanged ();
+			return true;
+		}
 
 		static DockOrientation orientation = (DockOrientation) Enum.Parse (typeof (DockOrientation), prefs.Get ("Orientation", DockOrientation.Bottom.ToString ()));
 		public static DockOrientation Orientation {
@@ -200,27 +263,37 @@
 				return orientation;
 			}
 			set {
-				if (orientation == value)
-					return;
-				orientation = value;
-				prefs.Set ("Orientation", value.ToString ());
-				if (OrientationChanged != null)
-					OrientationChanged ();
+				if (SetOrientation (value))
+					prefs.Set ("Orientation", value.ToString ());
 			}
 		}
+		static bool SetOrientation (DockOrientation val)
+		{
+			if (orientation == val)
+				return false;
+			orientation = val;
+			if (OrientationChanged != null)
+				OrientationChanged ();
+			return true;
+		}
 		
 		static AutohideType hide = (AutohideType) Enum.Parse (typeof (AutohideType), prefs.Get ("AutohideType", AutohideType.None.ToString ()));
 		public static AutohideType AutohideType {
 			get { return hide; }
 			set {
-				if (hide == value)
-					return;
-				hide = value;
-				prefs.Set ("AutohideType", value.ToString ());
-				if (AutohideChanged != null)
-					AutohideChanged ();
+				if (SetAutohideType (value))
+					prefs.Set ("AutohideType", value.ToString ());
 			}
 		}
+		static bool SetAutohideType (AutohideType val)
+		{
+			if (hide == val)
+				return false;
+			hide = val;
+			if (AutohideChanged != null)
+				AutohideChanged ();
+			return true;
+		}
 
 		#region blacklists
 		static List<string> item_blacklist = DeserializeBlacklist ();

=== modified file 'Do.Platform.Linux/src/Do.Platform/Do.Platform.Linux/GConfPreferencesService.cs'
--- Do.Platform.Linux/src/Do.Platform/Do.Platform.Linux/GConfPreferencesService.cs	2009-01-18 00:47:28 +0000
+++ Do.Platform.Linux/src/Do.Platform/Do.Platform.Linux/GConfPreferencesService.cs	2009-08-28 06:44:14 +0000
@@ -38,6 +38,12 @@
 		{
 			RootPath = rootPath;
 			client = new GConf.Client ();
+			client.AddNotify (RootPath, new GConf.NotifyEventHandler (HandleGConfChanged));
+		}
+		
+		void HandleGConfChanged (object sender, GConf.NotifyEventArgs args)
+		{
+			OnPreferencesChanged (args.Key.Substring(RootPath.Length + 1), null, args.Value);
 		}
 
 		string AbsolutePathForKey (string key)
@@ -46,9 +52,23 @@
 				return key;
 			return string.Format ("{0}/{1}", RootPath, key);
 		}
-
+		
+		bool IgnoreNextEvent { get; set; }
+		
+		void OnPreferencesChanged (string key, object oldValue, object newValue)
+		{
+			if (IgnoreNextEvent) {
+				IgnoreNextEvent = false;
+				return;
+			}
+			if (PreferencesChanged == null) return;
+			PreferencesChanged (this, new PreferencesChangedEventArgs (key, oldValue, newValue));
+		}
+		
 		#region IPreferencesService
 		
+		public event EventHandler<PreferencesChangedEventArgs> PreferencesChanged;
+		
 		public bool Set<T> (string key, T val)
 		{
 			bool success = true;
@@ -59,6 +79,7 @@
 				Log.Debug (e.StackTrace);
 				success = false;
 			}
+			IgnoreNextEvent = success;
 			return success;
 		}
 

=== modified file 'Do.Platform/src/Do.Platform/Do.Platform.Common/DictionaryPreferencesService.cs'
--- Do.Platform/src/Do.Platform/Do.Platform.Common/DictionaryPreferencesService.cs	2009-01-18 00:47:28 +0000
+++ Do.Platform/src/Do.Platform/Do.Platform.Common/DictionaryPreferencesService.cs	2009-08-28 05:42:11 +0000
@@ -35,8 +35,16 @@
 			Store = new Dictionary<string, object> ();
 		}
 		
+		void OnPreferencesChanged (string key, object oldValue, object newValue)
+		{
+			if (PreferencesChanged == null) return;
+			PreferencesChanged (this, new PreferencesChangedEventArgs (key, oldValue, newValue));
+		}
+		
 		#region IPreferencesService
 		
+		public event EventHandler<PreferencesChangedEventArgs> PreferencesChanged;
+		
 		public bool Set<T> (string key, T val)
 		{
 			Store [key] = val;

=== modified file 'Do.Platform/src/Do.Platform/Do.Platform.Default/PreferencesService.cs'
--- Do.Platform/src/Do.Platform/Do.Platform.Default/PreferencesService.cs	2008-12-18 18:39:06 +0000
+++ Do.Platform/src/Do.Platform/Do.Platform.Default/PreferencesService.cs	2009-08-28 05:42:11 +0000
@@ -29,6 +29,8 @@
 
 		#region IPreferencesService
 		
+		public event EventHandler<PreferencesChangedEventArgs> PreferencesChanged;
+		
 		public bool Set<T> (string key, T val)
 		{
 			Log.Debug ("Default IPreferencesService cannot set key \"{0}\".", key);

=== modified file 'Do.Platform/src/Do.Platform/Do.Platform.Preferences/PreferencesImplementation.cs'
--- Do.Platform/src/Do.Platform/Do.Platform.Preferences/PreferencesImplementation.cs	2009-01-08 18:12:28 +0000
+++ Do.Platform/src/Do.Platform/Do.Platform.Preferences/PreferencesImplementation.cs	2009-08-28 06:40:00 +0000
@@ -38,12 +38,19 @@
 		{
 			Service = service;
 			SecureService = new SecurePreferencesServiceWrapper (secureService);
-		}
-		
-		void OnPreferencesChanged (string key, object oldValue)
+			Service.PreferencesChanged += HandlePreferencesChanged;
+		}
+		
+		void HandlePreferencesChanged (object o, PreferencesChangedEventArgs e)
+		{
+			if (e.Key.Length <= OwnerString.Length + 1 || e.Key.Substring(0, OwnerString.Length) != OwnerString) return;
+			OnPreferencesChanged (e.Key.Substring(OwnerString.Length + 1), e.OldValue, e.Value);
+		}
+		
+		void OnPreferencesChanged (string key, object oldValue, object newValue)
 		{
 			if (PreferencesChanged == null) return;
-			PreferencesChanged (this, new PreferencesChangedEventArgs (key, oldValue));
+			PreferencesChanged (this, new PreferencesChangedEventArgs (key, oldValue, newValue));
 		}
 
 		#region IPreferences
@@ -109,7 +116,7 @@
 				oldValue = default (T);
 			
 			if (service.Set (keypath, val)) {
-				OnPreferencesChanged (key, oldValue);
+				OnPreferencesChanged (key, oldValue, val);
 				return true;
 			}
 			return false;

=== modified file 'Do.Platform/src/Do.Platform/IPreferencesService.cs'
--- Do.Platform/src/Do.Platform/IPreferencesService.cs	2008-12-18 18:39:06 +0000
+++ Do.Platform/src/Do.Platform/IPreferencesService.cs	2009-08-28 05:42:11 +0000
@@ -28,7 +28,9 @@
 	
 	public interface IPreferencesService : IService
 	{
+		event EventHandler<PreferencesChangedEventArgs> PreferencesChanged;
+		
 		bool Set<T>    (string key, T val);
 		bool TryGet<T> (string key, out T val);
 	}
-}
\ No newline at end of file
+}

=== modified file 'Do.Platform/src/Do.Platform/PreferencesChangedEventArgs.cs'
--- Do.Platform/src/Do.Platform/PreferencesChangedEventArgs.cs	2008-12-18 18:39:06 +0000
+++ Do.Platform/src/Do.Platform/PreferencesChangedEventArgs.cs	2009-08-28 05:42:11 +0000
@@ -26,12 +26,14 @@
 	{
 		public string Key { get; private set; }
 		public object OldValue { get; private set; }
+		public object Value { get; private set; }
 		
-		public PreferencesChangedEventArgs (string key, object oldValue)
+		public PreferencesChangedEventArgs (string key, object oldValue, object newValue)
 		{
 			Key = key;
 			OldValue = oldValue;
+			Value = newValue;
 		}
 	}
 	
-}
\ No newline at end of file
+}

=== modified file 'Do.Platform/src/Do.Platform/SecurePreferencesWrapper.cs'
--- Do.Platform/src/Do.Platform/SecurePreferencesWrapper.cs	2008-12-18 18:39:06 +0000
+++ Do.Platform/src/Do.Platform/SecurePreferencesWrapper.cs	2009-08-28 05:42:11 +0000
@@ -36,6 +36,8 @@
 		{
 			SecureService = secureService;
 		}
+		
+		public event EventHandler<PreferencesChangedEventArgs> PreferencesChanged;
 
 		public bool Set<T> (string key, T val)
 		{

=== modified file 'Do/src/Do.Core/Controller.cs'
--- Do/src/Do.Core/Controller.cs	2009-08-19 07:27:08 +0000
+++ Do/src/Do.Core/Controller.cs	2009-08-28 08:43:13 +0000
@@ -175,7 +175,7 @@
 		
 		void OnThemeChanged (object sender, PreferencesChangedEventArgs e)
 		{
-			string oldTheme = e.OldValue as string, newTheme = Do.Preferences.Theme;
+			string oldTheme = e.OldValue as string, newTheme = e.Value as string;
 			
 			// Only change the theme of the old and new themes are different.
 			if (oldTheme != newTheme) {