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 "gtkfilefilter.h"
  22
  23 #include <gtk/gtkobject.h>
  24
  25 #include <string.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></programlisting>
 157  *
 158  * Return value: a new #GtkFileFilter
 159  **/
 160 GtkFileFilter *
 161 gtk_file_filter_new (void)
 162 {
 163   return g_object_new (GTK_TYPE_FILE_FILTER, NULL);
 164 }
 165
 166 /**
 167  * gtk_file_filter_set_name:
 168  * @filter: a #GtkFileFilter
 169  * @name: the human-readable-name for the filter, or %NULL
 170  *   to remove any existing name.
 171  *
 172  * Sets the human-readable name of the filter; this is the string
 173  * that will be displayed in the file selector user interface if
 174  * there is a selectable list of filters.
 175  **/
 176 void
 177 gtk_file_filter_set_name (GtkFileFilter *filter,
 178                           const gchar   *name)
 179 {
 180   g_return_if_fail (GTK_IS_FILE_FILTER (filter));
 181
 182   if (filter->name)
 183     g_free (filter->name);
 184
 185   filter->name = g_strdup (name);
 186 }
 187
 188 /**
 189  * gtk_file_filter_get_name:
 190  * @filter: a #GtkFileFilter
 191  *
 192  * Gets the human-readable name for the filter. See gtk_file_filter_set_name().
 193  *
 194  * Return value: The human-readable name of the filter,
 195  *   or %NULL. This value is owned by GTK+ and must not
 196  *   be modified or freed.
 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 void
 222 gtk_file_filter_add_mime_type (GtkFileFilter *filter,
 223                                const gchar   *mime_type)
 224 {
 225   FilterRule *rule;
 226
 227   g_return_if_fail (GTK_IS_FILE_FILTER (filter));
 228   g_return_if_fail (mime_type != NULL);
 229
 230   rule = g_new (FilterRule, 1);
 231   rule->type = FILTER_RULE_MIME_TYPE;
 232   rule->needed = GTK_FILE_FILTER_MIME_TYPE;
 233   rule->u.mime_type = g_strdup (mime_type);
 234
 235   file_filter_add_rule (filter, rule);
 236 }
 237
 238 /**
 239  * gtk_file_filter_add_pattern:
 240  * @filter: a #GtkFileFilter
 241  * @pattern: a shell style glob
 242  *
 243  * Adds a rule allowing a shell style glob to a filter.
 244  **/
 245 void
 246 gtk_file_filter_add_pattern (GtkFileFilter *filter,
 247                              const gchar   *pattern)
 248 {
 249   FilterRule *rule;
 250
 251   g_return_if_fail (GTK_IS_FILE_FILTER (filter));
 252   g_return_if_fail (pattern != NULL);
 253
 254   rule = g_new (FilterRule, 1);
 255   rule->type = FILTER_RULE_PATTERN;
 256   rule->needed = GTK_FILE_FILTER_DISPLAY_NAME;
 257   rule->u.pattern = g_strdup (pattern);
 258
 259   file_filter_add_rule (filter, rule);
 260 }
 261
 262 /**
 263  * gtk_file_filter_add_custom:
 264  * @filter: a #GtkFileFilter
 265  * @needed: bitfield of flags indicating the information that the custom
 266  *          filter function needs.
 267  * @func: callback function; if the function returns %TRUE, then
 268  *   the file will be displayed.
 269  * @data: data to pass to @func
 270  * @notify: function to call to free @data when it is no longer needed.
 271  *
 272  * Adds rule to a filter that allows files based on a custom callback
 273  * function. The bitfield @needed which is passed in provides information
 274  * about what sorts of information that the filter function needs;
 275  * this allows GTK+ to avoid retrieving expensive information when
 276  * it isn't needed by the filter.
 277  **/
 278 void
 279 gtk_file_filter_add_custom (GtkFileFilter         *filter,
 280                             GtkFileFilterFlags     needed,
 281                             GtkFileFilterFunc      func,
 282                             gpointer               data,
 283                             GDestroyNotify         notify)
 284 {
 285   FilterRule *rule;
 286
 287   g_return_if_fail (GTK_IS_FILE_FILTER (filter));
 288   g_return_if_fail (func != NULL);
 289
 290   rule = g_new (FilterRule, 1);
 291   rule->type = FILTER_RULE_CUSTOM;
 292   rule->needed = needed;
 293   rule->u.custom.func = func;
 294   rule->u.custom.data = data;
 295   rule->u.custom.notify = notify;
 296
 297   file_filter_add_rule (filter, rule);
 298 }
 299
 300 /**
 301  * gtk_file_filter_get_needed:
 302  * @filter: a #GtkFileFilter
 303  *
 304  * Gets the fields that need to be filled in for the structure
 305  * passed to gtk_file_filter_filter()
 306  *
 307  * This function will not typically be used by applications; it
 308  * is intended principally for use in the implementation of
 309  * #GtkFileChooser.
 310  *
 311  * Return value: bitfield of flags indicating needed fields when
 312  *   calling gtk_file_filter_filter()
 313  **/
 314 GtkFileFilterFlags
 315 gtk_file_filter_get_needed (GtkFileFilter *filter)
 316 {
 317   return filter->needed;
 318 }
 319
 320 /* Remove once we merge into GTK+ and use _gtk_fnmatch().
 321  */
 322 gboolean _gtk_file_chooser_fnmatch (const char *pattern,
 323                                     const char *string);
 324
 325 /**
 326  * gtk_file_filter_filter:
 327  * @filter: a #GtkFileFilter
 328  * @filter_info: a #GtkFileFilterInfo structure containing information
 329  *  about a file.
 330  *
 331  * Tests whether a file should be displayed according to @filter.
 332  * The #GtkFileFilterInfo structure @filter_info should include
 333  * the fields returned feom gtk_file_filter_get_needed().
 334  *
 335  * This function will not typically be used by applications; it
 336  * is intended principally for use in the implementation of
 337  * #GtkFileChooser.
 338  *
 339  * Return value: %TRUE if the file should be displayed
 340  **/
 341 gboolean
 342 gtk_file_filter_filter (GtkFileFilter           *filter,
 343                         const GtkFileFilterInfo *filter_info)
 344 {
 345   GSList *tmp_list;
 346
 347   for (tmp_list = filter->rules; tmp_list; tmp_list = tmp_list->next)
 348     {
 349       FilterRule *rule = tmp_list->data;
 350
 351       if ((filter_info->contains & rule->needed) != rule->needed)
 352         continue;
 353
 354       switch (rule->type)
 355         {
 356         case FILTER_RULE_MIME_TYPE:
 357           if (filter_info->mime_type != NULL
 358               && strcmp (rule->u.mime_type, filter_info->mime_type) == 0)
 359             return TRUE;
 360           break;
 361         case FILTER_RULE_PATTERN:
 362           if (_gtk_file_chooser_fnmatch (rule->u.pattern, filter_info->display_name))
 363             return TRUE;
 364           break;
 365         case FILTER_RULE_CUSTOM:
 366           if (rule->u.custom.func (filter_info, rule->u.custom.data))
 367             return TRUE;
 368           break;
 369         }
 370     }
 371
 372   return FALSE;
 373 }