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