gtkitemfactory.c 44.3 KB
Newer Older
Tim Janik's avatar
Tim Janik committed
1 2 3 4 5 6 7
/* 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
8
 * modify it under the terms of the GNU Lesser General Public
Tim Janik's avatar
Tim Janik committed
9 10 11 12 13 14
 * 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
15
 * Lesser General Public License for more details.
Tim Janik's avatar
Tim Janik committed
16
 *
17
 * You should have received a copy of the GNU Lesser General Public
Tim Janik's avatar
Tim Janik committed
18 19 20 21
 * 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
 * Modified by the GTK+ Team and others 1997-2000.  See the AUTHORS
25 26 27 28 29
 * 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/gtkimagemenuitem.h"
41
#include	"gtk/gtktearoffmenuitem.h"
Tim Janik's avatar
Tim Janik committed
42
#include	"gtk/gtkaccellabel.h"
43
#include        "gdk/gdkkeysyms.h"
44 45 46
#include	"gtk/gtkimage.h"
#include	"gtk/gtkstock.h"
#include	"gtk/gtkiconfactory.h"
Tim Janik's avatar
Tim Janik committed
47 48 49
#include	<string.h>
#include	<sys/stat.h>
#include	<fcntl.h>
50
#ifdef HAVE_UNISTD_H
Tim Janik's avatar
Tim Janik committed
51
#include	<unistd.h>
52
#endif
53
#include	<stdio.h>
Tim Janik's avatar
Tim Janik committed
54

Manish Singh's avatar
Manish Singh committed
55
#ifdef G_OS_WIN32
56 57 58 59 60 61
#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
62 63 64 65 66 67 68 69 70


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


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


/* --- 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);
92
static void	gtk_item_factory_finalize		(GObject	      *object);
Tim Janik's avatar
Tim Janik committed
93 94 95 96


/* --- static variables --- */
static GtkItemFactoryClass *gtk_item_factory_class = NULL;
97
static gpointer          parent_class = NULL;
Tim Janik's avatar
Tim Janik committed
98 99 100
static const gchar	*item_factory_string = "Gtk-<ItemFactory>";
static GMemChunk	*ifactory_item_chunks = NULL;
static GMemChunk	*ifactory_cb_data_chunks = NULL;
101 102 103
static GQuark		 quark_popup_data = 0;
static GQuark		 quark_if_menu_pos = 0;
static GQuark		 quark_item_factory = 0;
104 105 106
static GQuark		 quark_item_path = 0;
static GQuark		 quark_action = 0;
static GQuark		 quark_accel_group = 0;
107 108 109 110 111
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;
112 113
static GQuark		 quark_type_image_item = 0;
static GQuark		 quark_type_stock_item = 0;
114
static GQuark		 quark_type_tearoff_item = 0;
115 116 117
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
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 163 164 165 166 167 168
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)
    {
169
      static const GtkTypeInfo item_factory_info =
Tim Janik's avatar
Tim Janik committed
170 171 172 173 174 175
      {
	"GtkItemFactory",
	sizeof (GtkItemFactory),
	sizeof (GtkItemFactoryClass),
	(GtkClassInitFunc) gtk_item_factory_class_init,
	(GtkObjectInitFunc) gtk_item_factory_init,
176 177
	/* reserved_1 */ NULL,
	/* reserved_2 */ NULL,
178
        (GtkClassInitFunc) NULL,
Tim Janik's avatar
Tim Janik committed
179 180
      };
      
181
      item_factory_type = gtk_type_unique (GTK_TYPE_OBJECT, &item_factory_info);
Tim Janik's avatar
Tim Janik committed
182 183 184 185 186 187 188 189
    }
  
  return item_factory_type;
}

