ROX-Filer/src/pixmaps.c

   1 /*
   2  * $Id$
   3  *
   4  * ROX-Filer, filer for the ROX desktop project
   5  * Copyright (C) 1999, Thomas Leonard, <tal197@ecs.soton.ac.uk>.
   6  *
   7  * This program is free software; you can redistribute it and/or modify it
   8  * under the terms of the GNU General Public License as published by the Free
   9  * Software Foundation; either version 2 of the License, or (at your option)
  10  * any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful, but WITHOUT
  13  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  14  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
  15  * more details.
  16  *
  17  * You should have received a copy of the GNU General Public License along with
  18  * this program; if not, write to the Free Software Foundation, Inc., 59 Temple
  19  * Place, Suite 330, Boston, MA  02111-1307  USA
  20  */
  21
  22 /* pixmaps.c - code for handling pixmaps */
  23
  24 /* Remove pixmaps from the cache when they haven't been accessed for
  25  * this period of time (seconds).
  26  */
  27 #define PIXMAP_PURGE_TIME 1200
  28
  29 #include <stdlib.h>
  30 #include <stdio.h>
  31 #include <errno.h>
  32
  33 #include <gtk/gtk.h>
  34 #include "collection.h"
  35
  36 #include "fscache.h"
  37 #include "support.h"
  38 #include "gui_support.h"
  39 #include "pixmaps.h"
  40
  41 static GFSCache *pixmap_cache = NULL;
  42
  43 static char * bad_xpm[] = {
  44 "12 12 3 1",
  45 "       c #000000000000",
  46 ".      c #FFFF00000000",
  47 "X      c #FFFFFFFFFFFF",
  48 "            ",
  49 " ..XXXXXX.. ",
  50 " ...XXXX... ",
  51 " X...XX...X ",
  52 " XX......XX ",
  53 " XXX....XXX ",
  54 " XXX....XXX ",
  55 " XX......XX ",
  56 " X...XX...X ",
  57 " ...XXXX... ",
  58 " ..XXXXXX.. ",
  59 "            "};
  60
  61 MaskedPixmap    default_pixmap[LAST_DEFAULT_PIXMAP];
  62
  63 /* Static prototypes */
  64
  65 static void load_default_pixmaps(void);
  66 static MaskedPixmap *load(char *pathname, gpointer data);
  67 static void ref(MaskedPixmap *mp, gpointer data);
  68 static void unref(MaskedPixmap *mp, gpointer data);
  69 static gint purge(gpointer data);
  70
  71
  72 /****************************************************************
  73  *                      EXTERNAL INTERFACE                      *
  74  ****************************************************************/
  75
  76 void pixmaps_init(void)
  77 {
  78         pixmap_cache = g_fscache_new((GFSLoadFunc) load,
  79                                         (GFSFunc) ref,
  80                                         (GFSFunc) unref,
  81                                         NULL);
  82
  83         gtk_timeout_add(10000, purge, NULL);
  84
  85         load_default_pixmaps();
  86 }
  87
  88 /* Try to load the pixmap from the given path, allocate a MaskedPixmap
  89  * structure for it and return a pointer to the structure. NULL on failure.
  90  * Remember to pixmap_unref() the result afterwards.
  91  */
  92 MaskedPixmap *load_pixmap_from(GtkWidget *window, char *path)
  93 {
  94         MaskedPixmap    *masked_pixmap;
  95
  96         pixmap_cache->user_data = window;
  97         masked_pixmap = g_fscache_lookup(pixmap_cache, path);
  98         pixmap_cache->user_data = NULL;
  99
 100         return masked_pixmap;
 101 }
 102
 103 void load_pixmap(char *name, MaskedPixmap *image)
 104 {
 105         image->pixmap = gdk_pixmap_colormap_create_from_xpm(NULL,
 106                                 gtk_widget_get_default_colormap(),
 107                                 &image->mask,
 108                                 0,
 109                                 make_path(getenv("APP_DIR"), name)->str);
 110
 111         if (!image->pixmap)
 112         {
 113                 image->pixmap= gdk_pixmap_colormap_create_from_xpm_d(NULL,
 114                                 gtk_widget_get_default_colormap(),
 115                                 &image->mask, NULL, bad_xpm);
 116         }
 117
 118         image->ref = 1;
 119 }
 120
 121 /* Load all the standard pixmaps */
 122 static void load_default_pixmaps(void)
 123 {
 124         load_pixmap("pixmaps/error.xpm", default_pixmap + TYPE_ERROR);
 125         load_pixmap("pixmaps/unknown.xpm", default_pixmap + TYPE_UNKNOWN);
 126         load_pixmap("pixmaps/symlink.xpm", default_pixmap + TYPE_SYMLINK);
 127         load_pixmap("pixmaps/file.xpm", default_pixmap + TYPE_FILE);
 128         load_pixmap("pixmaps/directory.xpm", default_pixmap + TYPE_DIRECTORY);
 129         load_pixmap("pixmaps/char.xpm", default_pixmap + TYPE_CHAR_DEVICE);
 130         load_pixmap("pixmaps/block.xpm", default_pixmap + TYPE_BLOCK_DEVICE);
 131         load_pixmap("pixmaps/pipe.xpm", default_pixmap + TYPE_PIPE);
 132         load_pixmap("pixmaps/socket.xpm", default_pixmap + TYPE_SOCKET);
 133
 134         load_pixmap("pixmaps/mount.xpm", default_pixmap + TYPE_UNMOUNTED);
 135         load_pixmap("pixmaps/mounted.xpm", default_pixmap + TYPE_MOUNTED);
 136         load_pixmap("pixmaps/multiple.xpm", default_pixmap + TYPE_MULTIPLE);
 137         load_pixmap("pixmaps/exec.xpm", default_pixmap + TYPE_EXEC_FILE);
 138         load_pixmap("pixmaps/application.xpm", default_pixmap + TYPE_APPDIR);
 139
 140         load_pixmap("pixmaps/up.xpm", default_pixmap + TOOLBAR_UP_ICON);
 141         load_pixmap("pixmaps/home.xpm", default_pixmap + TOOLBAR_HOME_ICON);
 142 }
 143
 144 void pixmap_ref(MaskedPixmap *mp)
 145 {
 146         ref(mp, pixmap_cache->user_data);
 147 }
 148
 149 void pixmap_unref(MaskedPixmap *mp)
 150 {
 151         unref(mp, pixmap_cache->user_data);
 152 }
 153
 154 /****************************************************************
 155  *                      INTERNAL FUNCTIONS                      *
 156  ****************************************************************/
 157
 158 /* Try to load the pixmap from the given path, allocate a MaskedPixmap
 159  * structure for it and return a pointer to the structure. NULL on failure.
 160  */
 161 static MaskedPixmap *load(char *pathname, gpointer user_data)
 162 {
 163         GtkWidget       *window = (GtkWidget *) user_data;
 164         GdkPixmap       *pixmap;
 165         GdkBitmap       *mask;
 166         GtkStyle        *style;
 167         MaskedPixmap    *masked_pixmap;
 168
 169         style = gtk_widget_get_style(window);
 170
 171         pixmap = gdk_pixmap_create_from_xpm(window->window,
 172                         &mask,
 173                         &style->bg[GTK_STATE_NORMAL],
 174                         pathname);
 175         if (!pixmap)
 176                 return NULL;
 177
 178         masked_pixmap = g_new(MaskedPixmap, 1);
 179         masked_pixmap->pixmap = pixmap;
 180         masked_pixmap->mask = mask;
 181         masked_pixmap->ref = 1;
 182
 183         return masked_pixmap;
 184 }
 185
 186 static void ref(MaskedPixmap *mp, gpointer data)
 187 {
 188         /* printf("[ ref %p %d->%d ]\n", mp, mp->ref, mp->ref + 1); */
 189
 190         if (mp)
 191         {
 192                 gdk_pixmap_ref(mp->pixmap);
 193                 gdk_bitmap_ref(mp->mask);
 194                 mp->ref++;
 195         }
 196 }
 197
 198 static void unref(MaskedPixmap *mp, gpointer data)
 199 {
 200         /* printf("[ unref %p %d->%d ]\n", mp, mp->ref, mp->ref - 1); */
 201
 202         if (mp && --mp->ref == 0)
 203         {
 204                 gdk_pixmap_unref(mp->pixmap);
 205                 gdk_bitmap_unref(mp->mask);
 206                 g_free(mp);
 207         }
 208 }
 209
 210 /* Called now and then to clear out old pixmaps */
 211 static gint purge(gpointer data)
 212 {
 213         g_fscache_purge(pixmap_cache, PIXMAP_PURGE_TIME);
 214
 215         return TRUE;
 216 }