2 * Copyright © 2001, 2007 Red Hat, Inc.
4 * Permission to use, copy, modify, distribute, and sell this software and its
5 * documentation for any purpose is hereby granted without fee, provided that
6 * the above copyright notice appear in all copies and that both that
7 * copyright notice and this permission notice appear in supporting
8 * documentation, and that the name of Red Hat not be used in advertising or
9 * publicity pertaining to distribution of the software without specific,
10 * written prior permission. Red Hat makes no representations about the
11 * suitability of this software for any purpose. It is provided "as is"
12 * without express or implied warranty.
14 * RED HAT DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL
15 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL RED HAT
16 * BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
17 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION
18 * OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
19 * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
21 * Author: Owen Taylor, Red Hat, Inc.
26 #include "xsettings-client.h"
28 #include <gdk/x11/gdkx11display.h>
29 #include <gdk/x11/gdkx11property.h>
30 #include <gdk/x11/gdkx11screen.h>
31 #include <gdk/x11/gdkx11window.h>
32 #include <gdk/x11/gdkscreen-x11.h>
34 #include <gdkinternals.h>
39 #include <X11/Xmd.h> /* For CARD16 */
41 #include "gdksettings.c"
43 typedef struct _XSettingsBuffer XSettingsBuffer;
45 struct _XSettingsBuffer
53 struct _XSettingsClient
58 Window manager_window;
61 GHashTable *settings; /* string of GDK settings name => XSettingsSetting */
65 gdk_xsettings_notify (const char *name,
66 GdkSettingAction action,
67 XSettingsSetting *setting,
71 GdkX11Screen *x11_screen = GDK_X11_SCREEN (screen);
73 if (x11_screen->xsettings_in_init)
76 new_event.type = GDK_SETTING;
77 new_event.setting.window = gdk_screen_get_root_window (screen);
78 new_event.setting.send_event = FALSE;
79 new_event.setting.action = action;
80 new_event.setting.name = (char*) name;
82 gdk_event_put (&new_event);
86 notify_changes (XSettingsClient *client,
90 XSettingsSetting *setting, *old_setting;
93 if (client->settings != NULL)
95 g_hash_table_iter_init (&iter, client->settings);
96 while (g_hash_table_iter_next (&iter, (gpointer *) &name, (gpointer*) &setting))
98 old_setting = old_list ? g_hash_table_lookup (old_list, name) : NULL;
100 if (old_setting == NULL)
101 gdk_xsettings_notify (name, GDK_SETTING_ACTION_NEW, setting, client->screen);
102 else if (!xsettings_setting_equal (setting, old_setting))
103 gdk_xsettings_notify (name, GDK_SETTING_ACTION_CHANGED, setting, client->screen);
105 /* remove setting from old_list */
106 if (old_setting != NULL)
107 g_hash_table_remove (old_list, name);
111 if (old_list != NULL)
113 /* old_list now contains only deleted settings */
114 g_hash_table_iter_init (&iter, old_list);
115 while (g_hash_table_iter_next (&iter, (gpointer *) &name, (gpointer*) &old_setting))
116 gdk_xsettings_notify (name, GDK_SETTING_ACTION_DELETED, NULL, client->screen);
120 #define BYTES_LEFT(buffer) ((buffer)->data + (buffer)->len - (buffer)->pos)
122 #define return_if_fail_bytes(buffer, n_bytes) G_STMT_START{ \
123 if (BYTES_LEFT (buffer) < (n_bytes)) \
125 g_warning ("Invalid XSETTINGS property (read off end: Expected %u bytes, only %ld left", \
126 (n_bytes), BYTES_LEFT (buffer)); \
132 fetch_card16 (XSettingsBuffer *buffer,
137 return_if_fail_bytes (buffer, 2);
139 x = *(CARD16 *)buffer->pos;
142 if (buffer->byte_order == MSBFirst)
143 *result = GUINT16_FROM_BE (x);
145 *result = GUINT16_FROM_LE (x);
151 fetch_ushort (XSettingsBuffer *buffer,
152 unsigned short *result)
157 r = fetch_card16 (buffer, &x);
165 fetch_card32 (XSettingsBuffer *buffer,
170 return_if_fail_bytes (buffer, 4);
172 x = *(CARD32 *)buffer->pos;
175 if (buffer->byte_order == MSBFirst)
176 *result = GUINT32_FROM_BE (x);
178 *result = GUINT32_FROM_LE (x);
184 fetch_card8 (XSettingsBuffer *buffer,
187 return_if_fail_bytes (buffer, 1);
189 *result = *(CARD8 *)buffer->pos;
195 #define XSETTINGS_PAD(n,m) ((n + m - 1) & (~(m-1)))
198 fetch_string (XSettingsBuffer *buffer,
204 pad_len = XSETTINGS_PAD (length, 4);
205 if (pad_len < length) /* guard against overflow */
207 g_warning ("Invalid XSETTINGS property (overflow in string length)");
211 return_if_fail_bytes (buffer, pad_len);
213 *result = g_strndup ((char *) buffer->pos, length);
214 buffer->pos += pad_len;
220 parse_settings (unsigned char *data,
223 XSettingsBuffer buffer;
224 GHashTable *settings = NULL;
228 XSettingsSetting *setting = NULL;
230 const char *gdk_name;
232 buffer.pos = buffer.data = data;
235 if (!fetch_card8 (&buffer, (unsigned char *)&buffer.byte_order))
238 if (buffer.byte_order != MSBFirst &&
239 buffer.byte_order != LSBFirst)
241 g_warning ("Invalid XSETTINGS property (unknown byte order %u)", buffer.byte_order);
247 if (!fetch_card32 (&buffer, &serial) ||
248 !fetch_card32 (&buffer, &n_entries))
251 GDK_NOTE(SETTINGS, g_print("reading %u settings (serial %u byte order %u)\n", n_entries, serial, buffer.byte_order));
253 for (i = 0; i < n_entries; i++)
259 if (!fetch_card8 (&buffer, &type))
264 if (!fetch_card16 (&buffer, &name_len))
267 setting = g_new (XSettingsSetting, 1);
268 setting->type = XSETTINGS_TYPE_INT; /* No allocated memory */
270 if (!fetch_string (&buffer, name_len, &x_name) ||
271 /* last change serial (we ignore it) */
272 !fetch_card32 (&buffer, &v_int))
277 case XSETTINGS_TYPE_INT:
278 if (!fetch_card32 (&buffer, &v_int))
281 setting->data.v_int = (INT32)v_int;
282 GDK_NOTE(SETTINGS, g_print(" %s = %d\n", x_name, (gint) setting->data.v_int));
284 case XSETTINGS_TYPE_STRING:
285 if (!fetch_card32 (&buffer, &v_int) ||
286 !fetch_string (&buffer, v_int, &setting->data.v_string))
289 GDK_NOTE(SETTINGS, g_print(" %s = \"%s\"\n", x_name, setting->data.v_string));
291 case XSETTINGS_TYPE_COLOR:
292 if (!fetch_ushort (&buffer, &setting->data.v_color.red) ||
293 !fetch_ushort (&buffer, &setting->data.v_color.green) ||
294 !fetch_ushort (&buffer, &setting->data.v_color.blue) ||
295 !fetch_ushort (&buffer, &setting->data.v_color.alpha))
298 GDK_NOTE(SETTINGS, g_print(" %s = #%02X%02X%02X%02X\n", x_name,
299 setting->data.v_color.alpha, setting->data.v_color.red,
300 setting->data.v_color.green, setting->data.v_color.blue));
303 /* Quietly ignore unknown types */
304 GDK_NOTE(SETTINGS, g_print(" %s = ignored (unknown type %u)\n", x_name, type));
308 setting->type = type;
310 gdk_name = gdk_from_xsettings_name (x_name);
314 if (gdk_name == NULL)
316 GDK_NOTE(SETTINGS, g_print(" ==> unknown to GTK\n"));
320 GDK_NOTE(SETTINGS, g_print(" ==> storing as '%s'\n", gdk_name));
322 if (settings == NULL)
323 settings = g_hash_table_new_full (g_str_hash, g_str_equal,
325 (GDestroyNotify) xsettings_setting_free);
327 if (g_hash_table_lookup (settings, gdk_name) != NULL)
329 g_warning ("Invalid XSETTINGS property (Duplicate entry for '%s')", gdk_name);
333 g_hash_table_insert (settings, (gpointer) gdk_name, setting);
344 xsettings_setting_free (setting);
347 g_hash_table_unref (settings);
355 read_settings (XSettingsClient *client)
359 unsigned long n_items;
360 unsigned long bytes_after;
364 GHashTable *old_list = client->settings;
366 client->settings = NULL;
368 if (client->manager_window)
370 GdkDisplay *display = gdk_screen_get_display (client->screen);
371 Atom xsettings_atom = gdk_x11_get_xatom_by_name_for_display (display, "_XSETTINGS_SETTINGS");
373 gdk_x11_display_error_trap_push (display);
374 result = XGetWindowProperty (client->display, client->manager_window,
375 xsettings_atom, 0, LONG_MAX,
376 False, xsettings_atom,
377 &type, &format, &n_items, &bytes_after, &data);
378 gdk_x11_display_error_trap_pop_ignored (display);
380 if (result == Success && type != None)
382 if (type != xsettings_atom)
384 g_warning ("Invalid type for XSETTINGS property: %s", gdk_x11_get_xatom_name_for_display (display, type));
386 else if (format != 8)
388 g_warning ("Invalid format for XSETTINGS property: %d", format);
391 client->settings = parse_settings (data, n_items);
397 notify_changes (client, old_list);
399 g_hash_table_unref (old_list);
403 gdk_xsettings_watch (Window window,
408 check_manager_window (XSettingsClient *client)
410 if (client->manager_window)
411 gdk_xsettings_watch (client->manager_window, False, client->screen);
413 gdk_x11_display_grab (gdk_screen_get_display (client->screen));
415 client->manager_window = XGetSelectionOwner (client->display,
416 client->selection_atom);
417 if (client->manager_window)
418 XSelectInput (client->display, client->manager_window,
419 PropertyChangeMask | StructureNotifyMask);
421 gdk_x11_display_ungrab (gdk_screen_get_display (client->screen));
423 XFlush (client->display);
425 if (client->manager_window)
427 if (!gdk_xsettings_watch (client->manager_window, True, client->screen))
429 /* Inability to watch the window probably means that it was destroyed
432 client->manager_window = None;
437 read_settings (client);
440 static GdkFilterReturn
441 gdk_xsettings_client_event_filter (GdkXEvent *xevent,
445 GdkScreen *screen = data;
446 GdkDisplay *display = gdk_screen_get_display (screen);
447 XSettingsClient *client = GDK_X11_SCREEN (screen)->xsettings_client;
448 XEvent *xev = xevent;
450 /* The checks here will not unlikely cause us to reread
451 * the properties from the manager window a number of
452 * times when the manager changes from A->B. But manager changes
453 * are going to be pretty rare.
455 if (xev->xany.window == gdk_x11_window_get_xid (gdk_screen_get_root_window (screen)))
457 if (xev->xany.type == ClientMessage &&
458 xev->xclient.message_type == gdk_x11_get_xatom_by_name_for_display (display, "MANAGER") &&
459 xev->xclient.data.l[1] == client->selection_atom)
461 check_manager_window (client);
462 return GDK_FILTER_REMOVE;
465 else if (xev->xany.window == client->manager_window)
467 if (xev->xany.type == DestroyNotify)
469 check_manager_window (client);
470 /* let GDK do its cleanup */
471 return GDK_FILTER_CONTINUE;
473 else if (xev->xany.type == PropertyNotify)
475 read_settings (client);
476 return GDK_FILTER_REMOVE;
480 return GDK_FILTER_CONTINUE;;
484 gdk_xsettings_watch (Window window,
490 gdkwin = gdk_x11_window_lookup_for_display (gdk_screen_get_display (screen), window);
495 g_object_ref (gdkwin);
498 gdkwin = gdk_x11_window_foreign_new_for_display (gdk_screen_get_display (screen), window);
500 /* gdk_window_foreign_new_for_display() can fail and return NULL if the
501 * window has already been destroyed.
507 gdk_window_add_filter (gdkwin, gdk_xsettings_client_event_filter, screen);
513 /* gdkwin should not be NULL here, since if starting the watch succeeded
514 * we have a reference on the window. It might mean that the caller didn't
515 * remove the watch when it got a DestroyNotify event. Or maybe the
516 * caller ignored the return value when starting the watch failed.
518 g_warning ("gdk_xsettings_watch_cb(): Couldn't find window to unwatch");
522 gdk_window_remove_filter (gdkwin, gdk_xsettings_client_event_filter, screen);
523 g_object_unref (gdkwin);
530 xsettings_client_new (GdkScreen *screen)
532 XSettingsClient *client;
533 char *selection_atom_name;
535 client = g_new (XSettingsClient, 1);
539 client->screen = screen;
540 client->display = gdk_x11_display_get_xdisplay (gdk_screen_get_display (screen));
541 client->screen = screen;
542 client->manager_window = None;
543 client->settings = NULL;
545 selection_atom_name = g_strdup_printf ("_XSETTINGS_S%d", gdk_x11_screen_get_screen_number (screen));
546 client->selection_atom = gdk_x11_get_xatom_by_name_for_display (gdk_screen_get_display (screen), selection_atom_name);
547 g_free (selection_atom_name);
549 gdk_xsettings_watch (gdk_x11_window_get_xid (gdk_screen_get_root_window (screen)), True, client->screen);
551 check_manager_window (client);
557 xsettings_client_destroy (XSettingsClient *client)
559 gdk_xsettings_watch (gdk_x11_window_get_xid (gdk_screen_get_root_window (client->screen)), False, client->screen);
560 if (client->manager_window)
561 gdk_xsettings_watch (client->manager_window, False, client->screen);
563 if (client->settings)
564 g_hash_table_unref (client->settings);
568 const XSettingsSetting *
569 xsettings_client_get_setting (XSettingsClient *client,
572 return g_hash_table_lookup (client->settings, name);
576 xsettings_setting_equal (XSettingsSetting *setting_a,
577 XSettingsSetting *setting_b)
579 if (setting_a->type != setting_b->type)
582 switch (setting_a->type)
584 case XSETTINGS_TYPE_INT:
585 return setting_a->data.v_int == setting_b->data.v_int;
586 case XSETTINGS_TYPE_COLOR:
587 return (setting_a->data.v_color.red == setting_b->data.v_color.red &&
588 setting_a->data.v_color.green == setting_b->data.v_color.green &&
589 setting_a->data.v_color.blue == setting_b->data.v_color.blue &&
590 setting_a->data.v_color.alpha == setting_b->data.v_color.alpha);
591 case XSETTINGS_TYPE_STRING:
592 return strcmp (setting_a->data.v_string, setting_b->data.v_string) == 0;
599 xsettings_setting_free (XSettingsSetting *setting)
601 if (setting->type == XSETTINGS_TYPE_STRING)
602 g_free (setting->data.v_string);