Make code more readable by renaming poorly named macros NZV and NVL
[geany-mirror.git] / src / sidebar.c
blob2431c36350b3cb9050a7ea9f23b2471f57202382
1 /*
2 * sidebar.c - this file is part of Geany, a fast and lightweight IDE
4 * Copyright 2005-2012 Enrico Tröger <enrico(dot)troeger(at)uvena(dot)de>
5 * Copyright 2006-2012 Nick Treleaven <nick(dot)treleaven(at)btinternet(dot)com>
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.
23 * Sidebar related code for the Symbol list and Open files GtkTreeViews.
26 #include <string.h>
28 #include "geany.h"
29 #include "support.h"
30 #include "callbacks.h"
31 #include "sidebar.h"
32 #include "document.h"
33 #include "editor.h"
34 #include "documentprivate.h"
35 #include "filetypes.h"
36 #include "utils.h"
37 #include "ui_utils.h"
38 #include "symbols.h"
39 #include "navqueue.h"
40 #include "project.h"
41 #include "stash.h"
42 #include "keyfile.h"
43 #include "sciwrappers.h"
44 #include "search.h"
46 #include <gdk/gdkkeysyms.h>
49 SidebarTreeviews tv = {NULL, NULL, NULL};
50 /* while typeahead searching, editor should not get focus */
51 static gboolean may_steal_focus = FALSE;
53 static struct
55 GtkWidget *close;
56 GtkWidget *save;
57 GtkWidget *reload;
58 GtkWidget *show_paths;
59 GtkWidget *find_in_files;
60 GtkWidget *expand_all;
61 GtkWidget *collapse_all;
63 doc_items = {NULL, NULL, NULL, NULL, NULL, NULL, NULL};
65 enum
67 TREEVIEW_SYMBOL = 0,
68 TREEVIEW_OPENFILES
71 enum
73 OPENFILES_ACTION_REMOVE = 0,
74 OPENFILES_ACTION_SAVE,
75 OPENFILES_ACTION_RELOAD
78 /* documents tree model columns */
79 enum
81 DOCUMENTS_ICON,
82 DOCUMENTS_SHORTNAME, /* dirname for parents, basename for children */
83 DOCUMENTS_DOCUMENT,
84 DOCUMENTS_COLOR,
85 DOCUMENTS_FILENAME /* full filename */
88 static GtkTreeStore *store_openfiles;
89 static GtkWidget *openfiles_popup_menu;
90 static gboolean documents_show_paths;
91 static GtkWidget *tag_window; /* scrolled window that holds the symbol list GtkTreeView */
93 /* callback prototypes */
94 static void on_openfiles_document_action(GtkMenuItem *menuitem, gpointer user_data);
95 static gboolean sidebar_button_press_cb(GtkWidget *widget, GdkEventButton *event,
96 gpointer user_data);
97 static gboolean sidebar_key_press_cb(GtkWidget *widget, GdkEventKey *event,
98 gpointer user_data);
99 static void on_list_document_activate(GtkCheckMenuItem *item, gpointer user_data);
100 static void on_list_symbol_activate(GtkCheckMenuItem *item, gpointer user_data);
101 static void documents_menu_update(GtkTreeSelection *selection);
102 static void sidebar_tabs_show_hide(GtkNotebook *notebook, GtkWidget *child,
103 guint page_num, gpointer data);
106 /* the prepare_* functions are document-related, but I think they fit better here than in document.c */
107 static void prepare_taglist(GtkWidget *tree, GtkTreeStore *store)
109 GtkCellRenderer *text_renderer, *icon_renderer;
110 GtkTreeViewColumn *column;
111 GtkTreeSelection *selection;
113 text_renderer = gtk_cell_renderer_text_new();
114 icon_renderer = gtk_cell_renderer_pixbuf_new();
115 column = gtk_tree_view_column_new();
117 gtk_tree_view_column_pack_start(column, icon_renderer, FALSE);
118 gtk_tree_view_column_set_attributes(column, icon_renderer, "pixbuf", SYMBOLS_COLUMN_ICON, NULL);
119 g_object_set(icon_renderer, "xalign", 0.0, NULL);
121 gtk_tree_view_column_pack_start(column, text_renderer, TRUE);
122 gtk_tree_view_column_set_attributes(column, text_renderer, "text", SYMBOLS_COLUMN_NAME, NULL);
123 g_object_set(text_renderer, "yalign", 0.5, NULL);
124 gtk_tree_view_column_set_title(column, _("Symbols"));
126 gtk_tree_view_append_column(GTK_TREE_VIEW(tree), column);
127 gtk_tree_view_set_headers_visible(GTK_TREE_VIEW(tree), FALSE);
129 ui_widget_modify_font_from_string(tree, interface_prefs.tagbar_font);
131 gtk_tree_view_set_model(GTK_TREE_VIEW(tree), GTK_TREE_MODEL(store));
132 g_object_unref(store);
134 g_signal_connect(tree, "button-press-event",
135 G_CALLBACK(sidebar_button_press_cb), NULL);
136 g_signal_connect(tree, "key-press-event",
137 G_CALLBACK(sidebar_key_press_cb), NULL);
139 gtk_tree_view_set_show_expanders(GTK_TREE_VIEW(tree), interface_prefs.show_symbol_list_expanders);
140 if (! interface_prefs.show_symbol_list_expanders)
141 gtk_tree_view_set_level_indentation(GTK_TREE_VIEW(tree), 10);
142 /* Tooltips */
143 gtk_tree_view_set_tooltip_column(GTK_TREE_VIEW(tree), SYMBOLS_COLUMN_TOOLTIP);
145 /* selection handling */
146 selection = gtk_tree_view_get_selection(GTK_TREE_VIEW(tree));
147 gtk_tree_selection_set_mode(selection, GTK_SELECTION_SINGLE);
148 /* callback for changed selection not necessary, will be handled by button-press-event */
152 static gboolean
153 on_default_tag_tree_button_press_event(GtkWidget *widget, GdkEventButton *event,
154 gpointer user_data)
156 if (event->button == 3)
158 gtk_menu_popup(GTK_MENU(tv.popup_taglist), NULL, NULL, NULL, NULL,
159 event->button, event->time);
160 return TRUE;
162 return FALSE;
166 static void create_default_tag_tree(void)
168 GtkScrolledWindow *scrolled_window = GTK_SCROLLED_WINDOW(tag_window);
169 GtkWidget *label;
171 /* default_tag_tree is a GtkViewPort with a GtkLabel inside it */
172 tv.default_tag_tree = gtk_viewport_new(
173 gtk_scrolled_window_get_hadjustment(scrolled_window),
174 gtk_scrolled_window_get_vadjustment(scrolled_window));
175 label = gtk_label_new(_("No tags found"));
176 gtk_misc_set_alignment(GTK_MISC(label), 0.1f, 0.01f);
177 gtk_container_add(GTK_CONTAINER(tv.default_tag_tree), label);
178 gtk_widget_show_all(tv.default_tag_tree);
179 g_signal_connect(tv.default_tag_tree, "button-press-event",
180 G_CALLBACK(on_default_tag_tree_button_press_event), NULL);
181 g_object_ref((gpointer)tv.default_tag_tree); /* to hold it after removing */
185 /* update = rescan the tags for doc->filename */
186 void sidebar_update_tag_list(GeanyDocument *doc, gboolean update)
188 GtkWidget *child = gtk_bin_get_child(GTK_BIN(tag_window));
190 /* changes the tree view to the given one, trying not to do useless changes */
191 #define CHANGE_TREE(new_child) \
192 G_STMT_START { \
193 /* only change the tag tree if it's actually not the same (to avoid flickering) and if
194 * it's the one of the current document (to avoid problems when e.g. reloading
195 * configuration files */ \
196 if (child != new_child && doc == document_get_current()) \
198 if (child) \
199 gtk_container_remove(GTK_CONTAINER(tag_window), child); \
200 gtk_container_add(GTK_CONTAINER(tag_window), new_child); \
202 } G_STMT_END
204 if (tv.default_tag_tree == NULL)
205 create_default_tag_tree();
207 /* show default empty tag tree if there are no tags */
208 if (doc == NULL || doc->file_type == NULL || ! filetype_has_tags(doc->file_type))
210 CHANGE_TREE(tv.default_tag_tree);
211 return;
214 if (update)
215 { /* updating the tag list in the left tag window */
216 if (doc->priv->tag_tree == NULL)
218 doc->priv->tag_store = gtk_tree_store_new(
219 SYMBOLS_N_COLUMNS, GDK_TYPE_PIXBUF, G_TYPE_STRING, TM_TYPE_TAG, G_TYPE_STRING);
220 doc->priv->tag_tree = gtk_tree_view_new();
221 prepare_taglist(doc->priv->tag_tree, doc->priv->tag_store);
222 gtk_widget_show(doc->priv->tag_tree);
223 g_object_ref((gpointer)doc->priv->tag_tree); /* to hold it after removing */
226 doc->has_tags = symbols_recreate_tag_list(doc, SYMBOLS_SORT_USE_PREVIOUS);
229 if (doc->has_tags)
231 CHANGE_TREE(doc->priv->tag_tree);
233 else
235 CHANGE_TREE(tv.default_tag_tree);
238 #undef CHANGE_TREE
242 /* cleverly sorts documents by their short name */
243 static gint documents_sort_func(GtkTreeModel *model, GtkTreeIter *iter_a,
244 GtkTreeIter *iter_b, gpointer data)
246 gchar *key_a, *key_b;
247 gchar *name_a, *name_b;
248 gint cmp;
250 gtk_tree_model_get(model, iter_a, DOCUMENTS_SHORTNAME, &name_a, -1);
251 key_a = g_utf8_collate_key_for_filename(name_a, -1);
252 g_free(name_a);
253 gtk_tree_model_get(model, iter_b, DOCUMENTS_SHORTNAME, &name_b, -1);
254 key_b = g_utf8_collate_key_for_filename(name_b, -1);
255 g_free(name_b);
256 cmp = strcmp(key_a, key_b);
257 g_free(key_b);
258 g_free(key_a);
260 return cmp;
264 /* does some preparing things to the open files list widget */
265 static void prepare_openfiles(void)
267 GtkCellRenderer *icon_renderer;
268 GtkCellRenderer *text_renderer;
269 GtkTreeViewColumn *column;
270 GtkTreeSelection *selection;
271 GtkTreeSortable *sortable;
273 tv.tree_openfiles = ui_lookup_widget(main_widgets.window, "treeview6");
275 /* store the icon and the short filename to show, and the index as reference,
276 * the colour (black/red/green) and the full name for the tooltip */
277 store_openfiles = gtk_tree_store_new(5, GDK_TYPE_PIXBUF, G_TYPE_STRING,
278 G_TYPE_POINTER, GDK_TYPE_COLOR, G_TYPE_STRING);
279 gtk_tree_view_set_model(GTK_TREE_VIEW(tv.tree_openfiles), GTK_TREE_MODEL(store_openfiles));
281 /* set policy settings for the scolledwindow around the treeview again, because glade
282 * doesn't keep the settings */
283 gtk_scrolled_window_set_policy(
284 GTK_SCROLLED_WINDOW(ui_lookup_widget(main_widgets.window, "scrolledwindow7")),
285 GTK_POLICY_AUTOMATIC, GTK_POLICY_AUTOMATIC);
287 icon_renderer = gtk_cell_renderer_pixbuf_new();
288 text_renderer = gtk_cell_renderer_text_new();
289 g_object_set(text_renderer, "ellipsize", PANGO_ELLIPSIZE_MIDDLE, NULL);
290 column = gtk_tree_view_column_new();
291 gtk_tree_view_column_pack_start(column, icon_renderer, FALSE);
292 gtk_tree_view_column_set_attributes(column, icon_renderer, "pixbuf", DOCUMENTS_ICON, NULL);
293 gtk_tree_view_column_pack_start(column, text_renderer, TRUE);
294 gtk_tree_view_column_set_attributes(column, text_renderer, "text", DOCUMENTS_SHORTNAME,
295 "foreground-gdk", DOCUMENTS_COLOR, NULL);
296 gtk_tree_view_append_column(GTK_TREE_VIEW(tv.tree_openfiles), column);
297 gtk_tree_view_set_headers_visible(GTK_TREE_VIEW(tv.tree_openfiles), FALSE);
299 gtk_tree_view_set_search_column(GTK_TREE_VIEW(tv.tree_openfiles),
300 DOCUMENTS_SHORTNAME);
302 /* sort opened filenames in the store_openfiles treeview */
303 sortable = GTK_TREE_SORTABLE(GTK_TREE_MODEL(store_openfiles));
304 gtk_tree_sortable_set_sort_func(sortable, DOCUMENTS_SHORTNAME, documents_sort_func, NULL, NULL);
305 gtk_tree_sortable_set_sort_column_id(sortable, DOCUMENTS_SHORTNAME, GTK_SORT_ASCENDING);
307 ui_widget_modify_font_from_string(tv.tree_openfiles, interface_prefs.tagbar_font);
309 /* tooltips */
310 gtk_tree_view_set_tooltip_column(GTK_TREE_VIEW(tv.tree_openfiles), DOCUMENTS_FILENAME);
312 /* selection handling */
313 selection = gtk_tree_view_get_selection(GTK_TREE_VIEW(tv.tree_openfiles));
314 gtk_tree_selection_set_mode(selection, GTK_SELECTION_SINGLE);
315 g_object_unref(store_openfiles);
317 g_signal_connect(GTK_TREE_VIEW(tv.tree_openfiles), "button-press-event",
318 G_CALLBACK(sidebar_button_press_cb), NULL);
319 g_signal_connect(GTK_TREE_VIEW(tv.tree_openfiles), "key-press-event",
320 G_CALLBACK(sidebar_key_press_cb), NULL);
324 /* iter should be toplevel */
325 static gboolean find_tree_iter_dir(GtkTreeIter *iter, const gchar *dir)
327 GeanyDocument *doc;
328 gchar *name;
329 gboolean result;
331 if (utils_str_equal(dir, "."))
332 dir = GEANY_STRING_UNTITLED;
334 gtk_tree_model_get(GTK_TREE_MODEL(store_openfiles), iter, DOCUMENTS_DOCUMENT, &doc, -1);
335 g_return_val_if_fail(!doc, FALSE);
337 gtk_tree_model_get(GTK_TREE_MODEL(store_openfiles), iter, DOCUMENTS_SHORTNAME, &name, -1);
339 result = utils_filenamecmp(name, dir) == 0;
340 g_free(name);
342 return result;
346 static gboolean utils_filename_has_prefix(const gchar *str, const gchar *prefix)
348 gchar *head = g_strndup(str, strlen(prefix));
349 gboolean ret = utils_filenamecmp(head, prefix) == 0;
351 g_free(head);
352 return ret;
356 static gchar *get_doc_folder(const gchar *path)
358 gchar *tmp_dirname = g_strdup(path);
359 gchar *project_base_path;
360 gchar *dirname = NULL;
361 const gchar *home_dir = g_get_home_dir();
362 const gchar *rest;
364 /* replace the project base path with the project name */
365 project_base_path = project_get_base_path();
367 if (project_base_path != NULL)
369 gsize len = strlen(project_base_path);
371 /* remove trailing separator so we can match base path exactly */
372 if (project_base_path[len-1] == G_DIR_SEPARATOR)
373 project_base_path[--len] = '\0';
375 /* check whether the dir name matches or uses the project base path */
376 if (utils_filename_has_prefix(tmp_dirname, project_base_path))
378 rest = tmp_dirname + len;
379 if (*rest == G_DIR_SEPARATOR || *rest == '\0')
381 dirname = g_strdup_printf("%s%s", app->project->name, rest);
384 g_free(project_base_path);
386 if (dirname == NULL)
388 dirname = tmp_dirname;
390 /* If matches home dir, replace with tilde */
391 if (!EMPTY(home_dir) && utils_filename_has_prefix(dirname, home_dir))
393 rest = dirname + strlen(home_dir);
394 if (*rest == G_DIR_SEPARATOR || *rest == '\0')
396 dirname = g_strdup_printf("~%s", rest);
397 g_free(tmp_dirname);
401 else
402 g_free(tmp_dirname);
404 return dirname;
408 static GtkTreeIter *get_doc_parent(GeanyDocument *doc)
410 gchar *path;
411 gchar *dirname = NULL;
412 static GtkTreeIter parent;
413 GtkTreeModel *model = GTK_TREE_MODEL(store_openfiles);
414 static GdkPixbuf *dir_icon = NULL;
416 if (!documents_show_paths)
417 return NULL;
419 path = g_path_get_dirname(DOC_FILENAME(doc));
420 dirname = get_doc_folder(path);
422 if (gtk_tree_model_get_iter_first(model, &parent))
426 if (find_tree_iter_dir(&parent, dirname))
428 g_free(dirname);
429 g_free(path);
430 return &parent;
433 while (gtk_tree_model_iter_next(model, &parent));
435 /* no match, add dir parent */
436 if (!dir_icon)
437 dir_icon = ui_get_mime_icon("inode/directory", GTK_ICON_SIZE_MENU);
439 gtk_tree_store_append(store_openfiles, &parent, NULL);
440 gtk_tree_store_set(store_openfiles, &parent, DOCUMENTS_ICON, dir_icon,
441 DOCUMENTS_FILENAME, path,
442 DOCUMENTS_SHORTNAME, doc->file_name ? dirname : GEANY_STRING_UNTITLED, -1);
444 g_free(dirname);
445 g_free(path);
446 return &parent;
450 /* Also sets doc->priv->iter.
451 * This is called recursively in sidebar_openfiles_update_all(). */
452 void sidebar_openfiles_add(GeanyDocument *doc)
454 GtkTreeIter *iter = &doc->priv->iter;
455 GtkTreeIter *parent = get_doc_parent(doc);
456 gchar *basename;
457 const GdkColor *color = document_get_status_color(doc);
458 static GdkPixbuf *file_icon = NULL;
460 gtk_tree_store_append(store_openfiles, iter, parent);
462 /* check if new parent */
463 if (parent && gtk_tree_model_iter_n_children(GTK_TREE_MODEL(store_openfiles), parent) == 1)
465 GtkTreePath *path;
467 /* expand parent */
468 path = gtk_tree_model_get_path(GTK_TREE_MODEL(store_openfiles), parent);
469 gtk_tree_view_expand_row(GTK_TREE_VIEW(tv.tree_openfiles), path, TRUE);
470 gtk_tree_path_free(path);
472 if (!file_icon)
473 file_icon = ui_get_mime_icon("text/plain", GTK_ICON_SIZE_MENU);
475 basename = g_path_get_basename(DOC_FILENAME(doc));
476 gtk_tree_store_set(store_openfiles, iter,
477 DOCUMENTS_ICON, (doc->file_type && doc->file_type->icon) ? doc->file_type->icon : file_icon,
478 DOCUMENTS_SHORTNAME, basename, DOCUMENTS_DOCUMENT, doc, DOCUMENTS_COLOR, color,
479 DOCUMENTS_FILENAME, DOC_FILENAME(doc), -1);
480 g_free(basename);
484 static void openfiles_remove(GeanyDocument *doc)
486 GtkTreeIter *iter = &doc->priv->iter;
487 GtkTreeIter parent;
489 if (gtk_tree_model_iter_parent(GTK_TREE_MODEL(store_openfiles), &parent, iter) &&
490 gtk_tree_model_iter_n_children(GTK_TREE_MODEL(store_openfiles), &parent) == 1)
491 gtk_tree_store_remove(store_openfiles, &parent);
492 else
493 gtk_tree_store_remove(store_openfiles, iter);
497 void sidebar_openfiles_update(GeanyDocument *doc)
499 GtkTreeIter *iter = &doc->priv->iter;
500 gchar *fname;
502 gtk_tree_model_get(GTK_TREE_MODEL(store_openfiles), iter, DOCUMENTS_FILENAME, &fname, -1);
504 if (utils_str_equal(fname, DOC_FILENAME(doc)))
506 /* just update color and the icon */
507 const GdkColor *color = document_get_status_color(doc);
508 GdkPixbuf *icon = doc->file_type->icon;
510 gtk_tree_store_set(store_openfiles, iter, DOCUMENTS_COLOR, color, -1);
511 if (icon)
512 gtk_tree_store_set(store_openfiles, iter, DOCUMENTS_ICON, icon, -1);
514 else
516 /* path has changed, so remove and re-add */
517 GtkTreeSelection *treesel;
518 gboolean sel;
520 treesel = gtk_tree_view_get_selection(GTK_TREE_VIEW(tv.tree_openfiles));
521 sel = gtk_tree_selection_iter_is_selected(treesel, &doc->priv->iter);
522 openfiles_remove(doc);
524 sidebar_openfiles_add(doc);
525 if (sel)
526 gtk_tree_selection_select_iter(treesel, &doc->priv->iter);
528 g_free(fname);
532 void sidebar_openfiles_update_all()
534 guint i;
536 gtk_tree_store_clear(store_openfiles);
537 foreach_document (i)
539 sidebar_openfiles_add(documents[i]);
544 void sidebar_remove_document(GeanyDocument *doc)
546 openfiles_remove(doc);
548 if (GTK_IS_WIDGET(doc->priv->tag_tree))
550 gtk_widget_destroy(doc->priv->tag_tree); /* make GTK release its references, if any */
551 /* Because it was ref'd in sidebar_update_tag_list, it needs unref'ing */
552 g_object_unref(doc->priv->tag_tree);
553 doc->priv->tag_tree = NULL;
558 static void on_hide_sidebar(void)
560 ui_prefs.sidebar_visible = FALSE;
561 ui_sidebar_show_hide();
565 static gboolean on_sidebar_display_symbol_list_show(GtkWidget *item)
567 gtk_check_menu_item_set_active(GTK_CHECK_MENU_ITEM(item),
568 interface_prefs.sidebar_symbol_visible);
569 return FALSE;
573 static gboolean on_sidebar_display_open_files_show(GtkWidget *item)
575 gtk_check_menu_item_set_active(GTK_CHECK_MENU_ITEM(item),
576 interface_prefs.sidebar_openfiles_visible);
577 return FALSE;
581 void sidebar_add_common_menu_items(GtkMenu *menu)
583 GtkWidget *item;
585 item = gtk_separator_menu_item_new();
586 gtk_widget_show(item);
587 gtk_container_add(GTK_CONTAINER(menu), item);
589 item = gtk_check_menu_item_new_with_mnemonic(_("Show S_ymbol List"));
590 gtk_container_add(GTK_CONTAINER(menu), item);
591 #if GTK_CHECK_VERSION(3, 0, 0)
592 g_signal_connect(item, "draw", G_CALLBACK(on_sidebar_display_symbol_list_show), NULL);
593 #else
594 g_signal_connect(item, "expose-event",
595 G_CALLBACK(on_sidebar_display_symbol_list_show), NULL);
596 #endif
597 gtk_widget_show(item);
598 g_signal_connect(item, "activate",
599 G_CALLBACK(on_list_symbol_activate), NULL);
601 item = gtk_check_menu_item_new_with_mnemonic(_("Show _Document List"));
602 gtk_container_add(GTK_CONTAINER(menu), item);
603 #if GTK_CHECK_VERSION(3, 0, 0)
604 g_signal_connect(item, "draw", G_CALLBACK(on_sidebar_display_open_files_show), NULL);
605 #else
606 g_signal_connect(item, "expose-event",
607 G_CALLBACK(on_sidebar_display_open_files_show), NULL);
608 #endif
609 gtk_widget_show(item);
610 g_signal_connect(item, "activate",
611 G_CALLBACK(on_list_document_activate), NULL);
613 item = gtk_image_menu_item_new_with_mnemonic(_("H_ide Sidebar"));
614 gtk_image_menu_item_set_image(GTK_IMAGE_MENU_ITEM(item),
615 gtk_image_new_from_stock(GTK_STOCK_CLOSE, GTK_ICON_SIZE_MENU));
616 gtk_widget_show(item);
617 gtk_container_add(GTK_CONTAINER(menu), item);
618 g_signal_connect(item, "activate", G_CALLBACK(on_hide_sidebar), NULL);
622 static void on_openfiles_show_paths_activate(GtkCheckMenuItem *item, gpointer user_data)
624 documents_show_paths = gtk_check_menu_item_get_active(item);
625 sidebar_openfiles_update_all();
629 static void on_list_document_activate(GtkCheckMenuItem *item, gpointer user_data)
631 interface_prefs.sidebar_openfiles_visible = gtk_check_menu_item_get_active(item);
632 ui_sidebar_show_hide();
633 sidebar_tabs_show_hide(GTK_NOTEBOOK(main_widgets.sidebar_notebook), NULL, 0, NULL);
637 static void on_list_symbol_activate(GtkCheckMenuItem *item, gpointer user_data)
639 interface_prefs.sidebar_symbol_visible = gtk_check_menu_item_get_active(item);
640 ui_sidebar_show_hide();
641 sidebar_tabs_show_hide(GTK_NOTEBOOK(main_widgets.sidebar_notebook), NULL, 0, NULL);
645 static void on_find_in_files(GtkMenuItem *menuitem, gpointer user_data)
647 GtkTreeSelection *treesel;
648 GtkTreeIter iter;
649 GtkTreeModel *model;
650 GeanyDocument *doc;
651 gchar *dir;
653 treesel = gtk_tree_view_get_selection(GTK_TREE_VIEW(tv.tree_openfiles));
654 if (!gtk_tree_selection_get_selected(treesel, &model, &iter))
655 return;
656 gtk_tree_model_get(model, &iter, DOCUMENTS_DOCUMENT, &doc, -1);
658 if (!doc)
660 gtk_tree_model_get(model, &iter, DOCUMENTS_FILENAME, &dir, -1);
662 else
663 dir = g_path_get_dirname(DOC_FILENAME(doc));
665 search_show_find_in_files_dialog(dir);
666 g_free(dir);
670 static void on_openfiles_expand_collapse(GtkMenuItem *menuitem, gpointer user_data)
672 gboolean expand = GPOINTER_TO_INT(user_data);
674 if (expand)
675 gtk_tree_view_expand_all(GTK_TREE_VIEW(tv.tree_openfiles));
676 else
677 gtk_tree_view_collapse_all(GTK_TREE_VIEW(tv.tree_openfiles));
681 static void create_openfiles_popup_menu(void)
683 GtkWidget *item;
685 openfiles_popup_menu = gtk_menu_new();
687 item = gtk_image_menu_item_new_from_stock(GTK_STOCK_CLOSE, NULL);
688 gtk_widget_show(item);
689 gtk_container_add(GTK_CONTAINER(openfiles_popup_menu), item);
690 g_signal_connect(item, "activate",
691 G_CALLBACK(on_openfiles_document_action), GINT_TO_POINTER(OPENFILES_ACTION_REMOVE));
692 doc_items.close = item;
694 item = gtk_separator_menu_item_new();
695 gtk_widget_show(item);
696 gtk_container_add(GTK_CONTAINER(openfiles_popup_menu), item);
698 item = gtk_image_menu_item_new_from_stock(GTK_STOCK_SAVE, NULL);
699 gtk_widget_show(item);
700 gtk_container_add(GTK_CONTAINER(openfiles_popup_menu), item);
701 g_signal_connect(item, "activate",
702 G_CALLBACK(on_openfiles_document_action), GINT_TO_POINTER(OPENFILES_ACTION_SAVE));
703 doc_items.save = item;
705 item = gtk_image_menu_item_new_with_mnemonic(_("_Reload"));
706 gtk_image_menu_item_set_image(GTK_IMAGE_MENU_ITEM(item),
707 gtk_image_new_from_stock(GTK_STOCK_REVERT_TO_SAVED, GTK_ICON_SIZE_MENU));
708 gtk_widget_show(item);
709 gtk_container_add(GTK_CONTAINER(openfiles_popup_menu), item);
710 g_signal_connect(item, "activate",
711 G_CALLBACK(on_openfiles_document_action), GINT_TO_POINTER(OPENFILES_ACTION_RELOAD));
712 doc_items.reload = item;
714 item = gtk_separator_menu_item_new();
715 gtk_widget_show(item);
716 gtk_container_add(GTK_CONTAINER(openfiles_popup_menu), item);
718 item = ui_image_menu_item_new(GTK_STOCK_FIND, _("_Find in Files..."));
719 gtk_widget_show(item);
720 gtk_container_add(GTK_CONTAINER(openfiles_popup_menu), item);
721 g_signal_connect(item, "activate", G_CALLBACK(on_find_in_files), NULL);
722 doc_items.find_in_files = item;
724 item = gtk_separator_menu_item_new();
725 gtk_widget_show(item);
726 gtk_container_add(GTK_CONTAINER(openfiles_popup_menu), item);
728 doc_items.show_paths = gtk_check_menu_item_new_with_mnemonic(_("Show _Paths"));
729 gtk_check_menu_item_set_active(GTK_CHECK_MENU_ITEM(doc_items.show_paths), documents_show_paths);
730 gtk_widget_show(doc_items.show_paths);
731 gtk_container_add(GTK_CONTAINER(openfiles_popup_menu), doc_items.show_paths);
732 g_signal_connect(doc_items.show_paths, "activate",
733 G_CALLBACK(on_openfiles_show_paths_activate), NULL);
735 item = gtk_separator_menu_item_new();
736 gtk_widget_show(item);
737 gtk_container_add(GTK_CONTAINER(openfiles_popup_menu), item);
739 doc_items.expand_all = ui_image_menu_item_new(GTK_STOCK_ADD, _("_Expand All"));
740 gtk_widget_show(doc_items.expand_all);
741 gtk_container_add(GTK_CONTAINER(openfiles_popup_menu), doc_items.expand_all);
742 g_signal_connect(doc_items.expand_all, "activate",
743 G_CALLBACK(on_openfiles_expand_collapse), GINT_TO_POINTER(TRUE));
745 doc_items.collapse_all = ui_image_menu_item_new(GTK_STOCK_REMOVE, _("_Collapse All"));
746 gtk_widget_show(doc_items.collapse_all);
747 gtk_container_add(GTK_CONTAINER(openfiles_popup_menu), doc_items.collapse_all);
748 g_signal_connect(doc_items.collapse_all, "activate",
749 G_CALLBACK(on_openfiles_expand_collapse), GINT_TO_POINTER(FALSE));
751 sidebar_add_common_menu_items(GTK_MENU(openfiles_popup_menu));
755 static void unfold_parent(GtkTreeIter *iter)
757 GtkTreeIter parent;
758 GtkTreePath *path;
760 if (gtk_tree_model_iter_parent(GTK_TREE_MODEL(store_openfiles), &parent, iter))
762 path = gtk_tree_model_get_path(GTK_TREE_MODEL(store_openfiles), &parent);
763 gtk_tree_view_expand_row(GTK_TREE_VIEW(tv.tree_openfiles), path, TRUE);
764 gtk_tree_path_free(path);
769 /* compares the given data with the doc pointer from the selected row of openfiles
770 * treeview, in case of a match the row is selected and TRUE is returned
771 * (called indirectly from gtk_tree_model_foreach()) */
772 static gboolean tree_model_find_node(GtkTreeModel *model, GtkTreePath *path,
773 GtkTreeIter *iter, gpointer data)
775 GeanyDocument *doc;
777 gtk_tree_model_get(GTK_TREE_MODEL(store_openfiles), iter, DOCUMENTS_DOCUMENT, &doc, -1);
779 if (doc == data)
781 /* unfolding also prevents a strange bug where the selection gets stuck on the parent
782 * when it is collapsed and then switching documents */
783 unfold_parent(iter);
784 gtk_tree_view_set_cursor(GTK_TREE_VIEW(tv.tree_openfiles), path, NULL, FALSE);
785 return TRUE;
787 else return FALSE;
791 void sidebar_select_openfiles_item(GeanyDocument *doc)
793 gtk_tree_model_foreach(GTK_TREE_MODEL(store_openfiles), tree_model_find_node, doc);
797 /* callbacks */
799 static void document_action(GeanyDocument *doc, gint action)
801 if (! DOC_VALID(doc))
802 return;
804 switch (action)
806 case OPENFILES_ACTION_REMOVE:
808 document_close(doc);
809 break;
811 case OPENFILES_ACTION_SAVE:
813 document_save_file(doc, FALSE);
814 break;
816 case OPENFILES_ACTION_RELOAD:
818 on_toolbutton_reload_clicked(NULL, NULL);
819 break;
825 static void on_openfiles_document_action(GtkMenuItem *menuitem, gpointer user_data)
827 GtkTreeIter iter;
828 GtkTreeSelection *selection = gtk_tree_view_get_selection(GTK_TREE_VIEW(tv.tree_openfiles));
829 GtkTreeModel *model;
830 GeanyDocument *doc;
831 gint action = GPOINTER_TO_INT(user_data);
833 if (gtk_tree_selection_get_selected(selection, &model, &iter))
835 gtk_tree_model_get(model, &iter, DOCUMENTS_DOCUMENT, &doc, -1);
836 if (doc)
838 document_action(doc, action);
840 else
842 /* parent item selected */
843 GtkTreeIter child;
844 gint i = gtk_tree_model_iter_n_children(model, &iter) - 1;
846 while (i >= 0 && gtk_tree_model_iter_nth_child(model, &child, &iter, i))
848 gtk_tree_model_get(model, &child, DOCUMENTS_DOCUMENT, &doc, -1);
850 document_action(doc, action);
851 i--;
858 static void change_focus_to_editor(GeanyDocument *doc, GtkWidget *source_widget)
860 if (may_steal_focus)
861 document_try_focus(doc, source_widget);
862 may_steal_focus = FALSE;
866 static gboolean openfiles_go_to_selection(GtkTreeSelection *selection, guint keyval)
868 GtkTreeIter iter;
869 GtkTreeModel *model;
870 GeanyDocument *doc = NULL;
872 /* use switch_notebook_page to ignore changing the notebook page because it is already done */
873 if (gtk_tree_selection_get_selected(selection, &model, &iter) && ! ignore_callback)
875 gtk_tree_model_get(model, &iter, DOCUMENTS_DOCUMENT, &doc, -1);
876 if (! doc)
877 return FALSE; /* parent */
879 /* switch to the doc and grab the focus */
880 document_show_tab(doc);
881 if (keyval != GDK_space)
882 change_focus_to_editor(doc, tv.tree_openfiles);
884 return FALSE;
888 static gboolean taglist_go_to_selection(GtkTreeSelection *selection, guint keyval, guint state)
890 GtkTreeIter iter;
891 GtkTreeModel *model;
892 gint line = 0;
893 gboolean handled = TRUE;
895 if (gtk_tree_selection_get_selected(selection, &model, &iter))
897 TMTag *tag;
899 gtk_tree_model_get(model, &iter, SYMBOLS_COLUMN_TAG, &tag, -1);
900 if (! tag)
901 return FALSE;
903 line = tag->atts.entry.line;
904 if (line > 0)
906 GeanyDocument *doc = document_get_current();
908 if (doc != NULL)
910 navqueue_goto_line(doc, doc, line);
911 if (keyval != GDK_space && ! (state & GDK_CONTROL_MASK))
912 change_focus_to_editor(doc, NULL);
913 else
914 handled = FALSE;
917 tm_tag_unref(tag);
919 return handled;
923 static gboolean sidebar_key_press_cb(GtkWidget *widget, GdkEventKey *event,
924 gpointer user_data)
926 may_steal_focus = FALSE;
927 if (ui_is_keyval_enter_or_return(event->keyval) || event->keyval == GDK_space)
929 GtkWidgetClass *widget_class = GTK_WIDGET_GET_CLASS(widget);
930 GtkTreeSelection *selection = gtk_tree_view_get_selection(GTK_TREE_VIEW(widget));
931 may_steal_focus = TRUE;
933 /* force the TreeView handler to run before us for it to do its job (selection & stuff).
934 * doing so will prevent further handlers to be run in most cases, but the only one is our
935 * own, so guess it's fine. */
936 if (widget_class->key_press_event)
937 widget_class->key_press_event(widget, event);
939 if (widget == tv.tree_openfiles) /* tag and doc list have separate handlers */
940 openfiles_go_to_selection(selection, event->keyval);
941 else
942 taglist_go_to_selection(selection, event->keyval, event->state);
944 return TRUE;
946 return FALSE;
950 static gboolean sidebar_button_press_cb(GtkWidget *widget, GdkEventButton *event,
951 G_GNUC_UNUSED gpointer user_data)
953 GtkTreeSelection *selection;
954 GtkWidgetClass *widget_class = GTK_WIDGET_GET_CLASS(widget);
955 gboolean handled = FALSE;
957 /* force the TreeView handler to run before us for it to do its job (selection & stuff).
958 * doing so will prevent further handlers to be run in most cases, but the only one is our own,
959 * so guess it's fine. */
960 if (widget_class->button_press_event)
961 handled = widget_class->button_press_event(widget, event);
963 selection = gtk_tree_view_get_selection(GTK_TREE_VIEW(widget));
964 may_steal_focus = TRUE;
966 if (event->type == GDK_2BUTTON_PRESS)
967 { /* double click on parent node(section) expands/collapses it */
968 GtkTreeModel *model;
969 GtkTreeIter iter;
971 if (gtk_tree_selection_get_selected(selection, &model, &iter))
973 if (gtk_tree_model_iter_has_child(model, &iter))
975 GtkTreePath *path = gtk_tree_model_get_path(model, &iter);
977 if (gtk_tree_view_row_expanded(GTK_TREE_VIEW(widget), path))
978 gtk_tree_view_collapse_row(GTK_TREE_VIEW(widget), path);
979 else
980 gtk_tree_view_expand_row(GTK_TREE_VIEW(widget), path, FALSE);
982 gtk_tree_path_free(path);
983 return TRUE;
987 else if (event->button == 1)
988 { /* allow reclicking of taglist treeview item */
989 if (widget == tv.tree_openfiles)
991 openfiles_go_to_selection(selection, 0);
992 handled = TRUE;
994 else
995 handled = taglist_go_to_selection(selection, 0, event->state);
997 else if (event->button == 3)
999 if (widget == tv.tree_openfiles)
1001 if (!openfiles_popup_menu)
1002 create_openfiles_popup_menu();
1004 /* update menu item sensitivity */
1005 documents_menu_update(selection);
1006 gtk_menu_popup(GTK_MENU(openfiles_popup_menu), NULL, NULL, NULL, NULL,
1007 event->button, event->time);
1009 else
1011 gtk_menu_popup(GTK_MENU(tv.popup_taglist), NULL, NULL, NULL, NULL,
1012 event->button, event->time);
1014 handled = TRUE;
1016 return handled;
1020 static void documents_menu_update(GtkTreeSelection *selection)
1022 GtkTreeModel *model;
1023 GtkTreeIter iter;
1024 gboolean sel, path;
1025 gchar *shortname = NULL;
1026 GeanyDocument *doc = NULL;
1028 /* maybe no selection e.g. if ctrl-click deselected */
1029 sel = gtk_tree_selection_get_selected(selection, &model, &iter);
1030 if (sel)
1032 gtk_tree_model_get(model, &iter, DOCUMENTS_DOCUMENT, &doc,
1033 DOCUMENTS_SHORTNAME, &shortname, -1);
1035 path = !EMPTY(shortname) &&
1036 (g_path_is_absolute(shortname) ||
1037 (app->project && g_str_has_prefix(shortname, app->project->name)));
1039 /* can close all, save all (except shortname), but only reload individually ATM */
1040 gtk_widget_set_sensitive(doc_items.close, sel);
1041 gtk_widget_set_sensitive(doc_items.save, (doc && doc->real_path) || path);
1042 gtk_widget_set_sensitive(doc_items.reload, doc && doc->real_path);
1043 gtk_widget_set_sensitive(doc_items.find_in_files, sel);
1044 g_free(shortname);
1046 gtk_check_menu_item_set_active(GTK_CHECK_MENU_ITEM(doc_items.show_paths), documents_show_paths);
1047 gtk_widget_set_sensitive(doc_items.expand_all, documents_show_paths);
1048 gtk_widget_set_sensitive(doc_items.collapse_all, documents_show_paths);
1052 static StashGroup *stash_group = NULL;
1054 static void on_load_settings(void)
1056 tag_window = ui_lookup_widget(main_widgets.window, "scrolledwindow2");
1058 prepare_openfiles();
1059 /* note: ui_prefs.sidebar_page is reapplied after plugins are loaded */
1060 stash_group_display(stash_group, NULL);
1061 sidebar_tabs_show_hide(GTK_NOTEBOOK(main_widgets.sidebar_notebook), NULL, 0, NULL);
1065 static void on_save_settings(void)
1067 stash_group_update(stash_group, NULL);
1068 sidebar_tabs_show_hide(GTK_NOTEBOOK(main_widgets.sidebar_notebook), NULL, 0, NULL);
1072 void sidebar_init(void)
1074 StashGroup *group;
1076 group = stash_group_new(PACKAGE);
1077 stash_group_add_boolean(group, &documents_show_paths, "documents_show_paths", TRUE);
1078 stash_group_add_widget_property(group, &ui_prefs.sidebar_page, "sidebar_page", GINT_TO_POINTER(0),
1079 main_widgets.sidebar_notebook, "page", 0);
1080 configuration_add_pref_group(group, FALSE);
1081 stash_group = group;
1083 /* delay building documents treeview until sidebar font has been read */
1084 g_signal_connect(geany_object, "load-settings", on_load_settings, NULL);
1085 g_signal_connect(geany_object, "save-settings", on_save_settings, NULL);
1087 g_signal_connect(main_widgets.sidebar_notebook, "page-added",
1088 G_CALLBACK(sidebar_tabs_show_hide), NULL);
1089 g_signal_connect(main_widgets.sidebar_notebook, "page-removed",
1090 G_CALLBACK(sidebar_tabs_show_hide), NULL);
1091 /* tabs may have changed when sidebar is reshown */
1092 g_signal_connect(main_widgets.sidebar_notebook, "show",
1093 G_CALLBACK(sidebar_tabs_show_hide), NULL);
1095 sidebar_tabs_show_hide(GTK_NOTEBOOK(main_widgets.sidebar_notebook), NULL, 0, NULL);
1098 #define WIDGET(w) w && GTK_IS_WIDGET(w)
1100 void sidebar_finalize(void)
1102 if (WIDGET(tv.default_tag_tree))
1104 gtk_widget_destroy(tv.default_tag_tree); /* make GTK release its references, if any... */
1105 g_object_unref(tv.default_tag_tree); /* ...and release our own */
1107 if (WIDGET(tv.popup_taglist))
1108 gtk_widget_destroy(tv.popup_taglist);
1109 if (WIDGET(openfiles_popup_menu))
1110 gtk_widget_destroy(openfiles_popup_menu);
1114 void sidebar_focus_openfiles_tab(void)
1116 if (ui_prefs.sidebar_visible && interface_prefs.sidebar_openfiles_visible)
1118 GtkNotebook *notebook = GTK_NOTEBOOK(main_widgets.sidebar_notebook);
1120 gtk_notebook_set_current_page(notebook, TREEVIEW_OPENFILES);
1121 gtk_widget_grab_focus(tv.tree_openfiles);
1126 void sidebar_focus_symbols_tab(void)
1128 if (ui_prefs.sidebar_visible && interface_prefs.sidebar_symbol_visible)
1130 GtkNotebook *notebook = GTK_NOTEBOOK(main_widgets.sidebar_notebook);
1131 GtkWidget *symbol_list_scrollwin = gtk_notebook_get_nth_page(notebook, TREEVIEW_SYMBOL);
1133 gtk_notebook_set_current_page(notebook, TREEVIEW_SYMBOL);
1134 gtk_widget_grab_focus(gtk_bin_get_child(GTK_BIN(symbol_list_scrollwin)));
1139 static void sidebar_tabs_show_hide(GtkNotebook *notebook, GtkWidget *child,
1140 guint page_num, gpointer data)
1142 gint tabs = gtk_notebook_get_n_pages(notebook);
1144 if (interface_prefs.sidebar_symbol_visible == FALSE)
1145 tabs--;
1146 if (interface_prefs.sidebar_openfiles_visible == FALSE)
1147 tabs--;
1149 gtk_notebook_set_show_tabs(notebook, (tabs > 1));