gtkicontheme.c 105 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14
/* GtkIconTheme - a loader for icon themes
 * gtk-icon-theme.c Copyright (C) 2002, 2003 Red Hat, Inc.
 *
 * 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
Javier Jardón's avatar
Javier Jardón committed
15
 * License along with this library. If not, see <http://www.gnu.org/licenses/>.
16 17
 */

18 19
#include "config.h"

20 21
#include <sys/types.h>
#include <sys/stat.h>
22
#ifdef HAVE_UNISTD_H
23
#include <unistd.h>
24
#endif
25 26 27
#include <string.h>
#include <stdlib.h>
#include <glib.h>
28
#include <glib/gstdio.h>
29

30 31 32 33
#ifdef G_OS_WIN32
#ifndef S_ISDIR
#define S_ISDIR(mode) ((mode)&_S_IFDIR)
#endif
34 35 36
#define WIN32_MEAN_AND_LEAN
#include <windows.h>
#include "win32/gdkwin32.h"
37 38
#endif /* G_OS_WIN32 */

39
#include "gtkicontheme.h"
40
#include "gtkdebug.h"
41
#include "gtkiconfactory.h"
42
#include "gtkiconcache.h"
43
#include "gtkbuiltincache.h"
44
#include "gtkintl.h"
45
#include "gtkmain.h"
Matthias Clasen's avatar
Matthias Clasen committed
46
#include "gtknumerableiconprivate.h"
47
#include "gtksettings.h"
48
#include "gtkprivate.h"
49 50 51 52 53 54

#undef GDK_DEPRECATED
#undef GDK_DEPRECATED_FOR
#define GDK_DEPRECATED
#define GDK_DEPRECATED_FOR(f)

55
#include "deprecated/gtkstyle.h"
56

57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142

/**
 * SECTION:gtkicontheme
 * @Short_description: Looking up icons by name
 * @Title: GtkIconTheme
 *
 * #GtkIconTheme provides a facility for looking up icons by name
 * and size. The main reason for using a name rather than simply
 * providing a filename is to allow different icons to be used
 * depending on what <firstterm>icon theme</firstterm> is selected
 * by the user. The operation of icon themes on Linux and Unix
 * follows the <ulink
 * url="http://www.freedesktop.org/Standards/icon-theme-spec">Icon
 * Theme Specification</ulink>. There is a default icon theme,
 * named <literal>hicolor</literal> where applications should install
 * their icons, but more additional application themes can be
 * installed as operating system vendors and users choose.
 *
 * Named icons are similar to the <xref linkend="gtk3-Themeable-Stock-Images"/>
 * facility, and the distinction between the two may be a bit confusing.
 * A few things to keep in mind:
 * <itemizedlist>
 * <listitem>
 * Stock images usually are used in conjunction with
 * <xref linkend="gtk3-Stock-Items"/>, such as %GTK_STOCK_OK or
 * %GTK_STOCK_OPEN. Named icons are easier to set up and therefore
 * are more useful for new icons that an application wants to
 * add, such as application icons or window icons.
 * </listitem>
 * <listitem>
 * Stock images can only be loaded at the symbolic sizes defined
 * by the #GtkIconSize enumeration, or by custom sizes defined
 * by gtk_icon_size_register(), while named icons are more flexible
 * and any pixel size can be specified.
 * </listitem>
 * <listitem>
 * Because stock images are closely tied to stock items, and thus
 * to actions in the user interface, stock images may come in
 * multiple variants for different widget states or writing
 * directions.
 * </listitem>
 * </itemizedlist>
 * A good rule of thumb is that if there is a stock image for what
 * you want to use, use it, otherwise use a named icon. It turns
 * out that internally stock images are generally defined in
 * terms of one or more named icons. (An example of the
 * more than one case is icons that depend on writing direction;
 * %GTK_STOCK_GO_FORWARD uses the two themed icons
 * "gtk-stock-go-forward-ltr" and "gtk-stock-go-forward-rtl".)
 *
 * In many cases, named themes are used indirectly, via #GtkImage
 * or stock items, rather than directly, but looking up icons
 * directly is also simple. The #GtkIconTheme object acts
 * as a database of all the icons in the current theme. You
 * can create new #GtkIconTheme objects, but its much more
 * efficient to use the standard icon theme for the #GdkScreen
 * so that the icon information is shared with other people
 * looking up icons. In the case where the default screen is
 * being used, looking up an icon can be as simple as:
 * <informalexample>
 * <programlisting>
 * GError *error = NULL;
 * GtkIconTheme *icon_theme;
 * GdkPixbuf *pixbuf;
 *
 * icon_theme = gtk_icon_theme_get_default ();
 * pixbuf = gtk_icon_theme_load_icon (icon_theme,
 *                                    "my-icon-name", // icon name
 *                                    48, // size
 *                                    0,  // flags
 *                                    &error);
 * if (!pixbuf)
 *   {
 *     g_warning ("Couldn't load icon: &percnt;s", error->message);
 *     g_error_free (error);
 *   }
 * else
 *   {
 *     // Use the pixbuf
 *     g_object_unref (pixbuf);
 *   }
 * </programlisting>
 * </informalexample>
 */


143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158
#define DEFAULT_THEME_NAME "hicolor"

typedef enum
{
  ICON_THEME_DIR_FIXED,  
  ICON_THEME_DIR_SCALABLE,  
  ICON_THEME_DIR_THRESHOLD,
  ICON_THEME_DIR_UNTHEMED
} IconThemeDirType;

/* In reverse search order: */
typedef enum
{
  ICON_SUFFIX_NONE = 0,
  ICON_SUFFIX_XPM = 1 << 0,
  ICON_SUFFIX_SVG = 1 << 1,
159 160
  ICON_SUFFIX_PNG = 1 << 2,
  HAS_ICON_FILE = 1 << 3
161 162 163 164 165
} IconSuffix;


struct _GtkIconThemePrivate
{
166 167 168 169 170
  gchar *current_theme;
  gchar *fallback_theme;
  gchar **search_path;
  gint search_path_len;

171
  guint custom_theme        : 1;
172 173
  guint is_screen_singleton : 1;
  guint pixbuf_supports_svg : 1;
174 175
  guint themes_valid        : 1;
  guint check_reload        : 1;
176
  guint loading_themes      : 1;
177 178 179 180 181 182

  /* A list of all the themes needed to look up icons.
   * In search order, without duplicates
   */
  GList *themes;
  GHashTable *unthemed_icons;
183

184 185 186 187 188 189 190 191
  /* Note: The keys of this hashtable are owned by the
   * themedir and unthemed hashtables.
   */
  GHashTable *all_icons;

  /* GdkScreen for the icon theme (may be NULL)
   */
  GdkScreen *screen;
192

193
  /* time when we last stat:ed for theme changes */
194
  glong last_stat_time;
195
  GList *dir_mtimes;
196 197

  gulong reset_styles_idle;
198 199 200 201 202 203 204
};

struct _GtkIconInfo
{
  /* Information about the source
   */
  gchar *filename;
205
  GLoadableIcon *loadable;
206
  GSList *emblem_infos;
207

Anders Carlsson's avatar
Anders Carlsson committed
208 209 210
  /* Cache pixbuf (if there is any) */
  GdkPixbuf *cache_pixbuf;

211
  GtkIconData *data;
212

213 214 215 216 217 218 219 220 221 222
  /* Information about the directory where
   * the source was found
   */
  IconThemeDirType dir_type;
  gint dir_size;
  gint threshold;

  /* Parameters influencing the scaled icon
   */
  gint desired_size;
223 224
  guint raw_coordinates : 1;
  guint forced_size     : 1;
225 226 227
  guint emblems_applied : 1;

  guint ref_count;
228 229 230 231 232 233 234

  /* Cached information if we go ahead and try to load
   * the icon.
   */
  GdkPixbuf *pixbuf;
  GError *load_error;
  gdouble scale;
235 236

  GtkRequisition *symbolic_pixbuf_size;
237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260
};

