gtkiconcache.c 13.3 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
/* gtkiconcache.c
 * Copyright (C) 2004  Anders Carlsson <andersca@gnome.org>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * 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
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 */

20
#include "config.h"
Matthias Clasen's avatar
Matthias Clasen committed
21

22 23
#include "gtkdebug.h"
#include "gtkiconcache.h"
24
#include "gtkiconcachevalidator.h"
25 26
#include "gtkalias.h"

27
#include <glib/gstdio.h>
Anders Carlsson's avatar
Anders Carlsson committed
28
#include <gdk-pixbuf/gdk-pixdata.h>
29 30 31 32

#ifdef HAVE_UNISTD_H
#include <unistd.h>
#endif
33 34 35
#ifdef G_OS_WIN32
#include <io.h>
#endif
36
#include <fcntl.h>
Matthias Clasen's avatar
Matthias Clasen committed
37 38
#include <sys/types.h>
#include <sys/stat.h>
39 40
#include <string.h>

Matthias Clasen's avatar
Matthias Clasen committed
41

42 43 44 45
#ifndef _O_BINARY
#define _O_BINARY 0
#endif

46 47 48 49 50 51
#define MAJOR_VERSION 1
#define MINOR_VERSION 0

#define GET_UINT16(cache, offset) (GUINT16_FROM_BE (*(guint16 *)((cache) + (offset))))
#define GET_UINT32(cache, offset) (GUINT32_FROM_BE (*(guint32 *)((cache) + (offset))))

52

53 54 55
struct _GtkIconCache {
  gint ref_count;

Matthias Clasen's avatar
Matthias Clasen committed
56
  GMappedFile *map;
57
  gchar *buffer;
58 59

  guint32 last_chain_offset;
60 61 62 63 64
};

GtkIconCache *
_gtk_icon_cache_ref (GtkIconCache *cache)
{
65
  cache->ref_count++;
66 67 68 69 70 71 72 73 74 75 76 77
  return cache;
}

void
_gtk_icon_cache_unref (GtkIconCache *cache)
{
  cache->ref_count --;

  if (cache->ref_count == 0)
    {
      GTK_NOTE (ICONTHEME, 
		g_print ("unmapping icon cache\n"));
Matthias Clasen's avatar
Matthias Clasen committed
78

79
      if (cache->map)
80
	g_mapped_file_unref (cache->map);
81 82 83 84 85 86 87
      g_free (cache);
    }
}

GtkIconCache *
_gtk_icon_cache_new_for_path (const gchar *path)
{
88
  GtkIconCache *cache = NULL;
Matthias Clasen's avatar
Matthias Clasen committed
89
  GMappedFile *map;
90

91
  gchar *cache_filename;
92
  gint fd = -1;
93 94
  struct stat st;
  struct stat path_st;
95
  CacheInfo info;
96

97
   /* Check if we have a cache file */
98 99 100 101 102
  cache_filename = g_build_filename (path, "icon-theme.cache", NULL);

  GTK_NOTE (ICONTHEME, 
	    g_print ("look for cache in %s\n", path));

103 104 105 106 107
  if (g_stat (path, &path_st) < 0)
    goto done;

  /* Open the file and map it into memory */
  fd = g_open (cache_filename, O_RDONLY|_O_BINARY, 0);
108 109

  if (fd < 0)
Matthias Clasen's avatar
Matthias Clasen committed
110
    goto done;
111
  
112
  if (fstat (fd, &st) < 0 || st.st_size < 4)
113 114 115 116 117 118 119 120 121 122
    goto done;

  /* Verify cache is uptodate */
  if (st.st_mtime < path_st.st_mtime)
    {
      GTK_NOTE (ICONTHEME, 
		g_print ("cache outdated\n"));
      goto done; 
    }

Matthias Clasen's avatar
Matthias Clasen committed
123
  map = g_mapped_file_new (cache_filename, FALSE, NULL);
124

Matthias Clasen's avatar
Matthias Clasen committed
125
  if (!map)
126 127
    goto done;

128 129 130 131 132
  info.cache = g_mapped_file_get_contents (map);
  info.cache_size = g_mapped_file_get_length (map);
  info.n_directories = 0;
  info.flags = CHECK_OFFSETS|CHECK_STRINGS;

133 134
#ifdef G_ENABLE_DEBUG
  if (gtk_debug_flags & GTK_DEBUG_ICONTHEME)
135
    {
136 137
      if (!_gtk_icon_cache_validate (&info))
        {
138
          g_mapped_file_unref (map);
139
          g_warning ("Icon cache '%s' is invalid\n", cache_filename);
Matthias Clasen's avatar
Matthias Clasen committed
140

141 142
          goto done;
        }
143
    }
144 145
#endif 

146
  GTK_NOTE (ICONTHEME, g_print ("found cache for %s\n", path));
147 148 149

  cache = g_new0 (GtkIconCache, 1);
  cache->ref_count = 1;
Matthias Clasen's avatar
Matthias Clasen committed
150
  cache->map = map;
151
  cache->buffer = g_mapped_file_get_contents (map);
Matthias Clasen's avatar
Matthias Clasen committed
152

153
 done:
154
  g_free (cache_filename);  
Matthias Clasen's avatar
Matthias Clasen committed
155
  if (fd >= 0)
156
    close (fd);
157 158 159 160

  return cache;
}

