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 "gfileenumerator.h"
26 #include "gfileattribute.h"
28 #include "gfileinfo.h"
29 #include "gcancellable.h"
35 * SECTION:gfilenamecompleter
36 * @short_description: Filename Completer
39 * Completes partial file and directory names given a partial string by
40 * looking in the file system for clues. Can return a list of possible
41 * completion strings for widget implementations.
50 static guint signals
[LAST_SIGNAL
] = { 0 };
53 GFilenameCompleter
*completer
;
54 GFileEnumerator
*enumerator
;
55 GCancellable
*cancellable
;
56 gboolean should_escape
;
62 struct _GFilenameCompleter
{
66 gboolean basenames_are_escaped
;
70 LoadBasenamesData
*basename_loader
;
73 G_DEFINE_TYPE (GFilenameCompleter
, g_filename_completer
, G_TYPE_OBJECT
);
75 static void cancel_load_basenames (GFilenameCompleter
*completer
);
78 g_filename_completer_finalize (GObject
*object
)
80 GFilenameCompleter
*completer
;
82 completer
= G_FILENAME_COMPLETER (object
);
84 cancel_load_basenames (completer
);
86 if (completer
->basenames_dir
)
87 g_object_unref (completer
->basenames_dir
);
89 g_list_foreach (completer
->basenames
, (GFunc
)g_free
, NULL
);
90 g_list_free (completer
->basenames
);
92 G_OBJECT_CLASS (g_filename_completer_parent_class
)->finalize (object
);
96 g_filename_completer_class_init (GFilenameCompleterClass
*klass
)
98 GObjectClass
*gobject_class
= G_OBJECT_CLASS (klass
);
100 gobject_class
->finalize
= g_filename_completer_finalize
;
102 * GFilenameCompleter::got-completion-data:
104 * Emitted when the file name completion information comes available.
106 signals
[GOT_COMPLETION_DATA
] = g_signal_new (I_("got-completion-data"),
107 G_TYPE_FILENAME_COMPLETER
,
109 G_STRUCT_OFFSET (GFilenameCompleterClass
, got_completion_data
),
111 g_cclosure_marshal_VOID__VOID
,
116 g_filename_completer_init (GFilenameCompleter
*completer
)
121 * g_filename_completer_new:
123 * Creates a new filename completer.
125 * Returns: a #GFilenameCompleter.
128 g_filename_completer_new (void)
130 return g_object_new (G_TYPE_FILENAME_COMPLETER
, NULL
);
134 longest_common_prefix (char *a
, char *b
)
140 while (g_utf8_get_char (a
) == g_utf8_get_char (b
))
142 a
= g_utf8_next_char (a
);
143 b
= g_utf8_next_char (b
);
146 return g_strndup (start
, a
- start
);
150 load_basenames_data_free (LoadBasenamesData
*data
)
152 if (data
->enumerator
)
153 g_object_unref (data
->enumerator
);
155 g_object_unref (data
->cancellable
);
156 g_object_unref (data
->dir
);
158 g_list_foreach (data
->basenames
, (GFunc
)g_free
, NULL
);
159 g_list_free (data
->basenames
);
165 got_more_files (GObject
*source_object
,
169 LoadBasenamesData
*data
= user_data
;
173 gboolean append_slash
;
177 if (data
->completer
== NULL
)
180 load_basenames_data_free (data
);
184 infos
= g_file_enumerator_next_files_finish (data
->enumerator
, res
, NULL
);
186 for (l
= infos
; l
!= NULL
; l
= l
->next
)
190 if (data
->dirs_only
&&
191 g_file_info_get_file_type (info
) != G_FILE_TYPE_DIRECTORY
)
193 g_object_unref (info
);
197 append_slash
= g_file_info_get_file_type (info
) == G_FILE_TYPE_DIRECTORY
;
198 name
= g_file_info_get_name (info
);
201 g_object_unref (info
);
206 if (data
->should_escape
)
207 basename
= g_uri_escape_string (name
,
208 G_URI_RESERVED_CHARS_ALLOWED_IN_PATH
,
211 /* If not should_escape, must be a local filename, convert to utf8 */
212 basename
= g_filename_to_utf8 (name
, -1, NULL
, NULL
, NULL
);
219 basename
= g_strconcat (basename
, "/", NULL
);
223 data
->basenames
= g_list_prepend (data
->basenames
, basename
);
226 g_object_unref (info
);
233 /* Not last, get more files */
234 g_file_enumerator_next_files_async (data
->enumerator
,
238 got_more_files
, data
);
242 data
->completer
->basename_loader
= NULL
;
244 if (data
->completer
->basenames_dir
)
245 g_object_unref (data
->completer
->basenames_dir
);
246 g_list_foreach (data
->completer
->basenames
, (GFunc
)g_free
, NULL
);
247 g_list_free (data
->completer
->basenames
);
249 data
->completer
->basenames_dir
= g_object_ref (data
->dir
);
250 data
->completer
->basenames
= data
->basenames
;
251 data
->completer
->basenames_are_escaped
= data
->should_escape
;
252 data
->basenames
= NULL
;
254 g_file_enumerator_close_async (data
->enumerator
, 0, NULL
, NULL
, NULL
);
256 g_signal_emit (data
->completer
, signals
[GOT_COMPLETION_DATA
], 0);
257 load_basenames_data_free (data
);
263 got_enum (GObject
*source_object
,
267 LoadBasenamesData
*data
= user_data
;
269 if (data
->completer
== NULL
)
272 load_basenames_data_free (data
);
276 data
->enumerator
= g_file_enumerate_children_finish (G_FILE (source_object
), res
, NULL
);
278 if (data
->enumerator
== NULL
)
280 data
->completer
->basename_loader
= NULL
;
282 if (data
->completer
->basenames_dir
)
283 g_object_unref (data
->completer
->basenames_dir
);
284 g_list_foreach (data
->completer
->basenames
, (GFunc
)g_free
, NULL
);
285 g_list_free (data
->completer
->basenames
);
287 /* Mark uptodate with no basenames */
288 data
->completer
->basenames_dir
= g_object_ref (data
->dir
);
289 data
->completer
->basenames
= NULL
;
290 data
->completer
->basenames_are_escaped
= data
->should_escape
;
292 load_basenames_data_free (data
);
296 g_file_enumerator_next_files_async (data
->enumerator
,
300 got_more_files
, data
);
304 schedule_load_basenames (GFilenameCompleter
*completer
,
306 gboolean should_escape
)
308 LoadBasenamesData
*data
;
310 cancel_load_basenames (completer
);
312 data
= g_new0 (LoadBasenamesData
, 1);
313 data
->completer
= completer
;
314 data
->cancellable
= g_cancellable_new ();
315 data
->dir
= g_object_ref (dir
);
316 data
->should_escape
= should_escape
;
317 data
->dirs_only
= completer
->dirs_only
;
319 completer
->basename_loader
= data
;
321 g_file_enumerate_children_async (dir
,
322 G_FILE_ATTRIBUTE_STANDARD_NAME
"," G_FILE_ATTRIBUTE_STANDARD_TYPE
,
329 cancel_load_basenames (GFilenameCompleter
*completer
)
331 LoadBasenamesData
*loader
;
333 if (completer
->basename_loader
)
335 loader
= completer
->basename_loader
;
336 loader
->completer
= NULL
;
338 g_cancellable_cancel (loader
->cancellable
);
340 completer
->basename_loader
= NULL
;
345 /* Returns a list of possible matches and the basename to use for it */
347 init_completion (GFilenameCompleter
*completer
,
348 const char *initial_text
,
351 gboolean should_escape
;
352 GFile
*file
, *parent
;
357 *basename_out
= NULL
;
359 should_escape
= ! (g_path_is_absolute (initial_text
) || *initial_text
== '~');
361 len
= strlen (initial_text
);
364 initial_text
[len
- 1] == '/')
367 file
= g_file_parse_name (initial_text
);
368 parent
= g_file_get_parent (file
);
371 g_object_unref (file
);
375 if (completer
->basenames_dir
== NULL
||
376 completer
->basenames_are_escaped
!= should_escape
||
377 !g_file_equal (parent
, completer
->basenames_dir
))
379 schedule_load_basenames (completer
, parent
, should_escape
);
380 g_object_unref (file
);
384 basename
= g_file_get_basename (file
);
388 basename
= g_uri_escape_string (basename
, G_URI_RESERVED_CHARS_ALLOWED_IN_PATH
, TRUE
);
394 basename
= g_filename_to_utf8 (basename
, -1, NULL
, NULL
, NULL
);
397 if (basename
== NULL
)
401 *basename_out
= basename
;
403 return completer
->basenames
;
407 * g_filename_completer_get_completion_suffix:
408 * @completer: the filename completer.
409 * @initial_text: text to be completed.
411 * Obtains a completion for @initial_text from @completer.
413 * Returns: a completed string, or %NULL if no completion exists.
414 * This string is not owned by GIO, so remember to g_free() it
418 g_filename_completer_get_completion_suffix (GFilenameCompleter
*completer
,
419 const char *initial_text
)
421 GList
*possible_matches
, *l
;
424 char *possible_match
;
427 g_return_val_if_fail (G_IS_FILENAME_COMPLETER (completer
), NULL
);
428 g_return_val_if_fail (initial_text
!= NULL
, NULL
);
430 possible_matches
= init_completion (completer
, initial_text
, &prefix
);
434 for (l
= possible_matches
; l
!= NULL
; l
= l
->next
)
436 possible_match
= l
->data
;
438 if (g_str_has_prefix (possible_match
, prefix
))
441 suffix
= g_strdup (possible_match
+ strlen (prefix
));
444 lcp
= longest_common_prefix (suffix
,
445 possible_match
+ strlen (prefix
));
461 * g_filename_completer_get_completions:
462 * @completer: the filename completer.
463 * @initial_text: text to be completed.
465 * Gets an array of completion strings for a given initial text.
467 * Returns: (array zero-terminated=1) (transfer full): array of strings with possible completions for @initial_text.
468 * This array must be freed by g_strfreev() when finished.
471 g_filename_completer_get_completions (GFilenameCompleter
*completer
,
472 const char *initial_text
)
474 GList
*possible_matches
, *l
;
476 char *possible_match
;
479 g_return_val_if_fail (G_IS_FILENAME_COMPLETER (completer
), NULL
);
480 g_return_val_if_fail (initial_text
!= NULL
, NULL
);
482 possible_matches
= init_completion (completer
, initial_text
, &prefix
);
484 res
= g_ptr_array_new ();
485 for (l
= possible_matches
; l
!= NULL
; l
= l
->next
)
487 possible_match
= l
->data
;
489 if (g_str_has_prefix (possible_match
, prefix
))
490 g_ptr_array_add (res
,
491 g_strconcat (initial_text
, possible_match
+ strlen (prefix
), NULL
));
496 g_ptr_array_add (res
, NULL
);
498 return (char**)g_ptr_array_free (res
, FALSE
);
502 * g_filename_completer_set_dirs_only:
503 * @completer: the filename completer.
504 * @dirs_only: a #gboolean.
506 * If @dirs_only is %TRUE, @completer will only
507 * complete directory names, and not file names.
510 g_filename_completer_set_dirs_only (GFilenameCompleter
*completer
,
513 g_return_if_fail (G_IS_FILENAME_COMPLETER (completer
));
515 completer
->dirs_only
= dirs_only
;