gtkiconfactory.c 81.2 KB
Newer Older
Cody Russell's avatar
Cody Russell committed
1
/* GTK - The GIMP Toolkit
Havoc Pennington's avatar
Havoc Pennington committed
2
 * Copyright (C) 2000 Red Hat, Inc.
3
 *               2008 Johan Dahlin
4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.	 See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 */

/*
 * Modified by the GTK+ Team and others 1997-2000.  See the AUTHORS
 * file for a list of people on the GTK+ Team.  See the ChangeLog
 * files for a list of changes.  These files are distributed with
Matthias Clasen's avatar
Matthias Clasen committed
24
 * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
25 26
 */

27
#include "config.h"
Manish Singh's avatar
Manish Singh committed
28 29 30
#include <stdlib.h>
#include <errno.h>
#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"
Havoc Pennington's avatar
Havoc Pennington committed
38
#include "gtkintl.h"
39 40
#include "gtkbuildable.h"
#include "gtkbuilderprivate.h"
41
#include "gtkalias.h"
42

43

44 45
static GSList *all_icon_factories = NULL;

46 47 48
typedef enum {
  GTK_ICON_SOURCE_EMPTY,
  GTK_ICON_SOURCE_ICON_NAME,
49
  GTK_ICON_SOURCE_STATIC_ICON_NAME,
50 51 52 53
  GTK_ICON_SOURCE_FILENAME,
  GTK_ICON_SOURCE_PIXBUF
} GtkIconSourceType;

54 55
struct _GtkIconSource
{
56
  GtkIconSourceType type;
Matthias Clasen's avatar
Matthias Clasen committed
57

58 59 60 61 62
  union {
    gchar *icon_name;
    gchar *filename;
    GdkPixbuf *pixbuf;
  } source;
63

64
  GdkPixbuf *filename_pixbuf;
65 66 67 68 69 70 71 72 73 74 75 76

  GtkTextDirection direction;
  GtkStateType state;
  GtkIconSize size;

  /* If TRUE, then the parameter is wildcarded, and the above
   * fields should be ignored. If FALSE, the parameter is
   * specified, and the above fields should be valid.
   */
  guint any_direction : 1;
  guint any_state : 1;
  guint any_size : 1;
77

78
#if defined (G_OS_WIN32) && !defined (_WIN64)
79 80 81 82 83
  /* System codepage version of filename, for DLL ABI backward
   * compatibility functions.
   */
  gchar *cp_filename;
#endif
84 85
};

86

87 88 89 90 91 92 93 94 95 96 97 98 99 100
static void
gtk_icon_factory_buildable_init  (GtkBuildableIface      *iface);

static gboolean gtk_icon_factory_buildable_custom_tag_start (GtkBuildable     *buildable,
							     GtkBuilder       *builder,
							     GObject          *child,
							     const gchar      *tagname,
							     GMarkupParser    *parser,
							     gpointer         *data);
static void gtk_icon_factory_buildable_custom_tag_end (GtkBuildable *buildable,
						       GtkBuilder   *builder,
						       GObject      *child,
						       const gchar  *tagname,
						       gpointer     *user_data);
101 102
static void gtk_icon_factory_finalize   (GObject             *object);
static void get_default_icons           (GtkIconFactory      *icon_factory);
103
static void icon_source_clear           (GtkIconSource       *source);
104

105 106 107 108
static GtkIconSize icon_size_register_intern (const gchar *name,
					      gint         width,
					      gint         height);

109 110 111 112 113
#define GTK_ICON_SOURCE_INIT(any_direction, any_state, any_size)	\
  { GTK_ICON_SOURCE_EMPTY, { NULL }, NULL,				\
   0, 0, 0,								\
   any_direction, any_state, any_size }

114 115 116
G_DEFINE_TYPE_WITH_CODE (GtkIconFactory, gtk_icon_factory, G_TYPE_OBJECT,
			 G_IMPLEMENT_INTERFACE (GTK_TYPE_BUILDABLE,
						gtk_icon_factory_buildable_init))
117 118 119 120 121

static void
gtk_icon_factory_init (GtkIconFactory *factory)
{
  factory->icons = g_hash_table_new (g_str_hash, g_str_equal);
122
  all_icon_factories = g_slist_prepend (all_icon_factories, factory);
123 124 125 126 127 128
}

static void
gtk_icon_factory_class_init (GtkIconFactoryClass *klass)
{
  GObjectClass *object_class = G_OBJECT_CLASS (klass);
Matthias Clasen's avatar
Matthias Clasen committed
129

130 131 132
  object_class->finalize = gtk_icon_factory_finalize;
}

133 134 135 136 137 138 139
static void
gtk_icon_factory_buildable_init (GtkBuildableIface *iface)
{
  iface->custom_tag_start = gtk_icon_factory_buildable_custom_tag_start;
  iface->custom_tag_end = gtk_icon_factory_buildable_custom_tag_end;
}

140 141 142 143 144 145 146 147 148 149 150 151
static void
free_icon_set (gpointer key, gpointer value, gpointer data)
{
  g_free (key);
  gtk_icon_set_unref (value);
}

static void
gtk_icon_factory_finalize (GObject *object)
{
  GtkIconFactory *factory = GTK_ICON_FACTORY (object);

152
  all_icon_factories = g_slist_remove (all_icon_factories, factory);
Matthias Clasen's avatar
Matthias Clasen committed
153

154
  g_hash_table_foreach (factory->icons, free_icon_set, NULL);
Matthias Clasen's avatar
Matthias Clasen committed
155

156
  g_hash_table_destroy (factory->icons);
Matthias Clasen's avatar
Matthias Clasen committed
157

Matthias Clasen's avatar
Matthias Clasen committed
158
  G_OBJECT_CLASS (gtk_icon_factory_parent_class)->finalize (object);
159 160
}

161 162 163 164
/**
 * gtk_icon_factory_new:
 *
 * Creates a new #GtkIconFactory. An icon factory manages a collection
165
 * of #GtkIconSet<!-- -->s; a #GtkIconSet manages a set of variants of a
166 167 168
 * particular icon (i.e. a #GtkIconSet contains variants for different
 * sizes and widget states). Icons in an icon factory are named by a
 * stock ID, which is a simple string identifying the icon. Each
169
 * #GtkStyle has a list of #GtkIconFactory<!-- -->s derived from the current
170 171 172 173 174 175 176
 * theme; those icon factories are consulted first when searching for
 * an icon. If the theme doesn't set a particular icon, GTK+ looks for
 * the icon in a list of default icon factories, maintained by
 * gtk_icon_factory_add_default() and
 * gtk_icon_factory_remove_default(). Applications with icons should
 * add a default icon factory with their icons, which will allow
 * themes to override the icons for the application.
Matthias Clasen's avatar
Matthias Clasen committed
177
 *
178
 * Return value: a new #GtkIconFactory
Matthias Clasen's avatar
Matthias Clasen committed
179
 */
180 181 182
GtkIconFactory*
gtk_icon_factory_new (void)
{
Manish Singh's avatar
Manish Singh committed
183
  return g_object_new (GTK_TYPE_ICON_FACTORY, NULL);
184 185
}

186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201
/**
 * gtk_icon_factory_add:
 * @factory: a #GtkIconFactory
 * @stock_id: icon name
 * @icon_set: icon set
 *
 * Adds the given @icon_set to the icon factory, under the name
 * @stock_id.  @stock_id should be namespaced for your application,
 * e.g. "myapp-whatever-icon".  Normally applications create a
 * #GtkIconFactory, then add it to the list of default factories with
 * gtk_icon_factory_add_default(). Then they pass the @stock_id to
 * widgets such as #GtkImage to display the icon. Themes can provide
 * an icon with the same name (such as "myapp-whatever-icon") to
 * override your application's default icons. If an icon already
 * existed in @factory for @stock_id, it is unreferenced and replaced
 * with the new @icon_set.
Matthias Clasen's avatar
Matthias Clasen committed
202
 */
