]> Pileus Git - ~andy/gtk/blobdiff - gdk/x11/xsettings-client.c
x11: Split out xsettings string reading code
[~andy/gtk] / gdk / x11 / xsettings-client.c
index 2a4aaae50c73d1d051623f86c0ed4ece2f717752..c693211950fb0c1a4e3244774201ead91e9411b4 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright © 2001 Red Hat, Inc.
+ * Copyright © 2001, 2007 Red Hat, Inc.
  *
  * Permission to use, copy, modify, distribute, and sell this software and its
  * documentation for any purpose is hereby granted without fee, provided that
  *
  * Author:  Owen Taylor, Red Hat, Inc.
  */
+
+#include "config.h"
+
+#include "xsettings-client.h"
+
+#include <gdk/x11/gdkx11display.h>
+#include <gdk/x11/gdkx11screen.h>
+#include <gdk/x11/gdkx11window.h>
+
+#include <gdkinternals.h>
+
 #include <limits.h>
 #include <stdio.h>
-#include <stdlib.h>
 #include <string.h>
 
 #include <X11/Xlib.h>
 #include <X11/Xmd.h>           /* For CARD16 */
 
-#include "xsettings-client.h"
+typedef struct _XSettingsBuffer  XSettingsBuffer;
+
+typedef enum
+{
+  XSETTINGS_SUCCESS,
+  XSETTINGS_ACCESS,
+  XSETTINGS_FAILED,
+  XSETTINGS_NO_ENTRY,
+  XSETTINGS_DUPLICATE_ENTRY
+} XSettingsResult;
+
+struct _XSettingsBuffer
+{
+  char byte_order;
+  size_t len;
+  unsigned char *data;
+  unsigned char *pos;
+};
 
 struct _XSettingsClient
 {
+  GdkScreen *screen;
   Display *display;
-  int screen;
   XSettingsNotifyFunc notify;
   XSettingsWatchFunc watch;
   void *cb_data;
@@ -43,58 +70,43 @@ struct _XSettingsClient
   Atom selection_atom;
   Atom xsettings_atom;
 
-  XSettingsList *settings;
+  GHashTable *settings; /* string => XSettingsSetting */
 };
 
 static void
 notify_changes (XSettingsClient *client,
-               XSettingsList   *old_list)
+               GHashTable      *old_list)
 {
-  XSettingsList *old_iter = old_list;
-  XSettingsList *new_iter = client->settings;
+  GHashTableIter iter;
+  XSettingsSetting *setting, *old_setting;
 
   if (!client->notify)
     return;
 
-  while (old_iter || new_iter)
+  if (client->settings != NULL)
     {
-      int cmp;
-      
-      if (old_iter && new_iter)
-       cmp = strcmp (old_iter->setting->name, new_iter->setting->name);
-      else if (old_iter)
-       cmp = -1;
-      else
-       cmp = 1;
-
-      if (cmp < 0)
+      g_hash_table_iter_init (&iter, client->settings);
+      while (g_hash_table_iter_next (&iter, NULL, (gpointer*) &setting))
        {
-         client->notify (old_iter->setting->name,
-                         XSETTINGS_ACTION_DELETED,
-                         NULL,
-                         client->cb_data);
-       }
-      else if (cmp == 0)
-       {
-         if (!xsettings_setting_equal (old_iter->setting,
-                                       new_iter->setting))
-           client->notify (old_iter->setting->name,
-                           XSETTINGS_ACTION_CHANGED,
-                           new_iter->setting,
-                           client->cb_data);
-       }
-      else
-       {
-         client->notify (new_iter->setting->name,
-                         XSETTINGS_ACTION_NEW,
-                         new_iter->setting,
-                         client->cb_data);
+         old_setting = old_list ? g_hash_table_lookup (old_list, setting->name) : NULL;
+
+         if (old_setting == NULL)
+           client->notify (setting->name, XSETTINGS_ACTION_NEW, setting, client->cb_data);
+         else if (!xsettings_setting_equal (setting, old_setting))
+           client->notify (setting->name, XSETTINGS_ACTION_CHANGED, setting, client->cb_data);
+           
+         /* remove setting from old_list */
+         if (old_setting != NULL)
+           g_hash_table_remove (old_list, setting->name);
        }
+    }
 
-      if (old_iter)
-       old_iter = old_iter->next;
-      if (new_iter)
-       new_iter = new_iter->next;
+  if (old_list != NULL)
+    {
+      /* old_list now contains only deleted settings */
+      g_hash_table_iter_init (&iter, old_list);
+      while (g_hash_table_iter_next (&iter, NULL, (gpointer*) &old_setting))
+       client->notify (old_setting->name, XSETTINGS_ACTION_DELETED, NULL, client->cb_data);
     }
 }
 
