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"
25 #include "gurifuncs.h"
33 * SECTION:gfilenamecompleter
34 * @short_description: Filename Completer
37 * Completes partial file and directory names given a partial string by
38 * looking in the file system for clues. Can return a list of possible
39 * completion strings for widget implementation.
48 static guint signals[LAST_SIGNAL] = { 0 };
51 GFilenameCompleter *completer;
52 GFileEnumerator *enumerator;
53 GCancellable *cancellable;
54 gboolean should_escape;
60 struct _GFilenameCompleter {
64 gboolean basenames_are_escaped;
68 LoadBasenamesData *basename_loader;
71 G_DEFINE_TYPE (GFilenameCompleter, g_filename_completer, G_TYPE_OBJECT);
73 static void cancel_load_basenames (GFilenameCompleter *completer);
76 g_filename_completer_finalize (GObject *object)
78 GFilenameCompleter *completer;
80 completer = G_FILENAME_COMPLETER (object);
82 cancel_load_basenames (completer);
84 if (completer->basenames_dir)
85 g_object_unref (completer->basenames_dir);
87 g_list_foreach (completer->basenames, (GFunc)g_free, NULL);
88 g_list_free (completer->basenames);
90 if (G_OBJECT_CLASS (g_filename_completer_parent_class)->finalize)
91 (*G_OBJECT_CLASS (g_filename_completer_parent_class)->finalize) (object);
95 g_filename_completer_class_init (GFilenameCompleterClass *klass)
97 GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
99 gobject_class->finalize = g_filename_completer_finalize;
101 * GFilenameCompleter::got-completion-data:
103 * Emitted when the file name completion information comes available.
105 signals[GOT_COMPLETION_DATA] = g_signal_new (I_("got_completion_data"),
106 G_TYPE_FILENAME_COMPLETER,
108 G_STRUCT_OFFSET (GFilenameCompleterClass, got_completion_data),
110 g_cclosure_marshal_VOID__VOID,
115 g_filename_completer_init (GFilenameCompleter *completer)
120 * g_filename_completer_new:
122 * Creates a new filename completer.
124 * Returns: a #GFilenameCompleter.
127 g_filename_completer_new (void)
129 return g_object_new (G_TYPE_FILENAME_COMPLETER, NULL);
133 longest_common_prefix (char *a, char *b)
139 while (g_utf8_get_char (a) == g_utf8_get_char (b))
141 a = g_utf8_next_char (a);
142 b = g_utf8_next_char (b);
145 return g_strndup (start, a - start);
149 load_basenames_data_free (LoadBasenamesData *data)
151 if (data->enumerator)
152 g_object_unref (data->enumerator);
154 g_object_unref (data->cancellable);
155 g_object_unref (data->dir);
157 g_list_foreach (data->basenames, (GFunc)g_free, NULL);
158 g_list_free (data->basenames);
164 got_more_files (GObject *source_object,
168 LoadBasenamesData *data = user_data;
172 gboolean append_slash;
176 if (data->completer == NULL)
179 load_basenames_data_free (data);
183 infos = g_file_enumerator_next_files_finish (data->enumerator, res, NULL);
185 for (l = infos; l != NULL; l = l->next)
189 if (data->dirs_only &&
190 g_file_info_get_file_type (info) != G_FILE_TYPE_DIRECTORY)
192 g_object_unref (info);
196 append_slash = g_file_info_get_file_type (info) == G_FILE_TYPE_DIRECTORY;
197 name = g_file_info_get_name (info);
200 g_object_unref (info);
205 if (data->should_escape)
206 basename = g_uri_escape_string (name,
207 G_URI_RESERVED_CHARS_ALLOWED_IN_PATH,
210 /* If not should_escape, must be a local filename, convert to utf8 */
211 basename = g_filename_to_utf8 (name, -1, NULL, NULL, NULL);
218 basename = g_strconcat (basename, "/", NULL);
222 data->basenames = g_list_prepend (data->basenames, basename);
225 g_object_unref (info);
232 /* Not last, get more files */
233 g_file_enumerator_next_files_async (data->enumerator,
237 got_more_files, data);
241 data->completer->basename_loader = NULL;
243 if (data->completer->basenames_dir)
244 g_object_unref (data->completer->basenames_dir);
245 g_list_foreach (data->completer->basenames, (GFunc)g_free, NULL);
246 g_list_free (data->completer->basenames);
248 data->completer->basenames_dir = g_object_ref (data->dir);
249 data->completer->basenames = data->basenames;
250 data->completer->basenames_are_escaped = data->should_escape;
251 data->basenames = NULL;
253 g_file_enumerator_close_async (data->enumerator, 0, NULL, NULL, NULL);
255 g_signal_emit (data->completer, signals[GOT_COMPLETION_DATA], 0);
256 load_basenames_data_free (data);
262 got_enum (GObject *source_object,
266 LoadBasenamesData *data = user_data;
268 if (data->completer == NULL)
271 load_basenames_data_free (data);
275 data->enumerator = g_file_enumerate_children_finish (G_FILE (source_object), res, NULL);
277 if (data->enumerator == NULL)
279 data->completer->basename_loader = NULL;
281 if (data->completer->basenames_dir)
282 g_object_unref (data->completer->basenames_dir);
283 g_list_foreach (data->completer->basenames, (GFunc)g_free, NULL);
284 g_list_free (data->completer->basenames);
286 /* Mark uptodate with no basenames */
287 data->completer->basenames_dir = g_object_ref (data->dir);
288 data->completer->basenames = NULL;
289 data->completer->basenames_are_escaped = data->should_escape;
291 load_basenames_data_free (data);
295 g_file_enumerator_next_files_async (data->enumerator,
299 got_more_files, data);
303 schedule_load_basenames (GFilenameCompleter *completer,
305 gboolean should_escape)
307 LoadBasenamesData *data;
309 cancel_load_basenames (completer);
311 data = g_new0 (LoadBasenamesData, 1);
312 data->completer = completer;
313 data->cancellable = g_cancellable_new ();
314 data->dir = g_object_ref (dir);
315 data->should_escape = should_escape;
316 data->dirs_only = completer->dirs_only;
318 completer->basename_loader = data;
320 g_file_enumerate_children_async (dir,
321 G_FILE_ATTRIBUTE_STANDARD_NAME "," G_FILE_ATTRIBUTE_STANDARD_TYPE,
328 cancel_load_basenames (GFilenameCompleter *completer)
330 LoadBasenamesData *loader;
332 if (completer->basename_loader)
334 loader = completer->basename_loader;
335 loader->completer = NULL;
337 g_cancellable_cancel (loader->cancellable);
339 completer->basename_loader = NULL;
344 /* Returns a list of possible matches and the basename to use for it */
346 init_completion (GFilenameCompleter *completer,
347 const char *initial_text,
350 gboolean should_escape;
351 GFile *file, *parent;
356 *basename_out = NULL;
358 should_escape = ! (g_path_is_absolute (initial_text) || *initial_text == '~');
360 len = strlen (initial_text);
363 initial_text[len - 1] == '/')
366 file = g_file_parse_name (initial_text);
367 parent = g_file_get_parent (file);
370 g_object_unref (file);
374 if (completer->basenames_dir == NULL ||
375 completer->basenames_are_escaped != should_escape ||
376 !g_file_equal (parent, completer->basenames_dir))
378 schedule_load_basenames (completer, parent, should_escape);
379 g_object_unref (file);
383 basename = g_file_get_basename (file);
387 basename = g_uri_escape_string (basename, G_URI_RESERVED_CHARS_ALLOWED_IN_PATH, TRUE);
393 basename = g_filename_to_utf8 (basename, -1, NULL, NULL, NULL);
396 if (basename == NULL)
400 *basename_out = basename;
402 return completer->basenames;
406 * g_filename_completer_get_completion_suffix:
407 * @completer: the filename completer.
408 * @initial_text: text to be completed.
410 * Obtains a completion for @initial_text from @completer.
412 * Returns: a completed string, or %NULL if no completion exists.
413 * This string is not owned by GIO, so remember to g_free() it
417 g_filename_completer_get_completion_suffix (GFilenameCompleter *completer,
418 const char *initial_text)
420 GList *possible_matches, *l;
423 char *possible_match;
426 g_return_val_if_fail (G_IS_FILENAME_COMPLETER (completer), NULL);
427 g_return_val_if_fail (initial_text != NULL, NULL);
429 possible_matches = init_completion (completer, initial_text, &prefix);
433 for (l = possible_matches; l != NULL; l = l->next)
435 possible_match = l->data;
437 if (g_str_has_prefix (possible_match, prefix))
440 suffix = g_strdup (possible_match + strlen (prefix));
443 lcp = longest_common_prefix (suffix,
444 possible_match + strlen (prefix));
460 * g_filename_completer_get_completions:
461 * @completer: the filename completer.
462 * @initial_text: text to be completed.
464 * Gets an array of completion strings for a given initial text.
466 * Returns: array of strings with possible completions for @initial_text.
467 * This array must be freed by g_strfreev() when finished.
470 g_filename_completer_get_completions (GFilenameCompleter *completer,
471 const char *initial_text)
473 GList *possible_matches, *l;
475 char *possible_match;
478 g_return_val_if_fail (G_IS_FILENAME_COMPLETER (completer), NULL);
479 g_return_val_if_fail (initial_text != NULL, NULL);
481 possible_matches = init_completion (completer, initial_text, &prefix);
483 res = g_ptr_array_new ();
484 for (l = possible_matches; l != NULL; l = l->next)
486 possible_match = l->data;
488 if (g_str_has_prefix (possible_match, prefix))
489 g_ptr_array_add (res,
490 g_strconcat (initial_text, possible_match + strlen (prefix), NULL));
495 return (char**)g_ptr_array_free (res, FALSE);
499 * g_filename_completer_set_dirs_only:
500 * @completer: the filename completer.
501 * @dirs_only: a #gboolean.
503 * If @dirs_only is %TRUE, @completer will only
504 * complete directory names, and not file names.
507 g_filename_completer_set_dirs_only (GFilenameCompleter *completer,
510 g_return_if_fail (G_IS_FILENAME_COMPLETER (completer));
512 completer->dirs_only = dirs_only;
515 #define __G_FILENAME_COMPLETER_C__
516 #include "gioaliasdef.c"