203 204 205 206 207 208 209 210 211 212
void
gtk_icon_factory_add (GtkIconFactory *factory,
                      const gchar    *stock_id,
                      GtkIconSet     *icon_set)
{
  gpointer old_key = NULL;
  gpointer old_value = NULL;

  g_return_if_fail (GTK_IS_ICON_FACTORY (factory));
  g_return_if_fail (stock_id != NULL);
Matthias Clasen's avatar
Matthias Clasen committed
213
  g_return_if_fail (icon_set != NULL);
214 215 216 217 218 219

  g_hash_table_lookup_extended (factory->icons, stock_id,
                                &old_key, &old_value);

  if (old_value == icon_set)
    return;
Matthias Clasen's avatar
Matthias Clasen committed
220

221 222 223 224 225 226 227 228 229 230 231 232
  gtk_icon_set_ref (icon_set);

  /* GHashTable key memory management is so fantastically broken. */
  if (old_key)
    g_hash_table_insert (factory->icons, old_key, icon_set);
  else
    g_hash_table_insert (factory->icons, g_strdup (stock_id), icon_set);

  if (old_value)
    gtk_icon_set_unref (old_value);
}

233 234 235 236
/**
 * gtk_icon_factory_lookup:
 * @factory: a #GtkIconFactory
 * @stock_id: an icon name
Matthias Clasen's avatar
Matthias Clasen committed
237
 *
238 239 240 241 242
 * Looks up @stock_id in the icon factory, returning an icon set
 * if found, otherwise %NULL. For display to the user, you should
 * use gtk_style_lookup_icon_set() on the #GtkStyle for the
 * widget that will display the icon, instead of using this
 * function directly, so that themes are taken into account.
Matthias Clasen's avatar
Matthias Clasen committed
243
 *
244
 * Return value: icon set of @stock_id.
Matthias Clasen's avatar
Matthias Clasen committed
245
 */
246 247 248 249 250 251
GtkIconSet *
gtk_icon_factory_lookup (GtkIconFactory *factory,
                         const gchar    *stock_id)
{
  g_return_val_if_fail (GTK_IS_ICON_FACTORY (factory), NULL);
  g_return_val_if_fail (stock_id != NULL, NULL);
Matthias Clasen's avatar
Matthias Clasen committed
252

253 254 255 256 257 258
  return g_hash_table_lookup (factory->icons, stock_id);
}

static GtkIconFactory *gtk_default_icons = NULL;
static GSList *default_factories = NULL;

259 260 261
/**
 * gtk_icon_factory_add_default:
 * @factory: a #GtkIconFactory
Matthias Clasen's avatar
Matthias Clasen committed
262
 *
263 264 265 266 267 268
 * Adds an icon factory to the list of icon factories searched by
 * gtk_style_lookup_icon_set(). This means that, for example,
 * gtk_image_new_from_stock() will be able to find icons in @factory.
 * There will normally be an icon factory added for each library or
 * application that comes with icons. The default icon factories
 * can be overridden by themes.
Matthias Clasen's avatar
Matthias Clasen committed
269
 */
270 271 272 273 274
void
gtk_icon_factory_add_default (GtkIconFactory *factory)
{
  g_return_if_fail (GTK_IS_ICON_FACTORY (factory));

Manish Singh's avatar
Manish Singh committed
275
  g_object_ref (factory);
Matthias Clasen's avatar
Matthias Clasen committed
276

277 278 279
  default_factories = g_slist_prepend (default_factories, factory);
}

280 281 282 283 284 285 286
/**
 * gtk_icon_factory_remove_default:
 * @factory: a #GtkIconFactory previously added with gtk_icon_factory_add_default()
 *
 * Removes an icon factory from the list of default icon
 * factories. Not normally used; you might use it for a library that
 * can be unloaded or shut down.
Matthias Clasen's avatar
Matthias Clasen committed
287
 */
288 289 290 291 292 293 294
void
gtk_icon_factory_remove_default (GtkIconFactory  *factory)
{
  g_return_if_fail (GTK_IS_ICON_FACTORY (factory));

  default_factories = g_slist_remove (default_factories, factory);

Manish Singh's avatar
Manish Singh committed
295
  g_object_unref (factory);
296 297
}

298 299
void
_gtk_icon_factory_ensure_default_icons (void)
300 301 302 303 304 305 306 307 308
{
  if (gtk_default_icons == NULL)
    {
      gtk_default_icons = gtk_icon_factory_new ();

      get_default_icons (gtk_default_icons);
    }
}

309 310 311 312 313 314 315 316 317
/**
 * gtk_icon_factory_lookup_default:
 * @stock_id: an icon name
 *
 * Looks for an icon in the list of default icon factories.  For
 * display to the user, you should use gtk_style_lookup_icon_set() on
 * the #GtkStyle for the widget that will display the icon, instead of
 * using this function directly, so that themes are taken into
 * account.
Matthias Clasen's avatar
Matthias Clasen committed
318
 *
319
 * Return value: a #GtkIconSet, or %NULL
Matthias Clasen's avatar
Matthias Clasen committed
320
 */
321 322 323 324 325 326
GtkIconSet *
gtk_icon_factory_lookup_default (const gchar *stock_id)
{
  GSList *tmp_list;

  g_return_val_if_fail (stock_id != NULL, NULL);
Matthias Clasen's avatar
Matthias Clasen committed
327

328 329 330 331 332 333 334 335 336
  tmp_list = default_factories;
  while (tmp_list != NULL)
    {
      GtkIconSet *icon_set =
        gtk_icon_factory_lookup (GTK_ICON_FACTORY (tmp_list->data),
                                 stock_id);

      if (icon_set)
        return icon_set;
Matthias Clasen's avatar
Matthias Clasen committed
337

338 339 340
      tmp_list = g_slist_next (tmp_list);
    }

341
  _gtk_icon_factory_ensure_default_icons ();
Matthias Clasen's avatar
Matthias Clasen committed
342

343 344 345
  return gtk_icon_factory_lookup (gtk_default_icons, stock_id);
}

346
static void
347 348
register_stock_icon (GtkIconFactory *factory,
		     const gchar    *stock_id)
349
{
350 351
  GtkIconSet *set = gtk_icon_set_new ();
  GtkIconSource source = GTK_ICON_SOURCE_INIT (TRUE, TRUE, TRUE);
352

353
  source.type = GTK_ICON_SOURCE_STATIC_ICON_NAME;
354 355
  source.source.icon_name = (gchar *)stock_id;
  gtk_icon_set_add_source (set, &source);
Matthias Clasen's avatar
Matthias Clasen committed
356

357 358
  gtk_icon_factory_add (factory, stock_id, set);
  gtk_icon_set_unref (set);
359
}
360

361 362 363 364 365
static void
register_bidi_stock_icon (GtkIconFactory *factory,
			  const gchar    *stock_id,
			  const gchar    *stock_id_ltr,
			  const gchar    *stock_id_rtl)
366
{
367 368
  GtkIconSet *set = gtk_icon_set_new ();
  GtkIconSource source = GTK_ICON_SOURCE_INIT (FALSE, TRUE, TRUE);
369

370
  source.type = GTK_ICON_SOURCE_STATIC_ICON_NAME;
371
  source.source.icon_name = (gchar *)stock_id_ltr;
372
  source.direction = GTK_TEXT_DIR_LTR;
373
  gtk_icon_set_add_source (set, &source);
Matthias Clasen's avatar
Matthias Clasen committed
374

375
  source.type = GTK_ICON_SOURCE_STATIC_ICON_NAME;
376 377 378
  source.source.icon_name = (gchar *)stock_id_rtl;
  source.direction = GTK_TEXT_DIR_RTL;
  gtk_icon_set_add_source (set, &source);
Matthias Clasen's avatar
Matthias Clasen committed
379

380 381
  gtk_icon_factory_add (factory, stock_id, set);
  gtk_icon_set_unref (set);
382 383
}

