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.
22 #include "ui-tabcomp.h"
26 #include <sys/types.h>
32 #include "history-list.h"
34 #include "main-defines.h"
35 #include "misc.h" /* expand_tilde() */
37 #include "ui-fileops.h"
38 #include "ui-utildlg.h"
40 /* define this to enable a pop-up menu that shows possible matches
41 * #define TAB_COMPLETION_ENABLE_POPUP_MENU
43 #define TAB_COMPLETION_ENABLE_POPUP_MENU 1
44 #define TAB_COMP_POPUP_MAX 1000
46 #ifdef TAB_COMPLETION_ENABLE_POPUP_MENU
53 * ----------------------------------------------------------------
54 * Tab completion routines, can be connected to any gtkentry widget
55 * using the tab_completion_add_to_entry() function.
57 * Use remove_trailing_slash() to strip the trailing G_DIR_SEPARATOR.
59 * ----------------------------------------------------------------
67 void (*enter_func)(const gchar *, gpointer);
68 void (*tab_func)(const gchar *, gpointer);
69 void (*tab_append_func)(const gchar *, gpointer, gint);
73 gpointer tab_append_data;
82 gboolean fd_folders_only;
91 static void tab_completion_select_show(TabCompData *td);
92 static gint tab_completion_do(TabCompData *td);
94 static void tab_completion_free_list(TabCompData *td)
97 td->dir_path = nullptr;
99 g_list_free_full(td->file_list, g_free);
100 td->file_list = nullptr;
103 static void tab_completion_read_dir(TabCompData *td, const gchar *path)
107 GList *list = nullptr;
110 tab_completion_free_list(td);
112 pathl = path_from_utf8(path);
120 while ((dir = readdir(dp)) != nullptr)
122 gchar *name = dir->d_name;
123 if (strcmp(name, ".") != 0 && strcmp(name, "..") != 0 &&
124 (name[0] != '.' || options->file_filter.show_hidden_files))
126 gchar *abspath = g_build_filename(pathl, name, NULL);
128 if (g_file_test(abspath, G_FILE_TEST_IS_DIR))
130 gchar *dname = g_strconcat(name, G_DIR_SEPARATOR_S, NULL);
131 list = g_list_prepend(list, path_to_utf8(dname));
136 list = g_list_prepend(list, path_to_utf8(name));
143 td->dir_path = g_strdup(path);
144 td->file_list = list;
148 static void tab_completion_destroy(GtkWidget *, gpointer data)
150 auto td = static_cast<TabCompData *>(data);
152 tab_completion_free_list(td);
153 g_free(td->history_key);
155 if (td->fd) file_dialog_close(td->fd);
156 g_free(td->fd_title);
159 g_free(td->filter_desc);
164 static gchar *tab_completion_get_text(TabCompData *td)
168 text = g_strdup(gq_gtk_entry_get_text(GTK_ENTRY(td->entry)));
173 text = expand_tilde(text);
180 static gboolean tab_completion_emit_enter_signal(TabCompData *td)
183 if (!td->enter_func) return FALSE;
185 text = tab_completion_get_text(td);
186 td->enter_func(text, td->enter_data);
192 static void tab_completion_emit_tab_signal(TabCompData *td)
195 if (!td->tab_func) return;
197 text = tab_completion_get_text(td);
198 td->tab_func(text, td->tab_data);
202 #ifdef TAB_COMPLETION_ENABLE_POPUP_MENU
203 void tab_completion_iter_menu_items(GtkWidget *widget, gpointer data)
205 auto td = static_cast<TabCompData *>(data);
208 if (!gtk_widget_get_visible(widget)) return;
210 child = gtk_bin_get_child(GTK_BIN(widget));
211 if (GTK_IS_LABEL(child)) {
212 const gchar *text = gtk_label_get_text(GTK_LABEL(child));
213 const gchar *entry_text = gq_gtk_entry_get_text(GTK_ENTRY(td->entry));
214 const gchar *prefix = filename_from_path(entry_text);
215 guint prefix_len = strlen(prefix);
217 if (strlen(text) < prefix_len || strncmp(text, prefix, prefix_len) != 0)
219 /* Hide menu items not matching */
220 gtk_widget_hide(widget);
224 /* Count how many choices are left in the menu */
230 static gboolean tab_completion_popup_key_press(GtkWidget *widget, GdkEventKey *event, gpointer data)
232 auto td = static_cast<TabCompData *>(data);
234 if (event->keyval == GDK_KEY_Tab ||
235 event->keyval == GDK_KEY_BackSpace ||
236 (event->keyval >= 0x20 && event->keyval <= 0xFF) )
238 if (event->keyval >= 0x20 && event->keyval <= 0xFF)
243 buf[0] = event->keyval;
245 gtk_editable_insert_text(GTK_EDITABLE(td->entry), buf, 1, &p);
246 gtk_editable_set_position(GTK_EDITABLE(td->entry), -1);
248 /* Reduce the number of entries in the menu */
250 gtk_container_foreach(GTK_CONTAINER(widget), tab_completion_iter_menu_items, td);
251 if (td->choices > 1) return TRUE; /* multiple choices */
252 if (td->choices > 0) tab_completion_do(td); /* one choice */
256 gtk_menu_popdown(GTK_MENU(widget));
257 /* doing this does not emit the "selection done" signal, unref it ourselves */
258 g_object_unref(widget);
265 static void tab_completion_popup_cb(GtkWidget *widget, gpointer data)
267 auto name = static_cast<gchar *>(data);
271 td = static_cast<TabCompData *>(g_object_get_data(G_OBJECT(widget), "tab_completion_data"));
274 buf = g_build_filename(td->dir_path, name, NULL);
275 gq_gtk_entry_set_text(GTK_ENTRY(td->entry), buf);
276 gtk_editable_set_position(GTK_EDITABLE(td->entry), strlen(buf));
279 tab_completion_emit_tab_signal(td);
282 static void tab_completion_popup_list(TabCompData *td, GList *list)
292 * well, the menu would be too long anyway...
293 * (listing /dev causes gtk+ window allocation errors, -> too big a window)
294 * this is why menu popups are disabled, this really should be a popup scrollable listview.
296 if (g_list_length(list) > 200) return;
299 menu = popup_menu_short_lived();
302 while (work && count < TAB_COMP_POPUP_MAX)
304 auto name = static_cast<gchar *>(work->data);
307 item = menu_item_add_simple(menu, name, G_CALLBACK(tab_completion_popup_cb), name);
308 g_object_set_data(G_OBJECT(item), "tab_completion_data", td);
314 g_signal_connect(G_OBJECT(menu), "key_press_event",
315 G_CALLBACK(tab_completion_popup_key_press), td);
317 gtk_menu_popup_at_widget(GTK_MENU(menu), td->entry, GDK_GRAVITY_NORTH_EAST, GDK_GRAVITY_NORTH, nullptr);
321 #define CASE_SORT strcmp
324 static gint simple_sort(gconstpointer a, gconstpointer b)
326 return CASE_SORT((gchar *)a, (gchar *)b);
331 static gboolean tab_completion_do(TabCompData *td)
333 const gchar *entry_text = gq_gtk_entry_get_text(GTK_ENTRY(td->entry));
334 const gchar *entry_file;
337 gboolean home_exp = FALSE;
339 if (entry_text[0] == '\0')
341 entry_dir = g_strdup(G_DIR_SEPARATOR_S); /** @FIXME root directory win32 */
342 gq_gtk_entry_set_text(GTK_ENTRY(td->entry), entry_dir);
343 gtk_editable_set_position(GTK_EDITABLE(td->entry), strlen(entry_dir));
348 /* home dir expansion */
349 if (entry_text[0] == '~')
351 entry_dir = expand_tilde(entry_text);
356 entry_dir = g_strdup(entry_text);
359 if (isfile(entry_dir))
363 gq_gtk_entry_set_text(GTK_ENTRY(td->entry), entry_dir);
364 gtk_editable_set_position(GTK_EDITABLE(td->entry), strlen(entry_dir));
370 entry_file = filename_from_path(entry_text);
372 if (isdir(entry_dir) && strcmp(entry_file, ".") != 0 && strcmp(entry_file, "..") != 0)
374 ptr = entry_dir + strlen(entry_dir) - 1;
375 if (ptr[0] == G_DIR_SEPARATOR)
379 gq_gtk_entry_set_text(GTK_ENTRY(td->entry), entry_dir);
380 gtk_editable_set_position(GTK_EDITABLE(td->entry), strlen(entry_dir));
383 tab_completion_read_dir(td, entry_dir);
384 td->file_list = g_list_sort(td->file_list, simple_sort);
385 if (td->file_list && !td->file_list->next)
390 file = static_cast<const gchar *>(td->file_list->data);
391 buf = g_build_filename(entry_dir, file, NULL);
394 gchar *tmp = g_strconcat(buf, G_DIR_SEPARATOR_S, NULL);
398 gq_gtk_entry_set_text(GTK_ENTRY(td->entry), buf);
399 gtk_editable_set_position(GTK_EDITABLE(td->entry), strlen(buf));
403 #ifdef TAB_COMPLETION_ENABLE_POPUP_MENU
407 tab_completion_popup_list(td, td->file_list);
415 gchar *buf = g_strconcat(entry_dir, G_DIR_SEPARATOR_S, NULL);
416 gq_gtk_entry_set_text(GTK_ENTRY(td->entry), buf);
417 gtk_editable_set_position(GTK_EDITABLE(td->entry), strlen(buf));
423 ptr = const_cast<gchar *>(filename_from_path(entry_dir));
424 if (ptr > entry_dir) ptr--;
427 if (strlen(entry_dir) == 0)
430 entry_dir = g_strdup(G_DIR_SEPARATOR_S); /** @FIXME win32 */
433 if (isdir(entry_dir))
436 GList *poss = nullptr;
437 gint l = strlen(entry_file);
439 if (!td->dir_path || !td->file_list || strcmp(td->dir_path, entry_dir) != 0)
441 tab_completion_read_dir(td, entry_dir);
444 list = td->file_list;
447 auto file = static_cast<gchar *>(list->data);
448 if (strncmp(entry_file, file, l) == 0)
450 poss = g_list_prepend(poss, file);
459 auto file = static_cast<gchar *>(poss->data);
462 buf = g_build_filename(entry_dir, file, NULL);
463 gq_gtk_entry_set_text(GTK_ENTRY(td->entry), buf);
464 gtk_editable_set_position(GTK_EDITABLE(td->entry), strlen(buf));
471 gsize c = strlen(entry_file);
472 gboolean done = FALSE;
473 auto test_file = static_cast<gchar *>(poss->data);
478 if (!list) done = TRUE;
479 while (list && !done)
481 auto file = static_cast<gchar *>(list->data);
482 if (strlen(file) < c || strncmp(test_file, file, c) != 0)
495 file = g_strdup(test_file);
497 buf = g_build_filename(entry_dir, file, NULL);
498 gq_gtk_entry_set_text(GTK_ENTRY(td->entry), buf);
499 gtk_editable_set_position(GTK_EDITABLE(td->entry), strlen(buf));
501 #ifdef TAB_COMPLETION_ENABLE_POPUP_MENU
503 poss = g_list_sort(poss, simple_sort);
504 tab_completion_popup_list(td, poss);
524 static gboolean tab_completion_key_pressed(GtkWidget *widget, GdkEventKey *event, gpointer data)
526 auto td = static_cast<TabCompData *>(data);
527 gboolean stop_signal = FALSE;
529 switch (event->keyval)
532 if (!(event->state & GDK_CONTROL_MASK))
534 if (tab_completion_do(td))
536 tab_completion_emit_tab_signal(td);
541 case GDK_KEY_Return: case GDK_KEY_KP_Enter:
543 (event->state & GDK_CONTROL_MASK))
545 tab_completion_select_show(td);
548 else if (tab_completion_emit_enter_signal(td))
557 if (stop_signal) g_signal_stop_emission_by_name(G_OBJECT(widget), "key_press_event");
559 return (stop_signal);
562 static void tab_completion_button_pressed(GtkWidget *, gpointer data)
565 auto entry = static_cast<GtkWidget *>(data);
567 td = static_cast<TabCompData *>(g_object_get_data(G_OBJECT(entry), "tab_completion_data"));
571 if (!gtk_widget_has_focus(entry))
573 gtk_widget_grab_focus(entry);
576 if (tab_completion_do(td))
578 tab_completion_emit_tab_signal(td);
582 static void tab_completion_button_size_allocate(GtkWidget *button, GtkAllocation *allocation, gpointer data)
584 auto parent = static_cast<GtkWidget *>(data);
585 GtkAllocation parent_allocation;
586 gtk_widget_get_allocation(parent, &parent_allocation);
588 if (allocation->height > parent_allocation.height)
590 GtkAllocation button_allocation;
592 gtk_widget_get_allocation(button, &button_allocation);
593 button_allocation.height = parent_allocation.height;
594 button_allocation.y = parent_allocation.y;
595 gtk_widget_size_allocate(button, &button_allocation);
599 static GtkWidget *tab_completion_create_complete_button(GtkWidget *entry, GtkWidget *parent)
603 button = gtk_button_new_from_icon_name(GQ_ICON_GO_LAST, GTK_ICON_SIZE_BUTTON);
604 gtk_widget_set_can_focus(button, FALSE);
605 g_signal_connect(G_OBJECT(button), "size_allocate",
606 G_CALLBACK(tab_completion_button_size_allocate), parent);
607 g_signal_connect(G_OBJECT(button), "clicked",
608 G_CALLBACK(tab_completion_button_pressed), entry);
614 *----------------------------------------------------------------------------
616 *----------------------------------------------------------------------------
619 GtkWidget *tab_completion_new_with_history(GtkWidget **entry, const gchar *text,
620 const gchar *history_key, gint max_levels,
621 void (*enter_func)(const gchar *, gpointer), gpointer data)
625 GtkWidget *combo_entry;
631 box = gtk_box_new(GTK_ORIENTATION_HORIZONTAL, 0);
633 combo = gtk_combo_box_text_new_with_entry();
634 gq_gtk_box_pack_start(GTK_BOX(box), combo, TRUE, TRUE, 0);
635 gtk_widget_show(combo);
637 combo_entry = gtk_bin_get_child(GTK_BIN(combo));
639 button = tab_completion_create_complete_button(combo_entry, combo);
640 gq_gtk_box_pack_start(GTK_BOX(box), button, FALSE, FALSE, 0);
641 gtk_widget_show(button);
643 tab_completion_add_to_entry(combo_entry, enter_func, nullptr, nullptr, data);
645 td = static_cast<TabCompData *>(g_object_get_data(G_OBJECT(combo_entry), "tab_completion_data"));
646 if (!td) return nullptr; /* this should never happen! */
649 td->has_history = TRUE;
650 td->history_key = g_strdup(history_key);
651 td->history_levels = max_levels;
653 work = history_list_get_by_key(td->history_key);
655 work = history_list_get_by_key(history_key);
658 gtk_combo_box_text_append_text(GTK_COMBO_BOX_TEXT(combo), static_cast<gchar *>(work->data));
665 gq_gtk_entry_set_text(GTK_ENTRY(combo_entry), text);
669 gtk_combo_box_set_active(GTK_COMBO_BOX(combo), 0);
672 if (entry) *entry = combo_entry;
676 const gchar *tab_completion_set_to_last_history(GtkWidget *entry)
678 auto td = static_cast<TabCompData *>(g_object_get_data(G_OBJECT(entry), "tab_completion_data"));
681 if (!td || !td->has_history) return nullptr;
683 buf = history_list_find_last_path_by_key(td->history_key);
686 gq_gtk_entry_set_text(GTK_ENTRY(td->entry), buf);
692 void tab_completion_append_to_history(GtkWidget *entry, const gchar *path)
699 td = static_cast<TabCompData *>(g_object_get_data(G_OBJECT(entry), "tab_completion_data"));
703 if (!td || !td->has_history) return;
705 history_list_add_to_key(td->history_key, path, td->history_levels);
707 gtk_combo_box_set_active(GTK_COMBO_BOX(td->combo), -1);
709 store = gtk_combo_box_get_model(GTK_COMBO_BOX(td->combo));
710 gtk_list_store_clear(GTK_LIST_STORE(store));
712 work = history_list_get_by_key(td->history_key);
715 gtk_combo_box_text_append_text(GTK_COMBO_BOX_TEXT(td->combo), static_cast<gchar *>(work->data));
720 if (td->tab_append_func) {
721 td->tab_append_func(path, td->tab_append_data, n);
725 GtkWidget *tab_completion_new(GtkWidget **entry, const gchar *text,
726 void (*enter_func)(const gchar *, gpointer), const gchar *filter, const gchar *filter_desc, gpointer data)
732 hbox = gtk_box_new(GTK_ORIENTATION_HORIZONTAL, 0);
734 newentry = gtk_entry_new();
735 if (text) gq_gtk_entry_set_text(GTK_ENTRY(newentry), text);
736 gq_gtk_box_pack_start(GTK_BOX(hbox), newentry, TRUE, TRUE, 0);
737 gtk_widget_show(newentry);
739 button = tab_completion_create_complete_button(newentry, newentry);
740 gq_gtk_box_pack_start(GTK_BOX(hbox), button, FALSE, FALSE, 0);
741 gtk_widget_show(button);
743 tab_completion_add_to_entry(newentry, enter_func, filter, filter_desc, data);
744 if (entry) *entry = newentry;
748 void tab_completion_add_to_entry(GtkWidget *entry, void (*enter_func)(const gchar *, gpointer), const gchar *filter, const gchar *filter_desc, gpointer data)
753 log_printf("Tab completion error: entry != NULL\n");
757 td = g_new0(TabCompData, 1);
760 td->enter_func = enter_func;
761 td->enter_data = data;
762 td->filter = g_strdup(filter);
763 td->filter_desc = g_strdup(filter_desc);
765 g_object_set_data(G_OBJECT(td->entry), "tab_completion_data", td);
767 g_signal_connect(G_OBJECT(entry), "key_press_event",
768 G_CALLBACK(tab_completion_key_pressed), td);
769 g_signal_connect(G_OBJECT(entry), "destroy",
770 G_CALLBACK(tab_completion_destroy), td);
773 void tab_completion_add_tab_func(GtkWidget *entry, void (*tab_func)(const gchar *, gpointer), gpointer data)
775 auto td = static_cast<TabCompData *>(g_object_get_data(G_OBJECT(entry), "tab_completion_data"));
779 td->tab_func = tab_func;
783 /* Add a callback function called when a new entry is appended to the list */
784 void tab_completion_add_append_func(GtkWidget *entry, void (*tab_append_func)(const gchar *, gpointer, gint), gpointer data)
786 auto td = static_cast<TabCompData *>(g_object_get_data(G_OBJECT(entry), "tab_completion_data"));
790 td->tab_append_func = tab_append_func;
791 td->tab_append_data = data;
794 gchar *remove_trailing_slash(const gchar *path)
798 if (!path) return nullptr;
801 while (l > 1 && path[l - 1] == G_DIR_SEPARATOR) l--;
803 return g_strndup(path, l);
806 static void tab_completion_select_cancel_cb(FileDialog *fd, gpointer data)
808 auto td = static_cast<TabCompData *>(data);
811 file_dialog_close(fd);
814 static void tab_completion_select_ok_cb(FileDialog *fd, gpointer data)
816 auto td = static_cast<TabCompData *>(data);
818 gq_gtk_entry_set_text(GTK_ENTRY(td->entry), gq_gtk_entry_get_text(GTK_ENTRY(fd->entry)));
820 tab_completion_select_cancel_cb(fd, data);
822 tab_completion_emit_enter_signal(td);
825 static void tab_completion_select_show(TabCompData *td)
829 const gchar *filter = nullptr;
830 gchar *filter_desc = nullptr;
834 gtk_window_present(GTK_WINDOW(GENERIC_DIALOG(td->fd)->dialog));
838 title = (td->fd_title) ? td->fd_title : _("Select path");
839 td->fd = file_dialog_new(title, "select_path", td->entry,
840 tab_completion_select_cancel_cb, td);
841 file_dialog_add_button(td->fd, GQ_ICON_OK, "OK",
842 tab_completion_select_ok_cb, TRUE);
844 generic_dialog_add_message(GENERIC_DIALOG(td->fd), nullptr, title, nullptr, FALSE);
856 filter_desc = td->filter_desc;
860 filter_desc = _("All files");
863 path = gq_gtk_entry_get_text(GTK_ENTRY(td->entry));
864 if (strlen(path) == 0) path = nullptr;
865 if (td->fd_folders_only)
867 file_dialog_add_path_widgets(td->fd, nullptr, path, td->history_key, nullptr, nullptr);
871 file_dialog_add_path_widgets(td->fd, nullptr, path, td->history_key, filter, filter_desc);
874 gtk_widget_show(GENERIC_DIALOG(td->fd)->dialog);
877 static void tab_completion_select_pressed(GtkWidget *, gpointer data)
879 auto td = static_cast<TabCompData *>(data);
881 tab_completion_select_show(td);
884 void tab_completion_add_select_button(GtkWidget *entry, const gchar *title, gboolean folders_only)
890 td = static_cast<TabCompData *>(g_object_get_data(G_OBJECT(entry), "tab_completion_data"));
894 g_free(td->fd_title);
895 td->fd_title = g_strdup(title);
896 td->fd_folders_only = folders_only;
898 if (td->fd_button) return;
900 parent = (td->combo) ? td->combo : td->entry;
902 hbox = gtk_widget_get_parent(parent);
903 if (!GTK_IS_BOX(hbox)) return;
905 td->fd_button = gtk_button_new_with_label("...");
906 g_signal_connect(G_OBJECT(td->fd_button), "size_allocate",
907 G_CALLBACK(tab_completion_button_size_allocate), parent);
908 g_signal_connect(G_OBJECT(td->fd_button), "clicked",
909 G_CALLBACK(tab_completion_select_pressed), td);
911 gq_gtk_box_pack_start(GTK_BOX(hbox), td->fd_button, FALSE, FALSE, 0);
913 gtk_widget_show(td->fd_button);
915 /* vim: set shiftwidth=8 softtabstop=0 cindent cinoptions={1s: */