gtkitemfactory.c 42.7 KB
Newer Older
Tim Janik's avatar
Tim Janik committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21
/* GTK - The GIMP Toolkit
 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
 *
 * GtkItemFactory: Flexible item factory with automatic rc handling
 * Copyright (C) 1998 Tim Janik
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.	 See the GNU
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 */
22 23 24 25 26 27 28 29

/*
 * Modified by the GTK+ Team and others 1997-1999.  See the AUTHORS
 * file for a list of people on the GTK+ Team.  See the ChangeLog
 * files for a list of changes.  These files are distributed with
 * GTK+ at ftp://ftp.gtk.org/pub/gtk/. 
 */

30 31
#include	"config.h"

Tim Janik's avatar
Tim Janik committed
32 33 34 35 36 37 38 39
#include	"gtkitemfactory.h"
#include	"gtk/gtksignal.h"
#include	"gtk/gtkoptionmenu.h"
#include	"gtk/gtkmenubar.h"
#include	"gtk/gtkmenu.h"
#include	"gtk/gtkmenuitem.h"
#include	"gtk/gtkradiomenuitem.h"
#include	"gtk/gtkcheckmenuitem.h"
40
#include	"gtk/gtktearoffmenuitem.h"
Tim Janik's avatar
Tim Janik committed
41
#include	"gtk/gtkaccellabel.h"
42
#include        "gdk/gdkkeysyms.h"
Tim Janik's avatar
Tim Janik committed
43 44 45
#include	<string.h>
#include	<sys/stat.h>
#include	<fcntl.h>
46
#ifdef HAVE_UNISTD_H
Tim Janik's avatar
Tim Janik committed
47
#include	<unistd.h>
48
#endif
49
#include	<stdio.h>
Tim Janik's avatar
Tim Janik committed
50

Manish Singh's avatar
Manish Singh committed
51
#ifdef G_OS_WIN32
52 53 54 55 56 57
#include	<io.h>		/* For _open and _close */

#ifndef S_ISREG
#define S_ISREG(mode) ((mode)&_S_IFREG)
#endif
#endif
Tim Janik's avatar
Tim Janik committed
58 59 60 61 62 63 64 65 66


/* --- defines --- */
#define		ITEM_FACTORY_STRING	((gchar*) item_factory_string)
#define		ITEM_BLOCK_SIZE		(128)


/* --- structures --- */
typedef struct	_GtkIFCBData		GtkIFCBData;
67
typedef struct  _GtkIFDumpData		GtkIFDumpData;
Tim Janik's avatar
Tim Janik committed
68 69
struct _GtkIFCBData
{
70 71 72 73
  GtkItemFactoryCallback  func;
  guint			  callback_type;
  gpointer		  func_data;
  guint			  callback_action;
Tim Janik's avatar
Tim Janik committed
74
};
75 76 77 78 79 80 81
struct _GtkIFDumpData
{
  GtkPrintFunc	         print_func;
  gpointer	         func_data;
  guint		         modified_only : 1;
  GtkPatternSpec	*pspec;
};
Tim Janik's avatar
Tim Janik committed
82 83 84 85 86 87


/* --- prototypes --- */
static void	gtk_item_factory_class_init		(GtkItemFactoryClass  *klass);
static void	gtk_item_factory_init			(GtkItemFactory	      *ifactory);
static void	gtk_item_factory_destroy		(GtkObject	      *object);
88
static void	gtk_item_factory_finalize		(GObject	      *object);
Tim Janik's avatar
Tim Janik committed
89 90 91 92


/* --- static variables --- */
static GtkItemFactoryClass *gtk_item_factory_class = NULL;
93
static gpointer          parent_class = NULL;
Tim Janik's avatar
Tim Janik committed
94 95 96
static const gchar	*item_factory_string = "Gtk-<ItemFactory>";
static GMemChunk	*ifactory_item_chunks = NULL;
static GMemChunk	*ifactory_cb_data_chunks = NULL;
97 98 99
static GQuark		 quark_popup_data = 0;
static GQuark		 quark_if_menu_pos = 0;
static GQuark		 quark_item_factory = 0;
100 101 102
static GQuark		 quark_item_path = 0;
static GQuark		 quark_action = 0;
static GQuark		 quark_accel_group = 0;
103 104 105 106 107
static GQuark		 quark_type_item = 0;
static GQuark		 quark_type_title = 0;
static GQuark		 quark_type_radio_item = 0;
static GQuark		 quark_type_check_item = 0;
static GQuark		 quark_type_toggle_item = 0;
108
static GQuark		 quark_type_tearoff_item = 0;
109 110 111
static GQuark		 quark_type_separator_item = 0;
static GQuark		 quark_type_branch = 0;
static GQuark		 quark_type_last_branch = 0;
Tim Janik's avatar
Tim Janik committed
112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162
static	GScannerConfig	ifactory_scanner_config =
{
  (
   " \t\n"
   )			/* cset_skip_characters */,
  (
   G_CSET_a_2_z
   "_"
   G_CSET_A_2_Z
   )			/* cset_identifier_first */,
  (
   G_CSET_a_2_z
   "-+_0123456789"
   G_CSET_A_2_Z
   G_CSET_LATINS
   G_CSET_LATINC
   )			/* cset_identifier_nth */,
  ( ";\n" )		/* cpair_comment_single */,
  
  FALSE			/* case_sensitive */,
  
  TRUE			/* skip_comment_multi */,
  TRUE			/* skip_comment_single */,
  FALSE			/* scan_comment_multi */,
  TRUE			/* scan_identifier */,
  FALSE			/* scan_identifier_1char */,
  FALSE			/* scan_identifier_NULL */,
  TRUE			/* scan_symbols */,
  TRUE			/* scan_binary */,
  TRUE			/* scan_octal */,
  TRUE			/* scan_float */,
  TRUE			/* scan_hex */,
  FALSE			/* scan_hex_dollar */,
  TRUE			/* scan_string_sq */,
  TRUE			/* scan_string_dq */,
  TRUE			/* numbers_2_int */,
  FALSE			/* int_2_float */,
  FALSE			/* identifier_2_string */,
  TRUE			/* char_2_token */,
  FALSE			/* symbol_2_token */,
};