static void
gtk_item_factory_class_init (GtkItemFactoryClass  *class)
{
190
  GObjectClass *gobject_class = G_OBJECT_CLASS (class);
Tim Janik's avatar
Tim Janik committed
191 192 193 194
  GtkObjectClass *object_class;

  gtk_item_factory_class = class;

195
  parent_class = gtk_type_class (GTK_TYPE_OBJECT);
Tim Janik's avatar
Tim Janik committed
196 197 198

  object_class = (GtkObjectClass*) class;

199 200
  gobject_class->finalize = gtk_item_factory_finalize;

Tim Janik's avatar
Tim Janik committed
201 202 203 204 205
  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);
206
  class->dummy = NULL;
Tim Janik's avatar
Tim Janik committed
207 208 209 210 211 212 213 214 215 216 217
  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);

218 219 220 221 222 223 224 225 226 227 228
  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>");
229 230
  quark_type_image_item         = g_quark_from_static_string ("<ImageItem>");
  quark_type_stock_item         = g_quark_from_static_string ("<StockItem>");
231
  quark_type_separator_item	= g_quark_from_static_string ("<Separator>");
232
  quark_type_tearoff_item	= g_quark_from_static_string ("<Tearoff>");
233 234
  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
235 236 237 238 239 240 241 242 243 244 245 246
}

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

  object = GTK_OBJECT (ifactory);

  ifactory->path = NULL;
  ifactory->accel_group = NULL;
  ifactory->widget = NULL;
247
  ifactory->items = NULL;
248 249 250
  ifactory->translate_func = NULL;
  ifactory->translate_data = NULL;
  ifactory->translate_notify = NULL;
Tim Janik's avatar
Tim Janik committed
251 252 253 254 255 256 257 258 259 260 261
}

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

  g_return_val_if_fail (path != NULL, NULL);

262
  ifactory = gtk_type_new (GTK_TYPE_ITEM_FACTORY);
Tim Janik's avatar
Tim Janik committed
263 264 265 266 267 268 269 270 271 272 273 274 275
  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;

276 277
  if (data->callback_type == 1)
    {
278
      GtkItemFactoryCallback1 func1 = (GtkItemFactoryCallback1) data->func;
279 280 281 282
      func1 (data->func_data, data->callback_action, widget);
    }
  else if (data->callback_type == 2)
    {
283
      GtkItemFactoryCallback2 func2 = (GtkItemFactoryCallback2) data->func;
284 285
      func2 (widget, data->func_data, data->callback_action);
    }
Tim Janik's avatar
Tim Janik committed
286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316
}

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;
317 318
      GtkAccelGroup *accel_group;
      guint signal_id;
Tim Janik's avatar
Tim Janik committed
319 320 321
      
      widget = slist->data;
      
322
      accel_group = gtk_object_get_data_by_id (GTK_OBJECT (widget), quark_accel_group);
Tim Janik's avatar
Tim Janik committed
323
      
324 325
      signal_id = gtk_signal_lookup ("activate", GTK_OBJECT_TYPE (widget));
      if (signal_id && accel_group)
Tim Janik's avatar
Tim Janik committed
326
	{
327 328 329 330 331 332 333 334
	  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
335
	    {
336 337
	      GSList *work;
	      
338
	      work = gtk_accel_group_entries_from_object (G_OBJECT (widget));
339
	      while (work)
Tim Janik's avatar
Tim Janik committed
340
		{
341
		  GtkAccelEntry *ac_entry;
Tim Janik's avatar
Tim Janik committed
342
		  
343 344 345 346 347 348 349 350 351
		  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
352 353 354
		}
	    }
	}
355

Tim Janik's avatar
Tim Janik committed
356 357
      gtk_widget_unref (widget);
    }
358
  
Tim Janik's avatar
Tim Janik committed
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 404 405 406 407 408 409 410 411
  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);
412
  gtk_object_remove_data_by_id (GTK_OBJECT (widget), quark_item_factory);
413
  gtk_object_remove_data_by_id (GTK_OBJECT (widget), quark_item_path);
