1 /* GtkIconTheme - a loader for icon themes
2 * gtk-icon-theme.c Copyright (C) 2002, 2003 Red Hat, Inc.
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17 * Boston, MA 02111-1307, USA.
22 #include <sys/types.h>
30 #include <glib/gstdio.h>
34 #define S_ISDIR(mode) ((mode)&_S_IFDIR)
36 #define WIN32_MEAN_AND_LEAN
38 #include "win32/gdkwin32.h"
39 #endif /* G_OS_WIN32 */
41 #include "gtkicontheme.h"
43 #include "gtkiconfactory.h"
44 #include "gtkiconcache.h"
45 #include "gtkbuiltincache.h"
48 #include "gtksettings.h"
49 #include "gtkprivate.h"
51 #define DEFAULT_THEME_NAME "hicolor"
56 ICON_THEME_DIR_SCALABLE,
57 ICON_THEME_DIR_THRESHOLD,
58 ICON_THEME_DIR_UNTHEMED
61 /* In reverse search order: */
65 ICON_SUFFIX_XPM = 1 << 0,
66 ICON_SUFFIX_SVG = 1 << 1,
67 ICON_SUFFIX_PNG = 1 << 2,
68 HAS_ICON_FILE = 1 << 3
72 struct _GtkIconThemePrivate
74 guint custom_theme : 1;
75 guint is_screen_singleton : 1;
76 guint pixbuf_supports_svg : 1;
77 guint themes_valid : 1;
78 guint check_reload : 1;
79 guint loading_themes : 1;
86 /* A list of all the themes needed to look up icons.
87 * In search order, without duplicates
90 GHashTable *unthemed_icons;
92 /* Note: The keys of this hashtable are owned by the
93 * themedir and unthemed hashtables.
95 GHashTable *all_icons;
97 /* GdkScreen for the icon theme (may be NULL)
101 /* time when we last stat:ed for theme changes */
105 gulong reset_styles_idle;
110 /* Information about the source
113 GLoadableIcon *loadable;
114 GSList *emblem_infos;
116 /* Cache pixbuf (if there is any) */
117 GdkPixbuf *cache_pixbuf;
121 /* Information about the directory where
122 * the source was found
124 IconThemeDirType dir_type;
128 /* Parameters influencing the scaled icon
131 guint raw_coordinates : 1;
132 guint forced_size : 1;
134 /* Cached information if we go ahead and try to load
140 gboolean emblems_applied;
152 /* In search order */
158 IconThemeDirType type;
173 GHashTable *icon_data;
179 char *no_svg_filename;
191 time_t mtime; /* 0 == not existing or not a dir */
196 static void gtk_icon_theme_finalize (GObject *object);
197 static void theme_dir_destroy (IconThemeDir *dir);
199 static void theme_destroy (IconTheme *theme);
200 static GtkIconInfo *theme_lookup_icon (IconTheme *theme,
201 const char *icon_name,
204 gboolean use_default_icons);
205 static void theme_list_icons (IconTheme *theme,
208 static void theme_list_contexts (IconTheme *theme,
209 GHashTable *contexts);
210 static void theme_subdir_load (GtkIconTheme *icon_theme,
212 GKeyFile *theme_file,
214 static void do_theme_change (GtkIconTheme *icon_theme);
216 static void blow_themes (GtkIconTheme *icon_themes);
217 static gboolean rescan_themes (GtkIconTheme *icon_themes);
219 static void icon_data_free (GtkIconData *icon_data);
220 static void load_icon_data (IconThemeDir *dir,
224 static IconSuffix theme_dir_get_icon_suffix (IconThemeDir *dir,
225 const gchar *icon_name,
226 gboolean *has_icon_file);
229 static GtkIconInfo *icon_info_new (void);
230 static GtkIconInfo *icon_info_new_builtin (BuiltinIcon *icon);
232 static IconSuffix suffix_from_name (const char *name);
234 static BuiltinIcon *find_builtin_icon (const gchar *icon_name,
236 gint *min_difference_p,
237 gboolean *has_larger_p);
239 static guint signal_changed = 0;
241 static GHashTable *icon_theme_builtin_icons;
243 /* also used in gtkiconfactory.c */
244 GtkIconCache *_builtin_cache = NULL;
245 static GList *builtin_dirs = NULL;
247 G_DEFINE_TYPE (GtkIconTheme, gtk_icon_theme, G_TYPE_OBJECT)
250 * gtk_icon_theme_new:
252 * Creates a new icon theme object. Icon theme objects are used
253 * to lookup up an icon by name in a particular icon theme.
254 * Usually, you'll want to use gtk_icon_theme_get_default()
255 * or gtk_icon_theme_get_for_screen() rather than creating
256 * a new icon theme object for scratch.
258 * Return value: the newly created #GtkIconTheme object.
263 gtk_icon_theme_new (void)
265 return g_object_new (GTK_TYPE_ICON_THEME, NULL);
269 * gtk_icon_theme_get_default:
271 * Gets the icon theme for the default screen. See
272 * gtk_icon_theme_get_for_screen().
274 * Return value: (transfer none): A unique #GtkIconTheme associated with
275 * the default screen. This icon theme is associated with
276 * the screen and can be used as long as the screen
277 * is open. Do not ref or unref it.
282 gtk_icon_theme_get_default (void)
284 return gtk_icon_theme_get_for_screen (gdk_screen_get_default ());
288 * gtk_icon_theme_get_for_screen:
289 * @screen: a #GdkScreen
291 * Gets the icon theme object associated with @screen; if this
292 * function has not previously been called for the given
293 * screen, a new icon theme object will be created and
294 * associated with the screen. Icon theme objects are
295 * fairly expensive to create, so using this function
296 * is usually a better choice than calling than gtk_icon_theme_new()
297 * and setting the screen yourself; by using this function
298 * a single icon theme object will be shared between users.
300 * Return value: (transfer none): A unique #GtkIconTheme associated with
301 * the given screen. This icon theme is associated with
302 * the screen and can be used as long as the screen
303 * is open. Do not ref or unref it.
308 gtk_icon_theme_get_for_screen (GdkScreen *screen)
310 GtkIconTheme *icon_theme;
312 g_return_val_if_fail (GDK_IS_SCREEN (screen), NULL);
313 g_return_val_if_fail (!screen->closed, NULL);
315 icon_theme = g_object_get_data (G_OBJECT (screen), "gtk-icon-theme");
318 GtkIconThemePrivate *priv;
320 icon_theme = gtk_icon_theme_new ();
321 gtk_icon_theme_set_screen (icon_theme, screen);
323 priv = icon_theme->priv;
324 priv->is_screen_singleton = TRUE;
326 g_object_set_data (G_OBJECT (screen), I_("gtk-icon-theme"), icon_theme);
333 gtk_icon_theme_class_init (GtkIconThemeClass *klass)
335 GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
337 gobject_class->finalize = gtk_icon_theme_finalize;
340 * GtkIconTheme::changed
341 * @icon_theme: the icon theme
343 * Emitted when the current icon theme is switched or GTK+ detects
344 * that a change has occurred in the contents of the current
347 signal_changed = g_signal_new (I_("changed"),
348 G_TYPE_FROM_CLASS (klass),
350 G_STRUCT_OFFSET (GtkIconThemeClass, changed),
352 g_cclosure_marshal_VOID__VOID,
355 g_type_class_add_private (klass, sizeof (GtkIconThemePrivate));
359 /* Callback when the display that the icon theme is attached to
360 * is closed; unset the screen, and if it's the unique theme
361 * for the screen, drop the reference
364 display_closed (GdkDisplay *display,
366 GtkIconTheme *icon_theme)
368 GtkIconThemePrivate *priv = icon_theme->priv;
369 GdkScreen *screen = priv->screen;
370 gboolean was_screen_singleton = priv->is_screen_singleton;
372 if (was_screen_singleton)
374 g_object_set_data (G_OBJECT (screen), I_("gtk-icon-theme"), NULL);
375 priv->is_screen_singleton = FALSE;
378 gtk_icon_theme_set_screen (icon_theme, NULL);
380 if (was_screen_singleton)
382 g_object_unref (icon_theme);
387 update_current_theme (GtkIconTheme *icon_theme)
389 #define theme_changed(_old, _new) \
390 ((_old && !_new) || (!_old && _new) || \
391 (_old && _new && strcmp (_old, _new) != 0))
392 GtkIconThemePrivate *priv = icon_theme->priv;
394 if (!priv->custom_theme)
397 gchar *fallback_theme = NULL;
398 gboolean changed = FALSE;
402 GtkSettings *settings = gtk_settings_get_for_screen (priv->screen);
403 g_object_get (settings,
404 "gtk-icon-theme-name", &theme,
405 "gtk-fallback-icon-theme", &fallback_theme, NULL);
408 /* ensure that the current theme (even when just the default)
409 * is searched before any fallback theme
411 if (!theme && fallback_theme)
412 theme = g_strdup (DEFAULT_THEME_NAME);
414 if (theme_changed (priv->current_theme, theme))
416 g_free (priv->current_theme);
417 priv->current_theme = theme;
423 if (theme_changed (priv->fallback_theme, fallback_theme))
425 g_free (priv->fallback_theme);
426 priv->fallback_theme = fallback_theme;
430 g_free (fallback_theme);
433 do_theme_change (icon_theme);
438 /* Callback when the icon theme GtkSetting changes
441 theme_changed (GtkSettings *settings,
443 GtkIconTheme *icon_theme)
445 update_current_theme (icon_theme);
449 unset_screen (GtkIconTheme *icon_theme)
451 GtkIconThemePrivate *priv = icon_theme->priv;
452 GtkSettings *settings;
457 settings = gtk_settings_get_for_screen (priv->screen);
458 display = gdk_screen_get_display (priv->screen);
460 g_signal_handlers_disconnect_by_func (display,
461 (gpointer) display_closed,
463 g_signal_handlers_disconnect_by_func (settings,
464 (gpointer) theme_changed,
472 * gtk_icon_theme_set_screen:
473 * @icon_theme: a #GtkIconTheme
474 * @screen: a #GdkScreen
476 * Sets the screen for an icon theme; the screen is used
477 * to track the user's currently configured icon theme,
478 * which might be different for different screens.
483 gtk_icon_theme_set_screen (GtkIconTheme *icon_theme,
486 GtkIconThemePrivate *priv;
487 GtkSettings *settings;
490 g_return_if_fail (GTK_ICON_THEME (icon_theme));
491 g_return_if_fail (screen == NULL || GDK_IS_SCREEN (screen));
493 priv = icon_theme->priv;
495 unset_screen (icon_theme);
499 display = gdk_screen_get_display (screen);
500 settings = gtk_settings_get_for_screen (screen);
502 priv->screen = screen;
504 g_signal_connect (display, "closed",
505 G_CALLBACK (display_closed), icon_theme);
506 g_signal_connect (settings, "notify::gtk-icon-theme-name",
507 G_CALLBACK (theme_changed), icon_theme);
508 g_signal_connect (settings, "notify::gtk-fallback-icon-theme-name",
509 G_CALLBACK (theme_changed), icon_theme);
512 update_current_theme (icon_theme);
515 /* Checks whether a loader for SVG files has been registered
519 pixbuf_supports_svg (void)
523 static gint found_svg = -1;
528 formats = gdk_pixbuf_get_formats ();
531 for (tmp_list = formats; tmp_list && !found_svg; tmp_list = tmp_list->next)
533 gchar **mime_types = gdk_pixbuf_format_get_mime_types (tmp_list->data);
536 for (mime_type = mime_types; *mime_type && !found_svg; mime_type++)
538 if (strcmp (*mime_type, "image/svg") == 0)
542 g_strfreev (mime_types);
545 g_slist_free (formats);
551 gtk_icon_theme_init (GtkIconTheme *icon_theme)
553 GtkIconThemePrivate *priv;
554 const gchar * const *xdg_data_dirs;
557 priv = G_TYPE_INSTANCE_GET_PRIVATE (icon_theme,
559 GtkIconThemePrivate);
560 icon_theme->priv = priv;
562 priv->custom_theme = FALSE;
564 xdg_data_dirs = g_get_system_data_dirs ();
565 for (i = 0; xdg_data_dirs[i]; i++) ;
567 priv->search_path_len = 2 * i + 2;
569 priv->search_path = g_new (char *, priv->search_path_len);
572 priv->search_path[i++] = g_build_filename (g_get_home_dir (), ".icons", NULL);
573 priv->search_path[i++] = g_build_filename (g_get_user_data_dir (), "icons", NULL);
575 for (j = 0; xdg_data_dirs[j]; j++)
576 priv->search_path[i++] = g_build_filename (xdg_data_dirs[j], "icons", NULL);
578 for (j = 0; xdg_data_dirs[j]; j++)
579 priv->search_path[i++] = g_build_filename (xdg_data_dirs[j], "pixmaps", NULL);
581 priv->themes_valid = FALSE;
583 priv->unthemed_icons = NULL;
585 priv->pixbuf_supports_svg = pixbuf_supports_svg ();
589 free_dir_mtime (IconThemeDirMtime *dir_mtime)
591 if (dir_mtime->cache)
592 _gtk_icon_cache_unref (dir_mtime->cache);
594 g_free (dir_mtime->dir);
595 g_slice_free (IconThemeDirMtime, dir_mtime);
600 reset_styles_idle (gpointer user_data)
602 GtkIconTheme *icon_theme;
603 GtkIconThemePrivate *priv;
605 icon_theme = GTK_ICON_THEME (user_data);
606 priv = icon_theme->priv;
608 if (priv->screen && priv->is_screen_singleton)
610 GtkSettings *settings = gtk_settings_get_for_screen (priv->screen);
611 gtk_rc_reset_styles (settings);
614 priv->reset_styles_idle = 0;
620 do_theme_change (GtkIconTheme *icon_theme)
622 GtkIconThemePrivate *priv = icon_theme->priv;
624 if (!priv->themes_valid)
628 g_print ("change to icon theme \"%s\"\n", priv->current_theme));
629 blow_themes (icon_theme);
630 g_signal_emit (icon_theme, signal_changed, 0);
632 if (!priv->reset_styles_idle)
633 priv->reset_styles_idle =
634 gdk_threads_add_idle_full (GTK_PRIORITY_RESIZE - 2,
635 reset_styles_idle, icon_theme, NULL);
639 blow_themes (GtkIconTheme *icon_theme)
641 GtkIconThemePrivate *priv = icon_theme->priv;
643 if (priv->themes_valid)
645 g_hash_table_destroy (priv->all_icons);
646 g_list_foreach (priv->themes, (GFunc)theme_destroy, NULL);
647 g_list_free (priv->themes);
648 g_list_foreach (priv->dir_mtimes, (GFunc)free_dir_mtime, NULL);
649 g_list_free (priv->dir_mtimes);
650 g_hash_table_destroy (priv->unthemed_icons);
653 priv->unthemed_icons = NULL;
654 priv->dir_mtimes = NULL;
655 priv->all_icons = NULL;
656 priv->themes_valid = FALSE;
660 gtk_icon_theme_finalize (GObject *object)
662 GtkIconTheme *icon_theme;
663 GtkIconThemePrivate *priv;
666 icon_theme = GTK_ICON_THEME (object);
667 priv = icon_theme->priv;
669 if (priv->reset_styles_idle)
671 g_source_remove (priv->reset_styles_idle);
672 priv->reset_styles_idle = 0;
675 unset_screen (icon_theme);
677 g_free (priv->current_theme);
678 priv->current_theme = NULL;
680 for (i = 0; i < priv->search_path_len; i++)
681 g_free (priv->search_path[i]);
683 g_free (priv->search_path);
684 priv->search_path = NULL;
686 blow_themes (icon_theme);
688 G_OBJECT_CLASS (gtk_icon_theme_parent_class)->finalize (object);
692 * gtk_icon_theme_set_search_path:
693 * @icon_theme: a #GtkIconTheme
694 * @path: array of directories that are searched for icon themes
695 * @n_elements: number of elements in @path.
697 * Sets the search path for the icon theme object. When looking
698 * for an icon theme, GTK+ will search for a subdirectory of
699 * one or more of the directories in @path with the same name
700 * as the icon theme. (Themes from multiple of the path elements
701 * are combined to allow themes to be extended by adding icons
702 * in the user's home directory.)
704 * In addition if an icon found isn't found either in the current
705 * icon theme or the default icon theme, and an image file with
706 * the right name is found directly in one of the elements of
707 * @path, then that image will be used for the icon name.
708 * (This is legacy feature, and new icons should be put
709 * into the default icon theme, which is called DEFAULT_THEME_NAME,
710 * rather than directly on the icon path.)
715 gtk_icon_theme_set_search_path (GtkIconTheme *icon_theme,
719 GtkIconThemePrivate *priv;
722 g_return_if_fail (GTK_IS_ICON_THEME (icon_theme));
724 priv = icon_theme->priv;
725 for (i = 0; i < priv->search_path_len; i++)
726 g_free (priv->search_path[i]);
728 g_free (priv->search_path);
730 priv->search_path = g_new (gchar *, n_elements);
731 priv->search_path_len = n_elements;
733 for (i = 0; i < priv->search_path_len; i++)
734 priv->search_path[i] = g_strdup (path[i]);
736 do_theme_change (icon_theme);
741 * gtk_icon_theme_get_search_path:
742 * @icon_theme: a #GtkIconTheme
743 * @path: (allow-none) (array length=n_elements) (out): location to store a list of icon theme path directories or %NULL
744 * The stored value should be freed with g_strfreev().
745 * @n_elements: location to store number of elements
748 * Gets the current search path. See gtk_icon_theme_set_search_path().
753 gtk_icon_theme_get_search_path (GtkIconTheme *icon_theme,
757 GtkIconThemePrivate *priv;
760 g_return_if_fail (GTK_IS_ICON_THEME (icon_theme));
762 priv = icon_theme->priv;
765 *n_elements = priv->search_path_len;
769 *path = g_new (gchar *, priv->search_path_len + 1);
770 for (i = 0; i < priv->search_path_len; i++)
771 (*path)[i] = g_strdup (priv->search_path[i]);
777 * gtk_icon_theme_append_search_path:
778 * @icon_theme: a #GtkIconTheme
779 * @path: directory name to append to the icon path
781 * Appends a directory to the search path.
782 * See gtk_icon_theme_set_search_path().
787 gtk_icon_theme_append_search_path (GtkIconTheme *icon_theme,
790 GtkIconThemePrivate *priv;
792 g_return_if_fail (GTK_IS_ICON_THEME (icon_theme));
793 g_return_if_fail (path != NULL);
795 priv = icon_theme->priv;
797 priv->search_path_len++;
799 priv->search_path = g_renew (gchar *, priv->search_path, priv->search_path_len);
800 priv->search_path[priv->search_path_len-1] = g_strdup (path);
802 do_theme_change (icon_theme);
806 * gtk_icon_theme_prepend_search_path:
807 * @icon_theme: a #GtkIconTheme
808 * @path: directory name to prepend to the icon path
810 * Prepends a directory to the search path.
811 * See gtk_icon_theme_set_search_path().
816 gtk_icon_theme_prepend_search_path (GtkIconTheme *icon_theme,
819 GtkIconThemePrivate *priv;
822 g_return_if_fail (GTK_IS_ICON_THEME (icon_theme));
823 g_return_if_fail (path != NULL);
825 priv = icon_theme->priv;
827 priv->search_path_len++;
828 priv->search_path = g_renew (gchar *, priv->search_path, priv->search_path_len);
830 for (i = priv->search_path_len - 1; i > 0; i--)
831 priv->search_path[i] = priv->search_path[i - 1];
833 priv->search_path[0] = g_strdup (path);
835 do_theme_change (icon_theme);
839 * gtk_icon_theme_set_custom_theme:
840 * @icon_theme: a #GtkIconTheme
841 * @theme_name: name of icon theme to use instead of configured theme,
842 * or %NULL to unset a previously set custom theme
844 * Sets the name of the icon theme that the #GtkIconTheme object uses
845 * overriding system configuration. This function cannot be called
846 * on the icon theme objects returned from gtk_icon_theme_get_default()
847 * and gtk_icon_theme_get_for_screen().
852 gtk_icon_theme_set_custom_theme (GtkIconTheme *icon_theme,
853 const gchar *theme_name)
855 GtkIconThemePrivate *priv;
857 g_return_if_fail (GTK_IS_ICON_THEME (icon_theme));
859 priv = icon_theme->priv;
861 g_return_if_fail (!priv->is_screen_singleton);
863 if (theme_name != NULL)
865 priv->custom_theme = TRUE;
866 if (!priv->current_theme || strcmp (theme_name, priv->current_theme) != 0)
868 g_free (priv->current_theme);
869 priv->current_theme = g_strdup (theme_name);
871 do_theme_change (icon_theme);
876 if (priv->custom_theme)
878 priv->custom_theme = FALSE;
880 update_current_theme (icon_theme);
886 insert_theme (GtkIconTheme *icon_theme, const char *theme_name)
892 GtkIconThemePrivate *priv;
893 IconTheme *theme = NULL;
895 GKeyFile *theme_file;
896 GError *error = NULL;
897 IconThemeDirMtime *dir_mtime;
898 struct stat stat_buf;
900 priv = icon_theme->priv;
902 for (l = priv->themes; l != NULL; l = l->next)
905 if (strcmp (theme->name, theme_name) == 0)
909 for (i = 0; i < priv->search_path_len; i++)
911 path = g_build_filename (priv->search_path[i],
914 dir_mtime = g_slice_new (IconThemeDirMtime);
915 dir_mtime->cache = NULL;
916 dir_mtime->dir = path;
917 if (g_stat (path, &stat_buf) == 0 && S_ISDIR (stat_buf.st_mode))
918 dir_mtime->mtime = stat_buf.st_mtime;
920 dir_mtime->mtime = 0;
922 priv->dir_mtimes = g_list_prepend (priv->dir_mtimes, dir_mtime);
924 priv->dir_mtimes = g_list_reverse (priv->dir_mtimes);
927 for (i = 0; i < priv->search_path_len && !theme_file; i++)
929 path = g_build_filename (priv->search_path[i],
933 if (g_file_test (path, G_FILE_TEST_IS_REGULAR))
935 theme_file = g_key_file_new ();
936 g_key_file_set_list_separator (theme_file, ',');
937 g_key_file_load_from_file (theme_file, path, 0, &error);
940 g_key_file_free (theme_file);
942 g_error_free (error);
949 if (theme_file || strcmp (theme_name, DEFAULT_THEME_NAME) == 0)
951 theme = g_new0 (IconTheme, 1);
952 theme->name = g_strdup (theme_name);
953 priv->themes = g_list_prepend (priv->themes, theme);
956 if (theme_file == NULL)
959 theme->display_name =
960 g_key_file_get_locale_string (theme_file, "Icon Theme", "Name", NULL, NULL);
961 if (!theme->display_name)
962 g_warning ("Theme file for %s has no name\n", theme_name);
964 dirs = g_key_file_get_string_list (theme_file, "Icon Theme", "Directories", NULL, NULL);
967 g_warning ("Theme file for %s has no directories\n", theme_name);
968 priv->themes = g_list_remove (priv->themes, theme);
969 g_free (theme->name);
970 g_free (theme->display_name);
972 g_key_file_free (theme_file);
977 g_key_file_get_locale_string (theme_file,
978 "Icon Theme", "Comment",
981 g_key_file_get_string (theme_file,
982 "Icon Theme", "Example",
986 for (i = 0; dirs[i] != NULL; i++)
987 theme_subdir_load (icon_theme, theme, theme_file, dirs[i]);
991 theme->dirs = g_list_reverse (theme->dirs);
993 themes = g_key_file_get_string_list (theme_file,
1000 for (i = 0; themes[i] != NULL; i++)
1001 insert_theme (icon_theme, themes[i]);
1003 g_strfreev (themes);
1006 g_key_file_free (theme_file);
1010 free_unthemed_icon (UnthemedIcon *unthemed_icon)
1012 g_free (unthemed_icon->svg_filename);
1013 g_free (unthemed_icon->no_svg_filename);
1014 g_slice_free (UnthemedIcon, unthemed_icon);
1018 strip_suffix (const char *filename)
1022 dot = strrchr (filename, '.');
1025 return g_strdup (filename);
1027 return g_strndup (filename, dot - filename);
1031 load_themes (GtkIconTheme *icon_theme)
1033 GtkIconThemePrivate *priv;
1038 UnthemedIcon *unthemed_icon;
1039 IconSuffix old_suffix, new_suffix;
1041 IconThemeDirMtime *dir_mtime;
1042 struct stat stat_buf;
1044 priv = icon_theme->priv;
1046 priv->all_icons = g_hash_table_new (g_str_hash, g_str_equal);
1048 if (priv->current_theme)
1049 insert_theme (icon_theme, priv->current_theme);
1051 /* Always look in the "default" icon theme, and in a fallback theme */
1052 if (priv->fallback_theme)
1053 insert_theme (icon_theme, priv->fallback_theme);
1054 insert_theme (icon_theme, DEFAULT_THEME_NAME);
1055 priv->themes = g_list_reverse (priv->themes);
1058 priv->unthemed_icons = g_hash_table_new_full (g_str_hash, g_str_equal,
1059 g_free, (GDestroyNotify)free_unthemed_icon);
1061 for (base = 0; base < icon_theme->priv->search_path_len; base++)
1063 dir = icon_theme->priv->search_path[base];
1065 dir_mtime = g_slice_new (IconThemeDirMtime);
1066 priv->dir_mtimes = g_list_append (priv->dir_mtimes, dir_mtime);
1068 dir_mtime->dir = g_strdup (dir);
1069 dir_mtime->mtime = 0;
1070 dir_mtime->cache = NULL;
1072 if (g_stat (dir, &stat_buf) != 0 || !S_ISDIR (stat_buf.st_mode))
1074 dir_mtime->mtime = stat_buf.st_mtime;
1076 dir_mtime->cache = _gtk_icon_cache_new_for_path (dir);
1077 if (dir_mtime->cache != NULL)
1080 gdir = g_dir_open (dir, 0, NULL);
1084 while ((file = g_dir_read_name (gdir)))
1086 new_suffix = suffix_from_name (file);
1088 if (new_suffix != ICON_SUFFIX_NONE)
1093 abs_file = g_build_filename (dir, file, NULL);
1094 base_name = strip_suffix (file);
1096 if ((unthemed_icon = g_hash_table_lookup (priv->unthemed_icons,
1099 if (new_suffix == ICON_SUFFIX_SVG)
1101 if (unthemed_icon->svg_filename)
1104 unthemed_icon->svg_filename = abs_file;
1108 if (unthemed_icon->no_svg_filename)
1110 old_suffix = suffix_from_name (unthemed_icon->no_svg_filename);
1111 if (new_suffix > old_suffix)
1113 g_free (unthemed_icon->no_svg_filename);
1114 unthemed_icon->no_svg_filename = abs_file;
1120 unthemed_icon->no_svg_filename = abs_file;
1127 unthemed_icon = g_slice_new0 (UnthemedIcon);
1129 if (new_suffix == ICON_SUFFIX_SVG)
1130 unthemed_icon->svg_filename = abs_file;
1132 unthemed_icon->no_svg_filename = abs_file;
1134 g_hash_table_insert (priv->unthemed_icons,
1137 g_hash_table_insert (priv->all_icons,
1145 priv->themes_valid = TRUE;
1147 g_get_current_time(&tv);
1148 priv->last_stat_time = tv.tv_sec;
1152 _gtk_icon_theme_ensure_builtin_cache (void)
1154 static gboolean initialized = FALSE;
1156 static IconThemeDir dirs[5] =
1158 { ICON_THEME_DIR_THRESHOLD, 0, 16, 16, 16, 2, NULL, "16", -1, NULL, NULL, NULL },
1159 { ICON_THEME_DIR_THRESHOLD, 0, 20, 20, 20, 2, NULL, "20", -1, NULL, NULL, NULL },
1160 { ICON_THEME_DIR_THRESHOLD, 0, 24, 24, 24, 2, NULL, "24", -1, NULL, NULL, NULL },
1161 { ICON_THEME_DIR_THRESHOLD, 0, 32, 32, 32, 2, NULL, "32", -1, NULL, NULL, NULL },
1162 { ICON_THEME_DIR_THRESHOLD, 0, 48, 48, 48, 2, NULL, "48", -1, NULL, NULL, NULL }
1170 _builtin_cache = _gtk_icon_cache_new ((gchar *)builtin_icons);
1172 for (i = 0; i < G_N_ELEMENTS (dirs); i++)
1175 dir->cache = _gtk_icon_cache_ref (_builtin_cache);
1176 dir->subdir_index = _gtk_icon_cache_get_directory_index (dir->cache, dir->subdir);
1178 builtin_dirs = g_list_append (builtin_dirs, dir);
1184 ensure_valid_themes (GtkIconTheme *icon_theme)
1186 GtkIconThemePrivate *priv = icon_theme->priv;
1188 gboolean was_valid = priv->themes_valid;
1190 if (priv->loading_themes)
1192 priv->loading_themes = TRUE;
1194 _gtk_icon_theme_ensure_builtin_cache ();
1196 if (priv->themes_valid)
1198 g_get_current_time (&tv);
1200 if (ABS (tv.tv_sec - priv->last_stat_time) > 5 &&
1201 rescan_themes (icon_theme))
1202 blow_themes (icon_theme);
1205 if (!priv->themes_valid)
1207 load_themes (icon_theme);
1211 g_signal_emit (icon_theme, signal_changed, 0);
1213 if (!priv->check_reload && priv->screen)
1215 static GdkAtom atom_iconthemes = GDK_NONE;
1216 GdkEvent *event = gdk_event_new (GDK_CLIENT_EVENT);
1219 if (!atom_iconthemes)
1220 atom_iconthemes = gdk_atom_intern_static_string ("_GTK_LOAD_ICONTHEMES");
1222 for (i = 0; i < 5; i++)
1223 event->client.data.l[i] = 0;
1224 event->client.data_format = 32;
1225 event->client.message_type = atom_iconthemes;
1227 gdk_screen_broadcast_client_message (priv->screen, event);
1232 priv->loading_themes = FALSE;
1235 static GtkIconInfo *
1236 choose_icon (GtkIconTheme *icon_theme,
1237 const gchar *icon_names[],
1239 GtkIconLookupFlags flags)
1241 GtkIconThemePrivate *priv;
1243 GtkIconInfo *icon_info = NULL;
1244 UnthemedIcon *unthemed_icon = NULL;
1246 gboolean use_builtin;
1249 priv = icon_theme->priv;
1251 if (flags & GTK_ICON_LOOKUP_NO_SVG)
1253 else if (flags & GTK_ICON_LOOKUP_FORCE_SVG)
1256 allow_svg = priv->pixbuf_supports_svg;
1258 use_builtin = flags & GTK_ICON_LOOKUP_USE_BUILTIN;
1260 ensure_valid_themes (icon_theme);
1262 for (l = priv->themes; l; l = l->next)
1264 IconTheme *theme = l->data;
1266 for (i = 0; icon_names[i]; i++)
1268 icon_info = theme_lookup_icon (theme, icon_names[i], size, allow_svg, use_builtin);
1274 for (i = 0; icon_names[i]; i++)
1276 unthemed_icon = g_hash_table_lookup (priv->unthemed_icons, icon_names[i]);
1281 /* Still not found an icon, check if reference to a Win32 resource */
1287 resources = g_strsplit (icon_names[0], ",", 0);
1290 wchar_t *wfile = g_utf8_to_utf16 (resources[0], -1, NULL, NULL, NULL);
1291 ExtractIconExW (wfile, resources[1] ? atoi (resources[1]) : 0, &hIcon, NULL, 1);
1297 icon_info = icon_info_new ();
1298 icon_info->cache_pixbuf = gdk_win32_icon_to_pixbuf_libgtk_only (hIcon);
1299 DestroyIcon (hIcon);
1300 icon_info->dir_type = ICON_THEME_DIR_UNTHEMED;
1301 icon_info->dir_size = size;
1303 g_strfreev (resources);
1309 icon_info = icon_info_new ();
1311 /* A SVG icon, when allowed, beats out a XPM icon, but not
1315 unthemed_icon->svg_filename &&
1316 (!unthemed_icon->no_svg_filename ||
1317 suffix_from_name (unthemed_icon->no_svg_filename) != ICON_SUFFIX_PNG))
1318 icon_info->filename = g_strdup (unthemed_icon->svg_filename);
1319 else if (unthemed_icon->no_svg_filename)
1320 icon_info->filename = g_strdup (unthemed_icon->no_svg_filename);
1322 icon_info->dir_type = ICON_THEME_DIR_UNTHEMED;
1323 icon_info->dir_size = size;
1329 icon_info->desired_size = size;
1330 icon_info->forced_size = (flags & GTK_ICON_LOOKUP_FORCE_SIZE) != 0;
1334 static gboolean check_for_default_theme = TRUE;
1335 char *default_theme_path;
1336 gboolean found = FALSE;
1339 if (check_for_default_theme)
1341 check_for_default_theme = FALSE;
1343 for (i = 0; !found && i < priv->search_path_len; i++)
1345 default_theme_path = g_build_filename (priv->search_path[i],
1349 found = g_file_test (default_theme_path, G_FILE_TEST_IS_REGULAR);
1350 g_free (default_theme_path);
1355 g_warning (_("Could not find the icon '%s'. The '%s' theme\n"
1356 "was not found either, perhaps you need to install it.\n"
1357 "You can get a copy from:\n"
1359 icon_names[0], DEFAULT_THEME_NAME, "http://icon-theme.freedesktop.org/releases");
1369 * gtk_icon_theme_lookup_icon:
1370 * @icon_theme: a #GtkIconTheme
1371 * @icon_name: the name of the icon to lookup
1372 * @size: desired icon size
1373 * @flags: flags modifying the behavior of the icon lookup
1375 * Looks up a named icon and returns a structure containing
1376 * information such as the filename of the icon. The icon
1377 * can then be rendered into a pixbuf using
1378 * gtk_icon_info_load_icon(). (gtk_icon_theme_load_icon()
1379 * combines these two steps if all you need is the pixbuf.)
1381 * Return value: a #GtkIconInfo structure containing information
1382 * about the icon, or %NULL if the icon wasn't found. Free with
1383 * gtk_icon_info_free()
1388 gtk_icon_theme_lookup_icon (GtkIconTheme *icon_theme,
1389 const gchar *icon_name,
1391 GtkIconLookupFlags flags)
1395 g_return_val_if_fail (GTK_IS_ICON_THEME (icon_theme), NULL);
1396 g_return_val_if_fail (icon_name != NULL, NULL);
1397 g_return_val_if_fail ((flags & GTK_ICON_LOOKUP_NO_SVG) == 0 ||
1398 (flags & GTK_ICON_LOOKUP_FORCE_SVG) == 0, NULL);
1400 GTK_NOTE (ICONTHEME,
1401 g_print ("gtk_icon_theme_lookup_icon %s\n", icon_name));
1403 if (flags & GTK_ICON_LOOKUP_GENERIC_FALLBACK)
1410 for (p = (gchar *) icon_name; *p; p++)
1414 names = g_new (gchar *, dashes + 2);
1415 names[0] = g_strdup (icon_name);
1416 for (i = 1; i <= dashes; i++)
1418 names[i] = g_strdup (names[i - 1]);
1419 p = strrchr (names[i], '-');
1422 names[dashes + 1] = NULL;
1424 info = choose_icon (icon_theme, (const gchar **) names, size, flags);
1430 const gchar *names[2];
1432 names[0] = icon_name;
1435 info = choose_icon (icon_theme, names, size, flags);
1442 * gtk_icon_theme_choose_icon:
1443 * @icon_theme: a #GtkIconTheme
1444 * @icon_names: %NULL-terminated array of icon names to lookup
1445 * @size: desired icon size
1446 * @flags: flags modifying the behavior of the icon lookup
1448 * Looks up a named icon and returns a structure containing
1449 * information such as the filename of the icon. The icon
1450 * can then be rendered into a pixbuf using
1451 * gtk_icon_info_load_icon(). (gtk_icon_theme_load_icon()
1452 * combines these two steps if all you need is the pixbuf.)
1454 * If @icon_names contains more than one name, this function
1455 * tries them all in the given order before falling back to
1456 * inherited icon themes.
1458 * Return value: a #GtkIconInfo structure containing information
1459 * about the icon, or %NULL if the icon wasn't found. Free with
1460 * gtk_icon_info_free()
1465 gtk_icon_theme_choose_icon (GtkIconTheme *icon_theme,
1466 const gchar *icon_names[],
1468 GtkIconLookupFlags flags)
1470 g_return_val_if_fail (GTK_IS_ICON_THEME (icon_theme), NULL);
1471 g_return_val_if_fail (icon_names != NULL, NULL);
1472 g_return_val_if_fail ((flags & GTK_ICON_LOOKUP_NO_SVG) == 0 ||
1473 (flags & GTK_ICON_LOOKUP_FORCE_SVG) == 0, NULL);
1475 return choose_icon (icon_theme, icon_names, size, flags);
1480 gtk_icon_theme_error_quark (void)
1482 return g_quark_from_static_string ("gtk-icon-theme-error-quark");
1486 * gtk_icon_theme_load_icon:
1487 * @icon_theme: a #GtkIconTheme
1488 * @icon_name: the name of the icon to lookup
1489 * @size: the desired icon size. The resulting icon may not be
1490 * exactly this size; see gtk_icon_info_load_icon().
1491 * @flags: flags modifying the behavior of the icon lookup
1492 * @error: (allow-none): Location to store error information on failure,
1495 * Looks up an icon in an icon theme, scales it to the given size
1496 * and renders it into a pixbuf. This is a convenience function;
1497 * if more details about the icon are needed, use
1498 * gtk_icon_theme_lookup_icon() followed by gtk_icon_info_load_icon().
1500 * Note that you probably want to listen for icon theme changes and
1501 * update the icon. This is usually done by connecting to the
1502 * GtkWidget::style-set signal. If for some reason you do not want to
1503 * update the icon when the icon theme changes, you should consider
1504 * using gdk_pixbuf_copy() to make a private copy of the pixbuf
1505 * returned by this function. Otherwise GTK+ may need to keep the old
1506 * icon theme loaded, which would be a waste of memory.
1508 * Return value: (transfer full): the rendered icon; this may be a
1509 * newly created icon or a new reference to an internal icon, so
1510 * you must not modify the icon. Use g_object_unref() to release
1511 * your reference to the icon. %NULL if the icon isn't found.
1516 gtk_icon_theme_load_icon (GtkIconTheme *icon_theme,
1517 const gchar *icon_name,
1519 GtkIconLookupFlags flags,
1522 GtkIconInfo *icon_info;
1523 GdkPixbuf *pixbuf = NULL;
1525 g_return_val_if_fail (GTK_IS_ICON_THEME (icon_theme), NULL);
1526 g_return_val_if_fail (icon_name != NULL, NULL);
1527 g_return_val_if_fail ((flags & GTK_ICON_LOOKUP_NO_SVG) == 0 ||
1528 (flags & GTK_ICON_LOOKUP_FORCE_SVG) == 0, NULL);
1529 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
1531 icon_info = gtk_icon_theme_lookup_icon (icon_theme, icon_name, size,
1532 flags | GTK_ICON_LOOKUP_USE_BUILTIN);
1535 g_set_error (error, GTK_ICON_THEME_ERROR, GTK_ICON_THEME_NOT_FOUND,
1536 _("Icon '%s' not present in theme"), icon_name);
1540 pixbuf = gtk_icon_info_load_icon (icon_info, error);
1541 gtk_icon_info_free (icon_info);
1547 * gtk_icon_theme_has_icon:
1548 * @icon_theme: a #GtkIconTheme
1549 * @icon_name: the name of an icon
1551 * Checks whether an icon theme includes an icon
1552 * for a particular name.
1554 * Return value: %TRUE if @icon_theme includes an
1555 * icon for @icon_name.
1560 gtk_icon_theme_has_icon (GtkIconTheme *icon_theme,
1561 const char *icon_name)
1563 GtkIconThemePrivate *priv;
1566 g_return_val_if_fail (GTK_IS_ICON_THEME (icon_theme), FALSE);
1567 g_return_val_if_fail (icon_name != NULL, FALSE);
1569 priv = icon_theme->priv;
1571 ensure_valid_themes (icon_theme);
1573 for (l = priv->dir_mtimes; l; l = l->next)
1575 IconThemeDirMtime *dir_mtime = l->data;
1576 GtkIconCache *cache = dir_mtime->cache;
1578 if (cache && _gtk_icon_cache_has_icon (cache, icon_name))
1582 if (g_hash_table_lookup_extended (priv->all_icons,
1583 icon_name, NULL, NULL))
1586 if (_builtin_cache &&
1587 _gtk_icon_cache_has_icon (_builtin_cache, icon_name))
1590 if (icon_theme_builtin_icons &&
1591 g_hash_table_lookup_extended (icon_theme_builtin_icons,
1592 icon_name, NULL, NULL))
1599 add_size (gpointer key,
1603 gint **res_p = user_data;
1605 **res_p = GPOINTER_TO_INT (key);
1611 * gtk_icon_theme_get_icon_sizes:
1612 * @icon_theme: a #GtkIconTheme
1613 * @icon_name: the name of an icon
1615 * Returns an array of integers describing the sizes at which
1616 * the icon is available without scaling. A size of -1 means
1617 * that the icon is available in a scalable format. The array
1618 * is zero-terminated.
1620 * Return value: An newly allocated array describing the sizes at
1621 * which the icon is available. The array should be freed with g_free()
1622 * when it is no longer needed.
1627 gtk_icon_theme_get_icon_sizes (GtkIconTheme *icon_theme,
1628 const char *icon_name)
1630 GList *l, *d, *icons;
1634 GtkIconThemePrivate *priv;
1636 g_return_val_if_fail (GTK_IS_ICON_THEME (icon_theme), NULL);
1638 priv = icon_theme->priv;
1640 ensure_valid_themes (icon_theme);
1642 sizes = g_hash_table_new (g_direct_hash, g_direct_equal);
1644 for (l = priv->themes; l; l = l->next)
1646 IconTheme *theme = l->data;
1647 for (d = theme->dirs; d; d = d->next)
1649 IconThemeDir *dir = d->data;
1651 if (dir->type != ICON_THEME_DIR_SCALABLE && g_hash_table_lookup_extended (sizes, GINT_TO_POINTER (dir->size), NULL, NULL))
1654 suffix = theme_dir_get_icon_suffix (dir, icon_name, NULL);
1655 if (suffix != ICON_SUFFIX_NONE)
1657 if (suffix == ICON_SUFFIX_SVG)
1658 g_hash_table_insert (sizes, GINT_TO_POINTER (-1), NULL);
1660 g_hash_table_insert (sizes, GINT_TO_POINTER (dir->size), NULL);
1665 for (d = builtin_dirs; d; d = d->next)
1667 IconThemeDir *dir = d->data;
1669 if (dir->type != ICON_THEME_DIR_SCALABLE && g_hash_table_lookup_extended (sizes, GINT_TO_POINTER (dir->size), NULL, NULL))
1672 suffix = theme_dir_get_icon_suffix (dir, icon_name, NULL);
1673 if (suffix != ICON_SUFFIX_NONE)
1675 if (suffix == ICON_SUFFIX_SVG)
1676 g_hash_table_insert (sizes, GINT_TO_POINTER (-1), NULL);
1678 g_hash_table_insert (sizes, GINT_TO_POINTER (dir->size), NULL);
1682 if (icon_theme_builtin_icons)
1684 icons = g_hash_table_lookup (icon_theme_builtin_icons, icon_name);
1688 BuiltinIcon *icon = icons->data;
1690 g_hash_table_insert (sizes, GINT_TO_POINTER (icon->size), NULL);
1691 icons = icons->next;
1695 r = result = g_new0 (gint, g_hash_table_size (sizes) + 1);
1697 g_hash_table_foreach (sizes, add_size, &r);
1698 g_hash_table_destroy (sizes);
1704 add_key_to_hash (gpointer key,
1708 GHashTable *hash = user_data;
1710 g_hash_table_insert (hash, key, NULL);
1714 add_key_to_list (gpointer key,
1718 GList **list = user_data;
1720 *list = g_list_prepend (*list, g_strdup (key));
1724 * gtk_icon_theme_list_icons:
1725 * @icon_theme: a #GtkIconTheme
1726 * @context: a string identifying a particular type of icon,
1727 * or %NULL to list all icons.
1729 * Lists the icons in the current icon theme. Only a subset
1730 * of the icons can be listed by providing a context string.
1731 * The set of values for the context string is system dependent,
1732 * but will typically include such values as "Applications" and
1735 * Return value: (element-type utf8) (transfer none): a #GList list holding the names of all the
1736 * icons in the theme. You must first free each element
1737 * in the list with g_free(), then free the list itself
1738 * with g_list_free().
1743 gtk_icon_theme_list_icons (GtkIconTheme *icon_theme,
1744 const char *context)
1746 GtkIconThemePrivate *priv;
1749 GQuark context_quark;
1751 priv = icon_theme->priv;
1753 ensure_valid_themes (icon_theme);
1757 context_quark = g_quark_try_string (context);
1765 icons = g_hash_table_new (g_str_hash, g_str_equal);
1770 theme_list_icons (l->data, icons, context_quark);
1774 if (context_quark == 0)
1775 g_hash_table_foreach (priv->unthemed_icons,
1781 g_hash_table_foreach (icons,
1785 g_hash_table_destroy (icons);
1791 * gtk_icon_theme_list_contexts:
1792 * @icon_theme: a #GtkIconTheme
1794 * Gets the list of contexts available within the current
1795 * hierarchy of icon themes
1797 * Return value: (element-type utf8) (transfer full): a #GList list holding the names of all the
1798 * contexts in the theme. You must first free each element
1799 * in the list with g_free(), then free the list itself
1800 * with g_list_free().
1805 gtk_icon_theme_list_contexts (GtkIconTheme *icon_theme)
1807 GtkIconThemePrivate *priv;
1808 GHashTable *contexts;
1811 priv = icon_theme->priv;
1813 ensure_valid_themes (icon_theme);
1815 contexts = g_hash_table_new (g_str_hash, g_str_equal);
1820 theme_list_contexts (l->data, contexts);
1826 g_hash_table_foreach (contexts,
1830 g_hash_table_destroy (contexts);
1836 * gtk_icon_theme_get_example_icon_name:
1837 * @icon_theme: a #GtkIconTheme
1839 * Gets the name of an icon that is representative of the
1840 * current theme (for instance, to use when presenting
1841 * a list of themes to the user.)
1843 * Return value: the name of an example icon or %NULL.
1844 * Free with g_free().
1849 gtk_icon_theme_get_example_icon_name (GtkIconTheme *icon_theme)
1851 GtkIconThemePrivate *priv;
1855 g_return_val_if_fail (GTK_IS_ICON_THEME (icon_theme), NULL);
1857 priv = icon_theme->priv;
1859 ensure_valid_themes (icon_theme);
1866 return g_strdup (theme->example);
1876 rescan_themes (GtkIconTheme *icon_theme)
1878 GtkIconThemePrivate *priv;
1879 IconThemeDirMtime *dir_mtime;
1882 struct stat stat_buf;
1885 priv = icon_theme->priv;
1887 for (d = priv->dir_mtimes; d != NULL; d = d->next)
1889 dir_mtime = d->data;
1891 stat_res = g_stat (dir_mtime->dir, &stat_buf);
1893 /* dir mtime didn't change */
1894 if (stat_res == 0 &&
1895 S_ISDIR (stat_buf.st_mode) &&
1896 dir_mtime->mtime == stat_buf.st_mtime)
1898 /* didn't exist before, and still doesn't */
1899 if (dir_mtime->mtime == 0 &&
1900 (stat_res != 0 || !S_ISDIR (stat_buf.st_mode)))
1906 g_get_current_time (&tv);
1907 priv->last_stat_time = tv.tv_sec;
1913 * gtk_icon_theme_rescan_if_needed:
1914 * @icon_theme: a #GtkIconTheme
1916 * Checks to see if the icon theme has changed; if it has, any
1917 * currently cached information is discarded and will be reloaded
1918 * next time @icon_theme is accessed.
1920 * Return value: %TRUE if the icon theme has changed and needed
1926 gtk_icon_theme_rescan_if_needed (GtkIconTheme *icon_theme)
1930 g_return_val_if_fail (GTK_IS_ICON_THEME (icon_theme), FALSE);
1932 retval = rescan_themes (icon_theme);
1934 do_theme_change (icon_theme);
1940 theme_destroy (IconTheme *theme)
1942 g_free (theme->display_name);
1943 g_free (theme->comment);
1944 g_free (theme->name);
1945 g_free (theme->example);
1947 g_list_foreach (theme->dirs, (GFunc)theme_dir_destroy, NULL);
1948 g_list_free (theme->dirs);
1954 theme_dir_destroy (IconThemeDir *dir)
1957 _gtk_icon_cache_unref (dir->cache);
1959 g_hash_table_destroy (dir->icons);
1962 g_hash_table_destroy (dir->icon_data);
1964 g_free (dir->subdir);
1969 theme_dir_size_difference (IconThemeDir *dir, int size, gboolean *smaller)
1974 case ICON_THEME_DIR_FIXED:
1975 *smaller = size < dir->size;
1976 return abs (size - dir->size);
1978 case ICON_THEME_DIR_SCALABLE:
1979 *smaller = size < dir->min_size;
1980 if (size < dir->min_size)
1981 return dir->min_size - size;
1982 if (size > dir->max_size)
1983 return size - dir->max_size;
1986 case ICON_THEME_DIR_THRESHOLD:
1987 min = dir->size - dir->threshold;
1988 max = dir->size + dir->threshold;
1989 *smaller = size < min;
1996 case ICON_THEME_DIR_UNTHEMED:
1997 g_assert_not_reached ();
2000 g_assert_not_reached ();
2005 string_from_suffix (IconSuffix suffix)
2009 case ICON_SUFFIX_XPM:
2011 case ICON_SUFFIX_SVG:
2013 case ICON_SUFFIX_PNG:
2016 g_assert_not_reached();
2022 suffix_from_name (const char *name)
2026 if (g_str_has_suffix (name, ".png"))
2027 retval = ICON_SUFFIX_PNG;
2028 else if (g_str_has_suffix (name, ".svg"))
2029 retval = ICON_SUFFIX_SVG;
2030 else if (g_str_has_suffix (name, ".xpm"))
2031 retval = ICON_SUFFIX_XPM;
2033 retval = ICON_SUFFIX_NONE;
2039 best_suffix (IconSuffix suffix,
2042 if ((suffix & ICON_SUFFIX_PNG) != 0)
2043 return ICON_SUFFIX_PNG;
2044 else if (allow_svg && ((suffix & ICON_SUFFIX_SVG) != 0))
2045 return ICON_SUFFIX_SVG;
2046 else if ((suffix & ICON_SUFFIX_XPM) != 0)
2047 return ICON_SUFFIX_XPM;
2049 return ICON_SUFFIX_NONE;
2054 theme_dir_get_icon_suffix (IconThemeDir *dir,
2055 const gchar *icon_name,
2056 gboolean *has_icon_file)
2062 suffix = (IconSuffix)_gtk_icon_cache_get_icon_flags (dir->cache,
2067 *has_icon_file = suffix & HAS_ICON_FILE;
2069 suffix = suffix & ~HAS_ICON_FILE;
2072 suffix = GPOINTER_TO_UINT (g_hash_table_lookup (dir->icons, icon_name));
2074 GTK_NOTE (ICONTHEME,
2075 g_print ("get_icon_suffix%s %u\n", dir->cache ? " (cached)" : "", suffix));
2080 static GtkIconInfo *
2081 theme_lookup_icon (IconTheme *theme,
2082 const char *icon_name,
2085 gboolean use_builtin)
2088 IconThemeDir *dir, *min_dir;
2090 int min_difference, difference;
2091 BuiltinIcon *closest_builtin = NULL;
2092 gboolean smaller, has_larger, match;
2095 min_difference = G_MAXINT;
2100 /* Builtin icons are logically part of the default theme and
2101 * are searched before other subdirectories of the default theme.
2103 if (use_builtin && strcmp (theme->name, DEFAULT_THEME_NAME) == 0)
2105 closest_builtin = find_builtin_icon (icon_name,
2110 if (min_difference == 0)
2111 return icon_info_new_builtin (closest_builtin);
2113 dirs = builtin_dirs;
2123 GTK_NOTE (ICONTHEME,
2124 g_print ("theme_lookup_icon dir %s\n", dir->dir));
2125 suffix = theme_dir_get_icon_suffix (dir, icon_name, NULL);
2126 if (best_suffix (suffix, allow_svg) != ICON_SUFFIX_NONE)
2128 difference = theme_dir_size_difference (dir, size, &smaller);
2130 if (difference == 0)
2132 if (dir->type == ICON_THEME_DIR_SCALABLE)
2134 /* don't pick scalable if we already found
2135 * a matching non-scalable dir
2145 /* for a matching non-scalable dir keep
2146 * going and look for a closer match
2148 difference = abs (size - dir->size);
2149 if (!match || difference < min_difference)
2152 min_difference = difference;
2155 if (difference == 0)
2164 if (difference < min_difference || smaller)
2166 min_difference = difference;
2168 has_larger = smaller;
2173 if (difference < min_difference && smaller)
2175 min_difference = difference;
2184 if (l == NULL && dirs == builtin_dirs)
2193 GtkIconInfo *icon_info = icon_info_new ();
2194 gboolean has_icon_file = FALSE;
2196 suffix = theme_dir_get_icon_suffix (min_dir, icon_name, &has_icon_file);
2197 suffix = best_suffix (suffix, allow_svg);
2198 g_assert (suffix != ICON_SUFFIX_NONE);
2202 file = g_strconcat (icon_name, string_from_suffix (suffix), NULL);
2203 icon_info->filename = g_build_filename (min_dir->dir, file, NULL);
2208 icon_info->filename = NULL;
2211 if (min_dir->icon_data != NULL)
2212 icon_info->data = g_hash_table_lookup (min_dir->icon_data, icon_name);
2214 if (icon_info->data == NULL && min_dir->cache != NULL)
2216 icon_info->data = _gtk_icon_cache_get_icon_data (min_dir->cache, icon_name, min_dir->subdir_index);
2217 if (icon_info->data)
2219 if (min_dir->icon_data == NULL)
2220 min_dir->icon_data = g_hash_table_new_full (g_str_hash, g_str_equal,
2221 g_free, (GDestroyNotify)icon_data_free);
2223 g_hash_table_replace (min_dir->icon_data, g_strdup (icon_name), icon_info->data);
2227 if (icon_info->data == NULL && has_icon_file)
2229 gchar *icon_file_name, *icon_file_path;
2231 icon_file_name = g_strconcat (icon_name, ".icon", NULL);
2232 icon_file_path = g_build_filename (min_dir->dir, icon_file_name, NULL);
2234 if (g_file_test (icon_file_path, G_FILE_TEST_IS_REGULAR))
2236 if (min_dir->icon_data == NULL)
2237 min_dir->icon_data = g_hash_table_new_full (g_str_hash, g_str_equal,
2238 g_free, (GDestroyNotify)icon_data_free);
2239 load_icon_data (min_dir, icon_file_path, icon_file_name);
2241 icon_info->data = g_hash_table_lookup (min_dir->icon_data, icon_name);
2243 g_free (icon_file_name);
2244 g_free (icon_file_path);
2249 icon_info->cache_pixbuf = _gtk_icon_cache_get_icon (min_dir->cache, icon_name,
2250 min_dir->subdir_index);
2253 icon_info->dir_type = min_dir->type;
2254 icon_info->dir_size = min_dir->size;
2255 icon_info->threshold = min_dir->threshold;
2260 if (closest_builtin)
2261 return icon_info_new_builtin (closest_builtin);
2267 theme_list_icons (IconTheme *theme,
2271 GList *l = theme->dirs;
2278 if (context == dir->context ||
2283 _gtk_icon_cache_add_icons (dir->cache,
2290 g_hash_table_foreach (dir->icons,
2300 theme_list_contexts (IconTheme *theme,
2301 GHashTable *contexts)
2303 GList *l = theme->dirs;
2305 const char *context;
2311 context = g_quark_to_string (dir->context);
2312 g_hash_table_replace (contexts, (gpointer) context, NULL);
2319 load_icon_data (IconThemeDir *dir, const char *path, const char *name)
2321 GKeyFile *icon_file;
2329 GError *error = NULL;
2333 icon_file = g_key_file_new ();
2334 g_key_file_set_list_separator (icon_file, ',');
2335 g_key_file_load_from_file (icon_file, path, 0, &error);
2338 g_error_free (error);
2339 g_key_file_free (icon_file);
2344 base_name = strip_suffix (name);
2346 data = g_slice_new0 (GtkIconData);
2347 g_hash_table_replace (dir->icon_data, base_name, data);
2349 ivalues = g_key_file_get_integer_list (icon_file,
2350 "Icon Data", "EmbeddedTextRectangle",
2356 data->has_embedded_rect = TRUE;
2357 data->x0 = ivalues[0];
2358 data->y0 = ivalues[1];
2359 data->x1 = ivalues[2];
2360 data->y1 = ivalues[3];
2366 str = g_key_file_get_string (icon_file, "Icon Data", "AttachPoints", NULL);
2369 split = g_strsplit (str, "|", -1);
2371 data->n_attach_points = g_strv_length (split);
2372 data->attach_points = g_new (GdkPoint, data->n_attach_points);
2375 while (split[i] != NULL && i < data->n_attach_points)
2377 split_point = strchr (split[i], ',');
2382 data->attach_points[i].x = atoi (split[i]);
2383 data->attach_points[i].y = atoi (split_point);
2392 data->display_name = g_key_file_get_locale_string (icon_file,
2393 "Icon Data", "DisplayName",
2395 g_key_file_free (icon_file);
2400 scan_directory (GtkIconThemePrivate *icon_theme,
2401 IconThemeDir *dir, char *full_dir)
2406 GTK_NOTE (ICONTHEME,
2407 g_print ("scanning directory %s\n", full_dir));
2408 dir->icons = g_hash_table_new_full (g_str_hash, g_str_equal,
2411 gdir = g_dir_open (full_dir, 0, NULL);
2416 while ((name = g_dir_read_name (gdir)))
2420 IconSuffix suffix, hash_suffix;
2422 if (g_str_has_suffix (name, ".icon"))
2424 if (dir->icon_data == NULL)
2425 dir->icon_data = g_hash_table_new_full (g_str_hash, g_str_equal,
2426 g_free, (GDestroyNotify)icon_data_free);
2428 path = g_build_filename (full_dir, name, NULL);
2429 if (g_file_test (path, G_FILE_TEST_IS_REGULAR))
2430 load_icon_data (dir, path, name);
2437 suffix = suffix_from_name (name);
2438 if (suffix == ICON_SUFFIX_NONE)
2441 base_name = strip_suffix (name);
2443 hash_suffix = GPOINTER_TO_INT (g_hash_table_lookup (dir->icons, base_name));
2444 g_hash_table_replace (icon_theme->all_icons, base_name, NULL);
2445 g_hash_table_replace (dir->icons, base_name, GUINT_TO_POINTER (hash_suffix| suffix));
2452 theme_subdir_load (GtkIconTheme *icon_theme,
2454 GKeyFile *theme_file,
2460 IconThemeDirType type;
2461 char *context_string;
2468 GError *error = NULL;
2469 IconThemeDirMtime *dir_mtime;
2471 size = g_key_file_get_integer (theme_file, subdir, "Size", &error);
2474 g_error_free (error);
2475 g_warning ("Theme directory %s of theme %s has no size field\n",
2476 subdir, theme->name);
2480 type = ICON_THEME_DIR_THRESHOLD;
2481 type_string = g_key_file_get_string (theme_file, subdir, "Type", NULL);
2484 if (strcmp (type_string, "Fixed") == 0)
2485 type = ICON_THEME_DIR_FIXED;
2486 else if (strcmp (type_string, "Scalable") == 0)
2487 type = ICON_THEME_DIR_SCALABLE;
2488 else if (strcmp (type_string, "Threshold") == 0)
2489 type = ICON_THEME_DIR_THRESHOLD;
2491 g_free (type_string);
2495 context_string = g_key_file_get_string (theme_file, subdir, "Context", NULL);
2498 context = g_quark_from_string (context_string);
2499 g_free (context_string);
2502 max_size = g_key_file_get_integer (theme_file, subdir, "MaxSize", &error);
2507 g_error_free (error);
2511 min_size = g_key_file_get_integer (theme_file, subdir, "MinSize", &error);
2516 g_error_free (error);
2520 threshold = g_key_file_get_integer (theme_file, subdir, "Threshold", &error);
2525 g_error_free (error);
2529 for (d = icon_theme->priv->dir_mtimes; d; d = d->next)
2531 dir_mtime = (IconThemeDirMtime *)d->data;
2533 if (dir_mtime->mtime == 0)
2534 continue; /* directory doesn't exist */
2536 full_dir = g_build_filename (dir_mtime->dir, subdir, NULL);
2538 /* First, see if we have a cache for the directory */
2539 if (dir_mtime->cache != NULL || g_file_test (full_dir, G_FILE_TEST_IS_DIR))
2541 if (dir_mtime->cache == NULL)
2543 /* This will return NULL if the cache doesn't exist or is outdated */
2544 dir_mtime->cache = _gtk_icon_cache_new_for_path (dir_mtime->dir);
2547 dir = g_new (IconThemeDir, 1);
2549 dir->context = context;
2551 dir->min_size = min_size;
2552 dir->max_size = max_size;
2553 dir->threshold = threshold;
2554 dir->dir = full_dir;
2555 dir->icon_data = NULL;
2556 dir->subdir = g_strdup (subdir);
2557 if (dir_mtime->cache != NULL)
2559 dir->cache = _gtk_icon_cache_ref (dir_mtime->cache);
2560 dir->subdir_index = _gtk_icon_cache_get_directory_index (dir->cache, dir->subdir);
2565 dir->subdir_index = -1;
2566 scan_directory (icon_theme->priv, dir, full_dir);
2569 theme->dirs = g_list_prepend (theme->dirs, dir);
2577 icon_data_free (GtkIconData *icon_data)
2579 g_free (icon_data->attach_points);
2580 g_free (icon_data->display_name);
2581 g_slice_free (GtkIconData, icon_data);
2588 G_DEFINE_BOXED_TYPE (GtkIconInfo, gtk_icon_info,
2592 static GtkIconInfo *
2593 icon_info_new (void)
2595 GtkIconInfo *icon_info = g_slice_new0 (GtkIconInfo);
2597 icon_info->scale = -1.;
2598 icon_info->ref_count = 1;
2603 static GtkIconInfo *
2604 icon_info_new_builtin (BuiltinIcon *icon)
2606 GtkIconInfo *icon_info = icon_info_new ();
2608 icon_info->cache_pixbuf = g_object_ref (icon->pixbuf);
2609 icon_info->dir_type = ICON_THEME_DIR_THRESHOLD;
2610 icon_info->dir_size = icon->size;
2611 icon_info->threshold = 2;
2617 * gtk_icon_info_copy:
2618 * @icon_info: a #GtkIconInfo
2620 * Make a copy of a #GtkIconInfo.
2622 * Return value: the new GtkIconInfo
2627 gtk_icon_info_copy (GtkIconInfo *icon_info)
2630 g_return_val_if_fail (icon_info != NULL, NULL);
2632 icon_info->ref_count++;
2638 * gtk_icon_info_free:
2639 * @icon_info: a #GtkIconInfo
2641 * Free a #GtkIconInfo and associated information
2646 gtk_icon_info_free (GtkIconInfo *icon_info)
2648 g_return_if_fail (icon_info != NULL);
2650 icon_info->ref_count--;
2651 if (icon_info->ref_count > 0)
2654 g_free (icon_info->filename);
2655 if (icon_info->loadable)
2656 g_object_unref (icon_info->loadable);
2657 g_slist_foreach (icon_info->emblem_infos, (GFunc)gtk_icon_info_free, NULL);
2658 g_slist_free (icon_info->emblem_infos);
2659 if (icon_info->pixbuf)
2660 g_object_unref (icon_info->pixbuf);
2661 if (icon_info->cache_pixbuf)
2662 g_object_unref (icon_info->cache_pixbuf);
2664 g_slice_free (GtkIconInfo, icon_info);
2668 * gtk_icon_info_get_base_size:
2669 * @icon_info: a #GtkIconInfo
2671 * Gets the base size for the icon. The base size
2672 * is a size for the icon that was specified by
2673 * the icon theme creator. This may be different
2674 * than the actual size of image; an example of
2675 * this is small emblem icons that can be attached
2676 * to a larger icon. These icons will be given
2677 * the same base size as the larger icons to which
2678 * they are attached.
2680 * Return value: the base size, or 0, if no base
2681 * size is known for the icon.
2686 gtk_icon_info_get_base_size (GtkIconInfo *icon_info)
2688 g_return_val_if_fail (icon_info != NULL, 0);
2690 return icon_info->dir_size;
2694 * gtk_icon_info_get_filename:
2695 * @icon_info: a #GtkIconInfo
2697 * Gets the filename for the icon. If the
2698 * %GTK_ICON_LOOKUP_USE_BUILTIN flag was passed
2699 * to gtk_icon_theme_lookup_icon(), there may be
2700 * no filename if a builtin icon is returned; in this
2701 * case, you should use gtk_icon_info_get_builtin_pixbuf().
2703 * Return value: the filename for the icon, or %NULL
2704 * if gtk_icon_info_get_builtin_pixbuf() should
2705 * be used instead. The return value is owned by
2706 * GTK+ and should not be modified or freed.
2710 G_CONST_RETURN gchar *
2711 gtk_icon_info_get_filename (GtkIconInfo *icon_info)
2713 g_return_val_if_fail (icon_info != NULL, NULL);
2715 return icon_info->filename;
2719 * gtk_icon_info_get_builtin_pixbuf:
2720 * @icon_info: a #GtkIconInfo structure
2722 * Gets the built-in image for this icon, if any. To allow
2723 * GTK+ to use built in icon images, you must pass the
2724 * %GTK_ICON_LOOKUP_USE_BUILTIN to
2725 * gtk_icon_theme_lookup_icon().
2727 * Return value: (transfer none): the built-in image pixbuf, or %NULL. No
2728 * extra reference is added to the returned pixbuf, so if
2729 * you want to keep it around, you must use g_object_ref().
2730 * The returned image must not be modified.
2735 gtk_icon_info_get_builtin_pixbuf (GtkIconInfo *icon_info)
2737 g_return_val_if_fail (icon_info != NULL, NULL);
2739 if (icon_info->filename)
2742 return icon_info->cache_pixbuf;
2745 static gboolean icon_info_ensure_scale_and_pixbuf (GtkIconInfo*, gboolean);
2747 /* Combine the icon with all emblems, the first emblem is placed
2748 * in the southeast corner. Scale emblems to be at most 3/4 of the
2749 * size of the icon itself.
2752 apply_emblems (GtkIconInfo *info)
2754 GdkPixbuf *icon = NULL;
2758 if (info->emblem_infos == NULL)
2761 if (info->emblems_applied)
2764 w = gdk_pixbuf_get_width (info->pixbuf);
2765 h = gdk_pixbuf_get_height (info->pixbuf);
2767 for (l = info->emblem_infos, pos = 0; l; l = l->next, pos++)
2769 GtkIconInfo *emblem_info = l->data;
2771 if (icon_info_ensure_scale_and_pixbuf (emblem_info, FALSE))
2773 GdkPixbuf *emblem = emblem_info->pixbuf;
2775 gint x = 0, y = 0; /* silence compiler */
2778 ew = gdk_pixbuf_get_width (emblem);
2779 eh = gdk_pixbuf_get_height (emblem);
2811 icon = gdk_pixbuf_copy (info->pixbuf);
2816 gdk_pixbuf_composite (emblem, icon, x, y, ew, eh, x, y,
2817 scale, scale, GDK_INTERP_BILINEAR, 255);
2823 g_object_unref (info->pixbuf);
2824 info->pixbuf = icon;
2827 info->emblems_applied = TRUE;
2830 /* This function contains the complicated logic for deciding
2831 * on the size at which to load the icon and loading it at
2835 icon_info_ensure_scale_and_pixbuf (GtkIconInfo *icon_info,
2836 gboolean scale_only)
2838 int image_width, image_height;
2839 GdkPixbuf *source_pixbuf;
2842 /* First check if we already succeeded have the necessary
2843 * information (or failed earlier)
2845 if (scale_only && icon_info->scale >= 0)
2848 if (icon_info->pixbuf)
2850 apply_emblems (icon_info);
2854 if (icon_info->load_error)
2857 /* SVG icons are a special case - we just immediately scale them
2858 * to the desired size
2860 if (icon_info->filename && !icon_info->loadable)
2864 file = g_file_new_for_path (icon_info->filename);
2865 icon_info->loadable = G_LOADABLE_ICON (g_file_icon_new (file));
2866 g_object_unref (file);
2870 if (G_IS_FILE_ICON (icon_info->loadable))
2873 GFileInfo *file_info;
2874 const gchar *content_type;
2876 file = g_file_icon_get_file (G_FILE_ICON (icon_info->loadable));
2877 file_info = g_file_query_info (file,
2878 G_FILE_ATTRIBUTE_STANDARD_CONTENT_TYPE,
2879 G_FILE_QUERY_INFO_NONE,
2883 content_type = g_file_info_get_content_type (file_info);
2885 if (content_type && strcmp (content_type, "image/svg+xml") == 0)
2888 g_object_unref (file_info);
2894 GInputStream *stream;
2896 icon_info->scale = icon_info->desired_size / 1000.;
2901 stream = g_loadable_icon_load (icon_info->loadable,
2902 icon_info->desired_size,
2904 &icon_info->load_error);
2907 icon_info->pixbuf = gdk_pixbuf_new_from_stream_at_scale (stream,
2908 icon_info->desired_size,
2909 icon_info->desired_size,
2912 &icon_info->load_error);
2913 g_object_unref (stream);
2916 if (!icon_info->pixbuf)
2919 apply_emblems (icon_info);
2924 /* In many cases, the scale can be determined without actual access
2925 * to the icon file. This is generally true when we have a size
2926 * for the directory where the icon is; the image size doesn't
2927 * matter in that case.
2929 if (icon_info->forced_size)
2930 icon_info->scale = -1;
2931 else if (icon_info->dir_type == ICON_THEME_DIR_FIXED)
2932 icon_info->scale = 1.0;
2933 else if (icon_info->dir_type == ICON_THEME_DIR_THRESHOLD)
2935 if (icon_info->desired_size >= icon_info->dir_size - icon_info->threshold &&
2936 icon_info->desired_size <= icon_info->dir_size + icon_info->threshold)
2937 icon_info->scale = 1.0;
2938 else if (icon_info->dir_size > 0)
2939 icon_info->scale =(gdouble) icon_info->desired_size / icon_info->dir_size;
2941 else if (icon_info->dir_type == ICON_THEME_DIR_SCALABLE)
2943 if (icon_info->dir_size > 0)
2944 icon_info->scale = (gdouble) icon_info->desired_size / icon_info->dir_size;
2947 if (icon_info->scale >= 0. && scale_only)
2950 /* At this point, we need to actually get the icon; either from the
2951 * builtin image or by loading the file
2953 source_pixbuf = NULL;
2954 if (icon_info->cache_pixbuf)
2955 source_pixbuf = g_object_ref (icon_info->cache_pixbuf);
2958 GInputStream *stream;
2960 stream = g_loadable_icon_load (icon_info->loadable,
2961 icon_info->desired_size,
2963 &icon_info->load_error);
2966 source_pixbuf = gdk_pixbuf_new_from_stream (stream,
2968 &icon_info->load_error);
2969 g_object_unref (stream);
2976 /* Do scale calculations that depend on the image size
2978 image_width = gdk_pixbuf_get_width (source_pixbuf);
2979 image_height = gdk_pixbuf_get_height (source_pixbuf);
2981 if (icon_info->scale < 0.0)
2983 gint image_size = MAX (image_width, image_height);
2985 icon_info->scale = (gdouble)icon_info->desired_size / (gdouble)image_size;
2987 icon_info->scale = 1.0;
2989 if (icon_info->dir_type == ICON_THEME_DIR_UNTHEMED &&
2990 !icon_info->forced_size)
2991 icon_info->scale = MIN (icon_info->scale, 1.0);
2994 /* We don't short-circuit out here for scale_only, since, now
2995 * we've loaded the icon, we might as well go ahead and finish
2996 * the job. This is a bit of a waste when we scale here
2997 * and never get the final pixbuf; at the cost of a bit of
2998 * extra complexity, we could keep the source pixbuf around
2999 * but not actually scale it until needed.
3001 if (icon_info->scale == 1.0)
3002 icon_info->pixbuf = source_pixbuf;
3005 icon_info->pixbuf = gdk_pixbuf_scale_simple (source_pixbuf,
3006 0.5 + image_width * icon_info->scale,
3007 0.5 + image_height * icon_info->scale,
3008 GDK_INTERP_BILINEAR);
3009 g_object_unref (source_pixbuf);
3012 apply_emblems (icon_info);
3018 * gtk_icon_info_load_icon:
3019 * @icon_info: a #GtkIconInfo structure from gtk_icon_theme_lookup_icon()
3020 * @error: (allow-none): location to store error information on failure,
3023 * Renders an icon previously looked up in an icon theme using
3024 * gtk_icon_theme_lookup_icon(); the size will be based on the size
3025 * passed to gtk_icon_theme_lookup_icon(). Note that the resulting
3026 * pixbuf may not be exactly this size; an icon theme may have icons
3027 * that differ slightly from their nominal sizes, and in addition GTK+
3028 * will avoid scaling icons that it considers sufficiently close to the
3029 * requested size or for which the source image would have to be scaled
3030 * up too far. (This maintains sharpness.). This behaviour can be changed
3031 * by passing the %GTK_ICON_LOOKUP_FORCE_SIZE flag when obtaining
3032 * the #GtkIconInfo. If this flag has been specified, the pixbuf
3033 * returned by this function will be scaled to the exact size.
3035 * Return value: (transfer full): the rendered icon; this may be a newly
3036 * created icon or a new reference to an internal icon, so you must
3037 * not modify the icon. Use g_object_unref() to release your reference
3043 gtk_icon_info_load_icon (GtkIconInfo *icon_info,
3046 g_return_val_if_fail (icon_info != NULL, NULL);
3047 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
3049 if (!icon_info_ensure_scale_and_pixbuf (icon_info, FALSE))
3051 if (icon_info->load_error)
3052 g_propagate_error (error, icon_info->load_error);
3054 g_set_error_literal (error,
3055 GTK_ICON_THEME_ERROR,
3056 GTK_ICON_THEME_NOT_FOUND,
3057 _("Failed to load icon"));
3062 return g_object_ref (icon_info->pixbuf);
3066 gdk_color_to_css (GdkColor *color)
3068 return g_strdup_printf ("rgb(%d,%d,%d)",
3075 gdk_rgba_to_css (GdkRGBA *color)
3077 return g_strdup_printf ("rgba(%d,%d,%d,%f)",
3078 (gint)(color->red * 255),
3079 (gint)(color->green * 255),
3080 (gint)(color->blue * 255),
3085 _gtk_icon_info_load_symbolic_internal (GtkIconInfo *icon_info,
3086 const gchar *css_fg,
3087 const gchar *css_success,
3088 const gchar *css_warning,
3089 const gchar *css_error,
3092 GInputStream *stream;
3095 gchar *success, *warning, *err;
3097 /* css_fg can't possibly have failed, otherwise
3098 * that would mean we have a broken style */
3099 g_return_val_if_fail (css_fg != NULL, NULL);
3101 success = warning = err = NULL;
3105 GdkColor success_default_color = { 0, 0x4e00, 0x9a00, 0x0600 };
3106 success = gdk_color_to_css (&success_default_color);
3110 GdkColor warning_default_color = { 0, 0xf500, 0x7900, 0x3e00 };
3111 warning = gdk_color_to_css (&warning_default_color);
3115 GdkColor error_default_color = { 0, 0xcc00, 0x0000, 0x0000 };
3116 err = gdk_color_to_css (&error_default_color);
3120 data = g_strconcat ("<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"no\"?>\n"
3121 "<svg version=\"1.1\"\n"
3122 " xmlns=\"http://www.w3.org/2000/svg\"\n"
3123 " xmlns:xi=\"http://www.w3.org/2001/XInclude\"\n"
3126 " <style type=\"text/css\">\n"
3128 " fill: ", css_fg," !important;\n"
3131 " fill: ", css_warning ? css_warning : warning," !important;\n"
3134 " fill: ", css_error ? css_error : err," !important;\n"
3137 " fill: ", css_success ? css_success : success," !important;\n"
3140 " <xi:include href=\"", icon_info->filename, "\"/>\n"
3147 stream = g_memory_input_stream_new_from_data (data, -1, g_free);
3148 pixbuf = gdk_pixbuf_new_from_stream_at_scale (stream,
3149 icon_info->desired_size,
3150 icon_info->desired_size,
3154 g_object_unref (stream);
3160 * gtk_icon_info_load_symbolic:
3161 * @icon_info: a #GtkIconInfo
3162 * @fg: a #GdkRGBA representing the foreground color of the icon
3163 * @success_color: (allow-none): a #GdkRGBA representing the warning color
3164 * of the icon or %NULL to use the default color
3165 * @warning_color: (allow-none): a #GdkRGBA representing the warning color
3166 * of the icon or %NULL to use the default color
3167 * @error_color: (allow-none): a #GdkRGBA representing the error color
3168 * of the icon or %NULL to use the default color (allow-none)
3169 * @was_symbolic: (allow-none): a #gboolean, returns whether the loaded icon
3170 * was a symbolic one and whether the @fg color was applied to it.
3171 * @error: (allow-none): location to store error information on failure,
3174 * Loads an icon, modifying it to match the system colours for the foreground,
3175 * success, warning and error colors provided. If the icon is not a symbolic
3176 * one, the function will return the result from gtk_icon_info_load_icon().
3178 * This allows loading symbolic icons that will match the system theme.
3180 * Unless you are implementing a widget, you will want to use
3181 * g_themed_icon_new_with_default_fallbacks() to load the icon.
3183 * As implementation details, the icon loaded needs to be of SVG type,
3184 * contain the "symbolic" term as the last component of the icon name,
3185 * and use the 'fg', 'success', 'warning' and 'error' CSS styles in the
3188 * See the <ulink url="http://www.freedesktop.org/wiki/SymbolicIcons">Symbolic Icons spec</ulink>
3189 * for more information about symbolic icons.
3191 * Return value: (transfer full): a #GdkPixbuf representing the loaded icon
3196 gtk_icon_info_load_symbolic (GtkIconInfo *icon_info,
3198 GdkRGBA *success_color,
3199 GdkRGBA *warning_color,
3200 GdkRGBA *error_color,
3201 gboolean *was_symbolic,
3210 g_return_val_if_fail (fg != NULL, NULL);
3212 if (!icon_info->filename ||
3213 !g_str_has_suffix (icon_info->filename, "-symbolic.svg"))
3216 *was_symbolic = FALSE;
3217 return gtk_icon_info_load_icon (icon_info, error);
3221 *was_symbolic = TRUE;
3223 css_fg = gdk_rgba_to_string (fg);
3225 css_success = css_warning = css_error = NULL;
3228 css_warning = gdk_rgba_to_string (warning_color);
3231 css_error = gdk_rgba_to_string (error_color);
3234 css_success = gdk_rgba_to_string (success_color);
3236 pixbuf = _gtk_icon_info_load_symbolic_internal (icon_info,
3237 css_fg, css_success,
3238 css_warning, css_error,
3241 g_free (css_warning);
3242 g_free (css_success);
3249 * gtk_icon_info_load_symbolic_for_context:
3250 * @icon_info: a #GtkIconInfo
3251 * context: a #GtkStyleContext
3252 * @was_symbolic: (allow-none): a #gboolean, returns whether the loaded icon
3253 * was a symbolic one and whether the @fg color was applied to it.
3254 * @error: (allow-none): location to store error information on failure,
3257 * Loads an icon, modifying it to match the system colors for the foreground,
3258 * success, warning and error colors provided. If the icon is not a symbolic
3259 * one, the function will return the result from gtk_icon_info_load_icon().
3261 * This allows loading symbolic icons that will match the system theme.
3263 * See gtk_icon_info_load_symbolic() for more details.
3265 * Return value: (transfer full): a #GdkPixbuf representing the loaded icon
3270 gtk_icon_info_load_symbolic_for_context (GtkIconInfo *icon_info,
3271 GtkStyleContext *context,
3272 gboolean *was_symbolic,
3276 GdkRGBA *color = NULL;
3278 gchar *css_fg = NULL, *css_success;
3279 gchar *css_warning, *css_error;
3280 GtkStateFlags state;
3282 if (!icon_info->filename ||
3283 !g_str_has_suffix (icon_info->filename, "-symbolic.svg"))
3286 *was_symbolic = FALSE;
3287 return gtk_icon_info_load_icon (icon_info, error);
3291 *was_symbolic = TRUE;
3293 state = gtk_style_context_get_state (context);
3294 gtk_style_context_get (context, state, "color", &color, NULL);
3297 css_fg = gdk_rgba_to_css (color);
3298 gdk_rgba_free (color);
3301 css_success = css_warning = css_error = NULL;
3303 if (gtk_style_context_lookup_color (context, "success_color", &rgba))
3304 css_success = gdk_rgba_to_css (&rgba);
3306 if (gtk_style_context_lookup_color (context, "warning_color", &rgba))
3307 css_warning = gdk_rgba_to_css (&rgba);
3309 if (gtk_style_context_lookup_color (context, "error_color", &rgba))
3310 css_error = gdk_rgba_to_css (&rgba);
3312 pixbuf = _gtk_icon_info_load_symbolic_internal (icon_info,
3313 css_fg, css_success,
3314 css_warning, css_error,
3318 g_free (css_success);
3319 g_free (css_warning);
3326 * gtk_icon_info_load_symbolic_for_style:
3327 * @icon_info: a #GtkIconInfo
3328 * @style: a #GtkStyle to take the colors from
3329 * @state: the widget state to use for colors
3330 * @was_symbolic: (allow-none): a #gboolean, returns whether the loaded icon
3331 * was a symbolic one and whether the @fg color was applied to it.
3332 * @error: (allow-none): location to store error information on failure,
3335 * Loads an icon, modifying it to match the system colours for the foreground,
3336 * success, warning and error colors provided. If the icon is not a symbolic
3337 * one, the function will return the result from gtk_icon_info_load_icon().
3339 * This allows loading symbolic icons that will match the system theme.
3341 * See gtk_icon_info_load_symbolic() for more details.
3343 * Return value: (transfer full): a #GdkPixbuf representing the loaded icon
3347 * Deprecated: 3.0: Use gtk_icon_info_load_symbolic_for_context() instead
3350 gtk_icon_info_load_symbolic_for_style (GtkIconInfo *icon_info,
3353 gboolean *was_symbolic,
3357 GdkColor success_color;
3358 GdkColor warning_color;
3359 GdkColor error_color;
3361 gchar *css_fg, *css_success;
3362 gchar *css_warning, *css_error;
3364 if (!icon_info->filename ||
3365 !g_str_has_suffix (icon_info->filename, "-symbolic.svg"))
3368 *was_symbolic = FALSE;
3369 return gtk_icon_info_load_icon (icon_info, error);
3373 *was_symbolic = TRUE;
3375 fg = &style->fg[state];
3376 css_fg = gdk_color_to_css (fg);
3378 css_success = css_warning = css_error = NULL;
3380 if (gtk_style_lookup_color (style, "success_color", &success_color))
3381 css_success = gdk_color_to_css (&success_color);
3383 if (gtk_style_lookup_color (style, "warning_color", &warning_color))
3384 css_warning = gdk_color_to_css (&warning_color);
3386 if (gtk_style_lookup_color (style, "error_color", &error_color))
3387 css_error = gdk_color_to_css (&error_color);
3389 pixbuf = _gtk_icon_info_load_symbolic_internal (icon_info,
3390 css_fg, css_success,
3391 css_warning, css_error,
3395 g_free (css_success);
3396 g_free (css_warning);
3403 * gtk_icon_info_set_raw_coordinates:
3404 * @icon_info: a #GtkIconInfo
3405 * @raw_coordinates: whether the coordinates of embedded rectangles
3406 * and attached points should be returned in their original
3409 * Sets whether the coordinates returned by gtk_icon_info_get_embedded_rect()
3410 * and gtk_icon_info_get_attach_points() should be returned in their
3411 * original form as specified in the icon theme, instead of scaled
3412 * appropriately for the pixbuf returned by gtk_icon_info_load_icon().
3414 * Raw coordinates are somewhat strange; they are specified to be with
3415 * respect to the unscaled pixmap for PNG and XPM icons, but for SVG
3416 * icons, they are in a 1000x1000 coordinate space that is scaled
3417 * to the final size of the icon. You can determine if the icon is an SVG
3418 * icon by using gtk_icon_info_get_filename(), and seeing if it is non-%NULL
3419 * and ends in '.svg'.
3421 * This function is provided primarily to allow compatibility wrappers
3422 * for older API's, and is not expected to be useful for applications.
3427 gtk_icon_info_set_raw_coordinates (GtkIconInfo *icon_info,
3428 gboolean raw_coordinates)
3430 g_return_if_fail (icon_info != NULL);
3432 icon_info->raw_coordinates = raw_coordinates != FALSE;
3435 /* Scale coordinates from the icon data prior to returning
3439 icon_info_scale_point (GtkIconInfo *icon_info,
3445 if (icon_info->raw_coordinates)
3452 if (!icon_info_ensure_scale_and_pixbuf (icon_info, TRUE))
3455 *x_out = 0.5 + x * icon_info->scale;
3456 *y_out = 0.5 + y * icon_info->scale;
3463 * gtk_icon_info_get_embedded_rect:
3464 * @icon_info: a #GtkIconInfo
3465 * @rectangle: #GdkRectangle in which to store embedded
3466 * rectangle coordinates; coordinates are only stored
3467 * when this function returns %TRUE.
3469 * Gets the coordinates of a rectangle within the icon
3470 * that can be used for display of information such
3471 * as a preview of the contents of a text file.
3472 * See gtk_icon_info_set_raw_coordinates() for further
3473 * information about the coordinate system.
3475 * Return value: %TRUE if the icon has an embedded rectangle
3480 gtk_icon_info_get_embedded_rect (GtkIconInfo *icon_info,
3481 GdkRectangle *rectangle)
3483 g_return_val_if_fail (icon_info != NULL, FALSE);
3485 if (icon_info->data && icon_info->data->has_embedded_rect &&
3486 icon_info_ensure_scale_and_pixbuf (icon_info, TRUE))
3488 gint scaled_x0, scaled_y0;
3489 gint scaled_x1, scaled_y1;
3493 icon_info_scale_point (icon_info,
3494 icon_info->data->x0, icon_info->data->y0,
3495 &scaled_x0, &scaled_y0);
3496 icon_info_scale_point (icon_info,
3497 icon_info->data->x1, icon_info->data->y1,
3498 &scaled_x1, &scaled_y1);
3500 rectangle->x = scaled_x0;
3501 rectangle->y = scaled_y0;
3502 rectangle->width = scaled_x1 - rectangle->x;
3503 rectangle->height = scaled_y1 - rectangle->y;
3513 * gtk_icon_info_get_attach_points:
3514 * @icon_info: a #GtkIconInfo
3515 * @points: (allow-none) (array length=n_points) (out): location to store pointer to an array of points, or %NULL
3516 * free the array of points with g_free().
3517 * @n_points: (allow-none): location to store the number of points in @points, or %NULL
3519 * Fetches the set of attach points for an icon. An attach point
3520 * is a location in the icon that can be used as anchor points for attaching
3521 * emblems or overlays to the icon.
3523 * Return value: %TRUE if there are any attach points for the icon.
3528 gtk_icon_info_get_attach_points (GtkIconInfo *icon_info,
3532 g_return_val_if_fail (icon_info != NULL, FALSE);
3534 if (icon_info->data && icon_info->data->n_attach_points &&
3535 icon_info_ensure_scale_and_pixbuf (icon_info, TRUE))
3541 *points = g_new (GdkPoint, icon_info->data->n_attach_points);
3542 for (i = 0; i < icon_info->data->n_attach_points; i++)
3543 icon_info_scale_point (icon_info,
3544 icon_info->data->attach_points[i].x,
3545 icon_info->data->attach_points[i].y,
3551 *n_points = icon_info->data->n_attach_points;
3567 * gtk_icon_info_get_display_name:
3568 * @icon_info: a #GtkIconInfo
3570 * Gets the display name for an icon. A display name is a
3571 * string to be used in place of the icon name in a user
3572 * visible context like a list of icons.
3574 * Return value: the display name for the icon or %NULL, if
3575 * the icon doesn't have a specified display name. This value
3576 * is owned @icon_info and must not be modified or free.
3580 G_CONST_RETURN gchar *
3581 gtk_icon_info_get_display_name (GtkIconInfo *icon_info)
3583 g_return_val_if_fail (icon_info != NULL, NULL);
3585 if (icon_info->data)
3586 return icon_info->data->display_name;
3597 * gtk_icon_theme_add_builtin_icon:
3598 * @icon_name: the name of the icon to register
3599 * @size: the size at which to register the icon (different
3600 * images can be registered for the same icon name
3601 * at different sizes.)
3602 * @pixbuf: #GdkPixbuf that contains the image to use
3605 * Registers a built-in icon for icon theme lookups. The idea
3606 * of built-in icons is to allow an application or library
3607 * that uses themed icons to function requiring files to
3608 * be present in the file system. For instance, the default
3609 * images for all of GTK+'s stock icons are registered
3612 * In general, if you use gtk_icon_theme_add_builtin_icon()
3613 * you should also install the icon in the icon theme, so
3614 * that the icon is generally available.
3616 * This function will generally be used with pixbufs loaded
3617 * via gdk_pixbuf_new_from_inline().
3622 gtk_icon_theme_add_builtin_icon (const gchar *icon_name,
3626 BuiltinIcon *default_icon;
3630 g_return_if_fail (icon_name != NULL);
3631 g_return_if_fail (GDK_IS_PIXBUF (pixbuf));
3633 if (!icon_theme_builtin_icons)
3634 icon_theme_builtin_icons = g_hash_table_new (g_str_hash, g_str_equal);
3636 icons = g_hash_table_lookup (icon_theme_builtin_icons, icon_name);
3638 key = g_strdup (icon_name);
3640 key = (gpointer)icon_name; /* Won't get stored */
3642 default_icon = g_new (BuiltinIcon, 1);
3643 default_icon->size = size;
3644 default_icon->pixbuf = g_object_ref (pixbuf);
3645 icons = g_slist_prepend (icons, default_icon);
3647 /* Replaces value, leaves key untouched
3649 g_hash_table_insert (icon_theme_builtin_icons, key, icons);
3652 /* Look up a builtin icon; the min_difference_p and
3653 * has_larger_p out parameters allow us to combine
3654 * this lookup with searching through the actual directories
3655 * of the "hicolor" icon theme. See theme_lookup_icon()
3656 * for how they are used.
3658 static BuiltinIcon *
3659 find_builtin_icon (const gchar *icon_name,
3661 gint *min_difference_p,
3662 gboolean *has_larger_p)
3664 GSList *icons = NULL;
3665 gint min_difference = G_MAXINT;
3666 gboolean has_larger = FALSE;
3667 BuiltinIcon *min_icon = NULL;
3669 if (!icon_theme_builtin_icons)
3672 icons = g_hash_table_lookup (icon_theme_builtin_icons, icon_name);
3676 BuiltinIcon *default_icon = icons->data;
3677 int min, max, difference;
3680 min = default_icon->size - 2;
3681 max = default_icon->size + 2;
3682 smaller = size < min;
3684 difference = min - size;
3685 else if (size > max)
3686 difference = size - max;
3690 if (difference == 0)
3692 min_icon = default_icon;
3698 if (difference < min_difference || smaller)
3700 min_difference = difference;
3701 min_icon = default_icon;
3702 has_larger = smaller;
3707 if (difference < min_difference && smaller)
3709 min_difference = difference;
3710 min_icon = default_icon;
3714 icons = icons->next;
3717 if (min_difference_p)
3718 *min_difference_p = min_difference;
3720 *has_larger_p = has_larger;
3726 _gtk_icon_theme_check_reload (GdkDisplay *display)
3730 GtkIconTheme *icon_theme;
3732 n_screens = gdk_display_get_n_screens (display);
3734 for (i = 0; i < n_screens; i++)
3736 screen = gdk_display_get_screen (display, i);
3738 icon_theme = g_object_get_data (G_OBJECT (screen), "gtk-icon-theme");
3741 icon_theme->priv->check_reload = TRUE;
3742 ensure_valid_themes (icon_theme);
3743 icon_theme->priv->check_reload = FALSE;
3750 * gtk_icon_theme_lookup_by_gicon:
3751 * @icon_theme: a #GtkIconTheme
3752 * @icon: the #GIcon to look up
3753 * @size: desired icon size
3754 * @flags: flags modifying the behavior of the icon lookup
3756 * Looks up an icon and returns a structure containing
3757 * information such as the filename of the icon.
3758 * The icon can then be rendered into a pixbuf using
3759 * gtk_icon_info_load_icon().
3761 * Return value: a #GtkIconInfo structure containing
3762 * information about the icon, or %NULL if the icon
3763 * wasn't found. Free with gtk_icon_info_free()
3768 gtk_icon_theme_lookup_by_gicon (GtkIconTheme *icon_theme,
3771 GtkIconLookupFlags flags)
3775 g_return_val_if_fail (GTK_IS_ICON_THEME (icon_theme), NULL);
3776 g_return_val_if_fail (G_IS_ICON (icon), NULL);
3778 if (G_IS_LOADABLE_ICON (icon))
3780 info = icon_info_new ();
3781 info->loadable = G_LOADABLE_ICON (g_object_ref (icon));
3783 info->dir_type = ICON_THEME_DIR_UNTHEMED;
3784 info->dir_size = size;
3785 info->desired_size = size;
3786 info->threshold = 2;
3787 info->forced_size = (flags & GTK_ICON_LOOKUP_FORCE_SIZE) != 0;
3791 else if (G_IS_THEMED_ICON (icon))
3793 const gchar **names;
3795 names = (const gchar **)g_themed_icon_get_names (G_THEMED_ICON (icon));
3796 info = gtk_icon_theme_choose_icon (icon_theme, names, size, flags);
3800 else if (G_IS_EMBLEMED_ICON (icon))
3802 GIcon *base, *emblem;
3804 GtkIconInfo *emblem_info;
3806 base = g_emblemed_icon_get_icon (G_EMBLEMED_ICON (icon));
3807 info = gtk_icon_theme_lookup_by_gicon (icon_theme, base, size, flags);
3810 list = g_emblemed_icon_get_emblems (G_EMBLEMED_ICON (icon));
3811 for (l = list; l; l = l->next)
3813 emblem = g_emblem_get_icon (G_EMBLEM (l->data));
3814 /* always force size for emblems */
3815 emblem_info = gtk_icon_theme_lookup_by_gicon (icon_theme, emblem, size / 2, flags | GTK_ICON_LOOKUP_FORCE_SIZE);
3817 info->emblem_infos = g_slist_prepend (info->emblem_infos, emblem_info);
3823 else if (GDK_IS_PIXBUF (icon))
3827 pixbuf = GDK_PIXBUF (icon);
3829 if ((flags & GTK_ICON_LOOKUP_FORCE_SIZE) != 0)
3831 gint width, height, max;
3835 width = gdk_pixbuf_get_width (pixbuf);
3836 height = gdk_pixbuf_get_height (pixbuf);
3837 max = MAX (width, height);
3838 scale = (gdouble) size / (gdouble) max;
3840 scaled = gdk_pixbuf_scale_simple (pixbuf,
3841 0.5 + width * scale,
3842 0.5 + height * scale,
3843 GDK_INTERP_BILINEAR);
3845 info = gtk_icon_info_new_for_pixbuf (icon_theme, scaled);
3847 g_object_unref (scaled);
3851 info = gtk_icon_info_new_for_pixbuf (icon_theme, pixbuf);
3861 * gtk_icon_info_new_for_pixbuf:
3862 * @icon_theme: a #GtkIconTheme
3863 * @pixbuf: the pixbuf to wrap in a #GtkIconInfo
3865 * Creates a #GtkIconInfo for a #GdkPixbuf.
3867 * Returns: a #GtkIconInfo
3872 gtk_icon_info_new_for_pixbuf (GtkIconTheme *icon_theme,
3877 g_return_val_if_fail (GTK_IS_ICON_THEME (icon_theme), NULL);
3878 g_return_val_if_fail (GDK_IS_PIXBUF (pixbuf), NULL);
3880 info = icon_info_new ();
3881 info->pixbuf = g_object_ref (pixbuf);
3883 info->dir_type = ICON_THEME_DIR_UNTHEMED;