gtkitemfactory.c 32.8 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"
42
#include	"gtk/gtkaccelmap.h"
Tim Janik's avatar
Tim Janik committed
43
#include	"gtk/gtkaccellabel.h"
44
#include        "gdk/gdkkeysyms.h"
45 46 47
#include	"gtk/gtkimage.h"
#include	"gtk/gtkstock.h"
#include	"gtk/gtkiconfactory.h"
Tim Janik's avatar
Tim Janik committed
48 49
#include	<string.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 81 82 83 84
};


/* --- 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);
85
static void	gtk_item_factory_finalize		(GObject	      *object);
Tim Janik's avatar
Tim Janik committed
86 87 88 89


/* --- static variables --- */
static GtkItemFactoryClass *gtk_item_factory_class = NULL;
90
static gpointer          parent_class = NULL;
Tim Janik's avatar
Tim Janik committed
91 92 93
static const gchar	*item_factory_string = "Gtk-<ItemFactory>";
static GMemChunk	*ifactory_item_chunks = NULL;
static GMemChunk	*ifactory_cb_data_chunks = NULL;
94 95 96
static GQuark		 quark_popup_data = 0;
static GQuark		 quark_if_menu_pos = 0;
static GQuark		 quark_item_factory = 0;
97 98 99
static GQuark		 quark_item_path = 0;
static GQuark		 quark_action = 0;
static GQuark		 quark_accel_group = 0;
100 101 102 103 104
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;
105 106
static GQuark		 quark_type_image_item = 0;
static GQuark		 quark_type_stock_item = 0;
107
static GQuark		 quark_type_tearoff_item = 0;
108 109 110
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
111 112 113 114 115 116 117 118 119 120


/* --- functions --- */
GtkType
gtk_item_factory_get_type (void)
{
  static GtkType item_factory_type = 0;
  
  if (!item_factory_type)
    {
121
      static const GtkTypeInfo item_factory_info =
Tim Janik's avatar
Tim Janik committed
122 123 124 125 126 127
      {
	"GtkItemFactory",
	sizeof (GtkItemFactory),
	sizeof (GtkItemFactoryClass),
	(GtkClassInitFunc) gtk_item_factory_class_init,
	(GtkObjectInitFunc) gtk_item_factory_init,
128 129
	/* reserved_1 */ NULL,
	/* reserved_2 */ NULL,
130
        (GtkClassInitFunc) NULL,
Tim Janik's avatar
Tim Janik committed
131 132
      };
      
133
      item_factory_type = gtk_type_unique (GTK_TYPE_OBJECT, &item_factory_info);
Tim Janik's avatar
Tim Janik committed
134 135 136 137 138 139 140 141
    }
  
  return item_factory_type;
}

static void
gtk_item_factory_class_init (GtkItemFactoryClass  *class)
{
142
  GObjectClass *gobject_class = G_OBJECT_CLASS (class);
143
  GtkObjectClass *object_class = GTK_OBJECT_CLASS (class);
Tim Janik's avatar
Tim Janik committed
144 145

  gtk_item_factory_class = class;
146
  parent_class = g_type_class_peek_parent (class);
Tim Janik's avatar
Tim Janik committed
147

148 149
  gobject_class->finalize = gtk_item_factory_finalize;

Tim Janik's avatar
Tim Janik committed
150 151 152 153 154 155 156 157 158 159 160 161 162 163
  object_class->destroy = gtk_item_factory_destroy;

  class->item_ht = g_hash_table_new (g_str_hash, g_str_equal);
  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);

164 165 166 167 168 169 170 171 172 173 174
  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>");
175 176
  quark_type_image_item         = g_quark_from_static_string ("<ImageItem>");
  quark_type_stock_item         = g_quark_from_static_string ("<StockItem>");
177
  quark_type_separator_item	= g_quark_from_static_string ("<Separator>");
178
  quark_type_tearoff_item	= g_quark_from_static_string ("<Tearoff>");
179 180
  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
