gio/gemblemedicon.c

   1 /* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
   2
   3 /* GIO - GLib Input, Output and Streaming Library
   4  *
   5  * Copyright (C) 2006-2007 Red Hat, Inc.
   6  *
   7  * This library is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Lesser General Public
   9  * License as published by the Free Software Foundation; either
  10  * version 2 of the License, or (at your option) any later version.
  11  *
  12  * This library is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * Lesser General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Lesser General
  18  * Public License along with this library; if not, write to the
  19  * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
  20  * Boston, MA 02111-1307, USA.
  21  *
  22  * Author: Matthias Clasen <mclasen@redhat.com>
  23  *         Clemens N. Buss <cebuzz@gmail.com>
  24  */
  25
  26 #include <config.h>
  27
  28 #include <string.h>
  29
  30 #include "gemblemedicon.h"
  31 #include "glibintl.h"
  32 #include "gioerror.h"
  33
  34
  35 /**
  36  * SECTION:gemblemedicon
  37  * @short_description: Icon with emblems
  38  * @include: gio/gio.h
  39  * @see_also: #GIcon, #GLoadableIcon, #GThemedIcon, #GEmblem
  40  *
  41  * #GEmblemedIcon is an implementation of #GIcon that supports
  42  * adding an emblem to an icon. Adding multiple emblems to an
  43  * icon is ensured via g_emblemed_icon_add_emblem().
  44  *
  45  * Note that #GEmblemedIcon allows no control over the position
  46  * of the emblems. See also #GEmblem for more information.
  47  **/
  48
  49 static void g_emblemed_icon_icon_iface_init (GIconIface *iface);
  50
  51 struct _GEmblemedIcon
  52 {
  53   GObject parent_instance;
  54
  55   GIcon *icon;
  56   GList *emblems;
  57 };
  58
  59 struct _GEmblemedIconClass
  60 {
  61   GObjectClass parent_class;
  62 };
  63
  64 G_DEFINE_TYPE_WITH_CODE (GEmblemedIcon, g_emblemed_icon, G_TYPE_OBJECT,
  65                          G_IMPLEMENT_INTERFACE (G_TYPE_ICON,
  66                          g_emblemed_icon_icon_iface_init))
  67
  68
  69 static void
  70 g_emblemed_icon_finalize (GObject *object)
  71 {
  72   GEmblemedIcon *emblemed;
  73
  74   emblemed = G_EMBLEMED_ICON (object);
  75
  76   g_object_unref (emblemed->icon);
  77   g_list_foreach (emblemed->emblems, (GFunc) g_object_unref, NULL);
  78   g_list_free (emblemed->emblems);
  79
  80   (*G_OBJECT_CLASS (g_emblemed_icon_parent_class)->finalize) (object);
  81 }
  82
  83 static void
  84 g_emblemed_icon_class_init (GEmblemedIconClass *klass)
  85 {
  86   GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
  87   gobject_class->finalize = g_emblemed_icon_finalize;
  88 }
  89
  90 static void
  91 g_emblemed_icon_init (GEmblemedIcon *emblemed)
  92 {
  93 }
  94
  95 /**
  96  * g_emblemed_icon_new:
  97  * @icon: a #GIcon
  98  * @emblem: (allow-none): a #GEmblem, or %NULL
  99  *
 100  * Creates a new emblemed icon for @icon with the emblem @emblem.
 101  *
 102  * Returns: (transfer full): a new #GIcon
 103  *
 104  * Since: 2.18
 105  **/
 106 GIcon *
 107 g_emblemed_icon_new (GIcon   *icon,
 108                      GEmblem *emblem)
 109 {
 110   GEmblemedIcon *emblemed;
 111
 112   g_return_val_if_fail (G_IS_ICON (icon), NULL);
 113   g_return_val_if_fail (!G_IS_EMBLEM (icon), NULL);
 114
 115   emblemed = G_EMBLEMED_ICON (g_object_new (G_TYPE_EMBLEMED_ICON, NULL));
 116   emblemed->icon = g_object_ref (icon);
 117
 118   if (emblem != NULL)
 119     g_emblemed_icon_add_emblem (emblemed, emblem);
 120
 121   return G_ICON (emblemed);
 122 }
 123
 124
 125 /**
 126  * g_emblemed_icon_get_icon:
 127  * @emblemed: a #GEmblemedIcon
 128  *
 129  * Gets the main icon for @emblemed.
 130  *
 131  * Returns: (transfer full): a #GIcon that is owned by @emblemed
 132  *
 133  * Since: 2.18
 134  **/
 135 GIcon *
 136 g_emblemed_icon_get_icon (GEmblemedIcon *emblemed)
 137 {
 138   g_return_val_if_fail (G_IS_EMBLEMED_ICON (emblemed), NULL);
 139
 140   return emblemed->icon;
 141 }
 142
 143 /**
 144  * g_emblemed_icon_get_emblems:
 145  * @emblemed: a #GEmblemedIcon
 146  *
 147  * Gets the list of emblems for the @icon.
 148  *
 149  * Returns: (element-type utf8) (transfer none): a #GList of #GEmblem <!-- -->s that
 150  * is owned by @emblemed
 151  *
 152  * Since: 2.18
 153  **/
 154
 155 GList *
 156 g_emblemed_icon_get_emblems (GEmblemedIcon *emblemed)
 157 {
 158   g_return_val_if_fail (G_IS_EMBLEMED_ICON (emblemed), NULL);
 159
 160   return emblemed->emblems;
 161 }
 162
 163 void
 164 g_emblemed_icon_clear_emblems (GEmblemedIcon *emblemed)
 165 {
 166   g_return_if_fail (G_IS_EMBLEMED_ICON (emblemed));
 167
 168   if (emblemed->emblems == NULL)
 169     return;
 170
 171   g_list_free_full (emblemed->emblems, g_object_unref);
 172   emblemed->emblems = NULL;
 173 }
 174
 175 static gint
 176 g_emblem_comp (GEmblem *a,
 177                GEmblem *b)
 178 {
 179   guint hash_a = g_icon_hash (G_ICON (a));
 180   guint hash_b = g_icon_hash (G_ICON (b));
 181
 182   if(hash_a < hash_b)
 183     return -1;
 184
 185   if(hash_a == hash_b)
 186     return 0;
 187
 188   return 1;
 189 }
 190
 191 /**
 192  * g_emblemed_icon_add_emblem:
 193  * @emblemed: a #GEmblemedIcon
 194  * @emblem: a #GEmblem
 195  *
 196  * Adds @emblem to the #GList of #GEmblem <!-- -->s.
 197  *
 198  * Since: 2.18
 199  **/
 200 void
 201 g_emblemed_icon_add_emblem (GEmblemedIcon *emblemed,
 202                             GEmblem       *emblem)
 203 {
 204   g_return_if_fail (G_IS_EMBLEMED_ICON (emblemed));
 205   g_return_if_fail (G_IS_EMBLEM (emblem));
 206
 207   g_object_ref (emblem);
 208   emblemed->emblems = g_list_insert_sorted (emblemed->emblems, emblem,
 209                                             (GCompareFunc) g_emblem_comp);
 210 }
 211
 212 static guint
 213 g_emblemed_icon_hash (GIcon *icon)
 214 {
 215   GEmblemedIcon *emblemed = G_EMBLEMED_ICON (icon);
 216   GList *list;
 217   guint hash = g_icon_hash (emblemed->icon);
 218
 219   for (list = emblemed->emblems; list != NULL; list = list->next)
 220     hash ^= g_icon_hash (G_ICON (list->data));
 221
 222   return hash;
 223 }
 224
 225 static gboolean
 226 g_emblemed_icon_equal (GIcon *icon1,
 227                        GIcon *icon2)
 228 {
 229   GEmblemedIcon *emblemed1 = G_EMBLEMED_ICON (icon1);
 230   GEmblemedIcon *emblemed2 = G_EMBLEMED_ICON (icon2);
 231   GList *list1, *list2;
 232
 233   if (!g_icon_equal (emblemed1->icon, emblemed2->icon))
 234     return FALSE;
 235
 236   list1 = emblemed1->emblems;
 237   list2 = emblemed2->emblems;
 238
 239   while (list1 && list2)
 240   {
 241     if (!g_icon_equal (G_ICON (list1->data), G_ICON (list2->data)))
 242         return FALSE;
 243
 244     list1 = list1->next;
 245     list2 = list2->next;
 246   }
 247
 248   return list1 == NULL && list2 == NULL;
 249 }
 250
 251 static gboolean
 252 g_emblemed_icon_to_tokens (GIcon *icon,
 253                            GPtrArray *tokens,
 254                            gint  *out_version)
 255 {
 256   GEmblemedIcon *emblemed_icon = G_EMBLEMED_ICON (icon);
 257   GList *l;
 258   char *s;
 259
 260   /* GEmblemedIcons are encoded as
 261    *
 262    *   <encoded_icon> [<encoded_emblem_icon>]*
 263    */
 264
 265   g_return_val_if_fail (out_version != NULL, FALSE);
 266
 267   *out_version = 0;
 268
 269   s = g_icon_to_string (emblemed_icon->icon);
 270   if (s == NULL)
 271     return FALSE;
 272
 273   g_ptr_array_add (tokens, s);
 274
 275   for (l = emblemed_icon->emblems; l != NULL; l = l->next)
 276     {
 277       GIcon *emblem_icon = G_ICON (l->data);
 278
 279       s = g_icon_to_string (emblem_icon);
 280       if (s == NULL)
 281         return FALSE;
 282
 283       g_ptr_array_add (tokens, s);
 284     }
 285
 286   return TRUE;
 287 }
 288
 289 static GIcon *
 290 g_emblemed_icon_from_tokens (gchar  **tokens,
 291                              gint     num_tokens,
 292                              gint     version,
 293                              GError **error)
 294 {
 295   GEmblemedIcon *emblemed_icon;
 296   int n;
 297
 298   emblemed_icon = NULL;
 299
 300   if (version != 0)
 301     {
 302       g_set_error (error,
 303                    G_IO_ERROR,
 304                    G_IO_ERROR_INVALID_ARGUMENT,
 305                    _("Can't handle version %d of GEmblemedIcon encoding"),
 306                    version);
 307       goto fail;
 308     }
 309
 310   if (num_tokens < 1)
 311     {
 312       g_set_error (error,
 313                    G_IO_ERROR,
 314                    G_IO_ERROR_INVALID_ARGUMENT,
 315                    _("Malformed number of tokens (%d) in GEmblemedIcon encoding"),
 316                    num_tokens);
 317       goto fail;
 318     }
 319
 320   emblemed_icon = g_object_new (G_TYPE_EMBLEMED_ICON, NULL);
 321   emblemed_icon->icon = g_icon_new_for_string (tokens[0], error);
 322   if (emblemed_icon->icon == NULL)
 323     goto fail;
 324
 325   for (n = 1; n < num_tokens; n++)
 326     {
 327       GIcon *emblem;
 328
 329       emblem = g_icon_new_for_string (tokens[n], error);
 330       if (emblem == NULL)
 331         goto fail;
 332
 333       if (!G_IS_EMBLEM (emblem))
 334         {
 335           g_set_error_literal (error,
 336                                G_IO_ERROR,
 337                                G_IO_ERROR_INVALID_ARGUMENT,
 338                                _("Expected a GEmblem for GEmblemedIcon"));
 339           g_object_unref (emblem);
 340           goto fail;
 341         }
 342
 343       emblemed_icon->emblems = g_list_append (emblemed_icon->emblems, emblem);
 344     }
 345
 346   return G_ICON (emblemed_icon);
 347
 348  fail:
 349   if (emblemed_icon != NULL)
 350     g_object_unref (emblemed_icon);
 351   return NULL;
 352 }
 353
 354 static void
 355 g_emblemed_icon_icon_iface_init (GIconIface *iface)
 356 {
 357   iface->hash = g_emblemed_icon_hash;
 358   iface->equal = g_emblemed_icon_equal;
 359   iface->to_tokens = g_emblemed_icon_to_tokens;
 360   iface->from_tokens = g_emblemed_icon_from_tokens;
 361 }