Tim Janik's avatar
Tim Janik committed
414 415
}

416 417 418 419 420 421
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
422 423 424 425
{
  GtkItemFactoryClass *class;
  GtkItemFactoryItem *item;

426 427
  g_return_if_fail (GTK_IS_WIDGET (accel_widget));
  g_return_if_fail (full_path != NULL);
Tim Janik's avatar
Tim Janik committed
428

429
  class = gtk_type_class (GTK_TYPE_ITEM_FACTORY);
Tim Janik's avatar
Tim Janik committed
430

431 432 433
  keyval = keyval != GDK_VoidSymbol ? keyval : 0;

  item = g_hash_table_lookup (class->item_ht, full_path);
Tim Janik's avatar
Tim Janik committed
434 435 436 437
  if (!item)
    {
      item = g_chunk_new (GtkItemFactoryItem, ifactory_item_chunks);

438
      item->path = g_strdup (full_path);
Tim Janik's avatar
Tim Janik committed
439
      item->accelerator_key = keyval;
440
      item->accelerator_mods = modifiers;
Tim Janik's avatar
Tim Janik committed
441 442
      item->modified = FALSE;
      item->in_propagation = FALSE;
443
      item->dummy = NULL;
Tim Janik's avatar
Tim Janik committed
444 445 446 447 448
      item->widgets = NULL;
      
      g_hash_table_insert (class->item_ht, item->path, item);
    }

449 450
  item->widgets = g_slist_prepend (item->widgets, accel_widget);
  gtk_signal_connect (GTK_OBJECT (accel_widget),
Tim Janik's avatar
Tim Janik committed
451 452 453 454
		      "destroy",
		      GTK_SIGNAL_FUNC (gtk_item_factory_item_remove_widget),
		      item);

455
  /* set the item path for the widget
Tim Janik's avatar
Tim Janik committed
456
   */
457 458 459 460 461 462 463 464 465 466 467 468
  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
469 470 471

  /* install defined accelerators
   */
472
  if (gtk_signal_lookup ("activate", GTK_OBJECT_TYPE (accel_widget)))
Tim Janik's avatar
Tim Janik committed
473
    {
474 475
      if (item->accelerator_key && accel_group)
	gtk_widget_add_accelerator (accel_widget,
Tim Janik's avatar
Tim Janik committed
476
				    "activate",
477
				    accel_group,
Tim Janik's avatar
Tim Janik committed
478 479 480 481
				    item->accelerator_key,
				    item->accelerator_mods,
				    GTK_ACCEL_VISIBLE);
      else
482
	gtk_widget_remove_accelerators (accel_widget,
Tim Janik's avatar
Tim Janik committed
483 484 485 486 487 488
					"activate",
					TRUE);
    }

  /* keep track of accelerator changes
   */
489
  gtk_signal_connect_after (GTK_OBJECT (accel_widget),
Tim Janik's avatar
Tim Janik committed
490 491 492
			    "add-accelerator",
			    GTK_SIGNAL_FUNC (gtk_item_factory_item_add_accelerator),
			    item);
493
  gtk_signal_connect_after (GTK_OBJECT (accel_widget),
Tim Janik's avatar
Tim Janik committed
494 495 496
			    "remove-accelerator",
			    GTK_SIGNAL_FUNC (gtk_item_factory_item_remove_accelerator),
			    item);
497
}
Tim Janik's avatar
Tim Janik committed
498

499 500 501 502 503
static void
ifactory_cb_data_free (gpointer mem)
{
  g_mem_chunk_free (ifactory_cb_data_chunks, mem);
}
Tim Janik's avatar
Tim Janik committed
504

505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523
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);

524
  class = GTK_ITEM_FACTORY_GET_CLASS (ifactory);