@@ -104,8 +116,6 @@ ignore_errors (Display *display, XErrorEvent *event)
   return True;
 }
 
-static char local_byte_order = '\0';
-
 #define BYTES_LEFT(buffer) ((buffer)->data + (buffer)->len - (buffer)->pos)
 
 static XSettingsResult
@@ -120,10 +130,10 @@ fetch_card16 (XSettingsBuffer *buffer,
   x = *(CARD16 *)buffer->pos;
   buffer->pos += 2;
   
-  if (buffer->byte_order == local_byte_order)
-    *result = x;
+  if (buffer->byte_order == MSBFirst)
+    *result = GUINT16_FROM_BE (x);
   else
-    *result = (x << 8) | (x >> 8);
+    *result = GUINT16_FROM_LE (x);
 
   return XSETTINGS_SUCCESS;
 }
@@ -154,10 +164,10 @@ fetch_card32 (XSettingsBuffer *buffer,
   x = *(CARD32 *)buffer->pos;
   buffer->pos += 4;
   
-  if (buffer->byte_order == local_byte_order)
-    *result = x;
+  if (buffer->byte_order == MSBFirst)
+    *result = GUINT32_FROM_BE (x);
   else
-    *result = (x << 24) | ((x & 0xff00) << 8) | ((x & 0xff0000) >> 8) | (x >> 24);
+    *result = GUINT32_FROM_LE (x);
   
   return XSETTINGS_SUCCESS;
 }
