1 /* GIO - GLib Input, Output and Streaming Library
3 * Copyright (C) 2006-2007 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
16 * Public 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.
20 * Author: Alexander Larsson <alexl@redhat.com>
24 #include "gfilenamecompleter.h"
32 * SECTION:gfilenamecompleter
33 * @short_description: Filename Completer
36 * Completes partial file and directory names given a partial string by
37 * looking in the file system for clues. Can return a list of possible
38 * completion strings for widget implementations.
47 static guint signals[LAST_SIGNAL] = { 0 };
50 GFilenameCompleter *completer;
51 GFileEnumerator *enumerator;
52 GCancellable *cancellable;
53 gboolean should_escape;
59 struct _GFilenameCompleter {
63 gboolean basenames_are_escaped;
67 LoadBasenamesData *basename_loader;
70 G_DEFINE_TYPE (GFilenameCompleter, g_filename_completer, G_TYPE_OBJECT);
72 static void cancel_load_basenames (GFilenameCompleter *completer);
75 g_filename_completer_finalize (GObject *object)
77 GFilenameCompleter *completer;
79 completer = G_FILENAME_COMPLETER (object);
81 cancel_load_basenames (completer);
83 if (completer->basenames_dir)
84 g_object_unref (completer->basenames_dir);
86 g_list_foreach (completer->basenames, (GFunc)g_free, NULL);
87 g_list_free (completer->basenames);
89 G_OBJECT_CLASS (g_filename_completer_parent_class)->finalize (object);
93 g_filename_completer_class_init (GFilenameCompleterClass *klass)
95 GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
97 gobject_class->finalize = g_filename_completer_finalize;
99 * GFilenameCompleter::got-completion-data:
101 * Emitted when the file name completion information comes available.
103 signals[GOT_COMPLETION_DATA] = g_signal_new (I_("got_completion_data"),
104 G_TYPE_FILENAME_COMPLETER,
106 G_STRUCT_OFFSET (GFilenameCompleterClass, got_completion_data),
108 g_cclosure_marshal_VOID__VOID,
113 g_filename_completer_init (GFilenameCompleter *completer)
118 * g_filename_completer_new:
120 * Creates a new filename completer.
122 * Returns: a #GFilenameCompleter.
125 g_filename_completer_new (void)
127 return g_object_new (G_TYPE_FILENAME_COMPLETER, NULL);
131 longest_common_prefix (char *a, char *b)
137 while (g_utf8_get_char (a) == g_utf8_get_char (b))
139 a = g_utf8_next_char (a);
140 b = g_utf8_next_char (b);
143 return g_strndup (start, a - start);
147 load_basenames_data_free (LoadBasenamesData *data)
149 if (data->enumerator)
150 g_object_unref (data->enumerator);
152 g_object_unref (data->cancellable);
153 g_object_unref (data->dir);
155 g_list_foreach (data->basenames, (GFunc)g_free, NULL);
156 g_list_free (data->basenames);
162 got_more_files (GObject *source_object,
166 LoadBasenamesData *data = user_data;
170 gboolean append_slash;
174 if (data->completer == NULL)
177 load_basenames_data_free (data);
181 infos = g_file_enumerator_next_files_finish (data->enumerator, res, NULL);
183 for (l = infos; l != NULL; l = l->next)
187 if (data->dirs_only &&
188 g_file_info_get_file_type (info) != G_FILE_TYPE_DIRECTORY)
190 g_object_unref (info);
194 append_slash = g_file_info_get_file_type (info) == G_FILE_TYPE_DIRECTORY;
195 name = g_file_info_get_name (info);
198 g_object_unref (info);
203 if (data->should_escape)
204 basename = g_uri_escape_string (name,
205 G_URI_RESERVED_CHARS_ALLOWED_IN_PATH,
208 /* If not should_escape, must be a local filename, convert to utf8 */
209 basename = g_filename_to_utf8 (name, -1, NULL, NULL, NULL);
216 basename = g_strconcat (basename, "/", NULL);
220 data->basenames = g_list_prepend (data->basenames, basename);
223 g_object_unref (info);
230 /* Not last, get more files */
231 g_file_enumerator_next_files_async (data->enumerator,
235 got_more_files, data);
239 data->completer->basename_loader = NULL;
241 if (data->completer->basenames_dir)
242 g_object_unref (data->completer->basenames_dir);
243 g_list_foreach (data->completer->basenames, (GFunc)g_free, NULL);
244 g_list_free (data->completer->basenames);
246 data->completer->basenames_dir = g_object_ref (data->dir);
247 data->completer->basenames = data->basenames;
248 data->completer->basenames_are_escaped = data->should_escape;
249 data->basenames = NULL;
251 g_file_enumerator_close_async (data->enumerator, 0, NULL, NULL, NULL);
253 g_signal_emit (data->completer, signals[GOT_COMPLETION_DATA], 0);
254 load_basenames_data_free (data);
260 got_enum (GObject *source_object,
264 LoadBasenamesData *data = user_data;
266 if (data->completer == NULL)
269 load_basenames_data_free (data);
273 data->enumerator = g_file_enumerate_children_finish (G_FILE (source_object), res, NULL);
275 if (data->enumerator == NULL)
277 data->completer->basename_loader = NULL;
279 if (data->completer->basenames_dir)
280 g_object_unref (data->completer->basenames_dir);
281 g_list_foreach (data->completer->basenames, (GFunc)g_free, NULL);
282 g_list_free (data->completer->basenames);
284 /* Mark uptodate with no basenames */
285 data->completer->basenames_dir = g_object_ref (data->dir);
286 data->completer->basenames = NULL;
287 data->completer->basenames_are_escaped = data->should_escape;
289 load_basenames_data_free (data);
293 g_file_enumerator_next_files_async (data->enumerator,
297 got_more_files, data);
301 schedule_load_basenames (GFilenameCompleter *completer,
303 gboolean should_escape)
305 LoadBasenamesData *data;
307 cancel_load_basenames (completer);
309 data = g_new0 (LoadBasenamesData, 1);
310 data->completer = completer;
311 data->cancellable = g_cancellable_new ();
312 data->dir = g_object_ref (dir);
313 data->should_escape = should_escape;
314 data->dirs_only = completer->dirs_only;
316 completer->basename_loader = data;
318 g_file_enumerate_children_async (dir,
319 G_FILE_ATTRIBUTE_STANDARD_NAME "," G_FILE_ATTRIBUTE_STANDARD_TYPE,
326 cancel_load_basenames (GFilenameCompleter *completer)
328 LoadBasenamesData *loader;
330 if (completer->basename_loader)
332 loader = completer->basename_loader;
333 loader->completer = NULL;
335 g_cancellable_cancel (loader->cancellable);
337 completer->basename_loader = NULL;
342 /* Returns a list of possible matches and the basename to use for it */
344 init_completion (GFilenameCompleter *completer,
345 const char *initial_text,
348 gboolean should_escape;
349 GFile *file, *parent;
354 *basename_out = NULL;
356 should_escape = ! (g_path_is_absolute (initial_text) || *initial_text == '~');
358 len = strlen (initial_text);
361 initial_text[len - 1] == '/')
364 file = g_file_parse_name (initial_text);
365 parent = g_file_get_parent (file);
368 g_object_unref (file);
372 if (completer->basenames_dir == NULL ||
373 completer->basenames_are_escaped != should_escape ||
374 !g_file_equal (parent, completer->basenames_dir))
376 schedule_load_basenames (completer, parent, should_escape);
377 g_object_unref (file);
381 basename = g_file_get_basename (file);
385 basename = g_uri_escape_string (basename, G_URI_RESERVED_CHARS_ALLOWED_IN_PATH, TRUE);
391 basename = g_filename_to_utf8 (basename, -1, NULL, NULL, NULL);
394 if (basename == NULL)
398 *basename_out = basename;
400 return completer->basenames;
404 * g_filename_completer_get_completion_suffix:
405 * @completer: the filename completer.
406 * @initial_text: text to be completed.
408 * Obtains a completion for @initial_text from @completer.
410 * Returns: a completed string, or %NULL if no completion exists.
411 * This string is not owned by GIO, so remember to g_free() it
415 g_filename_completer_get_completion_suffix (GFilenameCompleter *completer,
416 const char *initial_text)
418 GList *possible_matches, *l;
421 char *possible_match;
424 g_return_val_if_fail (G_IS_FILENAME_COMPLETER (completer), NULL);
425 g_return_val_if_fail (initial_text != NULL, NULL);
427 possible_matches = init_completion (completer, initial_text, &prefix);
431 for (l = possible_matches; l != NULL; l = l->next)
433 possible_match = l->data;
435 if (g_str_has_prefix (possible_match, prefix))
438 suffix = g_strdup (possible_match + strlen (prefix));
441 lcp = longest_common_prefix (suffix,
442 possible_match + strlen (prefix));
458 * g_filename_completer_get_completions:
459 * @completer: the filename completer.
460 * @initial_text: text to be completed.
462 * Gets an array of completion strings for a given initial text.
464 * Returns: array of strings with possible completions for @initial_text.
465 * This array must be freed by g_strfreev() when finished.
468 g_filename_completer_get_completions (GFilenameCompleter *completer,
469 const char *initial_text)
471 GList *possible_matches, *l;
473 char *possible_match;
476 g_return_val_if_fail (G_IS_FILENAME_COMPLETER (completer), NULL);
477 g_return_val_if_fail (initial_text != NULL, NULL);
479 possible_matches = init_completion (completer, initial_text, &prefix);
481 res = g_ptr_array_new ();
482 for (l = possible_matches; l != NULL; l = l->next)
484 possible_match = l->data;
486 if (g_str_has_prefix (possible_match, prefix))
487 g_ptr_array_add (res,
488 g_strconcat (initial_text, possible_match + strlen (prefix), NULL));
493 return (char**)g_ptr_array_free (res, FALSE);
497 * g_filename_completer_set_dirs_only:
498 * @completer: the filename completer.
499 * @dirs_only: a #gboolean.
501 * If @dirs_only is %TRUE, @completer will only
502 * complete directory names, and not file names.
505 g_filename_completer_set_dirs_only (GFilenameCompleter *completer,
508 g_return_if_fail (G_IS_FILENAME_COMPLETER (completer));
510 completer->dirs_only = dirs_only;
513 #define __G_FILENAME_COMPLETER_C__
514 #include "gioaliasdef.c"