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: a #GEmblem
  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   g_return_val_if_fail (G_IS_EMBLEM (emblem), NULL);
 115
 116   emblemed = G_EMBLEMED_ICON (g_object_new (G_TYPE_EMBLEMED_ICON, NULL));
 117   emblemed->icon = g_object_ref (icon);
 118
 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 static gint
 164 g_emblem_comp (GEmblem *a,
 165                GEmblem *b)
 166 {
 167   guint hash_a = g_icon_hash (G_ICON (a));
 168   guint hash_b = g_icon_hash (G_ICON (b));
 169
 170   if(hash_a < hash_b)
 171     return -1;
 172
 173   if(hash_a == hash_b)
 174     return 0;
 175
 176   return 1;
 177 }
 178
 179 /**
 180  * g_emblemed_icon_add_emblem:
 181  * @emblemed: a #GEmblemedIcon
 182  * @emblem: a #GEmblem
 183  *
 184  * Adds @emblem to the #GList of #GEmblem <!-- -->s.
 185  *
 186  * Since: 2.18
 187  **/
 188 void
 189 g_emblemed_icon_add_emblem (GEmblemedIcon *emblemed,
 190                             GEmblem       *emblem)
 191 {
 192   g_return_if_fail (G_IS_EMBLEMED_ICON (emblemed));
 193   g_return_if_fail (G_IS_EMBLEM (emblem));
 194
 195   g_object_ref (emblem);
 196   emblemed->emblems = g_list_insert_sorted (emblemed->emblems, emblem,
 197                                             (GCompareFunc) g_emblem_comp);
 198 }
 199
 200 static guint
 201 g_emblemed_icon_hash (GIcon *icon)
 202 {
 203   GEmblemedIcon *emblemed = G_EMBLEMED_ICON (icon);
 204   GList *list;
 205   guint hash = g_icon_hash (emblemed->icon);
 206
 207   for (list = emblemed->emblems; list != NULL; list = list->next)
 208     hash ^= g_icon_hash (G_ICON (list->data));
 209
 210   return hash;
 211 }
 212
 213 static gboolean
 214 g_emblemed_icon_equal (GIcon *icon1,
 215                        GIcon *icon2)
 216 {
 217   GEmblemedIcon *emblemed1 = G_EMBLEMED_ICON (icon1);
 218   GEmblemedIcon *emblemed2 = G_EMBLEMED_ICON (icon2);
 219   GList *list1, *list2;
 220
 221   if (!g_icon_equal (emblemed1->icon, emblemed2->icon))
 222     return FALSE;
 223
 224   list1 = emblemed1->emblems;
 225   list2 = emblemed2->emblems;
 226
 227   while (list1 && list2)
 228   {
 229     if (!g_icon_equal (G_ICON (list1->data), G_ICON (list2->data)))
 230         return FALSE;
 231
 232     list1 = list1->next;
 233     list2 = list2->next;
 234   }
 235
 236   return list1 == NULL && list2 == NULL;
 237 }
 238
 239 static gboolean
 240 g_emblemed_icon_to_tokens (GIcon *icon,
 241                            GPtrArray *tokens,
 242                            gint  *out_version)
 243 {
 244   GEmblemedIcon *emblemed_icon = G_EMBLEMED_ICON (icon);
 245   GList *l;
 246   char *s;
 247
 248   /* GEmblemedIcons are encoded as
 249    *
 250    *   <encoded_icon> [<encoded_emblem_icon>]*
 251    */
 252
 253   g_return_val_if_fail (out_version != NULL, FALSE);
 254
 255   *out_version = 0;
 256
 257   s = g_icon_to_string (emblemed_icon->icon);
 258   if (s == NULL)
 259     return FALSE;
 260
 261   g_ptr_array_add (tokens, s);
 262
 263   for (l = emblemed_icon->emblems; l != NULL; l = l->next)
 264     {
 265       GIcon *emblem_icon = G_ICON (l->data);
 266
 267       s = g_icon_to_string (emblem_icon);
 268       if (s == NULL)
 269         return FALSE;
 270
 271       g_ptr_array_add (tokens, s);
 272     }
 273
 274   return TRUE;
 275 }
 276
 277 static GIcon *
 278 g_emblemed_icon_from_tokens (gchar  **tokens,
 279                              gint     num_tokens,
 280                              gint     version,
 281                              GError **error)
 282 {
 283   GEmblemedIcon *emblemed_icon;
 284   int n;
 285
 286   emblemed_icon = NULL;
 287
 288   if (version != 0)
 289     {
 290       g_set_error (error,
 291                    G_IO_ERROR,
 292                    G_IO_ERROR_INVALID_ARGUMENT,
 293                    _("Can't handle version %d of GEmblemedIcon encoding"),
 294                    version);
 295       goto fail;
 296     }
 297
 298   if (num_tokens < 1)
 299     {
 300       g_set_error (error,
 301                    G_IO_ERROR,
 302                    G_IO_ERROR_INVALID_ARGUMENT,
 303                    _("Malformed number of tokens (%d) in GEmblemedIcon encoding"),
 304                    num_tokens);
 305       goto fail;
 306     }
 307
 308   emblemed_icon = g_object_new (G_TYPE_EMBLEMED_ICON, NULL);
 309   emblemed_icon->icon = g_icon_new_for_string (tokens[0], error);
 310   if (emblemed_icon->icon == NULL)
 311     goto fail;
 312
 313   for (n = 1; n < num_tokens; n++)
 314     {
 315       GIcon *emblem;
 316
 317       emblem = g_icon_new_for_string (tokens[n], error);
 318       if (emblem == NULL)
 319         goto fail;
 320
 321       if (!G_IS_EMBLEM (emblem))
 322         {
 323           g_set_error_literal (error,
 324                                G_IO_ERROR,
 325                                G_IO_ERROR_INVALID_ARGUMENT,
 326                                _("Expected a GEmblem for GEmblemedIcon"));
 327           g_object_unref (emblem);
 328           goto fail;
 329         }
 330
 331       emblemed_icon->emblems = g_list_append (emblemed_icon->emblems, emblem);
 332     }
 333
 334   return G_ICON (emblemed_icon);
 335
 336  fail:
 337   if (emblemed_icon != NULL)
 338     g_object_unref (emblemed_icon);
 339   return NULL;
 340 }
 341
 342 static void
 343 g_emblemed_icon_icon_iface_init (GIconIface *iface)
 344 {
 345   iface->hash = g_emblemed_icon_hash;
 346   iface->equal = g_emblemed_icon_equal;
 347   iface->to_tokens = g_emblemed_icon_to_tokens;
 348   iface->from_tokens = g_emblemed_icon_from_tokens;
 349 }