/* --- functions --- */
GtkType
gtk_item_factory_get_type (void)
{
  static GtkType item_factory_type = 0;
  
  if (!item_factory_type)
    {
163
      static const GtkTypeInfo item_factory_info =
Tim Janik's avatar
Tim Janik committed
164 165 166 167 168 169
      {
	"GtkItemFactory",
	sizeof (GtkItemFactory),
	sizeof (GtkItemFactoryClass),
	(GtkClassInitFunc) gtk_item_factory_class_init,
	(GtkObjectInitFunc) gtk_item_factory_init,
170 171
	/* reserved_1 */ NULL,
	/* reserved_2 */ NULL,
172
        (GtkClassInitFunc) NULL,
Tim Janik's avatar
Tim Janik committed
173 174
      };
      
175
      item_factory_type = gtk_type_unique (GTK_TYPE_OBJECT, &item_factory_info);
Tim Janik's avatar
Tim Janik committed
176 177 178 179 180 181 182 183
    }
  
  return item_factory_type;
}

static void
gtk_item_factory_class_init (GtkItemFactoryClass  *class)
{
184
  GObjectClass *gobject_class = G_OBJECT_CLASS (class);
Tim Janik's avatar
Tim Janik committed
185 186 187 188
  GtkObjectClass *object_class;

  gtk_item_factory_class = class;

189
  parent_class = gtk_type_class (GTK_TYPE_OBJECT);
Tim Janik's avatar
Tim Janik committed
190 191 192

  object_class = (GtkObjectClass*) class;

193 194
  gobject_class->finalize = gtk_item_factory_finalize;

Tim Janik's avatar
Tim Janik committed
195 196 197 198 199
  object_class->destroy = gtk_item_factory_destroy;

  class->cpair_comment_single = g_strdup (";\n");

  class->item_ht = g_hash_table_new (g_str_hash, g_str_equal);
200
  class->dummy = NULL;
Tim Janik's avatar
Tim Janik committed
201 202 203 204 205 206 207 208 209 210 211
  ifactory_item_chunks =
    g_mem_chunk_new ("GtkItemFactoryItem",
		     sizeof (GtkItemFactoryItem),
		     sizeof (GtkItemFactoryItem) * ITEM_BLOCK_SIZE,
		     G_ALLOC_ONLY);
  ifactory_cb_data_chunks =
    g_mem_chunk_new ("GtkIFCBData",
		     sizeof (GtkIFCBData),
		     sizeof (GtkIFCBData) * ITEM_BLOCK_SIZE,
		     G_ALLOC_AND_FREE);

212 213 214 215 216 217 218 219 220 221 222 223 224 225 226
  quark_popup_data		= g_quark_from_static_string ("GtkItemFactory-popup-data");
  quark_if_menu_pos		= g_quark_from_static_string ("GtkItemFactory-menu-position");
  quark_item_factory		= g_quark_from_static_string ("GtkItemFactory");
  quark_item_path		= g_quark_from_static_string ("GtkItemFactory-path");
  quark_action			= g_quark_from_static_string ("GtkItemFactory-action");
  quark_accel_group		= g_quark_from_static_string ("GtkAccelGroup");
  quark_type_item		= g_quark_from_static_string ("<Item>");
  quark_type_title		= g_quark_from_static_string ("<Title>");
  quark_type_radio_item		= g_quark_from_static_string ("<RadioItem>");
  quark_type_check_item		= g_quark_from_static_string ("<CheckItem>");
  quark_type_toggle_item	= g_quark_from_static_string ("<ToggleItem>");
  quark_type_tearoff_item	= g_quark_from_static_string ("<Tearoff>");
  quark_type_separator_item	= g_quark_from_static_string ("<Separator>");
  quark_type_branch		= g_quark_from_static_string ("<Branch>");
  quark_type_last_branch	= g_quark_from_static_string ("<LastBranch>");
Tim Janik's avatar
Tim Janik committed
227 228 229 230 231 232 233 234 235 236 237 238
}

static void
gtk_item_factory_init (GtkItemFactory	    *ifactory)
{
  GtkObject *object;

  object = GTK_OBJECT (ifactory);

  ifactory->path = NULL;
  ifactory->accel_group = NULL;
  ifactory->widget = NULL;
239
  ifactory->items = NULL;
240 241 242
  ifactory->translate_func = NULL;
  ifactory->translate_data = NULL;
  ifactory->translate_notify = NULL;
Tim Janik's avatar
Tim Janik committed
243 244 245 246 247 248 249 250 251 252 253
}

GtkItemFactory*
gtk_item_factory_new (GtkType	     container_type,
		      const gchar   *path,
		      GtkAccelGroup *accel_group)
{
  GtkItemFactory *ifactory;

  g_return_val_if_fail (path != NULL, NULL);

254
  ifactory = gtk_type_new (GTK_TYPE_ITEM_FACTORY);
Tim Janik's avatar
Tim Janik committed
255 256 257 258 259 260 261 262 263 264 265 266 267
  gtk_item_factory_construct (ifactory, container_type, path, accel_group);

  return ifactory;
}

static void
gtk_item_factory_callback_marshal (GtkWidget *widget,
				   gpointer   func_data)
{
  GtkIFCBData *data;

  data = func_data;

268 269
  if (data->callback_type == 1)
    {
270
      GtkItemFactoryCallback1 func1 = (GtkItemFactoryCallback1) data->func;
271 272 273 274
      func1 (data->func_data, data->callback_action, widget);
    }
  else if (data->callback_type == 2)
    {
275
      GtkItemFactoryCallback2 func2 = (GtkItemFactoryCallback2) data->func;
276 277
      func2 (widget, data->func_data, data->callback_action);
    }
Tim Janik's avatar
Tim Janik committed
278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308
}

