"Fix" passing const arguments to spawn functions
[geany-mirror.git] / src / symbols.c
blob567a9f62ca557a860d4af6c108a7f5f0d1be0a68
1 /*
2 * symbols.c - this file is part of Geany, a fast and lightweight IDE
4 * Copyright 2006 The Geany contributors
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License along
17 * with this program; if not, write to the Free Software Foundation, Inc.,
18 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
21 /**
22 * @file symbols.h
23 * Tag-related functions.
24 **/
27 * Symbol Tree and TagManager-related convenience functions.
28 * TagManager parses tags for each document, and also adds them to the workspace (session).
29 * Global tags are lists of tags for each filetype, loaded when a document with a
30 * matching filetype is first loaded.
33 #ifdef HAVE_CONFIG_H
34 # include "config.h"
35 #endif
37 #include "symbols.h"
39 #include "app.h"
40 #include "callbacks.h" /* FIXME: for ignore_callback */
41 #include "documentprivate.h"
42 #include "editor.h"
43 #include "encodings.h"
44 #include "filetypesprivate.h"
45 #include "geanyobject.h"
46 #include "highlighting.h"
47 #include "main.h"
48 #include "navqueue.h"
49 #include "sciwrappers.h"
50 #include "sidebar.h"
51 #include "support.h"
52 #include "tm_parser.h"
53 #include "tm_tag.h"
54 #include "tm_ctags.h"
55 #include "ui_utils.h"
56 #include "utils.h"
58 #include "SciLexer.h"
60 #include <ctype.h>
61 #include <string.h>
62 #include <stdlib.h>
63 #include <gtk/gtk.h>
66 typedef struct
68 gint found_line; /* return: the nearest line found */
69 gint line; /* input: the line to look for */
70 gboolean lower /* input: search only for lines with lower number than @line */;
71 } TreeSearchData;
74 static GPtrArray *top_level_iter_names = NULL;
77 static struct
79 const gchar *icon_name;
80 GdkPixbuf *pixbuf;
82 /* keep in sync with enum in tm_parser.h */
83 symbols_icons[TM_N_ICONS] = {
84 [TM_ICON_CLASS] = { "classviewer-class", NULL },
85 [TM_ICON_MACRO] = { "classviewer-macro", NULL },
86 [TM_ICON_MEMBER] = { "classviewer-member", NULL },
87 [TM_ICON_METHOD] = { "classviewer-method", NULL },
88 [TM_ICON_NAMESPACE] = { "classviewer-namespace", NULL },
89 [TM_ICON_OTHER] = { "classviewer-other", NULL },
90 [TM_ICON_STRUCT] = { "classviewer-struct", NULL },
91 [TM_ICON_VAR] = { "classviewer-var", NULL },
94 static struct
96 GtkWidget *expand_all;
97 GtkWidget *collapse_all;
98 GtkWidget *sort_by_name;
99 GtkWidget *sort_by_appearance;
100 GtkWidget *find_usage;
101 GtkWidget *find_doc_usage;
102 GtkWidget *find_in_files;
103 GtkWidget *group_by_type;
105 symbol_menu;
107 static void load_user_tags(GeanyFiletypeID ft_id);
109 /* get the tags_ignore list, exported by geany_lcpp.c */
110 extern gchar **c_tags_ignore;
112 /* ignore certain tokens when parsing C-like syntax.
113 * Also works for reloading. */
114 static void load_c_ignore_tags(void)
116 gchar *path = g_build_filename(app->configdir, "ignore.tags", NULL);
117 gchar *content;
119 if (g_file_get_contents(path, &content, NULL, NULL))
121 gchar **line;
123 /* historically we ignore the glib _DECLS for tag generation */
124 SETPTR(content, g_strconcat("G_BEGIN_DECLS G_END_DECLS\n", content, NULL));
126 g_strfreev(c_tags_ignore);
127 tm_ctags_clear_ignore_symbols();
129 /* for old c.c parser */
130 c_tags_ignore = g_strsplit_set(content, " \n\r", -1);
131 /* for new cxx parser */
132 foreach_strv(line, c_tags_ignore)
134 tm_ctags_add_ignore_symbol(*line);
137 g_free(content);
139 g_free(path);
143 void symbols_reload_config_files(void)
145 load_c_ignore_tags();
149 static gsize get_tag_count(void)
151 GPtrArray *tags = tm_get_workspace()->global_tags;
152 gsize count = tags ? tags->len : 0;
154 return count;
158 /* wrapper for tm_workspace_load_global_tags().
159 * note that the tag count only counts new global tags added - if a tag has the same name,
160 * currently it replaces the existing tag, so loading a file twice will say 0 tags the 2nd time. */
161 static gboolean symbols_load_global_tags(const gchar *tags_file, GeanyFiletype *ft)
163 gboolean result;
164 gsize old_tag_count = get_tag_count();
166 result = tm_workspace_load_global_tags(tags_file, ft->lang);
167 if (result)
169 geany_debug("Loaded %s (%s), %u symbol(s).", tags_file, ft->name,
170 (guint) (get_tag_count() - old_tag_count));
172 return result;
176 /* Ensure that the global tags file(s) for the file_type_idx filetype is loaded.
177 * This provides autocompletion, calltips, etc. */
178 void symbols_global_tags_loaded(guint file_type_idx)
180 /* load ignore list for C/C++ parser */
181 if ((file_type_idx == GEANY_FILETYPES_C || file_type_idx == GEANY_FILETYPES_CPP) &&
182 c_tags_ignore == NULL)
184 load_c_ignore_tags();
187 if (cl_options.ignore_global_tags || app->tm_workspace == NULL)
188 return;
190 /* load config in case of custom filetypes */
191 filetypes_load_config(file_type_idx, FALSE);
193 load_user_tags(file_type_idx);
195 switch (file_type_idx)
197 case GEANY_FILETYPES_CPP:
198 symbols_global_tags_loaded(GEANY_FILETYPES_C); /* load C global tags */
199 break;
200 case GEANY_FILETYPES_PHP:
201 symbols_global_tags_loaded(GEANY_FILETYPES_HTML); /* load HTML global tags */
202 break;
207 GString *symbols_find_typenames_as_string(TMParserType lang, gboolean global)
209 guint j;
210 TMTag *tag;
211 GString *s = NULL;
212 GPtrArray *typedefs;
213 TMParserType tag_lang;
215 if (global)
216 typedefs = app->tm_workspace->global_typename_array;
217 else
218 typedefs = app->tm_workspace->typename_array;
220 if ((typedefs) && (typedefs->len > 0))
222 const gchar *last_name = "";
224 s = g_string_sized_new(typedefs->len * 10);
225 for (j = 0; j < typedefs->len; ++j)
227 tag = TM_TAG(typedefs->pdata[j]);
228 tag_lang = tag->lang;
230 if (tag->name && tm_parser_langs_compatible(lang, tag_lang) &&
231 strcmp(tag->name, last_name) != 0)
233 if (j != 0)
234 g_string_append_c(s, ' ');
235 g_string_append(s, tag->name);
236 last_name = tag->name;
240 return s;
244 /** Gets the context separator used by the tag manager for a particular file
245 * type.
246 * @param ft_id File type identifier.
247 * @return The context separator string.
249 * Returns non-printing sequence "\x03" ie ETX (end of text) for filetypes
250 * without a context separator.
252 * @since 0.19
254 GEANY_API_SYMBOL
255 const gchar *symbols_get_context_separator(gint ft_id)
257 return tm_parser_scope_separator(filetypes[ft_id]->lang);
261 /* sort by name, then line */
262 static gint compare_symbol(const TMTag *tag_a, const TMTag *tag_b)
264 gint ret;
266 if (tag_a == NULL || tag_b == NULL)
267 return 0;
269 if (tag_a->name == NULL)
270 return -(tag_a->name != tag_b->name);
272 if (tag_b->name == NULL)
273 return tag_a->name != tag_b->name;
275 ret = strcmp(tag_a->name, tag_b->name);
276 if (ret == 0)
278 return tag_a->line - tag_b->line;
280 return ret;
284 /* sort by line, then scope */
285 static gint compare_symbol_lines(gconstpointer a, gconstpointer b)
287 const TMTag *tag_a = TM_TAG(a);
288 const TMTag *tag_b = TM_TAG(b);
289 gint ret;
291 if (a == NULL || b == NULL)
292 return 0;
294 ret = tag_a->line - tag_b->line;
295 if (ret == 0)
297 if (tag_a->scope == NULL)
298 return -(tag_a->scope != tag_b->scope);
299 if (tag_b->scope == NULL)
300 return tag_a->scope != tag_b->scope;
301 else
302 return strcmp(tag_a->scope, tag_b->scope);
304 return ret;
308 static GList *get_tag_list(GeanyDocument *doc, TMTagType tag_types)
310 GList *tag_names = NULL;
311 guint i;
312 gchar **tf_strv;
314 g_return_val_if_fail(doc, NULL);
316 if (! doc->tm_file || ! doc->tm_file->tags_array)
317 return NULL;
319 tf_strv = g_strsplit_set(doc->priv->tag_filter, " ", -1);
321 for (i = 0; i < doc->tm_file->tags_array->len; ++i)
323 TMTag *tag = TM_TAG(doc->tm_file->tags_array->pdata[i]);
325 if (tag->type & tag_types)
327 gboolean filtered = FALSE;
328 gchar **val;
329 gchar *full_tagname = g_strconcat(tag->scope ? tag->scope : "",
330 tag->scope ? tm_parser_scope_separator_printable(tag->lang) : "",
331 tag->name, NULL);
332 gchar *normalized_tagname = g_utf8_normalize(full_tagname, -1, G_NORMALIZE_ALL);
334 foreach_strv(val, tf_strv)
336 gchar *normalized_val = g_utf8_normalize(*val, -1, G_NORMALIZE_ALL);
338 if (normalized_tagname != NULL && normalized_val != NULL)
340 gchar *case_normalized_tagname = g_utf8_casefold(normalized_tagname, -1);
341 gchar *case_normalized_val = g_utf8_casefold(normalized_val, -1);
343 filtered = strstr(case_normalized_tagname, case_normalized_val) == NULL;
344 g_free(case_normalized_tagname);
345 g_free(case_normalized_val);
347 g_free(normalized_val);
349 if (filtered)
350 break;
352 if (!filtered)
353 tag_names = g_list_prepend(tag_names, tag);
355 g_free(normalized_tagname);
356 g_free(full_tagname);
359 tag_names = g_list_sort(tag_names, compare_symbol_lines);
361 g_strfreev(tf_strv);
363 return tag_names;
367 /* amount of types in the symbol list - can be increased if needed */
368 #define MAX_SYMBOL_TYPES 15
370 GtkTreeIter tv_iters[MAX_SYMBOL_TYPES];
373 static void init_tag_iters(void)
375 guint i;
376 /* init all GtkTreeIters with -1 to make them invalid to avoid crashes when switching between
377 * filetypes(e.g. config file to Python crashes Geany without this) */
378 for (i = 0; i < MAX_SYMBOL_TYPES; i++)
379 tv_iters[i].stamp = -1;
383 static GdkPixbuf *get_tag_icon(const gchar *icon_name)
385 static GtkIconTheme *icon_theme = NULL;
386 static gint x = -1;
388 if (G_UNLIKELY(x < 0))
390 gint dummy;
391 icon_theme = gtk_icon_theme_get_default();
392 gtk_icon_size_lookup(GTK_ICON_SIZE_MENU, &x, &dummy);
394 return gtk_icon_theme_load_icon(icon_theme, icon_name, x, 0, NULL);
398 static gboolean find_toplevel_iter(GtkTreeStore *store, GtkTreeIter *iter, const gchar *title)
400 GtkTreeModel *model = GTK_TREE_MODEL(store);
402 if (!gtk_tree_model_get_iter_first(model, iter))
403 return FALSE;
406 gchar *candidate;
408 gtk_tree_model_get(model, iter, SYMBOLS_COLUMN_NAME, &candidate, -1);
409 /* FIXME: what if 2 different items have the same name?
410 * this should never happen, but might be caused by a typo in a translation */
411 if (utils_str_equal(candidate, title))
413 g_free(candidate);
414 return TRUE;
416 else
417 g_free(candidate);
419 while (gtk_tree_model_iter_next(model, iter));
421 return FALSE;
425 static void tag_list_add_groups(GtkTreeStore *tree_store, TMParserType lang)
427 const gchar *title;
428 guint i;
429 guint icon_id;
431 g_return_if_fail(top_level_iter_names);
433 for (i = 0; (title = tm_parser_get_sidebar_info(lang, i, &icon_id)) != NULL; i++)
435 GtkTreeIter *iter = &tv_iters[i];
436 GdkPixbuf *icon = NULL;
438 if (icon_id < TM_N_ICONS)
439 icon = symbols_icons[icon_id].pixbuf;
441 g_assert(title != NULL);
442 g_ptr_array_add(top_level_iter_names, (gchar *)title);
444 if (!find_toplevel_iter(tree_store, iter, title))
445 gtk_tree_store_append(tree_store, iter, NULL);
447 if (icon)
448 gtk_tree_store_set(tree_store, iter, SYMBOLS_COLUMN_ICON, icon, -1);
449 gtk_tree_store_set(tree_store, iter, SYMBOLS_COLUMN_NAME, title, -1);
454 static void add_top_level_items(GeanyDocument *doc)
456 TMParserType lang = doc->file_type->lang;
457 GtkTreeStore *tag_store = doc->priv->tag_store;
459 if (top_level_iter_names == NULL)
460 top_level_iter_names = g_ptr_array_new();
461 else
462 g_ptr_array_set_size(top_level_iter_names, 0);
464 init_tag_iters();
466 tag_list_add_groups(tag_store, lang);
470 /* removes toplevel items that have no children */
471 static void hide_empty_rows(GtkTreeStore *store)
473 GtkTreeIter iter;
474 gboolean cont = TRUE;
476 if (! gtk_tree_model_get_iter_first(GTK_TREE_MODEL(store), &iter))
477 return; /* stop when first iter is invalid, i.e. no elements */
479 while (cont)
481 if (! gtk_tree_model_iter_has_child(GTK_TREE_MODEL(store), &iter))
482 cont = gtk_tree_store_remove(store, &iter);
483 else
484 cont = gtk_tree_model_iter_next(GTK_TREE_MODEL(store), &iter);
489 static const gchar *get_symbol_name(GeanyDocument *doc, const TMTag *tag, gboolean include_scope,
490 gboolean include_line)
492 gchar *utf8_name;
493 const gchar *scope = tag->scope;
494 static GString *buffer = NULL; /* buffer will be small so we can keep it for reuse */
495 gboolean doc_is_utf8 = FALSE;
497 /* encodings_convert_to_utf8_from_charset() fails with charset "None", so skip conversion
498 * for None at this point completely */
499 if (utils_str_equal(doc->encoding, "UTF-8") ||
500 utils_str_equal(doc->encoding, "None"))
501 doc_is_utf8 = TRUE;
502 else /* normally the tags will always be in UTF-8 since we parse from our buffer, but a
503 * plugin might have called tm_source_file_update(), so check to be sure */
504 doc_is_utf8 = g_utf8_validate(tag->name, -1, NULL);
506 if (! doc_is_utf8)
507 utf8_name = encodings_convert_to_utf8_from_charset(tag->name,
508 -1, doc->encoding, TRUE);
509 else
510 utf8_name = tag->name;
512 if (utf8_name == NULL)
513 return NULL;
515 if (! buffer)
516 buffer = g_string_new(NULL);
517 else
518 g_string_truncate(buffer, 0);
520 /* check first char of scope is a wordchar */
521 if (include_scope && scope &&
522 strpbrk(scope, GEANY_WORDCHARS) == scope)
524 const gchar *sep = tm_parser_scope_separator_printable(tag->lang);
526 g_string_append(buffer, scope);
527 g_string_append(buffer, sep);
529 g_string_append(buffer, utf8_name);
531 if (! doc_is_utf8)
532 g_free(utf8_name);
534 if (include_line)
535 g_string_append_printf(buffer, " [%lu]", tag->line);
537 return buffer->str;
541 // Returns NULL if the tag is not a variable or callable
542 static gchar *get_symbol_tooltip(GeanyDocument *doc, const TMTag *tag, gboolean include_scope)
544 gchar *utf8_name = tm_parser_format_function(tag->lang, tag->name,
545 tag->arglist, tag->var_type, tag->scope);
547 if (!utf8_name && tag->var_type &&
548 tag->type & (tm_tag_field_t | tm_tag_member_t | tm_tag_variable_t | tm_tag_externvar_t))
550 gchar *scope = include_scope ? tag->scope : NULL;
551 utf8_name = tm_parser_format_variable(tag->lang, tag->name, tag->var_type, scope);
554 /* encodings_convert_to_utf8_from_charset() fails with charset "None", so skip conversion
555 * for None at this point completely */
556 if (utf8_name != NULL &&
557 ! utils_str_equal(doc->encoding, "UTF-8") &&
558 ! utils_str_equal(doc->encoding, "None"))
560 SETPTR(utf8_name,
561 encodings_convert_to_utf8_from_charset(utf8_name, -1, doc->encoding, TRUE));
564 return utf8_name;
568 static const gchar *get_parent_name(const TMTag *tag)
570 return !EMPTY(tag->scope) ? tag->scope : NULL;
574 static GtkTreeIter *get_tag_type_iter(TMParserType lang, TMTagType tag_type)
576 /* TODO: tm_parser_get_sidebar_group() goes through groups one by one.
577 * If this happens to be slow for tree construction, create a lookup
578 * table for them. */
579 gint group = tm_parser_get_sidebar_group(lang, tag_type);
581 if (group < 0)
582 return NULL;
584 return &tv_iters[group];
588 static GdkPixbuf *get_child_icon(GtkTreeStore *tree_store, GtkTreeIter *parent)
590 GdkPixbuf *icon = NULL;
592 /* copy parent icon */
593 gtk_tree_model_get(GTK_TREE_MODEL(tree_store), parent,
594 SYMBOLS_COLUMN_ICON, &icon, -1);
595 return icon;
599 static gboolean tag_equal(gconstpointer v1, gconstpointer v2)
601 const TMTag *t1 = v1;
602 const TMTag *t2 = v2;
604 return (t1->type == t2->type && strcmp(t1->name, t2->name) == 0 &&
605 utils_str_equal(t1->scope, t2->scope) &&
606 /* include arglist in match to support e.g. C++ overloading */
607 utils_str_equal(t1->arglist, t2->arglist));
611 /* inspired from g_str_hash() */
612 static guint tag_hash(gconstpointer v)
614 const TMTag *tag = v;
615 const gchar *p;
616 guint32 h = 5381;
618 h = (h << 5) + h + tag->type;
619 for (p = tag->name; *p != '\0'; p++)
620 h = (h << 5) + h + *p;
621 if (tag->scope)
623 for (p = tag->scope; *p != '\0'; p++)
624 h = (h << 5) + h + *p;
626 /* for e.g. C++ overloading */
627 if (tag->arglist)
629 for (p = tag->arglist; *p != '\0'; p++)
630 h = (h << 5) + h + *p;
633 return h;
637 /* like gtk_tree_view_expand_to_path() but with an iter */
638 static void tree_view_expand_to_iter(GtkTreeView *view, GtkTreeIter *iter)
640 GtkTreeModel *model = gtk_tree_view_get_model(view);
641 GtkTreePath *path = gtk_tree_model_get_path(model, iter);
643 gtk_tree_view_expand_to_path(view, path);
644 gtk_tree_path_free(path);
648 /* like gtk_tree_store_remove() but finds the next iter at any level */
649 static gboolean tree_store_remove_row(GtkTreeStore *store, GtkTreeIter *iter)
651 GtkTreeIter parent;
652 gboolean has_parent;
653 gboolean cont;
655 has_parent = gtk_tree_model_iter_parent(GTK_TREE_MODEL(store), &parent, iter);
656 cont = gtk_tree_store_remove(store, iter);
657 /* if there is no next at this level but there is a parent iter, continue from it */
658 if (! cont && has_parent)
660 *iter = parent;
661 cont = ui_tree_model_iter_any_next(GTK_TREE_MODEL(store), iter, FALSE);
664 return cont;
668 static gint tree_search_func(gconstpointer key, gpointer user_data)
670 TreeSearchData *data = user_data;
671 gint parent_line = GPOINTER_TO_INT(key);
672 gboolean new_nearest;
674 if (data->found_line == -1)
675 data->found_line = parent_line; /* initial value */
677 new_nearest = ABS(data->line - parent_line) < ABS(data->line - data->found_line);
679 if (parent_line > data->line)
681 if (new_nearest && !data->lower)
682 data->found_line = parent_line;
683 return -1;
686 if (new_nearest)
687 data->found_line = parent_line;
689 if (parent_line < data->line)
690 return 1;
692 return 0;
696 static gint tree_cmp(gconstpointer a, gconstpointer b, gpointer user_data)
698 return GPOINTER_TO_INT(a) - GPOINTER_TO_INT(b);
702 static void parents_table_tree_value_free(gpointer data)
704 g_slice_free(GtkTreeIter, data);
708 /* adds a new element in the parent table if its key is known. */
709 static void update_parents_table(GHashTable *table, const TMTag *tag, const GtkTreeIter *iter)
711 const gchar *name;
712 gchar *name_free = NULL;
713 GTree *tree;
715 if (EMPTY(tag->scope))
717 /* simple case, just use the tag name */
718 name = tag->name;
720 else if (! tm_parser_has_full_scope(tag->lang))
722 /* if the parser doesn't use fully qualified scope, use the name alone but
723 * prevent Foo::Foo from making parent = child */
724 if (utils_str_equal(tag->scope, tag->name))
725 name = NULL;
726 else
727 name = tag->name;
729 else
731 /* build the fully qualified scope as get_parent_name() would return it for a child tag */
732 name_free = g_strconcat(tag->scope, tm_parser_scope_separator(tag->lang), tag->name, NULL);
733 name = name_free;
736 if (name && g_hash_table_lookup_extended(table, name, NULL, (gpointer *) &tree))
738 if (!tree)
740 tree = g_tree_new_full(tree_cmp, NULL, NULL, parents_table_tree_value_free);
741 g_hash_table_insert(table, name_free ? name_free : g_strdup(name), tree);
742 name_free = NULL;
745 g_tree_insert(tree, GINT_TO_POINTER(tag->line), g_slice_dup(GtkTreeIter, iter));
748 g_free(name_free);
752 static GtkTreeIter *parents_table_lookup(GHashTable *table, const gchar *name, guint line)
754 GtkTreeIter *parent_search = NULL;
755 GTree *tree;
757 tree = g_hash_table_lookup(table, name);
758 if (tree)
760 TreeSearchData user_data = {-1, line, TRUE};
762 /* search parent candidates for the one with the nearest
763 * line number which is lower than the tag's line number */
764 g_tree_search(tree, (GCompareFunc)tree_search_func, &user_data);
765 parent_search = g_tree_lookup(tree, GINT_TO_POINTER(user_data.found_line));
768 return parent_search;
772 static void parents_table_value_free(gpointer data)
774 GTree *tree = data;
775 if (tree)
776 g_tree_destroy(tree);
780 /* inserts a @data in @table on key @tag.
781 * previous data is not overwritten if the key is duplicated, but rather the
782 * two values are kept in a list
784 * table is: GHashTable<TMTag, GTree<line_num, GList<GList<TMTag>>>> */
785 static void tags_table_insert(GHashTable *table, TMTag *tag, GList *data)
787 GTree *tree = g_hash_table_lookup(table, tag);
788 if (!tree)
790 tree = g_tree_new_full(tree_cmp, NULL, NULL, NULL);
791 g_hash_table_insert(table, tag, tree);
793 GList *list = g_tree_lookup(tree, GINT_TO_POINTER(tag->line));
794 list = g_list_prepend(list, data);
795 g_tree_insert(tree, GINT_TO_POINTER(tag->line), list);
799 /* looks up the entry in @table that best matches @tag.
800 * if there is more than one candidate, the one that has closest line position to @tag is chosen */
801 static GList *tags_table_lookup(GHashTable *table, TMTag *tag)
803 TreeSearchData user_data = {-1, tag->line, FALSE};
804 GTree *tree = g_hash_table_lookup(table, tag);
806 if (tree)
808 GList *list;
810 g_tree_search(tree, (GCompareFunc)tree_search_func, &user_data);
811 list = g_tree_lookup(tree, GINT_TO_POINTER(user_data.found_line));
812 /* return the first value in the list - we don't care which of the
813 * tags with identical names defined on the same line we get */
814 if (list)
815 return list->data;
817 return NULL;
821 /* removes the element at @tag from @table.
822 * @tag must be the exact pointer used at insertion time */
823 static void tags_table_remove(GHashTable *table, TMTag *tag)
825 GTree *tree = g_hash_table_lookup(table, tag);
826 if (tree)
828 GList *list = g_tree_lookup(tree, GINT_TO_POINTER(tag->line));
829 if (list)
831 GList *node;
832 /* should always be the first element as we returned the first one in
833 * tags_table_lookup() */
834 foreach_list(node, list)
836 if (((GList *) node->data)->data == tag)
837 break;
839 list = g_list_delete_link(list, node);
840 if (!list)
841 g_tree_remove(tree, GINT_TO_POINTER(tag->line));
842 else
843 g_tree_insert(tree, GINT_TO_POINTER(tag->line), list);
849 static gboolean tags_table_tree_value_free(gpointer key, gpointer value, gpointer data)
851 GList *list = value;
852 g_list_free(list);
853 return FALSE;
857 static void tags_table_value_free(gpointer data)
859 GTree *tree = data;
860 if (tree)
862 /* free any leftover elements. note that we can't register a value_free_func when
863 * creating the tree because we only want to free it when destroying the tree,
864 * not when inserting a duplicate (we handle this manually) */
865 g_tree_foreach(tree, tags_table_tree_value_free, NULL);
866 g_tree_destroy(tree);
872 * Updates the tag tree for a document with the tags in *list.
873 * @param doc a document
874 * @param tags a pointer to a GList* holding the tags to add/update. This
875 * list may be updated, removing updated elements.
877 * The update is done in two passes:
878 * 1) walking the current tree, update tags that still exist and remove the
879 * obsolescent ones;
880 * 2) walking the remaining (non updated) tags, adds them in the list.
882 * For better performances, we use 2 hash tables:
883 * - one containing all the tags for lookup in the first pass (actually stores a
884 * reference in the tags list for removing it efficiently), avoiding list search
885 * on each tag;
886 * - the other holding "tag-name":row references for tags having children, used to
887 * lookup for a parent in both passes, avoiding tree traversal.
889 static void update_tree_tags(GeanyDocument *doc, GList **tags)
891 GtkTreeStore *store = doc->priv->tag_store;
892 GtkTreeModel *model = GTK_TREE_MODEL(store);
893 GHashTable *parents_table;
894 GHashTable *tags_table;
895 GtkTreeIter iter;
896 gboolean cont;
897 GList *item;
899 /* Build hash tables holding tags and parents */
900 /* parent table is GHashTable<tag_name, GTree<line_num, GtkTreeIter>>
901 * where tag_name might be a fully qualified name (with scope) if the language
902 * parser reports scope properly (see tm_parser_has_full_scope()). */
903 parents_table = g_hash_table_new_full(g_str_hash, g_str_equal, g_free, parents_table_value_free);
904 /* tags table is another representation of the @tags list,
905 * GHashTable<TMTag, GTree<line_num, GList<GList<TMTag>>>> */
906 tags_table = g_hash_table_new_full(tag_hash, tag_equal, NULL, tags_table_value_free);
907 foreach_list(item, *tags)
909 TMTag *tag = item->data;
910 const gchar *parent_name;
912 tags_table_insert(tags_table, tag, item);
914 parent_name = get_parent_name(tag);
915 if (parent_name)
916 g_hash_table_insert(parents_table, g_strdup(parent_name), NULL);
919 /* First pass, update existing rows or delete them.
920 * It is OK to delete them since we walk top down so we would remove
921 * parents before checking for their children, thus never implicitly
922 * deleting an updated child */
923 cont = gtk_tree_model_get_iter_first(model, &iter);
924 while (cont)
926 TMTag *tag;
928 gtk_tree_model_get(model, &iter, SYMBOLS_COLUMN_TAG, &tag, -1);
929 if (! tag) /* most probably a toplevel, skip it */
930 cont = ui_tree_model_iter_any_next(model, &iter, TRUE);
931 else
933 GList *found_item;
935 found_item = tags_table_lookup(tags_table, tag);
936 if (! found_item) /* tag doesn't exist, remove it */
937 cont = tree_store_remove_row(store, &iter);
938 else /* tag still exist, update it */
940 const gchar *parent_name;
941 TMTag *found = found_item->data;
943 parent_name = get_parent_name(found);
944 /* if parent is unknown, ignore it */
945 if (parent_name && ! g_hash_table_lookup(parents_table, parent_name))
946 parent_name = NULL;
948 if (!tm_tags_equal(tag, found))
950 const gchar *name;
951 gchar *tooltip;
953 /* only update fields that (can) have changed (name that holds line
954 * number, tooltip, and the tag itself) */
955 name = get_symbol_name(doc, found, parent_name == NULL, TRUE);
956 tooltip = get_symbol_tooltip(doc, found, FALSE);
957 gtk_tree_store_set(store, &iter,
958 SYMBOLS_COLUMN_NAME, name,
959 SYMBOLS_COLUMN_TOOLTIP, tooltip,
960 SYMBOLS_COLUMN_TAG, found,
961 -1);
962 g_free(tooltip);
965 update_parents_table(parents_table, found, &iter);
967 /* remove the updated tag from the table and list */
968 tags_table_remove(tags_table, found);
969 *tags = g_list_delete_link(*tags, found_item);
971 cont = ui_tree_model_iter_any_next(model, &iter, TRUE);
974 tm_tag_unref(tag);
978 /* Second pass, now we have a tree cleaned up from invalid rows,
979 * we simply add new ones */
980 foreach_list (item, *tags)
982 TMTag *tag = item->data;
983 GtkTreeIter *parent, *parent_group;
985 parent_group = get_tag_type_iter(tag->lang, tag->type);
986 /* tv_iters[0] is reserved for the "Symbols" group */
987 parent = ui_prefs.symbols_group_by_type ? parent_group : &tv_iters[0];
988 if (parent_group)
990 gboolean expand;
991 const gchar *name;
992 const gchar *parent_name;
993 gchar *tooltip;
994 GdkPixbuf *icon = get_child_icon(store, parent_group);
996 parent_name = get_parent_name(tag);
997 if (parent_name)
999 GtkTreeIter *parent_search = parents_table_lookup(parents_table, parent_name, tag->line);
1001 if (parent_search)
1002 parent = parent_search;
1003 else
1004 parent_name = NULL;
1007 /* only expand to the iter if the parent was empty, otherwise we let the
1008 * folding as it was before (already expanded, or closed by the user) */
1009 expand = ! gtk_tree_model_iter_has_child(model, parent);
1011 /* insert the new element */
1012 name = get_symbol_name(doc, tag, parent_name == NULL, TRUE);
1013 tooltip = get_symbol_tooltip(doc, tag, FALSE);
1014 gtk_tree_store_insert_with_values(store, &iter, parent, 0,
1015 SYMBOLS_COLUMN_NAME, name,
1016 SYMBOLS_COLUMN_TOOLTIP, tooltip,
1017 SYMBOLS_COLUMN_ICON, icon,
1018 SYMBOLS_COLUMN_TAG, tag,
1019 -1);
1020 g_free(tooltip);
1021 if (G_LIKELY(icon))
1022 g_object_unref(icon);
1024 update_parents_table(parents_table, tag, &iter);
1026 if (expand)
1027 tree_view_expand_to_iter(GTK_TREE_VIEW(doc->priv->tag_tree), &iter);
1031 g_hash_table_destroy(parents_table);
1032 g_hash_table_destroy(tags_table);
1036 /* we don't want to sort 1st-level nodes, but we can't return 0 because the tree sort
1037 * is not stable, so the order is already lost. */
1038 static gint compare_top_level_names(const gchar *a, const gchar *b)
1040 guint i;
1041 const gchar *name;
1043 /* This should never happen as it would mean that two or more top
1044 * level items have the same name but it can happen by typos in the translations. */
1045 if (utils_str_equal(a, b))
1046 return 1;
1048 foreach_ptr_array(name, i, top_level_iter_names)
1050 if (utils_str_equal(name, a))
1051 return -1;
1052 if (utils_str_equal(name, b))
1053 return 1;
1055 g_warning("Couldn't find top level node '%s' or '%s'!", a, b);
1056 return 0;
1060 static gboolean tag_has_missing_parent(const TMTag *tag, GtkTreeStore *store,
1061 GtkTreeIter *iter)
1063 /* if the tag has a parent tag, it should be at depth >= 2 */
1064 return !EMPTY(tag->scope) &&
1065 gtk_tree_store_iter_depth(store, iter) == 1;
1069 static gint tree_sort_func(GtkTreeModel *model, GtkTreeIter *a, GtkTreeIter *b,
1070 gpointer user_data)
1072 gboolean sort_by_name = GPOINTER_TO_INT(user_data);
1073 TMTag *tag_a, *tag_b;
1074 gint cmp;
1076 gtk_tree_model_get(model, a, SYMBOLS_COLUMN_TAG, &tag_a, -1);
1077 gtk_tree_model_get(model, b, SYMBOLS_COLUMN_TAG, &tag_b, -1);
1079 /* Check if the iters can be sorted based on tag name and line, not tree item name.
1080 * Sort by tree name if the scope was prepended, e.g. 'ScopeNameWithNoTag::TagName'. */
1081 if (tag_a && !tag_has_missing_parent(tag_a, GTK_TREE_STORE(model), a) &&
1082 tag_b && !tag_has_missing_parent(tag_b, GTK_TREE_STORE(model), b))
1084 cmp = sort_by_name ? compare_symbol(tag_a, tag_b) :
1085 compare_symbol_lines(tag_a, tag_b);
1087 else
1089 gchar *astr, *bstr;
1091 gtk_tree_model_get(model, a, SYMBOLS_COLUMN_NAME, &astr, -1);
1092 gtk_tree_model_get(model, b, SYMBOLS_COLUMN_NAME, &bstr, -1);
1094 /* if a is toplevel, b must be also */
1095 if (gtk_tree_store_iter_depth(GTK_TREE_STORE(model), a) == 0)
1097 cmp = compare_top_level_names(astr, bstr);
1099 else
1101 /* this is what g_strcmp0() does */
1102 if (! astr)
1103 cmp = -(astr != bstr);
1104 else if (! bstr)
1105 cmp = astr != bstr;
1106 else
1108 cmp = strcmp(astr, bstr);
1110 /* sort duplicate 'ScopeName::OverloadedTagName' items by line as well */
1111 if (tag_a && tag_b)
1112 if (!sort_by_name ||
1113 (utils_str_equal(tag_a->name, tag_b->name) &&
1114 utils_str_equal(tag_a->scope, tag_b->scope)))
1115 cmp = compare_symbol_lines(tag_a, tag_b);
1118 g_free(astr);
1119 g_free(bstr);
1121 tm_tag_unref(tag_a);
1122 tm_tag_unref(tag_b);
1124 return cmp;
1128 static void sort_tree(GtkTreeStore *store, gboolean sort_by_name)
1130 gtk_tree_sortable_set_sort_func(GTK_TREE_SORTABLE(store), SYMBOLS_COLUMN_NAME, tree_sort_func,
1131 GINT_TO_POINTER(sort_by_name), NULL);
1133 gtk_tree_sortable_set_sort_column_id(GTK_TREE_SORTABLE(store), SYMBOLS_COLUMN_NAME, GTK_SORT_ASCENDING);
1137 gboolean symbols_recreate_tag_list(GeanyDocument *doc, gint sort_mode)
1139 GList *tags;
1141 g_return_val_if_fail(DOC_VALID(doc), FALSE);
1143 tags = get_tag_list(doc, ~(tm_tag_local_var_t | tm_tag_include_t));
1144 if (tags == NULL)
1145 return FALSE;
1147 if (doc->priv->symbols_group_by_type != ui_prefs.symbols_group_by_type)
1148 gtk_tree_store_clear(doc->priv->tag_store);
1150 doc->priv->symbols_group_by_type = ui_prefs.symbols_group_by_type;
1152 /* FIXME: Not sure why we detached the model here? */
1154 /* disable sorting during update because the code doesn't support correctly
1155 * models that are currently being built */
1156 gtk_tree_sortable_set_sort_column_id(GTK_TREE_SORTABLE(doc->priv->tag_store), GTK_TREE_SORTABLE_UNSORTED_SORT_COLUMN_ID, 0);
1158 /* add grandparent type iters */
1159 add_top_level_items(doc);
1161 update_tree_tags(doc, &tags);
1162 g_list_free(tags);
1164 hide_empty_rows(doc->priv->tag_store);
1166 if (sort_mode == SYMBOLS_SORT_USE_PREVIOUS)
1167 sort_mode = doc->priv->symbol_list_sort_mode;
1169 sort_tree(doc->priv->tag_store, sort_mode == SYMBOLS_SORT_BY_NAME);
1170 doc->priv->symbol_list_sort_mode = sort_mode;
1172 return TRUE;
1176 /* Detects a global tags filetype from the *.lang.* language extension.
1177 * Returns NULL if there was no matching TM language. */
1178 static GeanyFiletype *detect_global_tags_filetype(const gchar *utf8_filename)
1180 gchar *tags_ext;
1181 gchar *shortname = utils_strdupa(utf8_filename);
1182 GeanyFiletype *ft = NULL;
1184 tags_ext = g_strrstr(shortname, ".tags");
1185 if (tags_ext)
1187 *tags_ext = '\0'; /* remove .tags extension */
1188 ft = filetypes_detect_from_extension(shortname);
1189 if (ft->id != GEANY_FILETYPES_NONE)
1190 return ft;
1192 return NULL;
1196 /* Adapted from anjuta-2.0.2/global-tags/tm_global_tags.c, thanks.
1197 * Needs full paths for filenames, except for C/C++ tag files, when CFLAGS includes
1198 * the relevant path.
1199 * Example:
1200 * CFLAGS=-I/home/user/libname-1.x geany -g libname.d.tags libname.h */
1201 int symbols_generate_global_tags(int argc, char **argv, gboolean want_preprocess)
1203 /* -E pre-process, -dD output user macros, -p prof info (?) */
1204 const char pre_process[] = "gcc -E -dD -p -I.";
1206 if (argc > 2)
1208 /* Create global taglist */
1209 int status;
1210 char *command;
1211 const char *tags_file = argv[1];
1212 char *utf8_fname;
1213 GeanyFiletype *ft;
1215 utf8_fname = utils_get_utf8_from_locale(tags_file);
1216 ft = detect_global_tags_filetype(utf8_fname);
1217 g_free(utf8_fname);
1219 if (ft == NULL)
1221 g_printerr(_("Unknown filetype extension for \"%s\".\n"), tags_file);
1222 return 1;
1224 /* load config in case of custom filetypes */
1225 filetypes_load_config(ft->id, FALSE);
1227 /* load ignore list for C/C++ parser */
1228 if (ft->id == GEANY_FILETYPES_C || ft->id == GEANY_FILETYPES_CPP)
1229 load_c_ignore_tags();
1231 if (want_preprocess && (ft->id == GEANY_FILETYPES_C || ft->id == GEANY_FILETYPES_CPP))
1233 const gchar *cflags = getenv("CFLAGS");
1234 command = g_strdup_printf("%s %s", pre_process, FALLBACK(cflags, ""));
1236 else
1237 command = NULL; /* don't preprocess */
1239 geany_debug("Generating %s tags file.", ft->name);
1240 tm_get_workspace();
1241 status = tm_workspace_create_global_tags(command, (const char **) (argv + 2),
1242 argc - 2, tags_file, ft->lang);
1243 g_free(command);
1244 symbols_finalize(); /* free c_tags_ignore data */
1245 if (! status)
1247 g_printerr(_("Failed to create tags file, perhaps because no symbols "
1248 "were found.\n"));
1249 return 1;
1252 else
1254 g_printerr(_("Usage: %s -g <Tags File> <File list>\n\n"), argv[0]);
1255 g_printerr(_("Example:\n"
1256 "CFLAGS=`pkg-config gtk+-2.0 --cflags` %s -g gtk2.c.tags"
1257 " /usr/include/gtk-2.0/gtk/gtk.h\n"), argv[0]);
1258 return 1;
1260 return 0;
1264 void symbols_show_load_tags_dialog(void)
1266 GtkWidget *dialog;
1267 GtkFileFilter *filter;
1269 dialog = gtk_file_chooser_dialog_new(_("Load Tags File"), GTK_WINDOW(main_widgets.window),
1270 GTK_FILE_CHOOSER_ACTION_OPEN,
1271 GTK_STOCK_CANCEL, GTK_RESPONSE_CANCEL,
1272 GTK_STOCK_OPEN, GTK_RESPONSE_OK,
1273 NULL);
1274 gtk_widget_set_name(dialog, "GeanyDialog");
1275 filter = gtk_file_filter_new();
1276 gtk_file_filter_set_name(filter, _("Geany tags file (*.*.tags)"));
1277 gtk_file_filter_add_pattern(filter, "*.*.tags");
1278 gtk_file_chooser_add_filter(GTK_FILE_CHOOSER(dialog), filter);
1280 if (gtk_dialog_run(GTK_DIALOG(dialog)) == GTK_RESPONSE_OK)
1282 GSList *flist = gtk_file_chooser_get_filenames(GTK_FILE_CHOOSER(dialog));
1283 GSList *item;
1285 for (item = flist; item != NULL; item = g_slist_next(item))
1287 gchar *fname = item->data;
1288 gchar *utf8_fname;
1289 GeanyFiletype *ft;
1291 utf8_fname = utils_get_utf8_from_locale(fname);
1292 ft = detect_global_tags_filetype(utf8_fname);
1294 if (ft != NULL && symbols_load_global_tags(fname, ft))
1295 /* For translators: the first wildcard is the filetype, the second the filename */
1296 ui_set_statusbar(TRUE, _("Loaded %s tags file '%s'."),
1297 filetypes_get_display_name(ft), utf8_fname);
1298 else
1299 ui_set_statusbar(TRUE, _("Could not load tags file '%s'."), utf8_fname);
1301 g_free(utf8_fname);
1302 g_free(fname);
1304 g_slist_free(flist);
1306 gtk_widget_destroy(dialog);
1310 static void init_user_tags(void)
1312 GSList *file_list = NULL, *list = NULL;
1313 const GSList *node;
1314 gchar *dir;
1316 dir = g_build_filename(app->configdir, GEANY_TAGS_SUBDIR, NULL);
1317 /* create the user tags dir for next time if it doesn't exist */
1318 if (! g_file_test(dir, G_FILE_TEST_IS_DIR))
1319 utils_mkdir(dir, FALSE);
1320 file_list = utils_get_file_list_full(dir, TRUE, FALSE, NULL);
1322 SETPTR(dir, g_build_filename(app->datadir, GEANY_TAGS_SUBDIR, NULL));
1323 list = utils_get_file_list_full(dir, TRUE, FALSE, NULL);
1324 g_free(dir);
1326 file_list = g_slist_concat(file_list, list);
1328 /* populate the filetype-specific tag files lists */
1329 for (node = file_list; node != NULL; node = node->next)
1331 gchar *fname = node->data;
1332 gchar *utf8_fname = utils_get_utf8_from_locale(fname);
1333 GeanyFiletype *ft = detect_global_tags_filetype(utf8_fname);
1335 g_free(utf8_fname);
1337 if (FILETYPE_ID(ft) != GEANY_FILETYPES_NONE)
1338 ft->priv->tag_files = g_slist_prepend(ft->priv->tag_files, fname);
1339 else
1341 geany_debug("Unknown filetype for file '%s'.", fname);
1342 g_free(fname);
1346 /* don't need to delete list contents because they are now stored in
1347 * ft->priv->tag_files */
1348 g_slist_free(file_list);
1352 static void load_user_tags(GeanyFiletypeID ft_id)
1354 static guchar *tags_loaded = NULL;
1355 static gboolean init_tags = FALSE;
1356 const GSList *node;
1357 GeanyFiletype *ft = filetypes[ft_id];
1359 g_return_if_fail(ft_id > 0);
1361 if (!tags_loaded)
1362 tags_loaded = g_new0(guchar, filetypes_array->len);
1363 if (tags_loaded[ft_id])
1364 return;
1365 tags_loaded[ft_id] = TRUE; /* prevent reloading */
1367 if (!init_tags)
1369 init_user_tags();
1370 init_tags = TRUE;
1373 for (node = ft->priv->tag_files; node != NULL; node = g_slist_next(node))
1375 const gchar *fname = node->data;
1377 symbols_load_global_tags(fname, ft);
1382 static void on_goto_popup_item_activate(GtkMenuItem *item, TMTag *tag)
1384 GeanyDocument *new_doc, *old_doc;
1386 g_return_if_fail(tag);
1388 old_doc = document_get_current();
1389 new_doc = document_open_file(tag->file->file_name, FALSE, NULL, NULL);
1391 if (new_doc)
1392 navqueue_goto_line(old_doc, new_doc, tag->line);
1396 static guint get_tag_class(const TMTag *tag)
1398 gint group = tm_parser_get_sidebar_group(tag->lang, tag->type);
1400 if (group >= 0)
1402 guint icon_id;
1403 if (tm_parser_get_sidebar_info(tag->lang, group, &icon_id))
1404 return icon_id;
1407 return TM_ICON_STRUCT;
1411 /* opens menu at caret position */
1412 static void show_menu_at_caret(GtkMenu* menu, ScintillaObject *sci)
1414 GdkWindow *window = gtk_widget_get_window(GTK_WIDGET(sci));
1415 gint pos = sci_get_current_position(sci);
1416 gint line = sci_get_line_from_position(sci, pos);
1417 gint line_height = SSM(sci, SCI_TEXTHEIGHT, line, 0);
1418 gint x = SSM(sci, SCI_POINTXFROMPOSITION, 0, pos);
1419 gint y = SSM(sci, SCI_POINTYFROMPOSITION, 0, pos);
1420 gint pos_next = sci_get_position_after(sci, pos);
1421 gint char_width = 0;
1422 /* if next pos is on the same Y (same line and not after wrapping), diff the X */
1423 if (pos_next > pos && SSM(sci, SCI_POINTYFROMPOSITION, 0, pos_next) == y)
1424 char_width = SSM(sci, SCI_POINTXFROMPOSITION, 0, pos_next) - x;
1425 GdkRectangle rect = {x, y, char_width, line_height};
1426 gtk_menu_popup_at_rect(GTK_MENU(menu), window, &rect, GDK_GRAVITY_SOUTH_WEST, GDK_GRAVITY_NORTH_WEST, NULL);
1430 static void show_goto_popup(GeanyDocument *doc, GPtrArray *tags, gboolean have_best)
1432 GtkWidget *first = NULL;
1433 GtkWidget *menu;
1434 GtkSizeGroup *group = gtk_size_group_new(GTK_SIZE_GROUP_HORIZONTAL);
1435 GdkEvent *event;
1436 TMTag *tmtag;
1437 guint i;
1438 gchar **short_names, **file_names;
1439 menu = gtk_menu_new();
1441 /* If popup would show multiple files present a smart file list that allows
1442 * to easily distinguish the files while avoiding the file paths in their entirety */
1443 file_names = g_new(gchar *, tags->len);
1444 foreach_ptr_array(tmtag, i, tags)
1445 file_names[i] = tmtag->file->file_name;
1446 short_names = utils_strv_shorten_file_list(file_names, tags->len);
1447 g_free(file_names);
1449 foreach_ptr_array(tmtag, i, tags)
1451 GtkWidget *item;
1452 GtkWidget *label;
1453 GtkWidget *box;
1454 GtkWidget *image;
1455 gchar *fname = short_names[i];
1456 gchar *text;
1457 gchar *tooltip;
1458 gchar *sym = get_symbol_tooltip(doc, tmtag, TRUE);
1460 if (!sym)
1461 sym = g_strdup(get_symbol_name(doc, tmtag, TRUE, FALSE));
1462 if (!sym)
1463 sym = g_strdup("");
1465 if (! first && have_best)
1466 text = g_markup_printf_escaped("<b>%s:%lu</b>", fname, tmtag->line);
1467 else
1468 text = g_markup_printf_escaped("%s:%lu", fname, tmtag->line);
1470 tooltip = g_markup_printf_escaped("%s:%lu\n<small><tt>%s</tt></small>", fname, tmtag->line, sym);
1472 image = gtk_image_new_from_pixbuf(symbols_icons[get_tag_class(tmtag)].pixbuf);
1473 box = g_object_new(GTK_TYPE_BOX, "orientation", GTK_ORIENTATION_HORIZONTAL, "spacing", 12, NULL);
1474 label = g_object_new(GTK_TYPE_LABEL, "label", text, "use-markup", TRUE, "xalign", 0.0, NULL);
1475 gtk_size_group_add_widget(group, label);
1476 gtk_box_pack_start(GTK_BOX(box), label, FALSE, FALSE, 0);
1477 g_free(text);
1478 text = g_markup_printf_escaped("<small><tt>%s</tt></small>", sym);
1479 gtk_box_pack_start(GTK_BOX(box), g_object_new(GTK_TYPE_LABEL, "label", text, "use-markup", TRUE, "xalign", 0.0,
1480 "max-width-chars", 80, "ellipsize", PANGO_ELLIPSIZE_END, NULL), FALSE, FALSE, 0);
1481 item = g_object_new(GTK_TYPE_IMAGE_MENU_ITEM, "image", image, "child", box, "always-show-image", TRUE,
1482 "tooltip-markup", tooltip, NULL);
1483 g_signal_connect_data(item, "activate", G_CALLBACK(on_goto_popup_item_activate),
1484 tm_tag_ref(tmtag), (GClosureNotify) tm_tag_unref, 0);
1485 gtk_menu_shell_append(GTK_MENU_SHELL(menu), item);
1487 if (! first)
1488 first = item;
1490 g_free(sym);
1491 g_free(text);
1492 g_free(fname);
1494 g_free(short_names);
1496 gtk_widget_show_all(menu);
1498 if (first) /* always select the first item for better keyboard navigation */
1499 g_signal_connect(menu, "realize", G_CALLBACK(gtk_menu_shell_select_item), first);
1501 event = gtk_get_current_event();
1502 if (event && event->type == GDK_BUTTON_PRESS)
1503 gtk_menu_popup_at_pointer(GTK_MENU(menu), event);
1504 else
1505 show_menu_at_caret(GTK_MENU(menu), doc->editor->sci);
1506 if (event)
1507 gdk_event_free(event);
1509 g_object_unref(group);
1513 static gint compare_tags_by_name_line(gconstpointer ptr1, gconstpointer ptr2)
1515 gint res;
1516 TMTag *t1 = *((TMTag **) ptr1);
1517 TMTag *t2 = *((TMTag **) ptr2);
1519 res = g_strcmp0(t1->file->short_name, t2->file->short_name);
1520 if (res != 0)
1521 return res;
1522 return t1->line - t2->line;
1526 static TMTag *find_best_goto_tag(GeanyDocument *doc, GPtrArray *tags)
1528 TMTag *tag;
1529 guint i;
1531 /* first check if we have a tag in the current file */
1532 foreach_ptr_array(tag, i, tags)
1534 if (g_strcmp0(doc->real_path, tag->file->file_name) == 0)
1535 return tag;
1538 /* next check if we have a tag for some of the open documents */
1539 foreach_ptr_array(tag, i, tags)
1541 guint j;
1543 foreach_document(j)
1545 if (g_strcmp0(documents[j]->real_path, tag->file->file_name) == 0)
1546 return tag;
1550 /* next check if we have a tag for a file inside the current document's directory */
1551 foreach_ptr_array(tag, i, tags)
1553 gchar *dir = g_path_get_dirname(doc->real_path);
1555 if (g_str_has_prefix(tag->file->file_name, dir))
1557 g_free(dir);
1558 return tag;
1560 g_free(dir);
1563 return NULL;
1567 static GPtrArray *filter_tags(GPtrArray *tags, TMTag *current_tag, gboolean definition)
1569 GeanyDocument *doc = document_get_current();
1570 guint current_line = sci_get_current_line(doc->editor->sci) + 1;
1571 const TMTagType forward_types = tm_tag_prototype_t | tm_tag_externvar_t;
1572 TMTag *tmtag, *last_tag = NULL;
1573 const gchar *current_scope = NULL;
1574 GPtrArray *filtered_tags = g_ptr_array_new();
1575 guint i;
1577 symbols_get_current_function(doc, &current_scope);
1579 foreach_ptr_array(tmtag, i, tags)
1581 /* don't show local variables outside current function or other
1582 * irrelevant tags - same as in the autocomplete case */
1583 if (!tm_workspace_is_autocomplete_tag(tmtag, doc->tm_file, current_line, current_scope))
1584 continue;
1586 if ((definition && !(tmtag->type & forward_types)) ||
1587 (!definition && (tmtag->type & forward_types)))
1589 /* If there are typedefs of e.g. a struct such as
1590 * "typedef struct Foo {} Foo;", filter out the typedef unless
1591 * cursor is at the struct name. */
1592 if (last_tag != NULL && last_tag->file == tmtag->file &&
1593 last_tag->type != tm_tag_typedef_t && tmtag->type == tm_tag_typedef_t)
1595 if (last_tag == current_tag)
1596 g_ptr_array_add(filtered_tags, tmtag);
1598 else if (tmtag != current_tag)
1599 g_ptr_array_add(filtered_tags, tmtag);
1601 last_tag = tmtag;
1605 return filtered_tags;
1609 static gboolean goto_tag(const gchar *name, gboolean definition)
1611 const TMTagType forward_types = tm_tag_prototype_t | tm_tag_externvar_t;
1612 TMTag *tmtag, *current_tag = NULL;
1613 GeanyDocument *old_doc = document_get_current();
1614 gboolean found = FALSE;
1615 const GPtrArray *all_tags;
1616 GPtrArray *tags, *filtered_tags;
1617 guint i;
1618 guint current_line = sci_get_current_line(old_doc->editor->sci) + 1;
1620 all_tags = tm_workspace_find(name, NULL, tm_tag_max_t, NULL, old_doc->file_type->lang);
1622 /* get rid of global tags and find tag at current line */
1623 tags = g_ptr_array_new();
1624 foreach_ptr_array(tmtag, i, all_tags)
1626 if (tmtag->file)
1628 g_ptr_array_add(tags, tmtag);
1629 if (tmtag->file == old_doc->tm_file && tmtag->line == current_line)
1630 current_tag = tmtag;
1634 if (current_tag)
1635 /* swap definition/declaration search */
1636 definition = current_tag->type & forward_types;
1638 filtered_tags = filter_tags(tags, current_tag, definition);
1639 if (filtered_tags->len == 0)
1641 /* if we didn't find anything, try again with the opposite type */
1642 g_ptr_array_free(filtered_tags, TRUE);
1643 filtered_tags = filter_tags(tags, current_tag, !definition);
1645 g_ptr_array_free(tags, TRUE);
1646 tags = filtered_tags;
1648 if (tags->len == 1)
1650 GeanyDocument *new_doc;
1652 tmtag = tags->pdata[0];
1653 new_doc = document_find_by_real_path(tmtag->file->file_name);
1655 if (!new_doc)
1656 /* not found in opened document, should open */
1657 new_doc = document_open_file(tmtag->file->file_name, FALSE, NULL, NULL);
1659 navqueue_goto_line(old_doc, new_doc, tmtag->line);
1661 else if (tags->len > 1)
1663 GPtrArray *tag_list;
1664 TMTag *tag, *best_tag;
1666 g_ptr_array_sort(tags, compare_tags_by_name_line);
1667 best_tag = find_best_goto_tag(old_doc, tags);
1669 tag_list = g_ptr_array_new();
1670 if (best_tag)
1671 g_ptr_array_add(tag_list, best_tag);
1672 foreach_ptr_array(tag, i, tags)
1674 if (tag != best_tag)
1675 g_ptr_array_add(tag_list, tag);
1677 show_goto_popup(old_doc, tag_list, best_tag != NULL);
1679 g_ptr_array_free(tag_list, TRUE);
1682 found = tags->len > 0;
1683 g_ptr_array_free(tags, TRUE);
1685 return found;
1689 gboolean symbols_goto_tag(const gchar *name, gboolean definition)
1691 if (goto_tag(name, definition))
1692 return TRUE;
1694 /* if we are here, there was no match and we are beeping ;-) */
1695 utils_beep();
1697 if (!definition)
1698 ui_set_statusbar(FALSE, _("Forward declaration \"%s\" not found."), name);
1699 else
1700 ui_set_statusbar(FALSE, _("Definition of \"%s\" not found."), name);
1701 return FALSE;
1705 /* This could perhaps be improved to check for #if, class etc. */
1706 static gint get_function_fold_number(GeanyDocument *doc)
1708 /* for Java the functions are always one fold level above the class scope */
1709 if (doc->file_type->id == GEANY_FILETYPES_JAVA)
1710 return SC_FOLDLEVELBASE + 1;
1711 else
1712 return SC_FOLDLEVELBASE;
1716 /* Should be used only with get_current_tag_cached.
1717 * tag_types caching might trigger recomputation too often but this isn't used differently often
1718 * enough to be an issue for now */
1719 static gboolean current_tag_changed(GeanyDocument *doc, gint cur_line, gint fold_level, guint tag_types)
1721 static gint old_line = -2;
1722 static GeanyDocument *old_doc = NULL;
1723 static gint old_fold_num = -1;
1724 static guint old_tag_types = 0;
1725 const gint fold_num = fold_level & SC_FOLDLEVELNUMBERMASK;
1726 gboolean ret;
1728 /* check if the cached line and file index have changed since last time: */
1729 if (doc == NULL || doc != old_doc || old_tag_types != tag_types)
1730 ret = TRUE;
1731 else if (cur_line == old_line)
1732 ret = FALSE;
1733 else
1735 /* if the line has only changed by 1 */
1736 if (abs(cur_line - old_line) == 1)
1738 /* It's the same function if the fold number hasn't changed */
1739 ret = (fold_num != old_fold_num);
1741 else ret = TRUE;
1744 /* record current line and file index for next time */
1745 old_line = cur_line;
1746 old_doc = doc;
1747 old_fold_num = fold_num;
1748 old_tag_types = tag_types;
1749 return ret;
1753 /* Parse the function name up to 2 lines before tag_line.
1754 * C++ like syntax should be parsed by parse_cpp_function_at_line, otherwise the return
1755 * type or argument names can be confused with the function name. */
1756 static gchar *parse_function_at_line(ScintillaObject *sci, gint tag_line)
1758 gint start, end, max_pos;
1759 gint fn_style;
1761 switch (sci_get_lexer(sci))
1763 case SCLEX_RUBY: fn_style = SCE_RB_DEFNAME; break;
1764 case SCLEX_PYTHON: fn_style = SCE_P_DEFNAME; break;
1765 default: fn_style = SCE_C_IDENTIFIER; /* several lexers use SCE_C_IDENTIFIER */
1767 start = sci_get_position_from_line(sci, tag_line - 2);
1768 max_pos = sci_get_position_from_line(sci, tag_line + 1);
1769 while (start < max_pos && sci_get_style_at(sci, start) != fn_style)
1770 start++;
1772 end = start;
1773 while (end < max_pos && sci_get_style_at(sci, end) == fn_style)
1774 end++;
1776 if (start == end)
1777 return NULL;
1778 return sci_get_contents_range(sci, start, end);
1782 /* Parse the function name */
1783 static gchar *parse_cpp_function_at_line(ScintillaObject *sci, gint tag_line)
1785 gint start, end, first_pos, max_pos;
1786 gint tmp;
1787 gchar c;
1789 first_pos = end = sci_get_position_from_line(sci, tag_line);
1790 max_pos = sci_get_position_from_line(sci, tag_line + 1);
1791 tmp = 0;
1792 /* goto the begin of function body */
1793 while (end < max_pos &&
1794 (tmp = sci_get_char_at(sci, end)) != '{' &&
1795 tmp != 0) end++;
1796 if (tmp == 0) end --;
1798 /* go back to the end of function identifier */
1799 while (end > 0 && end > first_pos - 500 &&
1800 (tmp = sci_get_char_at(sci, end)) != '(' &&
1801 tmp != 0) end--;
1802 end--;
1803 if (end < 0) end = 0;
1805 /* skip whitespaces between identifier and ( */
1806 while (end > 0 && isspace(sci_get_char_at(sci, end))) end--;
1808 start = end;
1809 /* Use tmp to find SCE_C_IDENTIFIER or SCE_C_GLOBALCLASS chars */
1810 while (start >= 0 && ((tmp = sci_get_style_at(sci, start)) == SCE_C_IDENTIFIER
1811 || tmp == SCE_C_GLOBALCLASS
1812 || (c = sci_get_char_at(sci, start)) == '~'
1813 || c == ':'))
1814 start--;
1815 if (start != 0 && start < end) start++; /* correct for last non-matching char */
1817 if (start == end) return NULL;
1818 return sci_get_contents_range(sci, start, end + 1);
1822 /* gets the fold header after or on @line, but skipping folds created because of parentheses */
1823 static gint get_fold_header_after(ScintillaObject *sci, gint line)
1825 const gint line_count = sci_get_line_count(sci);
1827 for (; line < line_count; line++)
1829 if (sci_get_fold_level(sci, line) & SC_FOLDLEVELHEADERFLAG)
1831 const gint last_child = SSM(sci, SCI_GETLASTCHILD, line, -1);
1832 const gint line_end = sci_get_line_end_position(sci, line);
1833 const gint lexer = sci_get_lexer(sci);
1834 gint parenthesis_match_line = -1;
1836 /* now find any unbalanced open parenthesis on the line and see where the matching
1837 * brace would be, mimicking what folding on () does */
1838 for (gint pos = sci_get_position_from_line(sci, line); pos < line_end; pos++)
1840 if (highlighting_is_code_style(lexer, sci_get_style_at(sci, pos)) &&
1841 sci_get_char_at(sci, pos) == '(')
1843 const gint matching = sci_find_matching_brace(sci, pos);
1845 if (matching >= 0)
1847 parenthesis_match_line = sci_get_line_from_position(sci, matching);
1848 if (parenthesis_match_line != line)
1849 break; /* match is on a different line, we found a possible fold */
1850 else
1851 pos = matching; /* just skip the range and continue searching */
1856 /* if the matching parenthesis matches the fold level, skip it and continue.
1857 * it matches if it either spans the same lines, or spans one more but the next one is
1858 * a fold header (in which case the last child of the fold is one less to let the
1859 * header be at the parent level) */
1860 if ((parenthesis_match_line == last_child) ||
1861 (parenthesis_match_line == last_child + 1 &&
1862 sci_get_fold_level(sci, parenthesis_match_line) & SC_FOLDLEVELHEADERFLAG))
1863 line = last_child;
1864 else
1865 return line;
1869 return -1;
1873 static gint get_current_tag_name(GeanyDocument *doc, gchar **tagname, TMTagType tag_types)
1875 gint line;
1876 gint parent;
1878 line = sci_get_current_line(doc->editor->sci);
1879 parent = sci_get_fold_parent(doc->editor->sci, line);
1880 /* if we're inside a fold level and we have up-to-date tags, get the function from TM */
1881 if (parent >= 0 && doc->tm_file != NULL && doc->tm_file->tags_array != NULL &&
1882 (! doc->changed || editor_prefs.autocompletion_update_freq > 0))
1884 const TMTag *tag = tm_get_current_tag(doc->tm_file->tags_array, parent + 1, tag_types);
1886 if (tag)
1888 gint tag_line = tag->line - 1;
1889 gint last_child = line + 1;
1891 /* if it may be a false positive because we're inside a fold level not inside anything
1892 * we match, e.g. a #if in C or C++, we check we're inside the fold level that start
1893 * right after the tag we got from TM.
1894 * Additionally, we perform parentheses matching on the initial line not to get confused
1895 * by folding on () in case the parameter list spans multiple lines */
1896 if (abs(tag_line - parent) > 1)
1898 const gint tag_fold = get_fold_header_after(doc->editor->sci, tag_line);
1899 if (tag_fold >= 0)
1900 last_child = SSM(doc->editor->sci, SCI_GETLASTCHILD, tag_fold, -1);
1903 if (line <= last_child)
1905 if (tag->scope)
1906 *tagname = g_strconcat(tag->scope,
1907 tm_parser_scope_separator(tag->lang), tag->name, NULL);
1908 else
1909 *tagname = g_strdup(tag->name);
1911 return tag_line;
1915 /* for the poor guy with a modified document and without real time tag parsing, we fallback
1916 * to dirty and inaccurate hand-parsing */
1917 else if (parent >= 0 && doc->file_type != NULL && doc->file_type->id != GEANY_FILETYPES_NONE)
1919 const gint fn_fold = get_function_fold_number(doc);
1920 gint tag_line = parent;
1921 gint fold_level = sci_get_fold_level(doc->editor->sci, tag_line);
1923 /* find the top level fold point */
1924 while (tag_line >= 0 && (fold_level & SC_FOLDLEVELNUMBERMASK) != fn_fold)
1926 tag_line = sci_get_fold_parent(doc->editor->sci, tag_line);
1927 fold_level = sci_get_fold_level(doc->editor->sci, tag_line);
1930 if (tag_line >= 0)
1932 gchar *cur_tag;
1934 if (sci_get_lexer(doc->editor->sci) == SCLEX_CPP)
1935 cur_tag = parse_cpp_function_at_line(doc->editor->sci, tag_line);
1936 else
1937 cur_tag = parse_function_at_line(doc->editor->sci, tag_line);
1939 if (cur_tag != NULL)
1941 *tagname = cur_tag;
1942 return tag_line;
1947 *tagname = g_strdup(_("unknown"));
1948 return -1;
1952 static gint get_current_tag_name_cached(GeanyDocument *doc, const gchar **tagname, TMTagType tag_types)
1954 static gint tag_line = -1;
1955 static gchar *cur_tag = NULL;
1957 g_return_val_if_fail(doc == NULL || doc->is_valid, -1);
1959 if (doc == NULL) /* reset current function */
1961 current_tag_changed(NULL, -1, -1, 0);
1962 g_free(cur_tag);
1963 cur_tag = g_strdup(_("unknown"));
1964 if (tagname != NULL)
1965 *tagname = cur_tag;
1966 tag_line = -1;
1968 else
1970 gint line = sci_get_current_line(doc->editor->sci);
1971 gint fold_level = sci_get_fold_level(doc->editor->sci, line);
1973 if (current_tag_changed(doc, line, fold_level, tag_types))
1975 g_free(cur_tag);
1976 tag_line = get_current_tag_name(doc, &cur_tag, tag_types);
1978 *tagname = cur_tag;
1981 return tag_line;
1985 /* Sets *tagname to point at the current function or tag name.
1986 * If doc is NULL, reset the cached current tag data to ensure it will be reparsed on the next
1987 * call to this function.
1988 * Returns: line number of the current tag, or -1 if unknown. */
1989 gint symbols_get_current_function(GeanyDocument *doc, const gchar **tagname)
1991 return get_current_tag_name_cached(doc, tagname, tm_tag_function_t | tm_tag_method_t);
1995 /* same as symbols_get_current_function() but finds class, namespaces and more */
1996 gint symbols_get_current_scope(GeanyDocument *doc, const gchar **tagname)
1998 TMTagType tag_types = (tm_tag_function_t | tm_tag_method_t | tm_tag_class_t |
1999 tm_tag_struct_t | tm_tag_enum_t | tm_tag_union_t | tm_tag_namespace_t);
2001 return get_current_tag_name_cached(doc, tagname, tag_types);
2005 const gchar *symbols_get_icon_name(guint icon_id)
2007 if (icon_id < TM_N_ICONS)
2008 return symbols_icons[icon_id].icon_name;
2009 return NULL;
2013 static void on_symbol_tree_sort_clicked(GtkMenuItem *menuitem, gpointer user_data)
2015 gint sort_mode = GPOINTER_TO_INT(user_data);
2016 GeanyDocument *doc = document_get_current();
2018 if (ignore_callback)
2019 return;
2021 if (doc != NULL)
2022 doc->has_tags = symbols_recreate_tag_list(doc, sort_mode);
2025 static void on_symbol_tree_group_by_type_clicked(GtkMenuItem *menuitem, gpointer user_data)
2027 GeanyDocument *doc = document_get_current();
2029 if (ignore_callback)
2030 return;
2032 ui_prefs.symbols_group_by_type = gtk_check_menu_item_get_active(GTK_CHECK_MENU_ITEM(menuitem));
2033 if (doc != NULL)
2034 doc->has_tags = symbols_recreate_tag_list(doc, SYMBOLS_SORT_USE_PREVIOUS);
2037 static void on_symbol_tree_menu_show(GtkWidget *widget,
2038 gpointer user_data)
2040 GeanyDocument *doc = document_get_current();
2041 gboolean enable;
2043 enable = doc && doc->has_tags;
2044 gtk_widget_set_sensitive(symbol_menu.sort_by_name, enable);
2045 gtk_widget_set_sensitive(symbol_menu.sort_by_appearance, enable);
2046 gtk_widget_set_sensitive(symbol_menu.group_by_type, enable);
2047 gtk_widget_set_sensitive(symbol_menu.expand_all, enable);
2048 gtk_widget_set_sensitive(symbol_menu.collapse_all, enable);
2049 gtk_widget_set_sensitive(symbol_menu.find_usage, enable);
2050 gtk_widget_set_sensitive(symbol_menu.find_doc_usage, enable);
2052 if (! doc)
2053 return;
2055 ignore_callback = TRUE;
2057 if (doc->priv->symbol_list_sort_mode == SYMBOLS_SORT_BY_NAME)
2058 gtk_check_menu_item_set_active(GTK_CHECK_MENU_ITEM(symbol_menu.sort_by_name), TRUE);
2059 else
2060 gtk_check_menu_item_set_active(GTK_CHECK_MENU_ITEM(symbol_menu.sort_by_appearance), TRUE);
2062 gtk_check_menu_item_set_active(GTK_CHECK_MENU_ITEM(symbol_menu.group_by_type),
2063 ui_prefs.symbols_group_by_type);
2065 ignore_callback = FALSE;
2069 static void on_expand_collapse(GtkWidget *widget, gpointer user_data)
2071 gboolean expand = GPOINTER_TO_INT(user_data);
2072 GeanyDocument *doc = document_get_current();
2074 if (! doc)
2075 return;
2077 g_return_if_fail(doc->priv->tag_tree);
2079 if (expand)
2080 gtk_tree_view_expand_all(GTK_TREE_VIEW(doc->priv->tag_tree));
2081 else
2082 gtk_tree_view_collapse_all(GTK_TREE_VIEW(doc->priv->tag_tree));
2086 static void on_find_usage(GtkWidget *widget, G_GNUC_UNUSED gpointer unused)
2088 GtkTreeIter iter;
2089 GtkTreeSelection *selection;
2090 GtkTreeModel *model;
2091 GeanyDocument *doc;
2092 TMTag *tag = NULL;
2094 doc = document_get_current();
2095 if (!doc)
2096 return;
2098 selection = gtk_tree_view_get_selection(GTK_TREE_VIEW(doc->priv->tag_tree));
2099 if (gtk_tree_selection_get_selected(selection, &model, &iter))
2100 gtk_tree_model_get(model, &iter, SYMBOLS_COLUMN_TAG, &tag, -1);
2101 if (tag)
2103 if (widget == symbol_menu.find_in_files)
2104 search_show_find_in_files_dialog_full(tag->name, NULL);
2105 else
2106 search_find_usage(tag->name, tag->name, GEANY_FIND_WHOLEWORD | GEANY_FIND_MATCHCASE,
2107 widget == symbol_menu.find_usage);
2109 tm_tag_unref(tag);
2114 static void create_taglist_popup_menu(void)
2116 GtkWidget *item, *menu;
2118 tv.popup_taglist = menu = gtk_menu_new();
2120 symbol_menu.expand_all = item = ui_image_menu_item_new(GTK_STOCK_ADD, _("_Expand All"));
2121 gtk_widget_show(item);
2122 gtk_container_add(GTK_CONTAINER(menu), item);
2123 g_signal_connect(item, "activate", G_CALLBACK(on_expand_collapse), GINT_TO_POINTER(TRUE));
2125 symbol_menu.collapse_all = item = ui_image_menu_item_new(GTK_STOCK_REMOVE, _("_Collapse All"));
2126 gtk_widget_show(item);
2127 gtk_container_add(GTK_CONTAINER(menu), item);
2128 g_signal_connect(item, "activate", G_CALLBACK(on_expand_collapse), GINT_TO_POINTER(FALSE));
2130 item = gtk_separator_menu_item_new();
2131 gtk_widget_show(item);
2132 gtk_container_add(GTK_CONTAINER(menu), item);
2134 symbol_menu.sort_by_name = item = gtk_radio_menu_item_new_with_mnemonic(NULL,
2135 _("Sort by _Name"));
2136 gtk_widget_show(item);
2137 gtk_container_add(GTK_CONTAINER(menu), item);
2138 g_signal_connect(item, "activate", G_CALLBACK(on_symbol_tree_sort_clicked),
2139 GINT_TO_POINTER(SYMBOLS_SORT_BY_NAME));
2141 symbol_menu.sort_by_appearance = item = gtk_radio_menu_item_new_with_mnemonic_from_widget(
2142 GTK_RADIO_MENU_ITEM(item), _("Sort by _Appearance"));
2143 gtk_widget_show(item);
2144 gtk_container_add(GTK_CONTAINER(menu), item);
2145 g_signal_connect(item, "activate", G_CALLBACK(on_symbol_tree_sort_clicked),
2146 GINT_TO_POINTER(SYMBOLS_SORT_BY_APPEARANCE));
2148 item = gtk_separator_menu_item_new();
2149 gtk_widget_show(item);
2150 gtk_container_add(GTK_CONTAINER(menu), item);
2152 symbol_menu.group_by_type = item = gtk_check_menu_item_new_with_mnemonic(_("_Group by Type"));
2153 gtk_widget_show(item);
2154 gtk_container_add(GTK_CONTAINER(menu), item);
2155 g_signal_connect(item, "activate", G_CALLBACK(on_symbol_tree_group_by_type_clicked), NULL);
2157 item = gtk_separator_menu_item_new();
2158 gtk_widget_show(item);
2159 gtk_container_add(GTK_CONTAINER(menu), item);
2161 symbol_menu.find_usage = item = ui_image_menu_item_new(GTK_STOCK_FIND, _("Find _Usage"));
2162 gtk_widget_show(item);
2163 gtk_container_add(GTK_CONTAINER(menu), item);
2164 g_signal_connect(item, "activate", G_CALLBACK(on_find_usage), symbol_menu.find_usage);
2166 symbol_menu.find_doc_usage = item = ui_image_menu_item_new(GTK_STOCK_FIND, _("Find _Document Usage"));
2167 gtk_widget_show(item);
2168 gtk_container_add(GTK_CONTAINER(menu), item);
2169 g_signal_connect(item, "activate", G_CALLBACK(on_find_usage), symbol_menu.find_doc_usage);
2171 symbol_menu.find_in_files = item = ui_image_menu_item_new(GTK_STOCK_FIND, _("Find in F_iles..."));
2172 gtk_widget_show(item);
2173 gtk_container_add(GTK_CONTAINER(menu), item);
2174 g_signal_connect(item, "activate", G_CALLBACK(on_find_usage), NULL);
2176 g_signal_connect(menu, "show", G_CALLBACK(on_symbol_tree_menu_show), NULL);
2178 sidebar_add_common_menu_items(GTK_MENU(menu));
2182 static void on_document_save(G_GNUC_UNUSED GObject *object, GeanyDocument *doc)
2184 gchar *f;
2186 g_return_if_fail(!EMPTY(doc->real_path));
2188 f = g_build_filename(app->configdir, "ignore.tags", NULL);
2189 if (utils_str_equal(doc->real_path, f))
2190 load_c_ignore_tags();
2192 g_free(f);
2196 void symbols_init(void)
2198 gchar *f;
2199 guint i;
2201 create_taglist_popup_menu();
2203 f = g_build_filename(app->configdir, "ignore.tags", NULL);
2204 ui_add_config_file_menu_item(f, NULL, NULL);
2205 g_free(f);
2207 g_signal_connect(geany_object, "document-save", G_CALLBACK(on_document_save), NULL);
2209 for (i = 0; i < G_N_ELEMENTS(symbols_icons); i++)
2210 symbols_icons[i].pixbuf = get_tag_icon(symbols_icons[i].icon_name);
2214 void symbols_finalize(void)
2216 guint i;
2218 g_strfreev(c_tags_ignore);
2220 for (i = 0; i < G_N_ELEMENTS(symbols_icons); i++)
2222 if (symbols_icons[i].pixbuf)
2223 g_object_unref(symbols_icons[i].pixbuf);