typedef struct
{
  char *name;
  char *display_name;
  char *comment;
  char *example;

  /* In search order */
  GList *dirs;
} IconTheme;

typedef struct
{
  IconThemeDirType type;
  GQuark context;

  int size;
  int min_size;
  int max_size;
  int threshold;

  char *dir;
261
  char *subdir;
262
  int subdir_index;
263 264
  
  GtkIconCache *cache;
265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285
  
  GHashTable *icons;
  GHashTable *icon_data;
} IconThemeDir;

typedef struct
{
  char *svg_filename;
  char *no_svg_filename;
} UnthemedIcon;

typedef struct
{
  gint size;
  GdkPixbuf *pixbuf;
} BuiltinIcon;

typedef struct 
{
  char *dir;
  time_t mtime; /* 0 == not existing or not a dir */
286 287

  GtkIconCache *cache;
288 289 290 291 292 293 294 295 296 297 298 299 300 301
} IconThemeDirMtime;

static void  gtk_icon_theme_finalize   (GObject              *object);
static void  theme_dir_destroy         (IconThemeDir         *dir);

static void         theme_destroy     (IconTheme        *theme);
static GtkIconInfo *theme_lookup_icon (IconTheme        *theme,
				       const char       *icon_name,
				       int               size,
				       gboolean          allow_svg,
				       gboolean          use_default_icons);
static void         theme_list_icons  (IconTheme        *theme,
				       GHashTable       *icons,
				       GQuark            context);
302 303
static void         theme_list_contexts  (IconTheme        *theme,
					  GHashTable       *contexts);
304 305
static void         theme_subdir_load (GtkIconTheme     *icon_theme,
				       IconTheme        *theme,
306
				       GKeyFile         *theme_file,
307 308 309
				       char             *subdir);
static void         do_theme_change   (GtkIconTheme     *icon_theme);

310 311
static void     blow_themes               (GtkIconTheme    *icon_themes);
static gboolean rescan_themes             (GtkIconTheme    *icon_themes);
312

313 314 315 316
static void  icon_data_free            (GtkIconData     *icon_data);
static void load_icon_data             (IconThemeDir    *dir,
			                const char      *path,
			                const char      *name);
317 318 319 320 321

static IconSuffix theme_dir_get_icon_suffix (IconThemeDir *dir,
					     const gchar  *icon_name,
					     gboolean     *has_icon_file);

322 323 324 325 326 327 328

static GtkIconInfo *icon_info_new             (void);
static GtkIconInfo *icon_info_new_builtin     (BuiltinIcon *icon);

static IconSuffix suffix_from_name (const char *name);

static BuiltinIcon *find_builtin_icon (const gchar *icon_name,
329
				       gint        size,
330 331 332 333 334 335 336
				       gint        *min_difference_p,
				       gboolean    *has_larger_p);

static guint signal_changed = 0;

static GHashTable *icon_theme_builtin_icons;

337 338 339 340
/* also used in gtkiconfactory.c */
GtkIconCache *_builtin_cache = NULL;
static GList *builtin_dirs = NULL;

Matthias Clasen's avatar
Matthias Clasen committed
341
G_DEFINE_TYPE (GtkIconTheme, gtk_icon_theme, G_TYPE_OBJECT)
342 343 344 345 346 347 348 349 350 351 352

/**
 * gtk_icon_theme_new:
 * 
 * Creates a new icon theme object. Icon theme objects are used
 * to lookup up an icon by name in a particular icon theme.
 * Usually, you'll want to use gtk_icon_theme_get_default()
 * or gtk_icon_theme_get_for_screen() rather than creating
 * a new icon theme object for scratch.
 * 
 * Return value: the newly created #GtkIconTheme object.
Matthias Clasen's avatar
Matthias Clasen committed
353 354
 *
 * Since: 2.4
355 356 357 358 359 360 361 362 363 364 365 366
 **/
GtkIconTheme *
gtk_icon_theme_new (void)
{
  return g_object_new (GTK_TYPE_ICON_THEME, NULL);
}

/**
 * gtk_icon_theme_get_default:
 * 
 * Gets the icon theme for the default screen. See
 * gtk_icon_theme_get_for_screen().
367 368
 *
 * Return value: (transfer none): A unique #GtkIconTheme associated with
369 370
 *  the default screen. This icon theme is associated with
 *  the screen and can be used as long as the screen
371
 *  is open. Do not ref or unref it.
Matthias Clasen's avatar
Matthias Clasen committed
372 373
 *
 * Since: 2.4
374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392
 **/
GtkIconTheme *
gtk_icon_theme_get_default (void)
{
  return gtk_icon_theme_get_for_screen (gdk_screen_get_default ());
}

/**
 * gtk_icon_theme_get_for_screen:
 * @screen: a #GdkScreen
 * 
 * Gets the icon theme object associated with @screen; if this
 * function has not previously been called for the given
 * screen, a new icon theme object will be created and
 * associated with the screen. Icon theme objects are
 * fairly expensive to create, so using this function
 * is usually a better choice than calling than gtk_icon_theme_new()
 * and setting the screen yourself; by using this function
 * a single icon theme object will be shared between users.
393 394
 *
 * Return value: (transfer none): A unique #GtkIconTheme associated with
395 396
 *  the given screen. This icon theme is associated with
 *  the screen and can be used as long as the screen
397
 *  is open. Do not ref or unref it.
Matthias Clasen's avatar
Matthias Clasen committed
398 399
 *
 * Since: 2.4
400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418
 **/
GtkIconTheme *
gtk_icon_theme_get_for_screen (GdkScreen *screen)
{
  GtkIconTheme *icon_theme;

  g_return_val_if_fail (GDK_IS_SCREEN (screen), NULL);

  icon_theme = g_object_get_data (G_OBJECT (screen), "gtk-icon-theme");
  if (!icon_theme)
    {
      GtkIconThemePrivate *priv;

      icon_theme = gtk_icon_theme_new ();
      gtk_icon_theme_set_screen (icon_theme, screen);

      priv = icon_theme->priv;
      priv->is_screen_singleton = TRUE;

419
      g_object_set_data (G_OBJECT (screen), I_("gtk-icon-theme"), icon_theme);
420 421 422 423 424 425 426 427 428 429 430 431 432
    }

  return icon_theme;
}

static void
gtk_icon_theme_class_init (GtkIconThemeClass *klass)
{
  GObjectClass *gobject_class = G_OBJECT_CLASS (klass);

  gobject_class->finalize = gtk_icon_theme_finalize;

/**
433
 * GtkIconTheme::changed:
434 435 436 437 438 439
 * @icon_theme: the icon theme
 * 
 * Emitted when the current icon theme is switched or GTK+ detects
 * that a change has occurred in the contents of the current
 * icon theme.
 **/
440
  signal_changed = g_signal_new (I_("changed"),
441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466
				 G_TYPE_FROM_CLASS (klass),
				 G_SIGNAL_RUN_LAST,
				 G_STRUCT_OFFSET (GtkIconThemeClass, changed),
				 NULL, NULL,
				 g_cclosure_marshal_VOID__VOID,
				 G_TYPE_NONE, 0);

  g_type_class_add_private (klass, sizeof (GtkIconThemePrivate));
}


/* Callback when the display that the icon theme is attached to
 * is closed; unset the screen, and if it's the unique theme
 * for the screen, drop the reference
 */
static void
display_closed (GdkDisplay   *display,
		gboolean      is_error,
		GtkIconTheme *icon_theme)
{
  GtkIconThemePrivate *priv = icon_theme->priv;
  GdkScreen *screen = priv->screen;
  gboolean was_screen_singleton = priv->is_screen_singleton;

  if (was_screen_singleton)
    {
467
      g_object_set_data (G_OBJECT (screen), I_("gtk-icon-theme"), NULL);
468 469 470 471 472 473 474 475 476 477 478 479 480 481
      priv->is_screen_singleton = FALSE;
    }

  gtk_icon_theme_set_screen (icon_theme, NULL);

  if (was_screen_singleton)
    {
      g_object_unref (icon_theme);
    }
}

