Pileus Git - ~andy/gtk/blob - gtk/gtkkeyhash.c

   1 /* gtkkeyhash.c: Keymap aware matching of key bindings
   2  *
   3  * GTK - The GIMP Toolkit
   4  * Copyright (C) 2002, Red Hat Inc.
   5  *
   6  * This library is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2 of the License, or (at your option) any later version.
  10  *
  11  * This library is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public
  17  * License along with this library; if not, write to the
  18  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  19  * Boston, MA 02111-1307, USA.
  20  */
  21 #include "gtkdebug.h"
  22 #include "gtkkeyhash.h"
  23
  24 typedef struct _GtkKeyHashEntry GtkKeyHashEntry;
  25
  26 struct _GtkKeyHashEntry
  27 {
  28   guint keyval;
  29   GdkModifierType modifiers;
  30   gpointer value;
  31
  32   /* Set as a side effect of generating key_hash->keycode_hash
  33    */
  34   GdkKeymapKey *keys;
  35   gint n_keys;
  36 };
  37
  38 struct _GtkKeyHash
  39 {
  40   GdkKeymap *keymap;
  41   GHashTable *keycode_hash;
  42   GHashTable *reverse_hash;
  43   GList *entries_list;
  44   GDestroyNotify destroy_notify;
  45 };
  46
  47 static void
  48 key_hash_clear_keycode (gpointer key,
  49                         gpointer value,
  50                         gpointer data)
  51 {
  52   GSList *keys = value;
  53   g_slist_free (keys);
  54 }
  55
  56 static void
  57 key_hash_insert_entry (GtkKeyHash      *key_hash,
  58                        GtkKeyHashEntry *entry)
  59 {
  60   gint i;
  61
  62   g_free (entry->keys);
  63   gdk_keymap_get_entries_for_keyval (key_hash->keymap,
  64                                      entry->keyval,
  65                                      &entry->keys, &entry->n_keys);
  66
  67   for (i = 0; i < entry->n_keys; i++)
  68     {
  69       GSList *old_keys = g_hash_table_lookup (key_hash->keycode_hash,
  70                                               GUINT_TO_POINTER (entry->keys[i].keycode));
  71       old_keys = g_slist_prepend (old_keys, entry);
  72       g_hash_table_insert (key_hash->keycode_hash,
  73                            GUINT_TO_POINTER (entry->keys[i].keycode),
  74                            old_keys);
  75     }
  76 }
  77
  78 static GHashTable *
  79 key_hash_get_keycode_hash (GtkKeyHash *key_hash)
  80 {
  81   if (!key_hash->keycode_hash)
  82     {
  83       GList *tmp_list;
  84
  85       key_hash->keycode_hash = g_hash_table_new (g_direct_hash, NULL);
  86
  87       /* Preserve the original insertion order
  88        */
  89       for (tmp_list = g_list_last (key_hash->entries_list);
  90            tmp_list;
  91            tmp_list = tmp_list->prev)
  92         key_hash_insert_entry (key_hash, tmp_list->data);
  93     }
  94
  95   return key_hash->keycode_hash;
  96 }
  97
  98 static void
  99 key_hash_keys_changed (GdkKeymap  *keymap,
 100                        GtkKeyHash *key_hash)
 101 {
 102   /* The keymap changed, so we have to regenerate the keycode hash
 103    */
 104   if (key_hash->keycode_hash)
 105     {
 106       g_hash_table_foreach (key_hash->keycode_hash, key_hash_clear_keycode, NULL);
 107       g_hash_table_destroy (key_hash->keycode_hash);
 108       key_hash->keycode_hash = NULL;
 109     }
 110 }
 111
 112 /**
 113  * _gtk_key_hash_new:
 114  * @keymap: a #GdkKeymap
 115  * @item_destroy_notify: function to be called when items are removed
 116  *   from the hash or %NULL.
 117  *
 118  * Create a new key hash object for doing binding resolution.
 119  *
 120  * Return value: the newly created object. Free with _gtk_key_hash_free().
 121  **/
 122 GtkKeyHash *
 123 _gtk_key_hash_new (GdkKeymap      *keymap,
 124                    GDestroyNotify  item_destroy_notify)
 125 {
 126   GtkKeyHash *key_hash = g_new (GtkKeyHash, 1);
 127
 128   key_hash->keymap = keymap;
 129   g_signal_connect (keymap, "keys_changed",
 130                     G_CALLBACK (key_hash_keys_changed), key_hash);
 131
 132   key_hash->entries_list = NULL;
 133   key_hash->keycode_hash = NULL;
 134   key_hash->reverse_hash = g_hash_table_new (g_direct_hash, NULL);
 135   key_hash->destroy_notify = item_destroy_notify;
 136
 137   return key_hash;
 138 }
 139
 140 static void
 141 key_hash_free_entry (GtkKeyHash      *key_hash,
 142                      GtkKeyHashEntry *entry)
 143 {
 144   if (key_hash->destroy_notify)
 145     (*key_hash->destroy_notify) (entry->value);
 146
 147   g_free (entry->keys);
 148   g_free (entry);
 149 }
 150
 151 static void
 152 key_hash_free_entry_foreach (gpointer value,
 153                              gpointer data)
 154 {
 155   GtkKeyHashEntry *entry = value;
 156   GtkKeyHash *key_hash = data;
 157
 158   key_hash_free_entry (key_hash, entry);
 159 }
 160
 161 /**
 162  * gtk_key_hash_free:
 163  * @key_hash: a #GtkKeyHash
 164  *
 165  * Destroys a key hash created with gtk_key_hash_new()
 166  **/
 167 void
 168 _gtk_key_hash_free (GtkKeyHash *key_hash)
 169 {
 170   g_signal_handlers_disconnect_by_func (key_hash->keymap,
 171                                         G_CALLBACK (key_hash_keys_changed), key_hash);
 172
 173   if (key_hash->keycode_hash)
 174     {
 175       g_hash_table_foreach (key_hash->keycode_hash, key_hash_clear_keycode, NULL);
 176       g_hash_table_destroy (key_hash->keycode_hash);
 177     }
 178
 179   g_hash_table_destroy (key_hash->reverse_hash);
 180
 181   g_list_foreach (key_hash->entries_list, key_hash_free_entry_foreach, key_hash);
 182   g_list_free (key_hash->entries_list);
 183
 184   g_free (key_hash);
 185 }
 186
 187 /**
 188  * _gtk_key_hash_add_entry:
 189  * @key_hash: a #GtkKeyHash
 190  * @keyval: key symbol for this binding
 191  * @modifiers: modifiers for this binding
 192  * @value: value to insert in the key hash
 193  *
 194  * Inserts a pair of key symbol and modifier mask into the key hash.
 195  **/
 196 void
 197 _gtk_key_hash_add_entry (GtkKeyHash      *key_hash,
 198                          guint            keyval,
 199                          GdkModifierType  modifiers,
 200                          gpointer         value)
 201 {
 202   GtkKeyHashEntry *entry = g_new (GtkKeyHashEntry, 1);
 203
 204   entry->value = value;
 205   entry->keyval = keyval;
 206   entry->modifiers = modifiers;
 207   entry->keys = NULL;
 208
 209   key_hash->entries_list = g_list_prepend (key_hash->entries_list, entry);
 210   g_hash_table_insert (key_hash->reverse_hash, value, key_hash->entries_list);
 211
 212   if (key_hash->keycode_hash)
 213     key_hash_insert_entry (key_hash, entry);
 214 }
 215
 216 /**
 217  * _gtk_key_hash_remove_entry:
 218  * @key_hash: a #GtkKeyHash
 219  * @value: value previously added with _gtk_key_hash_add_entry()
 220  *
 221  * Removes a value previously added to the key hash with
 222  * _gtk_key_hash_add_entry().
 223  **/
 224 void
 225 _gtk_key_hash_remove_entry (GtkKeyHash *key_hash,
 226                             gpointer    value)
 227 {
 228   GList *entry_node = g_hash_table_lookup (key_hash->reverse_hash, value);
 229
 230   if (entry_node)
 231     {
 232       GtkKeyHashEntry *entry = entry_node->data;
 233
 234       if (key_hash->keycode_hash)
 235         {
 236           gint i;
 237
 238           for (i = 0; i < entry->n_keys; i++)
 239             {
 240               GSList *old_keys = g_hash_table_lookup (key_hash->keycode_hash,
 241                                                       GUINT_TO_POINTER (entry->keys[i].keycode));
 242
 243               GSList *new_keys = g_slist_remove (old_keys, entry);
 244               if (new_keys != old_keys)
 245                 {
 246                   if (new_keys)
 247                     g_hash_table_insert (key_hash->keycode_hash,
 248                                          GUINT_TO_POINTER (entry->keys[i].keycode),
 249                                          new_keys);
 250                   else
 251                     g_hash_table_remove (key_hash->keycode_hash,
 252                                          GUINT_TO_POINTER (entry->keys[i].keycode));
 253                 }
 254             }
 255         }
 256
 257       g_hash_table_remove (key_hash->reverse_hash, entry_node);
 258       key_hash->entries_list = g_list_delete_link (key_hash->entries_list, entry_node);
 259
 260       key_hash_free_entry (key_hash, entry);
 261     }
 262 }
 263
 264 static gint
 265 lookup_result_compare (gconstpointer a,
 266                        gconstpointer b)
 267 {
 268   const GtkKeyHashEntry *entry_a = a;
 269   const GtkKeyHashEntry *entry_b = b;
 270   guint modifiers;
 271
 272   gint n_bits_a = 0;
 273   gint n_bits_b = 0;
 274
 275   modifiers = entry_a->modifiers;
 276   while (modifiers)
 277     {
 278       if (modifiers & 1)
 279         n_bits_a++;
 280       modifiers >>= 1;
 281     }
 282
 283   modifiers = entry_b->modifiers;
 284   while (modifiers)
 285     {
 286       if (modifiers & 1)
 287         n_bits_b++;
 288       modifiers >>= 1;
 289     }
 290
 291   return n_bits_a < n_bits_b ? -1 : (n_bits_a == n_bits_b ? 0 : 1);
 292
 293 }
 294
 295 /* Sort a list of results so that matches with less modifiers come
 296  * before matches with more modifiers
 297  */
 298 static GSList *
 299 sort_lookup_results (GSList *slist)
 300 {
 301   return g_slist_sort (slist, lookup_result_compare);
 302 }
 303
 304 /**
 305  * _gtk_key_hash_lookup:
 306  * @key_hash: a #GtkKeyHash
 307  * @hardware_keycode: hardware keycode field from a #GdkEventKey
 308  * @state: state field from a #GdkEventKey
 309  * @group: group field from a #GdkEventKey
 310  *
 311  * Looks up the best matching entry or entries in the hash table for
 312  * a given event. The results are sorted so that entries with less
 313  * modifiers come before entries with more modifiers.
 314  *
 315  * Return value: A #GSList of all matching entries. If there were exact
 316  *  matches, they are returned, otherwise all fuzzy matches are
 317  *  returned. (A fuzzy match is a match in keycode and level, but not
 318  *  in group.)
 319  **/
 320 GSList *
 321 _gtk_key_hash_lookup (GtkKeyHash      *key_hash,
 322                       guint16          hardware_keycode,
 323                       GdkModifierType  state,
 324                       gint             group)
 325 {
 326   GHashTable *keycode_hash = key_hash_get_keycode_hash (key_hash);
 327   GSList *keys = g_hash_table_lookup (keycode_hash, GUINT_TO_POINTER ((guint)hardware_keycode));
 328   GSList *results = NULL;
 329   gboolean have_exact = FALSE;
 330   guint keyval;
 331   gint effective_group;
 332   gint level;
 333   GdkModifierType consumed_modifiers;
 334
 335   gdk_keymap_translate_keyboard_state (key_hash->keymap,
 336                                        hardware_keycode, state, group,
 337                                        &keyval, &effective_group, &level, &consumed_modifiers);
 338
 339   GTK_NOTE (KEYBINDINGS,
 340             g_message ("Looking up keycode = %u, modifiers = 0x%04x,\n"
 341                        "    keyval = %u, group = %d, level = %d, consumed_modifiers = 0x%04x",
 342                        hardware_keycode, state, keyval, effective_group, level, consumed_modifiers));
 343
 344   if (keys)
 345     {
 346       GSList *tmp_list = keys;
 347       while (tmp_list)
 348         {
 349           GtkKeyHashEntry *entry = tmp_list->data;
 350
 351           if ((entry->modifiers & ~consumed_modifiers) == (state & ~consumed_modifiers))
 352             {
 353               gint i;
 354
 355               if (keyval == entry->keyval) /* Exact match */
 356                 {
 357                   GTK_NOTE (KEYBINDINGS,
 358                             g_message ("  found exact match, keyval = %u, modifiers = 0x%04x",
 359                                        entry->keyval, entry->modifiers));
 360
 361                   if (!have_exact)
 362                     {
 363                       g_slist_free (results);
 364                       results = NULL;
 365                     }
 366
 367                   have_exact = TRUE;
 368                   results = g_slist_prepend (results, entry->value);
 369                 }
 370
 371               if (!have_exact)
 372                 {
 373                   for (i = 0; i < entry->n_keys; i++)
 374                     {
 375                       if (entry->keys[i].keycode == hardware_keycode &&
 376                           entry->keys[i].level == level) /* Match for all but group */
 377                         {
 378                           GTK_NOTE (KEYBINDINGS,
 379                                     g_message ("  found group = %d, level = %d",
 380                                                entry->keys[i].group, entry->keys[i].level));
 381                           results = g_slist_prepend (results, entry->value);
 382                           break;
 383                         }
 384                     }
 385                 }
 386             }
 387
 388           tmp_list = tmp_list->next;
 389         }
 390     }
 391
 392   return sort_lookup_results (results);
 393 }
 394
 395 /**
 396  * _gtk_key_hash_lookup_keyval:
 397  * @key_hash: a #GtkKeyHash
 398  * @event: a #GtkEvent
 399  *
 400  * Looks up the best matching entry or entries in the hash table for a
 401  * given keyval/modifiers pair. It's better to use
 402  * _gtk_key_hash_lookup() if you have the original #GdkEventKey
 403  * available.  The results are sorted so that entries with less
 404  * modifiers come before entries with more modifiers.
 405  *
 406  * Return value: A #GSList of all matching entries.
 407  **/
 408 GSList *
 409 _gtk_key_hash_lookup_keyval (GtkKeyHash     *key_hash,
 410                              guint           keyval,
 411                              GdkModifierType modifiers)
 412 {
 413   GdkKeymapKey *keys;
 414   gint n_keys;
 415   GSList *results = NULL;
 416
 417   if (!keyval)                  /* Key without symbol */
 418     return NULL;
 419
 420   /* Find some random keycode for this keycode
 421    */
 422   gdk_keymap_get_entries_for_keyval (key_hash->keymap, keyval,
 423                                      &keys, &n_keys);
 424
 425   if (n_keys)
 426     {
 427       GHashTable *keycode_hash = key_hash_get_keycode_hash (key_hash);
 428       GSList *entries = g_hash_table_lookup (keycode_hash, GUINT_TO_POINTER (keys[0].keycode));
 429
 430       while (entries)
 431         {
 432           GtkKeyHashEntry *entry = entries->data;
 433
 434           if (entry->keyval == keyval && entry->modifiers == modifiers)
 435             results = g_slist_prepend (results, entry->value);
 436
 437           entries = entries->next;
 438         }
 439     }
 440
 441   g_free (keys);
 442
 443   return sort_lookup_results (results);
 444 }