384 385 386 387
static void
get_default_icons (GtkIconFactory *factory)
{
  /* KEEP IN SYNC with gtkstock.c */
388

389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414
  register_stock_icon (factory, GTK_STOCK_DIALOG_AUTHENTICATION);
  register_stock_icon (factory, GTK_STOCK_DIALOG_ERROR);
  register_stock_icon (factory, GTK_STOCK_DIALOG_INFO);
  register_stock_icon (factory, GTK_STOCK_DIALOG_QUESTION);
  register_stock_icon (factory, GTK_STOCK_DIALOG_WARNING);
  register_stock_icon (factory, GTK_STOCK_DND);
  register_stock_icon (factory, GTK_STOCK_DND_MULTIPLE);
  register_stock_icon (factory, GTK_STOCK_APPLY);
  register_stock_icon (factory, GTK_STOCK_CANCEL);
  register_stock_icon (factory, GTK_STOCK_NO);
  register_stock_icon (factory, GTK_STOCK_OK);
  register_stock_icon (factory, GTK_STOCK_YES);
  register_stock_icon (factory, GTK_STOCK_CLOSE);
  register_stock_icon (factory, GTK_STOCK_ADD);
  register_stock_icon (factory, GTK_STOCK_JUSTIFY_CENTER);
  register_stock_icon (factory, GTK_STOCK_JUSTIFY_FILL);
  register_stock_icon (factory, GTK_STOCK_JUSTIFY_LEFT);
  register_stock_icon (factory, GTK_STOCK_JUSTIFY_RIGHT);
  register_stock_icon (factory, GTK_STOCK_GOTO_BOTTOM);
  register_stock_icon (factory, GTK_STOCK_CDROM);
  register_stock_icon (factory, GTK_STOCK_CONVERT);
  register_stock_icon (factory, GTK_STOCK_COPY);
  register_stock_icon (factory, GTK_STOCK_CUT);
  register_stock_icon (factory, GTK_STOCK_GO_DOWN);
  register_stock_icon (factory, GTK_STOCK_EXECUTE);
  register_stock_icon (factory, GTK_STOCK_QUIT);
Matthias Clasen's avatar
Matthias Clasen committed
415 416 417
  register_bidi_stock_icon (factory,
			    GTK_STOCK_GOTO_FIRST,
			    GTK_STOCK_GOTO_FIRST "-ltr",
418 419 420 421 422 423 424 425
			    GTK_STOCK_GOTO_FIRST "-rtl");
  register_stock_icon (factory, GTK_STOCK_SELECT_FONT);
  register_stock_icon (factory, GTK_STOCK_FULLSCREEN);
  register_stock_icon (factory, GTK_STOCK_LEAVE_FULLSCREEN);
  register_stock_icon (factory, GTK_STOCK_HARDDISK);
  register_stock_icon (factory, GTK_STOCK_HELP);
  register_stock_icon (factory, GTK_STOCK_HOME);
  register_stock_icon (factory, GTK_STOCK_INFO);
Matthias Clasen's avatar
Matthias Clasen committed
426
  register_bidi_stock_icon (factory,
427 428 429
			    GTK_STOCK_JUMP_TO,
			    GTK_STOCK_JUMP_TO "-ltr",
			    GTK_STOCK_JUMP_TO "-rtl");
Matthias Clasen's avatar
Matthias Clasen committed
430
  register_bidi_stock_icon (factory,
431 432 433
			    GTK_STOCK_GOTO_LAST,
			    GTK_STOCK_GOTO_LAST "-ltr",
			    GTK_STOCK_GOTO_LAST "-rtl");
Matthias Clasen's avatar
Matthias Clasen committed
434
  register_bidi_stock_icon (factory,
435 436 437 438 439 440 441
			    GTK_STOCK_GO_BACK,
			    GTK_STOCK_GO_BACK "-ltr",
			    GTK_STOCK_GO_BACK "-rtl");
  register_stock_icon (factory, GTK_STOCK_MISSING_IMAGE);
  register_stock_icon (factory, GTK_STOCK_NETWORK);
  register_stock_icon (factory, GTK_STOCK_NEW);
  register_stock_icon (factory, GTK_STOCK_OPEN);
442 443
  register_stock_icon (factory, GTK_STOCK_ORIENTATION_PORTRAIT);
  register_stock_icon (factory, GTK_STOCK_ORIENTATION_LANDSCAPE);
Matthias Clasen's avatar
Matthias Clasen committed
444
  register_stock_icon (factory, GTK_STOCK_ORIENTATION_REVERSE_PORTRAIT);
445
  register_stock_icon (factory, GTK_STOCK_ORIENTATION_REVERSE_LANDSCAPE);
446
  register_stock_icon (factory, GTK_STOCK_PAGE_SETUP);
447 448 449
  register_stock_icon (factory, GTK_STOCK_PASTE);
  register_stock_icon (factory, GTK_STOCK_PREFERENCES);
  register_stock_icon (factory, GTK_STOCK_PRINT);
Matthias Clasen's avatar
Matthias Clasen committed
450
  register_stock_icon (factory, GTK_STOCK_PRINT_ERROR);
451
  register_stock_icon (factory, GTK_STOCK_PRINT_PAUSED);
452
  register_stock_icon (factory, GTK_STOCK_PRINT_PREVIEW);
Matthias Clasen's avatar
Matthias Clasen committed
453 454
  register_stock_icon (factory, GTK_STOCK_PRINT_REPORT);
  register_stock_icon (factory, GTK_STOCK_PRINT_WARNING);
455
  register_stock_icon (factory, GTK_STOCK_PROPERTIES);
Matthias Clasen's avatar
Matthias Clasen committed
456
  register_bidi_stock_icon (factory,
457 458 459 460 461
			    GTK_STOCK_REDO,
			    GTK_STOCK_REDO "-ltr",
			    GTK_STOCK_REDO "-rtl");
  register_stock_icon (factory, GTK_STOCK_REMOVE);
  register_stock_icon (factory, GTK_STOCK_REFRESH);
Matthias Clasen's avatar
Matthias Clasen committed
462
  register_bidi_stock_icon (factory,
463 464 465
			    GTK_STOCK_REVERT_TO_SAVED,
			    GTK_STOCK_REVERT_TO_SAVED "-ltr",
			    GTK_STOCK_REVERT_TO_SAVED "-rtl");
Matthias Clasen's avatar
Matthias Clasen committed
466
  register_bidi_stock_icon (factory,
467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482
			    GTK_STOCK_GO_FORWARD,
			    GTK_STOCK_GO_FORWARD "-ltr",
			    GTK_STOCK_GO_FORWARD "-rtl");
  register_stock_icon (factory, GTK_STOCK_SAVE);
  register_stock_icon (factory, GTK_STOCK_FLOPPY);
  register_stock_icon (factory, GTK_STOCK_SAVE_AS);
  register_stock_icon (factory, GTK_STOCK_FIND);
  register_stock_icon (factory, GTK_STOCK_FIND_AND_REPLACE);
  register_stock_icon (factory, GTK_STOCK_SORT_DESCENDING);
  register_stock_icon (factory, GTK_STOCK_SORT_ASCENDING);
  register_stock_icon (factory, GTK_STOCK_SPELL_CHECK);
  register_stock_icon (factory, GTK_STOCK_STOP);
  register_stock_icon (factory, GTK_STOCK_BOLD);
  register_stock_icon (factory, GTK_STOCK_ITALIC);
  register_stock_icon (factory, GTK_STOCK_STRIKETHROUGH);
  register_stock_icon (factory, GTK_STOCK_UNDERLINE);
Matthias Clasen's avatar
Matthias Clasen committed
483
  register_bidi_stock_icon (factory,
484 485 486
			    GTK_STOCK_INDENT,
			    GTK_STOCK_INDENT "-ltr",
			    GTK_STOCK_INDENT "-rtl");
Matthias Clasen's avatar
Matthias Clasen committed
487
  register_bidi_stock_icon (factory,
488 489 490
			    GTK_STOCK_UNINDENT,
			    GTK_STOCK_UNINDENT "-ltr",
			    GTK_STOCK_UNINDENT "-rtl");
491 492
  register_stock_icon (factory, GTK_STOCK_GOTO_TOP);
  register_stock_icon (factory, GTK_STOCK_DELETE);
Matthias Clasen's avatar
Matthias Clasen committed
493
  register_bidi_stock_icon (factory,
494 495 496
			    GTK_STOCK_UNDELETE,
			    GTK_STOCK_UNDELETE "-ltr",
			    GTK_STOCK_UNDELETE "-rtl");
Matthias Clasen's avatar
Matthias Clasen committed
497
  register_bidi_stock_icon (factory,
498 499 500 501 502 503 504 505 506 507
			    GTK_STOCK_UNDO,
			    GTK_STOCK_UNDO "-ltr",
			    GTK_STOCK_UNDO "-rtl");
  register_stock_icon (factory, GTK_STOCK_GO_UP);
  register_stock_icon (factory, GTK_STOCK_FILE);
  register_stock_icon (factory, GTK_STOCK_DIRECTORY);
  register_stock_icon (factory, GTK_STOCK_ABOUT);
  register_stock_icon (factory, GTK_STOCK_CONNECT);
  register_stock_icon (factory, GTK_STOCK_DISCONNECT);
  register_stock_icon (factory, GTK_STOCK_EDIT);
508
  register_stock_icon (factory, GTK_STOCK_CAPS_LOCK_WARNING);
Matthias Clasen's avatar
Matthias Clasen committed
509
  register_bidi_stock_icon (factory,
510 511 512
			    GTK_STOCK_MEDIA_FORWARD,
			    GTK_STOCK_MEDIA_FORWARD "-ltr",
			    GTK_STOCK_MEDIA_FORWARD "-rtl");
Matthias Clasen's avatar
Matthias Clasen committed
513
  register_bidi_stock_icon (factory,
514 515 516 517
			    GTK_STOCK_MEDIA_NEXT,
			    GTK_STOCK_MEDIA_NEXT "-ltr",
			    GTK_STOCK_MEDIA_NEXT "-rtl");
  register_stock_icon (factory, GTK_STOCK_MEDIA_PAUSE);
Matthias Clasen's avatar
Matthias Clasen committed
518
  register_bidi_stock_icon (factory,
519 520 521
			    GTK_STOCK_MEDIA_PLAY,
			    GTK_STOCK_MEDIA_PLAY "-ltr",
			    GTK_STOCK_MEDIA_PLAY "-rtl");
Matthias Clasen's avatar
Matthias Clasen committed
522
  register_bidi_stock_icon (factory,
523 524 525 526
			    GTK_STOCK_MEDIA_PREVIOUS,
			    GTK_STOCK_MEDIA_PREVIOUS "-ltr",
			    GTK_STOCK_MEDIA_PREVIOUS "-rtl");
  register_stock_icon (factory, GTK_STOCK_MEDIA_RECORD);
Matthias Clasen's avatar
Matthias Clasen committed
527
  register_bidi_stock_icon (factory,
528 529 530 531 532 533 534 535 536 537 538 539 540
			    GTK_STOCK_MEDIA_REWIND,
			    GTK_STOCK_MEDIA_REWIND "-ltr",
			    GTK_STOCK_MEDIA_REWIND "-rtl");
  register_stock_icon (factory, GTK_STOCK_MEDIA_STOP);
  register_stock_icon (factory, GTK_STOCK_INDEX);
  register_stock_icon (factory, GTK_STOCK_ZOOM_100);
  register_stock_icon (factory, GTK_STOCK_ZOOM_IN);
  register_stock_icon (factory, GTK_STOCK_ZOOM_OUT);
  register_stock_icon (factory, GTK_STOCK_ZOOM_FIT);
  register_stock_icon (factory, GTK_STOCK_SELECT_ALL);
  register_stock_icon (factory, GTK_STOCK_CLEAR);
  register_stock_icon (factory, GTK_STOCK_SELECT_COLOR);
  register_stock_icon (factory, GTK_STOCK_COLOR_PICKER);
541 542
}