161 162 163 164 165 166 167 168 169 170 171 172 173 174
GtkIconCache *
_gtk_icon_cache_new (const gchar *data)
{
  GtkIconCache *cache;

  cache = g_new0 (GtkIconCache, 1);
  cache->ref_count = 1;
  cache->map = NULL;
  cache->buffer = (gchar *)data;
  
  return cache;
}

static gint
175 176 177 178
get_directory_index (GtkIconCache *cache,
		     const gchar *directory)
{
  guint32 dir_list_offset;
179 180
  gint n_dirs;
  gint i;
181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196
  
  dir_list_offset = GET_UINT32 (cache->buffer, 8);

  n_dirs = GET_UINT32 (cache->buffer, dir_list_offset);

  for (i = 0; i < n_dirs; i++)
    {
      guint32 name_offset = GET_UINT32 (cache->buffer, dir_list_offset + 4 + 4 * i);
      gchar *name = cache->buffer + name_offset;
      if (strcmp (name, directory) == 0)
	return i;
    }
  
  return -1;
}

197 198 199
gint
_gtk_icon_cache_get_directory_index (GtkIconCache *cache,
			             const gchar *directory)
200
{
201
  return get_directory_index (cache, directory);
202 203 204 205 206
}

static guint
icon_name_hash (gconstpointer key)
{
207 208
  const signed char *p = key;
  guint32 h = *p;
209 210 211 212 213 214 215 216

  if (h)
    for (p += 1; *p != '\0'; p++)
      h = (h << 5) - h + *p;

  return h;
}

217
static gint
Anders Carlsson's avatar
Anders Carlsson committed
218 219
find_image_offset (GtkIconCache *cache,
		   const gchar  *icon_name,
220
		   gint          directory_index)