181 182 183 184 185 186 187 188 189 190 191 192
}

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

  object = GTK_OBJECT (ifactory);

  ifactory->path = NULL;
  ifactory->accel_group = NULL;
  ifactory->widget = NULL;
193
  ifactory->items = NULL;
194 195 196
  ifactory->translate_func = NULL;
  ifactory->translate_data = NULL;
  ifactory->translate_notify = NULL;
Tim Janik's avatar
Tim Janik committed
197 198 199 200 201 202 203 204 205 206 207
}

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

  g_return_val_if_fail (path != NULL, NULL);

208
  ifactory = gtk_type_new (GTK_TYPE_ITEM_FACTORY);
Tim Janik's avatar
Tim Janik committed
209 210 211 212 213 214 215 216 217 218 219 220 221
  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;

222 223
  if (data->callback_type == 1)
    {
224
      GtkItemFactoryCallback1 func1 = (GtkItemFactoryCallback1) data->func;
225 226 227 228
      func1 (data->func_data, data->callback_action, widget);
    }
  else if (data->callback_type == 2)
    {
229
      GtkItemFactoryCallback2 func2 = (GtkItemFactoryCallback2) data->func;
230 231
      func2 (widget, data->func_data, data->callback_action);
    }
Tim Janik's avatar
Tim Janik committed
232 233 234 235 236 237 238
}

static void
gtk_item_factory_item_remove_widget (GtkWidget		*widget,
				     GtkItemFactoryItem *item)
{
  item->widgets = g_slist_remove (item->widgets, widget);
239
  gtk_object_remove_data_by_id (GTK_OBJECT (widget), quark_item_factory);
240
  gtk_object_remove_data_by_id (GTK_OBJECT (widget), quark_item_path);
Tim Janik's avatar
Tim Janik committed
241 242
}

243 244 245 246
void
gtk_item_factory_add_foreign (GtkWidget      *accel_widget,
			      const gchar    *full_path,
			      GtkAccelGroup  *accel_group,
247 248
			      guint           accel_key,
			      GdkModifierType accel_mods)
Tim Janik's avatar
Tim Janik committed
249 250 251 252
{
  GtkItemFactoryClass *class;
  GtkItemFactoryItem *item;

253 254
  g_return_if_fail (GTK_IS_WIDGET (accel_widget));
  g_return_if_fail (full_path != NULL);
Tim Janik's avatar
Tim Janik committed
255

256
  class = gtk_type_class (GTK_TYPE_ITEM_FACTORY);
Tim Janik's avatar
Tim Janik committed
257

258
  accel_key = accel_key != GDK_VoidSymbol ? accel_key : 0;
259 260

  item = g_hash_table_lookup (class->item_ht, full_path);
Tim Janik's avatar
Tim Janik committed
261 262 263 264
  if (!item)
    {
      item = g_chunk_new (GtkItemFactoryItem, ifactory_item_chunks);

265
      item->path = g_strdup (full_path);
Tim Janik's avatar
Tim Janik committed
266 267 268 269 270
      item->widgets = NULL;
      
      g_hash_table_insert (class->item_ht, item->path, item);
    }

271 272
  item->widgets = g_slist_prepend (item->widgets, accel_widget);
  gtk_signal_connect (GTK_OBJECT (accel_widget),
Tim Janik's avatar
Tim Janik committed
273 274 275 276
		      "destroy",
		      GTK_SIGNAL_FUNC (gtk_item_factory_item_remove_widget),
		      item);

277
  /* set the item path for the widget
Tim Janik's avatar
Tim Janik committed
278
   */
279 280 281 282 283 284 285 286 287 288 289 290
  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
291 292 293

  /* install defined accelerators
   */
294
  if (gtk_signal_lookup ("activate", GTK_OBJECT_TYPE (accel_widget)))
Tim Janik's avatar
Tim Janik committed
295
    {
296 297 298 299 300
      if (accel_key && accel_group)
	{
	  gtk_accel_map_add_entry (full_path, accel_key, accel_mods);
	  _gtk_widget_set_accel_path (accel_widget, full_path, accel_group);
	}
Tim Janik's avatar
Tim Janik committed
301
    }
302
}
Tim Janik's avatar
Tim Janik committed
303