525 526 527 528 529

  /* 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
530 531 532 533 534 535 536 537 538

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

      data = g_chunk_new (GtkIFCBData, ifactory_cb_data_chunks);
      data->func = callback;
539
      data->callback_type = callback_type;
Tim Janik's avatar
Tim Janik committed
540 541 542 543 544 545 546 547 548 549 550
      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);
    }
551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572

  /* 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
573 574 575 576 577 578 579 580 581 582 583 584 585
}

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

  g_return_if_fail (GTK_IS_ITEM_FACTORY (ifactory));
  g_return_if_fail (ifactory->accel_group == NULL);
  g_return_if_fail (path != NULL);
586 587
  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
588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605

  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);
Tim Janik's avatar
Tim Janik committed
606 607 608
  ifactory->widget = g_object_connect (gtk_widget_new (container_type, NULL),
				       "signal::destroy", gtk_widget_destroyed, &ifactory->widget,
				       NULL);
Tim Janik's avatar
Tim Janik committed
609 610
  gtk_object_ref (GTK_OBJECT (ifactory));
  gtk_object_sink (GTK_OBJECT (ifactory));
611

Tim Janik's avatar
Tim Janik committed
612 613
  gtk_item_factory_add_item (ifactory,
			     "", NULL,
614
			     NULL, 0, NULL, 0,
Tim Janik's avatar
Tim Janik committed
615 616 617 618
			     ITEM_FACTORY_STRING,
			     ifactory->widget);
}

619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645
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);
646 647 648

  g_free (fname);

649 650 651 652 653 654
  if (item && item->widgets)
    return gtk_item_factory_from_widget (item->widgets->data);

  return NULL;
}

Tim Janik's avatar
Tim Janik committed
655
static void
Tim Janik's avatar
Tim Janik committed
656
gtk_item_factory_destroy (GtkObject *object)
Tim Janik's avatar
Tim Janik committed
657 658 659 660 661 662 663 664 665 666
{
  GtkItemFactory *ifactory;
  GSList *slist;

  g_return_if_fail (GTK_IS_ITEM_FACTORY (object));

  ifactory = (GtkItemFactory*) object;

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

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

Tim Janik's avatar
Tim Janik committed
671 672 673 674
      gtk_object_ref (dobj);
      gtk_object_sink (dobj);
      gtk_object_destroy (dobj);
      gtk_object_unref (dobj);
Tim Janik's avatar
Tim Janik committed
675 676 677 678

      ifactory->widget = NULL;
    }

679 680 681 682 683 684
  for (slist = ifactory->items; slist; slist = slist->next)
    {
      GtkItemFactoryItem *item = slist->data;
      GSList *link;
      
      for (link = item->widgets; link; link = link->next)
685
	if (gtk_object_get_data_by_id (link->data, quark_item_factory) == ifactory)
686 687 688 689
	  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
690

691
  GTK_OBJECT_CLASS (parent_class)->destroy (object);
Tim Janik's avatar
Tim Janik committed
692 693 694
}

static void
695
gtk_item_factory_finalize (GObject *object)
Tim Janik's avatar
Tim Janik committed
696 697 698 699 700 701 702 703 704 705 706
{
  GtkItemFactory *ifactory;

  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);

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

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

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

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

726
  return gtk_object_get_data_by_id (GTK_OBJECT (widget), quark_item_path);
Tim Janik's avatar
Tim Janik committed
727 728
}

729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759
static gchar *
item_factory_escape_path (const gchar *path)
{
  GString *str = g_string_new (NULL);

  while (*path)
    {
      gchar c = *path;

      switch (c)
	{
	case '\n':
	  g_string_append (str, "\\n");
	  break;
	case '\r':
	  g_string_append (str, "\\r");
	  break;
	case '"':
	case '\\':
	  g_string_append_c (str, '\\');
	  /* Fall through */
	default:
	  g_string_append_c (str, c);
	}
      
      path++;
    }

  return g_string_free (str, FALSE);
}

