2 * Copyright (C) 2006 John Ellis
3 * Copyright (C) 2008 - 2016 The Geeqie Team
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License along
18 * with this program; if not, write to the Free Software Foundation, Inc.,
19 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
31 #include <sys/types.h>
36 #include <gdk-pixbuf/gdk-pixbuf.h>
39 #include "ui_tabcomp.h"
41 #include "history_list.h"
42 #include "misc.h" /* expand_tilde() */
43 #include "ui_fileops.h"
44 #include "ui_spinner.h"
45 #include "ui_utildlg.h"
47 #include <gdk/gdkkeysyms.h> /* for key values */
50 /* define this to enable a pop-up menu that shows possible matches
51 * #define TAB_COMPLETION_ENABLE_POPUP_MENU
53 #define TAB_COMPLETION_ENABLE_POPUP_MENU 1
54 #define TAB_COMP_POPUP_MAX 1000
56 #ifdef TAB_COMPLETION_ENABLE_POPUP_MENU
61 /* ----------------------------------------------------------------
62 Tab completion routines, can be connected to any gtkentry widget
63 using the tab_completion_add_to_entry() function.
64 Use remove_trailing_slash() to strip the trailing G_DIR_SEPARATOR.
65 ----------------------------------------------------------------*/
67 typedef struct _TabCompData TabCompData;
73 void (*enter_func)(const gchar *, gpointer);
74 void (*tab_func)(const gchar *, gpointer);
75 void (*tab_append_func)(const gchar *, gpointer, gint);
79 gpointer tab_append_data;
88 gboolean fd_folders_only;
97 static void tab_completion_select_show(TabCompData *td);
98 static gint tab_completion_do(TabCompData *td);
100 static void tab_completion_free_list(TabCompData *td)
104 g_free(td->dir_path);
107 list = td->file_list;
115 g_list_free(td->file_list);
116 td->file_list = NULL;
119 static void tab_completion_read_dir(TabCompData *td, const gchar *path)
126 tab_completion_free_list(td);
128 pathl = path_from_utf8(path);
136 while ((dir = readdir(dp)) != NULL)
138 gchar *name = dir->d_name;
139 if (strcmp(name, ".") != 0 && strcmp(name, "..") != 0 &&
140 (name[0] != '.' || options->file_filter.show_hidden_files))
142 gchar *abspath = g_build_filename(pathl, name, NULL);
144 if (g_file_test(abspath, G_FILE_TEST_IS_DIR))
146 gchar *dname = g_strconcat(name, G_DIR_SEPARATOR_S, NULL);
147 list = g_list_prepend(list, path_to_utf8(dname));
152 list = g_list_prepend(list, path_to_utf8(name));
159 td->dir_path = g_strdup(path);
160 td->file_list = list;
164 static void tab_completion_destroy(GtkWidget *widget, gpointer data)
166 TabCompData *td = data;
168 tab_completion_free_list(td);
169 g_free(td->history_key);
171 if (td->fd) file_dialog_close(td->fd);
172 g_free(td->fd_title);
175 g_free(td->filter_desc);
180 static gchar *tab_completion_get_text(TabCompData *td)
184 text = g_strdup(gtk_entry_get_text(GTK_ENTRY(td->entry)));
189 text = expand_tilde(text);
196 static gboolean tab_completion_emit_enter_signal(TabCompData *td)
199 if (!td->enter_func) return FALSE;
201 text = tab_completion_get_text(td);
202 td->enter_func(text, td->enter_data);
208 static void tab_completion_emit_tab_signal(TabCompData *td)
211 if (!td->tab_func) return;
213 text = tab_completion_get_text(td);
214 td->tab_func(text, td->tab_data);
218 #ifdef TAB_COMPLETION_ENABLE_POPUP_MENU
219 void tab_completion_iter_menu_items(GtkWidget *widget, gpointer data)
221 TabCompData *td = data;
224 if (!gtk_widget_get_visible(widget)) return;
226 child = gtk_bin_get_child(GTK_BIN(widget));
227 if (GTK_IS_LABEL(child)) {
228 const gchar *text = gtk_label_get_text(GTK_LABEL(child));
229 const gchar *entry_text = gtk_entry_get_text(GTK_ENTRY(td->entry));
230 const gchar *prefix = filename_from_path(entry_text);
231 guint prefix_len = strlen(prefix);
233 if (strlen(text) < prefix_len || strncmp(text, prefix, prefix_len))
235 /* Hide menu items not matching */
236 gtk_widget_hide(widget);
240 /* Count how many choices are left in the menu */
246 static gboolean tab_completion_popup_key_press(GtkWidget *widget, GdkEventKey *event, gpointer data)
248 TabCompData *td = data;
250 if (event->keyval == GDK_KEY_Tab ||
251 event->keyval == GDK_KEY_BackSpace ||
252 (event->keyval >= 0x20 && event->keyval <= 0xFF) )
254 if (event->keyval >= 0x20 && event->keyval <= 0xFF)
259 buf[0] = event->keyval;
261 gtk_editable_insert_text(GTK_EDITABLE(td->entry), buf, 1, &p);
262 gtk_editable_set_position(GTK_EDITABLE(td->entry), -1);
264 /* Reduce the number of entries in the menu */
266 gtk_container_foreach(GTK_CONTAINER(widget), tab_completion_iter_menu_items, (gpointer) td);
267 if (td->choices > 1) return TRUE; /* multiple choices */
268 if (td->choices > 0) tab_completion_do(td); /* one choice */
272 gtk_menu_popdown(GTK_MENU(widget));
273 /* doing this does not emit the "selection done" signal, unref it ourselves */
274 g_object_unref(widget);
281 static void tab_completion_popup_cb(GtkWidget *widget, gpointer data)
287 td = g_object_get_data(G_OBJECT(widget), "tab_completion_data");
290 buf = g_build_filename(td->dir_path, name, NULL);
291 gtk_entry_set_text(GTK_ENTRY(td->entry), buf);
292 gtk_editable_set_position(GTK_EDITABLE(td->entry), strlen(buf));
295 tab_completion_emit_tab_signal(td);
298 static void tab_completion_popup_pos_cb(GtkMenu *menu, gint *x, gint *y, gboolean *push_in, gpointer data)
300 TabCompData *td = data;
303 PangoRectangle strong_pos, weak_pos;
305 gint xoffset, yoffset;
309 GdkRectangle monitor;
310 GtkRequisition requisition;
311 GtkAllocation allocation;
313 gdk_window_get_origin(gtk_widget_get_window(GTK_WIDGET(td->entry)), x, y);
315 screen = gtk_widget_get_screen(GTK_WIDGET(menu));
316 monitor_num = gdk_screen_get_monitor_at_window(screen, gtk_widget_get_window(GTK_WIDGET(td->entry)));
317 gdk_screen_get_monitor_geometry(screen, monitor_num, &monitor);
319 gtk_widget_size_request(GTK_WIDGET(menu), &req);
321 length = strlen(gtk_entry_get_text(GTK_ENTRY(td->entry)));
322 gtk_entry_get_layout_offsets(GTK_ENTRY(td->entry), &xoffset, &yoffset);
324 layout = gtk_entry_get_layout(GTK_ENTRY(td->entry));
325 pango_layout_get_cursor_pos(layout, length, &strong_pos, &weak_pos);
327 *x += strong_pos.x / PANGO_SCALE + xoffset;
329 gtk_widget_get_requisition(td->entry, &requisition);
330 gtk_widget_get_allocation(td->entry, &allocation);
332 height = MIN(requisition.height, allocation.height);
334 if (req.height > monitor.y + monitor.height - *y - height &&
335 *y - monitor.y > monitor.y + monitor.height - *y)
337 height = MIN(*y - monitor.y, req.height);
338 gtk_widget_set_size_request(GTK_WIDGET(menu), -1, height);
347 static void tab_completion_popup_list(TabCompData *td, GList *list)
360 * well, the menu would be too long anyway...
361 * (listing /dev causes gtk+ window allocation errors, -> too big a window)
362 * this is why menu popups are disabled, this really should be a popup scrollable listview.
364 if (g_list_length(list) > 200) return;
367 menu = popup_menu_short_lived();
370 while (work && count < TAB_COMP_POPUP_MAX)
372 gchar *name = work->data;
375 item = menu_item_add_simple(menu, name, G_CALLBACK(tab_completion_popup_cb), name);
376 g_object_set_data(G_OBJECT(item), "tab_completion_data", td);
382 g_signal_connect(G_OBJECT(menu), "key_press_event",
383 G_CALLBACK(tab_completion_popup_key_press), td);
385 /* peek at the current event to get the time, etc. */
386 event = gtk_get_current_event();
388 if (event && event->type == GDK_BUTTON_RELEASE)
390 ebutton = event->button.button;
399 etime = gdk_event_get_time(event);
400 gdk_event_free(event);
407 gtk_menu_popup(GTK_MENU(menu), NULL, NULL,
408 tab_completion_popup_pos_cb, td, ebutton, etime);
412 #define CASE_SORT strcmp
415 static gint simple_sort(gconstpointer a, gconstpointer b)
417 return CASE_SORT((gchar *)a, (gchar *)b);
422 static gboolean tab_completion_do(TabCompData *td)
424 const gchar *entry_text = gtk_entry_get_text(GTK_ENTRY(td->entry));
425 const gchar *entry_file;
428 gboolean home_exp = FALSE;
430 if (entry_text[0] == '\0')
432 entry_dir = g_strdup(G_DIR_SEPARATOR_S); /* FIXME: root directory win32 */
433 gtk_entry_set_text(GTK_ENTRY(td->entry), entry_dir);
434 gtk_editable_set_position(GTK_EDITABLE(td->entry), strlen(entry_dir));
439 /* home dir expansion */
440 if (entry_text[0] == '~')
442 entry_dir = expand_tilde(entry_text);
447 entry_dir = g_strdup(entry_text);
450 if (isfile(entry_dir))
454 gtk_entry_set_text(GTK_ENTRY(td->entry), entry_dir);
455 gtk_editable_set_position(GTK_EDITABLE(td->entry), strlen(entry_dir));
461 entry_file = filename_from_path(entry_text);
463 if (isdir(entry_dir) && strcmp(entry_file, ".") != 0 && strcmp(entry_file, "..") != 0)
465 ptr = entry_dir + strlen(entry_dir) - 1;
466 if (ptr[0] == G_DIR_SEPARATOR)
470 gtk_entry_set_text(GTK_ENTRY(td->entry), entry_dir);
471 gtk_editable_set_position(GTK_EDITABLE(td->entry), strlen(entry_dir));
474 tab_completion_read_dir(td, entry_dir);
475 td->file_list = g_list_sort(td->file_list, simple_sort);
476 if (td->file_list && !td->file_list->next)
481 file = td->file_list->data;
482 buf = g_build_filename(entry_dir, file, NULL);
485 gchar *tmp = g_strconcat(buf, G_DIR_SEPARATOR_S, NULL);
489 gtk_entry_set_text(GTK_ENTRY(td->entry), buf);
490 gtk_editable_set_position(GTK_EDITABLE(td->entry), strlen(buf));
494 #ifdef TAB_COMPLETION_ENABLE_POPUP_MENU
498 tab_completion_popup_list(td, td->file_list);
507 gchar *buf = g_strconcat(entry_dir, G_DIR_SEPARATOR_S, NULL);
508 gtk_entry_set_text(GTK_ENTRY(td->entry), buf);
509 gtk_editable_set_position(GTK_EDITABLE(td->entry), strlen(buf));
516 ptr = (gchar *)filename_from_path(entry_dir);
517 if (ptr > entry_dir) ptr--;
520 if (strlen(entry_dir) == 0)
523 entry_dir = g_strdup(G_DIR_SEPARATOR_S); /* FIXME: win32 */
526 if (isdir(entry_dir))
530 gint l = strlen(entry_file);
532 if (!td->dir_path || !td->file_list || strcmp(td->dir_path, entry_dir) != 0)
534 tab_completion_read_dir(td, entry_dir);
537 list = td->file_list;
540 gchar *file = list->data;
541 if (strncmp(entry_file, file, l) == 0)
543 poss = g_list_prepend(poss, file);
552 gchar *file = poss->data;
555 buf = g_build_filename(entry_dir, file, NULL);
556 gtk_entry_set_text(GTK_ENTRY(td->entry), buf);
557 gtk_editable_set_position(GTK_EDITABLE(td->entry), strlen(buf));
565 gsize c = strlen(entry_file);
566 gboolean done = FALSE;
567 gchar *test_file = poss->data;
572 if (!list) done = TRUE;
573 while (list && !done)
575 gchar *file = list->data;
576 if (strlen(file) < c || strncmp(test_file, file, c) != 0)
589 file = g_strdup(test_file);
591 buf = g_build_filename(entry_dir, file, NULL);
592 gtk_entry_set_text(GTK_ENTRY(td->entry), buf);
593 gtk_editable_set_position(GTK_EDITABLE(td->entry), strlen(buf));
595 #ifdef TAB_COMPLETION_ENABLE_POPUP_MENU
597 poss = g_list_sort(poss, simple_sort);
598 tab_completion_popup_list(td, poss);
618 static gboolean tab_completion_key_pressed(GtkWidget *widget, GdkEventKey *event, gpointer data)
620 TabCompData *td = data;
621 gboolean stop_signal = FALSE;
623 switch (event->keyval)
626 if (!(event->state & GDK_CONTROL_MASK))
628 if (tab_completion_do(td))
630 tab_completion_emit_tab_signal(td);
635 case GDK_KEY_Return: case GDK_KEY_KP_Enter:
637 (event->state & GDK_CONTROL_MASK))
639 tab_completion_select_show(td);
642 else if (tab_completion_emit_enter_signal(td))
651 if (stop_signal) g_signal_stop_emission_by_name(G_OBJECT(widget), "key_press_event");
653 return (stop_signal);
656 static void tab_completion_button_pressed(GtkWidget *widget, gpointer data)
659 GtkWidget *entry = data;
661 td = g_object_get_data(G_OBJECT(entry), "tab_completion_data");
665 if (!gtk_widget_has_focus(entry))
667 gtk_widget_grab_focus(entry);
670 if (tab_completion_do(td))
672 tab_completion_emit_tab_signal(td);
676 static void tab_completion_button_size_allocate(GtkWidget *button, GtkAllocation *allocation, gpointer data)
678 GtkWidget *parent = data;
679 GtkAllocation parent_allocation;
680 gtk_widget_get_allocation(parent, &parent_allocation);
682 if (allocation->height > parent_allocation.height)
684 GtkAllocation button_allocation;
686 gtk_widget_get_allocation(button, &button_allocation);
687 button_allocation.height = parent_allocation.height;
688 button_allocation.y = parent_allocation.y +
689 (parent_allocation.height - parent_allocation.height) / 2;
690 gtk_widget_size_allocate(button, &button_allocation);
694 static GtkWidget *tab_completion_create_complete_button(GtkWidget *entry, GtkWidget *parent)
700 button = gtk_button_new();
701 gtk_widget_set_can_focus(button, FALSE);
702 g_signal_connect(G_OBJECT(button), "size_allocate",
703 G_CALLBACK(tab_completion_button_size_allocate), parent);
704 g_signal_connect(G_OBJECT(button), "clicked",
705 G_CALLBACK(tab_completion_button_pressed), entry);
707 pixbuf = gdk_pixbuf_new_from_inline(-1, icon_tabcomp, FALSE, NULL);
708 icon = gtk_image_new_from_pixbuf(pixbuf);
709 g_object_unref(pixbuf);
711 gtk_container_add(GTK_CONTAINER(button), icon);
712 gtk_widget_show(icon);
718 *----------------------------------------------------------------------------
720 *----------------------------------------------------------------------------
723 GtkWidget *tab_completion_new_with_history(GtkWidget **entry, const gchar *text,
724 const gchar *history_key, gint max_levels,
725 void (*enter_func)(const gchar *, gpointer), gpointer data)
729 GtkWidget *combo_entry;
735 box = gtk_hbox_new(FALSE, 0);
737 combo = gtk_combo_box_text_new_with_entry();
738 gtk_box_pack_start(GTK_BOX(box), combo, TRUE, TRUE, 0);
739 gtk_widget_show(combo);
741 combo_entry = gtk_bin_get_child(GTK_BIN(combo));
743 button = tab_completion_create_complete_button(combo_entry, combo);
744 gtk_box_pack_start(GTK_BOX(box), button, FALSE, FALSE, 0);
745 gtk_widget_show(button);
747 tab_completion_add_to_entry(combo_entry, enter_func, NULL, NULL, data);
749 td = g_object_get_data(G_OBJECT(combo_entry), "tab_completion_data");
750 if (!td) return NULL; /* this should never happen! */
753 td->has_history = TRUE;
754 td->history_key = g_strdup(history_key);
755 td->history_levels = max_levels;
757 work = history_list_get_by_key(td->history_key);
759 work = history_list_get_by_key(history_key);
762 gtk_combo_box_text_append_text(GTK_COMBO_BOX_TEXT(combo), (gchar *)work->data);
769 gtk_entry_set_text(GTK_ENTRY(combo_entry), text);
773 gtk_combo_box_set_active(GTK_COMBO_BOX(combo), 0);
776 if (entry) *entry = combo_entry;
780 const gchar *tab_completion_set_to_last_history(GtkWidget *entry)
782 TabCompData *td = g_object_get_data(G_OBJECT(entry), "tab_completion_data");
785 if (!td || !td->has_history) return NULL;
787 buf = history_list_find_last_path_by_key(td->history_key);
790 gtk_entry_set_text(GTK_ENTRY(td->entry), buf);
796 void tab_completion_append_to_history(GtkWidget *entry, const gchar *path)
803 td = g_object_get_data(G_OBJECT(entry), "tab_completion_data");
807 if (!td || !td->has_history) return;
809 history_list_add_to_key(td->history_key, path, td->history_levels);
811 gtk_combo_box_set_active(GTK_COMBO_BOX(td->combo), -1);
813 store = gtk_combo_box_get_model(GTK_COMBO_BOX(td->combo));
814 gtk_list_store_clear(GTK_LIST_STORE(store));
816 work = history_list_get_by_key(td->history_key);
819 gtk_combo_box_text_append_text(GTK_COMBO_BOX_TEXT(td->combo), (gchar *)work->data);
824 if (td->tab_append_func) {
825 td->tab_append_func(path, td->tab_append_data, n);
829 GtkWidget *tab_completion_new(GtkWidget **entry, const gchar *text,
830 void (*enter_func)(const gchar *, gpointer), const gchar *filter, const gchar *filter_desc, gpointer data)
836 hbox = gtk_hbox_new(FALSE, 0);
838 newentry = gtk_entry_new();
839 if (text) gtk_entry_set_text(GTK_ENTRY(newentry), text);
840 gtk_box_pack_start(GTK_BOX(hbox), newentry, TRUE, TRUE, 0);
841 gtk_widget_show(newentry);
843 button = tab_completion_create_complete_button(newentry, newentry);
844 gtk_box_pack_start(GTK_BOX(hbox), button, FALSE, FALSE, 0);
845 gtk_widget_show(button);
847 tab_completion_add_to_entry(newentry, enter_func, filter, filter_desc, data);
848 if (entry) *entry = newentry;
852 void tab_completion_add_to_entry(GtkWidget *entry, void (*enter_func)(const gchar *, gpointer), const gchar *filter, const gchar *filter_desc, gpointer data)
857 log_printf("Tab completion error: entry != NULL\n");
861 td = g_new0(TabCompData, 1);
864 td->enter_func = enter_func;
865 td->enter_data = data;
866 td->filter = g_strdup(filter);
867 td->filter_desc = g_strdup(filter_desc);
869 g_object_set_data(G_OBJECT(td->entry), "tab_completion_data", td);
871 g_signal_connect(G_OBJECT(entry), "key_press_event",
872 G_CALLBACK(tab_completion_key_pressed), td);
873 g_signal_connect(G_OBJECT(entry), "destroy",
874 G_CALLBACK(tab_completion_destroy), td);
877 void tab_completion_add_tab_func(GtkWidget *entry, void (*tab_func)(const gchar *, gpointer), gpointer data)
879 TabCompData *td = g_object_get_data(G_OBJECT(entry), "tab_completion_data");
883 td->tab_func = tab_func;
887 /* Add a callback function called when a new entry is appended to the list */
888 void tab_completion_add_append_func(GtkWidget *entry, void (*tab_append_func)(const gchar *, gpointer, gint), gpointer data)
890 TabCompData *td = g_object_get_data(G_OBJECT(entry), "tab_completion_data");
894 td->tab_append_func = tab_append_func;
895 td->tab_append_data = data;
898 gchar *remove_trailing_slash(const gchar *path)
902 if (!path) return NULL;
905 while (l > 1 && path[l - 1] == G_DIR_SEPARATOR) l--;
907 return g_strndup(path, l);
910 static void tab_completion_select_cancel_cb(FileDialog *fd, gpointer data)
912 TabCompData *td = data;
915 file_dialog_close(fd);
918 static void tab_completion_select_ok_cb(FileDialog *fd, gpointer data)
920 TabCompData *td = data;
922 gtk_entry_set_text(GTK_ENTRY(td->entry), gtk_entry_get_text(GTK_ENTRY(fd->entry)));
924 tab_completion_select_cancel_cb(fd, data);
926 tab_completion_emit_enter_signal(td);
929 static void tab_completion_select_show(TabCompData *td)
933 gchar *filter = NULL;
934 gchar *filter_desc = NULL;
938 gtk_window_present(GTK_WINDOW(GENERIC_DIALOG(td->fd)->dialog));
942 title = (td->fd_title) ? td->fd_title : _("Select path");
943 td->fd = file_dialog_new(title, "select_path", td->entry,
944 tab_completion_select_cancel_cb, td);
945 file_dialog_add_button(td->fd, GTK_STOCK_OK, NULL,
946 tab_completion_select_ok_cb, TRUE);
948 generic_dialog_add_message(GENERIC_DIALOG(td->fd), NULL, title, NULL, FALSE);
960 filter_desc = td->filter_desc;
964 filter_desc = _("All files");
967 path = gtk_entry_get_text(GTK_ENTRY(td->entry));
968 if (strlen(path) == 0) path = NULL;
969 if (td->fd_folders_only)
971 file_dialog_add_path_widgets(td->fd, NULL, path, td->history_key, NULL, NULL);
975 file_dialog_add_path_widgets(td->fd, NULL, path, td->history_key, filter, filter_desc);
978 gtk_widget_show(GENERIC_DIALOG(td->fd)->dialog);
981 static void tab_completion_select_pressed(GtkWidget *widget, gpointer data)
983 TabCompData *td = data;
985 tab_completion_select_show(td);
988 void tab_completion_add_select_button(GtkWidget *entry, const gchar *title, gboolean folders_only)
994 td = g_object_get_data(G_OBJECT(entry), "tab_completion_data");
998 g_free(td->fd_title);
999 td->fd_title = g_strdup(title);
1000 td->fd_folders_only = folders_only;
1002 if (td->fd_button) return;
1004 parent = (td->combo) ? td->combo : td->entry;
1006 hbox = gtk_widget_get_parent(parent);
1007 if (!GTK_IS_BOX(hbox)) return;
1009 td->fd_button = gtk_button_new_with_label("...");
1010 g_signal_connect(G_OBJECT(td->fd_button), "size_allocate",
1011 G_CALLBACK(tab_completion_button_size_allocate), parent);
1012 g_signal_connect(G_OBJECT(td->fd_button), "clicked",
1013 G_CALLBACK(tab_completion_select_pressed), td);
1015 gtk_box_pack_start(GTK_BOX(hbox), td->fd_button, FALSE, FALSE, 0);
1017 gtk_widget_show(td->fd_button);
1019 /* vim: set shiftwidth=8 softtabstop=0 cindent cinoptions={1s: */