static void
gtk_item_factory_propagate_accelerator (GtkItemFactoryItem *item,
					GtkWidget          *exclude)
{
  GSList *widget_list;
  GSList *slist;
  
  if (item->in_propagation)
    return;
  
  item->in_propagation = TRUE;
  
  widget_list = NULL;
  for (slist = item->widgets; slist; slist = slist->next)
    {
      GtkWidget *widget;
      
      widget = slist->data;
      
      if (widget != exclude)
	{
	  gtk_widget_ref (widget);
	  widget_list = g_slist_prepend (widget_list, widget);
	}
    }
  
  for (slist = widget_list; slist; slist = slist->next)
    {
      GtkWidget *widget;
309 310
      GtkAccelGroup *accel_group;
      guint signal_id;
Tim Janik's avatar
Tim Janik committed
311 312 313
      
      widget = slist->data;
      
314
      accel_group = gtk_object_get_data_by_id (GTK_OBJECT (widget), quark_accel_group);
Tim Janik's avatar
Tim Janik committed
315
      
316 317
      signal_id = gtk_signal_lookup ("activate", GTK_OBJECT_TYPE (widget));
      if (signal_id && accel_group)
Tim Janik's avatar
Tim Janik committed
318
	{
319 320 321 322 323 324 325 326
	  if (item->accelerator_key)
	    gtk_widget_add_accelerator (widget,
					"activate",
					accel_group,
					item->accelerator_key,
					item->accelerator_mods,
					GTK_ACCEL_VISIBLE);
	  else
Tim Janik's avatar
Tim Janik committed
327
	    {
328 329 330 331
	      GSList *work;
	      
	      work = gtk_accel_group_entries_from_object (GTK_OBJECT (widget));
	      while (work)
Tim Janik's avatar
Tim Janik committed
332
		{
333
		  GtkAccelEntry *ac_entry;
Tim Janik's avatar
Tim Janik committed
334
		  
335 336 337 338 339 340 341 342 343
		  ac_entry = work->data;
		  work = work->next;
		  if (ac_entry->accel_flags & GTK_ACCEL_VISIBLE &&
		      ac_entry->accel_group == accel_group &&
		      ac_entry->signal_id == signal_id)
		    gtk_widget_remove_accelerator (GTK_WIDGET (widget),
						   ac_entry->accel_group,
						   ac_entry->accelerator_key,
						   ac_entry->accelerator_mods);
Tim Janik's avatar
Tim Janik committed
344 345 346
		}
	    }
	}
347

Tim Janik's avatar
Tim Janik committed
348 349
      gtk_widget_unref (widget);
    }
350
  
Tim Janik's avatar
Tim Janik committed
351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403
  g_slist_free (widget_list);
  
  item->in_propagation = FALSE;
}

static gint
gtk_item_factory_item_add_accelerator (GtkWidget	  *widget,
				       guint               accel_signal_id,
				       GtkAccelGroup      *accel_group,
				       guint               accel_key,
				       guint               accel_mods,
				       GtkAccelFlags       accel_flags,
				       GtkItemFactoryItem *item)
{
  if (!item->in_propagation &&
      g_slist_find (item->widgets, widget) &&
      accel_signal_id == gtk_signal_lookup ("activate", GTK_OBJECT_TYPE (widget)))
    {
      item->accelerator_key = accel_key;
      item->accelerator_mods = accel_mods;
      item->modified = TRUE;
      
      gtk_item_factory_propagate_accelerator (item, widget);
    }

  return TRUE;
}

static void
gtk_item_factory_item_remove_accelerator (GtkWidget	     *widget,
					  GtkAccelGroup      *accel_group,
					  guint               accel_key,
					  guint               accel_mods,
					  GtkItemFactoryItem *item)
{
  if (!item->in_propagation &&
      g_slist_find (item->widgets, widget) &&
      item->accelerator_key == accel_key &&
      item->accelerator_mods == accel_mods)
    {
      item->accelerator_key = 0;
      item->accelerator_mods = 0;
      item->modified = TRUE;
      
      gtk_item_factory_propagate_accelerator (item, widget);
    }
}

static void
gtk_item_factory_item_remove_widget (GtkWidget		*widget,
				     GtkItemFactoryItem *item)
{
  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);
Tim Janik's avatar
Tim Janik committed
406 407
}

408 409 410 411 412 413
void
gtk_item_factory_add_foreign (GtkWidget      *accel_widget,
			      const gchar    *full_path,
			      GtkAccelGroup  *accel_group,
			      guint           keyval,
			      GdkModifierType modifiers)