543 544 545
/************************************************************
 *                    Icon size handling                    *
 ************************************************************/
546 547 548 549 550

typedef struct _IconSize IconSize;

struct _IconSize
{
551
  gint size;
552
  gchar *name;
Matthias Clasen's avatar
Matthias Clasen committed
553

554 555
  gint width;
  gint height;
556 557
};

558
typedef struct _IconAlias IconAlias;
559

560
struct _IconAlias
561
{
562 563 564
  gchar *name;
  gint   target;
};
565

566 567 568 569 570 571 572 573
typedef struct _SettingsIconSize SettingsIconSize;

struct _SettingsIconSize
{
  gint width;
  gint height;
};

574 575 576 577
static GHashTable *icon_aliases = NULL;
static IconSize *icon_sizes = NULL;
static gint      icon_sizes_allocated = 0;
static gint      icon_sizes_used = 0;
578 579

static void
580
init_icon_sizes (void)
581
{
582
  if (icon_sizes == NULL)
583
    {
584
#define NUM_BUILTIN_SIZES 7
585
      gint i;
586

587
      icon_aliases = g_hash_table_new (g_str_hash, g_str_equal);
Matthias Clasen's avatar
Matthias Clasen committed
588

589 590 591 592 593 594 595 596 597 598 599 600 601 602
      icon_sizes = g_new (IconSize, NUM_BUILTIN_SIZES);
      icon_sizes_allocated = NUM_BUILTIN_SIZES;
      icon_sizes_used = NUM_BUILTIN_SIZES;

      icon_sizes[GTK_ICON_SIZE_INVALID].size = 0;
      icon_sizes[GTK_ICON_SIZE_INVALID].name = NULL;
      icon_sizes[GTK_ICON_SIZE_INVALID].width = 0;
      icon_sizes[GTK_ICON_SIZE_INVALID].height = 0;

      /* the name strings aren't copied since we don't ever remove
       * icon sizes, so we don't need to know whether they're static.
       * Even if we did I suppose removing the builtin sizes would be
       * disallowed.
       */
Matthias Clasen's avatar
Matthias Clasen committed
603

604 605 606 607 608 609 610
      icon_sizes[GTK_ICON_SIZE_MENU].size = GTK_ICON_SIZE_MENU;
      icon_sizes[GTK_ICON_SIZE_MENU].name = "gtk-menu";
      icon_sizes[GTK_ICON_SIZE_MENU].width = 16;
      icon_sizes[GTK_ICON_SIZE_MENU].height = 16;

      icon_sizes[GTK_ICON_SIZE_BUTTON].size = GTK_ICON_SIZE_BUTTON;
      icon_sizes[GTK_ICON_SIZE_BUTTON].name = "gtk-button";
Anders Carlsson's avatar
Anders Carlsson committed
611 612
      icon_sizes[GTK_ICON_SIZE_BUTTON].width = 20;
      icon_sizes[GTK_ICON_SIZE_BUTTON].height = 20;
613 614 615 616 617

      icon_sizes[GTK_ICON_SIZE_SMALL_TOOLBAR].size = GTK_ICON_SIZE_SMALL_TOOLBAR;
      icon_sizes[GTK_ICON_SIZE_SMALL_TOOLBAR].name = "gtk-small-toolbar";
      icon_sizes[GTK_ICON_SIZE_SMALL_TOOLBAR].width = 18;
      icon_sizes[GTK_ICON_SIZE_SMALL_TOOLBAR].height = 18;
Matthias Clasen's avatar
Matthias Clasen committed
618

619 620 621 622
      icon_sizes[GTK_ICON_SIZE_LARGE_TOOLBAR].size = GTK_ICON_SIZE_LARGE_TOOLBAR;
      icon_sizes[GTK_ICON_SIZE_LARGE_TOOLBAR].name = "gtk-large-toolbar";
      icon_sizes[GTK_ICON_SIZE_LARGE_TOOLBAR].width = 24;
      icon_sizes[GTK_ICON_SIZE_LARGE_TOOLBAR].height = 24;
623

624 625 626 627 628
      icon_sizes[GTK_ICON_SIZE_DND].size = GTK_ICON_SIZE_DND;
      icon_sizes[GTK_ICON_SIZE_DND].name = "gtk-dnd";
      icon_sizes[GTK_ICON_SIZE_DND].width = 32;
      icon_sizes[GTK_ICON_SIZE_DND].height = 32;

629 630 631 632
      icon_sizes[GTK_ICON_SIZE_DIALOG].size = GTK_ICON_SIZE_DIALOG;
      icon_sizes[GTK_ICON_SIZE_DIALOG].name = "gtk-dialog";
      icon_sizes[GTK_ICON_SIZE_DIALOG].width = 48;
      icon_sizes[GTK_ICON_SIZE_DIALOG].height = 48;
633

634
      g_assert ((GTK_ICON_SIZE_DIALOG + 1) == NUM_BUILTIN_SIZES);
635

636 637 638 639 640
      /* Alias everything to itself. */
      i = 1; /* skip invalid size */
      while (i < NUM_BUILTIN_SIZES)
        {
          gtk_icon_size_register_alias (icon_sizes[i].name, icon_sizes[i].size);
Matthias Clasen's avatar
Matthias Clasen committed
641

642 643
          ++i;
        }
Matthias Clasen's avatar
Matthias Clasen committed
644

645
#undef NUM_BUILTIN_SIZES
646 647 648
    }
}

649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693
static void
free_settings_sizes (gpointer data)
{
  g_array_free (data, TRUE);
}

