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