Tim Janik's avatar
Tim Janik committed
414 415 416 417
{
  GtkItemFactoryClass *class;
  GtkItemFactoryItem *item;

418 419
  g_return_if_fail (GTK_IS_WIDGET (accel_widget));
  g_return_if_fail (full_path != NULL);
Tim Janik's avatar
Tim Janik committed
420

421
  class = gtk_type_class (GTK_TYPE_ITEM_FACTORY);
Tim Janik's avatar
Tim Janik committed
422

423 424 425
  keyval = keyval != GDK_VoidSymbol ? keyval : 0;

  item = g_hash_table_lookup (class->item_ht, full_path);
Tim Janik's avatar
Tim Janik committed
426 427 428 429
  if (!item)
    {
      item = g_chunk_new (GtkItemFactoryItem, ifactory_item_chunks);

430
      item->path = g_strdup (full_path);
Tim Janik's avatar
Tim Janik committed
431
      item->accelerator_key = keyval;
432
      item->accelerator_mods = modifiers;
Tim Janik's avatar
Tim Janik committed
433 434
      item->modified = FALSE;
      item->in_propagation = FALSE;
435
      item->dummy = NULL;
Tim Janik's avatar
Tim Janik committed
436 437 438 439 440
      item->widgets = NULL;
      
      g_hash_table_insert (class->item_ht, item->path, item);
    }

441 442
  item->widgets = g_slist_prepend (item->widgets, accel_widget);
  gtk_signal_connect (GTK_OBJECT (accel_widget),
Tim Janik's avatar
Tim Janik committed
443 444 445 446
		      "destroy",
		      GTK_SIGNAL_FUNC (gtk_item_factory_item_remove_widget),
		      item);

447
  /* set the item path for the widget
Tim Janik's avatar
Tim Janik committed
448
   */
449 450 451 452 453 454 455 456 457 458 459 460
  gtk_object_set_data_by_id (GTK_OBJECT (accel_widget), quark_item_path, item->path);
  gtk_widget_set_name (accel_widget, item->path);
  if (accel_group)
    {
      gtk_accel_group_ref (accel_group);
      gtk_object_set_data_by_id_full (GTK_OBJECT (accel_widget),
				      quark_accel_group,
				      accel_group,
				      (GtkDestroyNotify) gtk_accel_group_unref);
    }
  else
    gtk_object_set_data_by_id (GTK_OBJECT (accel_widget), quark_accel_group, NULL);
Tim Janik's avatar
Tim Janik committed
461 462 463

  /* install defined accelerators
   */
464
  if (gtk_signal_lookup ("activate", GTK_OBJECT_TYPE (accel_widget)))
Tim Janik's avatar
Tim Janik committed
465
    {
466 467
      if (item->accelerator_key && accel_group)
	gtk_widget_add_accelerator (accel_widget,
Tim Janik's avatar
Tim Janik committed
468
				    "activate",
469
				    accel_group,
Tim Janik's avatar
Tim Janik committed
470 471 472 473
				    item->accelerator_key,
				    item->accelerator_mods,
				    GTK_ACCEL_VISIBLE);
      else
474
	gtk_widget_remove_accelerators (accel_widget,
Tim Janik's avatar
Tim Janik committed
475 476 477 478 479 480
					"activate",
					TRUE);
    }

  /* keep track of accelerator changes
   */
481
  gtk_signal_connect_after (GTK_OBJECT (accel_widget),
Tim Janik's avatar
Tim Janik committed
482 483 484
			    "add-accelerator",
			    GTK_SIGNAL_FUNC (gtk_item_factory_item_add_accelerator),
			    item);
485
  gtk_signal_connect_after (GTK_OBJECT (accel_widget),
Tim Janik's avatar
Tim Janik committed
486 487 488
			    "remove-accelerator",
			    GTK_SIGNAL_FUNC (gtk_item_factory_item_remove_accelerator),
			    item);
489
}
Tim Janik's avatar
Tim Janik committed
490

491 492 493 494 495
static void
ifactory_cb_data_free (gpointer mem)
{
  g_mem_chunk_free (ifactory_cb_data_chunks, mem);
}
Tim Janik's avatar
Tim Janik committed
496

497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515
static void
gtk_item_factory_add_item (GtkItemFactory		*ifactory,
			   const gchar			*path,
			   const gchar			*accelerator,
			   GtkItemFactoryCallback	callback,
			   guint			callback_action,
			   gpointer			callback_data,
			   guint			callback_type,
			   gchar			*item_type,
			   GtkWidget			*widget)
{
  GtkItemFactoryClass *class;
  GtkItemFactoryItem *item;
  gchar *fpath;
  guint keyval, mods;
  
  g_return_if_fail (widget != NULL);
  g_return_if_fail (item_type != NULL);

516
  class = GTK_ITEM_FACTORY_GET_CLASS (ifactory);
517 518 519 520 521

  /* set accelerator group on menu widgets
   */
  if (GTK_IS_MENU (widget))
    gtk_menu_set_accel_group ((GtkMenu*) widget, ifactory->accel_group);
Tim Janik's avatar
Tim Janik committed
522 523 524 525 526 527 528 529 530

  /* connect callback if neccessary
   */
  if (callback)
    {
      GtkIFCBData *data;

      data = g_chunk_new (GtkIFCBData, ifactory_cb_data_chunks);
      data->func = callback;
531
      data->callback_type = callback_type;
Tim Janik's avatar
Tim Janik committed
532 533 534 535 536 537 538 539 540 541 542
      data->func_data = callback_data;
      data->callback_action = callback_action;

      gtk_object_weakref (GTK_OBJECT (widget),
			  ifactory_cb_data_free,
			  data);
      gtk_signal_connect (GTK_OBJECT (widget),
			  "activate",
			  GTK_SIGNAL_FUNC (gtk_item_factory_callback_marshal),
			  data);
    }
543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564

  /* link the widget into its item-entry
   * and keep back pointer on both the item factory and the widget
   */
  gtk_object_set_data_by_id (GTK_OBJECT (widget), quark_action, GUINT_TO_POINTER (callback_action));
  gtk_object_set_data_by_id (GTK_OBJECT (widget), quark_item_factory, ifactory);
  if (accelerator)
    gtk_accelerator_parse (accelerator, &keyval, &mods);
  else
    {
      keyval = 0;
      mods = 0;
    }
  fpath = g_strconcat (ifactory->path, path, NULL);
  gtk_item_factory_add_foreign (widget, fpath, ifactory->accel_group, keyval, mods);
  item = g_hash_table_lookup (class->item_ht, fpath);
  g_free (fpath);

  g_return_if_fail (item != NULL);

  if (!g_slist_find (ifactory->items, item))
    ifactory->items = g_slist_prepend (ifactory->items, item);
Tim Janik's avatar
Tim Janik committed
565 566 567 568 569 570 571 572 573 574 575 576 577 578
}

