gthemedicon.c 14.2 KB
Newer Older
1 2 3 4 5 6 7
/* GIO - GLib Input, Output and Streaming Library
 * 
 * Copyright (C) 2006-2007 Red Hat, Inc.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
8
 * version 2.1 of the License, or (at your option) any later version.
9 10 11 12 13 14 15
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General
16
 * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
17 18 19 20
 *
 * Author: Alexander Larsson <alexl@redhat.com>
 */

21
#include "config.h"
22

23 24
#include <string.h>

25
#include "gthemedicon.h"
26
#include "gicon.h"
27
#include "gioerror.h"
28
#include "glibintl.h"
29

30

31 32
/**
 * SECTION:gthemedicon
Matthias Clasen's avatar
Matthias Clasen committed
33
 * @short_description: Icon theming support
Matthias Clasen's avatar
Matthias Clasen committed
34
 * @include: gio/gio.h
35
 * @see_also: #GIcon, #GLoadableIcon
36
 *
37 38 39 40
 * #GThemedIcon is an implementation of #GIcon that supports icon themes.
 * #GThemedIcon contains a list of all of the icons present in an icon
 * theme, so that icons can be looked up quickly. #GThemedIcon does
 * not provide actual pixmaps for icons, just the icon names.
41 42 43
 * Ideally something like gtk_icon_theme_choose_icon() should be used to
 * resolve the list of names so that fallback icons work nicely with
 * themes that inherit other themes.
44 45
 **/

46
static void g_themed_icon_icon_iface_init (GIconIface *iface);
47 48 49 50 51

struct _GThemedIcon
{
  GObject parent_instance;
  
52 53
  char     **names;
  gboolean   use_default_fallbacks;
54 55 56 57 58 59 60
};

struct _GThemedIconClass
{
  GObjectClass parent_class;
};

61 62 63 64 65 66 67 68
enum
{
  PROP_0,
  PROP_NAME,
  PROP_NAMES,
  PROP_USE_DEFAULT_FALLBACKS
};

69 70 71
G_DEFINE_TYPE_WITH_CODE (GThemedIcon, g_themed_icon, G_TYPE_OBJECT,
			 G_IMPLEMENT_INTERFACE (G_TYPE_ICON,
						g_themed_icon_icon_iface_init))
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86

static void
g_themed_icon_get_property (GObject    *object,
                            guint       prop_id,
                            GValue     *value,
                            GParamSpec *pspec)
{
  GThemedIcon *icon = G_THEMED_ICON (object);

  switch (prop_id)
    {
      case PROP_NAMES:
        g_value_set_boxed (value, icon->names);
        break;

87 88 89 90
      case PROP_USE_DEFAULT_FALLBACKS:
        g_value_set_boolean (value, icon->use_default_fallbacks);
        break;

91 92 93 94 95 96 97 98 99 100 101 102
      default:
        G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
    }
}

static void
g_themed_icon_set_property (GObject      *object,
                            guint         prop_id,
                            const GValue *value,
                            GParamSpec   *pspec)
{
  GThemedIcon *icon = G_THEMED_ICON (object);
103 104
  gchar **names;
  const gchar *name;
105 106 107 108

  switch (prop_id)
    {
      case PROP_NAME:
109 110 111 112 113
        name = g_value_get_string (value);

        if (!name)
          break;

114 115
        if (icon->names)
          g_strfreev (icon->names);
116

117
        icon->names = g_new (char *, 2);
118
        icon->names[0] = g_strdup (name);
119 120 121 122
        icon->names[1] = NULL;
        break;

      case PROP_NAMES:
123 124 125 126 127
        names = g_value_dup_boxed (value);

        if (!names)
          break;

128 129
        if (icon->names)
          g_strfreev (icon->names);
130 131

        icon->names = names;
132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155
        break;

      case PROP_USE_DEFAULT_FALLBACKS:
        icon->use_default_fallbacks = g_value_get_boolean (value);
        break;

      default:
        G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
    }
}