Tim Janik's avatar
Tim Janik committed
760 761 762 763 764 765
static void
gtk_item_factory_foreach (gpointer hash_key,
			  gpointer value,
			  gpointer user_data)
{
  GtkItemFactoryItem *item;
766
  GtkIFDumpData *data;
Tim Janik's avatar
Tim Janik committed
767
  gchar *string;
768
  gchar *path;
Tim Janik's avatar
Tim Janik committed
769 770 771 772 773 774
  gchar *name;
  gchar comment_prefix[2] = "\000\000";

  item = value;
  data = user_data;

775
  if (data->pspec && !g_pattern_match_string (data->pspec, item->path))
Tim Janik's avatar
Tim Janik committed
776 777 778 779
    return;

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

780
  path = item_factory_escape_path (hash_key);
Tim Janik's avatar
Tim Janik committed
781 782 783
  name = gtk_accelerator_name (item->accelerator_key, item->accelerator_mods);
  string = g_strconcat (item->modified ? "" : comment_prefix,
			"(menu-path \"",
784
			path,
Tim Janik's avatar
Tim Janik committed
785 786 787 788
			"\" \"",
			name,
			"\")",
			NULL);
789
  g_free (path);
Tim Janik's avatar
Tim Janik committed
790 791 792 793 794 795 796 797
  g_free (name);

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

  g_free (string);
}

void
798
gtk_item_factory_dump_items (GPatternSpec	 *path_pspec,
799 800 801
			     gboolean		  modified_only,
			     GtkPrintFunc	  print_func,
			     gpointer		  func_data)
Tim Janik's avatar
Tim Janik committed
802
{
803
  GtkIFDumpData data;
Tim Janik's avatar
Tim Janik committed
804 805 806 807 808 809 810 811 812

  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);
813
  data.pspec = path_pspec;
Tim Janik's avatar
Tim Janik committed
814 815 816 817

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

818
void
819 820
gtk_item_factory_print_func (gpointer     FILE_pointer,
			     const gchar *string)