static GArray *
get_settings_sizes (GtkSettings *settings,
		    gboolean    *created)
{
  GArray *settings_sizes;
  static GQuark sizes_quark = 0;

  if (!sizes_quark)
    sizes_quark = g_quark_from_static_string ("gtk-icon-sizes");

  settings_sizes = g_object_get_qdata (G_OBJECT (settings), sizes_quark);
  if (!settings_sizes)
    {
      settings_sizes = g_array_new (FALSE, FALSE, sizeof (SettingsIconSize));
      g_object_set_qdata_full (G_OBJECT (settings), sizes_quark,
			       settings_sizes, free_settings_sizes);
      if (created)
	*created = TRUE;
    }

  return settings_sizes;
}

static void
icon_size_set_for_settings (GtkSettings *settings,
			    const gchar *size_name,
			    gint         width,
			    gint         height)
{
  GtkIconSize size;
  GArray *settings_sizes;
  SettingsIconSize *settings_size;

  g_return_if_fail (size_name != NULL);

  size = gtk_icon_size_from_name (size_name);
  if (size == GTK_ICON_SIZE_INVALID)
    /* Reserve a place */
    size = icon_size_register_intern (size_name, -1, -1);
Matthias Clasen's avatar
Matthias Clasen committed
694

695 696 697 698 699 700 701 702 703 704 705
  settings_sizes = get_settings_sizes (settings, NULL);
  if (size >= settings_sizes->len)
    {
      SettingsIconSize unset = { -1, -1 };
      gint i;

      for (i = settings_sizes->len; i <= size; i++)
	g_array_append_val (settings_sizes, unset);
    }

  settings_size = &g_array_index (settings_sizes, SettingsIconSize, size);
Matthias Clasen's avatar
Matthias Clasen committed
706

707 708 709 710 711 712 713 714 715 716 717 718 719
  settings_size->width = width;
  settings_size->height = height;
}

/* Like pango_parse_word, but accept - as well
 */
static gboolean
scan_icon_size_name (const char **pos, GString *out)
{
  const char *p = *pos;

  while (g_ascii_isspace (*p))
    p++;
Matthias Clasen's avatar
Matthias Clasen committed
720

721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753
  if (!((*p >= 'A' && *p <= 'Z') ||
	(*p >= 'a' && *p <= 'z') ||
	*p == '_' || *p == '-'))
    return FALSE;

  g_string_truncate (out, 0);
  g_string_append_c (out, *p);
  p++;

  while ((*p >= 'A' && *p <= 'Z') ||
	 (*p >= 'a' && *p <= 'z') ||
	 (*p >= '0' && *p <= '9') ||
	 *p == '_' || *p == '-')
    {
      g_string_append_c (out, *p);
      p++;
    }

  *pos = p;

  return TRUE;
}

static void
icon_size_setting_parse (GtkSettings *settings,
			 const gchar *icon_size_string)
{
  GString *name_buf = g_string_new (NULL);
  const gchar *p = icon_size_string;

  while (pango_skip_space (&p))
    {
      gint width, height;
Matthias Clasen's avatar
Matthias Clasen committed
754

755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833
      if (!scan_icon_size_name (&p, name_buf))
	goto err;

      if (!pango_skip_space (&p))
	goto err;

      if (*p != '=')
	goto err;

      p++;

      if (!pango_scan_int (&p, &width))
	goto err;

      if (!pango_skip_space (&p))
	goto err;

      if (*p != ',')
	goto err;

      p++;

      if (!pango_scan_int (&p, &height))
	goto err;

      if (width > 0 && height > 0)
	{
	  icon_size_set_for_settings (settings, name_buf->str,
				      width, height);
	}
      else
	{
	  g_warning ("Invalid size in gtk-icon-sizes: %d,%d\n", width, height);
	}

      pango_skip_space (&p);
      if (*p == '\0')
	break;
      if (*p == ':')
	p++;
      else
	goto err;
    }

  g_string_free (name_buf, TRUE);
  return;

 err:
  g_warning ("Error parsing gtk-icon-sizes string:\n\t'%s'", icon_size_string);
  g_string_free (name_buf, TRUE);
}

static void
icon_size_set_all_from_settings (GtkSettings *settings)
{
  GArray *settings_sizes;
  gchar *icon_size_string;

  /* Reset old settings */
  settings_sizes = get_settings_sizes (settings, NULL);
  g_array_set_size (settings_sizes, 0);

  g_object_get (settings,
		"gtk-icon-sizes", &icon_size_string,
		NULL);

  if (icon_size_string)
    {
      icon_size_setting_parse (settings, icon_size_string);
      g_free (icon_size_string);
    }
}

static void
icon_size_settings_changed (GtkSettings  *settings,
			    GParamSpec   *pspec)
{
  icon_size_set_all_from_settings (settings);

834
  gtk_rc_reset_styles (settings);
835 836 837 838 839 840 841 842 843
}

static void
icon_sizes_init_for_settings (GtkSettings *settings)
{
  g_signal_connect (settings,
		    "notify::gtk-icon-sizes",
		    G_CALLBACK (icon_size_settings_changed),
		    NULL);
Matthias Clasen's avatar
Matthias Clasen committed
844

845 846
  icon_size_set_all_from_settings (settings);
}
Matthias Clasen's avatar
Matthias Clasen committed
847

848
static gboolean
849 850 851 852 853 854 855 856
icon_size_lookup_intern (GtkSettings *settings,
			 GtkIconSize  size,
			 gint        *widthp,
			 gint        *heightp)
{
  GArray *settings_sizes;
  gint width_for_settings = -1;
  gint height_for_settings = -1;
Matthias Clasen's avatar
Matthias Clasen committed
857

858 859
  init_icon_sizes ();

860
  if (size == (GtkIconSize)-1)
861
    return FALSE;
862

863
  if (size >= icon_sizes_used)
864 865 866 867 868 869 870 871
    return FALSE;

  if (size == GTK_ICON_SIZE_INVALID)
    return FALSE;

  if (settings)
    {
      gboolean initial = FALSE;
Matthias Clasen's avatar
Matthias Clasen committed
872

873 874
      settings_sizes = get_settings_sizes (settings, &initial);

875 876
      if (initial)
	icon_sizes_init_for_settings (settings);
Matthias Clasen's avatar
Matthias Clasen committed
877

878 879 880
      if (size < settings_sizes->len)
	{
	  SettingsIconSize *settings_size;
Matthias Clasen's avatar
Matthias Clasen committed
881

882
	  settings_size = &g_array_index (settings_sizes, SettingsIconSize, size);
Matthias Clasen's avatar
Matthias Clasen committed
883

884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899
	  width_for_settings = settings_size->width;
	  height_for_settings = settings_size->height;
	}
    }

  if (widthp)
    *widthp = width_for_settings >= 0 ? width_for_settings : icon_sizes[size].width;

  if (heightp)
    *heightp = height_for_settings >= 0 ? height_for_settings : icon_sizes[size].height;

  return TRUE;
}

/**
 * gtk_icon_size_lookup_for_settings:
900
 * @settings: a #GtkSettings object, used to determine
901
 *   which set of user preferences to used.
902
 * @size: (type int): an icon size
903 904 905 906
 * @width: location to store icon width
 * @height: location to store icon height
 *
 * Obtains the pixel size of a semantic icon size, possibly
Matthias Clasen's avatar
Matthias Clasen committed
907
 * modified by user preferences for a particular
Matthias Clasen's avatar
Matthias Clasen committed
908
 * #GtkSettings. Normally @size would be
909 910 911 912 913 914 915
 * #GTK_ICON_SIZE_MENU, #GTK_ICON_SIZE_BUTTON, etc.  This function
 * isn't normally needed, gtk_widget_render_icon() is the usual
 * way to get an icon for rendering, then just look at the size of
 * the rendered pixbuf. The rendered pixbuf may not even correspond to
 * the width/height returned by gtk_icon_size_lookup(), because themes
 * are free to render the pixbuf however they like, including changing
 * the usual size.
Matthias Clasen's avatar
Matthias Clasen committed
916
 *
917
 * Return value: %TRUE if @size was a valid size
918 919
 *
 * Since: 2.2
Matthias Clasen's avatar
Matthias Clasen committed
920
 */
921 922 923
gboolean
gtk_icon_size_lookup_for_settings (GtkSettings *settings,
				   GtkIconSize  size,
924 925
				   gint        *width,
				   gint        *height)
926 927 928
{
  g_return_val_if_fail (GTK_IS_SETTINGS (settings), FALSE);

929
  return icon_size_lookup_intern (settings, size, width, height);
930 931
}