static void
g_themed_icon_constructed (GObject *object)
{
  GThemedIcon *themed = G_THEMED_ICON (object);

  g_return_if_fail (themed->names != NULL && themed->names[0] != NULL);

  if (themed->use_default_fallbacks)
    {
      int i = 0, dashes = 0;
      const char *p;
      char *dashp;
      char *last;
156 157 158
      gboolean is_symbolic;
      char *name;
      char **names;
159

160 161 162 163 164 165 166
      is_symbolic = g_str_has_suffix (themed->names[0], "-symbolic");
      if (is_symbolic)
        name = g_strndup (themed->names[0], strlen (themed->names[0]) - 9);
      else
        name = g_strdup (themed->names[0]);

      p = name;
167 168 169 170 171 172 173
      while (*p)
        {
          if (*p == '-')
            dashes++;
          p++;
        }

174
      last = name;
175 176 177

      g_strfreev (themed->names);

178 179
      names = g_new (char *, dashes + 1 + 1);
      names[i++] = last;
180 181

      while ((dashp = strrchr (last, '-')) != NULL)
182 183 184 185 186 187
        names[i++] = last = g_strndup (last, dashp - last);

      names[i++] = NULL;

      if (is_symbolic)
        {
188
          themed->names = g_new (char *, 2 * dashes + 3);
189
          for (i = 0; names[i] != NULL; i++)
190 191 192 193
            {
              themed->names[i] = g_strconcat (names[i], "-symbolic", NULL);
              themed->names[dashes + 1 + i] = names[i];
            }
194

195 196
          themed->names[dashes + 1 + i] = NULL;
          g_free (names);
197 198 199 200 201
        }
      else
        {
          themed->names = names;
        }
202 203 204
    }
}

205 206 207 208 209 210 211 212
static void
g_themed_icon_finalize (GObject *object)
{
  GThemedIcon *themed;

  themed = G_THEMED_ICON (object);

  g_strfreev (themed->names);
213 214

  G_OBJECT_CLASS (g_themed_icon_parent_class)->finalize (object);
215 216 217 218 219 220 221 222
}

static void
g_themed_icon_class_init (GThemedIconClass *klass)
{
  GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
  
  gobject_class->finalize = g_themed_icon_finalize;
223 224 225 226 227 228 229 230 231
  gobject_class->constructed = g_themed_icon_constructed;
  gobject_class->set_property = g_themed_icon_set_property;
  gobject_class->get_property = g_themed_icon_get_property;

  /**
   * GThemedIcon:name:
   *
   * The icon name.
   */
232
  g_object_class_install_property (gobject_class, PROP_NAME,
233
                                   g_param_spec_string ("name",
234 235
                                                        P_("name"),
                                                        P_("The name of the icon"),
236 237 238 239 240 241 242 243 244 245
                                                        NULL,
                                                        G_PARAM_CONSTRUCT_ONLY | G_PARAM_WRITABLE | G_PARAM_STATIC_NAME | G_PARAM_STATIC_BLURB | G_PARAM_STATIC_NICK));

  /**
   * GThemedIcon:names:
   *
   * A %NULL-terminated array of icon names.
   */
  g_object_class_install_property (gobject_class, PROP_NAMES,
                                   g_param_spec_boxed ("names",
246 247
                                                       P_("names"),
                                                       P_("An array containing the icon names"),
248 249 250 251 252 253 254 255 256 257 258 259
                                                       G_TYPE_STRV,
                                                       G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE | G_PARAM_STATIC_NAME | G_PARAM_STATIC_BLURB | G_PARAM_STATIC_NICK));

  /**
   * GThemedIcon:use-default-fallbacks:
   *
   * Whether to use the default fallbacks found by shortening the icon name 
   * at '-' characters. If the "names" array has more than one element, 
   * ignores any past the first.
   *
   * For example, if the icon name was "gnome-dev-cdrom-audio", the array 
   * would become
260
   * |[<!-- language="C" -->
261 262 263 264 265 266 267 268 269 270 271
   * {
   *   "gnome-dev-cdrom-audio",
   *   "gnome-dev-cdrom",
   *   "gnome-dev",
   *   "gnome",
   *   NULL
   * };
   * ]|
   */
  g_object_class_install_property (gobject_class, PROP_USE_DEFAULT_FALLBACKS,
                                   g_param_spec_boolean ("use-default-fallbacks",
272
                                                         P_("use default fallbacks"),
273
                                                         P_("Whether to use default fallbacks found by shortening the name at “-” characters. Ignores names after the first if multiple names are given."),
274
                                                         FALSE,
275
                                                         G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE | G_PARAM_STATIC_NAME | G_PARAM_STATIC_BLURB | G_PARAM_STATIC_NICK));
276 277 278 279 280
}

static void
g_themed_icon_init (GThemedIcon *themed)
{
281
  themed->names = NULL;
282 283 284 285
}

