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"
29 #include <glib-object.h>
33 #include "history-list.h"
35 #include "main-defines.h"
36 #include "misc.h" /* expand_tilde() */
38 #include "ui-fileops.h"
39 #include "ui-utildlg.h"
41 /* define this to enable a pop-up menu that shows possible matches
42 * #define TAB_COMPLETION_ENABLE_POPUP_MENU
44 #define TAB_COMPLETION_ENABLE_POPUP_MENU 1
45 #define TAB_COMP_POPUP_MAX 1000
47 #ifdef TAB_COMPLETION_ENABLE_POPUP_MENU
54 * ----------------------------------------------------------------
55 * Tab completion routines, can be connected to any gtkentry widget
56 * using the tab_completion_add_to_entry() function.
58 * Use remove_trailing_slash() to strip the trailing G_DIR_SEPARATOR.
60 * ----------------------------------------------------------------
68 void (*enter_func)(const gchar *, gpointer);
69 void (*tab_func)(const gchar *, gpointer);
70 void (*tab_append_func)(const gchar *, gpointer, gint);
74 gpointer tab_append_data;
83 gboolean fd_folders_only;
92 static void tab_completion_select_show(TabCompData *td);
93 static gint tab_completion_do(TabCompData *td);
95 static void tab_completion_free_list(TabCompData *td)
98 td->dir_path = nullptr;
100 g_list_free_full(td->file_list, g_free);
101 td->file_list = nullptr;
104 static void tab_completion_read_dir(TabCompData *td, const gchar *path)
108 GList *list = nullptr;
111 tab_completion_free_list(td);
113 pathl = path_from_utf8(path);
121 while ((dir = readdir(dp)) != nullptr)
123 gchar *name = dir->d_name;
124 if (strcmp(name, ".") != 0 && strcmp(name, "..") != 0 &&
125 (name[0] != '.' || options->file_filter.show_hidden_files))
127 gchar *abspath = g_build_filename(pathl, name, NULL);
129 if (g_file_test(abspath, G_FILE_TEST_IS_DIR))
131 gchar *dname = g_strconcat(name, G_DIR_SEPARATOR_S, NULL);
132 list = g_list_prepend(list, path_to_utf8(dname));
137 list = g_list_prepend(list, path_to_utf8(name));
144 td->dir_path = g_strdup(path);
145 td->file_list = list;
149 static void tab_completion_destroy(GtkWidget *, gpointer data)
151 auto td = static_cast<TabCompData *>(data);
153 tab_completion_free_list(td);
154 g_free(td->history_key);
156 if (td->fd) file_dialog_close(td->fd);
157 g_free(td->fd_title);
160 g_free(td->filter_desc);
165 static gchar *tab_completion_get_text(TabCompData *td)
169 text = g_strdup(gq_gtk_entry_get_text(GTK_ENTRY(td->entry)));
174 text = expand_tilde(text);
181 static gboolean tab_completion_emit_enter_signal(TabCompData *td)
184 if (!td->enter_func) return FALSE;
186 text = tab_completion_get_text(td);
187 td->enter_func(text, td->enter_data);
193 static void tab_completion_emit_tab_signal(TabCompData *td)
196 if (!td->tab_func) return;
198 text = tab_completion_get_text(td);
199 td->tab_func(text, td->tab_data);
203 #ifdef TAB_COMPLETION_ENABLE_POPUP_MENU
204 void tab_completion_iter_menu_items(GtkWidget *widget, gpointer data)
206 auto td = static_cast<TabCompData *>(data);
209 if (!gtk_widget_get_visible(widget)) return;
211 child = gtk_bin_get_child(GTK_BIN(widget));
212 if (GTK_IS_LABEL(child)) {
213 const gchar *text = gtk_label_get_text(GTK_LABEL(child));
214 const gchar *entry_text = gq_gtk_entry_get_text(GTK_ENTRY(td->entry));
215 const gchar *prefix = filename_from_path(entry_text);
216 guint prefix_len = strlen(prefix);
218 if (strlen(text) < prefix_len || strncmp(text, prefix, prefix_len) != 0)
220 /* Hide menu items not matching */
221 gtk_widget_hide(widget);
225 /* Count how many choices are left in the menu */
231 static gboolean tab_completion_popup_key_press(GtkWidget *widget, GdkEventKey *event, gpointer data)
233 auto td = static_cast<TabCompData *>(data);
235 if (event->keyval == GDK_KEY_Tab ||
236 event->keyval == GDK_KEY_BackSpace ||
237 (event->keyval >= 0x20 && event->keyval <= 0xFF) )
239 if (event->keyval >= 0x20 && event->keyval <= 0xFF)
244 buf[0] = event->keyval;
246 gtk_editable_insert_text(GTK_EDITABLE(td->entry), buf, 1, &p);
247 gtk_editable_set_position(GTK_EDITABLE(td->entry), -1);
249 /* Reduce the number of entries in the menu */
251 gtk_container_foreach(GTK_CONTAINER(widget), tab_completion_iter_menu_items, td);
252 if (td->choices > 1) return TRUE; /* multiple choices */
253 if (td->choices > 0) tab_completion_do(td); /* one choice */
257 gtk_menu_popdown(GTK_MENU(widget));
258 /* doing this does not emit the "selection done" signal, unref it ourselves */
259 g_object_unref(widget);
266 static void tab_completion_popup_cb(GtkWidget *widget, gpointer data)
268 auto name = static_cast<gchar *>(data);
272 td = static_cast<TabCompData *>(g_object_get_data(G_OBJECT(widget), "tab_completion_data"));
275 buf = g_build_filename(td->dir_path, name, NULL);
276 gq_gtk_entry_set_text(GTK_ENTRY(td->entry), buf);
277 gtk_editable_set_position(GTK_EDITABLE(td->entry), strlen(buf));
280 tab_completion_emit_tab_signal(td);
283 static void tab_completion_popup_list(TabCompData *td, GList *list)
293 * well, the menu would be too long anyway...
294 * (listing /dev causes gtk+ window allocation errors, -> too big a window)
295 * this is why menu popups are disabled, this really should be a popup scrollable listview.
297 if (g_list_length(list) > 200) return;
300 menu = popup_menu_short_lived();
303 while (work && count < TAB_COMP_POPUP_MAX)
305 auto name = static_cast<gchar *>(work->data);
308 item = menu_item_add_simple(menu, name, G_CALLBACK(tab_completion_popup_cb), name);
309 g_object_set_data(G_OBJECT(item), "tab_completion_data", td);
315 g_signal_connect(G_OBJECT(menu), "key_press_event",
316 G_CALLBACK(tab_completion_popup_key_press), td);
318 gtk_menu_popup_at_widget(GTK_MENU(menu), td->entry, GDK_GRAVITY_NORTH_EAST, GDK_GRAVITY_NORTH, nullptr);
322 #define CASE_SORT strcmp
325 static gint simple_sort(gconstpointer a, gconstpointer b)
327 return CASE_SORT((gchar *)a, (gchar *)b);
332 static gboolean tab_completion_do(TabCompData *td)
334 const gchar *entry_text = gq_gtk_entry_get_text(GTK_ENTRY(td->entry));
335 const gchar *entry_file;
338 gboolean home_exp = FALSE;
340 if (entry_text[0] == '\0')
342 entry_dir = g_strdup(G_DIR_SEPARATOR_S); /** @FIXME root directory win32 */
343 gq_gtk_entry_set_text(GTK_ENTRY(td->entry), entry_dir);
344 gtk_editable_set_position(GTK_EDITABLE(td->entry), strlen(entry_dir));
349 /* home dir expansion */
350 if (entry_text[0] == '~')
352 entry_dir = expand_tilde(entry_text);
357 entry_dir = g_strdup(entry_text);
360 if (isfile(entry_dir))
364 gq_gtk_entry_set_text(GTK_ENTRY(td->entry), entry_dir);
365 gtk_editable_set_position(GTK_EDITABLE(td->entry), strlen(entry_dir));
371 entry_file = filename_from_path(entry_text);
373 if (isdir(entry_dir) && strcmp(entry_file, ".") != 0 && strcmp(entry_file, "..") != 0)
375 ptr = entry_dir + strlen(entry_dir) - 1;
376 if (ptr[0] == G_DIR_SEPARATOR)
380 gq_gtk_entry_set_text(GTK_ENTRY(td->entry), entry_dir);
381 gtk_editable_set_position(GTK_EDITABLE(td->entry), strlen(entry_dir));
384 tab_completion_read_dir(td, entry_dir);
385 td->file_list = g_list_sort(td->file_list, simple_sort);
386 if (td->file_list && !td->file_list->next)
391 file = static_cast<const gchar *>(td->file_list->data);
392 buf = g_build_filename(entry_dir, file, NULL);
395 gchar *tmp = g_strconcat(buf, G_DIR_SEPARATOR_S, NULL);
399 gq_gtk_entry_set_text(GTK_ENTRY(td->entry), buf);
400 gtk_editable_set_position(GTK_EDITABLE(td->entry), strlen(buf));
404 #ifdef TAB_COMPLETION_ENABLE_POPUP_MENU
408 tab_completion_popup_list(td, td->file_list);
416 gchar *buf = g_strconcat(entry_dir, G_DIR_SEPARATOR_S, NULL);
417 gq_gtk_entry_set_text(GTK_ENTRY(td->entry), buf);
418 gtk_editable_set_position(GTK_EDITABLE(td->entry), strlen(buf));
424 ptr = const_cast<gchar *>(filename_from_path(entry_dir));
425 if (ptr > entry_dir) ptr--;
428 if (strlen(entry_dir) == 0)
431 entry_dir = g_strdup(G_DIR_SEPARATOR_S); /** @FIXME win32 */
434 if (isdir(entry_dir))
437 GList *poss = nullptr;
438 gint l = strlen(entry_file);
440 if (!td->dir_path || !td->file_list || strcmp(td->dir_path, entry_dir) != 0)
442 tab_completion_read_dir(td, entry_dir);
445 list = td->file_list;
448 auto file = static_cast<gchar *>(list->data);
449 if (strncmp(entry_file, file, l) == 0)
451 poss = g_list_prepend(poss, file);
460 auto file = static_cast<gchar *>(poss->data);
463 buf = g_build_filename(entry_dir, file, NULL);
464 gq_gtk_entry_set_text(GTK_ENTRY(td->entry), buf);
465 gtk_editable_set_position(GTK_EDITABLE(td->entry), strlen(buf));
472 gsize c = strlen(entry_file);
473 gboolean done = FALSE;
474 auto test_file = static_cast<gchar *>(poss->data);
479 if (!list) done = TRUE;
480 while (list && !done)
482 auto file = static_cast<gchar *>(list->data);
483 if (strlen(file) < c || strncmp(test_file, file, c) != 0)
496 file = g_strdup(test_file);
498 buf = g_build_filename(entry_dir, file, NULL);
499 gq_gtk_entry_set_text(GTK_ENTRY(td->entry), buf);
500 gtk_editable_set_position(GTK_EDITABLE(td->entry), strlen(buf));
502 #ifdef TAB_COMPLETION_ENABLE_POPUP_MENU
504 poss = g_list_sort(poss, simple_sort);
505 tab_completion_popup_list(td, poss);
525 static gboolean tab_completion_key_pressed(GtkWidget *widget, GdkEventKey *event, gpointer data)
527 auto td = static_cast<TabCompData *>(data);
528 gboolean stop_signal = FALSE;
530 switch (event->keyval)
533 if (!(event->state & GDK_CONTROL_MASK))
535 if (tab_completion_do(td))
537 tab_completion_emit_tab_signal(td);
542 case GDK_KEY_Return: case GDK_KEY_KP_Enter:
544 (event->state & GDK_CONTROL_MASK))
546 tab_completion_select_show(td);
549 else if (tab_completion_emit_enter_signal(td))
558 if (stop_signal) g_signal_stop_emission_by_name(G_OBJECT(widget), "key_press_event");
560 return (stop_signal);
563 static void tab_completion_button_pressed(GtkWidget *, gpointer data)
566 auto entry = static_cast<GtkWidget *>(data);
568 td = static_cast<TabCompData *>(g_object_get_data(G_OBJECT(entry), "tab_completion_data"));
572 if (!gtk_widget_has_focus(entry))
574 gtk_widget_grab_focus(entry);
577 if (tab_completion_do(td))
579 tab_completion_emit_tab_signal(td);
583 static void tab_completion_button_size_allocate(GtkWidget *button, GtkAllocation *allocation, gpointer data)
585 auto parent = static_cast<GtkWidget *>(data);
586 GtkAllocation parent_allocation;
587 gtk_widget_get_allocation(parent, &parent_allocation);
589 if (allocation->height > parent_allocation.height)
591 GtkAllocation button_allocation;
593 gtk_widget_get_allocation(button, &button_allocation);
594 button_allocation.height = parent_allocation.height;
595 button_allocation.y = parent_allocation.y;
596 gtk_widget_size_allocate(button, &button_allocation);
600 static GtkWidget *tab_completion_create_complete_button(GtkWidget *entry, GtkWidget *parent)
604 button = gtk_button_new_from_icon_name(GQ_ICON_GO_LAST, GTK_ICON_SIZE_BUTTON);
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);
615 *----------------------------------------------------------------------------
617 *----------------------------------------------------------------------------
620 GtkWidget *tab_completion_new_with_history(GtkWidget **entry, const gchar *text,
621 const gchar *history_key, gint max_levels,
622 void (*enter_func)(const gchar *, gpointer), gpointer data)
626 GtkWidget *combo_entry;
632 box = gtk_box_new(GTK_ORIENTATION_HORIZONTAL, 0);
634 combo = gtk_combo_box_text_new_with_entry();
635 gq_gtk_box_pack_start(GTK_BOX(box), combo, TRUE, TRUE, 0);
636 gtk_widget_show(combo);
638 combo_entry = gtk_bin_get_child(GTK_BIN(combo));
640 button = tab_completion_create_complete_button(combo_entry, combo);
641 gq_gtk_box_pack_start(GTK_BOX(box), button, FALSE, FALSE, 0);
642 gtk_widget_show(button);
644 tab_completion_add_to_entry(combo_entry, enter_func, nullptr, nullptr, data);
646 td = static_cast<TabCompData *>(g_object_get_data(G_OBJECT(combo_entry), "tab_completion_data"));
647 if (!td) return nullptr; /* this should never happen! */
650 td->has_history = TRUE;
651 td->history_key = g_strdup(history_key);
652 td->history_levels = max_levels;
654 work = history_list_get_by_key(td->history_key);
656 work = history_list_get_by_key(history_key);
659 gtk_combo_box_text_append_text(GTK_COMBO_BOX_TEXT(combo), static_cast<gchar *>(work->data));
666 gq_gtk_entry_set_text(GTK_ENTRY(combo_entry), text);
670 gtk_combo_box_set_active(GTK_COMBO_BOX(combo), 0);
673 if (entry) *entry = combo_entry;
677 const gchar *tab_completion_set_to_last_history(GtkWidget *entry)
679 auto td = static_cast<TabCompData *>(g_object_get_data(G_OBJECT(entry), "tab_completion_data"));
682 if (!td || !td->has_history) return nullptr;
684 buf = history_list_find_last_path_by_key(td->history_key);
687 gq_gtk_entry_set_text(GTK_ENTRY(td->entry), buf);
693 void tab_completion_append_to_history(GtkWidget *entry, const gchar *path)
700 td = static_cast<TabCompData *>(g_object_get_data(G_OBJECT(entry), "tab_completion_data"));
704 if (!td || !td->has_history) return;
706 history_list_add_to_key(td->history_key, path, td->history_levels);
708 gtk_combo_box_set_active(GTK_COMBO_BOX(td->combo), -1);
710 store = gtk_combo_box_get_model(GTK_COMBO_BOX(td->combo));
711 gtk_list_store_clear(GTK_LIST_STORE(store));
713 work = history_list_get_by_key(td->history_key);
716 gtk_combo_box_text_append_text(GTK_COMBO_BOX_TEXT(td->combo), static_cast<gchar *>(work->data));
721 if (td->tab_append_func) {
722 td->tab_append_func(path, td->tab_append_data, n);
726 GtkWidget *tab_completion_new(GtkWidget **entry, const gchar *text,
727 void (*enter_func)(const gchar *, gpointer), const gchar *filter, const gchar *filter_desc, gpointer data)
733 hbox = gtk_box_new(GTK_ORIENTATION_HORIZONTAL, 0);
735 newentry = gtk_entry_new();
736 if (text) gq_gtk_entry_set_text(GTK_ENTRY(newentry), text);
737 gq_gtk_box_pack_start(GTK_BOX(hbox), newentry, TRUE, TRUE, 0);
738 gtk_widget_show(newentry);
740 button = tab_completion_create_complete_button(newentry, newentry);
741 gq_gtk_box_pack_start(GTK_BOX(hbox), button, FALSE, FALSE, 0);
742 gtk_widget_show(button);
744 tab_completion_add_to_entry(newentry, enter_func, filter, filter_desc, data);
745 if (entry) *entry = newentry;
749 void tab_completion_add_to_entry(GtkWidget *entry, void (*enter_func)(const gchar *, gpointer), const gchar *filter, const gchar *filter_desc, gpointer data)
754 log_printf("Tab completion error: entry != NULL\n");
758 td = g_new0(TabCompData, 1);
761 td->enter_func = enter_func;
762 td->enter_data = data;
763 td->filter = g_strdup(filter);
764 td->filter_desc = g_strdup(filter_desc);
766 g_object_set_data(G_OBJECT(td->entry), "tab_completion_data", td);
768 g_signal_connect(G_OBJECT(entry), "key_press_event",
769 G_CALLBACK(tab_completion_key_pressed), td);
770 g_signal_connect(G_OBJECT(entry), "destroy",
771 G_CALLBACK(tab_completion_destroy), td);
774 void tab_completion_add_tab_func(GtkWidget *entry, void (*tab_func)(const gchar *, gpointer), gpointer data)
776 auto td = static_cast<TabCompData *>(g_object_get_data(G_OBJECT(entry), "tab_completion_data"));
780 td->tab_func = tab_func;
784 /* Add a callback function called when a new entry is appended to the list */
785 void tab_completion_add_append_func(GtkWidget *entry, void (*tab_append_func)(const gchar *, gpointer, gint), gpointer data)
787 auto td = static_cast<TabCompData *>(g_object_get_data(G_OBJECT(entry), "tab_completion_data"));
791 td->tab_append_func = tab_append_func;
792 td->tab_append_data = data;
795 gchar *remove_trailing_slash(const gchar *path)
799 if (!path) return nullptr;
802 while (l > 1 && path[l - 1] == G_DIR_SEPARATOR) l--;
804 return g_strndup(path, l);
807 static void tab_completion_select_cancel_cb(FileDialog *fd, gpointer data)
809 auto td = static_cast<TabCompData *>(data);
812 file_dialog_close(fd);
815 static void tab_completion_select_ok_cb(FileDialog *fd, gpointer data)
817 auto td = static_cast<TabCompData *>(data);
819 gq_gtk_entry_set_text(GTK_ENTRY(td->entry), gq_gtk_entry_get_text(GTK_ENTRY(fd->entry)));
821 tab_completion_select_cancel_cb(fd, data);
823 tab_completion_emit_enter_signal(td);
826 static void tab_completion_select_show(TabCompData *td)
830 const gchar *filter = nullptr;
831 gchar *filter_desc = nullptr;
835 gtk_window_present(GTK_WINDOW(GENERIC_DIALOG(td->fd)->dialog));
839 title = (td->fd_title) ? td->fd_title : _("Select path");
840 td->fd = file_dialog_new(title, "select_path", td->entry,
841 tab_completion_select_cancel_cb, td);
842 file_dialog_add_button(td->fd, GQ_ICON_OK, "OK",
843 tab_completion_select_ok_cb, TRUE);
845 generic_dialog_add_message(GENERIC_DIALOG(td->fd), nullptr, title, nullptr, FALSE);
857 filter_desc = td->filter_desc;
861 filter_desc = _("All files");
864 path = gq_gtk_entry_get_text(GTK_ENTRY(td->entry));
865 if (strlen(path) == 0) path = nullptr;
866 if (td->fd_folders_only)
868 file_dialog_add_path_widgets(td->fd, nullptr, path, td->history_key, nullptr, nullptr);
872 file_dialog_add_path_widgets(td->fd, nullptr, path, td->history_key, filter, filter_desc);
875 gtk_widget_show(GENERIC_DIALOG(td->fd)->dialog);
878 static void tab_completion_select_pressed(GtkWidget *, gpointer data)
880 auto td = static_cast<TabCompData *>(data);
882 tab_completion_select_show(td);
885 void tab_completion_add_select_button(GtkWidget *entry, const gchar *title, gboolean folders_only)
891 td = static_cast<TabCompData *>(g_object_get_data(G_OBJECT(entry), "tab_completion_data"));
895 g_free(td->fd_title);
896 td->fd_title = g_strdup(title);
897 td->fd_folders_only = folders_only;
899 if (td->fd_button) return;
901 parent = (td->combo) ? td->combo : td->entry;
903 hbox = gtk_widget_get_parent(parent);
904 if (!GTK_IS_BOX(hbox)) return;
906 td->fd_button = gtk_button_new_with_label("...");
907 g_signal_connect(G_OBJECT(td->fd_button), "size_allocate",
908 G_CALLBACK(tab_completion_button_size_allocate), parent);
909 g_signal_connect(G_OBJECT(td->fd_button), "clicked",
910 G_CALLBACK(tab_completion_select_pressed), td);
912 gq_gtk_box_pack_start(GTK_BOX(hbox), td->fd_button, FALSE, FALSE, 0);
914 gtk_widget_show(td->fd_button);
916 /* vim: set shiftwidth=8 softtabstop=0 cindent cinoptions={1s: */