221 222 223 224
{
  guint32 hash_offset;
  guint32 n_buckets;
  guint32 chain_offset;
225
  int hash;
226 227
  guint32 image_list_offset, n_images;
  int i;
228 229 230 231 232 233 234 235 236 237 238

  chain_offset = cache->last_chain_offset;
  if (chain_offset)
    {
      guint32 name_offset = GET_UINT32 (cache->buffer, chain_offset + 4);
      gchar *name = cache->buffer + name_offset;

      if (strcmp (name, icon_name) == 0)
        goto find_dir;
    }

239 240 241 242 243 244 245 246 247 248 249
  hash_offset = GET_UINT32 (cache->buffer, 4);
  n_buckets = GET_UINT32 (cache->buffer, hash_offset);
  hash = icon_name_hash (icon_name) % n_buckets;

  chain_offset = GET_UINT32 (cache->buffer, hash_offset + 4 + 4 * hash);
  while (chain_offset != 0xffffffff)
    {
      guint32 name_offset = GET_UINT32 (cache->buffer, chain_offset + 4);
      gchar *name = cache->buffer + name_offset;

      if (strcmp (name, icon_name) == 0)
250 251 252
        {
          cache->last_chain_offset = chain_offset;
          goto find_dir;
253
	}
254
  
255 256 257
      chain_offset = GET_UINT32 (cache->buffer, chain_offset);
    }

258 259
  cache->last_chain_offset = 0;
  return 0;
260

261
find_dir:
262 263 264 265 266 267 268
  /* We've found an icon list, now check if we have the right icon in it */
  image_list_offset = GET_UINT32 (cache->buffer, chain_offset + 8);
  n_images = GET_UINT32 (cache->buffer, image_list_offset);
  
  for (i = 0; i < n_images; i++)
    {
      if (GET_UINT16 (cache->buffer, image_list_offset + 4 + 8 * i) ==
Anders Carlsson's avatar
Anders Carlsson committed
269 270
	  directory_index) 
	return image_list_offset + 4 + 8 * i;
271
    }
Anders Carlsson's avatar
Anders Carlsson committed
272

273 274 275
  return 0;
}

Anders Carlsson's avatar
Anders Carlsson committed
276 277 278
gint
_gtk_icon_cache_get_icon_flags (GtkIconCache *cache,
				const gchar  *icon_name,
279
				gint          directory_index)
Anders Carlsson's avatar
Anders Carlsson committed
280 281 282
{
  guint32 image_offset;

283
  image_offset = find_image_offset (cache, icon_name, directory_index);
Anders Carlsson's avatar
Anders Carlsson committed
284 285 286 287 288 289 290

  if (!image_offset)
    return 0;

  return GET_UINT16 (cache->buffer, image_offset + 2);
}

291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308
void
_gtk_icon_cache_add_icons (GtkIconCache *cache,
			   const gchar  *directory,
			   GHashTable   *hash_table)
{
  int directory_index;
  guint32 hash_offset, n_buckets;
  guint32 chain_offset;
  guint32 image_list_offset, n_images;
  int i, j;
  
  directory_index = get_directory_index (cache, directory);

  if (directory_index == -1)
    return;
  
  hash_offset = GET_UINT32 (cache->buffer, 4);
  n_buckets = GET_UINT32 (cache->buffer, hash_offset);
Anders Carlsson's avatar
Anders Carlsson committed
309

310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329
  for (i = 0; i < n_buckets; i++)
    {
      chain_offset = GET_UINT32 (cache->buffer, hash_offset + 4 + 4 * i);
      while (chain_offset != 0xffffffff)
	{
	  guint32 name_offset = GET_UINT32 (cache->buffer, chain_offset + 4);
	  gchar *name = cache->buffer + name_offset;
	  
	  image_list_offset = GET_UINT32 (cache->buffer, chain_offset + 8);
	  n_images = GET_UINT32 (cache->buffer, image_list_offset);
  
	  for (j = 0; j < n_images; j++)
	    {
	      if (GET_UINT16 (cache->buffer, image_list_offset + 4 + 8 * j) ==
		  directory_index)
		g_hash_table_insert (hash_table, name, NULL);
	    }

	  chain_offset = GET_UINT32 (cache->buffer, chain_offset);
	}
330 331 332 333 334 335 336 337 338 339 340
    }  
}

gboolean
_gtk_icon_cache_has_icon (GtkIconCache *cache,
			  const gchar  *icon_name)
{
  guint32 hash_offset;
  guint32 n_buckets;
  guint32 chain_offset;
  gint hash;
341
  
342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359
  hash_offset = GET_UINT32 (cache->buffer, 4);
  n_buckets = GET_UINT32 (cache->buffer, hash_offset);

  hash = icon_name_hash (icon_name) % n_buckets;

  chain_offset = GET_UINT32 (cache->buffer, hash_offset + 4 + 4 * hash);
  while (chain_offset != 0xffffffff)
    {
      guint32 name_offset = GET_UINT32 (cache->buffer, chain_offset + 4);
      gchar *name = cache->buffer + name_offset;

      if (strcmp (name, icon_name) == 0)
	return TRUE;
	  
      chain_offset = GET_UINT32 (cache->buffer, chain_offset);
    }

  return FALSE;
360
}
361