static void
update_current_theme (GtkIconTheme *icon_theme)
{
482 483 484
#define theme_changed(_old, _new) \
  ((_old && !_new) || (!_old && _new) || \
   (_old && _new && strcmp (_old, _new) != 0))
485 486 487 488 489
  GtkIconThemePrivate *priv = icon_theme->priv;

  if (!priv->custom_theme)
    {
      gchar *theme = NULL;
490 491
      gchar *fallback_theme = NULL;
      gboolean changed = FALSE;
492 493 494 495

      if (priv->screen)
	{
	  GtkSettings *settings = gtk_settings_get_for_screen (priv->screen);
496 497 498
	  g_object_get (settings, 
			"gtk-icon-theme-name", &theme, 
			"gtk-fallback-icon-theme", &fallback_theme, NULL);
499 500
	}

501 502 503 504
      /* ensure that the current theme (even when just the default)
       * is searched before any fallback theme
       */
      if (!theme && fallback_theme)
505 506
	theme = g_strdup (DEFAULT_THEME_NAME);

507
      if (theme_changed (priv->current_theme, theme))
508 509 510
	{
	  g_free (priv->current_theme);
	  priv->current_theme = theme;
511
	  changed = TRUE;
512 513 514
	}
      else
	g_free (theme);
515

516
      if (theme_changed (priv->fallback_theme, fallback_theme))
517 518 519 520 521 522 523 524 525 526
	{
	  g_free (priv->fallback_theme);
	  priv->fallback_theme = fallback_theme;
	  changed = TRUE;
	}
      else
	g_free (fallback_theme);

      if (changed)
	do_theme_change (icon_theme);
527
    }
528
#undef theme_changed
529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571
}

/* Callback when the icon theme GtkSetting changes
 */
static void
theme_changed (GtkSettings  *settings,
	       GParamSpec   *pspec,
	       GtkIconTheme *icon_theme)
{
  update_current_theme (icon_theme);
}

static void
unset_screen (GtkIconTheme *icon_theme)
{
  GtkIconThemePrivate *priv = icon_theme->priv;
  GtkSettings *settings;
  GdkDisplay *display;
  
  if (priv->screen)
    {
      settings = gtk_settings_get_for_screen (priv->screen);
      display = gdk_screen_get_display (priv->screen);
      
      g_signal_handlers_disconnect_by_func (display,
					    (gpointer) display_closed,
					    icon_theme);
      g_signal_handlers_disconnect_by_func (settings,
					    (gpointer) theme_changed,
					    icon_theme);

      priv->screen = NULL;
    }
}

/**
 * gtk_icon_theme_set_screen:
 * @icon_theme: a #GtkIconTheme
 * @screen: a #GdkScreen
 * 
 * Sets the screen for an icon theme; the screen is used
 * to track the user's currently configured icon theme,
 * which might be different for different screens.
Matthias Clasen's avatar
Matthias Clasen committed
572 573
 *
 * Since: 2.4
574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600
 **/
void
gtk_icon_theme_set_screen (GtkIconTheme *icon_theme,
			   GdkScreen    *screen)
{
  GtkIconThemePrivate *priv;
  GtkSettings *settings;
  GdkDisplay *display;

  g_return_if_fail (GTK_ICON_THEME (icon_theme));
  g_return_if_fail (screen == NULL || GDK_IS_SCREEN (screen));

  priv = icon_theme->priv;

  unset_screen (icon_theme);
  
  if (screen)
    {
      display = gdk_screen_get_display (screen);
      settings = gtk_settings_get_for_screen (screen);
      
      priv->screen = screen;
      
      g_signal_connect (display, "closed",
			G_CALLBACK (display_closed), icon_theme);
      g_signal_connect (settings, "notify::gtk-icon-theme-name",
			G_CALLBACK (theme_changed), icon_theme);
601 602
      g_signal_connect (settings, "notify::gtk-fallback-icon-theme-name",
			G_CALLBACK (theme_changed), icon_theme);
603 604 605 606 607 608 609 610 611
    }

  update_current_theme (icon_theme);
}

/* Checks whether a loader for SVG files has been registered
 * with GdkPixbuf.
 */
static gboolean
612
pixbuf_supports_svg (void)
613
{
614
  GSList *formats;
615
  GSList *tmp_list;
Matthias Clasen's avatar
Matthias Clasen committed
616
  static gint found_svg = -1;
617

Matthias Clasen's avatar
Matthias Clasen committed
618
  if (found_svg != -1)
619
    return found_svg;
620 621 622

  formats = gdk_pixbuf_get_formats ();

Matthias Clasen's avatar
Matthias Clasen committed
623
  found_svg = FALSE; 
624 625 626 627 628 629 630 631 632 633 634
  for (tmp_list = formats; tmp_list && !found_svg; tmp_list = tmp_list->next)
    {
      gchar **mime_types = gdk_pixbuf_format_get_mime_types (tmp_list->data);
      gchar **mime_type;
      
      for (mime_type = mime_types; *mime_type && !found_svg; mime_type++)
	{
	  if (strcmp (*mime_type, "image/svg") == 0)
	    found_svg = TRUE;
	}

635
      g_strfreev (mime_types);
636 637 638
    }

  g_slist_free (formats);
639
  
640 641 642 643 644 645 646
  return found_svg;
}

static void
gtk_icon_theme_init (GtkIconTheme *icon_theme)
{
  GtkIconThemePrivate *priv;
647
  const gchar * const *xdg_data_dirs;
648
  int i, j;
649 650 651 652

  priv = G_TYPE_INSTANCE_GET_PRIVATE (icon_theme,
                                      GTK_TYPE_ICON_THEME,
                                      GtkIconThemePrivate);
653 654 655
  icon_theme->priv = priv;

  priv->custom_theme = FALSE;
656 657 658 659

  xdg_data_dirs = g_get_system_data_dirs ();
  for (i = 0; xdg_data_dirs[i]; i++) ;

660
  priv->search_path_len = 2 * i + 2;
661 662 663 664 665
  
  priv->search_path = g_new (char *, priv->search_path_len);
  
  i = 0;
  priv->search_path[i++] = g_build_filename (g_get_user_data_dir (), "icons", NULL);
666
  priv->search_path[i++] = g_build_filename (g_get_home_dir (), ".icons", NULL);
667
  
668 669
  for (j = 0; xdg_data_dirs[j]; j++) 
    priv->search_path[i++] = g_build_filename (xdg_data_dirs[j], "icons", NULL);
670

671 672
  for (j = 0; xdg_data_dirs[j]; j++) 
    priv->search_path[i++] = g_build_filename (xdg_data_dirs[j], "pixmaps", NULL);
673 674 675 676

  priv->themes_valid = FALSE;
  priv->themes = NULL;
  priv->unthemed_icons = NULL;
677
  
678 679 680 681 682 683
  priv->pixbuf_supports_svg = pixbuf_supports_svg ();
}

static void
free_dir_mtime (IconThemeDirMtime *dir_mtime)
{
684 685 686
  if (dir_mtime->cache)
    _gtk_icon_cache_unref (dir_mtime->cache);

687
  g_free (dir_mtime->dir);
Matthias Clasen's avatar
Matthias Clasen committed
688
  g_slice_free (IconThemeDirMtime, dir_mtime);
689

690 691
}

692 693 694 695 696 697 698 699 700 701
static gboolean
reset_styles_idle (gpointer user_data)
{
  GtkIconTheme *icon_theme;
  GtkIconThemePrivate *priv;

  icon_theme = GTK_ICON_THEME (user_data);
  priv = icon_theme->priv;

  if (priv->screen && priv->is_screen_singleton)
702
    gtk_style_context_reset_widgets (priv->screen);
703 704 705 706 707 708

  priv->reset_styles_idle = 0;

  return FALSE;
}