304 305 306 307 308
static void
ifactory_cb_data_free (gpointer mem)
{
  g_mem_chunk_free (ifactory_cb_data_chunks, mem);
}
Tim Janik's avatar
Tim Janik committed
309

310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328
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);

329
  class = GTK_ITEM_FACTORY_GET_CLASS (ifactory);
330 331 332 333 334

  /* 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
335 336 337 338 339 340 341 342 343

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

      data = g_chunk_new (GtkIFCBData, ifactory_cb_data_chunks);
      data->func = callback;
344
      data->callback_type = callback_type;
Tim Janik's avatar
Tim Janik committed
345 346 347 348 349 350 351 352 353 354 355
      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);
    }
356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377

  /* 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
378 379 380 381 382 383 384 385 386 387 388 389 390
}

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);
391 392
  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
393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410

  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
411 412 413
  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
414 415
  gtk_object_ref (GTK_OBJECT (ifactory));
  gtk_object_sink (GTK_OBJECT (ifactory));
416

Tim Janik's avatar
Tim Janik committed
417 418
  gtk_item_factory_add_item (ifactory,
			     "", NULL,
419
			     NULL, 0, NULL, 0,
Tim Janik's avatar
Tim Janik committed
420 421 422 423
			     ITEM_FACTORY_STRING,
			     ifactory->widget);
}

424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450
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);
451 452 453

  g_free (fname);

454 455 456 457 458 459
  if (item && item->widgets)
    return gtk_item_factory_from_widget (item->widgets->data);

  return NULL;
}

Tim Janik's avatar
Tim Janik committed
460
static void
Tim Janik's avatar
Tim Janik committed
461
gtk_item_factory_destroy (GtkObject *object)
Tim Janik's avatar
Tim Janik committed
462 463 464 465 466 467 468 469 470 471
{
  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
472
      GtkObject *dobj;
Tim Janik's avatar
Tim Janik committed
473

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

Tim Janik's avatar
Tim Janik committed
476 477 478 479
      gtk_object_ref (dobj);
      gtk_object_sink (dobj);
      gtk_object_destroy (dobj);
      gtk_object_unref (dobj);
Tim Janik's avatar
Tim Janik committed
480 481 482 483

      ifactory->widget = NULL;
    }

484 485 486 487 488 489
  for (slist = ifactory->items; slist; slist = slist->next)
    {
      GtkItemFactoryItem *item = slist->data;
      GSList *link;
      
      for (link = item->widgets; link; link = link->next)
490
	if (gtk_object_get_data_by_id (link->data, quark_item_factory) == ifactory)
491 492 493 494
	  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
495

496
  GTK_OBJECT_CLASS (parent_class)->destroy (object);
Tim Janik's avatar
Tim Janik committed
497 498 499
}

static void
500
gtk_item_factory_finalize (GObject *object)
Tim Janik's avatar
Tim Janik committed
501 502 503 504 505 506 507 508 509 510 511
{
  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);

512
  if (ifactory->translate_notify)
513 514
    ifactory->translate_notify (ifactory->translate_data);
  
515
  G_OBJECT_CLASS (parent_class)->finalize (object);
Tim Janik's avatar
Tim Janik committed
516 517 518 519 520 521 522
}

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

523
  return gtk_object_get_data_by_id (GTK_OBJECT (widget), quark_item_factory);
Tim Janik's avatar
Tim Janik committed
524 525 526 527 528 529 530
}

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

531
  return gtk_object_get_data_by_id (GTK_OBJECT (widget), quark_item_path);
Tim Janik's avatar
Tim Janik committed
532 533 534
}

void
535 536 537 538
gtk_item_factory_create_items (GtkItemFactory	   *ifactory,
			       guint		    n_entries,
			       GtkItemFactoryEntry *entries,
			       gpointer		    callback_data)
539 540 541 542 543
{
  gtk_item_factory_create_items_ac (ifactory, n_entries, entries, callback_data, 1);
}

void
544 545 546 547 548
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
549 550 551 552
{
  guint i;

  g_return_if_fail (GTK_IS_ITEM_FACTORY (ifactory));
553 554 555 556 557
  g_return_if_fail (callback_type >= 1 && callback_type <= 2);

  if (n_entries == 0)
    return;

Tim Janik's avatar
Tim Janik committed
558 559 560
  g_return_if_fail (entries != NULL);

  for (i = 0; i < n_entries; i++)
561
    gtk_item_factory_create_item (ifactory, entries + i, callback_data, callback_type);
Tim Janik's avatar
Tim Janik committed
562 563 564
}

GtkWidget*
565 566
gtk_item_factory_get_widget (GtkItemFactory *ifactory,
			     const gchar    *path)
Tim Janik's avatar
Tim Janik committed
567 568 569 570 571 572 573
{
  GtkItemFactoryClass *class;
  GtkItemFactoryItem *item;

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

574
  class = GTK_ITEM_FACTORY_GET_CLASS (ifactory);
Tim Janik's avatar
Tim Janik committed
575

576 577 578 579 580 581 582 583 584 585
  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
586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601

  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*
602 603
gtk_item_factory_get_widget_by_action (GtkItemFactory *ifactory,
				       guint	       action)
Tim Janik's avatar
Tim Janik committed
604 605 606 607 608
{
  GSList *slist;

  g_return_val_if_fail (GTK_IS_ITEM_FACTORY (ifactory), NULL);

609
  for (slist = ifactory->items; slist; slist = slist->next)
Tim Janik's avatar
Tim Janik committed
610
    {
611 612
      GtkItemFactoryItem *item = slist->data;
      GSList *link;
Tim Janik's avatar
Tim Janik committed
613

614 615 616 617
      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
618 619 620 621 622
    }

  return NULL;
}

623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655
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;
}

656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709
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;
}

710
static gboolean
711 712 713 714 715
gtk_item_factory_parse_path (GtkItemFactory *ifactory,
			     gchar          *str,
			     gchar         **path,
			     gchar         **parent_path,
			     gchar         **item)
716
{
717
  gchar *translation;
718
  gchar *p, *q;
719
  
720 721 722 723 724
  *path = g_strdup (str);

  p = q = *path;
  while (*p)
    {
725 726 727 728 729 730 731 732 733
      if (*p == '_')
	{
	  if (p[1] == '_')
	    {
	      p++;
	      *q++ = '_';
	    }
	}
      else
734 735 736 737 738 739 740 741
	{
	  *q++ = *p;
	}
      p++;
    }
  *q = 0;

  *parent_path = g_strdup (*path);
742
  p = item_factory_find_separator_r (*parent_path);
743 744 745 746 747 748 749
  if (!p)
    {
      g_warning ("GtkItemFactory: invalid entry path `%s'", str);
      return FALSE;
    }
  *p = 0;

750 751 752 753 754
  if (ifactory->translate_func)
    translation = ifactory->translate_func (str, ifactory->translate_data);
  else
    translation = str;
			      
755
  p = item_factory_find_separator_r (translation);
756 757 758 759
  if (p)
    p++;
  else
    p = translation;
760

761
  *item = item_factory_unescape_label (p);
762 763 764 765

  return TRUE;
}

Tim Janik's avatar
Tim Janik committed
766 767 768
void
gtk_item_factory_create_item (GtkItemFactory	     *ifactory,
			      GtkItemFactoryEntry    *entry,
769 770
			      gpointer		      callback_data,
			      guint		      callback_type)
Tim Janik's avatar
Tim Janik committed
771
{
772
  GtkOptionMenu *option_menu = NULL;
Tim Janik's avatar
Tim Janik committed
773 774
  GtkWidget *parent;
  GtkWidget *widget;
775
  GtkWidget *image;
Tim Janik's avatar
Tim Janik committed
776
  GSList *radio_group;
777
  gchar *name;
Tim Janik's avatar
Tim Janik committed
778
  gchar *parent_path;
779
  gchar *path;
780
  gchar *accelerator;
Tim Janik's avatar
Tim Janik committed
781 782
  guint type_id;
  GtkType type;
783
  gchar *item_type_path;
784 785
  GtkStockItem stock_item;
      
Tim Janik's avatar
Tim Janik committed
786 787 788
  g_return_if_fail (GTK_IS_ITEM_FACTORY (ifactory));
  g_return_if_fail (entry != NULL);
  g_return_if_fail (entry->path != NULL);
789
  g_return_if_fail (entry->path[0] == '/');
790
  g_return_if_fail (callback_type >= 1 && callback_type <= 2);
Tim Janik's avatar
Tim Janik committed
791 792

  if (!entry->item_type ||
793 794
      entry->item_type[0] == 0)
    {
795
      item_type_path = "<Item>";
796
      type_id = quark_type_item;
797
    }
Tim Janik's avatar
Tim Janik committed
798
  else
799 800 801 802
    {
      item_type_path = entry->item_type;
      type_id = gtk_object_data_try_key (item_type_path);
    }
Tim Janik's avatar
Tim Janik committed
803 804

  radio_group = NULL;
805
  if (type_id == quark_type_item)
806
    type = GTK_TYPE_MENU_ITEM;
807
  else if (type_id == quark_type_title)
808
    type = GTK_TYPE_MENU_ITEM;
809
  else if (type_id == quark_type_radio_item)
810
    type = GTK_TYPE_RADIO_MENU_ITEM;
811
  else if (type_id == quark_type_check_item)
812
    type = GTK_TYPE_CHECK_MENU_ITEM;
813 814 815 816
  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;
817 818
  else if (type_id == quark_type_tearoff_item)
    type = GTK_TYPE_TEAROFF_MENU_ITEM;
819
  else if (type_id == quark_type_toggle_item)
820
    type = GTK_TYPE_CHECK_MENU_ITEM;
821
  else if (type_id == quark_type_separator_item)
822
    type = GTK_TYPE_MENU_ITEM;
823
  else if (type_id == quark_type_branch)
824
    type = GTK_TYPE_MENU_ITEM;
825
  else if (type_id == quark_type_last_branch)
826
    type = GTK_TYPE_MENU_ITEM;
Tim Janik's avatar
Tim Janik committed
827 828 829 830
  else
    {
      GtkWidget *radio_link;

831
      radio_link = gtk_item_factory_get_widget (ifactory, item_type_path);
Tim Janik's avatar
Tim Janik committed
832 833
      if (radio_link && GTK_IS_RADIO_MENU_ITEM (radio_link))
	{
834
	  type = GTK_TYPE_RADIO_MENU_ITEM;
Tim Janik's avatar
Tim Janik committed
835 836 837 838 839 840
	  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,
841
		     item_type_path);
Tim Janik's avatar
Tim Janik committed
842 843 844 845
	  return;
	}
    }

846
  if (!gtk_item_factory_parse_path (ifactory, entry->path, 
847 848
				    &path, &parent_path, &name))
    return;
849

Tim Janik's avatar
Tim Janik committed
850 851 852 853
  parent = gtk_item_factory_get_widget (ifactory, parent_path);
  if (!parent)
    {
      GtkItemFactoryEntry pentry;
854
      gchar *ppath, *p;
Tim Janik's avatar
Tim Janik committed
855

856
      ppath = g_strdup (entry->path);
857
      p = item_factory_find_separator_r (ppath);
858 859 860
      g_return_if_fail (p != NULL);
      *p = 0;
      pentry.path = ppath;
Tim Janik's avatar
Tim Janik committed
861 862 863 864 865
      pentry.accelerator = NULL;
      pentry.callback = NULL;
      pentry.callback_action = 0;
      pentry.item_type = "<Branch>";

866
      gtk_item_factory_create_item (ifactory, &pentry, NULL, 1);
867
      g_free (ppath);
Tim Janik's avatar
Tim Janik committed
868 869

      parent = gtk_item_factory_get_widget (ifactory, parent_path);
870
      g_return_if_fail (parent != NULL);
Tim Janik's avatar
Tim Janik committed
871 872
    }

873 874 875 876
  if (GTK_IS_OPTION_MENU (parent))
    {
      option_menu = GTK_OPTION_MENU (parent);
      if (!option_menu->menu)
877 878 879 880 881 882 883 884
	{
	  GtkWidget *menu = g_object_new (GTK_TYPE_MENU, NULL);
	  gchar *p = g_strconcat (ifactory->path, parent_path, NULL);

	  gtk_menu_set_accel_path (GTK_MENU (menu), p);
	  g_free (p);
	  gtk_option_menu_set_menu (option_menu, menu);
	}
885 886
      parent = option_menu->menu;
    }
887
  g_free (parent_path);
888
			      
889
  g_return_if_fail (GTK_IS_CONTAINER (parent));
890

891 892
  accelerator = entry->accelerator;
  
Tim Janik's avatar
Tim Janik committed
893
  widget = gtk_widget_new (type,
894 895 896 897
			   "visible", TRUE,
			   "sensitive", (type_id != quark_type_separator_item &&
					 type_id != quark_type_title),
			   "parent", parent,
Tim Janik's avatar
Tim Janik committed
898
			   NULL);
899 900
  if (option_menu && !option_menu->menu_item)
    gtk_option_menu_set_history (option_menu, 0);
Tim Janik's avatar
Tim Janik committed
901

902
  if (type == GTK_TYPE_RADIO_MENU_ITEM)
Tim Janik's avatar
Tim Janik committed
903 904 905
    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);
906
  if (type_id == quark_type_image_item)
907 908 909
    {
      GdkPixbuf *pixbuf = NULL;

910
      image = NULL;
911
      pixbuf = gdk_pixbuf_new_from_inline (-1,
912
					   entry->extra_data,
913 914 915 916 917
					   FALSE,
					   NULL);
      if (pixbuf)
	image = gtk_image_new_from_pixbuf (pixbuf);
      if (image)
918 919 920 921
	{
	  gtk_image_menu_item_set_image (GTK_IMAGE_MENU_ITEM (widget), image);
	  gtk_widget_show (image);
	}
922 923 924 925 926 927
      if (pixbuf)
	g_object_unref (G_OBJECT (pixbuf));
    }
  if (type_id == quark_type_stock_item)
    {
      image = gtk_image_new_from_stock (entry->extra_data, GTK_ICON_SIZE_MENU);
928
      gtk_image_menu_item_set_image (GTK_IMAGE_MENU_ITEM (widget), image);
929 930
      gtk_widget_show (image);

931 932 933 934 935 936
      if (gtk_stock_lookup (entry->extra_data, &stock_item))
	{
	  if (!accelerator)
	    accelerator = gtk_accelerator_name (stock_item.keyval, stock_item.modifier);
	}
    }
937 938 939 940 941

  /* install underline accelerators for this item
   */
  if (type_id != quark_type_separator_item && 
      type_id != quark_type_tearoff_item &&
942
      *name)
