2 * (SLIK) SimpLIstic sKin functions
4 * Copyright (C) 2008 - 2012 The Geeqie Team
8 * This software is released under the GNU General Public License (GNU GPL).
9 * Please read the included file COPYING for more information.
10 * This software comes with no warranty of any kind, use at your own risk!
22 #include <sys/types.h>
27 #include <gdk-pixbuf/gdk-pixbuf.h>
30 #include "ui_tabcomp.h"
32 #include "history_list.h"
33 #include "misc.h" /* expand_tilde() */
34 #include "ui_fileops.h"
35 #include "ui_spinner.h"
36 #include "ui_utildlg.h"
38 #include <gdk/gdkkeysyms.h> /* for key values */
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
52 /* ----------------------------------------------------------------
53 Tab completion routines, can be connected to any gtkentry widget
54 using the tab_completion_add_to_entry() function.
55 Use remove_trailing_slash() to strip the trailing G_DIR_SEPARATOR.
56 ----------------------------------------------------------------*/
58 typedef struct _TabCompData TabCompData;
64 void (*enter_func)(const gchar *, gpointer);
65 void (*tab_func)(const gchar *, gpointer);
66 void (*tab_append_func)(const gchar *, gpointer, gint);
70 gpointer tab_append_data;
79 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)
104 g_list_free(td->file_list);
105 td->file_list = NULL;
108 static void tab_completion_read_dir(TabCompData *td, const gchar *path)
115 tab_completion_free_list(td);
117 pathl = path_from_utf8(path);
125 while ((dir = readdir(dp)) != NULL)
127 gchar *name = dir->d_name;
128 if (strcmp(name, ".") != 0 && strcmp(name, "..") != 0)
130 gchar *abspath = g_build_filename(pathl, name, NULL);
132 if (g_file_test(abspath, G_FILE_TEST_IS_DIR))
134 gchar *dname = g_strconcat(name, G_DIR_SEPARATOR_S, NULL);
135 list = g_list_prepend(list, path_to_utf8(dname));
140 list = g_list_prepend(list, path_to_utf8(name));
147 td->dir_path = g_strdup(path);
148 td->file_list = list;
152 static void tab_completion_destroy(GtkWidget *widget, gpointer data)
154 TabCompData *td = data;
156 tab_completion_free_list(td);
157 g_free(td->history_key);
159 if (td->fd) file_dialog_close(td->fd);
160 g_free(td->fd_title);
165 static gchar *tab_completion_get_text(TabCompData *td)
169 text = g_strdup(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 TabCompData *td = data;
209 #if GTK_CHECK_VERSION(2,20,0)
210 if (!gtk_widget_get_visible(widget)) return;
212 if (!GTK_WIDGET_VISIBLE(widget)) return;
215 child = gtk_bin_get_child(GTK_BIN(widget));
216 if (GTK_IS_LABEL(child)) {
217 const gchar *text = gtk_label_get_text(GTK_LABEL(child));
218 const gchar *entry_text = gtk_entry_get_text(GTK_ENTRY(td->entry));
219 const gchar *prefix = filename_from_path(entry_text);
220 guint prefix_len = strlen(prefix);
222 if (strlen(text) < prefix_len || strncmp(text, prefix, prefix_len))
224 /* Hide menu items not matching */
225 gtk_widget_hide(widget);
229 /* Count how many choices are left in the menu */
235 static gboolean tab_completion_popup_key_press(GtkWidget *widget, GdkEventKey *event, gpointer data)
237 TabCompData *td = data;
239 if (event->keyval == GDK_KEY_Tab ||
240 event->keyval == GDK_KEY_BackSpace ||
241 (event->keyval >= 0x20 && event->keyval <= 0xFF) )
243 if (event->keyval >= 0x20 && event->keyval <= 0xFF)
248 buf[0] = event->keyval;
250 gtk_editable_insert_text(GTK_EDITABLE(td->entry), buf, 1, &p);
251 gtk_editable_set_position(GTK_EDITABLE(td->entry), -1);
253 /* Reduce the number of entries in the menu */
255 gtk_container_foreach(GTK_CONTAINER(widget), tab_completion_iter_menu_items, (gpointer) td);
256 if (td->choices > 1) return TRUE; /* multiple choices */
257 if (td->choices > 0) tab_completion_do(td); /* one choice */
261 gtk_menu_popdown(GTK_MENU(widget));
262 /* doing this does not emit the "selection done" signal, unref it ourselves */
263 #if GTK_CHECK_VERSION(2,12,0)
264 g_object_unref(widget);
266 gtk_widget_unref(widget);
274 static void tab_completion_popup_cb(GtkWidget *widget, gpointer data)
280 td = g_object_get_data(G_OBJECT(widget), "tab_completion_data");
283 buf = g_build_filename(td->dir_path, name, NULL);
284 gtk_entry_set_text(GTK_ENTRY(td->entry), buf);
285 gtk_editable_set_position(GTK_EDITABLE(td->entry), strlen(buf));
288 tab_completion_emit_tab_signal(td);
291 static void tab_completion_popup_pos_cb(GtkMenu *menu, gint *x, gint *y, gboolean *push_in, gpointer data)
293 TabCompData *td = data;
296 PangoRectangle strong_pos, weak_pos;
298 gint xoffset, yoffset;
302 GdkRectangle monitor;
303 GtkRequisition requisition;
304 GtkAllocation allocation;
306 gdk_window_get_origin(gtk_widget_get_window(GTK_WIDGET(td->entry)), x, y);
308 screen = gtk_widget_get_screen(GTK_WIDGET(menu));
309 monitor_num = gdk_screen_get_monitor_at_window(screen, gtk_widget_get_window(GTK_WIDGET(td->entry)));
310 gdk_screen_get_monitor_geometry(screen, monitor_num, &monitor);
312 gtk_widget_size_request(GTK_WIDGET(menu), &req);
314 length = strlen(gtk_entry_get_text(GTK_ENTRY(td->entry)));
315 gtk_entry_get_layout_offsets(GTK_ENTRY(td->entry), &xoffset, &yoffset);
317 layout = gtk_entry_get_layout(GTK_ENTRY(td->entry));
318 pango_layout_get_cursor_pos(layout, length, &strong_pos, &weak_pos);
320 *x += strong_pos.x / PANGO_SCALE + xoffset;
322 gtk_widget_get_requisition(td->entry, &requisition);
323 gtk_widget_get_allocation(td->entry, &allocation);
325 height = MIN(requisition.height, allocation.height);
327 if (req.height > monitor.y + monitor.height - *y - height &&
328 *y - monitor.y > monitor.y + monitor.height - *y)
330 height = MIN(*y - monitor.y, req.height);
331 gtk_widget_set_size_request(GTK_WIDGET(menu), -1, height);
340 static void tab_completion_popup_list(TabCompData *td, GList *list)
353 * well, the menu would be too long anyway...
354 * (listing /dev causes gtk+ window allocation errors, -> too big a window)
355 * this is why menu popups are disabled, this really should be a popup scrollable listview.
357 if (g_list_length(list) > 200) return;
360 menu = popup_menu_short_lived();
363 while (work && count < TAB_COMP_POPUP_MAX)
365 gchar *name = work->data;
368 item = menu_item_add_simple(menu, name, G_CALLBACK(tab_completion_popup_cb), name);
369 g_object_set_data(G_OBJECT(item), "tab_completion_data", td);
375 g_signal_connect(G_OBJECT(menu), "key_press_event",
376 G_CALLBACK(tab_completion_popup_key_press), td);
378 /* peek at the current event to get the time, etc. */
379 event = gtk_get_current_event();
381 if (event && event->type == GDK_BUTTON_RELEASE)
383 ebutton = event->button.button;
392 etime = gdk_event_get_time(event);
393 gdk_event_free(event);
400 gtk_menu_popup(GTK_MENU(menu), NULL, NULL,
401 tab_completion_popup_pos_cb, td, ebutton, etime);
405 #define CASE_SORT strcmp
408 static gint simple_sort(gconstpointer a, gconstpointer b)
410 return CASE_SORT((gchar *)a, (gchar *)b);
415 static gboolean tab_completion_do(TabCompData *td)
417 const gchar *entry_text = gtk_entry_get_text(GTK_ENTRY(td->entry));
418 const gchar *entry_file;
421 gboolean home_exp = FALSE;
423 if (entry_text[0] == '\0')
425 entry_dir = g_strdup(G_DIR_SEPARATOR_S); /* FIXME: root directory win32 */
426 gtk_entry_set_text(GTK_ENTRY(td->entry), entry_dir);
427 gtk_editable_set_position(GTK_EDITABLE(td->entry), strlen(entry_dir));
432 /* home dir expansion */
433 if (entry_text[0] == '~')
435 entry_dir = expand_tilde(entry_text);
440 entry_dir = g_strdup(entry_text);
443 if (isfile(entry_dir))
447 gtk_entry_set_text(GTK_ENTRY(td->entry), entry_dir);
448 gtk_editable_set_position(GTK_EDITABLE(td->entry), strlen(entry_dir));
454 entry_file = filename_from_path(entry_text);
456 if (isdir(entry_dir) && strcmp(entry_file, ".") != 0 && strcmp(entry_file, "..") != 0)
458 ptr = entry_dir + strlen(entry_dir) - 1;
459 if (ptr[0] == G_DIR_SEPARATOR)
463 gtk_entry_set_text(GTK_ENTRY(td->entry), entry_dir);
464 gtk_editable_set_position(GTK_EDITABLE(td->entry), strlen(entry_dir));
467 tab_completion_read_dir(td, entry_dir);
468 td->file_list = g_list_sort(td->file_list, simple_sort);
469 if (td->file_list && !td->file_list->next)
474 file = td->file_list->data;
475 buf = g_build_filename(entry_dir, file, NULL);
478 gchar *tmp = g_strconcat(buf, G_DIR_SEPARATOR_S, NULL);
482 gtk_entry_set_text(GTK_ENTRY(td->entry), buf);
483 gtk_editable_set_position(GTK_EDITABLE(td->entry), strlen(buf));
487 #ifdef TAB_COMPLETION_ENABLE_POPUP_MENU
491 tab_completion_popup_list(td, td->file_list);
500 gchar *buf = g_strconcat(entry_dir, G_DIR_SEPARATOR_S, NULL);
501 gtk_entry_set_text(GTK_ENTRY(td->entry), buf);
502 gtk_editable_set_position(GTK_EDITABLE(td->entry), strlen(buf));
509 ptr = (gchar *)filename_from_path(entry_dir);
510 if (ptr > entry_dir) ptr--;
513 if (strlen(entry_dir) == 0)
516 entry_dir = g_strdup(G_DIR_SEPARATOR_S); /* FIXME: win32 */
519 if (isdir(entry_dir))
523 gint l = strlen(entry_file);
525 if (!td->dir_path || !td->file_list || strcmp(td->dir_path, entry_dir) != 0)
527 tab_completion_read_dir(td, entry_dir);
530 list = td->file_list;
533 gchar *file = list->data;
534 if (strncmp(entry_file, file, l) == 0)
536 poss = g_list_prepend(poss, file);
545 gchar *file = poss->data;
548 buf = g_build_filename(entry_dir, file, NULL);
549 gtk_entry_set_text(GTK_ENTRY(td->entry), buf);
550 gtk_editable_set_position(GTK_EDITABLE(td->entry), strlen(buf));
558 gsize c = strlen(entry_file);
559 gboolean done = FALSE;
560 gchar *test_file = poss->data;
565 if (!list) done = TRUE;
566 while (list && !done)
568 gchar *file = list->data;
569 if (strlen(file) < c || strncmp(test_file, file, c) != 0)
582 file = g_strdup(test_file);
584 buf = g_build_filename(entry_dir, file, NULL);
585 gtk_entry_set_text(GTK_ENTRY(td->entry), buf);
586 gtk_editable_set_position(GTK_EDITABLE(td->entry), strlen(buf));
588 #ifdef TAB_COMPLETION_ENABLE_POPUP_MENU
590 poss = g_list_sort(poss, simple_sort);
591 tab_completion_popup_list(td, poss);
611 static gboolean tab_completion_key_pressed(GtkWidget *widget, GdkEventKey *event, gpointer data)
613 TabCompData *td = data;
614 gboolean stop_signal = FALSE;
616 switch (event->keyval)
619 if (!(event->state & GDK_CONTROL_MASK))
621 if (tab_completion_do(td))
623 tab_completion_emit_tab_signal(td);
628 case GDK_KEY_Return: case GDK_KEY_KP_Enter:
630 (event->state & GDK_CONTROL_MASK))
632 tab_completion_select_show(td);
635 else if (tab_completion_emit_enter_signal(td))
644 if (stop_signal) g_signal_stop_emission_by_name(G_OBJECT(widget), "key_press_event");
646 return (stop_signal);
649 static void tab_completion_button_pressed(GtkWidget *widget, gpointer data)
652 GtkWidget *entry = data;
654 td = g_object_get_data(G_OBJECT(entry), "tab_completion_data");
658 #if GTK_CHECK_VERSION(2,20,0)
659 if (!gtk_widget_has_focus(entry))
661 if (!GTK_WIDGET_HAS_FOCUS(entry))
664 gtk_widget_grab_focus(entry);
667 if (tab_completion_do(td))
669 tab_completion_emit_tab_signal(td);
673 static void tab_completion_button_size_allocate(GtkWidget *button, GtkAllocation *allocation, gpointer data)
675 GtkWidget *parent = data;
676 GtkAllocation parent_allocation;
677 gtk_widget_get_allocation(parent, &parent_allocation);
679 if (allocation->height > parent_allocation.height)
681 GtkAllocation button_allocation;
683 gtk_widget_get_allocation(button, &button_allocation);
684 button_allocation.height = parent_allocation.height;
685 button_allocation.y = parent_allocation.y +
686 (parent_allocation.height - parent_allocation.height) / 2;
687 gtk_widget_size_allocate(button, &button_allocation);
691 static GtkWidget *tab_completion_create_complete_button(GtkWidget *entry, GtkWidget *parent)
697 button = gtk_button_new();
698 gtk_widget_set_can_focus(button, FALSE);
699 g_signal_connect(G_OBJECT(button), "size_allocate",
700 G_CALLBACK(tab_completion_button_size_allocate), parent);
701 g_signal_connect(G_OBJECT(button), "clicked",
702 G_CALLBACK(tab_completion_button_pressed), entry);
704 pixbuf = gdk_pixbuf_new_from_inline(-1, icon_tabcomp, FALSE, NULL);
705 icon = gtk_image_new_from_pixbuf(pixbuf);
706 g_object_unref(pixbuf);
708 gtk_container_add(GTK_CONTAINER(button), icon);
709 gtk_widget_show(icon);
715 *----------------------------------------------------------------------------
717 *----------------------------------------------------------------------------
720 GtkWidget *tab_completion_new_with_history(GtkWidget **entry, const gchar *text,
721 const gchar *history_key, gint max_levels,
722 void (*enter_func)(const gchar *, gpointer), gpointer data)
726 GtkWidget *combo_entry;
732 box = gtk_hbox_new(FALSE, 0);
734 combo = gtk_combo_box_text_new_with_entry();
735 gtk_box_pack_start(GTK_BOX(box), combo, TRUE, TRUE, 0);
736 gtk_widget_show(combo);
738 combo_entry = gtk_bin_get_child(GTK_BIN(combo));
740 gtk_combo_set_case_sensitive(GTK_COMBO(combo), TRUE);
741 gtk_combo_set_use_arrows(GTK_COMBO(combo), FALSE);
744 button = tab_completion_create_complete_button(combo_entry, combo);
745 gtk_box_pack_start(GTK_BOX(box), button, FALSE, FALSE, 0);
746 gtk_widget_show(button);
748 tab_completion_add_to_entry(combo_entry, enter_func, data);
750 td = g_object_get_data(G_OBJECT(combo_entry), "tab_completion_data");
751 if (!td) return NULL; /* this should never happen! */
754 td->has_history = TRUE;
755 td->history_key = g_strdup(history_key);
756 td->history_levels = max_levels;
758 work = history_list_get_by_key(td->history_key);
760 work = history_list_get_by_key(history_key);
763 gtk_combo_box_text_append_text(GTK_COMBO_BOX_TEXT(combo), (gchar *)work->data);
770 gtk_entry_set_text(GTK_ENTRY(combo_entry), text);
774 gtk_combo_box_set_active(GTK_COMBO_BOX(combo), 0);
777 if (entry) *entry = combo_entry;
781 const gchar *tab_completion_set_to_last_history(GtkWidget *entry)
783 TabCompData *td = g_object_get_data(G_OBJECT(entry), "tab_completion_data");
786 if (!td || !td->has_history) return NULL;
788 buf = history_list_find_last_path_by_key(td->history_key);
791 gtk_entry_set_text(GTK_ENTRY(td->entry), buf);
797 void tab_completion_append_to_history(GtkWidget *entry, const gchar *path)
804 td = g_object_get_data(G_OBJECT(entry), "tab_completion_data");
808 if (!td || !td->has_history) return;
810 history_list_add_to_key(td->history_key, path, td->history_levels);
812 gtk_combo_box_set_active(GTK_COMBO_BOX(td->combo), -1);
814 store = gtk_combo_box_get_model(GTK_COMBO_BOX(td->combo));
815 gtk_list_store_clear(GTK_LIST_STORE(store));
817 work = history_list_get_by_key(td->history_key);
820 gtk_combo_box_text_append_text(GTK_COMBO_BOX_TEXT(td->combo), (gchar *)work->data);
825 if (td->tab_append_func) {
826 td->tab_append_func(path, td->tab_append_data, n);
830 GtkWidget *tab_completion_new(GtkWidget **entry, const gchar *text,
831 void (*enter_func)(const gchar *, gpointer), gpointer data)
837 hbox = gtk_hbox_new(FALSE, 0);
839 newentry = gtk_entry_new();
840 if (text) gtk_entry_set_text(GTK_ENTRY(newentry), text);
841 gtk_box_pack_start(GTK_BOX(hbox), newentry, TRUE, TRUE, 0);
842 gtk_widget_show(newentry);
844 button = tab_completion_create_complete_button(newentry, newentry);
845 gtk_box_pack_start(GTK_BOX(hbox), button, FALSE, FALSE, 0);
846 gtk_widget_show(button);
848 tab_completion_add_to_entry(newentry, enter_func, data);
850 if (entry) *entry = newentry;
854 void tab_completion_add_to_entry(GtkWidget *entry, void (*enter_func)(const gchar *, gpointer), gpointer data)
859 log_printf("Tab completion error: entry != NULL\n");
863 td = g_new0(TabCompData, 1);
866 td->enter_func = enter_func;
867 td->enter_data = data;
869 g_object_set_data(G_OBJECT(td->entry), "tab_completion_data", td);
871 g_signal_connect(G_OBJECT(entry), "key_press_event",
872 G_CALLBACK(tab_completion_key_pressed), td);
873 g_signal_connect(G_OBJECT(entry), "destroy",
874 G_CALLBACK(tab_completion_destroy), td);
877 void tab_completion_add_tab_func(GtkWidget *entry, void (*tab_func)(const gchar *, gpointer), gpointer data)
879 TabCompData *td = g_object_get_data(G_OBJECT(entry), "tab_completion_data");
883 td->tab_func = tab_func;
887 /* Add a callback function called when a new entry is appended to the list */
888 void tab_completion_add_append_func(GtkWidget *entry, void (*tab_append_func)(const gchar *, gpointer, gint), gpointer data)
890 TabCompData *td = g_object_get_data(G_OBJECT(entry), "tab_completion_data");
894 td->tab_append_func = tab_append_func;
895 td->tab_append_data = data;
898 gchar *remove_trailing_slash(const gchar *path)
902 if (!path) return NULL;
905 while (l > 1 && path[l - 1] == G_DIR_SEPARATOR) l--;
907 return g_strndup(path, l);
910 static void tab_completion_select_cancel_cb(FileDialog *fd, gpointer data)
912 TabCompData *td = data;
915 file_dialog_close(fd);
918 static void tab_completion_select_ok_cb(FileDialog *fd, gpointer data)
920 TabCompData *td = data;
922 gtk_entry_set_text(GTK_ENTRY(td->entry), gtk_entry_get_text(GTK_ENTRY(fd->entry)));
924 tab_completion_select_cancel_cb(fd, data);
926 tab_completion_emit_enter_signal(td);
929 static void tab_completion_select_show(TabCompData *td)
936 gtk_window_present(GTK_WINDOW(GENERIC_DIALOG(td->fd)->dialog));
940 title = (td->fd_title) ? td->fd_title : _("Select path");
941 td->fd = file_dialog_new(title, "select_path", td->entry,
942 tab_completion_select_cancel_cb, td);
943 file_dialog_add_button(td->fd, GTK_STOCK_OK, NULL,
944 tab_completion_select_ok_cb, TRUE);
946 generic_dialog_add_message(GENERIC_DIALOG(td->fd), NULL, title, NULL);
948 path = gtk_entry_get_text(GTK_ENTRY(td->entry));
949 if (strlen(path) == 0) path = NULL;
950 if (td->fd_folders_only)
952 file_dialog_add_path_widgets(td->fd, NULL, path, td->history_key, NULL, NULL);
956 file_dialog_add_path_widgets(td->fd, NULL, path, td->history_key, "*", _("All files"));
959 gtk_widget_show(GENERIC_DIALOG(td->fd)->dialog);
962 static void tab_completion_select_pressed(GtkWidget *widget, gpointer data)
964 TabCompData *td = data;
966 tab_completion_select_show(td);
969 void tab_completion_add_select_button(GtkWidget *entry, const gchar *title, gboolean folders_only)
975 td = g_object_get_data(G_OBJECT(entry), "tab_completion_data");
979 g_free(td->fd_title);
980 td->fd_title = g_strdup(title);
981 td->fd_folders_only = folders_only;
983 if (td->fd_button) return;
985 parent = (td->combo) ? td->combo : td->entry;
987 hbox = gtk_widget_get_parent(parent);
988 if (!GTK_IS_BOX(hbox)) return;
990 td->fd_button = gtk_button_new_with_label("...");
991 g_signal_connect(G_OBJECT(td->fd_button), "size_allocate",
992 G_CALLBACK(tab_completion_button_size_allocate), parent);
993 g_signal_connect(G_OBJECT(td->fd_button), "clicked",
994 G_CALLBACK(tab_completion_select_pressed), td);
996 gtk_box_pack_start(GTK_BOX(hbox), td->fd_button, FALSE, FALSE, 0);
998 gtk_widget_show(td->fd_button);
1000 /* vim: set shiftwidth=8 softtabstop=0 cindent cinoptions={1s: */