709 710 711 712
static void
do_theme_change (GtkIconTheme *icon_theme)
{
  GtkIconThemePrivate *priv = icon_theme->priv;
713 714 715

  if (!priv->themes_valid)
    return;
716
  
717 718
  GTK_NOTE (ICONTHEME, 
	    g_print ("change to icon theme \"%s\"\n", priv->current_theme));
719
  blow_themes (icon_theme);
720
  g_signal_emit (icon_theme, signal_changed, 0);
721 722 723

  if (!priv->reset_styles_idle)
    priv->reset_styles_idle = 
724
      gdk_threads_add_idle_full (GTK_PRIORITY_RESIZE - 2, 
725
		       reset_styles_idle, icon_theme, NULL);
726 727 728 729 730 731 732 733 734 735
}

static void
blow_themes (GtkIconTheme *icon_theme)
{
  GtkIconThemePrivate *priv = icon_theme->priv;
  
  if (priv->themes_valid)
    {
      g_hash_table_destroy (priv->all_icons);
736 737
      g_list_free_full (priv->themes, (GDestroyNotify) theme_destroy);
      g_list_free_full (priv->dir_mtimes, (GDestroyNotify) free_dir_mtime);
738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756
      g_hash_table_destroy (priv->unthemed_icons);
    }
  priv->themes = NULL;
  priv->unthemed_icons = NULL;
  priv->dir_mtimes = NULL;
  priv->all_icons = NULL;
  priv->themes_valid = FALSE;
}

static void
gtk_icon_theme_finalize (GObject *object)
{
  GtkIconTheme *icon_theme;
  GtkIconThemePrivate *priv;
  int i;

  icon_theme = GTK_ICON_THEME (object);
  priv = icon_theme->priv;

757 758 759 760 761 762
  if (priv->reset_styles_idle)
    {
      g_source_remove (priv->reset_styles_idle);
      priv->reset_styles_idle = 0;
    }

763 764 765 766 767
  unset_screen (icon_theme);

  g_free (priv->current_theme);
  priv->current_theme = NULL;

768
  for (i = 0; i < priv->search_path_len; i++)
769 770 771 772 773 774
    g_free (priv->search_path[i]);

  g_free (priv->search_path);
  priv->search_path = NULL;

  blow_themes (icon_theme);
775

Matthias Clasen's avatar
Matthias Clasen committed
776
  G_OBJECT_CLASS (gtk_icon_theme_parent_class)->finalize (object);  
777 778 779 780 781
}

/**
 * gtk_icon_theme_set_search_path:
 * @icon_theme: a #GtkIconTheme
782 783
 * @path: (array length=n_elements) (element-type filename): array of
 *     directories that are searched for icon themes
784 785 786 787 788 789 790 791 792 793 794 795 796 797
 * @n_elements: number of elements in @path.
 * 
 * Sets the search path for the icon theme object. When looking
 * for an icon theme, GTK+ will search for a subdirectory of
 * one or more of the directories in @path with the same name
 * as the icon theme. (Themes from multiple of the path elements
 * are combined to allow themes to be extended by adding icons
 * in the user's home directory.)
 *
 * In addition if an icon found isn't found either in the current
 * icon theme or the default icon theme, and an image file with
 * the right name is found directly in one of the elements of
 * @path, then that image will be used for the icon name.
 * (This is legacy feature, and new icons should be put
798 799
 * into the default icon theme, which is called DEFAULT_THEME_NAME,
 * rather than directly on the icon path.)
Matthias Clasen's avatar
Matthias Clasen committed
800 801
 *
 * Since: 2.4
802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820
 **/
void
gtk_icon_theme_set_search_path (GtkIconTheme *icon_theme,
				const gchar  *path[],
				gint          n_elements)
{
  GtkIconThemePrivate *priv;
  gint i;

  g_return_if_fail (GTK_IS_ICON_THEME (icon_theme));

  priv = icon_theme->priv;
  for (i = 0; i < priv->search_path_len; i++)
    g_free (priv->search_path[i]);

  g_free (priv->search_path);

  priv->search_path = g_new (gchar *, n_elements);
  priv->search_path_len = n_elements;
821

822 823 824 825 826 827 828 829 830 831
  for (i = 0; i < priv->search_path_len; i++)
    priv->search_path[i] = g_strdup (path[i]);

  do_theme_change (icon_theme);
}


/**
 * gtk_icon_theme_get_search_path:
 * @icon_theme: a #GtkIconTheme
832
 * @path: (allow-none) (array length=n_elements) (element-type filename) (out):
833 834 835 836
 *     location to store a list of icon theme path directories or %NULL.
 *     The stored value should be freed with g_strfreev().
 * @n_elements: location to store number of elements in @path, or %NULL
 *
837
 * Gets the current search path. See gtk_icon_theme_set_search_path().
Matthias Clasen's avatar
Matthias Clasen committed
838 839
 *
 * Since: 2.4
840
 */
841
void
842 843 844
gtk_icon_theme_get_search_path (GtkIconTheme  *icon_theme,
                                gchar        **path[],
                                gint          *n_elements)
845 846 847 848 849 850 851 852 853 854 855 856 857 858 859
{
  GtkIconThemePrivate *priv;
  int i;

  g_return_if_fail (GTK_IS_ICON_THEME (icon_theme));

  priv = icon_theme->priv;

  if (n_elements)
    *n_elements = priv->search_path_len;
  
  if (path)
    {
      *path = g_new (gchar *, priv->search_path_len + 1);
      for (i = 0; i < priv->search_path_len; i++)
860
	(*path)[i] = g_strdup (priv->search_path[i]);
861 862 863 864 865 866 867
      (*path)[i] = NULL;
    }
}

/**
 * gtk_icon_theme_append_search_path:
 * @icon_theme: a #GtkIconTheme
868
 * @path: (type filename): directory name to append to the icon path
869
 * 
870 871
 * Appends a directory to the search path. 
 * See gtk_icon_theme_set_search_path(). 
Matthias Clasen's avatar
Matthias Clasen committed
872 873
 *
 * Since: 2.4
874 875 876 877 878 879 880 881 882 883 884 885 886
 **/
void
gtk_icon_theme_append_search_path (GtkIconTheme *icon_theme,
				   const gchar  *path)
{
  GtkIconThemePrivate *priv;

  g_return_if_fail (GTK_IS_ICON_THEME (icon_theme));
  g_return_if_fail (path != NULL);

  priv = icon_theme->priv;
  
  priv->search_path_len++;
887

888 889 890 891 892 893 894 895 896
  priv->search_path = g_renew (gchar *, priv->search_path, priv->search_path_len);
  priv->search_path[priv->search_path_len-1] = g_strdup (path);

  do_theme_change (icon_theme);
}

/**
 * gtk_icon_theme_prepend_search_path:
 * @icon_theme: a #GtkIconTheme
897
 * @path: (type filename): directory name to prepend to the icon path
898
 * 
899 900
 * Prepends a directory to the search path. 
 * See gtk_icon_theme_set_search_path().
Matthias Clasen's avatar
Matthias Clasen committed
901 902
 *
 * Since: 2.4
903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918
 **/
void
gtk_icon_theme_prepend_search_path (GtkIconTheme *icon_theme,
				    const gchar  *path)
{
  GtkIconThemePrivate *priv;
  int i;

  g_return_if_fail (GTK_IS_ICON_THEME (icon_theme));
  g_return_if_fail (path != NULL);

  priv = icon_theme->priv;
  
  priv->search_path_len++;
  priv->search_path = g_renew (gchar *, priv->search_path, priv->search_path_len);

919 920
  for (i = priv->search_path_len - 1; i > 0; i--)
    priv->search_path[i] = priv->search_path[i - 1];
921 922 923 924 925 926 927 928 929
  
  priv->search_path[0] = g_strdup (path);

  do_theme_change (icon_theme);
}

/**
 * gtk_icon_theme_set_custom_theme:
 * @icon_theme: a #GtkIconTheme
930 931
 * @theme_name: (allow-none): name of icon theme to use instead of
 *   configured theme, or %NULL to unset a previously set custom theme
932 933 934 935
 * 
 * Sets the name of the icon theme that the #GtkIconTheme object uses
 * overriding system configuration. This function cannot be called
 * on the icon theme objects returned from gtk_icon_theme_get_default()
936
 * and gtk_icon_theme_get_for_screen().
Matthias Clasen's avatar
Matthias Clasen committed
937 938
 *
 * Since: 2.4
939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954
 **/