void
gtk_item_factory_construct (GtkItemFactory	*ifactory,
			    GtkType		 container_type,
			    const gchar		*path,
			    GtkAccelGroup	*accel_group)
{
  guint len;

  g_return_if_fail (ifactory != NULL);
  g_return_if_fail (GTK_IS_ITEM_FACTORY (ifactory));
  g_return_if_fail (ifactory->accel_group == NULL);
  g_return_if_fail (path != NULL);
579 580
  if (!gtk_type_is_a (container_type, GTK_TYPE_OPTION_MENU))
    g_return_if_fail (gtk_type_is_a (container_type, GTK_TYPE_MENU_SHELL));
Tim Janik's avatar
Tim Janik committed
581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604

  len = strlen (path);

  if (path[0] != '<' && path[len - 1] != '>')
    {
      g_warning ("GtkItemFactory: invalid factory path `%s'", path);
      return;
    }

  if (accel_group)
    {
      ifactory->accel_group = accel_group;
      gtk_accel_group_ref (ifactory->accel_group);
    }
  else
    ifactory->accel_group = gtk_accel_group_new ();

  ifactory->path = g_strdup (path);
  ifactory->widget =
    gtk_widget_new (container_type,
		    "GtkObject::signal::destroy", gtk_widget_destroyed, &ifactory->widget,
		    NULL);
  gtk_object_ref (GTK_OBJECT (ifactory));
  gtk_object_sink (GTK_OBJECT (ifactory));
605

Tim Janik's avatar
Tim Janik committed
606 607
  gtk_item_factory_add_item (ifactory,
			     "", NULL,
608
			     NULL, 0, NULL, 0,
Tim Janik's avatar
Tim Janik committed
609 610 611 612
			     ITEM_FACTORY_STRING,
			     ifactory->widget);
}

613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639
GtkItemFactory*
gtk_item_factory_from_path (const gchar      *path)
{
  GtkItemFactoryClass *class;
  GtkItemFactoryItem *item;
  gchar *fname;
  guint i;

  g_return_val_if_fail (path != NULL, NULL);
  g_return_val_if_fail (path[0] == '<', NULL);

  class = gtk_type_class (GTK_TYPE_ITEM_FACTORY);

  i = 0;
  while (path[i] && path[i] != '>')
    i++;
  if (path[i] != '>')
    {
      g_warning ("gtk_item_factory_from_path(): invalid factory path \"%s\"",
		 path);
      return NULL;
    }
  fname = g_new (gchar, i + 2);
  g_memmove (fname, path, i + 1);
  fname[i + 1] = 0;

  item = g_hash_table_lookup (class->item_ht, fname);
640 641 642

  g_free (fname);

643 644 645 646 647 648
  if (item && item->widgets)
    return gtk_item_factory_from_widget (item->widgets->data);

  return NULL;
}

Tim Janik's avatar
Tim Janik committed
649
static void
Tim Janik's avatar
Tim Janik committed
650
gtk_item_factory_destroy (GtkObject *object)
Tim Janik's avatar
Tim Janik committed
651 652 653 654 655 656 657 658 659 660 661
{
  GtkItemFactory *ifactory;
  GSList *slist;

  g_return_if_fail (object != NULL);
  g_return_if_fail (GTK_IS_ITEM_FACTORY (object));

  ifactory = (GtkItemFactory*) object;

  if (ifactory->widget)
    {
Tim Janik's avatar
Tim Janik committed
662
      GtkObject *dobj;
Tim Janik's avatar
Tim Janik committed
663

Tim Janik's avatar
Tim Janik committed
664
      dobj = GTK_OBJECT (ifactory->widget);
Tim Janik's avatar
Tim Janik committed
665

Tim Janik's avatar
Tim Janik committed
666 667 668 669
      gtk_object_ref (dobj);
      gtk_object_sink (dobj);
      gtk_object_destroy (dobj);
      gtk_object_unref (dobj);
Tim Janik's avatar
Tim Janik committed
670 671 672 673

      ifactory->widget = NULL;
    }

674 675 676 677 678 679
  for (slist = ifactory->items; slist; slist = slist->next)
    {
      GtkItemFactoryItem *item = slist->data;
      GSList *link;
      
      for (link = item->widgets; link; link = link->next)
680
	if (gtk_object_get_data_by_id (link->data, quark_item_factory) == ifactory)
681 682 683 684
	  gtk_object_remove_data_by_id (link->data, quark_item_factory);
    }
  g_slist_free (ifactory->items);
  ifactory->items = NULL;
Tim Janik's avatar
Tim Janik committed
685

686
  GTK_OBJECT_CLASS (parent_class)->destroy (object);
Tim Janik's avatar
Tim Janik committed
687 688 689
}

static void
690
gtk_item_factory_finalize (GObject *object)
Tim Janik's avatar
Tim Janik committed
691 692 693 694 695 696 697 698 699 700 701 702
{
  GtkItemFactory *ifactory;

  g_return_if_fail (object != NULL);
  g_return_if_fail (GTK_IS_ITEM_FACTORY (object));

  ifactory = GTK_ITEM_FACTORY (object);

  gtk_accel_group_unref (ifactory->accel_group);
  g_free (ifactory->path);
  g_assert (ifactory->widget == NULL);

703
  if (ifactory->translate_notify)
704 705
    ifactory->translate_notify (ifactory->translate_data);
  
706
  G_OBJECT_CLASS (parent_class)->finalize (object);
Tim Janik's avatar
Tim Janik committed
707 708 709 710 711 712 713 714
}

GtkItemFactory*
gtk_item_factory_from_widget (GtkWidget	       *widget)
{
  g_return_val_if_fail (widget != NULL, NULL);
  g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);

715
  return gtk_object_get_data_by_id (GTK_OBJECT (widget), quark_item_factory);
Tim Janik's avatar
Tim Janik committed
716 717 718 719 720 721 722 723
}

