Pileus Git - ~andy/gtk/blob - gtk/gtkaccelgroup.c

   1 /* GTK - The GIMP Toolkit
   2  * Copyright (C) 1998, 2001 Tim Janik
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Lesser General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public
  15  * License along with this library; if not, write to the
  16  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  17  * Boston, MA 02111-1307, USA.
  18  */
  19
  20 /*
  21  * Modified by the GTK+ Team and others 1997-2000.  See the AUTHORS
  22  * file for a list of people on the GTK+ Team.  See the ChangeLog
  23  * files for a list of changes.  These files are distributed with
  24  * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
  25  */
  26
  27 #include <string.h>
  28 #include <stdlib.h>
  29
  30 #include "gtkaccelgroup.h"
  31 #include "gtkaccelmap.h"
  32 #include "gtkmain.h"            /* For _gtk_boolean_handled_accumulator */
  33 #include "gdk/gdkkeysyms.h"
  34 #include "gtkmarshalers.h"
  35
  36
  37 /* --- prototypes --- */
  38 static void gtk_accel_group_class_init  (GtkAccelGroupClass     *class);
  39 static void gtk_accel_group_init        (GtkAccelGroup          *accel_group);
  40 static void gtk_accel_group_finalize    (GObject                *object);
  41
  42
  43 /* --- variables --- */
  44 static GObjectClass     *parent_class = NULL;
  45 static guint             signal_accel_activate = 0;
  46 static guint             signal_accel_changed = 0;
  47 static guint             quark_acceleratable_groups = 0;
  48 static guint             default_accel_mod_mask = (GDK_SHIFT_MASK |
  49                                                    GDK_CONTROL_MASK |
  50                                                    GDK_MOD1_MASK);
  51
  52
  53 /* --- functions --- */
  54 /**
  55  * gtk_accel_group_get_type:
  56  * @returns: the type ID for accelerator groups.
  57  */
  58 GType
  59 gtk_accel_group_get_type (void)
  60 {
  61   static GType object_type = 0;
  62
  63   if (!object_type)
  64     {
  65       static const GTypeInfo object_info = {
  66         sizeof (GtkAccelGroupClass),
  67         (GBaseInitFunc) NULL,
  68         (GBaseFinalizeFunc) NULL,
  69         (GClassInitFunc) gtk_accel_group_class_init,
  70         NULL,   /* class_finalize */
  71         NULL,   /* class_data */
  72         sizeof (GtkAccelGroup),
  73         0,      /* n_preallocs */
  74         (GInstanceInitFunc) gtk_accel_group_init,
  75       };
  76
  77       object_type = g_type_register_static (G_TYPE_OBJECT, "GtkAccelGroup",
  78                                             &object_info, 0);
  79     }
  80
  81   return object_type;
  82 }
  83
  84 static void
  85 gtk_accel_group_class_init (GtkAccelGroupClass *class)
  86 {
  87   GObjectClass *object_class = G_OBJECT_CLASS (class);
  88
  89   parent_class = g_type_class_peek_parent (class);
  90
  91   quark_acceleratable_groups = g_quark_from_static_string ("gtk-acceleratable-accel-groups");
  92
  93   object_class->finalize = gtk_accel_group_finalize;
  94
  95   class->accel_changed = NULL;
  96   signal_accel_activate =
  97     g_signal_new ("accel_activate",
  98                   G_OBJECT_CLASS_TYPE (class),
  99                   G_SIGNAL_DETAILED,
 100                   0,
 101                   _gtk_boolean_handled_accumulator, NULL,
 102                   _gtk_marshal_BOOLEAN__OBJECT_UINT_FLAGS,
 103                   G_TYPE_BOOLEAN, 3,
 104                   G_TYPE_OBJECT,
 105                   G_TYPE_UINT,
 106                   GDK_TYPE_MODIFIER_TYPE);
 107   signal_accel_changed =
 108     g_signal_new ("accel_changed",
 109                   G_OBJECT_CLASS_TYPE (class),
 110                   G_SIGNAL_RUN_FIRST | G_SIGNAL_DETAILED,
 111                   G_STRUCT_OFFSET (GtkAccelGroupClass, accel_changed),
 112                   NULL, NULL,
 113                   _gtk_marshal_VOID__UINT_FLAGS_BOXED,
 114                   G_TYPE_NONE, 3,
 115                   G_TYPE_UINT,
 116                   GDK_TYPE_MODIFIER_TYPE,
 117                   G_TYPE_CLOSURE);
 118 }
 119
 120 static void
 121 gtk_accel_group_finalize (GObject *object)
 122 {
 123   GtkAccelGroup *accel_group = GTK_ACCEL_GROUP (object);
 124   guint i;
 125
 126   for (i = 0; i < accel_group->n_accels; i++)
 127     {
 128       GtkAccelGroupEntry *entry = &accel_group->priv_accels[i];
 129
 130       if (entry->accel_path_quark)
 131         {
 132           const gchar *accel_path = g_quark_to_string (entry[i].accel_path_quark);
 133
 134           _gtk_accel_map_remove_group (accel_path, accel_group);
 135         }
 136     }
 137
 138   g_free (accel_group->priv_accels);
 139
 140   G_OBJECT_CLASS (parent_class)->finalize (object);
 141 }
 142
 143 static void
 144 gtk_accel_group_init (GtkAccelGroup *accel_group)
 145 {
 146   accel_group->lock_count = 0;
 147   accel_group->modifier_mask = gtk_accelerator_get_default_mod_mask ();
 148   accel_group->acceleratables = NULL;
 149   accel_group->n_accels = 0;
 150   accel_group->priv_accels = NULL;
 151 }
 152
 153 /**
 154  * gtk_accel_group_new:
 155  * @returns: a new #GtkAccelGroup object
 156  *
 157  * Creates a new #GtkAccelGroup.
 158  */
 159 GtkAccelGroup*
 160 gtk_accel_group_new (void)
 161 {
 162   return g_object_new (GTK_TYPE_ACCEL_GROUP, NULL);
 163 }
 164
 165 static void
 166 accel_group_weak_ref_detach (GSList  *free_list,
 167                              GObject *stale_object)
 168 {
 169   GSList *slist;
 170
 171   for (slist = free_list; slist; slist = slist->next)
 172     {
 173       GtkAccelGroup *accel_group;
 174
 175       accel_group = slist->data;
 176       accel_group->acceleratables = g_slist_remove (accel_group->acceleratables, stale_object);
 177       g_object_unref (accel_group);
 178     }
 179   g_slist_free (free_list);
 180   g_object_set_qdata (stale_object, quark_acceleratable_groups, NULL);
 181 }
 182
 183 void
 184 _gtk_accel_group_attach (GtkAccelGroup *accel_group,
 185                          GObject       *object)
 186 {
 187   GSList *slist;
 188
 189   g_return_if_fail (GTK_IS_ACCEL_GROUP (accel_group));
 190   g_return_if_fail (G_IS_OBJECT (object));
 191   g_return_if_fail (g_slist_find (accel_group->acceleratables, object) == NULL);
 192
 193   g_object_ref (accel_group);
 194   accel_group->acceleratables = g_slist_prepend (accel_group->acceleratables, object);
 195   slist = g_object_get_qdata (object, quark_acceleratable_groups);
 196   if (slist)
 197     g_object_weak_unref (object,
 198                          (GWeakNotify) accel_group_weak_ref_detach,
 199                          slist);
 200   slist = g_slist_prepend (slist, accel_group);
 201   g_object_set_qdata (object, quark_acceleratable_groups, slist);
 202   g_object_weak_ref (object,
 203                      (GWeakNotify) accel_group_weak_ref_detach,
 204                      slist);
 205 }
 206
 207 void
 208 _gtk_accel_group_detach (GtkAccelGroup *accel_group,
 209                          GObject       *object)
 210 {
 211   GSList *slist;
 212
 213   g_return_if_fail (GTK_IS_ACCEL_GROUP (accel_group));
 214   g_return_if_fail (G_IS_OBJECT (object));
 215   g_return_if_fail (g_slist_find (accel_group->acceleratables, object) != NULL);
 216
 217   accel_group->acceleratables = g_slist_remove (accel_group->acceleratables, object);
 218   slist = g_object_get_qdata (object, quark_acceleratable_groups);
 219   g_object_weak_unref (object,
 220                        (GWeakNotify) accel_group_weak_ref_detach,
 221                        slist);
 222   slist = g_slist_remove (slist, accel_group);
 223   g_object_set_qdata (object, quark_acceleratable_groups, slist);
 224   if (slist)
 225     g_object_weak_ref (object,
 226                        (GWeakNotify) accel_group_weak_ref_detach,
 227                        slist);
 228   g_object_unref (accel_group);
 229 }
 230
 231 /**
 232  * gtk_accel_groups_from_object:
 233  * @object:        a #GObject, usually a #GtkWindow
 234  * @returns: a list of all accel groups which are attached to @object
 235  *
 236  * Gets a list of all accel groups which are attached to @object.
 237  */
 238 GSList*
 239 gtk_accel_groups_from_object (GObject *object)
 240 {
 241   g_return_val_if_fail (G_IS_OBJECT (object), NULL);
 242
 243   return g_object_get_qdata (object, quark_acceleratable_groups);
 244 }
 245
 246 /**
 247  * gtk_accel_group_find:
 248  * @accel_group: a #GtkAccelGroup
 249  * @find_func: a function to filter the entries of @accel_group with
 250  * @data: data to pass to @find_func
 251  * @returns: the key of the first entry passing @find_func. The key is
 252  * owned by GTK+ and must not be freed.
 253  *
 254  * Finds the first entry in an accelerator group for which
 255  * @find_func returns %TRUE and returns its #GtkAccelKey.
 256  *
 257  */
 258 GtkAccelKey*
 259 gtk_accel_group_find (GtkAccelGroup        *accel_group,
 260                       GtkAccelGroupFindFunc find_func,
 261                       gpointer              data)
 262 {
 263   GtkAccelKey *key = NULL;
 264   guint i;
 265
 266   g_return_val_if_fail (GTK_IS_ACCEL_GROUP (accel_group), NULL);
 267   g_return_val_if_fail (find_func != NULL, NULL);
 268
 269   g_object_ref (accel_group);
 270   for (i = 0; i < accel_group->n_accels; i++)
 271     if (find_func (&accel_group->priv_accels[i].key,
 272                    accel_group->priv_accels[i].closure,
 273                    data))
 274       {
 275         key = &accel_group->priv_accels[i].key;
 276         break;
 277       }
 278   g_object_unref (accel_group);
 279
 280   return key;
 281 }
 282
 283 /**
 284  * gtk_accel_group_lock:
 285  * @accel_group: a #GtkAccelGroup
 286  *
 287  * Locks the given accelerator group.
 288  *
 289  * Locking an acelerator group prevents the accelerators contained
 290  * within it to be changed during runtime. Refer to
 291  * gtk_accel_map_change_entry() about runtime accelerator changes.
 292  *
 293  * If called more than once, @accel_group remains locked until
 294  * gtk_accel_group_unlock() has been called an equivalent number
 295  * of times.
 296  */
 297 void
 298 gtk_accel_group_lock (GtkAccelGroup *accel_group)
 299 {
 300   g_return_if_fail (GTK_IS_ACCEL_GROUP (accel_group));
 301
 302   accel_group->lock_count += 1;
 303 }
 304
 305 /**
 306  * gtk_accel_group_unlock:
 307  * @accel_group: a #GtkAccelGroup
 308  *
 309  * Undoes the last call to gtk_accel_group_lock() on this @accel_group.
 310  */
 311 void
 312 gtk_accel_group_unlock (GtkAccelGroup *accel_group)
 313 {
 314   g_return_if_fail (GTK_IS_ACCEL_GROUP (accel_group));
 315   g_return_if_fail (accel_group->lock_count > 0);
 316
 317   accel_group->lock_count -= 1;
 318 }
 319
 320 static void
 321 accel_closure_invalidate (gpointer  data,
 322                           GClosure *closure)
 323 {
 324   GtkAccelGroup *accel_group = GTK_ACCEL_GROUP (data);
 325
 326   gtk_accel_group_disconnect (accel_group, closure);
 327 }
 328
 329 static int
 330 bsearch_compare_accels (const void *d1,
 331                         const void *d2)
 332 {
 333   const GtkAccelGroupEntry *entry1 = d1;
 334   const GtkAccelGroupEntry *entry2 = d2;
 335
 336   if (entry1->key.accel_key == entry2->key.accel_key)
 337     return entry1->key.accel_mods < entry2->key.accel_mods ? -1 : entry1->key.accel_mods > entry2->key.accel_mods;
 338   else
 339     return entry1->key.accel_key < entry2->key.accel_key ? -1 : 1;
 340 }
 341
 342 static void
 343 quick_accel_add (GtkAccelGroup  *accel_group,
 344                  guint           accel_key,
 345                  GdkModifierType accel_mods,
 346                  GtkAccelFlags   accel_flags,
 347                  GClosure       *closure,
 348                  GQuark          path_quark)
 349 {
 350   guint pos, i = accel_group->n_accels++;
 351   GtkAccelGroupEntry key;
 352
 353   /* find position */
 354   key.key.accel_key = accel_key;
 355   key.key.accel_mods = accel_mods;
 356   for (pos = 0; pos < i; pos++)
 357     if (bsearch_compare_accels (&key, accel_group->priv_accels + pos) < 0)
 358       break;
 359
 360   /* insert at position, ref closure */
 361   accel_group->priv_accels = g_renew (GtkAccelGroupEntry, accel_group->priv_accels, accel_group->n_accels);
 362   g_memmove (accel_group->priv_accels + pos + 1, accel_group->priv_accels + pos,
 363              (i - pos) * sizeof (accel_group->priv_accels[0]));
 364   accel_group->priv_accels[pos].key.accel_key = accel_key;
 365   accel_group->priv_accels[pos].key.accel_mods = accel_mods;
 366   accel_group->priv_accels[pos].key.accel_flags = accel_flags;
 367   accel_group->priv_accels[pos].closure = g_closure_ref (closure);
 368   accel_group->priv_accels[pos].accel_path_quark = path_quark;
 369   g_closure_sink (closure);
 370
 371   /* handle closure invalidation and reverse lookups */
 372   g_closure_add_invalidate_notifier (closure, accel_group, accel_closure_invalidate);
 373
 374   /* get accel path notification */
 375   if (path_quark)
 376     _gtk_accel_map_add_group (g_quark_to_string (path_quark), accel_group);
 377
 378   /* connect and notify changed */
 379   if (accel_key)
 380     {
 381       gchar *accel_name = gtk_accelerator_name (accel_key, accel_mods);
 382       GQuark accel_quark = g_quark_from_string (accel_name);
 383
 384       g_free (accel_name);
 385
 386       /* setup handler */
 387       g_signal_connect_closure_by_id (accel_group, signal_accel_activate, accel_quark, closure, FALSE);
 388
 389       /* and notify */
 390       g_signal_emit (accel_group, signal_accel_changed, accel_quark, accel_key, accel_mods, closure);
 391     }
 392 }
 393
 394 static void
 395 quick_accel_remove (GtkAccelGroup      *accel_group,
 396                     GtkAccelGroupEntry *entry)
 397 {
 398   guint pos = entry - accel_group->priv_accels;
 399   GQuark accel_quark = 0;
 400   guint accel_key = entry->key.accel_key;
 401   GdkModifierType accel_mods = entry->key.accel_mods;
 402   GClosure *closure = entry->closure;
 403
 404   /* quark for notification */
 405   if (accel_key)
 406     {
 407       gchar *accel_name = gtk_accelerator_name (accel_key, accel_mods);
 408
 409       accel_quark = g_quark_from_string (accel_name);
 410       g_free (accel_name);
 411     }
 412
 413   /* clean up closure invalidate notification and disconnect */
 414   g_closure_remove_invalidate_notifier (entry->closure, accel_group, accel_closure_invalidate);
 415   if (accel_quark)
 416     g_signal_handlers_disconnect_matched (accel_group,
 417                                           G_SIGNAL_MATCH_ID | G_SIGNAL_MATCH_DETAIL | G_SIGNAL_MATCH_CLOSURE,
 418                                           signal_accel_activate, accel_quark,
 419                                           closure, NULL, NULL);
 420   /* clean up accel path notification */
 421   if (entry->accel_path_quark)
 422     _gtk_accel_map_remove_group (g_quark_to_string (entry->accel_path_quark), accel_group);
 423
 424   /* physically remove */
 425   accel_group->n_accels -= 1;
 426   g_memmove (entry, entry + 1,
 427              (accel_group->n_accels - pos) * sizeof (accel_group->priv_accels[0]));
 428
 429   /* and notify */
 430   if (accel_quark)
 431     g_signal_emit (accel_group, signal_accel_changed, accel_quark, accel_key, accel_mods, closure);
 432
 433   /* remove quick_accel_add() refcount */
 434   g_closure_unref (closure);
 435 }
 436
 437 static GtkAccelGroupEntry*
 438 quick_accel_find (GtkAccelGroup  *accel_group,
 439                   guint           accel_key,
 440                   GdkModifierType accel_mods,
 441                   guint          *count_p)
 442 {
 443   GtkAccelGroupEntry *entry;
 444   GtkAccelGroupEntry key;
 445
 446   if (!accel_group->n_accels)
 447     return NULL;
 448
 449   key.key.accel_key = accel_key;
 450   key.key.accel_mods = accel_mods;
 451   entry = bsearch (&key, accel_group->priv_accels, accel_group->n_accels,
 452                    sizeof (accel_group->priv_accels[0]), bsearch_compare_accels);
 453
 454   if (!entry)
 455     return NULL;
 456
 457   /* step back to the first member */
 458   for (; entry > accel_group->priv_accels; entry--)
 459     if (entry[-1].key.accel_key != accel_key ||
 460         entry[-1].key.accel_mods != accel_mods)
 461       break;
 462   /* count equal members */
 463   for (*count_p = 0; entry + *count_p < accel_group->priv_accels + accel_group->n_accels; (*count_p)++)
 464     if (entry[*count_p].key.accel_key != accel_key ||
 465         entry[*count_p].key.accel_mods != accel_mods)
 466       break;
 467   return entry;
 468 }
 469
 470 /**
 471  * gtk_accel_group_connect:
 472  * @accel_group:      the accelerator group to install an accelerator in
 473  * @accel_key:        key value of the accelerator
 474  * @accel_mods:       modifier combination of the accelerator
 475  * @accel_flags:      a flag mask to configure this accelerator
 476  * @closure:          closure to be executed upon accelerator activation
 477  *
 478  * Installs an accelerator in this group. When @accel_group is being activated
 479  * in response to a call to gtk_accel_groups_activate(), @closure will be
 480  * invoked if the @accel_key and @accel_mods from gtk_accel_groups_activate()
 481  * match those of this connection.
 482  *
 483  * The signature used for the @closure is that of #GtkAccelGroupActivate.
 484  *
 485  * Note that, due to implementation details, a single closure can only be
 486  * connected to one accelerator group.
 487  */
 488 void
 489 gtk_accel_group_connect (GtkAccelGroup  *accel_group,
 490                          guint           accel_key,
 491                          GdkModifierType accel_mods,
 492                          GtkAccelFlags   accel_flags,
 493                          GClosure       *closure)
 494 {
 495   g_return_if_fail (GTK_IS_ACCEL_GROUP (accel_group));
 496   g_return_if_fail (closure != NULL);
 497   g_return_if_fail (accel_key > 0);
 498   g_return_if_fail (gtk_accel_group_from_accel_closure (closure) == NULL);
 499
 500   g_object_ref (accel_group);
 501   if (!closure->is_invalid)
 502     quick_accel_add (accel_group,
 503                      gdk_keyval_to_lower (accel_key),
 504                      accel_mods, accel_flags, closure, 0);
 505   g_object_unref (accel_group);
 506 }
 507
 508 /**
 509  * gtk_accel_group_connect_by_path:
 510  * @accel_group:      the accelerator group to install an accelerator in
 511  * @accel_path:       path used for determining key and modifiers.
 512  * @closure:          closure to be executed upon accelerator activation
 513  *
 514  * Installs an accelerator in this group, using an accelerator path to look
 515  * up the appropriate key and modifiers (see gtk_accel_map_add_entry()).
 516  * When @accel_group is being activated in response to a call to
 517  * gtk_accel_groups_activate(), @closure will be invoked if the @accel_key and
 518  * @accel_mods from gtk_accel_groups_activate() match the key and modifiers
 519  * for the path.
 520  *
 521  * The signature used for the @closure is that of #GtkAccelGroupActivate.
 522  */
 523 void
 524 gtk_accel_group_connect_by_path (GtkAccelGroup  *accel_group,
 525                                  const gchar    *accel_path,
 526                                  GClosure       *closure)
 527 {
 528   guint accel_key = 0;
 529   GdkModifierType accel_mods = 0;
 530   GtkAccelKey key;
 531
 532   g_return_if_fail (GTK_IS_ACCEL_GROUP (accel_group));
 533   g_return_if_fail (closure != NULL);
 534   g_return_if_fail (_gtk_accel_path_is_valid (accel_path));
 535
 536   if (closure->is_invalid)
 537     return;
 538
 539   g_object_ref (accel_group);
 540
 541   if (gtk_accel_map_lookup_entry (accel_path, &key))
 542     {
 543       accel_key = gdk_keyval_to_lower (key.accel_key);
 544       accel_mods = key.accel_mods;
 545     }
 546
 547   quick_accel_add (accel_group, accel_key, accel_mods, GTK_ACCEL_VISIBLE, closure,
 548                    g_quark_from_string (accel_path));
 549
 550   g_object_unref (accel_group);
 551 }
 552
 553 /**
 554  * gtk_accel_group_disconnect:
 555  * @accel_group: the accelerator group to remove an accelerator from
 556  * @closure:     the closure to remove from this accelerator group
 557  * @returns:     %TRUE if the closure was found and got disconnected
 558  *
 559  * Removes an accelerator previously installed through
 560  * gtk_accel_group_connect().
 561  */
 562 gboolean
 563 gtk_accel_group_disconnect (GtkAccelGroup *accel_group,
 564                             GClosure      *closure)
 565 {
 566   guint i;
 567
 568   g_return_val_if_fail (GTK_IS_ACCEL_GROUP (accel_group), FALSE);
 569
 570   for (i = 0; i < accel_group->n_accels; i++)
 571     if (accel_group->priv_accels[i].closure == closure)
 572       {
 573         g_object_ref (accel_group);
 574         quick_accel_remove (accel_group, accel_group->priv_accels + i);
 575         g_object_unref (accel_group);
 576         return TRUE;
 577       }
 578   return FALSE;
 579 }
 580
 581 /**
 582  * gtk_accel_group_disconnect_key:
 583  * @accel_group:      the accelerator group to install an accelerator in
 584  * @accel_key:        key value of the accelerator
 585  * @accel_mods:       modifier combination of the accelerator
 586  * @returns:          %TRUE if there was an accelerator which could be
 587  *                    removed, %FALSE otherwise
 588  *
 589  * Removes an accelerator previously installed through
 590  * gtk_accel_group_connect().
 591  */
 592 gboolean
 593 gtk_accel_group_disconnect_key (GtkAccelGroup  *accel_group,
 594                                 guint           accel_key,
 595                                 GdkModifierType accel_mods)
 596 {
 597   GtkAccelGroupEntry *entries;
 598   GSList *slist, *clist = NULL;
 599   gboolean removed_one = FALSE;
 600   guint n;
 601
 602   g_return_val_if_fail (GTK_IS_ACCEL_GROUP (accel_group), FALSE);
 603
 604   g_object_ref (accel_group);
 605
 606   accel_key = gdk_keyval_to_lower (accel_key);
 607   entries = quick_accel_find (accel_group, accel_key, accel_mods, &n);
 608   while (n--)
 609     {
 610       GClosure *closure = g_closure_ref (entries[n].closure);
 611
 612       clist = g_slist_prepend (clist, closure);
 613     }
 614
 615   for (slist = clist; slist; slist = slist->next)
 616     {
 617       GClosure *closure = slist->data;
 618
 619       removed_one |= gtk_accel_group_disconnect (accel_group, closure);
 620       g_closure_unref (closure);
 621     }
 622   g_slist_free (clist);
 623
 624   g_object_unref (accel_group);
 625
 626   return removed_one;
 627 }
 628
 629 void
 630 _gtk_accel_group_reconnect (GtkAccelGroup *accel_group,
 631                             GQuark         accel_path_quark)
 632 {
 633   GSList *slist, *clist = NULL;
 634   guint i;
 635
 636   g_return_if_fail (GTK_IS_ACCEL_GROUP (accel_group));
 637
 638   g_object_ref (accel_group);
 639
 640   for (i = 0; i < accel_group->n_accels; i++)
 641     if (accel_group->priv_accels[i].accel_path_quark == accel_path_quark)
 642       {
 643         GClosure *closure = g_closure_ref (accel_group->priv_accels[i].closure);
 644
 645         clist = g_slist_prepend (clist, closure);
 646       }
 647
 648   for (slist = clist; slist; slist = slist->next)
 649     {
 650       GClosure *closure = slist->data;
 651
 652       gtk_accel_group_disconnect (accel_group, closure);
 653       gtk_accel_group_connect_by_path (accel_group, g_quark_to_string (accel_path_quark), closure);
 654       g_closure_unref (closure);
 655     }
 656   g_slist_free (clist);
 657
 658   g_object_unref (accel_group);
 659 }
 660
 661 /**
 662  * gtk_accel_group_query:
 663  * @accel_group:      the accelerator group to query
 664  * @accel_key:        key value of the accelerator
 665  * @accel_mods:       modifier combination of the accelerator
 666  * @n_entries:        location to return the number of entries found, or %NULL
 667  * @returns:          an array of @n_entries #GtkAccelGroupEntry elements, or %NULL. The array is owned by GTK+ and must not be freed.
 668  *
 669  * Queries an accelerator group for all entries matching @accel_key and
 670  * @accel_mods.
 671  */
 672 GtkAccelGroupEntry*
 673 gtk_accel_group_query (GtkAccelGroup  *accel_group,
 674                        guint           accel_key,
 675                        GdkModifierType accel_mods,
 676                        guint          *n_entries)
 677 {
 678   GtkAccelGroupEntry *entries;
 679   guint n;
 680
 681   g_return_val_if_fail (GTK_IS_ACCEL_GROUP (accel_group), NULL);
 682
 683   entries = quick_accel_find (accel_group, gdk_keyval_to_lower (accel_key), accel_mods, &n);
 684
 685   if (n_entries)
 686     *n_entries = entries ? n : 0;
 687
 688   return entries;
 689 }
 690
 691 /**
 692  * gtk_accel_group_from_accel_closure:
 693  * @closure: a #GClosure
 694  * @returns: the #GtkAccelGroup to which @closure is connected, or %NULL.
 695  *
 696  * Finds the #GtkAccelGroup to which @closure is connected;
 697  * see gtk_accel_group_connect().
 698  */
 699 GtkAccelGroup*
 700 gtk_accel_group_from_accel_closure (GClosure *closure)
 701 {
 702   guint i;
 703
 704   g_return_val_if_fail (closure != NULL, NULL);
 705
 706   /* a few remarks on what we do here. in general, we need a way to reverse lookup
 707    * accel_groups from closures that are being used in accel groups. this could
 708    * be done e.g via a hashtable. it is however cheaper (memory wise) to just
 709    * use the invalidation notifier on the closure itself (which we need to install
 710    * anyway), that contains the accel group as data which, besides needing to peek
 711    * a bit at closure internals, works just as good.
 712    */
 713   for (i = 0; i < G_CLOSURE_N_NOTIFIERS (closure); i++)
 714     if (closure->notifiers[i].notify == accel_closure_invalidate)
 715       return closure->notifiers[i].data;
 716
 717   return NULL;
 718 }
 719
 720 gboolean
 721 _gtk_accel_group_activate (GtkAccelGroup  *accel_group,
 722                            GQuark          accel_quark,
 723                            GObject        *acceleratable,
 724                            guint           accel_key,
 725                            GdkModifierType accel_mods)
 726 {
 727   gboolean was_handled;
 728
 729   g_return_val_if_fail (GTK_IS_ACCEL_GROUP (accel_group), FALSE);
 730
 731   was_handled = FALSE;
 732   g_signal_emit (accel_group, signal_accel_activate, accel_quark,
 733                  acceleratable, accel_key, accel_mods, &was_handled);
 734
 735   return was_handled;
 736 }
 737
 738 /**
 739  * gtk_accel_groups_activate:
 740  * @object:        the #GObject, usually a #GtkWindow, on which
 741  *                 to activate the accelerator.
 742  * @accel_key:     accelerator keyval from a key event
 743  * @accel_mods:    keyboard state mask from a key event
 744  * @returns:       %TRUE if the accelerator was handled, %FALSE otherwise
 745  *
 746  * Finds the first accelerator in any #GtkAccelGroup attached
 747  * to @object that matches @accel_key and @accel_mods, and
 748  * activates that accelerator.
 749  * If an accelerator was activated and handled this keypress, %TRUE
 750  * is returned.
 751  */
 752 gboolean
 753 gtk_accel_groups_activate (GObject        *object,
 754                            guint           accel_key,
 755                            GdkModifierType accel_mods)
 756 {
 757   g_return_val_if_fail (G_IS_OBJECT (object), FALSE);
 758
 759   if (gtk_accelerator_valid (accel_key, accel_mods))
 760     {
 761       gchar *accel_name;
 762       GQuark accel_quark;
 763       GSList *slist;
 764
 765       accel_name = gtk_accelerator_name (accel_key, (accel_mods & gtk_accelerator_get_default_mod_mask ()));
 766       accel_quark = g_quark_from_string (accel_name);
 767       g_free (accel_name);
 768
 769       for (slist = gtk_accel_groups_from_object (object); slist; slist = slist->next)
 770         if (_gtk_accel_group_activate (slist->data, accel_quark, object, accel_key, accel_mods))
 771           return TRUE;
 772     }
 773
 774   return FALSE;
 775 }
 776
 777 /**
 778  * gtk_accelerator_valid:
 779  * @keyval:    a GDK keyval
 780  * @modifiers: modifier mask
 781  * @returns:   %TRUE if the accelerator is valid
 782  *
 783  * Determines whether a given keyval and modifier mask constitute
 784  * a valid keyboard accelerator. For example, the #GDK_a keyval
 785  * plus #GDK_CONTROL_MASK is valid - this is a "Ctrl+a" accelerator.
 786  * But, you can't, for instance, use the #GDK_Control_L keyval
 787  * as an accelerator.
 788  */
 789 gboolean
 790 gtk_accelerator_valid (guint              keyval,
 791                        GdkModifierType    modifiers)
 792 {
 793   static const guint invalid_accelerator_vals[] = {
 794     GDK_Shift_L, GDK_Shift_R, GDK_Shift_Lock, GDK_Caps_Lock, GDK_ISO_Lock,
 795     GDK_Control_L, GDK_Control_R, GDK_Meta_L, GDK_Meta_R,
 796     GDK_Alt_L, GDK_Alt_R, GDK_Super_L, GDK_Super_R, GDK_Hyper_L, GDK_Hyper_R,
 797     GDK_ISO_Level3_Shift, GDK_ISO_Next_Group, GDK_ISO_Prev_Group,
 798     GDK_ISO_First_Group, GDK_ISO_Last_Group,
 799     GDK_Mode_switch, GDK_Num_Lock, GDK_Multi_key,
 800     GDK_Scroll_Lock, GDK_Sys_Req,
 801     GDK_Tab, GDK_ISO_Left_Tab, GDK_KP_Tab,
 802     GDK_First_Virtual_Screen, GDK_Prev_Virtual_Screen,
 803     GDK_Next_Virtual_Screen, GDK_Last_Virtual_Screen,
 804     GDK_Terminate_Server, GDK_AudibleBell_Enable,
 805     0
 806   };
 807   static const guint invalid_unmodified_vals[] = {
 808     GDK_Up, GDK_Down, GDK_Left, GDK_Right,
 809     GDK_KP_Up, GDK_KP_Down, GDK_KP_Left, GDK_KP_Right,
 810     0
 811   };
 812   const guint *ac_val;
 813
 814   modifiers &= GDK_MODIFIER_MASK;
 815
 816   if (keyval <= 0xFF)
 817     return keyval >= 0x20;
 818
 819   ac_val = invalid_accelerator_vals;
 820   while (*ac_val)
 821     {
 822       if (keyval == *ac_val++)
 823         return FALSE;
 824     }
 825
 826   if (!modifiers)
 827     {
 828       ac_val = invalid_unmodified_vals;
 829       while (*ac_val)
 830         {
 831           if (keyval == *ac_val++)
 832             return FALSE;
 833         }
 834     }
 835
 836   return TRUE;
 837 }
 838
 839 static inline gboolean
 840 is_alt (const gchar *string)
 841 {
 842   return ((string[0] == '<') &&
 843           (string[1] == 'a' || string[1] == 'A') &&
 844           (string[2] == 'l' || string[2] == 'L') &&
 845           (string[3] == 't' || string[3] == 'T') &&
 846           (string[4] == '>'));
 847 }
 848
 849 static inline gboolean
 850 is_ctl (const gchar *string)
 851 {
 852   return ((string[0] == '<') &&
 853           (string[1] == 'c' || string[1] == 'C') &&
 854           (string[2] == 't' || string[2] == 'T') &&
 855           (string[3] == 'l' || string[3] == 'L') &&
 856           (string[4] == '>'));
 857 }
 858
 859 static inline gboolean
 860 is_modx (const gchar *string)
 861 {
 862   return ((string[0] == '<') &&
 863           (string[1] == 'm' || string[1] == 'M') &&
 864           (string[2] == 'o' || string[2] == 'O') &&
 865           (string[3] == 'd' || string[3] == 'D') &&
 866           (string[4] >= '1' && string[4] <= '5') &&
 867           (string[5] == '>'));
 868 }
 869
 870 static inline gboolean
 871 is_ctrl (const gchar *string)
 872 {
 873   return ((string[0] == '<') &&
 874           (string[1] == 'c' || string[1] == 'C') &&
 875           (string[2] == 't' || string[2] == 'T') &&
 876           (string[3] == 'r' || string[3] == 'R') &&
 877           (string[4] == 'l' || string[4] == 'L') &&
 878           (string[5] == '>'));
 879 }
 880
 881 static inline gboolean
 882 is_shft (const gchar *string)
 883 {
 884   return ((string[0] == '<') &&
 885           (string[1] == 's' || string[1] == 'S') &&
 886           (string[2] == 'h' || string[2] == 'H') &&
 887           (string[3] == 'f' || string[3] == 'F') &&
 888           (string[4] == 't' || string[4] == 'T') &&
 889           (string[5] == '>'));
 890 }
 891
 892 static inline gboolean
 893 is_shift (const gchar *string)
 894 {
 895   return ((string[0] == '<') &&
 896           (string[1] == 's' || string[1] == 'S') &&
 897           (string[2] == 'h' || string[2] == 'H') &&
 898           (string[3] == 'i' || string[3] == 'I') &&
 899           (string[4] == 'f' || string[4] == 'F') &&
 900           (string[5] == 't' || string[5] == 'T') &&
 901           (string[6] == '>'));
 902 }
 903
 904 static inline gboolean
 905 is_control (const gchar *string)
 906 {
 907   return ((string[0] == '<') &&
 908           (string[1] == 'c' || string[1] == 'C') &&
 909           (string[2] == 'o' || string[2] == 'O') &&
 910           (string[3] == 'n' || string[3] == 'N') &&
 911           (string[4] == 't' || string[4] == 'T') &&
 912           (string[5] == 'r' || string[5] == 'R') &&
 913           (string[6] == 'o' || string[6] == 'O') &&
 914           (string[7] == 'l' || string[7] == 'L') &&
 915           (string[8] == '>'));
 916 }
 917
 918 static inline gboolean
 919 is_release (const gchar *string)
 920 {
 921   return ((string[0] == '<') &&
 922           (string[1] == 'r' || string[1] == 'R') &&
 923           (string[2] == 'e' || string[2] == 'E') &&
 924           (string[3] == 'l' || string[3] == 'L') &&
 925           (string[4] == 'e' || string[4] == 'E') &&
 926           (string[5] == 'a' || string[5] == 'A') &&
 927           (string[6] == 's' || string[6] == 'S') &&
 928           (string[7] == 'e' || string[7] == 'E') &&
 929           (string[8] == '>'));
 930 }
 931
 932 /**
 933  * gtk_accelerator_parse:
 934  * @accelerator:      string representing an accelerator
 935  * @accelerator_key:  return location for accelerator keyval
 936  * @accelerator_mods: return location for accelerator modifier mask
 937  *
 938  * Parses a string representing an accelerator. The
 939  * format looks like "&lt;Control&gt;a" or "&lt;Shift&gt;&lt;Alt&gt;F1" or
 940  * "&lt;Release&gt;z" (the last one is for key release).
 941  * The parser is fairly liberal and allows lower or upper case,
 942  * and also abbreviations such as "&lt;Ctl&gt;" and "&lt;Ctrl&gt;".
 943  *
 944  * If the parse fails, @accelerator_key and @accelerator_mods will
 945  * be set to 0 (zero).
 946  */
 947 void
 948 gtk_accelerator_parse (const gchar     *accelerator,
 949                        guint           *accelerator_key,
 950                        GdkModifierType *accelerator_mods)
 951 {
 952   guint keyval;
 953   GdkModifierType mods;
 954   gint len;
 955
 956   if (accelerator_key)
 957     *accelerator_key = 0;
 958   if (accelerator_mods)
 959     *accelerator_mods = 0;
 960   g_return_if_fail (accelerator != NULL);
 961
 962   keyval = 0;
 963   mods = 0;
 964   len = strlen (accelerator);
 965   while (len)
 966     {
 967       if (*accelerator == '<')
 968         {
 969           if (len >= 9 && is_release (accelerator))
 970             {
 971               accelerator += 9;
 972               len -= 9;
 973               mods |= GDK_RELEASE_MASK;
 974             }
 975           else if (len >= 9 && is_control (accelerator))
 976             {
 977               accelerator += 9;
 978               len -= 9;
 979               mods |= GDK_CONTROL_MASK;
 980             }
 981           else if (len >= 7 && is_shift (accelerator))
 982             {
 983               accelerator += 7;
 984               len -= 7;
 985               mods |= GDK_SHIFT_MASK;
 986             }
 987           else if (len >= 6 && is_shft (accelerator))
 988             {
 989               accelerator += 6;
 990               len -= 6;
 991               mods |= GDK_SHIFT_MASK;
 992             }
 993           else if (len >= 6 && is_ctrl (accelerator))
 994             {
 995               accelerator += 6;
 996               len -= 6;
 997               mods |= GDK_CONTROL_MASK;
 998             }
 999           else if (len >= 6 && is_modx (accelerator))
1000             {
1001               static const guint mod_vals[] = {
1002                 GDK_MOD1_MASK, GDK_MOD2_MASK, GDK_MOD3_MASK,
1003                 GDK_MOD4_MASK, GDK_MOD5_MASK
1004               };
1005
1006               len -= 6;
1007               accelerator += 4;
1008               mods |= mod_vals[*accelerator - '1'];
1009               accelerator += 2;
1010             }
1011           else if (len >= 5 && is_ctl (accelerator))
1012             {
1013               accelerator += 5;
1014               len -= 5;
1015               mods |= GDK_CONTROL_MASK;
1016             }
1017           else if (len >= 5 && is_alt (accelerator))
1018             {
1019               accelerator += 5;
1020               len -= 5;
1021               mods |= GDK_MOD1_MASK;
1022             }
1023           else
1024             {
1025               gchar last_ch;
1026
1027               last_ch = *accelerator;
1028               while (last_ch && last_ch != '>')
1029                 {
1030                   last_ch = *accelerator;
1031                   accelerator += 1;
1032                   len -= 1;
1033                 }
1034             }
1035         }
1036       else
1037         {
1038           keyval = gdk_keyval_from_name (accelerator);
1039           accelerator += len;
1040           len -= len;
1041         }
1042     }
1043
1044   if (accelerator_key)
1045     *accelerator_key = gdk_keyval_to_lower (keyval);
1046   if (accelerator_mods)
1047     *accelerator_mods = mods;
1048 }
1049
1050 /**
1051  * gtk_accelerator_name:
1052  * @accelerator_key:  accelerator keyval
1053  * @accelerator_mods: accelerator modifier mask
1054  * @returns:          a newly-allocated accelerator name
1055  *
1056  * Converts an accelerator keyval and modifier mask
1057  * into a string parseable by gtk_accelerator_parse().
1058  * For example, if you pass in #GDK_q and #GDK_CONTROL_MASK,
1059  * this function returns "&lt;Control&gt;q".
1060  *
1061  * The caller of this function must free the returned string.
1062  */
1063 gchar*
1064 gtk_accelerator_name (guint           accelerator_key,
1065                       GdkModifierType accelerator_mods)
1066 {
1067   static const gchar text_release[] = "<Release>";
1068   static const gchar text_shift[] = "<Shift>";
1069   static const gchar text_control[] = "<Control>";
1070   static const gchar text_mod1[] = "<Alt>";
1071   static const gchar text_mod2[] = "<Mod2>";
1072   static const gchar text_mod3[] = "<Mod3>";
1073   static const gchar text_mod4[] = "<Mod4>";
1074   static const gchar text_mod5[] = "<Mod5>";
1075   guint l;
1076   gchar *keyval_name;
1077   gchar *accelerator;
1078
1079   accelerator_mods &= GDK_MODIFIER_MASK;
1080
1081   keyval_name = gdk_keyval_name (gdk_keyval_to_lower (accelerator_key));
1082   if (!keyval_name)
1083     keyval_name = "";
1084
1085   l = 0;
1086   if (accelerator_mods & GDK_RELEASE_MASK)
1087     l += sizeof (text_release) - 1;
1088   if (accelerator_mods & GDK_SHIFT_MASK)
1089     l += sizeof (text_shift) - 1;
1090   if (accelerator_mods & GDK_CONTROL_MASK)
1091     l += sizeof (text_control) - 1;
1092   if (accelerator_mods & GDK_MOD1_MASK)
1093     l += sizeof (text_mod1) - 1;
1094   if (accelerator_mods & GDK_MOD2_MASK)
1095     l += sizeof (text_mod2) - 1;
1096   if (accelerator_mods & GDK_MOD3_MASK)
1097     l += sizeof (text_mod3) - 1;
1098   if (accelerator_mods & GDK_MOD4_MASK)
1099     l += sizeof (text_mod4) - 1;
1100   if (accelerator_mods & GDK_MOD5_MASK)
1101     l += sizeof (text_mod5) - 1;
1102   l += strlen (keyval_name);
1103
1104   accelerator = g_new (gchar, l + 1);
1105
1106   l = 0;
1107   accelerator[l] = 0;
1108   if (accelerator_mods & GDK_RELEASE_MASK)
1109     {
1110       strcpy (accelerator + l, text_release);
1111       l += sizeof (text_release) - 1;
1112     }
1113   if (accelerator_mods & GDK_SHIFT_MASK)
1114     {
1115       strcpy (accelerator + l, text_shift);
1116       l += sizeof (text_shift) - 1;
1117     }
1118   if (accelerator_mods & GDK_CONTROL_MASK)
1119     {
1120       strcpy (accelerator + l, text_control);
1121       l += sizeof (text_control) - 1;
1122     }
1123   if (accelerator_mods & GDK_MOD1_MASK)
1124     {
1125       strcpy (accelerator + l, text_mod1);
1126       l += sizeof (text_mod1) - 1;
1127     }
1128   if (accelerator_mods & GDK_MOD2_MASK)
1129     {
1130       strcpy (accelerator + l, text_mod2);
1131       l += sizeof (text_mod2) - 1;
1132     }
1133   if (accelerator_mods & GDK_MOD3_MASK)
1134     {
1135       strcpy (accelerator + l, text_mod3);
1136       l += sizeof (text_mod3) - 1;
1137     }
1138   if (accelerator_mods & GDK_MOD4_MASK)
1139     {
1140       strcpy (accelerator + l, text_mod4);
1141       l += sizeof (text_mod4) - 1;
1142     }
1143   if (accelerator_mods & GDK_MOD5_MASK)
1144     {
1145       strcpy (accelerator + l, text_mod5);
1146       l += sizeof (text_mod5) - 1;
1147     }
1148   strcpy (accelerator + l, keyval_name);
1149
1150   return accelerator;
1151 }
1152
1153 /**
1154  * gtk_accelerator_set_default_mod_mask:
1155  * @default_mod_mask: accelerator modifier mask
1156  *
1157  * Sets the modifiers that will be considered significant for keyboard
1158  * accelerators. The default mod mask is #GDK_CONTROL_MASK |
1159  * #GDK_SHIFT_MASK | #GDK_MOD1_MASK, that is, Control, Shift, and Alt.
1160  * Other modifiers will by default be ignored by #GtkAccelGroup.
1161  * You must include at least the three default modifiers in any
1162  * value you pass to this function.
1163  *
1164  * The default mod mask should be changed on application startup,
1165  * before using any accelerator groups.
1166  */
1167 void
1168 gtk_accelerator_set_default_mod_mask (GdkModifierType default_mod_mask)
1169 {
1170   default_accel_mod_mask = (default_mod_mask & GDK_MODIFIER_MASK) |
1171     (GDK_CONTROL_MASK | GDK_SHIFT_MASK | GDK_MOD1_MASK);
1172 }
1173
1174 /**
1175  * gtk_accelerator_get_default_mod_mask:
1176  * @returns: the default accelerator modifier mask
1177  *
1178  * Gets the value set by gtk_accelerator_set_default_mod_mask().
1179  */
1180 guint
1181 gtk_accelerator_get_default_mod_mask (void)
1182 {
1183   return default_accel_mod_mask;
1184 }