932 933
/**
 * gtk_icon_size_lookup:
934
 * @size: (type int): an icon size
935 936 937
 * @width: location to store icon width
 * @height: location to store icon height
 *
938 939 940 941
 * Obtains the pixel size of a semantic icon size, possibly
 * modified by user preferences for the default #GtkSettings.
 * (See gtk_icon_size_lookup_for_settings().)
 * Normally @size would be
942 943 944 945 946
 * #GTK_ICON_SIZE_MENU, #GTK_ICON_SIZE_BUTTON, etc.  This function
 * isn't normally needed, gtk_widget_render_icon() is the usual
 * way to get an icon for rendering, then just look at the size of
 * the rendered pixbuf. The rendered pixbuf may not even correspond to
 * the width/height returned by gtk_icon_size_lookup(), because themes
947 948
 * are free to render the pixbuf however they like, including changing
 * the usual size.
Matthias Clasen's avatar
Matthias Clasen committed
949
 *
950
 * Return value: %TRUE if @size was a valid size
Matthias Clasen's avatar
Matthias Clasen committed
951
 */
952
gboolean
953
gtk_icon_size_lookup (GtkIconSize  size,
954 955 956
                      gint        *widthp,
                      gint        *heightp)
{
957 958
  GTK_NOTE (MULTIHEAD,
	    g_warning ("gtk_icon_size_lookup ()) is not multihead safe"));
959

960 961 962
  return gtk_icon_size_lookup_for_settings (gtk_settings_get_default (),
					    size, widthp, heightp);
}
963

964 965 966 967 968 969 970
static GtkIconSize
icon_size_register_intern (const gchar *name,
			   gint         width,
			   gint         height)
{
  IconAlias *old_alias;
  GtkIconSize size;
Matthias Clasen's avatar
Matthias Clasen committed
971

972
  init_icon_sizes ();
973

974 975 976 977 978 979
  old_alias = g_hash_table_lookup (icon_aliases, name);
  if (old_alias && icon_sizes[old_alias->target].width > 0)
    {
      g_warning ("Icon size name '%s' already exists", name);
      return GTK_ICON_SIZE_INVALID;
    }
980

981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005
  if (old_alias)
    {
      size = old_alias->target;
    }
  else
    {
      if (icon_sizes_used == icon_sizes_allocated)
	{
	  icon_sizes_allocated *= 2;
	  icon_sizes = g_renew (IconSize, icon_sizes, icon_sizes_allocated);
	}

      size = icon_sizes_used++;

      /* alias to self. */
      gtk_icon_size_register_alias (name, size);

      icon_sizes[size].size = size;
      icon_sizes[size].name = g_strdup (name);
    }

  icon_sizes[size].width = width;
  icon_sizes[size].height = height;

  return size;
1006 1007
}

1008 1009
/**
 * gtk_icon_size_register:
1010
 * @name: name of the icon size
1011 1012 1013 1014
 * @width: the icon width
 * @height: the icon height
 *
 * Registers a new icon size, along the same lines as #GTK_ICON_SIZE_MENU,
1015 1016
 * etc. Returns the integer value for the size.
 *
1017
 * Returns: (type int): integer value representing the size
Matthias Clasen's avatar
Matthias Clasen committed
1018
 */
1019 1020
GtkIconSize
gtk_icon_size_register (const gchar *name,
1021 1022 1023
                        gint         width,
                        gint         height)
{
1024 1025 1026
  g_return_val_if_fail (name != NULL, 0);
  g_return_val_if_fail (width > 0, 0);
  g_return_val_if_fail (height > 0, 0);
Matthias Clasen's avatar
Matthias Clasen committed
1027

1028
  return icon_size_register_intern (name, width, height);
1029 1030
}

1031 1032 1033
/**
 * gtk_icon_size_register_alias:
 * @alias: an alias for @target
1034
 * @target: (type int): an existing icon size
1035 1036 1037 1038
 *
 * Registers @alias as another name for @target.
 * So calling gtk_icon_size_from_name() with @alias as argument
 * will return @target.
Matthias Clasen's avatar
Matthias Clasen committed
1039
 */
1040 1041
void
gtk_icon_size_register_alias (const gchar *alias,
1042
                              GtkIconSize  target)
1043
{
1044
  IconAlias *ia;
Matthias Clasen's avatar
Matthias Clasen committed
1045

1046 1047 1048 1049
  g_return_if_fail (alias != NULL);

  init_icon_sizes ();

1050
  if (!icon_size_lookup_intern (NULL, target, NULL, NULL))
1051
    g_warning ("gtk_icon_size_register_alias: Icon size %u does not exist", target);
1052

1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072
  ia = g_hash_table_lookup (icon_aliases, alias);
  if (ia)
    {
      if (icon_sizes[ia->target].width > 0)
	{
	  g_warning ("gtk_icon_size_register_alias: Icon size name '%s' already exists", alias);
	  return;
	}

      ia->target = target;
    }

  if (!ia)
    {
      ia = g_new (IconAlias, 1);
      ia->name = g_strdup (alias);
      ia->target = target;

      g_hash_table_insert (icon_aliases, ia->name, ia);
    }
1073 1074
}

Matthias Clasen's avatar
Matthias Clasen committed
1075
/**
Matthias Clasen's avatar
Matthias Clasen committed
1076 1077 1078
 * gtk_icon_size_from_name:
 * @name: the name to look up.
 * @returns: the icon size with the given name.
Matthias Clasen's avatar
Matthias Clasen committed
1079
 *
Matthias Clasen's avatar
Matthias Clasen committed
1080
 * Looks up the icon size associated with @name.
1081 1082
 *
 * Return value: (type int): the icon size
Matthias Clasen's avatar
Matthias Clasen committed
1083
 */
1084 1085 1086 1087 1088 1089
GtkIconSize
gtk_icon_size_from_name (const gchar *name)
{
  IconAlias *ia;

  init_icon_sizes ();
Matthias Clasen's avatar
Matthias Clasen committed
1090

1091 1092
  ia = g_hash_table_lookup (icon_aliases, name);

1093
  if (ia && icon_sizes[ia->target].width > 0)
1094 1095 1096 1097 1098
    return ia->target;
  else
    return GTK_ICON_SIZE_INVALID;
}

Matthias Clasen's avatar
Matthias Clasen committed
1099 1100
/**
 * gtk_icon_size_get_name:
1101
 * @size: (type int): a #GtkIconSize.
Matthias Clasen's avatar
Matthias Clasen committed
1102
 * @returns: the name of the given icon size.
Matthias Clasen's avatar
Matthias Clasen committed
1103 1104
 *
 * Gets the canonical name of the given icon size. The returned string
Matthias Clasen's avatar
Matthias Clasen committed
1105
 * is statically allocated and should not be freed.
Matthias Clasen's avatar
Matthias Clasen committed
1106
 */
1107 1108 1109 1110 1111 1112 1113
G_CONST_RETURN gchar*
gtk_icon_size_get_name (GtkIconSize  size)
{
  if (size >= icon_sizes_used)
    return NULL;
  else
    return icon_sizes[size].name;
1114 1115
}

1116 1117
/************************************************************/

1118 1119 1120 1121 1122 1123 1124
/* Icon Set */


static GdkPixbuf *find_in_cache     (GtkIconSet       *icon_set,
                                     GtkStyle         *style,
                                     GtkTextDirection  direction,
                                     GtkStateType      state,
1125
                                     GtkIconSize       size);
1126 1127 1128 1129
static void       add_to_cache      (GtkIconSet       *icon_set,
                                     GtkStyle         *style,
                                     GtkTextDirection  direction,
                                     GtkStateType      state,
1130
                                     GtkIconSize       size,
1131
                                     GdkPixbuf        *pixbuf);
1132 1133 1134 1135
/* Clear icon set contents, drop references to all contained
 * GdkPixbuf objects and forget all GtkIconSources. Used to
 * recycle an icon set.
 */
1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161
static void       clear_cache       (GtkIconSet       *icon_set,
                                     gboolean          style_detach);
static GSList*    copy_cache        (GtkIconSet       *icon_set,
                                     GtkIconSet       *copy_recipient);
static void       attach_to_style   (GtkIconSet       *icon_set,
                                     GtkStyle         *style);
static void       detach_from_style (GtkIconSet       *icon_set,
                                     GtkStyle         *style);
static void       style_dnotify     (gpointer          data);

struct _GtkIconSet
{
  guint ref_count;

  GSList *sources;

  /* Cache of the last few rendered versions of the icon. */
  GSList *cache;

  guint cache_size;

  guint cache_serial;
};

static guint cache_serial = 0;