362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417
gboolean
_gtk_icon_cache_has_icon_in_directory (GtkIconCache *cache,
				       const gchar  *icon_name,
				       const gchar  *directory)
{
  guint32 hash_offset;
  guint32 n_buckets;
  guint32 chain_offset;
  gint hash;
  gboolean found_icon = FALSE;
  gint directory_index;

  directory_index = get_directory_index (cache, directory);

  if (directory_index == -1)
    return FALSE;
  
  hash_offset = GET_UINT32 (cache->buffer, 4);
  n_buckets = GET_UINT32 (cache->buffer, hash_offset);

  hash = icon_name_hash (icon_name) % n_buckets;

  chain_offset = GET_UINT32 (cache->buffer, hash_offset + 4 + 4 * hash);
  while (chain_offset != 0xffffffff)
    {
      guint32 name_offset = GET_UINT32 (cache->buffer, chain_offset + 4);
      gchar *name = cache->buffer + name_offset;

      if (strcmp (name, icon_name) == 0)
	{
	  found_icon = TRUE;
	  break;
	}
	  
      chain_offset = GET_UINT32 (cache->buffer, chain_offset);
    }

  if (found_icon)
    {
      guint32 image_list_offset = GET_UINT32 (cache->buffer, chain_offset + 8);
      guint32 n_images =  GET_UINT32 (cache->buffer, image_list_offset);
      guint32 image_offset = image_list_offset + 4;
      gint i;
      for (i = 0; i < n_images; i++)
	{
	  guint16 index = GET_UINT16 (cache->buffer, image_offset);
	  
	  if (index == directory_index)
	    return TRUE;
	  image_offset += 8;
	}
    }

  return FALSE;
}

418 419 420 421 422 423 424 425 426
static void
pixbuf_destroy_cb (guchar   *pixels, 
		   gpointer  data)
{
  GtkIconCache *cache = data;

  _gtk_icon_cache_unref (cache);
}

Anders Carlsson's avatar
Anders Carlsson committed
427 428 429
GdkPixbuf *
_gtk_icon_cache_get_icon (GtkIconCache *cache,
			  const gchar  *icon_name,
430
			  gint          directory_index)
Anders Carlsson's avatar
Anders Carlsson committed
431 432 433 434 435 436 437
{
  guint32 offset, image_data_offset, pixel_data_offset;
  guint32 length, type;
  GdkPixbuf *pixbuf;
  GdkPixdata pixdata;
  GError *error = NULL;

438
  offset = find_image_offset (cache, icon_name, directory_index);
Anders Carlsson's avatar
Anders Carlsson committed
439 440 441 442 443 444 445 446 447 448 449 450 451
  
  image_data_offset = GET_UINT32 (cache->buffer, offset + 4);
  
  if (!image_data_offset)
    return NULL;

  pixel_data_offset = GET_UINT32 (cache->buffer, image_data_offset);

  type = GET_UINT32 (cache->buffer, pixel_data_offset);

  if (type != 0)
    {
      GTK_NOTE (ICONTHEME,
452
		g_print ("invalid pixel data type %u\n", type));
Anders Carlsson's avatar
Anders Carlsson committed
453 454 455 456 457 458
      return NULL;
    }

  length = GET_UINT32 (cache->buffer, pixel_data_offset + 4);
  
  if (!gdk_pixdata_deserialize (&pixdata, length, 
459
				(guchar *)(cache->buffer + pixel_data_offset + 8),
Anders Carlsson's avatar
Anders Carlsson committed
460 461 462 463 464 465 466 467 468
				&error))
    {
      GTK_NOTE (ICONTHEME,
		g_print ("could not deserialize data: %s\n", error->message));
      g_error_free (error);

      return NULL;
    }

469 470 471 472 473
  pixbuf = gdk_pixbuf_new_from_data (pixdata.pixel_data, GDK_COLORSPACE_RGB,
				     (pixdata.pixdata_type & GDK_PIXDATA_COLOR_TYPE_MASK) == GDK_PIXDATA_COLOR_TYPE_RGBA,
				     8, pixdata.width, pixdata.height, pixdata.rowstride,
				     (GdkPixbufDestroyNotify)pixbuf_destroy_cb, 
				     cache);
Anders Carlsson's avatar
Anders Carlsson committed
474 475 476 477 478 479 480 481 482
  if (!pixbuf)
    {
      GTK_NOTE (ICONTHEME,
		g_print ("could not convert pixdata to pixbuf: %s\n", error->message));
      g_error_free (error);

      return NULL;
    }

483 484
  _gtk_icon_cache_ref (cache);

Anders Carlsson's avatar
Anders Carlsson committed
485 486 487 488 489 490
  return pixbuf;
}

