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  *
1079  * Looks up the icon size associated with @name.
1080  *
1081  * Return value: (type int): the icon size
1082  */
1083 GtkIconSize
1084 gtk_icon_size_from_name (const gchar *name)
1085 {
1086   IconAlias *ia;
1087
1088   init_icon_sizes ();
1089
1090   ia = g_hash_table_lookup (icon_aliases, name);
1091
1092   if (ia && icon_sizes[ia->target].width > 0)
1093     return ia->target;
1094   else
1095     return GTK_ICON_SIZE_INVALID;
1096 }
1097
1098 /**
1099  * gtk_icon_size_get_name:
1100  * @size: (type int): a #GtkIconSize.
1101  * @returns: the name of the given icon size.
1102  *
1103  * Gets the canonical name of the given icon size. The returned string
1104  * is statically allocated and should not be freed.
1105  */
1106 G_CONST_RETURN gchar*
1107 gtk_icon_size_get_name (GtkIconSize  size)
1108 {
1109   if (size >= icon_sizes_used)
1110     return NULL;
1111   else
1112     return icon_sizes[size].name;
1113 }
1114
1115 /************************************************************/
1116
1117 /* Icon Set */
1118
1119
1120 static GdkPixbuf *find_in_cache     (GtkIconSet       *icon_set,
1121                                      GtkStyle         *style,
1122                                      GtkTextDirection  direction,
1123                                      GtkStateType      state,
1124                                      GtkIconSize       size);
1125 static void       add_to_cache      (GtkIconSet       *icon_set,
1126                                      GtkStyle         *style,
1127                                      GtkTextDirection  direction,
1128                                      GtkStateType      state,
1129                                      GtkIconSize       size,
1130                                      GdkPixbuf        *pixbuf);
1131 /* Clear icon set contents, drop references to all contained
1132  * GdkPixbuf objects and forget all GtkIconSources. Used to
1133  * recycle an icon set.
1134  */
1135 static void       clear_cache       (GtkIconSet       *icon_set,
1136                                      gboolean          style_detach);
1137 static GSList*    copy_cache        (GtkIconSet       *icon_set,
1138                                      GtkIconSet       *copy_recipient);
1139 static void       attach_to_style   (GtkIconSet       *icon_set,
1140                                      GtkStyle         *style);
1141 static void       detach_from_style (GtkIconSet       *icon_set,
1142                                      GtkStyle         *style);
1143 static void       style_dnotify     (gpointer          data);
1144
1145 struct _GtkIconSet
1146 {
1147   guint ref_count;
1148
1149   GSList *sources;
1150
1151   /* Cache of the last few rendered versions of the icon. */
1152   GSList *cache;
1153
1154   guint cache_size;
1155
1156   guint cache_serial;
1157 };
1158
1159 static guint cache_serial = 0;
1160
1161 /**
1162  * gtk_icon_set_new:
1163  *
1164  * Creates a new #GtkIconSet. A #GtkIconSet represents a single icon
1165  * in various sizes and widget states. It can provide a #GdkPixbuf
1166  * for a given size and state on request, and automatically caches
1167  * some of the rendered #GdkPixbuf objects.
1168  *
1169  * Normally you would use gtk_widget_render_icon() instead of
1170  * using #GtkIconSet directly. The one case where you'd use
1171  * #GtkIconSet is to create application-specific icon sets to place in
1172  * a #GtkIconFactory.
1173  *
1174  * Return value: a new #GtkIconSet
1175  */
1176 GtkIconSet*
1177 gtk_icon_set_new (void)
1178 {
1179   GtkIconSet *icon_set;
1180
1181   icon_set = g_new (GtkIconSet, 1);
1182
1183   icon_set->ref_count = 1;
1184   icon_set->sources = NULL;
1185   icon_set->cache = NULL;
1186   icon_set->cache_size = 0;
1187   icon_set->cache_serial = cache_serial;
1188
1189   return icon_set;
1190 }
1191
1192 /**
1193  * gtk_icon_set_new_from_pixbuf:
1194  * @pixbuf: a #GdkPixbuf
1195  *
1196  * Creates a new #GtkIconSet with @pixbuf as the default/fallback
1197  * source image. If you don't add any additional #GtkIconSource to the
1198  * icon set, all variants of the icon will be created from @pixbuf,
1199  * using scaling, pixelation, etc. as required to adjust the icon size
1200  * or make the icon look insensitive/prelighted.
1201  *
1202  * Return value: a new #GtkIconSet
1203  */
1204 GtkIconSet *
1205 gtk_icon_set_new_from_pixbuf (GdkPixbuf *pixbuf)
1206 {
1207   GtkIconSet *set;
1208
1209   GtkIconSource source = GTK_ICON_SOURCE_INIT (TRUE, TRUE, TRUE);
1210
1211   g_return_val_if_fail (pixbuf != NULL, NULL);
1212
1213   set = gtk_icon_set_new ();
1214
1215   gtk_icon_source_set_pixbuf (&source, pixbuf);
1216   gtk_icon_set_add_source (set, &source);
1217   gtk_icon_source_set_pixbuf (&source, NULL);
1218
1219   return set;
1220 }
1221
1222
1223 /**
1224  * gtk_icon_set_ref:
1225  * @icon_set: a #GtkIconSet.
1226  *
1227  * Increments the reference count on @icon_set.
1228  *
1229  * Return value: @icon_set.
1230  */
1231 GtkIconSet*
1232 gtk_icon_set_ref (GtkIconSet *icon_set)
1233 {
1234   g_return_val_if_fail (icon_set != NULL, NULL);
1235   g_return_val_if_fail (icon_set->ref_count > 0, NULL);
1236
1237   icon_set->ref_count += 1;
1238
1239   return icon_set;
1240 }
1241
1242 /**
1243  * gtk_icon_set_unref:
1244  * @icon_set: a #GtkIconSet
1245  *
1246  * Decrements the reference count on @icon_set, and frees memory
1247  * if the reference count reaches 0.
1248  */
1249 void
1250 gtk_icon_set_unref (GtkIconSet *icon_set)
1251 {
1252   g_return_if_fail (icon_set != NULL);
1253   g_return_if_fail (icon_set->ref_count > 0);
1254
1255   icon_set->ref_count -= 1;
1256
1257   if (icon_set->ref_count == 0)
1258     {
1259       GSList *tmp_list = icon_set->sources;
1260       while (tmp_list != NULL)
1261         {
1262           gtk_icon_source_free (tmp_list->data);
1263
1264           tmp_list = g_slist_next (tmp_list);
1265         }
1266       g_slist_free (icon_set->sources);
1267
1268       clear_cache (icon_set, TRUE);
1269
1270       g_free (icon_set);
1271     }
1272 }
1273
1274 GType
1275 gtk_icon_set_get_type (void)
1276 {
1277   static GType our_type = 0;
1278
1279   if (our_type == 0)
1280     our_type = g_boxed_type_register_static (I_("GtkIconSet"),
1281                                              (GBoxedCopyFunc) gtk_icon_set_ref,
1282                                              (GBoxedFreeFunc) gtk_icon_set_unref);
1283
1284   return our_type;
1285 }
1286
1287 /**
1288  * gtk_icon_set_copy:
1289  * @icon_set: a #GtkIconSet
1290  *
1291  * Copies @icon_set by value.
1292  *
1293  * Return value: a new #GtkIconSet identical to the first.
1294  **/
1295 GtkIconSet*
1296 gtk_icon_set_copy (GtkIconSet *icon_set)
1297 {
1298   GtkIconSet *copy;
1299   GSList *tmp_list;
1300
1301   copy = gtk_icon_set_new ();
1302
1303   tmp_list = icon_set->sources;
1304   while (tmp_list != NULL)
1305     {
1306       copy->sources = g_slist_prepend (copy->sources,
1307                                        gtk_icon_source_copy (tmp_list->data));
1308
1309       tmp_list = g_slist_next (tmp_list);
1310     }
1311
1312   copy->sources = g_slist_reverse (copy->sources);
1313
1314   copy->cache = copy_cache (icon_set, copy);
1315   copy->cache_size = icon_set->cache_size;
1316   copy->cache_serial = icon_set->cache_serial;
1317
1318   return copy;
1319 }
1320
1321 static gboolean
1322 sizes_equivalent (GtkIconSize lhs,
1323                   GtkIconSize rhs)
1324 {
1325   /* We used to consider sizes equivalent if they were
1326    * the same pixel size, but we don't have the GtkSettings
1327    * here, so we can't do that. Plus, it's not clear that
1328    * it is right... it was just a workaround for the fact
1329    * that we register icons by logical size, not pixel size.
1330    */
1331 #if 1
1332   return lhs == rhs;
1333 #else
1334
1335   gint r_w, r_h, l_w, l_h;
1336
1337   icon_size_lookup_intern (NULL, rhs, &r_w, &r_h);
1338   icon_size_lookup_intern (NULL, lhs, &l_w, &l_h);
1339
1340   return r_w == l_w && r_h == l_h;
1341 #endif
1342 }
1343
1344 static GtkIconSource *
1345 find_best_matching_source (GtkIconSet       *icon_set,
1346                            GtkTextDirection  direction,
1347                            GtkStateType      state,
1348                            GtkIconSize       size,
1349                            GSList           *failed)
1350 {
1351   GtkIconSource *source;
1352   GSList *tmp_list;
1353
1354   /* We need to find the best icon source.  Direction matters more
1355    * than state, state matters more than size. icon_set->sources
1356    * is sorted according to wildness, so if we take the first
1357    * match we find it will be the least-wild match (if there are
1358    * multiple matches for a given "wildness" then the RC file contained
1359    * dumb stuff, and we end up with an arbitrary matching source)
1360    */
1361
1362   source = NULL;
1363   tmp_list = icon_set->sources;
1364   while (tmp_list != NULL)
1365     {
1366       GtkIconSource *s = tmp_list->data;
1367
1368       if ((s->any_direction || (s->direction == direction)) &&
1369           (s->any_state || (s->state == state)) &&
1370           (s->any_size || size == (GtkIconSize)-1 || (sizes_equivalent (size, s->size))))
1371         {
1372           if (!g_slist_find (failed, s))
1373             {
1374               source = s;
1375               break;
1376             }
1377         }
1378
1379       tmp_list = g_slist_next (tmp_list);
1380     }
1381
1382   return source;
1383 }
1384
1385 static gboolean
1386 ensure_filename_pixbuf (GtkIconSet    *icon_set,
1387                         GtkIconSource *source)
1388 {
1389   if (source->filename_pixbuf == NULL)
1390     {
1391       GError *error = NULL;
1392
1393       source->filename_pixbuf = gdk_pixbuf_new_from_file (source->source.filename, &error);
1394
1395       if (source->filename_pixbuf == NULL)
1396         {
1397           /* Remove this icon source so we don't keep trying to
1398            * load it.
1399            */
1400           g_warning (_("Error loading icon: %s"), error->message);
1401           g_error_free (error);
1402
1403           icon_set->sources = g_slist_remove (icon_set->sources, source);
1404
1405           gtk_icon_source_free (source);
1406
1407           return FALSE;
1408         }
1409     }
1410
1411   return TRUE;
1412 }
1413
1414 static GdkPixbuf *
1415 render_icon_name_pixbuf (GtkIconSource    *icon_source,
1416                          GtkStyle         *style,
1417                          GtkTextDirection  direction,
1418                          GtkStateType      state,
1419                          GtkIconSize       size,
1420                          GtkWidget         *widget,
1421                          const char        *detail)
1422 {
1423   GdkPixbuf *pixbuf;
1424   GdkPixbuf *tmp_pixbuf;
1425   GtkIconSource tmp_source;
1426   GdkScreen *screen;
1427   GtkIconTheme *icon_theme;
1428   GtkSettings *settings;
1429   gint width, height, pixel_size;
1430   gint *sizes, *s, dist;
1431   GError *error = NULL;
1432
1433   if (widget && gtk_widget_has_screen (widget))
1434     screen = gtk_widget_get_screen (widget);
1435   else if (style && style->colormap)
1436     screen = gdk_colormap_get_screen (style->colormap);
1437   else
1438     {
1439       screen = gdk_screen_get_default ();
1440       GTK_NOTE (MULTIHEAD,
1441                 g_warning ("Using the default screen for gtk_icon_source_render_icon()"));
1442     }
1443
1444   icon_theme = gtk_icon_theme_get_for_screen (screen);
1445   settings = gtk_settings_get_for_screen (screen);
1446
1447   if (!gtk_icon_size_lookup_for_settings (settings, size, &width, &height))
1448     {
1449       if (size == (GtkIconSize)-1)
1450         {
1451           /* Find an available size close to 48 */
1452           sizes = gtk_icon_theme_get_icon_sizes (icon_theme, icon_source->source.icon_name);
1453           dist = 1000;
1454           width = height = 48;
1455           for (s = sizes; *s; s++)
1456             {
1457               if (*s == -1)
1458                 {
1459                   width = height = 48;
1460                   break;
1461                 }
1462               if (*s < 48)
1463                 {
1464                   if (48 - *s < dist)
1465                     {
1466                       width = height = *s;
1467                       dist = 48 - *s;
1468                     }
1469                 }
1470               else
1471                 {
1472                   if (*s - 48 < dist)
1473                     {
1474                       width = height = *s;
1475                       dist = *s - 48;
1476                     }
1477                 }
1478             }
1479
1480           g_free (sizes);
1481         }
1482       else
1483         {
1484           g_warning ("Invalid icon size %u\n", size);
1485           width = height = 24;
1486         }
1487     }
1488
1489   pixel_size = MIN (width, height);
1490
1491   tmp_pixbuf = gtk_icon_theme_load_icon (icon_theme,
1492                                          icon_source->source.icon_name,
1493                                          pixel_size, 0,
1494                                          &error);
1495
1496   if (!tmp_pixbuf)
1497     {
1498       g_warning ("Error loading theme icon '%s' for stock: %s",
1499                  icon_source->source.icon_name, error ? error->message : "");
1500       if (error)
1501         g_error_free (error);
1502       return NULL;
1503     }
1504
1505   tmp_source = *icon_source;
1506   tmp_source.type = GTK_ICON_SOURCE_PIXBUF;
1507   tmp_source.source.pixbuf = tmp_pixbuf;
1508
1509   pixbuf = gtk_style_render_icon (style, &tmp_source,
1510                                   direction, state, -1,
1511                                   widget, detail);
1512
1513   if (!pixbuf)
1514     g_warning ("Failed to render icon");
1515
1516   g_object_unref (tmp_pixbuf);
1517
1518   return pixbuf;
1519 }
1520
1521 static GdkPixbuf *
1522 find_and_render_icon_source (GtkIconSet       *icon_set,
1523                              GtkStyle         *style,
1524                              GtkTextDirection  direction,
1525                              GtkStateType      state,
1526                              GtkIconSize       size,
1527                              GtkWidget         *widget,
1528                              const char        *detail)
1529 {
1530   GSList *failed = NULL;
1531   GdkPixbuf *pixbuf = NULL;
1532
1533   /* We treat failure in two different ways:
1534    *
1535    *  A) If loading a source that specifies a filename fails,
1536    *     we treat that as permanent, and remove the source
1537    *     from the GtkIconSet. (in ensure_filename_pixbuf ()
1538    *  B) If loading a themed icon fails, or scaling an icon
1539    *     fails, we treat that as transient and will try
1540    *     again next time the icon falls out of the cache
1541    *     and we need to recreate it.
1542    */
1543   while (pixbuf == NULL)
1544     {
1545       GtkIconSource *source = find_best_matching_source (icon_set, direction, state, size, failed);
1546
1547       if (source == NULL)
1548         break;
1549
1550       switch (source->type)
1551         {
1552         case GTK_ICON_SOURCE_FILENAME:
1553           if (!ensure_filename_pixbuf (icon_set, source))
1554             break;
1555           /* Fall through */
1556         case GTK_ICON_SOURCE_PIXBUF:
1557           pixbuf = gtk_style_render_icon (style, source,
1558                                           direction, state, size,
1559                                           widget, detail);
1560           if (!pixbuf)
1561             {
1562               g_warning ("Failed to render icon");
1563               failed = g_slist_prepend (failed, source);
1564             }
1565           break;
1566         case GTK_ICON_SOURCE_ICON_NAME:
1567         case GTK_ICON_SOURCE_STATIC_ICON_NAME:
1568           pixbuf = render_icon_name_pixbuf (source, style,
1569                                             direction, state, size,
1570                                             widget, detail);
1571           if (!pixbuf)
1572             failed = g_slist_prepend (failed, source);
1573           break;
1574         case GTK_ICON_SOURCE_EMPTY:
1575           g_assert_not_reached ();
1576         }
1577     }
1578
1579   g_slist_free (failed);
1580
1581   return pixbuf;
1582 }
1583
1584 extern GtkIconCache *_builtin_cache;
1585
1586 static GdkPixbuf*
1587 render_fallback_image (GtkStyle          *style,
1588                        GtkTextDirection   direction,
1589                        GtkStateType       state,
1590                        GtkIconSize        size,
1591                        GtkWidget         *widget,
1592                        const char        *detail)
1593 {
1594   /* This icon can be used for any direction/state/size */
1595   static GtkIconSource fallback_source = GTK_ICON_SOURCE_INIT (TRUE, TRUE, TRUE);
1596
1597   if (fallback_source.type == GTK_ICON_SOURCE_EMPTY)
1598     {
1599       gint index;
1600       GdkPixbuf *pixbuf;
1601
1602       _gtk_icon_theme_ensure_builtin_cache ();
1603
1604       index = _gtk_icon_cache_get_directory_index (_builtin_cache, "24");
1605       pixbuf = _gtk_icon_cache_get_icon (_builtin_cache,
1606                                          GTK_STOCK_MISSING_IMAGE,
1607                                          index);
1608       gtk_icon_source_set_pixbuf (&fallback_source, pixbuf);
1609       g_object_unref (pixbuf);
1610     }
1611
1612   return gtk_style_render_icon (style,
1613                                 &fallback_source,
1614                                 direction,
1615                                 state,
1616                                 size,
1617                                 widget,
1618                                 detail);
1619 }
1620
1621 /**
1622  * gtk_icon_set_render_icon:
1623  * @icon_set: a #GtkIconSet
1624  * @style: (allow-none): a #GtkStyle associated with @widget, or %NULL
1625  * @direction: text direction
1626  * @state: widget state
1627  * @size: (type int): icon size. A size of (GtkIconSize)-1
1628  *        means render at the size of the source and don't scale.
1629  * @widget: (allow-none): widget that will display the icon, or %NULL.
1630  *          The only use that is typically made of this
1631  *          is to determine the appropriate #GdkScreen.
1632  * @detail: (allow-none): detail to pass to the theme engine, or %NULL.
1633  *          Note that passing a detail of anything but %NULL
1634  *          will disable caching.
1635  *
1636  * Renders an icon using gtk_style_render_icon(). In most cases,
1637  * gtk_widget_render_icon() is better, since it automatically provides
1638  * most of the arguments from the current widget settings.  This
1639  * function never returns %NULL; if the icon can't be rendered
1640  * (perhaps because an image file fails to load), a default "missing
1641  * image" icon will be returned instead.
1642  *
1643  * Return value: a #GdkPixbuf to be displayed
1644  */
1645 GdkPixbuf*
1646 gtk_icon_set_render_icon (GtkIconSet        *icon_set,
1647                           GtkStyle          *style,
1648                           GtkTextDirection   direction,
1649                           GtkStateType       state,
1650                           GtkIconSize        size,
1651                           GtkWidget         *widget,
1652                           const char        *detail)
1653 {
1654   GdkPixbuf *icon;
1655
1656   g_return_val_if_fail (icon_set != NULL, NULL);
1657   g_return_val_if_fail (style == NULL || GTK_IS_STYLE (style), NULL);
1658
1659   if (icon_set->sources == NULL)
1660     return render_fallback_image (style, direction, state, size, widget, detail);
1661
1662   if (detail == NULL)
1663     {
1664       icon = find_in_cache (icon_set, style, direction,
1665                         state, size);
1666
1667       if (icon)
1668         {
1669           g_object_ref (icon);
1670           return icon;
1671         }
1672     }
1673
1674
1675   icon = find_and_render_icon_source (icon_set, style, direction, state, size,
1676                                       widget, detail);
1677
1678   if (icon == NULL)
1679     icon = render_fallback_image (style, direction, state, size, widget, detail);
1680
1681   if (detail == NULL)
1682     add_to_cache (icon_set, style, direction, state, size, icon);
1683
1684   return icon;
1685 }
1686
1687 /* Order sources by their "wildness", so that "wilder" sources are
1688  * greater than "specific" sources; for determining ordering,
1689  * direction beats state beats size.
1690  */
1691
1692 static int
1693 icon_source_compare (gconstpointer ap, gconstpointer bp)
1694 {
1695   const GtkIconSource *a = ap;
1696   const GtkIconSource *b = bp;
1697
1698   if (!a->any_direction && b->any_direction)
1699     return -1;
1700   else if (a->any_direction && !b->any_direction)
1701     return 1;
1702   else if (!a->any_state && b->any_state)
1703     return -1;
1704   else if (a->any_state && !b->any_state)
1705     return 1;
1706   else if (!a->any_size && b->any_size)
1707     return -1;
1708   else if (a->any_size && !b->any_size)
1709     return 1;
1710   else
1711     return 0;
1712 }
1713
1714 /**
1715  * gtk_icon_set_add_source:
1716  * @icon_set: a #GtkIconSet
1717  * @source: a #GtkIconSource
1718  *
1719  * Icon sets have a list of #GtkIconSource, which they use as base
1720  * icons for rendering icons in different states and sizes. Icons are
1721  * scaled, made to look insensitive, etc. in
1722  * gtk_icon_set_render_icon(), but #GtkIconSet needs base images to
1723  * work with. The base images and when to use them are described by
1724  * a #GtkIconSource.
1725  *
1726  * This function copies @source, so you can reuse the same source immediately
1727  * without affecting the icon set.
1728  *
1729  * An example of when you'd use this function: a web browser's "Back
1730  * to Previous Page" icon might point in a different direction in
1731  * Hebrew and in English; it might look different when insensitive;
1732  * and it might change size depending on toolbar mode (small/large
1733  * icons). So a single icon set would contain all those variants of
1734  * the icon, and you might add a separate source for each one.
1735  *
1736  * You should nearly always add a "default" icon source with all
1737  * fields wildcarded, which will be used as a fallback if no more
1738  * specific source matches. #GtkIconSet always prefers more specific
1739  * icon sources to more generic icon sources. The order in which you
1740  * add the sources to the icon set does not matter.
1741  *
1742  * gtk_icon_set_new_from_pixbuf() creates a new icon set with a
1743  * default icon source based on the given pixbuf.
1744  */
1745 void
1746 gtk_icon_set_add_source (GtkIconSet          *icon_set,
1747                          const GtkIconSource *source)
1748 {
1749   g_return_if_fail (icon_set != NULL);
1750   g_return_if_fail (source != NULL);
1751
1752   if (source->type == GTK_ICON_SOURCE_EMPTY)
1753     {
1754       g_warning ("Useless empty GtkIconSource");
1755       return;
1756     }
1757
1758   icon_set->sources = g_slist_insert_sorted (icon_set->sources,
1759                                              gtk_icon_source_copy (source),
1760                                              icon_source_compare);
1761 }
1762
1763 /**
1764  * gtk_icon_set_get_sizes:
1765  * @icon_set: a #GtkIconSet
1766  * @sizes: (array length=n_sizes) (out) (type int): return location
1767  *     for array of sizes
1768  * @n_sizes: location to store number of elements in returned array
1769  *
1770  * Obtains a list of icon sizes this icon set can render. The returned
1771  * array must be freed with g_free().
1772  */
1773 void
1774 gtk_icon_set_get_sizes (GtkIconSet   *icon_set,
1775                         GtkIconSize **sizes,
1776                         gint         *n_sizes)
1777 {
1778   GSList *tmp_list;
1779   gboolean all_sizes = FALSE;
1780   GSList *specifics = NULL;
1781
1782   g_return_if_fail (icon_set != NULL);
1783   g_return_if_fail (sizes != NULL);
1784   g_return_if_fail (n_sizes != NULL);
1785
1786   tmp_list = icon_set->sources;
1787   while (tmp_list != NULL)
1788     {
1789       GtkIconSource *source;
1790
1791       source = tmp_list->data;
1792
1793       if (source->any_size)
1794         {
1795           all_sizes = TRUE;
1796           break;
1797         }
1798       else
1799         specifics = g_slist_prepend (specifics, GINT_TO_POINTER (source->size));
1800
1801       tmp_list = g_slist_next (tmp_list);
1802     }
1803
1804   if (all_sizes)
1805     {
1806       /* Need to find out what sizes exist */
1807       gint i;
1808
1809       init_icon_sizes ();
1810
1811       *sizes = g_new (GtkIconSize, icon_sizes_used);
1812       *n_sizes = icon_sizes_used - 1;
1813
1814       i = 1;
1815       while (i < icon_sizes_used)
1816         {
1817           (*sizes)[i - 1] = icon_sizes[i].size;
1818           ++i;
1819         }
1820     }
1821   else
1822     {
1823       gint i;
1824
1825       *n_sizes = g_slist_length (specifics);
1826       *sizes = g_new (GtkIconSize, *n_sizes);
1827
1828       i = 0;
1829       tmp_list = specifics;
1830       while (tmp_list != NULL)
1831         {
1832           (*sizes)[i] = GPOINTER_TO_INT (tmp_list->data);
1833
1834           ++i;
1835           tmp_list = g_slist_next (tmp_list);
1836         }
1837     }
1838
1839   g_slist_free (specifics);
1840 }
1841
1842
1843 /**
1844  * gtk_icon_source_new:
1845  *
1846  * Creates a new #GtkIconSource. A #GtkIconSource contains a #GdkPixbuf (or
1847  * image filename) that serves as the base image for one or more of the
1848  * icons in a #GtkIconSet, along with a specification for which icons in the
1849  * icon set will be based on that pixbuf or image file. An icon set contains
1850  * a set of icons that represent "the same" logical concept in different states,
1851  * different global text directions, and different sizes.
1852  *
1853  * So for example a web browser's "Back to Previous Page" icon might
1854  * point in a different direction in Hebrew and in English; it might
1855  * look different when insensitive; and it might change size depending
1856  * on toolbar mode (small/large icons). So a single icon set would
1857  * contain all those variants of the icon. #GtkIconSet contains a list
1858  * of #GtkIconSource from which it can derive specific icon variants in
1859  * the set.
1860  *
1861  * In the simplest case, #GtkIconSet contains one source pixbuf from
1862  * which it derives all variants. The convenience function
1863  * gtk_icon_set_new_from_pixbuf() handles this case; if you only have
1864  * one source pixbuf, just use that function.
1865  *
1866  * If you want to use a different base pixbuf for different icon
1867  * variants, you create multiple icon sources, mark which variants
1868  * they'll be used to create, and add them to the icon set with
1869  * gtk_icon_set_add_source().
1870  *
1871  * By default, the icon source has all parameters wildcarded. That is,
1872  * the icon source will be used as the base icon for any desired text
1873  * direction, widget state, or icon size.
1874  *
1875  * Return value: a new #GtkIconSource
1876  */
1877 GtkIconSource*
1878 gtk_icon_source_new (void)
1879 {
1880   GtkIconSource *src;
1881
1882   src = g_new0 (GtkIconSource, 1);
1883
1884   src->direction = GTK_TEXT_DIR_NONE;
1885   src->size = GTK_ICON_SIZE_INVALID;
1886   src->state = GTK_STATE_NORMAL;
1887
1888   src->any_direction = TRUE;
1889   src->any_state = TRUE;
1890   src->any_size = TRUE;
1891
1892   return src;
1893 }
1894
1895 /**
1896  * gtk_icon_source_copy:
1897  * @source: a #GtkIconSource
1898  *
1899  * Creates a copy of @source; mostly useful for language bindings.
1900  *
1901  * Return value: a new #GtkIconSource
1902  */
1903 GtkIconSource*
1904 gtk_icon_source_copy (const GtkIconSource *source)
1905 {
1906   GtkIconSource *copy;
1907
1908   g_return_val_if_fail (source != NULL, NULL);
1909
1910   copy = g_new (GtkIconSource, 1);
1911
1912   *copy = *source;
1913
1914   switch (copy->type)
1915     {
1916     case GTK_ICON_SOURCE_EMPTY:
1917     case GTK_ICON_SOURCE_STATIC_ICON_NAME:
1918       break;
1919     case GTK_ICON_SOURCE_ICON_NAME:
1920       copy->source.icon_name = g_strdup (copy->source.icon_name);
1921       break;
1922     case GTK_ICON_SOURCE_FILENAME:
1923       copy->source.filename = g_strdup (copy->source.filename);
1924 #if defined (G_OS_WIN32) && !defined (_WIN64)
1925       copy->cp_filename = g_strdup (copy->cp_filename);
1926 #endif
1927       if (copy->filename_pixbuf)
1928         g_object_ref (copy->filename_pixbuf);
1929       break;
1930     case GTK_ICON_SOURCE_PIXBUF:
1931       g_object_ref (copy->source.pixbuf);
1932       break;
1933     default:
1934       g_assert_not_reached();
1935     }
1936
1937   return copy;
1938 }
1939
1940 /**
1941  * gtk_icon_source_free:
1942  * @source: a #GtkIconSource
1943  *
1944  * Frees a dynamically-allocated icon source, along with its
1945  * filename, size, and pixbuf fields if those are not %NULL.
1946  */
1947 void
1948 gtk_icon_source_free (GtkIconSource *source)
1949 {
1950   g_return_if_fail (source != NULL);
1951
1952   icon_source_clear (source);
1953   g_free (source);
1954 }
1955
1956 GType
1957 gtk_icon_source_get_type (void)
1958 {
1959   static GType our_type = 0;
1960
1961   if (our_type == 0)
1962     our_type = g_boxed_type_register_static (I_("GtkIconSource"),
1963                                              (GBoxedCopyFunc) gtk_icon_source_copy,
1964                                              (GBoxedFreeFunc) gtk_icon_source_free);
1965
1966   return our_type;
1967 }
1968
1969 static void
1970 icon_source_clear (GtkIconSource *source)
1971 {
1972   switch (source->type)
1973     {
1974     case GTK_ICON_SOURCE_EMPTY:
1975       break;
1976     case GTK_ICON_SOURCE_ICON_NAME:
1977       g_free (source->source.icon_name);
1978       /* fall thru */
1979     case GTK_ICON_SOURCE_STATIC_ICON_NAME:
1980       source->source.icon_name = NULL;
1981       break;
1982     case GTK_ICON_SOURCE_FILENAME:
1983       g_free (source->source.filename);
1984       source->source.filename = NULL;
1985 #if defined (G_OS_WIN32) && !defined (_WIN64)
1986       g_free (source->cp_filename);
1987       source->cp_filename = NULL;
1988 #endif
1989       if (source->filename_pixbuf)
1990         g_object_unref (source->filename_pixbuf);
1991       source->filename_pixbuf = NULL;
1992       break;
1993     case GTK_ICON_SOURCE_PIXBUF:
1994       g_object_unref (source->source.pixbuf);
1995       source->source.pixbuf = NULL;
1996       break;
1997     default:
1998       g_assert_not_reached();
1999     }
2000
2001   source->type = GTK_ICON_SOURCE_EMPTY;
2002 }
2003
2004 /**
2005  * gtk_icon_source_set_filename:
2006  * @source: a #GtkIconSource
2007  * @filename: image file to use
2008  *
2009  * Sets the name of an image file to use as a base image when creating
2010  * icon variants for #GtkIconSet. The filename must be absolute.
2011  */
2012 void
2013 gtk_icon_source_set_filename (GtkIconSource *source,
2014                               const gchar   *filename)
2015 {
2016   g_return_if_fail (source != NULL);
2017   g_return_if_fail (filename == NULL || g_path_is_absolute (filename));
2018
2019   if (source->type == GTK_ICON_SOURCE_FILENAME &&
2020       source->source.filename == filename)
2021     return;
2022
2023   icon_source_clear (source);
2024
2025   if (filename != NULL)
2026     {
2027       source->type = GTK_ICON_SOURCE_FILENAME;
2028       source->source.filename = g_strdup (filename);
2029 #if defined (G_OS_WIN32) && !defined (_WIN64)
2030       source->cp_filename = g_locale_from_utf8 (filename, -1, NULL, NULL, NULL);
2031 #endif
2032     }
2033 }
2034
2035 /**
2036  * gtk_icon_source_set_icon_name
2037  * @source: a #GtkIconSource
2038  * @icon_name: (allow-none): name of icon to use
2039  *
2040  * Sets the name of an icon to look up in the current icon theme
2041  * to use as a base image when creating icon variants for #GtkIconSet.
2042  */
2043 void
2044 gtk_icon_source_set_icon_name (GtkIconSource *source,
2045                                const gchar   *icon_name)
2046 {
2047   g_return_if_fail (source != NULL);
2048
2049   if (source->type == GTK_ICON_SOURCE_ICON_NAME &&
2050       source->source.icon_name == icon_name)
2051     return;
2052
2053   icon_source_clear (source);
2054
2055   if (icon_name != NULL)
2056     {
2057       source->type = GTK_ICON_SOURCE_ICON_NAME;
2058       source->source.icon_name = g_strdup (icon_name);
2059     }
2060 }
2061
2062 /**
2063  * gtk_icon_source_set_pixbuf:
2064  * @source: a #GtkIconSource
2065  * @pixbuf: pixbuf to use as a source
2066  *
2067  * Sets a pixbuf to use as a base image when creating icon variants
2068  * for #GtkIconSet.
2069  */
2070 void
2071 gtk_icon_source_set_pixbuf (GtkIconSource *source,
2072                             GdkPixbuf     *pixbuf)
2073 {
2074   g_return_if_fail (source != NULL);
2075   g_return_if_fail (pixbuf == NULL || GDK_IS_PIXBUF (pixbuf));
2076
2077   if (source->type == GTK_ICON_SOURCE_PIXBUF &&
2078       source->source.pixbuf == pixbuf)
2079     return;
2080
2081   icon_source_clear (source);
2082
2083   if (pixbuf != NULL)
2084     {
2085       source->type = GTK_ICON_SOURCE_PIXBUF;
2086       source->source.pixbuf = g_object_ref (pixbuf);
2087     }
2088 }
2089
2090 /**
2091  * gtk_icon_source_get_filename:
2092  * @source: a #GtkIconSource
2093  *
2094  * Retrieves the source filename, or %NULL if none is set. The
2095  * filename is not a copy, and should not be modified or expected to
2096  * persist beyond the lifetime of the icon source.
2097  *
2098  * Return value: image filename. This string must not be modified
2099  * or freed.
2100  */
2101 G_CONST_RETURN gchar*
2102 gtk_icon_source_get_filename (const GtkIconSource *source)
2103 {
2104   g_return_val_if_fail (source != NULL, NULL);
2105
2106   if (source->type == GTK_ICON_SOURCE_FILENAME)
2107     return source->source.filename;
2108   else
2109     return NULL;
2110 }
2111
2112 /**
2113  * gtk_icon_source_get_icon_name:
2114  * @source: a #GtkIconSource
2115  *
2116  * Retrieves the source icon name, or %NULL if none is set. The
2117  * icon_name is not a copy, and should not be modified or expected to
2118  * persist beyond the lifetime of the icon source.
2119  *
2120  * Return value: icon name. This string must not be modified or freed.
2121  */
2122 G_CONST_RETURN gchar*
2123 gtk_icon_source_get_icon_name (const GtkIconSource *source)
2124 {
2125   g_return_val_if_fail (source != NULL, NULL);
2126
2127   if (source->type == GTK_ICON_SOURCE_ICON_NAME ||
2128      source->type == GTK_ICON_SOURCE_STATIC_ICON_NAME)
2129     return source->source.icon_name;
2130   else
2131     return NULL;
2132 }
2133
2134 /**
2135  * gtk_icon_source_get_pixbuf:
2136  * @source: a #GtkIconSource
2137  *
2138  * Retrieves the source pixbuf, or %NULL if none is set.
2139  * In addition, if a filename source is in use, this
2140  * function in some cases will return the pixbuf from
2141  * loaded from the filename. This is, for example, true
2142  * for the GtkIconSource passed to the GtkStyle::render_icon()
2143  * virtual function. The reference count on the pixbuf is
2144  * not incremented.
2145  *
2146  * Return value: source pixbuf
2147  */
2148 GdkPixbuf*
2149 gtk_icon_source_get_pixbuf (const GtkIconSource *source)
2150 {
2151   g_return_val_if_fail (source != NULL, NULL);
2152
2153   if (source->type == GTK_ICON_SOURCE_PIXBUF)
2154     return source->source.pixbuf;
2155   else if (source->type == GTK_ICON_SOURCE_FILENAME)
2156     return source->filename_pixbuf;
2157   else
2158     return NULL;
2159 }
2160
2161 /**
2162  * gtk_icon_source_set_direction_wildcarded:
2163  * @source: a #GtkIconSource
2164  * @setting: %TRUE to wildcard the text direction
2165  *
2166  * If the text direction is wildcarded, this source can be used
2167  * as the base image for an icon in any #GtkTextDirection.
2168  * If the text direction is not wildcarded, then the
2169  * text direction the icon source applies to should be set
2170  * with gtk_icon_source_set_direction(), and the icon source
2171  * will only be used with that text direction.
2172  *
2173  * #GtkIconSet prefers non-wildcarded sources (exact matches) over
2174  * wildcarded sources, and will use an exact match when possible.
2175  */
2176 void
2177 gtk_icon_source_set_direction_wildcarded (GtkIconSource *source,
2178                                           gboolean       setting)
2179 {
2180   g_return_if_fail (source != NULL);
2181
2182   source->any_direction = setting != FALSE;
2183 }
2184
2185 /**
2186  * gtk_icon_source_set_state_wildcarded:
2187  * @source: a #GtkIconSource
2188  * @setting: %TRUE to wildcard the widget state
2189  *
2190  * If the widget state is wildcarded, this source can be used as the
2191  * base image for an icon in any #GtkStateType.  If the widget state
2192  * is not wildcarded, then the state the source applies to should be
2193  * set with gtk_icon_source_set_state() and the icon source will
2194  * only be used with that specific state.
2195  *
2196  * #GtkIconSet prefers non-wildcarded sources (exact matches) over
2197  * wildcarded sources, and will use an exact match when possible.
2198  *
2199  * #GtkIconSet will normally transform wildcarded source images to
2200  * produce an appropriate icon for a given state, for example
2201  * lightening an image on prelight, but will not modify source images
2202  * that match exactly.
2203  */
2204 void
2205 gtk_icon_source_set_state_wildcarded (GtkIconSource *source,
2206                                       gboolean       setting)
2207 {
2208   g_return_if_fail (source != NULL);
2209
2210   source->any_state = setting != FALSE;
2211 }
2212
2213
2214 /**
2215  * gtk_icon_source_set_size_wildcarded:
2216  * @source: a #GtkIconSource
2217  * @setting: %TRUE to wildcard the widget state
2218  *
2219  * If the icon size is wildcarded, this source can be used as the base
2220  * image for an icon of any size.  If the size is not wildcarded, then
2221  * the size the source applies to should be set with
2222  * gtk_icon_source_set_size() and the icon source will only be used
2223  * with that specific size.
2224  *
2225  * #GtkIconSet prefers non-wildcarded sources (exact matches) over
2226  * wildcarded sources, and will use an exact match when possible.
2227  *
2228  * #GtkIconSet will normally scale wildcarded source images to produce
2229  * an appropriate icon at a given size, but will not change the size
2230  * of source images that match exactly.
2231  */
2232 void
2233 gtk_icon_source_set_size_wildcarded (GtkIconSource *source,
2234                                      gboolean       setting)
2235 {
2236   g_return_if_fail (source != NULL);
2237
2238   source->any_size = setting != FALSE;
2239 }
2240
2241 /**
2242  * gtk_icon_source_get_size_wildcarded:
2243  * @source: a #GtkIconSource
2244  *
2245  * Gets the value set by gtk_icon_source_set_size_wildcarded().
2246  *
2247  * Return value: %TRUE if this icon source is a base for any icon size variant
2248  */
2249 gboolean
2250 gtk_icon_source_get_size_wildcarded (const GtkIconSource *source)
2251 {
2252   g_return_val_if_fail (source != NULL, TRUE);
2253
2254   return source->any_size;
2255 }
2256
2257 /**
2258  * gtk_icon_source_get_state_wildcarded:
2259  * @source: a #GtkIconSource
2260  *
2261  * Gets the value set by gtk_icon_source_set_state_wildcarded().
2262  *
2263  * Return value: %TRUE if this icon source is a base for any widget state variant
2264  */
2265 gboolean
2266 gtk_icon_source_get_state_wildcarded (const GtkIconSource *source)
2267 {
2268   g_return_val_if_fail (source != NULL, TRUE);
2269
2270   return source->any_state;
2271 }
2272
2273 /**
2274  * gtk_icon_source_get_direction_wildcarded:
2275  * @source: a #GtkIconSource
2276  *
2277  * Gets the value set by gtk_icon_source_set_direction_wildcarded().
2278  *
2279  * Return value: %TRUE if this icon source is a base for any text direction variant
2280  */
2281 gboolean
2282 gtk_icon_source_get_direction_wildcarded (const GtkIconSource *source)
2283 {
2284   g_return_val_if_fail (source != NULL, TRUE);
2285
2286   return source->any_direction;
2287 }
2288
2289 /**
2290  * gtk_icon_source_set_direction:
2291  * @source: a #GtkIconSource
2292  * @direction: text direction this source applies to
2293  *
2294  * Sets the text direction this icon source is intended to be used
2295  * with.
2296  *
2297  * Setting the text direction on an icon source makes no difference
2298  * if the text direction is wildcarded. Therefore, you should usually
2299  * call gtk_icon_source_set_direction_wildcarded() to un-wildcard it
2300  * in addition to calling this function.
2301  */
2302 void
2303 gtk_icon_source_set_direction (GtkIconSource   *source,
2304                                GtkTextDirection direction)
2305 {
2306   g_return_if_fail (source != NULL);
2307
2308   source->direction = direction;
2309 }
2310
2311 /**
2312  * gtk_icon_source_set_state:
2313  * @source: a #GtkIconSource
2314  * @state: widget state this source applies to
2315  *
2316  * Sets the widget state this icon source is intended to be used
2317  * with.
2318  *
2319  * Setting the widget state on an icon source makes no difference
2320  * if the state is wildcarded. Therefore, you should usually
2321  * call gtk_icon_source_set_state_wildcarded() to un-wildcard it
2322  * in addition to calling this function.
2323  */
2324 void
2325 gtk_icon_source_set_state (GtkIconSource *source,
2326                            GtkStateType   state)
2327 {
2328   g_return_if_fail (source != NULL);
2329
2330   source->state = state;
2331 }
2332
2333 /**
2334  * gtk_icon_source_set_size:
2335  * @source: a #GtkIconSource
2336  * @size: (type int): icon size this source applies to
2337  *
2338  * Sets the icon size this icon source is intended to be used
2339  * with.
2340  *
2341  * Setting the icon size on an icon source makes no difference
2342  * if the size is wildcarded. Therefore, you should usually
2343  * call gtk_icon_source_set_size_wildcarded() to un-wildcard it
2344  * in addition to calling this function.
2345  */
2346 void
2347 gtk_icon_source_set_size (GtkIconSource *source,
2348                           GtkIconSize    size)
2349 {
2350   g_return_if_fail (source != NULL);
2351
2352   source->size = size;
2353 }
2354
2355 /**
2356  * gtk_icon_source_get_direction:
2357  * @source: a #GtkIconSource
2358  *
2359  * Obtains the text direction this icon source applies to. The return
2360  * value is only useful/meaningful if the text direction is <emphasis>not</emphasis>
2361  * wildcarded.
2362  *
2363  * Return value: text direction this source matches
2364  */
2365 GtkTextDirection
2366 gtk_icon_source_get_direction (const GtkIconSource *source)
2367 {
2368   g_return_val_if_fail (source != NULL, 0);
2369
2370   return source->direction;
2371 }
2372
2373 /**
2374  * gtk_icon_source_get_state:
2375  * @source: a #GtkIconSource
2376  *
2377  * Obtains the widget state this icon source applies to. The return
2378  * value is only useful/meaningful if the widget state is <emphasis>not</emphasis>
2379  * wildcarded.
2380  *
2381  * Return value: widget state this source matches
2382  */
2383 GtkStateType
2384 gtk_icon_source_get_state (const GtkIconSource *source)
2385 {
2386   g_return_val_if_fail (source != NULL, 0);
2387
2388   return source->state;
2389 }
2390
2391 /**
2392  * gtk_icon_source_get_size:
2393  * @source: a #GtkIconSource
2394  *
2395  * Obtains the icon size this source applies to. The return value
2396  * is only useful/meaningful if the icon size is <emphasis>not</emphasis> wildcarded.
2397  *
2398  * Return value: (type int): icon size this source matches.
2399  */
2400 GtkIconSize
2401 gtk_icon_source_get_size (const GtkIconSource *source)
2402 {
2403   g_return_val_if_fail (source != NULL, 0);
2404
2405   return source->size;
2406 }
2407
2408 #define NUM_CACHED_ICONS 8
2409
2410 typedef struct _CachedIcon CachedIcon;
2411
2412 struct _CachedIcon
2413 {
2414   /* These must all match to use the cached pixbuf.
2415    * If any don't match, we must re-render the pixbuf.
2416    */
2417   GtkStyle *style;
2418   GtkTextDirection direction;
2419   GtkStateType state;
2420   GtkIconSize size;
2421
2422   GdkPixbuf *pixbuf;
2423 };
2424
2425 static void
2426 ensure_cache_up_to_date (GtkIconSet *icon_set)
2427 {
2428   if (icon_set->cache_serial != cache_serial)
2429     {
2430       clear_cache (icon_set, TRUE);
2431       icon_set->cache_serial = cache_serial;
2432     }
2433 }
2434
2435 static void
2436 cached_icon_free (CachedIcon *icon)
2437 {
2438   g_object_unref (icon->pixbuf);
2439
2440   if (icon->style)
2441     g_object_unref (icon->style);
2442
2443   g_free (icon);
2444 }
2445
2446 static GdkPixbuf *
2447 find_in_cache (GtkIconSet      *icon_set,
2448                GtkStyle        *style,
2449                GtkTextDirection direction,
2450                GtkStateType     state,
2451                GtkIconSize      size)
2452 {
2453   GSList *tmp_list;
2454   GSList *prev;
2455
2456   ensure_cache_up_to_date (icon_set);
2457
2458   prev = NULL;
2459   tmp_list = icon_set->cache;
2460   while (tmp_list != NULL)
2461     {
2462       CachedIcon *icon = tmp_list->data;
2463
2464       if (icon->style == style &&
2465           icon->direction == direction &&
2466           icon->state == state &&
2467           (size == (GtkIconSize)-1 || icon->size == size))
2468         {
2469           if (prev)
2470             {
2471               /* Move this icon to the front of the list. */
2472               prev->next = tmp_list->next;
2473               tmp_list->next = icon_set->cache;
2474               icon_set->cache = tmp_list;
2475             }
2476
2477           return icon->pixbuf;
2478         }
2479
2480       prev = tmp_list;
2481       tmp_list = g_slist_next (tmp_list);
2482     }
2483
2484   return NULL;
2485 }
2486
2487 static void
2488 add_to_cache (GtkIconSet      *icon_set,
2489               GtkStyle        *style,
2490               GtkTextDirection direction,
2491               GtkStateType     state,
2492               GtkIconSize      size,
2493               GdkPixbuf       *pixbuf)
2494 {
2495   CachedIcon *icon;
2496
2497   ensure_cache_up_to_date (icon_set);
2498
2499   g_object_ref (pixbuf);
2500
2501   /* We have to ref the style, since if the style was finalized
2502    * its address could be reused by another style, creating a
2503    * really weird bug
2504    */
2505
2506   if (style)
2507     g_object_ref (style);
2508
2509   icon = g_new (CachedIcon, 1);
2510   icon_set->cache = g_slist_prepend (icon_set->cache, icon);
2511   icon_set->cache_size++;
2512
2513   icon->style = style;
2514   icon->direction = direction;
2515   icon->state = state;
2516   icon->size = size;
2517   icon->pixbuf = pixbuf;
2518
2519   if (icon->style)
2520     attach_to_style (icon_set, icon->style);
2521
2522   if (icon_set->cache_size >= NUM_CACHED_ICONS)
2523     {
2524       /* Remove oldest item in the cache */
2525       GSList *tmp_list;
2526
2527       tmp_list = icon_set->cache;
2528
2529       /* Find next-to-last link */
2530       g_assert (NUM_CACHED_ICONS > 2);
2531       while (tmp_list->next->next)
2532         tmp_list = tmp_list->next;
2533
2534       g_assert (tmp_list != NULL);
2535       g_assert (tmp_list->next != NULL);
2536       g_assert (tmp_list->next->next == NULL);
2537
2538       /* Free the last icon */
2539       icon = tmp_list->next->data;
2540
2541       g_slist_free (tmp_list->next);
2542       tmp_list->next = NULL;
2543
2544       cached_icon_free (icon);
2545     }
2546 }
2547
2548 static void
2549 clear_cache (GtkIconSet *icon_set,
2550              gboolean    style_detach)
2551 {
2552   GSList *cache, *tmp_list;
2553   GtkStyle *last_style = NULL;
2554
2555   cache = icon_set->cache;
2556   icon_set->cache = NULL;
2557   icon_set->cache_size = 0;
2558   tmp_list = cache;
2559   while (tmp_list != NULL)
2560     {
2561       CachedIcon *icon = tmp_list->data;
2562
2563       if (style_detach)
2564         {
2565           /* simple optimization for the case where the cache
2566            * contains contiguous icons from the same style.
2567            * it's safe to call detach_from_style more than
2568            * once on the same style though.
2569            */
2570           if (last_style != icon->style)
2571             {
2572               detach_from_style (icon_set, icon->style);
2573               last_style = icon->style;
2574             }
2575         }
2576
2577       cached_icon_free (icon);
2578
2579       tmp_list = g_slist_next (tmp_list);
2580     }
2581
2582   g_slist_free (cache);
2583 }
2584
2585 static GSList*
2586 copy_cache (GtkIconSet *icon_set,
2587             GtkIconSet *copy_recipient)
2588 {
2589   GSList *tmp_list;
2590   GSList *copy = NULL;
2591
2592   ensure_cache_up_to_date (icon_set);
2593
2594   tmp_list = icon_set->cache;
2595   while (tmp_list != NULL)
2596     {
2597       CachedIcon *icon = tmp_list->data;
2598       CachedIcon *icon_copy = g_new (CachedIcon, 1);
2599
2600       *icon_copy = *icon;
2601
2602       if (icon_copy->style)
2603         {
2604           attach_to_style (copy_recipient, icon_copy->style);
2605           g_object_ref (icon_copy->style);
2606         }
2607
2608       g_object_ref (icon_copy->pixbuf);
2609
2610       icon_copy->size = icon->size;
2611
2612       copy = g_slist_prepend (copy, icon_copy);
2613
2614       tmp_list = g_slist_next (tmp_list);
2615     }
2616
2617   return g_slist_reverse (copy);
2618 }
2619
2620 static void
2621 attach_to_style (GtkIconSet *icon_set,
2622                  GtkStyle   *style)
2623 {
2624   GHashTable *table;
2625
2626   table = g_object_get_qdata (G_OBJECT (style),
2627                               g_quark_try_string ("gtk-style-icon-sets"));
2628
2629   if (table == NULL)
2630     {
2631       table = g_hash_table_new (NULL, NULL);
2632       g_object_set_qdata_full (G_OBJECT (style),
2633                                g_quark_from_static_string ("gtk-style-icon-sets"),
2634                                table,
2635                                style_dnotify);
2636     }
2637
2638   g_hash_table_insert (table, icon_set, icon_set);
2639 }
2640
2641 static void
2642 detach_from_style (GtkIconSet *icon_set,
2643                    GtkStyle   *style)
2644 {
2645   GHashTable *table;
2646
2647   table = g_object_get_qdata (G_OBJECT (style),
2648                               g_quark_try_string ("gtk-style-icon-sets"));
2649
2650   if (table != NULL)
2651     g_hash_table_remove (table, icon_set);
2652 }
2653
2654 static void
2655 iconsets_foreach (gpointer key,
2656                   gpointer value,
2657                   gpointer user_data)
2658 {
2659   GtkIconSet *icon_set = key;
2660
2661   /* We only need to remove cache entries for the given style;
2662    * but that complicates things because in destroy notify
2663    * we don't know which style got destroyed, and 95% of the
2664    * time all cache entries will have the same style,
2665    * so this is faster anyway.
2666    */
2667
2668   clear_cache (icon_set, FALSE);
2669 }
2670
2671 static void
2672 style_dnotify (gpointer data)
2673 {
2674   GHashTable *table = data;
2675
2676   g_hash_table_foreach (table, iconsets_foreach, NULL);
2677
2678   g_hash_table_destroy (table);
2679 }
2680
2681 /* This allows the icon set to detect that its cache is out of date. */
2682 void
2683 _gtk_icon_set_invalidate_caches (void)
2684 {
2685   ++cache_serial;
2686 }
2687
2688 /**
2689  * _gtk_icon_factory_list_ids:
2690  *
2691  * Gets all known IDs stored in an existing icon factory.
2692  * The strings in the returned list aren't copied.
2693  * The list itself should be freed.
2694  *
2695  * Return value: List of ids in icon factories
2696  */
2697 GList*
2698 _gtk_icon_factory_list_ids (void)
2699 {
2700   GSList *tmp_list;
2701   GList *ids;
2702
2703   ids = NULL;
2704
2705   _gtk_icon_factory_ensure_default_icons ();
2706
2707   tmp_list = all_icon_factories;
2708   while (tmp_list != NULL)
2709     {
2710       GList *these_ids;
2711
2712       GtkIconFactory *factory = GTK_ICON_FACTORY (tmp_list->data);
2713
2714       these_ids = g_hash_table_get_keys (factory->icons);
2715
2716       ids = g_list_concat (ids, these_ids);
2717
2718       tmp_list = g_slist_next (tmp_list);
2719     }
2720
2721   return ids;
2722 }
2723
2724 typedef struct {
2725   GSList *sources;
2726   gboolean in_source;
2727
2728 } IconFactoryParserData;
2729
2730 typedef struct {
2731   gchar            *stock_id;
2732   gchar            *filename;
2733   gchar            *icon_name;
2734   GtkTextDirection  direction;
2735   GtkIconSize       size;
2736   GtkStateType      state;
2737 } IconSourceParserData;
2738
2739 static void
2740 icon_source_start_element (GMarkupParseContext *context,
2741                            const gchar         *element_name,
2742                            const gchar        **names,
2743                            const gchar        **values,
2744                            gpointer             user_data,
2745                            GError             **error)
2746 {
2747   gint i;
2748   gchar *stock_id = NULL;
2749   gchar *filename = NULL;
2750   gchar *icon_name = NULL;
2751   gint size = -1;
2752   gint direction = -1;
2753   gint state = -1;
2754   IconFactoryParserData *parser_data;
2755   IconSourceParserData *source_data;
2756   gchar *error_msg;
2757   GQuark error_domain;
2758
2759   parser_data = (IconFactoryParserData*)user_data;
2760
2761   if (!parser_data->in_source)
2762     {
2763       if (strcmp (element_name, "sources") != 0)
2764         {
2765           error_msg = g_strdup_printf ("Unexpected element %s, expected <sources>", element_name);
2766           error_domain = GTK_BUILDER_ERROR_INVALID_TAG;
2767           goto error;
2768         }
2769       parser_data->in_source = TRUE;
2770       return;
2771     }
2772   else
2773     {
2774       if (strcmp (element_name, "source") != 0)
2775         {
2776           error_msg = g_strdup_printf ("Unexpected element %s, expected <source>", element_name);
2777           error_domain = GTK_BUILDER_ERROR_INVALID_TAG;
2778           goto error;
2779         }
2780     }
2781
2782   for (i = 0; names[i]; i++)
2783     {
2784       if (strcmp (names[i], "stock-id") == 0)
2785         stock_id = g_strdup (values[i]);
2786       else if (strcmp (names[i], "filename") == 0)
2787         filename = g_strdup (values[i]);
2788       else if (strcmp (names[i], "icon-name") == 0)
2789         icon_name = g_strdup (values[i]);
2790       else if (strcmp (names[i], "size") == 0)
2791         {
2792           if (!_gtk_builder_enum_from_string (GTK_TYPE_ICON_SIZE,
2793                                               values[i],
2794                                               &size,
2795                                               error))
2796               return;
2797         }
2798       else if (strcmp (names[i], "direction") == 0)
2799         {
2800           if (!_gtk_builder_enum_from_string (GTK_TYPE_TEXT_DIRECTION,
2801                                               values[i],
2802                                               &direction,
2803                                               error))
2804               return;
2805         }
2806       else if (strcmp (names[i], "state") == 0)
2807         {
2808           if (!_gtk_builder_enum_from_string (GTK_TYPE_STATE_TYPE,
2809                                               values[i],
2810                                               &state,
2811                                               error))
2812               return;
2813         }
2814       else
2815         {
2816           error_msg = g_strdup_printf ("'%s' is not a valid attribute of <%s>",
2817                                        names[i], "source");
2818           error_domain = GTK_BUILDER_ERROR_INVALID_ATTRIBUTE;
2819           goto error;
2820         }
2821     }
2822
2823   if (!stock_id)
2824     {
2825       error_msg = g_strdup_printf ("<source> requires a stock_id");
2826       error_domain = GTK_BUILDER_ERROR_MISSING_ATTRIBUTE;
2827       goto error;
2828     }
2829
2830   source_data = g_slice_new (IconSourceParserData);
2831   source_data->stock_id = stock_id;
2832   source_data->filename = filename;
2833   source_data->icon_name = icon_name;
2834   source_data->size = size;
2835   source_data->direction = direction;
2836   source_data->state = state;
2837
2838   parser_data->sources = g_slist_prepend (parser_data->sources, source_data);
2839   return;
2840
2841  error:
2842   {
2843     gchar *tmp;
2844     gint line_number, char_number;
2845
2846     g_markup_parse_context_get_position (context,
2847                                          &line_number,
2848                                          &char_number);
2849
2850     tmp = g_strdup_printf ("%s:%d:%d %s", "input",
2851                            line_number, char_number, error_msg);
2852 #if 0
2853     g_set_error_literal (error,
2854                  GTK_BUILDER_ERROR,
2855                  error_domain,
2856                  tmp);
2857 #else
2858     g_warning ("%s", tmp);
2859 #endif
2860     g_free (tmp);
2861     g_free (stock_id);
2862     g_free (filename);
2863     g_free (icon_name);
2864     return;
2865   }
2866 }
2867
2868 static const GMarkupParser icon_source_parser =
2869   {
2870     icon_source_start_element,
2871   };
2872
2873 static gboolean
2874 gtk_icon_factory_buildable_custom_tag_start (GtkBuildable     *buildable,
2875                                              GtkBuilder       *builder,
2876                                              GObject          *child,
2877                                              const gchar      *tagname,
2878                                              GMarkupParser    *parser,
2879                                              gpointer         *data)
2880 {
2881   g_assert (buildable);
2882
2883   if (strcmp (tagname, "sources") == 0)
2884     {
2885       IconFactoryParserData *parser_data;
2886
2887       parser_data = g_slice_new0 (IconFactoryParserData);
2888       *parser = icon_source_parser;
2889       *data = parser_data;
2890       return TRUE;
2891     }
2892   return FALSE;
2893 }
2894
2895 static void
2896 gtk_icon_factory_buildable_custom_tag_end (GtkBuildable *buildable,
2897                                            GtkBuilder   *builder,
2898                                            GObject      *child,
2899                                            const gchar  *tagname,
2900                                            gpointer     *user_data)
2901 {
2902   GtkIconFactory *icon_factory;
2903
2904   icon_factory = GTK_ICON_FACTORY (buildable);
2905
2906   if (strcmp (tagname, "sources") == 0)
2907     {
2908       IconFactoryParserData *parser_data;
2909       GtkIconSource *icon_source;
2910       GtkIconSet *icon_set;
2911       GSList *l;
2912
2913       parser_data = (IconFactoryParserData*)user_data;
2914
2915       for (l = parser_data->sources; l; l = l->next)
2916         {
2917           IconSourceParserData *source_data = l->data;
2918
2919           icon_set = gtk_icon_factory_lookup (icon_factory, source_data->stock_id);
2920           if (!icon_set)
2921             {
2922               icon_set = gtk_icon_set_new ();
2923               gtk_icon_factory_add (icon_factory, source_data->stock_id, icon_set);
2924               gtk_icon_set_unref (icon_set);
2925             }
2926
2927           icon_source = gtk_icon_source_new ();
2928
2929           if (source_data->filename)
2930             {
2931               gchar *filename;
2932               filename = _gtk_builder_get_absolute_filename (builder, source_data->filename);
2933               gtk_icon_source_set_filename (icon_source, filename);
2934               g_free (filename);
2935             }
2936           if (source_data->icon_name)
2937             gtk_icon_source_set_icon_name (icon_source, source_data->icon_name);
2938           if (source_data->size != -1)
2939             {
2940               gtk_icon_source_set_size (icon_source, source_data->size);
2941               gtk_icon_source_set_size_wildcarded (icon_source, FALSE);
2942             }
2943           if (source_data->direction != -1)
2944             {
2945               gtk_icon_source_set_direction (icon_source, source_data->direction);
2946               gtk_icon_source_set_direction_wildcarded (icon_source, FALSE);
2947             }
2948           if (source_data->state != -1)
2949             {
2950               gtk_icon_source_set_state (icon_source, source_data->state);
2951               gtk_icon_source_set_state_wildcarded (icon_source, FALSE);
2952             }
2953
2954           /* Inline source_add() to avoid creating a copy */
2955           g_assert (icon_source->type != GTK_ICON_SOURCE_EMPTY);
2956           icon_set->sources = g_slist_insert_sorted (icon_set->sources,
2957                                                      icon_source,
2958                                                      icon_source_compare);
2959
2960           g_free (source_data->stock_id);
2961           g_free (source_data->filename);
2962           g_free (source_data->icon_name);
2963           g_slice_free (IconSourceParserData, source_data);
2964         }
2965       g_slist_free (parser_data->sources);
2966       g_slice_free (IconFactoryParserData, parser_data);
2967
2968       /* TODO: Add an attribute/tag to prevent this.
2969        * Usually it's the right thing to do though.
2970        */
2971       gtk_icon_factory_add_default (icon_factory);
2972     }
2973 }
2974
2975 #if defined (G_OS_WIN32) && !defined (_WIN64)
2976
2977 /* DLL ABI stability backward compatibility versions */
2978
2979 #undef gtk_icon_source_set_filename
2980
2981 void
2982 gtk_icon_source_set_filename (GtkIconSource *source,
2983                               const gchar   *filename)
2984 {
2985   gchar *utf8_filename = g_locale_to_utf8 (filename, -1, NULL, NULL, NULL);
2986
2987   gtk_icon_source_set_filename_utf8 (source, utf8_filename);
2988
2989   g_free (utf8_filename);
2990 }
2991
2992 #undef gtk_icon_source_get_filename
2993
2994 G_CONST_RETURN gchar*
2995 gtk_icon_source_get_filename (const GtkIconSource *source)
2996 {
2997   g_return_val_if_fail (source != NULL, NULL);
2998
2999   if (source->type == GTK_ICON_SOURCE_FILENAME)
3000     return source->cp_filename;
3001   else
3002     return NULL;
3003 }
3004
3005 #endif
3006
3007 #define __GTK_ICON_FACTORY_C__
3008 #include "gtkaliasdef.c"