@@ -177,24 +187,40 @@ fetch_card8 (XSettingsBuffer *buffer,
 
 #define XSETTINGS_PAD(n,m) ((n + m - 1) & (~(m-1)))
 
-static XSettingsList *
+static XSettingsResult
+fetch_string (XSettingsBuffer  *buffer,
+              guint             length,
+              char            **result)
+{
+  guint pad_len;
+
+  pad_len = XSETTINGS_PAD (length, 4);
+  if (pad_len < length /* guard against overflow */
+      || BYTES_LEFT (buffer) < pad_len)
+    return XSETTINGS_ACCESS;
+
+  *result = g_strndup ((char *) buffer->pos, length);
+  buffer->pos += pad_len;
+
+  return XSETTINGS_SUCCESS;
+}
+
+static GHashTable *
 parse_settings (unsigned char *data,
                size_t         len)
 {
   XSettingsBuffer buffer;
   XSettingsResult result = XSETTINGS_SUCCESS;
-  XSettingsList *settings = NULL;
+  GHashTable *settings = NULL;
   CARD32 serial;
   CARD32 n_entries;
   CARD32 i;
   XSettingsSetting *setting = NULL;
   
-  local_byte_order = xsettings_byte_order ();
-
   buffer.pos = buffer.data = data;
   buffer.len = len;
   
-  result = fetch_card8 (&buffer, &buffer.byte_order);
+  result = fetch_card8 (&buffer, (unsigned char *)&buffer.byte_order);
   if (buffer.byte_order != MSBFirst &&
       buffer.byte_order != LSBFirst)
     {
@@ -213,12 +239,13 @@ parse_settings (unsigned char *data,
   if (result != XSETTINGS_SUCCESS)
     goto out;
 
+  GDK_NOTE(SETTINGS, g_print("reading %u settings (serial %u byte order %u)\n", n_entries, serial, buffer.byte_order));
+
   for (i = 0; i < n_entries; i++)
     {
       CARD8 type;
       CARD16 name_len;
       CARD32 v_int;
-      size_t pad_len;
       
       result = fetch_card8 (&buffer, &type);
       if (result != XSETTINGS_SUCCESS)
@@ -230,36 +257,18 @@ parse_settings (unsigned char *data,
       if (result != XSETTINGS_SUCCESS)
        goto out;
 
-      pad_len = XSETTINGS_PAD(name_len, 4);
-      if (BYTES_LEFT (&buffer) < pad_len)
-       {
-         result = XSETTINGS_ACCESS;
-         goto out;
-       }
-
-      setting = malloc (sizeof *setting);
-      if (!setting)
-       {
-         result = XSETTINGS_NO_MEM;
-         goto out;
-       }
+      setting = g_new (XSettingsSetting, 1);
       setting->type = XSETTINGS_TYPE_INT; /* No allocated memory */
 
-      setting->name = malloc (name_len + 1);
-      if (!setting->name)
-       {
-         result = XSETTINGS_NO_MEM;
-         goto out;
-       }
-
-      memcpy (setting->name, buffer.pos, name_len);
-      setting->name[name_len] = '\0';
-      buffer.pos += pad_len;
+      setting->name = NULL;
+      result = fetch_string (&buffer, name_len, &setting->name);
+      if (result != XSETTINGS_SUCCESS)
+       goto out;
 
+      /* last change serial (we ignore it) */
       result = fetch_card32 (&buffer, &v_int);
       if (result != XSETTINGS_SUCCESS)
        goto out;
-      setting->last_change_serial = v_int;
 
       switch (type)
        {
@@ -269,31 +278,18 @@ parse_settings (unsigned char *data,
            goto out;
 
          setting->data.v_int = (INT32)v_int;
+          GDK_NOTE(SETTINGS, g_print("  %s = %d\n", setting->name, (gint) setting->data.v_int));
          break;
        case XSETTINGS_TYPE_STRING:
          result = fetch_card32 (&buffer, &v_int);
          if (result != XSETTINGS_SUCCESS)
            goto out;
 
-         pad_len = XSETTINGS_PAD (v_int, 4);
-         if (v_int + 1 == 0 || /* Guard against wrap-around */
-             BYTES_LEFT (&buffer) < pad_len)
-           {
-             result = XSETTINGS_ACCESS;
-             goto out;
-           }
-
-         setting->data.v_string = malloc (v_int + 1);
-         if (!setting->data.v_string)
-           {
-             result = XSETTINGS_NO_MEM;
-             goto out;
-           }
+          result = fetch_string (&buffer, v_int, &setting->data.v_string);
+          if (result != XSETTINGS_SUCCESS)
+            goto out;
          
-         memcpy (setting->data.v_string, buffer.pos, v_int);
-         setting->data.v_string[v_int] = '\0';
-         buffer.pos += pad_len;
-
+          GDK_NOTE(SETTINGS, g_print("  %s = \"%s\"\n", setting->name, setting->data.v_string));
          break;
        case XSETTINGS_TYPE_COLOR:
          result = fetch_ushort (&buffer, &setting->data.v_color.red);
@@ -309,18 +305,30 @@ parse_settings (unsigned char *data,
          if (result != XSETTINGS_SUCCESS)
            goto out;
 
+          GDK_NOTE(SETTINGS, g_print("  %s = #%02X%02X%02X%02X\n", setting->name, 
+                                 setting->data.v_color.alpha, setting->data.v_color.red,
+                                 setting->data.v_color.green, setting->data.v_color.blue));
          break;
        default:
          /* Quietly ignore unknown types */
+          GDK_NOTE(SETTINGS, g_print("  %s = ignored (unknown type %u)\n", setting->name, type));
          break;
        }
 
       setting->type = type;
 
-      result = xsettings_list_insert (&settings, setting);
-      if (result != XSETTINGS_SUCCESS)
-       goto out;
+      if (settings == NULL)
+        settings = g_hash_table_new_full (g_str_hash, g_str_equal,
+                                          NULL,
+                                          (GDestroyNotify) xsettings_setting_free);
+
+      if (g_hash_table_lookup (settings, setting->name) != NULL)
+        {
+          result = XSETTINGS_DUPLICATE_ENTRY;
+          goto out;
+        }
 
+      g_hash_table_insert (settings, setting->name, setting);
       setting = NULL;
     }
 
@@ -330,9 +338,6 @@ parse_settings (unsigned char *data,
     {
       switch (result)
        {
-       case XSETTINGS_NO_MEM:
-         fprintf(stderr, "Out of memory reading XSETTINGS property\n");
-         break;
        case XSETTINGS_ACCESS:
          fprintf(stderr, "Invalid XSETTINGS property (read off end)\n");
          break;
@@ -347,9 +352,9 @@ parse_settings (unsigned char *data,
       if (setting)
        xsettings_setting_free (setting);
 
-      xsettings_list_free (settings);
+      if (settings)
+        g_hash_table_unref (settings);
       settings = NULL;
-
     }
 
   return settings;
@@ -367,31 +372,39 @@ read_settings (XSettingsClient *client)
 
   int (*old_handler) (Display *, XErrorEvent *);
   
-  XSettingsList *old_list = client->settings;
+  GHashTable *old_list = client->settings;
 
   client->settings = NULL;
-  
-  old_handler = XSetErrorHandler (ignore_errors);
-  result = XGetWindowProperty (client->display, client->manager_window,
-                              client->xsettings_atom, 0, LONG_MAX,
-                              False, client->xsettings_atom,
-                              &type, &format, &n_items, &bytes_after, &data);
-  XSetErrorHandler (old_handler);
-
-  if (result == Success && type == client->xsettings_atom)
+
+  if (client->manager_window)
     {
-      if (format != 8)
+      old_handler = XSetErrorHandler (ignore_errors);
+      result = XGetWindowProperty (client->display, client->manager_window,
+                                  client->xsettings_atom, 0, LONG_MAX,
+                                  False, client->xsettings_atom,
+                                  &type, &format, &n_items, &bytes_after, &data);
+      XSetErrorHandler (old_handler);
+      
+      if (result == Success && type != None)
        {
-         fprintf (stderr, "Invalid format for XSETTINGS property %d", format);
+         if (type != client->xsettings_atom)
+           {
+             fprintf (stderr, "Invalid type for XSETTINGS property");
+           }
+         else if (format != 8)
+           {
+             fprintf (stderr, "Invalid format for XSETTINGS property %d", format);
+           }
+         else
+           client->settings = parse_settings (data, n_items);
+         
+         XFree (data);
        }
-      else
-       client->settings = parse_settings (data, n_items);
-
-      XFree (data);
     }
 
   notify_changes (client, old_list);
-  xsettings_list_free (old_list);
+  if (old_list)
+    g_hash_table_unref (old_list);
 }
 
 static void
@@ -410,8 +423,8 @@ check_manager_window (XSettingsClient *client)
 {
   if (client->manager_window && client->watch)
     client->watch (client->manager_window, False, 0, client->cb_data);
-  
-  XGrabServer (client->display);
+
+  gdk_x11_display_grab (gdk_screen_get_display (client->screen));
 
   client->manager_window = XGetSelectionOwner (client->display,
                                               client->selection_atom);
@@ -419,51 +432,68 @@ check_manager_window (XSettingsClient *client)
     XSelectInput (client->display, client->manager_window,
                  PropertyChangeMask | StructureNotifyMask);
 
-  XUngrabServer (client->display);
+  gdk_x11_display_ungrab (gdk_screen_get_display (client->screen));
+  
   XFlush (client->display);
 
   if (client->manager_window && client->watch)
-    client->watch (client->manager_window, True, 
-                  PropertyChangeMask | StructureNotifyMask,
-                  client->cb_data);
+    {
+      if (!client->watch (client->manager_window, True, 
+                         PropertyChangeMask | StructureNotifyMask,
+                         client->cb_data))
+       {
+         /* Inability to watch the window probably means that it was destroyed
+          * after we ungrabbed
+          */
+         client->manager_window = None;
+         return;
+       }
+    }
+      
   
   read_settings (client);
 }
 
 XSettingsClient *
-xsettings_client_new (Display             *display,
-                     int                  screen,
+xsettings_client_new (GdkScreen           *screen,
                      XSettingsNotifyFunc  notify,
                      XSettingsWatchFunc   watch,
                      void                *cb_data)
 {
   XSettingsClient *client;
   char buffer[256];
-
-  client = malloc (sizeof *client);
+  char *atom_names[3];
+  Atom atoms[3];
+  
+  client = g_new (XSettingsClient, 1);
   if (!client)
     return NULL;
 
-  client->display = display;
   client->screen = screen;
+  client->display = gdk_x11_display_get_xdisplay (gdk_screen_get_display (screen));
   client->notify = notify;
   client->watch = watch;
   client->cb_data = cb_data;
-  
   client->manager_window = None;
   client->settings = NULL;
 
-  sprintf(buffer, "_XSETTINGS_S%d", screen);
-  client->selection_atom = XInternAtom (display, buffer, False);
-  client->xsettings_atom = XInternAtom (display, "_XSETTINGS_SETTINGS", False);
-  client->manager_atom = XInternAtom (display, "MANAGER", False);
+  sprintf(buffer, "_XSETTINGS_S%d", gdk_x11_screen_get_screen_number (screen));
+  atom_names[0] = buffer;
+  atom_names[1] = "_XSETTINGS_SETTINGS";
+  atom_names[2] = "MANAGER";
+
+  XInternAtoms (client->display, atom_names, 3, False, atoms);
+
+  client->selection_atom = atoms[0];
+  client->xsettings_atom = atoms[1];
+  client->manager_atom = atoms[2];
 
   /* Select on StructureNotify so we get MANAGER events
    */
-  add_events (display, RootWindow (display, screen), StructureNotifyMask);
+  add_events (client->display, gdk_x11_window_get_xid (gdk_screen_get_root_window (screen)), StructureNotifyMask);
 
   if (client->watch)
-    client->watch (RootWindow (display, screen), True, StructureNotifyMask,
+    client->watch (gdk_x11_window_get_xid (gdk_screen_get_root_window (screen)), True, StructureNotifyMask,
                   client->cb_data);
 
   check_manager_window (client);
@@ -475,28 +505,21 @@ void
 xsettings_client_destroy (XSettingsClient *client)
 {
   if (client->watch)
-    client->watch (RootWindow (client->display, client->screen),
+    client->watch (gdk_x11_window_get_xid (gdk_screen_get_root_window (client->screen)),
                   False, 0, client->cb_data);
   if (client->manager_window && client->watch)
     client->watch (client->manager_window, False, 0, client->cb_data);
   
-  xsettings_list_free (client->settings);
-  free (client);
+  if (client->settings)
+    g_hash_table_unref (client->settings);
+  g_free (client);
 }
 
-XSettingsResult
+const XSettingsSetting *
 xsettings_client_get_setting (XSettingsClient   *client,
-                             const char        *name,
-                             XSettingsSetting **setting)
+                             const char        *name)
 {
-  XSettingsSetting *search = xsettings_list_lookup (client->settings, name);
-  if (search)
-    {
-      *setting = xsettings_setting_copy (search);
-      return *setting ? XSETTINGS_SUCCESS : XSETTINGS_NO_MEM;
-    }
-  else
-    return XSETTINGS_NO_ENTRY;
+  return g_hash_table_lookup (client->settings, name);
 }
 
 Bool
@@ -508,10 +531,11 @@ xsettings_client_process_event (XSettingsClient *client,
    * times when the manager changes from A->B. But manager changes
    * are going to be pretty rare.
    */
-  if (xev->xany.window == RootWindow (client->display, client->screen))
+  if (xev->xany.window == gdk_x11_window_get_xid (gdk_screen_get_root_window (client->screen)))
     {
       if (xev->xany.type == ClientMessage &&
-         xev->xclient.message_type == client->manager_atom)
+         xev->xclient.message_type == client->manager_atom &&
+         xev->xclient.data.l[1] == client->selection_atom)
        {
          check_manager_window (client);
          return True;
@@ -522,7 +546,8 @@ xsettings_client_process_event (XSettingsClient *client,
       if (xev->xany.type == DestroyNotify)
        {
          check_manager_window (client);
-         return True;
+          /* let GDK do its cleanup */
+         return False; 
        }
       else if (xev->xany.type == PropertyNotify)
        {
@@ -533,3 +558,42 @@ xsettings_client_process_event (XSettingsClient *client,
   
   return False;
 }
+
+int
+xsettings_setting_equal (XSettingsSetting *setting_a,
+                        XSettingsSetting *setting_b)
+{
+  if (setting_a->type != setting_b->type)
+    return 0;
+
+  if (strcmp (setting_a->name, setting_b->name) != 0)
+    return 0;
+
+  switch (setting_a->type)
+    {
+    case XSETTINGS_TYPE_INT:
+      return setting_a->data.v_int == setting_b->data.v_int;
+    case XSETTINGS_TYPE_COLOR:
+      return (setting_a->data.v_color.red == setting_b->data.v_color.red &&
+             setting_a->data.v_color.green == setting_b->data.v_color.green &&
+             setting_a->data.v_color.blue == setting_b->data.v_color.blue &&
+             setting_a->data.v_color.alpha == setting_b->data.v_color.alpha);
+    case XSETTINGS_TYPE_STRING:
+      return strcmp (setting_a->data.v_string, setting_b->data.v_string) == 0;
+    }
+
+  return 0;
+}
+
+void
+xsettings_setting_free (XSettingsSetting *setting)
+{
+  if (setting->type == XSETTINGS_TYPE_STRING)
+    g_free (setting->data.v_string);
+
+  if (setting->name)
+    g_free (setting->name);
+  
+  g_free (setting);
+}
+