1162 1163
/**
 * gtk_icon_set_new:
Matthias Clasen's avatar
Matthias Clasen committed
1164
 *
1165 1166 1167 1168 1169 1170 1171 1172 1173
 * Creates a new #GtkIconSet. A #GtkIconSet represents a single icon
 * in various sizes and widget states. It can provide a #GdkPixbuf
 * for a given size and state on request, and automatically caches
 * some of the rendered #GdkPixbuf objects.
 *
 * Normally you would use gtk_widget_render_icon() instead of
 * using #GtkIconSet directly. The one case where you'd use
 * #GtkIconSet is to create application-specific icon sets to place in
 * a #GtkIconFactory.
Matthias Clasen's avatar
Matthias Clasen committed
1174
 *
1175
 * Return value: a new #GtkIconSet
Matthias Clasen's avatar
Matthias Clasen committed
1176
 */
1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188
GtkIconSet*
gtk_icon_set_new (void)
{
  GtkIconSet *icon_set;

  icon_set = g_new (GtkIconSet, 1);

  icon_set->ref_count = 1;
  icon_set->sources = NULL;
  icon_set->cache = NULL;
  icon_set->cache_size = 0;
  icon_set->cache_serial = cache_serial;
Matthias Clasen's avatar
Matthias Clasen committed
1189

1190 1191 1192
  return icon_set;
}

1193 1194 1195
/**
 * gtk_icon_set_new_from_pixbuf:
 * @pixbuf: a #GdkPixbuf
Matthias Clasen's avatar
Matthias Clasen committed
1196
 *
1197 1198 1199 1200 1201
 * Creates a new #GtkIconSet with @pixbuf as the default/fallback
 * source image. If you don't add any additional #GtkIconSource to the
 * icon set, all variants of the icon will be created from @pixbuf,
 * using scaling, pixelation, etc. as required to adjust the icon size
 * or make the icon look insensitive/prelighted.
Matthias Clasen's avatar
Matthias Clasen committed
1202
 *
1203
 * Return value: a new #GtkIconSet
Matthias Clasen's avatar
Matthias Clasen committed
1204
 */
1205 1206 1207 1208 1209
GtkIconSet *
gtk_icon_set_new_from_pixbuf (GdkPixbuf *pixbuf)
{
  GtkIconSet *set;

1210
  GtkIconSource source = GTK_ICON_SOURCE_INIT (TRUE, TRUE, TRUE);
1211 1212 1213 1214 1215

  g_return_val_if_fail (pixbuf != NULL, NULL);

  set = gtk_icon_set_new ();

1216
  gtk_icon_source_set_pixbuf (&source, pixbuf);
1217
  gtk_icon_set_add_source (set, &source);
1218
  gtk_icon_source_set_pixbuf (&source, NULL);
Matthias Clasen's avatar
Matthias Clasen committed
1219

1220 1221 1222 1223
  return set;
}


1224 1225
/**
 * gtk_icon_set_ref:
1226
 * @icon_set: a #GtkIconSet.
Matthias Clasen's avatar
Matthias Clasen committed
1227
 *
1228
 * Increments the reference count on @icon_set.
Matthias Clasen's avatar
Matthias Clasen committed
1229
 *
1230
 * Return value: @icon_set.
Matthias Clasen's avatar
Matthias Clasen committed
1231
 */
1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242
GtkIconSet*
gtk_icon_set_ref (GtkIconSet *icon_set)
{
  g_return_val_if_fail (icon_set != NULL, NULL);
  g_return_val_if_fail (icon_set->ref_count > 0, NULL);

  icon_set->ref_count += 1;

  return icon_set;
}

1243 1244 1245
/**
 * gtk_icon_set_unref:
 * @icon_set: a #GtkIconSet
Matthias Clasen's avatar
Matthias Clasen committed
1246
 *
1247 1248
 * Decrements the reference count on @icon_set, and frees memory
 * if the reference count reaches 0.
Matthias Clasen's avatar
Matthias Clasen committed
1249
 */
1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266
void
gtk_icon_set_unref (GtkIconSet *icon_set)
{
  g_return_if_fail (icon_set != NULL);
  g_return_if_fail (icon_set->ref_count > 0);

  icon_set->ref_count -= 1;

  if (icon_set->ref_count == 0)
    {
      GSList *tmp_list = icon_set->sources;
      while (tmp_list != NULL)
        {
          gtk_icon_source_free (tmp_list->data);

          tmp_list = g_slist_next (tmp_list);
        }
1267
      g_slist_free (icon_set->sources);
1268 1269 1270 1271 1272 1273 1274

      clear_cache (icon_set, TRUE);

      g_free (icon_set);
    }
}

1275 1276 1277 1278
GType
gtk_icon_set_get_type (void)
{
  static GType our_type = 0;
Matthias Clasen's avatar
Matthias Clasen committed
1279

1280
  if (our_type == 0)
1281
    our_type = g_boxed_type_register_static (I_("GtkIconSet"),
1282 1283 1284 1285 1286 1287
					     (GBoxedCopyFunc) gtk_icon_set_ref,
					     (GBoxedFreeFunc) gtk_icon_set_unref);

  return our_type;
}

1288 1289 1290
/**
 * gtk_icon_set_copy:
 * @icon_set: a #GtkIconSet
Matthias Clasen's avatar
Matthias Clasen committed
1291 1292 1293
 *
 * Copies @icon_set by value.
 *
1294 1295
 * Return value: a new #GtkIconSet identical to the first.
 **/
1296 1297 1298 1299 1300
GtkIconSet*
gtk_icon_set_copy (GtkIconSet *icon_set)
{
  GtkIconSet *copy;
  GSList *tmp_list;
Matthias Clasen's avatar
Matthias Clasen committed
1301

1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317
  copy = gtk_icon_set_new ();

  tmp_list = icon_set->sources;
  while (tmp_list != NULL)
    {
      copy->sources = g_slist_prepend (copy->sources,
                                       gtk_icon_source_copy (tmp_list->data));

      tmp_list = g_slist_next (tmp_list);
    }

  copy->sources = g_slist_reverse (copy->sources);

  copy->cache = copy_cache (icon_set, copy);
  copy->cache_size = icon_set->cache_size;
  copy->cache_serial = icon_set->cache_serial;
Matthias Clasen's avatar
Matthias Clasen committed
1318

1319 1320 1321 1322
  return copy;
}

static gboolean
1323 1324
sizes_equivalent (GtkIconSize lhs,
                  GtkIconSize rhs)
1325
{
1326 1327 1328 1329 1330 1331 1332 1333
  /* We used to consider sizes equivalent if they were
   * the same pixel size, but we don't have the GtkSettings
   * here, so we can't do that. Plus, it's not clear that
   * it is right... it was just a workaround for the fact
   * that we register icons by logical size, not pixel size.
   */
#if 1
  return lhs == rhs;
Matthias Clasen's avatar
Matthias Clasen committed
1334 1335
#else

1336 1337
  gint r_w, r_h, l_w, l_h;

1338 1339
  icon_size_lookup_intern (NULL, rhs, &r_w, &r_h);
  icon_size_lookup_intern (NULL, lhs, &l_w, &l_h);
1340 1341

  return r_w == l_w && r_h == l_h;
1342
#endif
1343 1344
}

1345 1346 1347 1348 1349 1350
static GtkIconSource *
find_best_matching_source (GtkIconSet       *icon_set,
			   GtkTextDirection  direction,
			   GtkStateType      state,
			   GtkIconSize       size,
			   GSList           *failed)
1351 1352 1353
{
  GtkIconSource *source;
  GSList *tmp_list;
Matthias Clasen's avatar
Matthias Clasen committed
1354

1355 1356 1357 1358 1359 1360 1361
  /* We need to find the best icon source.  Direction matters more
   * than state, state matters more than size. icon_set->sources
   * is sorted according to wildness, so if we take the first
   * match we find it will be the least-wild match (if there are
   * multiple matches for a given "wildness" then the RC file contained
   * dumb stuff, and we end up with an arbitrary matching source)
   */
Matthias Clasen's avatar
Matthias Clasen committed
1362

1363 1364 1365 1366 1367
  source = NULL;
  tmp_list = icon_set->sources;
  while (tmp_list != NULL)
    {
      GtkIconSource *s = tmp_list->data;
Matthias Clasen's avatar
Matthias Clasen committed
1368

1369 1370
      if ((s->any_direction || (s->direction == direction)) &&
          (s->any_state || (s->state == state)) &&
1371
          (s->any_size || size == (GtkIconSize)-1 || (sizes_equivalent (size, s->size))))
1372
        {
1373 1374 1375 1376 1377 1378
	  if (!g_slist_find (failed, s))
	    {
	      source = s;
	      break;
	    }
	}
Matthias Clasen's avatar
Matthias Clasen committed
1379

1380 1381 1382
      tmp_list = g_slist_next (tmp_list);
    }

1383 1384
  return source;
}
Matthias Clasen's avatar
Matthias Clasen committed
1385

