Opening recent projects: Don't ask whether to close current project
[geany-mirror.git] / src / symbols.c
blobc4d017f175dd033c1a911a59b93ce6fbed25ec26
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 "ui_utils.h"
55 #include "utils.h"
57 #include "SciLexer.h"
59 #include "gtkcompat.h"
61 #include <ctype.h>
62 #include <string.h>
63 #include <stdlib.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;
76 enum
78 ICON_CLASS,
79 ICON_MACRO,
80 ICON_MEMBER,
81 ICON_METHOD,
82 ICON_NAMESPACE,
83 ICON_OTHER,
84 ICON_STRUCT,
85 ICON_VAR,
86 ICON_NONE,
87 N_ICONS = ICON_NONE
90 static struct
92 const gchar *icon_name;
93 GdkPixbuf *pixbuf;
95 symbols_icons[N_ICONS] = {
96 [ICON_CLASS] = { "classviewer-class", NULL },
97 [ICON_MACRO] = { "classviewer-macro", NULL },
98 [ICON_MEMBER] = { "classviewer-member", NULL },
99 [ICON_METHOD] = { "classviewer-method", NULL },
100 [ICON_NAMESPACE] = { "classviewer-namespace", NULL },
101 [ICON_OTHER] = { "classviewer-other", NULL },
102 [ICON_STRUCT] = { "classviewer-struct", NULL },
103 [ICON_VAR] = { "classviewer-var", NULL },
106 static struct
108 GtkWidget *expand_all;
109 GtkWidget *collapse_all;
110 GtkWidget *sort_by_name;
111 GtkWidget *sort_by_appearance;
112 GtkWidget *find_usage;
113 GtkWidget *find_doc_usage;
114 GtkWidget *find_in_files;
116 symbol_menu;
118 static void load_user_tags(GeanyFiletypeID ft_id);
120 /* get the tags_ignore list, exported by tagmanager's geany.c */
121 extern gchar **c_tags_ignore;
123 /* ignore certain tokens when parsing C-like syntax.
124 * Also works for reloading. */
125 static void load_c_ignore_tags(void)
127 gchar *path = g_build_filename(app->configdir, "ignore.tags", NULL);
128 gchar *content;
130 if (g_file_get_contents(path, &content, NULL, NULL))
132 /* historically we ignore the glib _DECLS for tag generation */
133 SETPTR(content, g_strconcat("G_BEGIN_DECLS G_END_DECLS\n", content, NULL));
135 g_strfreev(c_tags_ignore);
136 c_tags_ignore = g_strsplit_set(content, " \n\r", -1);
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_context_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;
313 g_return_val_if_fail(doc, NULL);
315 if (! doc->tm_file || ! doc->tm_file->tags_array)
316 return NULL;
318 for (i = 0; i < doc->tm_file->tags_array->len; ++i)
320 TMTag *tag = TM_TAG(doc->tm_file->tags_array->pdata[i]);
322 if (G_UNLIKELY(tag == NULL))
323 return NULL;
325 if (tag->type & tag_types)
327 tag_names = g_list_prepend(tag_names, tag);
330 tag_names = g_list_sort(tag_names, compare_symbol_lines);
331 return tag_names;
335 /* amount of types in the symbol list (currently max. 8 are used) */
336 #define MAX_SYMBOL_TYPES (sizeof(tv_iters) / sizeof(GtkTreeIter))
338 struct TreeviewSymbols
340 GtkTreeIter tag_function;
341 GtkTreeIter tag_class;
342 GtkTreeIter tag_macro;
343 GtkTreeIter tag_member;
344 GtkTreeIter tag_variable;
345 GtkTreeIter tag_externvar;
346 GtkTreeIter tag_namespace;
347 GtkTreeIter tag_struct;
348 GtkTreeIter tag_interface;
349 GtkTreeIter tag_type;
350 GtkTreeIter tag_other;
351 } tv_iters;
354 static void init_tag_iters(void)
356 /* init all GtkTreeIters with -1 to make them invalid to avoid crashes when switching between
357 * filetypes(e.g. config file to Python crashes Geany without this) */
358 tv_iters.tag_function.stamp = -1;
359 tv_iters.tag_class.stamp = -1;
360 tv_iters.tag_member.stamp = -1;
361 tv_iters.tag_macro.stamp = -1;
362 tv_iters.tag_variable.stamp = -1;
363 tv_iters.tag_externvar.stamp = -1;
364 tv_iters.tag_namespace.stamp = -1;
365 tv_iters.tag_struct.stamp = -1;
366 tv_iters.tag_interface.stamp = -1;
367 tv_iters.tag_type.stamp = -1;
368 tv_iters.tag_other.stamp = -1;
372 static GdkPixbuf *get_tag_icon(const gchar *icon_name)
374 static GtkIconTheme *icon_theme = NULL;
375 static gint x = -1;
377 if (G_UNLIKELY(x < 0))
379 gint dummy;
380 icon_theme = gtk_icon_theme_get_default();
381 gtk_icon_size_lookup(GTK_ICON_SIZE_MENU, &x, &dummy);
383 return gtk_icon_theme_load_icon(icon_theme, icon_name, x, 0, NULL);
387 static gboolean find_toplevel_iter(GtkTreeStore *store, GtkTreeIter *iter, const gchar *title)
389 GtkTreeModel *model = GTK_TREE_MODEL(store);
391 if (!gtk_tree_model_get_iter_first(model, iter))
392 return FALSE;
395 gchar *candidate;
397 gtk_tree_model_get(model, iter, SYMBOLS_COLUMN_NAME, &candidate, -1);
398 /* FIXME: what if 2 different items have the same name?
399 * this should never happen, but might be caused by a typo in a translation */
400 if (utils_str_equal(candidate, title))
402 g_free(candidate);
403 return TRUE;
405 else
406 g_free(candidate);
408 while (gtk_tree_model_iter_next(model, iter));
410 return FALSE;
414 /* Adds symbol list groups in (iter*, title) pairs.
415 * The list must be ended with NULL. */
416 static void G_GNUC_NULL_TERMINATED
417 tag_list_add_groups(GtkTreeStore *tree_store, ...)
419 va_list args;
420 GtkTreeIter *iter;
422 g_return_if_fail(top_level_iter_names);
424 va_start(args, tree_store);
425 for (; iter = va_arg(args, GtkTreeIter*), iter != NULL;)
427 gchar *title = va_arg(args, gchar*);
428 guint icon_id = va_arg(args, guint);
429 GdkPixbuf *icon = NULL;
431 if (icon_id < N_ICONS)
432 icon = symbols_icons[icon_id].pixbuf;
434 g_assert(title != NULL);
435 g_ptr_array_add(top_level_iter_names, title);
437 if (!find_toplevel_iter(tree_store, iter, title))
438 gtk_tree_store_append(tree_store, iter, NULL);
440 if (icon)
441 gtk_tree_store_set(tree_store, iter, SYMBOLS_COLUMN_ICON, icon, -1);
442 gtk_tree_store_set(tree_store, iter, SYMBOLS_COLUMN_NAME, title, -1);
444 va_end(args);
448 static void add_top_level_items(GeanyDocument *doc)
450 GeanyFiletypeID ft_id = doc->file_type->id;
451 GtkTreeStore *tag_store = doc->priv->tag_store;
453 if (top_level_iter_names == NULL)
454 top_level_iter_names = g_ptr_array_new();
455 else
456 g_ptr_array_set_size(top_level_iter_names, 0);
458 init_tag_iters();
460 switch (ft_id)
462 case GEANY_FILETYPES_DIFF:
464 tag_list_add_groups(tag_store,
465 &(tv_iters.tag_function), _("Files"), ICON_NONE, NULL);
466 break;
468 case GEANY_FILETYPES_DOCBOOK:
470 tag_list_add_groups(tag_store,
471 &(tv_iters.tag_function), _("Chapter"), ICON_NONE,
472 &(tv_iters.tag_class), _("Section"), ICON_NONE,
473 &(tv_iters.tag_member), _("Sect1"), ICON_NONE,
474 &(tv_iters.tag_macro), _("Sect2"), ICON_NONE,
475 &(tv_iters.tag_variable), _("Sect3"), ICON_NONE,
476 &(tv_iters.tag_struct), _("Appendix"), ICON_NONE,
477 &(tv_iters.tag_other), _("Other"), ICON_NONE,
478 NULL);
479 break;
481 case GEANY_FILETYPES_HASKELL:
482 tag_list_add_groups(tag_store,
483 &tv_iters.tag_namespace, _("Module"), ICON_NONE,
484 &tv_iters.tag_type, _("Types"), ICON_NONE,
485 &tv_iters.tag_macro, _("Type constructors"), ICON_NONE,
486 &tv_iters.tag_function, _("Functions"), ICON_METHOD,
487 NULL);
488 break;
489 case GEANY_FILETYPES_COBOL:
490 tag_list_add_groups(tag_store,
491 &tv_iters.tag_class, _("Program"), ICON_CLASS,
492 &tv_iters.tag_function, _("File"), ICON_METHOD,
493 &tv_iters.tag_interface, _("Divisions"), ICON_NAMESPACE,
494 &tv_iters.tag_namespace, _("Sections"), ICON_NAMESPACE,
495 &tv_iters.tag_macro, _("Paragraph"), ICON_OTHER,
496 &tv_iters.tag_struct, _("Group"), ICON_STRUCT,
497 &tv_iters.tag_variable, _("Data"), ICON_VAR,
498 &tv_iters.tag_externvar, _("Copies"), ICON_NAMESPACE,
499 NULL);
500 break;
501 case GEANY_FILETYPES_CONF:
502 tag_list_add_groups(tag_store,
503 &tv_iters.tag_namespace, _("Sections"), ICON_OTHER,
504 &tv_iters.tag_macro, _("Keys"), ICON_VAR,
505 NULL);
506 break;
507 case GEANY_FILETYPES_NSIS:
508 tag_list_add_groups(tag_store,
509 &tv_iters.tag_namespace, _("Sections"), ICON_OTHER,
510 &tv_iters.tag_function, _("Functions"), ICON_METHOD,
511 &(tv_iters.tag_variable), _("Variables"), ICON_VAR,
512 NULL);
513 break;
514 case GEANY_FILETYPES_LATEX:
516 tag_list_add_groups(tag_store,
517 &(tv_iters.tag_function), _("Command"), ICON_NONE,
518 &(tv_iters.tag_class), _("Environment"), ICON_NONE,
519 &(tv_iters.tag_member), _("Section"), ICON_NONE,
520 &(tv_iters.tag_macro), _("Subsection"), ICON_NONE,
521 &(tv_iters.tag_variable), _("Subsubsection"), ICON_NONE,
522 &(tv_iters.tag_struct), _("Label"), ICON_NONE,
523 &(tv_iters.tag_namespace), _("Chapter"), ICON_NONE,
524 &(tv_iters.tag_other), _("Other"), ICON_NONE,
525 NULL);
526 break;
528 case GEANY_FILETYPES_MATLAB:
530 tag_list_add_groups(tag_store,
531 &(tv_iters.tag_function), _("Functions"), ICON_METHOD,
532 &(tv_iters.tag_struct), _("Structures"), ICON_STRUCT,
533 NULL);
534 break;
536 case GEANY_FILETYPES_ABAQUS:
538 tag_list_add_groups(tag_store,
539 &(tv_iters.tag_class), _("Parts"), ICON_NONE,
540 &(tv_iters.tag_member), _("Assembly"), ICON_NONE,
541 &(tv_iters.tag_namespace), _("Steps"), ICON_NONE,
542 NULL);
543 break;
545 case GEANY_FILETYPES_R:
547 tag_list_add_groups(tag_store,
548 &(tv_iters.tag_function), _("Functions"), ICON_METHOD,
549 &(tv_iters.tag_other), _("Other"), ICON_NONE,
550 NULL);
551 break;
553 case GEANY_FILETYPES_RUST:
555 tag_list_add_groups(tag_store,
556 &(tv_iters.tag_namespace), _("Modules"), ICON_NAMESPACE,
557 &(tv_iters.tag_struct), _("Structures"), ICON_STRUCT,
558 &(tv_iters.tag_interface), _("Traits"), ICON_CLASS,
559 &(tv_iters.tag_class), _("Implementations"), ICON_CLASS,
560 &(tv_iters.tag_function), _("Functions"), ICON_METHOD,
561 &(tv_iters.tag_type), _("Typedefs / Enums"), ICON_STRUCT,
562 &(tv_iters.tag_variable), _("Variables"), ICON_VAR,
563 &(tv_iters.tag_macro), _("Macros"), ICON_MACRO,
564 &(tv_iters.tag_member), _("Methods"), ICON_MEMBER,
565 &(tv_iters.tag_other), _("Other"), ICON_OTHER,
566 NULL);
567 break;
569 case GEANY_FILETYPES_GO:
571 tag_list_add_groups(tag_store,
572 &(tv_iters.tag_namespace), _("Package"), ICON_NAMESPACE,
573 &(tv_iters.tag_function), _("Functions"), ICON_METHOD,
574 &(tv_iters.tag_interface), _("Interfaces"), ICON_STRUCT,
575 &(tv_iters.tag_struct), _("Structs"), ICON_STRUCT,
576 &(tv_iters.tag_type), _("Types"), ICON_STRUCT,
577 &(tv_iters.tag_macro), _("Constants"), ICON_MACRO,
578 &(tv_iters.tag_variable), _("Variables"), ICON_VAR,
579 &(tv_iters.tag_member), _("Members"), ICON_MEMBER,
580 &(tv_iters.tag_other), _("Other"), ICON_OTHER,
581 NULL);
582 break;
584 case GEANY_FILETYPES_PERL:
586 tag_list_add_groups(tag_store,
587 &(tv_iters.tag_namespace), _("Package"), ICON_NAMESPACE,
588 &(tv_iters.tag_function), _("Functions"), ICON_METHOD,
589 &(tv_iters.tag_macro), _("Labels"), ICON_NONE,
590 &(tv_iters.tag_type), _("Constants"), ICON_NONE,
591 &(tv_iters.tag_other), _("Other"), ICON_OTHER,
592 NULL);
593 break;
595 case GEANY_FILETYPES_PHP:
596 case GEANY_FILETYPES_ZEPHIR:
598 tag_list_add_groups(tag_store,
599 &(tv_iters.tag_namespace), _("Namespaces"), ICON_NAMESPACE,
600 &(tv_iters.tag_interface), _("Interfaces"), ICON_STRUCT,
601 &(tv_iters.tag_class), _("Classes"), ICON_CLASS,
602 &(tv_iters.tag_function), _("Functions"), ICON_METHOD,
603 &(tv_iters.tag_macro), _("Constants"), ICON_MACRO,
604 &(tv_iters.tag_variable), _("Variables"), ICON_VAR,
605 &(tv_iters.tag_struct), _("Traits"), ICON_STRUCT,
606 NULL);
607 break;
609 case GEANY_FILETYPES_HTML:
611 tag_list_add_groups(tag_store,
612 &(tv_iters.tag_function), _("Functions"), ICON_NONE,
613 &(tv_iters.tag_member), _("Anchors"), ICON_NONE,
614 &(tv_iters.tag_namespace), _("H1 Headings"), ICON_NONE,
615 &(tv_iters.tag_class), _("H2 Headings"), ICON_NONE,
616 &(tv_iters.tag_variable), _("H3 Headings"), ICON_NONE,
617 NULL);
618 break;
620 case GEANY_FILETYPES_CSS:
622 tag_list_add_groups(tag_store,
623 &(tv_iters.tag_class), _("Classes"), ICON_CLASS,
624 &(tv_iters.tag_variable), _("ID Selectors"), ICON_VAR,
625 &(tv_iters.tag_struct), _("Type Selectors"), ICON_STRUCT, NULL);
626 break;
628 case GEANY_FILETYPES_REST:
629 case GEANY_FILETYPES_TXT2TAGS:
630 case GEANY_FILETYPES_ABC:
632 tag_list_add_groups(tag_store,
633 &(tv_iters.tag_namespace), _("Chapter"), ICON_NONE,
634 &(tv_iters.tag_member), _("Section"), ICON_NONE,
635 &(tv_iters.tag_macro), _("Subsection"), ICON_NONE,
636 &(tv_iters.tag_variable), _("Subsubsection"), ICON_NONE,
637 NULL);
638 break;
640 case GEANY_FILETYPES_ASCIIDOC:
642 tag_list_add_groups(tag_store,
643 &(tv_iters.tag_namespace), _("Document"), ICON_NONE,
644 &(tv_iters.tag_member), _("Section Level 1"), ICON_NONE,
645 &(tv_iters.tag_macro), _("Section Level 2"), ICON_NONE,
646 &(tv_iters.tag_variable), _("Section Level 3"), ICON_NONE,
647 &(tv_iters.tag_struct), _("Section Level 4"), ICON_NONE,
648 NULL);
649 break;
651 case GEANY_FILETYPES_RUBY:
653 tag_list_add_groups(tag_store,
654 &(tv_iters.tag_namespace), _("Modules"), ICON_NAMESPACE,
655 &(tv_iters.tag_class), _("Classes"), ICON_CLASS,
656 &(tv_iters.tag_member), _("Singletons"), ICON_STRUCT,
657 &(tv_iters.tag_function), _("Methods"), ICON_METHOD,
658 NULL);
659 break;
661 case GEANY_FILETYPES_TCL:
663 tag_list_add_groups(tag_store,
664 &(tv_iters.tag_namespace), _("Namespaces"), ICON_NAMESPACE,
665 &(tv_iters.tag_class), _("Classes"), ICON_CLASS,
666 &(tv_iters.tag_member), _("Methods"), ICON_METHOD,
667 &(tv_iters.tag_function), _("Procedures"), ICON_OTHER,
668 NULL);
669 break;
671 case GEANY_FILETYPES_PYTHON:
673 tag_list_add_groups(tag_store,
674 &(tv_iters.tag_class), _("Classes"), ICON_CLASS,
675 &(tv_iters.tag_member), _("Methods"), ICON_MACRO,
676 &(tv_iters.tag_function), _("Functions"), ICON_METHOD,
677 &(tv_iters.tag_variable), _("Variables"), ICON_VAR,
678 &(tv_iters.tag_externvar), _("Imports"), ICON_NAMESPACE,
679 NULL);
680 break;
682 case GEANY_FILETYPES_VHDL:
684 tag_list_add_groups(tag_store,
685 &(tv_iters.tag_namespace), _("Package"), ICON_NAMESPACE,
686 &(tv_iters.tag_class), _("Entities"), ICON_CLASS,
687 &(tv_iters.tag_struct), _("Architectures"), ICON_STRUCT,
688 &(tv_iters.tag_type), _("Types"), ICON_OTHER,
689 &(tv_iters.tag_function), _("Functions / Procedures"), ICON_METHOD,
690 &(tv_iters.tag_variable), _("Variables / Signals"), ICON_VAR,
691 &(tv_iters.tag_member), _("Processes / Blocks / Components"), ICON_MEMBER,
692 &(tv_iters.tag_other), _("Other"), ICON_OTHER,
693 NULL);
694 break;
696 case GEANY_FILETYPES_VERILOG:
698 tag_list_add_groups(tag_store,
699 &(tv_iters.tag_type), _("Events"), ICON_MACRO,
700 &(tv_iters.tag_class), _("Modules"), ICON_CLASS,
701 &(tv_iters.tag_function), _("Functions / Tasks"), ICON_METHOD,
702 &(tv_iters.tag_variable), _("Variables"), ICON_VAR,
703 &(tv_iters.tag_other), _("Other"), ICON_OTHER,
704 NULL);
705 break;
707 case GEANY_FILETYPES_JAVA:
709 tag_list_add_groups(tag_store,
710 &(tv_iters.tag_namespace), _("Package"), ICON_NAMESPACE,
711 &(tv_iters.tag_interface), _("Interfaces"), ICON_STRUCT,
712 &(tv_iters.tag_class), _("Classes"), ICON_CLASS,
713 &(tv_iters.tag_function), _("Methods"), ICON_METHOD,
714 &(tv_iters.tag_member), _("Members"), ICON_MEMBER,
715 &(tv_iters.tag_type), _("Enums"), ICON_STRUCT,
716 &(tv_iters.tag_other), _("Other"), ICON_OTHER,
717 NULL);
718 break;
720 case GEANY_FILETYPES_AS:
722 tag_list_add_groups(tag_store,
723 &(tv_iters.tag_externvar), _("Imports"), ICON_NAMESPACE,
724 &(tv_iters.tag_namespace), _("Package"), ICON_NAMESPACE,
725 &(tv_iters.tag_interface), _("Interfaces"), ICON_STRUCT,
726 &(tv_iters.tag_class), _("Classes"), ICON_CLASS,
727 &(tv_iters.tag_function), _("Functions"), ICON_METHOD,
728 &(tv_iters.tag_member), _("Properties"), ICON_MEMBER,
729 &(tv_iters.tag_variable), _("Variables"), ICON_VAR,
730 &(tv_iters.tag_macro), _("Constants"), ICON_MACRO,
731 &(tv_iters.tag_other), _("Other"), ICON_OTHER,
732 NULL);
733 break;
735 case GEANY_FILETYPES_HAXE:
737 tag_list_add_groups(tag_store,
738 &(tv_iters.tag_interface), _("Interfaces"), ICON_STRUCT,
739 &(tv_iters.tag_class), _("Classes"), ICON_CLASS,
740 &(tv_iters.tag_function), _("Methods"), ICON_METHOD,
741 &(tv_iters.tag_type), _("Types"), ICON_MACRO,
742 &(tv_iters.tag_variable), _("Variables"), ICON_VAR,
743 &(tv_iters.tag_other), _("Other"), ICON_OTHER,
744 NULL);
745 break;
747 case GEANY_FILETYPES_BASIC:
749 tag_list_add_groups(tag_store,
750 &(tv_iters.tag_function), _("Functions"), ICON_METHOD,
751 &(tv_iters.tag_variable), _("Variables"), ICON_VAR,
752 &(tv_iters.tag_macro), _("Constants"), ICON_MACRO,
753 &(tv_iters.tag_struct), _("Types"), ICON_NAMESPACE,
754 &(tv_iters.tag_namespace), _("Labels"), ICON_MEMBER,
755 &(tv_iters.tag_other), _("Other"), ICON_OTHER,
756 NULL);
757 break;
759 case GEANY_FILETYPES_F77:
760 case GEANY_FILETYPES_FORTRAN:
762 tag_list_add_groups(tag_store,
763 &(tv_iters.tag_namespace), _("Module"), ICON_CLASS,
764 &(tv_iters.tag_struct), _("Programs"), ICON_CLASS,
765 &(tv_iters.tag_interface), _("Interfaces"), ICON_STRUCT,
766 &(tv_iters.tag_function), _("Functions / Subroutines"), ICON_METHOD,
767 &(tv_iters.tag_variable), _("Variables"), ICON_VAR,
768 &(tv_iters.tag_class), _("Types"), ICON_CLASS,
769 &(tv_iters.tag_member), _("Components"), ICON_MEMBER,
770 &(tv_iters.tag_macro), _("Blocks"), ICON_MEMBER,
771 &(tv_iters.tag_type), _("Enums"), ICON_STRUCT,
772 &(tv_iters.tag_other), _("Other"), ICON_OTHER,
773 NULL);
774 break;
776 case GEANY_FILETYPES_ASM:
778 tag_list_add_groups(tag_store,
779 &(tv_iters.tag_namespace), _("Labels"), ICON_NAMESPACE,
780 &(tv_iters.tag_function), _("Macros"), ICON_METHOD,
781 &(tv_iters.tag_macro), _("Defines"), ICON_MACRO,
782 &(tv_iters.tag_struct), _("Types"), ICON_STRUCT,
783 NULL);
784 break;
786 case GEANY_FILETYPES_MAKE:
787 tag_list_add_groups(tag_store,
788 &tv_iters.tag_function, _("Targets"), ICON_METHOD,
789 &tv_iters.tag_macro, _("Macros"), ICON_MACRO,
790 NULL);
791 break;
792 case GEANY_FILETYPES_SQL:
794 tag_list_add_groups(tag_store,
795 &(tv_iters.tag_function), _("Functions"), ICON_METHOD,
796 &(tv_iters.tag_namespace), _("Procedures"), ICON_NAMESPACE,
797 &(tv_iters.tag_struct), _("Indexes"), ICON_STRUCT,
798 &(tv_iters.tag_class), _("Tables"), ICON_CLASS,
799 &(tv_iters.tag_macro), _("Triggers"), ICON_MACRO,
800 &(tv_iters.tag_member), _("Views"), ICON_VAR,
801 &(tv_iters.tag_other), _("Other"), ICON_OTHER,
802 &(tv_iters.tag_variable), _("Variables"), ICON_VAR,
803 NULL);
804 break;
806 case GEANY_FILETYPES_D:
807 default:
809 if (ft_id == GEANY_FILETYPES_D)
810 tag_list_add_groups(tag_store,
811 &(tv_iters.tag_namespace), _("Module"), ICON_NONE, NULL);
812 else
813 tag_list_add_groups(tag_store,
814 &(tv_iters.tag_namespace), _("Namespaces"), ICON_NAMESPACE, NULL);
816 tag_list_add_groups(tag_store,
817 &(tv_iters.tag_class), _("Classes"), ICON_CLASS,
818 &(tv_iters.tag_interface), _("Interfaces"), ICON_STRUCT,
819 &(tv_iters.tag_function), _("Functions"), ICON_METHOD,
820 &(tv_iters.tag_member), _("Members"), ICON_MEMBER,
821 &(tv_iters.tag_struct), _("Structs"), ICON_STRUCT,
822 &(tv_iters.tag_type), _("Typedefs / Enums"), ICON_STRUCT,
823 NULL);
825 if (ft_id != GEANY_FILETYPES_D)
827 tag_list_add_groups(tag_store,
828 &(tv_iters.tag_macro), _("Macros"), ICON_MACRO, NULL);
830 tag_list_add_groups(tag_store,
831 &(tv_iters.tag_variable), _("Variables"), ICON_VAR,
832 &(tv_iters.tag_externvar), _("Extern Variables"), ICON_VAR,
833 &(tv_iters.tag_other), _("Other"), ICON_OTHER, NULL);
839 /* removes toplevel items that have no children */
840 static void hide_empty_rows(GtkTreeStore *store)
842 GtkTreeIter iter;
843 gboolean cont = TRUE;
845 if (! gtk_tree_model_get_iter_first(GTK_TREE_MODEL(store), &iter))
846 return; /* stop when first iter is invalid, i.e. no elements */
848 while (cont)
850 if (! gtk_tree_model_iter_has_child(GTK_TREE_MODEL(store), &iter))
851 cont = gtk_tree_store_remove(store, &iter);
852 else
853 cont = gtk_tree_model_iter_next(GTK_TREE_MODEL(store), &iter);
858 static const gchar *get_symbol_name(GeanyDocument *doc, const TMTag *tag, gboolean found_parent)
860 gchar *utf8_name;
861 const gchar *scope = tag->scope;
862 static GString *buffer = NULL; /* buffer will be small so we can keep it for reuse */
863 gboolean doc_is_utf8 = FALSE;
865 /* encodings_convert_to_utf8_from_charset() fails with charset "None", so skip conversion
866 * for None at this point completely */
867 if (utils_str_equal(doc->encoding, "UTF-8") ||
868 utils_str_equal(doc->encoding, "None"))
869 doc_is_utf8 = TRUE;
870 else /* normally the tags will always be in UTF-8 since we parse from our buffer, but a
871 * plugin might have called tm_source_file_update(), so check to be sure */
872 doc_is_utf8 = g_utf8_validate(tag->name, -1, NULL);
874 if (! doc_is_utf8)
875 utf8_name = encodings_convert_to_utf8_from_charset(tag->name,
876 -1, doc->encoding, TRUE);
877 else
878 utf8_name = tag->name;
880 if (utf8_name == NULL)
881 return NULL;
883 if (! buffer)
884 buffer = g_string_new(NULL);
885 else
886 g_string_truncate(buffer, 0);
888 /* check first char of scope is a wordchar */
889 if (!found_parent && scope &&
890 strpbrk(scope, GEANY_WORDCHARS) == scope)
892 const gchar *sep = symbols_get_context_separator(doc->file_type->id);
894 g_string_append(buffer, scope);
895 g_string_append(buffer, sep);
897 g_string_append(buffer, utf8_name);
899 if (! doc_is_utf8)
900 g_free(utf8_name);
902 g_string_append_printf(buffer, " [%lu]", tag->line);
904 return buffer->str;
908 static gchar *get_symbol_tooltip(GeanyDocument *doc, const TMTag *tag)
910 gchar *utf8_name = editor_get_calltip_text(doc->editor, tag);
912 if (!utf8_name && tag->var_type &&
913 tag->type & (tm_tag_field_t | tm_tag_member_t | tm_tag_variable_t | tm_tag_externvar_t))
915 if (tag->lang != TM_PARSER_PASCAL && tag->lang != TM_PARSER_GO)
916 utf8_name = g_strconcat(tag->var_type, " ", tag->name, NULL);
917 else
919 const gchar *sep = tag->lang == TM_PARSER_PASCAL ? " : " : " ";
920 utf8_name = g_strconcat(tag->name, sep, tag->var_type, NULL);
924 /* encodings_convert_to_utf8_from_charset() fails with charset "None", so skip conversion
925 * for None at this point completely */
926 if (utf8_name != NULL &&
927 ! utils_str_equal(doc->encoding, "UTF-8") &&
928 ! utils_str_equal(doc->encoding, "None"))
930 SETPTR(utf8_name,
931 encodings_convert_to_utf8_from_charset(utf8_name, -1, doc->encoding, TRUE));
934 return utf8_name;
938 static const gchar *get_parent_name(const TMTag *tag)
940 return !EMPTY(tag->scope) ? tag->scope : NULL;
944 static GtkTreeIter *get_tag_type_iter(TMTagType tag_type)
946 GtkTreeIter *iter = NULL;
948 switch (tag_type)
950 case tm_tag_prototype_t:
951 case tm_tag_method_t:
952 case tm_tag_function_t:
954 iter = &tv_iters.tag_function;
955 break;
957 case tm_tag_externvar_t:
959 iter = &tv_iters.tag_externvar;
960 break;
962 case tm_tag_macro_t:
963 case tm_tag_macro_with_arg_t:
965 iter = &tv_iters.tag_macro;
966 break;
968 case tm_tag_class_t:
970 iter = &tv_iters.tag_class;
971 break;
973 case tm_tag_member_t:
974 case tm_tag_field_t:
976 iter = &tv_iters.tag_member;
977 break;
979 case tm_tag_typedef_t:
980 case tm_tag_enum_t:
982 iter = &tv_iters.tag_type;
983 break;
985 case tm_tag_union_t:
986 case tm_tag_struct_t:
988 iter = &tv_iters.tag_struct;
989 break;
991 case tm_tag_interface_t:
992 iter = &tv_iters.tag_interface;
993 break;
994 case tm_tag_variable_t:
996 iter = &tv_iters.tag_variable;
997 break;
999 case tm_tag_namespace_t:
1000 case tm_tag_package_t:
1002 iter = &tv_iters.tag_namespace;
1003 break;
1005 default:
1007 iter = &tv_iters.tag_other;
1010 if (G_LIKELY(iter->stamp != -1))
1011 return iter;
1012 else
1013 return NULL;
1017 static GdkPixbuf *get_child_icon(GtkTreeStore *tree_store, GtkTreeIter *parent)
1019 GdkPixbuf *icon = NULL;
1021 if (parent == &tv_iters.tag_other)
1023 return g_object_ref(symbols_icons[ICON_VAR].pixbuf);
1025 /* copy parent icon */
1026 gtk_tree_model_get(GTK_TREE_MODEL(tree_store), parent,
1027 SYMBOLS_COLUMN_ICON, &icon, -1);
1028 return icon;
1032 static gboolean tag_equal(gconstpointer v1, gconstpointer v2)
1034 const TMTag *t1 = v1;
1035 const TMTag *t2 = v2;
1037 return (t1->type == t2->type && strcmp(t1->name, t2->name) == 0 &&
1038 utils_str_equal(t1->scope, t2->scope) &&
1039 /* include arglist in match to support e.g. C++ overloading */
1040 utils_str_equal(t1->arglist, t2->arglist));
1044 /* inspired from g_str_hash() */
1045 static guint tag_hash(gconstpointer v)
1047 const TMTag *tag = v;
1048 const gchar *p;
1049 guint32 h = 5381;
1051 h = (h << 5) + h + tag->type;
1052 for (p = tag->name; *p != '\0'; p++)
1053 h = (h << 5) + h + *p;
1054 if (tag->scope)
1056 for (p = tag->scope; *p != '\0'; p++)
1057 h = (h << 5) + h + *p;
1059 /* for e.g. C++ overloading */
1060 if (tag->arglist)
1062 for (p = tag->arglist; *p != '\0'; p++)
1063 h = (h << 5) + h + *p;
1066 return h;
1070 /* like gtk_tree_view_expand_to_path() but with an iter */
1071 static void tree_view_expand_to_iter(GtkTreeView *view, GtkTreeIter *iter)
1073 GtkTreeModel *model = gtk_tree_view_get_model(view);
1074 GtkTreePath *path = gtk_tree_model_get_path(model, iter);
1076 gtk_tree_view_expand_to_path(view, path);
1077 gtk_tree_path_free(path);
1081 /* like gtk_tree_store_remove() but finds the next iter at any level */
1082 static gboolean tree_store_remove_row(GtkTreeStore *store, GtkTreeIter *iter)
1084 GtkTreeIter parent;
1085 gboolean has_parent;
1086 gboolean cont;
1088 has_parent = gtk_tree_model_iter_parent(GTK_TREE_MODEL(store), &parent, iter);
1089 cont = gtk_tree_store_remove(store, iter);
1090 /* if there is no next at this level but there is a parent iter, continue from it */
1091 if (! cont && has_parent)
1093 *iter = parent;
1094 cont = ui_tree_model_iter_any_next(GTK_TREE_MODEL(store), iter, FALSE);
1097 return cont;
1101 static gint tree_search_func(gconstpointer key, gpointer user_data)
1103 TreeSearchData *data = user_data;
1104 gint parent_line = GPOINTER_TO_INT(key);
1105 gboolean new_nearest;
1107 if (data->found_line == -1)
1108 data->found_line = parent_line; /* initial value */
1110 new_nearest = ABS(data->line - parent_line) < ABS(data->line - data->found_line);
1112 if (parent_line > data->line)
1114 if (new_nearest && !data->lower)
1115 data->found_line = parent_line;
1116 return -1;
1119 if (new_nearest)
1120 data->found_line = parent_line;
1122 if (parent_line < data->line)
1123 return 1;
1125 return 0;
1129 static gint tree_cmp(gconstpointer a, gconstpointer b, gpointer user_data)
1131 return GPOINTER_TO_INT(a) - GPOINTER_TO_INT(b);
1135 static void parents_table_tree_value_free(gpointer data)
1137 g_slice_free(GtkTreeIter, data);
1141 /* adds a new element in the parent table if its key is known. */
1142 static void update_parents_table(GHashTable *table, const TMTag *tag, const GtkTreeIter *iter)
1144 const gchar *name;
1145 gchar *name_free = NULL;
1146 GTree *tree;
1148 if (EMPTY(tag->scope))
1150 /* simple case, just use the tag name */
1151 name = tag->name;
1153 else if (! tm_parser_has_full_context(tag->lang))
1155 /* if the parser doesn't use fully qualified scope, use the name alone but
1156 * prevent Foo::Foo from making parent = child */
1157 if (utils_str_equal(tag->scope, tag->name))
1158 name = NULL;
1159 else
1160 name = tag->name;
1162 else
1164 /* build the fully qualified scope as get_parent_name() would return it for a child tag */
1165 name_free = g_strconcat(tag->scope, tm_parser_context_separator(tag->lang), tag->name, NULL);
1166 name = name_free;
1169 if (name && g_hash_table_lookup_extended(table, name, NULL, (gpointer *) &tree))
1171 if (!tree)
1173 tree = g_tree_new_full(tree_cmp, NULL, NULL, parents_table_tree_value_free);
1174 g_hash_table_insert(table, name_free ? name_free : g_strdup(name), tree);
1175 name_free = NULL;
1178 g_tree_insert(tree, GINT_TO_POINTER(tag->line), g_slice_dup(GtkTreeIter, iter));
1181 g_free(name_free);
1185 static GtkTreeIter *parents_table_lookup(GHashTable *table, const gchar *name, guint line)
1187 GtkTreeIter *parent_search = NULL;
1188 GTree *tree;
1190 tree = g_hash_table_lookup(table, name);
1191 if (tree)
1193 TreeSearchData user_data = {-1, line, TRUE};
1195 /* search parent candidates for the one with the nearest
1196 * line number which is lower than the tag's line number */
1197 g_tree_search(tree, (GCompareFunc)tree_search_func, &user_data);
1198 parent_search = g_tree_lookup(tree, GINT_TO_POINTER(user_data.found_line));
1201 return parent_search;
1205 static void parents_table_value_free(gpointer data)
1207 GTree *tree = data;
1208 if (tree)
1209 g_tree_destroy(tree);
1213 /* inserts a @data in @table on key @tag.
1214 * previous data is not overwritten if the key is duplicated, but rather the
1215 * two values are kept in a list
1217 * table is: GHashTable<TMTag, GTree<line_num, GList<GList<TMTag>>>> */
1218 static void tags_table_insert(GHashTable *table, TMTag *tag, GList *data)
1220 GTree *tree = g_hash_table_lookup(table, tag);
1221 if (!tree)
1223 tree = g_tree_new_full(tree_cmp, NULL, NULL, NULL);
1224 g_hash_table_insert(table, tag, tree);
1226 GList *list = g_tree_lookup(tree, GINT_TO_POINTER(tag->line));
1227 list = g_list_prepend(list, data);
1228 g_tree_insert(tree, GINT_TO_POINTER(tag->line), list);
1232 /* looks up the entry in @table that best matches @tag.
1233 * if there is more than one candidate, the one that has closest line position to @tag is chosen */
1234 static GList *tags_table_lookup(GHashTable *table, TMTag *tag)
1236 TreeSearchData user_data = {-1, tag->line, FALSE};
1237 GTree *tree = g_hash_table_lookup(table, tag);
1239 if (tree)
1241 GList *list;
1243 g_tree_search(tree, (GCompareFunc)tree_search_func, &user_data);
1244 list = g_tree_lookup(tree, GINT_TO_POINTER(user_data.found_line));
1245 /* return the first value in the list - we don't care which of the
1246 * tags with identical names defined on the same line we get */
1247 if (list)
1248 return list->data;
1250 return NULL;
1254 /* removes the element at @tag from @table.
1255 * @tag must be the exact pointer used at insertion time */
1256 static void tags_table_remove(GHashTable *table, TMTag *tag)
1258 GTree *tree = g_hash_table_lookup(table, tag);
1259 if (tree)
1261 GList *list = g_tree_lookup(tree, GINT_TO_POINTER(tag->line));
1262 if (list)
1264 GList *node;
1265 /* should always be the first element as we returned the first one in
1266 * tags_table_lookup() */
1267 foreach_list(node, list)
1269 if (((GList *) node->data)->data == tag)
1270 break;
1272 list = g_list_delete_link(list, node);
1273 if (!list)
1274 g_tree_remove(tree, GINT_TO_POINTER(tag->line));
1275 else
1276 g_tree_insert(tree, GINT_TO_POINTER(tag->line), list);
1282 static gboolean tags_table_tree_value_free(gpointer key, gpointer value, gpointer data)
1284 GList *list = value;
1285 g_list_free(list);
1286 return FALSE;
1290 static void tags_table_value_free(gpointer data)
1292 GTree *tree = data;
1293 if (tree)
1295 /* free any leftover elements. note that we can't register a value_free_func when
1296 * creating the tree because we only want to free it when destroying the tree,
1297 * not when inserting a duplicate (we handle this manually) */
1298 g_tree_foreach(tree, tags_table_tree_value_free, NULL);
1299 g_tree_destroy(tree);
1305 * Updates the tag tree for a document with the tags in *list.
1306 * @param doc a document
1307 * @param tags a pointer to a GList* holding the tags to add/update. This
1308 * list may be updated, removing updated elements.
1310 * The update is done in two passes:
1311 * 1) walking the current tree, update tags that still exist and remove the
1312 * obsolescent ones;
1313 * 2) walking the remaining (non updated) tags, adds them in the list.
1315 * For better performances, we use 2 hash tables:
1316 * - one containing all the tags for lookup in the first pass (actually stores a
1317 * reference in the tags list for removing it efficiently), avoiding list search
1318 * on each tag;
1319 * - the other holding "tag-name":row references for tags having children, used to
1320 * lookup for a parent in both passes, avoiding tree traversal.
1322 static void update_tree_tags(GeanyDocument *doc, GList **tags)
1324 GtkTreeStore *store = doc->priv->tag_store;
1325 GtkTreeModel *model = GTK_TREE_MODEL(store);
1326 GHashTable *parents_table;
1327 GHashTable *tags_table;
1328 GtkTreeIter iter;
1329 gboolean cont;
1330 GList *item;
1332 /* Build hash tables holding tags and parents */
1333 /* parent table is GHashTable<tag_name, GTree<line_num, GtkTreeIter>>
1334 * where tag_name might be a fully qualified name (with scope) if the language
1335 * parser reports scope properly (see tm_parser_has_full_context()). */
1336 parents_table = g_hash_table_new_full(g_str_hash, g_str_equal, g_free, parents_table_value_free);
1337 /* tags table is another representation of the @tags list,
1338 * GHashTable<TMTag, GTree<line_num, GList<GList<TMTag>>>> */
1339 tags_table = g_hash_table_new_full(tag_hash, tag_equal, NULL, tags_table_value_free);
1340 foreach_list(item, *tags)
1342 TMTag *tag = item->data;
1343 const gchar *parent_name;
1345 tags_table_insert(tags_table, tag, item);
1347 parent_name = get_parent_name(tag);
1348 if (parent_name)
1349 g_hash_table_insert(parents_table, g_strdup(parent_name), NULL);
1352 /* First pass, update existing rows or delete them.
1353 * It is OK to delete them since we walk top down so we would remove
1354 * parents before checking for their children, thus never implicitly
1355 * deleting an updated child */
1356 cont = gtk_tree_model_get_iter_first(model, &iter);
1357 while (cont)
1359 TMTag *tag;
1361 gtk_tree_model_get(model, &iter, SYMBOLS_COLUMN_TAG, &tag, -1);
1362 if (! tag) /* most probably a toplevel, skip it */
1363 cont = ui_tree_model_iter_any_next(model, &iter, TRUE);
1364 else
1366 GList *found_item;
1368 found_item = tags_table_lookup(tags_table, tag);
1369 if (! found_item) /* tag doesn't exist, remove it */
1370 cont = tree_store_remove_row(store, &iter);
1371 else /* tag still exist, update it */
1373 const gchar *parent_name;
1374 TMTag *found = found_item->data;
1376 parent_name = get_parent_name(found);
1377 /* if parent is unknown, ignore it */
1378 if (parent_name && ! g_hash_table_lookup(parents_table, parent_name))
1379 parent_name = NULL;
1381 if (!tm_tags_equal(tag, found))
1383 const gchar *name;
1384 gchar *tooltip;
1386 /* only update fields that (can) have changed (name that holds line
1387 * number, tooltip, and the tag itself) */
1388 name = get_symbol_name(doc, found, parent_name != NULL);
1389 tooltip = get_symbol_tooltip(doc, found);
1390 gtk_tree_store_set(store, &iter,
1391 SYMBOLS_COLUMN_NAME, name,
1392 SYMBOLS_COLUMN_TOOLTIP, tooltip,
1393 SYMBOLS_COLUMN_TAG, found,
1394 -1);
1395 g_free(tooltip);
1398 update_parents_table(parents_table, found, &iter);
1400 /* remove the updated tag from the table and list */
1401 tags_table_remove(tags_table, found);
1402 *tags = g_list_delete_link(*tags, found_item);
1404 cont = ui_tree_model_iter_any_next(model, &iter, TRUE);
1407 tm_tag_unref(tag);
1411 /* Second pass, now we have a tree cleaned up from invalid rows,
1412 * we simply add new ones */
1413 foreach_list (item, *tags)
1415 TMTag *tag = item->data;
1416 GtkTreeIter *parent;
1418 parent = get_tag_type_iter(tag->type);
1419 if (G_UNLIKELY(! parent))
1420 geany_debug("Missing symbol-tree parent iter for type %d!", tag->type);
1421 else
1423 gboolean expand;
1424 const gchar *name;
1425 const gchar *parent_name;
1426 gchar *tooltip;
1427 GdkPixbuf *icon = get_child_icon(store, parent);
1429 parent_name = get_parent_name(tag);
1430 if (parent_name)
1432 GtkTreeIter *parent_search = parents_table_lookup(parents_table, parent_name, tag->line);
1434 if (parent_search)
1435 parent = parent_search;
1436 else
1437 parent_name = NULL;
1440 /* only expand to the iter if the parent was empty, otherwise we let the
1441 * folding as it was before (already expanded, or closed by the user) */
1442 expand = ! gtk_tree_model_iter_has_child(model, parent);
1444 /* insert the new element */
1445 name = get_symbol_name(doc, tag, parent_name != NULL);
1446 tooltip = get_symbol_tooltip(doc, tag);
1447 gtk_tree_store_insert_with_values(store, &iter, parent, 0,
1448 SYMBOLS_COLUMN_NAME, name,
1449 SYMBOLS_COLUMN_TOOLTIP, tooltip,
1450 SYMBOLS_COLUMN_ICON, icon,
1451 SYMBOLS_COLUMN_TAG, tag,
1452 -1);
1453 g_free(tooltip);
1454 if (G_LIKELY(icon))
1455 g_object_unref(icon);
1457 update_parents_table(parents_table, tag, &iter);
1459 if (expand)
1460 tree_view_expand_to_iter(GTK_TREE_VIEW(doc->priv->tag_tree), &iter);
1464 g_hash_table_destroy(parents_table);
1465 g_hash_table_destroy(tags_table);
1469 /* we don't want to sort 1st-level nodes, but we can't return 0 because the tree sort
1470 * is not stable, so the order is already lost. */
1471 static gint compare_top_level_names(const gchar *a, const gchar *b)
1473 guint i;
1474 const gchar *name;
1476 /* This should never happen as it would mean that two or more top
1477 * level items have the same name but it can happen by typos in the translations. */
1478 if (utils_str_equal(a, b))
1479 return 1;
1481 foreach_ptr_array(name, i, top_level_iter_names)
1483 if (utils_str_equal(name, a))
1484 return -1;
1485 if (utils_str_equal(name, b))
1486 return 1;
1488 g_warning("Couldn't find top level node '%s' or '%s'!", a, b);
1489 return 0;
1493 static gboolean tag_has_missing_parent(const TMTag *tag, GtkTreeStore *store,
1494 GtkTreeIter *iter)
1496 /* if the tag has a parent tag, it should be at depth >= 2 */
1497 return !EMPTY(tag->scope) &&
1498 gtk_tree_store_iter_depth(store, iter) == 1;
1502 static gint tree_sort_func(GtkTreeModel *model, GtkTreeIter *a, GtkTreeIter *b,
1503 gpointer user_data)
1505 gboolean sort_by_name = GPOINTER_TO_INT(user_data);
1506 TMTag *tag_a, *tag_b;
1507 gint cmp;
1509 gtk_tree_model_get(model, a, SYMBOLS_COLUMN_TAG, &tag_a, -1);
1510 gtk_tree_model_get(model, b, SYMBOLS_COLUMN_TAG, &tag_b, -1);
1512 /* Check if the iters can be sorted based on tag name and line, not tree item name.
1513 * Sort by tree name if the scope was prepended, e.g. 'ScopeNameWithNoTag::TagName'. */
1514 if (tag_a && !tag_has_missing_parent(tag_a, GTK_TREE_STORE(model), a) &&
1515 tag_b && !tag_has_missing_parent(tag_b, GTK_TREE_STORE(model), b))
1517 cmp = sort_by_name ? compare_symbol(tag_a, tag_b) :
1518 compare_symbol_lines(tag_a, tag_b);
1520 else
1522 gchar *astr, *bstr;
1524 gtk_tree_model_get(model, a, SYMBOLS_COLUMN_NAME, &astr, -1);
1525 gtk_tree_model_get(model, b, SYMBOLS_COLUMN_NAME, &bstr, -1);
1527 /* if a is toplevel, b must be also */
1528 if (gtk_tree_store_iter_depth(GTK_TREE_STORE(model), a) == 0)
1530 cmp = compare_top_level_names(astr, bstr);
1532 else
1534 /* this is what g_strcmp0() does */
1535 if (! astr)
1536 cmp = -(astr != bstr);
1537 else if (! bstr)
1538 cmp = astr != bstr;
1539 else
1541 cmp = strcmp(astr, bstr);
1543 /* sort duplicate 'ScopeName::OverloadedTagName' items by line as well */
1544 if (tag_a && tag_b)
1545 if (!sort_by_name ||
1546 (utils_str_equal(tag_a->name, tag_b->name) &&
1547 utils_str_equal(tag_a->scope, tag_b->scope)))
1548 cmp = compare_symbol_lines(tag_a, tag_b);
1551 g_free(astr);
1552 g_free(bstr);
1554 tm_tag_unref(tag_a);
1555 tm_tag_unref(tag_b);
1557 return cmp;
1561 static void sort_tree(GtkTreeStore *store, gboolean sort_by_name)
1563 gtk_tree_sortable_set_sort_func(GTK_TREE_SORTABLE(store), SYMBOLS_COLUMN_NAME, tree_sort_func,
1564 GINT_TO_POINTER(sort_by_name), NULL);
1566 gtk_tree_sortable_set_sort_column_id(GTK_TREE_SORTABLE(store), SYMBOLS_COLUMN_NAME, GTK_SORT_ASCENDING);
1570 gboolean symbols_recreate_tag_list(GeanyDocument *doc, gint sort_mode)
1572 GList *tags;
1574 g_return_val_if_fail(DOC_VALID(doc), FALSE);
1576 tags = get_tag_list(doc, tm_tag_max_t);
1577 if (tags == NULL)
1578 return FALSE;
1580 /* FIXME: Not sure why we detached the model here? */
1582 /* disable sorting during update because the code doesn't support correctly
1583 * models that are currently being built */
1584 gtk_tree_sortable_set_sort_column_id(GTK_TREE_SORTABLE(doc->priv->tag_store), GTK_TREE_SORTABLE_UNSORTED_SORT_COLUMN_ID, 0);
1586 /* add grandparent type iters */
1587 add_top_level_items(doc);
1589 update_tree_tags(doc, &tags);
1590 g_list_free(tags);
1592 hide_empty_rows(doc->priv->tag_store);
1594 if (sort_mode == SYMBOLS_SORT_USE_PREVIOUS)
1595 sort_mode = doc->priv->symbol_list_sort_mode;
1597 sort_tree(doc->priv->tag_store, sort_mode == SYMBOLS_SORT_BY_NAME);
1598 doc->priv->symbol_list_sort_mode = sort_mode;
1600 return TRUE;
1604 /* Detects a global tags filetype from the *.lang.* language extension.
1605 * Returns NULL if there was no matching TM language. */
1606 static GeanyFiletype *detect_global_tags_filetype(const gchar *utf8_filename)
1608 gchar *tags_ext;
1609 gchar *shortname = utils_strdupa(utf8_filename);
1610 GeanyFiletype *ft = NULL;
1612 tags_ext = g_strrstr(shortname, ".tags");
1613 if (tags_ext)
1615 *tags_ext = '\0'; /* remove .tags extension */
1616 ft = filetypes_detect_from_extension(shortname);
1617 if (ft->id != GEANY_FILETYPES_NONE)
1618 return ft;
1620 return NULL;
1624 /* Adapted from anjuta-2.0.2/global-tags/tm_global_tags.c, thanks.
1625 * Needs full paths for filenames, except for C/C++ tag files, when CFLAGS includes
1626 * the relevant path.
1627 * Example:
1628 * CFLAGS=-I/home/user/libname-1.x geany -g libname.d.tags libname.h */
1629 int symbols_generate_global_tags(int argc, char **argv, gboolean want_preprocess)
1631 /* -E pre-process, -dD output user macros, -p prof info (?) */
1632 const char pre_process[] = "gcc -E -dD -p -I.";
1634 if (argc > 2)
1636 /* Create global taglist */
1637 int status;
1638 char *command;
1639 const char *tags_file = argv[1];
1640 char *utf8_fname;
1641 GeanyFiletype *ft;
1643 utf8_fname = utils_get_utf8_from_locale(tags_file);
1644 ft = detect_global_tags_filetype(utf8_fname);
1645 g_free(utf8_fname);
1647 if (ft == NULL)
1649 g_printerr(_("Unknown filetype extension for \"%s\".\n"), tags_file);
1650 return 1;
1652 /* load config in case of custom filetypes */
1653 filetypes_load_config(ft->id, FALSE);
1655 /* load ignore list for C/C++ parser */
1656 if (ft->id == GEANY_FILETYPES_C || ft->id == GEANY_FILETYPES_CPP)
1657 load_c_ignore_tags();
1659 if (want_preprocess && (ft->id == GEANY_FILETYPES_C || ft->id == GEANY_FILETYPES_CPP))
1661 const gchar *cflags = getenv("CFLAGS");
1662 command = g_strdup_printf("%s %s", pre_process, FALLBACK(cflags, ""));
1664 else
1665 command = NULL; /* don't preprocess */
1667 geany_debug("Generating %s tags file.", ft->name);
1668 tm_get_workspace();
1669 status = tm_workspace_create_global_tags(command, (const char **) (argv + 2),
1670 argc - 2, tags_file, ft->lang);
1671 g_free(command);
1672 symbols_finalize(); /* free c_tags_ignore data */
1673 if (! status)
1675 g_printerr(_("Failed to create tags file, perhaps because no symbols "
1676 "were found.\n"));
1677 return 1;
1680 else
1682 g_printerr(_("Usage: %s -g <Tags File> <File list>\n\n"), argv[0]);
1683 g_printerr(_("Example:\n"
1684 "CFLAGS=`pkg-config gtk+-2.0 --cflags` %s -g gtk2.c.tags"
1685 " /usr/include/gtk-2.0/gtk/gtk.h\n"), argv[0]);
1686 return 1;
1688 return 0;
1692 void symbols_show_load_tags_dialog(void)
1694 GtkWidget *dialog;
1695 GtkFileFilter *filter;
1697 dialog = gtk_file_chooser_dialog_new(_("Load Tags File"), GTK_WINDOW(main_widgets.window),
1698 GTK_FILE_CHOOSER_ACTION_OPEN,
1699 GTK_STOCK_CANCEL, GTK_RESPONSE_CANCEL,
1700 GTK_STOCK_OPEN, GTK_RESPONSE_OK,
1701 NULL);
1702 gtk_widget_set_name(dialog, "GeanyDialog");
1703 filter = gtk_file_filter_new();
1704 gtk_file_filter_set_name(filter, _("Geany tags file (*.*.tags)"));
1705 gtk_file_filter_add_pattern(filter, "*.*.tags");
1706 gtk_file_chooser_add_filter(GTK_FILE_CHOOSER(dialog), filter);
1708 if (gtk_dialog_run(GTK_DIALOG(dialog)) == GTK_RESPONSE_OK)
1710 GSList *flist = gtk_file_chooser_get_filenames(GTK_FILE_CHOOSER(dialog));
1711 GSList *item;
1713 for (item = flist; item != NULL; item = g_slist_next(item))
1715 gchar *fname = item->data;
1716 gchar *utf8_fname;
1717 GeanyFiletype *ft;
1719 utf8_fname = utils_get_utf8_from_locale(fname);
1720 ft = detect_global_tags_filetype(utf8_fname);
1722 if (ft != NULL && symbols_load_global_tags(fname, ft))
1723 /* For translators: the first wildcard is the filetype, the second the filename */
1724 ui_set_statusbar(TRUE, _("Loaded %s tags file '%s'."),
1725 filetypes_get_display_name(ft), utf8_fname);
1726 else
1727 ui_set_statusbar(TRUE, _("Could not load tags file '%s'."), utf8_fname);
1729 g_free(utf8_fname);
1730 g_free(fname);
1732 g_slist_free(flist);
1734 gtk_widget_destroy(dialog);
1738 static void init_user_tags(void)
1740 GSList *file_list = NULL, *list = NULL;
1741 const GSList *node;
1742 gchar *dir;
1744 dir = g_build_filename(app->configdir, GEANY_TAGS_SUBDIR, NULL);
1745 /* create the user tags dir for next time if it doesn't exist */
1746 if (! g_file_test(dir, G_FILE_TEST_IS_DIR))
1747 utils_mkdir(dir, FALSE);
1748 file_list = utils_get_file_list_full(dir, TRUE, FALSE, NULL);
1750 SETPTR(dir, g_build_filename(app->datadir, GEANY_TAGS_SUBDIR, NULL));
1751 list = utils_get_file_list_full(dir, TRUE, FALSE, NULL);
1752 g_free(dir);
1754 file_list = g_slist_concat(file_list, list);
1756 /* populate the filetype-specific tag files lists */
1757 for (node = file_list; node != NULL; node = node->next)
1759 gchar *fname = node->data;
1760 gchar *utf8_fname = utils_get_utf8_from_locale(fname);
1761 GeanyFiletype *ft = detect_global_tags_filetype(utf8_fname);
1763 g_free(utf8_fname);
1765 if (FILETYPE_ID(ft) != GEANY_FILETYPES_NONE)
1766 ft->priv->tag_files = g_slist_prepend(ft->priv->tag_files, fname);
1767 else
1769 geany_debug("Unknown filetype for file '%s'.", fname);
1770 g_free(fname);
1774 /* don't need to delete list contents because they are now stored in
1775 * ft->priv->tag_files */
1776 g_slist_free(file_list);
1780 static void load_user_tags(GeanyFiletypeID ft_id)
1782 static guchar *tags_loaded = NULL;
1783 static gboolean init_tags = FALSE;
1784 const GSList *node;
1785 GeanyFiletype *ft = filetypes[ft_id];
1787 g_return_if_fail(ft_id > 0);
1789 if (!tags_loaded)
1790 tags_loaded = g_new0(guchar, filetypes_array->len);
1791 if (tags_loaded[ft_id])
1792 return;
1793 tags_loaded[ft_id] = TRUE; /* prevent reloading */
1795 if (!init_tags)
1797 init_user_tags();
1798 init_tags = TRUE;
1801 for (node = ft->priv->tag_files; node != NULL; node = g_slist_next(node))
1803 const gchar *fname = node->data;
1805 symbols_load_global_tags(fname, ft);
1810 static void on_goto_popup_item_activate(GtkMenuItem *item, TMTag *tag)
1812 GeanyDocument *new_doc, *old_doc;
1814 g_return_if_fail(tag);
1816 old_doc = document_get_current();
1817 new_doc = document_open_file(tag->file->file_name, FALSE, NULL, NULL);
1819 if (new_doc)
1820 navqueue_goto_line(old_doc, new_doc, tag->line);
1824 /* FIXME: use the same icons as in the symbols tree defined in add_top_level_items() */
1825 static guint get_tag_class(const TMTag *tag)
1827 switch (tag->type)
1829 case tm_tag_prototype_t:
1830 case tm_tag_method_t:
1831 case tm_tag_function_t:
1832 return ICON_METHOD;
1833 case tm_tag_variable_t:
1834 case tm_tag_externvar_t:
1835 return ICON_VAR;
1836 case tm_tag_macro_t:
1837 case tm_tag_macro_with_arg_t:
1838 return ICON_MACRO;
1839 case tm_tag_class_t:
1840 return ICON_CLASS;
1841 case tm_tag_member_t:
1842 case tm_tag_field_t:
1843 return ICON_MEMBER;
1844 case tm_tag_typedef_t:
1845 case tm_tag_enum_t:
1846 case tm_tag_union_t:
1847 case tm_tag_struct_t:
1848 return ICON_STRUCT;
1849 case tm_tag_namespace_t:
1850 case tm_tag_package_t:
1851 return ICON_NAMESPACE;
1852 default:
1853 break;
1855 return ICON_STRUCT;
1859 /* positions a popup at the caret from the ScintillaObject in @p data */
1860 static void goto_popup_position_func(GtkMenu *menu, gint *x, gint *y, gboolean *push_in, gpointer data)
1862 gint line_height;
1863 GdkScreen *screen = gtk_widget_get_screen(GTK_WIDGET(menu));
1864 gint monitor_num;
1865 GdkRectangle monitor;
1866 GtkRequisition req;
1867 GdkEventButton *event_button = g_object_get_data(G_OBJECT(menu), "geany-button-event");
1869 if (event_button)
1871 /* if we got a mouse click, popup at that position */
1872 *x = (gint) event_button->x_root;
1873 *y = (gint) event_button->y_root;
1874 line_height = 0; /* we don't want to offset below the line or anything */
1876 else /* keyboard positioning */
1878 ScintillaObject *sci = data;
1879 GdkWindow *window = gtk_widget_get_window(GTK_WIDGET(sci));
1880 gint pos = sci_get_current_position(sci);
1881 gint line = sci_get_line_from_position(sci, pos);
1882 gint pos_x = SSM(sci, SCI_POINTXFROMPOSITION, 0, pos);
1883 gint pos_y = SSM(sci, SCI_POINTYFROMPOSITION, 0, pos);
1885 line_height = SSM(sci, SCI_TEXTHEIGHT, line, 0);
1887 gdk_window_get_origin(window, x, y);
1888 *x += pos_x;
1889 *y += pos_y;
1892 monitor_num = gdk_screen_get_monitor_at_point(screen, *x, *y);
1894 #if GTK_CHECK_VERSION(3, 0, 0)
1895 gtk_widget_get_preferred_size(GTK_WIDGET(menu), NULL, &req);
1896 #else
1897 gtk_widget_size_request(GTK_WIDGET(menu), &req);
1898 #endif
1900 #if GTK_CHECK_VERSION(3, 4, 0)
1901 gdk_screen_get_monitor_workarea(screen, monitor_num, &monitor);
1902 #else
1903 gdk_screen_get_monitor_geometry(screen, monitor_num, &monitor);
1904 #endif
1906 /* put on one size of the X position, but within the monitor */
1907 if (gtk_widget_get_direction(GTK_WIDGET(menu)) == GTK_TEXT_DIR_RTL)
1909 if (*x - req.width - 1 >= monitor.x)
1910 *x -= req.width + 1;
1911 else if (*x + req.width > monitor.x + monitor.width)
1912 *x = monitor.x;
1913 else
1914 *x += 1;
1916 else
1918 if (*x + req.width + 1 <= monitor.x + monitor.width)
1919 *x = MAX(monitor.x, *x + 1);
1920 else if (*x - req.width - 1 >= monitor.x)
1921 *x -= req.width + 1;
1922 else
1923 *x = monitor.x + MAX(0, monitor.width - req.width);
1926 /* try to put, in order:
1927 * 1. below the Y position, under the line
1928 * 2. above the Y position
1929 * 3. within the monitor */
1930 if (*y + line_height + req.height <= monitor.y + monitor.height)
1931 *y = MAX(monitor.y, *y + line_height);
1932 else if (*y - req.height >= monitor.y)
1933 *y = *y - req.height;
1934 else
1935 *y = monitor.y + MAX(0, monitor.height - req.height);
1937 *push_in = FALSE;
1941 static void show_goto_popup(GeanyDocument *doc, GPtrArray *tags, gboolean have_best)
1943 GtkWidget *first = NULL;
1944 GtkWidget *menu;
1945 GdkEvent *event;
1946 GdkEventButton *button_event = NULL;
1947 TMTag *tmtag;
1948 guint i;
1949 gchar **short_names, **file_names;
1950 menu = gtk_menu_new();
1952 /* If popup would show multiple files present a smart file list that allows
1953 * to easily distinguish the files while avoiding the file paths in their entirety */
1954 file_names = g_new(gchar *, tags->len);
1955 foreach_ptr_array(tmtag, i, tags)
1956 file_names[i] = tmtag->file->file_name;
1957 short_names = utils_strv_shorten_file_list(file_names, tags->len);
1958 g_free(file_names);
1960 foreach_ptr_array(tmtag, i, tags)
1962 GtkWidget *item;
1963 GtkWidget *label;
1964 GtkWidget *image;
1965 gchar *fname = short_names[i];
1966 gchar *text;
1968 if (! first && have_best)
1969 /* For translators: it's the filename and line number of a symbol in the goto-symbol popup menu */
1970 text = g_markup_printf_escaped(_("<b>%s: %lu</b>"), fname, tmtag->line);
1971 else
1972 /* For translators: it's the filename and line number of a symbol in the goto-symbol popup menu */
1973 text = g_markup_printf_escaped(_("%s: %lu"), fname, tmtag->line);
1975 image = gtk_image_new_from_pixbuf(symbols_icons[get_tag_class(tmtag)].pixbuf);
1976 label = g_object_new(GTK_TYPE_LABEL, "label", text, "use-markup", TRUE, "xalign", 0.0, NULL);
1977 item = g_object_new(GTK_TYPE_IMAGE_MENU_ITEM, "image", image, "child", label, "always-show-image", TRUE, NULL);
1978 g_signal_connect_data(item, "activate", G_CALLBACK(on_goto_popup_item_activate),
1979 tm_tag_ref(tmtag), (GClosureNotify) tm_tag_unref, 0);
1980 gtk_menu_shell_append(GTK_MENU_SHELL(menu), item);
1982 if (! first)
1983 first = item;
1985 g_free(text);
1986 g_free(fname);
1988 g_free(short_names);
1990 gtk_widget_show_all(menu);
1992 if (first) /* always select the first item for better keyboard navigation */
1993 g_signal_connect(menu, "realize", G_CALLBACK(gtk_menu_shell_select_item), first);
1995 event = gtk_get_current_event();
1996 if (event && event->type == GDK_BUTTON_PRESS)
1997 button_event = (GdkEventButton *) event;
1998 else
1999 gdk_event_free(event);
2001 g_object_set_data_full(G_OBJECT(menu), "geany-button-event", button_event,
2002 button_event ? (GDestroyNotify) gdk_event_free : NULL);
2003 gtk_menu_popup(GTK_MENU(menu), NULL, NULL, goto_popup_position_func, doc->editor->sci,
2004 button_event ? button_event->button : 0, gtk_get_current_event_time ());
2008 static gint compare_tags_by_name_line(gconstpointer ptr1, gconstpointer ptr2)
2010 gint res;
2011 TMTag *t1 = *((TMTag **) ptr1);
2012 TMTag *t2 = *((TMTag **) ptr2);
2014 res = g_strcmp0(t1->file->short_name, t2->file->short_name);
2015 if (res != 0)
2016 return res;
2017 return t1->line - t2->line;
2021 static TMTag *find_best_goto_tag(GeanyDocument *doc, GPtrArray *tags)
2023 TMTag *tag;
2024 guint i;
2026 /* first check if we have a tag in the current file */
2027 foreach_ptr_array(tag, i, tags)
2029 if (g_strcmp0(doc->real_path, tag->file->file_name) == 0)
2030 return tag;
2033 /* next check if we have a tag for some of the open documents */
2034 foreach_ptr_array(tag, i, tags)
2036 guint j;
2038 foreach_document(j)
2040 if (g_strcmp0(documents[j]->real_path, tag->file->file_name) == 0)
2041 return tag;
2045 /* next check if we have a tag for a file inside the current document's directory */
2046 foreach_ptr_array(tag, i, tags)
2048 gchar *dir = g_path_get_dirname(doc->real_path);
2050 if (g_str_has_prefix(tag->file->file_name, dir))
2052 g_free(dir);
2053 return tag;
2055 g_free(dir);
2058 return NULL;
2062 static GPtrArray *filter_tags(GPtrArray *tags, TMTag *current_tag, gboolean definition)
2064 const TMTagType forward_types = tm_tag_prototype_t | tm_tag_externvar_t;
2065 TMTag *tmtag, *last_tag = NULL;
2066 GPtrArray *filtered_tags = g_ptr_array_new();
2067 guint i;
2069 foreach_ptr_array(tmtag, i, tags)
2071 if ((definition && !(tmtag->type & forward_types)) ||
2072 (!definition && (tmtag->type & forward_types)))
2074 /* If there are typedefs of e.g. a struct such as
2075 * "typedef struct Foo {} Foo;", filter out the typedef unless
2076 * cursor is at the struct name. */
2077 if (last_tag != NULL && last_tag->file == tmtag->file &&
2078 last_tag->type != tm_tag_typedef_t && tmtag->type == tm_tag_typedef_t)
2080 if (last_tag == current_tag)
2081 g_ptr_array_add(filtered_tags, tmtag);
2083 else if (tmtag != current_tag)
2084 g_ptr_array_add(filtered_tags, tmtag);
2086 last_tag = tmtag;
2090 return filtered_tags;
2094 static gboolean goto_tag(const gchar *name, gboolean definition)
2096 const TMTagType forward_types = tm_tag_prototype_t | tm_tag_externvar_t;
2097 TMTag *tmtag, *current_tag = NULL;
2098 GeanyDocument *old_doc = document_get_current();
2099 gboolean found = FALSE;
2100 const GPtrArray *all_tags;
2101 GPtrArray *tags, *filtered_tags;
2102 guint i;
2103 guint current_line = sci_get_current_line(old_doc->editor->sci) + 1;
2105 all_tags = tm_workspace_find(name, NULL, tm_tag_max_t, NULL, old_doc->file_type->lang);
2107 /* get rid of global tags and find tag at current line */
2108 tags = g_ptr_array_new();
2109 foreach_ptr_array(tmtag, i, all_tags)
2111 if (tmtag->file)
2113 g_ptr_array_add(tags, tmtag);
2114 if (tmtag->file == old_doc->tm_file && tmtag->line == current_line)
2115 current_tag = tmtag;
2119 if (current_tag)
2120 /* swap definition/declaration search */
2121 definition = current_tag->type & forward_types;
2123 filtered_tags = filter_tags(tags, current_tag, definition);
2124 if (filtered_tags->len == 0)
2126 /* if we didn't find anything, try again with the opposite type */
2127 g_ptr_array_free(filtered_tags, TRUE);
2128 filtered_tags = filter_tags(tags, current_tag, !definition);
2130 g_ptr_array_free(tags, TRUE);
2131 tags = filtered_tags;
2133 if (tags->len == 1)
2135 GeanyDocument *new_doc;
2137 tmtag = tags->pdata[0];
2138 new_doc = document_find_by_real_path(tmtag->file->file_name);
2140 if (!new_doc)
2141 /* not found in opened document, should open */
2142 new_doc = document_open_file(tmtag->file->file_name, FALSE, NULL, NULL);
2144 navqueue_goto_line(old_doc, new_doc, tmtag->line);
2146 else if (tags->len > 1)
2148 GPtrArray *tag_list;
2149 TMTag *tag, *best_tag;
2151 g_ptr_array_sort(tags, compare_tags_by_name_line);
2152 best_tag = find_best_goto_tag(old_doc, tags);
2154 tag_list = g_ptr_array_new();
2155 if (best_tag)
2156 g_ptr_array_add(tag_list, best_tag);
2157 foreach_ptr_array(tag, i, tags)
2159 if (tag != best_tag)
2160 g_ptr_array_add(tag_list, tag);
2162 show_goto_popup(old_doc, tag_list, best_tag != NULL);
2164 g_ptr_array_free(tag_list, TRUE);
2167 found = tags->len > 0;
2168 g_ptr_array_free(tags, TRUE);
2170 return found;
2174 gboolean symbols_goto_tag(const gchar *name, gboolean definition)
2176 if (goto_tag(name, definition))
2177 return TRUE;
2179 /* if we are here, there was no match and we are beeping ;-) */
2180 utils_beep();
2182 if (!definition)
2183 ui_set_statusbar(FALSE, _("Forward declaration \"%s\" not found."), name);
2184 else
2185 ui_set_statusbar(FALSE, _("Definition of \"%s\" not found."), name);
2186 return FALSE;
2190 /* This could perhaps be improved to check for #if, class etc. */
2191 static gint get_function_fold_number(GeanyDocument *doc)
2193 /* for Java the functions are always one fold level above the class scope */
2194 if (doc->file_type->id == GEANY_FILETYPES_JAVA)
2195 return SC_FOLDLEVELBASE + 1;
2196 else
2197 return SC_FOLDLEVELBASE;
2201 /* Should be used only with get_current_tag_cached.
2202 * tag_types caching might trigger recomputation too often but this isn't used differently often
2203 * enough to be an issue for now */
2204 static gboolean current_tag_changed(GeanyDocument *doc, gint cur_line, gint fold_level, guint tag_types)
2206 static gint old_line = -2;
2207 static GeanyDocument *old_doc = NULL;
2208 static gint old_fold_num = -1;
2209 static guint old_tag_types = 0;
2210 const gint fold_num = fold_level & SC_FOLDLEVELNUMBERMASK;
2211 gboolean ret;
2213 /* check if the cached line and file index have changed since last time: */
2214 if (doc == NULL || doc != old_doc || old_tag_types != tag_types)
2215 ret = TRUE;
2216 else if (cur_line == old_line)
2217 ret = FALSE;
2218 else
2220 /* if the line has only changed by 1 */
2221 if (abs(cur_line - old_line) == 1)
2223 /* It's the same function if the fold number hasn't changed */
2224 ret = (fold_num != old_fold_num);
2226 else ret = TRUE;
2229 /* record current line and file index for next time */
2230 old_line = cur_line;
2231 old_doc = doc;
2232 old_fold_num = fold_num;
2233 old_tag_types = tag_types;
2234 return ret;
2238 /* Parse the function name up to 2 lines before tag_line.
2239 * C++ like syntax should be parsed by parse_cpp_function_at_line, otherwise the return
2240 * type or argument names can be confused with the function name. */
2241 static gchar *parse_function_at_line(ScintillaObject *sci, gint tag_line)
2243 gint start, end, max_pos;
2244 gint fn_style;
2246 switch (sci_get_lexer(sci))
2248 case SCLEX_RUBY: fn_style = SCE_RB_DEFNAME; break;
2249 case SCLEX_PYTHON: fn_style = SCE_P_DEFNAME; break;
2250 default: fn_style = SCE_C_IDENTIFIER; /* several lexers use SCE_C_IDENTIFIER */
2252 start = sci_get_position_from_line(sci, tag_line - 2);
2253 max_pos = sci_get_position_from_line(sci, tag_line + 1);
2254 while (start < max_pos && sci_get_style_at(sci, start) != fn_style)
2255 start++;
2257 end = start;
2258 while (end < max_pos && sci_get_style_at(sci, end) == fn_style)
2259 end++;
2261 if (start == end)
2262 return NULL;
2263 return sci_get_contents_range(sci, start, end);
2267 /* Parse the function name */
2268 static gchar *parse_cpp_function_at_line(ScintillaObject *sci, gint tag_line)
2270 gint start, end, first_pos, max_pos;
2271 gint tmp;
2272 gchar c;
2274 first_pos = end = sci_get_position_from_line(sci, tag_line);
2275 max_pos = sci_get_position_from_line(sci, tag_line + 1);
2276 tmp = 0;
2277 /* goto the begin of function body */
2278 while (end < max_pos &&
2279 (tmp = sci_get_char_at(sci, end)) != '{' &&
2280 tmp != 0) end++;
2281 if (tmp == 0) end --;
2283 /* go back to the end of function identifier */
2284 while (end > 0 && end > first_pos - 500 &&
2285 (tmp = sci_get_char_at(sci, end)) != '(' &&
2286 tmp != 0) end--;
2287 end--;
2288 if (end < 0) end = 0;
2290 /* skip whitespaces between identifier and ( */
2291 while (end > 0 && isspace(sci_get_char_at(sci, end))) end--;
2293 start = end;
2294 /* Use tmp to find SCE_C_IDENTIFIER or SCE_C_GLOBALCLASS chars */
2295 while (start >= 0 && ((tmp = sci_get_style_at(sci, start)) == SCE_C_IDENTIFIER
2296 || tmp == SCE_C_GLOBALCLASS
2297 || (c = sci_get_char_at(sci, start)) == '~'
2298 || c == ':'))
2299 start--;
2300 if (start != 0 && start < end) start++; /* correct for last non-matching char */
2302 if (start == end) return NULL;
2303 return sci_get_contents_range(sci, start, end + 1);
2307 /* gets the fold header after or on @line, but skipping folds created because of parentheses */
2308 static gint get_fold_header_after(ScintillaObject *sci, gint line)
2310 const gint line_count = sci_get_line_count(sci);
2312 for (; line < line_count; line++)
2314 if (sci_get_fold_level(sci, line) & SC_FOLDLEVELHEADERFLAG)
2316 const gint last_child = SSM(sci, SCI_GETLASTCHILD, line, -1);
2317 const gint line_end = sci_get_line_end_position(sci, line);
2318 const gint lexer = sci_get_lexer(sci);
2319 gint parenthesis_match_line = -1;
2321 /* now find any unbalanced open parenthesis on the line and see where the matching
2322 * brace would be, mimicking what folding on () does */
2323 for (gint pos = sci_get_position_from_line(sci, line); pos < line_end; pos++)
2325 if (highlighting_is_code_style(lexer, sci_get_style_at(sci, pos)) &&
2326 sci_get_char_at(sci, pos) == '(')
2328 const gint matching = sci_find_matching_brace(sci, pos);
2330 if (matching >= 0)
2332 parenthesis_match_line = sci_get_line_from_position(sci, matching);
2333 if (parenthesis_match_line != line)
2334 break; /* match is on a different line, we found a possible fold */
2335 else
2336 pos = matching; /* just skip the range and continue searching */
2341 /* if the matching parenthesis matches the fold level, skip it and continue.
2342 * it matches if it either spans the same lines, or spans one more but the next one is
2343 * a fold header (in which case the last child of the fold is one less to let the
2344 * header be at the parent level) */
2345 if ((parenthesis_match_line == last_child) ||
2346 (parenthesis_match_line == last_child + 1 &&
2347 sci_get_fold_level(sci, parenthesis_match_line) & SC_FOLDLEVELHEADERFLAG))
2348 line = last_child;
2349 else
2350 return line;
2354 return -1;
2358 static gint get_current_tag_name(GeanyDocument *doc, gchar **tagname, TMTagType tag_types)
2360 gint line;
2361 gint parent;
2363 line = sci_get_current_line(doc->editor->sci);
2364 parent = sci_get_fold_parent(doc->editor->sci, line);
2365 /* if we're inside a fold level and we have up-to-date tags, get the function from TM */
2366 if (parent >= 0 && doc->tm_file != NULL && doc->tm_file->tags_array != NULL &&
2367 (! doc->changed || editor_prefs.autocompletion_update_freq > 0))
2369 const TMTag *tag = tm_get_current_tag(doc->tm_file->tags_array, parent + 1, tag_types);
2371 if (tag)
2373 gint tag_line = tag->line - 1;
2374 gint last_child = line + 1;
2376 /* if it may be a false positive because we're inside a fold level not inside anything
2377 * we match, e.g. a #if in C or C++, we check we're inside the fold level that start
2378 * right after the tag we got from TM.
2379 * Additionally, we perform parentheses matching on the initial line not to get confused
2380 * by folding on () in case the parameter list spans multiple lines */
2381 if (abs(tag_line - parent) > 1)
2383 const gint tag_fold = get_fold_header_after(doc->editor->sci, tag_line);
2384 if (tag_fold >= 0)
2385 last_child = SSM(doc->editor->sci, SCI_GETLASTCHILD, tag_fold, -1);
2388 if (line <= last_child)
2390 if (tag->scope)
2391 *tagname = g_strconcat(tag->scope,
2392 symbols_get_context_separator(doc->file_type->id), tag->name, NULL);
2393 else
2394 *tagname = g_strdup(tag->name);
2396 return tag_line;
2400 /* for the poor guy with a modified document and without real time tag parsing, we fallback
2401 * to dirty and inaccurate hand-parsing */
2402 else if (parent >= 0 && doc->file_type != NULL && doc->file_type->id != GEANY_FILETYPES_NONE)
2404 const gint fn_fold = get_function_fold_number(doc);
2405 gint tag_line = parent;
2406 gint fold_level = sci_get_fold_level(doc->editor->sci, tag_line);
2408 /* find the top level fold point */
2409 while (tag_line >= 0 && (fold_level & SC_FOLDLEVELNUMBERMASK) != fn_fold)
2411 tag_line = sci_get_fold_parent(doc->editor->sci, tag_line);
2412 fold_level = sci_get_fold_level(doc->editor->sci, tag_line);
2415 if (tag_line >= 0)
2417 gchar *cur_tag;
2419 if (sci_get_lexer(doc->editor->sci) == SCLEX_CPP)
2420 cur_tag = parse_cpp_function_at_line(doc->editor->sci, tag_line);
2421 else
2422 cur_tag = parse_function_at_line(doc->editor->sci, tag_line);
2424 if (cur_tag != NULL)
2426 *tagname = cur_tag;
2427 return tag_line;
2432 *tagname = g_strdup(_("unknown"));
2433 return -1;
2437 static gint get_current_tag_name_cached(GeanyDocument *doc, const gchar **tagname, TMTagType tag_types)
2439 static gint tag_line = -1;
2440 static gchar *cur_tag = NULL;
2442 g_return_val_if_fail(doc == NULL || doc->is_valid, -1);
2444 if (doc == NULL) /* reset current function */
2446 current_tag_changed(NULL, -1, -1, 0);
2447 g_free(cur_tag);
2448 cur_tag = g_strdup(_("unknown"));
2449 if (tagname != NULL)
2450 *tagname = cur_tag;
2451 tag_line = -1;
2453 else
2455 gint line = sci_get_current_line(doc->editor->sci);
2456 gint fold_level = sci_get_fold_level(doc->editor->sci, line);
2458 if (current_tag_changed(doc, line, fold_level, tag_types))
2460 g_free(cur_tag);
2461 tag_line = get_current_tag_name(doc, &cur_tag, tag_types);
2463 *tagname = cur_tag;
2466 return tag_line;
2470 /* Sets *tagname to point at the current function or tag name.
2471 * If doc is NULL, reset the cached current tag data to ensure it will be reparsed on the next
2472 * call to this function.
2473 * Returns: line number of the current tag, or -1 if unknown. */
2474 gint symbols_get_current_function(GeanyDocument *doc, const gchar **tagname)
2476 return get_current_tag_name_cached(doc, tagname, tm_tag_function_t | tm_tag_method_t);
2480 /* same as symbols_get_current_function() but finds class, namespaces and more */
2481 gint symbols_get_current_scope(GeanyDocument *doc, const gchar **tagname)
2483 TMTagType tag_types = (tm_tag_function_t | tm_tag_method_t | tm_tag_class_t |
2484 tm_tag_struct_t | tm_tag_enum_t | tm_tag_union_t);
2486 /* Python parser reports imports as namespaces which confuses the scope detection */
2487 if (doc && doc->file_type->lang != filetypes[GEANY_FILETYPES_PYTHON]->lang)
2488 tag_types |= tm_tag_namespace_t;
2490 return get_current_tag_name_cached(doc, tagname, tag_types);
2494 static void on_symbol_tree_sort_clicked(GtkMenuItem *menuitem, gpointer user_data)
2496 gint sort_mode = GPOINTER_TO_INT(user_data);
2497 GeanyDocument *doc = document_get_current();
2499 if (ignore_callback)
2500 return;
2502 if (doc != NULL)
2503 doc->has_tags = symbols_recreate_tag_list(doc, sort_mode);
2507 static void on_symbol_tree_menu_show(GtkWidget *widget,
2508 gpointer user_data)
2510 GeanyDocument *doc = document_get_current();
2511 gboolean enable;
2513 enable = doc && doc->has_tags;
2514 gtk_widget_set_sensitive(symbol_menu.sort_by_name, enable);
2515 gtk_widget_set_sensitive(symbol_menu.sort_by_appearance, enable);
2516 gtk_widget_set_sensitive(symbol_menu.expand_all, enable);
2517 gtk_widget_set_sensitive(symbol_menu.collapse_all, enable);
2518 gtk_widget_set_sensitive(symbol_menu.find_usage, enable);
2519 gtk_widget_set_sensitive(symbol_menu.find_doc_usage, enable);
2521 if (! doc)
2522 return;
2524 ignore_callback = TRUE;
2526 if (doc->priv->symbol_list_sort_mode == SYMBOLS_SORT_BY_NAME)
2527 gtk_check_menu_item_set_active(GTK_CHECK_MENU_ITEM(symbol_menu.sort_by_name), TRUE);
2528 else
2529 gtk_check_menu_item_set_active(GTK_CHECK_MENU_ITEM(symbol_menu.sort_by_appearance), TRUE);
2531 ignore_callback = FALSE;
2535 static void on_expand_collapse(GtkWidget *widget, gpointer user_data)
2537 gboolean expand = GPOINTER_TO_INT(user_data);
2538 GeanyDocument *doc = document_get_current();
2540 if (! doc)
2541 return;
2543 g_return_if_fail(doc->priv->tag_tree);
2545 if (expand)
2546 gtk_tree_view_expand_all(GTK_TREE_VIEW(doc->priv->tag_tree));
2547 else
2548 gtk_tree_view_collapse_all(GTK_TREE_VIEW(doc->priv->tag_tree));
2552 static void on_find_usage(GtkWidget *widget, G_GNUC_UNUSED gpointer unused)
2554 GtkTreeIter iter;
2555 GtkTreeSelection *selection;
2556 GtkTreeModel *model;
2557 GeanyDocument *doc;
2558 TMTag *tag = NULL;
2560 doc = document_get_current();
2561 if (!doc)
2562 return;
2564 selection = gtk_tree_view_get_selection(GTK_TREE_VIEW(doc->priv->tag_tree));
2565 if (gtk_tree_selection_get_selected(selection, &model, &iter))
2566 gtk_tree_model_get(model, &iter, SYMBOLS_COLUMN_TAG, &tag, -1);
2567 if (tag)
2569 if (widget == symbol_menu.find_in_files)
2570 search_show_find_in_files_dialog_full(tag->name, NULL);
2571 else
2572 search_find_usage(tag->name, tag->name, GEANY_FIND_WHOLEWORD | GEANY_FIND_MATCHCASE,
2573 widget == symbol_menu.find_usage);
2575 tm_tag_unref(tag);
2580 static void create_taglist_popup_menu(void)
2582 GtkWidget *item, *menu;
2584 tv.popup_taglist = menu = gtk_menu_new();
2586 symbol_menu.expand_all = item = ui_image_menu_item_new(GTK_STOCK_ADD, _("_Expand All"));
2587 gtk_widget_show(item);
2588 gtk_container_add(GTK_CONTAINER(menu), item);
2589 g_signal_connect(item, "activate", G_CALLBACK(on_expand_collapse), GINT_TO_POINTER(TRUE));
2591 symbol_menu.collapse_all = item = ui_image_menu_item_new(GTK_STOCK_REMOVE, _("_Collapse All"));
2592 gtk_widget_show(item);
2593 gtk_container_add(GTK_CONTAINER(menu), item);
2594 g_signal_connect(item, "activate", G_CALLBACK(on_expand_collapse), GINT_TO_POINTER(FALSE));
2596 item = gtk_separator_menu_item_new();
2597 gtk_widget_show(item);
2598 gtk_container_add(GTK_CONTAINER(menu), item);
2600 symbol_menu.sort_by_name = item = gtk_radio_menu_item_new_with_mnemonic(NULL,
2601 _("Sort by _Name"));
2602 gtk_widget_show(item);
2603 gtk_container_add(GTK_CONTAINER(menu), item);
2604 g_signal_connect(item, "activate", G_CALLBACK(on_symbol_tree_sort_clicked),
2605 GINT_TO_POINTER(SYMBOLS_SORT_BY_NAME));
2607 symbol_menu.sort_by_appearance = item = gtk_radio_menu_item_new_with_mnemonic_from_widget(
2608 GTK_RADIO_MENU_ITEM(item), _("Sort by _Appearance"));
2609 gtk_widget_show(item);
2610 gtk_container_add(GTK_CONTAINER(menu), item);
2611 g_signal_connect(item, "activate", G_CALLBACK(on_symbol_tree_sort_clicked),
2612 GINT_TO_POINTER(SYMBOLS_SORT_BY_APPEARANCE));
2614 item = gtk_separator_menu_item_new();
2615 gtk_widget_show(item);
2616 gtk_container_add(GTK_CONTAINER(menu), item);
2618 symbol_menu.find_usage = item = ui_image_menu_item_new(GTK_STOCK_FIND, _("Find _Usage"));
2619 gtk_widget_show(item);
2620 gtk_container_add(GTK_CONTAINER(menu), item);
2621 g_signal_connect(item, "activate", G_CALLBACK(on_find_usage), symbol_menu.find_usage);
2623 symbol_menu.find_doc_usage = item = ui_image_menu_item_new(GTK_STOCK_FIND, _("Find _Document Usage"));
2624 gtk_widget_show(item);
2625 gtk_container_add(GTK_CONTAINER(menu), item);
2626 g_signal_connect(item, "activate", G_CALLBACK(on_find_usage), symbol_menu.find_doc_usage);
2628 symbol_menu.find_in_files = item = ui_image_menu_item_new(GTK_STOCK_FIND, _("Find in F_iles..."));
2629 gtk_widget_show(item);
2630 gtk_container_add(GTK_CONTAINER(menu), item);
2631 g_signal_connect(item, "activate", G_CALLBACK(on_find_usage), NULL);
2633 g_signal_connect(menu, "show", G_CALLBACK(on_symbol_tree_menu_show), NULL);
2635 sidebar_add_common_menu_items(GTK_MENU(menu));
2639 static void on_document_save(G_GNUC_UNUSED GObject *object, GeanyDocument *doc)
2641 gchar *f;
2643 g_return_if_fail(!EMPTY(doc->real_path));
2645 f = g_build_filename(app->configdir, "ignore.tags", NULL);
2646 if (utils_str_equal(doc->real_path, f))
2647 load_c_ignore_tags();
2649 g_free(f);
2653 void symbols_init(void)
2655 gchar *f;
2656 guint i;
2658 create_taglist_popup_menu();
2660 f = g_build_filename(app->configdir, "ignore.tags", NULL);
2661 ui_add_config_file_menu_item(f, NULL, NULL);
2662 g_free(f);
2664 g_signal_connect(geany_object, "document-save", G_CALLBACK(on_document_save), NULL);
2666 for (i = 0; i < G_N_ELEMENTS(symbols_icons); i++)
2667 symbols_icons[i].pixbuf = get_tag_icon(symbols_icons[i].icon_name);
2671 void symbols_finalize(void)
2673 guint i;
2675 g_strfreev(c_tags_ignore);
2677 for (i = 0; i < G_N_ELEMENTS(symbols_icons); i++)
2679 if (symbols_icons[i].pixbuf)
2680 g_object_unref(symbols_icons[i].pixbuf);