void
gtk_icon_theme_set_custom_theme (GtkIconTheme *icon_theme,
				 const gchar  *theme_name)
{
  GtkIconThemePrivate *priv;

  g_return_if_fail (GTK_IS_ICON_THEME (icon_theme));

  priv = icon_theme->priv;

  g_return_if_fail (!priv->is_screen_singleton);
  
  if (theme_name != NULL)
    {
      priv->custom_theme = TRUE;
955
      if (!priv->current_theme || strcmp (theme_name, priv->current_theme) != 0)
956 957 958 959 960 961 962 963 964
	{
	  g_free (priv->current_theme);
	  priv->current_theme = g_strdup (theme_name);

	  do_theme_change (icon_theme);
	}
    }
  else
    {
965 966 967
      if (priv->custom_theme)
	{
	  priv->custom_theme = FALSE;
968

969 970
	  update_current_theme (icon_theme);
	}
971 972 973 974 975 976 977 978 979 980 981
    }
}

static void
insert_theme (GtkIconTheme *icon_theme, const char *theme_name)
{
  int i;
  GList *l;
  char **dirs;
  char **themes;
  GtkIconThemePrivate *priv;
982
  IconTheme *theme = NULL;
983
  char *path;
984 985
  GKeyFile *theme_file;
  GError *error = NULL;
986
  IconThemeDirMtime *dir_mtime;
987
  GStatBuf stat_buf;
988 989
  
  priv = icon_theme->priv;
990

991 992 993 994 995 996 997 998 999 1000 1001 1002
  for (l = priv->themes; l != NULL; l = l->next)
    {
      theme = l->data;
      if (strcmp (theme->name, theme_name) == 0)
	return;
    }
  
  for (i = 0; i < priv->search_path_len; i++)
    {
      path = g_build_filename (priv->search_path[i],
			       theme_name,
			       NULL);
Matthias Clasen's avatar
Matthias Clasen committed
1003
      dir_mtime = g_slice_new (IconThemeDirMtime);
1004
      dir_mtime->cache = NULL;
1005
      dir_mtime->dir = path;
1006
      if (g_stat (path, &stat_buf) == 0 && S_ISDIR (stat_buf.st_mode))
1007 1008 1009 1010 1011 1012
	dir_mtime->mtime = stat_buf.st_mtime;
      else
	dir_mtime->mtime = 0;

      priv->dir_mtimes = g_list_prepend (priv->dir_mtimes, dir_mtime);
    }
1013
  priv->dir_mtimes = g_list_reverse (priv->dir_mtimes);
1014 1015

  theme_file = NULL;
1016
  for (i = 0; i < priv->search_path_len && !theme_file; i++)
1017 1018 1019 1020 1021
    {
      path = g_build_filename (priv->search_path[i],
			       theme_name,
			       "index.theme",
			       NULL);
1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033
      if (g_file_test (path, G_FILE_TEST_IS_REGULAR)) 
	{
	  theme_file = g_key_file_new ();
	  g_key_file_set_list_separator (theme_file, ',');
	  g_key_file_load_from_file (theme_file, path, 0, &error);
	  if (error)
	    {
	      g_key_file_free (theme_file);
	      theme_file = NULL;
	      g_error_free (error);
	      error = NULL;
	    }
1034 1035 1036 1037
	}
      g_free (path);
    }

1038 1039 1040 1041 1042 1043 1044
  if (theme_file || strcmp (theme_name, DEFAULT_THEME_NAME) == 0)
    {
      theme = g_new0 (IconTheme, 1);
      theme->name = g_strdup (theme_name);
      priv->themes = g_list_prepend (priv->themes, theme);
    }

1045 1046
  if (theme_file == NULL)
    return;
1047

1048 1049 1050
  theme->display_name = 
    g_key_file_get_locale_string (theme_file, "Icon Theme", "Name", NULL, NULL);
  if (!theme->display_name)
1051
    g_warning ("Theme file for %s has no name\n", theme_name);
1052

1053 1054
  dirs = g_key_file_get_string_list (theme_file, "Icon Theme", "Directories", NULL, NULL);
  if (!dirs)
Matthias Clasen's avatar
Matthias Clasen committed
1055 1056
    {
      g_warning ("Theme file for %s has no directories\n", theme_name);
1057 1058
      priv->themes = g_list_remove (priv->themes, theme);
      g_free (theme->name);
Matthias Clasen's avatar
Matthias Clasen committed
1059 1060 1061 1062 1063
      g_free (theme->display_name);
      g_free (theme);
      g_key_file_free (theme_file);
      return;
    }
1064
  
1065 1066 1067 1068 1069 1070 1071 1072
  theme->comment = 
    g_key_file_get_locale_string (theme_file, 
				  "Icon Theme", "Comment",
				  NULL, NULL);
  theme->example = 
    g_key_file_get_string (theme_file, 
			   "Icon Theme", "Example",
			   NULL);
1073 1074

  theme->dirs = NULL;
Matthias Clasen's avatar
Matthias Clasen committed
1075 1076 1077 1078 1079
  for (i = 0; dirs[i] != NULL; i++)
    theme_subdir_load (icon_theme, theme, theme_file, dirs[i]);

  g_strfreev (dirs);

1080 1081
  theme->dirs = g_list_reverse (theme->dirs);

1082
  themes = g_key_file_get_string_list (theme_file,
1083 1084
				       "Icon Theme",
				       "Inherits",
1085 1086 1087
				       NULL,
				       NULL);
  if (themes)
1088 1089 1090 1091 1092 1093 1094
    {
      for (i = 0; themes[i] != NULL; i++)
	insert_theme (icon_theme, themes[i]);
      
      g_strfreev (themes);
    }

1095
  g_key_file_free (theme_file);
1096 1097 1098 1099 1100
}

static void
free_unthemed_icon (UnthemedIcon *unthemed_icon)
{
1101 1102
  g_free (unthemed_icon->svg_filename);
  g_free (unthemed_icon->no_svg_filename);
1103
  g_slice_free (UnthemedIcon, unthemed_icon);
1104 1105
}

1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118
static char *
strip_suffix (const char *filename)
{
  const char *dot;

  dot = strrchr (filename, '.');

  if (dot == NULL)
    return g_strdup (filename);

  return g_strndup (filename, dot - filename);
}