821 822 823 824 825 826 827 828 829 830 831
{
  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
832 833 834
gtk_item_factory_dump_rc (const gchar  *file_name,
			  GPatternSpec *path_pspec,
			  gboolean      modified_only)
835 836 837 838 839 840 841 842 843 844
{
  FILE *f_out;

  g_return_if_fail (file_name != NULL);

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

  fputs ("; ", f_out);
845 846
  if (g_get_prgname ())
    fputs (g_get_prgname (), f_out);
847 848 849 850 851 852 853 854 855 856 857 858
  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
859
void
860 861 862 863
gtk_item_factory_create_items (GtkItemFactory	   *ifactory,
			       guint		    n_entries,
			       GtkItemFactoryEntry *entries,
			       gpointer		    callback_data)
864 865 866 867 868
{
  gtk_item_factory_create_items_ac (ifactory, n_entries, entries, callback_data, 1);
}

void
869 870 871 872 873
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
874 875 876 877
{
  guint i;

  g_return_if_fail (GTK_IS_ITEM_FACTORY (ifactory));
878 879 880 881 882
  g_return_if_fail (callback_type >= 1 && callback_type <= 2);

  if (n_entries == 0)
    return;

Tim Janik's avatar
Tim Janik committed
883 884 885
  g_return_if_fail (entries != NULL);

  for (i = 0; i < n_entries; i++)
886
    gtk_item_factory_create_item (ifactory, entries + i, callback_data, callback_type);
Tim Janik's avatar
Tim Janik committed
887 888 889
}

GtkWidget*
890 891
gtk_item_factory_get_widget (GtkItemFactory *ifactory,
			     const gchar    *path)
Tim Janik's avatar
Tim Janik committed
892 893 894 895 896 897 898
{
  GtkItemFactoryClass *class;
  GtkItemFactoryItem *item;

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

899
  class = GTK_ITEM_FACTORY_GET_CLASS (ifactory);
Tim Janik's avatar
Tim Janik committed
900

901 902 903 904 905 906 907 908 909 910
  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
911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926

  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*
927 928
gtk_item_factory_get_widget_by_action (GtkItemFactory *ifactory,
				       guint	       action)
Tim Janik's avatar
Tim Janik committed
929 930 931 932 933
{
  GSList *slist;

  g_return_val_if_fail (GTK_IS_ITEM_FACTORY (ifactory), NULL);

934
  for (slist = ifactory->items; slist; slist = slist->next)
Tim Janik's avatar
Tim Janik committed
935
    {
936 937
      GtkItemFactoryItem *item = slist->data;
      GSList *link;
Tim Janik's avatar
Tim Janik committed
938

939 940 941 942
      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
943 944 945 946 947
    }

  return NULL;
}

948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980
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;
}

981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034
static char *
item_factory_find_separator_r (char *path)
{
  gchar *result = NULL;
  gboolean escaped = FALSE;

  while (*path)
    {
      if (escaped)
	escaped = FALSE;
      else
	{
	  if (*path == '\\')
	    escaped = TRUE;
	  else if (*path == '/')
	    result = path;
	}
      
      path++;
    }

  return result;
}

static char *
item_factory_unescape_label (const char *label)
{
  char *new = g_malloc (strlen (label) + 1);
  char *p = new;
  gboolean escaped = FALSE;
  
  while (*label)
    {
      if (escaped)
	{
	  *p++ = *label;
	  escaped = FALSE;
	}
      else
	{
	  if (*label == '\\')
	    escaped = TRUE;
	  else
	    *p++ = *label;
	}
      
      label++;
    }

  *p = '\0';

  return new;
}

1035
static gboolean
1036 1037 1038 1039 1040
gtk_item_factory_parse_path (GtkItemFactory *ifactory,
			     gchar          *str,
			     gchar         **path,
			     gchar         **parent_path,
			     gchar         **item)
1041
{
1042
  gchar *translation;
1043
  gchar *p, *q;
1044
  
1045 1046 1047 1048 1049
  *path = g_strdup (str);

  p = q = *path;
  while (*p)
    {
1050 1051 1052 1053 1054 1055 1056 1057 1058
      if (*p == '_')
	{
	  if (p[1] == '_')
	    {
	      p++;
	      *q++ = '_';
	    }
	}
      else
1059 1060 1061 1062 1063 1064 1065 1066
	{
	  *q++ = *p;
	}
      p++;
    }
  *q = 0;

  *parent_path = g_strdup (*path);
1067
  p = item_factory_find_separator_r (*parent_path);
1068 1069 1070 1071 1072 1073 1074
  if (!p)
    {
      g_warning ("GtkItemFactory: invalid entry path `%s'", str);
      return FALSE;
    }
  *p = 0;

1075 1076 1077 1078 1079
  if (ifactory->translate_func)
    translation = ifactory->translate_func (str, ifactory->translate_data);
  else
    translation = str;
			      
1080
  p = item_factory_find_separator_r (translation);
1081 1082 1083 1084
  if (p)
    p++;
  else
    p = translation;
1085

1086
  *item = item_factory_unescape_label (p);
1087 1088 1089 1090

  return TRUE;
}

Tim Janik's avatar
Tim Janik committed
1091 1092 1093
void
gtk_item_factory_create_item (GtkItemFactory	     *ifactory,
			      GtkItemFactoryEntry    *entry,
1094 1095
			      gpointer		      callback_data,
			      guint		      callback_type)
Tim Janik's avatar
Tim Janik committed
1096
{
1097
  GtkOptionMenu *option_menu = NULL;
Tim Janik's avatar
Tim Janik committed
1098 1099
  GtkWidget *parent;
  GtkWidget *widget;
1100
  GtkWidget *image;
Tim Janik's avatar
Tim Janik committed
1101
  GSList *radio_group;
1102
  gchar *name;
Tim Janik's avatar
Tim Janik committed
1103
  gchar *parent_path;
1104
  gchar *path;
1105
  gchar *accelerator;
Tim Janik's avatar
Tim Janik committed
1106 1107
  guint type_id;
  GtkType type;
1108
  gchar *item_type_path;
1109 1110
  GtkStockItem stock_item;
      
Tim Janik's avatar
Tim Janik committed
1111 1112 1113
  g_return_if_fail (GTK_IS_ITEM_FACTORY (ifactory));
  g_return_if_fail (entry != NULL);
  g_return_if_fail (entry->path != NULL);
1114
  g_return_if_fail (entry->path[0] == '/');
1115
  g_return_if_fail (callback_type >= 1 && callback_type <= 2);
Tim Janik's avatar
Tim Janik committed
1116 1117

  if (!entry->item_type ||
1118 1119
      entry->item_type[0] == 0)
    {
1120
      item_type_path = "<Item>";
1121
      type_id = quark_type_item;
1122
    }
Tim Janik's avatar
Tim Janik committed
1123
  else
1124 1125 1126 1127
    {
      item_type_path = entry->item_type;
      type_id = gtk_object_data_try_key (item_type_path);
    }
Tim Janik's avatar
Tim Janik committed
1128 1129

  radio_group = NULL;
1130
  if (type_id == quark_type_item)
1131
    type = GTK_TYPE_MENU_ITEM;
1132
  else if (type_id == quark_type_title)
1133
    type = GTK_TYPE_MENU_ITEM;
1134
  else if (type_id == quark_type_radio_item)
1135
    type = GTK_TYPE_RADIO_MENU_ITEM;
1136
  else if (type_id == quark_type_check_item)
1137
    type = GTK_TYPE_CHECK_MENU_ITEM;
1138 1139 1140 1141
  else if (type_id == quark_type_image_item)
    type = GTK_TYPE_IMAGE_MENU_ITEM;
  else if (type_id == quark_type_stock_item)
    type = GTK_TYPE_IMAGE_MENU_ITEM;
1142 1143
  else if (type_id == quark_type_tearoff_item)
    type = GTK_TYPE_TEAROFF_MENU_ITEM;
1144
  else if (type_id == quark_type_toggle_item)
1145
    type = GTK_TYPE_CHECK_MENU_ITEM;
1146
  else if (type_id == quark_type_separator_item)
1147
    type = GTK_TYPE_MENU_ITEM;
1148
  else if (type_id == quark_type_branch)
1149
    type = GTK_TYPE_MENU_ITEM;
1150
  else if (type_id == quark_type_last_branch)
1151
    type = GTK_TYPE_MENU_ITEM;
Tim Janik's avatar
Tim Janik committed
1152 1153 1154 1155
  else
    {
      GtkWidget *radio_link;

1156
      radio_link = gtk_item_factory_get_widget (ifactory, item_type_path);
Tim Janik's avatar
Tim Janik committed
1157 1158
      if (radio_link && GTK_IS_RADIO_MENU_ITEM (radio_link))
	{
1159
	  type = GTK_TYPE_RADIO_MENU_ITEM;
Tim Janik's avatar
Tim Janik committed
1160 1161 1162 1163 1164 1165
	  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,
1166
		     item_type_path);
Tim Janik's avatar
Tim Janik committed
1167 1168 1169 1170
	  return;
	}
    }

1171
  if (!gtk_item_factory_parse_path (ifactory, entry->path, 
1172 1173
				    &path, &parent_path, &name))
    return;
1174

Tim Janik's avatar
Tim Janik committed
1175 1176 1177 1178
  parent = gtk_item_factory_get_widget (ifactory, parent_path);
  if (!parent)
    {
      GtkItemFactoryEntry pentry;
1179
      gchar *ppath, *p;
Tim Janik's avatar
Tim Janik committed
1180