Pileus Git - ~andy/gtk/blob - gtk/gtkfilefilter.c

   1 /* GTK - The GIMP Toolkit
   2  * gtkfilefilter.c: Filters for selecting a file subset
   3  * Copyright (C) 2003, 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 Public
  16  * 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
  21 #include <config.h>
  22 #include <string.h>
  23
  24 #include "gtkfilefilter.h"
  25 #include "gtkobject.h"
  26 #include "gtkintl.h"
  27 #include "gtkprivate.h"
  28
  29 #include "gtkalias.h"
  30
  31 #ifdef G_OS_UNIX
  32 #define XDG_PREFIX _gtk_xdg
  33 #include "xdgmime/xdgmime.h"
  34 #endif
  35
  36 typedef struct _GtkFileFilterClass GtkFileFilterClass;
  37 typedef struct _FilterRule FilterRule;
  38
  39 #define GTK_FILE_FILTER_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_FILE_FILTER, GtkFileFilterClass))
  40 #define GTK_IS_FILE_FILTER_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_FILE_FILTER))
  41 #define GTK_FILE_FILTER_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_FILE_FILTER, GtkFileFilterClass))
  42
  43 typedef enum {
  44   FILTER_RULE_PATTERN,
  45   FILTER_RULE_MIME_TYPE,
  46   FILTER_RULE_PIXBUF_FORMATS,
  47   FILTER_RULE_CUSTOM
  48 } FilterRuleType;
  49
  50 struct _GtkFileFilterClass
  51 {
  52   GtkObjectClass parent_class;
  53 };
  54
  55 struct _GtkFileFilter
  56 {
  57   GtkObject parent_instance;
  58
  59   gchar *name;
  60   GSList *rules;
  61
  62   GtkFileFilterFlags needed;
  63 };
  64
  65 struct _FilterRule
  66 {
  67   FilterRuleType type;
  68   GtkFileFilterFlags needed;
  69
  70   union {
  71     gchar *pattern;
  72     gchar *mime_type;
  73     GSList *pixbuf_formats;
  74     struct {
  75       GtkFileFilterFunc func;
  76       gpointer data;
  77       GDestroyNotify notify;
  78     } custom;
  79   } u;
  80 };
  81
  82 static void gtk_file_filter_finalize   (GObject            *object);
  83
  84
  85 G_DEFINE_TYPE (GtkFileFilter, gtk_file_filter, GTK_TYPE_OBJECT)
  86
  87 static void
  88 gtk_file_filter_init (GtkFileFilter *object)
  89 {
  90 }
  91
  92 static void
  93 gtk_file_filter_class_init (GtkFileFilterClass *class)
  94 {
  95   GObjectClass *gobject_class = G_OBJECT_CLASS (class);
  96
  97   gobject_class->finalize = gtk_file_filter_finalize;
  98 }
  99
 100 static void
 101 filter_rule_free (FilterRule *rule)
 102 {
 103   switch (rule->type)
 104     {
 105     case FILTER_RULE_MIME_TYPE:
 106       g_free (rule->u.mime_type);
 107       break;
 108     case FILTER_RULE_PATTERN:
 109       g_free (rule->u.pattern);
 110       break;
 111     case FILTER_RULE_CUSTOM:
 112       if (rule->u.custom.notify)
 113         rule->u.custom.notify (rule->u.custom.data);
 114       break;
 115     case FILTER_RULE_PIXBUF_FORMATS:
 116       g_slist_free (rule->u.pixbuf_formats);
 117       break;
 118     default:
 119       g_assert_not_reached ();
 120     }
 121
 122   g_free (rule);
 123 }
 124
 125 static void
 126 gtk_file_filter_finalize (GObject  *object)
 127 {
 128   GtkFileFilter *filter = GTK_FILE_FILTER (object);
 129
 130   g_slist_foreach (filter->rules, (GFunc)filter_rule_free, NULL);
 131   g_slist_free (filter->rules);
 132
 133   g_free (filter->name);
 134
 135   G_OBJECT_CLASS (gtk_file_filter_parent_class)->finalize (object);
 136 }
 137
 138 /**
 139  * gtk_file_filter_new:
 140  *
 141  * Creates a new #GtkFileFilter with no rules added to it.
 142  * Such a filter doesn't accept any files, so is not
 143  * particularly useful until you add rules with
 144  * gtk_file_filter_add_mime_type(), gtk_file_filter_add_pattern(),
 145  * or gtk_file_filter_add_custom(). To create a filter
 146  * that accepts any file, use:
 147  *
 148  * <informalexample><programlisting>
 149  * GtkFileFilter *filter = gtk_file_filter_new (<!-- -->);
 150  * gtk_file_filter_add_pattern (filter, "*");
 151  * </programlisting></informalexample>
 152  *
 153  * Return value: a new #GtkFileFilter
 154  *
 155  * Since: 2.4
 156  **/
 157 GtkFileFilter *
 158 gtk_file_filter_new (void)
 159 {
 160   return g_object_new (GTK_TYPE_FILE_FILTER, NULL);
 161 }
 162
 163 /**
 164  * gtk_file_filter_set_name:
 165  * @filter: a #GtkFileFilter
 166  * @name: the human-readable-name for the filter, or %NULL
 167  *   to remove any existing name.
 168  *
 169  * Sets the human-readable name of the filter; this is the string
 170  * that will be displayed in the file selector user interface if
 171  * there is a selectable list of filters.
 172  *
 173  * Since: 2.4
 174  **/
 175 void
 176 gtk_file_filter_set_name (GtkFileFilter *filter,
 177                           const gchar   *name)
 178 {
 179   g_return_if_fail (GTK_IS_FILE_FILTER (filter));
 180
 181   g_free (filter->name);
 182
 183   filter->name = g_strdup (name);
 184 }
 185
 186 /**
 187  * gtk_file_filter_get_name:
 188  * @filter: a #GtkFileFilter
 189  *
 190  * Gets the human-readable name for the filter. See gtk_file_filter_set_name().
 191  *
 192  * Return value: The human-readable name of the filter,
 193  *   or %NULL. This value is owned by GTK+ and must not
 194  *   be modified or freed.
 195  *
 196  * Since: 2.4
 197  **/
 198 G_CONST_RETURN gchar *
 199 gtk_file_filter_get_name (GtkFileFilter *filter)
 200 {
 201   g_return_val_if_fail (GTK_IS_FILE_FILTER (filter), NULL);
 202
 203   return filter->name;
 204 }
 205
 206 static void
 207 file_filter_add_rule (GtkFileFilter *filter,
 208                       FilterRule    *rule)
 209 {
 210   filter->needed |= rule->needed;
 211   filter->rules = g_slist_append (filter->rules, rule);
 212 }
 213
 214 /**
 215  * gtk_file_filter_add_mime_type:
 216  * @filter: A #GtkFileFilter
 217  * @mime_type: name of a MIME type
 218  *
 219  * Adds a rule allowing a given mime type to @filter.
 220  *
 221  * Since: 2.4
 222  **/
 223 void
 224 gtk_file_filter_add_mime_type (GtkFileFilter *filter,
 225                                const gchar   *mime_type)
 226 {
 227   FilterRule *rule;
 228
 229   g_return_if_fail (GTK_IS_FILE_FILTER (filter));
 230   g_return_if_fail (mime_type != NULL);
 231
 232   rule = g_new (FilterRule, 1);
 233   rule->type = FILTER_RULE_MIME_TYPE;
 234   rule->needed = GTK_FILE_FILTER_MIME_TYPE;
 235   rule->u.mime_type = g_strdup (mime_type);
 236
 237   file_filter_add_rule (filter, rule);
 238 }
 239
 240 /**
 241  * gtk_file_filter_add_pattern:
 242  * @filter: a #GtkFileFilter
 243  * @pattern: a shell style glob
 244  *
 245  * Adds a rule allowing a shell style glob to a filter.
 246  *
 247  * Since: 2.4
 248  **/
 249 void
 250 gtk_file_filter_add_pattern (GtkFileFilter *filter,
 251                              const gchar   *pattern)
 252 {
 253   FilterRule *rule;
 254
 255   g_return_if_fail (GTK_IS_FILE_FILTER (filter));
 256   g_return_if_fail (pattern != NULL);
 257
 258   rule = g_new (FilterRule, 1);
 259   rule->type = FILTER_RULE_PATTERN;
 260   rule->needed = GTK_FILE_FILTER_DISPLAY_NAME;
 261   rule->u.pattern = g_strdup (pattern);
 262
 263   file_filter_add_rule (filter, rule);
 264 }
 265
 266 /**
 267  * gtk_file_filter_add_pixbuf_formats:
 268  * @filter: a #GtkFileFilter
 269  *
 270  * Adds a rule allowing image files in the formats supported
 271  * by GdkPixbuf.
 272  *
 273  * Since: 2.6
 274  **/
 275 void
 276 gtk_file_filter_add_pixbuf_formats (GtkFileFilter *filter)
 277 {
 278   FilterRule *rule;
 279
 280   g_return_if_fail (GTK_IS_FILE_FILTER (filter));
 281
 282   rule = g_new (FilterRule, 1);
 283   rule->type = FILTER_RULE_PIXBUF_FORMATS;
 284   rule->needed = GTK_FILE_FILTER_MIME_TYPE;
 285   rule->u.pixbuf_formats = gdk_pixbuf_get_formats ();
 286   file_filter_add_rule (filter, rule);
 287 }
 288
 289
 290 /**
 291  * gtk_file_filter_add_custom:
 292  * @filter: a #GtkFileFilter
 293  * @needed: bitfield of flags indicating the information that the custom
 294  *          filter function needs.
 295  * @func: callback function; if the function returns %TRUE, then
 296  *   the file will be displayed.
 297  * @data: data to pass to @func
 298  * @notify: function to call to free @data when it is no longer needed.
 299  *
 300  * Adds rule to a filter that allows files based on a custom callback
 301  * function. The bitfield @needed which is passed in provides information
 302  * about what sorts of information that the filter function needs;
 303  * this allows GTK+ to avoid retrieving expensive information when
 304  * it isn't needed by the filter.
 305  *
 306  * Since: 2.4
 307  **/
 308 void
 309 gtk_file_filter_add_custom (GtkFileFilter         *filter,
 310                             GtkFileFilterFlags     needed,
 311                             GtkFileFilterFunc      func,
 312                             gpointer               data,
 313                             GDestroyNotify         notify)
 314 {
 315   FilterRule *rule;
 316
 317   g_return_if_fail (GTK_IS_FILE_FILTER (filter));
 318   g_return_if_fail (func != NULL);
 319
 320   rule = g_new (FilterRule, 1);
 321   rule->type = FILTER_RULE_CUSTOM;
 322   rule->needed = needed;
 323   rule->u.custom.func = func;
 324   rule->u.custom.data = data;
 325   rule->u.custom.notify = notify;
 326
 327   file_filter_add_rule (filter, rule);
 328 }
 329
 330 /**
 331  * gtk_file_filter_get_needed:
 332  * @filter: a #GtkFileFilter
 333  *
 334  * Gets the fields that need to be filled in for the structure
 335  * passed to gtk_file_filter_filter()
 336  *
 337  * This function will not typically be used by applications; it
 338  * is intended principally for use in the implementation of
 339  * #GtkFileChooser.
 340  *
 341  * Return value: bitfield of flags indicating needed fields when
 342  *   calling gtk_file_filter_filter()
 343  *
 344  * Since: 2.4
 345  **/
 346 GtkFileFilterFlags
 347 gtk_file_filter_get_needed (GtkFileFilter *filter)
 348 {
 349   return filter->needed;
 350 }
 351
 352 /**
 353  * gtk_file_filter_filter:
 354  * @filter: a #GtkFileFilter
 355  * @filter_info: a #GtkFileFilterInfo structure containing information
 356  *  about a file.
 357  *
 358  * Tests whether a file should be displayed according to @filter.
 359  * The #GtkFileFilterInfo structure @filter_info should include
 360  * the fields returned from gtk_file_filter_get_needed().
 361  *
 362  * This function will not typically be used by applications; it
 363  * is intended principally for use in the implementation of
 364  * #GtkFileChooser.
 365  *
 366  * Return value: %TRUE if the file should be displayed
 367  *
 368  * Since: 2.4
 369  **/
 370 gboolean
 371 gtk_file_filter_filter (GtkFileFilter           *filter,
 372                         const GtkFileFilterInfo *filter_info)
 373 {
 374   GSList *tmp_list;
 375
 376   for (tmp_list = filter->rules; tmp_list; tmp_list = tmp_list->next)
 377     {
 378       FilterRule *rule = tmp_list->data;
 379
 380       if ((filter_info->contains & rule->needed) != rule->needed)
 381         continue;
 382
 383       switch (rule->type)
 384         {
 385         case FILTER_RULE_MIME_TYPE:
 386           if (filter_info->mime_type != NULL
 387 #ifdef G_OS_UNIX
 388               && xdg_mime_mime_type_subclass (filter_info->mime_type, rule->u.mime_type))
 389 #else
 390               && strcmp (rule->u.mime_type, filter_info->mime_type) == 0)
 391 #endif
 392             return TRUE;
 393           break;
 394         case FILTER_RULE_PATTERN:
 395           if (filter_info->display_name != NULL &&
 396               _gtk_fnmatch (rule->u.pattern, filter_info->display_name, FALSE))
 397             return TRUE;
 398           break;
 399         case FILTER_RULE_PIXBUF_FORMATS:
 400           {
 401             GSList *list;
 402
 403             if (!filter_info->mime_type)
 404               break;
 405
 406             for (list = rule->u.pixbuf_formats; list; list = list->next)
 407               {
 408                 int i;
 409                 gchar **mime_types;
 410
 411                 mime_types = gdk_pixbuf_format_get_mime_types (list->data);
 412
 413                 for (i = 0; mime_types[i] != NULL; i++)
 414                   {
 415                     if (strcmp (mime_types[i], filter_info->mime_type) == 0)
 416                       {
 417                         g_strfreev (mime_types);
 418                         return TRUE;
 419                       }
 420                   }
 421
 422                 g_strfreev (mime_types);
 423               }
 424             break;
 425           }
 426         case FILTER_RULE_CUSTOM:
 427           if (rule->u.custom.func (filter_info, rule->u.custom.data))
 428             return TRUE;
 429           break;
 430         }
 431     }
 432
 433   return FALSE;
 434 }
 435
 436 #define __GTK_FILE_FILTER_C__
 437 #include "gtkaliasdef.c"