1 /* GTK - The GIMP Toolkit
2 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
4 * GtkItemFactory: Flexible item factory with automatic rc handling
5 * Copyright (C) 1998 Tim Janik
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2 of the License, or (at your option) any later version.
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with this library; if not, write to the
19 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20 * Boston, MA 02111-1307, USA.
24 * Modified by the GTK+ Team and others 1997-2000. See the AUTHORS
25 * file for a list of people on the GTK+ Team. See the ChangeLog
26 * files for a list of changes. These files are distributed with
27 * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
32 #include "gtkitemfactory.h"
33 #include "gtk/gtksignal.h"
34 #include "gtk/gtkoptionmenu.h"
35 #include "gtk/gtkmenubar.h"
36 #include "gtk/gtkmenu.h"
37 #include "gtk/gtkmenuitem.h"
38 #include "gtk/gtkradiomenuitem.h"
39 #include "gtk/gtkcheckmenuitem.h"
40 #include "gtk/gtkimagemenuitem.h"
41 #include "gtk/gtktearoffmenuitem.h"
42 #include "gtk/gtkaccellabel.h"
43 #include "gdk/gdkkeysyms.h"
44 #include "gtk/gtkimage.h"
45 #include "gtk/gtkstock.h"
46 #include "gtk/gtkiconfactory.h"
55 #include <io.h> /* For _open and _close */
58 #define S_ISREG(mode) ((mode)&_S_IFREG)
64 #define ITEM_FACTORY_STRING ((gchar*) item_factory_string)
65 #define ITEM_BLOCK_SIZE (128)
68 /* --- structures --- */
69 typedef struct _GtkIFCBData GtkIFCBData;
70 typedef struct _GtkIFDumpData GtkIFDumpData;
73 GtkItemFactoryCallback func;
76 guint callback_action;
80 GtkPrintFunc print_func;
82 guint modified_only : 1;
87 /* --- prototypes --- */
88 static void gtk_item_factory_class_init (GtkItemFactoryClass *klass);
89 static void gtk_item_factory_init (GtkItemFactory *ifactory);
90 static void gtk_item_factory_destroy (GtkObject *object);
91 static void gtk_item_factory_finalize (GObject *object);
94 /* --- static variables --- */
95 static GtkItemFactoryClass *gtk_item_factory_class = NULL;
96 static gpointer parent_class = NULL;
97 static const gchar *item_factory_string = "Gtk-<ItemFactory>";
98 static GMemChunk *ifactory_item_chunks = NULL;
99 static GMemChunk *ifactory_cb_data_chunks = NULL;
100 static GQuark quark_popup_data = 0;
101 static GQuark quark_if_menu_pos = 0;
102 static GQuark quark_item_factory = 0;
103 static GQuark quark_item_path = 0;
104 static GQuark quark_action = 0;
105 static GQuark quark_accel_group = 0;
106 static GQuark quark_type_item = 0;
107 static GQuark quark_type_title = 0;
108 static GQuark quark_type_radio_item = 0;
109 static GQuark quark_type_check_item = 0;
110 static GQuark quark_type_toggle_item = 0;
111 static GQuark quark_type_image_item = 0;
112 static GQuark quark_type_stock_item = 0;
113 static GQuark quark_type_tearoff_item = 0;
114 static GQuark quark_type_separator_item = 0;
115 static GQuark quark_type_branch = 0;
116 static GQuark quark_type_last_branch = 0;
117 static GScannerConfig ifactory_scanner_config =
121 ) /* cset_skip_characters */,
126 ) /* cset_identifier_first */,
133 ) /* cset_identifier_nth */,
134 ( ";\n" ) /* cpair_comment_single */,
136 FALSE /* case_sensitive */,
138 TRUE /* skip_comment_multi */,
139 TRUE /* skip_comment_single */,
140 FALSE /* scan_comment_multi */,
141 TRUE /* scan_identifier */,
142 FALSE /* scan_identifier_1char */,
143 FALSE /* scan_identifier_NULL */,
144 TRUE /* scan_symbols */,
145 TRUE /* scan_binary */,
146 TRUE /* scan_octal */,
147 TRUE /* scan_float */,
149 FALSE /* scan_hex_dollar */,
150 TRUE /* scan_string_sq */,
151 TRUE /* scan_string_dq */,
152 TRUE /* numbers_2_int */,
153 FALSE /* int_2_float */,
154 FALSE /* identifier_2_string */,
155 TRUE /* char_2_token */,
156 FALSE /* symbol_2_token */,
160 /* --- functions --- */
162 gtk_item_factory_get_type (void)
164 static GtkType item_factory_type = 0;
166 if (!item_factory_type)
168 static const GtkTypeInfo item_factory_info =
171 sizeof (GtkItemFactory),
172 sizeof (GtkItemFactoryClass),
173 (GtkClassInitFunc) gtk_item_factory_class_init,
174 (GtkObjectInitFunc) gtk_item_factory_init,
175 /* reserved_1 */ NULL,
176 /* reserved_2 */ NULL,
177 (GtkClassInitFunc) NULL,
180 item_factory_type = gtk_type_unique (GTK_TYPE_OBJECT, &item_factory_info);
183 return item_factory_type;
187 gtk_item_factory_class_init (GtkItemFactoryClass *class)
189 GObjectClass *gobject_class = G_OBJECT_CLASS (class);
190 GtkObjectClass *object_class;
192 gtk_item_factory_class = class;
194 parent_class = gtk_type_class (GTK_TYPE_OBJECT);
196 object_class = (GtkObjectClass*) class;
198 gobject_class->finalize = gtk_item_factory_finalize;
200 object_class->destroy = gtk_item_factory_destroy;
202 class->cpair_comment_single = g_strdup (";\n");
204 class->item_ht = g_hash_table_new (g_str_hash, g_str_equal);
206 ifactory_item_chunks =
207 g_mem_chunk_new ("GtkItemFactoryItem",
208 sizeof (GtkItemFactoryItem),
209 sizeof (GtkItemFactoryItem) * ITEM_BLOCK_SIZE,
211 ifactory_cb_data_chunks =
212 g_mem_chunk_new ("GtkIFCBData",
213 sizeof (GtkIFCBData),
214 sizeof (GtkIFCBData) * ITEM_BLOCK_SIZE,
217 quark_popup_data = g_quark_from_static_string ("GtkItemFactory-popup-data");
218 quark_if_menu_pos = g_quark_from_static_string ("GtkItemFactory-menu-position");
219 quark_item_factory = g_quark_from_static_string ("GtkItemFactory");
220 quark_item_path = g_quark_from_static_string ("GtkItemFactory-path");
221 quark_action = g_quark_from_static_string ("GtkItemFactory-action");
222 quark_accel_group = g_quark_from_static_string ("GtkAccelGroup");
223 quark_type_item = g_quark_from_static_string ("<Item>");
224 quark_type_title = g_quark_from_static_string ("<Title>");
225 quark_type_radio_item = g_quark_from_static_string ("<RadioItem>");
226 quark_type_check_item = g_quark_from_static_string ("<CheckItem>");
227 quark_type_toggle_item = g_quark_from_static_string ("<ToggleItem>");
228 quark_type_image_item = g_quark_from_static_string ("<ImageItem>");
229 quark_type_stock_item = g_quark_from_static_string ("<StockItem>");
230 quark_type_separator_item = g_quark_from_static_string ("<Separator>");
231 quark_type_tearoff_item = g_quark_from_static_string ("<Tearoff>");
232 quark_type_branch = g_quark_from_static_string ("<Branch>");
233 quark_type_last_branch = g_quark_from_static_string ("<LastBranch>");
237 gtk_item_factory_init (GtkItemFactory *ifactory)
241 object = GTK_OBJECT (ifactory);
243 ifactory->path = NULL;
244 ifactory->accel_group = NULL;
245 ifactory->widget = NULL;
246 ifactory->items = NULL;
247 ifactory->translate_func = NULL;
248 ifactory->translate_data = NULL;
249 ifactory->translate_notify = NULL;
253 gtk_item_factory_new (GtkType container_type,
255 GtkAccelGroup *accel_group)
257 GtkItemFactory *ifactory;
259 g_return_val_if_fail (path != NULL, NULL);
261 ifactory = gtk_type_new (GTK_TYPE_ITEM_FACTORY);
262 gtk_item_factory_construct (ifactory, container_type, path, accel_group);
268 gtk_item_factory_callback_marshal (GtkWidget *widget,
275 if (data->callback_type == 1)
277 GtkItemFactoryCallback1 func1 = (GtkItemFactoryCallback1) data->func;
278 func1 (data->func_data, data->callback_action, widget);
280 else if (data->callback_type == 2)
282 GtkItemFactoryCallback2 func2 = (GtkItemFactoryCallback2) data->func;
283 func2 (widget, data->func_data, data->callback_action);
288 gtk_item_factory_propagate_accelerator (GtkItemFactoryItem *item,
294 if (item->in_propagation)
297 item->in_propagation = TRUE;
300 for (slist = item->widgets; slist; slist = slist->next)
304 widget = slist->data;
306 if (widget != exclude)
308 gtk_widget_ref (widget);
309 widget_list = g_slist_prepend (widget_list, widget);
313 for (slist = widget_list; slist; slist = slist->next)
316 GtkAccelGroup *accel_group;
319 widget = slist->data;
321 accel_group = gtk_object_get_data_by_id (GTK_OBJECT (widget), quark_accel_group);
323 signal_id = gtk_signal_lookup ("activate", GTK_OBJECT_TYPE (widget));
324 if (signal_id && accel_group)
326 if (item->accelerator_key)
327 gtk_widget_add_accelerator (widget,
330 item->accelerator_key,
331 item->accelerator_mods,
337 work = gtk_accel_group_entries_from_object (G_OBJECT (widget));
340 GtkAccelEntry *ac_entry;
342 ac_entry = work->data;
344 if (ac_entry->accel_flags & GTK_ACCEL_VISIBLE &&
345 ac_entry->accel_group == accel_group &&
346 ac_entry->signal_id == signal_id)
347 gtk_widget_remove_accelerator (GTK_WIDGET (widget),
348 ac_entry->accel_group,
349 ac_entry->accelerator_key,
350 ac_entry->accelerator_mods);
355 gtk_widget_unref (widget);
358 g_slist_free (widget_list);
360 item->in_propagation = FALSE;
364 gtk_item_factory_item_add_accelerator (GtkWidget *widget,
365 guint accel_signal_id,
366 GtkAccelGroup *accel_group,
369 GtkAccelFlags accel_flags,
370 GtkItemFactoryItem *item)
372 if (!item->in_propagation &&
373 g_slist_find (item->widgets, widget) &&
374 accel_signal_id == gtk_signal_lookup ("activate", GTK_OBJECT_TYPE (widget)))
376 item->accelerator_key = accel_key;
377 item->accelerator_mods = accel_mods;
378 item->modified = TRUE;
380 gtk_item_factory_propagate_accelerator (item, widget);
387 gtk_item_factory_item_remove_accelerator (GtkWidget *widget,
388 GtkAccelGroup *accel_group,
391 GtkItemFactoryItem *item)
393 if (!item->in_propagation &&
394 g_slist_find (item->widgets, widget) &&
395 item->accelerator_key == accel_key &&
396 item->accelerator_mods == accel_mods)
398 item->accelerator_key = 0;
399 item->accelerator_mods = 0;
400 item->modified = TRUE;
402 gtk_item_factory_propagate_accelerator (item, widget);
407 gtk_item_factory_item_remove_widget (GtkWidget *widget,
408 GtkItemFactoryItem *item)
410 item->widgets = g_slist_remove (item->widgets, widget);
411 gtk_object_remove_data_by_id (GTK_OBJECT (widget), quark_item_factory);
412 gtk_object_remove_data_by_id (GTK_OBJECT (widget), quark_item_path);
416 gtk_item_factory_add_foreign (GtkWidget *accel_widget,
417 const gchar *full_path,
418 GtkAccelGroup *accel_group,
420 GdkModifierType modifiers)
422 GtkItemFactoryClass *class;
423 GtkItemFactoryItem *item;
425 g_return_if_fail (GTK_IS_WIDGET (accel_widget));
426 g_return_if_fail (full_path != NULL);
428 class = gtk_type_class (GTK_TYPE_ITEM_FACTORY);
430 keyval = keyval != GDK_VoidSymbol ? keyval : 0;
432 item = g_hash_table_lookup (class->item_ht, full_path);
435 item = g_chunk_new (GtkItemFactoryItem, ifactory_item_chunks);
437 item->path = g_strdup (full_path);
438 item->accelerator_key = keyval;
439 item->accelerator_mods = modifiers;
440 item->modified = FALSE;
441 item->in_propagation = FALSE;
443 item->widgets = NULL;
445 g_hash_table_insert (class->item_ht, item->path, item);
448 item->widgets = g_slist_prepend (item->widgets, accel_widget);
449 gtk_signal_connect (GTK_OBJECT (accel_widget),
451 GTK_SIGNAL_FUNC (gtk_item_factory_item_remove_widget),
454 /* set the item path for the widget
456 gtk_object_set_data_by_id (GTK_OBJECT (accel_widget), quark_item_path, item->path);
457 gtk_widget_set_name (accel_widget, item->path);
460 gtk_accel_group_ref (accel_group);
461 gtk_object_set_data_by_id_full (GTK_OBJECT (accel_widget),
464 (GtkDestroyNotify) gtk_accel_group_unref);
467 gtk_object_set_data_by_id (GTK_OBJECT (accel_widget), quark_accel_group, NULL);
469 /* install defined accelerators
471 if (gtk_signal_lookup ("activate", GTK_OBJECT_TYPE (accel_widget)))
473 if (item->accelerator_key && accel_group)
474 gtk_widget_add_accelerator (accel_widget,
477 item->accelerator_key,
478 item->accelerator_mods,
481 gtk_widget_remove_accelerators (accel_widget,
486 /* keep track of accelerator changes
488 gtk_signal_connect_after (GTK_OBJECT (accel_widget),
490 GTK_SIGNAL_FUNC (gtk_item_factory_item_add_accelerator),
492 gtk_signal_connect_after (GTK_OBJECT (accel_widget),
493 "remove-accelerator",
494 GTK_SIGNAL_FUNC (gtk_item_factory_item_remove_accelerator),
499 ifactory_cb_data_free (gpointer mem)
501 g_mem_chunk_free (ifactory_cb_data_chunks, mem);
505 gtk_item_factory_add_item (GtkItemFactory *ifactory,
507 const gchar *accelerator,
508 GtkItemFactoryCallback callback,
509 guint callback_action,
510 gpointer callback_data,
515 GtkItemFactoryClass *class;
516 GtkItemFactoryItem *item;
520 g_return_if_fail (widget != NULL);
521 g_return_if_fail (item_type != NULL);
523 class = GTK_ITEM_FACTORY_GET_CLASS (ifactory);
525 /* set accelerator group on menu widgets
527 if (GTK_IS_MENU (widget))
528 gtk_menu_set_accel_group ((GtkMenu*) widget, ifactory->accel_group);
530 /* connect callback if neccessary
536 data = g_chunk_new (GtkIFCBData, ifactory_cb_data_chunks);
537 data->func = callback;
538 data->callback_type = callback_type;
539 data->func_data = callback_data;
540 data->callback_action = callback_action;
542 gtk_object_weakref (GTK_OBJECT (widget),
543 ifactory_cb_data_free,
545 gtk_signal_connect (GTK_OBJECT (widget),
547 GTK_SIGNAL_FUNC (gtk_item_factory_callback_marshal),
551 /* link the widget into its item-entry
552 * and keep back pointer on both the item factory and the widget
554 gtk_object_set_data_by_id (GTK_OBJECT (widget), quark_action, GUINT_TO_POINTER (callback_action));
555 gtk_object_set_data_by_id (GTK_OBJECT (widget), quark_item_factory, ifactory);
557 gtk_accelerator_parse (accelerator, &keyval, &mods);
563 fpath = g_strconcat (ifactory->path, path, NULL);
564 gtk_item_factory_add_foreign (widget, fpath, ifactory->accel_group, keyval, mods);
565 item = g_hash_table_lookup (class->item_ht, fpath);
568 g_return_if_fail (item != NULL);
570 if (!g_slist_find (ifactory->items, item))
571 ifactory->items = g_slist_prepend (ifactory->items, item);
575 gtk_item_factory_construct (GtkItemFactory *ifactory,
576 GtkType container_type,
578 GtkAccelGroup *accel_group)
582 g_return_if_fail (GTK_IS_ITEM_FACTORY (ifactory));
583 g_return_if_fail (ifactory->accel_group == NULL);
584 g_return_if_fail (path != NULL);
585 if (!gtk_type_is_a (container_type, GTK_TYPE_OPTION_MENU))
586 g_return_if_fail (gtk_type_is_a (container_type, GTK_TYPE_MENU_SHELL));
590 if (path[0] != '<' && path[len - 1] != '>')
592 g_warning ("GtkItemFactory: invalid factory path `%s'", path);
598 ifactory->accel_group = accel_group;
599 gtk_accel_group_ref (ifactory->accel_group);
602 ifactory->accel_group = gtk_accel_group_new ();
604 ifactory->path = g_strdup (path);
605 ifactory->widget = g_object_connect (gtk_widget_new (container_type, NULL),
606 "signal::destroy", gtk_widget_destroyed, &ifactory->widget,
608 gtk_object_ref (GTK_OBJECT (ifactory));
609 gtk_object_sink (GTK_OBJECT (ifactory));
611 gtk_item_factory_add_item (ifactory,
619 gtk_item_factory_from_path (const gchar *path)
621 GtkItemFactoryClass *class;
622 GtkItemFactoryItem *item;
626 g_return_val_if_fail (path != NULL, NULL);
627 g_return_val_if_fail (path[0] == '<', NULL);
629 class = gtk_type_class (GTK_TYPE_ITEM_FACTORY);
632 while (path[i] && path[i] != '>')
636 g_warning ("gtk_item_factory_from_path(): invalid factory path \"%s\"",
640 fname = g_new (gchar, i + 2);
641 g_memmove (fname, path, i + 1);
644 item = g_hash_table_lookup (class->item_ht, fname);
648 if (item && item->widgets)
649 return gtk_item_factory_from_widget (item->widgets->data);
655 gtk_item_factory_destroy (GtkObject *object)
657 GtkItemFactory *ifactory;
660 g_return_if_fail (GTK_IS_ITEM_FACTORY (object));
662 ifactory = (GtkItemFactory*) object;
664 if (ifactory->widget)
668 dobj = GTK_OBJECT (ifactory->widget);
670 gtk_object_ref (dobj);
671 gtk_object_sink (dobj);
672 gtk_object_destroy (dobj);
673 gtk_object_unref (dobj);
675 ifactory->widget = NULL;
678 for (slist = ifactory->items; slist; slist = slist->next)
680 GtkItemFactoryItem *item = slist->data;
683 for (link = item->widgets; link; link = link->next)
684 if (gtk_object_get_data_by_id (link->data, quark_item_factory) == ifactory)
685 gtk_object_remove_data_by_id (link->data, quark_item_factory);
687 g_slist_free (ifactory->items);
688 ifactory->items = NULL;
690 GTK_OBJECT_CLASS (parent_class)->destroy (object);
694 gtk_item_factory_finalize (GObject *object)
696 GtkItemFactory *ifactory;
698 g_return_if_fail (GTK_IS_ITEM_FACTORY (object));
700 ifactory = GTK_ITEM_FACTORY (object);
702 gtk_accel_group_unref (ifactory->accel_group);
703 g_free (ifactory->path);
704 g_assert (ifactory->widget == NULL);
706 if (ifactory->translate_notify)
707 ifactory->translate_notify (ifactory->translate_data);
709 G_OBJECT_CLASS (parent_class)->finalize (object);
713 gtk_item_factory_from_widget (GtkWidget *widget)
715 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
717 return gtk_object_get_data_by_id (GTK_OBJECT (widget), quark_item_factory);
721 gtk_item_factory_path_from_widget (GtkWidget *widget)
723 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
725 return gtk_object_get_data_by_id (GTK_OBJECT (widget), quark_item_path);
729 item_factory_escape_path (const gchar *path)
731 GString *str = g_string_new (NULL);
740 g_string_append (str, "\\n");
743 g_string_append (str, "\\r");
747 g_string_append_c (str, '\\');
750 g_string_append_c (str, c);
756 return g_string_free (str, FALSE);
760 gtk_item_factory_foreach (gpointer hash_key,
764 GtkItemFactoryItem *item;
769 gchar comment_prefix[2] = "\000\000";
774 if (data->pspec && !g_pattern_match_string (data->pspec, item->path))
777 comment_prefix[0] = gtk_item_factory_class->cpair_comment_single[0];
779 path = item_factory_escape_path (hash_key);
780 name = gtk_accelerator_name (item->accelerator_key, item->accelerator_mods);
781 string = g_strconcat (item->modified ? "" : comment_prefix,
791 data->print_func (data->func_data, string);
797 gtk_item_factory_dump_items (GPatternSpec *path_pspec,
798 gboolean modified_only,
799 GtkPrintFunc print_func,
804 g_return_if_fail (print_func != NULL);
806 if (!gtk_item_factory_class)
807 gtk_type_class (GTK_TYPE_ITEM_FACTORY);
809 data.print_func = print_func;
810 data.func_data = func_data;
811 data.modified_only = (modified_only != FALSE);
812 data.pspec = path_pspec;
814 g_hash_table_foreach (gtk_item_factory_class->item_ht, gtk_item_factory_foreach, &data);
818 gtk_item_factory_print_func (gpointer FILE_pointer,
821 FILE *f_out = FILE_pointer;
823 g_return_if_fail (FILE_pointer != NULL);
824 g_return_if_fail (string != NULL);
826 fputs (string, f_out);
831 gtk_item_factory_dump_rc (const gchar *file_name,
832 GPatternSpec *path_pspec,
833 gboolean modified_only)
837 g_return_if_fail (file_name != NULL);
839 f_out = fopen (file_name, "w");
844 if (g_get_prgname ())
845 fputs (g_get_prgname (), f_out);
846 fputs (" GtkItemFactory rc-file -*- scheme -*-\n", f_out);
847 fputs ("; this file is an automated menu-path dump\n", f_out);
848 fputs (";\n", f_out);
850 gtk_item_factory_dump_items (path_pspec,
852 gtk_item_factory_print_func,
859 gtk_item_factory_create_items (GtkItemFactory *ifactory,
861 GtkItemFactoryEntry *entries,
862 gpointer callback_data)
864 gtk_item_factory_create_items_ac (ifactory, n_entries, entries, callback_data, 1);
868 gtk_item_factory_create_items_ac (GtkItemFactory *ifactory,
870 GtkItemFactoryEntry *entries,
871 gpointer callback_data,
876 g_return_if_fail (GTK_IS_ITEM_FACTORY (ifactory));
877 g_return_if_fail (callback_type >= 1 && callback_type <= 2);
882 g_return_if_fail (entries != NULL);
884 for (i = 0; i < n_entries; i++)
885 gtk_item_factory_create_item (ifactory, entries + i, callback_data, callback_type);
889 gtk_item_factory_get_widget (GtkItemFactory *ifactory,
892 GtkItemFactoryClass *class;
893 GtkItemFactoryItem *item;
895 g_return_val_if_fail (GTK_IS_ITEM_FACTORY (ifactory), NULL);
896 g_return_val_if_fail (path != NULL, NULL);
898 class = GTK_ITEM_FACTORY_GET_CLASS (ifactory);
901 item = g_hash_table_lookup (class->item_ht, (gpointer) path);
906 fpath = g_strconcat (ifactory->path, path, NULL);
907 item = g_hash_table_lookup (class->item_ht, fpath);
915 for (slist = item->widgets; slist; slist = slist->next)
917 if (gtk_item_factory_from_widget (slist->data) == ifactory)
926 gtk_item_factory_get_widget_by_action (GtkItemFactory *ifactory,
931 g_return_val_if_fail (GTK_IS_ITEM_FACTORY (ifactory), NULL);
933 for (slist = ifactory->items; slist; slist = slist->next)
935 GtkItemFactoryItem *item = slist->data;
938 for (link = item->widgets; link; link = link->next)
939 if (gtk_object_get_data_by_id (link->data, quark_item_factory) == ifactory &&
940 gtk_object_get_data_by_id (link->data, quark_action) == GUINT_TO_POINTER (action))
948 gtk_item_factory_get_item (GtkItemFactory *ifactory,
953 g_return_val_if_fail (GTK_IS_ITEM_FACTORY (ifactory), NULL);
954 g_return_val_if_fail (path != NULL, NULL);
956 widget = gtk_item_factory_get_widget (ifactory, path);
958 if (GTK_IS_MENU (widget))
959 widget = gtk_menu_get_attach_widget (GTK_MENU (widget));
961 return GTK_IS_ITEM (widget) ? widget : NULL;
965 gtk_item_factory_get_item_by_action (GtkItemFactory *ifactory,
970 g_return_val_if_fail (GTK_IS_ITEM_FACTORY (ifactory), NULL);
972 widget = gtk_item_factory_get_widget_by_action (ifactory, action);
974 if (GTK_IS_MENU (widget))
975 widget = gtk_menu_get_attach_widget (GTK_MENU (widget));
977 return GTK_IS_ITEM (widget) ? widget : NULL;
981 item_factory_find_separator_r (char *path)
983 gchar *result = NULL;
984 gboolean escaped = FALSE;
994 else if (*path == '/')
1005 item_factory_unescape_label (const char *label)
1007 char *new = g_malloc (strlen (label) + 1);
1009 gboolean escaped = FALSE;
1035 gtk_item_factory_parse_path (GtkItemFactory *ifactory,
1038 gchar **parent_path,
1044 *path = g_strdup (str);
1065 *parent_path = g_strdup (*path);
1066 p = item_factory_find_separator_r (*parent_path);
1069 g_warning ("GtkItemFactory: invalid entry path `%s'", str);
1074 if (ifactory->translate_func)
1075 translation = ifactory->translate_func (str, ifactory->translate_data);
1079 p = item_factory_find_separator_r (translation);
1085 *item = item_factory_unescape_label (p);
1091 gtk_item_factory_create_item (GtkItemFactory *ifactory,
1092 GtkItemFactoryEntry *entry,
1093 gpointer callback_data,
1094 guint callback_type)
1096 GtkOptionMenu *option_menu = NULL;
1100 GSList *radio_group;
1107 gchar *item_type_path;
1108 GtkStockItem stock_item;
1110 g_return_if_fail (GTK_IS_ITEM_FACTORY (ifactory));
1111 g_return_if_fail (entry != NULL);
1112 g_return_if_fail (entry->path != NULL);
1113 g_return_if_fail (entry->path[0] == '/');
1114 g_return_if_fail (callback_type >= 1 && callback_type <= 2);
1116 if (!entry->item_type ||
1117 entry->item_type[0] == 0)
1119 item_type_path = "<Item>";
1120 type_id = quark_type_item;
1124 item_type_path = entry->item_type;
1125 type_id = gtk_object_data_try_key (item_type_path);
1129 if (type_id == quark_type_item)
1130 type = GTK_TYPE_MENU_ITEM;
1131 else if (type_id == quark_type_title)
1132 type = GTK_TYPE_MENU_ITEM;
1133 else if (type_id == quark_type_radio_item)
1134 type = GTK_TYPE_RADIO_MENU_ITEM;
1135 else if (type_id == quark_type_check_item)
1136 type = GTK_TYPE_CHECK_MENU_ITEM;
1137 else if (type_id == quark_type_image_item)
1138 type = GTK_TYPE_IMAGE_MENU_ITEM;
1139 else if (type_id == quark_type_stock_item)
1140 type = GTK_TYPE_IMAGE_MENU_ITEM;
1141 else if (type_id == quark_type_tearoff_item)
1142 type = GTK_TYPE_TEAROFF_MENU_ITEM;
1143 else if (type_id == quark_type_toggle_item)
1144 type = GTK_TYPE_CHECK_MENU_ITEM;
1145 else if (type_id == quark_type_separator_item)
1146 type = GTK_TYPE_MENU_ITEM;
1147 else if (type_id == quark_type_branch)
1148 type = GTK_TYPE_MENU_ITEM;
1149 else if (type_id == quark_type_last_branch)
1150 type = GTK_TYPE_MENU_ITEM;
1153 GtkWidget *radio_link;
1155 radio_link = gtk_item_factory_get_widget (ifactory, item_type_path);
1156 if (radio_link && GTK_IS_RADIO_MENU_ITEM (radio_link))
1158 type = GTK_TYPE_RADIO_MENU_ITEM;
1159 radio_group = gtk_radio_menu_item_group (GTK_RADIO_MENU_ITEM (radio_link));
1163 g_warning ("GtkItemFactory: entry path `%s' has invalid type `%s'",
1170 if (!gtk_item_factory_parse_path (ifactory, entry->path,
1171 &path, &parent_path, &name))
1174 parent = gtk_item_factory_get_widget (ifactory, parent_path);
1177 GtkItemFactoryEntry pentry;
1180 ppath = g_strdup (entry->path);
1181 p = item_factory_find_separator_r (ppath);
1182 g_return_if_fail (p != NULL);
1184 pentry.path = ppath;
1185 pentry.accelerator = NULL;
1186 pentry.callback = NULL;
1187 pentry.callback_action = 0;
1188 pentry.item_type = "<Branch>";
1190 gtk_item_factory_create_item (ifactory, &pentry, NULL, 1);
1193 parent = gtk_item_factory_get_widget (ifactory, parent_path);
1194 g_return_if_fail (parent != NULL);
1196 g_free (parent_path);
1198 if (GTK_IS_OPTION_MENU (parent))
1200 option_menu = GTK_OPTION_MENU (parent);
1201 if (!option_menu->menu)
1202 gtk_option_menu_set_menu (option_menu, gtk_widget_new (GTK_TYPE_MENU, NULL));
1203 parent = option_menu->menu;
1206 g_return_if_fail (GTK_IS_CONTAINER (parent));
1208 accelerator = entry->accelerator;
1210 widget = gtk_widget_new (type,
1211 "GtkWidget::visible", TRUE,
1212 "GtkWidget::sensitive", (type_id != quark_type_separator_item &&
1213 type_id != quark_type_title),
1214 "GtkWidget::parent", parent,
1216 if (option_menu && !option_menu->menu_item)
1217 gtk_option_menu_set_history (option_menu, 0);
1219 if (type == GTK_TYPE_RADIO_MENU_ITEM)
1220 gtk_radio_menu_item_set_group (GTK_RADIO_MENU_ITEM (widget), radio_group);
1221 if (GTK_IS_CHECK_MENU_ITEM (widget))
1222 gtk_check_menu_item_set_show_toggle (GTK_CHECK_MENU_ITEM (widget), TRUE);
1223 if (type_id == quark_type_image_item)
1225 GdkPixbuf *pixbuf = NULL;
1228 pixbuf = gdk_pixbuf_new_from_stream (-1,
1234 image = gtk_image_new_from_pixbuf (pixbuf);
1237 gtk_image_menu_item_set_image (GTK_IMAGE_MENU_ITEM (widget), image);
1240 g_object_unref (G_OBJECT (pixbuf));
1242 if (type_id == quark_type_stock_item)
1244 image = gtk_image_new_from_stock (entry->extra_data, GTK_ICON_SIZE_MENU);
1246 gtk_image_menu_item_set_image (GTK_IMAGE_MENU_ITEM (widget), image);
1248 if (gtk_stock_lookup (entry->extra_data, &stock_item))
1251 accelerator = gtk_accelerator_name (stock_item.keyval, stock_item.modifier);
1257 /* install underline accelerators for this item
1259 if (type_id != quark_type_separator_item &&
1260 type_id != quark_type_tearoff_item &&
1265 label = gtk_widget_new (GTK_TYPE_ACCEL_LABEL,
1266 "GtkWidget::visible", TRUE,
1267 "GtkWidget::parent", widget,
1268 "GtkAccelLabel::accel_object", widget,
1269 "GtkMisc::xalign", 0.0,
1272 gtk_label_set_text_with_mnemonic (GTK_LABEL (label), name);
1277 if (type_id == quark_type_branch ||
1278 type_id == quark_type_last_branch)
1280 if (entry->callback)
1281 g_warning ("gtk_item_factory_create_item(): Can't specify a callback on a branch: \"%s\"",
1284 if (type_id == quark_type_last_branch)
1285 gtk_menu_item_right_justify (GTK_MENU_ITEM (widget));
1288 widget = gtk_widget_new (GTK_TYPE_MENU,
1291 gtk_menu_item_set_submenu (GTK_MENU_ITEM (parent), widget);
1294 gtk_item_factory_add_item (ifactory,
1296 (type_id == quark_type_branch ||
1297 type_id == quark_type_last_branch) ?
1298 (GtkItemFactoryCallback) NULL : entry->callback,
1299 entry->callback_action, callback_data,
1304 if (accelerator != entry->accelerator)
1305 g_free (accelerator);
1311 gtk_item_factory_create_menu_entries (guint n_entries,
1312 GtkMenuEntry *entries)
1314 static GPatternSpec *pspec_separator = NULL;
1315 static GPatternSpec *pspec_check = NULL;
1320 g_return_if_fail (entries != NULL);
1322 if (!pspec_separator)
1324 pspec_separator = g_pattern_spec_new ("*<separator>*");
1325 pspec_check = g_pattern_spec_new ("*<check>*");
1328 for (i = 0; i < n_entries; i++)
1330 GtkItemFactory *ifactory;
1331 GtkItemFactoryEntry entry;
1335 path = entries[i].path;
1336 ifactory = gtk_item_factory_from_path (path);
1339 g_warning ("gtk_item_factory_create_menu_entries(): "
1340 "entry[%u] refers to unknown item factory: \"%s\"",
1341 i, entries[i].path);
1345 while (*path != '>')
1351 entry.accelerator = entries[i].accelerator;
1352 entry.callback = entries[i].callback;
1353 entry.callback_action = 0;
1354 if (g_pattern_match_string (pspec_separator, path))
1355 entry.item_type = "<Separator>";
1356 else if (!g_pattern_match_string (pspec_check, path))
1357 entry.item_type = NULL;
1360 gboolean in_brace = FALSE;
1363 cpath = g_new (gchar, strlen (path));
1369 else if (*path == '>')
1376 entry.item_type = "<ToggleItem>";
1380 gtk_item_factory_create_item (ifactory, &entry, entries[i].callback_data, 2);
1381 entries[i].widget = gtk_item_factory_get_widget (ifactory, entries[i].path);
1387 gtk_item_factories_path_delete (const gchar *ifactory_path,
1390 GtkItemFactoryClass *class;
1391 GtkItemFactoryItem *item;
1393 g_return_if_fail (path != NULL);
1395 class = gtk_type_class (GTK_TYPE_ITEM_FACTORY);
1398 item = g_hash_table_lookup (class->item_ht, (gpointer) path);
1403 g_return_if_fail (ifactory_path != NULL);
1405 fpath = g_strconcat (ifactory_path, path, NULL);
1406 item = g_hash_table_lookup (class->item_ht, fpath);
1412 GSList *widget_list;
1416 for (slist = item->widgets; slist; slist = slist->next)
1420 widget = slist->data;
1421 widget_list = g_slist_prepend (widget_list, widget);
1422 gtk_widget_ref (widget);
1425 for (slist = widget_list; slist; slist = slist->next)
1429 widget = slist->data;
1430 gtk_widget_destroy (widget);
1431 gtk_widget_unref (widget);
1433 g_slist_free (widget_list);
1438 gtk_item_factory_delete_item (GtkItemFactory *ifactory,
1441 GtkItemFactoryClass *class;
1444 g_return_if_fail (GTK_IS_ITEM_FACTORY (ifactory));
1445 g_return_if_fail (path != NULL);
1447 class = GTK_ITEM_FACTORY_GET_CLASS (ifactory);
1449 widget = gtk_item_factory_get_widget (ifactory, path);
1453 if (GTK_IS_MENU (widget))
1454 widget = gtk_menu_get_attach_widget (GTK_MENU (widget));
1456 gtk_widget_destroy (widget);
1461 gtk_item_factory_delete_entry (GtkItemFactory *ifactory,
1462 GtkItemFactoryEntry *entry)
1464 g_return_if_fail (GTK_IS_ITEM_FACTORY (ifactory));
1465 g_return_if_fail (entry != NULL);
1467 gtk_item_factory_delete_item (ifactory, entry->path);
1471 gtk_item_factory_delete_entries (GtkItemFactory *ifactory,
1473 GtkItemFactoryEntry *entries)
1477 g_return_if_fail (GTK_IS_ITEM_FACTORY (ifactory));
1479 g_return_if_fail (entries != NULL);
1481 for (i = 0; i < n_entries; i++)
1482 gtk_item_factory_delete_item (ifactory, (entries + i)->path);
1492 gtk_item_factory_menu_pos (GtkMenu *menu,
1498 MenuPos *mpos = func_data;
1505 gtk_item_factory_popup_data_from_widget (GtkWidget *widget)
1507 GtkItemFactory *ifactory;
1509 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
1511 ifactory = gtk_item_factory_from_widget (widget);
1513 return gtk_object_get_data_by_id (GTK_OBJECT (ifactory), quark_popup_data);
1519 gtk_item_factory_popup_data (GtkItemFactory *ifactory)
1521 g_return_val_if_fail (GTK_IS_ITEM_FACTORY (ifactory), NULL);
1523 return gtk_object_get_data_by_id (GTK_OBJECT (ifactory), quark_popup_data);
1527 ifactory_delete_popup_data (GtkObject *object,
1528 GtkItemFactory *ifactory)
1530 gtk_signal_disconnect_by_func (object,
1531 GTK_SIGNAL_FUNC (ifactory_delete_popup_data),
1533 gtk_object_remove_data_by_id (GTK_OBJECT (ifactory), quark_popup_data);
1537 gtk_item_factory_popup (GtkItemFactory *ifactory,
1543 gtk_item_factory_popup_with_data (ifactory, NULL, NULL, x, y, mouse_button, time);
1547 gtk_item_factory_popup_with_data (GtkItemFactory *ifactory,
1548 gpointer popup_data,
1549 GtkDestroyNotify destroy,
1557 g_return_if_fail (GTK_IS_ITEM_FACTORY (ifactory));
1558 g_return_if_fail (GTK_IS_MENU (ifactory->widget));
1560 mpos = gtk_object_get_data_by_id (GTK_OBJECT (ifactory->widget), quark_if_menu_pos);
1564 mpos = g_new0 (MenuPos, 1);
1565 gtk_object_set_data_by_id_full (GTK_OBJECT (ifactory->widget),
1574 if (popup_data != NULL)
1576 gtk_object_set_data_by_id_full (GTK_OBJECT (ifactory),
1580 gtk_signal_connect (GTK_OBJECT (ifactory->widget),
1582 GTK_SIGNAL_FUNC (ifactory_delete_popup_data),
1586 gtk_menu_popup (GTK_MENU (ifactory->widget),
1588 gtk_item_factory_menu_pos, mpos,
1589 mouse_button, time);
1593 gtk_item_factory_parse_menu_path (GScanner *scanner,
1594 GtkItemFactoryClass *class)
1596 GtkItemFactoryItem *item;
1598 g_scanner_get_next_token (scanner);
1599 if (scanner->token != G_TOKEN_STRING)
1600 return G_TOKEN_STRING;
1602 g_scanner_peek_next_token (scanner);
1603 if (scanner->next_token != G_TOKEN_STRING)
1605 g_scanner_get_next_token (scanner);
1606 return G_TOKEN_STRING;
1609 item = g_hash_table_lookup (class->item_ht, scanner->value.v_string);
1612 item = g_chunk_new (GtkItemFactoryItem, ifactory_item_chunks);
1614 item->path = g_strdup (scanner->value.v_string);
1615 item->accelerator_key = 0;
1616 item->accelerator_mods = 0;
1617 item->modified = TRUE;
1618 item->in_propagation = FALSE;
1620 item->widgets = NULL;
1622 g_hash_table_insert (class->item_ht, item->path, item);
1624 g_scanner_get_next_token (scanner);
1626 if (!item->in_propagation)
1631 old_keyval = item->accelerator_key;
1632 old_mods = item->accelerator_mods;
1633 gtk_accelerator_parse (scanner->value.v_string,
1634 &item->accelerator_key,
1635 &item->accelerator_mods);
1636 if (old_keyval != item->accelerator_key ||
1637 old_mods != item->accelerator_mods)
1639 item->modified = TRUE;
1640 gtk_item_factory_propagate_accelerator (item, NULL);
1644 g_scanner_get_next_token (scanner);
1645 if (scanner->token != ')')
1648 return G_TOKEN_NONE;
1652 gtk_item_factory_parse_statement (GScanner *scanner,
1653 GtkItemFactoryClass *class)
1655 guint expected_token;
1657 g_scanner_get_next_token (scanner);
1659 if (scanner->token == G_TOKEN_SYMBOL)
1661 guint (*parser_func) (GScanner*, GtkItemFactoryClass*);
1663 parser_func = scanner->value.v_symbol;
1665 /* check whether this is a GtkItemFactory symbol.
1667 if (parser_func == gtk_item_factory_parse_menu_path)
1668 expected_token = parser_func (scanner, class);
1670 expected_token = G_TOKEN_SYMBOL;
1673 expected_token = G_TOKEN_SYMBOL;
1675 /* skip rest of statement on errrors
1677 if (expected_token != G_TOKEN_NONE)
1679 register guint level;
1682 if (scanner->token == ')')
1684 if (scanner->token == '(')
1687 while (!g_scanner_eof (scanner) && level > 0)
1689 g_scanner_get_next_token (scanner);
1691 if (scanner->token == '(')
1693 else if (scanner->token == ')')
1700 gtk_item_factory_parse_rc_string (const gchar *rc_string)
1704 g_return_if_fail (rc_string != NULL);
1706 if (!gtk_item_factory_class)
1707 gtk_type_class (GTK_TYPE_ITEM_FACTORY);
1709 ifactory_scanner_config.cpair_comment_single = gtk_item_factory_class->cpair_comment_single;
1710 scanner = g_scanner_new (&ifactory_scanner_config);
1712 g_scanner_input_text (scanner, rc_string, strlen (rc_string));
1714 gtk_item_factory_parse_rc_scanner (scanner);
1716 g_scanner_destroy (scanner);
1720 gtk_item_factory_parse_rc_scanner (GScanner *scanner)
1722 gpointer saved_symbol;
1724 g_return_if_fail (scanner != NULL);
1726 if (!gtk_item_factory_class)
1727 gtk_type_class (GTK_TYPE_ITEM_FACTORY);
1729 saved_symbol = g_scanner_lookup_symbol (scanner, "menu-path");
1730 g_scanner_remove_symbol (scanner, "menu-path");
1731 g_scanner_add_symbol (scanner, "menu-path", gtk_item_factory_parse_menu_path);
1733 g_scanner_peek_next_token (scanner);
1735 while (scanner->next_token == '(')
1737 g_scanner_get_next_token (scanner);
1739 gtk_item_factory_parse_statement (scanner, gtk_item_factory_class);
1741 g_scanner_peek_next_token (scanner);
1744 g_scanner_remove_symbol (scanner, "menu-path");
1745 g_scanner_add_symbol (scanner, "menu-path", saved_symbol);
1749 gtk_item_factory_parse_rc (const gchar *file_name)
1754 g_return_if_fail (file_name != NULL);
1756 if (!g_file_test (file_name, G_FILE_TEST_IS_REGULAR))
1759 fd = open (file_name, O_RDONLY);
1763 if (!gtk_item_factory_class)
1764 gtk_type_class (GTK_TYPE_ITEM_FACTORY);
1766 ifactory_scanner_config.cpair_comment_single = gtk_item_factory_class->cpair_comment_single;
1767 scanner = g_scanner_new (&ifactory_scanner_config);
1769 g_scanner_input_file (scanner, fd);
1771 gtk_item_factory_parse_rc_scanner (scanner);
1773 g_scanner_destroy (scanner);
1779 gtk_item_factory_set_translate_func (GtkItemFactory *ifactory,
1780 GtkTranslateFunc func,
1782 GtkDestroyNotify notify)
1784 g_return_if_fail (ifactory != NULL);
1786 if (ifactory->translate_notify)
1787 ifactory->translate_notify (ifactory->translate_data);
1789 ifactory->translate_func = func;
1790 ifactory->translate_data = data;
1791 ifactory->translate_notify = notify;