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