* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
- * License along with this library; if not, write to the
- * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- * Boston, MA 02111-1307, USA.
+ * License along with this library. If not, see <http://www.gnu.org/licenses/>.
*/
+
+#include "config.h"
+
#include "gtkdebug.h"
#include "gtkkeyhash.h"
-
-/* We need to add a ::changed signal to GdkKeyMap to properly deal
- * with changes to the key map while we are running.
- */
-#undef HAVE_CHANGED_SIGNAL
+#include "gtkprivate.h"
typedef struct _GtkKeyHashEntry GtkKeyHashEntry;
{
guint keyval;
GdkModifierType modifiers;
- GdkKeymapKey *keys;
- gint n_keys;
gpointer value;
+
+ /* Set as a side effect of generating key_hash->keycode_hash
+ */
+ GdkKeymapKey *keys;
+ gint n_keys;
};
struct _GtkKeyHash
GdkKeymap *keymap;
GHashTable *keycode_hash;
GHashTable *reverse_hash;
+ GList *entries_list;
GDestroyNotify destroy_notify;
};
{
gint i;
+ g_free (entry->keys);
gdk_keymap_get_entries_for_keyval (key_hash->keymap,
entry->keyval,
&entry->keys, &entry->n_keys);
}
}
-#ifdef HAVE_CHANGED_SIGNAL
-static void
-key_hash_reinsert_entry (gpointer key,
- gpointer value,
- gpointer data)
+static GHashTable *
+key_hash_get_keycode_hash (GtkKeyHash *key_hash)
{
- GtkKeyHashEntry *entry = value;
- GtkKeyHash *key_hash = data;
+ if (!key_hash->keycode_hash)
+ {
+ GList *tmp_list;
+
+ key_hash->keycode_hash = g_hash_table_new (g_direct_hash, NULL);
+
+ /* Preserve the original insertion order
+ */
+ for (tmp_list = g_list_last (key_hash->entries_list);
+ tmp_list;
+ tmp_list = tmp_list->prev)
+ key_hash_insert_entry (key_hash, tmp_list->data);
+ }
- g_free (entry->keys);
- key_hash_insert_entry (key_hash, entry);
+ return key_hash->keycode_hash;
}
static void
-key_hash_keymap_changed (GdkKeymap *keymap,
- GtkKeyHash *key_hash)
+key_hash_keys_changed (GdkKeymap *keymap,
+ GtkKeyHash *key_hash)
{
- /* The keymap changed, so we have to clear and reinsert all our entries
- */
- g_hash_table_foreach (key_hash->keycode_hash, key_hash_clear_keycode, NULL);
-
- /* FIXME: Here we reinsert in random order, but I think we actually have to
- * insert in the same order as the original order to keep GtkBindingSet happy.
+ /* The keymap changed, so we have to regenerate the keycode hash
*/
- g_hash_table_foreach (key_hash->reverse_hash, key_hash_reinsert_entry, key_hash);
+ if (key_hash->keycode_hash)
+ {
+ g_hash_table_foreach (key_hash->keycode_hash, key_hash_clear_keycode, NULL);
+ g_hash_table_destroy (key_hash->keycode_hash);
+ key_hash->keycode_hash = NULL;
+ }
}
-#endif /* HAVE_CHANGED_SIGNAL */
/**
* _gtk_key_hash_new:
GtkKeyHash *key_hash = g_new (GtkKeyHash, 1);
key_hash->keymap = keymap;
-#ifdef HAVE_CHANGED_SIGNAL
- g_signal_connect (keymap, "changed",
- G_CALLBACK (key_hash_keymap_changed), key_hash);
-#endif
+ g_signal_connect (keymap, "keys-changed",
+ G_CALLBACK (key_hash_keys_changed), key_hash);
- key_hash->keycode_hash = g_hash_table_new (g_direct_hash, NULL);
+ key_hash->entries_list = NULL;
+ key_hash->keycode_hash = NULL;
key_hash->reverse_hash = g_hash_table_new (g_direct_hash, NULL);
key_hash->destroy_notify = item_destroy_notify;
(*key_hash->destroy_notify) (entry->value);
g_free (entry->keys);
- g_free (entry);
+ g_slice_free (GtkKeyHashEntry, entry);
}
static void
-key_hash_free_entry_foreach (gpointer key,
- gpointer value,
+key_hash_free_entry_foreach (gpointer value,
gpointer data)
{
GtkKeyHashEntry *entry = value;
void
_gtk_key_hash_free (GtkKeyHash *key_hash)
{
-#if HAVE_CHANGED_SIGNAL
g_signal_handlers_disconnect_by_func (key_hash->keymap,
- G_CALLBACK (key_hash_keymap_changed), key_hash);
-#endif
+ key_hash_keys_changed,
+ key_hash);
- g_hash_table_foreach (key_hash->keycode_hash, key_hash_clear_keycode, NULL);
- g_hash_table_foreach (key_hash->reverse_hash, key_hash_free_entry_foreach, key_hash);
- g_hash_table_destroy (key_hash->keycode_hash);
+ if (key_hash->keycode_hash)
+ {
+ g_hash_table_foreach (key_hash->keycode_hash, key_hash_clear_keycode, NULL);
+ g_hash_table_destroy (key_hash->keycode_hash);
+ }
+
g_hash_table_destroy (key_hash->reverse_hash);
+ g_list_foreach (key_hash->entries_list, key_hash_free_entry_foreach, key_hash);
+ g_list_free (key_hash->entries_list);
+
g_free (key_hash);
}
GdkModifierType modifiers,
gpointer value)
{
- GtkKeyHashEntry *entry = g_new (GtkKeyHashEntry, 1);
+ GtkKeyHashEntry *entry = g_slice_new (GtkKeyHashEntry);
entry->value = value;
entry->keyval = keyval;
entry->modifiers = modifiers;
+ entry->keys = NULL;
+
+ key_hash->entries_list = g_list_prepend (key_hash->entries_list, entry);
+ g_hash_table_insert (key_hash->reverse_hash, value, key_hash->entries_list);
- g_hash_table_insert (key_hash->reverse_hash, value, entry);
- key_hash_insert_entry (key_hash, entry);
+ if (key_hash->keycode_hash)
+ key_hash_insert_entry (key_hash, entry);
}
/**
_gtk_key_hash_remove_entry (GtkKeyHash *key_hash,
gpointer value)
{
- GtkKeyHashEntry *entry = g_hash_table_lookup (key_hash->reverse_hash, value);
- if (entry)
+ GList *entry_node = g_hash_table_lookup (key_hash->reverse_hash, value);
+
+ if (entry_node)
{
- gint i;
+ GtkKeyHashEntry *entry = entry_node->data;
- for (i = 0; i < entry->n_keys; i++)
+ if (key_hash->keycode_hash)
{
- GSList *old_keys = g_hash_table_lookup (key_hash->keycode_hash,
- GUINT_TO_POINTER (entry->keys[i].keycode));
-
- GSList *new_keys = g_slist_remove (old_keys, entry);
- if (old_keys != new_keys)
+ gint i;
+
+ for (i = 0; i < entry->n_keys; i++)
{
- if (old_keys)
- g_hash_table_insert (key_hash->keycode_hash,
- GUINT_TO_POINTER (entry->keys[i].keycode),
- old_keys);
- else
- g_hash_table_remove (key_hash->keycode_hash,
- GUINT_TO_POINTER (entry->keys[i].keycode));
+ GSList *old_keys = g_hash_table_lookup (key_hash->keycode_hash,
+ GUINT_TO_POINTER (entry->keys[i].keycode));
+
+ GSList *new_keys = g_slist_remove (old_keys, entry);
+ if (new_keys != old_keys)
+ {
+ if (new_keys)
+ g_hash_table_insert (key_hash->keycode_hash,
+ GUINT_TO_POINTER (entry->keys[i].keycode),
+ new_keys);
+ else
+ g_hash_table_remove (key_hash->keycode_hash,
+ GUINT_TO_POINTER (entry->keys[i].keycode));
+ }
}
}
-
- g_hash_table_remove (key_hash->reverse_hash, value);
+
+ g_hash_table_remove (key_hash->reverse_hash, entry_node);
+ key_hash->entries_list = g_list_delete_link (key_hash->entries_list, entry_node);
key_hash_free_entry (key_hash, entry);
- g_free (entry);
}
}
+static gint
+lookup_result_compare (gconstpointer a,
+ gconstpointer b)
+{
+ const GtkKeyHashEntry *entry_a = a;
+ const GtkKeyHashEntry *entry_b = b;
+ guint modifiers;
+
+ gint n_bits_a = 0;
+ gint n_bits_b = 0;
+
+ modifiers = entry_a->modifiers;
+ while (modifiers)
+ {
+ if (modifiers & 1)
+ n_bits_a++;
+ modifiers >>= 1;
+ }
+
+ modifiers = entry_b->modifiers;
+ while (modifiers)
+ {
+ if (modifiers & 1)
+ n_bits_b++;
+ modifiers >>= 1;
+ }
+
+ return n_bits_a < n_bits_b ? -1 : (n_bits_a == n_bits_b ? 0 : 1);
+
+}
+
+/* Sort a list of results so that matches with less modifiers come
+ * before matches with more modifiers
+ */
+static GSList *
+sort_lookup_results (GSList *slist)
+{
+ return g_slist_sort (slist, lookup_result_compare);
+}
+
+static gint
+lookup_result_compare_by_keyval (gconstpointer a,
+ gconstpointer b)
+{
+ const GtkKeyHashEntry *entry_a = a;
+ const GtkKeyHashEntry *entry_b = b;
+
+ if (entry_a->keyval < entry_b->keyval)
+ return -1;
+ else if (entry_a->keyval > entry_b->keyval)
+ return 1;
+ else
+ return 0;
+}
+
+static GSList *
+sort_lookup_results_by_keyval (GSList *slist)
+{
+ return g_slist_sort (slist, lookup_result_compare_by_keyval);
+}
+
+/* Return true if keyval is defined in keyboard group
+ */
+static gboolean
+keyval_in_group (GdkKeymap *keymap,
+ guint keyval,
+ gint group)
+{
+ GtkKeyHashEntry entry;
+ gint i;
+
+ gdk_keymap_get_entries_for_keyval (keymap,
+ keyval,
+ &entry.keys, &entry.n_keys);
+
+ for (i = 0; i < entry.n_keys; i++)
+ {
+ if (entry.keys[i].group == group)
+ {
+ g_free (entry.keys);
+ return TRUE;
+ }
+ }
+
+ g_free (entry.keys);
+ return FALSE;
+}
+
/**
* _gtk_key_hash_lookup:
* @key_hash: a #GtkKeyHash
* @hardware_keycode: hardware keycode field from a #GdkEventKey
* @state: state field from a #GdkEventKey
+ * @mask: mask of modifiers to consider when matching against the
+ * modifiers in entries.
* @group: group field from a #GdkEventKey
*
* Looks up the best matching entry or entries in the hash table for
- * a given event.
+ * a given event. The results are sorted so that entries with less
+ * modifiers come before entries with more modifiers.
*
- * Return value: A #GSList of all matching entries. If there were exact
- * matches, they are returned, otherwise all fuzzy matches are
- * returned. (A fuzzy match is a match in keycode and level, but not
- * in group.)
- **/
+ * The matches returned by this function can be exact (i.e. keycode, level
+ * and group all match) or fuzzy (i.e. keycode and level match, but group
+ * does not). As long there are any exact matches, only exact matches
+ * are returned. If there are no exact matches, fuzzy matches will be
+ * returned, as long as they are not shadowing a possible exact match.
+ * This means that fuzzy matches won't be considered if their keyval is
+ * present in the current group.
+ *
+ * Return value: A newly-allocated #GSList of matching entries.
+ * Free with g_slist_free() when no longer needed.
+ */
GSList *
_gtk_key_hash_lookup (GtkKeyHash *key_hash,
guint16 hardware_keycode,
GdkModifierType state,
+ GdkModifierType mask,
gint group)
{
- GSList *keys = g_hash_table_lookup (key_hash->keycode_hash, GUINT_TO_POINTER ((guint)hardware_keycode));
+ GHashTable *keycode_hash = key_hash_get_keycode_hash (key_hash);
+ GSList *keys = g_hash_table_lookup (keycode_hash, GUINT_TO_POINTER ((guint)hardware_keycode));
GSList *results = NULL;
+ GSList *l;
gboolean have_exact = FALSE;
guint keyval;
gint effective_group;
gint level;
+ GdkModifierType modifiers;
GdkModifierType consumed_modifiers;
+ GdkModifierType shift_group_mask;
+ gboolean group_mod_is_accel_mod = FALSE;
+ const GdkModifierType xmods = GDK_MOD2_MASK|GDK_MOD3_MASK|GDK_MOD4_MASK|GDK_MOD5_MASK;
+ const GdkModifierType vmods = GDK_SUPER_MASK|GDK_HYPER_MASK|GDK_META_MASK;
+
+ /* We don't want Caps_Lock to affect keybinding lookups.
+ */
+ state &= ~GDK_LOCK_MASK;
+
+ _gtk_translate_keyboard_accel_state (key_hash->keymap,
+ hardware_keycode, state, mask, group,
+ &keyval,
+ &effective_group, &level, &consumed_modifiers);
- gdk_keymap_translate_keyboard_state (key_hash->keymap,
- hardware_keycode, state, group,
- &keyval, &effective_group, &level, &consumed_modifiers);
+ /* if the group-toggling modifier is part of the default accel mod
+ * mask, and it is active, disable it for matching
+ */
+ shift_group_mask = gdk_keymap_get_modifier_mask (key_hash->keymap,
+ GDK_MODIFIER_INTENT_SHIFT_GROUP);
+ if (mask & shift_group_mask)
+ group_mod_is_accel_mod = TRUE;
+
+ gdk_keymap_map_virtual_modifiers (key_hash->keymap, &mask);
+ gdk_keymap_add_virtual_modifiers (key_hash->keymap, &state);
GTK_NOTE (KEYBINDINGS,
g_message ("Looking up keycode = %u, modifiers = 0x%04x,\n"
{
GtkKeyHashEntry *entry = tmp_list->data;
- if ((entry->modifiers & ~consumed_modifiers) == (state & ~consumed_modifiers))
+ /* If the virtual Super, Hyper or Meta modifiers are present,
+ * they will also be mapped to some of the Mod2 - Mod5 modifiers,
+ * so we compare them twice, ignoring either set.
+ * We accept combinations involving virtual modifiers only if they
+ * are mapped to separate modifiers; i.e. if Super and Hyper are
+ * both mapped to Mod4, then pressing a key that is mapped to Mod4
+ * will not match a Super+Hyper entry.
+ */
+ modifiers = entry->modifiers;
+ if (gdk_keymap_map_virtual_modifiers (key_hash->keymap, &modifiers) &&
+ ((modifiers & ~consumed_modifiers & mask & ~vmods) == (state & ~consumed_modifiers & mask & ~vmods) ||
+ (modifiers & ~consumed_modifiers & mask & ~xmods) == (state & ~consumed_modifiers & mask & ~xmods)))
{
gint i;
- if (keyval == entry->keyval) /* Exact match */
+ if (keyval == entry->keyval && /* Exact match */
+ /* but also match for group if it is an accel mod, because
+ * otherwise we can get multiple exact matches, some being
+ * bogus */
+ (!group_mod_is_accel_mod ||
+ (state & shift_group_mask) == (entry->modifiers & shift_group_mask)))
+
{
GTK_NOTE (KEYBINDINGS,
g_message (" found exact match, keyval = %u, modifiers = 0x%04x",
entry->keyval, entry->modifiers));
-
+
if (!have_exact)
{
g_slist_free (results);
}
have_exact = TRUE;
- results = g_slist_prepend (results, entry->value);
+ results = g_slist_prepend (results, entry);
}
if (!have_exact)
{
for (i = 0; i < entry->n_keys; i++)
{
- if (entry->keys[i].keycode == hardware_keycode &&
- entry->keys[i].level == level) /* Match for all but group */
+ if (entry->keys[i].keycode == hardware_keycode &&
+ entry->keys[i].level == level &&
+ /* Only match for group if it's an accel mod */
+ (!group_mod_is_accel_mod ||
+ entry->keys[i].group == effective_group))
{
GTK_NOTE (KEYBINDINGS,
g_message (" found group = %d, level = %d",
entry->keys[i].group, entry->keys[i].level));
- results = g_slist_prepend (results, entry->value);
+ results = g_slist_prepend (results, entry);
break;
}
}
}
}
+ if (!have_exact && results)
+ {
+ /* If there are fuzzy matches, check that the current group doesn't also
+ * define these keyvals; if yes, discard results because a widget up in
+ * the stack may have an exact match and we don't want to 'steal' it.
+ */
+ guint oldkeyval = 0;
+ GtkKeyHashEntry *keyhashentry;
+
+ results = sort_lookup_results_by_keyval (results);
+ for (l = results; l; l = l->next)
+ {
+ keyhashentry = l->data;
+ if (l == results || oldkeyval != keyhashentry->keyval)
+ {
+ oldkeyval = keyhashentry->keyval;
+ if (keyval_in_group (key_hash->keymap, oldkeyval, group))
+ {
+ g_slist_free (results);
+ return NULL;
+ }
+ }
+ }
+ }
+
+ results = sort_lookup_results (results);
+ for (l = results; l; l = l->next)
+ l->data = ((GtkKeyHashEntry *)l->data)->value;
+
return results;
}
* Looks up the best matching entry or entries in the hash table for a
* given keyval/modifiers pair. It's better to use
* _gtk_key_hash_lookup() if you have the original #GdkEventKey
- * available.
+ * available. The results are sorted so that entries with less
+ * modifiers come before entries with more modifiers.
*
* Return value: A #GSList of all matching entries.
**/
GdkKeymapKey *keys;
gint n_keys;
GSList *results = NULL;
+ GSList *l;
if (!keyval) /* Key without symbol */
return NULL;
- /* Find some random keycode for this keycode
+ /* Find some random keycode for this keyval
*/
gdk_keymap_get_entries_for_keyval (key_hash->keymap, keyval,
&keys, &n_keys);
if (n_keys)
{
- GSList *entries = g_hash_table_lookup (key_hash->keycode_hash, GUINT_TO_POINTER (keys[0].keycode));
+ GHashTable *keycode_hash = key_hash_get_keycode_hash (key_hash);
+ GSList *entries = g_hash_table_lookup (keycode_hash, GUINT_TO_POINTER (keys[0].keycode));
while (entries)
{
GtkKeyHashEntry *entry = entries->data;
if (entry->keyval == keyval && entry->modifiers == modifiers)
- results = g_slist_prepend (results, entry->value);
+ results = g_slist_prepend (results, entry);
entries = entries->next;
}
g_free (keys);
+ results = sort_lookup_results (results);
+ for (l = results; l; l = l->next)
+ l->data = ((GtkKeyHashEntry *)l->data)->value;
+
return results;
}
projects / ~andy / gtk / blobdiff