1 /* GTK - The GIMP Toolkit
2 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
4 * GtkBindingSet: Keybinding manager for GtkObjects.
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>
34 #include "gtkbindings.h"
35 #include "gtkkeyhash.h"
36 #include "gtkwidget.h"
42 #define BINDING_MOD_MASK() (gtk_accelerator_get_default_mod_mask () | GDK_RELEASE_MASK)
45 /* --- structures --- */
55 /* --- variables --- */
56 static GHashTable *binding_entry_hash_table = NULL;
57 static GSList *binding_key_hashes = NULL;
58 static GSList *binding_set_list = NULL;
59 static const gchar key_class_binding_set[] = "gtk-class-binding-set";
60 static GQuark key_id_class_binding_set = 0;
63 /* --- functions --- */
65 pattern_spec_free (PatternSpec *pspec)
67 _gtk_rc_free_widget_class_path (pspec->path);
69 g_pattern_spec_free (pspec->pspec);
73 static GtkBindingSignal*
74 binding_signal_new (const gchar *signal_name,
77 GtkBindingSignal *signal;
79 signal = (GtkBindingSignal *) g_slice_alloc0 (sizeof (GtkBindingSignal) + n_args * sizeof (GtkBindingArg));
81 signal->signal_name = (gchar *)g_intern_string (signal_name);
82 signal->n_args = n_args;
83 signal->args = (GtkBindingArg *)(signal + 1);
89 binding_signal_free (GtkBindingSignal *sig)
93 for (i = 0; i < sig->n_args; i++)
95 if (G_TYPE_FUNDAMENTAL (sig->args[i].arg_type) == G_TYPE_STRING)
96 g_free (sig->args[i].d.string_data);
98 g_slice_free1 (sizeof (GtkBindingSignal) + sig->n_args * sizeof (GtkBindingArg), sig);
102 binding_entry_hash (gconstpointer key)
104 register const GtkBindingEntry *e = key;
114 binding_entries_compare (gconstpointer a,
117 register const GtkBindingEntry *ea = a;
118 register const GtkBindingEntry *eb = b;
120 return (ea->keyval == eb->keyval && ea->modifiers == eb->modifiers);
124 binding_key_hash_insert_entry (GtkKeyHash *key_hash,
125 GtkBindingEntry *entry)
127 guint keyval = entry->keyval;
129 /* We store lowercased accelerators. To deal with this, if <Shift>
130 * was specified, uppercase.
132 if (entry->modifiers & GDK_SHIFT_MASK)
134 if (keyval == GDK_Tab)
135 keyval = GDK_ISO_Left_Tab;
137 keyval = gdk_keyval_to_upper (keyval);
140 _gtk_key_hash_add_entry (key_hash, keyval, entry->modifiers & ~GDK_RELEASE_MASK, entry);
144 binding_key_hash_destroy (gpointer data)
146 GtkKeyHash *key_hash = data;
148 binding_key_hashes = g_slist_remove (binding_key_hashes, key_hash);
149 _gtk_key_hash_free (key_hash);
153 insert_entries_into_key_hash (gpointer key,
157 GtkKeyHash *key_hash = data;
158 GtkBindingEntry *entry = value;
160 for (; entry; entry = entry->hash_next)
161 binding_key_hash_insert_entry (key_hash, entry);
165 binding_key_hash_for_keymap (GdkKeymap *keymap)
167 static GQuark key_hash_quark = 0;
168 GtkKeyHash *key_hash;
171 key_hash_quark = g_quark_from_static_string ("gtk-binding-key-hash");
173 key_hash = g_object_get_qdata (G_OBJECT (keymap), key_hash_quark);
177 key_hash = _gtk_key_hash_new (keymap, NULL);
178 g_object_set_qdata_full (G_OBJECT (keymap), key_hash_quark, key_hash, binding_key_hash_destroy);
180 if (binding_entry_hash_table)
181 g_hash_table_foreach (binding_entry_hash_table,
182 insert_entries_into_key_hash,
185 binding_key_hashes = g_slist_prepend (binding_key_hashes, key_hash);
192 static GtkBindingEntry*
193 binding_entry_new (GtkBindingSet *binding_set,
195 GdkModifierType modifiers)
198 GtkBindingEntry *entry;
200 if (!binding_entry_hash_table)
201 binding_entry_hash_table = g_hash_table_new (binding_entry_hash, binding_entries_compare);
203 entry = g_new (GtkBindingEntry, 1);
204 entry->keyval = keyval;
205 entry->modifiers = modifiers;
206 entry->binding_set = binding_set,
207 entry->destroyed = FALSE;
208 entry->in_emission = FALSE;
209 entry->marks_unbound = FALSE;
210 entry->signals = NULL;
212 entry->set_next = binding_set->entries;
213 binding_set->entries = entry;
215 entry->hash_next = g_hash_table_lookup (binding_entry_hash_table, entry);
216 if (entry->hash_next)
217 g_hash_table_remove (binding_entry_hash_table, entry->hash_next);
218 g_hash_table_insert (binding_entry_hash_table, entry, entry);
220 for (tmp_list = binding_key_hashes; tmp_list; tmp_list = tmp_list->next)
222 GtkKeyHash *key_hash = tmp_list->data;
223 binding_key_hash_insert_entry (key_hash, entry);
230 binding_entry_free (GtkBindingEntry *entry)
232 GtkBindingSignal *sig;
234 g_assert (entry->set_next == NULL &&
235 entry->hash_next == NULL &&
236 entry->in_emission == FALSE &&
237 entry->destroyed == TRUE);
239 entry->destroyed = FALSE;
241 sig = entry->signals;
244 GtkBindingSignal *prev;
248 binding_signal_free (prev);
254 binding_entry_destroy (GtkBindingEntry *entry)
256 GtkBindingEntry *o_entry;
257 register GtkBindingEntry *tmp;
258 GtkBindingEntry *begin;
259 register GtkBindingEntry *last;
262 /* unlink from binding set
265 tmp = entry->binding_set->entries;
271 last->set_next = entry->set_next;
273 entry->binding_set->entries = entry->set_next;
277 tmp = last->set_next;
279 entry->set_next = NULL;
281 o_entry = g_hash_table_lookup (binding_entry_hash_table, entry);
290 last->hash_next = entry->hash_next;
292 begin = entry->hash_next;
296 tmp = last->hash_next;
298 entry->hash_next = NULL;
301 g_hash_table_remove (binding_entry_hash_table, entry);
302 else if (begin != o_entry)
304 g_hash_table_remove (binding_entry_hash_table, entry);
305 g_hash_table_insert (binding_entry_hash_table, begin, begin);
308 for (tmp_list = binding_key_hashes; tmp_list; tmp_list = tmp_list->next)
310 GtkKeyHash *key_hash = tmp_list->data;
311 _gtk_key_hash_remove_entry (key_hash, entry);
314 entry->destroyed = TRUE;
316 if (!entry->in_emission)
317 binding_entry_free (entry);
320 static GtkBindingEntry*
321 binding_ht_lookup_entry (GtkBindingSet *set,
323 GdkModifierType modifiers)
325 GtkBindingEntry lookup_entry = { 0 };
326 GtkBindingEntry *entry;
328 if (!binding_entry_hash_table)
331 lookup_entry.keyval = keyval;
332 lookup_entry.modifiers = modifiers;
334 entry = g_hash_table_lookup (binding_entry_hash_table, &lookup_entry);
335 for (; entry; entry = entry->hash_next)
336 if (entry->binding_set == set)
343 binding_compose_params (GtkObject *object,
353 params = g_new0 (GValue, query->n_params + 1);
356 /* The instance we emit on is the first object in the array
358 g_value_init (params, G_TYPE_OBJECT);
359 g_value_set_object (params, G_OBJECT (object));
362 types = query->param_types;
364 for (i = 1; i < query->n_params + 1 && valid; i++)
366 GValue tmp_value = { 0, };
368 g_value_init (params, *types);
370 switch (G_TYPE_FUNDAMENTAL (args->arg_type))
373 g_value_init (&tmp_value, G_TYPE_DOUBLE);
374 g_value_set_double (&tmp_value, args->d.double_data);
377 g_value_init (&tmp_value, G_TYPE_LONG);
378 g_value_set_long (&tmp_value, args->d.long_data);
381 /* gtk_rc_parse_flags/enum() has fancier parsing for this; we can't call
382 * that since we don't have a GParamSpec, so just do something simple
384 if (G_TYPE_FUNDAMENTAL (*types) == G_TYPE_ENUM)
386 GEnumClass *class = G_ENUM_CLASS (g_type_class_ref (*types));
390 if (args->arg_type == GTK_TYPE_IDENTIFIER)
392 GEnumValue *enum_value = NULL;
393 enum_value = g_enum_get_value_by_name (class, args->d.string_data);
395 enum_value = g_enum_get_value_by_nick (class, args->d.string_data);
398 g_value_init (&tmp_value, *types);
399 g_value_set_enum (&tmp_value, enum_value->value);
404 g_type_class_unref (class);
406 /* This is just a hack for compatibility with GTK+-1.2 where a string
407 * could be used for a single flag value / without the support for multiple
408 * values in gtk_rc_parse_flags(), this isn't very useful.
410 else if (G_TYPE_FUNDAMENTAL (*types) == G_TYPE_FLAGS)
412 GFlagsClass *class = G_FLAGS_CLASS (g_type_class_ref (*types));
416 if (args->arg_type == GTK_TYPE_IDENTIFIER)
418 GFlagsValue *flags_value = NULL;
419 flags_value = g_flags_get_value_by_name (class, args->d.string_data);
421 flags_value = g_flags_get_value_by_nick (class, args->d.string_data);
424 g_value_init (&tmp_value, *types);
425 g_value_set_flags (&tmp_value, flags_value->value);
430 g_type_class_unref (class);
434 g_value_init (&tmp_value, G_TYPE_STRING);
435 g_value_set_static_string (&tmp_value, args->d.string_data);
445 if (!g_value_transform (&tmp_value, params))
448 g_value_unset (&tmp_value);
460 for (j = 0; j < i; j++)
461 g_value_unset (&(*params_p)[j]);
471 gtk_binding_entry_activate (GtkBindingEntry *entry,
474 GtkBindingSignal *sig;
475 gboolean old_emission;
476 gboolean handled = FALSE;
479 old_emission = entry->in_emission;
480 entry->in_emission = TRUE;
482 g_object_ref (object);
484 for (sig = entry->signals; sig; sig = sig->next)
488 GValue *params = NULL;
489 GValue return_val = { 0, };
490 gchar *accelerator = NULL;
492 signal_id = g_signal_lookup (sig->signal_name, G_OBJECT_TYPE (object));
495 accelerator = gtk_accelerator_name (entry->keyval, entry->modifiers);
496 g_warning ("gtk_binding_entry_activate(): binding \"%s::%s\": "
497 "could not find signal \"%s\" in the `%s' class ancestry",
498 entry->binding_set->set_name,
501 g_type_name (G_OBJECT_TYPE (object)));
502 g_free (accelerator);
506 g_signal_query (signal_id, &query);
507 if (query.n_params != sig->n_args ||
508 (query.return_type != G_TYPE_NONE && query.return_type != G_TYPE_BOOLEAN) ||
509 !binding_compose_params (object, sig->args, &query, ¶ms))
511 accelerator = gtk_accelerator_name (entry->keyval, entry->modifiers);
512 g_warning ("gtk_binding_entry_activate(): binding \"%s::%s\": "
513 "signature mismatch for signal \"%s\" in the `%s' class ancestry",
514 entry->binding_set->set_name,
517 g_type_name (G_OBJECT_TYPE (object)));
519 else if (!(query.signal_flags & G_SIGNAL_ACTION))
521 accelerator = gtk_accelerator_name (entry->keyval, entry->modifiers);
522 g_warning ("gtk_binding_entry_activate(): binding \"%s::%s\": "
523 "signal \"%s\" in the `%s' class ancestry cannot be used for action emissions",
524 entry->binding_set->set_name,
527 g_type_name (G_OBJECT_TYPE (object)));
529 g_free (accelerator);
533 if (query.return_type == G_TYPE_BOOLEAN)
534 g_value_init (&return_val, G_TYPE_BOOLEAN);
536 g_signal_emitv (params, signal_id, 0, &return_val);
538 if (query.return_type == G_TYPE_BOOLEAN)
540 if (g_value_get_boolean (&return_val))
542 g_value_unset (&return_val);
547 for (i = 0; i < query.n_params + 1; i++)
548 g_value_unset (¶ms[i]);
551 if (entry->destroyed)
555 g_object_unref (object);
557 entry->in_emission = old_emission;
558 if (entry->destroyed && !entry->in_emission)
559 binding_entry_free (entry);
565 * gtk_binding_set_new:
566 * @set_name: unique name of this binding set
568 * Gtk+ maintains a global list of binding sets. Each binding set has
569 * a unique name which needs to be specified upon creation.
571 * Return value: new binding set
574 gtk_binding_set_new (const gchar *set_name)
576 GtkBindingSet *binding_set;
578 g_return_val_if_fail (set_name != NULL, NULL);
580 binding_set = g_new (GtkBindingSet, 1);
581 binding_set->set_name = (gchar *) g_intern_string (set_name);
582 binding_set->widget_path_pspecs = NULL;
583 binding_set->widget_class_pspecs = NULL;
584 binding_set->class_branch_pspecs = NULL;
585 binding_set->entries = NULL;
586 binding_set->current = NULL;
587 binding_set->parsed = FALSE;
589 binding_set_list = g_slist_prepend (binding_set_list, binding_set);
595 * gtk_binding_set_by_class:
596 * @object_class: a valid #GtkObject class
598 * This function returns the binding set named after the type name of
599 * the passed in class structure. New binding sets are created on
600 * demand by this function.
602 * Return value: the binding set corresponding to @object_class
605 gtk_binding_set_by_class (gpointer object_class)
607 GtkObjectClass *class = object_class;
608 GtkBindingSet* binding_set;
610 g_return_val_if_fail (GTK_IS_OBJECT_CLASS (class), NULL);
612 if (!key_id_class_binding_set)
613 key_id_class_binding_set = g_quark_from_static_string (key_class_binding_set);
615 binding_set = g_dataset_id_get_data (class, key_id_class_binding_set);
620 binding_set = gtk_binding_set_new (g_type_name (G_OBJECT_CLASS_TYPE (class)));
621 gtk_binding_set_add_path (binding_set,
623 g_type_name (G_OBJECT_CLASS_TYPE (class)),
625 g_dataset_id_set_data (class, key_id_class_binding_set, binding_set);
631 * gtk_binding_set_find:
632 * @set_name: unique binding set name
634 * Find a binding set by its globally unique name. The @set_name can
635 * either be a name used for gtk_binding_set_new() or the type name of
636 * a class used in gtk_binding_set_by_class().
638 * Return value: %NULL or the specified binding set
641 gtk_binding_set_find (const gchar *set_name)
645 g_return_val_if_fail (set_name != NULL, NULL);
647 for (slist = binding_set_list; slist; slist = slist->next)
649 GtkBindingSet *binding_set;
651 binding_set = slist->data;
652 if (g_str_equal (binding_set->set_name, (gpointer) set_name))
659 * gtk_binding_set_activate:
660 * @binding_set: @binding_set to activate
661 * @keyval: key value of the binding
662 * @modifiers: key modifier of the binding
663 * @object: object to activate when binding found
665 * Find a key binding matching @keyval and @modifiers within
666 * @binding_set and activate the binding on @object.
668 * Return value: %TRUE if a binding was found and activated
671 gtk_binding_set_activate (GtkBindingSet *binding_set,
673 GdkModifierType modifiers,
676 GtkBindingEntry *entry;
678 g_return_val_if_fail (binding_set != NULL, FALSE);
679 g_return_val_if_fail (GTK_IS_OBJECT (object), FALSE);
681 keyval = gdk_keyval_to_lower (keyval);
682 modifiers = modifiers & BINDING_MOD_MASK ();
684 entry = binding_ht_lookup_entry (binding_set, keyval, modifiers);
686 return gtk_binding_entry_activate (entry, object);
692 * gtk_binding_entry_clear:
697 * Use of this function is deprecated.
700 gtk_binding_entry_clear (GtkBindingSet *binding_set,
702 GdkModifierType modifiers)
704 GtkBindingEntry *entry;
706 g_return_if_fail (binding_set != NULL);
708 keyval = gdk_keyval_to_lower (keyval);
709 modifiers = modifiers & BINDING_MOD_MASK ();
711 entry = binding_ht_lookup_entry (binding_set, keyval, modifiers);
713 binding_entry_destroy (entry);
715 entry = binding_entry_new (binding_set, keyval, modifiers);
719 * gtk_binding_entry_skip:
720 * @binding_set: @binding_set to skip an entry of
721 * @keyval: key value of binding to skip
722 * @modifiers: key modifier of binding to skip
726 * Install a binding on @binding_set which causes key lookups
727 * to be aborted, to prevent bindings from lower priority sets
731 gtk_binding_entry_skip (GtkBindingSet *binding_set,
733 GdkModifierType modifiers)
735 GtkBindingEntry *entry;
737 g_return_if_fail (binding_set != NULL);
739 keyval = gdk_keyval_to_lower (keyval);
740 modifiers = modifiers & BINDING_MOD_MASK ();
742 entry = binding_ht_lookup_entry (binding_set, keyval, modifiers);
744 binding_entry_destroy (entry);
746 entry = binding_entry_new (binding_set, keyval, modifiers);
747 entry->marks_unbound = TRUE;
751 * gtk_binding_entry_remove:
752 * @binding_set: @binding_set to remove an entry of
753 * @keyval: key value of binding to remove
754 * @modifiers: key modifier of binding to remove
756 * Remove a binding previously installed via
757 * gtk_binding_entry_add_signal() on @binding_set.
760 gtk_binding_entry_remove (GtkBindingSet *binding_set,
762 GdkModifierType modifiers)
764 GtkBindingEntry *entry;
766 g_return_if_fail (binding_set != NULL);
768 keyval = gdk_keyval_to_lower (keyval);
769 modifiers = modifiers & BINDING_MOD_MASK ();
771 entry = binding_ht_lookup_entry (binding_set, keyval, modifiers);
773 binding_entry_destroy (entry);
777 * gtk_binding_entry_add_signall:
778 * @binding_set: binding set to add a signal to
780 * @modifiers: key modifier
781 * @signal_name: signal name to be bound
782 * @binding_args: list of #GtkBindingArg signal arguments
787 gtk_binding_entry_add_signall (GtkBindingSet *binding_set,
789 GdkModifierType modifiers,
790 const gchar *signal_name,
791 GSList *binding_args)
793 _gtk_binding_entry_add_signall (binding_set,
795 signal_name, binding_args);
799 _gtk_binding_entry_add_signall (GtkBindingSet *binding_set,
801 GdkModifierType modifiers,
802 const gchar *signal_name,
803 GSList *binding_args)
805 GtkBindingEntry *entry;
806 GtkBindingSignal *signal, **signal_p;
811 g_return_if_fail (binding_set != NULL);
812 g_return_if_fail (signal_name != NULL);
814 keyval = gdk_keyval_to_lower (keyval);
815 modifiers = modifiers & BINDING_MOD_MASK ();
817 signal = binding_signal_new (signal_name, g_slist_length (binding_args));
820 for (slist = binding_args; slist; slist = slist->next)
822 GtkBindingArg *tmp_arg;
824 tmp_arg = slist->data;
827 g_warning ("gtk_binding_entry_add_signall(): arg[%u] is `NULL'", n);
828 binding_signal_free (signal);
831 switch (G_TYPE_FUNDAMENTAL (tmp_arg->arg_type))
834 arg->arg_type = G_TYPE_LONG;
835 arg->d.long_data = tmp_arg->d.long_data;
838 arg->arg_type = G_TYPE_DOUBLE;
839 arg->d.double_data = tmp_arg->d.double_data;
842 if (tmp_arg->arg_type != GTK_TYPE_IDENTIFIER)
843 arg->arg_type = G_TYPE_STRING;
845 arg->arg_type = GTK_TYPE_IDENTIFIER;
846 arg->d.string_data = g_strdup (tmp_arg->d.string_data);
847 if (!arg->d.string_data)
849 g_warning ("gtk_binding_entry_add_signall(): value of `string' arg[%u] is `NULL'", n);
850 binding_signal_free (signal);
855 g_warning ("gtk_binding_entry_add_signall(): unsupported type `%s' for arg[%u]",
856 g_type_name (arg->arg_type), n);
857 binding_signal_free (signal);
864 entry = binding_ht_lookup_entry (binding_set, keyval, modifiers);
867 gtk_binding_entry_add (binding_set, keyval, modifiers);
868 entry = binding_ht_lookup_entry (binding_set, keyval, modifiers);
870 signal_p = &entry->signals;
872 signal_p = &(*signal_p)->next;
877 * gtk_binding_entry_add_signal:
878 * @binding_set: @binding_set to install an entry for
879 * @keyval: key value of binding to install
880 * @modifiers: key modifier of binding to install
881 * @signal_name: signal to execute upon activation
882 * @n_args: number of arguments to @signal_name
883 * @: arguments to @signal_name
885 * Override or install a new key binding for @keyval with @modifiers on
886 * @binding_set. When the binding is activated, @signal_name will be
887 * emitted on the target widget, with @n_args @Varargs used as
891 gtk_binding_entry_add_signal (GtkBindingSet *binding_set,
893 GdkModifierType modifiers,
894 const gchar *signal_name,
898 GSList *slist, *free_slist;
902 g_return_if_fail (binding_set != NULL);
903 g_return_if_fail (signal_name != NULL);
905 va_start (args, n_args);
907 for (i = 0; i < n_args; i++)
911 arg = g_slice_new0 (GtkBindingArg);
912 slist = g_slist_prepend (slist, arg);
914 arg->arg_type = va_arg (args, GtkType);
915 switch (G_TYPE_FUNDAMENTAL (arg->arg_type))
917 /* for elaborated commenting about var args collection, take a look
918 * at gtk_arg_collect_value() in gtkargcollector.c
927 arg->arg_type = G_TYPE_LONG;
928 arg->d.long_data = va_arg (args, gint);
932 arg->arg_type = G_TYPE_LONG;
933 arg->d.long_data = va_arg (args, glong);
937 arg->arg_type = G_TYPE_DOUBLE;
938 arg->d.double_data = va_arg (args, gdouble);
941 if (arg->arg_type != GTK_TYPE_IDENTIFIER)
942 arg->arg_type = G_TYPE_STRING;
943 arg->d.string_data = va_arg (args, gchar*);
944 if (!arg->d.string_data)
946 g_warning ("gtk_binding_entry_add_signal(): type `%s' arg[%u] is `NULL'",
947 g_type_name (arg->arg_type),
953 g_warning ("gtk_binding_entry_add_signal(): unsupported type `%s' for arg[%u]",
954 g_type_name (arg->arg_type), i);
961 if (i == n_args || i == 0)
963 slist = g_slist_reverse (slist);
964 gtk_binding_entry_add_signall (binding_set, keyval, modifiers, signal_name, slist);
970 g_slice_free (GtkBindingArg, slist->data);
973 g_slist_free (free_slist);
977 * gtk_binding_set_add_path:
978 * @binding_set: binding set to add a path to
979 * @path_type: path type the pattern applies to
980 * @path_pattern: the actual match pattern
981 * @priority: binding priority
983 * This function is used internally by the GtkRC parsing mechanism to
984 * assign match patterns to #GtkBindingSet structures.
987 gtk_binding_set_add_path (GtkBindingSet *binding_set,
988 GtkPathType path_type,
989 const gchar *path_pattern,
990 GtkPathPriorityType priority)
993 GSList **slist_p, *slist;
994 static guint seq_id = 0;
996 g_return_if_fail (binding_set != NULL);
997 g_return_if_fail (path_pattern != NULL);
998 g_return_if_fail (priority <= GTK_PATH_PRIO_MASK);
1000 priority &= GTK_PATH_PRIO_MASK;
1004 case GTK_PATH_WIDGET:
1005 slist_p = &binding_set->widget_path_pspecs;
1007 case GTK_PATH_WIDGET_CLASS:
1008 slist_p = &binding_set->widget_class_pspecs;
1010 case GTK_PATH_CLASS:
1011 slist_p = &binding_set->class_branch_pspecs;
1014 g_assert_not_reached ();
1019 pspec = g_new (PatternSpec, 1);
1020 pspec->type = path_type;
1021 if (path_type == GTK_PATH_WIDGET_CLASS)
1023 pspec->pspec = NULL;
1024 pspec->path = _gtk_rc_parse_widget_class_path (path_pattern);
1028 pspec->pspec = g_pattern_spec_new (path_pattern);
1032 pspec->seq_id = priority << 28;
1033 pspec->user_data = binding_set;
1038 PatternSpec *tmp_pspec;
1040 tmp_pspec = slist->data;
1041 slist = slist->next;
1043 if (g_pattern_spec_equal (tmp_pspec->pspec, pspec->pspec))
1045 GtkPathPriorityType lprio = tmp_pspec->seq_id >> 28;
1047 pattern_spec_free (pspec);
1049 if (lprio < priority)
1051 tmp_pspec->seq_id &= 0x0fffffff;
1052 tmp_pspec->seq_id |= priority << 28;
1059 pspec->seq_id |= seq_id++ & 0x0fffffff;
1060 *slist_p = g_slist_prepend (*slist_p, pspec);
1065 binding_match_activate (GSList *pspec_list,
1069 gchar *path_reversed,
1076 for (slist = pspec_list; slist; slist = slist->next)
1079 GtkBindingSet *binding_set;
1082 pspec = slist->data;
1084 if (pspec->type == GTK_PATH_WIDGET_CLASS)
1086 if (_gtk_rc_match_widget_class (pspec->path, path_length, path, path_reversed))
1087 binding_set = pspec->user_data;
1091 if (g_pattern_match (pspec->pspec, path_length, path, path_reversed))
1092 binding_set = pspec->user_data;
1097 if (binding_set->current->marks_unbound)
1103 if (gtk_binding_entry_activate (binding_set->current, object))
1112 gtk_binding_pattern_compare (gconstpointer new_pattern,
1113 gconstpointer existing_pattern)
1115 register const PatternSpec *np = new_pattern;
1116 register const PatternSpec *ep = existing_pattern;
1118 /* walk the list as long as the existing patterns have
1119 * higher priorities.
1122 return np->seq_id < ep->seq_id;
1126 gtk_binding_entries_sort_patterns (GSList *entries,
1127 GtkPathType path_id,
1128 gboolean is_release)
1134 for (tmp_list = entries; tmp_list; tmp_list = tmp_list->next)
1136 GtkBindingEntry *entry = tmp_list->data;
1137 GtkBindingSet *binding_set;
1139 binding_set = entry->binding_set;
1140 binding_set->current = NULL;
1143 for (; entries; entries = entries->next)
1145 GtkBindingEntry *entry = entries->data;
1146 GtkBindingSet *binding_set;
1147 GSList *slist = NULL;
1149 if (is_release != ((entry->modifiers & GDK_RELEASE_MASK) != 0))
1152 binding_set = entry->binding_set;
1154 if (binding_set->current)
1156 binding_set->current = entry;
1160 case GTK_PATH_WIDGET:
1161 slist = binding_set->widget_path_pspecs;
1163 case GTK_PATH_WIDGET_CLASS:
1164 slist = binding_set->widget_class_pspecs;
1166 case GTK_PATH_CLASS:
1167 slist = binding_set->class_branch_pspecs;
1171 for (; slist; slist = slist->next)
1175 pspec = slist->data;
1176 patterns = g_slist_insert_sorted (patterns, pspec, gtk_binding_pattern_compare);
1184 gtk_bindings_activate_list (GtkObject *object,
1186 gboolean is_release)
1188 GtkWidget *widget = GTK_WIDGET (object);
1189 gboolean handled = FALSE;
1197 gchar *path, *path_reversed;
1201 gtk_widget_path (widget, &path_length, &path, &path_reversed);
1202 patterns = gtk_binding_entries_sort_patterns (entries, GTK_PATH_WIDGET, is_release);
1203 handled = binding_match_activate (patterns, object, path_length, path, path_reversed, &unbound);
1204 g_slist_free (patterns);
1206 g_free (path_reversed);
1215 gchar *path, *path_reversed;
1219 gtk_widget_class_path (widget, &path_length, &path, &path_reversed);
1220 patterns = gtk_binding_entries_sort_patterns (entries, GTK_PATH_WIDGET_CLASS, is_release);
1221 handled = binding_match_activate (patterns, object, path_length, path, path_reversed, &unbound);
1222 g_slist_free (patterns);
1224 g_free (path_reversed);
1234 gboolean unbound = FALSE;
1236 patterns = gtk_binding_entries_sort_patterns (entries, GTK_PATH_CLASS, is_release);
1237 class_type = G_TYPE_FROM_INSTANCE (object);
1238 while (class_type && !handled)
1242 gchar *path_reversed;
1244 path = g_strdup (g_type_name (class_type));
1245 path_reversed = g_strdup (path);
1246 g_strreverse (path_reversed);
1247 path_length = strlen (path);
1248 handled = binding_match_activate (patterns, object, path_length, path, path_reversed, &unbound);
1250 g_free (path_reversed);
1255 class_type = g_type_parent (class_type);
1257 g_slist_free (patterns);
1267 * gtk_bindings_activate:
1268 * @object: object to activate when binding found
1269 * @keyval: key value of the binding
1270 * @modifiers: key modifier of the binding
1272 * Find a key binding matching @keyval and @modifiers and activate the
1273 * binding on @object.
1275 * Return value: %TRUE if a binding was found and activated
1278 gtk_bindings_activate (GtkObject *object,
1280 GdkModifierType modifiers)
1282 GSList *entries = NULL;
1283 GdkDisplay *display;
1284 GtkKeyHash *key_hash;
1285 gboolean handled = FALSE;
1286 gboolean is_release;
1288 g_return_val_if_fail (GTK_IS_OBJECT (object), FALSE);
1290 if (!GTK_IS_WIDGET (object))
1293 is_release = (modifiers & GDK_RELEASE_MASK) != 0;
1294 modifiers = modifiers & BINDING_MOD_MASK () & ~GDK_RELEASE_MASK;
1296 display = gtk_widget_get_display (GTK_WIDGET (object));
1297 key_hash = binding_key_hash_for_keymap (gdk_keymap_get_for_display (display));
1299 entries = _gtk_key_hash_lookup_keyval (key_hash, keyval, modifiers);
1301 handled = gtk_bindings_activate_list (object, entries, is_release);
1303 g_slist_free (entries);
1309 * gtk_bindings_activate_event:
1310 * @object: a #GtkObject (generally must be a widget)
1311 * @event: a #GdkEventKey
1313 * Looks up key bindings for @object to find one matching
1314 * @event, and if one was found, activate it.
1316 * Return value: %TRUE if a matching key binding was found
1319 gtk_bindings_activate_event (GtkObject *object,
1322 GSList *entries = NULL;
1323 GdkDisplay *display;
1324 GtkKeyHash *key_hash;
1325 gboolean handled = FALSE;
1327 g_return_val_if_fail (GTK_IS_OBJECT (object), FALSE);
1329 if (!GTK_IS_WIDGET (object))
1332 display = gtk_widget_get_display (GTK_WIDGET (object));
1333 key_hash = binding_key_hash_for_keymap (gdk_keymap_get_for_display (display));
1335 entries = _gtk_key_hash_lookup (key_hash,
1336 event->hardware_keycode,
1338 BINDING_MOD_MASK () & ~GDK_RELEASE_MASK,
1341 handled = gtk_bindings_activate_list (object, entries,
1342 event->type == GDK_KEY_RELEASE);
1344 g_slist_free (entries);
1350 gtk_binding_parse_signal (GScanner *scanner,
1351 GtkBindingSet *binding_set,
1353 GdkModifierType modifiers)
1356 guint expected_token = 0;
1362 gboolean seen_comma;
1364 g_return_val_if_fail (scanner != NULL, G_TOKEN_ERROR);
1366 g_scanner_get_next_token (scanner);
1367 if (scanner->token != G_TOKEN_STRING)
1368 return G_TOKEN_STRING;
1369 g_scanner_peek_next_token (scanner);
1370 if (scanner->next_token != '(')
1372 g_scanner_get_next_token (scanner);
1375 signal = g_strdup (scanner->value.v_string);
1376 g_scanner_get_next_token (scanner);
1383 scanner->config->scan_symbols = FALSE;
1387 expected_token = G_TOKEN_INT;
1389 expected_token = ')';
1390 g_scanner_get_next_token (scanner);
1391 switch (scanner->token)
1399 arg = g_new (GtkBindingArg, 1);
1400 arg->arg_type = G_TYPE_DOUBLE;
1401 arg->d.double_data = scanner->value.v_float;
1404 arg->d.double_data = - arg->d.double_data;
1407 args = g_slist_prepend (args, arg);
1416 arg = g_new (GtkBindingArg, 1);
1417 arg->arg_type = G_TYPE_LONG;
1418 arg->d.long_data = scanner->value.v_int;
1421 arg->d.long_data = - arg->d.long_data;
1424 args = g_slist_prepend (args, arg);
1429 case G_TOKEN_STRING:
1430 if (need_arg && !negate)
1433 arg = g_new (GtkBindingArg, 1);
1434 arg->arg_type = G_TYPE_STRING;
1435 arg->d.string_data = g_strdup (scanner->value.v_string);
1436 args = g_slist_prepend (args, arg);
1441 case G_TOKEN_IDENTIFIER:
1442 if (need_arg && !negate)
1445 arg = g_new (GtkBindingArg, 1);
1446 arg->arg_type = GTK_TYPE_IDENTIFIER;
1447 arg->d.string_data = g_strdup (scanner->value.v_identifier);
1448 args = g_slist_prepend (args, arg);
1458 expected_token = G_TOKEN_INT;
1472 if (!(need_arg && seen_comma) && !negate)
1474 args = g_slist_reverse (args);
1475 gtk_binding_entry_add_signall (binding_set,
1480 expected_token = G_TOKEN_NONE;
1490 scanner->config->scan_symbols = TRUE;
1492 for (slist = args; slist; slist = slist->next)
1497 if (G_TYPE_FUNDAMENTAL (arg->arg_type) == G_TYPE_STRING)
1498 g_free (arg->d.string_data);
1501 g_slist_free (args);
1504 return expected_token;
1508 gtk_binding_parse_bind (GScanner *scanner,
1509 GtkBindingSet *binding_set)
1512 GdkModifierType modifiers = 0;
1513 gboolean unbind = FALSE;
1515 g_return_val_if_fail (scanner != NULL, G_TOKEN_ERROR);
1517 g_scanner_get_next_token (scanner);
1518 if (scanner->token != GTK_RC_TOKEN_BIND &&
1519 scanner->token != GTK_RC_TOKEN_UNBIND)
1520 return GTK_RC_TOKEN_BIND;
1521 unbind = scanner->token == GTK_RC_TOKEN_UNBIND;
1522 g_scanner_get_next_token (scanner);
1523 if (scanner->token != G_TOKEN_STRING)
1524 return G_TOKEN_STRING;
1525 gtk_accelerator_parse (scanner->value.v_string, &keyval, &modifiers);
1526 modifiers &= BINDING_MOD_MASK ();
1528 return G_TOKEN_STRING;
1532 gtk_binding_entry_skip (binding_set, keyval, modifiers);
1533 return G_TOKEN_NONE;
1536 g_scanner_get_next_token (scanner);
1538 if (scanner->token != '{')
1541 gtk_binding_entry_clear (binding_set, keyval, modifiers);
1543 g_scanner_peek_next_token (scanner);
1544 while (scanner->next_token != '}')
1546 switch (scanner->next_token)
1548 guint expected_token;
1550 case G_TOKEN_STRING:
1551 expected_token = gtk_binding_parse_signal (scanner,
1555 if (expected_token != G_TOKEN_NONE)
1556 return expected_token;
1559 g_scanner_get_next_token (scanner);
1562 g_scanner_peek_next_token (scanner);
1564 g_scanner_get_next_token (scanner);
1566 return G_TOKEN_NONE;
1570 * gtk_binding_parse_binding:
1571 * @scanner: GtkRC scanner
1573 * Deprecated as public API, used only internally.
1575 * Return value: expected token upon errors, %G_TOKEN_NONE on success.
1578 gtk_binding_parse_binding (GScanner *scanner)
1580 return _gtk_binding_parse_binding (scanner);
1584 _gtk_binding_parse_binding (GScanner *scanner)
1587 GtkBindingSet *binding_set;
1589 g_return_val_if_fail (scanner != NULL, G_TOKEN_ERROR);
1591 g_scanner_get_next_token (scanner);
1592 if (scanner->token != GTK_RC_TOKEN_BINDING)
1593 return GTK_RC_TOKEN_BINDING;
1594 g_scanner_get_next_token (scanner);
1595 if (scanner->token != G_TOKEN_STRING)
1596 return G_TOKEN_STRING;
1597 name = g_strdup (scanner->value.v_string);
1599 g_scanner_get_next_token (scanner);
1600 if (scanner->token != '{')
1603 return G_TOKEN_STRING;
1606 binding_set = gtk_binding_set_find (name);
1609 binding_set = gtk_binding_set_new (name);
1610 binding_set->parsed = 1;
1614 g_scanner_peek_next_token (scanner);
1615 while (scanner->next_token != '}')
1617 switch (scanner->next_token)
1619 guint expected_token;
1621 case GTK_RC_TOKEN_BIND:
1622 case GTK_RC_TOKEN_UNBIND:
1623 expected_token = gtk_binding_parse_bind (scanner, binding_set);
1624 if (expected_token != G_TOKEN_NONE)
1625 return expected_token;
1628 g_scanner_get_next_token (scanner);
1631 g_scanner_peek_next_token (scanner);
1633 g_scanner_get_next_token (scanner);
1635 return G_TOKEN_NONE;
1639 free_pattern_specs (GSList *pattern_specs)
1643 for (slist = pattern_specs; slist; slist = slist->next)
1647 pspec = slist->data;
1649 pattern_spec_free (pspec);
1652 g_slist_free (pattern_specs);
1656 binding_set_delete (GtkBindingSet *binding_set)
1658 GtkBindingEntry *entry, *next;
1660 entry = binding_set->entries;
1663 next = entry->set_next;
1664 binding_entry_destroy (entry);
1668 free_pattern_specs (binding_set->widget_path_pspecs);
1669 free_pattern_specs (binding_set->widget_class_pspecs);
1670 free_pattern_specs (binding_set->class_branch_pspecs);
1672 g_free (binding_set);
1676 * _gtk_binding_reset_parsed:
1678 * Removing all binding sets that were added by
1679 * gtk_binding_parse_binding()
1682 _gtk_binding_reset_parsed (void)
1684 GSList *slist, *next;
1686 slist = binding_set_list;
1689 GtkBindingSet *binding_set;
1691 binding_set = slist->data;
1694 if (binding_set->parsed)
1696 binding_set_list = g_slist_delete_link (binding_set_list, slist);
1697 binding_set_delete (binding_set);
1705 _gtk_binding_signal_new (const gchar *signal_name,
1707 GSignalFlags signal_flags,
1709 GSignalAccumulator accumulator,
1711 GSignalCMarshaller c_marshaller,
1719 g_return_val_if_fail (signal_name != NULL, 0);
1721 va_start (args, n_params);
1723 signal_id = g_signal_new_valist (signal_name, itype, signal_flags,
1724 g_cclosure_new (handler, NULL, NULL),
1725 accumulator, accu_data, c_marshaller,
1726 return_type, n_params, args);
1733 #define __GTK_BINDINGS_C__
1734 #include "gtkaliasdef.c"