1119 1120 1121 1122 1123 1124
static void
load_themes (GtkIconTheme *icon_theme)
{
  GtkIconThemePrivate *priv;
  GDir *gdir;
  int base;
1125
  char *dir;
1126 1127 1128
  const char *file;
  UnthemedIcon *unthemed_icon;
  IconSuffix old_suffix, new_suffix;
1129
  GTimeVal tv;
1130
  IconThemeDirMtime *dir_mtime;
1131
  GStatBuf stat_buf;
1132 1133 1134 1135 1136
  
  priv = icon_theme->priv;

  priv->all_icons = g_hash_table_new (g_str_hash, g_str_equal);
  
1137 1138
  if (priv->current_theme)
    insert_theme (icon_theme, priv->current_theme);
1139 1140 1141 1142

  /* Always look in the "default" icon theme, and in a fallback theme */
  if (priv->fallback_theme)
    insert_theme (icon_theme, priv->fallback_theme);
1143 1144
  insert_theme (icon_theme, DEFAULT_THEME_NAME);
  priv->themes = g_list_reverse (priv->themes);
1145 1146


1147 1148 1149 1150 1151 1152
  priv->unthemed_icons = g_hash_table_new_full (g_str_hash, g_str_equal,
						g_free, (GDestroyNotify)free_unthemed_icon);

  for (base = 0; base < icon_theme->priv->search_path_len; base++)
    {
      dir = icon_theme->priv->search_path[base];
1153

Matthias Clasen's avatar
Matthias Clasen committed
1154
      dir_mtime = g_slice_new (IconThemeDirMtime);
1155
      priv->dir_mtimes = g_list_append (priv->dir_mtimes, dir_mtime);
1156
      
1157 1158 1159 1160 1161 1162 1163 1164 1165
      dir_mtime->dir = g_strdup (dir);
      dir_mtime->mtime = 0;
      dir_mtime->cache = NULL;

      if (g_stat (dir, &stat_buf) != 0 || !S_ISDIR (stat_buf.st_mode))
	continue;
      dir_mtime->mtime = stat_buf.st_mtime;

      dir_mtime->cache = _gtk_icon_cache_new_for_path (dir);
1166 1167
      if (dir_mtime->cache != NULL)
	continue;
1168

1169 1170 1171
      gdir = g_dir_open (dir, 0, NULL);
      if (gdir == NULL)
	continue;
1172

1173 1174 1175
      while ((file = g_dir_read_name (gdir)))
	{
	  new_suffix = suffix_from_name (file);
1176
	  
1177 1178
	  if (new_suffix != ICON_SUFFIX_NONE)
	    {
1179 1180 1181
	      char *abs_file;
	      char *base_name;

1182
	      abs_file = g_build_filename (dir, file, NULL);
1183 1184
	      base_name = strip_suffix (file);

1185 1186 1187 1188 1189
	      if ((unthemed_icon = g_hash_table_lookup (priv->unthemed_icons,
							base_name)))
		{
		  if (new_suffix == ICON_SUFFIX_SVG)
		    {
1190
		      if (unthemed_icon->svg_filename)
1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215
			g_free (abs_file);
		      else
			unthemed_icon->svg_filename = abs_file;
		    }
		  else
		    {
		      if (unthemed_icon->no_svg_filename)
			{
			  old_suffix = suffix_from_name (unthemed_icon->no_svg_filename);
			  if (new_suffix > old_suffix)
			    {
			      g_free (unthemed_icon->no_svg_filename);
			      unthemed_icon->no_svg_filename = abs_file;			      
			    }
			  else
			    g_free (abs_file);
			}
		      else
			unthemed_icon->no_svg_filename = abs_file;			      
		    }

		  g_free (base_name);
		}
	      else
		{
1216
		  unthemed_icon = g_slice_new0 (UnthemedIcon);
1217 1218 1219 1220
		  
		  if (new_suffix == ICON_SUFFIX_SVG)
		    unthemed_icon->svg_filename = abs_file;
		  else
1221
		    unthemed_icon->no_svg_filename = abs_file;
1222

1223 1224 1225 1226
		  /* takes ownership of base_name */
		  g_hash_table_replace (priv->unthemed_icons,
					base_name,
					unthemed_icon);
1227 1228 1229 1230 1231 1232 1233 1234 1235 1236
		  g_hash_table_insert (priv->all_icons,
				       base_name, NULL);
		}
	    }
	}
      g_dir_close (gdir);
    }

  priv->themes_valid = TRUE;
  
1237
  g_get_current_time(&tv);
1238 1239 1240
  priv->last_stat_time = tv.tv_sec;
}

Matthias Clasen's avatar
Matthias Clasen committed
1241
void
1242 1243 1244 1245
_gtk_icon_theme_ensure_builtin_cache (void)
{
  static gboolean initialized = FALSE;
  IconThemeDir *dir;
1246 1247
  static IconThemeDir dirs[5] = 
    {
1248 1249 1250 1251 1252
      { ICON_THEME_DIR_THRESHOLD, 0, 16, 16, 16, 2, NULL, "16", -1, NULL, NULL, NULL },
      { ICON_THEME_DIR_THRESHOLD, 0, 20, 20, 20, 2, NULL, "20", -1,  NULL, NULL, NULL },
      { ICON_THEME_DIR_THRESHOLD, 0, 24, 24, 24, 2, NULL, "24", -1, NULL, NULL, NULL },
      { ICON_THEME_DIR_THRESHOLD, 0, 32, 32, 32, 2, NULL, "32", -1, NULL, NULL, NULL },
      { ICON_THEME_DIR_THRESHOLD, 0, 48, 48, 48, 2, NULL, "48", -1, NULL, NULL, NULL }
1253
    };
1254 1255 1256 1257 1258 1259 1260 1261
  gint i;

  if (!initialized)
    {
      initialized = TRUE;

      _builtin_cache = _gtk_icon_cache_new ((gchar *)builtin_icons);

1262
      for (i = 0; i < G_N_ELEMENTS (dirs); i++)
1263
	{
1264
	  dir = &(dirs[i]);
1265
	  dir->cache = _gtk_icon_cache_ref (_builtin_cache);
1266
          dir->subdir_index = _gtk_icon_cache_get_directory_index (dir->cache, dir->subdir);
1267 1268 1269 1270 1271 1272

	  builtin_dirs = g_list_append (builtin_dirs, dir);
	}
    }
}

1273 1274 1275 1276
static void
ensure_valid_themes (GtkIconTheme *icon_theme)
{
  GtkIconThemePrivate *priv = icon_theme->priv;
1277
  GTimeVal tv;
1278
  gboolean was_valid = priv->themes_valid;
1279

1280 1281 1282 1283
  if (priv->loading_themes)
    return;
  priv->loading_themes = TRUE;

1284 1285
  _gtk_icon_theme_ensure_builtin_cache ();

1286 1287
  if (priv->themes_valid)
    {
Matthias Clasen's avatar
Matthias Clasen committed
1288
      g_get_current_time (&tv);
1289

1290 1291 1292
      if (ABS (tv.tv_sec - priv->last_stat_time) > 5 &&
	  rescan_themes (icon_theme))
	blow_themes (icon_theme);
1293 1294 1295
    }
  
  if (!priv->themes_valid)
1296 1297 1298
    {
      load_themes (icon_theme);

1299 1300 1301
      if (was_valid)
	{
	  g_signal_emit (icon_theme, signal_changed, 0);
1302 1303
	}
    }
1304 1305

  priv->loading_themes = FALSE;
1306 1307
}

1308 1309 1310 1311 1312
static GtkIconInfo *
choose_icon (GtkIconTheme       *icon_theme,
	     const gchar        *icon_names[],
	     gint                size,
	     GtkIconLookupFlags  flags)
