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