1 /* GTK - The GIMP Toolkit
2 * gtkfilefilter.c: Filters for selecting a file subset
3 * Copyright (C) 2003, Red Hat, Inc.
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.
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.
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.
23 #include "gtkfilefilter.h"
24 #include "gtkobject.h"
26 typedef struct _GtkFileFilterClass GtkFileFilterClass;
27 typedef struct _FilterRule FilterRule;
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))
35 FILTER_RULE_MIME_TYPE,
39 struct _GtkFileFilterClass
41 GtkObjectClass parent_class;
46 GtkObject parent_instance;
51 GtkFileFilterFlags needed;
57 GtkFileFilterFlags needed;
63 GtkFileFilterFunc func;
65 GDestroyNotify notify;
70 static void gtk_file_filter_class_init (GtkFileFilterClass *class);
71 static void gtk_file_filter_finalize (GObject *object);
73 static GObjectClass *parent_class;
76 gtk_file_filter_get_type (void)
78 static GType file_filter_type = 0;
80 if (!file_filter_type)
82 static const GTypeInfo file_filter_info =
84 sizeof (GtkFileFilterClass),
86 NULL, /* base_finalize */
87 (GClassInitFunc) gtk_file_filter_class_init,
88 NULL, /* class_finalize */
89 NULL, /* class_data */
90 sizeof (GtkFileFilter),
95 file_filter_type = g_type_register_static (GTK_TYPE_OBJECT, "GtkFileFilter",
96 &file_filter_info, 0);
99 return file_filter_type;
103 gtk_file_filter_class_init (GtkFileFilterClass *class)
105 GObjectClass *gobject_class = G_OBJECT_CLASS (class);
107 parent_class = g_type_class_peek_parent (class);
109 gobject_class->finalize = gtk_file_filter_finalize;
113 filter_rule_free (FilterRule *rule)
117 case FILTER_RULE_MIME_TYPE:
118 g_free (rule->u.mime_type);
120 case FILTER_RULE_PATTERN:
121 g_free (rule->u.pattern);
123 case FILTER_RULE_CUSTOM:
124 if (rule->u.custom.notify)
125 rule->u.custom.notify (rule->u.custom.data);
133 gtk_file_filter_finalize (GObject *object)
135 GtkFileFilter *filter = GTK_FILE_FILTER (filter);
137 g_slist_foreach (filter->rules, (GFunc)filter_rule_free, NULL);
139 parent_class->finalize (object);
143 * gtk_file_filter_new:
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:
152 * <informalexample><programlisting>
153 * GtkFileFilter *filter = gtk_file_filter_new (<!-- -->);
154 * gtk_file_filter_add_pattern (filter, "*");
155 * </programlisting></informalexample>
157 * Return value: a new #GtkFileFilter
162 gtk_file_filter_new (void)
164 return g_object_new (GTK_TYPE_FILE_FILTER, NULL);
168 * gtk_file_filter_set_name:
169 * @filter: a #GtkFileFilter
170 * @name: the human-readable-name for the filter, or %NULL
171 * to remove any existing name.
173 * Sets the human-readable name of the filter; this is the string
174 * that will be displayed in the file selector user interface if
175 * there is a selectable list of filters.
180 gtk_file_filter_set_name (GtkFileFilter *filter,
183 g_return_if_fail (GTK_IS_FILE_FILTER (filter));
186 g_free (filter->name);
188 filter->name = g_strdup (name);
192 * gtk_file_filter_get_name:
193 * @filter: a #GtkFileFilter
195 * Gets the human-readable name for the filter. See gtk_file_filter_set_name().
197 * Return value: The human-readable name of the filter,
198 * or %NULL. This value is owned by GTK+ and must not
199 * be modified or freed.
203 G_CONST_RETURN gchar *
204 gtk_file_filter_get_name (GtkFileFilter *filter)
206 g_return_val_if_fail (GTK_IS_FILE_FILTER (filter), NULL);
212 file_filter_add_rule (GtkFileFilter *filter,
215 filter->needed |= rule->needed;
216 filter->rules = g_slist_append (filter->rules, rule);
220 * gtk_file_filter_add_mime_type:
221 * @filter: A #GtkFileFilter
222 * @mime_type: name of a MIME type
224 * Adds a rule allowing a given mime type to @filter.
229 gtk_file_filter_add_mime_type (GtkFileFilter *filter,
230 const gchar *mime_type)
234 g_return_if_fail (GTK_IS_FILE_FILTER (filter));
235 g_return_if_fail (mime_type != NULL);
237 rule = g_new (FilterRule, 1);
238 rule->type = FILTER_RULE_MIME_TYPE;
239 rule->needed = GTK_FILE_FILTER_MIME_TYPE;
240 rule->u.mime_type = g_strdup (mime_type);
242 file_filter_add_rule (filter, rule);
246 * gtk_file_filter_add_pattern:
247 * @filter: a #GtkFileFilter
248 * @pattern: a shell style glob
250 * Adds a rule allowing a shell style glob to a filter.
255 gtk_file_filter_add_pattern (GtkFileFilter *filter,
256 const gchar *pattern)
260 g_return_if_fail (GTK_IS_FILE_FILTER (filter));
261 g_return_if_fail (pattern != NULL);
263 rule = g_new (FilterRule, 1);
264 rule->type = FILTER_RULE_PATTERN;
265 rule->needed = GTK_FILE_FILTER_DISPLAY_NAME;
266 rule->u.pattern = g_strdup (pattern);
268 file_filter_add_rule (filter, rule);
272 * gtk_file_filter_add_custom:
273 * @filter: a #GtkFileFilter
274 * @needed: bitfield of flags indicating the information that the custom
275 * filter function needs.
276 * @func: callback function; if the function returns %TRUE, then
277 * the file will be displayed.
278 * @data: data to pass to @func
279 * @notify: function to call to free @data when it is no longer needed.
281 * Adds rule to a filter that allows files based on a custom callback
282 * function. The bitfield @needed which is passed in provides information
283 * about what sorts of information that the filter function needs;
284 * this allows GTK+ to avoid retrieving expensive information when
285 * it isn't needed by the filter.
290 gtk_file_filter_add_custom (GtkFileFilter *filter,
291 GtkFileFilterFlags needed,
292 GtkFileFilterFunc func,
294 GDestroyNotify notify)
298 g_return_if_fail (GTK_IS_FILE_FILTER (filter));
299 g_return_if_fail (func != NULL);
301 rule = g_new (FilterRule, 1);
302 rule->type = FILTER_RULE_CUSTOM;
303 rule->needed = needed;
304 rule->u.custom.func = func;
305 rule->u.custom.data = data;
306 rule->u.custom.notify = notify;
308 file_filter_add_rule (filter, rule);
312 * gtk_file_filter_get_needed:
313 * @filter: a #GtkFileFilter
315 * Gets the fields that need to be filled in for the structure
316 * passed to gtk_file_filter_filter()
318 * This function will not typically be used by applications; it
319 * is intended principally for use in the implementation of
322 * Return value: bitfield of flags indicating needed fields when
323 * calling gtk_file_filter_filter()
328 gtk_file_filter_get_needed (GtkFileFilter *filter)
330 return filter->needed;
334 * gtk_file_filter_filter:
335 * @filter: a #GtkFileFilter
336 * @filter_info: a #GtkFileFilterInfo structure containing information
339 * Tests whether a file should be displayed according to @filter.
340 * The #GtkFileFilterInfo structure @filter_info should include
341 * the fields returned feom gtk_file_filter_get_needed().
343 * This function will not typically be used by applications; it
344 * is intended principally for use in the implementation of
347 * Return value: %TRUE if the file should be displayed
352 gtk_file_filter_filter (GtkFileFilter *filter,
353 const GtkFileFilterInfo *filter_info)
357 for (tmp_list = filter->rules; tmp_list; tmp_list = tmp_list->next)
359 FilterRule *rule = tmp_list->data;
361 if ((filter_info->contains & rule->needed) != rule->needed)
366 case FILTER_RULE_MIME_TYPE:
367 if (filter_info->mime_type != NULL
368 && strcmp (rule->u.mime_type, filter_info->mime_type) == 0)
371 case FILTER_RULE_PATTERN:
372 if (_gtk_fnmatch (rule->u.pattern, filter_info->display_name))
375 case FILTER_RULE_CUSTOM:
376 if (rule->u.custom.func (filter_info, rule->u.custom.data))