1313 1314 1315 1316
{
  GtkIconThemePrivate *priv;
  GList *l;
  GtkIconInfo *icon_info = NULL;
1317
  UnthemedIcon *unthemed_icon = NULL;
1318 1319
  gboolean allow_svg;
  gboolean use_builtin;
1320
  gint i;
Matthias Clasen's avatar
Matthias Clasen committed
1321

1322 1323 1324 1325 1326 1327 1328 1329 1330
  priv = icon_theme->priv;

  if (flags & GTK_ICON_LOOKUP_NO_SVG)
    allow_svg = FALSE;
  else if (flags & GTK_ICON_LOOKUP_FORCE_SVG)
    allow_svg = TRUE;
  else
    allow_svg = priv->pixbuf_supports_svg;

1331 1332
  use_builtin = flags & GTK_ICON_LOOKUP_USE_BUILTIN;
  
1333 1334
  ensure_valid_themes (icon_theme);

1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351
  /* for symbolic icons, do a search in all registered themes first;
   * a theme that inherits them from a parent theme might provide
   * an alternative highcolor version, but still expect the symbolic icon
   * to show up instead.
   */
  if (icon_names[0] &&
      g_str_has_suffix (icon_names[0], "-symbolic"))
    {
      for (l = priv->themes; l; l = l->next)
        {
          IconTheme *theme = l->data;
          icon_info = theme_lookup_icon (theme, icon_names[0], size, allow_svg, use_builtin);
          if (icon_info)
            goto out;
        }
    }

1352
  for (l = priv->themes; l; l = l->next)
1353
    {
Matthias Clasen's avatar
Matthias Clasen committed
1354
      IconTheme *theme = l->data;
1355
      
1356
      for (i = 0; icon_names[i]; i++)
1357
        {
1358 1359 1360
          icon_info = theme_lookup_icon (theme, icon_names[i], size, allow_svg, use_builtin);
          if (icon_info)
            goto out;
1361
        }
1362
    }
1363

1364 1365 1366 1367 1368
  for (i = 0; icon_names[i]; i++)
    {
      unthemed_icon = g_hash_table_lookup (priv->unthemed_icons, icon_names[i]);
      if (unthemed_icon)
        break;
1369
    }
1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395
#ifdef G_OS_WIN32
  /* Still not found an icon, check if reference to a Win32 resource */
  if (!unthemed_icon)
    {
      gchar **resources;
      HICON hIcon = NULL;
      
      resources = g_strsplit (icon_names[0], ",", 0);
      if (resources[0])
	{
	  wchar_t *wfile = g_utf8_to_utf16 (resources[0], -1, NULL, NULL, NULL);
	  ExtractIconExW (wfile, resources[1] ? atoi (resources[1]) : 0, &hIcon, NULL, 1);
	  g_free (wfile);
	}
      
      if (hIcon)
	{
	  icon_info = icon_info_new ();
	  icon_info->cache_pixbuf = gdk_win32_icon_to_pixbuf_libgtk_only (hIcon);
	  DestroyIcon (hIcon);
          icon_info->dir_type = ICON_THEME_DIR_UNTHEMED;
          icon_info->dir_size = size;
	}
      g_strfreev (resources);
    }
#endif
1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412

  if (unthemed_icon)
    {
      icon_info = icon_info_new ();

      /* A SVG icon, when allowed, beats out a XPM icon, but not
       * a PNG icon
       */
      if (allow_svg &&
	  unthemed_icon->svg_filename &&
	  (!unthemed_icon->no_svg_filename ||
	   suffix_from_name (unthemed_icon->no_svg_filename) != ICON_SUFFIX_PNG))
	icon_info->filename = g_strdup (unthemed_icon->svg_filename);
      else if (unthemed_icon->no_svg_filename)
	icon_info->filename = g_strdup (unthemed_icon->no_svg_filename);

      icon_info->dir_type = ICON_THEME_DIR_UNTHEMED;
1413
      icon_info->dir_size = size;
1414 1415 1416
    }

 out:
1417 1418 1419 1420 1421
  if (icon_info) 
    {
      icon_info->desired_size = size;
      icon_info->forced_size = (flags & GTK_ICON_LOOKUP_FORCE_SIZE) != 0;
    }
1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441
  else
    {
      static gboolean check_for_default_theme = TRUE;
      char *default_theme_path;
      gboolean found = FALSE;
      unsigned i;

      if (check_for_default_theme)
	{
	  check_for_default_theme = FALSE;

	  for (i = 0; !found && i < priv->search_path_len; i++)
	    {
	      default_theme_path = g_build_filename (priv->search_path[i],
						     DEFAULT_THEME_NAME,
						     "index.theme",
						     NULL);
	      found = g_file_test (default_theme_path, G_FILE_TEST_IS_REGULAR);
	      g_free (default_theme_path);
	    }
1442

1443 1444
	  if (!found)
	    {
1445 1446 1447 1448
	      g_warning ("Could not find the icon '%s'. The '%s' theme\n"
			 "was not found either, perhaps you need to install it.\n"
			 "You can get a copy from:\n"
			 "\t%s",
1449
			 icon_names[0], DEFAULT_THEME_NAME, "http://icon-theme.freedesktop.org/releases");
1450 1451 1452
	    }
	}
    }
1453 1454 1455 1456

  return icon_info;
}

1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499

/**
 * gtk_icon_theme_lookup_icon:
 * @icon_theme: a #GtkIconTheme
 * @icon_name: the name of the icon to lookup
 * @size: desired icon size
 * @flags: flags modifying the behavior of the icon lookup
 * 
 * Looks up a named icon and returns a structure containing
 * information such as the filename of the icon. The icon
 * can then be rendered into a pixbuf using
 * gtk_icon_info_load_icon(). (gtk_icon_theme_load_icon()
 * combines these two steps if all you need is the pixbuf.)
 * 
 * Return value: a #GtkIconInfo structure containing information
 * about the icon, or %NULL if the icon wasn't found. Free with
 * gtk_icon_info_free()
 *
 * Since: 2.4
 */
GtkIconInfo *
gtk_icon_theme_lookup_icon (GtkIconTheme       *icon_theme,
			    const gchar        *icon_name,
			    gint                size,
			    GtkIconLookupFlags  flags)
{
  GtkIconInfo *info;

  g_return_val_if_fail (GTK_IS_ICON_THEME (icon_theme), NULL);
  g_return_val_if_fail (icon_name != NULL, NULL);
  g_return_val_if_fail ((flags & GTK_ICON_LOOKUP_NO_SVG) == 0 ||
			(flags & GTK_ICON_LOOKUP_FORCE_SVG) == 0, NULL);

  GTK_NOTE (ICONTHEME, 
	    g_print ("gtk_icon_theme_lookup_icon %s\n", icon_name));

  if (flags & GTK_ICON_LOOKUP_GENERIC_FALLBACK)
    {
      gchar **names;
      gint dashes, i;
      gchar *p;
 
      dashes = 0;
1500
      for (p = (gchar *) icon_name; *p; p++)
1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513
        if (*p == '-')
          dashes++;

      names = g_new (gchar *, dashes + 2);
      names[0] = g_strdup (icon_name);
      for (i = 1; i <= dashes; i++)
        {
          names[i] = g_strdup (names[i - 1]);
          p = strrchr (names[i], '-');
          *p = '\0';
        }
      names[dashes + 1] = NULL;
   
1514
      info = choose_icon (icon_theme, (const gchar **) names, size, flags);
1515 1516 1517 1518 1519
      
      g_strfreev (names);
    }
  else 
    {
1520
      const gchar *names[2];
1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533
      
      names[0] = icon_name;
      names[1] = NULL;

      info = choose_icon (icon_theme, names, size, flags);
    }

  return info;
}

/**
 * gtk_icon_theme_choose_icon:
 * @icon_theme: a #GtkIconTheme
1534 1535
 * @icon_names: (array zero-terminated=1): %NULL-terminated array of
 *     icon names to lookup
1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568
 * @size: desired icon size
 * @flags: flags modifying the behavior of the icon lookup
 * 
 * Looks up a named icon and returns a structure containing
 * information such as the filename of the icon. The icon
 * can then be rendered into a pixbuf using
 * gtk_icon_info_load_icon(). (gtk_icon_theme_load_icon()
 * combines these two steps if all you need is the pixbuf.)
 *
 * If @icon_names contains more than one name, this function 
 * tries them all in the given order before falling back to 
 * inherited icon themes.
 * 
 * Return value: a #GtkIconInfo structure containing information
 * about the icon, or %NULL if the icon wasn't found. Free with
 * gtk_icon_info_free()
 *
 * Since: 2.12
 */
GtkIconInfo *
gtk_icon_theme_choose_icon (GtkIconTheme       *icon_theme,
			    const gchar        *icon_names[],
			    gint                size,
			    GtkIconLookupFlags  flags)
{
  g_return_val_if_fail (GTK_IS_ICON_THEME (icon_theme), NULL);
  g_return_val_if_fail (icon_names != NULL, NULL);
  g_return_val_if_fail ((flags & GTK_ICON_LOOKUP_NO_SVG) == 0 ||
			(flags & GTK_ICON_LOOKUP_FORCE_SVG) == 0, NULL);

  return choose_icon (icon_theme, icon_names, size, flags);
}

1569 1570 1571 1572
/* Error quark */
GQuark
gtk_icon_theme_error_quark (void)
{
1573
  return g_quark_from_static_string ("gtk-icon-theme-error-quark");
1574 1575 1576 1577 1578 1579 1580
}