1386 1387 1388 1389 1390
static gboolean
ensure_filename_pixbuf (GtkIconSet    *icon_set,
			GtkIconSource *source)
{
  if (source->filename_pixbuf == NULL)
1391
    {
1392
      GError *error = NULL;
Matthias Clasen's avatar
Matthias Clasen committed
1393

1394
      source->filename_pixbuf = gdk_pixbuf_new_from_file (source->source.filename, &error);
Matthias Clasen's avatar
Matthias Clasen committed
1395

1396 1397 1398 1399 1400 1401 1402
      if (source->filename_pixbuf == NULL)
	{
	  /* Remove this icon source so we don't keep trying to
	   * load it.
	   */
	  g_warning (_("Error loading icon: %s"), error->message);
	  g_error_free (error);
Matthias Clasen's avatar
Matthias Clasen committed
1403

1404
	  icon_set->sources = g_slist_remove (icon_set->sources, source);
Matthias Clasen's avatar
Matthias Clasen committed
1405

1406
	  gtk_icon_source_free (source);
1407

1408 1409 1410
	  return FALSE;
	}
    }
Matthias Clasen's avatar
Matthias Clasen committed
1411

1412 1413
  return TRUE;
}
Matthias Clasen's avatar
Matthias Clasen committed
1414

1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430
static GdkPixbuf *
render_icon_name_pixbuf (GtkIconSource    *icon_source,
			 GtkStyle         *style,
			 GtkTextDirection  direction,
			 GtkStateType      state,
			 GtkIconSize       size,
			 GtkWidget         *widget,
			 const char        *detail)
{
  GdkPixbuf *pixbuf;
  GdkPixbuf *tmp_pixbuf;
  GtkIconSource tmp_source;
  GdkScreen *screen;
  GtkIconTheme *icon_theme;
  GtkSettings *settings;
  gint width, height, pixel_size;
Matthias Clasen's avatar
Matthias Clasen committed
1431
  gint *sizes, *s, dist;
1432
  GError *error = NULL;
Matthias Clasen's avatar
Matthias Clasen committed
1433

1434 1435
  if (widget && gtk_widget_has_screen (widget))
    screen = gtk_widget_get_screen (widget);
Matthias Clasen's avatar
Matthias Clasen committed
1436
  else if (style && style->colormap)
1437 1438 1439 1440 1441 1442
    screen = gdk_colormap_get_screen (style->colormap);
  else
    {
      screen = gdk_screen_get_default ();
      GTK_NOTE (MULTIHEAD,
		g_warning ("Using the default screen for gtk_icon_source_render_icon()"));
1443 1444
    }

1445 1446 1447 1448 1449
  icon_theme = gtk_icon_theme_get_for_screen (screen);
  settings = gtk_settings_get_for_screen (screen);

  if (!gtk_icon_size_lookup_for_settings (settings, size, &width, &height))
    {
1450
      if (size == (GtkIconSize)-1)
Matthias Clasen's avatar
Matthias Clasen committed
1451
	{
Matthias Clasen's avatar
Matthias Clasen committed
1452
	  /* Find an available size close to 48 */
Matthias Clasen's avatar
Matthias Clasen committed
1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470
	  sizes = gtk_icon_theme_get_icon_sizes (icon_theme, icon_source->source.icon_name);
	  dist = 1000;
	  width = height = 48;
	  for (s = sizes; *s; s++)
	    {
	      if (*s == -1)
		{
		  width = height = 48;
		  break;
		}
	      if (*s < 48)
		{
		  if (48 - *s < dist)
		    {
		      width = height = *s;
		      dist = 48 - *s;
		    }
		}
Matthias Clasen's avatar
Matthias Clasen committed
1471
	      else
Matthias Clasen's avatar
Matthias Clasen committed
1472 1473 1474 1475 1476 1477 1478 1479
		{
		  if (*s - 48 < dist)
		    {
		      width = height = *s;
		      dist = *s - 48;
		    }
		}
	    }
Matthias Clasen's avatar
Matthias Clasen committed
1480

Matthias Clasen's avatar
Matthias Clasen committed
1481 1482 1483 1484
	  g_free (sizes);
	}
      else
	{
1485
	  g_warning ("Invalid icon size %u\n", size);
Matthias Clasen's avatar
Matthias Clasen committed
1486 1487
	  width = height = 24;
	}
1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498
    }

  pixel_size = MIN (width, height);

  tmp_pixbuf = gtk_icon_theme_load_icon (icon_theme,
					 icon_source->source.icon_name,
					 pixel_size, 0,
					 &error);

  if (!tmp_pixbuf)
    {
1499 1500 1501 1502
      g_warning ("Error loading theme icon '%s' for stock: %s",
                 icon_source->source.icon_name, error ? error->message : "");
      if (error)
        g_error_free (error);
1503 1504
      return NULL;
    }
Matthias Clasen's avatar
Matthias Clasen committed
1505

1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546
  tmp_source = *icon_source;
  tmp_source.type = GTK_ICON_SOURCE_PIXBUF;
  tmp_source.source.pixbuf = tmp_pixbuf;

  pixbuf = gtk_style_render_icon (style, &tmp_source,
				  direction, state, -1,
				  widget, detail);

  if (!pixbuf)
    g_warning ("Failed to render icon");

  g_object_unref (tmp_pixbuf);

  return pixbuf;
}

static GdkPixbuf *
find_and_render_icon_source (GtkIconSet       *icon_set,
			     GtkStyle         *style,
			     GtkTextDirection  direction,
			     GtkStateType      state,
			     GtkIconSize       size,
			     GtkWidget         *widget,
			     const char        *detail)
{
  GSList *failed = NULL;
  GdkPixbuf *pixbuf = NULL;

  /* We treat failure in two different ways:
   *
   *  A) If loading a source that specifies a filename fails,
   *     we treat that as permanent, and remove the source
   *     from the GtkIconSet. (in ensure_filename_pixbuf ()
   *  B) If loading a themed icon fails, or scaling an icon
   *     fails, we treat that as transient and will try
   *     again next time the icon falls out of the cache
   *     and we need to recreate it.
   */
  while (pixbuf == NULL)
    {
      GtkIconSource *source = find_best_matching_source (icon_set, direction, state, size, failed);
Matthias Clasen's avatar
Matthias Clasen committed
1547

1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567
      if (source == NULL)
	break;

      switch (source->type)
	{
	case GTK_ICON_SOURCE_FILENAME:
	  if (!ensure_filename_pixbuf (icon_set, source))
	    break;
	  /* Fall through */
	case GTK_ICON_SOURCE_PIXBUF:
	  pixbuf = gtk_style_render_icon (style, source,
					  direction, state, size,
					  widget, detail);
	  if (!pixbuf)
	    {
	      g_warning ("Failed to render icon");
	      failed = g_slist_prepend (failed, source);
	    }
	  break;
	case GTK_ICON_SOURCE_ICON_NAME:
1568
	case GTK_ICON_SOURCE_STATIC_ICON_NAME:
1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582
	  pixbuf = render_icon_name_pixbuf (source, style,
					    direction, state, size,
					    widget, detail);
	  if (!pixbuf)
	    failed = g_slist_prepend (failed, source);
	  break;
	case GTK_ICON_SOURCE_EMPTY:
	  g_assert_not_reached ();
	}
    }

  g_slist_free (failed);

  return pixbuf;
1583 1584
}

1585 1586
extern GtkIconCache *_builtin_cache;

1587
static GdkPixbuf*
1588 1589 1590 1591 1592 1593
render_fallback_image (GtkStyle          *style,
                       GtkTextDirection   direction,
                       GtkStateType       state,
                       GtkIconSize        size,
                       GtkWidget         *widget,
                       const char        *detail)
1594 1595
{
  /* This icon can be used for any direction/state/size */
1596
  static GtkIconSource fallback_source = GTK_ICON_SOURCE_INIT (TRUE,