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"
31 * SECTION:gfilenamecompleter
32 * @short_description: Filename Completer.
34 * Completes partial file and directory names given a partial string by
35 * looking in the file system for clues. Can return a list of possible
36 * completion strings for widget implementation.
45 static guint signals[LAST_SIGNAL] = { 0 };
48 GFilenameCompleter *completer;
49 GFileEnumerator *enumerator;
50 GCancellable *cancellable;
51 gboolean should_escape;
57 struct _GFilenameCompleter {
61 gboolean basenames_are_escaped;
65 LoadBasenamesData *basename_loader;
68 G_DEFINE_TYPE (GFilenameCompleter, g_filename_completer, G_TYPE_OBJECT);
70 static void cancel_load_basenames (GFilenameCompleter *completer);
73 g_filename_completer_finalize (GObject *object)
75 GFilenameCompleter *completer;
77 completer = G_FILENAME_COMPLETER (object);
79 cancel_load_basenames (completer);
81 if (completer->basenames_dir)
82 g_object_unref (completer->basenames_dir);
84 g_list_foreach (completer->basenames, (GFunc)g_free, NULL);
85 g_list_free (completer->basenames);
87 if (G_OBJECT_CLASS (g_filename_completer_parent_class)->finalize)
88 (*G_OBJECT_CLASS (g_filename_completer_parent_class)->finalize) (object);
92 g_filename_completer_class_init (GFilenameCompleterClass *klass)
94 GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
96 gobject_class->finalize = g_filename_completer_finalize;
98 * GFilenameCompleter::got-completion-data:
100 * Emitted when the file name completion information comes available.
102 signals[GOT_COMPLETION_DATA] = g_signal_new (I_("got_completion_data"),
103 G_TYPE_FILENAME_COMPLETER,
105 G_STRUCT_OFFSET (GFilenameCompleterClass, got_completion_data),
107 g_cclosure_marshal_VOID__VOID,
112 g_filename_completer_init (GFilenameCompleter *completer)
117 * g_filename_completer_new:
119 * Creates a new filename completer.
121 * Returns: a #GFilenameCompleter.
124 g_filename_completer_new (void)
126 return g_object_new (G_TYPE_FILENAME_COMPLETER, NULL);
130 longest_common_prefix (char *a, char *b)
136 while (g_utf8_get_char (a) == g_utf8_get_char (b))
138 a = g_utf8_next_char (a);
139 b = g_utf8_next_char (b);
142 return g_strndup (start, a - start);
146 load_basenames_data_free (LoadBasenamesData *data)
148 if (data->enumerator)
149 g_object_unref (data->enumerator);
151 g_object_unref (data->cancellable);
152 g_object_unref (data->dir);
154 g_list_foreach (data->basenames, (GFunc)g_free, NULL);
155 g_list_free (data->basenames);
161 got_more_files (GObject *source_object,
165 LoadBasenamesData *data = user_data;
169 gboolean append_slash;
173 if (data->completer == NULL)
176 load_basenames_data_free (data);
180 infos = g_file_enumerator_next_files_finish (data->enumerator, res, NULL);
182 for (l = infos; l != NULL; l = l->next)
186 if (data->dirs_only &&
187 g_file_info_get_file_type (info) != G_FILE_TYPE_DIRECTORY)
189 g_object_unref (info);
193 append_slash = g_file_info_get_file_type (info) == G_FILE_TYPE_DIRECTORY;
194 name = g_file_info_get_name (info);
197 g_object_unref (info);
202 if (data->should_escape)
203 basename = g_uri_escape_string (name,
204 G_URI_RESERVED_CHARS_ALLOWED_IN_PATH,
207 /* If not should_escape, must be a local filename, convert to utf8 */
208 basename = g_filename_to_utf8 (name, -1, NULL, NULL, NULL);
215 basename = g_strconcat (basename, "/", NULL);
219 data->basenames = g_list_prepend (data->basenames, basename);
222 g_object_unref (info);
229 /* Not last, get more files */
230 g_file_enumerator_next_files_async (data->enumerator,
234 got_more_files, data);
238 data->completer->basename_loader = NULL;
240 if (data->completer->basenames_dir)
241 g_object_unref (data->completer->basenames_dir);
242 g_list_foreach (data->completer->basenames, (GFunc)g_free, NULL);
243 g_list_free (data->completer->basenames);
245 data->completer->basenames_dir = g_object_ref (data->dir);
246 data->completer->basenames = data->basenames;
247 data->completer->basenames_are_escaped = data->should_escape;
248 data->basenames = NULL;
250 g_file_enumerator_close_async (data->enumerator, 0, NULL, NULL, NULL);
252 g_signal_emit (data->completer, signals[GOT_COMPLETION_DATA], 0);
253 load_basenames_data_free (data);
259 got_enum (GObject *source_object,
263 LoadBasenamesData *data = user_data;
265 if (data->completer == NULL)
268 load_basenames_data_free (data);
272 data->enumerator = g_file_enumerate_children_finish (G_FILE (source_object), res, NULL);
274 if (data->enumerator == NULL)
276 data->completer->basename_loader = NULL;
278 if (data->completer->basenames_dir)
279 g_object_unref (data->completer->basenames_dir);
280 g_list_foreach (data->completer->basenames, (GFunc)g_free, NULL);
281 g_list_free (data->completer->basenames);
283 /* Mark uptodate with no basenames */
284 data->completer->basenames_dir = g_object_ref (data->dir);
285 data->completer->basenames = NULL;
286 data->completer->basenames_are_escaped = data->should_escape;
288 load_basenames_data_free (data);
292 g_file_enumerator_next_files_async (data->enumerator,
296 got_more_files, data);
300 schedule_load_basenames (GFilenameCompleter *completer,
302 gboolean should_escape)
304 LoadBasenamesData *data;
306 cancel_load_basenames (completer);
308 data = g_new0 (LoadBasenamesData, 1);
309 data->completer = completer;
310 data->cancellable = g_cancellable_new ();
311 data->dir = g_object_ref (dir);
312 data->should_escape = should_escape;
313 data->dirs_only = completer->dirs_only;
315 completer->basename_loader = data;
317 g_file_enumerate_children_async (dir,
318 G_FILE_ATTRIBUTE_STD_NAME "," G_FILE_ATTRIBUTE_STD_TYPE,
325 cancel_load_basenames (GFilenameCompleter *completer)
327 LoadBasenamesData *loader;
329 if (completer->basename_loader)
331 loader = completer->basename_loader;
332 loader->completer = NULL;
334 g_cancellable_cancel (loader->cancellable);
336 completer->basename_loader = NULL;
341 /* Returns a list of possible matches and the basename to use for it */
343 init_completion (GFilenameCompleter *completer,
344 const char *initial_text,
347 gboolean should_escape;
348 GFile *file, *parent;
353 *basename_out = NULL;
355 should_escape = ! (g_path_is_absolute (initial_text) || *initial_text == '~');
357 len = strlen (initial_text);
360 initial_text[len - 1] == '/')
363 file = g_file_parse_name (initial_text);
364 parent = g_file_get_parent (file);
367 g_object_unref (file);
371 if (completer->basenames_dir == NULL ||
372 completer->basenames_are_escaped != should_escape ||
373 !g_file_equal (parent, completer->basenames_dir))
375 schedule_load_basenames (completer, parent, should_escape);
376 g_object_unref (file);
380 basename = g_file_get_basename (file);
384 basename = g_uri_escape_string (basename, G_URI_RESERVED_CHARS_ALLOWED_IN_PATH, TRUE);
390 basename = g_filename_to_utf8 (basename, -1, NULL, NULL, NULL);
393 if (basename == NULL)
397 *basename_out = basename;
399 return completer->basenames;
403 * g_filename_completer_get_completion_suffix:
404 * @completer: the filename completer.
405 * @initial_text: text to be completed.
407 * Returns: a completed string. This string is not owned by GIO, so
408 * remember to g_free() it when finished.
411 g_filename_completer_get_completion_suffix (GFilenameCompleter *completer,
412 const char *initial_text)
414 GList *possible_matches, *l;
417 char *possible_match;
420 g_return_val_if_fail (G_IS_FILENAME_COMPLETER (completer), NULL);
421 g_return_val_if_fail (initial_text != NULL, NULL);
423 possible_matches = init_completion (completer, initial_text, &prefix);
427 for (l = possible_matches; l != NULL; l = l->next)
429 possible_match = l->data;
431 if (g_str_has_prefix (possible_match, prefix))
434 suffix = g_strdup (possible_match + strlen (prefix));
437 lcp = longest_common_prefix (suffix,
438 possible_match + strlen (prefix));
454 * g_filename_completer_get_completions:
455 * @completer: the filename completer.
456 * @initial_text: text to be completed.
458 * Gets an array of completion strings for a given initial text.
460 * Returns: array of strings with possible completions for @initial_text.
461 * This array must be freed by g_strfreev() when finished.
464 g_filename_completer_get_completions (GFilenameCompleter *completer,
465 const char *initial_text)
467 GList *possible_matches, *l;
469 char *possible_match;
472 g_return_val_if_fail (G_IS_FILENAME_COMPLETER (completer), NULL);
473 g_return_val_if_fail (initial_text != NULL, NULL);
475 possible_matches = init_completion (completer, initial_text, &prefix);
477 res = g_ptr_array_new ();
478 for (l = possible_matches; l != NULL; l = l->next)
480 possible_match = l->data;
482 if (g_str_has_prefix (possible_match, prefix))
483 g_ptr_array_add (res,
484 g_strconcat (initial_text, possible_match + strlen (prefix), NULL));
489 return (char**)g_ptr_array_free (res, FALSE);
493 * g_filename_completer_set_dirs_only:
494 * @completer: the filename completer.
495 * @dirs_only: a #gboolean.
497 * If @dirs_only is %TRUE, @completer will only
498 * complete directory names, and not file names.
501 g_filename_completer_set_dirs_only (GFilenameCompleter *completer,
504 g_return_if_fail (G_IS_FILENAME_COMPLETER (completer));
506 completer->dirs_only = dirs_only;