Tim Janik's avatar
Tim Janik committed
943 944
    {
      GtkWidget *label;
945 946
      
      label = gtk_widget_new (GTK_TYPE_ACCEL_LABEL,
947 948 949 950
			      "visible", TRUE,
			      "parent", widget,
			      "accel_widget", widget,
			      "xalign", 0.0,
951
			      NULL);
952
      gtk_label_set_text_with_mnemonic (GTK_LABEL (label), name);
Tim Janik's avatar
Tim Janik committed
953
    }
954
  
955
  g_free (name);
956
  
957 958
  if (type_id == quark_type_branch ||
      type_id == quark_type_last_branch)
Tim Janik's avatar
Tim Janik committed
959
    {
960 961
      gchar *p;

962 963 964
      if (entry->callback)
	g_warning ("gtk_item_factory_create_item(): Can't specify a callback on a branch: \"%s\"",
		   entry->path);
965
      if (type_id == quark_type_last_branch)
966
	gtk_menu_item_set_right_justified (GTK_MENU_ITEM (widget), TRUE);
967
      
Tim Janik's avatar
Tim Janik committed
968
      parent = widget;
969 970 971 972
      widget = gtk_widget_new (GTK_TYPE_MENU, NULL);
      p = g_strconcat (ifactory->path, path, NULL);
      gtk_menu_set_accel_path (GTK_MENU (widget), p);
      g_free (p);
973
      
Tim Janik's avatar
Tim Janik committed
974 975 976 977
      gtk_menu_item_set_submenu (GTK_MENU_ITEM (parent), widget);
    }	   
  
  gtk_item_factory_add_item (ifactory,
978
			     path, accelerator,
979
			     (type_id == quark_type_branch ||
980 981
			      type_id == quark_type_last_branch) ?
			      (GtkItemFactoryCallback) NULL : entry->callback,
982
			     entry->callback_action, callback_data,
983
			     callback_type,
984
			     item_type_path,
Tim Janik's avatar
Tim Janik committed
985
			     widget);
