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 Library 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 * Library General Public License for more details.
17 * You should have received a copy of the GNU Library 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-1999. 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/gtktearoffmenuitem.h"
41 #include "gtk/gtkaccellabel.h"
42 #include "gdk/gdkkeysyms.h"
52 #include <io.h> /* For _open and _close */
55 #define S_ISREG(mode) ((mode)&_S_IFREG)
61 #define ITEM_FACTORY_STRING ((gchar*) item_factory_string)
62 #define ITEM_BLOCK_SIZE (128)
65 /* --- structures --- */
66 typedef struct _GtkIFCBData GtkIFCBData;
67 typedef struct _GtkIFDumpData GtkIFDumpData;
70 GtkItemFactoryCallback func;
73 guint callback_action;
77 GtkPrintFunc print_func;
79 guint modified_only : 1;
80 GtkPatternSpec *pspec;
84 /* --- prototypes --- */
85 static void gtk_item_factory_class_init (GtkItemFactoryClass *klass);
86 static void gtk_item_factory_init (GtkItemFactory *ifactory);
87 static void gtk_item_factory_destroy (GtkObject *object);
88 static void gtk_item_factory_finalize (GObject *object);
91 /* --- static variables --- */
92 static GtkItemFactoryClass *gtk_item_factory_class = NULL;
93 static gpointer parent_class = NULL;
94 static const gchar *item_factory_string = "Gtk-<ItemFactory>";
95 static GMemChunk *ifactory_item_chunks = NULL;
96 static GMemChunk *ifactory_cb_data_chunks = NULL;
97 static GQuark quark_popup_data = 0;
98 static GQuark quark_if_menu_pos = 0;
99 static GQuark quark_item_factory = 0;
100 static GQuark quark_item_path = 0;
101 static GQuark quark_action = 0;
102 static GQuark quark_accel_group = 0;
103 static GQuark quark_type_item = 0;
104 static GQuark quark_type_title = 0;
105 static GQuark quark_type_radio_item = 0;
106 static GQuark quark_type_check_item = 0;
107 static GQuark quark_type_toggle_item = 0;
108 static GQuark quark_type_tearoff_item = 0;
109 static GQuark quark_type_separator_item = 0;
110 static GQuark quark_type_branch = 0;
111 static GQuark quark_type_last_branch = 0;
112 static GScannerConfig ifactory_scanner_config =
116 ) /* cset_skip_characters */,
121 ) /* cset_identifier_first */,
128 ) /* cset_identifier_nth */,
129 ( ";\n" ) /* cpair_comment_single */,
131 FALSE /* case_sensitive */,
133 TRUE /* skip_comment_multi */,
134 TRUE /* skip_comment_single */,
135 FALSE /* scan_comment_multi */,
136 TRUE /* scan_identifier */,
137 FALSE /* scan_identifier_1char */,
138 FALSE /* scan_identifier_NULL */,
139 TRUE /* scan_symbols */,
140 TRUE /* scan_binary */,
141 TRUE /* scan_octal */,
142 TRUE /* scan_float */,
144 FALSE /* scan_hex_dollar */,
145 TRUE /* scan_string_sq */,
146 TRUE /* scan_string_dq */,
147 TRUE /* numbers_2_int */,
148 FALSE /* int_2_float */,
149 FALSE /* identifier_2_string */,
150 TRUE /* char_2_token */,
151 FALSE /* symbol_2_token */,
155 /* --- functions --- */
157 gtk_item_factory_get_type (void)
159 static GtkType item_factory_type = 0;
161 if (!item_factory_type)
163 static const GtkTypeInfo item_factory_info =
166 sizeof (GtkItemFactory),
167 sizeof (GtkItemFactoryClass),
168 (GtkClassInitFunc) gtk_item_factory_class_init,
169 (GtkObjectInitFunc) gtk_item_factory_init,
170 /* reserved_1 */ NULL,
171 /* reserved_2 */ NULL,
172 (GtkClassInitFunc) NULL,
175 item_factory_type = gtk_type_unique (GTK_TYPE_OBJECT, &item_factory_info);
178 return item_factory_type;
182 gtk_item_factory_class_init (GtkItemFactoryClass *class)
184 GObjectClass *gobject_class = G_OBJECT_CLASS (class);
185 GtkObjectClass *object_class;
187 gtk_item_factory_class = class;
189 parent_class = gtk_type_class (GTK_TYPE_OBJECT);
191 object_class = (GtkObjectClass*) class;
193 gobject_class->finalize = gtk_item_factory_finalize;
195 object_class->destroy = gtk_item_factory_destroy;
197 class->cpair_comment_single = g_strdup (";\n");
199 class->item_ht = g_hash_table_new (g_str_hash, g_str_equal);
201 ifactory_item_chunks =
202 g_mem_chunk_new ("GtkItemFactoryItem",
203 sizeof (GtkItemFactoryItem),
204 sizeof (GtkItemFactoryItem) * ITEM_BLOCK_SIZE,
206 ifactory_cb_data_chunks =
207 g_mem_chunk_new ("GtkIFCBData",
208 sizeof (GtkIFCBData),
209 sizeof (GtkIFCBData) * ITEM_BLOCK_SIZE,
212 quark_popup_data = g_quark_from_static_string ("GtkItemFactory-popup-data");
213 quark_if_menu_pos = g_quark_from_static_string ("GtkItemFactory-menu-position");
214 quark_item_factory = g_quark_from_static_string ("GtkItemFactory");
215 quark_item_path = g_quark_from_static_string ("GtkItemFactory-path");
216 quark_action = g_quark_from_static_string ("GtkItemFactory-action");
217 quark_accel_group = g_quark_from_static_string ("GtkAccelGroup");
218 quark_type_item = g_quark_from_static_string ("<Item>");
219 quark_type_title = g_quark_from_static_string ("<Title>");
220 quark_type_radio_item = g_quark_from_static_string ("<RadioItem>");
221 quark_type_check_item = g_quark_from_static_string ("<CheckItem>");
222 quark_type_toggle_item = g_quark_from_static_string ("<ToggleItem>");
223 quark_type_tearoff_item = g_quark_from_static_string ("<Tearoff>");
224 quark_type_separator_item = g_quark_from_static_string ("<Separator>");
225 quark_type_branch = g_quark_from_static_string ("<Branch>");
226 quark_type_last_branch = g_quark_from_static_string ("<LastBranch>");
230 gtk_item_factory_init (GtkItemFactory *ifactory)
234 object = GTK_OBJECT (ifactory);
236 ifactory->path = NULL;
237 ifactory->accel_group = NULL;
238 ifactory->widget = NULL;
239 ifactory->items = NULL;
240 ifactory->translate_func = NULL;
241 ifactory->translate_data = NULL;
242 ifactory->translate_notify = NULL;
246 gtk_item_factory_new (GtkType container_type,
248 GtkAccelGroup *accel_group)
250 GtkItemFactory *ifactory;
252 g_return_val_if_fail (path != NULL, NULL);
254 ifactory = gtk_type_new (GTK_TYPE_ITEM_FACTORY);
255 gtk_item_factory_construct (ifactory, container_type, path, accel_group);
261 gtk_item_factory_callback_marshal (GtkWidget *widget,
268 if (data->callback_type == 1)
270 GtkItemFactoryCallback1 func1 = (GtkItemFactoryCallback1) data->func;
271 func1 (data->func_data, data->callback_action, widget);
273 else if (data->callback_type == 2)
275 GtkItemFactoryCallback2 func2 = (GtkItemFactoryCallback2) data->func;
276 func2 (widget, data->func_data, data->callback_action);
281 gtk_item_factory_propagate_accelerator (GtkItemFactoryItem *item,
287 if (item->in_propagation)
290 item->in_propagation = TRUE;
293 for (slist = item->widgets; slist; slist = slist->next)
297 widget = slist->data;
299 if (widget != exclude)
301 gtk_widget_ref (widget);
302 widget_list = g_slist_prepend (widget_list, widget);
306 for (slist = widget_list; slist; slist = slist->next)
309 GtkAccelGroup *accel_group;
312 widget = slist->data;
314 accel_group = gtk_object_get_data_by_id (GTK_OBJECT (widget), quark_accel_group);
316 signal_id = gtk_signal_lookup ("activate", GTK_OBJECT_TYPE (widget));
317 if (signal_id && accel_group)
319 if (item->accelerator_key)
320 gtk_widget_add_accelerator (widget,
323 item->accelerator_key,
324 item->accelerator_mods,
330 work = gtk_accel_group_entries_from_object (GTK_OBJECT (widget));
333 GtkAccelEntry *ac_entry;
335 ac_entry = work->data;
337 if (ac_entry->accel_flags & GTK_ACCEL_VISIBLE &&
338 ac_entry->accel_group == accel_group &&
339 ac_entry->signal_id == signal_id)
340 gtk_widget_remove_accelerator (GTK_WIDGET (widget),
341 ac_entry->accel_group,
342 ac_entry->accelerator_key,
343 ac_entry->accelerator_mods);
348 gtk_widget_unref (widget);
351 g_slist_free (widget_list);
353 item->in_propagation = FALSE;
357 gtk_item_factory_item_add_accelerator (GtkWidget *widget,
358 guint accel_signal_id,
359 GtkAccelGroup *accel_group,
362 GtkAccelFlags accel_flags,
363 GtkItemFactoryItem *item)
365 if (!item->in_propagation &&
366 g_slist_find (item->widgets, widget) &&
367 accel_signal_id == gtk_signal_lookup ("activate", GTK_OBJECT_TYPE (widget)))
369 item->accelerator_key = accel_key;
370 item->accelerator_mods = accel_mods;
371 item->modified = TRUE;
373 gtk_item_factory_propagate_accelerator (item, widget);
380 gtk_item_factory_item_remove_accelerator (GtkWidget *widget,
381 GtkAccelGroup *accel_group,
384 GtkItemFactoryItem *item)
386 if (!item->in_propagation &&
387 g_slist_find (item->widgets, widget) &&
388 item->accelerator_key == accel_key &&
389 item->accelerator_mods == accel_mods)
391 item->accelerator_key = 0;
392 item->accelerator_mods = 0;
393 item->modified = TRUE;
395 gtk_item_factory_propagate_accelerator (item, widget);
400 gtk_item_factory_item_remove_widget (GtkWidget *widget,
401 GtkItemFactoryItem *item)
403 item->widgets = g_slist_remove (item->widgets, widget);
404 gtk_object_remove_data_by_id (GTK_OBJECT (widget), quark_item_factory);
405 gtk_object_remove_data_by_id (GTK_OBJECT (widget), quark_item_path);
409 gtk_item_factory_add_foreign (GtkWidget *accel_widget,
410 const gchar *full_path,
411 GtkAccelGroup *accel_group,
413 GdkModifierType modifiers)
415 GtkItemFactoryClass *class;
416 GtkItemFactoryItem *item;
418 g_return_if_fail (GTK_IS_WIDGET (accel_widget));
419 g_return_if_fail (full_path != NULL);
421 class = gtk_type_class (GTK_TYPE_ITEM_FACTORY);
423 keyval = keyval != GDK_VoidSymbol ? keyval : 0;
425 item = g_hash_table_lookup (class->item_ht, full_path);
428 item = g_chunk_new (GtkItemFactoryItem, ifactory_item_chunks);
430 item->path = g_strdup (full_path);
431 item->accelerator_key = keyval;
432 item->accelerator_mods = modifiers;
433 item->modified = FALSE;
434 item->in_propagation = FALSE;
436 item->widgets = NULL;
438 g_hash_table_insert (class->item_ht, item->path, item);
441 item->widgets = g_slist_prepend (item->widgets, accel_widget);
442 gtk_signal_connect (GTK_OBJECT (accel_widget),
444 GTK_SIGNAL_FUNC (gtk_item_factory_item_remove_widget),
447 /* set the item path for the widget
449 gtk_object_set_data_by_id (GTK_OBJECT (accel_widget), quark_item_path, item->path);
450 gtk_widget_set_name (accel_widget, item->path);
453 gtk_accel_group_ref (accel_group);
454 gtk_object_set_data_by_id_full (GTK_OBJECT (accel_widget),
457 (GtkDestroyNotify) gtk_accel_group_unref);
460 gtk_object_set_data_by_id (GTK_OBJECT (accel_widget), quark_accel_group, NULL);
462 /* install defined accelerators
464 if (gtk_signal_lookup ("activate", GTK_OBJECT_TYPE (accel_widget)))
466 if (item->accelerator_key && accel_group)
467 gtk_widget_add_accelerator (accel_widget,
470 item->accelerator_key,
471 item->accelerator_mods,
474 gtk_widget_remove_accelerators (accel_widget,
479 /* keep track of accelerator changes
481 gtk_signal_connect_after (GTK_OBJECT (accel_widget),
483 GTK_SIGNAL_FUNC (gtk_item_factory_item_add_accelerator),
485 gtk_signal_connect_after (GTK_OBJECT (accel_widget),
486 "remove-accelerator",
487 GTK_SIGNAL_FUNC (gtk_item_factory_item_remove_accelerator),
492 ifactory_cb_data_free (gpointer mem)
494 g_mem_chunk_free (ifactory_cb_data_chunks, mem);
498 gtk_item_factory_add_item (GtkItemFactory *ifactory,
500 const gchar *accelerator,
501 GtkItemFactoryCallback callback,
502 guint callback_action,
503 gpointer callback_data,
508 GtkItemFactoryClass *class;
509 GtkItemFactoryItem *item;
513 g_return_if_fail (widget != NULL);
514 g_return_if_fail (item_type != NULL);
516 class = GTK_ITEM_FACTORY_GET_CLASS (ifactory);
518 /* set accelerator group on menu widgets
520 if (GTK_IS_MENU (widget))
521 gtk_menu_set_accel_group ((GtkMenu*) widget, ifactory->accel_group);
523 /* connect callback if neccessary
529 data = g_chunk_new (GtkIFCBData, ifactory_cb_data_chunks);
530 data->func = callback;
531 data->callback_type = callback_type;
532 data->func_data = callback_data;
533 data->callback_action = callback_action;
535 gtk_object_weakref (GTK_OBJECT (widget),
536 ifactory_cb_data_free,
538 gtk_signal_connect (GTK_OBJECT (widget),
540 GTK_SIGNAL_FUNC (gtk_item_factory_callback_marshal),
544 /* link the widget into its item-entry
545 * and keep back pointer on both the item factory and the widget
547 gtk_object_set_data_by_id (GTK_OBJECT (widget), quark_action, GUINT_TO_POINTER (callback_action));
548 gtk_object_set_data_by_id (GTK_OBJECT (widget), quark_item_factory, ifactory);
550 gtk_accelerator_parse (accelerator, &keyval, &mods);
556 fpath = g_strconcat (ifactory->path, path, NULL);
557 gtk_item_factory_add_foreign (widget, fpath, ifactory->accel_group, keyval, mods);
558 item = g_hash_table_lookup (class->item_ht, fpath);
561 g_return_if_fail (item != NULL);
563 if (!g_slist_find (ifactory->items, item))
564 ifactory->items = g_slist_prepend (ifactory->items, item);
568 gtk_item_factory_construct (GtkItemFactory *ifactory,
569 GtkType container_type,
571 GtkAccelGroup *accel_group)
575 g_return_if_fail (ifactory != NULL);
576 g_return_if_fail (GTK_IS_ITEM_FACTORY (ifactory));
577 g_return_if_fail (ifactory->accel_group == NULL);
578 g_return_if_fail (path != NULL);
579 if (!gtk_type_is_a (container_type, GTK_TYPE_OPTION_MENU))
580 g_return_if_fail (gtk_type_is_a (container_type, GTK_TYPE_MENU_SHELL));
584 if (path[0] != '<' && path[len - 1] != '>')
586 g_warning ("GtkItemFactory: invalid factory path `%s'", path);
592 ifactory->accel_group = accel_group;
593 gtk_accel_group_ref (ifactory->accel_group);
596 ifactory->accel_group = gtk_accel_group_new ();
598 ifactory->path = g_strdup (path);
600 gtk_widget_new (container_type,
601 "GtkObject::signal::destroy", gtk_widget_destroyed, &ifactory->widget,
603 gtk_object_ref (GTK_OBJECT (ifactory));
604 gtk_object_sink (GTK_OBJECT (ifactory));
606 gtk_item_factory_add_item (ifactory,
614 gtk_item_factory_from_path (const gchar *path)
616 GtkItemFactoryClass *class;
617 GtkItemFactoryItem *item;
621 g_return_val_if_fail (path != NULL, NULL);
622 g_return_val_if_fail (path[0] == '<', NULL);
624 class = gtk_type_class (GTK_TYPE_ITEM_FACTORY);
627 while (path[i] && path[i] != '>')
631 g_warning ("gtk_item_factory_from_path(): invalid factory path \"%s\"",
635 fname = g_new (gchar, i + 2);
636 g_memmove (fname, path, i + 1);
639 item = g_hash_table_lookup (class->item_ht, fname);
643 if (item && item->widgets)
644 return gtk_item_factory_from_widget (item->widgets->data);
650 gtk_item_factory_destroy (GtkObject *object)
652 GtkItemFactory *ifactory;
655 g_return_if_fail (object != NULL);
656 g_return_if_fail (GTK_IS_ITEM_FACTORY (object));
658 ifactory = (GtkItemFactory*) object;
660 if (ifactory->widget)
664 dobj = GTK_OBJECT (ifactory->widget);
666 gtk_object_ref (dobj);
667 gtk_object_sink (dobj);
668 gtk_object_destroy (dobj);
669 gtk_object_unref (dobj);
671 ifactory->widget = NULL;
674 for (slist = ifactory->items; slist; slist = slist->next)
676 GtkItemFactoryItem *item = slist->data;
679 for (link = item->widgets; link; link = link->next)
680 if (gtk_object_get_data_by_id (link->data, quark_item_factory) == ifactory)
681 gtk_object_remove_data_by_id (link->data, quark_item_factory);
683 g_slist_free (ifactory->items);
684 ifactory->items = NULL;
686 GTK_OBJECT_CLASS (parent_class)->destroy (object);
690 gtk_item_factory_finalize (GObject *object)
692 GtkItemFactory *ifactory;
694 g_return_if_fail (object != NULL);
695 g_return_if_fail (GTK_IS_ITEM_FACTORY (object));
697 ifactory = GTK_ITEM_FACTORY (object);
699 gtk_accel_group_unref (ifactory->accel_group);
700 g_free (ifactory->path);
701 g_assert (ifactory->widget == NULL);
703 if (ifactory->translate_notify)
704 ifactory->translate_notify (ifactory->translate_data);
706 G_OBJECT_CLASS (parent_class)->finalize (object);
710 gtk_item_factory_from_widget (GtkWidget *widget)
712 g_return_val_if_fail (widget != NULL, NULL);
713 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
715 return gtk_object_get_data_by_id (GTK_OBJECT (widget), quark_item_factory);
719 gtk_item_factory_path_from_widget (GtkWidget *widget)
721 g_return_val_if_fail (widget != NULL, NULL);
722 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
724 return gtk_object_get_data_by_id (GTK_OBJECT (widget), quark_item_path);
728 gtk_item_factory_foreach (gpointer hash_key,
732 GtkItemFactoryItem *item;
736 gchar comment_prefix[2] = "\000\000";
741 if (data->pspec && !gtk_pattern_match_string (data->pspec, item->path))
744 comment_prefix[0] = gtk_item_factory_class->cpair_comment_single[0];
746 name = gtk_accelerator_name (item->accelerator_key, item->accelerator_mods);
747 string = g_strconcat (item->modified ? "" : comment_prefix,
756 data->print_func (data->func_data, string);
762 gtk_item_factory_dump_items (GtkPatternSpec *path_pspec,
763 gboolean modified_only,
764 GtkPrintFunc print_func,
769 g_return_if_fail (print_func != NULL);
771 if (!gtk_item_factory_class)
772 gtk_type_class (GTK_TYPE_ITEM_FACTORY);
774 data.print_func = print_func;
775 data.func_data = func_data;
776 data.modified_only = (modified_only != FALSE);
777 data.pspec = path_pspec;
779 g_hash_table_foreach (gtk_item_factory_class->item_ht, gtk_item_factory_foreach, &data);
783 gtk_item_factory_print_func (gpointer FILE_pointer,
786 FILE *f_out = FILE_pointer;
788 g_return_if_fail (FILE_pointer != NULL);
789 g_return_if_fail (string != NULL);
791 fputs (string, f_out);
796 gtk_item_factory_dump_rc (const gchar *file_name,
797 GtkPatternSpec *path_pspec,
798 gboolean modified_only)
802 g_return_if_fail (file_name != NULL);
804 f_out = fopen (file_name, "w");
809 if (g_get_prgname ())
810 fputs (g_get_prgname (), f_out);
811 fputs (" GtkItemFactory rc-file -*- scheme -*-\n", f_out);
812 fputs ("; this file is an automated menu-path dump\n", f_out);
813 fputs (";\n", f_out);
815 gtk_item_factory_dump_items (path_pspec,
817 gtk_item_factory_print_func,
824 gtk_item_factory_create_items (GtkItemFactory *ifactory,
826 GtkItemFactoryEntry *entries,
827 gpointer callback_data)
829 gtk_item_factory_create_items_ac (ifactory, n_entries, entries, callback_data, 1);
833 gtk_item_factory_create_items_ac (GtkItemFactory *ifactory,
835 GtkItemFactoryEntry *entries,
836 gpointer callback_data,
841 g_return_if_fail (ifactory != NULL);
842 g_return_if_fail (GTK_IS_ITEM_FACTORY (ifactory));
843 g_return_if_fail (callback_type >= 1 && callback_type <= 2);
848 g_return_if_fail (entries != NULL);
850 for (i = 0; i < n_entries; i++)
851 gtk_item_factory_create_item (ifactory, entries + i, callback_data, callback_type);
855 gtk_item_factory_get_widget (GtkItemFactory *ifactory,
858 GtkItemFactoryClass *class;
859 GtkItemFactoryItem *item;
861 g_return_val_if_fail (GTK_IS_ITEM_FACTORY (ifactory), NULL);
862 g_return_val_if_fail (path != NULL, NULL);
864 class = GTK_ITEM_FACTORY_GET_CLASS (ifactory);
867 item = g_hash_table_lookup (class->item_ht, (gpointer) path);
872 fpath = g_strconcat (ifactory->path, path, NULL);
873 item = g_hash_table_lookup (class->item_ht, fpath);
881 for (slist = item->widgets; slist; slist = slist->next)
883 if (gtk_item_factory_from_widget (slist->data) == ifactory)
892 gtk_item_factory_get_widget_by_action (GtkItemFactory *ifactory,
897 g_return_val_if_fail (GTK_IS_ITEM_FACTORY (ifactory), NULL);
899 for (slist = ifactory->items; slist; slist = slist->next)
901 GtkItemFactoryItem *item = slist->data;
904 for (link = item->widgets; link; link = link->next)
905 if (gtk_object_get_data_by_id (link->data, quark_item_factory) == ifactory &&
906 gtk_object_get_data_by_id (link->data, quark_action) == GUINT_TO_POINTER (action))
914 gtk_item_factory_get_item (GtkItemFactory *ifactory,
919 g_return_val_if_fail (GTK_IS_ITEM_FACTORY (ifactory), NULL);
920 g_return_val_if_fail (path != NULL, NULL);
922 widget = gtk_item_factory_get_widget (ifactory, path);
924 if (GTK_IS_MENU (widget))
925 widget = gtk_menu_get_attach_widget (GTK_MENU (widget));
927 return GTK_IS_ITEM (widget) ? widget : NULL;
931 gtk_item_factory_get_item_by_action (GtkItemFactory *ifactory,
936 g_return_val_if_fail (GTK_IS_ITEM_FACTORY (ifactory), NULL);
938 widget = gtk_item_factory_get_widget_by_action (ifactory, action);
940 if (GTK_IS_MENU (widget))
941 widget = gtk_menu_get_attach_widget (GTK_MENU (widget));
943 return GTK_IS_ITEM (widget) ? widget : NULL;
947 gtk_item_factory_parse_path (GtkItemFactory *ifactory,
956 *path = g_strdup (str);
958 /* FIXME: This does not handle __ correctly !!! */
970 *parent_path = g_strdup (*path);
971 p = strrchr (*parent_path, '/');
974 g_warning ("GtkItemFactory: invalid entry path `%s'", str);
979 if (ifactory->translate_func)
980 translation = ifactory->translate_func (str, ifactory->translate_data);
984 p = strrchr (translation, '/');
990 *item = g_strdup (p);
996 gtk_item_factory_create_item (GtkItemFactory *ifactory,
997 GtkItemFactoryEntry *entry,
998 gpointer callback_data,
1001 GtkOptionMenu *option_menu = NULL;
1004 GSList *radio_group;
1011 gchar *item_type_path;
1013 g_return_if_fail (ifactory != NULL);
1014 g_return_if_fail (GTK_IS_ITEM_FACTORY (ifactory));
1015 g_return_if_fail (entry != NULL);
1016 g_return_if_fail (entry->path != NULL);
1017 g_return_if_fail (entry->path[0] == '/');
1018 g_return_if_fail (callback_type >= 1 && callback_type <= 2);
1020 if (!entry->item_type ||
1021 entry->item_type[0] == 0)
1023 item_type_path = "<Item>";
1024 type_id = quark_type_item;
1028 item_type_path = entry->item_type;
1029 type_id = gtk_object_data_try_key (item_type_path);
1033 if (type_id == quark_type_item)
1034 type = GTK_TYPE_MENU_ITEM;
1035 else if (type_id == quark_type_title)
1036 type = GTK_TYPE_MENU_ITEM;
1037 else if (type_id == quark_type_radio_item)
1038 type = GTK_TYPE_RADIO_MENU_ITEM;
1039 else if (type_id == quark_type_check_item)
1040 type = GTK_TYPE_CHECK_MENU_ITEM;
1041 else if (type_id == quark_type_tearoff_item)
1042 type = GTK_TYPE_TEAROFF_MENU_ITEM;
1043 else if (type_id == quark_type_toggle_item)
1044 type = GTK_TYPE_CHECK_MENU_ITEM;
1045 else if (type_id == quark_type_separator_item)
1046 type = GTK_TYPE_MENU_ITEM;
1047 else if (type_id == quark_type_branch)
1048 type = GTK_TYPE_MENU_ITEM;
1049 else if (type_id == quark_type_last_branch)
1050 type = GTK_TYPE_MENU_ITEM;
1053 GtkWidget *radio_link;
1055 radio_link = gtk_item_factory_get_widget (ifactory, item_type_path);
1056 if (radio_link && GTK_IS_RADIO_MENU_ITEM (radio_link))
1058 type = GTK_TYPE_RADIO_MENU_ITEM;
1059 radio_group = gtk_radio_menu_item_group (GTK_RADIO_MENU_ITEM (radio_link));
1063 g_warning ("GtkItemFactory: entry path `%s' has invalid type `%s'",
1070 if (!gtk_item_factory_parse_path (ifactory, entry->path,
1071 &path, &parent_path, &name))
1074 parent = gtk_item_factory_get_widget (ifactory, parent_path);
1077 GtkItemFactoryEntry pentry;
1080 ppath = g_strdup (entry->path);
1081 p = strrchr (ppath, '/');
1082 g_return_if_fail (p != NULL);
1084 pentry.path = ppath;
1085 pentry.accelerator = NULL;
1086 pentry.callback = NULL;
1087 pentry.callback_action = 0;
1088 pentry.item_type = "<Branch>";
1090 gtk_item_factory_create_item (ifactory, &pentry, NULL, 1);
1093 parent = gtk_item_factory_get_widget (ifactory, parent_path);
1094 g_return_if_fail (parent != NULL);
1096 g_free (parent_path);
1098 if (GTK_IS_OPTION_MENU (parent))
1100 option_menu = GTK_OPTION_MENU (parent);
1101 if (!option_menu->menu)
1102 gtk_option_menu_set_menu (option_menu, gtk_widget_new (GTK_TYPE_MENU, NULL));
1103 parent = option_menu->menu;
1106 g_return_if_fail (GTK_IS_CONTAINER (parent));
1108 widget = gtk_widget_new (type,
1109 "GtkWidget::visible", TRUE,
1110 "GtkWidget::sensitive", (type_id != quark_type_separator_item &&
1111 type_id != quark_type_title),
1112 "GtkWidget::parent", parent,
1114 if (option_menu && !option_menu->menu_item)
1115 gtk_option_menu_set_history (option_menu, 0);
1117 if (type == GTK_TYPE_RADIO_MENU_ITEM)
1118 gtk_radio_menu_item_set_group (GTK_RADIO_MENU_ITEM (widget), radio_group);
1119 if (GTK_IS_CHECK_MENU_ITEM (widget))
1120 gtk_check_menu_item_set_show_toggle (GTK_CHECK_MENU_ITEM (widget), TRUE);
1122 /* install underline accelerators for this item
1124 if (type_id != quark_type_separator_item &&
1125 type_id != quark_type_tearoff_item &&
1130 label = gtk_widget_new (GTK_TYPE_ACCEL_LABEL,
1131 "GtkWidget::visible", TRUE,
1132 "GtkWidget::parent", widget,
1133 "GtkAccelLabel::accel_widget", widget,
1134 "GtkMisc::xalign", 0.0,
1137 accel_key = gtk_label_parse_uline (GTK_LABEL (label), name);
1139 if (accel_key != GDK_VoidSymbol)
1141 if (GTK_IS_MENU_BAR (parent))
1142 gtk_widget_add_accelerator (widget,
1144 ifactory->accel_group,
1145 accel_key, GDK_MOD1_MASK,
1148 if (GTK_IS_MENU (parent))
1149 gtk_widget_add_accelerator (widget,
1151 gtk_menu_ensure_uline_accel_group (GTK_MENU (parent)),
1159 if (type_id == quark_type_branch ||
1160 type_id == quark_type_last_branch)
1162 if (entry->callback)
1163 g_warning ("gtk_item_factory_create_item(): Can't specify a callback on a branch: \"%s\"",
1166 if (type_id == quark_type_last_branch)
1167 gtk_menu_item_right_justify (GTK_MENU_ITEM (widget));
1170 widget = gtk_widget_new (GTK_TYPE_MENU,
1173 gtk_menu_item_set_submenu (GTK_MENU_ITEM (parent), widget);
1176 gtk_item_factory_add_item (ifactory,
1177 path, entry->accelerator,
1178 (type_id == quark_type_branch ||
1179 type_id == quark_type_last_branch) ?
1180 (GtkItemFactoryCallback) NULL : entry->callback,
1181 entry->callback_action, callback_data,
1190 gtk_item_factory_create_menu_entries (guint n_entries,
1191 GtkMenuEntry *entries)
1193 static GtkPatternSpec pspec_separator = { 42, 0 };
1194 static GtkPatternSpec pspec_check = { 42, 0 };
1199 g_return_if_fail (entries != NULL);
1201 if (pspec_separator.pattern_length == 0)
1203 gtk_pattern_spec_init (&pspec_separator, "*<separator>*");
1204 gtk_pattern_spec_init (&pspec_check, "*<check>*");
1207 for (i = 0; i < n_entries; i++)
1209 GtkItemFactory *ifactory;
1210 GtkItemFactoryEntry entry;
1214 path = entries[i].path;
1215 ifactory = gtk_item_factory_from_path (path);
1218 g_warning ("gtk_item_factory_create_menu_entries(): "
1219 "entry[%u] refers to unknown item factory: \"%s\"",
1220 i, entries[i].path);
1224 while (*path != '>')
1230 entry.accelerator = entries[i].accelerator;
1231 entry.callback = entries[i].callback;
1232 entry.callback_action = 0;
1233 if (gtk_pattern_match_string (&pspec_separator, path))
1234 entry.item_type = "<Separator>";
1235 else if (!gtk_pattern_match_string (&pspec_check, path))
1236 entry.item_type = NULL;
1239 gboolean in_brace = FALSE;
1242 cpath = g_new (gchar, strlen (path));
1248 else if (*path == '>')
1255 entry.item_type = "<ToggleItem>";
1259 gtk_item_factory_create_item (ifactory, &entry, entries[i].callback_data, 2);
1260 entries[i].widget = gtk_item_factory_get_widget (ifactory, entries[i].path);
1266 gtk_item_factories_path_delete (const gchar *ifactory_path,
1269 GtkItemFactoryClass *class;
1270 GtkItemFactoryItem *item;
1272 g_return_if_fail (path != NULL);
1274 class = gtk_type_class (GTK_TYPE_ITEM_FACTORY);
1277 item = g_hash_table_lookup (class->item_ht, (gpointer) path);
1282 g_return_if_fail (ifactory_path != NULL);
1284 fpath = g_strconcat (ifactory_path, path, NULL);
1285 item = g_hash_table_lookup (class->item_ht, fpath);
1291 GSList *widget_list;
1295 for (slist = item->widgets; slist; slist = slist->next)
1299 widget = slist->data;
1300 widget_list = g_slist_prepend (widget_list, widget);
1301 gtk_widget_ref (widget);
1304 for (slist = widget_list; slist; slist = slist->next)
1308 widget = slist->data;
1309 gtk_widget_destroy (widget);
1310 gtk_widget_unref (widget);
1312 g_slist_free (widget_list);
1317 gtk_item_factory_delete_item (GtkItemFactory *ifactory,
1320 GtkItemFactoryClass *class;
1321 GtkItemFactoryItem *item;
1324 g_return_if_fail (ifactory != NULL);
1325 g_return_if_fail (GTK_IS_ITEM_FACTORY (ifactory));
1326 g_return_if_fail (path != NULL);
1328 class = GTK_ITEM_FACTORY_GET_CLASS (ifactory);
1330 fpath = g_strconcat (ifactory->path, path, NULL);
1331 item = g_hash_table_lookup (class->item_ht, fpath);
1336 GtkWidget *widget = NULL;
1339 for (slist = item->widgets; slist; slist = slist->next)
1341 widget = slist->data;
1343 if (gtk_item_factory_from_widget (widget) == ifactory)
1348 gtk_widget_destroy (widget);
1353 gtk_item_factory_delete_entry (GtkItemFactory *ifactory,
1354 GtkItemFactoryEntry *entry)
1356 g_return_if_fail (ifactory != NULL);
1357 g_return_if_fail (GTK_IS_ITEM_FACTORY (ifactory));
1358 g_return_if_fail (entry != NULL);
1360 gtk_item_factory_delete_item (ifactory, entry->path);
1364 gtk_item_factory_delete_entries (GtkItemFactory *ifactory,
1366 GtkItemFactoryEntry *entries)
1370 g_return_if_fail (ifactory != NULL);
1371 g_return_if_fail (GTK_IS_ITEM_FACTORY (ifactory));
1373 g_return_if_fail (entries != NULL);
1375 for (i = 0; i < n_entries; i++)
1376 gtk_item_factory_delete_item (ifactory, (entries + i)->path);
1386 gtk_item_factory_menu_pos (GtkMenu *menu,
1391 MenuPos *mpos = func_data;
1398 gtk_item_factory_popup_data_from_widget (GtkWidget *widget)
1400 GtkItemFactory *ifactory;
1402 g_return_val_if_fail (widget != NULL, NULL);
1403 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
1405 ifactory = gtk_item_factory_from_widget (widget);
1407 return gtk_object_get_data_by_id (GTK_OBJECT (ifactory), quark_popup_data);
1413 gtk_item_factory_popup_data (GtkItemFactory *ifactory)
1415 g_return_val_if_fail (ifactory != NULL, NULL);
1416 g_return_val_if_fail (GTK_IS_ITEM_FACTORY (ifactory), NULL);
1418 return gtk_object_get_data_by_id (GTK_OBJECT (ifactory), quark_popup_data);
1422 ifactory_delete_popup_data (GtkObject *object,
1423 GtkItemFactory *ifactory)
1425 gtk_signal_disconnect_by_func (object,
1426 GTK_SIGNAL_FUNC (ifactory_delete_popup_data),
1428 gtk_object_remove_data_by_id (GTK_OBJECT (ifactory), quark_popup_data);
1432 gtk_item_factory_popup (GtkItemFactory *ifactory,
1438 gtk_item_factory_popup_with_data (ifactory, NULL, NULL, x, y, mouse_button, time);
1442 gtk_item_factory_popup_with_data (GtkItemFactory *ifactory,
1443 gpointer popup_data,
1444 GtkDestroyNotify destroy,
1452 g_return_if_fail (ifactory != NULL);
1453 g_return_if_fail (GTK_IS_ITEM_FACTORY (ifactory));
1454 g_return_if_fail (GTK_IS_MENU (ifactory->widget));
1456 mpos = gtk_object_get_data_by_id (GTK_OBJECT (ifactory->widget), quark_if_menu_pos);
1460 mpos = g_new0 (MenuPos, 1);
1461 gtk_object_set_data_by_id_full (GTK_OBJECT (ifactory->widget),
1470 if (popup_data != NULL)
1472 gtk_object_set_data_by_id_full (GTK_OBJECT (ifactory),
1476 gtk_signal_connect (GTK_OBJECT (ifactory->widget),
1478 GTK_SIGNAL_FUNC (ifactory_delete_popup_data),
1482 gtk_menu_popup (GTK_MENU (ifactory->widget),
1484 gtk_item_factory_menu_pos, mpos,
1485 mouse_button, time);
1489 gtk_item_factory_parse_menu_path (GScanner *scanner,
1490 GtkItemFactoryClass *class)
1492 GtkItemFactoryItem *item;
1494 g_scanner_get_next_token (scanner);
1495 if (scanner->token != G_TOKEN_STRING)
1496 return G_TOKEN_STRING;
1498 g_scanner_peek_next_token (scanner);
1499 if (scanner->next_token != G_TOKEN_STRING)
1501 g_scanner_get_next_token (scanner);
1502 return G_TOKEN_STRING;
1505 item = g_hash_table_lookup (class->item_ht, scanner->value.v_string);
1508 item = g_chunk_new (GtkItemFactoryItem, ifactory_item_chunks);
1510 item->path = g_strdup (scanner->value.v_string);
1511 item->accelerator_key = 0;
1512 item->accelerator_mods = 0;
1513 item->modified = TRUE;
1514 item->in_propagation = FALSE;
1516 item->widgets = NULL;
1518 g_hash_table_insert (class->item_ht, item->path, item);
1520 g_scanner_get_next_token (scanner);
1522 if (!item->in_propagation)
1527 old_keyval = item->accelerator_key;
1528 old_mods = item->accelerator_mods;
1529 gtk_accelerator_parse (scanner->value.v_string,
1530 &item->accelerator_key,
1531 &item->accelerator_mods);
1532 if (old_keyval != item->accelerator_key ||
1533 old_mods != item->accelerator_mods)
1535 item->modified = TRUE;
1536 gtk_item_factory_propagate_accelerator (item, NULL);
1540 g_scanner_get_next_token (scanner);
1541 if (scanner->token != ')')
1544 return G_TOKEN_NONE;
1548 gtk_item_factory_parse_statement (GScanner *scanner,
1549 GtkItemFactoryClass *class)
1551 guint expected_token;
1553 g_scanner_get_next_token (scanner);
1555 if (scanner->token == G_TOKEN_SYMBOL)
1557 guint (*parser_func) (GScanner*, GtkItemFactoryClass*);
1559 parser_func = scanner->value.v_symbol;
1561 /* check whether this is a GtkItemFactory symbol.
1563 if (parser_func == gtk_item_factory_parse_menu_path)
1564 expected_token = parser_func (scanner, class);
1566 expected_token = G_TOKEN_SYMBOL;
1569 expected_token = G_TOKEN_SYMBOL;
1571 /* skip rest of statement on errrors
1573 if (expected_token != G_TOKEN_NONE)
1575 register guint level;
1578 if (scanner->token == ')')
1580 if (scanner->token == '(')
1583 while (!g_scanner_eof (scanner) && level > 0)
1585 g_scanner_get_next_token (scanner);
1587 if (scanner->token == '(')
1589 else if (scanner->token == ')')
1596 gtk_item_factory_parse_rc_string (const gchar *rc_string)
1600 g_return_if_fail (rc_string != NULL);
1602 if (!gtk_item_factory_class)
1603 gtk_type_class (GTK_TYPE_ITEM_FACTORY);
1605 ifactory_scanner_config.cpair_comment_single = gtk_item_factory_class->cpair_comment_single;
1606 scanner = g_scanner_new (&ifactory_scanner_config);
1608 g_scanner_input_text (scanner, rc_string, strlen (rc_string));
1610 gtk_item_factory_parse_rc_scanner (scanner);
1612 g_scanner_destroy (scanner);
1616 gtk_item_factory_parse_rc_scanner (GScanner *scanner)
1618 gpointer saved_symbol;
1620 g_return_if_fail (scanner != NULL);
1622 if (!gtk_item_factory_class)
1623 gtk_type_class (GTK_TYPE_ITEM_FACTORY);
1625 saved_symbol = g_scanner_lookup_symbol (scanner, "menu-path");
1626 g_scanner_remove_symbol (scanner, "menu-path");
1627 g_scanner_add_symbol (scanner, "menu-path", gtk_item_factory_parse_menu_path);
1629 g_scanner_peek_next_token (scanner);
1631 while (scanner->next_token == '(')
1633 g_scanner_get_next_token (scanner);
1635 gtk_item_factory_parse_statement (scanner, gtk_item_factory_class);
1637 g_scanner_peek_next_token (scanner);
1640 g_scanner_remove_symbol (scanner, "menu-path");
1641 g_scanner_add_symbol (scanner, "menu-path", saved_symbol);
1645 gtk_item_factory_parse_rc (const gchar *file_name)
1650 g_return_if_fail (file_name != NULL);
1652 if (!S_ISREG (g_scanner_stat_mode (file_name)))
1655 fd = open (file_name, O_RDONLY);
1659 if (!gtk_item_factory_class)
1660 gtk_type_class (GTK_TYPE_ITEM_FACTORY);
1662 ifactory_scanner_config.cpair_comment_single = gtk_item_factory_class->cpair_comment_single;
1663 scanner = g_scanner_new (&ifactory_scanner_config);
1665 g_scanner_input_file (scanner, fd);
1667 gtk_item_factory_parse_rc_scanner (scanner);
1669 g_scanner_destroy (scanner);
1675 gtk_item_factory_set_translate_func (GtkItemFactory *ifactory,
1676 GtkTranslateFunc func,
1678 GtkDestroyNotify notify)
1680 g_return_if_fail (ifactory != NULL);
1682 if (ifactory->translate_notify)
1683 ifactory->translate_notify (ifactory->translate_data);
1685 ifactory->translate_func = func;
1686 ifactory->translate_data = data;
1687 ifactory->translate_notify = notify;