gio/gicon.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 #include <stdlib.h>
  25 #include <string.h>
  26
  27 #include "gicon.h"
  28 #include "gthemedicon.h"
  29 #include "gfileicon.h"
  30 #include "gemblemedicon.h"
  31 #include "gfile.h"
  32 #include "gioerror.h"
  33
  34 #include "glibintl.h"
  35
  36
  37 /* There versioning of this is implicit, version 1 would be ".1 " */
  38 #define G_ICON_SERIALIZATION_MAGIC0 ". "
  39
  40 /**
  41  * SECTION:gicon
  42  * @short_description: Interface for icons
  43  * @include: gio/gio.h
  44  *
  45  * #GIcon is a very minimal interface for icons. It provides functions
  46  * for checking the equality of two icons, hashing of icons and
  47  * serializing an icon to and from strings.
  48  *
  49  * #GIcon does not provide the actual pixmap for the icon as this is out
  50  * of GIO's scope, however implementations of #GIcon may contain the name
  51  * of an icon (see #GThemedIcon), or the path to an icon (see #GLoadableIcon).
  52  *
  53  * To obtain a hash of a #GIcon, see g_icon_hash().
  54  *
  55  * To check if two #GIcons are equal, see g_icon_equal().
  56  *
  57  * For serializing a #GIcon, use g_icon_to_string() and
  58  * g_icon_new_for_string().
  59  *
  60  * If your application or library provides one or more #GIcon
  61  * implementations you need to ensure that each #GType is registered
  62  * with the type system prior to calling g_icon_new_for_string().
  63  **/
  64
  65 typedef GIconIface GIconInterface;
  66 G_DEFINE_INTERFACE(GIcon, g_icon, G_TYPE_OBJECT)
  67
  68 static void
  69 g_icon_default_init (GIconInterface *iface)
  70 {
  71 }
  72
  73 /**
  74  * g_icon_hash:
  75  * @icon: #gconstpointer to an icon object.
  76  *
  77  * Gets a hash for an icon.
  78  *
  79  * Virtual: hash
  80  * Returns: a #guint containing a hash for the @icon, suitable for
  81  * use in a #GHashTable or similar data structure.
  82  **/
  83 guint
  84 g_icon_hash (gconstpointer icon)
  85 {
  86   GIconIface *iface;
  87
  88   g_return_val_if_fail (G_IS_ICON (icon), 0);
  89
  90   iface = G_ICON_GET_IFACE (icon);
  91
  92   return (* iface->hash) ((GIcon *)icon);
  93 }
  94
  95 /**
  96  * g_icon_equal:
  97  * @icon1: pointer to the first #GIcon.
  98  * @icon2: pointer to the second #GIcon.
  99  *
 100  * Checks if two icons are equal.
 101  *
 102  * Returns: %TRUE if @icon1 is equal to @icon2. %FALSE otherwise.
 103  **/
 104 gboolean
 105 g_icon_equal (GIcon *icon1,
 106               GIcon *icon2)
 107 {
 108   GIconIface *iface;
 109
 110   if (icon1 == NULL && icon2 == NULL)
 111     return TRUE;
 112
 113   if (icon1 == NULL || icon2 == NULL)
 114     return FALSE;
 115
 116   if (G_TYPE_FROM_INSTANCE (icon1) != G_TYPE_FROM_INSTANCE (icon2))
 117     return FALSE;
 118
 119   iface = G_ICON_GET_IFACE (icon1);
 120
 121   return (* iface->equal) (icon1, icon2);
 122 }
 123
 124 static gboolean
 125 g_icon_to_string_tokenized (GIcon *icon, GString *s)
 126 {
 127   char *ret;
 128   GPtrArray *tokens;
 129   gint version;
 130   GIconIface *icon_iface;
 131   int i;
 132
 133   g_return_val_if_fail (icon != NULL, FALSE);
 134   g_return_val_if_fail (G_IS_ICON (icon), FALSE);
 135
 136   ret = NULL;
 137
 138   icon_iface = G_ICON_GET_IFACE (icon);
 139   if (icon_iface->to_tokens == NULL)
 140     return FALSE;
 141
 142   tokens = g_ptr_array_new ();
 143   if (!icon_iface->to_tokens (icon, tokens, &version))
 144     {
 145       g_ptr_array_free (tokens, TRUE);
 146       return FALSE;
 147     }
 148
 149   /* format: TypeName[.Version] <token_0> .. <token_N-1>
 150      version 0 is implicit and can be omitted
 151      all the tokens are url escaped to ensure they have no spaces in them */
 152
 153   g_string_append (s, g_type_name_from_instance ((GTypeInstance *)icon));
 154   if (version != 0)
 155     g_string_append_printf (s, ".%d", version);
 156
 157   for (i = 0; i < tokens->len; i++)
 158     {
 159       char *token;
 160
 161       token = g_ptr_array_index (tokens, i);
 162
 163       g_string_append_c (s, ' ');
 164       /* We really only need to escape spaces here, so allow lots of otherwise reserved chars */
 165       g_string_append_uri_escaped (s, token,
 166                                    G_URI_RESERVED_CHARS_ALLOWED_IN_PATH, TRUE);
 167
 168       g_free (token);
 169     }
 170
 171   g_ptr_array_free (tokens, TRUE);
 172
 173   return TRUE;
 174 }
 175
 176 /**
 177  * g_icon_to_string:
 178  * @icon: a #GIcon.
 179  *
 180  * Generates a textual representation of @icon that can be used for
 181  * serialization such as when passing @icon to a different process or
 182  * saving it to persistent storage. Use g_icon_new_for_string() to
 183  * get @icon back from the returned string.
 184  *
 185  * The encoding of the returned string is proprietary to #GIcon except
 186  * in the following two cases
 187  *
 188  * <itemizedlist>
 189  * <listitem><para>
 190  *     If @icon is a #GFileIcon, the returned string is a native path
 191  *     (such as <literal>/path/to/my icon.png</literal>) without escaping
 192  *     if the #GFile for @icon is a native file.  If the file is not
 193  *     native, the returned string is the result of g_file_get_uri()
 194  *     (such as <literal>sftp://path/to/my%%20icon.png</literal>).
 195  * </para></listitem>
 196  * <listitem><para>
 197  *    If @icon is a #GThemedIcon with exactly one name, the encoding is
 198  *    simply the name (such as <literal>network-server</literal>).
 199  * </para></listitem>
 200  * </itemizedlist>
 201  *
 202  * Virtual: to_tokens
 203  * Returns: An allocated NUL-terminated UTF8 string or %NULL if @icon can't
 204  * be serialized. Use g_free() to free.
 205  *
 206  * Since: 2.20
 207  */
 208 gchar *
 209 g_icon_to_string (GIcon *icon)
 210 {
 211   gchar *ret;
 212
 213   g_return_val_if_fail (icon != NULL, NULL);
 214   g_return_val_if_fail (G_IS_ICON (icon), NULL);
 215
 216   ret = NULL;
 217
 218   if (G_IS_FILE_ICON (icon))
 219     {
 220       GFile *file;
 221
 222       file = g_file_icon_get_file (G_FILE_ICON (icon));
 223       if (g_file_is_native (file))
 224         {
 225           ret = g_file_get_path (file);
 226           if (!g_utf8_validate (ret, -1, NULL))
 227             {
 228               g_free (ret);
 229               ret = NULL;
 230             }
 231         }
 232       else
 233         ret = g_file_get_uri (file);
 234     }
 235   else if (G_IS_THEMED_ICON (icon))
 236     {
 237       const char * const *names;
 238
 239       names = g_themed_icon_get_names (G_THEMED_ICON (icon));
 240       if (names != NULL &&
 241           names[0] != NULL &&
 242           names[0][0] != '.' && /* Allowing icons starting with dot would break G_ICON_SERIALIZATION_MAGIC0 */
 243           g_utf8_validate (names[0], -1, NULL) && /* Only return utf8 strings */
 244           names[1] == NULL)
 245         ret = g_strdup (names[0]);
 246     }
 247
 248   if (ret == NULL)
 249     {
 250       GString *s;
 251
 252       s = g_string_new (G_ICON_SERIALIZATION_MAGIC0);
 253
 254       if (g_icon_to_string_tokenized (icon, s))
 255         ret = g_string_free (s, FALSE);
 256       else
 257         g_string_free (s, TRUE);
 258     }
 259
 260   return ret;
 261 }
 262
 263 static GIcon *
 264 g_icon_new_from_tokens (char   **tokens,
 265                         GError **error)
 266 {
 267   GIcon *icon;
 268   char *typename, *version_str;
 269   GType type;
 270   gpointer klass;
 271   GIconIface *icon_iface;
 272   gint version;
 273   char *endp;
 274   int num_tokens;
 275   int i;
 276
 277   icon = NULL;
 278   klass = NULL;
 279
 280   num_tokens = g_strv_length (tokens);
 281
 282   if (num_tokens < 1)
 283     {
 284       g_set_error (error,
 285                    G_IO_ERROR,
 286                    G_IO_ERROR_INVALID_ARGUMENT,
 287                    _("Wrong number of tokens (%d)"),
 288                    num_tokens);
 289       goto out;
 290     }
 291
 292   typename = tokens[0];
 293   version_str = strchr (typename, '.');
 294   if (version_str)
 295     {
 296       *version_str = 0;
 297       version_str += 1;
 298     }
 299
 300
 301   type = g_type_from_name (tokens[0]);
 302   if (type == 0)
 303     {
 304       g_set_error (error,
 305                    G_IO_ERROR,
 306                    G_IO_ERROR_INVALID_ARGUMENT,
 307                    _("No type for class name %s"),
 308                    tokens[0]);
 309       goto out;
 310     }
 311
 312   if (!g_type_is_a (type, G_TYPE_ICON))
 313     {
 314       g_set_error (error,
 315                    G_IO_ERROR,
 316                    G_IO_ERROR_INVALID_ARGUMENT,
 317                    _("Type %s does not implement the GIcon interface"),
 318                    tokens[0]);
 319       goto out;
 320     }
 321
 322   klass = g_type_class_ref (type);
 323   if (klass == NULL)
 324     {
 325       g_set_error (error,
 326                    G_IO_ERROR,
 327                    G_IO_ERROR_INVALID_ARGUMENT,
 328                    _("Type %s is not classed"),
 329                    tokens[0]);
 330       goto out;
 331     }
 332
 333   version = 0;
 334   if (version_str)
 335     {
 336       version = strtol (version_str, &endp, 10);
 337       if (endp == NULL || *endp != '\0')
 338         {
 339           g_set_error (error,
 340                        G_IO_ERROR,
 341                        G_IO_ERROR_INVALID_ARGUMENT,
 342                        _("Malformed version number: %s"),
 343                        version_str);
 344           goto out;
 345         }
 346     }
 347
 348   icon_iface = g_type_interface_peek (klass, G_TYPE_ICON);
 349   g_assert (icon_iface != NULL);
 350
 351   if (icon_iface->from_tokens == NULL)
 352     {
 353       g_set_error (error,
 354                    G_IO_ERROR,
 355                    G_IO_ERROR_INVALID_ARGUMENT,
 356                    _("Type %s does not implement from_tokens() on the GIcon interface"),
 357                    tokens[0]);
 358       goto out;
 359     }
 360
 361   for (i = 1;  i < num_tokens; i++)
 362     {
 363       char *escaped;
 364
 365       escaped = tokens[i];
 366       tokens[i] = g_uri_unescape_string (escaped, NULL);
 367       g_free (escaped);
 368     }
 369
 370   icon = icon_iface->from_tokens (tokens + 1, num_tokens - 1, version, error);
 371
 372  out:
 373   if (klass != NULL)
 374     g_type_class_unref (klass);
 375   return icon;
 376 }
 377
 378 static void
 379 ensure_builtin_icon_types (void)
 380 {
 381   static volatile GType t;
 382   t = g_themed_icon_get_type ();
 383   t = g_file_icon_get_type ();
 384   t = g_emblemed_icon_get_type ();
 385   t = g_emblem_get_type ();
 386 }
 387
 388 /**
 389  * g_icon_new_for_string:
 390  * @str: A string obtained via g_icon_to_string().
 391  * @error: Return location for error.
 392  *
 393  * Generate a #GIcon instance from @str. This function can fail if
 394  * @str is not valid - see g_icon_to_string() for discussion.
 395  *
 396  * If your application or library provides one or more #GIcon
 397  * implementations you need to ensure that each #GType is registered
 398  * with the type system prior to calling g_icon_new_for_string().
 399  *
 400  * Returns: (transfer full): An object implementing the #GIcon
 401  *          interface or %NULL if @error is set.
 402  *
 403  * Since: 2.20
 404  **/
 405 GIcon *
 406 g_icon_new_for_string (const gchar   *str,
 407                        GError       **error)
 408 {
 409   GIcon *icon;
 410
 411   g_return_val_if_fail (str != NULL, NULL);
 412
 413   ensure_builtin_icon_types ();
 414
 415   icon = NULL;
 416
 417   if (*str == '.')
 418     {
 419       if (g_str_has_prefix (str, G_ICON_SERIALIZATION_MAGIC0))
 420         {
 421           gchar **tokens;
 422
 423           /* handle tokenized encoding */
 424           tokens = g_strsplit (str + sizeof (G_ICON_SERIALIZATION_MAGIC0) - 1, " ", 0);
 425           icon = g_icon_new_from_tokens (tokens, error);
 426           g_strfreev (tokens);
 427         }
 428       else
 429         g_set_error_literal (error,
 430                              G_IO_ERROR,
 431                              G_IO_ERROR_INVALID_ARGUMENT,
 432                              _("Can't handle the supplied version the icon encoding"));
 433     }
 434   else
 435     {
 436       gchar *scheme;
 437
 438       /* handle special GFileIcon and GThemedIcon cases */
 439       scheme = g_uri_parse_scheme (str);
 440       if (scheme != NULL || str[0] == '/')
 441         {
 442           GFile *location;
 443           location = g_file_new_for_commandline_arg (str);
 444           icon = g_file_icon_new (location);
 445           g_object_unref (location);
 446         }
 447       else
 448         icon = g_themed_icon_new (str);
 449       g_free (scheme);
 450     }
 451
 452   return icon;
 453 }