gchar*
gtk_item_factory_path_from_widget (GtkWidget	    *widget)
{
  g_return_val_if_fail (widget != NULL, NULL);
  g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);

724
  return gtk_object_get_data_by_id (GTK_OBJECT (widget), quark_item_path);
Tim Janik's avatar
Tim Janik committed
725 726 727 728 729 730 731 732
}

static void
gtk_item_factory_foreach (gpointer hash_key,
			  gpointer value,
			  gpointer user_data)
{
  GtkItemFactoryItem *item;
733
  GtkIFDumpData *data;
Tim Janik's avatar
Tim Janik committed
734 735 736 737 738 739 740
  gchar *string;
  gchar *name;
  gchar comment_prefix[2] = "\000\000";

  item = value;
  data = user_data;

741
  if (data->pspec && !gtk_pattern_match_string (data->pspec, item->path))
Tim Janik's avatar
Tim Janik committed
742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761
    return;

  comment_prefix[0] = gtk_item_factory_class->cpair_comment_single[0];

  name = gtk_accelerator_name (item->accelerator_key, item->accelerator_mods);
  string = g_strconcat (item->modified ? "" : comment_prefix,
			"(menu-path \"",
			hash_key,
			"\" \"",
			name,
			"\")",
			NULL);
  g_free (name);

  data->print_func (data->func_data, string);

  g_free (string);
}

void
762 763 764 765
gtk_item_factory_dump_items (GtkPatternSpec	 *path_pspec,
			     gboolean		  modified_only,
			     GtkPrintFunc	  print_func,
			     gpointer		  func_data)
Tim Janik's avatar
Tim Janik committed
766
{
767
  GtkIFDumpData data;
Tim Janik's avatar
Tim Janik committed
768 769 770 771 772 773 774 775 776

  g_return_if_fail (print_func != NULL);

  if (!gtk_item_factory_class)
    gtk_type_class (GTK_TYPE_ITEM_FACTORY);

  data.print_func = print_func;
  data.func_data = func_data;
  data.modified_only = (modified_only != FALSE);
777
  data.pspec = path_pspec;
Tim Janik's avatar
Tim Janik committed
778 779 780 781

  g_hash_table_foreach (gtk_item_factory_class->item_ht, gtk_item_factory_foreach, &data);
}

782
void
783 784
gtk_item_factory_print_func (gpointer     FILE_pointer,
			     const gchar *string)
785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808
{
  FILE *f_out = FILE_pointer;

  g_return_if_fail (FILE_pointer != NULL);
  g_return_if_fail (string != NULL);
  
  fputs (string, f_out);
  fputc ('\n', f_out);
}

void
gtk_item_factory_dump_rc (const gchar            *file_name,
			  GtkPatternSpec         *path_pspec,
			  gboolean                modified_only)
{
  FILE *f_out;

  g_return_if_fail (file_name != NULL);

  f_out = fopen (file_name, "w");
  if (!f_out)
    return;

  fputs ("; ", f_out);
809 810
  if (g_get_prgname ())
    fputs (g_get_prgname (), f_out);
811 812 813 814 815 816 817 818 819 820 821 822
  fputs (" GtkItemFactory rc-file         -*- scheme -*-\n", f_out);
  fputs ("; this file is an automated menu-path dump\n", f_out);
  fputs (";\n", f_out);

  gtk_item_factory_dump_items (path_pspec,
			       modified_only,
			       gtk_item_factory_print_func,
			       f_out);

  fclose (f_out);
}

Tim Janik's avatar
Tim Janik committed
823
void
824 825 826 827
gtk_item_factory_create_items (GtkItemFactory	   *ifactory,
			       guint		    n_entries,
			       GtkItemFactoryEntry *entries,
			       gpointer		    callback_data)
828 829 830 831 832
{
  gtk_item_factory_create_items_ac (ifactory, n_entries, entries, callback_data, 1);
}

void
833 834 835 836 837
gtk_item_factory_create_items_ac (GtkItemFactory      *ifactory,
				  guint		       n_entries,
				  GtkItemFactoryEntry *entries,
				  gpointer	       callback_data,
				  guint		       callback_type)
Tim Janik's avatar
Tim Janik committed
838 839 840 841 842
{
  guint i;

  g_return_if_fail (ifactory != NULL);
  g_return_if_fail (GTK_IS_ITEM_FACTORY (ifactory));
843 844 845 846 847
  g_return_if_fail (callback_type >= 1 && callback_type <= 2);

  if (n_entries == 0)
    return;

Tim Janik's avatar
Tim Janik committed
848 849 850
  g_return_if_fail (entries != NULL);

  for (i = 0; i < n_entries; i++)
851
    gtk_item_factory_create_item (ifactory, entries + i, callback_data, callback_type);
Tim Janik's avatar
Tim Janik committed
852 853 854
}

GtkWidget*
855 856
gtk_item_factory_get_widget (GtkItemFactory *ifactory,
			     const gchar    *path)
Tim Janik's avatar
Tim Janik committed
857 858 859 860 861 862 863
{
  GtkItemFactoryClass *class;
  GtkItemFactoryItem *item;

  g_return_val_if_fail (GTK_IS_ITEM_FACTORY (ifactory), NULL);
  g_return_val_if_fail (path != NULL, NULL);

864
  class = GTK_ITEM_FACTORY_GET_CLASS (ifactory);
Tim Janik's avatar
Tim Janik committed
865

866 867 868 869 870 871 872 873 874 875
  if (path[0] == '<')
    item = g_hash_table_lookup (class->item_ht, (gpointer) path);
  else
    {
      gchar *fpath;

      fpath = g_strconcat (ifactory->path, path, NULL);
      item = g_hash_table_lookup (class->item_ht, fpath);
      g_free (fpath);
    }
Tim Janik's avatar
Tim Janik committed
876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891

  if (item)
    {
      GSList *slist;

      for (slist = item->widgets; slist; slist = slist->next)
	{
	  if (gtk_item_factory_from_widget (slist->data) == ifactory)
	    return slist->data;
	}
    }

  return NULL;
}