GtkIconData  *
_gtk_icon_cache_get_icon_data  (GtkIconCache *cache,
				const gchar  *icon_name,
491
				gint          directory_index)
Anders Carlsson's avatar
Anders Carlsson committed
492 493 494 495 496
{
  guint32 offset, image_data_offset, meta_data_offset;
  GtkIconData *data;
  int i;

497
  offset = find_image_offset (cache, icon_name, directory_index);
Anders Carlsson's avatar
Anders Carlsson committed
498 499 500 501 502 503 504 505 506 507 508 509
  if (!offset)
    return NULL;

  image_data_offset = GET_UINT32 (cache->buffer, offset + 4);
  if (!image_data_offset)
    return NULL;

  meta_data_offset = GET_UINT32 (cache->buffer, image_data_offset + 4);
  
  if (!meta_data_offset)
    return NULL;

510
  data = g_slice_new0 (GtkIconData);
Anders Carlsson's avatar
Anders Carlsson committed
511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567

  offset = GET_UINT32 (cache->buffer, meta_data_offset);
  if (offset)
    {
      data->has_embedded_rect = TRUE;
      data->x0 = GET_UINT16 (cache->buffer, offset);
      data->y0 = GET_UINT16 (cache->buffer, offset + 2);
      data->x1 = GET_UINT16 (cache->buffer, offset + 4);
      data->y1 = GET_UINT16 (cache->buffer, offset + 6);
    }

  offset = GET_UINT32 (cache->buffer, meta_data_offset + 4);
  if (offset)
    {
      data->n_attach_points = GET_UINT32 (cache->buffer, offset);
      data->attach_points = g_new (GdkPoint, data->n_attach_points);
      for (i = 0; i < data->n_attach_points; i++)
	{
	  data->attach_points[i].x = GET_UINT16 (cache->buffer, offset + 4 + 4 * i); 
	  data->attach_points[i].y = GET_UINT16 (cache->buffer, offset + 4 + 4 * i + 2); 
	}
    }

  offset = GET_UINT32 (cache->buffer, meta_data_offset + 8);
  if (offset)
    {
      gint n_names;
      gchar *lang, *name;
      gchar **langs;
      GHashTable *table = g_hash_table_new (g_str_hash, g_str_equal);

      n_names = GET_UINT32 (cache->buffer, offset);
      
      for (i = 0; i < n_names; i++)
	{
	  lang = cache->buffer + GET_UINT32 (cache->buffer, offset + 4 + 8 * i);
	  name = cache->buffer + GET_UINT32 (cache->buffer, offset + 4 + 8 * i + 4);
	  
	  g_hash_table_insert (table, lang, name);
	}
      
      langs = (gchar **)g_get_language_names ();
      for (i = 0; langs[i]; i++)
	{
	  name = g_hash_table_lookup (table, langs[i]);
	  if (name)
	    {
	      data->display_name = g_strdup (name);
	      break;
	    }
	}

      g_hash_table_destroy (table);
    }

  return data;
}
568