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"
34 #include <X11/Xmd.h> /* For CARD16 */
36 struct _XSettingsClient
40 XSettingsNotifyFunc notify;
41 XSettingsWatchFunc watch;
44 XSettingsGrabFunc grab;
45 XSettingsGrabFunc ungrab;
47 Window manager_window;
52 XSettingsList *settings;
56 notify_changes (XSettingsClient *client,
57 XSettingsList *old_list)
60 XSettingsSetting *setting, *old_setting;
65 if (client->settings != NULL)
67 g_hash_table_iter_init (&iter, client->settings);
68 while (g_hash_table_iter_next (&iter, NULL, (gpointer*) &setting))
70 old_setting = xsettings_list_lookup (old_list, setting->name);
72 if (old_setting == NULL)
73 client->notify (setting->name, XSETTINGS_ACTION_NEW, setting, client->cb_data);
74 else if (!xsettings_setting_equal (setting, old_setting))
75 client->notify (setting->name, XSETTINGS_ACTION_CHANGED, setting, client->cb_data);
77 /* remove setting from old_list */
78 if (old_setting != NULL)
79 g_hash_table_remove (old_list, setting->name);
85 /* old_list now contains only deleted settings */
86 g_hash_table_iter_init (&iter, old_list);
87 while (g_hash_table_iter_next (&iter, NULL, (gpointer*) &old_setting))
88 client->notify (old_setting->name, XSETTINGS_ACTION_DELETED, NULL, client->cb_data);
93 ignore_errors (Display *display, XErrorEvent *event)
98 static char local_byte_order = '\0';
100 #define BYTES_LEFT(buffer) ((buffer)->data + (buffer)->len - (buffer)->pos)
102 static XSettingsResult
103 fetch_card16 (XSettingsBuffer *buffer,
108 if (BYTES_LEFT (buffer) < 2)
109 return XSETTINGS_ACCESS;
111 x = *(CARD16 *)buffer->pos;
114 if (buffer->byte_order == local_byte_order)
117 *result = (x << 8) | (x >> 8);
119 return XSETTINGS_SUCCESS;
122 static XSettingsResult
123 fetch_ushort (XSettingsBuffer *buffer,
124 unsigned short *result)
129 r = fetch_card16 (buffer, &x);
130 if (r == XSETTINGS_SUCCESS)
136 static XSettingsResult
137 fetch_card32 (XSettingsBuffer *buffer,
142 if (BYTES_LEFT (buffer) < 4)
143 return XSETTINGS_ACCESS;
145 x = *(CARD32 *)buffer->pos;
148 if (buffer->byte_order == local_byte_order)
151 *result = (x << 24) | ((x & 0xff00) << 8) | ((x & 0xff0000) >> 8) | (x >> 24);
153 return XSETTINGS_SUCCESS;
156 static XSettingsResult
157 fetch_card8 (XSettingsBuffer *buffer,
160 if (BYTES_LEFT (buffer) < 1)
161 return XSETTINGS_ACCESS;
163 *result = *(CARD8 *)buffer->pos;
166 return XSETTINGS_SUCCESS;
169 #define XSETTINGS_PAD(n,m) ((n + m - 1) & (~(m-1)))
171 static XSettingsList *
172 parse_settings (unsigned char *data,
175 XSettingsBuffer buffer;
176 XSettingsResult result = XSETTINGS_SUCCESS;
177 XSettingsList *settings = NULL;
181 XSettingsSetting *setting = NULL;
183 local_byte_order = xsettings_byte_order ();
185 buffer.pos = buffer.data = data;
188 result = fetch_card8 (&buffer, (unsigned char *)&buffer.byte_order);
189 if (buffer.byte_order != MSBFirst &&
190 buffer.byte_order != LSBFirst)
192 fprintf (stderr, "Invalid byte order in XSETTINGS property\n");
193 result = XSETTINGS_FAILED;
199 result = fetch_card32 (&buffer, &serial);
200 if (result != XSETTINGS_SUCCESS)
203 result = fetch_card32 (&buffer, &n_entries);
204 if (result != XSETTINGS_SUCCESS)
207 for (i = 0; i < n_entries; i++)
214 result = fetch_card8 (&buffer, &type);
215 if (result != XSETTINGS_SUCCESS)
220 result = fetch_card16 (&buffer, &name_len);
221 if (result != XSETTINGS_SUCCESS)
224 pad_len = XSETTINGS_PAD(name_len, 4);
225 if (BYTES_LEFT (&buffer) < pad_len)
227 result = XSETTINGS_ACCESS;
231 setting = malloc (sizeof *setting);
234 result = XSETTINGS_NO_MEM;
237 setting->type = XSETTINGS_TYPE_INT; /* No allocated memory */
239 setting->name = malloc (name_len + 1);
242 result = XSETTINGS_NO_MEM;
246 memcpy (setting->name, buffer.pos, name_len);
247 setting->name[name_len] = '\0';
248 buffer.pos += pad_len;
250 result = fetch_card32 (&buffer, &v_int);
251 if (result != XSETTINGS_SUCCESS)
253 setting->last_change_serial = v_int;
257 case XSETTINGS_TYPE_INT:
258 result = fetch_card32 (&buffer, &v_int);
259 if (result != XSETTINGS_SUCCESS)
262 setting->data.v_int = (INT32)v_int;
264 case XSETTINGS_TYPE_STRING:
265 result = fetch_card32 (&buffer, &v_int);
266 if (result != XSETTINGS_SUCCESS)
269 pad_len = XSETTINGS_PAD (v_int, 4);
270 if (v_int + 1 == 0 || /* Guard against wrap-around */
271 BYTES_LEFT (&buffer) < pad_len)
273 result = XSETTINGS_ACCESS;
277 setting->data.v_string = malloc (v_int + 1);
278 if (!setting->data.v_string)
280 result = XSETTINGS_NO_MEM;
284 memcpy (setting->data.v_string, buffer.pos, v_int);
285 setting->data.v_string[v_int] = '\0';
286 buffer.pos += pad_len;
289 case XSETTINGS_TYPE_COLOR:
290 result = fetch_ushort (&buffer, &setting->data.v_color.red);
291 if (result != XSETTINGS_SUCCESS)
293 result = fetch_ushort (&buffer, &setting->data.v_color.green);
294 if (result != XSETTINGS_SUCCESS)
296 result = fetch_ushort (&buffer, &setting->data.v_color.blue);
297 if (result != XSETTINGS_SUCCESS)
299 result = fetch_ushort (&buffer, &setting->data.v_color.alpha);
300 if (result != XSETTINGS_SUCCESS)
305 /* Quietly ignore unknown types */
309 setting->type = type;
311 result = xsettings_list_insert (&settings, setting);
312 if (result != XSETTINGS_SUCCESS)
320 if (result != XSETTINGS_SUCCESS)
324 case XSETTINGS_NO_MEM:
325 fprintf(stderr, "Out of memory reading XSETTINGS property\n");
327 case XSETTINGS_ACCESS:
328 fprintf(stderr, "Invalid XSETTINGS property (read off end)\n");
330 case XSETTINGS_DUPLICATE_ENTRY:
331 fprintf (stderr, "Duplicate XSETTINGS entry for '%s'\n", setting->name);
332 case XSETTINGS_FAILED:
333 case XSETTINGS_SUCCESS:
334 case XSETTINGS_NO_ENTRY:
339 xsettings_setting_free (setting);
341 xsettings_list_free (settings);
350 read_settings (XSettingsClient *client)
354 unsigned long n_items;
355 unsigned long bytes_after;
359 int (*old_handler) (Display *, XErrorEvent *);
361 XSettingsList *old_list = client->settings;
363 client->settings = NULL;
365 if (client->manager_window)
367 old_handler = XSetErrorHandler (ignore_errors);
368 result = XGetWindowProperty (client->display, client->manager_window,
369 client->xsettings_atom, 0, LONG_MAX,
370 False, client->xsettings_atom,
371 &type, &format, &n_items, &bytes_after, &data);
372 XSetErrorHandler (old_handler);
374 if (result == Success && type != None)
376 if (type != client->xsettings_atom)
378 fprintf (stderr, "Invalid type for XSETTINGS property");
380 else if (format != 8)
382 fprintf (stderr, "Invalid format for XSETTINGS property %d", format);
385 client->settings = parse_settings (data, n_items);
391 notify_changes (client, old_list);
392 xsettings_list_free (old_list);
396 add_events (Display *display,
400 XWindowAttributes attr;
402 XGetWindowAttributes (display, window, &attr);
403 XSelectInput (display, window, attr.your_event_mask | mask);
407 check_manager_window (XSettingsClient *client)
409 if (client->manager_window && client->watch)
410 client->watch (client->manager_window, False, 0, client->cb_data);
413 client->grab (client->display);
415 XGrabServer (client->display);
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);
424 client->ungrab (client->display);
426 XUngrabServer (client->display);
428 XFlush (client->display);
430 if (client->manager_window && client->watch)
432 if (!client->watch (client->manager_window, True,
433 PropertyChangeMask | StructureNotifyMask,
436 /* Inability to watch the window probably means that it was destroyed
439 client->manager_window = None;
445 read_settings (client);
449 xsettings_client_new (Display *display,
451 XSettingsNotifyFunc notify,
452 XSettingsWatchFunc watch,
455 return xsettings_client_new_with_grab_funcs (display, screen, notify, watch, cb_data,
460 xsettings_client_new_with_grab_funcs (Display *display,
462 XSettingsNotifyFunc notify,
463 XSettingsWatchFunc watch,
465 XSettingsGrabFunc grab,
466 XSettingsGrabFunc ungrab)
468 XSettingsClient *client;
473 client = malloc (sizeof *client);
477 client->display = display;
478 client->screen = screen;
479 client->notify = notify;
480 client->watch = watch;
481 client->cb_data = cb_data;
483 client->ungrab = ungrab;
484 client->manager_window = None;
485 client->settings = NULL;
487 sprintf(buffer, "_XSETTINGS_S%d", screen);
488 atom_names[0] = buffer;
489 atom_names[1] = "_XSETTINGS_SETTINGS";
490 atom_names[2] = "MANAGER";
492 XInternAtoms (display, atom_names, 3, False, atoms);
494 client->selection_atom = atoms[0];
495 client->xsettings_atom = atoms[1];
496 client->manager_atom = atoms[2];
498 /* Select on StructureNotify so we get MANAGER events
500 add_events (display, RootWindow (display, screen), StructureNotifyMask);
503 client->watch (RootWindow (display, screen), True, StructureNotifyMask,
506 check_manager_window (client);
513 xsettings_client_set_grab_func (XSettingsClient *client,
514 XSettingsGrabFunc grab)
520 xsettings_client_set_ungrab_func (XSettingsClient *client,
521 XSettingsGrabFunc ungrab)
523 client->ungrab = ungrab;
527 xsettings_client_destroy (XSettingsClient *client)
530 client->watch (RootWindow (client->display, client->screen),
531 False, 0, client->cb_data);
532 if (client->manager_window && client->watch)
533 client->watch (client->manager_window, False, 0, client->cb_data);
535 xsettings_list_free (client->settings);
540 xsettings_client_get_setting (XSettingsClient *client,
542 XSettingsSetting **setting)
544 XSettingsSetting *search = xsettings_list_lookup (client->settings, name);
547 *setting = xsettings_setting_copy (search);
548 return *setting ? XSETTINGS_SUCCESS : XSETTINGS_NO_MEM;
551 return XSETTINGS_NO_ENTRY;
555 xsettings_client_process_event (XSettingsClient *client,
558 /* The checks here will not unlikely cause us to reread
559 * the properties from the manager window a number of
560 * times when the manager changes from A->B. But manager changes
561 * are going to be pretty rare.
563 if (xev->xany.window == RootWindow (client->display, client->screen))
565 if (xev->xany.type == ClientMessage &&
566 xev->xclient.message_type == client->manager_atom &&
567 xev->xclient.data.l[1] == client->selection_atom)
569 check_manager_window (client);
573 else if (xev->xany.window == client->manager_window)
575 if (xev->xany.type == DestroyNotify)
577 check_manager_window (client);
578 /* let GDK do its cleanup */
581 else if (xev->xany.type == PropertyNotify)
583 read_settings (client);