GtkWidget*
892 893
gtk_item_factory_get_widget_by_action (GtkItemFactory *ifactory,
				       guint	       action)
Tim Janik's avatar
Tim Janik committed
894 895 896 897 898
{
  GSList *slist;

  g_return_val_if_fail (GTK_IS_ITEM_FACTORY (ifactory), NULL);

899
  for (slist = ifactory->items; slist; slist = slist->next)
Tim Janik's avatar
Tim Janik committed
900
    {
901 902
      GtkItemFactoryItem *item = slist->data;
      GSList *link;
Tim Janik's avatar
Tim Janik committed
903

904 905 906 907
      for (link = item->widgets; link; link = link->next)
	if (gtk_object_get_data_by_id (link->data, quark_item_factory) == ifactory &&
	    gtk_object_get_data_by_id (link->data, quark_action) == GUINT_TO_POINTER (action))
	  return link->data;
Tim Janik's avatar
Tim Janik committed
908 909 910 911 912
    }

  return NULL;
}

913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945
GtkWidget*
gtk_item_factory_get_item (GtkItemFactory *ifactory,
			   const gchar    *path)
{
  GtkWidget *widget;

  g_return_val_if_fail (GTK_IS_ITEM_FACTORY (ifactory), NULL);
  g_return_val_if_fail (path != NULL, NULL);

  widget = gtk_item_factory_get_widget (ifactory, path);

  if (GTK_IS_MENU (widget))
    widget = gtk_menu_get_attach_widget (GTK_MENU (widget));

  return GTK_IS_ITEM (widget) ? widget : NULL;
}

GtkWidget*
gtk_item_factory_get_item_by_action (GtkItemFactory *ifactory,
				     guint	     action)
{
  GtkWidget *widget;

  g_return_val_if_fail (GTK_IS_ITEM_FACTORY (ifactory), NULL);

  widget = gtk_item_factory_get_widget_by_action (ifactory, action);

  if (GTK_IS_MENU (widget))
    widget = gtk_menu_get_attach_widget (GTK_MENU (widget));

  return GTK_IS_ITEM (widget) ? widget : NULL;
}

946
static gboolean
947 948 949 950 951
gtk_item_factory_parse_path (GtkItemFactory *ifactory,
			     gchar          *str,
			     gchar         **path,
			     gchar         **parent_path,
			     gchar         **item)
952
{
953
  gchar *translation;
954 955 956 957
  gchar *p, *q;

  *path = g_strdup (str);

Owen Taylor's avatar
Owen Taylor committed
958
  /* FIXME: This does not handle __ correctly !!! */
959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978
  p = q = *path;
  while (*p)
    {
      if (*p != '_')
	{
	  *q++ = *p;
	}
      p++;
    }
  *q = 0;

  *parent_path = g_strdup (*path);
  p = strrchr (*parent_path, '/');
  if (!p)
    {
      g_warning ("GtkItemFactory: invalid entry path `%s'", str);
      return FALSE;
    }
  *p = 0;

979 980 981 982 983 984
  if (ifactory->translate_func)
    translation = ifactory->translate_func (str, ifactory->translate_data);
  else
    translation = str;
			      
  p = strrchr (translation, '/');
985 986 987 988
  if (p)
    p++;
  else
    p = translation;
989 990 991 992 993 994

  *item = g_strdup (p);

  return TRUE;
}

Tim Janik's avatar
Tim Janik committed
995 996 997
void
gtk_item_factory_create_item (GtkItemFactory	     *ifactory,
			      GtkItemFactoryEntry    *entry,
998 999
			      gpointer		      callback_data,
			      guint		      callback_type)
Tim Janik's avatar
Tim Janik committed
1000
{
1001
  GtkOptionMenu *option_menu = NULL;
Tim Janik's avatar
Tim Janik committed
1002 1003 1004
  GtkWidget *parent;
  GtkWidget *widget;
  GSList *radio_group;
1005
  gchar *name;
Tim Janik's avatar
Tim Janik committed
1006
  gchar *parent_path;
1007 1008
  gchar *path;
  guint accel_key;
Tim Janik's avatar
Tim Janik committed
1009 1010
  guint type_id;
  GtkType type;
1011
  gchar *item_type_path;
Tim Janik's avatar
Tim Janik committed
1012 1013 1014 1015 1016

  g_return_if_fail (ifactory != NULL);
  g_return_if_fail (GTK_IS_ITEM_FACTORY (ifactory));
  g_return_if_fail (entry != NULL);
  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);
Tim Janik's avatar
Tim Janik committed
1019 1020

  if (!entry->item_type ||
1021 1022
      entry->item_type[0] == 0)
    {
1023
      item_type_path = "<Item>";
1024
      type_id = quark_type_item;
1025
    }
Tim Janik's avatar
Tim Janik committed
1026
  else
1027 1028 1029 1030
    {
      item_type_path = entry->item_type;
      type_id = gtk_object_data_try_key (item_type_path);
    }
Tim Janik's avatar
Tim Janik committed
1031 1032

  radio_group = NULL;
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 1042
  else if (type_id == quark_type_tearoff_item)
    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;
Tim Janik's avatar
Tim Janik committed
1051 1052 1053 1054
  else
    {
      GtkWidget *radio_link;

1055
      radio_link = gtk_item_factory_get_widget (ifactory, item_type_path);
Tim Janik's avatar
Tim Janik committed
1056 1057
      if (radio_link && GTK_IS_RADIO_MENU_ITEM (radio_link))
	{
1058
	  type = GTK_TYPE_RADIO_MENU_ITEM;
Tim Janik's avatar
Tim Janik committed
1059 1060 1061 1062 1063 1064
	  radio_group = gtk_radio_menu_item_group (GTK_RADIO_MENU_ITEM (radio_link));
	}
      else
	{
	  g_warning ("GtkItemFactory: entry path `%s' has invalid type `%s'",
		     entry->path,
1065
		     item_type_path);
Tim Janik's avatar
Tim Janik committed
1066 1067 1068 1069
	  return;
	}
    }

