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/.
34 #include "gtkbindingsprivate.h"
35 #include "gtkkeyhash.h"
36 #include "gtkwidget.h"
43 * @Short_description: Key bindings for individual widgets
44 * @See_also: <link linkend="gtk-keyboard-accelerators">Keyboard Accelerators</link>, #GtkCssProvider
46 * GtkBinding provides a mechanism for configuring GTK+ key bindings
47 * through CSS files. This eases key binding adjustments for application
48 * developers as well as users and provides GTK+ users or administrators
49 * with high key binding configurability which requires no application
50 * or toolkit side changes.
52 * <refsect2 id="gtk-bindings-install">
53 * <title>Installing a key binding</title>
55 * A CSS file binding consists of a 'binding-set' definition and a match
56 * statement to apply the binding set to specific widget types. Details
57 * on the matching mechanism are described under
58 * <link linkend="gtkcssprovider-selectors">Selectors</link>
59 * in the #GtkCssProvider documentation. Inside the binding-set definition,
60 * key combinations are bound to one or more specific signal emissions on
61 * the target widget. Key combinations are strings consisting of an optional
62 * #GdkModifierType name and <link linkend="gdk-Keyboard-Handling">key names</link>
63 * such as those defined in <filename><gdk/gdkkeysyms.h></filename>
64 * or returned from gdk_keyval_name(), they have to be parsable by
65 * gtk_accelerator_parse(). Specifications of signal emissions consist
66 * of a string identifying the signal name, and a list of signal specific
67 * arguments in parenthesis.
70 * For example for binding Control and the left or right cursor keys
71 * of a #GtkEntry widget to the #GtkEntry::move-cursor signal (so movement
72 * occurs in 3-character steps), the following binding can be used:
73 * <informalexample><programlisting>
74 * @binding-set "MoveCursor3"
76 * bind "<Control>Right" { "move-cursor" (visual-positions, 3, 0) };
77 * bind "<Control>Left" { "move-cursor" (visual-positions, -3, 0) };
81 * gtk-key-bindings: MoveCursor3
83 * </programlisting></informalexample>
86 * <refsect2 id="gtk-bindings-unbind">
87 * <title>Unbinding existing key bindings</title>
89 * GTK+ already defines a number of useful bindings for the widgets
90 * it provides. Because custom bindings set up in CSS files take
91 * precedence over the default bindings shipped with GTK+, overriding
92 * existing bindings as demonstrated in
93 * <link linkend="gtk-bindings-install">Installing a key binding</link>
94 * works as expected. The same mechanism can not be used to "unbind"
95 * existing bindings, however.
96 * <informalexample><programlisting>
97 * @binding-set "MoveCursor3"
99 * bind "<Control>Right" { };
100 * bind "<Control>Left" { };
104 * gtk-key-bindings: MoveCursor3
106 * </programlisting></informalexample>
107 * The above example will not have the desired effect of causing
108 * "<Control>Right" and "<Control>Left" key presses to
109 * be ignored by GTK+. Instead, it just causes any existing bindings
110 * from the bindings set "MoveCursor3" to be deleted, so when
111 * "<Control>Right" or "<Control>Left" are pressed, no
112 * binding for these keys is found in binding set "MoveCursor3".
113 * GTK+ will thus continue to search for matching key bindings, and will
114 * eventually lookup and find the default GTK+ bindings for entries which
115 * implement word movement. To keep GTK+ from activating its default
116 * bindings, the "unbind" keyword can be used like this:
117 * <informalexample><programlisting>
118 * @binding-set "MoveCursor3"
120 * unbind "<Control>Right";
121 * unbind "<Control>Left";
125 * gtk-key-bindings: MoveCursor3
127 * </programlisting></informalexample>
128 * Now, GTK+ will find a match when looking up "<Control>Right"
129 * and "<Control>Left" key presses before it resorts to its default
130 * bindings, and the match instructs it to abort ("unbind") the search,
131 * so the key presses are not consumed by this widget. As usual, further
132 * processing of the key presses, e.g. by an entry's parent widget, is
137 /* --- defines --- */
138 #define BINDING_MOD_MASK() (gtk_accelerator_get_default_mod_mask () | GDK_RELEASE_MASK)
141 #define GTK_TYPE_IDENTIFIER (gtk_identifier_get_type ())
142 GType gtk_identifier_get_type (void) G_GNUC_CONST;
145 /* --- structures --- */
154 GTK_BINDING_TOKEN_BIND,
155 GTK_BINDING_TOKEN_UNBIND
158 /* --- variables --- */
159 static GHashTable *binding_entry_hash_table = NULL;
160 static GSList *binding_key_hashes = NULL;
161 static GSList *binding_set_list = NULL;
162 static const gchar key_class_binding_set[] = "gtk-class-binding-set";
163 static GQuark key_id_class_binding_set = 0;
166 /* --- functions --- */
168 gtk_identifier_get_type (void)
170 static GType our_type = 0;
174 GTypeInfo tinfo = { 0, };
175 our_type = g_type_register_static (G_TYPE_STRING, I_("GtkIdentifier"), &tinfo, 0);
182 pattern_spec_free (PatternSpec *pspec)
185 g_pattern_spec_free (pspec->pspec);
189 static GtkBindingSignal*
190 binding_signal_new (const gchar *signal_name,
193 GtkBindingSignal *signal;
195 signal = (GtkBindingSignal *) g_slice_alloc0 (sizeof (GtkBindingSignal) + n_args * sizeof (GtkBindingArg));
197 signal->signal_name = (gchar *)g_intern_string (signal_name);
198 signal->n_args = n_args;
199 signal->args = (GtkBindingArg *)(signal + 1);
205 binding_signal_free (GtkBindingSignal *sig)
209 for (i = 0; i < sig->n_args; i++)
211 if (G_TYPE_FUNDAMENTAL (sig->args[i].arg_type) == G_TYPE_STRING)
212 g_free (sig->args[i].d.string_data);
214 g_slice_free1 (sizeof (GtkBindingSignal) + sig->n_args * sizeof (GtkBindingArg), sig);
218 binding_entry_hash (gconstpointer key)
220 register const GtkBindingEntry *e = key;
230 binding_entries_compare (gconstpointer a,
233 register const GtkBindingEntry *ea = a;
234 register const GtkBindingEntry *eb = b;
236 return (ea->keyval == eb->keyval && ea->modifiers == eb->modifiers);
240 binding_key_hash_insert_entry (GtkKeyHash *key_hash,
241 GtkBindingEntry *entry)
243 guint keyval = entry->keyval;
245 /* We store lowercased accelerators. To deal with this, if <Shift>
246 * was specified, uppercase.
248 if (entry->modifiers & GDK_SHIFT_MASK)
250 if (keyval == GDK_KEY_Tab)
251 keyval = GDK_KEY_ISO_Left_Tab;
253 keyval = gdk_keyval_to_upper (keyval);
256 _gtk_key_hash_add_entry (key_hash, keyval, entry->modifiers & ~GDK_RELEASE_MASK, entry);
260 binding_key_hash_destroy (gpointer data)
262 GtkKeyHash *key_hash = data;
264 binding_key_hashes = g_slist_remove (binding_key_hashes, key_hash);
265 _gtk_key_hash_free (key_hash);
269 insert_entries_into_key_hash (gpointer key,
273 GtkKeyHash *key_hash = data;
274 GtkBindingEntry *entry = value;
276 for (; entry; entry = entry->hash_next)
277 binding_key_hash_insert_entry (key_hash, entry);
281 binding_key_hash_for_keymap (GdkKeymap *keymap)
283 static GQuark key_hash_quark = 0;
284 GtkKeyHash *key_hash;
287 key_hash_quark = g_quark_from_static_string ("gtk-binding-key-hash");
289 key_hash = g_object_get_qdata (G_OBJECT (keymap), key_hash_quark);
293 key_hash = _gtk_key_hash_new (keymap, NULL);
294 g_object_set_qdata_full (G_OBJECT (keymap), key_hash_quark, key_hash, binding_key_hash_destroy);
296 if (binding_entry_hash_table)
297 g_hash_table_foreach (binding_entry_hash_table,
298 insert_entries_into_key_hash,
301 binding_key_hashes = g_slist_prepend (binding_key_hashes, key_hash);
308 static GtkBindingEntry*
309 binding_entry_new (GtkBindingSet *binding_set,
311 GdkModifierType modifiers)
314 GtkBindingEntry *entry;
316 if (!binding_entry_hash_table)
317 binding_entry_hash_table = g_hash_table_new (binding_entry_hash, binding_entries_compare);
319 entry = g_new (GtkBindingEntry, 1);
320 entry->keyval = keyval;
321 entry->modifiers = modifiers;
322 entry->binding_set = binding_set,
323 entry->destroyed = FALSE;
324 entry->in_emission = FALSE;
325 entry->marks_unbound = FALSE;
326 entry->signals = NULL;
328 entry->set_next = binding_set->entries;
329 binding_set->entries = entry;
331 entry->hash_next = g_hash_table_lookup (binding_entry_hash_table, entry);
332 if (entry->hash_next)
333 g_hash_table_remove (binding_entry_hash_table, entry->hash_next);
334 g_hash_table_insert (binding_entry_hash_table, entry, entry);
336 for (tmp_list = binding_key_hashes; tmp_list; tmp_list = tmp_list->next)
338 GtkKeyHash *key_hash = tmp_list->data;
339 binding_key_hash_insert_entry (key_hash, entry);
346 binding_entry_free (GtkBindingEntry *entry)
348 GtkBindingSignal *sig;
350 g_assert (entry->set_next == NULL &&
351 entry->hash_next == NULL &&
352 entry->in_emission == FALSE &&
353 entry->destroyed == TRUE);
355 entry->destroyed = FALSE;
357 sig = entry->signals;
360 GtkBindingSignal *prev;
364 binding_signal_free (prev);
370 binding_entry_destroy (GtkBindingEntry *entry)
372 GtkBindingEntry *o_entry;
373 register GtkBindingEntry *tmp;
374 GtkBindingEntry *begin;
375 register GtkBindingEntry *last;
378 /* unlink from binding set
381 tmp = entry->binding_set->entries;
387 last->set_next = entry->set_next;
389 entry->binding_set->entries = entry->set_next;
393 tmp = last->set_next;
395 entry->set_next = NULL;
397 o_entry = g_hash_table_lookup (binding_entry_hash_table, entry);
406 last->hash_next = entry->hash_next;
408 begin = entry->hash_next;
412 tmp = last->hash_next;
414 entry->hash_next = NULL;
417 g_hash_table_remove (binding_entry_hash_table, entry);
418 else if (begin != o_entry)
420 g_hash_table_remove (binding_entry_hash_table, entry);
421 g_hash_table_insert (binding_entry_hash_table, begin, begin);
424 for (tmp_list = binding_key_hashes; tmp_list; tmp_list = tmp_list->next)
426 GtkKeyHash *key_hash = tmp_list->data;
427 _gtk_key_hash_remove_entry (key_hash, entry);
430 entry->destroyed = TRUE;
432 if (!entry->in_emission)
433 binding_entry_free (entry);
436 static GtkBindingEntry*
437 binding_ht_lookup_entry (GtkBindingSet *set,
439 GdkModifierType modifiers)
441 GtkBindingEntry lookup_entry = { 0 };
442 GtkBindingEntry *entry;
444 if (!binding_entry_hash_table)
447 lookup_entry.keyval = keyval;
448 lookup_entry.modifiers = modifiers;
450 entry = g_hash_table_lookup (binding_entry_hash_table, &lookup_entry);
451 for (; entry; entry = entry->hash_next)
452 if (entry->binding_set == set)
459 binding_compose_params (GObject *object,
469 params = g_new0 (GValue, query->n_params + 1);
472 /* The instance we emit on is the first object in the array
474 g_value_init (params, G_TYPE_OBJECT);
475 g_value_set_object (params, G_OBJECT (object));
478 types = query->param_types;
480 for (i = 1; i < query->n_params + 1 && valid; i++)
482 GValue tmp_value = { 0, };
484 g_value_init (params, *types);
486 switch (G_TYPE_FUNDAMENTAL (args->arg_type))
489 g_value_init (&tmp_value, G_TYPE_DOUBLE);
490 g_value_set_double (&tmp_value, args->d.double_data);
493 g_value_init (&tmp_value, G_TYPE_LONG);
494 g_value_set_long (&tmp_value, args->d.long_data);
497 /* gtk_rc_parse_flags/enum() has fancier parsing for this; we can't call
498 * that since we don't have a GParamSpec, so just do something simple
500 if (G_TYPE_FUNDAMENTAL (*types) == G_TYPE_ENUM)
502 GEnumClass *class = G_ENUM_CLASS (g_type_class_ref (*types));
506 if (args->arg_type == GTK_TYPE_IDENTIFIER)
508 GEnumValue *enum_value = NULL;
509 enum_value = g_enum_get_value_by_name (class, args->d.string_data);
511 enum_value = g_enum_get_value_by_nick (class, args->d.string_data);
514 g_value_init (&tmp_value, *types);
515 g_value_set_enum (&tmp_value, enum_value->value);
520 g_type_class_unref (class);
522 /* This is just a hack for compatibility with GTK+-1.2 where a string
523 * could be used for a single flag value / without the support for multiple
524 * values in gtk_rc_parse_flags(), this isn't very useful.
526 else if (G_TYPE_FUNDAMENTAL (*types) == G_TYPE_FLAGS)
528 GFlagsClass *class = G_FLAGS_CLASS (g_type_class_ref (*types));
532 if (args->arg_type == GTK_TYPE_IDENTIFIER)
534 GFlagsValue *flags_value = NULL;
535 flags_value = g_flags_get_value_by_name (class, args->d.string_data);
537 flags_value = g_flags_get_value_by_nick (class, args->d.string_data);
540 g_value_init (&tmp_value, *types);
541 g_value_set_flags (&tmp_value, flags_value->value);
546 g_type_class_unref (class);
550 g_value_init (&tmp_value, G_TYPE_STRING);
551 g_value_set_static_string (&tmp_value, args->d.string_data);
561 if (!g_value_transform (&tmp_value, params))
564 g_value_unset (&tmp_value);
576 for (j = 0; j < i; j++)
577 g_value_unset (&(*params_p)[j]);
587 gtk_binding_entry_activate (GtkBindingEntry *entry,
590 GtkBindingSignal *sig;
591 gboolean old_emission;
592 gboolean handled = FALSE;
595 old_emission = entry->in_emission;
596 entry->in_emission = TRUE;
598 g_object_ref (object);
600 for (sig = entry->signals; sig; sig = sig->next)
604 GValue *params = NULL;
605 GValue return_val = { 0, };
606 gchar *accelerator = NULL;
608 signal_id = g_signal_lookup (sig->signal_name, G_OBJECT_TYPE (object));
611 accelerator = gtk_accelerator_name (entry->keyval, entry->modifiers);
612 g_warning ("gtk_binding_entry_activate(): binding \"%s::%s\": "
613 "could not find signal \"%s\" in the `%s' class ancestry",
614 entry->binding_set->set_name,
617 g_type_name (G_OBJECT_TYPE (object)));
618 g_free (accelerator);
622 g_signal_query (signal_id, &query);
623 if (query.n_params != sig->n_args ||
624 (query.return_type != G_TYPE_NONE && query.return_type != G_TYPE_BOOLEAN) ||
625 !binding_compose_params (object, sig->args, &query, ¶ms))
627 accelerator = gtk_accelerator_name (entry->keyval, entry->modifiers);
628 g_warning ("gtk_binding_entry_activate(): binding \"%s::%s\": "
629 "signature mismatch for signal \"%s\" in the `%s' class ancestry",
630 entry->binding_set->set_name,
633 g_type_name (G_OBJECT_TYPE (object)));
635 else if (!(query.signal_flags & G_SIGNAL_ACTION))
637 accelerator = gtk_accelerator_name (entry->keyval, entry->modifiers);
638 g_warning ("gtk_binding_entry_activate(): binding \"%s::%s\": "
639 "signal \"%s\" in the `%s' class ancestry cannot be used for action emissions",
640 entry->binding_set->set_name,
643 g_type_name (G_OBJECT_TYPE (object)));
645 g_free (accelerator);
649 if (query.return_type == G_TYPE_BOOLEAN)
650 g_value_init (&return_val, G_TYPE_BOOLEAN);
652 g_signal_emitv (params, signal_id, 0, &return_val);
654 if (query.return_type == G_TYPE_BOOLEAN)
656 if (g_value_get_boolean (&return_val))
658 g_value_unset (&return_val);
663 for (i = 0; i < query.n_params + 1; i++)
664 g_value_unset (¶ms[i]);
667 if (entry->destroyed)
671 g_object_unref (object);
673 entry->in_emission = old_emission;
674 if (entry->destroyed && !entry->in_emission)
675 binding_entry_free (entry);
681 * gtk_binding_set_new: (skip)
682 * @set_name: unique name of this binding set
684 * GTK+ maintains a global list of binding sets. Each binding set has
685 * a unique name which needs to be specified upon creation.
687 * Return value: (transfer full): new binding set
690 gtk_binding_set_new (const gchar *set_name)
692 GtkBindingSet *binding_set;
694 g_return_val_if_fail (set_name != NULL, NULL);
696 binding_set = g_new (GtkBindingSet, 1);
697 binding_set->set_name = (gchar *) g_intern_string (set_name);
698 binding_set->widget_path_pspecs = NULL;
699 binding_set->widget_class_pspecs = NULL;
700 binding_set->class_branch_pspecs = NULL;
701 binding_set->entries = NULL;
702 binding_set->current = NULL;
703 binding_set->parsed = FALSE;
705 binding_set_list = g_slist_prepend (binding_set_list, binding_set);
711 * gtk_binding_set_by_class: (skip)
712 * @object_class: a valid #GObject class
714 * This function returns the binding set named after the type name of
715 * the passed in class structure. New binding sets are created on
716 * demand by this function.
718 * Return value: (transfer full): the binding set corresponding to
722 gtk_binding_set_by_class (gpointer object_class)
724 GObjectClass *class = object_class;
725 GtkBindingSet* binding_set;
727 g_return_val_if_fail (G_IS_OBJECT_CLASS (class), NULL);
729 if (!key_id_class_binding_set)
730 key_id_class_binding_set = g_quark_from_static_string (key_class_binding_set);
732 binding_set = g_dataset_id_get_data (class, key_id_class_binding_set);
737 binding_set = gtk_binding_set_new (g_type_name (G_OBJECT_CLASS_TYPE (class)));
738 gtk_binding_set_add_path (binding_set,
740 g_type_name (G_OBJECT_CLASS_TYPE (class)),
742 g_dataset_id_set_data (class, key_id_class_binding_set, binding_set);
748 * gtk_binding_set_find:
749 * @set_name: unique binding set name
751 * Find a binding set by its globally unique name.
753 * The @set_name can either be a name used for gtk_binding_set_new()
754 * or the type name of a class used in gtk_binding_set_by_class().
756 * Return value: (transfer none): %NULL or the specified binding set
759 gtk_binding_set_find (const gchar *set_name)
763 g_return_val_if_fail (set_name != NULL, NULL);
765 for (slist = binding_set_list; slist; slist = slist->next)
767 GtkBindingSet *binding_set;
769 binding_set = slist->data;
770 if (g_str_equal (binding_set->set_name, (gpointer) set_name))
777 * gtk_binding_set_activate:
778 * @binding_set: a #GtkBindingSet set to activate
779 * @keyval: key value of the binding
780 * @modifiers: key modifier of the binding
781 * @object: object to activate when binding found
783 * Find a key binding matching @keyval and @modifiers within
784 * @binding_set and activate the binding on @object.
786 * Return value: %TRUE if a binding was found and activated
789 gtk_binding_set_activate (GtkBindingSet *binding_set,
791 GdkModifierType modifiers,
794 GtkBindingEntry *entry;
796 g_return_val_if_fail (binding_set != NULL, FALSE);
797 g_return_val_if_fail (G_IS_OBJECT (object), FALSE);
799 keyval = gdk_keyval_to_lower (keyval);
800 modifiers = modifiers & BINDING_MOD_MASK ();
802 entry = binding_ht_lookup_entry (binding_set, keyval, modifiers);
804 return gtk_binding_entry_activate (entry, object);
810 gtk_binding_entry_clear_internal (GtkBindingSet *binding_set,
812 GdkModifierType modifiers)
814 GtkBindingEntry *entry;
816 keyval = gdk_keyval_to_lower (keyval);
817 modifiers = modifiers & BINDING_MOD_MASK ();
819 entry = binding_ht_lookup_entry (binding_set, keyval, modifiers);
821 binding_entry_destroy (entry);
823 entry = binding_entry_new (binding_set, keyval, modifiers);
827 * gtk_binding_entry_skip:
828 * @binding_set: a #GtkBindingSet to skip an entry of
829 * @keyval: key value of binding to skip
830 * @modifiers: key modifier of binding to skip
832 * Install a binding on @binding_set which causes key lookups
833 * to be aborted, to prevent bindings from lower priority sets
839 gtk_binding_entry_skip (GtkBindingSet *binding_set,
841 GdkModifierType modifiers)
843 GtkBindingEntry *entry;
845 g_return_if_fail (binding_set != NULL);
847 keyval = gdk_keyval_to_lower (keyval);
848 modifiers = modifiers & BINDING_MOD_MASK ();
850 entry = binding_ht_lookup_entry (binding_set, keyval, modifiers);
852 binding_entry_destroy (entry);
854 entry = binding_entry_new (binding_set, keyval, modifiers);
855 entry->marks_unbound = TRUE;
859 * gtk_binding_entry_remove:
860 * @binding_set: a #GtkBindingSet to remove an entry of
861 * @keyval: key value of binding to remove
862 * @modifiers: key modifier of binding to remove
864 * Remove a binding previously installed via
865 * gtk_binding_entry_add_signal() on @binding_set.
868 gtk_binding_entry_remove (GtkBindingSet *binding_set,
870 GdkModifierType modifiers)
872 GtkBindingEntry *entry;
874 g_return_if_fail (binding_set != NULL);
876 keyval = gdk_keyval_to_lower (keyval);
877 modifiers = modifiers & BINDING_MOD_MASK ();
879 entry = binding_ht_lookup_entry (binding_set, keyval, modifiers);
881 binding_entry_destroy (entry);
885 * gtk_binding_entry_add_signall:
886 * @binding_set: a #GtkBindingSet to add a signal to
888 * @modifiers: key modifier
889 * @signal_name: signal name to be bound
890 * @binding_args: (transfer none) (element-type GtkBindingArg):
891 * list of #GtkBindingArg signal arguments
893 * Override or install a new key binding for @keyval with @modifiers on
897 gtk_binding_entry_add_signall (GtkBindingSet *binding_set,
899 GdkModifierType modifiers,
900 const gchar *signal_name,
901 GSList *binding_args)
903 _gtk_binding_entry_add_signall (binding_set,
905 signal_name, binding_args);
909 _gtk_binding_entry_add_signall (GtkBindingSet *binding_set,
911 GdkModifierType modifiers,
912 const gchar *signal_name,
913 GSList *binding_args)
915 GtkBindingEntry *entry;
916 GtkBindingSignal *signal, **signal_p;
921 g_return_if_fail (binding_set != NULL);
922 g_return_if_fail (signal_name != NULL);
924 keyval = gdk_keyval_to_lower (keyval);
925 modifiers = modifiers & BINDING_MOD_MASK ();
927 signal = binding_signal_new (signal_name, g_slist_length (binding_args));
930 for (slist = binding_args; slist; slist = slist->next)
932 GtkBindingArg *tmp_arg;
934 tmp_arg = slist->data;
937 g_warning ("gtk_binding_entry_add_signall(): arg[%u] is `NULL'", n);
938 binding_signal_free (signal);
941 switch (G_TYPE_FUNDAMENTAL (tmp_arg->arg_type))
944 arg->arg_type = G_TYPE_LONG;
945 arg->d.long_data = tmp_arg->d.long_data;
948 arg->arg_type = G_TYPE_DOUBLE;
949 arg->d.double_data = tmp_arg->d.double_data;
952 if (tmp_arg->arg_type != GTK_TYPE_IDENTIFIER)
953 arg->arg_type = G_TYPE_STRING;
955 arg->arg_type = GTK_TYPE_IDENTIFIER;
956 arg->d.string_data = g_strdup (tmp_arg->d.string_data);
957 if (!arg->d.string_data)
959 g_warning ("gtk_binding_entry_add_signall(): value of `string' arg[%u] is `NULL'", n);
960 binding_signal_free (signal);
965 g_warning ("gtk_binding_entry_add_signall(): unsupported type `%s' for arg[%u]",
966 g_type_name (arg->arg_type), n);
967 binding_signal_free (signal);
974 entry = binding_ht_lookup_entry (binding_set, keyval, modifiers);
977 gtk_binding_entry_clear_internal (binding_set, keyval, modifiers);
978 entry = binding_ht_lookup_entry (binding_set, keyval, modifiers);
980 signal_p = &entry->signals;
982 signal_p = &(*signal_p)->next;
987 * gtk_binding_entry_add_signal:
988 * @binding_set: a #GtkBindingSet to install an entry for
989 * @keyval: key value of binding to install
990 * @modifiers: key modifier of binding to install
991 * @signal_name: signal to execute upon activation
992 * @n_args: number of arguments to @signal_name
993 * @Varargs: arguments to @signal_name
995 * Override or install a new key binding for @keyval with @modifiers on
996 * @binding_set. When the binding is activated, @signal_name will be
997 * emitted on the target widget, with @n_args @Varargs used as
1001 gtk_binding_entry_add_signal (GtkBindingSet *binding_set,
1003 GdkModifierType modifiers,
1004 const gchar *signal_name,
1008 GSList *slist, *free_slist;
1012 g_return_if_fail (binding_set != NULL);
1013 g_return_if_fail (signal_name != NULL);
1015 va_start (args, n_args);
1017 for (i = 0; i < n_args; i++)
1021 arg = g_slice_new0 (GtkBindingArg);
1022 slist = g_slist_prepend (slist, arg);
1024 arg->arg_type = va_arg (args, GType);
1025 switch (G_TYPE_FUNDAMENTAL (arg->arg_type))
1031 case G_TYPE_BOOLEAN:
1034 arg->arg_type = G_TYPE_LONG;
1035 arg->d.long_data = va_arg (args, gint);
1039 arg->arg_type = G_TYPE_LONG;
1040 arg->d.long_data = va_arg (args, glong);
1044 arg->arg_type = G_TYPE_DOUBLE;
1045 arg->d.double_data = va_arg (args, gdouble);
1048 if (arg->arg_type != GTK_TYPE_IDENTIFIER)
1049 arg->arg_type = G_TYPE_STRING;
1050 arg->d.string_data = va_arg (args, gchar*);
1051 if (!arg->d.string_data)
1053 g_warning ("gtk_binding_entry_add_signal(): type `%s' arg[%u] is `NULL'",
1054 g_type_name (arg->arg_type),
1060 g_warning ("gtk_binding_entry_add_signal(): unsupported type `%s' for arg[%u]",
1061 g_type_name (arg->arg_type), i);
1068 if (i == n_args || i == 0)
1070 slist = g_slist_reverse (slist);
1071 _gtk_binding_entry_add_signall (binding_set, keyval, modifiers, signal_name, slist);
1077 g_slice_free (GtkBindingArg, slist->data);
1078 slist = slist->next;
1080 g_slist_free (free_slist);
1084 gtk_binding_parse_signal (GScanner *scanner,
1085 GtkBindingSet *binding_set,
1087 GdkModifierType modifiers)
1090 guint expected_token = 0;
1096 gboolean seen_comma;
1098 g_return_val_if_fail (scanner != NULL, G_TOKEN_ERROR);
1100 g_scanner_get_next_token (scanner);
1102 if (scanner->token != G_TOKEN_STRING)
1103 return G_TOKEN_STRING;
1105 g_scanner_peek_next_token (scanner);
1107 if (scanner->next_token != '(')
1109 g_scanner_get_next_token (scanner);
1113 signal = g_strdup (scanner->value.v_string);
1114 g_scanner_get_next_token (scanner);
1121 scanner->config->scan_symbols = FALSE;
1128 expected_token = G_TOKEN_INT;
1130 expected_token = ')';
1132 g_scanner_get_next_token (scanner);
1134 switch ((guint) scanner->token)
1140 arg = g_new (GtkBindingArg, 1);
1141 arg->arg_type = G_TYPE_DOUBLE;
1142 arg->d.double_data = scanner->value.v_float;
1146 arg->d.double_data = - arg->d.double_data;
1149 args = g_slist_prepend (args, arg);
1159 arg = g_new (GtkBindingArg, 1);
1160 arg->arg_type = G_TYPE_LONG;
1161 arg->d.long_data = scanner->value.v_int;
1165 arg->d.long_data = - arg->d.long_data;
1168 args = g_slist_prepend (args, arg);
1173 case G_TOKEN_STRING:
1174 if (need_arg && !negate)
1177 arg = g_new (GtkBindingArg, 1);
1178 arg->arg_type = G_TYPE_STRING;
1179 arg->d.string_data = g_strdup (scanner->value.v_string);
1180 args = g_slist_prepend (args, arg);
1186 case G_TOKEN_IDENTIFIER:
1187 if (need_arg && !negate)
1190 arg = g_new (GtkBindingArg, 1);
1191 arg->arg_type = GTK_TYPE_IDENTIFIER;
1192 arg->d.string_data = g_strdup (scanner->value.v_identifier);
1193 args = g_slist_prepend (args, arg);
1204 expected_token = G_TOKEN_INT;
1220 if (!(need_arg && seen_comma) && !negate)
1222 args = g_slist_reverse (args);
1223 _gtk_binding_entry_add_signall (binding_set,
1228 expected_token = G_TOKEN_NONE;
1240 scanner->config->scan_symbols = TRUE;
1242 for (slist = args; slist; slist = slist->next)
1248 if (G_TYPE_FUNDAMENTAL (arg->arg_type) == G_TYPE_STRING)
1249 g_free (arg->d.string_data);
1253 g_slist_free (args);
1256 return expected_token;
1260 gtk_binding_parse_bind (GScanner *scanner,
1261 GtkBindingSet *binding_set)
1264 GdkModifierType modifiers = 0;
1265 gboolean unbind = FALSE;
1267 g_return_val_if_fail (scanner != NULL, G_TOKEN_ERROR);
1269 g_scanner_get_next_token (scanner);
1271 if (scanner->token != G_TOKEN_SYMBOL)
1272 return G_TOKEN_SYMBOL;
1274 if (scanner->value.v_symbol != GUINT_TO_POINTER (GTK_BINDING_TOKEN_BIND) &&
1275 scanner->value.v_symbol != GUINT_TO_POINTER (GTK_BINDING_TOKEN_UNBIND))
1276 return G_TOKEN_SYMBOL;
1278 unbind = (scanner->value.v_symbol == GUINT_TO_POINTER (GTK_BINDING_TOKEN_UNBIND));
1279 g_scanner_get_next_token (scanner);
1281 if (scanner->token != (guint) G_TOKEN_STRING)
1282 return G_TOKEN_STRING;
1284 gtk_accelerator_parse (scanner->value.v_string, &keyval, &modifiers);
1285 modifiers &= BINDING_MOD_MASK ();
1288 return G_TOKEN_STRING;
1292 gtk_binding_entry_skip (binding_set, keyval, modifiers);
1293 return G_TOKEN_NONE;
1296 g_scanner_get_next_token (scanner);
1298 if (scanner->token != '{')
1301 gtk_binding_entry_clear_internal (binding_set, keyval, modifiers);
1302 g_scanner_peek_next_token (scanner);
1304 while (scanner->next_token != '}')
1306 guint expected_token;
1308 switch (scanner->next_token)
1310 case G_TOKEN_STRING:
1311 expected_token = gtk_binding_parse_signal (scanner,
1315 if (expected_token != G_TOKEN_NONE)
1316 return expected_token;
1319 g_scanner_get_next_token (scanner);
1323 g_scanner_peek_next_token (scanner);
1326 g_scanner_get_next_token (scanner);
1328 return G_TOKEN_NONE;
1332 create_signal_scanner (void)
1336 scanner = g_scanner_new (NULL);
1337 scanner->config->cset_identifier_nth = G_CSET_a_2_z G_CSET_A_2_Z G_CSET_DIGITS "-_";
1339 g_scanner_scope_add_symbol (scanner, 0, "bind", GUINT_TO_POINTER (GTK_BINDING_TOKEN_BIND));
1340 g_scanner_scope_add_symbol (scanner, 0, "unbind", GUINT_TO_POINTER (GTK_BINDING_TOKEN_UNBIND));
1342 g_scanner_set_scope (scanner, 0);
1348 * gtk_binding_entry_add_signal_from_string:
1349 * @binding_set: a #GtkBindingSet
1350 * @signal_desc: a signal description
1352 * Parses a signal description from @signal_desc and incorporates
1353 * it into @binding_set.
1355 * signal descriptions may either bind a key combination to
1356 * one or more signals:
1357 * <informalexample><programlisting>
1358 * bind <replaceable>key</replaceable> {
1359 * <replaceable>signalname</replaceable> (<replaceable>param</replaceable>, ...)
1362 * </programlisting></informalexample>
1364 * Or they may also unbind a key combination:
1365 * <informalexample><programlisting>
1366 * unbind <replaceable>key</replaceable>
1367 * </programlisting></informalexample>
1369 * Key combinations must be in a format that can be parsed by
1370 * gtk_accelerator_parse().
1372 * Returns: %G_TOKEN_NONE if the signal was successfully parsed and added,
1373 * the expected token otherwise
1378 gtk_binding_entry_add_signal_from_string (GtkBindingSet *binding_set,
1379 const gchar *signal_desc)
1381 static GScanner *scanner = NULL;
1384 g_return_val_if_fail (binding_set != NULL, G_TOKEN_NONE);
1385 g_return_val_if_fail (signal_desc != NULL, G_TOKEN_NONE);
1387 if (G_UNLIKELY (!scanner))
1388 scanner = create_signal_scanner ();
1390 g_scanner_input_text (scanner, signal_desc,
1391 (guint) strlen (signal_desc));
1393 ret = gtk_binding_parse_bind (scanner, binding_set);
1395 /* Reset for next use */
1396 g_scanner_set_scope (scanner, 0);
1402 * gtk_binding_set_add_path:
1403 * @binding_set: a #GtkBindingSet to add a path to
1404 * @path_type: path type the pattern applies to
1405 * @path_pattern: the actual match pattern
1406 * @priority: binding priority
1408 * This function is used internally by the GtkRC parsing mechanism to
1409 * assign match patterns to #GtkBindingSet structures.
1414 gtk_binding_set_add_path (GtkBindingSet *binding_set,
1415 GtkPathType path_type,
1416 const gchar *path_pattern,
1417 GtkPathPriorityType priority)
1420 GSList **slist_p, *slist;
1421 static guint seq_id = 0;
1423 g_return_if_fail (binding_set != NULL);
1424 g_return_if_fail (path_pattern != NULL);
1425 g_return_if_fail (priority <= GTK_PATH_PRIO_MASK);
1427 priority &= GTK_PATH_PRIO_MASK;
1431 case GTK_PATH_WIDGET:
1432 slist_p = &binding_set->widget_path_pspecs;
1434 case GTK_PATH_WIDGET_CLASS:
1435 slist_p = &binding_set->widget_class_pspecs;
1437 case GTK_PATH_CLASS:
1438 slist_p = &binding_set->class_branch_pspecs;
1441 g_assert_not_reached ();
1446 pspec = g_new (PatternSpec, 1);
1447 pspec->type = path_type;
1448 if (path_type == GTK_PATH_WIDGET_CLASS)
1449 pspec->pspec = NULL;
1451 pspec->pspec = g_pattern_spec_new (path_pattern);
1453 pspec->seq_id = priority << 28;
1454 pspec->user_data = binding_set;
1459 PatternSpec *tmp_pspec;
1461 tmp_pspec = slist->data;
1462 slist = slist->next;
1464 if (g_pattern_spec_equal (tmp_pspec->pspec, pspec->pspec))
1466 GtkPathPriorityType lprio = tmp_pspec->seq_id >> 28;
1468 pattern_spec_free (pspec);
1470 if (lprio < priority)
1472 tmp_pspec->seq_id &= 0x0fffffff;
1473 tmp_pspec->seq_id |= priority << 28;
1480 pspec->seq_id |= seq_id++ & 0x0fffffff;
1481 *slist_p = g_slist_prepend (*slist_p, pspec);
1486 find_entry_with_binding (GtkBindingEntry *entry,
1487 GtkBindingSet *binding_set)
1489 return (entry->binding_set == binding_set) ? 0 : 1;
1493 binding_activate (GtkBindingSet *binding_set,
1496 gboolean is_release,
1499 GtkBindingEntry *entry;
1502 elem = g_slist_find_custom (entries, binding_set,
1503 (GCompareFunc) find_entry_with_binding);
1510 if (is_release != ((entry->modifiers & GDK_RELEASE_MASK) != 0))
1513 if (entry->marks_unbound)
1519 if (gtk_binding_entry_activate (entry, object))
1526 gtk_bindings_activate_list (GObject *object,
1528 gboolean is_release)
1530 GtkStyleContext *context;
1531 GtkBindingSet *binding_set;
1532 GtkStateFlags state;
1533 gboolean handled = FALSE;
1534 gboolean unbound = FALSE;
1540 context = gtk_widget_get_style_context (GTK_WIDGET (object));
1541 state = gtk_widget_get_state_flags (GTK_WIDGET (object));
1543 gtk_style_context_get (context, state,
1544 "gtk-key-bindings", &array,
1550 for (i = 0; i < array->len; i++)
1552 binding_set = g_ptr_array_index (array, i);
1553 handled = binding_activate (binding_set, entries,
1560 g_ptr_array_unref (array);
1570 class_type = G_TYPE_FROM_INSTANCE (object);
1572 while (class_type && !handled)
1574 binding_set = gtk_binding_set_find (g_type_name (class_type));
1575 class_type = g_type_parent (class_type);
1580 handled = binding_activate (binding_set, entries,
1593 * gtk_bindings_activate:
1594 * @object: object to activate when binding found
1595 * @keyval: key value of the binding
1596 * @modifiers: key modifier of the binding
1598 * Find a key binding matching @keyval and @modifiers and activate the
1599 * binding on @object.
1601 * Return value: %TRUE if a binding was found and activated
1604 gtk_bindings_activate (GObject *object,
1606 GdkModifierType modifiers)
1608 GSList *entries = NULL;
1609 GdkDisplay *display;
1610 GtkKeyHash *key_hash;
1611 gboolean handled = FALSE;
1612 gboolean is_release;
1614 if (!GTK_IS_WIDGET (object))
1617 is_release = (modifiers & GDK_RELEASE_MASK) != 0;
1618 modifiers = modifiers & BINDING_MOD_MASK () & ~GDK_RELEASE_MASK;
1620 display = gtk_widget_get_display (GTK_WIDGET (object));
1621 key_hash = binding_key_hash_for_keymap (gdk_keymap_get_for_display (display));
1623 entries = _gtk_key_hash_lookup_keyval (key_hash, keyval, modifiers);
1625 handled = gtk_bindings_activate_list (object, entries, is_release);
1627 g_slist_free (entries);
1633 * gtk_bindings_activate_event:
1634 * @object: a #GObject (generally must be a widget)
1635 * @event: a #GdkEventKey
1637 * Looks up key bindings for @object to find one matching
1638 * @event, and if one was found, activate it.
1640 * Return value: %TRUE if a matching key binding was found
1645 gtk_bindings_activate_event (GObject *object,
1648 GSList *entries = NULL;
1649 GdkDisplay *display;
1650 GtkKeyHash *key_hash;
1651 gboolean handled = FALSE;
1653 if (!GTK_IS_WIDGET (object))
1656 display = gtk_widget_get_display (GTK_WIDGET (object));
1657 key_hash = binding_key_hash_for_keymap (gdk_keymap_get_for_display (display));
1659 entries = _gtk_key_hash_lookup (key_hash,
1660 event->hardware_keycode,
1662 BINDING_MOD_MASK () & ~GDK_RELEASE_MASK,
1665 handled = gtk_bindings_activate_list (object, entries,
1666 event->type == GDK_KEY_RELEASE);
1668 g_slist_free (entries);