gio/gthemedicon.c

   1 /* GIO - GLib Input, Output and Streaming Library
   2  *
   3  * Copyright (C) 2006-2007 Red Hat, Inc.
   4  *
   5  * This library is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU Lesser General Public
   7  * License as published by the Free Software Foundation; either
   8  * version 2 of the License, or (at your option) any later version.
   9  *
  10  * This library is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * Lesser General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU Lesser General
  16  * Public License along with this library; if not, write to the
  17  * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
  18  * Boston, MA 02111-1307, USA.
  19  *
  20  * Author: Alexander Larsson <alexl@redhat.com>
  21  */
  22
  23 #include <config.h>
  24
  25 #include <string.h>
  26
  27 #include "gthemedicon.h"
  28
  29 #include "gioalias.h"
  30
  31 /**
  32  * SECTION:gthemedicon
  33  * @short_description: Icon theming support
  34  * @include: gio.h
  35  * @see_also: #GIcon, #GLoadableIcon
  36  *
  37  * #GThemedIcon is an implementation of #GIcon that supports icon themes.
  38  * #GThemedIcon contains a list of all of the icons present in an icon
  39  * theme, so that icons can be looked up quickly. #GThemedIcon does
  40  * not provide actual pixmaps for icons, just the icon names.
  41  * Ideally something like gtk_icon_theme_choose_icon() should be used to
  42  * resolve the list of names so that fallback icons work nicely with
  43  * themes that inherit other themes.
  44  **/
  45
  46 static void g_themed_icon_icon_iface_init (GIconIface *iface);
  47
  48 struct _GThemedIcon
  49 {
  50   GObject parent_instance;
  51
  52   char **names;
  53 };
  54
  55 struct _GThemedIconClass
  56 {
  57   GObjectClass parent_class;
  58 };
  59
  60 G_DEFINE_TYPE_WITH_CODE (GThemedIcon, g_themed_icon, G_TYPE_OBJECT,
  61                          G_IMPLEMENT_INTERFACE (G_TYPE_ICON,
  62                                                 g_themed_icon_icon_iface_init))
  63
  64 static void
  65 g_themed_icon_finalize (GObject *object)
  66 {
  67   GThemedIcon *themed;
  68
  69   themed = G_THEMED_ICON (object);
  70
  71   g_strfreev (themed->names);
  72
  73   if (G_OBJECT_CLASS (g_themed_icon_parent_class)->finalize)
  74     (*G_OBJECT_CLASS (g_themed_icon_parent_class)->finalize) (object);
  75 }
  76
  77 static void
  78 g_themed_icon_class_init (GThemedIconClass *klass)
  79 {
  80   GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
  81
  82   gobject_class->finalize = g_themed_icon_finalize;
  83 }
  84
  85 static void
  86 g_themed_icon_init (GThemedIcon *themed)
  87 {
  88 }
  89
  90 /**
  91  * g_themed_icon_new:
  92  * @iconname: a string containing an icon name.
  93  *
  94  * Creates a new themed icon for @iconname.
  95  *
  96  * Returns: a new #GThemedIcon.
  97  **/
  98 GIcon *
  99 g_themed_icon_new (const char *iconname)
 100 {
 101   GThemedIcon *themed;
 102
 103   g_return_val_if_fail (iconname != NULL, NULL);
 104
 105   themed = g_object_new (G_TYPE_THEMED_ICON, NULL);
 106   themed->names = g_new (char *, 2);
 107   themed->names[0] = g_strdup (iconname);
 108   themed->names[1] = NULL;
 109
 110   return G_ICON (themed);
 111 }
 112
 113 /**
 114  * g_themed_icon_new_from_names:
 115  * @iconnames: an array of strings containing icon names.
 116  * @len: the number of elements in the @iconnames array.
 117  *
 118  * Creates a new themed icon for @iconnames.
 119  *
 120  * Returns: a new #GThemedIcon.
 121  **/
 122 GIcon *
 123 g_themed_icon_new_from_names (char **iconnames,
 124                               int    len)
 125 {
 126   GThemedIcon *themed;
 127   int i;
 128
 129   g_return_val_if_fail (iconnames != NULL, NULL);
 130
 131   themed = g_object_new (G_TYPE_THEMED_ICON, NULL);
 132   if (len == -1)
 133     themed->names = g_strdupv (iconnames);
 134   else
 135     {
 136       themed->names = g_new (char *, len + 1);
 137       for (i = 0; i < len; i++)
 138         themed->names[i] = g_strdup (iconnames[i]);
 139       themed->names[i] = NULL;
 140     }
 141
 142
 143   return G_ICON (themed);
 144 }
 145
 146 /**
 147  * g_themed_icon_new_with_default_fallbacks:
 148  * @iconname: a string containing an icon name
 149  *
 150  * Creates a new themed icon for @iconname, and all the names
 151  * that can be created by shortening @iconname at '-' characters.
 152  *
 153  * In the following example, @icon1 and @icon2 are equivalent:
 154  * |[
 155  * const char *names[] = {
 156  *   "gnome-dev-cdrom-audio",
 157  *   "gnome-dev-cdrom",
 158  *   "gnome-dev",
 159  *   "gnome"
 160  * };
 161  *
 162  * icon1 = g_themed_icon_new_from_names (names, 4);
 163  * icon2 = g_themed_icon_new_with_default_fallbacks ("gnome-dev-cdrom-audio");
 164  * ]|
 165  *
 166  * Returns: a new #GThemedIcon.
 167  */
 168 GIcon *
 169 g_themed_icon_new_with_default_fallbacks (const char *iconname)
 170 {
 171   GThemedIcon *themed;
 172   int i, dashes;
 173   const char *p;
 174   char *dashp;
 175   char *last;
 176
 177   g_return_val_if_fail (iconname != NULL, NULL);
 178
 179   themed = g_object_new (G_TYPE_THEMED_ICON, NULL);
 180
 181   dashes = 0;
 182   p = iconname;
 183   while (*p)
 184     {
 185       if (*p == '-')
 186         dashes++;
 187       p++;
 188     }
 189
 190   themed->names = g_new (char *, dashes + 1 + 1);
 191   i = 0;
 192   themed->names[i++] = last = g_strdup (iconname);
 193
 194   while ((dashp = strrchr (last, '-')) != NULL)
 195     themed->names[i++] = last = g_strndup (last, dashp - last);
 196
 197   themed->names[i++] = NULL;
 198
 199   return G_ICON (themed);
 200 }
 201
 202
 203 /**
 204  * g_themed_icon_get_names:
 205  * @icon: a #GThemedIcon.
 206  *
 207  * Gets the names of icons from within @icon.
 208  *
 209  * Returns: a list of icon names.
 210  **/
 211 const char * const *
 212 g_themed_icon_get_names (GThemedIcon *icon)
 213 {
 214   g_return_val_if_fail (G_IS_THEMED_ICON (icon), NULL);
 215   return (const char * const *)icon->names;
 216 }
 217
 218 /**
 219  * g_themed_icon_append_name:
 220  * @icon: a #GThemedIcon
 221  * @iconname: name of icon to append to list of icons from within @icon.
 222  *
 223  * Append a name to the list of icons from within @icon.
 224  */
 225 void
 226 g_themed_icon_append_name (GThemedIcon *icon, const char *iconname)
 227 {
 228   guint num_names;
 229   char **new_names;
 230
 231   g_return_if_fail (G_IS_THEMED_ICON (icon));
 232   g_return_if_fail (iconname != NULL);
 233
 234   num_names = g_strv_length (icon->names);
 235   icon->names = g_realloc (icon->names, sizeof (char*) * (num_names + 2));
 236   icon->names[num_names] = g_strdup (iconname);
 237   icon->names[num_names + 1] = NULL;
 238 }
 239
 240 static guint
 241 g_themed_icon_hash (GIcon *icon)
 242 {
 243   GThemedIcon *themed = G_THEMED_ICON (icon);
 244   guint hash;
 245   int i;
 246
 247   hash = 0;
 248
 249   for (i = 0; themed->names[i] != NULL; i++)
 250     hash ^= g_str_hash (themed->names[i]);
 251
 252   return hash;
 253 }
 254
 255 static gboolean
 256 g_themed_icon_equal (GIcon *icon1,
 257                      GIcon *icon2)
 258 {
 259   GThemedIcon *themed1 = G_THEMED_ICON (icon1);
 260   GThemedIcon *themed2 = G_THEMED_ICON (icon2);
 261   int i;
 262
 263   for (i = 0; themed1->names[i] != NULL && themed2->names[i] != NULL; i++)
 264     {
 265       if (!g_str_equal (themed1->names[i], themed2->names[i]))
 266         return FALSE;
 267     }
 268
 269   return themed1->names[i] == NULL && themed2->names[i] == NULL;
 270 }
 271
 272 static void
 273 g_themed_icon_icon_iface_init (GIconIface *iface)
 274 {
 275   iface->hash = g_themed_icon_hash;
 276   iface->equal = g_themed_icon_equal;
 277 }
 278
 279 #define __G_THEMED_ICON_C__
 280 #include "gioaliasdef.c"