1 /* GTK - The GIMP Toolkit
2 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
4 * GtkBindingSet: Keybinding manager for GObjects.
5 * Copyright (C) 1998 Tim Janik
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2 of the License, or (at your option) any later version.
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with this library; if not, write to the
19 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20 * Boston, MA 02111-1307, USA.
24 * Modified by the GTK+ Team and others 1997-2000. See the AUTHORS
25 * file for a list of people on the GTK+ Team. See the ChangeLog
26 * files for a list of changes. These files are distributed with
27 * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
33 #include <gdkkeysyms.h>
35 #include "gtkbindings.h"
36 #include "gtkkeyhash.h"
37 #include "gtktypeutils.h"
38 #include "gtkwidget.h"
43 #define BINDING_MOD_MASK() (gtk_accelerator_get_default_mod_mask () | GDK_RELEASE_MASK)
46 /* --- structures --- */
56 /* --- variables --- */
57 static GHashTable *binding_entry_hash_table = NULL;
58 static GSList *binding_key_hashes = NULL;
59 static GSList *binding_set_list = NULL;
60 static const gchar key_class_binding_set[] = "gtk-class-binding-set";
61 static GQuark key_id_class_binding_set = 0;
64 /* --- functions --- */
66 pattern_spec_free (PatternSpec *pspec)
68 _gtk_rc_free_widget_class_path (pspec->path);
70 g_pattern_spec_free (pspec->pspec);
74 static GtkBindingSignal*
75 binding_signal_new (const gchar *signal_name,
78 GtkBindingSignal *signal;
80 signal = (GtkBindingSignal *) g_slice_alloc0 (sizeof (GtkBindingSignal) + n_args * sizeof (GtkBindingArg));
82 signal->signal_name = (gchar *)g_intern_string (signal_name);
83 signal->n_args = n_args;
84 signal->args = (GtkBindingArg *)(signal + 1);
90 binding_signal_free (GtkBindingSignal *sig)
94 for (i = 0; i < sig->n_args; i++)
96 if (G_TYPE_FUNDAMENTAL (sig->args[i].arg_type) == G_TYPE_STRING)
97 g_free (sig->args[i].d.string_data);
99 g_slice_free1 (sizeof (GtkBindingSignal) + sig->n_args * sizeof (GtkBindingArg), sig);
103 binding_entry_hash (gconstpointer key)
105 register const GtkBindingEntry *e = key;
115 binding_entries_compare (gconstpointer a,
118 register const GtkBindingEntry *ea = a;
119 register const GtkBindingEntry *eb = b;
121 return (ea->keyval == eb->keyval && ea->modifiers == eb->modifiers);
125 binding_key_hash_insert_entry (GtkKeyHash *key_hash,
126 GtkBindingEntry *entry)
128 guint keyval = entry->keyval;
130 /* We store lowercased accelerators. To deal with this, if <Shift>
131 * was specified, uppercase.
133 if (entry->modifiers & GDK_SHIFT_MASK)
135 if (keyval == GDK_KEY_Tab)
136 keyval = GDK_KEY_ISO_Left_Tab;
138 keyval = gdk_keyval_to_upper (keyval);
141 _gtk_key_hash_add_entry (key_hash, keyval, entry->modifiers & ~GDK_RELEASE_MASK, entry);
145 binding_key_hash_destroy (gpointer data)
147 GtkKeyHash *key_hash = data;
149 binding_key_hashes = g_slist_remove (binding_key_hashes, key_hash);
150 _gtk_key_hash_free (key_hash);
154 insert_entries_into_key_hash (gpointer key,
158 GtkKeyHash *key_hash = data;
159 GtkBindingEntry *entry = value;
161 for (; entry; entry = entry->hash_next)
162 binding_key_hash_insert_entry (key_hash, entry);
166 binding_key_hash_for_keymap (GdkKeymap *keymap)
168 static GQuark key_hash_quark = 0;
169 GtkKeyHash *key_hash;
172 key_hash_quark = g_quark_from_static_string ("gtk-binding-key-hash");
174 key_hash = g_object_get_qdata (G_OBJECT (keymap), key_hash_quark);
178 key_hash = _gtk_key_hash_new (keymap, NULL);
179 g_object_set_qdata_full (G_OBJECT (keymap), key_hash_quark, key_hash, binding_key_hash_destroy);
181 if (binding_entry_hash_table)
182 g_hash_table_foreach (binding_entry_hash_table,
183 insert_entries_into_key_hash,
186 binding_key_hashes = g_slist_prepend (binding_key_hashes, key_hash);
193 static GtkBindingEntry*
194 binding_entry_new (GtkBindingSet *binding_set,
196 GdkModifierType modifiers)
199 GtkBindingEntry *entry;
201 if (!binding_entry_hash_table)
202 binding_entry_hash_table = g_hash_table_new (binding_entry_hash, binding_entries_compare);
204 entry = g_new (GtkBindingEntry, 1);
205 entry->keyval = keyval;
206 entry->modifiers = modifiers;
207 entry->binding_set = binding_set,
208 entry->destroyed = FALSE;
209 entry->in_emission = FALSE;
210 entry->marks_unbound = FALSE;
211 entry->signals = NULL;
213 entry->set_next = binding_set->entries;
214 binding_set->entries = entry;
216 entry->hash_next = g_hash_table_lookup (binding_entry_hash_table, entry);
217 if (entry->hash_next)
218 g_hash_table_remove (binding_entry_hash_table, entry->hash_next);
219 g_hash_table_insert (binding_entry_hash_table, entry, entry);
221 for (tmp_list = binding_key_hashes; tmp_list; tmp_list = tmp_list->next)
223 GtkKeyHash *key_hash = tmp_list->data;
224 binding_key_hash_insert_entry (key_hash, entry);
231 binding_entry_free (GtkBindingEntry *entry)
233 GtkBindingSignal *sig;
235 g_assert (entry->set_next == NULL &&
236 entry->hash_next == NULL &&
237 entry->in_emission == FALSE &&
238 entry->destroyed == TRUE);
240 entry->destroyed = FALSE;
242 sig = entry->signals;
245 GtkBindingSignal *prev;
249 binding_signal_free (prev);
255 binding_entry_destroy (GtkBindingEntry *entry)
257 GtkBindingEntry *o_entry;
258 register GtkBindingEntry *tmp;
259 GtkBindingEntry *begin;
260 register GtkBindingEntry *last;
263 /* unlink from binding set
266 tmp = entry->binding_set->entries;
272 last->set_next = entry->set_next;
274 entry->binding_set->entries = entry->set_next;
278 tmp = last->set_next;
280 entry->set_next = NULL;
282 o_entry = g_hash_table_lookup (binding_entry_hash_table, entry);
291 last->hash_next = entry->hash_next;
293 begin = entry->hash_next;
297 tmp = last->hash_next;
299 entry->hash_next = NULL;
302 g_hash_table_remove (binding_entry_hash_table, entry);
303 else if (begin != o_entry)
305 g_hash_table_remove (binding_entry_hash_table, entry);
306 g_hash_table_insert (binding_entry_hash_table, begin, begin);
309 for (tmp_list = binding_key_hashes; tmp_list; tmp_list = tmp_list->next)
311 GtkKeyHash *key_hash = tmp_list->data;
312 _gtk_key_hash_remove_entry (key_hash, entry);
315 entry->destroyed = TRUE;
317 if (!entry->in_emission)
318 binding_entry_free (entry);
321 static GtkBindingEntry*
322 binding_ht_lookup_entry (GtkBindingSet *set,
324 GdkModifierType modifiers)
326 GtkBindingEntry lookup_entry = { 0 };
327 GtkBindingEntry *entry;
329 if (!binding_entry_hash_table)
332 lookup_entry.keyval = keyval;
333 lookup_entry.modifiers = modifiers;
335 entry = g_hash_table_lookup (binding_entry_hash_table, &lookup_entry);
336 for (; entry; entry = entry->hash_next)
337 if (entry->binding_set == set)
344 binding_compose_params (GObject *object,
354 params = g_new0 (GValue, query->n_params + 1);
357 /* The instance we emit on is the first object in the array
359 g_value_init (params, G_TYPE_OBJECT);
360 g_value_set_object (params, G_OBJECT (object));
363 types = query->param_types;
365 for (i = 1; i < query->n_params + 1 && valid; i++)
367 GValue tmp_value = { 0, };
369 g_value_init (params, *types);
371 switch (G_TYPE_FUNDAMENTAL (args->arg_type))
374 g_value_init (&tmp_value, G_TYPE_DOUBLE);
375 g_value_set_double (&tmp_value, args->d.double_data);
378 g_value_init (&tmp_value, G_TYPE_LONG);
379 g_value_set_long (&tmp_value, args->d.long_data);
382 /* gtk_rc_parse_flags/enum() has fancier parsing for this; we can't call
383 * that since we don't have a GParamSpec, so just do something simple
385 if (G_TYPE_FUNDAMENTAL (*types) == G_TYPE_ENUM)
387 GEnumClass *class = G_ENUM_CLASS (g_type_class_ref (*types));
391 if (args->arg_type == GTK_TYPE_IDENTIFIER)
393 GEnumValue *enum_value = NULL;
394 enum_value = g_enum_get_value_by_name (class, args->d.string_data);
396 enum_value = g_enum_get_value_by_nick (class, args->d.string_data);
399 g_value_init (&tmp_value, *types);
400 g_value_set_enum (&tmp_value, enum_value->value);
405 g_type_class_unref (class);
407 /* This is just a hack for compatibility with GTK+-1.2 where a string
408 * could be used for a single flag value / without the support for multiple
409 * values in gtk_rc_parse_flags(), this isn't very useful.
411 else if (G_TYPE_FUNDAMENTAL (*types) == G_TYPE_FLAGS)
413 GFlagsClass *class = G_FLAGS_CLASS (g_type_class_ref (*types));
417 if (args->arg_type == GTK_TYPE_IDENTIFIER)
419 GFlagsValue *flags_value = NULL;
420 flags_value = g_flags_get_value_by_name (class, args->d.string_data);
422 flags_value = g_flags_get_value_by_nick (class, args->d.string_data);
425 g_value_init (&tmp_value, *types);
426 g_value_set_flags (&tmp_value, flags_value->value);
431 g_type_class_unref (class);
435 g_value_init (&tmp_value, G_TYPE_STRING);
436 g_value_set_static_string (&tmp_value, args->d.string_data);
446 if (!g_value_transform (&tmp_value, params))
449 g_value_unset (&tmp_value);
461 for (j = 0; j < i; j++)
462 g_value_unset (&(*params_p)[j]);
472 gtk_binding_entry_activate (GtkBindingEntry *entry,
475 GtkBindingSignal *sig;
476 gboolean old_emission;
477 gboolean handled = FALSE;
480 old_emission = entry->in_emission;
481 entry->in_emission = TRUE;
483 g_object_ref (object);
485 for (sig = entry->signals; sig; sig = sig->next)
489 GValue *params = NULL;
490 GValue return_val = { 0, };
491 gchar *accelerator = NULL;
493 signal_id = g_signal_lookup (sig->signal_name, G_OBJECT_TYPE (object));
496 accelerator = gtk_accelerator_name (entry->keyval, entry->modifiers);
497 g_warning ("gtk_binding_entry_activate(): binding \"%s::%s\": "
498 "could not find signal \"%s\" in the `%s' class ancestry",
499 entry->binding_set->set_name,
502 g_type_name (G_OBJECT_TYPE (object)));
503 g_free (accelerator);
507 g_signal_query (signal_id, &query);
508 if (query.n_params != sig->n_args ||
509 (query.return_type != G_TYPE_NONE && query.return_type != G_TYPE_BOOLEAN) ||
510 !binding_compose_params (object, sig->args, &query, ¶ms))
512 accelerator = gtk_accelerator_name (entry->keyval, entry->modifiers);
513 g_warning ("gtk_binding_entry_activate(): binding \"%s::%s\": "
514 "signature mismatch for signal \"%s\" in the `%s' class ancestry",
515 entry->binding_set->set_name,
518 g_type_name (G_OBJECT_TYPE (object)));
520 else if (!(query.signal_flags & G_SIGNAL_ACTION))
522 accelerator = gtk_accelerator_name (entry->keyval, entry->modifiers);
523 g_warning ("gtk_binding_entry_activate(): binding \"%s::%s\": "
524 "signal \"%s\" in the `%s' class ancestry cannot be used for action emissions",
525 entry->binding_set->set_name,
528 g_type_name (G_OBJECT_TYPE (object)));
530 g_free (accelerator);
534 if (query.return_type == G_TYPE_BOOLEAN)
535 g_value_init (&return_val, G_TYPE_BOOLEAN);
537 g_signal_emitv (params, signal_id, 0, &return_val);
539 if (query.return_type == G_TYPE_BOOLEAN)
541 if (g_value_get_boolean (&return_val))
543 g_value_unset (&return_val);
548 for (i = 0; i < query.n_params + 1; i++)
549 g_value_unset (¶ms[i]);
552 if (entry->destroyed)
556 g_object_unref (object);
558 entry->in_emission = old_emission;
559 if (entry->destroyed && !entry->in_emission)
560 binding_entry_free (entry);
566 * gtk_binding_set_new:
567 * @set_name: unique name of this binding set
569 * GTK+ maintains a global list of binding sets. Each binding set has
570 * a unique name which needs to be specified upon creation.
572 * Return value: new binding set
575 gtk_binding_set_new (const gchar *set_name)
577 GtkBindingSet *binding_set;
579 g_return_val_if_fail (set_name != NULL, NULL);
581 binding_set = g_new (GtkBindingSet, 1);
582 binding_set->set_name = (gchar *) g_intern_string (set_name);
583 binding_set->widget_path_pspecs = NULL;
584 binding_set->widget_class_pspecs = NULL;
585 binding_set->class_branch_pspecs = NULL;
586 binding_set->entries = NULL;
587 binding_set->current = NULL;
588 binding_set->parsed = FALSE;
590 binding_set_list = g_slist_prepend (binding_set_list, binding_set);
596 * gtk_binding_set_by_class:
597 * @object_class: a valid #GObject class
599 * This function returns the binding set named after the type name of
600 * the passed in class structure. New binding sets are created on
601 * demand by this function.
603 * Return value: the binding set corresponding to @object_class
606 gtk_binding_set_by_class (gpointer object_class)
608 GObjectClass *class = object_class;
609 GtkBindingSet* binding_set;
611 g_return_val_if_fail (G_IS_OBJECT_CLASS (class), NULL);
613 if (!key_id_class_binding_set)
614 key_id_class_binding_set = g_quark_from_static_string (key_class_binding_set);
616 binding_set = g_dataset_id_get_data (class, key_id_class_binding_set);
621 binding_set = gtk_binding_set_new (g_type_name (G_OBJECT_CLASS_TYPE (class)));
622 gtk_binding_set_add_path (binding_set,
624 g_type_name (G_OBJECT_CLASS_TYPE (class)),
626 g_dataset_id_set_data (class, key_id_class_binding_set, binding_set);
632 * gtk_binding_set_find:
633 * @set_name: unique binding set name
635 * Find a binding set by its globally unique name. The @set_name can
636 * either be a name used for gtk_binding_set_new() or the type name of
637 * a class used in gtk_binding_set_by_class().
639 * Return value: %NULL or the specified binding set
642 gtk_binding_set_find (const gchar *set_name)
646 g_return_val_if_fail (set_name != NULL, NULL);
648 for (slist = binding_set_list; slist; slist = slist->next)
650 GtkBindingSet *binding_set;
652 binding_set = slist->data;
653 if (g_str_equal (binding_set->set_name, (gpointer) set_name))
660 * gtk_binding_set_activate:
661 * @binding_set: a #GtkBindingSet set to activate
662 * @keyval: key value of the binding
663 * @modifiers: key modifier of the binding
664 * @object: object to activate when binding found
666 * Find a key binding matching @keyval and @modifiers within
667 * @binding_set and activate the binding on @object.
669 * Return value: %TRUE if a binding was found and activated
672 gtk_binding_set_activate (GtkBindingSet *binding_set,
674 GdkModifierType modifiers,
677 GtkBindingEntry *entry;
679 g_return_val_if_fail (binding_set != NULL, FALSE);
680 g_return_val_if_fail (G_IS_OBJECT (object), FALSE);
682 keyval = gdk_keyval_to_lower (keyval);
683 modifiers = modifiers & BINDING_MOD_MASK ();
685 entry = binding_ht_lookup_entry (binding_set, keyval, modifiers);
687 return gtk_binding_entry_activate (entry, object);
693 gtk_binding_entry_clear_internal (GtkBindingSet *binding_set,
695 GdkModifierType modifiers)
697 GtkBindingEntry *entry;
699 keyval = gdk_keyval_to_lower (keyval);
700 modifiers = modifiers & BINDING_MOD_MASK ();
702 entry = binding_ht_lookup_entry (binding_set, keyval, modifiers);
704 binding_entry_destroy (entry);
706 entry = binding_entry_new (binding_set, keyval, modifiers);
710 * gtk_binding_entry_skip:
711 * @binding_set: a #GtkBindingSet to skip an entry of
712 * @keyval: key value of binding to skip
713 * @modifiers: key modifier of binding to skip
715 * Install a binding on @binding_set which causes key lookups
716 * to be aborted, to prevent bindings from lower priority sets
722 gtk_binding_entry_skip (GtkBindingSet *binding_set,
724 GdkModifierType modifiers)
726 GtkBindingEntry *entry;
728 g_return_if_fail (binding_set != NULL);
730 keyval = gdk_keyval_to_lower (keyval);
731 modifiers = modifiers & BINDING_MOD_MASK ();
733 entry = binding_ht_lookup_entry (binding_set, keyval, modifiers);
735 binding_entry_destroy (entry);
737 entry = binding_entry_new (binding_set, keyval, modifiers);
738 entry->marks_unbound = TRUE;
742 * gtk_binding_entry_remove:
743 * @binding_set: a #GtkBindingSet to remove an entry of
744 * @keyval: key value of binding to remove
745 * @modifiers: key modifier of binding to remove
747 * Remove a binding previously installed via
748 * gtk_binding_entry_add_signal() on @binding_set.
751 gtk_binding_entry_remove (GtkBindingSet *binding_set,
753 GdkModifierType modifiers)
755 GtkBindingEntry *entry;
757 g_return_if_fail (binding_set != NULL);
759 keyval = gdk_keyval_to_lower (keyval);
760 modifiers = modifiers & BINDING_MOD_MASK ();
762 entry = binding_ht_lookup_entry (binding_set, keyval, modifiers);
764 binding_entry_destroy (entry);
768 * gtk_binding_entry_add_signall:
769 * @binding_set: a #GtkBindingSet to add a signal to
771 * @modifiers: key modifier
772 * @signal_name: signal name to be bound
773 * @binding_args: (transfer none) (element-type GtkBindingArg):
774 * list of #GtkBindingArg signal arguments
776 * Override or install a new key binding for @keyval with @modifiers on
780 gtk_binding_entry_add_signall (GtkBindingSet *binding_set,
782 GdkModifierType modifiers,
783 const gchar *signal_name,
784 GSList *binding_args)
786 _gtk_binding_entry_add_signall (binding_set,
788 signal_name, binding_args);
792 _gtk_binding_entry_add_signall (GtkBindingSet *binding_set,
794 GdkModifierType modifiers,
795 const gchar *signal_name,
796 GSList *binding_args)
798 GtkBindingEntry *entry;
799 GtkBindingSignal *signal, **signal_p;
804 g_return_if_fail (binding_set != NULL);
805 g_return_if_fail (signal_name != NULL);
807 keyval = gdk_keyval_to_lower (keyval);
808 modifiers = modifiers & BINDING_MOD_MASK ();
810 signal = binding_signal_new (signal_name, g_slist_length (binding_args));
813 for (slist = binding_args; slist; slist = slist->next)
815 GtkBindingArg *tmp_arg;
817 tmp_arg = slist->data;
820 g_warning ("gtk_binding_entry_add_signall(): arg[%u] is `NULL'", n);
821 binding_signal_free (signal);
824 switch (G_TYPE_FUNDAMENTAL (tmp_arg->arg_type))
827 arg->arg_type = G_TYPE_LONG;
828 arg->d.long_data = tmp_arg->d.long_data;
831 arg->arg_type = G_TYPE_DOUBLE;
832 arg->d.double_data = tmp_arg->d.double_data;
835 if (tmp_arg->arg_type != GTK_TYPE_IDENTIFIER)
836 arg->arg_type = G_TYPE_STRING;
838 arg->arg_type = GTK_TYPE_IDENTIFIER;
839 arg->d.string_data = g_strdup (tmp_arg->d.string_data);
840 if (!arg->d.string_data)
842 g_warning ("gtk_binding_entry_add_signall(): value of `string' arg[%u] is `NULL'", n);
843 binding_signal_free (signal);
848 g_warning ("gtk_binding_entry_add_signall(): unsupported type `%s' for arg[%u]",
849 g_type_name (arg->arg_type), n);
850 binding_signal_free (signal);
857 entry = binding_ht_lookup_entry (binding_set, keyval, modifiers);
860 gtk_binding_entry_clear_internal (binding_set, keyval, modifiers);
861 entry = binding_ht_lookup_entry (binding_set, keyval, modifiers);
863 signal_p = &entry->signals;
865 signal_p = &(*signal_p)->next;
870 * gtk_binding_entry_add_signal:
871 * @binding_set: a #GtkBindingSet to install an entry for
872 * @keyval: key value of binding to install
873 * @modifiers: key modifier of binding to install
874 * @signal_name: signal to execute upon activation
875 * @n_args: number of arguments to @signal_name
876 * @Varargs: arguments to @signal_name
878 * Override or install a new key binding for @keyval with @modifiers on
879 * @binding_set. When the binding is activated, @signal_name will be
880 * emitted on the target widget, with @n_args @Varargs used as
884 gtk_binding_entry_add_signal (GtkBindingSet *binding_set,
886 GdkModifierType modifiers,
887 const gchar *signal_name,
891 GSList *slist, *free_slist;
895 g_return_if_fail (binding_set != NULL);
896 g_return_if_fail (signal_name != NULL);
898 va_start (args, n_args);
900 for (i = 0; i < n_args; i++)
904 arg = g_slice_new0 (GtkBindingArg);
905 slist = g_slist_prepend (slist, arg);
907 arg->arg_type = va_arg (args, GType);
908 switch (G_TYPE_FUNDAMENTAL (arg->arg_type))
917 arg->arg_type = G_TYPE_LONG;
918 arg->d.long_data = va_arg (args, gint);
922 arg->arg_type = G_TYPE_LONG;
923 arg->d.long_data = va_arg (args, glong);
927 arg->arg_type = G_TYPE_DOUBLE;
928 arg->d.double_data = va_arg (args, gdouble);
931 if (arg->arg_type != GTK_TYPE_IDENTIFIER)
932 arg->arg_type = G_TYPE_STRING;
933 arg->d.string_data = va_arg (args, gchar*);
934 if (!arg->d.string_data)
936 g_warning ("gtk_binding_entry_add_signal(): type `%s' arg[%u] is `NULL'",
937 g_type_name (arg->arg_type),
943 g_warning ("gtk_binding_entry_add_signal(): unsupported type `%s' for arg[%u]",
944 g_type_name (arg->arg_type), i);
951 if (i == n_args || i == 0)
953 slist = g_slist_reverse (slist);
954 _gtk_binding_entry_add_signall (binding_set, keyval, modifiers, signal_name, slist);
960 g_slice_free (GtkBindingArg, slist->data);
963 g_slist_free (free_slist);
967 * gtk_binding_set_add_path:
968 * @binding_set: a #GtkBindingSet to add a path to
969 * @path_type: path type the pattern applies to
970 * @path_pattern: the actual match pattern
971 * @priority: binding priority
973 * This function is used internally by the GtkRC parsing mechanism to
974 * assign match patterns to #GtkBindingSet structures.
977 gtk_binding_set_add_path (GtkBindingSet *binding_set,
978 GtkPathType path_type,
979 const gchar *path_pattern,
980 GtkPathPriorityType priority)
983 GSList **slist_p, *slist;
984 static guint seq_id = 0;
986 g_return_if_fail (binding_set != NULL);
987 g_return_if_fail (path_pattern != NULL);
988 g_return_if_fail (priority <= GTK_PATH_PRIO_MASK);
990 priority &= GTK_PATH_PRIO_MASK;
994 case GTK_PATH_WIDGET:
995 slist_p = &binding_set->widget_path_pspecs;
997 case GTK_PATH_WIDGET_CLASS:
998 slist_p = &binding_set->widget_class_pspecs;
1000 case GTK_PATH_CLASS:
1001 slist_p = &binding_set->class_branch_pspecs;
1004 g_assert_not_reached ();
1009 pspec = g_new (PatternSpec, 1);
1010 pspec->type = path_type;
1011 if (path_type == GTK_PATH_WIDGET_CLASS)
1013 pspec->pspec = NULL;
1014 pspec->path = _gtk_rc_parse_widget_class_path (path_pattern);
1018 pspec->pspec = g_pattern_spec_new (path_pattern);
1022 pspec->seq_id = priority << 28;
1023 pspec->user_data = binding_set;
1028 PatternSpec *tmp_pspec;
1030 tmp_pspec = slist->data;
1031 slist = slist->next;
1033 if (g_pattern_spec_equal (tmp_pspec->pspec, pspec->pspec))
1035 GtkPathPriorityType lprio = tmp_pspec->seq_id >> 28;
1037 pattern_spec_free (pspec);
1039 if (lprio < priority)
1041 tmp_pspec->seq_id &= 0x0fffffff;
1042 tmp_pspec->seq_id |= priority << 28;
1049 pspec->seq_id |= seq_id++ & 0x0fffffff;
1050 *slist_p = g_slist_prepend (*slist_p, pspec);
1055 binding_match_activate (GSList *pspec_list,
1059 gchar *path_reversed,
1066 for (slist = pspec_list; slist; slist = slist->next)
1069 GtkBindingSet *binding_set;
1072 pspec = slist->data;
1074 if (pspec->type == GTK_PATH_WIDGET_CLASS)
1076 if (_gtk_rc_match_widget_class (pspec->path, path_length, path, path_reversed))
1077 binding_set = pspec->user_data;
1081 if (g_pattern_match (pspec->pspec, path_length, path, path_reversed))
1082 binding_set = pspec->user_data;
1087 if (binding_set->current->marks_unbound)
1093 if (gtk_binding_entry_activate (binding_set->current, object))
1102 gtk_binding_pattern_compare (gconstpointer new_pattern,
1103 gconstpointer existing_pattern)
1105 register const PatternSpec *np = new_pattern;
1106 register const PatternSpec *ep = existing_pattern;
1108 /* walk the list as long as the existing patterns have
1109 * higher priorities.
1112 return np->seq_id < ep->seq_id;
1116 gtk_binding_entries_sort_patterns (GSList *entries,
1117 GtkPathType path_id,
1118 gboolean is_release)
1124 for (tmp_list = entries; tmp_list; tmp_list = tmp_list->next)
1126 GtkBindingEntry *entry = tmp_list->data;
1127 GtkBindingSet *binding_set;
1129 binding_set = entry->binding_set;
1130 binding_set->current = NULL;
1133 for (; entries; entries = entries->next)
1135 GtkBindingEntry *entry = entries->data;
1136 GtkBindingSet *binding_set;
1137 GSList *slist = NULL;
1139 if (is_release != ((entry->modifiers & GDK_RELEASE_MASK) != 0))
1142 binding_set = entry->binding_set;
1144 if (binding_set->current)
1146 binding_set->current = entry;
1150 case GTK_PATH_WIDGET:
1151 slist = binding_set->widget_path_pspecs;
1153 case GTK_PATH_WIDGET_CLASS:
1154 slist = binding_set->widget_class_pspecs;
1156 case GTK_PATH_CLASS:
1157 slist = binding_set->class_branch_pspecs;
1161 for (; slist; slist = slist->next)
1165 pspec = slist->data;
1166 patterns = g_slist_insert_sorted (patterns, pspec, gtk_binding_pattern_compare);
1174 gtk_bindings_activate_list (GObject *object,
1176 gboolean is_release)
1178 GtkWidget *widget = GTK_WIDGET (object);
1179 gboolean handled = FALSE;
1187 gchar *path, *path_reversed;
1191 gtk_widget_path (widget, &path_length, &path, &path_reversed);
1192 patterns = gtk_binding_entries_sort_patterns (entries, GTK_PATH_WIDGET, is_release);
1193 handled = binding_match_activate (patterns, object, path_length, path, path_reversed, &unbound);
1194 g_slist_free (patterns);
1196 g_free (path_reversed);
1205 gchar *path, *path_reversed;
1209 gtk_widget_class_path (widget, &path_length, &path, &path_reversed);
1210 patterns = gtk_binding_entries_sort_patterns (entries, GTK_PATH_WIDGET_CLASS, is_release);
1211 handled = binding_match_activate (patterns, object, path_length, path, path_reversed, &unbound);
1212 g_slist_free (patterns);
1214 g_free (path_reversed);
1224 gboolean unbound = FALSE;
1226 patterns = gtk_binding_entries_sort_patterns (entries, GTK_PATH_CLASS, is_release);
1227 class_type = G_TYPE_FROM_INSTANCE (object);
1228 while (class_type && !handled)
1232 gchar *path_reversed;
1234 path = g_strdup (g_type_name (class_type));
1235 path_reversed = g_strdup (path);
1236 g_strreverse (path_reversed);
1237 path_length = strlen (path);
1238 handled = binding_match_activate (patterns, object, path_length, path, path_reversed, &unbound);
1240 g_free (path_reversed);
1245 class_type = g_type_parent (class_type);
1247 g_slist_free (patterns);
1257 * gtk_bindings_activate:
1258 * @object: object to activate when binding found
1259 * @keyval: key value of the binding
1260 * @modifiers: key modifier of the binding
1262 * Find a key binding matching @keyval and @modifiers and activate the
1263 * binding on @object.
1265 * Return value: %TRUE if a binding was found and activated
1268 gtk_bindings_activate (GObject *object,
1270 GdkModifierType modifiers)
1272 GSList *entries = NULL;
1273 GdkDisplay *display;
1274 GtkKeyHash *key_hash;
1275 gboolean handled = FALSE;
1276 gboolean is_release;
1278 if (!GTK_IS_WIDGET (object))
1281 is_release = (modifiers & GDK_RELEASE_MASK) != 0;
1282 modifiers = modifiers & BINDING_MOD_MASK () & ~GDK_RELEASE_MASK;
1284 display = gtk_widget_get_display (GTK_WIDGET (object));
1285 key_hash = binding_key_hash_for_keymap (gdk_keymap_get_for_display (display));
1287 entries = _gtk_key_hash_lookup_keyval (key_hash, keyval, modifiers);
1289 handled = gtk_bindings_activate_list (object, entries, is_release);
1291 g_slist_free (entries);
1297 * gtk_bindings_activate_event:
1298 * @object: a #GObject (generally must be a widget)
1299 * @event: a #GdkEventKey
1301 * Looks up key bindings for @object to find one matching
1302 * @event, and if one was found, activate it.
1304 * Return value: %TRUE if a matching key binding was found
1309 gtk_bindings_activate_event (GObject *object,
1312 GSList *entries = NULL;
1313 GdkDisplay *display;
1314 GtkKeyHash *key_hash;
1315 gboolean handled = FALSE;
1317 if (!GTK_IS_WIDGET (object))
1320 display = gtk_widget_get_display (GTK_WIDGET (object));
1321 key_hash = binding_key_hash_for_keymap (gdk_keymap_get_for_display (display));
1323 entries = _gtk_key_hash_lookup (key_hash,
1324 event->hardware_keycode,
1326 BINDING_MOD_MASK () & ~GDK_RELEASE_MASK,
1329 handled = gtk_bindings_activate_list (object, entries,
1330 event->type == GDK_KEY_RELEASE);
1332 g_slist_free (entries);
1338 gtk_binding_parse_signal (GScanner *scanner,
1339 GtkBindingSet *binding_set,
1341 GdkModifierType modifiers)
1344 guint expected_token = 0;
1350 gboolean seen_comma;
1353 g_return_val_if_fail (scanner != NULL, G_TOKEN_ERROR);
1355 g_scanner_get_next_token (scanner);
1356 if (scanner->token != G_TOKEN_STRING)
1357 return G_TOKEN_STRING;
1358 g_scanner_peek_next_token (scanner);
1359 if (scanner->next_token != '(')
1361 g_scanner_get_next_token (scanner);
1364 signal = g_strdup (scanner->value.v_string);
1365 g_scanner_get_next_token (scanner);
1372 scanner->config->scan_symbols = FALSE;
1376 expected_token = G_TOKEN_INT;
1378 expected_token = ')';
1380 token = g_scanner_get_next_token (scanner);
1389 arg = g_new (GtkBindingArg, 1);
1390 arg->arg_type = G_TYPE_DOUBLE;
1391 arg->d.double_data = scanner->value.v_float;
1394 arg->d.double_data = - arg->d.double_data;
1397 args = g_slist_prepend (args, arg);
1406 arg = g_new (GtkBindingArg, 1);
1407 arg->arg_type = G_TYPE_LONG;
1408 arg->d.long_data = scanner->value.v_int;
1411 arg->d.long_data = - arg->d.long_data;
1414 args = g_slist_prepend (args, arg);
1419 case G_TOKEN_STRING:
1420 if (need_arg && !negate)
1423 arg = g_new (GtkBindingArg, 1);
1424 arg->arg_type = G_TYPE_STRING;
1425 arg->d.string_data = g_strdup (scanner->value.v_string);
1426 args = g_slist_prepend (args, arg);
1431 case G_TOKEN_IDENTIFIER:
1432 if (need_arg && !negate)
1435 arg = g_new (GtkBindingArg, 1);
1436 arg->arg_type = GTK_TYPE_IDENTIFIER;
1437 arg->d.string_data = g_strdup (scanner->value.v_identifier);
1438 args = g_slist_prepend (args, arg);
1448 expected_token = G_TOKEN_INT;
1462 if (!(need_arg && seen_comma) && !negate)
1464 args = g_slist_reverse (args);
1465 _gtk_binding_entry_add_signall (binding_set,
1470 expected_token = G_TOKEN_NONE;
1480 scanner->config->scan_symbols = TRUE;
1482 for (slist = args; slist; slist = slist->next)
1487 if (G_TYPE_FUNDAMENTAL (arg->arg_type) == G_TYPE_STRING)
1488 g_free (arg->d.string_data);
1491 g_slist_free (args);
1494 return expected_token;
1498 gtk_binding_parse_bind (GScanner *scanner,
1499 GtkBindingSet *binding_set)
1502 GdkModifierType modifiers = 0;
1503 gboolean unbind = FALSE;
1506 g_return_val_if_fail (scanner != NULL, G_TOKEN_ERROR);
1508 token = g_scanner_get_next_token (scanner);
1509 if (token != GTK_RC_TOKEN_BIND &&
1510 token != GTK_RC_TOKEN_UNBIND)
1511 return GTK_RC_TOKEN_BIND;
1512 unbind = token == GTK_RC_TOKEN_UNBIND;
1513 g_scanner_get_next_token (scanner);
1514 if (scanner->token != G_TOKEN_STRING)
1515 return G_TOKEN_STRING;
1516 gtk_accelerator_parse (scanner->value.v_string, &keyval, &modifiers);
1517 modifiers &= BINDING_MOD_MASK ();
1519 return G_TOKEN_STRING;
1523 gtk_binding_entry_skip (binding_set, keyval, modifiers);
1524 return G_TOKEN_NONE;
1527 g_scanner_get_next_token (scanner);
1529 if (scanner->token != '{')
1532 gtk_binding_entry_clear_internal (binding_set, keyval, modifiers);
1534 g_scanner_peek_next_token (scanner);
1535 while (scanner->next_token != '}')
1537 switch (scanner->next_token)
1539 guint expected_token;
1541 case G_TOKEN_STRING:
1542 expected_token = gtk_binding_parse_signal (scanner,
1546 if (expected_token != G_TOKEN_NONE)
1547 return expected_token;
1550 g_scanner_get_next_token (scanner);
1553 g_scanner_peek_next_token (scanner);
1555 g_scanner_get_next_token (scanner);
1557 return G_TOKEN_NONE;
1561 _gtk_binding_parse_binding (GScanner *scanner)
1563 GtkBindingSet *binding_set;
1567 g_return_val_if_fail (scanner != NULL, G_TOKEN_ERROR);
1569 token = g_scanner_get_next_token (scanner);
1570 if (token != GTK_RC_TOKEN_BINDING)
1571 return GTK_RC_TOKEN_BINDING;
1572 g_scanner_get_next_token (scanner);
1573 if (scanner->token != G_TOKEN_STRING)
1574 return G_TOKEN_STRING;
1575 name = g_strdup (scanner->value.v_string);
1577 g_scanner_get_next_token (scanner);
1578 if (scanner->token != '{')
1581 return G_TOKEN_STRING;
1584 binding_set = gtk_binding_set_find (name);
1587 binding_set = gtk_binding_set_new (name);
1588 binding_set->parsed = 1;
1592 g_scanner_peek_next_token (scanner);
1593 while (scanner->next_token != '}')
1595 guint next_token = scanner->next_token;
1598 guint expected_token;
1600 case GTK_RC_TOKEN_BIND:
1601 case GTK_RC_TOKEN_UNBIND:
1602 expected_token = gtk_binding_parse_bind (scanner, binding_set);
1603 if (expected_token != G_TOKEN_NONE)
1604 return expected_token;
1607 g_scanner_get_next_token (scanner);
1610 g_scanner_peek_next_token (scanner);
1612 g_scanner_get_next_token (scanner);
1614 return G_TOKEN_NONE;
1618 free_pattern_specs (GSList *pattern_specs)
1622 for (slist = pattern_specs; slist; slist = slist->next)
1626 pspec = slist->data;
1628 pattern_spec_free (pspec);
1631 g_slist_free (pattern_specs);
1635 binding_set_delete (GtkBindingSet *binding_set)
1637 GtkBindingEntry *entry, *next;
1639 entry = binding_set->entries;
1642 next = entry->set_next;
1643 binding_entry_destroy (entry);
1647 free_pattern_specs (binding_set->widget_path_pspecs);
1648 free_pattern_specs (binding_set->widget_class_pspecs);
1649 free_pattern_specs (binding_set->class_branch_pspecs);
1651 g_free (binding_set);
1655 * _gtk_binding_reset_parsed:
1657 * Remove all binding sets that were added by gtk_binding_parse_binding().
1660 _gtk_binding_reset_parsed (void)
1662 GSList *slist, *next;
1664 slist = binding_set_list;
1667 GtkBindingSet *binding_set;
1669 binding_set = slist->data;
1672 if (binding_set->parsed)
1674 binding_set_list = g_slist_delete_link (binding_set_list, slist);
1675 binding_set_delete (binding_set);