Pileus Git - ~andy/gtk/blob - gtk/gtkiconfactory.c

   1 /* GTK - The GIMP Toolkit
   2  * Copyright (C) 2000 Red Hat, Inc.
   3  *               2008 Johan Dahlin
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Lesser General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public
  15  * License along with this library; if not, write to the
  16  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  17  * Boston, MA 02111-1307, USA.
  18  */
  19
  20 /*
  21  * Modified by the GTK+ Team and others 1997-2000.  See the AUTHORS
  22  * file for a list of people on the GTK+ Team.  See the ChangeLog
  23  * files for a list of changes.  These files are distributed with
  24  * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
  25  */
  26
  27 #include "config.h"
  28 #include <stdlib.h>
  29 #include <errno.h>
  30 #include <string.h>
  31 #include "gtkiconfactory.h"
  32 #include "gtkiconcache.h"
  33 #include "gtkdebug.h"
  34 #include "gtkicontheme.h"
  35 #include "gtksettings.h"
  36 #include "gtkstock.h"
  37 #include "gtkwidget.h"
  38 #include "gtkintl.h"
  39 #include "gtkbuildable.h"
  40 #include "gtkbuilderprivate.h"
  41 #include "gtkalias.h"
  42
  43
  44 static GSList *all_icon_factories = NULL;
  45
  46 typedef enum {
  47   GTK_ICON_SOURCE_EMPTY,
  48   GTK_ICON_SOURCE_ICON_NAME,
  49   GTK_ICON_SOURCE_STATIC_ICON_NAME,
  50   GTK_ICON_SOURCE_FILENAME,
  51   GTK_ICON_SOURCE_PIXBUF
  52 } GtkIconSourceType;
  53
  54 struct _GtkIconSource
  55 {
  56   GtkIconSourceType type;
  57
  58   union {
  59     gchar *icon_name;
  60     gchar *filename;
  61     GdkPixbuf *pixbuf;
  62   } source;
  63
  64   GdkPixbuf *filename_pixbuf;
  65
  66   GtkTextDirection direction;
  67   GtkStateType state;
  68   GtkIconSize size;
  69
  70   /* If TRUE, then the parameter is wildcarded, and the above
  71    * fields should be ignored. If FALSE, the parameter is
  72    * specified, and the above fields should be valid.
  73    */
  74   guint any_direction : 1;
  75   guint any_state : 1;
  76   guint any_size : 1;
  77
  78 #if defined (G_OS_WIN32) && !defined (_WIN64)
  79   /* System codepage version of filename, for DLL ABI backward
  80    * compatibility functions.
  81    */
  82   gchar *cp_filename;
  83 #endif
  84 };
  85
  86
  87 static void
  88 gtk_icon_factory_buildable_init  (GtkBuildableIface      *iface);
  89
  90 static gboolean gtk_icon_factory_buildable_custom_tag_start (GtkBuildable     *buildable,
  91                                                              GtkBuilder       *builder,
  92                                                              GObject          *child,
  93                                                              const gchar      *tagname,
  94                                                              GMarkupParser    *parser,
  95                                                              gpointer         *data);
  96 static void gtk_icon_factory_buildable_custom_tag_end (GtkBuildable *buildable,
  97                                                        GtkBuilder   *builder,
  98                                                        GObject      *child,
  99                                                        const gchar  *tagname,
 100                                                        gpointer     *user_data);
 101 static void gtk_icon_factory_finalize   (GObject             *object);
 102 static void get_default_icons           (GtkIconFactory      *icon_factory);
 103 static void icon_source_clear           (GtkIconSource       *source);
 104
 105 static GtkIconSize icon_size_register_intern (const gchar *name,
 106                                               gint         width,
 107                                               gint         height);
 108
 109 #define GTK_ICON_SOURCE_INIT(any_direction, any_state, any_size)        \
 110   { GTK_ICON_SOURCE_EMPTY, { NULL }, NULL,                              \
 111    0, 0, 0,                                                             \
 112    any_direction, any_state, any_size }
 113
 114 G_DEFINE_TYPE_WITH_CODE (GtkIconFactory, gtk_icon_factory, G_TYPE_OBJECT,
 115                          G_IMPLEMENT_INTERFACE (GTK_TYPE_BUILDABLE,
 116                                                 gtk_icon_factory_buildable_init))
 117
 118 static void
 119 gtk_icon_factory_init (GtkIconFactory *factory)
 120 {
 121   factory->icons = g_hash_table_new (g_str_hash, g_str_equal);
 122   all_icon_factories = g_slist_prepend (all_icon_factories, factory);
 123 }
 124
 125 static void
 126 gtk_icon_factory_class_init (GtkIconFactoryClass *klass)
 127 {
 128   GObjectClass *object_class = G_OBJECT_CLASS (klass);
 129
 130   object_class->finalize = gtk_icon_factory_finalize;
 131 }
 132
 133 static void
 134 gtk_icon_factory_buildable_init (GtkBuildableIface *iface)
 135 {
 136   iface->custom_tag_start = gtk_icon_factory_buildable_custom_tag_start;
 137   iface->custom_tag_end = gtk_icon_factory_buildable_custom_tag_end;
 138 }
 139
 140 static void
 141 free_icon_set (gpointer key, gpointer value, gpointer data)
 142 {
 143   g_free (key);
 144   gtk_icon_set_unref (value);
 145 }
 146
 147 static void
 148 gtk_icon_factory_finalize (GObject *object)
 149 {
 150   GtkIconFactory *factory = GTK_ICON_FACTORY (object);
 151
 152   all_icon_factories = g_slist_remove (all_icon_factories, factory);
 153
 154   g_hash_table_foreach (factory->icons, free_icon_set, NULL);
 155
 156   g_hash_table_destroy (factory->icons);
 157
 158   G_OBJECT_CLASS (gtk_icon_factory_parent_class)->finalize (object);
 159 }
 160
 161 /**
 162  * gtk_icon_factory_new:
 163  *
 164  * Creates a new #GtkIconFactory. An icon factory manages a collection
 165  * of #GtkIconSet<!-- -->s; a #GtkIconSet manages a set of variants of a
 166  * particular icon (i.e. a #GtkIconSet contains variants for different
 167  * sizes and widget states). Icons in an icon factory are named by a
 168  * stock ID, which is a simple string identifying the icon. Each
 169  * #GtkStyle has a list of #GtkIconFactory<!-- -->s derived from the current
 170  * theme; those icon factories are consulted first when searching for
 171  * an icon. If the theme doesn't set a particular icon, GTK+ looks for
 172  * the icon in a list of default icon factories, maintained by
 173  * gtk_icon_factory_add_default() and
 174  * gtk_icon_factory_remove_default(). Applications with icons should
 175  * add a default icon factory with their icons, which will allow
 176  * themes to override the icons for the application.
 177  *
 178  * Return value: a new #GtkIconFactory
 179  */
 180 GtkIconFactory*
 181 gtk_icon_factory_new (void)
 182 {
 183   return g_object_new (GTK_TYPE_ICON_FACTORY, NULL);
 184 }
 185
 186 /**
 187  * gtk_icon_factory_add:
 188  * @factory: a #GtkIconFactory
 189  * @stock_id: icon name
 190  * @icon_set: icon set
 191  *
 192  * Adds the given @icon_set to the icon factory, under the name
 193  * @stock_id.  @stock_id should be namespaced for your application,
 194  * e.g. "myapp-whatever-icon".  Normally applications create a
 195  * #GtkIconFactory, then add it to the list of default factories with
 196  * gtk_icon_factory_add_default(). Then they pass the @stock_id to
 197  * widgets such as #GtkImage to display the icon. Themes can provide
 198  * an icon with the same name (such as "myapp-whatever-icon") to
 199  * override your application's default icons. If an icon already
 200  * existed in @factory for @stock_id, it is unreferenced and replaced
 201  * with the new @icon_set.
 202  */
 203 void
 204 gtk_icon_factory_add (GtkIconFactory *factory,
 205                       const gchar    *stock_id,
 206                       GtkIconSet     *icon_set)
 207 {
 208   gpointer old_key = NULL;
 209   gpointer old_value = NULL;
 210
 211   g_return_if_fail (GTK_IS_ICON_FACTORY (factory));
 212   g_return_if_fail (stock_id != NULL);
 213   g_return_if_fail (icon_set != NULL);
 214
 215   g_hash_table_lookup_extended (factory->icons, stock_id,
 216                                 &old_key, &old_value);
 217
 218   if (old_value == icon_set)
 219     return;
 220
 221   gtk_icon_set_ref (icon_set);
 222
 223   /* GHashTable key memory management is so fantastically broken. */
 224   if (old_key)
 225     g_hash_table_insert (factory->icons, old_key, icon_set);
 226   else
 227     g_hash_table_insert (factory->icons, g_strdup (stock_id), icon_set);
 228
 229   if (old_value)
 230     gtk_icon_set_unref (old_value);
 231 }
 232
 233 /**
 234  * gtk_icon_factory_lookup:
 235  * @factory: a #GtkIconFactory
 236  * @stock_id: an icon name
 237  *
 238  * Looks up @stock_id in the icon factory, returning an icon set
 239  * if found, otherwise %NULL. For display to the user, you should
 240  * use gtk_style_lookup_icon_set() on the #GtkStyle for the
 241  * widget that will display the icon, instead of using this
 242  * function directly, so that themes are taken into account.
 243  *
 244  * Return value: icon set of @stock_id.
 245  */
 246 GtkIconSet *
 247 gtk_icon_factory_lookup (GtkIconFactory *factory,
 248                          const gchar    *stock_id)
 249 {
 250   g_return_val_if_fail (GTK_IS_ICON_FACTORY (factory), NULL);
 251   g_return_val_if_fail (stock_id != NULL, NULL);
 252
 253   return g_hash_table_lookup (factory->icons, stock_id);
 254 }
 255
 256 static GtkIconFactory *gtk_default_icons = NULL;
 257 static GSList *default_factories = NULL;
 258
 259 /**
 260  * gtk_icon_factory_add_default:
 261  * @factory: a #GtkIconFactory
 262  *
 263  * Adds an icon factory to the list of icon factories searched by
 264  * gtk_style_lookup_icon_set(). This means that, for example,
 265  * gtk_image_new_from_stock() will be able to find icons in @factory.
 266  * There will normally be an icon factory added for each library or
 267  * application that comes with icons. The default icon factories
 268  * can be overridden by themes.
 269  */
 270 void
 271 gtk_icon_factory_add_default (GtkIconFactory *factory)
 272 {
 273   g_return_if_fail (GTK_IS_ICON_FACTORY (factory));
 274
 275   g_object_ref (factory);
 276
 277   default_factories = g_slist_prepend (default_factories, factory);
 278 }
 279
 280 /**
 281  * gtk_icon_factory_remove_default:
 282  * @factory: a #GtkIconFactory previously added with gtk_icon_factory_add_default()
 283  *
 284  * Removes an icon factory from the list of default icon
 285  * factories. Not normally used; you might use it for a library that
 286  * can be unloaded or shut down.
 287  */
 288 void
 289 gtk_icon_factory_remove_default (GtkIconFactory  *factory)
 290 {
 291   g_return_if_fail (GTK_IS_ICON_FACTORY (factory));
 292
 293   default_factories = g_slist_remove (default_factories, factory);
 294
 295   g_object_unref (factory);
 296 }
 297
 298 void
 299 _gtk_icon_factory_ensure_default_icons (void)
 300 {
 301   if (gtk_default_icons == NULL)
 302     {
 303       gtk_default_icons = gtk_icon_factory_new ();
 304
 305       get_default_icons (gtk_default_icons);
 306     }
 307 }
 308
 309 /**
 310  * gtk_icon_factory_lookup_default:
 311  * @stock_id: an icon name
 312  *
 313  * Looks for an icon in the list of default icon factories.  For
 314  * display to the user, you should use gtk_style_lookup_icon_set() on
 315  * the #GtkStyle for the widget that will display the icon, instead of
 316  * using this function directly, so that themes are taken into
 317  * account.
 318  *
 319  * Return value: a #GtkIconSet, or %NULL
 320  */
 321 GtkIconSet *
 322 gtk_icon_factory_lookup_default (const gchar *stock_id)
 323 {
 324   GSList *tmp_list;
 325
 326   g_return_val_if_fail (stock_id != NULL, NULL);
 327
 328   tmp_list = default_factories;
 329   while (tmp_list != NULL)
 330     {
 331       GtkIconSet *icon_set =
 332         gtk_icon_factory_lookup (GTK_ICON_FACTORY (tmp_list->data),
 333                                  stock_id);
 334
 335       if (icon_set)
 336         return icon_set;
 337
 338       tmp_list = g_slist_next (tmp_list);
 339     }
 340
 341   _gtk_icon_factory_ensure_default_icons ();
 342
 343   return gtk_icon_factory_lookup (gtk_default_icons, stock_id);
 344 }
 345
 346 static void
 347 register_stock_icon (GtkIconFactory *factory,
 348                      const gchar    *stock_id)
 349 {
 350   GtkIconSet *set = gtk_icon_set_new ();
 351   GtkIconSource source = GTK_ICON_SOURCE_INIT (TRUE, TRUE, TRUE);
 352
 353   source.type = GTK_ICON_SOURCE_STATIC_ICON_NAME;
 354   source.source.icon_name = (gchar *)stock_id;
 355   gtk_icon_set_add_source (set, &source);
 356
 357   gtk_icon_factory_add (factory, stock_id, set);
 358   gtk_icon_set_unref (set);
 359 }
 360
 361 static void
 362 register_bidi_stock_icon (GtkIconFactory *factory,
 363                           const gchar    *stock_id,
 364                           const gchar    *stock_id_ltr,
 365                           const gchar    *stock_id_rtl)
 366 {
 367   GtkIconSet *set = gtk_icon_set_new ();
 368   GtkIconSource source = GTK_ICON_SOURCE_INIT (FALSE, TRUE, TRUE);
 369
 370   source.type = GTK_ICON_SOURCE_STATIC_ICON_NAME;
 371   source.source.icon_name = (gchar *)stock_id_ltr;
 372   source.direction = GTK_TEXT_DIR_LTR;
 373   gtk_icon_set_add_source (set, &source);
 374
 375   source.type = GTK_ICON_SOURCE_STATIC_ICON_NAME;
 376   source.source.icon_name = (gchar *)stock_id_rtl;
 377   source.direction = GTK_TEXT_DIR_RTL;
 378   gtk_icon_set_add_source (set, &source);
 379
 380   gtk_icon_factory_add (factory, stock_id, set);
 381   gtk_icon_set_unref (set);
 382 }
 383
 384 static void
 385 get_default_icons (GtkIconFactory *factory)
 386 {
 387   /* KEEP IN SYNC with gtkstock.c */
 388
 389   register_stock_icon (factory, GTK_STOCK_DIALOG_AUTHENTICATION);
 390   register_stock_icon (factory, GTK_STOCK_DIALOG_ERROR);
 391   register_stock_icon (factory, GTK_STOCK_DIALOG_INFO);
 392   register_stock_icon (factory, GTK_STOCK_DIALOG_QUESTION);
 393   register_stock_icon (factory, GTK_STOCK_DIALOG_WARNING);
 394   register_stock_icon (factory, GTK_STOCK_DND);
 395   register_stock_icon (factory, GTK_STOCK_DND_MULTIPLE);
 396   register_stock_icon (factory, GTK_STOCK_APPLY);
 397   register_stock_icon (factory, GTK_STOCK_CANCEL);
 398   register_stock_icon (factory, GTK_STOCK_NO);
 399   register_stock_icon (factory, GTK_STOCK_OK);
 400   register_stock_icon (factory, GTK_STOCK_YES);
 401   register_stock_icon (factory, GTK_STOCK_CLOSE);
 402   register_stock_icon (factory, GTK_STOCK_ADD);
 403   register_stock_icon (factory, GTK_STOCK_JUSTIFY_CENTER);
 404   register_stock_icon (factory, GTK_STOCK_JUSTIFY_FILL);
 405   register_stock_icon (factory, GTK_STOCK_JUSTIFY_LEFT);
 406   register_stock_icon (factory, GTK_STOCK_JUSTIFY_RIGHT);
 407   register_stock_icon (factory, GTK_STOCK_GOTO_BOTTOM);
 408   register_stock_icon (factory, GTK_STOCK_CDROM);
 409   register_stock_icon (factory, GTK_STOCK_CONVERT);
 410   register_stock_icon (factory, GTK_STOCK_COPY);
 411   register_stock_icon (factory, GTK_STOCK_CUT);
 412   register_stock_icon (factory, GTK_STOCK_GO_DOWN);
 413   register_stock_icon (factory, GTK_STOCK_EXECUTE);
 414   register_stock_icon (factory, GTK_STOCK_QUIT);
 415   register_bidi_stock_icon (factory,
 416                             GTK_STOCK_GOTO_FIRST,
 417                             GTK_STOCK_GOTO_FIRST "-ltr",
 418                             GTK_STOCK_GOTO_FIRST "-rtl");
 419   register_stock_icon (factory, GTK_STOCK_SELECT_FONT);
 420   register_stock_icon (factory, GTK_STOCK_FULLSCREEN);
 421   register_stock_icon (factory, GTK_STOCK_LEAVE_FULLSCREEN);
 422   register_stock_icon (factory, GTK_STOCK_HARDDISK);
 423   register_stock_icon (factory, GTK_STOCK_HELP);
 424   register_stock_icon (factory, GTK_STOCK_HOME);
 425   register_stock_icon (factory, GTK_STOCK_INFO);
 426   register_bidi_stock_icon (factory,
 427                             GTK_STOCK_JUMP_TO,
 428                             GTK_STOCK_JUMP_TO "-ltr",
 429                             GTK_STOCK_JUMP_TO "-rtl");
 430   register_bidi_stock_icon (factory,
 431                             GTK_STOCK_GOTO_LAST,
 432                             GTK_STOCK_GOTO_LAST "-ltr",
 433                             GTK_STOCK_GOTO_LAST "-rtl");
 434   register_bidi_stock_icon (factory,
 435                             GTK_STOCK_GO_BACK,
 436                             GTK_STOCK_GO_BACK "-ltr",
 437                             GTK_STOCK_GO_BACK "-rtl");
 438   register_stock_icon (factory, GTK_STOCK_MISSING_IMAGE);
 439   register_stock_icon (factory, GTK_STOCK_NETWORK);
 440   register_stock_icon (factory, GTK_STOCK_NEW);
 441   register_stock_icon (factory, GTK_STOCK_OPEN);
 442   register_stock_icon (factory, GTK_STOCK_ORIENTATION_PORTRAIT);
 443   register_stock_icon (factory, GTK_STOCK_ORIENTATION_LANDSCAPE);
 444   register_stock_icon (factory, GTK_STOCK_ORIENTATION_REVERSE_PORTRAIT);
 445   register_stock_icon (factory, GTK_STOCK_ORIENTATION_REVERSE_LANDSCAPE);
 446   register_stock_icon (factory, GTK_STOCK_PAGE_SETUP);
 447   register_stock_icon (factory, GTK_STOCK_PASTE);
 448   register_stock_icon (factory, GTK_STOCK_PREFERENCES);
 449   register_stock_icon (factory, GTK_STOCK_PRINT);
 450   register_stock_icon (factory, GTK_STOCK_PRINT_ERROR);
 451   register_stock_icon (factory, GTK_STOCK_PRINT_PAUSED);
 452   register_stock_icon (factory, GTK_STOCK_PRINT_PREVIEW);
 453   register_stock_icon (factory, GTK_STOCK_PRINT_REPORT);
 454   register_stock_icon (factory, GTK_STOCK_PRINT_WARNING);
 455   register_stock_icon (factory, GTK_STOCK_PROPERTIES);
 456   register_bidi_stock_icon (factory,
 457                             GTK_STOCK_REDO,
 458                             GTK_STOCK_REDO "-ltr",
 459                             GTK_STOCK_REDO "-rtl");
 460   register_stock_icon (factory, GTK_STOCK_REMOVE);
 461   register_stock_icon (factory, GTK_STOCK_REFRESH);
 462   register_bidi_stock_icon (factory,
 463                             GTK_STOCK_REVERT_TO_SAVED,
 464                             GTK_STOCK_REVERT_TO_SAVED "-ltr",
 465                             GTK_STOCK_REVERT_TO_SAVED "-rtl");
 466   register_bidi_stock_icon (factory,
 467                             GTK_STOCK_GO_FORWARD,
 468                             GTK_STOCK_GO_FORWARD "-ltr",
 469                             GTK_STOCK_GO_FORWARD "-rtl");
 470   register_stock_icon (factory, GTK_STOCK_SAVE);
 471   register_stock_icon (factory, GTK_STOCK_FLOPPY);
 472   register_stock_icon (factory, GTK_STOCK_SAVE_AS);
 473   register_stock_icon (factory, GTK_STOCK_FIND);
 474   register_stock_icon (factory, GTK_STOCK_FIND_AND_REPLACE);
 475   register_stock_icon (factory, GTK_STOCK_SORT_DESCENDING);
 476   register_stock_icon (factory, GTK_STOCK_SORT_ASCENDING);
 477   register_stock_icon (factory, GTK_STOCK_SPELL_CHECK);
 478   register_stock_icon (factory, GTK_STOCK_STOP);
 479   register_stock_icon (factory, GTK_STOCK_BOLD);
 480   register_stock_icon (factory, GTK_STOCK_ITALIC);
 481   register_stock_icon (factory, GTK_STOCK_STRIKETHROUGH);
 482   register_stock_icon (factory, GTK_STOCK_UNDERLINE);
 483   register_bidi_stock_icon (factory,
 484                             GTK_STOCK_INDENT,
 485                             GTK_STOCK_INDENT "-ltr",
 486                             GTK_STOCK_INDENT "-rtl");
 487   register_bidi_stock_icon (factory,
 488                             GTK_STOCK_UNINDENT,
 489                             GTK_STOCK_UNINDENT "-ltr",
 490                             GTK_STOCK_UNINDENT "-rtl");
 491   register_stock_icon (factory, GTK_STOCK_GOTO_TOP);
 492   register_stock_icon (factory, GTK_STOCK_DELETE);
 493   register_bidi_stock_icon (factory,
 494                             GTK_STOCK_UNDELETE,
 495                             GTK_STOCK_UNDELETE "-ltr",
 496                             GTK_STOCK_UNDELETE "-rtl");
 497   register_bidi_stock_icon (factory,
 498                             GTK_STOCK_UNDO,
 499                             GTK_STOCK_UNDO "-ltr",
 500                             GTK_STOCK_UNDO "-rtl");
 501   register_stock_icon (factory, GTK_STOCK_GO_UP);
 502   register_stock_icon (factory, GTK_STOCK_FILE);
 503   register_stock_icon (factory, GTK_STOCK_DIRECTORY);
 504   register_stock_icon (factory, GTK_STOCK_ABOUT);
 505   register_stock_icon (factory, GTK_STOCK_CONNECT);
 506   register_stock_icon (factory, GTK_STOCK_DISCONNECT);
 507   register_stock_icon (factory, GTK_STOCK_EDIT);
 508   register_stock_icon (factory, GTK_STOCK_CAPS_LOCK_WARNING);
 509   register_bidi_stock_icon (factory,
 510                             GTK_STOCK_MEDIA_FORWARD,
 511                             GTK_STOCK_MEDIA_FORWARD "-ltr",
 512                             GTK_STOCK_MEDIA_FORWARD "-rtl");
 513   register_bidi_stock_icon (factory,
 514                             GTK_STOCK_MEDIA_NEXT,
 515                             GTK_STOCK_MEDIA_NEXT "-ltr",
 516                             GTK_STOCK_MEDIA_NEXT "-rtl");
 517   register_stock_icon (factory, GTK_STOCK_MEDIA_PAUSE);
 518   register_bidi_stock_icon (factory,
 519                             GTK_STOCK_MEDIA_PLAY,
 520                             GTK_STOCK_MEDIA_PLAY "-ltr",
 521                             GTK_STOCK_MEDIA_PLAY "-rtl");
 522   register_bidi_stock_icon (factory,
 523                             GTK_STOCK_MEDIA_PREVIOUS,
 524                             GTK_STOCK_MEDIA_PREVIOUS "-ltr",
 525                             GTK_STOCK_MEDIA_PREVIOUS "-rtl");
 526   register_stock_icon (factory, GTK_STOCK_MEDIA_RECORD);
 527   register_bidi_stock_icon (factory,
 528                             GTK_STOCK_MEDIA_REWIND,
 529                             GTK_STOCK_MEDIA_REWIND "-ltr",
 530                             GTK_STOCK_MEDIA_REWIND "-rtl");
 531   register_stock_icon (factory, GTK_STOCK_MEDIA_STOP);
 532   register_stock_icon (factory, GTK_STOCK_INDEX);
 533   register_stock_icon (factory, GTK_STOCK_ZOOM_100);
 534   register_stock_icon (factory, GTK_STOCK_ZOOM_IN);
 535   register_stock_icon (factory, GTK_STOCK_ZOOM_OUT);
 536   register_stock_icon (factory, GTK_STOCK_ZOOM_FIT);
 537   register_stock_icon (factory, GTK_STOCK_SELECT_ALL);
 538   register_stock_icon (factory, GTK_STOCK_CLEAR);
 539   register_stock_icon (factory, GTK_STOCK_SELECT_COLOR);
 540   register_stock_icon (factory, GTK_STOCK_COLOR_PICKER);
 541 }
 542
 543 /************************************************************
 544  *                    Icon size handling                    *
 545  ************************************************************/
 546
 547 typedef struct _IconSize IconSize;
 548
 549 struct _IconSize
 550 {
 551   gint size;
 552   gchar *name;
 553
 554   gint width;
 555   gint height;
 556 };
 557
 558 typedef struct _IconAlias IconAlias;
 559
 560 struct _IconAlias
 561 {
 562   gchar *name;
 563   gint   target;
 564 };
 565
 566 typedef struct _SettingsIconSize SettingsIconSize;
 567
 568 struct _SettingsIconSize
 569 {
 570   gint width;
 571   gint height;
 572 };
 573
 574 static GHashTable *icon_aliases = NULL;
 575 static IconSize *icon_sizes = NULL;
 576 static gint      icon_sizes_allocated = 0;
 577 static gint      icon_sizes_used = 0;
 578
 579 static void
 580 init_icon_sizes (void)
 581 {
 582   if (icon_sizes == NULL)
 583     {
 584 #define NUM_BUILTIN_SIZES 7
 585       gint i;
 586
 587       icon_aliases = g_hash_table_new (g_str_hash, g_str_equal);
 588
 589       icon_sizes = g_new (IconSize, NUM_BUILTIN_SIZES);
 590       icon_sizes_allocated = NUM_BUILTIN_SIZES;
 591       icon_sizes_used = NUM_BUILTIN_SIZES;
 592
 593       icon_sizes[GTK_ICON_SIZE_INVALID].size = 0;
 594       icon_sizes[GTK_ICON_SIZE_INVALID].name = NULL;
 595       icon_sizes[GTK_ICON_SIZE_INVALID].width = 0;
 596       icon_sizes[GTK_ICON_SIZE_INVALID].height = 0;
 597
 598       /* the name strings aren't copied since we don't ever remove
 599        * icon sizes, so we don't need to know whether they're static.
 600        * Even if we did I suppose removing the builtin sizes would be
 601        * disallowed.
 602        */
 603
 604       icon_sizes[GTK_ICON_SIZE_MENU].size = GTK_ICON_SIZE_MENU;
 605       icon_sizes[GTK_ICON_SIZE_MENU].name = "gtk-menu";
 606       icon_sizes[GTK_ICON_SIZE_MENU].width = 16;
 607       icon_sizes[GTK_ICON_SIZE_MENU].height = 16;
 608
 609       icon_sizes[GTK_ICON_SIZE_BUTTON].size = GTK_ICON_SIZE_BUTTON;
 610       icon_sizes[GTK_ICON_SIZE_BUTTON].name = "gtk-button";
 611       icon_sizes[GTK_ICON_SIZE_BUTTON].width = 20;
 612       icon_sizes[GTK_ICON_SIZE_BUTTON].height = 20;
 613
 614       icon_sizes[GTK_ICON_SIZE_SMALL_TOOLBAR].size = GTK_ICON_SIZE_SMALL_TOOLBAR;
 615       icon_sizes[GTK_ICON_SIZE_SMALL_TOOLBAR].name = "gtk-small-toolbar";
 616       icon_sizes[GTK_ICON_SIZE_SMALL_TOOLBAR].width = 18;
 617       icon_sizes[GTK_ICON_SIZE_SMALL_TOOLBAR].height = 18;
 618
 619       icon_sizes[GTK_ICON_SIZE_LARGE_TOOLBAR].size = GTK_ICON_SIZE_LARGE_TOOLBAR;
 620       icon_sizes[GTK_ICON_SIZE_LARGE_TOOLBAR].name = "gtk-large-toolbar";
 621       icon_sizes[GTK_ICON_SIZE_LARGE_TOOLBAR].width = 24;
 622       icon_sizes[GTK_ICON_SIZE_LARGE_TOOLBAR].height = 24;
 623
 624       icon_sizes[GTK_ICON_SIZE_DND].size = GTK_ICON_SIZE_DND;
 625       icon_sizes[GTK_ICON_SIZE_DND].name = "gtk-dnd";
 626       icon_sizes[GTK_ICON_SIZE_DND].width = 32;
 627       icon_sizes[GTK_ICON_SIZE_DND].height = 32;
 628
 629       icon_sizes[GTK_ICON_SIZE_DIALOG].size = GTK_ICON_SIZE_DIALOG;
 630       icon_sizes[GTK_ICON_SIZE_DIALOG].name = "gtk-dialog";
 631       icon_sizes[GTK_ICON_SIZE_DIALOG].width = 48;
 632       icon_sizes[GTK_ICON_SIZE_DIALOG].height = 48;
 633
 634       g_assert ((GTK_ICON_SIZE_DIALOG + 1) == NUM_BUILTIN_SIZES);
 635
 636       /* Alias everything to itself. */
 637       i = 1; /* skip invalid size */
 638       while (i < NUM_BUILTIN_SIZES)
 639         {
 640           gtk_icon_size_register_alias (icon_sizes[i].name, icon_sizes[i].size);
 641
 642           ++i;
 643         }
 644
 645 #undef NUM_BUILTIN_SIZES
 646     }
 647 }
 648
 649 static void
 650 free_settings_sizes (gpointer data)
 651 {
 652   g_array_free (data, TRUE);
 653 }
 654
 655 static GArray *
 656 get_settings_sizes (GtkSettings *settings,
 657                     gboolean    *created)
 658 {
 659   GArray *settings_sizes;
 660   static GQuark sizes_quark = 0;
 661
 662   if (!sizes_quark)
 663     sizes_quark = g_quark_from_static_string ("gtk-icon-sizes");
 664
 665   settings_sizes = g_object_get_qdata (G_OBJECT (settings), sizes_quark);
 666   if (!settings_sizes)
 667     {
 668       settings_sizes = g_array_new (FALSE, FALSE, sizeof (SettingsIconSize));
 669       g_object_set_qdata_full (G_OBJECT (settings), sizes_quark,
 670                                settings_sizes, free_settings_sizes);
 671       if (created)
 672         *created = TRUE;
 673     }
 674
 675   return settings_sizes;
 676 }
 677
 678 static void
 679 icon_size_set_for_settings (GtkSettings *settings,
 680                             const gchar *size_name,
 681                             gint         width,
 682                             gint         height)
 683 {
 684   GtkIconSize size;
 685   GArray *settings_sizes;
 686   SettingsIconSize *settings_size;
 687
 688   g_return_if_fail (size_name != NULL);
 689
 690   size = gtk_icon_size_from_name (size_name);
 691   if (size == GTK_ICON_SIZE_INVALID)
 692     /* Reserve a place */
 693     size = icon_size_register_intern (size_name, -1, -1);
 694
 695   settings_sizes = get_settings_sizes (settings, NULL);
 696   if (size >= settings_sizes->len)
 697     {
 698       SettingsIconSize unset = { -1, -1 };
 699       gint i;
 700
 701       for (i = settings_sizes->len; i <= size; i++)
 702         g_array_append_val (settings_sizes, unset);
 703     }
 704
 705   settings_size = &g_array_index (settings_sizes, SettingsIconSize, size);
 706
 707   settings_size->width = width;
 708   settings_size->height = height;
 709 }
 710
 711 /* Like pango_parse_word, but accept - as well
 712  */
 713 static gboolean
 714 scan_icon_size_name (const char **pos, GString *out)
 715 {
 716   const char *p = *pos;
 717
 718   while (g_ascii_isspace (*p))
 719     p++;
 720
 721   if (!((*p >= 'A' && *p <= 'Z') ||
 722         (*p >= 'a' && *p <= 'z') ||
 723         *p == '_' || *p == '-'))
 724     return FALSE;
 725
 726   g_string_truncate (out, 0);
 727   g_string_append_c (out, *p);
 728   p++;
 729
 730   while ((*p >= 'A' && *p <= 'Z') ||
 731          (*p >= 'a' && *p <= 'z') ||
 732          (*p >= '0' && *p <= '9') ||
 733          *p == '_' || *p == '-')
 734     {
 735       g_string_append_c (out, *p);
 736       p++;
 737     }
 738
 739   *pos = p;
 740
 741   return TRUE;
 742 }
 743
 744 static void
 745 icon_size_setting_parse (GtkSettings *settings,
 746                          const gchar *icon_size_string)
 747 {
 748   GString *name_buf = g_string_new (NULL);
 749   const gchar *p = icon_size_string;
 750
 751   while (pango_skip_space (&p))
 752     {
 753       gint width, height;
 754
 755       if (!scan_icon_size_name (&p, name_buf))
 756         goto err;
 757
 758       if (!pango_skip_space (&p))
 759         goto err;
 760
 761       if (*p != '=')
 762         goto err;
 763
 764       p++;
 765
 766       if (!pango_scan_int (&p, &width))
 767         goto err;
 768
 769       if (!pango_skip_space (&p))
 770         goto err;
 771
 772       if (*p != ',')
 773         goto err;
 774
 775       p++;
 776
 777       if (!pango_scan_int (&p, &height))
 778         goto err;
 779
 780       if (width > 0 && height > 0)
 781         {
 782           icon_size_set_for_settings (settings, name_buf->str,
 783                                       width, height);
 784         }
 785       else
 786         {
 787           g_warning ("Invalid size in gtk-icon-sizes: %d,%d\n", width, height);
 788         }
 789
 790       pango_skip_space (&p);
 791       if (*p == '\0')
 792         break;
 793       if (*p == ':')
 794         p++;
 795       else
 796         goto err;
 797     }
 798
 799   g_string_free (name_buf, TRUE);
 800   return;
 801
 802  err:
 803   g_warning ("Error parsing gtk-icon-sizes string:\n\t'%s'", icon_size_string);
 804   g_string_free (name_buf, TRUE);
 805 }
 806
 807 static void
 808 icon_size_set_all_from_settings (GtkSettings *settings)
 809 {
 810   GArray *settings_sizes;
 811   gchar *icon_size_string;
 812
 813   /* Reset old settings */
 814   settings_sizes = get_settings_sizes (settings, NULL);
 815   g_array_set_size (settings_sizes, 0);
 816
 817   g_object_get (settings,
 818                 "gtk-icon-sizes", &icon_size_string,
 819                 NULL);
 820
 821   if (icon_size_string)
 822     {
 823       icon_size_setting_parse (settings, icon_size_string);
 824       g_free (icon_size_string);
 825     }
 826 }
 827
 828 static void
 829 icon_size_settings_changed (GtkSettings  *settings,
 830                             GParamSpec   *pspec)
 831 {
 832   icon_size_set_all_from_settings (settings);
 833
 834   gtk_rc_reset_styles (settings);
 835 }
 836
 837 static void
 838 icon_sizes_init_for_settings (GtkSettings *settings)
 839 {
 840   g_signal_connect (settings,
 841                     "notify::gtk-icon-sizes",
 842                     G_CALLBACK (icon_size_settings_changed),
 843                     NULL);
 844
 845   icon_size_set_all_from_settings (settings);
 846 }
 847
 848 static gboolean
 849 icon_size_lookup_intern (GtkSettings *settings,
 850                          GtkIconSize  size,
 851                          gint        *widthp,
 852                          gint        *heightp)
 853 {
 854   GArray *settings_sizes;
 855   gint width_for_settings = -1;
 856   gint height_for_settings = -1;
 857
 858   init_icon_sizes ();
 859
 860   if (size == (GtkIconSize)-1)
 861     return FALSE;
 862
 863   if (size >= icon_sizes_used)
 864     return FALSE;
 865
 866   if (size == GTK_ICON_SIZE_INVALID)
 867     return FALSE;
 868
 869   if (settings)
 870     {
 871       gboolean initial = FALSE;
 872
 873       settings_sizes = get_settings_sizes (settings, &initial);
 874
 875       if (initial)
 876         icon_sizes_init_for_settings (settings);
 877
 878       if (size < settings_sizes->len)
 879         {
 880           SettingsIconSize *settings_size;
 881
 882           settings_size = &g_array_index (settings_sizes, SettingsIconSize, size);
 883
 884           width_for_settings = settings_size->width;
 885           height_for_settings = settings_size->height;
 886         }
 887     }
 888
 889   if (widthp)
 890     *widthp = width_for_settings >= 0 ? width_for_settings : icon_sizes[size].width;
 891
 892   if (heightp)
 893     *heightp = height_for_settings >= 0 ? height_for_settings : icon_sizes[size].height;
 894
 895   return TRUE;
 896 }
 897
 898 /**
 899  * gtk_icon_size_lookup_for_settings:
 900  * @settings: a #GtkSettings object, used to determine
 901  *   which set of user preferences to used.
 902  * @size: (type int): an icon size
 903  * @width: location to store icon width
 904  * @height: location to store icon height
 905  *
 906  * Obtains the pixel size of a semantic icon size, possibly
 907  * modified by user preferences for a particular
 908  * #GtkSettings. Normally @size would be
 909  * #GTK_ICON_SIZE_MENU, #GTK_ICON_SIZE_BUTTON, etc.  This function
 910  * isn't normally needed, gtk_widget_render_icon() is the usual
 911  * way to get an icon for rendering, then just look at the size of
 912  * the rendered pixbuf. The rendered pixbuf may not even correspond to
 913  * the width/height returned by gtk_icon_size_lookup(), because themes
 914  * are free to render the pixbuf however they like, including changing
 915  * the usual size.
 916  *
 917  * Return value: %TRUE if @size was a valid size
 918  *
 919  * Since: 2.2
 920  */
 921 gboolean
 922 gtk_icon_size_lookup_for_settings (GtkSettings *settings,
 923                                    GtkIconSize  size,
 924                                    gint        *width,
 925                                    gint        *height)
 926 {
 927   g_return_val_if_fail (GTK_IS_SETTINGS (settings), FALSE);
 928
 929   return icon_size_lookup_intern (settings, size, width, height);
 930 }
 931
 932 /**
 933  * gtk_icon_size_lookup:
 934  * @size: (type int): an icon size
 935  * @width: location to store icon width
 936  * @height: location to store icon height
 937  *
 938  * Obtains the pixel size of a semantic icon size, possibly
 939  * modified by user preferences for the default #GtkSettings.
 940  * (See gtk_icon_size_lookup_for_settings().)
 941  * Normally @size would be
 942  * #GTK_ICON_SIZE_MENU, #GTK_ICON_SIZE_BUTTON, etc.  This function
 943  * isn't normally needed, gtk_widget_render_icon() is the usual
 944  * way to get an icon for rendering, then just look at the size of
 945  * the rendered pixbuf. The rendered pixbuf may not even correspond to
 946  * the width/height returned by gtk_icon_size_lookup(), because themes
 947  * are free to render the pixbuf however they like, including changing
 948  * the usual size.
 949  *
 950  * Return value: %TRUE if @size was a valid size
 951  */
 952 gboolean
 953 gtk_icon_size_lookup (GtkIconSize  size,
 954                       gint        *widthp,
 955                       gint        *heightp)
 956 {
 957   GTK_NOTE (MULTIHEAD,
 958             g_warning ("gtk_icon_size_lookup ()) is not multihead safe"));
 959
 960   return gtk_icon_size_lookup_for_settings (gtk_settings_get_default (),
 961                                             size, widthp, heightp);
 962 }
 963
 964 static GtkIconSize
 965 icon_size_register_intern (const gchar *name,
 966                            gint         width,
 967                            gint         height)
 968 {
 969   IconAlias *old_alias;
 970   GtkIconSize size;
 971
 972   init_icon_sizes ();
 973
 974   old_alias = g_hash_table_lookup (icon_aliases, name);
 975   if (old_alias && icon_sizes[old_alias->target].width > 0)
 976     {
 977       g_warning ("Icon size name '%s' already exists", name);
 978       return GTK_ICON_SIZE_INVALID;
 979     }
 980
 981   if (old_alias)
 982     {
 983       size = old_alias->target;
 984     }
 985   else
 986     {
 987       if (icon_sizes_used == icon_sizes_allocated)
 988         {
 989           icon_sizes_allocated *= 2;
 990           icon_sizes = g_renew (IconSize, icon_sizes, icon_sizes_allocated);
 991         }
 992
 993       size = icon_sizes_used++;
 994
 995       /* alias to self. */
 996       gtk_icon_size_register_alias (name, size);
 997
 998       icon_sizes[size].size = size;
 999       icon_sizes[size].name = g_strdup (name);
1000     }
1001
1002   icon_sizes[size].width = width;
1003   icon_sizes[size].height = height;
1004
1005   return size;
1006 }
1007
1008 /**
1009  * gtk_icon_size_register:
1010  * @name: name of the icon size
1011  * @width: the icon width
1012  * @height: the icon height
1013  *
1014  * Registers a new icon size, along the same lines as #GTK_ICON_SIZE_MENU,
1015  * etc. Returns the integer value for the size.
1016  *
1017  * Returns: (type int): integer value representing the size
1018  */
1019 GtkIconSize
1020 gtk_icon_size_register (const gchar *name,
1021                         gint         width,
1022                         gint         height)
1023 {
1024   g_return_val_if_fail (name != NULL, 0);
1025   g_return_val_if_fail (width > 0, 0);
1026   g_return_val_if_fail (height > 0, 0);
1027
1028   return icon_size_register_intern (name, width, height);
1029 }
1030
1031 /**
1032  * gtk_icon_size_register_alias:
1033  * @alias: an alias for @target
1034  * @target: (type int): an existing icon size
1035  *
1036  * Registers @alias as another name for @target.
1037  * So calling gtk_icon_size_from_name() with @alias as argument
1038  * will return @target.
1039  */
1040 void
1041 gtk_icon_size_register_alias (const gchar *alias,
1042                               GtkIconSize  target)
1043 {
1044   IconAlias *ia;
1045
1046   g_return_if_fail (alias != NULL);
1047
1048   init_icon_sizes ();
1049
1050   if (!icon_size_lookup_intern (NULL, target, NULL, NULL))
1051     g_warning ("gtk_icon_size_register_alias: Icon size %u does not exist", target);
1052
1053   ia = g_hash_table_lookup (icon_aliases, alias);
1054   if (ia)
1055     {
1056       if (icon_sizes[ia->target].width > 0)
1057         {
1058           g_warning ("gtk_icon_size_register_alias: Icon size name '%s' already exists", alias);
1059           return;
1060         }
1061
1062       ia->target = target;
1063     }
1064
1065   if (!ia)
1066     {
1067       ia = g_new (IconAlias, 1);
1068       ia->name = g_strdup (alias);
1069       ia->target = target;
1070
1071       g_hash_table_insert (icon_aliases, ia->name, ia);
1072     }
1073 }
1074
1075 /**
1076  * gtk_icon_size_from_name:
1077  * @name: the name to look up.
1078  * @returns: the icon size with the given name.
1079  *
1080  * Looks up the icon size associated with @name.
1081  *
1082  * Return value: (type int): the icon size
1083  */
1084 GtkIconSize
1085 gtk_icon_size_from_name (const gchar *name)
1086 {
1087   IconAlias *ia;
1088
1089   init_icon_sizes ();
1090
1091   ia = g_hash_table_lookup (icon_aliases, name);
1092
1093   if (ia && icon_sizes[ia->target].width > 0)
1094     return ia->target;
1095   else
1096     return GTK_ICON_SIZE_INVALID;
1097 }
1098
1099 /**
1100  * gtk_icon_size_get_name:
1101  * @size: (type int): a #GtkIconSize.
1102  * @returns: the name of the given icon size.
1103  *
1104  * Gets the canonical name of the given icon size. The returned string
1105  * is statically allocated and should not be freed.
1106  */
1107 G_CONST_RETURN gchar*
1108 gtk_icon_size_get_name (GtkIconSize  size)
1109 {
1110   if (size >= icon_sizes_used)
1111     return NULL;
1112   else
1113     return icon_sizes[size].name;
1114 }
1115
1116 /************************************************************/
1117
1118 /* Icon Set */
1119
1120
1121 static GdkPixbuf *find_in_cache     (GtkIconSet       *icon_set,
1122                                      GtkStyle         *style,
1123                                      GtkTextDirection  direction,
1124                                      GtkStateType      state,
1125                                      GtkIconSize       size);
1126 static void       add_to_cache      (GtkIconSet       *icon_set,
1127                                      GtkStyle         *style,
1128                                      GtkTextDirection  direction,
1129                                      GtkStateType      state,
1130                                      GtkIconSize       size,
1131                                      GdkPixbuf        *pixbuf);
1132 /* Clear icon set contents, drop references to all contained
1133  * GdkPixbuf objects and forget all GtkIconSources. Used to
1134  * recycle an icon set.
1135  */
1136 static void       clear_cache       (GtkIconSet       *icon_set,
1137                                      gboolean          style_detach);
1138 static GSList*    copy_cache        (GtkIconSet       *icon_set,
1139                                      GtkIconSet       *copy_recipient);
1140 static void       attach_to_style   (GtkIconSet       *icon_set,
1141                                      GtkStyle         *style);
1142 static void       detach_from_style (GtkIconSet       *icon_set,
1143                                      GtkStyle         *style);
1144 static void       style_dnotify     (gpointer          data);
1145
1146 struct _GtkIconSet
1147 {
1148   guint ref_count;
1149
1150   GSList *sources;
1151
1152   /* Cache of the last few rendered versions of the icon. */
1153   GSList *cache;
1154
1155   guint cache_size;
1156
1157   guint cache_serial;
1158 };
1159
1160 static guint cache_serial = 0;
1161
1162 /**
1163  * gtk_icon_set_new:
1164  *
1165  * Creates a new #GtkIconSet. A #GtkIconSet represents a single icon
1166  * in various sizes and widget states. It can provide a #GdkPixbuf
1167  * for a given size and state on request, and automatically caches
1168  * some of the rendered #GdkPixbuf objects.
1169  *
1170  * Normally you would use gtk_widget_render_icon() instead of
1171  * using #GtkIconSet directly. The one case where you'd use
1172  * #GtkIconSet is to create application-specific icon sets to place in
1173  * a #GtkIconFactory.
1174  *
1175  * Return value: a new #GtkIconSet
1176  */
1177 GtkIconSet*
1178 gtk_icon_set_new (void)
1179 {
1180   GtkIconSet *icon_set;
1181
1182   icon_set = g_new (GtkIconSet, 1);
1183
1184   icon_set->ref_count = 1;
1185   icon_set->sources = NULL;
1186   icon_set->cache = NULL;
1187   icon_set->cache_size = 0;
1188   icon_set->cache_serial = cache_serial;
1189
1190   return icon_set;
1191 }
1192
1193 /**
1194  * gtk_icon_set_new_from_pixbuf:
1195  * @pixbuf: a #GdkPixbuf
1196  *
1197  * Creates a new #GtkIconSet with @pixbuf as the default/fallback
1198  * source image. If you don't add any additional #GtkIconSource to the
1199  * icon set, all variants of the icon will be created from @pixbuf,
1200  * using scaling, pixelation, etc. as required to adjust the icon size
1201  * or make the icon look insensitive/prelighted.
1202  *
1203  * Return value: a new #GtkIconSet
1204  */
1205 GtkIconSet *
1206 gtk_icon_set_new_from_pixbuf (GdkPixbuf *pixbuf)
1207 {
1208   GtkIconSet *set;
1209
1210   GtkIconSource source = GTK_ICON_SOURCE_INIT (TRUE, TRUE, TRUE);
1211
1212   g_return_val_if_fail (pixbuf != NULL, NULL);
1213
1214   set = gtk_icon_set_new ();
1215
1216   gtk_icon_source_set_pixbuf (&source, pixbuf);
1217   gtk_icon_set_add_source (set, &source);
1218   gtk_icon_source_set_pixbuf (&source, NULL);
1219
1220   return set;
1221 }
1222
1223
1224 /**
1225  * gtk_icon_set_ref:
1226  * @icon_set: a #GtkIconSet.
1227  *
1228  * Increments the reference count on @icon_set.
1229  *
1230  * Return value: @icon_set.
1231  */
1232 GtkIconSet*
1233 gtk_icon_set_ref (GtkIconSet *icon_set)
1234 {
1235   g_return_val_if_fail (icon_set != NULL, NULL);
1236   g_return_val_if_fail (icon_set->ref_count > 0, NULL);
1237
1238   icon_set->ref_count += 1;
1239
1240   return icon_set;
1241 }
1242
1243 /**
1244  * gtk_icon_set_unref:
1245  * @icon_set: a #GtkIconSet
1246  *
1247  * Decrements the reference count on @icon_set, and frees memory
1248  * if the reference count reaches 0.
1249  */
1250 void
1251 gtk_icon_set_unref (GtkIconSet *icon_set)
1252 {
1253   g_return_if_fail (icon_set != NULL);
1254   g_return_if_fail (icon_set->ref_count > 0);
1255
1256   icon_set->ref_count -= 1;
1257
1258   if (icon_set->ref_count == 0)
1259     {
1260       GSList *tmp_list = icon_set->sources;
1261       while (tmp_list != NULL)
1262         {
1263           gtk_icon_source_free (tmp_list->data);
1264
1265           tmp_list = g_slist_next (tmp_list);
1266         }
1267       g_slist_free (icon_set->sources);
1268
1269       clear_cache (icon_set, TRUE);
1270
1271       g_free (icon_set);
1272     }
1273 }
1274
1275 GType
1276 gtk_icon_set_get_type (void)
1277 {
1278   static GType our_type = 0;
1279
1280   if (our_type == 0)
1281     our_type = g_boxed_type_register_static (I_("GtkIconSet"),
1282                                              (GBoxedCopyFunc) gtk_icon_set_ref,
1283                                              (GBoxedFreeFunc) gtk_icon_set_unref);
1284
1285   return our_type;
1286 }
1287
1288 /**
1289  * gtk_icon_set_copy:
1290  * @icon_set: a #GtkIconSet
1291  *
1292  * Copies @icon_set by value.
1293  *
1294  * Return value: a new #GtkIconSet identical to the first.
1295  **/
1296 GtkIconSet*
1297 gtk_icon_set_copy (GtkIconSet *icon_set)
1298 {
1299   GtkIconSet *copy;
1300   GSList *tmp_list;
1301
1302   copy = gtk_icon_set_new ();
1303
1304   tmp_list = icon_set->sources;
1305   while (tmp_list != NULL)
1306     {
1307       copy->sources = g_slist_prepend (copy->sources,
1308                                        gtk_icon_source_copy (tmp_list->data));
1309
1310       tmp_list = g_slist_next (tmp_list);
1311     }
1312
1313   copy->sources = g_slist_reverse (copy->sources);
1314
1315   copy->cache = copy_cache (icon_set, copy);
1316   copy->cache_size = icon_set->cache_size;
1317   copy->cache_serial = icon_set->cache_serial;
1318
1319   return copy;
1320 }
1321
1322 static gboolean
1323 sizes_equivalent (GtkIconSize lhs,
1324                   GtkIconSize rhs)
1325 {
1326   /* We used to consider sizes equivalent if they were
1327    * the same pixel size, but we don't have the GtkSettings
1328    * here, so we can't do that. Plus, it's not clear that
1329    * it is right... it was just a workaround for the fact
1330    * that we register icons by logical size, not pixel size.
1331    */
1332 #if 1
1333   return lhs == rhs;
1334 #else
1335
1336   gint r_w, r_h, l_w, l_h;
1337
1338   icon_size_lookup_intern (NULL, rhs, &r_w, &r_h);
1339   icon_size_lookup_intern (NULL, lhs, &l_w, &l_h);
1340
1341   return r_w == l_w && r_h == l_h;
1342 #endif
1343 }
1344
1345 static GtkIconSource *
1346 find_best_matching_source (GtkIconSet       *icon_set,
1347                            GtkTextDirection  direction,
1348                            GtkStateType      state,
1349                            GtkIconSize       size,
1350                            GSList           *failed)
1351 {
1352   GtkIconSource *source;
1353   GSList *tmp_list;
1354
1355   /* We need to find the best icon source.  Direction matters more
1356    * than state, state matters more than size. icon_set->sources
1357    * is sorted according to wildness, so if we take the first
1358    * match we find it will be the least-wild match (if there are
1359    * multiple matches for a given "wildness" then the RC file contained
1360    * dumb stuff, and we end up with an arbitrary matching source)
1361    */
1362
1363   source = NULL;
1364   tmp_list = icon_set->sources;
1365   while (tmp_list != NULL)
1366     {
1367       GtkIconSource *s = tmp_list->data;
1368
1369       if ((s->any_direction || (s->direction == direction)) &&
1370           (s->any_state || (s->state == state)) &&
1371           (s->any_size || size == (GtkIconSize)-1 || (sizes_equivalent (size, s->size))))
1372         {
1373           if (!g_slist_find (failed, s))
1374             {
1375               source = s;
1376               break;
1377             }
1378         }
1379
1380       tmp_list = g_slist_next (tmp_list);
1381     }
1382
1383   return source;
1384 }
1385
1386 static gboolean
1387 ensure_filename_pixbuf (GtkIconSet    *icon_set,
1388                         GtkIconSource *source)
1389 {
1390   if (source->filename_pixbuf == NULL)
1391     {
1392       GError *error = NULL;
1393
1394       source->filename_pixbuf = gdk_pixbuf_new_from_file (source->source.filename, &error);
1395
1396       if (source->filename_pixbuf == NULL)
1397         {
1398           /* Remove this icon source so we don't keep trying to
1399            * load it.
1400            */
1401           g_warning (_("Error loading icon: %s"), error->message);
1402           g_error_free (error);
1403
1404           icon_set->sources = g_slist_remove (icon_set->sources, source);
1405
1406           gtk_icon_source_free (source);
1407
1408           return FALSE;
1409         }
1410     }
1411
1412   return TRUE;
1413 }
1414
1415 static GdkPixbuf *
1416 render_icon_name_pixbuf (GtkIconSource    *icon_source,
1417                          GtkStyle         *style,
1418                          GtkTextDirection  direction,
1419                          GtkStateType      state,
1420                          GtkIconSize       size,
1421                          GtkWidget         *widget,
1422                          const char        *detail)
1423 {
1424   GdkPixbuf *pixbuf;
1425   GdkPixbuf *tmp_pixbuf;
1426   GtkIconSource tmp_source;
1427   GdkScreen *screen;
1428   GtkIconTheme *icon_theme;
1429   GtkSettings *settings;
1430   gint width, height, pixel_size;
1431   gint *sizes, *s, dist;
1432   GError *error = NULL;
1433
1434   if (widget && gtk_widget_has_screen (widget))
1435     screen = gtk_widget_get_screen (widget);
1436   else if (style && style->colormap)
1437     screen = gdk_colormap_get_screen (style->colormap);
1438   else
1439     {
1440       screen = gdk_screen_get_default ();
1441       GTK_NOTE (MULTIHEAD,
1442                 g_warning ("Using the default screen for gtk_icon_source_render_icon()"));
1443     }
1444
1445   icon_theme = gtk_icon_theme_get_for_screen (screen);
1446   settings = gtk_settings_get_for_screen (screen);
1447
1448   if (!gtk_icon_size_lookup_for_settings (settings, size, &width, &height))
1449     {
1450       if (size == (GtkIconSize)-1)
1451         {
1452           /* Find an available size close to 48 */
1453           sizes = gtk_icon_theme_get_icon_sizes (icon_theme, icon_source->source.icon_name);
1454           dist = 1000;
1455           width = height = 48;
1456           for (s = sizes; *s; s++)
1457             {
1458               if (*s == -1)
1459                 {
1460                   width = height = 48;
1461                   break;
1462                 }
1463               if (*s < 48)
1464                 {
1465                   if (48 - *s < dist)
1466                     {
1467                       width = height = *s;
1468                       dist = 48 - *s;
1469                     }
1470                 }
1471               else
1472                 {
1473                   if (*s - 48 < dist)
1474                     {
1475                       width = height = *s;
1476                       dist = *s - 48;
1477                     }
1478                 }
1479             }
1480
1481           g_free (sizes);
1482         }
1483       else
1484         {
1485           g_warning ("Invalid icon size %u\n", size);
1486           width = height = 24;
1487         }
1488     }
1489
1490   pixel_size = MIN (width, height);
1491
1492   tmp_pixbuf = gtk_icon_theme_load_icon (icon_theme,
1493                                          icon_source->source.icon_name,
1494                                          pixel_size, 0,
1495                                          &error);
1496
1497   if (!tmp_pixbuf)
1498     {
1499       g_warning ("Error loading theme icon '%s' for stock: %s",
1500                  icon_source->source.icon_name, error ? error->message : "");
1501       if (error)
1502         g_error_free (error);
1503       return NULL;
1504     }
1505
1506   tmp_source = *icon_source;
1507   tmp_source.type = GTK_ICON_SOURCE_PIXBUF;
1508   tmp_source.source.pixbuf = tmp_pixbuf;
1509
1510   pixbuf = gtk_style_render_icon (style, &tmp_source,
1511                                   direction, state, -1,
1512                                   widget, detail);
1513
1514   if (!pixbuf)
1515     g_warning ("Failed to render icon");
1516
1517   g_object_unref (tmp_pixbuf);
1518
1519   return pixbuf;
1520 }
1521
1522 static GdkPixbuf *
1523 find_and_render_icon_source (GtkIconSet       *icon_set,
1524                              GtkStyle         *style,
1525                              GtkTextDirection  direction,
1526                              GtkStateType      state,
1527                              GtkIconSize       size,
1528                              GtkWidget         *widget,
1529                              const char        *detail)
1530 {
1531   GSList *failed = NULL;
1532   GdkPixbuf *pixbuf = NULL;
1533
1534   /* We treat failure in two different ways:
1535    *
1536    *  A) If loading a source that specifies a filename fails,
1537    *     we treat that as permanent, and remove the source
1538    *     from the GtkIconSet. (in ensure_filename_pixbuf ()
1539    *  B) If loading a themed icon fails, or scaling an icon
1540    *     fails, we treat that as transient and will try
1541    *     again next time the icon falls out of the cache
1542    *     and we need to recreate it.
1543    */
1544   while (pixbuf == NULL)
1545     {
1546       GtkIconSource *source = find_best_matching_source (icon_set, direction, state, size, failed);
1547
1548       if (source == NULL)
1549         break;
1550
1551       switch (source->type)
1552         {
1553         case GTK_ICON_SOURCE_FILENAME:
1554           if (!ensure_filename_pixbuf (icon_set, source))
1555             break;
1556           /* Fall through */
1557         case GTK_ICON_SOURCE_PIXBUF:
1558           pixbuf = gtk_style_render_icon (style, source,
1559                                           direction, state, size,
1560                                           widget, detail);
1561           if (!pixbuf)
1562             {
1563               g_warning ("Failed to render icon");
1564               failed = g_slist_prepend (failed, source);
1565             }
1566           break;
1567         case GTK_ICON_SOURCE_ICON_NAME:
1568         case GTK_ICON_SOURCE_STATIC_ICON_NAME:
1569           pixbuf = render_icon_name_pixbuf (source, style,
1570                                             direction, state, size,
1571                                             widget, detail);
1572           if (!pixbuf)
1573             failed = g_slist_prepend (failed, source);
1574           break;
1575         case GTK_ICON_SOURCE_EMPTY:
1576           g_assert_not_reached ();
1577         }
1578     }
1579
1580   g_slist_free (failed);
1581
1582   return pixbuf;
1583 }
1584
1585 extern GtkIconCache *_builtin_cache;
1586
1587 static GdkPixbuf*
1588 render_fallback_image (GtkStyle          *style,
1589                        GtkTextDirection   direction,
1590                        GtkStateType       state,
1591                        GtkIconSize        size,
1592                        GtkWidget         *widget,
1593                        const char        *detail)
1594 {
1595   /* This icon can be used for any direction/state/size */
1596   static GtkIconSource fallback_source = GTK_ICON_SOURCE_INIT (TRUE, TRUE, TRUE);
1597
1598   if (fallback_source.type == GTK_ICON_SOURCE_EMPTY)
1599     {
1600       gint index;
1601       GdkPixbuf *pixbuf;
1602
1603       _gtk_icon_theme_ensure_builtin_cache ();
1604
1605       index = _gtk_icon_cache_get_directory_index (_builtin_cache, "24");
1606       pixbuf = _gtk_icon_cache_get_icon (_builtin_cache,
1607                                          GTK_STOCK_MISSING_IMAGE,
1608                                          index);
1609       gtk_icon_source_set_pixbuf (&fallback_source, pixbuf);
1610       g_object_unref (pixbuf);
1611     }
1612
1613   return gtk_style_render_icon (style,
1614                                 &fallback_source,
1615                                 direction,
1616                                 state,
1617                                 size,
1618                                 widget,
1619                                 detail);
1620 }
1621
1622 /**
1623  * gtk_icon_set_render_icon:
1624  * @icon_set: a #GtkIconSet
1625  * @style: (allow-none): a #GtkStyle associated with @widget, or %NULL
1626  * @direction: text direction
1627  * @state: widget state
1628  * @size: (type int): icon size. A size of (GtkIconSize)-1
1629  *        means render at the size of the source and don't scale.
1630  * @widget: (allow-none): widget that will display the icon, or %NULL.
1631  *          The only use that is typically made of this
1632  *          is to determine the appropriate #GdkScreen.
1633  * @detail: (allow-none): detail to pass to the theme engine, or %NULL.
1634  *          Note that passing a detail of anything but %NULL
1635  *          will disable caching.
1636  *
1637  * Renders an icon using gtk_style_render_icon(). In most cases,
1638  * gtk_widget_render_icon() is better, since it automatically provides
1639  * most of the arguments from the current widget settings.  This
1640  * function never returns %NULL; if the icon can't be rendered
1641  * (perhaps because an image file fails to load), a default "missing
1642  * image" icon will be returned instead.
1643  *
1644  * Return value: a #GdkPixbuf to be displayed
1645  */
1646 GdkPixbuf*
1647 gtk_icon_set_render_icon (GtkIconSet        *icon_set,
1648                           GtkStyle          *style,
1649                           GtkTextDirection   direction,
1650                           GtkStateType       state,
1651                           GtkIconSize        size,
1652                           GtkWidget         *widget,
1653                           const char        *detail)
1654 {
1655   GdkPixbuf *icon;
1656
1657   g_return_val_if_fail (icon_set != NULL, NULL);
1658   g_return_val_if_fail (style == NULL || GTK_IS_STYLE (style), NULL);
1659
1660   if (icon_set->sources == NULL)
1661     return render_fallback_image (style, direction, state, size, widget, detail);
1662
1663   if (detail == NULL)
1664     {
1665       icon = find_in_cache (icon_set, style, direction,
1666                         state, size);
1667
1668       if (icon)
1669         {
1670           g_object_ref (icon);
1671           return icon;
1672         }
1673     }
1674
1675
1676   icon = find_and_render_icon_source (icon_set, style, direction, state, size,
1677                                       widget, detail);
1678
1679   if (icon == NULL)
1680     icon = render_fallback_image (style, direction, state, size, widget, detail);
1681
1682   if (detail == NULL)
1683     add_to_cache (icon_set, style, direction, state, size, icon);
1684
1685   return icon;
1686 }
1687
1688 /* Order sources by their "wildness", so that "wilder" sources are
1689  * greater than "specific" sources; for determining ordering,
1690  * direction beats state beats size.
1691  */
1692
1693 static int
1694 icon_source_compare (gconstpointer ap, gconstpointer bp)
1695 {
1696   const GtkIconSource *a = ap;
1697   const GtkIconSource *b = bp;
1698
1699   if (!a->any_direction && b->any_direction)
1700     return -1;
1701   else if (a->any_direction && !b->any_direction)
1702     return 1;
1703   else if (!a->any_state && b->any_state)
1704     return -1;
1705   else if (a->any_state && !b->any_state)
1706     return 1;
1707   else if (!a->any_size && b->any_size)
1708     return -1;
1709   else if (a->any_size && !b->any_size)
1710     return 1;
1711   else
1712     return 0;
1713 }
1714
1715 /**
1716  * gtk_icon_set_add_source:
1717  * @icon_set: a #GtkIconSet
1718  * @source: a #GtkIconSource
1719  *
1720  * Icon sets have a list of #GtkIconSource, which they use as base
1721  * icons for rendering icons in different states and sizes. Icons are
1722  * scaled, made to look insensitive, etc. in
1723  * gtk_icon_set_render_icon(), but #GtkIconSet needs base images to
1724  * work with. The base images and when to use them are described by
1725  * a #GtkIconSource.
1726  *
1727  * This function copies @source, so you can reuse the same source immediately
1728  * without affecting the icon set.
1729  *
1730  * An example of when you'd use this function: a web browser's "Back
1731  * to Previous Page" icon might point in a different direction in
1732  * Hebrew and in English; it might look different when insensitive;
1733  * and it might change size depending on toolbar mode (small/large
1734  * icons). So a single icon set would contain all those variants of
1735  * the icon, and you might add a separate source for each one.
1736  *
1737  * You should nearly always add a "default" icon source with all
1738  * fields wildcarded, which will be used as a fallback if no more
1739  * specific source matches. #GtkIconSet always prefers more specific
1740  * icon sources to more generic icon sources. The order in which you
1741  * add the sources to the icon set does not matter.
1742  *
1743  * gtk_icon_set_new_from_pixbuf() creates a new icon set with a
1744  * default icon source based on the given pixbuf.
1745  */
1746 void
1747 gtk_icon_set_add_source (GtkIconSet          *icon_set,
1748                          const GtkIconSource *source)
1749 {
1750   g_return_if_fail (icon_set != NULL);
1751   g_return_if_fail (source != NULL);
1752
1753   if (source->type == GTK_ICON_SOURCE_EMPTY)
1754     {
1755       g_warning ("Useless empty GtkIconSource");
1756       return;
1757     }
1758
1759   icon_set->sources = g_slist_insert_sorted (icon_set->sources,
1760                                              gtk_icon_source_copy (source),
1761                                              icon_source_compare);
1762 }
1763
1764 /**
1765  * gtk_icon_set_get_sizes:
1766  * @icon_set: a #GtkIconSet
1767  * @sizes: (array length=n_sizes) (out) (type int): return location
1768  *     for array of sizes
1769  * @n_sizes: location to store number of elements in returned array
1770  *
1771  * Obtains a list of icon sizes this icon set can render. The returned
1772  * array must be freed with g_free().
1773  */
1774 void
1775 gtk_icon_set_get_sizes (GtkIconSet   *icon_set,
1776                         GtkIconSize **sizes,
1777                         gint         *n_sizes)
1778 {
1779   GSList *tmp_list;
1780   gboolean all_sizes = FALSE;
1781   GSList *specifics = NULL;
1782
1783   g_return_if_fail (icon_set != NULL);
1784   g_return_if_fail (sizes != NULL);
1785   g_return_if_fail (n_sizes != NULL);
1786
1787   tmp_list = icon_set->sources;
1788   while (tmp_list != NULL)
1789     {
1790       GtkIconSource *source;
1791
1792       source = tmp_list->data;
1793
1794       if (source->any_size)
1795         {
1796           all_sizes = TRUE;
1797           break;
1798         }
1799       else
1800         specifics = g_slist_prepend (specifics, GINT_TO_POINTER (source->size));
1801
1802       tmp_list = g_slist_next (tmp_list);
1803     }
1804
1805   if (all_sizes)
1806     {
1807       /* Need to find out what sizes exist */
1808       gint i;
1809
1810       init_icon_sizes ();
1811
1812       *sizes = g_new (GtkIconSize, icon_sizes_used);
1813       *n_sizes = icon_sizes_used - 1;
1814
1815       i = 1;
1816       while (i < icon_sizes_used)
1817         {
1818           (*sizes)[i - 1] = icon_sizes[i].size;
1819           ++i;
1820         }
1821     }
1822   else
1823     {
1824       gint i;
1825
1826       *n_sizes = g_slist_length (specifics);
1827       *sizes = g_new (GtkIconSize, *n_sizes);
1828
1829       i = 0;
1830       tmp_list = specifics;
1831       while (tmp_list != NULL)
1832         {
1833           (*sizes)[i] = GPOINTER_TO_INT (tmp_list->data);
1834
1835           ++i;
1836           tmp_list = g_slist_next (tmp_list);
1837         }
1838     }
1839
1840   g_slist_free (specifics);
1841 }
1842
1843
1844 /**
1845  * gtk_icon_source_new:
1846  *
1847  * Creates a new #GtkIconSource. A #GtkIconSource contains a #GdkPixbuf (or
1848  * image filename) that serves as the base image for one or more of the
1849  * icons in a #GtkIconSet, along with a specification for which icons in the
1850  * icon set will be based on that pixbuf or image file. An icon set contains
1851  * a set of icons that represent "the same" logical concept in different states,
1852  * different global text directions, and different sizes.
1853  *
1854  * So for example a web browser's "Back to Previous Page" icon might
1855  * point in a different direction in Hebrew and in English; it might
1856  * look different when insensitive; and it might change size depending
1857  * on toolbar mode (small/large icons). So a single icon set would
1858  * contain all those variants of the icon. #GtkIconSet contains a list
1859  * of #GtkIconSource from which it can derive specific icon variants in
1860  * the set.
1861  *
1862  * In the simplest case, #GtkIconSet contains one source pixbuf from
1863  * which it derives all variants. The convenience function
1864  * gtk_icon_set_new_from_pixbuf() handles this case; if you only have
1865  * one source pixbuf, just use that function.
1866  *
1867  * If you want to use a different base pixbuf for different icon
1868  * variants, you create multiple icon sources, mark which variants
1869  * they'll be used to create, and add them to the icon set with
1870  * gtk_icon_set_add_source().
1871  *
1872  * By default, the icon source has all parameters wildcarded. That is,
1873  * the icon source will be used as the base icon for any desired text
1874  * direction, widget state, or icon size.
1875  *
1876  * Return value: a new #GtkIconSource
1877  */
1878 GtkIconSource*
1879 gtk_icon_source_new (void)
1880 {
1881   GtkIconSource *src;
1882
1883   src = g_new0 (GtkIconSource, 1);
1884
1885   src->direction = GTK_TEXT_DIR_NONE;
1886   src->size = GTK_ICON_SIZE_INVALID;
1887   src->state = GTK_STATE_NORMAL;
1888
1889   src->any_direction = TRUE;
1890   src->any_state = TRUE;
1891   src->any_size = TRUE;
1892
1893   return src;
1894 }
1895
1896 /**
1897  * gtk_icon_source_copy:
1898  * @source: a #GtkIconSource
1899  *
1900  * Creates a copy of @source; mostly useful for language bindings.
1901  *
1902  * Return value: a new #GtkIconSource
1903  */
1904 GtkIconSource*
1905 gtk_icon_source_copy (const GtkIconSource *source)
1906 {
1907   GtkIconSource *copy;
1908
1909   g_return_val_if_fail (source != NULL, NULL);
1910
1911   copy = g_new (GtkIconSource, 1);
1912
1913   *copy = *source;
1914
1915   switch (copy->type)
1916     {
1917     case GTK_ICON_SOURCE_EMPTY:
1918     case GTK_ICON_SOURCE_STATIC_ICON_NAME:
1919       break;
1920     case GTK_ICON_SOURCE_ICON_NAME:
1921       copy->source.icon_name = g_strdup (copy->source.icon_name);
1922       break;
1923     case GTK_ICON_SOURCE_FILENAME:
1924       copy->source.filename = g_strdup (copy->source.filename);
1925 #if defined (G_OS_WIN32) && !defined (_WIN64)
1926       copy->cp_filename = g_strdup (copy->cp_filename);
1927 #endif
1928       if (copy->filename_pixbuf)
1929         g_object_ref (copy->filename_pixbuf);
1930       break;
1931     case GTK_ICON_SOURCE_PIXBUF:
1932       g_object_ref (copy->source.pixbuf);
1933       break;
1934     default:
1935       g_assert_not_reached();
1936     }
1937
1938   return copy;
1939 }
1940
1941 /**
1942  * gtk_icon_source_free:
1943  * @source: a #GtkIconSource
1944  *
1945  * Frees a dynamically-allocated icon source, along with its
1946  * filename, size, and pixbuf fields if those are not %NULL.
1947  */
1948 void
1949 gtk_icon_source_free (GtkIconSource *source)
1950 {
1951   g_return_if_fail (source != NULL);
1952
1953   icon_source_clear (source);
1954   g_free (source);
1955 }
1956
1957 GType
1958 gtk_icon_source_get_type (void)
1959 {
1960   static GType our_type = 0;
1961
1962   if (our_type == 0)
1963     our_type = g_boxed_type_register_static (I_("GtkIconSource"),
1964                                              (GBoxedCopyFunc) gtk_icon_source_copy,
1965                                              (GBoxedFreeFunc) gtk_icon_source_free);
1966
1967   return our_type;
1968 }
1969
1970 static void
1971 icon_source_clear (GtkIconSource *source)
1972 {
1973   switch (source->type)
1974     {
1975     case GTK_ICON_SOURCE_EMPTY:
1976       break;
1977     case GTK_ICON_SOURCE_ICON_NAME:
1978       g_free (source->source.icon_name);
1979       /* fall thru */
1980     case GTK_ICON_SOURCE_STATIC_ICON_NAME:
1981       source->source.icon_name = NULL;
1982       break;
1983     case GTK_ICON_SOURCE_FILENAME:
1984       g_free (source->source.filename);
1985       source->source.filename = NULL;
1986 #if defined (G_OS_WIN32) && !defined (_WIN64)
1987       g_free (source->cp_filename);
1988       source->cp_filename = NULL;
1989 #endif
1990       if (source->filename_pixbuf)
1991         g_object_unref (source->filename_pixbuf);
1992       source->filename_pixbuf = NULL;
1993       break;
1994     case GTK_ICON_SOURCE_PIXBUF:
1995       g_object_unref (source->source.pixbuf);
1996       source->source.pixbuf = NULL;
1997       break;
1998     default:
1999       g_assert_not_reached();
2000     }
2001
2002   source->type = GTK_ICON_SOURCE_EMPTY;
2003 }
2004
2005 /**
2006  * gtk_icon_source_set_filename:
2007  * @source: a #GtkIconSource
2008  * @filename: image file to use
2009  *
2010  * Sets the name of an image file to use as a base image when creating
2011  * icon variants for #GtkIconSet. The filename must be absolute.
2012  */
2013 void
2014 gtk_icon_source_set_filename (GtkIconSource *source,
2015                               const gchar   *filename)
2016 {
2017   g_return_if_fail (source != NULL);
2018   g_return_if_fail (filename == NULL || g_path_is_absolute (filename));
2019
2020   if (source->type == GTK_ICON_SOURCE_FILENAME &&
2021       source->source.filename == filename)
2022     return;
2023
2024   icon_source_clear (source);
2025
2026   if (filename != NULL)
2027     {
2028       source->type = GTK_ICON_SOURCE_FILENAME;
2029       source->source.filename = g_strdup (filename);
2030 #if defined (G_OS_WIN32) && !defined (_WIN64)
2031       source->cp_filename = g_locale_from_utf8 (filename, -1, NULL, NULL, NULL);
2032 #endif
2033     }
2034 }
2035
2036 /**
2037  * gtk_icon_source_set_icon_name
2038  * @source: a #GtkIconSource
2039  * @icon_name: (allow-none): name of icon to use
2040  *
2041  * Sets the name of an icon to look up in the current icon theme
2042  * to use as a base image when creating icon variants for #GtkIconSet.
2043  */
2044 void
2045 gtk_icon_source_set_icon_name (GtkIconSource *source,
2046                                const gchar   *icon_name)
2047 {
2048   g_return_if_fail (source != NULL);
2049
2050   if (source->type == GTK_ICON_SOURCE_ICON_NAME &&
2051       source->source.icon_name == icon_name)
2052     return;
2053
2054   icon_source_clear (source);
2055
2056   if (icon_name != NULL)
2057     {
2058       source->type = GTK_ICON_SOURCE_ICON_NAME;
2059       source->source.icon_name = g_strdup (icon_name);
2060     }
2061 }
2062
2063 /**
2064  * gtk_icon_source_set_pixbuf:
2065  * @source: a #GtkIconSource
2066  * @pixbuf: pixbuf to use as a source
2067  *
2068  * Sets a pixbuf to use as a base image when creating icon variants
2069  * for #GtkIconSet.
2070  */
2071 void
2072 gtk_icon_source_set_pixbuf (GtkIconSource *source,
2073                             GdkPixbuf     *pixbuf)
2074 {
2075   g_return_if_fail (source != NULL);
2076   g_return_if_fail (pixbuf == NULL || GDK_IS_PIXBUF (pixbuf));
2077
2078   if (source->type == GTK_ICON_SOURCE_PIXBUF &&
2079       source->source.pixbuf == pixbuf)
2080     return;
2081
2082   icon_source_clear (source);
2083
2084   if (pixbuf != NULL)
2085     {
2086       source->type = GTK_ICON_SOURCE_PIXBUF;
2087       source->source.pixbuf = g_object_ref (pixbuf);
2088     }
2089 }
2090
2091 /**
2092  * gtk_icon_source_get_filename:
2093  * @source: a #GtkIconSource
2094  *
2095  * Retrieves the source filename, or %NULL if none is set. The
2096  * filename is not a copy, and should not be modified or expected to
2097  * persist beyond the lifetime of the icon source.
2098  *
2099  * Return value: image filename. This string must not be modified
2100  * or freed.
2101  */
2102 G_CONST_RETURN gchar*
2103 gtk_icon_source_get_filename (const GtkIconSource *source)
2104 {
2105   g_return_val_if_fail (source != NULL, NULL);
2106
2107   if (source->type == GTK_ICON_SOURCE_FILENAME)
2108     return source->source.filename;
2109   else
2110     return NULL;
2111 }
2112
2113 /**
2114  * gtk_icon_source_get_icon_name:
2115  * @source: a #GtkIconSource
2116  *
2117  * Retrieves the source icon name, or %NULL if none is set. The
2118  * icon_name is not a copy, and should not be modified or expected to
2119  * persist beyond the lifetime of the icon source.
2120  *
2121  * Return value: icon name. This string must not be modified or freed.
2122  */
2123 G_CONST_RETURN gchar*
2124 gtk_icon_source_get_icon_name (const GtkIconSource *source)
2125 {
2126   g_return_val_if_fail (source != NULL, NULL);
2127
2128   if (source->type == GTK_ICON_SOURCE_ICON_NAME ||
2129      source->type == GTK_ICON_SOURCE_STATIC_ICON_NAME)
2130     return source->source.icon_name;
2131   else
2132     return NULL;
2133 }
2134
2135 /**
2136  * gtk_icon_source_get_pixbuf:
2137  * @source: a #GtkIconSource
2138  *
2139  * Retrieves the source pixbuf, or %NULL if none is set.
2140  * In addition, if a filename source is in use, this
2141  * function in some cases will return the pixbuf from
2142  * loaded from the filename. This is, for example, true
2143  * for the GtkIconSource passed to the GtkStyle::render_icon()
2144  * virtual function. The reference count on the pixbuf is
2145  * not incremented.
2146  *
2147  * Return value: source pixbuf
2148  */
2149 GdkPixbuf*
2150 gtk_icon_source_get_pixbuf (const GtkIconSource *source)
2151 {
2152   g_return_val_if_fail (source != NULL, NULL);
2153
2154   if (source->type == GTK_ICON_SOURCE_PIXBUF)
2155     return source->source.pixbuf;
2156   else if (source->type == GTK_ICON_SOURCE_FILENAME)
2157     return source->filename_pixbuf;
2158   else
2159     return NULL;
2160 }
2161
2162 /**
2163  * gtk_icon_source_set_direction_wildcarded:
2164  * @source: a #GtkIconSource
2165  * @setting: %TRUE to wildcard the text direction
2166  *
2167  * If the text direction is wildcarded, this source can be used
2168  * as the base image for an icon in any #GtkTextDirection.
2169  * If the text direction is not wildcarded, then the
2170  * text direction the icon source applies to should be set
2171  * with gtk_icon_source_set_direction(), and the icon source
2172  * will only be used with that text direction.
2173  *
2174  * #GtkIconSet prefers non-wildcarded sources (exact matches) over
2175  * wildcarded sources, and will use an exact match when possible.
2176  */
2177 void
2178 gtk_icon_source_set_direction_wildcarded (GtkIconSource *source,
2179                                           gboolean       setting)
2180 {
2181   g_return_if_fail (source != NULL);
2182
2183   source->any_direction = setting != FALSE;
2184 }
2185
2186 /**
2187  * gtk_icon_source_set_state_wildcarded:
2188  * @source: a #GtkIconSource
2189  * @setting: %TRUE to wildcard the widget state
2190  *
2191  * If the widget state is wildcarded, this source can be used as the
2192  * base image for an icon in any #GtkStateType.  If the widget state
2193  * is not wildcarded, then the state the source applies to should be
2194  * set with gtk_icon_source_set_state() and the icon source will
2195  * only be used with that specific state.
2196  *
2197  * #GtkIconSet prefers non-wildcarded sources (exact matches) over
2198  * wildcarded sources, and will use an exact match when possible.
2199  *
2200  * #GtkIconSet will normally transform wildcarded source images to
2201  * produce an appropriate icon for a given state, for example
2202  * lightening an image on prelight, but will not modify source images
2203  * that match exactly.
2204  */
2205 void
2206 gtk_icon_source_set_state_wildcarded (GtkIconSource *source,
2207                                       gboolean       setting)
2208 {
2209   g_return_if_fail (source != NULL);
2210
2211   source->any_state = setting != FALSE;
2212 }
2213
2214
2215 /**
2216  * gtk_icon_source_set_size_wildcarded:
2217  * @source: a #GtkIconSource
2218  * @setting: %TRUE to wildcard the widget state
2219  *
2220  * If the icon size is wildcarded, this source can be used as the base
2221  * image for an icon of any size.  If the size is not wildcarded, then
2222  * the size the source applies to should be set with
2223  * gtk_icon_source_set_size() and the icon source will only be used
2224  * with that specific size.
2225  *
2226  * #GtkIconSet prefers non-wildcarded sources (exact matches) over
2227  * wildcarded sources, and will use an exact match when possible.
2228  *
2229  * #GtkIconSet will normally scale wildcarded source images to produce
2230  * an appropriate icon at a given size, but will not change the size
2231  * of source images that match exactly.
2232  */
2233 void
2234 gtk_icon_source_set_size_wildcarded (GtkIconSource *source,
2235                                      gboolean       setting)
2236 {
2237   g_return_if_fail (source != NULL);
2238
2239   source->any_size = setting != FALSE;
2240 }
2241
2242 /**
2243  * gtk_icon_source_get_size_wildcarded:
2244  * @source: a #GtkIconSource
2245  *
2246  * Gets the value set by gtk_icon_source_set_size_wildcarded().
2247  *
2248  * Return value: %TRUE if this icon source is a base for any icon size variant
2249  */
2250 gboolean
2251 gtk_icon_source_get_size_wildcarded (const GtkIconSource *source)
2252 {
2253   g_return_val_if_fail (source != NULL, TRUE);
2254
2255   return source->any_size;
2256 }
2257
2258 /**
2259  * gtk_icon_source_get_state_wildcarded:
2260  * @source: a #GtkIconSource
2261  *
2262  * Gets the value set by gtk_icon_source_set_state_wildcarded().
2263  *
2264  * Return value: %TRUE if this icon source is a base for any widget state variant
2265  */
2266 gboolean
2267 gtk_icon_source_get_state_wildcarded (const GtkIconSource *source)
2268 {
2269   g_return_val_if_fail (source != NULL, TRUE);
2270
2271   return source->any_state;
2272 }
2273
2274 /**
2275  * gtk_icon_source_get_direction_wildcarded:
2276  * @source: a #GtkIconSource
2277  *
2278  * Gets the value set by gtk_icon_source_set_direction_wildcarded().
2279  *
2280  * Return value: %TRUE if this icon source is a base for any text direction variant
2281  */
2282 gboolean
2283 gtk_icon_source_get_direction_wildcarded (const GtkIconSource *source)
2284 {
2285   g_return_val_if_fail (source != NULL, TRUE);
2286
2287   return source->any_direction;
2288 }
2289
2290 /**
2291  * gtk_icon_source_set_direction:
2292  * @source: a #GtkIconSource
2293  * @direction: text direction this source applies to
2294  *
2295  * Sets the text direction this icon source is intended to be used
2296  * with.
2297  *
2298  * Setting the text direction on an icon source makes no difference
2299  * if the text direction is wildcarded. Therefore, you should usually
2300  * call gtk_icon_source_set_direction_wildcarded() to un-wildcard it
2301  * in addition to calling this function.
2302  */
2303 void
2304 gtk_icon_source_set_direction (GtkIconSource   *source,
2305                                GtkTextDirection direction)
2306 {
2307   g_return_if_fail (source != NULL);
2308
2309   source->direction = direction;
2310 }
2311
2312 /**
2313  * gtk_icon_source_set_state:
2314  * @source: a #GtkIconSource
2315  * @state: widget state this source applies to
2316  *
2317  * Sets the widget state this icon source is intended to be used
2318  * with.
2319  *
2320  * Setting the widget state on an icon source makes no difference
2321  * if the state is wildcarded. Therefore, you should usually
2322  * call gtk_icon_source_set_state_wildcarded() to un-wildcard it
2323  * in addition to calling this function.
2324  */
2325 void
2326 gtk_icon_source_set_state (GtkIconSource *source,
2327                            GtkStateType   state)
2328 {
2329   g_return_if_fail (source != NULL);
2330
2331   source->state = state;
2332 }
2333
2334 /**
2335  * gtk_icon_source_set_size:
2336  * @source: a #GtkIconSource
2337  * @size: (type int): icon size this source applies to
2338  *
2339  * Sets the icon size this icon source is intended to be used
2340  * with.
2341  *
2342  * Setting the icon size on an icon source makes no difference
2343  * if the size is wildcarded. Therefore, you should usually
2344  * call gtk_icon_source_set_size_wildcarded() to un-wildcard it
2345  * in addition to calling this function.
2346  */
2347 void
2348 gtk_icon_source_set_size (GtkIconSource *source,
2349                           GtkIconSize    size)
2350 {
2351   g_return_if_fail (source != NULL);
2352
2353   source->size = size;
2354 }
2355
2356 /**
2357  * gtk_icon_source_get_direction:
2358  * @source: a #GtkIconSource
2359  *
2360  * Obtains the text direction this icon source applies to. The return
2361  * value is only useful/meaningful if the text direction is <emphasis>not</emphasis>
2362  * wildcarded.
2363  *
2364  * Return value: text direction this source matches
2365  */
2366 GtkTextDirection
2367 gtk_icon_source_get_direction (const GtkIconSource *source)
2368 {
2369   g_return_val_if_fail (source != NULL, 0);
2370
2371   return source->direction;
2372 }
2373
2374 /**
2375  * gtk_icon_source_get_state:
2376  * @source: a #GtkIconSource
2377  *
2378  * Obtains the widget state this icon source applies to. The return
2379  * value is only useful/meaningful if the widget state is <emphasis>not</emphasis>
2380  * wildcarded.
2381  *
2382  * Return value: widget state this source matches
2383  */
2384 GtkStateType
2385 gtk_icon_source_get_state (const GtkIconSource *source)
2386 {
2387   g_return_val_if_fail (source != NULL, 0);
2388
2389   return source->state;
2390 }
2391
2392 /**
2393  * gtk_icon_source_get_size:
2394  * @source: a #GtkIconSource
2395  *
2396  * Obtains the icon size this source applies to. The return value
2397  * is only useful/meaningful if the icon size is <emphasis>not</emphasis> wildcarded.
2398  *
2399  * Return value: (type int): icon size this source matches.
2400  */
2401 GtkIconSize
2402 gtk_icon_source_get_size (const GtkIconSource *source)
2403 {
2404   g_return_val_if_fail (source != NULL, 0);
2405
2406   return source->size;
2407 }
2408
2409 #define NUM_CACHED_ICONS 8
2410
2411 typedef struct _CachedIcon CachedIcon;
2412
2413 struct _CachedIcon
2414 {
2415   /* These must all match to use the cached pixbuf.
2416    * If any don't match, we must re-render the pixbuf.
2417    */
2418   GtkStyle *style;
2419   GtkTextDirection direction;
2420   GtkStateType state;
2421   GtkIconSize size;
2422
2423   GdkPixbuf *pixbuf;
2424 };
2425
2426 static void
2427 ensure_cache_up_to_date (GtkIconSet *icon_set)
2428 {
2429   if (icon_set->cache_serial != cache_serial)
2430     {
2431       clear_cache (icon_set, TRUE);
2432       icon_set->cache_serial = cache_serial;
2433     }
2434 }
2435
2436 static void
2437 cached_icon_free (CachedIcon *icon)
2438 {
2439   g_object_unref (icon->pixbuf);
2440
2441   if (icon->style)
2442     g_object_unref (icon->style);
2443
2444   g_free (icon);
2445 }
2446
2447 static GdkPixbuf *
2448 find_in_cache (GtkIconSet      *icon_set,
2449                GtkStyle        *style,
2450                GtkTextDirection direction,
2451                GtkStateType     state,
2452                GtkIconSize      size)
2453 {
2454   GSList *tmp_list;
2455   GSList *prev;
2456
2457   ensure_cache_up_to_date (icon_set);
2458
2459   prev = NULL;
2460   tmp_list = icon_set->cache;
2461   while (tmp_list != NULL)
2462     {
2463       CachedIcon *icon = tmp_list->data;
2464
2465       if (icon->style == style &&
2466           icon->direction == direction &&
2467           icon->state == state &&
2468           (size == (GtkIconSize)-1 || icon->size == size))
2469         {
2470           if (prev)
2471             {
2472               /* Move this icon to the front of the list. */
2473               prev->next = tmp_list->next;
2474               tmp_list->next = icon_set->cache;
2475               icon_set->cache = tmp_list;
2476             }
2477
2478           return icon->pixbuf;
2479         }
2480
2481       prev = tmp_list;
2482       tmp_list = g_slist_next (tmp_list);
2483     }
2484
2485   return NULL;
2486 }
2487
2488 static void
2489 add_to_cache (GtkIconSet      *icon_set,
2490               GtkStyle        *style,
2491               GtkTextDirection direction,
2492               GtkStateType     state,
2493               GtkIconSize      size,
2494               GdkPixbuf       *pixbuf)
2495 {
2496   CachedIcon *icon;
2497
2498   ensure_cache_up_to_date (icon_set);
2499
2500   g_object_ref (pixbuf);
2501
2502   /* We have to ref the style, since if the style was finalized
2503    * its address could be reused by another style, creating a
2504    * really weird bug
2505    */
2506
2507   if (style)
2508     g_object_ref (style);
2509
2510   icon = g_new (CachedIcon, 1);
2511   icon_set->cache = g_slist_prepend (icon_set->cache, icon);
2512   icon_set->cache_size++;
2513
2514   icon->style = style;
2515   icon->direction = direction;
2516   icon->state = state;
2517   icon->size = size;
2518   icon->pixbuf = pixbuf;
2519
2520   if (icon->style)
2521     attach_to_style (icon_set, icon->style);
2522
2523   if (icon_set->cache_size >= NUM_CACHED_ICONS)
2524     {
2525       /* Remove oldest item in the cache */
2526       GSList *tmp_list;
2527
2528       tmp_list = icon_set->cache;
2529
2530       /* Find next-to-last link */
2531       g_assert (NUM_CACHED_ICONS > 2);
2532       while (tmp_list->next->next)
2533         tmp_list = tmp_list->next;
2534
2535       g_assert (tmp_list != NULL);
2536       g_assert (tmp_list->next != NULL);
2537       g_assert (tmp_list->next->next == NULL);
2538
2539       /* Free the last icon */
2540       icon = tmp_list->next->data;
2541
2542       g_slist_free (tmp_list->next);
2543       tmp_list->next = NULL;
2544
2545       cached_icon_free (icon);
2546     }
2547 }
2548
2549 static void
2550 clear_cache (GtkIconSet *icon_set,
2551              gboolean    style_detach)
2552 {
2553   GSList *cache, *tmp_list;
2554   GtkStyle *last_style = NULL;
2555
2556   cache = icon_set->cache;
2557   icon_set->cache = NULL;
2558   icon_set->cache_size = 0;
2559   tmp_list = cache;
2560   while (tmp_list != NULL)
2561     {
2562       CachedIcon *icon = tmp_list->data;
2563
2564       if (style_detach)
2565         {
2566           /* simple optimization for the case where the cache
2567            * contains contiguous icons from the same style.
2568            * it's safe to call detach_from_style more than
2569            * once on the same style though.
2570            */
2571           if (last_style != icon->style)
2572             {
2573               detach_from_style (icon_set, icon->style);
2574               last_style = icon->style;
2575             }
2576         }
2577
2578       cached_icon_free (icon);
2579
2580       tmp_list = g_slist_next (tmp_list);
2581     }
2582
2583   g_slist_free (cache);
2584 }
2585
2586 static GSList*
2587 copy_cache (GtkIconSet *icon_set,
2588             GtkIconSet *copy_recipient)
2589 {
2590   GSList *tmp_list;
2591   GSList *copy = NULL;
2592
2593   ensure_cache_up_to_date (icon_set);
2594
2595   tmp_list = icon_set->cache;
2596   while (tmp_list != NULL)
2597     {
2598       CachedIcon *icon = tmp_list->data;
2599       CachedIcon *icon_copy = g_new (CachedIcon, 1);
2600
2601       *icon_copy = *icon;
2602
2603       if (icon_copy->style)
2604         {
2605           attach_to_style (copy_recipient, icon_copy->style);
2606           g_object_ref (icon_copy->style);
2607         }
2608
2609       g_object_ref (icon_copy->pixbuf);
2610
2611       icon_copy->size = icon->size;
2612
2613       copy = g_slist_prepend (copy, icon_copy);
2614
2615       tmp_list = g_slist_next (tmp_list);
2616     }
2617
2618   return g_slist_reverse (copy);
2619 }
2620
2621 static void
2622 attach_to_style (GtkIconSet *icon_set,
2623                  GtkStyle   *style)
2624 {
2625   GHashTable *table;
2626
2627   table = g_object_get_qdata (G_OBJECT (style),
2628                               g_quark_try_string ("gtk-style-icon-sets"));
2629
2630   if (table == NULL)
2631     {
2632       table = g_hash_table_new (NULL, NULL);
2633       g_object_set_qdata_full (G_OBJECT (style),
2634                                g_quark_from_static_string ("gtk-style-icon-sets"),
2635                                table,
2636                                style_dnotify);
2637     }
2638
2639   g_hash_table_insert (table, icon_set, icon_set);
2640 }
2641
2642 static void
2643 detach_from_style (GtkIconSet *icon_set,
2644                    GtkStyle   *style)
2645 {
2646   GHashTable *table;
2647
2648   table = g_object_get_qdata (G_OBJECT (style),
2649                               g_quark_try_string ("gtk-style-icon-sets"));
2650
2651   if (table != NULL)
2652     g_hash_table_remove (table, icon_set);
2653 }
2654
2655 static void
2656 iconsets_foreach (gpointer key,
2657                   gpointer value,
2658                   gpointer user_data)
2659 {
2660   GtkIconSet *icon_set = key;
2661
2662   /* We only need to remove cache entries for the given style;
2663    * but that complicates things because in destroy notify
2664    * we don't know which style got destroyed, and 95% of the
2665    * time all cache entries will have the same style,
2666    * so this is faster anyway.
2667    */
2668
2669   clear_cache (icon_set, FALSE);
2670 }
2671
2672 static void
2673 style_dnotify (gpointer data)
2674 {
2675   GHashTable *table = data;
2676
2677   g_hash_table_foreach (table, iconsets_foreach, NULL);
2678
2679   g_hash_table_destroy (table);
2680 }
2681
2682 /* This allows the icon set to detect that its cache is out of date. */
2683 void
2684 _gtk_icon_set_invalidate_caches (void)
2685 {
2686   ++cache_serial;
2687 }
2688
2689 /**
2690  * _gtk_icon_factory_list_ids:
2691  *
2692  * Gets all known IDs stored in an existing icon factory.
2693  * The strings in the returned list aren't copied.
2694  * The list itself should be freed.
2695  *
2696  * Return value: List of ids in icon factories
2697  */
2698 GList*
2699 _gtk_icon_factory_list_ids (void)
2700 {
2701   GSList *tmp_list;
2702   GList *ids;
2703
2704   ids = NULL;
2705
2706   _gtk_icon_factory_ensure_default_icons ();
2707
2708   tmp_list = all_icon_factories;
2709   while (tmp_list != NULL)
2710     {
2711       GList *these_ids;
2712
2713       GtkIconFactory *factory = GTK_ICON_FACTORY (tmp_list->data);
2714
2715       these_ids = g_hash_table_get_keys (factory->icons);
2716
2717       ids = g_list_concat (ids, these_ids);
2718
2719       tmp_list = g_slist_next (tmp_list);
2720     }
2721
2722   return ids;
2723 }
2724
2725 typedef struct {
2726   GSList *sources;
2727   gboolean in_source;
2728
2729 } IconFactoryParserData;
2730
2731 typedef struct {
2732   gchar            *stock_id;
2733   gchar            *filename;
2734   gchar            *icon_name;
2735   GtkTextDirection  direction;
2736   GtkIconSize       size;
2737   GtkStateType      state;
2738 } IconSourceParserData;
2739
2740 static void
2741 icon_source_start_element (GMarkupParseContext *context,
2742                            const gchar         *element_name,
2743                            const gchar        **names,
2744                            const gchar        **values,
2745                            gpointer             user_data,
2746                            GError             **error)
2747 {
2748   gint i;
2749   gchar *stock_id = NULL;
2750   gchar *filename = NULL;
2751   gchar *icon_name = NULL;
2752   gint size = -1;
2753   gint direction = -1;
2754   gint state = -1;
2755   IconFactoryParserData *parser_data;
2756   IconSourceParserData *source_data;
2757   gchar *error_msg;
2758   GQuark error_domain;
2759
2760   parser_data = (IconFactoryParserData*)user_data;
2761
2762   if (!parser_data->in_source)
2763     {
2764       if (strcmp (element_name, "sources") != 0)
2765         {
2766           error_msg = g_strdup_printf ("Unexpected element %s, expected <sources>", element_name);
2767           error_domain = GTK_BUILDER_ERROR_INVALID_TAG;
2768           goto error;
2769         }
2770       parser_data->in_source = TRUE;
2771       return;
2772     }
2773   else
2774     {
2775       if (strcmp (element_name, "source") != 0)
2776         {
2777           error_msg = g_strdup_printf ("Unexpected element %s, expected <source>", element_name);
2778           error_domain = GTK_BUILDER_ERROR_INVALID_TAG;
2779           goto error;
2780         }
2781     }
2782
2783   for (i = 0; names[i]; i++)
2784     {
2785       if (strcmp (names[i], "stock-id") == 0)
2786         stock_id = g_strdup (values[i]);
2787       else if (strcmp (names[i], "filename") == 0)
2788         filename = g_strdup (values[i]);
2789       else if (strcmp (names[i], "icon-name") == 0)
2790         icon_name = g_strdup (values[i]);
2791       else if (strcmp (names[i], "size") == 0)
2792         {
2793           if (!_gtk_builder_enum_from_string (GTK_TYPE_ICON_SIZE,
2794                                               values[i],
2795                                               &size,
2796                                               error))
2797               return;
2798         }
2799       else if (strcmp (names[i], "direction") == 0)
2800         {
2801           if (!_gtk_builder_enum_from_string (GTK_TYPE_TEXT_DIRECTION,
2802                                               values[i],
2803                                               &direction,
2804                                               error))
2805               return;
2806         }
2807       else if (strcmp (names[i], "state") == 0)
2808         {
2809           if (!_gtk_builder_enum_from_string (GTK_TYPE_STATE_TYPE,
2810                                               values[i],
2811                                               &state,
2812                                               error))
2813               return;
2814         }
2815       else
2816         {
2817           error_msg = g_strdup_printf ("'%s' is not a valid attribute of <%s>",
2818                                        names[i], "source");
2819           error_domain = GTK_BUILDER_ERROR_INVALID_ATTRIBUTE;
2820           goto error;
2821         }
2822     }
2823
2824   if (!stock_id)
2825     {
2826       error_msg = g_strdup_printf ("<source> requires a stock_id");
2827       error_domain = GTK_BUILDER_ERROR_MISSING_ATTRIBUTE;
2828       goto error;
2829     }
2830
2831   source_data = g_slice_new (IconSourceParserData);
2832   source_data->stock_id = stock_id;
2833   source_data->filename = filename;
2834   source_data->icon_name = icon_name;
2835   source_data->size = size;
2836   source_data->direction = direction;
2837   source_data->state = state;
2838
2839   parser_data->sources = g_slist_prepend (parser_data->sources, source_data);
2840   return;
2841
2842  error:
2843   {
2844     gchar *tmp;
2845     gint line_number, char_number;
2846
2847     g_markup_parse_context_get_position (context,
2848                                          &line_number,
2849                                          &char_number);
2850
2851     tmp = g_strdup_printf ("%s:%d:%d %s", "input",
2852                            line_number, char_number, error_msg);
2853 #if 0
2854     g_set_error_literal (error,
2855                  GTK_BUILDER_ERROR,
2856                  error_domain,
2857                  tmp);
2858 #else
2859     g_warning ("%s", tmp);
2860 #endif
2861     g_free (tmp);
2862     g_free (stock_id);
2863     g_free (filename);
2864     g_free (icon_name);
2865     return;
2866   }
2867 }
2868
2869 static const GMarkupParser icon_source_parser =
2870   {
2871     icon_source_start_element,
2872   };
2873
2874 static gboolean
2875 gtk_icon_factory_buildable_custom_tag_start (GtkBuildable     *buildable,
2876                                              GtkBuilder       *builder,
2877                                              GObject          *child,
2878                                              const gchar      *tagname,
2879                                              GMarkupParser    *parser,
2880                                              gpointer         *data)
2881 {
2882   g_assert (buildable);
2883
2884   if (strcmp (tagname, "sources") == 0)
2885     {
2886       IconFactoryParserData *parser_data;
2887
2888       parser_data = g_slice_new0 (IconFactoryParserData);
2889       *parser = icon_source_parser;
2890       *data = parser_data;
2891       return TRUE;
2892     }
2893   return FALSE;
2894 }
2895
2896 static void
2897 gtk_icon_factory_buildable_custom_tag_end (GtkBuildable *buildable,
2898                                            GtkBuilder   *builder,
2899                                            GObject      *child,
2900                                            const gchar  *tagname,
2901                                            gpointer     *user_data)
2902 {
2903   GtkIconFactory *icon_factory;
2904
2905   icon_factory = GTK_ICON_FACTORY (buildable);
2906
2907   if (strcmp (tagname, "sources") == 0)
2908     {
2909       IconFactoryParserData *parser_data;
2910       GtkIconSource *icon_source;
2911       GtkIconSet *icon_set;
2912       GSList *l;
2913
2914       parser_data = (IconFactoryParserData*)user_data;
2915
2916       for (l = parser_data->sources; l; l = l->next)
2917         {
2918           IconSourceParserData *source_data = l->data;
2919
2920           icon_set = gtk_icon_factory_lookup (icon_factory, source_data->stock_id);
2921           if (!icon_set)
2922             {
2923               icon_set = gtk_icon_set_new ();
2924               gtk_icon_factory_add (icon_factory, source_data->stock_id, icon_set);
2925               gtk_icon_set_unref (icon_set);
2926             }
2927
2928           icon_source = gtk_icon_source_new ();
2929
2930           if (source_data->filename)
2931             {
2932               gchar *filename;
2933               filename = _gtk_builder_get_absolute_filename (builder, source_data->filename);
2934               gtk_icon_source_set_filename (icon_source, filename);
2935               g_free (filename);
2936             }
2937           if (source_data->icon_name)
2938             gtk_icon_source_set_icon_name (icon_source, source_data->icon_name);
2939           if (source_data->size != -1)
2940             {
2941               gtk_icon_source_set_size (icon_source, source_data->size);
2942               gtk_icon_source_set_size_wildcarded (icon_source, FALSE);
2943             }
2944           if (source_data->direction != -1)
2945             {
2946               gtk_icon_source_set_direction (icon_source, source_data->direction);
2947               gtk_icon_source_set_direction_wildcarded (icon_source, FALSE);
2948             }
2949           if (source_data->state != -1)
2950             {
2951               gtk_icon_source_set_state (icon_source, source_data->state);
2952               gtk_icon_source_set_state_wildcarded (icon_source, FALSE);
2953             }
2954
2955           /* Inline source_add() to avoid creating a copy */
2956           g_assert (icon_source->type != GTK_ICON_SOURCE_EMPTY);
2957           icon_set->sources = g_slist_insert_sorted (icon_set->sources,
2958                                                      icon_source,
2959                                                      icon_source_compare);
2960
2961           g_free (source_data->stock_id);
2962           g_free (source_data->filename);
2963           g_free (source_data->icon_name);
2964           g_slice_free (IconSourceParserData, source_data);
2965         }
2966       g_slist_free (parser_data->sources);
2967       g_slice_free (IconFactoryParserData, parser_data);
2968
2969       /* TODO: Add an attribute/tag to prevent this.
2970        * Usually it's the right thing to do though.
2971        */
2972       gtk_icon_factory_add_default (icon_factory);
2973     }
2974 }
2975
2976 #if defined (G_OS_WIN32) && !defined (_WIN64)
2977
2978 /* DLL ABI stability backward compatibility versions */
2979
2980 #undef gtk_icon_source_set_filename
2981
2982 void
2983 gtk_icon_source_set_filename (GtkIconSource *source,
2984                               const gchar   *filename)
2985 {
2986   gchar *utf8_filename = g_locale_to_utf8 (filename, -1, NULL, NULL, NULL);
2987
2988   gtk_icon_source_set_filename_utf8 (source, utf8_filename);
2989
2990   g_free (utf8_filename);
2991 }
2992
2993 #undef gtk_icon_source_get_filename
2994
2995 G_CONST_RETURN gchar*
2996 gtk_icon_source_get_filename (const GtkIconSource *source)
2997 {
2998   g_return_val_if_fail (source != NULL, NULL);
2999
3000   if (source->type == GTK_ICON_SOURCE_FILENAME)
3001     return source->cp_filename;
3002   else
3003     return NULL;
3004 }
3005
3006 #endif
3007
3008 #define __GTK_ICON_FACTORY_C__
3009 #include "gtkaliasdef.c"