/**
 * g_themed_icon_new:
286
 * @iconname: a string containing an icon name.
287
 * 
288 289
 * Creates a new themed icon for @iconname.
 * 
290
 * Returns: (transfer full) (type GThemedIcon): a new #GThemedIcon.
291 292 293 294 295 296
 **/
GIcon *
g_themed_icon_new (const char *iconname)
{
  g_return_val_if_fail (iconname != NULL, NULL);

297
  return G_ICON (g_object_new (G_TYPE_THEMED_ICON, "name", iconname, NULL));
298 299 300 301
}

/**
 * g_themed_icon_new_from_names:
302
 * @iconnames: (array length=len): an array of strings containing icon names.
303 304
 * @len: the length of the @iconnames array, or -1 if @iconnames is 
 *     %NULL-terminated
305 306
 * 
 * Creates a new themed icon for @iconnames.
307
 * 
308
 * Returns: (transfer full) (type GThemedIcon): a new #GThemedIcon
309 310
 **/
GIcon *
311
g_themed_icon_new_from_names (char **iconnames,
312
                              int    len)
313
{
314
  GIcon *icon;
315 316

  g_return_val_if_fail (iconnames != NULL, NULL);
317 318

  if (len >= 0)
319
    {
320 321 322
      char **names;
      int i;

323
      names = g_new (char *, len + 1);
324

325
      for (i = 0; i < len; i++)
326 327 328 329 330 331 332
        names[i] = iconnames[i];

      names[i] = NULL;

      icon = G_ICON (g_object_new (G_TYPE_THEMED_ICON, "names", names, NULL));

      g_free (names);
333
    }
334 335 336 337
  else
    icon = G_ICON (g_object_new (G_TYPE_THEMED_ICON, "names", iconnames, NULL));

  return icon;
338 339
}

Matthias Clasen's avatar
Matthias Clasen committed
340 341 342 343 344 345 346 347
/**
 * g_themed_icon_new_with_default_fallbacks:
 * @iconname: a string containing an icon name
 *
 * Creates a new themed icon for @iconname, and all the names
 * that can be created by shortening @iconname at '-' characters.
 * 
 * In the following example, @icon1 and @icon2 are equivalent:
348
 * |[<!-- language="C" -->
Matthias Clasen's avatar
Matthias Clasen committed
349 350 351 352 353 354 355 356 357 358 359
 * const char *names[] = { 
 *   "gnome-dev-cdrom-audio",
 *   "gnome-dev-cdrom",
 *   "gnome-dev",
 *   "gnome"
 * };
 *
 * icon1 = g_themed_icon_new_from_names (names, 4);
 * icon2 = g_themed_icon_new_with_default_fallbacks ("gnome-dev-cdrom-audio");
 * ]|
 *
360
 * Returns: (transfer full) (type GThemedIcon): a new #GThemedIcon.
Matthias Clasen's avatar
Matthias Clasen committed
361
 */
362 363 364 365 366
GIcon *
g_themed_icon_new_with_default_fallbacks (const char *iconname)
{
  g_return_val_if_fail (iconname != NULL, NULL);

367
  return G_ICON (g_object_new (G_TYPE_THEMED_ICON, "name", iconname, "use-default-fallbacks", TRUE, NULL));
368 369 370
}


371 372
/**
 * g_themed_icon_get_names:
373
 * @icon: a #GThemedIcon.
374
 *
375
 * Gets the names of icons from within @icon.
376
 *
377
 * Returns: (transfer none): a list of icon names.
378
 */
379 380 381 382 383 384 385
const char * const *
g_themed_icon_get_names (GThemedIcon *icon)
{
  g_return_val_if_fail (G_IS_THEMED_ICON (icon), NULL);
  return (const char * const *)icon->names;
}

386 387 388 389 390 391
/**
 * g_themed_icon_append_name:
 * @icon: a #GThemedIcon
 * @iconname: name of icon to append to list of icons from within @icon.
 *
 * Append a name to the list of icons from within @icon.
392 393 394
 *
 * Note that doing so invalidates the hash computed by prior calls
 * to g_icon_hash().
395 396
 */
void
397 398
g_themed_icon_append_name (GThemedIcon *icon, 
                           const char  *iconname)