986 987
  if (accelerator != entry->accelerator)
    g_free (accelerator);
988
  g_free (path);
Tim Janik's avatar
Tim Janik committed
989 990 991
}

void
992 993 994
gtk_item_factory_create_menu_entries (guint              n_entries,
				      GtkMenuEntry      *entries)
{
995 996
  static GPatternSpec *pspec_separator = NULL;
  static GPatternSpec *pspec_check = NULL;
997 998 999 1000 1001 1002
  guint i;

  if (!n_entries)
    return;
  g_return_if_fail (entries != NULL);

1003
  if (!pspec_separator)
1004
    {
1005 1006
      pspec_separator = g_pattern_spec_new ("*<separator>*");
      pspec_check = g_pattern_spec_new ("*<check>*");
1007
    }
1008 1009 1010 1011 1012 1013

  for (i = 0; i < n_entries; i++)
    {
      GtkItemFactory *ifactory;
      GtkItemFactoryEntry entry;
      gchar *path;
1014
      gchar *cpath;
1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028

      path = entries[i].path;
      ifactory = gtk_item_factory_from_path (path);
      if (!ifactory)
	{
	  g_warning ("gtk_item_factory_create_menu_entries(): "
		     "entry[%u] refers to unknown item factory: \"%s\"",
		     i, entries[i].path);
	  continue;
	}

      while (*path != '>')
	path++;
      path++;
1029
      cpath = NULL;
1030 1031 1032 1033 1034

      entry.path = path;
      entry.accelerator = entries[i].accelerator;
      entry.callback = entries[i].callback;
      entry.callback_action = 0;
1035
      if (g_pattern_match_string (pspec_separator, path))
1036
	entry.item_type = "<Separator>";
1037
      else if (!g_pattern_match_string (pspec_check, path))
1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056
	entry.item_type = NULL;
      else
	{
	  gboolean in_brace = FALSE;
	  gchar *c;
	  
	  cpath = g_new (gchar, strlen (path));
	  c = cpath;
	  while (*path != 0)
	    {
	      if (*path == '<')
		in_brace = TRUE;
	      else if (*path == '>')
		in_brace = FALSE;
	      else if (!in_brace)
		*(c++) = *path;
	      path++;
	    }
	  *c = 0;
1057
	  entry.item_type = "<ToggleItem>";
1058 1059 1060
	  entry.path = cpath;
	}
      
1061 1062
      gtk_item_factory_create_item (ifactory, &entry, entries[i].callback_data, 2);
      entries[i].widget = gtk_item_factory_get_widget (ifactory, entries[i].path);
1063
      g_free (cpath);
1064 1065 1066 1067 1068 1069
    }
}

void
gtk_item_factories_path_delete (const gchar *ifactory_path,
				const gchar *path)
Tim Janik's avatar
Tim Janik committed
1070 1071 1072 1073 1074 1075 1076 1077
{
  GtkItemFactoryClass *class;
  GtkItemFactoryItem *item;

  g_return_if_fail (path != NULL);

  class = gtk_type_class (GTK_TYPE_ITEM_FACTORY);