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>
35 #include "gtkbindings.h"
36 #include "gtkkeyhash.h"
37 #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_Tab)
136 keyval = GDK_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 (GtkObject *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 #GtkObject 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 GtkObjectClass *class = object_class;
609 GtkBindingSet* binding_set;
611 g_return_val_if_fail (GTK_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 (GTK_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_add:
711 * @binding_set: #a GtkBindingSet to clear an entry of
712 * @keyval: key value of binding to clear
713 * @modifiers: key modifier of binding to clear
715 * Adds a binding entry.
717 * Deprecated: 2.12: Use gtk_binding_entry_add_signal() instead.
721 * gtk_binding_entry_clear:
722 * @binding_set: binding set to clear an entry of
723 * @keyval: key value of binding to clear
724 * @modifiers: key modifier of binding to clear
726 * Clears a binding entry.
728 * Deprecated: 2.12: Use gtk_binding_entry_remove() instead.
731 gtk_binding_entry_clear (GtkBindingSet *binding_set,
733 GdkModifierType modifiers)
735 g_return_if_fail (binding_set != NULL);
737 gtk_binding_entry_clear_internal (binding_set, keyval, modifiers);
741 * gtk_binding_entry_skip:
742 * @binding_set: a #GtkBindingSet to skip an entry of
743 * @keyval: key value of binding to skip
744 * @modifiers: key modifier of binding to skip
746 * Install a binding on @binding_set which causes key lookups
747 * to be aborted, to prevent bindings from lower priority sets
753 gtk_binding_entry_skip (GtkBindingSet *binding_set,
755 GdkModifierType modifiers)
757 GtkBindingEntry *entry;
759 g_return_if_fail (binding_set != NULL);
761 keyval = gdk_keyval_to_lower (keyval);
762 modifiers = modifiers & BINDING_MOD_MASK ();
764 entry = binding_ht_lookup_entry (binding_set, keyval, modifiers);
766 binding_entry_destroy (entry);
768 entry = binding_entry_new (binding_set, keyval, modifiers);
769 entry->marks_unbound = TRUE;
773 * gtk_binding_entry_remove:
774 * @binding_set: a #GtkBindingSet to remove an entry of
775 * @keyval: key value of binding to remove
776 * @modifiers: key modifier of binding to remove
778 * Remove a binding previously installed via
779 * gtk_binding_entry_add_signal() on @binding_set.
782 gtk_binding_entry_remove (GtkBindingSet *binding_set,
784 GdkModifierType modifiers)
786 GtkBindingEntry *entry;
788 g_return_if_fail (binding_set != NULL);
790 keyval = gdk_keyval_to_lower (keyval);
791 modifiers = modifiers & BINDING_MOD_MASK ();
793 entry = binding_ht_lookup_entry (binding_set, keyval, modifiers);
795 binding_entry_destroy (entry);
799 * gtk_binding_entry_add_signall:
800 * @binding_set: a #GtkBindingSet to add a signal to
802 * @modifiers: key modifier
803 * @signal_name: signal name to be bound
804 * @binding_args: list of #GtkBindingArg signal arguments
806 * Override or install a new key binding for @keyval with @modifiers on
810 gtk_binding_entry_add_signall (GtkBindingSet *binding_set,
812 GdkModifierType modifiers,
813 const gchar *signal_name,
814 GSList *binding_args)
816 _gtk_binding_entry_add_signall (binding_set,
818 signal_name, binding_args);
822 _gtk_binding_entry_add_signall (GtkBindingSet *binding_set,
824 GdkModifierType modifiers,
825 const gchar *signal_name,
826 GSList *binding_args)
828 GtkBindingEntry *entry;
829 GtkBindingSignal *signal, **signal_p;
834 g_return_if_fail (binding_set != NULL);
835 g_return_if_fail (signal_name != NULL);
837 keyval = gdk_keyval_to_lower (keyval);
838 modifiers = modifiers & BINDING_MOD_MASK ();
840 signal = binding_signal_new (signal_name, g_slist_length (binding_args));
843 for (slist = binding_args; slist; slist = slist->next)
845 GtkBindingArg *tmp_arg;
847 tmp_arg = slist->data;
850 g_warning ("gtk_binding_entry_add_signall(): arg[%u] is `NULL'", n);
851 binding_signal_free (signal);
854 switch (G_TYPE_FUNDAMENTAL (tmp_arg->arg_type))
857 arg->arg_type = G_TYPE_LONG;
858 arg->d.long_data = tmp_arg->d.long_data;
861 arg->arg_type = G_TYPE_DOUBLE;
862 arg->d.double_data = tmp_arg->d.double_data;
865 if (tmp_arg->arg_type != GTK_TYPE_IDENTIFIER)
866 arg->arg_type = G_TYPE_STRING;
868 arg->arg_type = GTK_TYPE_IDENTIFIER;
869 arg->d.string_data = g_strdup (tmp_arg->d.string_data);
870 if (!arg->d.string_data)
872 g_warning ("gtk_binding_entry_add_signall(): value of `string' arg[%u] is `NULL'", n);
873 binding_signal_free (signal);
878 g_warning ("gtk_binding_entry_add_signall(): unsupported type `%s' for arg[%u]",
879 g_type_name (arg->arg_type), n);
880 binding_signal_free (signal);
887 entry = binding_ht_lookup_entry (binding_set, keyval, modifiers);
890 gtk_binding_entry_clear_internal (binding_set, keyval, modifiers);
891 entry = binding_ht_lookup_entry (binding_set, keyval, modifiers);
893 signal_p = &entry->signals;
895 signal_p = &(*signal_p)->next;
900 * gtk_binding_entry_add_signal:
901 * @binding_set: a #GtkBindingSet to install an entry for
902 * @keyval: key value of binding to install
903 * @modifiers: key modifier of binding to install
904 * @signal_name: signal to execute upon activation
905 * @n_args: number of arguments to @signal_name
906 * @Varargs: arguments to @signal_name
908 * Override or install a new key binding for @keyval with @modifiers on
909 * @binding_set. When the binding is activated, @signal_name will be
910 * emitted on the target widget, with @n_args @Varargs used as
914 gtk_binding_entry_add_signal (GtkBindingSet *binding_set,
916 GdkModifierType modifiers,
917 const gchar *signal_name,
921 GSList *slist, *free_slist;
925 g_return_if_fail (binding_set != NULL);
926 g_return_if_fail (signal_name != NULL);
928 va_start (args, n_args);
930 for (i = 0; i < n_args; i++)
934 arg = g_slice_new0 (GtkBindingArg);
935 slist = g_slist_prepend (slist, arg);
937 arg->arg_type = va_arg (args, GType);
938 switch (G_TYPE_FUNDAMENTAL (arg->arg_type))
947 arg->arg_type = G_TYPE_LONG;
948 arg->d.long_data = va_arg (args, gint);
952 arg->arg_type = G_TYPE_LONG;
953 arg->d.long_data = va_arg (args, glong);
957 arg->arg_type = G_TYPE_DOUBLE;
958 arg->d.double_data = va_arg (args, gdouble);
961 if (arg->arg_type != GTK_TYPE_IDENTIFIER)
962 arg->arg_type = G_TYPE_STRING;
963 arg->d.string_data = va_arg (args, gchar*);
964 if (!arg->d.string_data)
966 g_warning ("gtk_binding_entry_add_signal(): type `%s' arg[%u] is `NULL'",
967 g_type_name (arg->arg_type),
973 g_warning ("gtk_binding_entry_add_signal(): unsupported type `%s' for arg[%u]",
974 g_type_name (arg->arg_type), i);
981 if (i == n_args || i == 0)
983 slist = g_slist_reverse (slist);
984 _gtk_binding_entry_add_signall (binding_set, keyval, modifiers, signal_name, slist);
990 g_slice_free (GtkBindingArg, slist->data);
993 g_slist_free (free_slist);
997 * gtk_binding_set_add_path:
998 * @binding_set: a #GtkBindingSet to add a path to
999 * @path_type: path type the pattern applies to
1000 * @path_pattern: the actual match pattern
1001 * @priority: binding priority
1003 * This function is used internally by the GtkRC parsing mechanism to
1004 * assign match patterns to #GtkBindingSet structures.
1007 gtk_binding_set_add_path (GtkBindingSet *binding_set,
1008 GtkPathType path_type,
1009 const gchar *path_pattern,
1010 GtkPathPriorityType priority)
1013 GSList **slist_p, *slist;
1014 static guint seq_id = 0;
1016 g_return_if_fail (binding_set != NULL);
1017 g_return_if_fail (path_pattern != NULL);
1018 g_return_if_fail (priority <= GTK_PATH_PRIO_MASK);
1020 priority &= GTK_PATH_PRIO_MASK;
1024 case GTK_PATH_WIDGET:
1025 slist_p = &binding_set->widget_path_pspecs;
1027 case GTK_PATH_WIDGET_CLASS:
1028 slist_p = &binding_set->widget_class_pspecs;
1030 case GTK_PATH_CLASS:
1031 slist_p = &binding_set->class_branch_pspecs;
1034 g_assert_not_reached ();
1039 pspec = g_new (PatternSpec, 1);
1040 pspec->type = path_type;
1041 if (path_type == GTK_PATH_WIDGET_CLASS)
1043 pspec->pspec = NULL;
1044 pspec->path = _gtk_rc_parse_widget_class_path (path_pattern);
1048 pspec->pspec = g_pattern_spec_new (path_pattern);
1052 pspec->seq_id = priority << 28;
1053 pspec->user_data = binding_set;
1058 PatternSpec *tmp_pspec;
1060 tmp_pspec = slist->data;
1061 slist = slist->next;
1063 if (g_pattern_spec_equal (tmp_pspec->pspec, pspec->pspec))
1065 GtkPathPriorityType lprio = tmp_pspec->seq_id >> 28;
1067 pattern_spec_free (pspec);
1069 if (lprio < priority)
1071 tmp_pspec->seq_id &= 0x0fffffff;
1072 tmp_pspec->seq_id |= priority << 28;
1079 pspec->seq_id |= seq_id++ & 0x0fffffff;
1080 *slist_p = g_slist_prepend (*slist_p, pspec);
1085 binding_match_activate (GSList *pspec_list,
1089 gchar *path_reversed,
1096 for (slist = pspec_list; slist; slist = slist->next)
1099 GtkBindingSet *binding_set;
1102 pspec = slist->data;
1104 if (pspec->type == GTK_PATH_WIDGET_CLASS)
1106 if (_gtk_rc_match_widget_class (pspec->path, path_length, path, path_reversed))
1107 binding_set = pspec->user_data;
1111 if (g_pattern_match (pspec->pspec, path_length, path, path_reversed))
1112 binding_set = pspec->user_data;
1117 if (binding_set->current->marks_unbound)
1123 if (gtk_binding_entry_activate (binding_set->current, object))
1132 gtk_binding_pattern_compare (gconstpointer new_pattern,
1133 gconstpointer existing_pattern)
1135 register const PatternSpec *np = new_pattern;
1136 register const PatternSpec *ep = existing_pattern;
1138 /* walk the list as long as the existing patterns have
1139 * higher priorities.
1142 return np->seq_id < ep->seq_id;
1146 gtk_binding_entries_sort_patterns (GSList *entries,
1147 GtkPathType path_id,
1148 gboolean is_release)
1154 for (tmp_list = entries; tmp_list; tmp_list = tmp_list->next)
1156 GtkBindingEntry *entry = tmp_list->data;
1157 GtkBindingSet *binding_set;
1159 binding_set = entry->binding_set;
1160 binding_set->current = NULL;
1163 for (; entries; entries = entries->next)
1165 GtkBindingEntry *entry = entries->data;
1166 GtkBindingSet *binding_set;
1167 GSList *slist = NULL;
1169 if (is_release != ((entry->modifiers & GDK_RELEASE_MASK) != 0))
1172 binding_set = entry->binding_set;
1174 if (binding_set->current)
1176 binding_set->current = entry;
1180 case GTK_PATH_WIDGET:
1181 slist = binding_set->widget_path_pspecs;
1183 case GTK_PATH_WIDGET_CLASS:
1184 slist = binding_set->widget_class_pspecs;
1186 case GTK_PATH_CLASS:
1187 slist = binding_set->class_branch_pspecs;
1191 for (; slist; slist = slist->next)
1195 pspec = slist->data;
1196 patterns = g_slist_insert_sorted (patterns, pspec, gtk_binding_pattern_compare);
1204 gtk_bindings_activate_list (GtkObject *object,
1206 gboolean is_release)
1208 GtkWidget *widget = GTK_WIDGET (object);
1209 gboolean handled = FALSE;
1217 gchar *path, *path_reversed;
1221 gtk_widget_path (widget, &path_length, &path, &path_reversed);
1222 patterns = gtk_binding_entries_sort_patterns (entries, GTK_PATH_WIDGET, is_release);
1223 handled = binding_match_activate (patterns, object, path_length, path, path_reversed, &unbound);
1224 g_slist_free (patterns);
1226 g_free (path_reversed);
1235 gchar *path, *path_reversed;
1239 gtk_widget_class_path (widget, &path_length, &path, &path_reversed);
1240 patterns = gtk_binding_entries_sort_patterns (entries, GTK_PATH_WIDGET_CLASS, is_release);
1241 handled = binding_match_activate (patterns, object, path_length, path, path_reversed, &unbound);
1242 g_slist_free (patterns);
1244 g_free (path_reversed);
1254 gboolean unbound = FALSE;
1256 patterns = gtk_binding_entries_sort_patterns (entries, GTK_PATH_CLASS, is_release);
1257 class_type = G_TYPE_FROM_INSTANCE (object);
1258 while (class_type && !handled)
1262 gchar *path_reversed;
1264 path = g_strdup (g_type_name (class_type));
1265 path_reversed = g_strdup (path);
1266 g_strreverse (path_reversed);
1267 path_length = strlen (path);
1268 handled = binding_match_activate (patterns, object, path_length, path, path_reversed, &unbound);
1270 g_free (path_reversed);
1275 class_type = g_type_parent (class_type);
1277 g_slist_free (patterns);
1287 * gtk_bindings_activate:
1288 * @object: object to activate when binding found
1289 * @keyval: key value of the binding
1290 * @modifiers: key modifier of the binding
1292 * Find a key binding matching @keyval and @modifiers and activate the
1293 * binding on @object.
1295 * Return value: %TRUE if a binding was found and activated
1298 gtk_bindings_activate (GtkObject *object,
1300 GdkModifierType modifiers)
1302 GSList *entries = NULL;
1303 GdkDisplay *display;
1304 GtkKeyHash *key_hash;
1305 gboolean handled = FALSE;
1306 gboolean is_release;
1308 g_return_val_if_fail (GTK_IS_OBJECT (object), FALSE);
1310 if (!GTK_IS_WIDGET (object))
1313 is_release = (modifiers & GDK_RELEASE_MASK) != 0;
1314 modifiers = modifiers & BINDING_MOD_MASK () & ~GDK_RELEASE_MASK;
1316 display = gtk_widget_get_display (GTK_WIDGET (object));
1317 key_hash = binding_key_hash_for_keymap (gdk_keymap_get_for_display (display));
1319 entries = _gtk_key_hash_lookup_keyval (key_hash, keyval, modifiers);
1321 handled = gtk_bindings_activate_list (object, entries, is_release);
1323 g_slist_free (entries);
1329 * gtk_bindings_activate_event:
1330 * @object: a #GtkObject (generally must be a widget)
1331 * @event: a #GdkEventKey
1333 * Looks up key bindings for @object to find one matching
1334 * @event, and if one was found, activate it.
1336 * Return value: %TRUE if a matching key binding was found
1339 gtk_bindings_activate_event (GtkObject *object,
1342 GSList *entries = NULL;
1343 GdkDisplay *display;
1344 GtkKeyHash *key_hash;
1345 gboolean handled = FALSE;
1347 g_return_val_if_fail (GTK_IS_OBJECT (object), FALSE);
1349 if (!GTK_IS_WIDGET (object))
1352 display = gtk_widget_get_display (GTK_WIDGET (object));
1353 key_hash = binding_key_hash_for_keymap (gdk_keymap_get_for_display (display));
1355 entries = _gtk_key_hash_lookup (key_hash,
1356 event->hardware_keycode,
1358 BINDING_MOD_MASK () & ~GDK_RELEASE_MASK,
1361 handled = gtk_bindings_activate_list (object, entries,
1362 event->type == GDK_KEY_RELEASE);
1364 g_slist_free (entries);
1370 gtk_binding_parse_signal (GScanner *scanner,
1371 GtkBindingSet *binding_set,
1373 GdkModifierType modifiers)
1376 guint expected_token = 0;
1382 gboolean seen_comma;
1384 g_return_val_if_fail (scanner != NULL, G_TOKEN_ERROR);
1386 g_scanner_get_next_token (scanner);
1387 if (scanner->token != G_TOKEN_STRING)
1388 return G_TOKEN_STRING;
1389 g_scanner_peek_next_token (scanner);
1390 if (scanner->next_token != '(')
1392 g_scanner_get_next_token (scanner);
1395 signal = g_strdup (scanner->value.v_string);
1396 g_scanner_get_next_token (scanner);
1403 scanner->config->scan_symbols = FALSE;
1407 expected_token = G_TOKEN_INT;
1409 expected_token = ')';
1410 g_scanner_get_next_token (scanner);
1411 switch (scanner->token)
1419 arg = g_new (GtkBindingArg, 1);
1420 arg->arg_type = G_TYPE_DOUBLE;
1421 arg->d.double_data = scanner->value.v_float;
1424 arg->d.double_data = - arg->d.double_data;
1427 args = g_slist_prepend (args, arg);
1436 arg = g_new (GtkBindingArg, 1);
1437 arg->arg_type = G_TYPE_LONG;
1438 arg->d.long_data = scanner->value.v_int;
1441 arg->d.long_data = - arg->d.long_data;
1444 args = g_slist_prepend (args, arg);
1449 case G_TOKEN_STRING:
1450 if (need_arg && !negate)
1453 arg = g_new (GtkBindingArg, 1);
1454 arg->arg_type = G_TYPE_STRING;
1455 arg->d.string_data = g_strdup (scanner->value.v_string);
1456 args = g_slist_prepend (args, arg);
1461 case G_TOKEN_IDENTIFIER:
1462 if (need_arg && !negate)
1465 arg = g_new (GtkBindingArg, 1);
1466 arg->arg_type = GTK_TYPE_IDENTIFIER;
1467 arg->d.string_data = g_strdup (scanner->value.v_identifier);
1468 args = g_slist_prepend (args, arg);
1478 expected_token = G_TOKEN_INT;
1492 if (!(need_arg && seen_comma) && !negate)
1494 args = g_slist_reverse (args);
1495 _gtk_binding_entry_add_signall (binding_set,
1500 expected_token = G_TOKEN_NONE;
1510 scanner->config->scan_symbols = TRUE;
1512 for (slist = args; slist; slist = slist->next)
1517 if (G_TYPE_FUNDAMENTAL (arg->arg_type) == G_TYPE_STRING)
1518 g_free (arg->d.string_data);
1521 g_slist_free (args);
1524 return expected_token;
1528 gtk_binding_parse_bind (GScanner *scanner,
1529 GtkBindingSet *binding_set)
1532 GdkModifierType modifiers = 0;
1533 gboolean unbind = FALSE;
1535 g_return_val_if_fail (scanner != NULL, G_TOKEN_ERROR);
1537 g_scanner_get_next_token (scanner);
1538 if (scanner->token != GTK_RC_TOKEN_BIND &&
1539 scanner->token != GTK_RC_TOKEN_UNBIND)
1540 return GTK_RC_TOKEN_BIND;
1541 unbind = scanner->token == GTK_RC_TOKEN_UNBIND;
1542 g_scanner_get_next_token (scanner);
1543 if (scanner->token != G_TOKEN_STRING)
1544 return G_TOKEN_STRING;
1545 gtk_accelerator_parse (scanner->value.v_string, &keyval, &modifiers);
1546 modifiers &= BINDING_MOD_MASK ();
1548 return G_TOKEN_STRING;
1552 gtk_binding_entry_skip (binding_set, keyval, modifiers);
1553 return G_TOKEN_NONE;
1556 g_scanner_get_next_token (scanner);
1558 if (scanner->token != '{')
1561 gtk_binding_entry_clear_internal (binding_set, keyval, modifiers);
1563 g_scanner_peek_next_token (scanner);
1564 while (scanner->next_token != '}')
1566 switch (scanner->next_token)
1568 guint expected_token;
1570 case G_TOKEN_STRING:
1571 expected_token = gtk_binding_parse_signal (scanner,
1575 if (expected_token != G_TOKEN_NONE)
1576 return expected_token;
1579 g_scanner_get_next_token (scanner);
1582 g_scanner_peek_next_token (scanner);
1584 g_scanner_get_next_token (scanner);
1586 return G_TOKEN_NONE;
1590 * gtk_binding_parse_binding:
1591 * @scanner: GtkRC scanner
1593 * Parse a binding entry from a gtkrc file.
1595 * Return value: expected token upon errors, %G_TOKEN_NONE on success.
1597 * Deprecated: 2.12: There should be no need to call this function outside GTK+.
1600 gtk_binding_parse_binding (GScanner *scanner)
1602 return _gtk_binding_parse_binding (scanner);
1606 _gtk_binding_parse_binding (GScanner *scanner)
1609 GtkBindingSet *binding_set;
1611 g_return_val_if_fail (scanner != NULL, G_TOKEN_ERROR);
1613 g_scanner_get_next_token (scanner);
1614 if (scanner->token != GTK_RC_TOKEN_BINDING)
1615 return GTK_RC_TOKEN_BINDING;
1616 g_scanner_get_next_token (scanner);
1617 if (scanner->token != G_TOKEN_STRING)
1618 return G_TOKEN_STRING;
1619 name = g_strdup (scanner->value.v_string);
1621 g_scanner_get_next_token (scanner);
1622 if (scanner->token != '{')
1625 return G_TOKEN_STRING;
1628 binding_set = gtk_binding_set_find (name);
1631 binding_set = gtk_binding_set_new (name);
1632 binding_set->parsed = 1;
1636 g_scanner_peek_next_token (scanner);
1637 while (scanner->next_token != '}')
1639 switch (scanner->next_token)
1641 guint expected_token;
1643 case GTK_RC_TOKEN_BIND:
1644 case GTK_RC_TOKEN_UNBIND:
1645 expected_token = gtk_binding_parse_bind (scanner, binding_set);
1646 if (expected_token != G_TOKEN_NONE)
1647 return expected_token;
1650 g_scanner_get_next_token (scanner);
1653 g_scanner_peek_next_token (scanner);
1655 g_scanner_get_next_token (scanner);
1657 return G_TOKEN_NONE;
1661 free_pattern_specs (GSList *pattern_specs)
1665 for (slist = pattern_specs; slist; slist = slist->next)
1669 pspec = slist->data;
1671 pattern_spec_free (pspec);
1674 g_slist_free (pattern_specs);
1678 binding_set_delete (GtkBindingSet *binding_set)
1680 GtkBindingEntry *entry, *next;
1682 entry = binding_set->entries;
1685 next = entry->set_next;
1686 binding_entry_destroy (entry);
1690 free_pattern_specs (binding_set->widget_path_pspecs);
1691 free_pattern_specs (binding_set->widget_class_pspecs);
1692 free_pattern_specs (binding_set->class_branch_pspecs);
1694 g_free (binding_set);
1698 * _gtk_binding_reset_parsed:
1700 * Remove all binding sets that were added by gtk_binding_parse_binding().
1703 _gtk_binding_reset_parsed (void)
1705 GSList *slist, *next;
1707 slist = binding_set_list;
1710 GtkBindingSet *binding_set;
1712 binding_set = slist->data;
1715 if (binding_set->parsed)
1717 binding_set_list = g_slist_delete_link (binding_set_list, slist);
1718 binding_set_delete (binding_set);
1725 #define __GTK_BINDINGS_C__
1726 #include "gtkaliasdef.c"