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