/**
 * gtk_icon_theme_load_icon:
 * @icon_theme: a #GtkIconTheme
 * @icon_name: the name of the icon to lookup
 * @size: the desired icon size. The resulting icon may not be
1581
 *     exactly this size; see gtk_icon_info_load_icon().
1582
 * @flags: flags modifying the behavior of the icon lookup
1583 1584 1585
 * @error: (allow-none): Location to store error information on failure,
 *     or %NULL.
 *
1586 1587 1588 1589
 * Looks up an icon in an icon theme, scales it to the given size
 * and renders it into a pixbuf. This is a convenience function;
 * if more details about the icon are needed, use
 * gtk_icon_theme_lookup_icon() followed by gtk_icon_info_load_icon().
1590 1591
 *
 * Note that you probably want to listen for icon theme changes and
1592
 * update the icon. This is usually done by connecting to the
1593 1594 1595
 * GtkWidget::style-set signal. If for some reason you do not want to
 * update the icon when the icon theme changes, you should consider
 * using gdk_pixbuf_copy() to make a private copy of the pixbuf
1596
 * returned by this function. Otherwise GTK+ may need to keep the old
1597
 * icon theme loaded, which would be a waste of memory.
1598 1599 1600 1601 1602
 *
 * Return value: (transfer full): the rendered icon; this may be a
 *     newly created icon or a new reference to an internal icon, so
 *     you must not modify the icon. Use g_object_unref() to release
 *     your reference to the icon. %NULL if the icon isn't found.
Matthias Clasen's avatar
Matthias Clasen committed
1603 1604
 *
 * Since: 2.4
1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621
 **/
GdkPixbuf *
gtk_icon_theme_load_icon (GtkIconTheme         *icon_theme,
			  const gchar          *icon_name,
			  gint                  size,
			  GtkIconLookupFlags    flags,
			  GError              **error)
{
  GtkIconInfo *icon_info;
  GdkPixbuf *pixbuf = NULL;
  
  g_return_val_if_fail (GTK_IS_ICON_THEME (icon_theme), NULL);
  g_return_val_if_fail (icon_name != NULL, NULL);
  g_return_val_if_fail ((flags & GTK_ICON_LOOKUP_NO_SVG) == 0 ||
			(flags & GTK_ICON_LOOKUP_FORCE_SVG) == 0, NULL);
  g_return_val_if_fail (error == NULL || *error == NULL, NULL);
  
Matthias Clasen's avatar
Matthias Clasen committed
1622 1623
  icon_info = gtk_icon_theme_lookup_icon (icon_theme, icon_name, size,
				          flags | GTK_ICON_LOOKUP_USE_BUILTIN);
1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646
  if (!icon_info)
    {
      g_set_error (error, GTK_ICON_THEME_ERROR,  GTK_ICON_THEME_NOT_FOUND,
		   _("Icon '%s' not present in theme"), icon_name);
      return NULL;
    }

  pixbuf = gtk_icon_info_load_icon (icon_info, error);
  gtk_icon_info_free (icon_info);

  return pixbuf;
}

/**
 * gtk_icon_theme_has_icon:
 * @icon_theme: a #GtkIconTheme
 * @icon_name: the name of an icon
 * 
 * Checks whether an icon theme includes an icon
 * for a particular name.
 * 
 * Return value: %TRUE if @icon_theme includes an
 *  icon for @icon_name.
Matthias Clasen's avatar
Matthias Clasen committed
1647 1648
 *
 * Since: 2.4
1649 1650 1651 1652 1653 1654
 **/
gboolean 
gtk_icon_theme_has_icon (GtkIconTheme *icon_theme,
			 const char   *icon_name)
{
  GtkIconThemePrivate *priv;
1655
  GList *l;
1656 1657

  g_return_val_if_fail (GTK_IS_ICON_THEME (icon_theme), FALSE);
1658 1659
  g_return_val_if_fail (icon_name != NULL, FALSE);

1660 1661 1662 1663
  priv = icon_theme->priv;
  
  ensure_valid_themes (icon_theme);

1664
  for (l = priv->dir_mtimes; l; l = l->next)
1665
    {
1666 1667 1668 1669
      IconThemeDirMtime *dir_mtime = l->data;
      GtkIconCache *cache = dir_mtime->cache;
      
      if (cache && _gtk_icon_cache_has_icon (cache, icon_name))
1670 1671 1672
	return TRUE;
    }

1673 1674 1675
  if (g_hash_table_lookup_extended (priv->all_icons,
				    icon_name, NULL, NULL))
    return TRUE;
1676

1677 1678 1679 1680
  if (_builtin_cache &&
      _gtk_icon_cache_has_icon (_builtin_cache, icon_name))
    return TRUE;

1681 1682
  if (icon_theme_builtin_icons &&
      g_hash_table_lookup_extended (icon_theme_builtin_icons,
1683 1684 1685 1686 1687 1688
				    icon_name, NULL, NULL))
    return TRUE;

  return FALSE;
}

1689 1690 1691 1692 1693 1694 1695 1696 1697
static void
add_size (gpointer  key,
	  gpointer  value,
	  gpointer  user_data)
{
  gint **res_p = user_data;

  **res_p = GPOINTER_TO_INT (key);

1698
  (*res_p)++;
1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710
}

/**
 * gtk_icon_theme_get_icon_sizes:
 * @icon_theme: a #GtkIconTheme
 * @icon_name: the name of an icon
 * 
 * Returns an array of integers describing the sizes at which
 * the icon is available without scaling. A size of -1 means 
 * that the icon is available in a scalable format. The array 
 * is zero-terminated.
 * 
1711 1712 1713
 * Return value: (array zero-terminated=1): An newly allocated array
 * describing the sizes at which the icon is available. The array
 * should be freed with g_free() when it is no longer needed.
1714 1715 1716 1717 1718 1719 1720
 *
 * Since: 2.6
 **/
gint *
gtk_icon_theme_get_icon_sizes (GtkIconTheme *icon_theme,
			       const char   *icon_name)
{
1721
  GList *l, *d, *icons;
1722
  GHashTable *sizes;
Matthias Clasen's avatar
Matthias Clasen committed
1723
  gint *result, *r;
1724
  guint suffix;  
1725 1726
  GtkIconThemePrivate *priv;

1727
  g_return_val_if_fail (GTK_IS_ICON_THEME (icon_theme), NULL);
1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740
  
  priv = icon_theme->priv;

  ensure_valid_themes (icon_theme);

  sizes = g_hash_table_new (g_direct_hash, g_direct_equal);

  for (l = priv->themes; l; l = l->next)
    {
      IconTheme *theme = l->data;
      for (d = theme->dirs; d; d = d->next)
	{
	  IconThemeDir *dir = d->data;
1741

1742 1743 1744
          if (dir->type != ICON_THEME_DIR_SCALABLE && g_hash_table_lookup_extended (sizes, GINT_TO_POINTER (dir->size), NULL, NULL))
            continue;

1745
	  suffix = theme_dir_get_icon_suffix (dir, icon_name, NULL);	  
1746 1747 1748 1749 1750 1751 1752 1753 1754 1755
	  if (suffix != ICON_SUFFIX_NONE)
	    {
	      if (suffix == ICON_SUFFIX_SVG)
		g_hash_table_insert (sizes, GINT_TO_POINTER (-1), NULL);
	      else
		g_hash_table_insert (sizes, GINT_TO_POINTER (dir->size), NULL);
	    }
	}
    }

1756 1757 1758 1759
  for (d = builtin_dirs; d; d = d->next)
    {
      IconThemeDir *dir = d->data;
      
1760 1761 1762
      if (dir->type != ICON_THEME_DIR_SCALABLE && g_hash_table_lookup_extended (sizes, GINT_TO_POINTER (dir->size), NULL, NULL))
        continue;

1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776
      suffix = theme_dir_get_icon_suffix (dir, icon_name, NULL);	  
      if (suffix != ICON_SUFFIX_NONE)
	{
	  if (suffix == ICON_SUFFIX_SVG)
	    g_hash_table_insert (sizes, GINT_TO_POINTER (-1), NULL);
	  else
	    g_hash_table_insert (sizes, GINT_TO_POINTER (dir->size), NULL);
	}
    }

  if (icon_theme_builtin_icons)
    {
      icons = g_hash_table_lookup (icon_theme_builtin_icons, icon_name);
      
Matthias Clasen's avatar
Matthias Clasen committed
1777 1778 1779
      while (icons