1 /* GTK - The GIMP Toolkit
2 * Copyright (C) 1998, 2001 Tim Janik
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.
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.
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.
22 #include "gtkaccelmap.h"
24 #include "gtkwindow.h" /* in lack of GtkAcceleratable */
37 /* --- structures --- */
39 const gchar *accel_path;
49 /* --- variables --- */
50 static GHashTable *accel_entry_ht = NULL; /* accel_path -> AccelEntry */
51 static GSList *accel_filters = NULL;
54 /* --- functions --- */
56 accel_entry_hash (gconstpointer key)
58 const AccelEntry *entry = key;
60 return g_str_hash (entry->accel_path);
64 accel_entry_equal (gconstpointer key1,
67 const AccelEntry *entry1 = key1;
68 const AccelEntry *entry2 = key2;
70 return g_str_equal (entry1->accel_path, entry2->accel_path);
73 static inline AccelEntry*
74 accel_path_lookup (const gchar *accel_path)
78 ekey.accel_path = accel_path;
80 /* safety NULL check for return_if_fail()s */
81 return accel_path ? g_hash_table_lookup (accel_entry_ht, &ekey) : NULL;
85 _gtk_accel_map_init (void)
87 g_assert (accel_entry_ht == NULL);
89 accel_entry_ht = g_hash_table_new (accel_entry_hash, accel_entry_equal);
93 _gtk_accel_path_is_valid (const gchar *accel_path)
97 if (!accel_path || accel_path[0] != '<' ||
98 accel_path[1] == '<' || accel_path[1] == '>' || !accel_path[1])
100 p = strchr (accel_path, '>');
101 if (!p || p[1] != '/')
107 * gtk_accel_map_add_entry:
108 * @accel_path: valid accelerator path
109 * @accel_key: the accelerator key
110 * @accel_mods: the accelerator modifiers
112 * Registers a new accelerator with the global accelerator map.
113 * This function should only be called once per @accel_path
114 * with the canonical @accel_key and @accel_mods for this path.
115 * To change the accelerator during runtime programatically, use
116 * gtk_accel_map_change_entry().
117 * The accelerator path must consist of "<WINDOWTYPE>/Category1/Category2/.../Action",
118 * where <WINDOWTYPE> should be a unique application-specific identifier, that
119 * corresponds to the kind of window the accelerator is being used in, e.g. "Gimp-Image",
120 * "Abiword-Document" or "Gnumeric-Settings".
121 * The Category1/.../Action portion is most appropriately chosen by the action the
122 * accelerator triggers, i.e. for accelerators on menu items, choose the item's menu path,
123 * e.g. "File/Save As", "Image/View/Zoom" or "Edit/Select All".
124 * So a full valid accelerator path may look like:
125 * "<Gimp-Toolbox>/File/Dialogs/Tool Options...".
128 gtk_accel_map_add_entry (const gchar *accel_path,
134 g_return_if_fail (_gtk_accel_path_is_valid (accel_path));
139 accel_mods &= gtk_accelerator_get_default_mod_mask ();
141 entry = accel_path_lookup (accel_path);
144 if (!entry->std_accel_key && !entry->std_accel_mods &&
145 (accel_key || accel_mods))
147 entry->std_accel_key = accel_key;
148 entry->std_accel_mods = accel_mods;
150 gtk_accel_map_change_entry (entry->accel_path, accel_key, accel_mods, TRUE);
155 entry = g_new0 (AccelEntry, 1);
156 entry->accel_path = g_quark_to_string (g_quark_from_string (accel_path));
157 entry->std_accel_key = accel_key;
158 entry->std_accel_mods = accel_mods;
159 entry->accel_key = accel_key;
160 entry->accel_mods = accel_mods;
161 entry->changed = FALSE;
162 g_hash_table_insert (accel_entry_ht, entry, entry);
167 * gtk_accel_map_lookup_entry:
168 * @accel_path: a valid accelerator path
169 * @key: the accelerator key to be filled in (optional)
170 * @returns: %TRUE if @accel_path is known, %FALSE otherwise
172 * Looks up the accelerator entry for @accel_path and fills in @key.
175 gtk_accel_map_lookup_entry (const gchar *accel_path,
180 g_return_val_if_fail (_gtk_accel_path_is_valid (accel_path), FALSE);
182 entry = accel_path_lookup (accel_path);
185 key->accel_key = entry->accel_key;
186 key->accel_mods = entry->accel_mods;
187 key->accel_flags = 0;
190 return entry ? TRUE : FALSE;
194 hash2slist_foreach (gpointer key,
198 GSList **slist_p = user_data;
200 *slist_p = g_slist_prepend (*slist_p, value);
204 g_hash_table_slist_values (GHashTable *hash_table)
206 GSList *slist = NULL;
208 g_return_val_if_fail (hash_table != NULL, NULL);
210 g_hash_table_foreach (hash_table, hash2slist_foreach, &slist);
215 /* if simulate==TRUE, return whether accel_path can be changed to
216 * accel_key && accel_mods. otherwise, return whether accel_path
217 * was actually changed.
220 internal_change_entry (const gchar *accel_path,
222 GdkModifierType accel_mods,
226 GSList *node, *slist, *win_list, *group_list, *replace_list = NULL;
227 GHashTable *group_hm, *window_hm;
228 gboolean change_accel, removable, can_change = TRUE, seen_accel = FALSE;
230 AccelEntry *entry = accel_path_lookup (accel_path);
232 /* not much todo if there's no entry yet */
237 gtk_accel_map_add_entry (accel_path, 0, 0);
238 entry = accel_path_lookup (accel_path);
239 entry->accel_key = accel_key;
240 entry->accel_mods = accel_mods;
241 entry->changed = TRUE;
246 /* if there's nothing to change, not much todo either */
247 if (entry->accel_key == accel_key && entry->accel_mods == accel_mods)
250 entry->changed = TRUE;
251 return simulate ? TRUE : FALSE;
254 /* nobody's interested, easy going */
259 entry->accel_key = accel_key;
260 entry->accel_mods = accel_mods;
261 entry->changed = TRUE;
266 /* 1) fetch all accel groups affected by this entry */
267 entry_quark = g_quark_try_string (entry->accel_path);
268 group_hm = g_hash_table_new (NULL, NULL);
269 window_hm = g_hash_table_new (NULL, NULL);
270 for (slist = entry->groups; slist; slist = slist->next)
271 g_hash_table_insert (group_hm, slist->data, slist->data);
273 /* 2) collect acceleratables affected */
274 group_list = g_hash_table_slist_values (group_hm);
275 for (slist = group_list; slist; slist = slist->next)
277 GtkAccelGroup *group = slist->data;
279 for (node = group->acceleratables; node; node = node->next)
280 g_hash_table_insert (window_hm, node->data, node->data);
282 g_slist_free (group_list);
284 /* 3) include all accel groups used by acceleratables */
285 win_list = g_hash_table_slist_values (window_hm);
286 g_hash_table_destroy (window_hm);
287 for (slist = win_list; slist; slist = slist->next)
288 for (node = gtk_accel_groups_from_object (slist->data); node; node = node->next)
289 g_hash_table_insert (group_hm, node->data, node->data);
290 group_list = g_hash_table_slist_values (group_hm);
291 g_hash_table_destroy (group_hm);
293 /* 4) walk the acceleratables and figure whether they occupy accel_key&accel_mods */
295 for (slist = win_list; slist; slist = slist->next)
296 if (GTK_IS_WINDOW (slist->data)) /* bad kludge in lack of a GtkAcceleratable */
297 if (_gtk_window_query_nonaccels (slist->data, accel_key, accel_mods))
302 removable = !seen_accel;
304 /* 5) walk all accel groups and search for locks */
306 for (slist = group_list; slist; slist = slist->next)
308 GtkAccelGroup *group = slist->data;
309 GtkAccelGroupEntry *ag_entry;
313 ag_entry = entry->accel_key ? gtk_accel_group_query (group, entry->accel_key, entry->accel_mods, &n) : NULL;
314 for (i = 0; i < n; i++)
315 if (ag_entry[i].accel_path_quark == entry_quark)
317 can_change = !(ag_entry[i].key.accel_flags & GTK_ACCEL_LOCKED);
319 goto break_loop_step5;
323 ag_entry = accel_key ? gtk_accel_group_query (group, accel_key, accel_mods, &n) : NULL;
324 for (i = 0; i < n; i++)
327 removable = !group->lock_count && !(ag_entry[i].key.accel_flags & GTK_ACCEL_LOCKED);
329 goto break_loop_step5;
330 if (ag_entry[i].accel_path_quark)
331 replace_list = g_slist_prepend (replace_list, GUINT_TO_POINTER (ag_entry->accel_path_quark));
336 /* 6) check whether we can remove existing accelerators */
337 if (removable && can_change)
338 for (slist = replace_list; slist; slist = slist->next)
339 if (!internal_change_entry (g_quark_to_string (GPOINTER_TO_UINT (slist->data)), 0, 0, FALSE, TRUE))
345 /* 7) check conditions and proceed if possible */
346 change_accel = can_change && (!seen_accel || (removable && replace));
348 if (change_accel && !simulate)
350 guint old_accel_key, old_accel_mods;
352 /* ref accel groups */
353 for (slist = group_list; slist; slist = slist->next)
354 g_object_ref (slist->data);
356 /* 8) remove existing accelerators */
357 for (slist = replace_list; slist; slist = slist->next)
358 internal_change_entry (g_quark_to_string (GPOINTER_TO_UINT (slist->data)), 0, 0, FALSE, FALSE);
360 /* 9) install new accelerator */
361 old_accel_key = entry->accel_key;
362 old_accel_mods = entry->accel_mods;
363 entry->accel_key = accel_key;
364 entry->accel_mods = accel_mods;
365 entry->changed = TRUE;
366 for (slist = group_list; slist; slist = slist->next)
367 _gtk_accel_group_reconnect (slist->data, g_quark_from_string (entry->accel_path));
369 /* unref accel groups */
370 for (slist = group_list; slist; slist = slist->next)
371 g_object_unref (slist->data);
373 g_slist_free (replace_list);
374 g_slist_free (group_list);
375 g_slist_free (win_list);
381 * gtk_accel_map_change_entry:
382 * @accel_path: a valid accelerator path
383 * @accel_key: the new accelerator key
384 * @accel_mods: the new accelerator modifiers
385 * @replace: %TRUE if other accelerators may be deleted upon conflicts
386 * @returns: %TRUE if the accelerator could be changed, %FALSE otherwise
388 * Changes the @accel_key and @accel_mods currently associated with @accel_path.
389 * Due to conflicts with other accelerators, a change may not always be possible,
390 * @replace indicates whether other accelerators may be deleted to resolve such
391 * conflicts. A change will only occur if all conflicts could be resolved (which
392 * might not be the case if conflicting accelerators are locked). Successful
393 * changes are indicated by a %TRUE return value.
396 gtk_accel_map_change_entry (const gchar *accel_path,
398 GdkModifierType accel_mods,
401 g_return_val_if_fail (_gtk_accel_path_is_valid (accel_path), FALSE);
403 return internal_change_entry (accel_path, accel_key, accel_key ? accel_mods : 0, replace, FALSE);
407 accel_map_parse_accel_path (GScanner *scanner)
409 guint accel_key = 0, accel_mods = 0;
412 /* parse accel path */
413 g_scanner_get_next_token (scanner);
414 if (scanner->token != G_TOKEN_STRING)
415 return G_TOKEN_STRING;
417 /* test if the next token is an accelerator */
418 g_scanner_peek_next_token (scanner);
419 if (scanner->next_token != G_TOKEN_STRING)
421 /* if not so, eat that token and error out */
422 g_scanner_get_next_token (scanner);
423 return G_TOKEN_STRING;
426 /* get the full accelerator specification */
427 path = g_strdup (scanner->value.v_string);
428 g_scanner_get_next_token (scanner);
429 accel = g_strdup (scanner->value.v_string);
431 /* ensure the entry is present */
432 gtk_accel_map_add_entry (path, 0, 0);
434 /* and propagate it */
435 gtk_accelerator_parse (accel, &accel_key, &accel_mods);
436 gtk_accel_map_change_entry (path, accel_key, accel_mods, TRUE);
441 /* check correct statement end */
442 g_scanner_get_next_token (scanner);
443 if (scanner->token != ')')
450 accel_map_parse_statement (GScanner *scanner)
452 guint expected_token;
454 g_scanner_get_next_token (scanner);
456 if (scanner->token == G_TOKEN_SYMBOL)
458 guint (*parser_func) (GScanner*);
460 parser_func = scanner->value.v_symbol;
462 expected_token = parser_func (scanner);
465 expected_token = G_TOKEN_SYMBOL;
467 /* skip rest of statement on errrors
469 if (expected_token != G_TOKEN_NONE)
471 register guint level;
474 if (scanner->token == ')')
476 if (scanner->token == '(')
479 while (!g_scanner_eof (scanner) && level > 0)
481 g_scanner_get_next_token (scanner);
483 if (scanner->token == '(')
485 else if (scanner->token == ')')
492 * gtk_accel_map_load_scanner:
493 * @scanner: a #GScanner which has already been provided with an input file
495 * #GScanner variant of gtk_accel_map_load().
498 gtk_accel_map_load_scanner (GScanner *scanner)
500 gboolean skip_comment_single;
501 gboolean symbol_2_token;
502 gchar *cpair_comment_single;
503 gpointer saved_symbol;
505 g_return_if_fail (scanner != 0);
507 /* configure scanner */
508 skip_comment_single = scanner->config->skip_comment_single;
509 scanner->config->skip_comment_single = TRUE;
510 cpair_comment_single = scanner->config->cpair_comment_single;
511 scanner->config->cpair_comment_single = ";\n";
512 symbol_2_token = scanner->config->symbol_2_token;
513 scanner->config->symbol_2_token = FALSE;
514 saved_symbol = g_scanner_lookup_symbol (scanner, "gtk_accel_path");
515 g_scanner_scope_add_symbol (scanner, 0, "gtk_accel_path", accel_map_parse_accel_path);
517 /* outer parsing loop
519 g_scanner_peek_next_token (scanner);
520 while (scanner->next_token == '(')
522 g_scanner_get_next_token (scanner);
524 accel_map_parse_statement (scanner);
526 g_scanner_peek_next_token (scanner);
530 scanner->config->skip_comment_single = skip_comment_single;
531 scanner->config->cpair_comment_single = cpair_comment_single;
532 scanner->config->symbol_2_token = symbol_2_token;
533 g_scanner_scope_remove_symbol (scanner, 0, "gtk_accel_path");
535 g_scanner_scope_add_symbol (scanner, 0, "gtk_accel_path", saved_symbol);
539 * gtk_accel_map_load_fd:
540 * @fd: a valid readable file descriptor
542 * Filedescriptor variant of gtk_accel_map_load().
544 * Note that the file descriptor will not be closed by this function.
547 gtk_accel_map_load_fd (gint fd)
551 g_return_if_fail (fd >= 0);
553 /* create and setup scanner */
554 scanner = g_scanner_new (NULL);
555 g_scanner_input_file (scanner, fd);
557 gtk_accel_map_load_scanner (scanner);
559 g_scanner_destroy (scanner);
563 * gtk_accel_map_load:
564 * @file_name: a file containing accelerator specifications
566 * Parses a file previously saved with gtk_accel_map_save() for
567 * accelerator specifications, and propagates them accordingly.
570 gtk_accel_map_load (const gchar *file_name)
574 g_return_if_fail (file_name != NULL);
576 if (!g_file_test (file_name, G_FILE_TEST_IS_REGULAR))
579 fd = open (file_name, O_RDONLY);
583 gtk_accel_map_load_fd (fd);
589 accel_map_print (gpointer data,
590 const gchar *accel_path,
595 GString *gstring = g_string_new (changed ? NULL : "; ");
596 gint err, fd = GPOINTER_TO_INT (data);
599 g_string_append (gstring, "(gtk_accel_path \"");
601 tmp = g_strescape (accel_path, NULL);
602 g_string_append (gstring, tmp);
605 g_string_append (gstring, "\" \"");
607 name = gtk_accelerator_name (accel_key, accel_mods);
608 tmp = g_strescape (name, NULL);
610 g_string_append (gstring, tmp);
613 g_string_append (gstring, "\")\n");
616 err = write (fd, gstring->str, gstring->len);
617 while (err < 0 && errno == EINTR);
619 g_string_free (gstring, TRUE);
623 * gtk_accel_map_save_fd:
624 * @fd: a valid writable file descriptor
626 * Filedescriptor variant of gtk_accel_map_save().
628 * Note that the file descriptor will not be closed by this function.
631 gtk_accel_map_save_fd (gint fd)
636 g_return_if_fail (fd >= 0);
638 gstring = g_string_new ("; ");
639 if (g_get_prgname ())
640 g_string_append (gstring, g_get_prgname ());
641 g_string_append (gstring, " GtkAccelMap rc-file -*- scheme -*-\n");
642 g_string_append (gstring, "; this file is an automated accelerator map dump\n");
643 g_string_append (gstring, ";\n");
646 err = write (fd, gstring->str, gstring->len);
647 while (err < 0 && errno == EINTR);
649 gtk_accel_map_foreach (GINT_TO_POINTER (fd), accel_map_print);
653 * gtk_accel_map_save:
654 * @file_name: the file to contain accelerator specifications
656 * Saves current accelerator specifications (accelerator path, key
657 * and modifiers) to @file_name.
658 * The file is written in a format suitable to be read back in by
659 * gtk_accel_map_load().
662 gtk_accel_map_save (const gchar *file_name)
666 g_return_if_fail (file_name != NULL);
668 fd = open (file_name, O_CREAT | O_TRUNC | O_WRONLY, 0644);
672 gtk_accel_map_save_fd (fd);
678 * gtk_accel_map_foreach:
679 * @data: data to be passed into @foreach_func
680 * @foreach_func: function to be executed for each accel map entry which
681 * is not filtered out
683 * Loops over the entries in the accelerator map whose accel path
684 * doesn't match any of the filters added with gtk_accel_map_add_filter(),
685 * and execute @foreach_func on each. The signature of @foreach_func is
686 * that of #GtkAccelMapForeach, the @changed parameter indicates whether
687 * this accelerator was changed during runtime (thus, would need
688 * saving during an accelerator map dump).
691 gtk_accel_map_foreach (gpointer data,
692 GtkAccelMapForeach foreach_func)
694 GSList *entries, *slist, *node;
696 g_return_if_fail (foreach_func != NULL);
698 entries = g_hash_table_slist_values (accel_entry_ht);
699 for (slist = entries; slist; slist = slist->next)
701 AccelEntry *entry = slist->data;
702 gboolean changed = entry->accel_key != entry->std_accel_key || entry->accel_mods != entry->std_accel_mods;
704 for (node = accel_filters; node; node = node->next)
705 if (g_pattern_match_string (node->data, entry->accel_path))
707 foreach_func (data, entry->accel_path, entry->accel_key, entry->accel_mods, changed);
711 g_slist_free (entries);
715 * gtk_accel_map_foreach_unfiltered:
716 * @data: data to be passed into @foreach_func
717 * @foreach_func: function to be executed for each accel map entry
719 * Loops over all entries in the accelerator map, and execute
720 * @foreach_func on each. The signature of @foreach_func is that of
721 * #GtkAccelMapForeach, the @changed parameter indicates whether
722 * this accelerator was changed during runtime (thus, would need
723 * saving during an accelerator map dump).
726 gtk_accel_map_foreach_unfiltered (gpointer data,
727 GtkAccelMapForeach foreach_func)
729 GSList *entries, *slist;
731 g_return_if_fail (foreach_func != NULL);
733 entries = g_hash_table_slist_values (accel_entry_ht);
734 for (slist = entries; slist; slist = slist->next)
736 AccelEntry *entry = slist->data;
737 gboolean changed = entry->accel_key != entry->std_accel_key || entry->accel_mods != entry->std_accel_mods;
739 foreach_func (data, entry->accel_path, entry->accel_key, entry->accel_mods, changed);
741 g_slist_free (entries);
745 * gtk_accel_map_add_filter:
746 * @filter_pattern: a pattern (see #GPatternSpec)
748 * Adds a filter to the global list of accel path filters.
750 * Accel map entries whose accel path matches one of the filters
751 * are skipped by gtk_accel_map_foreach().
754 gtk_accel_map_add_filter (const gchar *filter_pattern)
759 g_return_if_fail (filter_pattern != NULL);
761 pspec = g_pattern_spec_new (filter_pattern);
762 for (slist = accel_filters; slist; slist = slist->next)
763 if (g_pattern_spec_equal (pspec, slist->data))
765 g_pattern_spec_free (pspec);
768 accel_filters = g_slist_prepend (accel_filters, pspec);
772 _gtk_accel_map_add_group (const gchar *accel_path,
773 GtkAccelGroup *accel_group)
777 g_return_if_fail (_gtk_accel_path_is_valid (accel_path));
778 g_return_if_fail (GTK_IS_ACCEL_GROUP (accel_group));
780 entry = accel_path_lookup (accel_path);
783 gtk_accel_map_add_entry (accel_path, 0, 0);
784 entry = accel_path_lookup (accel_path);
786 entry->groups = g_slist_prepend (entry->groups, accel_group);
790 _gtk_accel_map_remove_group (const gchar *accel_path,
791 GtkAccelGroup *accel_group)
795 entry = accel_path_lookup (accel_path);
796 g_return_if_fail (entry != NULL);
797 g_return_if_fail (g_slist_find (entry->groups, accel_group));
799 entry->groups = g_slist_remove (entry->groups, accel_group);