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;
95 static void tab_completion_select_show(TabCompData *td);
96 static gint tab_completion_do(TabCompData *td);
98 static void tab_completion_free_list(TabCompData *td)
102 g_free(td->dir_path);
105 list = td->file_list;
113 g_list_free(td->file_list);
114 td->file_list = NULL;
117 static void tab_completion_read_dir(TabCompData *td, const gchar *path)
124 tab_completion_free_list(td);
126 pathl = path_from_utf8(path);
134 while ((dir = readdir(dp)) != NULL)
136 gchar *name = dir->d_name;
137 if (strcmp(name, ".") != 0 && strcmp(name, "..") != 0)
139 gchar *abspath = g_build_filename(pathl, name, NULL);
141 if (g_file_test(abspath, G_FILE_TEST_IS_DIR))
143 gchar *dname = g_strconcat(name, G_DIR_SEPARATOR_S, NULL);
144 list = g_list_prepend(list, path_to_utf8(dname));
149 list = g_list_prepend(list, path_to_utf8(name));
156 td->dir_path = g_strdup(path);
157 td->file_list = list;
161 static void tab_completion_destroy(GtkWidget *widget, gpointer data)
163 TabCompData *td = data;
165 tab_completion_free_list(td);
166 g_free(td->history_key);
168 if (td->fd) file_dialog_close(td->fd);
169 g_free(td->fd_title);
174 static gchar *tab_completion_get_text(TabCompData *td)
178 text = g_strdup(gtk_entry_get_text(GTK_ENTRY(td->entry)));
183 text = expand_tilde(text);
190 static gboolean tab_completion_emit_enter_signal(TabCompData *td)
193 if (!td->enter_func) return FALSE;
195 text = tab_completion_get_text(td);
196 td->enter_func(text, td->enter_data);
202 static void tab_completion_emit_tab_signal(TabCompData *td)
205 if (!td->tab_func) return;
207 text = tab_completion_get_text(td);
208 td->tab_func(text, td->tab_data);
212 #ifdef TAB_COMPLETION_ENABLE_POPUP_MENU
213 void tab_completion_iter_menu_items(GtkWidget *widget, gpointer data)
215 TabCompData *td = data;
218 if (!gtk_widget_get_visible(widget)) return;
220 child = gtk_bin_get_child(GTK_BIN(widget));
221 if (GTK_IS_LABEL(child)) {
222 const gchar *text = gtk_label_get_text(GTK_LABEL(child));
223 const gchar *entry_text = gtk_entry_get_text(GTK_ENTRY(td->entry));
224 const gchar *prefix = filename_from_path(entry_text);
225 guint prefix_len = strlen(prefix);
227 if (strlen(text) < prefix_len || strncmp(text, prefix, prefix_len))
229 /* Hide menu items not matching */
230 gtk_widget_hide(widget);
234 /* Count how many choices are left in the menu */
240 static gboolean tab_completion_popup_key_press(GtkWidget *widget, GdkEventKey *event, gpointer data)
242 TabCompData *td = data;
244 if (event->keyval == GDK_KEY_Tab ||
245 event->keyval == GDK_KEY_BackSpace ||
246 (event->keyval >= 0x20 && event->keyval <= 0xFF) )
248 if (event->keyval >= 0x20 && event->keyval <= 0xFF)
253 buf[0] = event->keyval;
255 gtk_editable_insert_text(GTK_EDITABLE(td->entry), buf, 1, &p);
256 gtk_editable_set_position(GTK_EDITABLE(td->entry), -1);
258 /* Reduce the number of entries in the menu */
260 gtk_container_foreach(GTK_CONTAINER(widget), tab_completion_iter_menu_items, (gpointer) td);
261 if (td->choices > 1) return TRUE; /* multiple choices */
262 if (td->choices > 0) tab_completion_do(td); /* one choice */
266 gtk_menu_popdown(GTK_MENU(widget));
267 /* doing this does not emit the "selection done" signal, unref it ourselves */
268 g_object_unref(widget);
275 static void tab_completion_popup_cb(GtkWidget *widget, gpointer data)
281 td = g_object_get_data(G_OBJECT(widget), "tab_completion_data");
284 buf = g_build_filename(td->dir_path, name, NULL);
285 gtk_entry_set_text(GTK_ENTRY(td->entry), buf);
286 gtk_editable_set_position(GTK_EDITABLE(td->entry), strlen(buf));
289 tab_completion_emit_tab_signal(td);
292 static void tab_completion_popup_pos_cb(GtkMenu *menu, gint *x, gint *y, gboolean *push_in, gpointer data)
294 TabCompData *td = data;
297 PangoRectangle strong_pos, weak_pos;
299 gint xoffset, yoffset;
303 GdkRectangle monitor;
304 GtkRequisition requisition;
305 GtkAllocation allocation;
307 gdk_window_get_origin(gtk_widget_get_window(GTK_WIDGET(td->entry)), x, y);
309 screen = gtk_widget_get_screen(GTK_WIDGET(menu));
310 monitor_num = gdk_screen_get_monitor_at_window(screen, gtk_widget_get_window(GTK_WIDGET(td->entry)));
311 gdk_screen_get_monitor_geometry(screen, monitor_num, &monitor);
313 gtk_widget_size_request(GTK_WIDGET(menu), &req);
315 length = strlen(gtk_entry_get_text(GTK_ENTRY(td->entry)));
316 gtk_entry_get_layout_offsets(GTK_ENTRY(td->entry), &xoffset, &yoffset);
318 layout = gtk_entry_get_layout(GTK_ENTRY(td->entry));
319 pango_layout_get_cursor_pos(layout, length, &strong_pos, &weak_pos);
321 *x += strong_pos.x / PANGO_SCALE + xoffset;
323 gtk_widget_get_requisition(td->entry, &requisition);
324 gtk_widget_get_allocation(td->entry, &allocation);
326 height = MIN(requisition.height, allocation.height);
328 if (req.height > monitor.y + monitor.height - *y - height &&
329 *y - monitor.y > monitor.y + monitor.height - *y)
331 height = MIN(*y - monitor.y, req.height);
332 gtk_widget_set_size_request(GTK_WIDGET(menu), -1, height);
341 static void tab_completion_popup_list(TabCompData *td, GList *list)
354 * well, the menu would be too long anyway...
355 * (listing /dev causes gtk+ window allocation errors, -> too big a window)
356 * this is why menu popups are disabled, this really should be a popup scrollable listview.
358 if (g_list_length(list) > 200) return;
361 menu = popup_menu_short_lived();
364 while (work && count < TAB_COMP_POPUP_MAX)
366 gchar *name = work->data;
369 item = menu_item_add_simple(menu, name, G_CALLBACK(tab_completion_popup_cb), name);
370 g_object_set_data(G_OBJECT(item), "tab_completion_data", td);
376 g_signal_connect(G_OBJECT(menu), "key_press_event",
377 G_CALLBACK(tab_completion_popup_key_press), td);
379 /* peek at the current event to get the time, etc. */
380 event = gtk_get_current_event();
382 if (event && event->type == GDK_BUTTON_RELEASE)
384 ebutton = event->button.button;
393 etime = gdk_event_get_time(event);
394 gdk_event_free(event);
401 gtk_menu_popup(GTK_MENU(menu), NULL, NULL,
402 tab_completion_popup_pos_cb, td, ebutton, etime);
406 #define CASE_SORT strcmp
409 static gint simple_sort(gconstpointer a, gconstpointer b)
411 return CASE_SORT((gchar *)a, (gchar *)b);
416 static gboolean tab_completion_do(TabCompData *td)
418 const gchar *entry_text = gtk_entry_get_text(GTK_ENTRY(td->entry));
419 const gchar *entry_file;
422 gboolean home_exp = FALSE;
424 if (entry_text[0] == '\0')
426 entry_dir = g_strdup(G_DIR_SEPARATOR_S); /* FIXME: root directory win32 */
427 gtk_entry_set_text(GTK_ENTRY(td->entry), entry_dir);
428 gtk_editable_set_position(GTK_EDITABLE(td->entry), strlen(entry_dir));
433 /* home dir expansion */
434 if (entry_text[0] == '~')
436 entry_dir = expand_tilde(entry_text);
441 entry_dir = g_strdup(entry_text);
444 if (isfile(entry_dir))
448 gtk_entry_set_text(GTK_ENTRY(td->entry), entry_dir);
449 gtk_editable_set_position(GTK_EDITABLE(td->entry), strlen(entry_dir));
455 entry_file = filename_from_path(entry_text);
457 if (isdir(entry_dir) && strcmp(entry_file, ".") != 0 && strcmp(entry_file, "..") != 0)
459 ptr = entry_dir + strlen(entry_dir) - 1;
460 if (ptr[0] == G_DIR_SEPARATOR)
464 gtk_entry_set_text(GTK_ENTRY(td->entry), entry_dir);
465 gtk_editable_set_position(GTK_EDITABLE(td->entry), strlen(entry_dir));
468 tab_completion_read_dir(td, entry_dir);
469 td->file_list = g_list_sort(td->file_list, simple_sort);
470 if (td->file_list && !td->file_list->next)
475 file = td->file_list->data;
476 buf = g_build_filename(entry_dir, file, NULL);
479 gchar *tmp = g_strconcat(buf, G_DIR_SEPARATOR_S, NULL);
483 gtk_entry_set_text(GTK_ENTRY(td->entry), buf);
484 gtk_editable_set_position(GTK_EDITABLE(td->entry), strlen(buf));
488 #ifdef TAB_COMPLETION_ENABLE_POPUP_MENU
492 tab_completion_popup_list(td, td->file_list);
501 gchar *buf = g_strconcat(entry_dir, G_DIR_SEPARATOR_S, NULL);
502 gtk_entry_set_text(GTK_ENTRY(td->entry), buf);
503 gtk_editable_set_position(GTK_EDITABLE(td->entry), strlen(buf));
510 ptr = (gchar *)filename_from_path(entry_dir);
511 if (ptr > entry_dir) ptr--;
514 if (strlen(entry_dir) == 0)
517 entry_dir = g_strdup(G_DIR_SEPARATOR_S); /* FIXME: win32 */
520 if (isdir(entry_dir))
524 gint l = strlen(entry_file);
526 if (!td->dir_path || !td->file_list || strcmp(td->dir_path, entry_dir) != 0)
528 tab_completion_read_dir(td, entry_dir);
531 list = td->file_list;
534 gchar *file = list->data;
535 if (strncmp(entry_file, file, l) == 0)
537 poss = g_list_prepend(poss, file);
546 gchar *file = poss->data;
549 buf = g_build_filename(entry_dir, file, NULL);
550 gtk_entry_set_text(GTK_ENTRY(td->entry), buf);
551 gtk_editable_set_position(GTK_EDITABLE(td->entry), strlen(buf));
559 gsize c = strlen(entry_file);
560 gboolean done = FALSE;
561 gchar *test_file = poss->data;
566 if (!list) done = TRUE;
567 while (list && !done)
569 gchar *file = list->data;
570 if (strlen(file) < c || strncmp(test_file, file, c) != 0)
583 file = g_strdup(test_file);
585 buf = g_build_filename(entry_dir, file, NULL);
586 gtk_entry_set_text(GTK_ENTRY(td->entry), buf);
587 gtk_editable_set_position(GTK_EDITABLE(td->entry), strlen(buf));
589 #ifdef TAB_COMPLETION_ENABLE_POPUP_MENU
591 poss = g_list_sort(poss, simple_sort);
592 tab_completion_popup_list(td, poss);
612 static gboolean tab_completion_key_pressed(GtkWidget *widget, GdkEventKey *event, gpointer data)
614 TabCompData *td = data;
615 gboolean stop_signal = FALSE;
617 switch (event->keyval)
620 if (!(event->state & GDK_CONTROL_MASK))
622 if (tab_completion_do(td))
624 tab_completion_emit_tab_signal(td);
629 case GDK_KEY_Return: case GDK_KEY_KP_Enter:
631 (event->state & GDK_CONTROL_MASK))
633 tab_completion_select_show(td);
636 else if (tab_completion_emit_enter_signal(td))
645 if (stop_signal) g_signal_stop_emission_by_name(G_OBJECT(widget), "key_press_event");
647 return (stop_signal);
650 static void tab_completion_button_pressed(GtkWidget *widget, gpointer data)
653 GtkWidget *entry = data;
655 td = g_object_get_data(G_OBJECT(entry), "tab_completion_data");
659 if (!gtk_widget_has_focus(entry))
661 gtk_widget_grab_focus(entry);
664 if (tab_completion_do(td))
666 tab_completion_emit_tab_signal(td);
670 static void tab_completion_button_size_allocate(GtkWidget *button, GtkAllocation *allocation, gpointer data)
672 GtkWidget *parent = data;
673 GtkAllocation parent_allocation;
674 gtk_widget_get_allocation(parent, &parent_allocation);
676 if (allocation->height > parent_allocation.height)
678 GtkAllocation button_allocation;
680 gtk_widget_get_allocation(button, &button_allocation);
681 button_allocation.height = parent_allocation.height;
682 button_allocation.y = parent_allocation.y +
683 (parent_allocation.height - parent_allocation.height) / 2;
684 gtk_widget_size_allocate(button, &button_allocation);
688 static GtkWidget *tab_completion_create_complete_button(GtkWidget *entry, GtkWidget *parent)
694 button = gtk_button_new();
695 gtk_widget_set_can_focus(button, FALSE);
696 g_signal_connect(G_OBJECT(button), "size_allocate",
697 G_CALLBACK(tab_completion_button_size_allocate), parent);
698 g_signal_connect(G_OBJECT(button), "clicked",
699 G_CALLBACK(tab_completion_button_pressed), entry);
701 pixbuf = gdk_pixbuf_new_from_inline(-1, icon_tabcomp, FALSE, NULL);
702 icon = gtk_image_new_from_pixbuf(pixbuf);
703 g_object_unref(pixbuf);
705 gtk_container_add(GTK_CONTAINER(button), icon);
706 gtk_widget_show(icon);
712 *----------------------------------------------------------------------------
714 *----------------------------------------------------------------------------
717 GtkWidget *tab_completion_new_with_history(GtkWidget **entry, const gchar *text,
718 const gchar *history_key, gint max_levels,
719 void (*enter_func)(const gchar *, gpointer), gpointer data)
723 GtkWidget *combo_entry;
729 box = gtk_hbox_new(FALSE, 0);
731 combo = gtk_combo_box_text_new_with_entry();
732 gtk_box_pack_start(GTK_BOX(box), combo, TRUE, TRUE, 0);
733 gtk_widget_show(combo);
735 combo_entry = gtk_bin_get_child(GTK_BIN(combo));
737 button = tab_completion_create_complete_button(combo_entry, combo);
738 gtk_box_pack_start(GTK_BOX(box), button, FALSE, FALSE, 0);
739 gtk_widget_show(button);
741 tab_completion_add_to_entry(combo_entry, enter_func, data);
743 td = g_object_get_data(G_OBJECT(combo_entry), "tab_completion_data");
744 if (!td) return NULL; /* this should never happen! */
747 td->has_history = TRUE;
748 td->history_key = g_strdup(history_key);
749 td->history_levels = max_levels;
751 work = history_list_get_by_key(td->history_key);
753 work = history_list_get_by_key(history_key);
756 gtk_combo_box_text_append_text(GTK_COMBO_BOX_TEXT(combo), (gchar *)work->data);
763 gtk_entry_set_text(GTK_ENTRY(combo_entry), text);
767 gtk_combo_box_set_active(GTK_COMBO_BOX(combo), 0);
770 if (entry) *entry = combo_entry;
774 const gchar *tab_completion_set_to_last_history(GtkWidget *entry)
776 TabCompData *td = g_object_get_data(G_OBJECT(entry), "tab_completion_data");
779 if (!td || !td->has_history) return NULL;
781 buf = history_list_find_last_path_by_key(td->history_key);
784 gtk_entry_set_text(GTK_ENTRY(td->entry), buf);
790 void tab_completion_append_to_history(GtkWidget *entry, const gchar *path)
797 td = g_object_get_data(G_OBJECT(entry), "tab_completion_data");
801 if (!td || !td->has_history) return;
803 history_list_add_to_key(td->history_key, path, td->history_levels);
805 gtk_combo_box_set_active(GTK_COMBO_BOX(td->combo), -1);
807 store = gtk_combo_box_get_model(GTK_COMBO_BOX(td->combo));
808 gtk_list_store_clear(GTK_LIST_STORE(store));
810 work = history_list_get_by_key(td->history_key);
813 gtk_combo_box_text_append_text(GTK_COMBO_BOX_TEXT(td->combo), (gchar *)work->data);
818 if (td->tab_append_func) {
819 td->tab_append_func(path, td->tab_append_data, n);
823 GtkWidget *tab_completion_new(GtkWidget **entry, const gchar *text,
824 void (*enter_func)(const gchar *, gpointer), gpointer data)
830 hbox = gtk_hbox_new(FALSE, 0);
832 newentry = gtk_entry_new();
833 if (text) gtk_entry_set_text(GTK_ENTRY(newentry), text);
834 gtk_box_pack_start(GTK_BOX(hbox), newentry, TRUE, TRUE, 0);
835 gtk_widget_show(newentry);
837 button = tab_completion_create_complete_button(newentry, newentry);
838 gtk_box_pack_start(GTK_BOX(hbox), button, FALSE, FALSE, 0);
839 gtk_widget_show(button);
841 tab_completion_add_to_entry(newentry, enter_func, data);
843 if (entry) *entry = newentry;
847 void tab_completion_add_to_entry(GtkWidget *entry, void (*enter_func)(const gchar *, gpointer), gpointer data)
852 log_printf("Tab completion error: entry != NULL\n");
856 td = g_new0(TabCompData, 1);
859 td->enter_func = enter_func;
860 td->enter_data = data;
862 g_object_set_data(G_OBJECT(td->entry), "tab_completion_data", td);
864 g_signal_connect(G_OBJECT(entry), "key_press_event",
865 G_CALLBACK(tab_completion_key_pressed), td);
866 g_signal_connect(G_OBJECT(entry), "destroy",
867 G_CALLBACK(tab_completion_destroy), td);
870 void tab_completion_add_tab_func(GtkWidget *entry, void (*tab_func)(const gchar *, gpointer), gpointer data)
872 TabCompData *td = g_object_get_data(G_OBJECT(entry), "tab_completion_data");
876 td->tab_func = tab_func;
880 /* Add a callback function called when a new entry is appended to the list */
881 void tab_completion_add_append_func(GtkWidget *entry, void (*tab_append_func)(const gchar *, gpointer, gint), gpointer data)
883 TabCompData *td = g_object_get_data(G_OBJECT(entry), "tab_completion_data");
887 td->tab_append_func = tab_append_func;
888 td->tab_append_data = data;
891 gchar *remove_trailing_slash(const gchar *path)
895 if (!path) return NULL;
898 while (l > 1 && path[l - 1] == G_DIR_SEPARATOR) l--;
900 return g_strndup(path, l);
903 static void tab_completion_select_cancel_cb(FileDialog *fd, gpointer data)
905 TabCompData *td = data;
908 file_dialog_close(fd);
911 static void tab_completion_select_ok_cb(FileDialog *fd, gpointer data)
913 TabCompData *td = data;
915 gtk_entry_set_text(GTK_ENTRY(td->entry), gtk_entry_get_text(GTK_ENTRY(fd->entry)));
917 tab_completion_select_cancel_cb(fd, data);
919 tab_completion_emit_enter_signal(td);
922 static void tab_completion_select_show(TabCompData *td)
929 gtk_window_present(GTK_WINDOW(GENERIC_DIALOG(td->fd)->dialog));
933 title = (td->fd_title) ? td->fd_title : _("Select path");
934 td->fd = file_dialog_new(title, "select_path", td->entry,
935 tab_completion_select_cancel_cb, td);
936 file_dialog_add_button(td->fd, GTK_STOCK_OK, NULL,
937 tab_completion_select_ok_cb, TRUE);
939 generic_dialog_add_message(GENERIC_DIALOG(td->fd), NULL, title, NULL);
941 path = gtk_entry_get_text(GTK_ENTRY(td->entry));
942 if (strlen(path) == 0) path = NULL;
943 if (td->fd_folders_only)
945 file_dialog_add_path_widgets(td->fd, NULL, path, td->history_key, NULL, NULL);
949 file_dialog_add_path_widgets(td->fd, NULL, path, td->history_key, "*", _("All files"));
952 gtk_widget_show(GENERIC_DIALOG(td->fd)->dialog);
955 static void tab_completion_select_pressed(GtkWidget *widget, gpointer data)
957 TabCompData *td = data;
959 tab_completion_select_show(td);
962 void tab_completion_add_select_button(GtkWidget *entry, const gchar *title, gboolean folders_only)
968 td = g_object_get_data(G_OBJECT(entry), "tab_completion_data");
972 g_free(td->fd_title);
973 td->fd_title = g_strdup(title);
974 td->fd_folders_only = folders_only;
976 if (td->fd_button) return;
978 parent = (td->combo) ? td->combo : td->entry;
980 hbox = gtk_widget_get_parent(parent);
981 if (!GTK_IS_BOX(hbox)) return;
983 td->fd_button = gtk_button_new_with_label("...");
984 g_signal_connect(G_OBJECT(td->fd_button), "size_allocate",
985 G_CALLBACK(tab_completion_button_size_allocate), parent);
986 g_signal_connect(G_OBJECT(td->fd_button), "clicked",
987 G_CALLBACK(tab_completion_select_pressed), td);
989 gtk_box_pack_start(GTK_BOX(hbox), td->fd_button, FALSE, FALSE, 0);
991 gtk_widget_show(td->fd_button);
993 /* vim: set shiftwidth=8 softtabstop=0 cindent cinoptions={1s: */