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_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 = 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))
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 TabCompData *td = 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, (gpointer) 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)
272 td = g_object_get_data(G_OBJECT(widget), "tab_completion_data");
275 buf = g_build_filename(td->dir_path, name, NULL);
276 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_pos_cb(GtkMenu *menu, gint *x, gint *y, gboolean *push_in, gpointer data)
285 TabCompData *td = data;
288 PangoRectangle strong_pos, weak_pos;
290 gint xoffset, yoffset;
294 GdkRectangle monitor;
295 GtkRequisition requisition;
296 GtkAllocation allocation;
298 gdk_window_get_origin(gtk_widget_get_window(GTK_WIDGET(td->entry)), x, y);
300 screen = gtk_widget_get_screen(GTK_WIDGET(menu));
301 monitor_num = gdk_screen_get_monitor_at_window(screen, gtk_widget_get_window(GTK_WIDGET(td->entry)));
302 gdk_screen_get_monitor_geometry(screen, monitor_num, &monitor);
304 gtk_widget_size_request(GTK_WIDGET(menu), &req);
306 length = strlen(gtk_entry_get_text(GTK_ENTRY(td->entry)));
307 gtk_entry_get_layout_offsets(GTK_ENTRY(td->entry), &xoffset, &yoffset);
309 layout = gtk_entry_get_layout(GTK_ENTRY(td->entry));
310 pango_layout_get_cursor_pos(layout, length, &strong_pos, &weak_pos);
312 *x += strong_pos.x / PANGO_SCALE + xoffset;
314 gtk_widget_get_requisition(td->entry, &requisition);
315 gtk_widget_get_allocation(td->entry, &allocation);
317 height = MIN(requisition.height, allocation.height);
319 if (req.height > monitor.y + monitor.height - *y - height &&
320 *y - monitor.y > monitor.y + monitor.height - *y)
322 height = MIN(*y - monitor.y, req.height);
323 gtk_widget_set_size_request(GTK_WIDGET(menu), -1, height);
332 static void tab_completion_popup_list(TabCompData *td, GList *list)
345 * well, the menu would be too long anyway...
346 * (listing /dev causes gtk+ window allocation errors, -> too big a window)
347 * this is why menu popups are disabled, this really should be a popup scrollable listview.
349 if (g_list_length(list) > 200) return;
352 menu = popup_menu_short_lived();
355 while (work && count < TAB_COMP_POPUP_MAX)
357 gchar *name = work->data;
360 item = menu_item_add_simple(menu, name, G_CALLBACK(tab_completion_popup_cb), name);
361 g_object_set_data(G_OBJECT(item), "tab_completion_data", td);
367 g_signal_connect(G_OBJECT(menu), "key_press_event",
368 G_CALLBACK(tab_completion_popup_key_press), td);
370 /* peek at the current event to get the time, etc. */
371 event = gtk_get_current_event();
373 if (event && event->type == GDK_BUTTON_RELEASE)
375 ebutton = event->button.button;
384 etime = gdk_event_get_time(event);
385 gdk_event_free(event);
392 gtk_menu_popup(GTK_MENU(menu), NULL, NULL,
393 tab_completion_popup_pos_cb, td, ebutton, etime);
397 #define CASE_SORT strcmp
400 static gint simple_sort(gconstpointer a, gconstpointer b)
402 return CASE_SORT((gchar *)a, (gchar *)b);
407 static gboolean tab_completion_do(TabCompData *td)
409 const gchar *entry_text = gtk_entry_get_text(GTK_ENTRY(td->entry));
410 const gchar *entry_file;
413 gboolean home_exp = FALSE;
415 if (entry_text[0] == '\0')
417 entry_dir = g_strdup(G_DIR_SEPARATOR_S); /* FIXME: root directory win32 */
418 gtk_entry_set_text(GTK_ENTRY(td->entry), entry_dir);
419 gtk_editable_set_position(GTK_EDITABLE(td->entry), strlen(entry_dir));
424 /* home dir expansion */
425 if (entry_text[0] == '~')
427 entry_dir = expand_tilde(entry_text);
432 entry_dir = g_strdup(entry_text);
435 if (isfile(entry_dir))
439 gtk_entry_set_text(GTK_ENTRY(td->entry), entry_dir);
440 gtk_editable_set_position(GTK_EDITABLE(td->entry), strlen(entry_dir));
446 entry_file = filename_from_path(entry_text);
448 if (isdir(entry_dir) && strcmp(entry_file, ".") != 0 && strcmp(entry_file, "..") != 0)
450 ptr = entry_dir + strlen(entry_dir) - 1;
451 if (ptr[0] == G_DIR_SEPARATOR)
455 gtk_entry_set_text(GTK_ENTRY(td->entry), entry_dir);
456 gtk_editable_set_position(GTK_EDITABLE(td->entry), strlen(entry_dir));
459 tab_completion_read_dir(td, entry_dir);
460 td->file_list = g_list_sort(td->file_list, simple_sort);
461 if (td->file_list && !td->file_list->next)
466 file = td->file_list->data;
467 buf = g_build_filename(entry_dir, file, NULL);
470 gchar *tmp = g_strconcat(buf, G_DIR_SEPARATOR_S, NULL);
474 gtk_entry_set_text(GTK_ENTRY(td->entry), buf);
475 gtk_editable_set_position(GTK_EDITABLE(td->entry), strlen(buf));
479 #ifdef TAB_COMPLETION_ENABLE_POPUP_MENU
483 tab_completion_popup_list(td, td->file_list);
492 gchar *buf = g_strconcat(entry_dir, G_DIR_SEPARATOR_S, NULL);
493 gtk_entry_set_text(GTK_ENTRY(td->entry), buf);
494 gtk_editable_set_position(GTK_EDITABLE(td->entry), strlen(buf));
501 ptr = (gchar *)filename_from_path(entry_dir);
502 if (ptr > entry_dir) ptr--;
505 if (strlen(entry_dir) == 0)
508 entry_dir = g_strdup(G_DIR_SEPARATOR_S); /* FIXME: win32 */
511 if (isdir(entry_dir))
515 gint l = strlen(entry_file);
517 if (!td->dir_path || !td->file_list || strcmp(td->dir_path, entry_dir) != 0)
519 tab_completion_read_dir(td, entry_dir);
522 list = td->file_list;
525 gchar *file = list->data;
526 if (strncmp(entry_file, file, l) == 0)
528 poss = g_list_prepend(poss, file);
537 gchar *file = poss->data;
540 buf = g_build_filename(entry_dir, file, NULL);
541 gtk_entry_set_text(GTK_ENTRY(td->entry), buf);
542 gtk_editable_set_position(GTK_EDITABLE(td->entry), strlen(buf));
550 gsize c = strlen(entry_file);
551 gboolean done = FALSE;
552 gchar *test_file = poss->data;
557 if (!list) done = TRUE;
558 while (list && !done)
560 gchar *file = list->data;
561 if (strlen(file) < c || strncmp(test_file, file, c) != 0)
574 file = g_strdup(test_file);
576 buf = g_build_filename(entry_dir, file, NULL);
577 gtk_entry_set_text(GTK_ENTRY(td->entry), buf);
578 gtk_editable_set_position(GTK_EDITABLE(td->entry), strlen(buf));
580 #ifdef TAB_COMPLETION_ENABLE_POPUP_MENU
582 poss = g_list_sort(poss, simple_sort);
583 tab_completion_popup_list(td, poss);
603 static gboolean tab_completion_key_pressed(GtkWidget *widget, GdkEventKey *event, gpointer data)
605 TabCompData *td = data;
606 gboolean stop_signal = FALSE;
608 switch (event->keyval)
611 if (!(event->state & GDK_CONTROL_MASK))
613 if (tab_completion_do(td))
615 tab_completion_emit_tab_signal(td);
620 case GDK_KEY_Return: case GDK_KEY_KP_Enter:
622 (event->state & GDK_CONTROL_MASK))
624 tab_completion_select_show(td);
627 else if (tab_completion_emit_enter_signal(td))
636 if (stop_signal) g_signal_stop_emission_by_name(G_OBJECT(widget), "key_press_event");
638 return (stop_signal);
641 static void tab_completion_button_pressed(GtkWidget *widget, gpointer data)
644 GtkWidget *entry = data;
646 td = g_object_get_data(G_OBJECT(entry), "tab_completion_data");
650 if (!gtk_widget_has_focus(entry))
652 gtk_widget_grab_focus(entry);
655 if (tab_completion_do(td))
657 tab_completion_emit_tab_signal(td);
661 static void tab_completion_button_size_allocate(GtkWidget *button, GtkAllocation *allocation, gpointer data)
663 GtkWidget *parent = data;
664 GtkAllocation parent_allocation;
665 gtk_widget_get_allocation(parent, &parent_allocation);
667 if (allocation->height > parent_allocation.height)
669 GtkAllocation button_allocation;
671 gtk_widget_get_allocation(button, &button_allocation);
672 button_allocation.height = parent_allocation.height;
673 button_allocation.y = parent_allocation.y +
674 (parent_allocation.height - parent_allocation.height) / 2;
675 gtk_widget_size_allocate(button, &button_allocation);
679 static GtkWidget *tab_completion_create_complete_button(GtkWidget *entry, GtkWidget *parent)
685 button = gtk_button_new();
686 gtk_widget_set_can_focus(button, FALSE);
687 g_signal_connect(G_OBJECT(button), "size_allocate",
688 G_CALLBACK(tab_completion_button_size_allocate), parent);
689 g_signal_connect(G_OBJECT(button), "clicked",
690 G_CALLBACK(tab_completion_button_pressed), entry);
692 pixbuf = gdk_pixbuf_new_from_inline(-1, icon_tabcomp, FALSE, NULL);
693 icon = gtk_image_new_from_pixbuf(pixbuf);
694 g_object_unref(pixbuf);
696 gtk_container_add(GTK_CONTAINER(button), icon);
697 gtk_widget_show(icon);
703 *----------------------------------------------------------------------------
705 *----------------------------------------------------------------------------
708 GtkWidget *tab_completion_new_with_history(GtkWidget **entry, const gchar *text,
709 const gchar *history_key, gint max_levels,
710 void (*enter_func)(const gchar *, gpointer), gpointer data)
714 GtkWidget *combo_entry;
720 box = gtk_hbox_new(FALSE, 0);
722 combo = gtk_combo_box_text_new_with_entry();
723 gtk_box_pack_start(GTK_BOX(box), combo, TRUE, TRUE, 0);
724 gtk_widget_show(combo);
726 combo_entry = gtk_bin_get_child(GTK_BIN(combo));
728 gtk_combo_set_case_sensitive(GTK_COMBO(combo), TRUE);
729 gtk_combo_set_use_arrows(GTK_COMBO(combo), FALSE);
732 button = tab_completion_create_complete_button(combo_entry, combo);
733 gtk_box_pack_start(GTK_BOX(box), button, FALSE, FALSE, 0);
734 gtk_widget_show(button);
736 tab_completion_add_to_entry(combo_entry, enter_func, data);
738 td = g_object_get_data(G_OBJECT(combo_entry), "tab_completion_data");
739 if (!td) return NULL; /* this should never happen! */
742 td->has_history = TRUE;
743 td->history_key = g_strdup(history_key);
744 td->history_levels = max_levels;
746 work = history_list_get_by_key(td->history_key);
748 work = history_list_get_by_key(history_key);
751 gtk_combo_box_text_append_text(GTK_COMBO_BOX_TEXT(combo), (gchar *)work->data);
758 gtk_entry_set_text(GTK_ENTRY(combo_entry), text);
762 gtk_combo_box_set_active(GTK_COMBO_BOX(combo), 0);
765 if (entry) *entry = combo_entry;
769 const gchar *tab_completion_set_to_last_history(GtkWidget *entry)
771 TabCompData *td = g_object_get_data(G_OBJECT(entry), "tab_completion_data");
774 if (!td || !td->has_history) return NULL;
776 buf = history_list_find_last_path_by_key(td->history_key);
779 gtk_entry_set_text(GTK_ENTRY(td->entry), buf);
785 void tab_completion_append_to_history(GtkWidget *entry, const gchar *path)
792 td = g_object_get_data(G_OBJECT(entry), "tab_completion_data");
796 if (!td || !td->has_history) return;
798 history_list_add_to_key(td->history_key, path, td->history_levels);
800 gtk_combo_box_set_active(GTK_COMBO_BOX(td->combo), -1);
802 store = gtk_combo_box_get_model(GTK_COMBO_BOX(td->combo));
803 gtk_list_store_clear(GTK_LIST_STORE(store));
805 work = history_list_get_by_key(td->history_key);
808 gtk_combo_box_text_append_text(GTK_COMBO_BOX_TEXT(td->combo), (gchar *)work->data);
813 if (td->tab_append_func) {
814 td->tab_append_func(path, td->tab_append_data, n);
818 GtkWidget *tab_completion_new(GtkWidget **entry, const gchar *text,
819 void (*enter_func)(const gchar *, gpointer), gpointer data)
825 hbox = gtk_hbox_new(FALSE, 0);
827 newentry = gtk_entry_new();
828 if (text) gtk_entry_set_text(GTK_ENTRY(newentry), text);
829 gtk_box_pack_start(GTK_BOX(hbox), newentry, TRUE, TRUE, 0);
830 gtk_widget_show(newentry);
832 button = tab_completion_create_complete_button(newentry, newentry);
833 gtk_box_pack_start(GTK_BOX(hbox), button, FALSE, FALSE, 0);
834 gtk_widget_show(button);
836 tab_completion_add_to_entry(newentry, enter_func, data);
838 if (entry) *entry = newentry;
842 void tab_completion_add_to_entry(GtkWidget *entry, void (*enter_func)(const gchar *, gpointer), gpointer data)
847 log_printf("Tab completion error: entry != NULL\n");
851 td = g_new0(TabCompData, 1);
854 td->enter_func = enter_func;
855 td->enter_data = data;
857 g_object_set_data(G_OBJECT(td->entry), "tab_completion_data", td);
859 g_signal_connect(G_OBJECT(entry), "key_press_event",
860 G_CALLBACK(tab_completion_key_pressed), td);
861 g_signal_connect(G_OBJECT(entry), "destroy",
862 G_CALLBACK(tab_completion_destroy), td);
865 void tab_completion_add_tab_func(GtkWidget *entry, void (*tab_func)(const gchar *, gpointer), gpointer data)
867 TabCompData *td = g_object_get_data(G_OBJECT(entry), "tab_completion_data");
871 td->tab_func = tab_func;
875 /* Add a callback function called when a new entry is appended to the list */
876 void tab_completion_add_append_func(GtkWidget *entry, void (*tab_append_func)(const gchar *, gpointer, gint), gpointer data)
878 TabCompData *td = g_object_get_data(G_OBJECT(entry), "tab_completion_data");
882 td->tab_append_func = tab_append_func;
883 td->tab_append_data = data;
886 gchar *remove_trailing_slash(const gchar *path)
890 if (!path) return NULL;
893 while (l > 1 && path[l - 1] == G_DIR_SEPARATOR) l--;
895 return g_strndup(path, l);
898 static void tab_completion_select_cancel_cb(FileDialog *fd, gpointer data)
900 TabCompData *td = data;
903 file_dialog_close(fd);
906 static void tab_completion_select_ok_cb(FileDialog *fd, gpointer data)
908 TabCompData *td = data;
910 gtk_entry_set_text(GTK_ENTRY(td->entry), gtk_entry_get_text(GTK_ENTRY(fd->entry)));
912 tab_completion_select_cancel_cb(fd, data);
914 tab_completion_emit_enter_signal(td);
917 static void tab_completion_select_show(TabCompData *td)
924 gtk_window_present(GTK_WINDOW(GENERIC_DIALOG(td->fd)->dialog));
928 title = (td->fd_title) ? td->fd_title : _("Select path");
929 td->fd = file_dialog_new(title, "select_path", td->entry,
930 tab_completion_select_cancel_cb, td);
931 file_dialog_add_button(td->fd, GTK_STOCK_OK, NULL,
932 tab_completion_select_ok_cb, TRUE);
934 generic_dialog_add_message(GENERIC_DIALOG(td->fd), NULL, title, NULL);
936 path = gtk_entry_get_text(GTK_ENTRY(td->entry));
937 if (strlen(path) == 0) path = NULL;
938 if (td->fd_folders_only)
940 file_dialog_add_path_widgets(td->fd, NULL, path, td->history_key, NULL, NULL);
944 file_dialog_add_path_widgets(td->fd, NULL, path, td->history_key, "*", _("All files"));
947 gtk_widget_show(GENERIC_DIALOG(td->fd)->dialog);
950 static void tab_completion_select_pressed(GtkWidget *widget, gpointer data)
952 TabCompData *td = data;
954 tab_completion_select_show(td);
957 void tab_completion_add_select_button(GtkWidget *entry, const gchar *title, gboolean folders_only)
963 td = g_object_get_data(G_OBJECT(entry), "tab_completion_data");
967 g_free(td->fd_title);
968 td->fd_title = g_strdup(title);
969 td->fd_folders_only = folders_only;
971 if (td->fd_button) return;
973 parent = (td->combo) ? td->combo : td->entry;
975 hbox = gtk_widget_get_parent(parent);
976 if (!GTK_IS_BOX(hbox)) return;
978 td->fd_button = gtk_button_new_with_label("...");
979 g_signal_connect(G_OBJECT(td->fd_button), "size_allocate",
980 G_CALLBACK(tab_completion_button_size_allocate), parent);
981 g_signal_connect(G_OBJECT(td->fd_button), "clicked",
982 G_CALLBACK(tab_completion_select_pressed), td);
984 gtk_box_pack_start(GTK_BOX(hbox), td->fd_button, FALSE, FALSE, 0);
986 gtk_widget_show(td->fd_button);
988 /* vim: set shiftwidth=8 softtabstop=0 cindent cinoptions={1s: */