X-Git-Url: http://pileus.org/git/?a=blobdiff_plain;f=gtk%2Fgtkaccelgroup.c;h=c2d91028fd68a9b55802b3c84dbe4a24c53a7ee3;hb=3a86af43fa208786b5c848c09f9c8e1d3f060931;hp=d5d9b53a96e76f526f91198bd08acb3a98bd0ad3;hpb=fe852721123fb7dc5749c690613ca6e209363e2f;p=~andy%2Fgtk diff --git a/gtk/gtkaccelgroup.c b/gtk/gtkaccelgroup.c index d5d9b53a9..c2d91028f 100644 --- a/gtk/gtkaccelgroup.c +++ b/gtk/gtkaccelgroup.c @@ -8,20 +8,18 @@ * * This library is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * Lesser General Public License for more details. * * You should have received a copy of the GNU Lesser General Public - * License along with this library; if not, write to the - * Free Software Foundation, Inc., 59 Temple Place - Suite 330, - * Boston, MA 02111-1307, USA. + * License along with this library. If not, see . */ /* * Modified by the GTK+ Team and others 1997-2000. See the AUTHORS * file for a list of people on the GTK+ Team. See the ChangeLog * files for a list of changes. These files are distributed with - * GTK+ at ftp://ftp.gtk.org/pub/gtk/. + * GTK+ at ftp://ftp.gtk.org/pub/gtk/. */ #include "config.h" @@ -29,29 +27,28 @@ #include #include "gtkaccelgroup.h" -#include "gtkaccellabel.h" /* For _gtk_accel_label_class_get_accelerator_label */ -#include "gtkaccelmap.h" +#include "gtkaccelgroupprivate.h" +#include "gtkaccellabel.h" +#include "gtkaccelmapprivate.h" #include "gtkintl.h" -#include "gtkmain.h" /* For _gtk_boolean_handled_accumulator */ -#include "gdk/gdkkeysyms.h" #include "gtkmarshalers.h" -#include "gtkalias.h" +#include "gtkprivate.h" /** * SECTION:gtkaccelgroup - * @Short_description: Groups of global keyboard accelerators for an entire GtkWindow + * @Short_description: Groups of global keyboard accelerators for an + * entire GtkWindow * @Title: Accelerator Groups * @See_also:gtk_window_add_accel_group(), gtk_accel_map_change_entry(), * gtk_item_factory_new(), gtk_label_new_with_mnemonic() - * + * * A #GtkAccelGroup represents a group of keyboard accelerators, * typically attached to a toplevel #GtkWindow (with * gtk_window_add_accel_group()). Usually you won't need to create a - * #GtkAccelGroup directly; instead, when using #GtkItemFactory, GTK+ - * automatically sets up the accelerators for your menus in the item - * factory's #GtkAccelGroup. - * - * + * #GtkAccelGroup directly; instead, when using #GtkUIManager, GTK+ + * automatically sets up the accelerators for your menus in the ui + * manager's #GtkAccelGroup. + * * Note that accelerators are different from * mnemonics. Accelerators are shortcuts for * activating a menu item; they appear alongside the menu item they're a @@ -62,7 +59,6 @@ * and mnemonics, of course. */ - /* --- prototypes --- */ static void gtk_accel_group_finalize (GObject *object); static void gtk_accel_group_get_property (GObject *object, @@ -132,20 +128,20 @@ gtk_accel_group_class_init (GtkAccelGroupClass *class) * * The accel-activate signal is an implementation detail of * #GtkAccelGroup and not meant to be used by applications. - * + * * Returns: %TRUE if the accelerator was activated */ signal_accel_activate = g_signal_new (I_("accel-activate"), - G_OBJECT_CLASS_TYPE (class), - G_SIGNAL_DETAILED, - 0, - _gtk_boolean_handled_accumulator, NULL, - _gtk_marshal_BOOLEAN__OBJECT_UINT_FLAGS, - G_TYPE_BOOLEAN, 3, - G_TYPE_OBJECT, - G_TYPE_UINT, - GDK_TYPE_MODIFIER_TYPE); + G_OBJECT_CLASS_TYPE (class), + G_SIGNAL_DETAILED, + 0, + _gtk_boolean_handled_accumulator, NULL, + _gtk_marshal_BOOLEAN__OBJECT_UINT_FLAGS, + G_TYPE_BOOLEAN, 3, + G_TYPE_OBJECT, + G_TYPE_UINT, + GDK_TYPE_MODIFIER_TYPE); /** * GtkAccelGroup::accel-changed: * @accel_group: the #GtkAccelGroup which received the signal @@ -153,24 +149,26 @@ gtk_accel_group_class_init (GtkAccelGroupClass *class) * @modifier: the modifier combination of the accelerator * @accel_closure: the #GClosure of the accelerator * - * The accel-changed signal is emitted when a #GtkAccelGroupEntry - * is added to or removed from the accel group. + * The accel-changed signal is emitted when an entry + * is added to or removed from the accel group. * - * Widgets like #GtkAccelLabel which display an associated - * accelerator should connect to this signal, and rebuild + * Widgets like #GtkAccelLabel which display an associated + * accelerator should connect to this signal, and rebuild * their visual representation if the @accel_closure is theirs. */ signal_accel_changed = g_signal_new (I_("accel-changed"), - G_OBJECT_CLASS_TYPE (class), - G_SIGNAL_RUN_FIRST | G_SIGNAL_DETAILED, - G_STRUCT_OFFSET (GtkAccelGroupClass, accel_changed), - NULL, NULL, - _gtk_marshal_VOID__UINT_FLAGS_BOXED, - G_TYPE_NONE, 3, - G_TYPE_UINT, - GDK_TYPE_MODIFIER_TYPE, - G_TYPE_CLOSURE); + G_OBJECT_CLASS_TYPE (class), + G_SIGNAL_RUN_FIRST | G_SIGNAL_DETAILED, + G_STRUCT_OFFSET (GtkAccelGroupClass, accel_changed), + NULL, NULL, + _gtk_marshal_VOID__UINT_FLAGS_BOXED, + G_TYPE_NONE, 3, + G_TYPE_UINT, + GDK_TYPE_MODIFIER_TYPE, + G_TYPE_CLOSURE); + + g_type_class_add_private (object_class, sizeof (GtkAccelGroupPrivate)); } static void @@ -178,24 +176,24 @@ gtk_accel_group_finalize (GObject *object) { GtkAccelGroup *accel_group = GTK_ACCEL_GROUP (object); guint i; - - for (i = 0; i < accel_group->n_accels; i++) + + for (i = 0; i < accel_group->priv->n_accels; i++) { - GtkAccelGroupEntry *entry = &accel_group->priv_accels[i]; + GtkAccelGroupEntry *entry = &accel_group->priv->priv_accels[i]; if (entry->accel_path_quark) - { - const gchar *accel_path = g_quark_to_string (entry->accel_path_quark); + { + const gchar *accel_path = g_quark_to_string (entry->accel_path_quark); - _gtk_accel_map_remove_group (accel_path, accel_group); - } + _gtk_accel_map_remove_group (accel_path, accel_group); + } g_closure_remove_invalidate_notifier (entry->closure, accel_group, accel_closure_invalidate); /* remove quick_accel_add() refcount */ g_closure_unref (entry->closure); } - g_free (accel_group->priv_accels); + g_free (accel_group->priv->priv_accels); G_OBJECT_CLASS (gtk_accel_group_parent_class)->finalize (object); } @@ -211,10 +209,10 @@ gtk_accel_group_get_property (GObject *object, switch (param_id) { case PROP_IS_LOCKED: - g_value_set_boolean (value, accel_group->lock_count > 0); + g_value_set_boolean (value, accel_group->priv->lock_count > 0); break; case PROP_MODIFIER_MASK: - g_value_set_flags (value, accel_group->modifier_mask); + g_value_set_flags (value, accel_group->priv->modifier_mask); break; default: G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec); @@ -225,18 +223,26 @@ gtk_accel_group_get_property (GObject *object, static void gtk_accel_group_init (GtkAccelGroup *accel_group) { - accel_group->lock_count = 0; - accel_group->modifier_mask = gtk_accelerator_get_default_mod_mask (); - accel_group->acceleratables = NULL; - accel_group->n_accels = 0; - accel_group->priv_accels = NULL; + GtkAccelGroupPrivate *priv; + + accel_group->priv = G_TYPE_INSTANCE_GET_PRIVATE (accel_group, + GTK_TYPE_ACCEL_GROUP, + GtkAccelGroupPrivate); + priv = accel_group->priv; + + priv->lock_count = 0; + priv->modifier_mask = gtk_accelerator_get_default_mod_mask (); + priv->acceleratables = NULL; + priv->n_accels = 0; + priv->priv_accels = NULL; } /** * gtk_accel_group_new: - * @returns: a new #GtkAccelGroup object - * - * Creates a new #GtkAccelGroup. + * + * Creates a new #GtkAccelGroup. + * + * Returns: a new #GtkAccelGroup object */ GtkAccelGroup* gtk_accel_group_new (void) @@ -252,7 +258,7 @@ gtk_accel_group_new (void) * gtk_accel_group_unlock(). * * Returns: %TRUE if there are 1 or more locks on the @accel_group, - * %FALSE otherwise. + * %FALSE otherwise. * * Since: 2.14 */ @@ -261,7 +267,7 @@ gtk_accel_group_get_is_locked (GtkAccelGroup *accel_group) { g_return_val_if_fail (GTK_IS_ACCEL_GROUP (accel_group), FALSE); - return accel_group->lock_count > 0; + return accel_group->priv->lock_count > 0; } /** @@ -280,21 +286,21 @@ gtk_accel_group_get_modifier_mask (GtkAccelGroup *accel_group) { g_return_val_if_fail (GTK_IS_ACCEL_GROUP (accel_group), 0); - return accel_group->modifier_mask; + return accel_group->priv->modifier_mask; } static void accel_group_weak_ref_detach (GSList *free_list, - GObject *stale_object) + GObject *stale_object) { GSList *slist; - + for (slist = free_list; slist; slist = slist->next) { GtkAccelGroup *accel_group; - + accel_group = slist->data; - accel_group->acceleratables = g_slist_remove (accel_group->acceleratables, stale_object); + accel_group->priv->acceleratables = g_slist_remove (accel_group->priv->acceleratables, stale_object); g_object_unref (accel_group); } g_slist_free (free_list); @@ -303,84 +309,86 @@ accel_group_weak_ref_detach (GSList *free_list, void _gtk_accel_group_attach (GtkAccelGroup *accel_group, - GObject *object) + GObject *object) { GSList *slist; - + g_return_if_fail (GTK_IS_ACCEL_GROUP (accel_group)); g_return_if_fail (G_IS_OBJECT (object)); - g_return_if_fail (g_slist_find (accel_group->acceleratables, object) == NULL); - + g_return_if_fail (g_slist_find (accel_group->priv->acceleratables, object) == NULL); + g_object_ref (accel_group); - accel_group->acceleratables = g_slist_prepend (accel_group->acceleratables, object); + accel_group->priv->acceleratables = g_slist_prepend (accel_group->priv->acceleratables, object); slist = g_object_get_qdata (object, quark_acceleratable_groups); if (slist) g_object_weak_unref (object, - (GWeakNotify) accel_group_weak_ref_detach, - slist); + (GWeakNotify) accel_group_weak_ref_detach, + slist); slist = g_slist_prepend (slist, accel_group); g_object_set_qdata (object, quark_acceleratable_groups, slist); g_object_weak_ref (object, - (GWeakNotify) accel_group_weak_ref_detach, - slist); + (GWeakNotify) accel_group_weak_ref_detach, + slist); } void _gtk_accel_group_detach (GtkAccelGroup *accel_group, - GObject *object) + GObject *object) { GSList *slist; - + g_return_if_fail (GTK_IS_ACCEL_GROUP (accel_group)); g_return_if_fail (G_IS_OBJECT (object)); - g_return_if_fail (g_slist_find (accel_group->acceleratables, object) != NULL); - - accel_group->acceleratables = g_slist_remove (accel_group->acceleratables, object); + g_return_if_fail (g_slist_find (accel_group->priv->acceleratables, object) != NULL); + + accel_group->priv->acceleratables = g_slist_remove (accel_group->priv->acceleratables, object); slist = g_object_get_qdata (object, quark_acceleratable_groups); g_object_weak_unref (object, - (GWeakNotify) accel_group_weak_ref_detach, - slist); + (GWeakNotify) accel_group_weak_ref_detach, + slist); slist = g_slist_remove (slist, accel_group); g_object_set_qdata (object, quark_acceleratable_groups, slist); if (slist) g_object_weak_ref (object, - (GWeakNotify) accel_group_weak_ref_detach, - slist); + (GWeakNotify) accel_group_weak_ref_detach, + slist); g_object_unref (accel_group); } /** * gtk_accel_groups_from_object: - * @object: a #GObject, usually a #GtkWindow + * @object: a #GObject, usually a #GtkWindow * * Gets a list of all accel groups which are attached to @object. * - * Returns: (element-type GtkAccelGroup) (transfer none): a list of all accel groups which are attached to @object + * Returns: (element-type GtkAccelGroup) (transfer none): a list of + * all accel groups which are attached to @object */ GSList* gtk_accel_groups_from_object (GObject *object) { g_return_val_if_fail (G_IS_OBJECT (object), NULL); - + return g_object_get_qdata (object, quark_acceleratable_groups); } /** * gtk_accel_group_find: * @accel_group: a #GtkAccelGroup - * @find_func: a function to filter the entries of @accel_group with + * @find_func: (scope call): a function to filter the entries + * of @accel_group with * @data: data to pass to @find_func - * @returns: the key of the first entry passing @find_func. The key is - * owned by GTK+ and must not be freed. * - * Finds the first entry in an accelerator group for which + * Finds the first entry in an accelerator group for which * @find_func returns %TRUE and returns its #GtkAccelKey. * + * Returns: (transfer none): the key of the first entry passing + * @find_func. The key is owned by GTK+ and must not be freed. */ GtkAccelKey* -gtk_accel_group_find (GtkAccelGroup *accel_group, - GtkAccelGroupFindFunc find_func, - gpointer data) +gtk_accel_group_find (GtkAccelGroup *accel_group, + GtkAccelGroupFindFunc find_func, + gpointer data) { GtkAccelKey *key = NULL; guint i; @@ -389,13 +397,13 @@ gtk_accel_group_find (GtkAccelGroup *accel_group, g_return_val_if_fail (find_func != NULL, NULL); g_object_ref (accel_group); - for (i = 0; i < accel_group->n_accels; i++) - if (find_func (&accel_group->priv_accels[i].key, - accel_group->priv_accels[i].closure, - data)) + for (i = 0; i < accel_group->priv->n_accels; i++) + if (find_func (&accel_group->priv->priv_accels[i].key, + accel_group->priv->priv_accels[i].closure, + data)) { - key = &accel_group->priv_accels[i].key; - break; + key = &accel_group->priv->priv_accels[i].key; + break; } g_object_unref (accel_group); @@ -405,7 +413,7 @@ gtk_accel_group_find (GtkAccelGroup *accel_group, /** * gtk_accel_group_lock: * @accel_group: a #GtkAccelGroup - * + * * Locks the given accelerator group. * * Locking an acelerator group prevents the accelerators contained @@ -420,10 +428,10 @@ void gtk_accel_group_lock (GtkAccelGroup *accel_group) { g_return_if_fail (GTK_IS_ACCEL_GROUP (accel_group)); - - accel_group->lock_count += 1; - if (accel_group->lock_count == 1) { + accel_group->priv->lock_count += 1; + + if (accel_group->priv->lock_count == 1) { /* State change from unlocked to locked */ g_object_notify (G_OBJECT (accel_group), "is-locked"); } @@ -432,18 +440,18 @@ gtk_accel_group_lock (GtkAccelGroup *accel_group) /** * gtk_accel_group_unlock: * @accel_group: a #GtkAccelGroup - * + * * Undoes the last call to gtk_accel_group_lock() on this @accel_group. */ void gtk_accel_group_unlock (GtkAccelGroup *accel_group) { g_return_if_fail (GTK_IS_ACCEL_GROUP (accel_group)); - g_return_if_fail (accel_group->lock_count > 0); + g_return_if_fail (accel_group->priv->lock_count > 0); - accel_group->lock_count -= 1; + accel_group->priv->lock_count -= 1; - if (accel_group->lock_count < 1) { + if (accel_group->priv->lock_count < 1) { /* State change from locked to unlocked */ g_object_notify (G_OBJECT (accel_group), "is-locked"); } @@ -451,7 +459,7 @@ gtk_accel_group_unlock (GtkAccelGroup *accel_group) static void accel_closure_invalidate (gpointer data, - GClosure *closure) + GClosure *closure) { GtkAccelGroup *accel_group = GTK_ACCEL_GROUP (data); @@ -460,7 +468,7 @@ accel_closure_invalidate (gpointer data, static int bsearch_compare_accels (const void *d1, - const void *d2) + const void *d2) { const GtkAccelGroupEntry *entry1 = d1; const GtkAccelGroupEntry *entry2 = d2; @@ -472,34 +480,34 @@ bsearch_compare_accels (const void *d1, } static void -quick_accel_add (GtkAccelGroup *accel_group, - guint accel_key, - GdkModifierType accel_mods, - GtkAccelFlags accel_flags, - GClosure *closure, - GQuark path_quark) +quick_accel_add (GtkAccelGroup *accel_group, + guint accel_key, + GdkModifierType accel_mods, + GtkAccelFlags accel_flags, + GClosure *closure, + GQuark path_quark) { - guint pos, i = accel_group->n_accels++; + guint pos, i = accel_group->priv->n_accels++; GtkAccelGroupEntry key; /* find position */ key.key.accel_key = accel_key; key.key.accel_mods = accel_mods; for (pos = 0; pos < i; pos++) - if (bsearch_compare_accels (&key, accel_group->priv_accels + pos) < 0) + if (bsearch_compare_accels (&key, accel_group->priv->priv_accels + pos) < 0) break; /* insert at position, ref closure */ - accel_group->priv_accels = g_renew (GtkAccelGroupEntry, accel_group->priv_accels, accel_group->n_accels); - g_memmove (accel_group->priv_accels + pos + 1, accel_group->priv_accels + pos, - (i - pos) * sizeof (accel_group->priv_accels[0])); - accel_group->priv_accels[pos].key.accel_key = accel_key; - accel_group->priv_accels[pos].key.accel_mods = accel_mods; - accel_group->priv_accels[pos].key.accel_flags = accel_flags; - accel_group->priv_accels[pos].closure = g_closure_ref (closure); - accel_group->priv_accels[pos].accel_path_quark = path_quark; + accel_group->priv->priv_accels = g_renew (GtkAccelGroupEntry, accel_group->priv->priv_accels, accel_group->priv->n_accels); + g_memmove (accel_group->priv->priv_accels + pos + 1, accel_group->priv->priv_accels + pos, + (i - pos) * sizeof (accel_group->priv->priv_accels[0])); + accel_group->priv->priv_accels[pos].key.accel_key = accel_key; + accel_group->priv->priv_accels[pos].key.accel_mods = accel_mods; + accel_group->priv->priv_accels[pos].key.accel_flags = accel_flags; + accel_group->priv->priv_accels[pos].closure = g_closure_ref (closure); + accel_group->priv->priv_accels[pos].accel_path_quark = path_quark; g_closure_sink (closure); - + /* handle closure invalidation and reverse lookups */ g_closure_add_invalidate_notifier (closure, accel_group, accel_closure_invalidate); @@ -514,21 +522,21 @@ quick_accel_add (GtkAccelGroup *accel_group, GQuark accel_quark = g_quark_from_string (accel_name); g_free (accel_name); - + /* setup handler */ g_signal_connect_closure_by_id (accel_group, signal_accel_activate, accel_quark, closure, FALSE); - + /* and notify */ g_signal_emit (accel_group, signal_accel_changed, accel_quark, accel_key, accel_mods, closure); } } static void -quick_accel_remove (GtkAccelGroup *accel_group, - guint pos) +quick_accel_remove (GtkAccelGroup *accel_group, + guint pos) { GQuark accel_quark = 0; - GtkAccelGroupEntry *entry = accel_group->priv_accels + pos; + GtkAccelGroupEntry *entry = accel_group->priv->priv_accels + pos; guint accel_key = entry->key.accel_key; GdkModifierType accel_mods = entry->key.accel_mods; GClosure *closure = entry->closure; @@ -546,17 +554,17 @@ quick_accel_remove (GtkAccelGroup *accel_group, g_closure_remove_invalidate_notifier (entry->closure, accel_group, accel_closure_invalidate); if (accel_quark) g_signal_handlers_disconnect_matched (accel_group, - G_SIGNAL_MATCH_ID | G_SIGNAL_MATCH_DETAIL | G_SIGNAL_MATCH_CLOSURE, - signal_accel_activate, accel_quark, - closure, NULL, NULL); + G_SIGNAL_MATCH_ID | G_SIGNAL_MATCH_DETAIL | G_SIGNAL_MATCH_CLOSURE, + signal_accel_activate, accel_quark, + closure, NULL, NULL); /* clean up accel path notification */ if (entry->accel_path_quark) _gtk_accel_map_remove_group (g_quark_to_string (entry->accel_path_quark), accel_group); /* physically remove */ - accel_group->n_accels -= 1; + accel_group->priv->n_accels -= 1; g_memmove (entry, entry + 1, - (accel_group->n_accels - pos) * sizeof (accel_group->priv_accels[0])); + (accel_group->priv->n_accels - pos) * sizeof (accel_group->priv->priv_accels[0])); /* and notify */ if (accel_quark) @@ -567,64 +575,64 @@ quick_accel_remove (GtkAccelGroup *accel_group, } static GtkAccelGroupEntry* -quick_accel_find (GtkAccelGroup *accel_group, - guint accel_key, - GdkModifierType accel_mods, - guint *count_p) +quick_accel_find (GtkAccelGroup *accel_group, + guint accel_key, + GdkModifierType accel_mods, + guint *count_p) { GtkAccelGroupEntry *entry; GtkAccelGroupEntry key; *count_p = 0; - if (!accel_group->n_accels) + if (!accel_group->priv->n_accels) return NULL; key.key.accel_key = accel_key; key.key.accel_mods = accel_mods; - entry = bsearch (&key, accel_group->priv_accels, accel_group->n_accels, - sizeof (accel_group->priv_accels[0]), bsearch_compare_accels); - + entry = bsearch (&key, accel_group->priv->priv_accels, accel_group->priv->n_accels, + sizeof (accel_group->priv->priv_accels[0]), bsearch_compare_accels); + if (!entry) return NULL; /* step back to the first member */ - for (; entry > accel_group->priv_accels; entry--) + for (; entry > accel_group->priv->priv_accels; entry--) if (entry[-1].key.accel_key != accel_key || - entry[-1].key.accel_mods != accel_mods) + entry[-1].key.accel_mods != accel_mods) break; /* count equal members */ - for (; entry + *count_p < accel_group->priv_accels + accel_group->n_accels; (*count_p)++) + for (; entry + *count_p < accel_group->priv->priv_accels + accel_group->priv->n_accels; (*count_p)++) if (entry[*count_p].key.accel_key != accel_key || - entry[*count_p].key.accel_mods != accel_mods) + entry[*count_p].key.accel_mods != accel_mods) break; return entry; } /** * gtk_accel_group_connect: - * @accel_group: the accelerator group to install an accelerator in - * @accel_key: key value of the accelerator - * @accel_mods: modifier combination of the accelerator - * @accel_flags: a flag mask to configure this accelerator - * @closure: closure to be executed upon accelerator activation + * @accel_group: the accelerator group to install an accelerator in + * @accel_key: key value of the accelerator + * @accel_mods: modifier combination of the accelerator + * @accel_flags: a flag mask to configure this accelerator + * @closure: closure to be executed upon accelerator activation * - * Installs an accelerator in this group. When @accel_group is being activated - * in response to a call to gtk_accel_groups_activate(), @closure will be - * invoked if the @accel_key and @accel_mods from gtk_accel_groups_activate() - * match those of this connection. + * Installs an accelerator in this group. When @accel_group is being + * activated in response to a call to gtk_accel_groups_activate(), + * @closure will be invoked if the @accel_key and @accel_mods from + * gtk_accel_groups_activate() match those of this connection. * * The signature used for the @closure is that of #GtkAccelGroupActivate. - * - * Note that, due to implementation details, a single closure can only be - * connected to one accelerator group. + * + * Note that, due to implementation details, a single closure can + * only be connected to one accelerator group. */ void -gtk_accel_group_connect (GtkAccelGroup *accel_group, - guint accel_key, - GdkModifierType accel_mods, - GtkAccelFlags accel_flags, - GClosure *closure) +gtk_accel_group_connect (GtkAccelGroup *accel_group, + guint accel_key, + GdkModifierType accel_mods, + GtkAccelFlags accel_flags, + GClosure *closure) { g_return_if_fail (GTK_IS_ACCEL_GROUP (accel_group)); g_return_if_fail (closure != NULL); @@ -634,34 +642,34 @@ gtk_accel_group_connect (GtkAccelGroup *accel_group, g_object_ref (accel_group); if (!closure->is_invalid) quick_accel_add (accel_group, - gdk_keyval_to_lower (accel_key), - accel_mods, accel_flags, closure, 0); + gdk_keyval_to_lower (accel_key), + accel_mods, accel_flags, closure, 0); g_object_unref (accel_group); } /** * gtk_accel_group_connect_by_path: - * @accel_group: the accelerator group to install an accelerator in - * @accel_path: path used for determining key and modifiers. - * @closure: closure to be executed upon accelerator activation + * @accel_group: the accelerator group to install an accelerator in + * @accel_path: path used for determining key and modifiers + * @closure: closure to be executed upon accelerator activation * - * Installs an accelerator in this group, using an accelerator path to look - * up the appropriate key and modifiers (see gtk_accel_map_add_entry()). - * When @accel_group is being activated in response to a call to - * gtk_accel_groups_activate(), @closure will be invoked if the @accel_key and - * @accel_mods from gtk_accel_groups_activate() match the key and modifiers - * for the path. + * Installs an accelerator in this group, using an accelerator path + * to look up the appropriate key and modifiers (see + * gtk_accel_map_add_entry()). When @accel_group is being activated + * in response to a call to gtk_accel_groups_activate(), @closure will + * be invoked if the @accel_key and @accel_mods from + * gtk_accel_groups_activate() match the key and modifiers for the path. * * The signature used for the @closure is that of #GtkAccelGroupActivate. - * - * Note that @accel_path string will be stored in a #GQuark. Therefore, if you - * pass a static string, you can save some memory by interning it first with - * g_intern_static_string(). + * + * Note that @accel_path string will be stored in a #GQuark. Therefore, + * if you pass a static string, you can save some memory by interning it + * first with g_intern_static_string(). */ void -gtk_accel_group_connect_by_path (GtkAccelGroup *accel_group, - const gchar *accel_path, - GClosure *closure) +gtk_accel_group_connect_by_path (GtkAccelGroup *accel_group, + const gchar *accel_path, + GClosure *closure) { guint accel_key = 0; GdkModifierType accel_mods = 0; @@ -683,7 +691,7 @@ gtk_accel_group_connect_by_path (GtkAccelGroup *accel_group, } quick_accel_add (accel_group, accel_key, accel_mods, GTK_ACCEL_VISIBLE, closure, - g_quark_from_string (accel_path)); + g_quark_from_string (accel_path)); g_object_unref (accel_group); } @@ -691,49 +699,51 @@ gtk_accel_group_connect_by_path (GtkAccelGroup *accel_group, /** * gtk_accel_group_disconnect: * @accel_group: the accelerator group to remove an accelerator from - * @closure: (allow-none): the closure to remove from this accelerator group, or %NULL - * to remove all closures - * @returns: %TRUE if the closure was found and got disconnected + * @closure: (allow-none): the closure to remove from this accelerator + * group, or %NULL to remove all closures * * Removes an accelerator previously installed through * gtk_accel_group_connect(). * * Since 2.20 @closure can be %NULL. + * + * Returns: %TRUE if the closure was found and got disconnected */ gboolean gtk_accel_group_disconnect (GtkAccelGroup *accel_group, - GClosure *closure) + GClosure *closure) { guint i; g_return_val_if_fail (GTK_IS_ACCEL_GROUP (accel_group), FALSE); - for (i = 0; i < accel_group->n_accels; i++) - if (accel_group->priv_accels[i].closure == closure || !closure) + for (i = 0; i < accel_group->priv->n_accels; i++) + if (accel_group->priv->priv_accels[i].closure == closure) { - g_object_ref (accel_group); - quick_accel_remove (accel_group, i); - g_object_unref (accel_group); - return TRUE; + g_object_ref (accel_group); + quick_accel_remove (accel_group, i); + g_object_unref (accel_group); + return TRUE; } return FALSE; } /** * gtk_accel_group_disconnect_key: - * @accel_group: the accelerator group to install an accelerator in - * @accel_key: key value of the accelerator - * @accel_mods: modifier combination of the accelerator - * @returns: %TRUE if there was an accelerator which could be - * removed, %FALSE otherwise + * @accel_group: the accelerator group to install an accelerator in + * @accel_key: key value of the accelerator + * @accel_mods: modifier combination of the accelerator * * Removes an accelerator previously installed through * gtk_accel_group_connect(). + * + * Returns: %TRUE if there was an accelerator which could be + * removed, %FALSE otherwise */ gboolean -gtk_accel_group_disconnect_key (GtkAccelGroup *accel_group, - guint accel_key, - GdkModifierType accel_mods) +gtk_accel_group_disconnect_key (GtkAccelGroup *accel_group, + guint accel_key, + GdkModifierType accel_mods) { GtkAccelGroupEntry *entries; GSList *slist, *clist = NULL; @@ -743,7 +753,7 @@ gtk_accel_group_disconnect_key (GtkAccelGroup *accel_group, g_return_val_if_fail (GTK_IS_ACCEL_GROUP (accel_group), FALSE); g_object_ref (accel_group); - + accel_key = gdk_keyval_to_lower (accel_key); entries = quick_accel_find (accel_group, accel_key, accel_mods, &n); while (n--) @@ -769,7 +779,7 @@ gtk_accel_group_disconnect_key (GtkAccelGroup *accel_group, void _gtk_accel_group_reconnect (GtkAccelGroup *accel_group, - GQuark accel_path_quark) + GQuark accel_path_quark) { GSList *slist, *clist = NULL; guint i; @@ -778,12 +788,12 @@ _gtk_accel_group_reconnect (GtkAccelGroup *accel_group, g_object_ref (accel_group); - for (i = 0; i < accel_group->n_accels; i++) - if (accel_group->priv_accels[i].accel_path_quark == accel_path_quark) + for (i = 0; i < accel_group->priv->n_accels; i++) + if (accel_group->priv->priv_accels[i].accel_path_quark == accel_path_quark) { - GClosure *closure = g_closure_ref (accel_group->priv_accels[i].closure); + GClosure *closure = g_closure_ref (accel_group->priv->priv_accels[i].closure); - clist = g_slist_prepend (clist, closure); + clist = g_slist_prepend (clist, closure); } for (slist = clist; slist; slist = slist->next) @@ -799,22 +809,34 @@ _gtk_accel_group_reconnect (GtkAccelGroup *accel_group, g_object_unref (accel_group); } +GSList* +_gtk_accel_group_get_accelerables (GtkAccelGroup *accel_group) +{ + g_return_val_if_fail (GTK_IS_ACCEL_GROUP (accel_group), NULL); + + return accel_group->priv->acceleratables; +} + /** * gtk_accel_group_query: - * @accel_group: the accelerator group to query - * @accel_key: key value of the accelerator - * @accel_mods: modifier combination of the accelerator - * @n_entries: (allow-none): location to return the number of entries found, or %NULL - * @returns: (allow-none): an array of @n_entries #GtkAccelGroupEntry elements, or %NULL. The array is owned by GTK+ and must not be freed. - * - * Queries an accelerator group for all entries matching @accel_key and - * @accel_mods. + * @accel_group: the accelerator group to query + * @accel_key: key value of the accelerator + * @accel_mods: modifier combination of the accelerator + * @n_entries: (allow-none): location to return the number + * of entries found, or %NULL + * + * Queries an accelerator group for all entries matching @accel_key + * and @accel_mods. + * + * Returns: (transfer none) (array length=n_entries): an array of + * @n_entries #GtkAccelGroupEntry elements, or %NULL. The array + * is owned by GTK+ and must not be freed. */ GtkAccelGroupEntry* -gtk_accel_group_query (GtkAccelGroup *accel_group, - guint accel_key, - GdkModifierType accel_mods, - guint *n_entries) +gtk_accel_group_query (GtkAccelGroup *accel_group, + guint accel_key, + GdkModifierType accel_mods, + guint *n_entries) { GtkAccelGroupEntry *entries; guint n; @@ -832,10 +854,12 @@ gtk_accel_group_query (GtkAccelGroup *accel_group, /** * gtk_accel_group_from_accel_closure: * @closure: a #GClosure - * @returns: (allow-none): the #GtkAccelGroup to which @closure is connected, or %NULL. * - * Finds the #GtkAccelGroup to which @closure is connected; + * Finds the #GtkAccelGroup to which @closure is connected; * see gtk_accel_group_connect(). + * + * Returns: (transfer none): the #GtkAccelGroup to which @closure + * is connected, or %NULL */ GtkAccelGroup* gtk_accel_group_from_accel_closure (GClosure *closure) @@ -844,12 +868,13 @@ gtk_accel_group_from_accel_closure (GClosure *closure) g_return_val_if_fail (closure != NULL, NULL); - /* a few remarks on what we do here. in general, we need a way to reverse lookup - * accel_groups from closures that are being used in accel groups. this could - * be done e.g via a hashtable. it is however cheaper (memory wise) to just - * use the invalidation notifier on the closure itself (which we need to install - * anyway), that contains the accel group as data which, besides needing to peek - * a bit at closure internals, works just as good. + /* A few remarks on what we do here. in general, we need a way to + * reverse lookup accel_groups from closures that are being used in + * accel groups. this could be done e.g via a hashtable. it is however + * cheaper (memory wise) to just use the invalidation notifier on the + * closure itself (which we need to install anyway), that contains the + * accel group as data which, besides needing to peek a bit at closure + * internals, works just as good. */ for (i = 0; i < G_CLOSURE_N_NOTIFIERS (closure); i++) if (closure->notifiers[i].notify == accel_closure_invalidate) @@ -860,58 +885,59 @@ gtk_accel_group_from_accel_closure (GClosure *closure) /** * gtk_accel_group_activate: - * @accel_group: a #GtkAccelGroup - * @accel_quark: the quark for the accelerator name + * @accel_group: a #GtkAccelGroup + * @accel_quark: the quark for the accelerator name * @acceleratable: the #GObject, usually a #GtkWindow, on which - * to activate the accelerator. - * @accel_key: accelerator keyval from a key event - * @accel_mods: keyboard state mask from a key event - * - * Finds the first accelerator in @accel_group - * that matches @accel_key and @accel_mods, and - * activates it. - * - * Returns: %TRUE if an accelerator was activated and handled this keypress + * to activate the accelerator + * @accel_key: accelerator keyval from a key event + * @accel_mods: keyboard state mask from a key event + * + * Finds the first accelerator in @accel_group that matches + * @accel_key and @accel_mods, and activates it. + * + * Returns: %TRUE if an accelerator was activated and handled + * this keypress */ gboolean gtk_accel_group_activate (GtkAccelGroup *accel_group, - GQuark accel_quark, - GObject *acceleratable, - guint accel_key, + GQuark accel_quark, + GObject *acceleratable, + guint accel_key, GdkModifierType accel_mods) { gboolean was_handled; g_return_val_if_fail (GTK_IS_ACCEL_GROUP (accel_group), FALSE); g_return_val_if_fail (G_IS_OBJECT (acceleratable), FALSE); - + was_handled = FALSE; g_signal_emit (accel_group, signal_accel_activate, accel_quark, - acceleratable, accel_key, accel_mods, &was_handled); + acceleratable, accel_key, accel_mods, &was_handled); return was_handled; } /** * gtk_accel_groups_activate: - * @object: the #GObject, usually a #GtkWindow, on which - * to activate the accelerator. - * @accel_key: accelerator keyval from a key event - * @accel_mods: keyboard state mask from a key event - * + * @object: the #GObject, usually a #GtkWindow, on which + * to activate the accelerator + * @accel_key: accelerator keyval from a key event + * @accel_mods: keyboard state mask from a key event + * * Finds the first accelerator in any #GtkAccelGroup attached * to @object that matches @accel_key and @accel_mods, and * activates that accelerator. * - * Returns: %TRUE if an accelerator was activated and handled this keypress + * Returns: %TRUE if an accelerator was activated and handled + * this keypress */ gboolean -gtk_accel_groups_activate (GObject *object, - guint accel_key, - GdkModifierType accel_mods) +gtk_accel_groups_activate (GObject *object, + guint accel_key, + GdkModifierType accel_mods) { g_return_val_if_fail (G_IS_OBJECT (object), FALSE); - + if (gtk_accelerator_valid (accel_key, accel_mods)) { gchar *accel_name; @@ -921,54 +947,57 @@ gtk_accel_groups_activate (GObject *object, accel_name = gtk_accelerator_name (accel_key, (accel_mods & gtk_accelerator_get_default_mod_mask ())); accel_quark = g_quark_from_string (accel_name); g_free (accel_name); - + for (slist = gtk_accel_groups_from_object (object); slist; slist = slist->next) - if (gtk_accel_group_activate (slist->data, accel_quark, object, accel_key, accel_mods)) - return TRUE; + if (gtk_accel_group_activate (slist->data, accel_quark, object, accel_key, accel_mods)) + return TRUE; } - + return FALSE; } /** * gtk_accelerator_valid: - * @keyval: a GDK keyval + * @keyval: a GDK keyval * @modifiers: modifier mask - * @returns: %TRUE if the accelerator is valid - * + * * Determines whether a given keyval and modifier mask constitute - * a valid keyboard accelerator. For example, the #GDK_a keyval + * a valid keyboard accelerator. For example, the #GDK_KEY_a keyval * plus #GDK_CONTROL_MASK is valid - this is a "Ctrl+a" accelerator. - * But, you can't, for instance, use the #GDK_Control_L keyval + * But, you can't, for instance, use the #GDK_KEY_Control_L keyval * as an accelerator. + * + * Returns: %TRUE if the accelerator is valid */ gboolean -gtk_accelerator_valid (guint keyval, - GdkModifierType modifiers) +gtk_accelerator_valid (guint keyval, + GdkModifierType modifiers) { static const guint invalid_accelerator_vals[] = { - GDK_Shift_L, GDK_Shift_R, GDK_Shift_Lock, GDK_Caps_Lock, GDK_ISO_Lock, - GDK_Control_L, GDK_Control_R, GDK_Meta_L, GDK_Meta_R, - GDK_Alt_L, GDK_Alt_R, GDK_Super_L, GDK_Super_R, GDK_Hyper_L, GDK_Hyper_R, - GDK_ISO_Level3_Shift, GDK_ISO_Next_Group, GDK_ISO_Prev_Group, - GDK_ISO_First_Group, GDK_ISO_Last_Group, - GDK_Mode_switch, GDK_Num_Lock, GDK_Multi_key, - GDK_Scroll_Lock, GDK_Sys_Req, - GDK_Tab, GDK_ISO_Left_Tab, GDK_KP_Tab, - GDK_First_Virtual_Screen, GDK_Prev_Virtual_Screen, - GDK_Next_Virtual_Screen, GDK_Last_Virtual_Screen, - GDK_Terminate_Server, GDK_AudibleBell_Enable, + GDK_KEY_Shift_L, GDK_KEY_Shift_R, GDK_KEY_Shift_Lock, + GDK_KEY_Caps_Lock, GDK_KEY_ISO_Lock, GDK_KEY_Control_L, + GDK_KEY_Control_R, GDK_KEY_Meta_L, GDK_KEY_Meta_R, + GDK_KEY_Alt_L, GDK_KEY_Alt_R, GDK_KEY_Super_L, GDK_KEY_Super_R, + GDK_KEY_Hyper_L, GDK_KEY_Hyper_R, GDK_KEY_ISO_Level3_Shift, + GDK_KEY_ISO_Next_Group, GDK_KEY_ISO_Prev_Group, + GDK_KEY_ISO_First_Group, GDK_KEY_ISO_Last_Group, + GDK_KEY_Mode_switch, GDK_KEY_Num_Lock, GDK_KEY_Multi_key, + GDK_KEY_Scroll_Lock, GDK_KEY_Sys_Req, + GDK_KEY_Tab, GDK_KEY_ISO_Left_Tab, GDK_KEY_KP_Tab, + GDK_KEY_First_Virtual_Screen, GDK_KEY_Prev_Virtual_Screen, + GDK_KEY_Next_Virtual_Screen, GDK_KEY_Last_Virtual_Screen, + GDK_KEY_Terminate_Server, GDK_KEY_AudibleBell_Enable, 0 }; static const guint invalid_unmodified_vals[] = { - GDK_Up, GDK_Down, GDK_Left, GDK_Right, - GDK_KP_Up, GDK_KP_Down, GDK_KP_Left, GDK_KP_Right, + GDK_KEY_Up, GDK_KEY_Down, GDK_KEY_Left, GDK_KEY_Right, + GDK_KEY_KP_Up, GDK_KEY_KP_Down, GDK_KEY_KP_Left, GDK_KEY_KP_Right, 0 }; const guint *ac_val; modifiers &= GDK_MODIFIER_MASK; - + if (keyval <= 0xFF) return keyval >= 0x20; @@ -976,19 +1005,19 @@ gtk_accelerator_valid (guint keyval, while (*ac_val) { if (keyval == *ac_val++) - return FALSE; + return FALSE; } if (!modifiers) { ac_val = invalid_unmodified_vals; while (*ac_val) - { - if (keyval == *ac_val++) - return FALSE; - } + { + if (keyval == *ac_val++) + return FALSE; + } } - + return TRUE; } @@ -996,275 +1025,490 @@ static inline gboolean is_alt (const gchar *string) { return ((string[0] == '<') && - (string[1] == 'a' || string[1] == 'A') && - (string[2] == 'l' || string[2] == 'L') && - (string[3] == 't' || string[3] == 'T') && - (string[4] == '>')); + (string[1] == 'a' || string[1] == 'A') && + (string[2] == 'l' || string[2] == 'L') && + (string[3] == 't' || string[3] == 'T') && + (string[4] == '>')); } static inline gboolean is_ctl (const gchar *string) { return ((string[0] == '<') && - (string[1] == 'c' || string[1] == 'C') && - (string[2] == 't' || string[2] == 'T') && - (string[3] == 'l' || string[3] == 'L') && - (string[4] == '>')); + (string[1] == 'c' || string[1] == 'C') && + (string[2] == 't' || string[2] == 'T') && + (string[3] == 'l' || string[3] == 'L') && + (string[4] == '>')); } static inline gboolean is_modx (const gchar *string) { return ((string[0] == '<') && - (string[1] == 'm' || string[1] == 'M') && - (string[2] == 'o' || string[2] == 'O') && - (string[3] == 'd' || string[3] == 'D') && - (string[4] >= '1' && string[4] <= '5') && - (string[5] == '>')); + (string[1] == 'm' || string[1] == 'M') && + (string[2] == 'o' || string[2] == 'O') && + (string[3] == 'd' || string[3] == 'D') && + (string[4] >= '1' && string[4] <= '5') && + (string[5] == '>')); } static inline gboolean is_ctrl (const gchar *string) { return ((string[0] == '<') && - (string[1] == 'c' || string[1] == 'C') && - (string[2] == 't' || string[2] == 'T') && - (string[3] == 'r' || string[3] == 'R') && - (string[4] == 'l' || string[4] == 'L') && - (string[5] == '>')); + (string[1] == 'c' || string[1] == 'C') && + (string[2] == 't' || string[2] == 'T') && + (string[3] == 'r' || string[3] == 'R') && + (string[4] == 'l' || string[4] == 'L') && + (string[5] == '>')); } static inline gboolean is_shft (const gchar *string) { return ((string[0] == '<') && - (string[1] == 's' || string[1] == 'S') && - (string[2] == 'h' || string[2] == 'H') && - (string[3] == 'f' || string[3] == 'F') && - (string[4] == 't' || string[4] == 'T') && - (string[5] == '>')); + (string[1] == 's' || string[1] == 'S') && + (string[2] == 'h' || string[2] == 'H') && + (string[3] == 'f' || string[3] == 'F') && + (string[4] == 't' || string[4] == 'T') && + (string[5] == '>')); } static inline gboolean is_shift (const gchar *string) { return ((string[0] == '<') && - (string[1] == 's' || string[1] == 'S') && - (string[2] == 'h' || string[2] == 'H') && - (string[3] == 'i' || string[3] == 'I') && - (string[4] == 'f' || string[4] == 'F') && - (string[5] == 't' || string[5] == 'T') && - (string[6] == '>')); + (string[1] == 's' || string[1] == 'S') && + (string[2] == 'h' || string[2] == 'H') && + (string[3] == 'i' || string[3] == 'I') && + (string[4] == 'f' || string[4] == 'F') && + (string[5] == 't' || string[5] == 'T') && + (string[6] == '>')); } static inline gboolean is_control (const gchar *string) { return ((string[0] == '<') && - (string[1] == 'c' || string[1] == 'C') && - (string[2] == 'o' || string[2] == 'O') && - (string[3] == 'n' || string[3] == 'N') && - (string[4] == 't' || string[4] == 'T') && - (string[5] == 'r' || string[5] == 'R') && - (string[6] == 'o' || string[6] == 'O') && - (string[7] == 'l' || string[7] == 'L') && - (string[8] == '>')); + (string[1] == 'c' || string[1] == 'C') && + (string[2] == 'o' || string[2] == 'O') && + (string[3] == 'n' || string[3] == 'N') && + (string[4] == 't' || string[4] == 'T') && + (string[5] == 'r' || string[5] == 'R') && + (string[6] == 'o' || string[6] == 'O') && + (string[7] == 'l' || string[7] == 'L') && + (string[8] == '>')); } static inline gboolean is_release (const gchar *string) { return ((string[0] == '<') && - (string[1] == 'r' || string[1] == 'R') && - (string[2] == 'e' || string[2] == 'E') && - (string[3] == 'l' || string[3] == 'L') && - (string[4] == 'e' || string[4] == 'E') && - (string[5] == 'a' || string[5] == 'A') && - (string[6] == 's' || string[6] == 'S') && - (string[7] == 'e' || string[7] == 'E') && - (string[8] == '>')); + (string[1] == 'r' || string[1] == 'R') && + (string[2] == 'e' || string[2] == 'E') && + (string[3] == 'l' || string[3] == 'L') && + (string[4] == 'e' || string[4] == 'E') && + (string[5] == 'a' || string[5] == 'A') && + (string[6] == 's' || string[6] == 'S') && + (string[7] == 'e' || string[7] == 'E') && + (string[8] == '>')); } static inline gboolean is_meta (const gchar *string) { return ((string[0] == '<') && - (string[1] == 'm' || string[1] == 'M') && - (string[2] == 'e' || string[2] == 'E') && - (string[3] == 't' || string[3] == 'T') && - (string[4] == 'a' || string[4] == 'A') && - (string[5] == '>')); + (string[1] == 'm' || string[1] == 'M') && + (string[2] == 'e' || string[2] == 'E') && + (string[3] == 't' || string[3] == 'T') && + (string[4] == 'a' || string[4] == 'A') && + (string[5] == '>')); } static inline gboolean is_super (const gchar *string) { return ((string[0] == '<') && - (string[1] == 's' || string[1] == 'S') && - (string[2] == 'u' || string[2] == 'U') && - (string[3] == 'p' || string[3] == 'P') && - (string[4] == 'e' || string[4] == 'E') && - (string[5] == 'r' || string[5] == 'R') && - (string[6] == '>')); + (string[1] == 's' || string[1] == 'S') && + (string[2] == 'u' || string[2] == 'U') && + (string[3] == 'p' || string[3] == 'P') && + (string[4] == 'e' || string[4] == 'E') && + (string[5] == 'r' || string[5] == 'R') && + (string[6] == '>')); } static inline gboolean is_hyper (const gchar *string) { return ((string[0] == '<') && - (string[1] == 'h' || string[1] == 'H') && - (string[2] == 'y' || string[2] == 'Y') && - (string[3] == 'p' || string[3] == 'P') && - (string[4] == 'e' || string[4] == 'E') && - (string[5] == 'r' || string[5] == 'R') && - (string[6] == '>')); + (string[1] == 'h' || string[1] == 'H') && + (string[2] == 'y' || string[2] == 'Y') && + (string[3] == 'p' || string[3] == 'P') && + (string[4] == 'e' || string[4] == 'E') && + (string[5] == 'r' || string[5] == 'R') && + (string[6] == '>')); +} + +static inline gboolean +is_primary (const gchar *string) +{ + return ((string[0] == '<') && + (string[1] == 'p' || string[1] == 'P') && + (string[2] == 'r' || string[2] == 'R') && + (string[3] == 'i' || string[3] == 'I') && + (string[4] == 'm' || string[4] == 'M') && + (string[5] == 'a' || string[5] == 'A') && + (string[6] == 'r' || string[6] == 'R') && + (string[7] == 'y' || string[7] == 'Y') && + (string[8] == '>')); +} + +static inline gboolean +is_keycode (const gchar *string) +{ + return (string[0] == '0' && + string[1] == 'x' && + g_ascii_isxdigit (string[2]) && + g_ascii_isxdigit (string[3])); } /** - * gtk_accelerator_parse: - * @accelerator: string representing an accelerator - * @accelerator_key: return location for accelerator keyval - * @accelerator_mods: return location for accelerator modifier mask + * gtk_accelerator_parse_with_keycode: + * @accelerator: string representing an accelerator + * @accelerator_key: (out) (allow-none): return location for accelerator + * keyval, or %NULL + * @accelerator_codes: (out) (allow-none): return location for accelerator + * keycodes, or %NULL + * @accelerator_mods: (out) (allow-none): return location for accelerator + * modifier mask, %NULL * - * Parses a string representing an accelerator. The - * format looks like "<Control>a" or "<Shift><Alt>F1" or - * "<Release>z" (the last one is for key release). - * The parser is fairly liberal and allows lower or upper case, - * and also abbreviations such as "<Ctl>" and "<Ctrl>". + * Parses a string representing an accelerator, similarly to + * gtk_accelerator_parse() but handles keycodes as well. This is only + * useful for system-level components, applications should use + * gtk_accelerator_parse() instead. * - * If the parse fails, @accelerator_key and @accelerator_mods will - * be set to 0 (zero). + * If a keycode is present in the accelerator and no @accelerator_codes + * is given, the parse will fail. + * + * If the parse fails, @accelerator_key, @accelerator_mods and + * @accelerator_codes will be set to 0 (zero). + * + * Since: 3.4 */ void -gtk_accelerator_parse (const gchar *accelerator, - guint *accelerator_key, - GdkModifierType *accelerator_mods) +gtk_accelerator_parse_with_keycode (const gchar *accelerator, + guint *accelerator_key, + guint **accelerator_codes, + GdkModifierType *accelerator_mods) { guint keyval; GdkModifierType mods; gint len; - + gboolean error; + if (accelerator_key) *accelerator_key = 0; if (accelerator_mods) *accelerator_mods = 0; + if (accelerator_codes) + *accelerator_codes = NULL; g_return_if_fail (accelerator != NULL); - + + error = FALSE; keyval = 0; mods = 0; len = strlen (accelerator); while (len) { if (*accelerator == '<') - { - if (len >= 9 && is_release (accelerator)) - { - accelerator += 9; - len -= 9; - mods |= GDK_RELEASE_MASK; - } - else if (len >= 9 && is_control (accelerator)) - { - accelerator += 9; - len -= 9; - mods |= GDK_CONTROL_MASK; - } - else if (len >= 7 && is_shift (accelerator)) - { - accelerator += 7; - len -= 7; - mods |= GDK_SHIFT_MASK; - } - else if (len >= 6 && is_shft (accelerator)) - { - accelerator += 6; - len -= 6; - mods |= GDK_SHIFT_MASK; - } - else if (len >= 6 && is_ctrl (accelerator)) - { - accelerator += 6; - len -= 6; - mods |= GDK_CONTROL_MASK; - } - else if (len >= 6 && is_modx (accelerator)) - { - static const guint mod_vals[] = { - GDK_MOD1_MASK, GDK_MOD2_MASK, GDK_MOD3_MASK, - GDK_MOD4_MASK, GDK_MOD5_MASK - }; - - len -= 6; - accelerator += 4; - mods |= mod_vals[*accelerator - '1']; - accelerator += 2; - } - else if (len >= 5 && is_ctl (accelerator)) - { - accelerator += 5; - len -= 5; - mods |= GDK_CONTROL_MASK; - } - else if (len >= 5 && is_alt (accelerator)) - { - accelerator += 5; - len -= 5; - mods |= GDK_MOD1_MASK; - } + { + if (len >= 9 && is_release (accelerator)) + { + accelerator += 9; + len -= 9; + mods |= GDK_RELEASE_MASK; + } + else if (len >= 9 && is_primary (accelerator)) + { + accelerator += 9; + len -= 9; + mods |= _gtk_get_primary_accel_mod (); + } + else if (len >= 9 && is_control (accelerator)) + { + accelerator += 9; + len -= 9; + mods |= GDK_CONTROL_MASK; + } + else if (len >= 7 && is_shift (accelerator)) + { + accelerator += 7; + len -= 7; + mods |= GDK_SHIFT_MASK; + } + else if (len >= 6 && is_shft (accelerator)) + { + accelerator += 6; + len -= 6; + mods |= GDK_SHIFT_MASK; + } + else if (len >= 6 && is_ctrl (accelerator)) + { + accelerator += 6; + len -= 6; + mods |= GDK_CONTROL_MASK; + } + else if (len >= 6 && is_modx (accelerator)) + { + static const guint mod_vals[] = { + GDK_MOD1_MASK, GDK_MOD2_MASK, GDK_MOD3_MASK, + GDK_MOD4_MASK, GDK_MOD5_MASK + }; + + len -= 6; + accelerator += 4; + mods |= mod_vals[*accelerator - '1']; + accelerator += 2; + } + else if (len >= 5 && is_ctl (accelerator)) + { + accelerator += 5; + len -= 5; + mods |= GDK_CONTROL_MASK; + } + else if (len >= 5 && is_alt (accelerator)) + { + accelerator += 5; + len -= 5; + mods |= GDK_MOD1_MASK; + } else if (len >= 6 && is_meta (accelerator)) - { - accelerator += 6; - len -= 6; - mods |= GDK_META_MASK; - } + { + accelerator += 6; + len -= 6; + mods |= GDK_META_MASK; + } else if (len >= 7 && is_hyper (accelerator)) - { - accelerator += 7; - len -= 7; - mods |= GDK_HYPER_MASK; - } + { + accelerator += 7; + len -= 7; + mods |= GDK_HYPER_MASK; + } else if (len >= 7 && is_super (accelerator)) - { - accelerator += 7; - len -= 7; - mods |= GDK_SUPER_MASK; - } + { + accelerator += 7; + len -= 7; + mods |= GDK_SUPER_MASK; + } + else + { + gchar last_ch; + + last_ch = *accelerator; + while (last_ch && last_ch != '>') + { + last_ch = *accelerator; + accelerator += 1; + len -= 1; + } + } + } + else + { + if (len >= 4 && is_keycode (accelerator)) + { + char keystring[5]; + gchar *endptr; + gint tmp_keycode; + + memcpy (keystring, accelerator, 4); + keystring [4] = '\000'; + + tmp_keycode = strtol (keystring, &endptr, 16); + + if (endptr == NULL || *endptr != '\000') + { + error = TRUE; + goto out; + } + else if (accelerator_codes != NULL) + { + /* 0x00 is an invalid keycode too. */ + if (tmp_keycode == 0) + { + error = TRUE; + goto out; + } + else + { + *accelerator_codes = g_new0 (guint, 2); + (*accelerator_codes)[0] = tmp_keycode; + } + } + else + { + /* There was a keycode in the string, but + * we cannot store it, so we have an error */ + error = TRUE; + goto out; + } + } else { - gchar last_ch; - - last_ch = *accelerator; - while (last_ch && last_ch != '>') - { - last_ch = *accelerator; - accelerator += 1; - len -= 1; + keyval = gdk_keyval_from_name (accelerator); + if (keyval == GDK_KEY_VoidSymbol) + { + error = TRUE; + goto out; } } - } - else - { - keyval = gdk_keyval_from_name (accelerator); - accelerator += len; - len -= len; - } + + if (keyval && accelerator_codes != NULL) + { + GdkKeymapKey *keys; + gint n_keys, i, j; + + if (!gdk_keymap_get_entries_for_keyval (gdk_keymap_get_default (), keyval, &keys, &n_keys)) + { + /* Not in keymap */ + error = TRUE; + goto out; + } + else + { + *accelerator_codes = g_new0 (guint, n_keys + 1); + + /* Prefer level-0 group-0 keys to modified keys */ + for (i = 0, j = 0; i < n_keys; ++i) + { + if (keys[i].level == 0 && keys[i].group == 0) + (*accelerator_codes)[j++] = keys[i].keycode; + } + + /* No level-0 group-0 keys? Find in the whole group-0 */ + if (j == 0) + { + for (i = 0, j = 0; i < n_keys; ++i) + { + if (keys[i].group == 0) + (*accelerator_codes)[j++] = keys[i].keycode; + } + } + + /* Still nothing? Try in other groups */ + if (j == 0) + { + for (i = 0, j = 0; i < n_keys; ++i) + (*accelerator_codes)[j++] = keys[i].keycode; + } + + if (j == 0) + { + g_free (*accelerator_codes); + *accelerator_codes = NULL; + /* Not in keymap */ + error = TRUE; + goto out; + } + g_free (keys); + } + } + + accelerator += len; + len -= len; + } } - + +out: + if (error) + keyval = mods = 0; + if (accelerator_key) *accelerator_key = gdk_keyval_to_lower (keyval); if (accelerator_mods) *accelerator_mods = mods; } +/** + * gtk_accelerator_parse: + * @accelerator: string representing an accelerator + * @accelerator_key: (out) (allow-none): return location for accelerator + * keyval, or %NULL + * @accelerator_mods: (out) (allow-none): return location for accelerator + * modifier mask, %NULL + * + * Parses a string representing an accelerator. The + * format looks like "<Control>a" or "<Shift><Alt>F1" + * or "<Release>z" (the last one is for key release). + * + * The parser is fairly liberal and allows lower or upper case, + * and also abbreviations such as "<Ctl>" and "<Ctrl>". + * Key names are parsed using gdk_keyval_from_name(). For character + * keys the name is not the symbol, but the lowercase name, e.g. one + * would use "<Ctrl>minus" instead of "<Ctrl>-". + * + * If the parse fails, @accelerator_key and @accelerator_mods will + * be set to 0 (zero). + */ +void +gtk_accelerator_parse (const gchar *accelerator, + guint *accelerator_key, + GdkModifierType *accelerator_mods) +{ + gtk_accelerator_parse_with_keycode (accelerator, accelerator_key, NULL, accelerator_mods); +} + +/** + * gtk_accelerator_name_with_keycode: + * @display: (allow-none): a #GdkDisplay or %NULL to use the default display + * @accelerator_key: accelerator keyval + * @keycode: accelerator keycode + * @accelerator_mods: accelerator modifier mask + * + * Converts an accelerator keyval and modifier mask + * into a string parseable by gtk_accelerator_parse_full(), + * similarly to gtk_accelerator_name() but handling keycodes. + * This is only useful for system-level components, applications + * should use gtk_accelerator_parse() instead. + * + * Returns: a newly allocated accelerator name. + * + * Since: 3.4 + */ +gchar * +gtk_accelerator_name_with_keycode (GdkDisplay *display, + guint accelerator_key, + guint keycode, + GdkModifierType accelerator_mods) +{ + gchar *gtk_name; + + if (display == NULL) + display = gdk_display_manager_get_default_display (gdk_display_manager_get ()); + + gdk_keymap_add_virtual_modifiers (gdk_keymap_get_for_display (display), &accelerator_mods); + gtk_name = gtk_accelerator_name (accelerator_key, accelerator_mods); + + if (!accelerator_key) + { + gchar *name; + name = g_strdup_printf ("%s0x%02x", gtk_name, keycode); + g_free (gtk_name); + return name; + } + + return gtk_name; +} + /** * gtk_accelerator_name: - * @accelerator_key: accelerator keyval + * @accelerator_key: accelerator keyval * @accelerator_mods: accelerator modifier mask - * + * * Converts an accelerator keyval and modifier mask * into a string parseable by gtk_accelerator_parse(). - * For example, if you pass in #GDK_q and #GDK_CONTROL_MASK, - * this function returns "<Control>q". + * For example, if you pass in #GDK_KEY_q and #GDK_CONTROL_MASK, + * this function returns "<Control>q". * * If you need to display accelerators in the user interface, * see gtk_accelerator_get_label(). @@ -1273,9 +1517,10 @@ gtk_accelerator_parse (const gchar *accelerator, */ gchar* gtk_accelerator_name (guint accelerator_key, - GdkModifierType accelerator_mods) + GdkModifierType accelerator_mods) { static const gchar text_release[] = ""; + static const gchar text_primary[] = ""; static const gchar text_shift[] = ""; static const gchar text_control[] = ""; static const gchar text_mod1[] = ""; @@ -1286,6 +1531,7 @@ gtk_accelerator_name (guint accelerator_key, static const gchar text_meta[] = ""; static const gchar text_super[] = ""; static const gchar text_hyper[] = ""; + GdkModifierType saved_mods; guint l; gchar *keyval_name; gchar *accelerator; @@ -1296,9 +1542,15 @@ gtk_accelerator_name (guint accelerator_key, if (!keyval_name) keyval_name = ""; + saved_mods = accelerator_mods; l = 0; if (accelerator_mods & GDK_RELEASE_MASK) l += sizeof (text_release) - 1; + if (accelerator_mods & _gtk_get_primary_accel_mod ()) + { + l += sizeof (text_primary) - 1; + accelerator_mods &= ~_gtk_get_primary_accel_mod (); /* consume the default accel */ + } if (accelerator_mods & GDK_SHIFT_MASK) l += sizeof (text_shift) - 1; if (accelerator_mods & GDK_CONTROL_MASK) @@ -1323,6 +1575,7 @@ gtk_accelerator_name (guint accelerator_key, accelerator = g_new (gchar, l + 1); + accelerator_mods = saved_mods; l = 0; accelerator[l] = 0; if (accelerator_mods & GDK_RELEASE_MASK) @@ -1330,6 +1583,12 @@ gtk_accelerator_name (guint accelerator_key, strcpy (accelerator + l, text_release); l += sizeof (text_release) - 1; } + if (accelerator_mods & _gtk_get_primary_accel_mod ()) + { + strcpy (accelerator + l, text_primary); + l += sizeof (text_primary) - 1; + accelerator_mods &= ~_gtk_get_primary_accel_mod (); /* consume the default accel */ + } if (accelerator_mods & GDK_SHIFT_MASK) { strcpy (accelerator + l, text_shift); @@ -1385,13 +1644,57 @@ gtk_accelerator_name (guint accelerator_key, return accelerator; } +/** + * gtk_accelerator_get_label_with_keycode: + * @display: (allow-none): a #GdkDisplay or %NULL to use the default display + * @accelerator_key: accelerator keyval + * @keycode: accelerator keycode + * @accelerator_mods: accelerator modifier mask + * + * Converts an accelerator keyval and modifier mask + * into a (possibly translated) string that can be displayed to + * a user, similarly to gtk_accelerator_get_label(), but handling + * keycodes. + * + * This is only useful for system-level components, applications + * should use gtk_accelerator_parse() instead. + * + * Returns: a newly-allocated string representing the accelerator. + * + * Since: 3.4 + */ +gchar * +gtk_accelerator_get_label_with_keycode (GdkDisplay *display, + guint accelerator_key, + guint keycode, + GdkModifierType accelerator_mods) +{ + gchar *gtk_label; + + if (display == NULL) + display = gdk_display_manager_get_default_display (gdk_display_manager_get ()); + + gdk_keymap_add_virtual_modifiers (gdk_keymap_get_for_display (display), &accelerator_mods); + gtk_label = gtk_accelerator_get_label (accelerator_key, accelerator_mods); + + if (!accelerator_key) + { + gchar *label; + label = g_strdup_printf ("%s0x%02x", gtk_label, keycode); + g_free (gtk_label); + return label; + } + + return gtk_label; +} + /** * gtk_accelerator_get_label: - * @accelerator_key: accelerator keyval + * @accelerator_key: accelerator keyval * @accelerator_mods: accelerator modifier mask - * - * Converts an accelerator keyval and modifier mask into a string - * which can be used to represent the accelerator to the user. + * + * Converts an accelerator keyval and modifier mask into a string + * which can be used to represent the accelerator to the user. * * Returns: a newly-allocated string representing the accelerator. * @@ -1399,19 +1702,19 @@ gtk_accelerator_name (guint accelerator_key, */ gchar* gtk_accelerator_get_label (guint accelerator_key, - GdkModifierType accelerator_mods) + GdkModifierType accelerator_mods) { GtkAccelLabelClass *klass; gchar *label; klass = g_type_class_ref (GTK_TYPE_ACCEL_LABEL); - label = _gtk_accel_label_class_get_accelerator_label (klass, - accelerator_key, - accelerator_mods); + label = _gtk_accel_label_class_get_accelerator_label (klass, + accelerator_key, + accelerator_mods); g_type_class_unref (klass); /* klass is kept alive since gtk uses static types */ return label; -} +} /** * gtk_accelerator_set_default_mod_mask: @@ -1419,9 +1722,9 @@ gtk_accelerator_get_label (guint accelerator_key, * * Sets the modifiers that will be considered significant for keyboard * accelerators. The default mod mask is #GDK_CONTROL_MASK | - * #GDK_SHIFT_MASK | #GDK_MOD1_MASK | #GDK_SUPER_MASK | - * #GDK_HYPER_MASK | #GDK_META_MASK, that is, Control, Shift, Alt, - * Super, Hyper and Meta. Other modifiers will by default be ignored + * #GDK_SHIFT_MASK | #GDK_MOD1_MASK | #GDK_SUPER_MASK | + * #GDK_HYPER_MASK | #GDK_META_MASK, that is, Control, Shift, Alt, + * Super, Hyper and Meta. Other modifiers will by default be ignored * by #GtkAccelGroup. * You must include at least the three modifiers Control, Shift * and Alt in any value you pass to this function. @@ -1438,15 +1741,13 @@ gtk_accelerator_set_default_mod_mask (GdkModifierType default_mod_mask) /** * gtk_accelerator_get_default_mod_mask: - * @returns: the default accelerator modifier mask * * Gets the value set by gtk_accelerator_set_default_mod_mask(). + * + * Returns: the default accelerator modifier mask */ -guint +GdkModifierType gtk_accelerator_get_default_mod_mask (void) { return default_accel_mod_mask; } - -#define __GTK_ACCEL_GROUP_C__ -#include "gtkaliasdef.c"