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.
24 #include <sys/types.h>
27 #include "ui-tabcomp.h"
29 #include "history-list.h"
30 #include "misc.h" /* expand_tilde() */
31 #include "ui-fileops.h"
32 #include "ui-spinner.h"
33 #include "ui-utildlg.h"
35 /* define this to enable a pop-up menu that shows possible matches
36 * #define TAB_COMPLETION_ENABLE_POPUP_MENU
38 #define TAB_COMPLETION_ENABLE_POPUP_MENU 1
39 #define TAB_COMP_POPUP_MAX 1000
41 #ifdef TAB_COMPLETION_ENABLE_POPUP_MENU
48 * ----------------------------------------------------------------
49 * Tab completion routines, can be connected to any gtkentry widget
50 * using the tab_completion_add_to_entry() function.
52 * Use remove_trailing_slash() to strip the trailing G_DIR_SEPARATOR.
54 * ----------------------------------------------------------------
62 void (*enter_func)(const gchar *, gpointer);
63 void (*tab_func)(const gchar *, gpointer);
64 void (*tab_append_func)(const gchar *, gpointer, gint);
68 gpointer tab_append_data;
77 gboolean fd_folders_only;
86 static void tab_completion_select_show(TabCompData *td);
87 static gint tab_completion_do(TabCompData *td);
89 static void tab_completion_free_list(TabCompData *td)
92 td->dir_path = nullptr;
94 g_list_free_full(td->file_list, g_free);
95 td->file_list = nullptr;
98 static void tab_completion_read_dir(TabCompData *td, const gchar *path)
102 GList *list = nullptr;
105 tab_completion_free_list(td);
107 pathl = path_from_utf8(path);
115 while ((dir = readdir(dp)) != nullptr)
117 gchar *name = dir->d_name;
118 if (strcmp(name, ".") != 0 && strcmp(name, "..") != 0 &&
119 (name[0] != '.' || options->file_filter.show_hidden_files))
121 gchar *abspath = g_build_filename(pathl, name, NULL);
123 if (g_file_test(abspath, G_FILE_TEST_IS_DIR))
125 gchar *dname = g_strconcat(name, G_DIR_SEPARATOR_S, NULL);
126 list = g_list_prepend(list, path_to_utf8(dname));
131 list = g_list_prepend(list, path_to_utf8(name));
138 td->dir_path = g_strdup(path);
139 td->file_list = list;
143 static void tab_completion_destroy(GtkWidget *, gpointer data)
145 auto td = static_cast<TabCompData *>(data);
147 tab_completion_free_list(td);
148 g_free(td->history_key);
150 if (td->fd) file_dialog_close(td->fd);
151 g_free(td->fd_title);
154 g_free(td->filter_desc);
159 static gchar *tab_completion_get_text(TabCompData *td)
163 text = g_strdup(gtk_entry_get_text(GTK_ENTRY(td->entry)));
168 text = expand_tilde(text);
175 static gboolean tab_completion_emit_enter_signal(TabCompData *td)
178 if (!td->enter_func) return FALSE;
180 text = tab_completion_get_text(td);
181 td->enter_func(text, td->enter_data);
187 static void tab_completion_emit_tab_signal(TabCompData *td)
190 if (!td->tab_func) return;
192 text = tab_completion_get_text(td);
193 td->tab_func(text, td->tab_data);
197 #ifdef TAB_COMPLETION_ENABLE_POPUP_MENU
198 void tab_completion_iter_menu_items(GtkWidget *widget, gpointer data)
200 auto td = static_cast<TabCompData *>(data);
203 if (!gtk_widget_get_visible(widget)) return;
205 child = gtk_bin_get_child(GTK_BIN(widget));
206 if (GTK_IS_LABEL(child)) {
207 const gchar *text = gtk_label_get_text(GTK_LABEL(child));
208 const gchar *entry_text = gtk_entry_get_text(GTK_ENTRY(td->entry));
209 const gchar *prefix = filename_from_path(entry_text);
210 guint prefix_len = strlen(prefix);
212 if (strlen(text) < prefix_len || strncmp(text, prefix, prefix_len))
214 /* Hide menu items not matching */
215 gtk_widget_hide(widget);
219 /* Count how many choices are left in the menu */
225 static gboolean tab_completion_popup_key_press(GtkWidget *widget, GdkEventKey *event, gpointer data)
227 auto td = static_cast<TabCompData *>(data);
229 if (event->keyval == GDK_KEY_Tab ||
230 event->keyval == GDK_KEY_BackSpace ||
231 (event->keyval >= 0x20 && event->keyval <= 0xFF) )
233 if (event->keyval >= 0x20 && event->keyval <= 0xFF)
238 buf[0] = event->keyval;
240 gtk_editable_insert_text(GTK_EDITABLE(td->entry), buf, 1, &p);
241 gtk_editable_set_position(GTK_EDITABLE(td->entry), -1);
243 /* Reduce the number of entries in the menu */
245 gtk_container_foreach(GTK_CONTAINER(widget), tab_completion_iter_menu_items, td);
246 if (td->choices > 1) return TRUE; /* multiple choices */
247 if (td->choices > 0) tab_completion_do(td); /* one choice */
251 gtk_menu_popdown(GTK_MENU(widget));
252 /* doing this does not emit the "selection done" signal, unref it ourselves */
253 g_object_unref(widget);
260 static void tab_completion_popup_cb(GtkWidget *widget, gpointer data)
262 auto name = static_cast<gchar *>(data);
266 td = static_cast<TabCompData *>(g_object_get_data(G_OBJECT(widget), "tab_completion_data"));
269 buf = g_build_filename(td->dir_path, name, NULL);
270 gtk_entry_set_text(GTK_ENTRY(td->entry), buf);
271 gtk_editable_set_position(GTK_EDITABLE(td->entry), strlen(buf));
274 tab_completion_emit_tab_signal(td);
277 static void tab_completion_popup_list(TabCompData *td, GList *list)
287 * well, the menu would be too long anyway...
288 * (listing /dev causes gtk+ window allocation errors, -> too big a window)
289 * this is why menu popups are disabled, this really should be a popup scrollable listview.
291 if (g_list_length(list) > 200) return;
294 menu = popup_menu_short_lived();
297 while (work && count < TAB_COMP_POPUP_MAX)
299 auto name = static_cast<gchar *>(work->data);
302 item = menu_item_add_simple(menu, name, G_CALLBACK(tab_completion_popup_cb), name);
303 g_object_set_data(G_OBJECT(item), "tab_completion_data", td);
309 g_signal_connect(G_OBJECT(menu), "key_press_event",
310 G_CALLBACK(tab_completion_popup_key_press), td);
312 gtk_menu_popup_at_widget(GTK_MENU(menu), td->entry, GDK_GRAVITY_NORTH_EAST, GDK_GRAVITY_NORTH, nullptr);
316 #define CASE_SORT strcmp
319 static gint simple_sort(gconstpointer a, gconstpointer b)
321 return CASE_SORT((gchar *)a, (gchar *)b);
326 static gboolean tab_completion_do(TabCompData *td)
328 const gchar *entry_text = gtk_entry_get_text(GTK_ENTRY(td->entry));
329 const gchar *entry_file;
332 gboolean home_exp = FALSE;
334 if (entry_text[0] == '\0')
336 entry_dir = g_strdup(G_DIR_SEPARATOR_S); /** @FIXME root directory win32 */
337 gtk_entry_set_text(GTK_ENTRY(td->entry), entry_dir);
338 gtk_editable_set_position(GTK_EDITABLE(td->entry), strlen(entry_dir));
343 /* home dir expansion */
344 if (entry_text[0] == '~')
346 entry_dir = expand_tilde(entry_text);
351 entry_dir = g_strdup(entry_text);
354 if (isfile(entry_dir))
358 gtk_entry_set_text(GTK_ENTRY(td->entry), entry_dir);
359 gtk_editable_set_position(GTK_EDITABLE(td->entry), strlen(entry_dir));
365 entry_file = filename_from_path(entry_text);
367 if (isdir(entry_dir) && strcmp(entry_file, ".") != 0 && strcmp(entry_file, "..") != 0)
369 ptr = entry_dir + strlen(entry_dir) - 1;
370 if (ptr[0] == G_DIR_SEPARATOR)
374 gtk_entry_set_text(GTK_ENTRY(td->entry), entry_dir);
375 gtk_editable_set_position(GTK_EDITABLE(td->entry), strlen(entry_dir));
378 tab_completion_read_dir(td, entry_dir);
379 td->file_list = g_list_sort(td->file_list, simple_sort);
380 if (td->file_list && !td->file_list->next)
385 file = static_cast<const gchar *>(td->file_list->data);
386 buf = g_build_filename(entry_dir, file, NULL);
389 gchar *tmp = g_strconcat(buf, G_DIR_SEPARATOR_S, NULL);
393 gtk_entry_set_text(GTK_ENTRY(td->entry), buf);
394 gtk_editable_set_position(GTK_EDITABLE(td->entry), strlen(buf));
398 #ifdef TAB_COMPLETION_ENABLE_POPUP_MENU
402 tab_completion_popup_list(td, td->file_list);
411 gchar *buf = g_strconcat(entry_dir, G_DIR_SEPARATOR_S, NULL);
412 gtk_entry_set_text(GTK_ENTRY(td->entry), buf);
413 gtk_editable_set_position(GTK_EDITABLE(td->entry), strlen(buf));
420 ptr = const_cast<gchar *>(filename_from_path(entry_dir));
421 if (ptr > entry_dir) ptr--;
424 if (strlen(entry_dir) == 0)
427 entry_dir = g_strdup(G_DIR_SEPARATOR_S); /** @FIXME win32 */
430 if (isdir(entry_dir))
433 GList *poss = nullptr;
434 gint l = strlen(entry_file);
436 if (!td->dir_path || !td->file_list || strcmp(td->dir_path, entry_dir) != 0)
438 tab_completion_read_dir(td, entry_dir);
441 list = td->file_list;
444 auto file = static_cast<gchar *>(list->data);
445 if (strncmp(entry_file, file, l) == 0)
447 poss = g_list_prepend(poss, file);
456 auto file = static_cast<gchar *>(poss->data);
459 buf = g_build_filename(entry_dir, file, NULL);
460 gtk_entry_set_text(GTK_ENTRY(td->entry), buf);
461 gtk_editable_set_position(GTK_EDITABLE(td->entry), strlen(buf));
469 gsize c = strlen(entry_file);
470 gboolean done = FALSE;
471 auto test_file = static_cast<gchar *>(poss->data);
476 if (!list) done = TRUE;
477 while (list && !done)
479 auto file = static_cast<gchar *>(list->data);
480 if (strlen(file) < c || strncmp(test_file, file, c) != 0)
493 file = g_strdup(test_file);
495 buf = g_build_filename(entry_dir, file, NULL);
496 gtk_entry_set_text(GTK_ENTRY(td->entry), buf);
497 gtk_editable_set_position(GTK_EDITABLE(td->entry), strlen(buf));
499 #ifdef TAB_COMPLETION_ENABLE_POPUP_MENU
501 poss = g_list_sort(poss, simple_sort);
502 tab_completion_popup_list(td, poss);
522 static gboolean tab_completion_key_pressed(GtkWidget *widget, GdkEventKey *event, gpointer data)
524 auto td = static_cast<TabCompData *>(data);
525 gboolean stop_signal = FALSE;
527 switch (event->keyval)
530 if (!(event->state & GDK_CONTROL_MASK))
532 if (tab_completion_do(td))
534 tab_completion_emit_tab_signal(td);
539 case GDK_KEY_Return: case GDK_KEY_KP_Enter:
541 (event->state & GDK_CONTROL_MASK))
543 tab_completion_select_show(td);
546 else if (tab_completion_emit_enter_signal(td))
555 if (stop_signal) g_signal_stop_emission_by_name(G_OBJECT(widget), "key_press_event");
557 return (stop_signal);
560 static void tab_completion_button_pressed(GtkWidget *, gpointer data)
563 auto entry = static_cast<GtkWidget *>(data);
565 td = static_cast<TabCompData *>(g_object_get_data(G_OBJECT(entry), "tab_completion_data"));
569 if (!gtk_widget_has_focus(entry))
571 gtk_widget_grab_focus(entry);
574 if (tab_completion_do(td))
576 tab_completion_emit_tab_signal(td);
580 static void tab_completion_button_size_allocate(GtkWidget *button, GtkAllocation *allocation, gpointer data)
582 auto parent = static_cast<GtkWidget *>(data);
583 GtkAllocation parent_allocation;
584 gtk_widget_get_allocation(parent, &parent_allocation);
586 if (allocation->height > parent_allocation.height)
588 GtkAllocation button_allocation;
590 gtk_widget_get_allocation(button, &button_allocation);
591 button_allocation.height = parent_allocation.height;
592 button_allocation.y = parent_allocation.y +
593 (parent_allocation.height - parent_allocation.height) / 2;
594 gtk_widget_size_allocate(button, &button_allocation);
598 static GtkWidget *tab_completion_create_complete_button(GtkWidget *entry, GtkWidget *parent)
604 button = gtk_button_new();
605 gtk_widget_set_can_focus(button, FALSE);
606 g_signal_connect(G_OBJECT(button), "size_allocate",
607 G_CALLBACK(tab_completion_button_size_allocate), parent);
608 g_signal_connect(G_OBJECT(button), "clicked",
609 G_CALLBACK(tab_completion_button_pressed), entry);
611 pixbuf = gdk_pixbuf_new_from_inline(-1, icon_tabcomp, FALSE, nullptr);
612 icon = gtk_image_new_from_pixbuf(pixbuf);
613 g_object_unref(pixbuf);
615 gtk_container_add(GTK_CONTAINER(button), icon);
616 gtk_widget_show(icon);
622 *----------------------------------------------------------------------------
624 *----------------------------------------------------------------------------
627 GtkWidget *tab_completion_new_with_history(GtkWidget **entry, const gchar *text,
628 const gchar *history_key, gint max_levels,
629 void (*enter_func)(const gchar *, gpointer), gpointer data)
633 GtkWidget *combo_entry;
639 box = gtk_box_new(GTK_ORIENTATION_HORIZONTAL, 0);
641 combo = gtk_combo_box_text_new_with_entry();
642 gtk_box_pack_start(GTK_BOX(box), combo, TRUE, TRUE, 0);
643 gtk_widget_show(combo);
645 combo_entry = gtk_bin_get_child(GTK_BIN(combo));
647 button = tab_completion_create_complete_button(combo_entry, combo);
648 gtk_box_pack_start(GTK_BOX(box), button, FALSE, FALSE, 0);
649 gtk_widget_show(button);
651 tab_completion_add_to_entry(combo_entry, enter_func, nullptr, nullptr, data);
653 td = static_cast<TabCompData *>(g_object_get_data(G_OBJECT(combo_entry), "tab_completion_data"));
654 if (!td) return nullptr; /* this should never happen! */
657 td->has_history = TRUE;
658 td->history_key = g_strdup(history_key);
659 td->history_levels = max_levels;
661 work = history_list_get_by_key(td->history_key);
663 work = history_list_get_by_key(history_key);
666 gtk_combo_box_text_append_text(GTK_COMBO_BOX_TEXT(combo), static_cast<gchar *>(work->data));
673 gtk_entry_set_text(GTK_ENTRY(combo_entry), text);
677 gtk_combo_box_set_active(GTK_COMBO_BOX(combo), 0);
680 if (entry) *entry = combo_entry;
684 const gchar *tab_completion_set_to_last_history(GtkWidget *entry)
686 auto td = static_cast<TabCompData *>(g_object_get_data(G_OBJECT(entry), "tab_completion_data"));
689 if (!td || !td->has_history) return nullptr;
691 buf = history_list_find_last_path_by_key(td->history_key);
694 gtk_entry_set_text(GTK_ENTRY(td->entry), buf);
700 void tab_completion_append_to_history(GtkWidget *entry, const gchar *path)
707 td = static_cast<TabCompData *>(g_object_get_data(G_OBJECT(entry), "tab_completion_data"));
711 if (!td || !td->has_history) return;
713 history_list_add_to_key(td->history_key, path, td->history_levels);
715 gtk_combo_box_set_active(GTK_COMBO_BOX(td->combo), -1);
717 store = gtk_combo_box_get_model(GTK_COMBO_BOX(td->combo));
718 gtk_list_store_clear(GTK_LIST_STORE(store));
720 work = history_list_get_by_key(td->history_key);
723 gtk_combo_box_text_append_text(GTK_COMBO_BOX_TEXT(td->combo), static_cast<gchar *>(work->data));
728 if (td->tab_append_func) {
729 td->tab_append_func(path, td->tab_append_data, n);
733 GtkWidget *tab_completion_new(GtkWidget **entry, const gchar *text,
734 void (*enter_func)(const gchar *, gpointer), const gchar *filter, const gchar *filter_desc, gpointer data)
740 hbox = gtk_box_new(GTK_ORIENTATION_HORIZONTAL, 0);
742 newentry = gtk_entry_new();
743 if (text) gtk_entry_set_text(GTK_ENTRY(newentry), text);
744 gtk_box_pack_start(GTK_BOX(hbox), newentry, TRUE, TRUE, 0);
745 gtk_widget_show(newentry);
747 button = tab_completion_create_complete_button(newentry, newentry);
748 gtk_box_pack_start(GTK_BOX(hbox), button, FALSE, FALSE, 0);
749 gtk_widget_show(button);
751 tab_completion_add_to_entry(newentry, enter_func, filter, filter_desc, data);
752 if (entry) *entry = newentry;
756 void tab_completion_add_to_entry(GtkWidget *entry, void (*enter_func)(const gchar *, gpointer), const gchar *filter, const gchar *filter_desc, gpointer data)
761 log_printf("Tab completion error: entry != NULL\n");
765 td = g_new0(TabCompData, 1);
768 td->enter_func = enter_func;
769 td->enter_data = data;
770 td->filter = g_strdup(filter);
771 td->filter_desc = g_strdup(filter_desc);
773 g_object_set_data(G_OBJECT(td->entry), "tab_completion_data", td);
775 g_signal_connect(G_OBJECT(entry), "key_press_event",
776 G_CALLBACK(tab_completion_key_pressed), td);
777 g_signal_connect(G_OBJECT(entry), "destroy",
778 G_CALLBACK(tab_completion_destroy), td);
781 void tab_completion_add_tab_func(GtkWidget *entry, void (*tab_func)(const gchar *, gpointer), gpointer data)
783 auto td = static_cast<TabCompData *>(g_object_get_data(G_OBJECT(entry), "tab_completion_data"));
787 td->tab_func = tab_func;
791 /* Add a callback function called when a new entry is appended to the list */
792 void tab_completion_add_append_func(GtkWidget *entry, void (*tab_append_func)(const gchar *, gpointer, gint), gpointer data)
794 auto td = static_cast<TabCompData *>(g_object_get_data(G_OBJECT(entry), "tab_completion_data"));
798 td->tab_append_func = tab_append_func;
799 td->tab_append_data = data;
802 gchar *remove_trailing_slash(const gchar *path)
806 if (!path) return nullptr;
809 while (l > 1 && path[l - 1] == G_DIR_SEPARATOR) l--;
811 return g_strndup(path, l);
814 static void tab_completion_select_cancel_cb(FileDialog *fd, gpointer data)
816 auto td = static_cast<TabCompData *>(data);
819 file_dialog_close(fd);
822 static void tab_completion_select_ok_cb(FileDialog *fd, gpointer data)
824 auto td = static_cast<TabCompData *>(data);
826 gtk_entry_set_text(GTK_ENTRY(td->entry), gtk_entry_get_text(GTK_ENTRY(fd->entry)));
828 tab_completion_select_cancel_cb(fd, data);
830 tab_completion_emit_enter_signal(td);
833 static void tab_completion_select_show(TabCompData *td)
837 const gchar *filter = nullptr;
838 gchar *filter_desc = nullptr;
842 gtk_window_present(GTK_WINDOW(GENERIC_DIALOG(td->fd)->dialog));
846 title = (td->fd_title) ? td->fd_title : _("Select path");
847 td->fd = file_dialog_new(title, "select_path", td->entry,
848 tab_completion_select_cancel_cb, td);
849 file_dialog_add_button(td->fd, GQ_ICON_OK, "OK",
850 tab_completion_select_ok_cb, TRUE);
852 generic_dialog_add_message(GENERIC_DIALOG(td->fd), nullptr, title, nullptr, FALSE);
864 filter_desc = td->filter_desc;
868 filter_desc = _("All files");
871 path = gtk_entry_get_text(GTK_ENTRY(td->entry));
872 if (strlen(path) == 0) path = nullptr;
873 if (td->fd_folders_only)
875 file_dialog_add_path_widgets(td->fd, nullptr, path, td->history_key, nullptr, nullptr);
879 file_dialog_add_path_widgets(td->fd, nullptr, path, td->history_key, filter, filter_desc);
882 gtk_widget_show(GENERIC_DIALOG(td->fd)->dialog);
885 static void tab_completion_select_pressed(GtkWidget *, gpointer data)
887 auto td = static_cast<TabCompData *>(data);
889 tab_completion_select_show(td);
892 void tab_completion_add_select_button(GtkWidget *entry, const gchar *title, gboolean folders_only)
898 td = static_cast<TabCompData *>(g_object_get_data(G_OBJECT(entry), "tab_completion_data"));
902 g_free(td->fd_title);
903 td->fd_title = g_strdup(title);
904 td->fd_folders_only = folders_only;
906 if (td->fd_button) return;
908 parent = (td->combo) ? td->combo : td->entry;
910 hbox = gtk_widget_get_parent(parent);
911 if (!GTK_IS_BOX(hbox)) return;
913 td->fd_button = gtk_button_new_with_label("...");
914 g_signal_connect(G_OBJECT(td->fd_button), "size_allocate",
915 G_CALLBACK(tab_completion_button_size_allocate), parent);
916 g_signal_connect(G_OBJECT(td->fd_button), "clicked",
917 G_CALLBACK(tab_completion_select_pressed), td);
919 gtk_box_pack_start(GTK_BOX(hbox), td->fd_button, FALSE, FALSE, 0);
921 gtk_widget_show(td->fd_button);
923 /* vim: set shiftwidth=8 softtabstop=0 cindent cinoptions={1s: */