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/gdkx11screen.h>
30 #include <gdk/x11/gdkx11window.h>
32 #include <gdkinternals.h>
37 #include <X11/Xmd.h> /* For CARD16 */
39 typedef struct _XSettingsBuffer XSettingsBuffer;
47 XSETTINGS_DUPLICATE_ENTRY
50 struct _XSettingsBuffer
58 struct _XSettingsClient
62 XSettingsNotifyFunc notify;
63 XSettingsWatchFunc watch;
66 Window manager_window;
71 GHashTable *settings; /* string => XSettingsSetting */
75 notify_changes (XSettingsClient *client,
79 XSettingsSetting *setting, *old_setting;
84 if (client->settings != NULL)
86 g_hash_table_iter_init (&iter, client->settings);
87 while (g_hash_table_iter_next (&iter, NULL, (gpointer*) &setting))
89 old_setting = old_list ? g_hash_table_lookup (old_list, setting->name) : NULL;
91 if (old_setting == NULL)
92 client->notify (setting->name, XSETTINGS_ACTION_NEW, setting, client->cb_data);
93 else if (!xsettings_setting_equal (setting, old_setting))
94 client->notify (setting->name, XSETTINGS_ACTION_CHANGED, setting, client->cb_data);
96 /* remove setting from old_list */
97 if (old_setting != NULL)
98 g_hash_table_remove (old_list, setting->name);
102 if (old_list != NULL)
104 /* old_list now contains only deleted settings */
105 g_hash_table_iter_init (&iter, old_list);
106 while (g_hash_table_iter_next (&iter, NULL, (gpointer*) &old_setting))
107 client->notify (old_setting->name, XSETTINGS_ACTION_DELETED, NULL, client->cb_data);
111 #define BYTES_LEFT(buffer) ((buffer)->data + (buffer)->len - (buffer)->pos)
113 #define return_if_fail_bytes(buffer, n_bytes) G_STMT_START{ \
114 if (BYTES_LEFT (buffer) < (n_bytes)) \
116 g_warning ("Invalid XSETTINGS property (read off end: Expected %u bytes, only %ld left", \
117 (n_bytes), BYTES_LEFT (buffer)); \
118 return XSETTINGS_ACCESS; \
122 static XSettingsResult
123 fetch_card16 (XSettingsBuffer *buffer,
128 return_if_fail_bytes (buffer, 2);
130 x = *(CARD16 *)buffer->pos;
133 if (buffer->byte_order == MSBFirst)
134 *result = GUINT16_FROM_BE (x);
136 *result = GUINT16_FROM_LE (x);
138 return XSETTINGS_SUCCESS;
141 static XSettingsResult
142 fetch_ushort (XSettingsBuffer *buffer,
143 unsigned short *result)
148 r = fetch_card16 (buffer, &x);
149 if (r == XSETTINGS_SUCCESS)
155 static XSettingsResult
156 fetch_card32 (XSettingsBuffer *buffer,
161 return_if_fail_bytes (buffer, 4);
163 x = *(CARD32 *)buffer->pos;
166 if (buffer->byte_order == MSBFirst)
167 *result = GUINT32_FROM_BE (x);
169 *result = GUINT32_FROM_LE (x);
171 return XSETTINGS_SUCCESS;
174 static XSettingsResult
175 fetch_card8 (XSettingsBuffer *buffer,
178 return_if_fail_bytes (buffer, 1);
180 *result = *(CARD8 *)buffer->pos;
183 return XSETTINGS_SUCCESS;
186 #define XSETTINGS_PAD(n,m) ((n + m - 1) & (~(m-1)))
188 static XSettingsResult
189 fetch_string (XSettingsBuffer *buffer,
195 pad_len = XSETTINGS_PAD (length, 4);
196 if (pad_len < length) /* guard against overflow */
198 g_warning ("Invalid XSETTINGS property (overflow in string length)");
199 return XSETTINGS_ACCESS;
202 return_if_fail_bytes (buffer, pad_len);
204 *result = g_strndup ((char *) buffer->pos, length);
205 buffer->pos += pad_len;
207 return XSETTINGS_SUCCESS;
211 parse_settings (unsigned char *data,
214 XSettingsBuffer buffer;
215 XSettingsResult result = XSETTINGS_SUCCESS;
216 GHashTable *settings = NULL;
220 XSettingsSetting *setting = NULL;
222 buffer.pos = buffer.data = data;
225 result = fetch_card8 (&buffer, (unsigned char *)&buffer.byte_order);
226 if (buffer.byte_order != MSBFirst &&
227 buffer.byte_order != LSBFirst)
229 g_warning ("Invalid XSETTINGS property (unknown byte order %u)", buffer.byte_order);
230 result = XSETTINGS_FAILED;
236 result = fetch_card32 (&buffer, &serial);
237 if (result != XSETTINGS_SUCCESS)
240 result = fetch_card32 (&buffer, &n_entries);
241 if (result != XSETTINGS_SUCCESS)
244 GDK_NOTE(SETTINGS, g_print("reading %u settings (serial %u byte order %u)\n", n_entries, serial, buffer.byte_order));
246 for (i = 0; i < n_entries; i++)
252 result = fetch_card8 (&buffer, &type);
253 if (result != XSETTINGS_SUCCESS)
258 result = fetch_card16 (&buffer, &name_len);
259 if (result != XSETTINGS_SUCCESS)
262 setting = g_new (XSettingsSetting, 1);
263 setting->type = XSETTINGS_TYPE_INT; /* No allocated memory */
265 setting->name = NULL;
266 result = fetch_string (&buffer, name_len, &setting->name);
267 if (result != XSETTINGS_SUCCESS)
270 /* last change serial (we ignore it) */
271 result = fetch_card32 (&buffer, &v_int);
272 if (result != XSETTINGS_SUCCESS)
277 case XSETTINGS_TYPE_INT:
278 result = fetch_card32 (&buffer, &v_int);
279 if (result != XSETTINGS_SUCCESS)
282 setting->data.v_int = (INT32)v_int;
283 GDK_NOTE(SETTINGS, g_print(" %s = %d\n", setting->name, (gint) setting->data.v_int));
285 case XSETTINGS_TYPE_STRING:
286 result = fetch_card32 (&buffer, &v_int);
287 if (result != XSETTINGS_SUCCESS)
290 result = fetch_string (&buffer, v_int, &setting->data.v_string);
291 if (result != XSETTINGS_SUCCESS)
294 GDK_NOTE(SETTINGS, g_print(" %s = \"%s\"\n", setting->name, setting->data.v_string));
296 case XSETTINGS_TYPE_COLOR:
297 result = fetch_ushort (&buffer, &setting->data.v_color.red);
298 if (result != XSETTINGS_SUCCESS)
300 result = fetch_ushort (&buffer, &setting->data.v_color.green);
301 if (result != XSETTINGS_SUCCESS)
303 result = fetch_ushort (&buffer, &setting->data.v_color.blue);
304 if (result != XSETTINGS_SUCCESS)
306 result = fetch_ushort (&buffer, &setting->data.v_color.alpha);
307 if (result != XSETTINGS_SUCCESS)
310 GDK_NOTE(SETTINGS, g_print(" %s = #%02X%02X%02X%02X\n", setting->name,
311 setting->data.v_color.alpha, setting->data.v_color.red,
312 setting->data.v_color.green, setting->data.v_color.blue));
315 /* Quietly ignore unknown types */
316 GDK_NOTE(SETTINGS, g_print(" %s = ignored (unknown type %u)\n", setting->name, type));
320 setting->type = type;
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, setting->name) != NULL)
329 result = XSETTINGS_DUPLICATE_ENTRY;
330 g_warning ("Invalid XSETTINGS property (Duplicate entry for '%s')", setting->name);
334 g_hash_table_insert (settings, setting->name, setting);
340 if (result != XSETTINGS_SUCCESS)
343 xsettings_setting_free (setting);
346 g_hash_table_unref (settings);
354 read_settings (XSettingsClient *client)
358 unsigned long n_items;
359 unsigned long bytes_after;
363 GHashTable *old_list = client->settings;
365 client->settings = NULL;
367 if (client->manager_window)
369 gdk_x11_display_error_trap_push (gdk_screen_get_display (client->screen));
370 result = XGetWindowProperty (client->display, client->manager_window,
371 client->xsettings_atom, 0, LONG_MAX,
372 False, client->xsettings_atom,
373 &type, &format, &n_items, &bytes_after, &data);
374 gdk_x11_display_error_trap_pop_ignored (gdk_screen_get_display (client->screen));
376 if (result == Success && type != None)
378 if (type != client->xsettings_atom)
380 fprintf (stderr, "Invalid type for XSETTINGS property");
382 else if (format != 8)
384 fprintf (stderr, "Invalid format for XSETTINGS property %d", format);
387 client->settings = parse_settings (data, n_items);
393 notify_changes (client, old_list);
395 g_hash_table_unref (old_list);
399 add_events (Display *display,
403 XWindowAttributes attr;
405 XGetWindowAttributes (display, window, &attr);
406 XSelectInput (display, window, attr.your_event_mask | mask);
410 check_manager_window (XSettingsClient *client)
412 if (client->manager_window && client->watch)
413 client->watch (client->manager_window, False, 0, client->cb_data);
415 gdk_x11_display_grab (gdk_screen_get_display (client->screen));
417 client->manager_window = XGetSelectionOwner (client->display,
418 client->selection_atom);
419 if (client->manager_window)
420 XSelectInput (client->display, client->manager_window,
421 PropertyChangeMask | StructureNotifyMask);
423 gdk_x11_display_ungrab (gdk_screen_get_display (client->screen));
425 XFlush (client->display);
427 if (client->manager_window && client->watch)
429 if (!client->watch (client->manager_window, True,
430 PropertyChangeMask | StructureNotifyMask,
433 /* Inability to watch the window probably means that it was destroyed
436 client->manager_window = None;
442 read_settings (client);
446 xsettings_client_new (GdkScreen *screen,
447 XSettingsNotifyFunc notify,
448 XSettingsWatchFunc watch,
451 XSettingsClient *client;
456 client = g_new (XSettingsClient, 1);
460 client->screen = screen;
461 client->display = gdk_x11_display_get_xdisplay (gdk_screen_get_display (screen));
462 client->notify = notify;
463 client->watch = watch;
464 client->cb_data = cb_data;
465 client->manager_window = None;
466 client->settings = NULL;
468 sprintf(buffer, "_XSETTINGS_S%d", gdk_x11_screen_get_screen_number (screen));
469 atom_names[0] = buffer;
470 atom_names[1] = "_XSETTINGS_SETTINGS";
471 atom_names[2] = "MANAGER";
473 XInternAtoms (client->display, atom_names, 3, False, atoms);
475 client->selection_atom = atoms[0];
476 client->xsettings_atom = atoms[1];
477 client->manager_atom = atoms[2];
479 /* Select on StructureNotify so we get MANAGER events
481 add_events (client->display, gdk_x11_window_get_xid (gdk_screen_get_root_window (screen)), StructureNotifyMask);
484 client->watch (gdk_x11_window_get_xid (gdk_screen_get_root_window (screen)), True, StructureNotifyMask,
487 check_manager_window (client);
493 xsettings_client_destroy (XSettingsClient *client)
496 client->watch (gdk_x11_window_get_xid (gdk_screen_get_root_window (client->screen)),
497 False, 0, client->cb_data);
498 if (client->manager_window && client->watch)
499 client->watch (client->manager_window, False, 0, client->cb_data);
501 if (client->settings)
502 g_hash_table_unref (client->settings);
506 const XSettingsSetting *
507 xsettings_client_get_setting (XSettingsClient *client,
510 return g_hash_table_lookup (client->settings, name);
514 xsettings_client_process_event (XSettingsClient *client,
517 /* The checks here will not unlikely cause us to reread
518 * the properties from the manager window a number of
519 * times when the manager changes from A->B. But manager changes
520 * are going to be pretty rare.
522 if (xev->xany.window == gdk_x11_window_get_xid (gdk_screen_get_root_window (client->screen)))
524 if (xev->xany.type == ClientMessage &&
525 xev->xclient.message_type == client->manager_atom &&
526 xev->xclient.data.l[1] == client->selection_atom)
528 check_manager_window (client);
532 else if (xev->xany.window == client->manager_window)
534 if (xev->xany.type == DestroyNotify)
536 check_manager_window (client);
537 /* let GDK do its cleanup */
540 else if (xev->xany.type == PropertyNotify)
542 read_settings (client);
551 xsettings_setting_equal (XSettingsSetting *setting_a,
552 XSettingsSetting *setting_b)
554 if (setting_a->type != setting_b->type)
557 if (strcmp (setting_a->name, setting_b->name) != 0)
560 switch (setting_a->type)
562 case XSETTINGS_TYPE_INT:
563 return setting_a->data.v_int == setting_b->data.v_int;
564 case XSETTINGS_TYPE_COLOR:
565 return (setting_a->data.v_color.red == setting_b->data.v_color.red &&
566 setting_a->data.v_color.green == setting_b->data.v_color.green &&
567 setting_a->data.v_color.blue == setting_b->data.v_color.blue &&
568 setting_a->data.v_color.alpha == setting_b->data.v_color.alpha);
569 case XSETTINGS_TYPE_STRING:
570 return strcmp (setting_a->data.v_string, setting_b->data.v_string) == 0;
577 xsettings_setting_free (XSettingsSetting *setting)
579 if (setting->type == XSETTINGS_TYPE_STRING)
580 g_free (setting->data.v_string);
583 g_free (setting->name);