]> Pileus Git - ~andy/gtk/blob - gtk/gtkfilechooserentry.c
API: Rename gtk_cairo_paint_*() to gtk_paint_*()
[~andy/gtk] / gtk / gtkfilechooserentry.c
1 /* GTK - The GIMP Toolkit
2  * gtkfilechooserentry.c: Entry with filename completion
3  * Copyright (C) 2003, Red Hat, Inc.
4  *
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.
9  *
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.
14  *
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.
19  */
20
21 #include "config.h"
22
23 #include "gtkfilechooserentry.h"
24
25 #include <string.h>
26
27 #include "gtkalignment.h"
28 #include "gtkcelllayout.h"
29 #include "gtkcellrenderertext.h"
30 #include "gtkentry.h"
31 #include "gtklabel.h"
32 #include "gtkmain.h"
33 #include "gtksizerequest.h"
34 #include "gtkwindow.h"
35 #include "gtkintl.h"
36
37 #include "gdkkeysyms.h"
38
39 typedef struct _GtkFileChooserEntryClass GtkFileChooserEntryClass;
40
41 #define GTK_FILE_CHOOSER_ENTRY_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_FILE_CHOOSER_ENTRY, GtkFileChooserEntryClass))
42 #define GTK_IS_FILE_CHOOSER_ENTRY_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_FILE_CHOOSER_ENTRY))
43 #define GTK_FILE_CHOOSER_ENTRY_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_FILE_CHOOSER_ENTRY, GtkFileChooserEntryClass))
44
45 struct _GtkFileChooserEntryClass
46 {
47   GtkEntryClass parent_class;
48 };
49
50 /* Action to take when the current folder finishes loading (for explicit or automatic completion) */
51 typedef enum {
52   LOAD_COMPLETE_NOTHING,
53   LOAD_COMPLETE_AUTOCOMPLETE,
54   LOAD_COMPLETE_EXPLICIT_COMPLETION
55 } LoadCompleteAction;
56
57 typedef enum
58 {
59   REFRESH_OK,
60   REFRESH_INVALID_INPUT,
61   REFRESH_INCOMPLETE_HOSTNAME,
62   REFRESH_NONEXISTENT,
63   REFRESH_NOT_LOCAL
64 } RefreshStatus;
65
66 struct _GtkFileChooserEntry
67 {
68   GtkEntry parent_instance;
69
70   GtkFileChooserAction action;
71
72   GtkFileSystem *file_system;
73   GFile *base_folder;
74   GFile *current_folder_file;
75   gchar *file_part;
76   gint file_part_pos;
77
78   /* Folder being loaded or already loaded */
79   GtkFolder *current_folder;
80   GCancellable *load_folder_cancellable;
81
82   LoadCompleteAction load_complete_action;
83
84   GtkListStore *completion_store;
85
86   guint start_autocompletion_idle_id;
87
88   GtkWidget *completion_feedback_window;
89   GtkWidget *completion_feedback_label;
90   guint completion_feedback_timeout_id;
91
92   guint has_completion : 1;
93   guint in_change      : 1;
94   guint eat_tabs       : 1;
95   guint local_only     : 1;
96 };
97
98 enum
99 {
100   DISPLAY_NAME_COLUMN,
101   FILE_COLUMN,
102   N_COLUMNS
103 };
104
105 #define COMPLETION_FEEDBACK_TIMEOUT_MS 2000
106
107 static void     gtk_file_chooser_entry_iface_init     (GtkEditableInterface *iface);
108
109 static void     gtk_file_chooser_entry_finalize       (GObject          *object);
110 static void     gtk_file_chooser_entry_dispose        (GObject          *object);
111 static void     gtk_file_chooser_entry_grab_focus     (GtkWidget        *widget);
112 static void     gtk_file_chooser_entry_unmap          (GtkWidget        *widget);
113 static gboolean gtk_file_chooser_entry_key_press_event (GtkWidget *widget,
114                                                         GdkEventKey *event);
115 static gboolean gtk_file_chooser_entry_focus_out_event (GtkWidget       *widget,
116                                                         GdkEventFocus   *event);
117 static void     gtk_file_chooser_entry_activate       (GtkEntry         *entry);
118 static void     gtk_file_chooser_entry_do_insert_text (GtkEditable *editable,
119                                                        const gchar *new_text,
120                                                        gint         new_text_length,
121                                                        gint        *position);
122 static void     gtk_file_chooser_entry_do_delete_text (GtkEditable *editable,
123                                                        gint         start_pos,
124                                                        gint         end_pos);
125 static void     gtk_file_chooser_entry_set_position (GtkEditable *editable,
126                                                      gint         position);
127 static void     gtk_file_chooser_entry_set_selection_bounds (GtkEditable *editable,
128                                                              gint         start_pos,
129                                                              gint         end_pos);
130
131 #ifdef G_OS_WIN32
132 static gint     insert_text_callback      (GtkFileChooserEntry *widget,
133                                            const gchar         *new_text,
134                                            gint                 new_text_length,
135                                            gint                *position,
136                                            gpointer             user_data);
137 static void     delete_text_callback      (GtkFileChooserEntry *widget,
138                                            gint                 start_pos,
139                                            gint                 end_pos,
140                                            gpointer             user_data);
141 #endif
142
143 static gboolean match_selected_callback   (GtkEntryCompletion  *completion,
144                                            GtkTreeModel        *model,
145                                            GtkTreeIter         *iter,
146                                            GtkFileChooserEntry *chooser_entry);
147 static gboolean completion_match_func     (GtkEntryCompletion  *comp,
148                                            const char          *key,
149                                            GtkTreeIter         *iter,
150                                            gpointer             data);
151 static char    *maybe_append_separator_to_file (GtkFileChooserEntry *chooser_entry,
152                                                 GFile               *file,
153                                                 gchar               *display_name,
154                                                 gboolean            *appended);
155
156 typedef enum {
157   REFRESH_UP_TO_CURSOR_POSITION,
158   REFRESH_WHOLE_TEXT
159 } RefreshMode;
160
161 static RefreshStatus refresh_current_folder_and_file_part (GtkFileChooserEntry *chooser_entry,
162                                                   RefreshMode refresh_mode);
163 static void finished_loading_cb (GtkFolder *folder,
164                                  gpointer   data);
165 static void autocomplete (GtkFileChooserEntry *chooser_entry);
166 static void install_start_autocompletion_idle (GtkFileChooserEntry *chooser_entry);
167 static void remove_completion_feedback (GtkFileChooserEntry *chooser_entry);
168 static void pop_up_completion_feedback (GtkFileChooserEntry *chooser_entry,
169                                         const gchar         *feedback);
170
171 static GtkEditableInterface *parent_editable_iface;
172
173 G_DEFINE_TYPE_WITH_CODE (GtkFileChooserEntry, _gtk_file_chooser_entry, GTK_TYPE_ENTRY,
174                          G_IMPLEMENT_INTERFACE (GTK_TYPE_EDITABLE,
175                                                 gtk_file_chooser_entry_iface_init))
176
177 static void
178 _gtk_file_chooser_entry_class_init (GtkFileChooserEntryClass *class)
179 {
180   GObjectClass *gobject_class = G_OBJECT_CLASS (class);
181   GtkWidgetClass *widget_class = GTK_WIDGET_CLASS (class);
182   GtkEntryClass *entry_class = GTK_ENTRY_CLASS (class);
183
184   gobject_class->finalize = gtk_file_chooser_entry_finalize;
185   gobject_class->dispose = gtk_file_chooser_entry_dispose;
186
187   widget_class->grab_focus = gtk_file_chooser_entry_grab_focus;
188   widget_class->unmap = gtk_file_chooser_entry_unmap;
189   widget_class->key_press_event = gtk_file_chooser_entry_key_press_event;
190   widget_class->focus_out_event = gtk_file_chooser_entry_focus_out_event;
191
192   entry_class->activate = gtk_file_chooser_entry_activate;
193 }
194
195 static void
196 gtk_file_chooser_entry_iface_init (GtkEditableInterface *iface)
197 {
198   parent_editable_iface = g_type_interface_peek_parent (iface);
199
200   iface->do_insert_text = gtk_file_chooser_entry_do_insert_text;
201   iface->do_delete_text = gtk_file_chooser_entry_do_delete_text;
202   iface->set_position = gtk_file_chooser_entry_set_position;
203   iface->set_selection_bounds = gtk_file_chooser_entry_set_selection_bounds;
204 }
205
206 static void
207 _gtk_file_chooser_entry_init (GtkFileChooserEntry *chooser_entry)
208 {
209   GtkEntryCompletion *comp;
210   GtkCellRenderer *cell;
211
212   chooser_entry->local_only = TRUE;
213
214   g_object_set (chooser_entry, "truncate-multiline", TRUE, NULL);
215
216   comp = gtk_entry_completion_new ();
217   gtk_entry_completion_set_popup_single_match (comp, FALSE);
218
219   gtk_entry_completion_set_match_func (comp,
220                                        completion_match_func,
221                                        chooser_entry,
222                                        NULL);
223
224   cell = gtk_cell_renderer_text_new ();
225   gtk_cell_layout_pack_start (GTK_CELL_LAYOUT (comp),
226                               cell, TRUE);
227   gtk_cell_layout_add_attribute (GTK_CELL_LAYOUT (comp),
228                                  cell,
229                                  "text", 0);
230
231   g_signal_connect (comp, "match-selected",
232                     G_CALLBACK (match_selected_callback), chooser_entry);
233
234   gtk_entry_set_completion (GTK_ENTRY (chooser_entry), comp);
235   g_object_unref (comp);
236
237 #ifdef G_OS_WIN32
238   g_signal_connect (chooser_entry, "insert-text",
239                     G_CALLBACK (insert_text_callback), NULL);
240   g_signal_connect (chooser_entry, "delete-text",
241                     G_CALLBACK (delete_text_callback), NULL);
242 #endif
243 }
244
245 static void
246 gtk_file_chooser_entry_finalize (GObject *object)
247 {
248   GtkFileChooserEntry *chooser_entry = GTK_FILE_CHOOSER_ENTRY (object);
249
250   if (chooser_entry->base_folder)
251     g_object_unref (chooser_entry->base_folder);
252
253   if (chooser_entry->current_folder)
254     g_object_unref (chooser_entry->current_folder);
255
256   if (chooser_entry->current_folder_file)
257     g_object_unref (chooser_entry->current_folder_file);
258
259   g_free (chooser_entry->file_part);
260
261   G_OBJECT_CLASS (_gtk_file_chooser_entry_parent_class)->finalize (object);
262 }
263
264 static void
265 discard_current_folder (GtkFileChooserEntry *chooser_entry)
266 {
267   if (chooser_entry->current_folder)
268     {
269       g_signal_handlers_disconnect_by_func (chooser_entry->current_folder,
270                                             G_CALLBACK (finished_loading_cb), chooser_entry);
271       g_object_unref (chooser_entry->current_folder);
272       chooser_entry->current_folder = NULL;
273     }
274 }
275
276 static void
277 discard_loading_and_current_folder_file (GtkFileChooserEntry *chooser_entry)
278 {
279   if (chooser_entry->load_folder_cancellable)
280     {
281       g_cancellable_cancel (chooser_entry->load_folder_cancellable);
282       chooser_entry->load_folder_cancellable = NULL;
283     }
284
285   if (chooser_entry->current_folder_file)
286     {
287       g_object_unref (chooser_entry->current_folder_file);
288       chooser_entry->current_folder_file = NULL;
289     }
290 }
291
292 static void
293 gtk_file_chooser_entry_dispose (GObject *object)
294 {
295   GtkFileChooserEntry *chooser_entry = GTK_FILE_CHOOSER_ENTRY (object);
296
297   remove_completion_feedback (chooser_entry);
298   discard_current_folder (chooser_entry);
299   discard_loading_and_current_folder_file (chooser_entry);
300
301   if (chooser_entry->start_autocompletion_idle_id != 0)
302     {
303       g_source_remove (chooser_entry->start_autocompletion_idle_id);
304       chooser_entry->start_autocompletion_idle_id = 0;
305     }
306
307   if (chooser_entry->completion_store)
308     {
309       g_object_unref (chooser_entry->completion_store);
310       chooser_entry->completion_store = NULL;
311     }
312
313   if (chooser_entry->file_system)
314     {
315       g_object_unref (chooser_entry->file_system);
316       chooser_entry->file_system = NULL;
317     }
318
319   G_OBJECT_CLASS (_gtk_file_chooser_entry_parent_class)->dispose (object);
320 }
321
322 /* Match functions for the GtkEntryCompletion */
323 static gboolean
324 match_selected_callback (GtkEntryCompletion  *completion,
325                          GtkTreeModel        *model,
326                          GtkTreeIter         *iter,
327                          GtkFileChooserEntry *chooser_entry)
328 {
329   char *display_name;
330   GFile *file;
331   gint pos;
332   gboolean dummy;
333   
334   gtk_tree_model_get (model, iter,
335                       DISPLAY_NAME_COLUMN, &display_name,
336                       FILE_COLUMN, &file,
337                       -1);
338
339   if (!display_name || !file)
340     {
341       /* these shouldn't complain if passed NULL */
342       g_object_unref (file);
343       g_free (display_name);
344       return FALSE;
345     }
346
347   display_name = maybe_append_separator_to_file (chooser_entry, file, display_name, &dummy);
348
349   pos = chooser_entry->file_part_pos;
350
351   /* We don't set in_change here as we want to update the current_folder
352    * variable */
353   gtk_editable_delete_text (GTK_EDITABLE (chooser_entry),
354                             pos, -1);
355   gtk_editable_insert_text (GTK_EDITABLE (chooser_entry),
356                             display_name, -1, 
357                             &pos);
358   gtk_editable_set_position (GTK_EDITABLE (chooser_entry), -1);
359
360   g_object_unref (file);
361   g_free (display_name);
362
363   return TRUE;
364 }
365
366 /* Match function for the GtkEntryCompletion */
367 static gboolean
368 completion_match_func (GtkEntryCompletion *comp,
369                        const char         *key_unused,
370                        GtkTreeIter        *iter,
371                        gpointer            data)
372 {
373   GtkFileChooserEntry *chooser_entry;
374   char *name;
375   gboolean result;
376   char *norm_file_part;
377   char *norm_name;
378
379   chooser_entry = GTK_FILE_CHOOSER_ENTRY (data);
380
381   /* We ignore the key because it is the contents of the entry.  Instead, we
382    * just use our precomputed file_part.
383    */
384   if (!chooser_entry->file_part)
385     {
386       return FALSE;
387     }
388
389   gtk_tree_model_get (GTK_TREE_MODEL (chooser_entry->completion_store), iter, DISPLAY_NAME_COLUMN, &name, -1);
390   if (!name)
391     {
392       return FALSE; /* Uninitialized row, ugh */
393     }
394
395   /* If we have an empty file_part, then we're at the root of a directory.  In
396    * that case, we want to match all non-dot files.  We might want to match
397    * dot_files too if show_hidden is TRUE on the fileselector in the future.
398    */
399   /* Additionally, support for gnome .hidden files would be sweet, too */
400   if (chooser_entry->file_part[0] == '\000')
401     {
402       if (name[0] == '.')
403         result = FALSE;
404       else
405         result = TRUE;
406       g_free (name);
407
408       return result;
409     }
410
411
412   norm_file_part = g_utf8_normalize (chooser_entry->file_part, -1, G_NORMALIZE_ALL);
413   norm_name = g_utf8_normalize (name, -1, G_NORMALIZE_ALL);
414
415 #ifdef G_PLATFORM_WIN32
416   {
417     gchar *temp;
418
419     temp = norm_file_part;
420     norm_file_part = g_utf8_casefold (norm_file_part, -1);
421     g_free (temp);
422
423     temp = norm_name;
424     norm_name = g_utf8_casefold (norm_name, -1);
425     g_free (temp);
426   }
427 #endif
428
429   result = (strncmp (norm_file_part, norm_name, strlen (norm_file_part)) == 0);
430
431   g_free (norm_file_part);
432   g_free (norm_name);
433   g_free (name);
434   
435   return result;
436 }
437
438 static void
439 clear_completions (GtkFileChooserEntry *chooser_entry)
440 {
441   chooser_entry->has_completion = FALSE;
442   chooser_entry->load_complete_action = LOAD_COMPLETE_NOTHING;
443
444   remove_completion_feedback (chooser_entry);
445 }
446
447 static void
448 beep (GtkFileChooserEntry *chooser_entry)
449 {
450   gtk_widget_error_bell (GTK_WIDGET (chooser_entry));
451 }
452
453 /* This function will append a directory separator to paths to
454  * display_name iff the path associated with it is a directory.
455  * maybe_append_separator_to_file will g_free the display_name and
456  * return a new one if needed.  Otherwise, it will return the old one.
457  * You should be safe calling
458  *
459  * display_name = maybe_append_separator_to_file (entry, file, display_name, &appended);
460  * ...
461  * g_free (display_name);
462  */
463 static char *
464 maybe_append_separator_to_file (GtkFileChooserEntry *chooser_entry,
465                                 GFile               *file,
466                                 gchar               *display_name,
467                                 gboolean            *appended)
468 {
469   *appended = FALSE;
470
471   if (!g_str_has_suffix (display_name, G_DIR_SEPARATOR_S) && file)
472     {
473       GFileInfo *info;
474
475       info = _gtk_folder_get_info (chooser_entry->current_folder, file);
476
477       if (info)
478         {
479           if (_gtk_file_info_consider_as_directory (info))
480             {
481               gchar *tmp = display_name;
482               display_name = g_strconcat (tmp, G_DIR_SEPARATOR_S, NULL);
483               *appended = TRUE;
484               g_free (tmp);
485             }
486
487           g_object_unref (info);
488         }
489     }
490
491   return display_name;
492 }
493
494 static char *
495 trim_dir_separator_suffix (const char *str)
496 {
497   int len;
498
499   len = strlen (str);
500   if (len > 0 && G_IS_DIR_SEPARATOR (str[len - 1]))
501     return g_strndup (str, len - 1);
502   else
503     return g_strdup (str);
504 }
505
506 /* Determines if the completion model has entries with a common prefix relative
507  * to the current contents of the entry.  Also, if there's one and only one such
508  * path, stores it in unique_path_ret.
509  */
510 static gboolean
511 find_common_prefix (GtkFileChooserEntry *chooser_entry,
512                     gchar               **common_prefix_ret,
513                     GFile               **unique_file_ret,
514                     gboolean             *is_complete_not_unique_ret,
515                     gboolean             *prefix_expands_the_file_part_ret,
516                     GError              **error)
517 {
518   GtkEditable *editable;
519   GtkTreeIter iter;
520   gboolean parsed;
521   gboolean valid;
522   char *text_up_to_cursor;
523   GFile *parsed_folder_file;
524   char *parsed_file_part;
525
526   *common_prefix_ret = NULL;
527   *unique_file_ret = NULL;
528   *is_complete_not_unique_ret = FALSE;
529   *prefix_expands_the_file_part_ret = FALSE;
530
531   editable = GTK_EDITABLE (chooser_entry);
532
533   text_up_to_cursor = gtk_editable_get_chars (editable, 0, gtk_editable_get_position (editable));
534
535   parsed = _gtk_file_system_parse (chooser_entry->file_system,
536                                    chooser_entry->base_folder,
537                                    text_up_to_cursor,
538                                    &parsed_folder_file,
539                                    &parsed_file_part,
540                                    error);
541
542   g_free (text_up_to_cursor);
543
544   if (!parsed)
545     return FALSE;
546
547   g_assert (parsed_folder_file != NULL
548             && chooser_entry->current_folder != NULL
549             && g_file_equal (parsed_folder_file, chooser_entry->current_folder_file));
550
551   g_object_unref (parsed_folder_file);
552
553   /* First pass: find the common prefix */
554
555   valid = gtk_tree_model_get_iter_first (GTK_TREE_MODEL (chooser_entry->completion_store), &iter);
556
557   while (valid)
558     {
559       gchar *display_name;
560       GFile *file;
561
562       gtk_tree_model_get (GTK_TREE_MODEL (chooser_entry->completion_store),
563                           &iter,
564                           DISPLAY_NAME_COLUMN, &display_name,
565                           FILE_COLUMN, &file,
566                           -1);
567
568       if (g_str_has_prefix (display_name, parsed_file_part))
569         {
570           if (!*common_prefix_ret)
571             {
572               *common_prefix_ret = trim_dir_separator_suffix (display_name);
573               *unique_file_ret = g_object_ref (file);
574             }
575           else
576             {
577               gchar *p = *common_prefix_ret;
578               const gchar *q = display_name;
579
580               while (*p && *p == *q)
581                 {
582                   p++;
583                   q++;
584                 }
585
586               *p = '\0';
587
588               if (*unique_file_ret)
589                 {
590                   g_object_unref (*unique_file_ret);
591                   *unique_file_ret = NULL;
592                 }
593             }
594         }
595
596       g_free (display_name);
597       g_object_unref (file);
598       valid = gtk_tree_model_iter_next (GTK_TREE_MODEL (chooser_entry->completion_store), &iter);
599     }
600
601   /* Second pass: see if the prefix we found is a complete match */
602
603   if (*common_prefix_ret != NULL)
604     {
605       valid = gtk_tree_model_get_iter_first (GTK_TREE_MODEL (chooser_entry->completion_store), &iter);
606
607       while (valid)
608         {
609           gchar *display_name;
610           int len;
611
612           gtk_tree_model_get (GTK_TREE_MODEL (chooser_entry->completion_store),
613                               &iter,
614                               DISPLAY_NAME_COLUMN, &display_name,
615                               -1);
616           len = strlen (display_name);
617           g_assert (len > 0);
618
619           if (G_IS_DIR_SEPARATOR (display_name[len - 1]))
620             len--;
621
622           if (*unique_file_ret == NULL && strncmp (*common_prefix_ret, display_name, len) == 0)
623             *is_complete_not_unique_ret = TRUE;
624
625           g_free (display_name);
626           valid = gtk_tree_model_iter_next (GTK_TREE_MODEL (chooser_entry->completion_store), &iter);
627         }
628
629       /* Finally:  Did we generate a new completion, or was the user's input already completed as far as it could go? */
630
631       *prefix_expands_the_file_part_ret = g_utf8_strlen (*common_prefix_ret, -1) > g_utf8_strlen (parsed_file_part, -1);
632     }
633
634   g_free (parsed_file_part);
635
636   return TRUE;
637 }
638
639 static gboolean
640 char_after_cursor_is_directory_separator (GtkFileChooserEntry *chooser_entry)
641 {
642   int cursor_pos;
643   gboolean result;
644
645   result = FALSE;
646
647   cursor_pos = gtk_editable_get_position (GTK_EDITABLE (chooser_entry));
648   if (cursor_pos < gtk_entry_get_text_length (GTK_ENTRY (chooser_entry)))
649     {
650       char *next_char_str;
651
652       next_char_str = gtk_editable_get_chars (GTK_EDITABLE (chooser_entry), cursor_pos, cursor_pos + 1);
653       if (G_IS_DIR_SEPARATOR (*next_char_str))
654         result = TRUE;
655
656       g_free (next_char_str);
657     }
658
659   return result;
660 }
661
662 typedef enum {
663   INVALID_INPUT,                /* what the user typed is bogus */
664   NO_MATCH,                     /* no matches based on what the user typed */
665   NOTHING_INSERTED_COMPLETE,    /* what the user typed is already completed as far as it will go */
666   NOTHING_INSERTED_UNIQUE,      /* what the user typed is already completed, and is a unique match */
667   COMPLETED,                    /* completion inserted (ambiguous suffix) */
668   COMPLETED_UNIQUE,             /* completion inserted, and it is a complete name and a unique match */
669   COMPLETE_BUT_NOT_UNIQUE       /* completion inserted, it is a complete name but not unique */
670 } CommonPrefixResult;
671
672 /* Finds a common prefix based on the contents of the entry and mandatorily appends it */
673 static CommonPrefixResult
674 append_common_prefix (GtkFileChooserEntry *chooser_entry,
675                       gboolean             highlight,
676                       gboolean             show_errors)
677 {
678   gchar *common_prefix;
679   GFile *unique_file;
680   gboolean is_complete_not_unique;
681   gboolean prefix_expands_the_file_part;
682   GError *error;
683   CommonPrefixResult result = NO_MATCH;
684   gboolean have_result;
685
686   clear_completions (chooser_entry);
687
688   if (chooser_entry->completion_store == NULL)
689     return NO_MATCH;
690
691   error = NULL;
692   if (!find_common_prefix (chooser_entry, &common_prefix, &unique_file, &is_complete_not_unique, &prefix_expands_the_file_part, &error))
693     {
694       /* If the user types an incomplete hostname ("http://foo" without a slash
695        * after that), it's not an error.  We just don't want to pop up a
696        * meaningless completion window in that state.
697        */
698       if (!g_error_matches (error, GTK_FILE_CHOOSER_ERROR, GTK_FILE_CHOOSER_ERROR_INCOMPLETE_HOSTNAME)
699           && show_errors)
700         {
701           beep (chooser_entry);
702           pop_up_completion_feedback (chooser_entry, _("Invalid path"));
703         }
704
705       g_error_free (error);
706
707       return INVALID_INPUT;
708     }
709
710   have_result = FALSE;
711
712   if (unique_file)
713     {
714       if (!char_after_cursor_is_directory_separator (chooser_entry))
715         {
716           gboolean appended;
717
718           common_prefix = maybe_append_separator_to_file (chooser_entry,
719                                                           unique_file,
720                                                           common_prefix,
721                                                           &appended);
722           if (appended)
723             prefix_expands_the_file_part = TRUE;
724         }
725
726       g_object_unref (unique_file);
727
728       if (prefix_expands_the_file_part)
729         result = COMPLETED_UNIQUE;
730       else
731         result = NOTHING_INSERTED_UNIQUE;
732
733       have_result = TRUE;
734     }
735   else
736     {
737       if (is_complete_not_unique)
738         {
739           result = COMPLETE_BUT_NOT_UNIQUE;
740           have_result = TRUE;
741         }
742     }
743
744   if (common_prefix)
745     {
746       gint cursor_pos;
747       gint common_prefix_len;
748       gint pos;
749
750       cursor_pos = gtk_editable_get_position (GTK_EDITABLE (chooser_entry));
751       common_prefix_len = g_utf8_strlen (common_prefix, -1);
752
753       pos = chooser_entry->file_part_pos;
754
755       if (prefix_expands_the_file_part)
756         {
757           chooser_entry->in_change = TRUE;
758           gtk_editable_delete_text (GTK_EDITABLE (chooser_entry),
759                                     pos, cursor_pos);
760           gtk_editable_insert_text (GTK_EDITABLE (chooser_entry),
761                                     common_prefix, -1, 
762                                     &pos);
763           chooser_entry->in_change = FALSE;
764
765           if (highlight)
766             {
767               gtk_editable_select_region (GTK_EDITABLE (chooser_entry),
768                                           cursor_pos,
769                                           pos); /* equivalent to cursor_pos + common_prefix_len); */
770               chooser_entry->has_completion = TRUE;
771             }
772           else
773             gtk_editable_set_position (GTK_EDITABLE (chooser_entry), pos);
774         }
775       else if (!have_result)
776         {
777           result = NOTHING_INSERTED_COMPLETE;
778           have_result = TRUE;
779         }
780
781       g_free (common_prefix);
782
783       if (have_result)
784         return result;
785       else
786         return COMPLETED;
787     }
788   else
789     {
790       if (have_result)
791         return result;
792       else
793         return NO_MATCH;
794     }
795 }
796
797 static void
798 gtk_file_chooser_entry_do_insert_text (GtkEditable *editable,
799                                        const gchar *new_text,
800                                        gint         new_text_length,
801                                        gint        *position)
802 {
803   GtkFileChooserEntry *chooser_entry = GTK_FILE_CHOOSER_ENTRY (editable);
804   gint old_text_len;
805   gint insert_pos;
806
807   old_text_len = gtk_entry_get_text_length (GTK_ENTRY (chooser_entry));
808   insert_pos = *position;
809
810   parent_editable_iface->do_insert_text (editable, new_text, new_text_length, position);
811
812   if (chooser_entry->in_change)
813     return;
814
815   remove_completion_feedback (chooser_entry);
816
817   if ((chooser_entry->action == GTK_FILE_CHOOSER_ACTION_OPEN
818        || chooser_entry->action == GTK_FILE_CHOOSER_ACTION_SELECT_FOLDER)
819       && insert_pos == old_text_len)
820     install_start_autocompletion_idle (chooser_entry);
821 }
822
823 static void
824 clear_completions_if_not_in_change (GtkFileChooserEntry *chooser_entry)
825 {
826   if (chooser_entry->in_change)
827     return;
828
829   clear_completions (chooser_entry);
830 }
831
832 static void
833 gtk_file_chooser_entry_do_delete_text (GtkEditable *editable,
834                                        gint         start_pos,
835                                        gint         end_pos)
836 {
837   GtkFileChooserEntry *chooser_entry = GTK_FILE_CHOOSER_ENTRY (editable);
838
839   parent_editable_iface->do_delete_text (editable, start_pos, end_pos);
840
841   clear_completions_if_not_in_change (chooser_entry);
842 }
843
844 static void
845 gtk_file_chooser_entry_set_position (GtkEditable *editable,
846                                      gint         position)
847 {
848   GtkFileChooserEntry *chooser_entry = GTK_FILE_CHOOSER_ENTRY (editable);
849
850   parent_editable_iface->set_position (editable, position);
851
852   clear_completions_if_not_in_change (chooser_entry);
853 }
854
855 static void
856 gtk_file_chooser_entry_set_selection_bounds (GtkEditable *editable,
857                                              gint         start_pos,
858                                              gint         end_pos)
859 {
860   GtkFileChooserEntry *chooser_entry = GTK_FILE_CHOOSER_ENTRY (editable);
861
862   parent_editable_iface->set_selection_bounds (editable, start_pos, end_pos);
863
864   clear_completions_if_not_in_change (chooser_entry);
865 }
866
867 static void
868 gtk_file_chooser_entry_grab_focus (GtkWidget *widget)
869 {
870   GTK_WIDGET_CLASS (_gtk_file_chooser_entry_parent_class)->grab_focus (widget);
871   _gtk_file_chooser_entry_select_filename (GTK_FILE_CHOOSER_ENTRY (widget));
872 }
873
874 static void
875 gtk_file_chooser_entry_unmap (GtkWidget *widget)
876 {
877   GtkFileChooserEntry *chooser_entry = GTK_FILE_CHOOSER_ENTRY (widget);
878
879   remove_completion_feedback (chooser_entry);
880
881   GTK_WIDGET_CLASS (_gtk_file_chooser_entry_parent_class)->unmap (widget);
882 }
883
884 static gboolean
885 completion_feedback_window_draw_cb (GtkWidget *widget,
886                                     cairo_t   *cr,
887                                     gpointer   data)
888 {
889   /* Stolen from gtk_tooltip_paint_window() */
890
891   GtkFileChooserEntry *chooser_entry = GTK_FILE_CHOOSER_ENTRY (data);
892
893   gtk_paint_flat_box (gtk_widget_get_style (chooser_entry->completion_feedback_window),
894                       cr,
895                       GTK_STATE_NORMAL,
896                       GTK_SHADOW_OUT,
897                       chooser_entry->completion_feedback_window,
898                       "tooltip",
899                       0, 0,
900                       gtk_widget_get_allocated_width (widget),
901                       gtk_widget_get_allocated_height (widget));
902
903   return FALSE;
904 }
905
906 static void
907 set_invisible_mouse_cursor (GdkWindow *window)
908 {
909   GdkDisplay *display;
910   GdkCursor *cursor;
911
912   display = gdk_window_get_display (window);
913   cursor = gdk_cursor_new_for_display (display, GDK_BLANK_CURSOR);
914
915   gdk_window_set_cursor (window, cursor);
916
917   gdk_cursor_unref (cursor);
918 }
919
920 static void
921 completion_feedback_window_realize_cb (GtkWidget *widget,
922                                        gpointer data)
923 {
924   /* We hide the mouse cursor inside the completion feedback window, since
925    * GtkEntry hides the cursor when the user types.  We don't want the cursor to
926    * come back if the completion feedback ends up where the mouse is.
927    */
928   set_invisible_mouse_cursor (gtk_widget_get_window (widget));
929 }
930
931 static void
932 create_completion_feedback_window (GtkFileChooserEntry *chooser_entry)
933 {
934   /* Stolen from gtk_tooltip_init() */
935
936   GtkStyle *style;
937   GtkWidget *alignment;
938
939   chooser_entry->completion_feedback_window = gtk_window_new (GTK_WINDOW_POPUP);
940   gtk_window_set_type_hint (GTK_WINDOW (chooser_entry->completion_feedback_window),
941                             GDK_WINDOW_TYPE_HINT_TOOLTIP);
942   gtk_widget_set_app_paintable (chooser_entry->completion_feedback_window, TRUE);
943   gtk_window_set_resizable (GTK_WINDOW (chooser_entry->completion_feedback_window), FALSE);
944   gtk_widget_set_name (chooser_entry->completion_feedback_window, "gtk-tooltip");
945
946   alignment = gtk_alignment_new (0.5, 0.5, 1.0, 1.0);
947   style = gtk_widget_get_style (chooser_entry->completion_feedback_window);
948   gtk_alignment_set_padding (GTK_ALIGNMENT (alignment),
949                              style->ythickness, style->ythickness,
950                              style->xthickness, style->xthickness);
951   gtk_container_add (GTK_CONTAINER (chooser_entry->completion_feedback_window), alignment);
952   gtk_widget_show (alignment);
953
954   g_signal_connect (chooser_entry->completion_feedback_window, "draw",
955                     G_CALLBACK (completion_feedback_window_draw_cb), chooser_entry);
956   g_signal_connect (chooser_entry->completion_feedback_window, "realize",
957                     G_CALLBACK (completion_feedback_window_realize_cb), chooser_entry);
958   /* FIXME: connect to motion-notify-event, and *show* the cursor when the mouse moves */
959
960   chooser_entry->completion_feedback_label = gtk_label_new (NULL);
961   gtk_container_add (GTK_CONTAINER (alignment), chooser_entry->completion_feedback_label);
962   gtk_widget_show (chooser_entry->completion_feedback_label);
963 }
964
965 static gboolean
966 completion_feedback_timeout_cb (gpointer data)
967 {
968   GtkFileChooserEntry *chooser_entry = GTK_FILE_CHOOSER_ENTRY (data);
969
970   chooser_entry->completion_feedback_timeout_id = 0;
971
972   remove_completion_feedback (chooser_entry);
973   return FALSE;
974 }
975
976 static void
977 install_completion_feedback_timer (GtkFileChooserEntry *chooser_entry)
978 {
979   if (chooser_entry->completion_feedback_timeout_id != 0)
980     g_source_remove (chooser_entry->completion_feedback_timeout_id);
981
982   chooser_entry->completion_feedback_timeout_id = gdk_threads_add_timeout (COMPLETION_FEEDBACK_TIMEOUT_MS,
983                                                                            completion_feedback_timeout_cb,
984                                                                            chooser_entry);
985 }
986
987 /* Gets the x position of the text cursor in the entry, in widget coordinates */
988 static void
989 get_entry_cursor_x (GtkFileChooserEntry *chooser_entry,
990                     gint                *x_ret)
991 {
992   /* FIXME: see the docs for gtk_entry_get_layout_offsets().  As an exercise for
993    * the reader, you have to implement support for the entry's scroll offset and
994    * RTL layouts and all the fancy Pango stuff.
995    */
996
997   PangoLayout *layout;
998   gint layout_x, layout_y;
999   gint layout_index;
1000   PangoRectangle strong_pos;
1001
1002   layout = gtk_entry_get_layout (GTK_ENTRY (chooser_entry));
1003
1004   gtk_entry_get_layout_offsets (GTK_ENTRY (chooser_entry), &layout_x, &layout_y);
1005
1006   layout_index = gtk_entry_text_index_to_layout_index (GTK_ENTRY (chooser_entry),
1007                                                        GTK_ENTRY (chooser_entry)->current_pos);
1008
1009   pango_layout_get_cursor_pos (layout, layout_index, &strong_pos, NULL);
1010
1011   *x_ret = layout_x + strong_pos.x / PANGO_SCALE;
1012 }
1013
1014 static void
1015 show_completion_feedback_window (GtkFileChooserEntry *chooser_entry)
1016 {
1017   /* More or less stolen from gtk_tooltip_position() */
1018
1019   GtkRequisition feedback_req;
1020   GtkWidget *widget = GTK_WIDGET (chooser_entry);
1021   gint entry_x, entry_y;
1022   gint cursor_x;
1023   GtkAllocation entry_allocation;
1024   int feedback_x, feedback_y;
1025
1026   gtk_size_request_get_size (GTK_SIZE_REQUEST (chooser_entry->completion_feedback_window),
1027                              &feedback_req, NULL);
1028
1029   gdk_window_get_origin (gtk_widget_get_window (widget), &entry_x, &entry_y);
1030   gtk_widget_get_allocation (widget, &entry_allocation);
1031
1032   get_entry_cursor_x (chooser_entry, &cursor_x);
1033
1034   /* FIXME: fit to the screen if we bump on the screen's edge */
1035   /* cheap "half M-width", use height as approximation of character em-size */
1036   feedback_x = entry_x + cursor_x + entry_allocation.height / 2;
1037   feedback_y = entry_y + (entry_allocation.height - feedback_req.height) / 2;
1038
1039   gtk_window_move (GTK_WINDOW (chooser_entry->completion_feedback_window), feedback_x, feedback_y);
1040   gtk_widget_show (chooser_entry->completion_feedback_window);
1041
1042   install_completion_feedback_timer (chooser_entry);
1043 }
1044
1045 static void
1046 pop_up_completion_feedback (GtkFileChooserEntry *chooser_entry,
1047                             const gchar         *feedback)
1048 {
1049   if (chooser_entry->completion_feedback_window == NULL)
1050     create_completion_feedback_window (chooser_entry);
1051
1052   gtk_label_set_text (GTK_LABEL (chooser_entry->completion_feedback_label), feedback);
1053
1054   show_completion_feedback_window (chooser_entry);
1055 }
1056
1057 static void
1058 remove_completion_feedback (GtkFileChooserEntry *chooser_entry)
1059 {
1060   if (chooser_entry->completion_feedback_window)
1061     gtk_widget_destroy (chooser_entry->completion_feedback_window);
1062
1063   chooser_entry->completion_feedback_window = NULL;
1064   chooser_entry->completion_feedback_label = NULL;
1065
1066   if (chooser_entry->completion_feedback_timeout_id != 0)
1067     {
1068       g_source_remove (chooser_entry->completion_feedback_timeout_id);
1069       chooser_entry->completion_feedback_timeout_id = 0;
1070     }
1071 }
1072
1073 static void
1074 explicitly_complete (GtkFileChooserEntry *chooser_entry)
1075 {
1076   CommonPrefixResult result;
1077
1078   g_assert (chooser_entry->current_folder != NULL);
1079   g_assert (_gtk_folder_is_finished_loading (chooser_entry->current_folder));
1080
1081   /* FIXME: see what Emacs does in case there is no common prefix, or there is more than one match:
1082    *
1083    * - If there is a common prefix, insert it (done)
1084    * - If there is no common prefix, pop up the suggestion window
1085    * - If there are no matches at all, beep and bring up a tooltip (done)
1086    * - If the suggestion window is already up, scroll it
1087    */
1088   result = append_common_prefix (chooser_entry, FALSE, TRUE);
1089
1090   switch (result)
1091     {
1092     case INVALID_INPUT:
1093       /* We already beeped in append_common_prefix(); do nothing here */
1094       break;
1095
1096     case NO_MATCH:
1097       beep (chooser_entry);
1098       /* translators: this text is shown when there are no completions 
1099        * for something the user typed in a file chooser entry
1100        */
1101       pop_up_completion_feedback (chooser_entry, _("No match"));
1102       break;
1103
1104     case NOTHING_INSERTED_COMPLETE:
1105       /* FIXME: pop up the suggestion window or scroll it */
1106       break;
1107
1108     case NOTHING_INSERTED_UNIQUE:
1109       /* translators: this text is shown when there is exactly one completion 
1110        * for something the user typed in a file chooser entry
1111        */
1112       pop_up_completion_feedback (chooser_entry, _("Sole completion"));
1113       break;
1114
1115     case COMPLETED:
1116       /* Nothing to do */
1117       break;
1118
1119     case COMPLETED_UNIQUE:
1120       /* Nothing to do */
1121       break;
1122
1123     case COMPLETE_BUT_NOT_UNIQUE:
1124       /* translators: this text is shown when the text in a file chooser
1125        * entry is a complete filename, but could be continued to find
1126        * a longer match
1127        */
1128       pop_up_completion_feedback (chooser_entry, _("Complete, but not unique"));
1129       break;
1130
1131     default:
1132       g_assert_not_reached ();
1133     }
1134 }
1135
1136 static void
1137 start_explicit_completion (GtkFileChooserEntry *chooser_entry)
1138 {
1139   RefreshStatus status;
1140   gboolean is_error;
1141   char *feedback_msg;
1142
1143   status = refresh_current_folder_and_file_part (chooser_entry, REFRESH_UP_TO_CURSOR_POSITION);
1144
1145   is_error = FALSE;
1146
1147   switch (status)
1148     {
1149     case REFRESH_OK:
1150       g_assert (chooser_entry->current_folder_file != NULL);
1151
1152       if (chooser_entry->current_folder && _gtk_folder_is_finished_loading (chooser_entry->current_folder))
1153         explicitly_complete (chooser_entry);
1154       else
1155         {
1156           chooser_entry->load_complete_action = LOAD_COMPLETE_EXPLICIT_COMPLETION;
1157
1158           /* Translators: this text is shown while the system is searching
1159            * for possible completions for filenames in a file chooser entry. */
1160           pop_up_completion_feedback (chooser_entry, _("Completing..."));
1161         }
1162
1163       break;
1164
1165     case REFRESH_INVALID_INPUT:
1166       is_error = TRUE;
1167       /* Translators: this is shown in the feedback for Tab-completion in a file
1168        * chooser's text entry, when the user enters an invalid path. */
1169       feedback_msg = _("Invalid path");
1170       break;
1171
1172     case REFRESH_INCOMPLETE_HOSTNAME:
1173       is_error = TRUE;
1174
1175       if (chooser_entry->local_only)
1176         {
1177           /* hostnames in a local_only file chooser?  user error */
1178
1179           /* Translators: this is shown in the feedback for Tab-completion in a
1180            * file chooser's text entry when the user enters something like
1181            * "sftp://blahblah" in an app that only supports local filenames. */
1182           feedback_msg = _("Only local files may be selected");
1183         }
1184       else
1185         {
1186           /* Another option is to complete the hostname based on the remote volumes that are mounted */
1187
1188           /* Translators: this is shown in the feedback for Tab-completion in a
1189            * file chooser's text entry when the user hasn't entered the first '/'
1190            * after a hostname and yet hits Tab (such as "sftp://blahblah[Tab]") */
1191           feedback_msg = _("Incomplete hostname; end it with '/'");
1192         }
1193
1194       break;
1195
1196     case REFRESH_NONEXISTENT:
1197       is_error = TRUE;
1198
1199       /* Translators: this is shown in the feedback for Tab-completion in a file
1200        * chooser's text entry when the user enters a path that does not exist
1201        * and then hits Tab */
1202       feedback_msg = _("Path does not exist");
1203       break;
1204
1205     case REFRESH_NOT_LOCAL:
1206       is_error = TRUE;
1207       feedback_msg = _("Only local files may be selected");
1208       break;
1209
1210     default:
1211       g_assert_not_reached ();
1212       return;
1213     }
1214
1215   if (is_error)
1216     {
1217       g_assert (chooser_entry->current_folder_file == NULL);
1218
1219       beep (chooser_entry);
1220       pop_up_completion_feedback (chooser_entry, feedback_msg);
1221       chooser_entry->load_complete_action = LOAD_COMPLETE_NOTHING;
1222     }
1223 }
1224
1225 static gboolean
1226 gtk_file_chooser_entry_key_press_event (GtkWidget *widget,
1227                                         GdkEventKey *event)
1228 {
1229   GtkFileChooserEntry *chooser_entry;
1230   GtkEditable *editable;
1231   GtkEntry *entry;
1232   GdkModifierType state;
1233   gboolean control_pressed;
1234
1235   chooser_entry = GTK_FILE_CHOOSER_ENTRY (widget);
1236   editable = GTK_EDITABLE (widget);
1237   entry = GTK_ENTRY (widget);
1238
1239   if (!chooser_entry->eat_tabs)
1240     return GTK_WIDGET_CLASS (_gtk_file_chooser_entry_parent_class)->key_press_event (widget, event);
1241
1242   control_pressed = FALSE;
1243
1244   if (gtk_get_current_event_state (&state))
1245     {
1246       if ((state & GDK_CONTROL_MASK) == GDK_CONTROL_MASK)
1247         control_pressed = TRUE;
1248     }
1249
1250   /* This is a bit evil -- it makes Tab never leave the entry. It basically
1251    * makes it 'safe' for people to hit. */
1252   if (event->keyval == GDK_KEY_Tab && !control_pressed)
1253     {
1254       if (chooser_entry->has_completion)
1255         gtk_editable_set_position (editable, gtk_entry_get_text_length (entry));
1256       else
1257         start_explicit_completion (chooser_entry);
1258
1259       return TRUE;
1260      }
1261
1262   return GTK_WIDGET_CLASS (_gtk_file_chooser_entry_parent_class)->key_press_event (widget, event);
1263
1264 }
1265
1266 static gboolean
1267 gtk_file_chooser_entry_focus_out_event (GtkWidget     *widget,
1268                                         GdkEventFocus *event)
1269 {
1270   GtkFileChooserEntry *chooser_entry = GTK_FILE_CHOOSER_ENTRY (widget);
1271
1272   chooser_entry->load_complete_action = LOAD_COMPLETE_NOTHING;
1273  
1274   return GTK_WIDGET_CLASS (_gtk_file_chooser_entry_parent_class)->focus_out_event (widget, event);
1275 }
1276
1277 static void
1278 commit_completion_and_refresh (GtkFileChooserEntry *chooser_entry)
1279 {
1280   if (chooser_entry->has_completion)
1281     {
1282       gtk_editable_set_position (GTK_EDITABLE (chooser_entry),
1283                                  gtk_entry_get_text_length (GTK_ENTRY (chooser_entry)));
1284     }
1285
1286   /* Here we ignore the result of refresh_current_folder_and_file_part(); there is nothing we can do with it */
1287   refresh_current_folder_and_file_part (chooser_entry, REFRESH_WHOLE_TEXT);
1288 }
1289
1290 static void
1291 gtk_file_chooser_entry_activate (GtkEntry *entry)
1292 {
1293   GtkFileChooserEntry *chooser_entry = GTK_FILE_CHOOSER_ENTRY (entry);
1294
1295   commit_completion_and_refresh (chooser_entry);
1296   GTK_ENTRY_CLASS (_gtk_file_chooser_entry_parent_class)->activate (entry);
1297 }
1298
1299 static void
1300 discard_completion_store (GtkFileChooserEntry *chooser_entry)
1301 {
1302   if (!chooser_entry->completion_store)
1303     return;
1304
1305   gtk_entry_completion_set_model (gtk_entry_get_completion (GTK_ENTRY (chooser_entry)), NULL);
1306   g_object_unref (chooser_entry->completion_store);
1307   chooser_entry->completion_store = NULL;
1308 }
1309
1310 /* Fills the completion store from the contents of the current folder */
1311 static void
1312 populate_completion_store (GtkFileChooserEntry *chooser_entry)
1313 {
1314   GSList *files;
1315   GSList *tmp_list;
1316
1317   discard_completion_store (chooser_entry);
1318
1319   files = _gtk_folder_list_children (chooser_entry->current_folder);
1320
1321   chooser_entry->completion_store = gtk_list_store_new (N_COLUMNS,
1322                                                         G_TYPE_STRING,
1323                                                         G_TYPE_FILE);
1324
1325   for (tmp_list = files; tmp_list; tmp_list = tmp_list->next)
1326     {
1327       GFileInfo *info;
1328       GFile *file;
1329
1330       file = tmp_list->data;
1331
1332       info = _gtk_folder_get_info (chooser_entry->current_folder, file);
1333
1334       if (info)
1335         {
1336           gchar *display_name = g_strdup (g_file_info_get_display_name (info));
1337           GtkTreeIter iter;
1338           gboolean dummy;
1339
1340           display_name = maybe_append_separator_to_file (chooser_entry, file, display_name, &dummy);
1341
1342           gtk_list_store_append (chooser_entry->completion_store, &iter);
1343           gtk_list_store_set (chooser_entry->completion_store, &iter,
1344                               DISPLAY_NAME_COLUMN, display_name,
1345                               FILE_COLUMN, file,
1346                               -1);
1347
1348           g_object_unref (info);
1349           g_free (display_name);
1350         }
1351     }
1352
1353   g_slist_foreach (files, (GFunc) g_object_unref, NULL);
1354   g_slist_free (files);
1355
1356   gtk_tree_sortable_set_sort_column_id (GTK_TREE_SORTABLE (chooser_entry->completion_store),
1357                                         DISPLAY_NAME_COLUMN, GTK_SORT_ASCENDING);
1358
1359   gtk_entry_completion_set_model (gtk_entry_get_completion (GTK_ENTRY (chooser_entry)),
1360                                   GTK_TREE_MODEL (chooser_entry->completion_store));
1361 }
1362
1363 /* When we finish loading the current folder, this function should get called to
1364  * perform the deferred autocompletion or explicit completion.
1365  */
1366 static void
1367 perform_load_complete_action (GtkFileChooserEntry *chooser_entry)
1368 {
1369   switch (chooser_entry->load_complete_action)
1370     {
1371     case LOAD_COMPLETE_NOTHING:
1372       break;
1373
1374     case LOAD_COMPLETE_AUTOCOMPLETE:
1375       autocomplete (chooser_entry);
1376       break;
1377
1378     case LOAD_COMPLETE_EXPLICIT_COMPLETION:
1379       explicitly_complete (chooser_entry);
1380       break;
1381
1382     default:
1383       g_assert_not_reached ();
1384     }
1385
1386   chooser_entry->load_complete_action = LOAD_COMPLETE_NOTHING;
1387 }
1388
1389 static void
1390 finish_folder_load (GtkFileChooserEntry *chooser_entry)
1391 {
1392   populate_completion_store (chooser_entry);
1393   perform_load_complete_action (chooser_entry);
1394
1395   gtk_widget_set_tooltip_text (GTK_WIDGET (chooser_entry), NULL);
1396 }
1397
1398 /* Callback when the current folder finishes loading */
1399 static void
1400 finished_loading_cb (GtkFolder *folder,
1401                      gpointer   data)
1402 {
1403   GtkFileChooserEntry *chooser_entry = GTK_FILE_CHOOSER_ENTRY (data);
1404
1405   finish_folder_load (chooser_entry);
1406 }
1407
1408 /* Callback when the current folder's handle gets obtained (not necessarily loaded completely) */
1409 static void
1410 load_directory_get_folder_callback (GCancellable  *cancellable,
1411                                     GtkFolder     *folder,
1412                                     const GError  *error,
1413                                     gpointer       data)
1414 {
1415   gboolean cancelled = g_cancellable_is_cancelled (cancellable);
1416   GtkFileChooserEntry *chooser_entry = data;
1417
1418   if (cancellable != chooser_entry->load_folder_cancellable)
1419     goto out;
1420
1421   chooser_entry->load_folder_cancellable = NULL;
1422
1423   if (error)
1424     {
1425       LoadCompleteAction old_load_complete_action;
1426
1427       old_load_complete_action = chooser_entry->load_complete_action;
1428
1429       discard_completion_store (chooser_entry);
1430       clear_completions (chooser_entry);
1431
1432       if (old_load_complete_action == LOAD_COMPLETE_EXPLICIT_COMPLETION)
1433         {
1434           /* Since this came from explicit user action (Tab completion), we'll present errors visually */
1435
1436           beep (chooser_entry);
1437           pop_up_completion_feedback (chooser_entry, error->message);
1438         }
1439
1440       discard_current_folder (chooser_entry);
1441     }
1442
1443   if (cancelled || error)
1444     goto out;
1445
1446   g_assert (folder != NULL);
1447   chooser_entry->current_folder = g_object_ref (folder);
1448
1449   discard_completion_store (chooser_entry);
1450
1451   if (_gtk_folder_is_finished_loading (chooser_entry->current_folder))
1452     finish_folder_load (chooser_entry);
1453   else
1454     g_signal_connect (chooser_entry->current_folder, "finished-loading",
1455                       G_CALLBACK (finished_loading_cb), chooser_entry);
1456
1457 out:
1458   g_object_unref (chooser_entry);
1459   g_object_unref (cancellable);
1460 }
1461
1462 static RefreshStatus
1463 start_loading_current_folder (GtkFileChooserEntry *chooser_entry)
1464 {
1465   if (chooser_entry->file_system == NULL)
1466     return REFRESH_OK;
1467
1468   g_assert (chooser_entry->current_folder_file != NULL);
1469   g_assert (chooser_entry->current_folder == NULL);
1470   g_assert (chooser_entry->load_folder_cancellable == NULL);
1471
1472   if (chooser_entry->local_only
1473       && !g_file_is_native (chooser_entry->current_folder_file))
1474     {
1475       g_object_unref (chooser_entry->current_folder_file);
1476       chooser_entry->current_folder_file = NULL;
1477
1478       return REFRESH_NOT_LOCAL;
1479     }
1480
1481   chooser_entry->load_folder_cancellable =
1482     _gtk_file_system_get_folder (chooser_entry->file_system,
1483                                  chooser_entry->current_folder_file,
1484                                 "standard::name,standard::display-name,standard::type",
1485                                  load_directory_get_folder_callback,
1486                                  g_object_ref (chooser_entry));
1487
1488   return REFRESH_OK;
1489 }
1490
1491 static RefreshStatus
1492 reload_current_folder (GtkFileChooserEntry *chooser_entry,
1493                        GFile               *folder_file,
1494                        gboolean             force_reload)
1495 {
1496   gboolean reload = FALSE;
1497
1498   g_assert (folder_file != NULL);
1499
1500   if (chooser_entry->current_folder_file)
1501     {
1502       if ((!(g_file_equal (folder_file, chooser_entry->current_folder_file)
1503              && chooser_entry->load_folder_cancellable))
1504           || force_reload)
1505         {
1506           reload = TRUE;
1507
1508           discard_current_folder (chooser_entry);
1509           discard_loading_and_current_folder_file (chooser_entry);
1510
1511           chooser_entry->current_folder_file = g_object_ref (folder_file);
1512         }
1513     }
1514   else
1515     {
1516       chooser_entry->current_folder_file = g_object_ref (folder_file);
1517       reload = TRUE;
1518     }
1519
1520   if (reload)
1521     return start_loading_current_folder (chooser_entry);
1522   else
1523     return REFRESH_OK;
1524 }
1525
1526 static RefreshStatus
1527 refresh_current_folder_and_file_part (GtkFileChooserEntry *chooser_entry,
1528                                       RefreshMode          refresh_mode)
1529 {
1530   GtkEditable *editable;
1531   gint end_pos;
1532   gchar *text;
1533   GFile *folder_file;
1534   gchar *file_part;
1535   gsize total_len, file_part_len;
1536   gint file_part_pos;
1537   GError *error;
1538   RefreshStatus result;
1539
1540   editable = GTK_EDITABLE (chooser_entry);
1541
1542   switch (refresh_mode)
1543     {
1544     case REFRESH_UP_TO_CURSOR_POSITION:
1545       end_pos = gtk_editable_get_position (editable);
1546       break;
1547
1548     case REFRESH_WHOLE_TEXT:
1549       end_pos = gtk_entry_get_text_length (GTK_ENTRY (chooser_entry));
1550       break;
1551
1552     default:
1553       g_assert_not_reached ();
1554       return REFRESH_INVALID_INPUT;
1555     }
1556
1557   text = gtk_editable_get_chars (editable, 0, end_pos);
1558
1559   error = NULL;
1560   if (!chooser_entry->file_system ||
1561       !chooser_entry->base_folder ||
1562       !_gtk_file_system_parse (chooser_entry->file_system,
1563                                chooser_entry->base_folder, text,
1564                                &folder_file, &file_part, &error))
1565     {
1566       if (g_error_matches (error, GTK_FILE_CHOOSER_ERROR, GTK_FILE_CHOOSER_ERROR_INCOMPLETE_HOSTNAME))
1567         {
1568           folder_file = NULL;
1569           result = REFRESH_INCOMPLETE_HOSTNAME;
1570         }
1571       else
1572         {
1573           folder_file = (chooser_entry->base_folder) ? g_object_ref (chooser_entry->base_folder) : NULL;
1574
1575           if (g_error_matches (error, GTK_FILE_CHOOSER_ERROR, GTK_FILE_CHOOSER_ERROR_NONEXISTENT))
1576             result = REFRESH_NONEXISTENT;
1577           else
1578             result = REFRESH_INVALID_INPUT;
1579         }
1580
1581       if (error)
1582         g_error_free (error);
1583
1584       file_part = g_strdup ("");
1585       file_part_pos = -1;
1586     }
1587   else
1588     {
1589       g_assert (folder_file != NULL);
1590
1591       file_part_len = strlen (file_part);
1592       total_len = strlen (text);
1593       if (total_len > file_part_len)
1594         file_part_pos = g_utf8_strlen (text, total_len - file_part_len);
1595       else
1596         file_part_pos = 0;
1597
1598       result = REFRESH_OK;
1599     }
1600
1601   g_free (text);
1602
1603   g_free (chooser_entry->file_part);
1604
1605   chooser_entry->file_part = file_part;
1606   chooser_entry->file_part_pos = file_part_pos;
1607
1608   if (result == REFRESH_OK)
1609     {
1610       result = reload_current_folder (chooser_entry, folder_file, file_part_pos == -1);
1611     }
1612   else
1613     {
1614       discard_current_folder (chooser_entry);
1615       discard_loading_and_current_folder_file (chooser_entry);
1616     }
1617
1618   if (folder_file)
1619     g_object_unref (folder_file);
1620
1621   g_assert (/* we are OK and we have a current folder file and (loading process or folder handle)... */
1622             ((result == REFRESH_OK)
1623              && (chooser_entry->current_folder_file != NULL)
1624              && (((chooser_entry->load_folder_cancellable != NULL) && (chooser_entry->current_folder == NULL))
1625                  || ((chooser_entry->load_folder_cancellable == NULL) && (chooser_entry->current_folder != NULL))))
1626             /* ... OR we have an error, and we don't have a current folder file nor a loading process nor a folder handle */
1627             || ((result != REFRESH_OK)
1628                 && (chooser_entry->current_folder_file == NULL)
1629                 && (chooser_entry->load_folder_cancellable == NULL)
1630                 && (chooser_entry->current_folder == NULL)));
1631
1632   return result;
1633 }
1634
1635 static void
1636 autocomplete (GtkFileChooserEntry *chooser_entry)
1637 {
1638   if (!(chooser_entry->current_folder != NULL
1639         && _gtk_folder_is_finished_loading (chooser_entry->current_folder)
1640         && gtk_editable_get_position (GTK_EDITABLE (chooser_entry)) == gtk_entry_get_text_length (GTK_ENTRY (chooser_entry))))
1641     return;
1642
1643   append_common_prefix (chooser_entry, TRUE, FALSE);
1644 }
1645
1646 static void
1647 start_autocompletion (GtkFileChooserEntry *chooser_entry)
1648 {
1649   RefreshStatus status;
1650
1651   status = refresh_current_folder_and_file_part (chooser_entry, REFRESH_UP_TO_CURSOR_POSITION);
1652
1653   switch (status)
1654     {
1655     case REFRESH_OK:
1656       g_assert (chooser_entry->current_folder_file != NULL);
1657
1658       if (chooser_entry->current_folder && _gtk_folder_is_finished_loading (chooser_entry->current_folder))
1659         autocomplete (chooser_entry);
1660       else
1661         chooser_entry->load_complete_action = LOAD_COMPLETE_AUTOCOMPLETE;
1662
1663       break;
1664
1665     case REFRESH_INVALID_INPUT:
1666     case REFRESH_INCOMPLETE_HOSTNAME:
1667     case REFRESH_NONEXISTENT:
1668     case REFRESH_NOT_LOCAL:
1669       /* We don't beep or anything, since this is autocompletion - the user
1670        * didn't request any action explicitly.
1671        */
1672       break;
1673
1674     default:
1675       g_assert_not_reached ();
1676     }
1677 }
1678
1679 static gboolean
1680 start_autocompletion_idle_handler (gpointer data)
1681 {
1682   GtkFileChooserEntry *chooser_entry = GTK_FILE_CHOOSER_ENTRY (data);
1683
1684   start_autocompletion (chooser_entry);
1685
1686   chooser_entry->start_autocompletion_idle_id = 0;
1687
1688   return FALSE;
1689 }
1690
1691 static void
1692 install_start_autocompletion_idle (GtkFileChooserEntry *chooser_entry)
1693 {
1694   if (chooser_entry->start_autocompletion_idle_id != 0)
1695     return;
1696
1697   chooser_entry->start_autocompletion_idle_id = gdk_threads_add_idle (start_autocompletion_idle_handler, chooser_entry);
1698 }
1699
1700 #ifdef G_OS_WIN32
1701 static gint
1702 insert_text_callback (GtkFileChooserEntry *chooser_entry,
1703                       const gchar         *new_text,
1704                       gint                 new_text_length,
1705                       gint                *position,
1706                       gpointer             user_data)
1707 {
1708   const gchar *colon = memchr (new_text, ':', new_text_length);
1709   gint i;
1710
1711   /* Disallow these characters altogether */
1712   for (i = 0; i < new_text_length; i++)
1713     {
1714       if (new_text[i] == '<' ||
1715           new_text[i] == '>' ||
1716           new_text[i] == '"' ||
1717           new_text[i] == '|' ||
1718           new_text[i] == '*' ||
1719           new_text[i] == '?')
1720         break;
1721     }
1722
1723   if (i < new_text_length ||
1724       /* Disallow entering text that would cause a colon to be anywhere except
1725        * after a drive letter.
1726        */
1727       (colon != NULL &&
1728        *position + (colon - new_text) != 1) ||
1729       (new_text_length > 0 &&
1730        *position <= 1 &&
1731        gtk_entry_get_text_length (GTK_ENTRY (chooser_entry)) >= 2 &&
1732        gtk_entry_get_text (GTK_ENTRY (chooser_entry))[1] == ':'))
1733     {
1734       gtk_widget_error_bell (GTK_WIDGET (chooser_entry));
1735       g_signal_stop_emission_by_name (chooser_entry, "insert_text");
1736       return FALSE;
1737     }
1738
1739   return TRUE;
1740 }
1741
1742 static void
1743 delete_text_callback (GtkFileChooserEntry *chooser_entry,
1744                       gint                 start_pos,
1745                       gint                 end_pos,
1746                       gpointer             user_data)
1747 {
1748   /* If deleting a drive letter, delete the colon, too */
1749   if (start_pos == 0 && end_pos == 1 &&
1750       gtk_entry_get_text_length (GTK_ENTRY (chooser_entry)) >= 2 &&
1751       gtk_entry_get_text (GTK_ENTRY (chooser_entry))[1] == ':')
1752     {
1753       g_signal_handlers_block_by_func (chooser_entry,
1754                                        G_CALLBACK (delete_text_callback),
1755                                        user_data);
1756       gtk_editable_delete_text (GTK_EDITABLE (chooser_entry), 0, 1);
1757       g_signal_handlers_unblock_by_func (chooser_entry,
1758                                          G_CALLBACK (delete_text_callback),
1759                                          user_data);
1760     }
1761 }
1762 #endif
1763
1764 /**
1765  * _gtk_file_chooser_entry_new:
1766  * @eat_tabs: If %FALSE, allow focus navigation with the tab key.
1767  *
1768  * Creates a new #GtkFileChooserEntry object. #GtkFileChooserEntry
1769  * is an internal implementation widget for the GTK+ file chooser
1770  * which is an entry with completion with respect to a
1771  * #GtkFileSystem object.
1772  *
1773  * Return value: the newly created #GtkFileChooserEntry
1774  **/
1775 GtkWidget *
1776 _gtk_file_chooser_entry_new (gboolean eat_tabs)
1777 {
1778   GtkFileChooserEntry *chooser_entry;
1779
1780   chooser_entry = g_object_new (GTK_TYPE_FILE_CHOOSER_ENTRY, NULL);
1781   chooser_entry->eat_tabs = (eat_tabs != FALSE);
1782
1783   return GTK_WIDGET (chooser_entry);
1784 }
1785
1786 /**
1787  * _gtk_file_chooser_entry_set_file_system:
1788  * @chooser_entry: a #GtkFileChooser
1789  * @file_system: an object implementing #GtkFileSystem
1790  *
1791  * Sets the file system for @chooser_entry.
1792  **/
1793 void
1794 _gtk_file_chooser_entry_set_file_system (GtkFileChooserEntry *chooser_entry,
1795                                          GtkFileSystem       *file_system)
1796 {
1797   g_return_if_fail (GTK_IS_FILE_CHOOSER_ENTRY (chooser_entry));
1798   g_return_if_fail (GTK_IS_FILE_SYSTEM (file_system));
1799
1800   if (file_system != chooser_entry->file_system)
1801     {
1802       if (chooser_entry->file_system)
1803         g_object_unref (chooser_entry->file_system);
1804
1805       chooser_entry->file_system = g_object_ref (file_system);
1806     }
1807 }
1808
1809 /**
1810  * _gtk_file_chooser_entry_set_base_folder:
1811  * @chooser_entry: a #GtkFileChooserEntry
1812  * @file: file for a folder in the chooser entries current file system.
1813  *
1814  * Sets the folder with respect to which completions occur.
1815  **/
1816 void
1817 _gtk_file_chooser_entry_set_base_folder (GtkFileChooserEntry *chooser_entry,
1818                                          GFile               *file)
1819 {
1820   if (chooser_entry->base_folder)
1821     g_object_unref (chooser_entry->base_folder);
1822
1823   chooser_entry->base_folder = file;
1824
1825   if (chooser_entry->base_folder)
1826     g_object_ref (chooser_entry->base_folder);
1827
1828   clear_completions (chooser_entry);
1829   _gtk_file_chooser_entry_select_filename (chooser_entry);
1830 }
1831
1832 /**
1833  * _gtk_file_chooser_entry_get_current_folder:
1834  * @chooser_entry: a #GtkFileChooserEntry
1835  *
1836  * Gets the current folder for the #GtkFileChooserEntry. If the
1837  * user has only entered a filename, this will be in the base folder
1838  * (see _gtk_file_chooser_entry_set_base_folder()), but if the
1839  * user has entered a relative or absolute path, then it will
1840  * be different.  If the user has entered unparsable text, or text which
1841  * the entry cannot handle, this will return %NULL.
1842  *
1843  * Return value: the file for the current folder - this value is owned by the
1844  *  chooser entry and must not be modified or freed.
1845  **/
1846 GFile *
1847 _gtk_file_chooser_entry_get_current_folder (GtkFileChooserEntry *chooser_entry)
1848 {
1849   commit_completion_and_refresh (chooser_entry);
1850   return chooser_entry->current_folder_file;
1851 }
1852
1853 /**
1854  * _gtk_file_chooser_entry_get_file_part:
1855  * @chooser_entry: a #GtkFileChooserEntry
1856  *
1857  * Gets the non-folder portion of whatever the user has entered
1858  * into the file selector. What is returned is a UTF-8 string,
1859  * and if a filename path is needed, g_file_get_child_for_display_name()
1860  * must be used
1861   *
1862  * Return value: the entered filename - this value is owned by the
1863  *  chooser entry and must not be modified or freed.
1864  **/
1865 const gchar *
1866 _gtk_file_chooser_entry_get_file_part (GtkFileChooserEntry *chooser_entry)
1867 {
1868   commit_completion_and_refresh (chooser_entry);
1869   return chooser_entry->file_part;
1870 }
1871
1872 /**
1873  * _gtk_file_chooser_entry_set_file_part:
1874  * @chooser_entry: a #GtkFileChooserEntry
1875  * @file_part: text to display in the entry, in UTF-8
1876  *
1877  * Sets the current text shown in the file chooser entry.
1878  **/
1879 void
1880 _gtk_file_chooser_entry_set_file_part (GtkFileChooserEntry *chooser_entry,
1881                                        const gchar         *file_part)
1882 {
1883   g_return_if_fail (GTK_IS_FILE_CHOOSER_ENTRY (chooser_entry));
1884
1885   chooser_entry->in_change = TRUE;
1886   clear_completions (chooser_entry);
1887   gtk_entry_set_text (GTK_ENTRY (chooser_entry), file_part);
1888   chooser_entry->in_change = FALSE;
1889 }
1890
1891
1892 /**
1893  * _gtk_file_chooser_entry_set_action:
1894  * @chooser_entry: a #GtkFileChooserEntry
1895  * @action: the action which is performed by the file selector using this entry
1896  *
1897  * Sets action which is performed by the file selector using this entry. 
1898  * The #GtkFileChooserEntry will use different completion strategies for 
1899  * different actions.
1900  **/
1901 void
1902 _gtk_file_chooser_entry_set_action (GtkFileChooserEntry *chooser_entry,
1903                                     GtkFileChooserAction action)
1904 {
1905   g_return_if_fail (GTK_IS_FILE_CHOOSER_ENTRY (chooser_entry));
1906   
1907   if (chooser_entry->action != action)
1908     {
1909       GtkEntryCompletion *comp;
1910
1911       chooser_entry->action = action;
1912
1913       comp = gtk_entry_get_completion (GTK_ENTRY (chooser_entry));
1914
1915       /* FIXME: do we need to actually set the following? */
1916
1917       switch (action)
1918         {
1919         case GTK_FILE_CHOOSER_ACTION_OPEN:
1920         case GTK_FILE_CHOOSER_ACTION_SELECT_FOLDER:
1921           gtk_entry_completion_set_popup_single_match (comp, FALSE);
1922           break;
1923         case GTK_FILE_CHOOSER_ACTION_SAVE:
1924         case GTK_FILE_CHOOSER_ACTION_CREATE_FOLDER:
1925           gtk_entry_completion_set_popup_single_match (comp, TRUE);
1926           break;
1927         }
1928     }
1929 }
1930
1931
1932 /**
1933  * _gtk_file_chooser_entry_get_action:
1934  * @chooser_entry: a #GtkFileChooserEntry
1935  *
1936  * Gets the action for this entry. 
1937  *
1938  * Returns: the action
1939  **/
1940 GtkFileChooserAction
1941 _gtk_file_chooser_entry_get_action (GtkFileChooserEntry *chooser_entry)
1942 {
1943   g_return_val_if_fail (GTK_IS_FILE_CHOOSER_ENTRY (chooser_entry),
1944                         GTK_FILE_CHOOSER_ACTION_OPEN);
1945   
1946   return chooser_entry->action;
1947 }
1948
1949 gboolean
1950 _gtk_file_chooser_entry_get_is_folder (GtkFileChooserEntry *chooser_entry,
1951                                        GFile               *file)
1952 {
1953   gboolean retval = FALSE;
1954
1955   if (chooser_entry->current_folder)
1956     {
1957       GFileInfo *file_info;
1958
1959       file_info = _gtk_folder_get_info (chooser_entry->current_folder, file);
1960
1961       if (file_info)
1962         {
1963           retval = _gtk_file_info_consider_as_directory (file_info);
1964           g_object_unref (file_info);
1965         }
1966     }
1967
1968   return retval;
1969 }
1970
1971
1972 /*
1973  * _gtk_file_chooser_entry_select_filename:
1974  * @chooser_entry: a #GtkFileChooserEntry
1975  *
1976  * Selects the filename (without the extension) for user edition.
1977  */
1978 void
1979 _gtk_file_chooser_entry_select_filename (GtkFileChooserEntry *chooser_entry)
1980 {
1981   const gchar *str, *ext;
1982   glong len = -1;
1983
1984   if (chooser_entry->action == GTK_FILE_CHOOSER_ACTION_SAVE)
1985     {
1986       str = gtk_entry_get_text (GTK_ENTRY (chooser_entry));
1987       ext = g_strrstr (str, ".");
1988
1989       if (ext)
1990        len = g_utf8_pointer_to_offset (str, ext);
1991     }
1992
1993   gtk_editable_select_region (GTK_EDITABLE (chooser_entry), 0, (gint) len);
1994 }
1995
1996 void
1997 _gtk_file_chooser_entry_set_local_only (GtkFileChooserEntry *chooser_entry,
1998                                         gboolean             local_only)
1999 {
2000   chooser_entry->local_only = local_only;
2001   clear_completions (chooser_entry);
2002 }
2003
2004 gboolean
2005 _gtk_file_chooser_entry_get_local_only (GtkFileChooserEntry *chooser_entry)
2006 {
2007   return chooser_entry->local_only;
2008 }