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
63 * ----------------------------------------------------------------
64 * Tab completion routines, can be connected to any gtkentry widget
65 * using the tab_completion_add_to_entry() function.
67 * Use remove_trailing_slash() to strip the trailing G_DIR_SEPARATOR.
69 * ----------------------------------------------------------------
72 typedef struct _TabCompData TabCompData;
78 void (*enter_func)(const gchar *, gpointer);
79 void (*tab_func)(const gchar *, gpointer);
80 void (*tab_append_func)(const gchar *, gpointer, gint);
84 gpointer tab_append_data;
93 gboolean fd_folders_only;
102 static void tab_completion_select_show(TabCompData *td);
103 static gint tab_completion_do(TabCompData *td);
105 static void tab_completion_free_list(TabCompData *td)
109 g_free(td->dir_path);
112 list = td->file_list;
120 g_list_free(td->file_list);
121 td->file_list = NULL;
124 static void tab_completion_read_dir(TabCompData *td, const gchar *path)
131 tab_completion_free_list(td);
133 pathl = path_from_utf8(path);
141 while ((dir = readdir(dp)) != NULL)
143 gchar *name = dir->d_name;
144 if (strcmp(name, ".") != 0 && strcmp(name, "..") != 0 &&
145 (name[0] != '.' || options->file_filter.show_hidden_files))
147 gchar *abspath = g_build_filename(pathl, name, NULL);
149 if (g_file_test(abspath, G_FILE_TEST_IS_DIR))
151 gchar *dname = g_strconcat(name, G_DIR_SEPARATOR_S, NULL);
152 list = g_list_prepend(list, path_to_utf8(dname));
157 list = g_list_prepend(list, path_to_utf8(name));
164 td->dir_path = g_strdup(path);
165 td->file_list = list;
169 static void tab_completion_destroy(GtkWidget *widget, gpointer data)
171 TabCompData *td = data;
173 tab_completion_free_list(td);
174 g_free(td->history_key);
176 if (td->fd) file_dialog_close(td->fd);
177 g_free(td->fd_title);
180 g_free(td->filter_desc);
185 static gchar *tab_completion_get_text(TabCompData *td)
189 text = g_strdup(gtk_entry_get_text(GTK_ENTRY(td->entry)));
194 text = expand_tilde(text);
201 static gboolean tab_completion_emit_enter_signal(TabCompData *td)
204 if (!td->enter_func) return FALSE;
206 text = tab_completion_get_text(td);
207 td->enter_func(text, td->enter_data);
213 static void tab_completion_emit_tab_signal(TabCompData *td)
216 if (!td->tab_func) return;
218 text = tab_completion_get_text(td);
219 td->tab_func(text, td->tab_data);
223 #ifdef TAB_COMPLETION_ENABLE_POPUP_MENU
224 void tab_completion_iter_menu_items(GtkWidget *widget, gpointer data)
226 TabCompData *td = data;
229 if (!gtk_widget_get_visible(widget)) return;
231 child = gtk_bin_get_child(GTK_BIN(widget));
232 if (GTK_IS_LABEL(child)) {
233 const gchar *text = gtk_label_get_text(GTK_LABEL(child));
234 const gchar *entry_text = gtk_entry_get_text(GTK_ENTRY(td->entry));
235 const gchar *prefix = filename_from_path(entry_text);
236 guint prefix_len = strlen(prefix);
238 if (strlen(text) < prefix_len || strncmp(text, prefix, prefix_len))
240 /* Hide menu items not matching */
241 gtk_widget_hide(widget);
245 /* Count how many choices are left in the menu */
251 static gboolean tab_completion_popup_key_press(GtkWidget *widget, GdkEventKey *event, gpointer data)
253 TabCompData *td = data;
255 if (event->keyval == GDK_KEY_Tab ||
256 event->keyval == GDK_KEY_BackSpace ||
257 (event->keyval >= 0x20 && event->keyval <= 0xFF) )
259 if (event->keyval >= 0x20 && event->keyval <= 0xFF)
264 buf[0] = event->keyval;
266 gtk_editable_insert_text(GTK_EDITABLE(td->entry), buf, 1, &p);
267 gtk_editable_set_position(GTK_EDITABLE(td->entry), -1);
269 /* Reduce the number of entries in the menu */
271 gtk_container_foreach(GTK_CONTAINER(widget), tab_completion_iter_menu_items, (gpointer) td);
272 if (td->choices > 1) return TRUE; /* multiple choices */
273 if (td->choices > 0) tab_completion_do(td); /* one choice */
277 gtk_menu_popdown(GTK_MENU(widget));
278 /* doing this does not emit the "selection done" signal, unref it ourselves */
279 g_object_unref(widget);
286 static void tab_completion_popup_cb(GtkWidget *widget, gpointer data)
292 td = g_object_get_data(G_OBJECT(widget), "tab_completion_data");
295 buf = g_build_filename(td->dir_path, name, NULL);
296 gtk_entry_set_text(GTK_ENTRY(td->entry), buf);
297 gtk_editable_set_position(GTK_EDITABLE(td->entry), strlen(buf));
300 tab_completion_emit_tab_signal(td);
303 static void tab_completion_popup_pos_cb(GtkMenu *menu, gint *x, gint *y, gboolean *push_in, gpointer data)
305 TabCompData *td = data;
308 PangoRectangle strong_pos, weak_pos;
310 gint xoffset, yoffset;
314 GdkRectangle monitor;
315 GtkRequisition requisition;
316 GtkAllocation allocation;
318 gdk_window_get_origin(gtk_widget_get_window(GTK_WIDGET(td->entry)), x, y);
320 screen = gtk_widget_get_screen(GTK_WIDGET(menu));
321 monitor_num = gdk_screen_get_monitor_at_window(screen, gtk_widget_get_window(GTK_WIDGET(td->entry)));
322 gdk_screen_get_monitor_geometry(screen, monitor_num, &monitor);
324 gtk_widget_size_request(GTK_WIDGET(menu), &req);
326 length = strlen(gtk_entry_get_text(GTK_ENTRY(td->entry)));
327 gtk_entry_get_layout_offsets(GTK_ENTRY(td->entry), &xoffset, &yoffset);
329 layout = gtk_entry_get_layout(GTK_ENTRY(td->entry));
330 pango_layout_get_cursor_pos(layout, length, &strong_pos, &weak_pos);
332 *x += strong_pos.x / PANGO_SCALE + xoffset;
334 gtk_widget_get_requisition(td->entry, &requisition);
335 gtk_widget_get_allocation(td->entry, &allocation);
337 height = MIN(requisition.height, allocation.height);
339 if (req.height > monitor.y + monitor.height - *y - height &&
340 *y - monitor.y > monitor.y + monitor.height - *y)
342 height = MIN(*y - monitor.y, req.height);
343 gtk_widget_set_size_request(GTK_WIDGET(menu), -1, height);
352 static void tab_completion_popup_list(TabCompData *td, GList *list)
365 * well, the menu would be too long anyway...
366 * (listing /dev causes gtk+ window allocation errors, -> too big a window)
367 * this is why menu popups are disabled, this really should be a popup scrollable listview.
369 if (g_list_length(list) > 200) return;
372 menu = popup_menu_short_lived();
375 while (work && count < TAB_COMP_POPUP_MAX)
377 gchar *name = work->data;
380 item = menu_item_add_simple(menu, name, G_CALLBACK(tab_completion_popup_cb), name);
381 g_object_set_data(G_OBJECT(item), "tab_completion_data", td);
387 g_signal_connect(G_OBJECT(menu), "key_press_event",
388 G_CALLBACK(tab_completion_popup_key_press), td);
390 /* peek at the current event to get the time, etc. */
391 event = gtk_get_current_event();
393 if (event && event->type == GDK_BUTTON_RELEASE)
395 ebutton = event->button.button;
404 etime = gdk_event_get_time(event);
405 gdk_event_free(event);
412 gtk_menu_popup(GTK_MENU(menu), NULL, NULL,
413 tab_completion_popup_pos_cb, td, ebutton, etime);
417 #define CASE_SORT strcmp
420 static gint simple_sort(gconstpointer a, gconstpointer b)
422 return CASE_SORT((gchar *)a, (gchar *)b);
427 static gboolean tab_completion_do(TabCompData *td)
429 const gchar *entry_text = gtk_entry_get_text(GTK_ENTRY(td->entry));
430 const gchar *entry_file;
433 gboolean home_exp = FALSE;
435 if (entry_text[0] == '\0')
437 entry_dir = g_strdup(G_DIR_SEPARATOR_S); /** @FIXME root directory win32 */
438 gtk_entry_set_text(GTK_ENTRY(td->entry), entry_dir);
439 gtk_editable_set_position(GTK_EDITABLE(td->entry), strlen(entry_dir));
444 /* home dir expansion */
445 if (entry_text[0] == '~')
447 entry_dir = expand_tilde(entry_text);
452 entry_dir = g_strdup(entry_text);
455 if (isfile(entry_dir))
459 gtk_entry_set_text(GTK_ENTRY(td->entry), entry_dir);
460 gtk_editable_set_position(GTK_EDITABLE(td->entry), strlen(entry_dir));
466 entry_file = filename_from_path(entry_text);
468 if (isdir(entry_dir) && strcmp(entry_file, ".") != 0 && strcmp(entry_file, "..") != 0)
470 ptr = entry_dir + strlen(entry_dir) - 1;
471 if (ptr[0] == G_DIR_SEPARATOR)
475 gtk_entry_set_text(GTK_ENTRY(td->entry), entry_dir);
476 gtk_editable_set_position(GTK_EDITABLE(td->entry), strlen(entry_dir));
479 tab_completion_read_dir(td, entry_dir);
480 td->file_list = g_list_sort(td->file_list, simple_sort);
481 if (td->file_list && !td->file_list->next)
486 file = td->file_list->data;
487 buf = g_build_filename(entry_dir, file, NULL);
490 gchar *tmp = g_strconcat(buf, G_DIR_SEPARATOR_S, NULL);
494 gtk_entry_set_text(GTK_ENTRY(td->entry), buf);
495 gtk_editable_set_position(GTK_EDITABLE(td->entry), strlen(buf));
499 #ifdef TAB_COMPLETION_ENABLE_POPUP_MENU
503 tab_completion_popup_list(td, td->file_list);
512 gchar *buf = g_strconcat(entry_dir, G_DIR_SEPARATOR_S, NULL);
513 gtk_entry_set_text(GTK_ENTRY(td->entry), buf);
514 gtk_editable_set_position(GTK_EDITABLE(td->entry), strlen(buf));
521 ptr = (gchar *)filename_from_path(entry_dir);
522 if (ptr > entry_dir) ptr--;
525 if (strlen(entry_dir) == 0)
528 entry_dir = g_strdup(G_DIR_SEPARATOR_S); /** @FIXME win32 */
531 if (isdir(entry_dir))
535 gint l = strlen(entry_file);
537 if (!td->dir_path || !td->file_list || strcmp(td->dir_path, entry_dir) != 0)
539 tab_completion_read_dir(td, entry_dir);
542 list = td->file_list;
545 gchar *file = list->data;
546 if (strncmp(entry_file, file, l) == 0)
548 poss = g_list_prepend(poss, file);
557 gchar *file = poss->data;
560 buf = g_build_filename(entry_dir, file, NULL);
561 gtk_entry_set_text(GTK_ENTRY(td->entry), buf);
562 gtk_editable_set_position(GTK_EDITABLE(td->entry), strlen(buf));
570 gsize c = strlen(entry_file);
571 gboolean done = FALSE;
572 gchar *test_file = poss->data;
577 if (!list) done = TRUE;
578 while (list && !done)
580 gchar *file = list->data;
581 if (strlen(file) < c || strncmp(test_file, file, c) != 0)
594 file = g_strdup(test_file);
596 buf = g_build_filename(entry_dir, file, NULL);
597 gtk_entry_set_text(GTK_ENTRY(td->entry), buf);
598 gtk_editable_set_position(GTK_EDITABLE(td->entry), strlen(buf));
600 #ifdef TAB_COMPLETION_ENABLE_POPUP_MENU
602 poss = g_list_sort(poss, simple_sort);
603 tab_completion_popup_list(td, poss);
623 static gboolean tab_completion_key_pressed(GtkWidget *widget, GdkEventKey *event, gpointer data)
625 TabCompData *td = data;
626 gboolean stop_signal = FALSE;
628 switch (event->keyval)
631 if (!(event->state & GDK_CONTROL_MASK))
633 if (tab_completion_do(td))
635 tab_completion_emit_tab_signal(td);
640 case GDK_KEY_Return: case GDK_KEY_KP_Enter:
642 (event->state & GDK_CONTROL_MASK))
644 tab_completion_select_show(td);
647 else if (tab_completion_emit_enter_signal(td))
656 if (stop_signal) g_signal_stop_emission_by_name(G_OBJECT(widget), "key_press_event");
658 return (stop_signal);
661 static void tab_completion_button_pressed(GtkWidget *widget, gpointer data)
664 GtkWidget *entry = data;
666 td = g_object_get_data(G_OBJECT(entry), "tab_completion_data");
670 if (!gtk_widget_has_focus(entry))
672 gtk_widget_grab_focus(entry);
675 if (tab_completion_do(td))
677 tab_completion_emit_tab_signal(td);
681 static void tab_completion_button_size_allocate(GtkWidget *button, GtkAllocation *allocation, gpointer data)
683 GtkWidget *parent = data;
684 GtkAllocation parent_allocation;
685 gtk_widget_get_allocation(parent, &parent_allocation);
687 if (allocation->height > parent_allocation.height)
689 GtkAllocation button_allocation;
691 gtk_widget_get_allocation(button, &button_allocation);
692 button_allocation.height = parent_allocation.height;
693 button_allocation.y = parent_allocation.y +
694 (parent_allocation.height - parent_allocation.height) / 2;
695 gtk_widget_size_allocate(button, &button_allocation);
699 static GtkWidget *tab_completion_create_complete_button(GtkWidget *entry, GtkWidget *parent)
705 button = gtk_button_new();
706 gtk_widget_set_can_focus(button, FALSE);
707 g_signal_connect(G_OBJECT(button), "size_allocate",
708 G_CALLBACK(tab_completion_button_size_allocate), parent);
709 g_signal_connect(G_OBJECT(button), "clicked",
710 G_CALLBACK(tab_completion_button_pressed), entry);
712 pixbuf = gdk_pixbuf_new_from_inline(-1, icon_tabcomp, FALSE, NULL);
713 icon = gtk_image_new_from_pixbuf(pixbuf);
714 g_object_unref(pixbuf);
716 gtk_container_add(GTK_CONTAINER(button), icon);
717 gtk_widget_show(icon);
723 *----------------------------------------------------------------------------
725 *----------------------------------------------------------------------------
728 GtkWidget *tab_completion_new_with_history(GtkWidget **entry, const gchar *text,
729 const gchar *history_key, gint max_levels,
730 void (*enter_func)(const gchar *, gpointer), gpointer data)
734 GtkWidget *combo_entry;
740 box = gtk_hbox_new(FALSE, 0);
742 combo = gtk_combo_box_text_new_with_entry();
743 gtk_box_pack_start(GTK_BOX(box), combo, TRUE, TRUE, 0);
744 gtk_widget_show(combo);
746 combo_entry = gtk_bin_get_child(GTK_BIN(combo));
748 button = tab_completion_create_complete_button(combo_entry, combo);
749 gtk_box_pack_start(GTK_BOX(box), button, FALSE, FALSE, 0);
750 gtk_widget_show(button);
752 tab_completion_add_to_entry(combo_entry, enter_func, NULL, NULL, data);
754 td = g_object_get_data(G_OBJECT(combo_entry), "tab_completion_data");
755 if (!td) return NULL; /* this should never happen! */
758 td->has_history = TRUE;
759 td->history_key = g_strdup(history_key);
760 td->history_levels = max_levels;
762 work = history_list_get_by_key(td->history_key);
764 work = history_list_get_by_key(history_key);
767 gtk_combo_box_text_append_text(GTK_COMBO_BOX_TEXT(combo), (gchar *)work->data);
774 gtk_entry_set_text(GTK_ENTRY(combo_entry), text);
778 gtk_combo_box_set_active(GTK_COMBO_BOX(combo), 0);
781 if (entry) *entry = combo_entry;
785 const gchar *tab_completion_set_to_last_history(GtkWidget *entry)
787 TabCompData *td = g_object_get_data(G_OBJECT(entry), "tab_completion_data");
790 if (!td || !td->has_history) return NULL;
792 buf = history_list_find_last_path_by_key(td->history_key);
795 gtk_entry_set_text(GTK_ENTRY(td->entry), buf);
801 void tab_completion_append_to_history(GtkWidget *entry, const gchar *path)
808 td = g_object_get_data(G_OBJECT(entry), "tab_completion_data");
812 if (!td || !td->has_history) return;
814 history_list_add_to_key(td->history_key, path, td->history_levels);
816 gtk_combo_box_set_active(GTK_COMBO_BOX(td->combo), -1);
818 store = gtk_combo_box_get_model(GTK_COMBO_BOX(td->combo));
819 gtk_list_store_clear(GTK_LIST_STORE(store));
821 work = history_list_get_by_key(td->history_key);
824 gtk_combo_box_text_append_text(GTK_COMBO_BOX_TEXT(td->combo), (gchar *)work->data);
829 if (td->tab_append_func) {
830 td->tab_append_func(path, td->tab_append_data, n);
834 GtkWidget *tab_completion_new(GtkWidget **entry, const gchar *text,
835 void (*enter_func)(const gchar *, gpointer), const gchar *filter, const gchar *filter_desc, gpointer data)
841 hbox = gtk_hbox_new(FALSE, 0);
843 newentry = gtk_entry_new();
844 if (text) gtk_entry_set_text(GTK_ENTRY(newentry), text);
845 gtk_box_pack_start(GTK_BOX(hbox), newentry, TRUE, TRUE, 0);
846 gtk_widget_show(newentry);
848 button = tab_completion_create_complete_button(newentry, newentry);
849 gtk_box_pack_start(GTK_BOX(hbox), button, FALSE, FALSE, 0);
850 gtk_widget_show(button);
852 tab_completion_add_to_entry(newentry, enter_func, filter, filter_desc, data);
853 if (entry) *entry = newentry;
857 void tab_completion_add_to_entry(GtkWidget *entry, void (*enter_func)(const gchar *, gpointer), const gchar *filter, const gchar *filter_desc, gpointer data)
862 log_printf("Tab completion error: entry != NULL\n");
866 td = g_new0(TabCompData, 1);
869 td->enter_func = enter_func;
870 td->enter_data = data;
871 td->filter = g_strdup(filter);
872 td->filter_desc = g_strdup(filter_desc);
874 g_object_set_data(G_OBJECT(td->entry), "tab_completion_data", td);
876 g_signal_connect(G_OBJECT(entry), "key_press_event",
877 G_CALLBACK(tab_completion_key_pressed), td);
878 g_signal_connect(G_OBJECT(entry), "destroy",
879 G_CALLBACK(tab_completion_destroy), td);
882 void tab_completion_add_tab_func(GtkWidget *entry, void (*tab_func)(const gchar *, gpointer), gpointer data)
884 TabCompData *td = g_object_get_data(G_OBJECT(entry), "tab_completion_data");
888 td->tab_func = tab_func;
892 /* Add a callback function called when a new entry is appended to the list */
893 void tab_completion_add_append_func(GtkWidget *entry, void (*tab_append_func)(const gchar *, gpointer, gint), gpointer data)
895 TabCompData *td = g_object_get_data(G_OBJECT(entry), "tab_completion_data");
899 td->tab_append_func = tab_append_func;
900 td->tab_append_data = data;
903 gchar *remove_trailing_slash(const gchar *path)
907 if (!path) return NULL;
910 while (l > 1 && path[l - 1] == G_DIR_SEPARATOR) l--;
912 return g_strndup(path, l);
915 static void tab_completion_select_cancel_cb(FileDialog *fd, gpointer data)
917 TabCompData *td = data;
920 file_dialog_close(fd);
923 static void tab_completion_select_ok_cb(FileDialog *fd, gpointer data)
925 TabCompData *td = data;
927 gtk_entry_set_text(GTK_ENTRY(td->entry), gtk_entry_get_text(GTK_ENTRY(fd->entry)));
929 tab_completion_select_cancel_cb(fd, data);
931 tab_completion_emit_enter_signal(td);
934 static void tab_completion_select_show(TabCompData *td)
938 gchar *filter = NULL;
939 gchar *filter_desc = NULL;
943 gtk_window_present(GTK_WINDOW(GENERIC_DIALOG(td->fd)->dialog));
947 title = (td->fd_title) ? td->fd_title : _("Select path");
948 td->fd = file_dialog_new(title, "select_path", td->entry,
949 tab_completion_select_cancel_cb, td);
950 file_dialog_add_button(td->fd, GTK_STOCK_OK, NULL,
951 tab_completion_select_ok_cb, TRUE);
953 generic_dialog_add_message(GENERIC_DIALOG(td->fd), NULL, title, NULL, FALSE);
965 filter_desc = td->filter_desc;
969 filter_desc = _("All files");
972 path = gtk_entry_get_text(GTK_ENTRY(td->entry));
973 if (strlen(path) == 0) path = NULL;
974 if (td->fd_folders_only)
976 file_dialog_add_path_widgets(td->fd, NULL, path, td->history_key, NULL, NULL);
980 file_dialog_add_path_widgets(td->fd, NULL, path, td->history_key, filter, filter_desc);
983 gtk_widget_show(GENERIC_DIALOG(td->fd)->dialog);
986 static void tab_completion_select_pressed(GtkWidget *widget, gpointer data)
988 TabCompData *td = data;
990 tab_completion_select_show(td);
993 void tab_completion_add_select_button(GtkWidget *entry, const gchar *title, gboolean folders_only)
999 td = g_object_get_data(G_OBJECT(entry), "tab_completion_data");
1003 g_free(td->fd_title);
1004 td->fd_title = g_strdup(title);
1005 td->fd_folders_only = folders_only;
1007 if (td->fd_button) return;
1009 parent = (td->combo) ? td->combo : td->entry;
1011 hbox = gtk_widget_get_parent(parent);
1012 if (!GTK_IS_BOX(hbox)) return;
1014 td->fd_button = gtk_button_new_with_label("...");
1015 g_signal_connect(G_OBJECT(td->fd_button), "size_allocate",
1016 G_CALLBACK(tab_completion_button_size_allocate), parent);
1017 g_signal_connect(G_OBJECT(td->fd_button), "clicked",
1018 G_CALLBACK(tab_completion_select_pressed), td);
1020 gtk_box_pack_start(GTK_BOX(hbox), td->fd_button, FALSE, FALSE, 0);
1022 gtk_widget_show(td->fd_button);
1024 /* vim: set shiftwidth=8 softtabstop=0 cindent cinoptions={1s: */