399 400 401 402 403 404 405 406 407 408
{
  guint num_names;

  g_return_if_fail (G_IS_THEMED_ICON (icon));
  g_return_if_fail (iconname != NULL);

  num_names = g_strv_length (icon->names);
  icon->names = g_realloc (icon->names, sizeof (char*) * (num_names + 2));
  icon->names[num_names] = g_strdup (iconname);
  icon->names[num_names + 1] = NULL;
409 410

  g_object_notify (G_OBJECT (icon), "names");
411 412
}

413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448
/**
 * g_themed_icon_prepend_name:
 * @icon: a #GThemedIcon
 * @iconname: name of icon to prepend to list of icons from within @icon.
 *
 * Prepend a name to the list of icons from within @icon.
 *
 * Note that doing so invalidates the hash computed by prior calls
 * to g_icon_hash().
 *
 * Since: 2.18
 */
void
g_themed_icon_prepend_name (GThemedIcon *icon, 
                            const char  *iconname)
{
  guint num_names;
  gchar **names;
  gint i;

  g_return_if_fail (G_IS_THEMED_ICON (icon));
  g_return_if_fail (iconname != NULL);

  num_names = g_strv_length (icon->names);
  names = g_new (char*, num_names + 2);
  for (i = 0; icon->names[i]; i++)
    names[i + 1] = icon->names[i];
  names[0] = g_strdup (iconname);
  names[num_names + 1] = NULL;

  g_free (icon->names);
  icon->names = names;

  g_object_notify (G_OBJECT (icon), "names");
}

449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465
static guint
g_themed_icon_hash (GIcon *icon)
{
  GThemedIcon *themed = G_THEMED_ICON (icon);
  guint hash;
  int i;

  hash = 0;

  for (i = 0; themed->names[i] != NULL; i++)
    hash ^= g_str_hash (themed->names[i]);
  
  return hash;
}

static gboolean
g_themed_icon_equal (GIcon *icon1,
466
                     GIcon *icon2)
467 468 469 470 471 472 473 474 475 476 477 478 479 480
{
  GThemedIcon *themed1 = G_THEMED_ICON (icon1);
  GThemedIcon *themed2 = G_THEMED_ICON (icon2);
  int i;

  for (i = 0; themed1->names[i] != NULL && themed2->names[i] != NULL; i++)
    {
      if (!g_str_equal (themed1->names[i], themed2->names[i]))
	return FALSE;
    }

  return themed1->names[i] == NULL && themed2->names[i] == NULL;
}

481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510

static gboolean
g_themed_icon_to_tokens (GIcon *icon,
			 GPtrArray *tokens,
                         gint  *out_version)
{
  GThemedIcon *themed_icon = G_THEMED_ICON (icon);
  int n;

  g_return_val_if_fail (out_version != NULL, FALSE);

  *out_version = 0;

  for (n = 0; themed_icon->names[n] != NULL; n++)
    g_ptr_array_add (tokens,
		     g_strdup (themed_icon->names[n]));
  
  return TRUE;
}

static GIcon *
g_themed_icon_from_tokens (gchar  **tokens,
                           gint     num_tokens,
                           gint     version,
                           GError **error)
{
  GIcon *icon;
  gchar **names;
  int n;

511 512 513 514 515 516 517
  icon = NULL;

  if (version != 0)
    {
      g_set_error (error,
                   G_IO_ERROR,
                   G_IO_ERROR_INVALID_ARGUMENT,
518
                   _("Can’t handle version %d of GThemedIcon encoding"),
519 520 521
                   version);
      goto out;
    }
522 523 524 525 526 527 528 529 530
  
  names = g_new0 (gchar *, num_tokens + 1);
  for (n = 0; n < num_tokens; n++)
    names[n] = tokens[n];
  names[n] = NULL;

  icon = g_themed_icon_new_from_names (names, num_tokens);
  g_free (names);

531
 out:
532 533 534
  return icon;
}

535 536 537 538 539 540 541 542
static GVariant *
g_themed_icon_serialize (GIcon *icon)
{
  GThemedIcon *themed_icon = G_THEMED_ICON (icon);

  return g_variant_new ("(sv)", "themed", g_variant_new ("^as", themed_icon->names));
}

543 544 545 546 547
static void
g_themed_icon_icon_iface_init (GIconIface *iface)
{
  iface->hash = g_themed_icon_hash;
  iface->equal = g_themed_icon_equal;
548 549
  iface->to_tokens = g_themed_icon_to_tokens;
  iface->from_tokens = g_themed_icon_from_tokens;
550
  iface->serialize = g_themed_icon_serialize;
551
}