1070
  if (!gtk_item_factory_parse_path (ifactory, entry->path, 
1071 1072
				    &path, &parent_path, &name))
    return;
1073

Tim Janik's avatar
Tim Janik committed
1074 1075 1076 1077
  parent = gtk_item_factory_get_widget (ifactory, parent_path);
  if (!parent)
    {
      GtkItemFactoryEntry pentry;
1078
      gchar *ppath, *p;
Tim Janik's avatar
Tim Janik committed
1079

1080 1081 1082 1083 1084
      ppath = g_strdup (entry->path);
      p = strrchr (ppath, '/');
      g_return_if_fail (p != NULL);
      *p = 0;
      pentry.path = ppath;
Tim Janik's avatar
Tim Janik committed
1085 1086 1087 1088 1089
      pentry.accelerator = NULL;
      pentry.callback = NULL;
      pentry.callback_action = 0;
      pentry.item_type = "<Branch>";

1090
      gtk_item_factory_create_item (ifactory, &pentry, NULL, 1);
1091
      g_free (ppath);
Tim Janik's avatar
Tim Janik committed
1092 1093

      parent = gtk_item_factory_get_widget (ifactory, parent_path);
1094
      g_return_if_fail (parent != NULL);
Tim Janik's avatar
Tim Janik committed
1095 1096 1097
    }
  g_free (parent_path);

1098 1099 1100 1101 1102 1103 1104 1105
  if (GTK_IS_OPTION_MENU (parent))
    {
      option_menu = GTK_OPTION_MENU (parent);
      if (!option_menu->menu)
	gtk_option_menu_set_menu (option_menu, gtk_widget_new (GTK_TYPE_MENU, NULL));
      parent = option_menu->menu;
    }
			      
1106
  g_return_if_fail (GTK_IS_CONTAINER (parent));
1107

Tim Janik's avatar
Tim Janik committed
1108 1109
  widget = gtk_widget_new (type,
			   "GtkWidget::visible", TRUE,
1110 1111
			   "GtkWidget::sensitive", (type_id != quark_type_separator_item &&
						    type_id != quark_type_title),
Tim Janik's avatar
Tim Janik committed
1112 1113
			   "GtkWidget::parent", parent,
			   NULL);
1114 1115
  if (option_menu && !option_menu->menu_item)
    gtk_option_menu_set_history (option_menu, 0);
Tim Janik's avatar
Tim Janik committed
1116

1117
  if (type == GTK_TYPE_RADIO_MENU_ITEM)
Tim Janik's avatar
Tim Janik committed
1118 1119 1120
    gtk_radio_menu_item_set_group (GTK_RADIO_MENU_ITEM (widget), radio_group);
  if (GTK_IS_CHECK_MENU_ITEM (widget))
    gtk_check_menu_item_set_show_toggle (GTK_CHECK_MENU_ITEM (widget), TRUE);
1121 1122 1123 1124 1125

  /* install underline accelerators for this item
   */
  if (type_id != quark_type_separator_item && 
      type_id != quark_type_tearoff_item &&
1126
      *name)
Tim Janik's avatar
Tim Janik committed
1127 1128
    {
      GtkWidget *label;
1129 1130 1131 1132 1133 1134 1135 1136
      
      label = gtk_widget_new (GTK_TYPE_ACCEL_LABEL,
			      "GtkWidget::visible", TRUE,
			      "GtkWidget::parent", widget,
			      "GtkAccelLabel::accel_widget", widget,
			      "GtkMisc::xalign", 0.0,
			      NULL);
      
1137
      accel_key = gtk_label_parse_uline (GTK_LABEL (label), name);
1138 1139
      
      if (accel_key != GDK_VoidSymbol)
1140
	{
1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153
	  if (GTK_IS_MENU_BAR (parent))
	    gtk_widget_add_accelerator (widget,
					"activate_item",
					ifactory->accel_group,
					accel_key, GDK_MOD1_MASK,
					GTK_ACCEL_LOCKED);

	  if (GTK_IS_MENU (parent))
	    gtk_widget_add_accelerator (widget,
					"activate_item",
					gtk_menu_ensure_uline_accel_group (GTK_MENU (parent)),
					accel_key, 0,
					GTK_ACCEL_LOCKED);
1154
	}
Tim Janik's avatar
Tim Janik committed
1155
    }
1156
  
1157
  g_free (name);
1158
  
1159 1160
  if (type_id == quark_type_branch ||
      type_id == quark_type_last_branch)
Tim Janik's avatar
Tim Janik committed
1161
    {
1162 1163 1164
      if (entry->callback)
	g_warning ("gtk_item_factory_create_item(): Can't specify a callback on a branch: \"%s\"",
		   entry->path);
1165
      
1166
      if (type_id == quark_type_last_branch)
Tim Janik's avatar
Tim Janik committed
1167
	gtk_menu_item_right_justify (GTK_MENU_ITEM (widget));
1168
      
Tim Janik's avatar
Tim Janik committed
1169
      parent = widget;
1170 1171
      widget = gtk_widget_new (GTK_TYPE_MENU,
			       NULL);
1172
      
Tim Janik's avatar
Tim Janik committed
1173 1174 1175 1176
      gtk_menu_item_set_submenu (GTK_MENU_ITEM (parent), widget);
    }	   
  
  gtk_item_factory_add_item (ifactory,
1177
			     path, entry->accelerator,
1178
			     (type_id == quark_type_branch ||
1179 1180
			      type_id == quark_type_last_branch) ?
			      (GtkItemFactoryCallback) NULL : entry->callback,