Cache G_TYPE_INSTANCE_GET_PRIVATE() result when initializing an
[geany-mirror.git] / src / symbols.c
blob85f58f0b931b920b025e8ff06f56c07e89f7805b
1 /*
2 * symbols.c - this file is part of Geany, a fast and lightweight IDE
4 * Copyright 2006-2010 Enrico Tröger <enrico(dot)troeger(at)uvena(dot)de>
5 * Copyright 2006-2010 Nick Treleaven <nick(dot)treleaven(at)btinternet(dot)com>
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
21 * $Id$
25 * Symbol Tree and TagManager-related convenience functions.
26 * TagManager parses tags for each document, and also adds them to the workspace (session).
27 * Global tags are lists of tags for each filetype, loaded when a document with a
28 * matching filetype is first loaded.
31 #include "SciLexer.h"
32 #include "geany.h"
34 #include <ctype.h>
35 #include <string.h>
36 #include <stdlib.h>
38 #include "prefix.h"
39 #include "symbols.h"
40 #include "utils.h"
41 #include "filetypes.h"
42 #include "encodings.h"
43 #include "document.h"
44 #include "documentprivate.h"
45 #include "support.h"
46 #include "msgwindow.h"
47 #include "sidebar.h"
48 #include "main.h"
49 #include "navqueue.h"
50 #include "ui_utils.h"
51 #include "editor.h"
52 #include "sciwrappers.h"
55 const guint TM_GLOBAL_TYPE_MASK =
56 tm_tag_class_t | tm_tag_enum_t | tm_tag_interface_t |
57 tm_tag_struct_t | tm_tag_typedef_t | tm_tag_union_t | tm_tag_namespace_t;
60 static gchar **html_entities = NULL;
62 typedef struct
64 gboolean tags_loaded;
65 const gchar *tag_file;
66 } TagFileInfo;
68 /* Check before adding any more tags files, usually they should be downloaded separately. */
69 enum /* Geany tag files */
71 GTF_C,
72 GTF_PASCAL,
73 GTF_PHP,
74 GTF_HTML_ENTITIES,
75 GTF_LATEX,
76 GTF_PYTHON,
77 GTF_MAX
80 static TagFileInfo tag_file_info[GTF_MAX] =
82 {FALSE, "c99.tags"},
83 {FALSE, "pascal.tags"},
84 {FALSE, "php.tags"},
85 {FALSE, "html_entities.tags"},
86 {FALSE, "latex.tags"},
87 {FALSE, "python.tags"}
90 static GPtrArray *top_level_iter_names = NULL;
92 static struct
94 GtkWidget *expand_all;
95 GtkWidget *collapse_all;
96 GtkWidget *sort_by_name;
97 GtkWidget *sort_by_appearance;
99 symbol_menu = {NULL, NULL, NULL, NULL};
102 static void html_tags_loaded(void);
103 static void load_user_tags(filetype_id ft_id);
105 /* get the tags_ignore list, exported by tagmanager's options.c */
106 extern gchar **c_tags_ignore;
108 /* ignore certain tokens when parsing C-like syntax.
109 * Also works for reloading. */
110 static void load_c_ignore_tags(void)
112 gchar *path = g_strconcat(app->configdir, G_DIR_SEPARATOR_S "ignore.tags", NULL);
113 gchar *content;
115 if (g_file_get_contents(path, &content, NULL, NULL))
117 g_strfreev(c_tags_ignore);
118 c_tags_ignore = g_strsplit_set(content, " \n\r", -1);
119 g_free(content);
121 g_free(path);
125 void symbols_reload_config_files(void)
127 load_c_ignore_tags();
131 static gsize get_tag_count()
133 GPtrArray *tags = tm_get_workspace()->global_tags;
134 gsize count = tags ? tags->len : 0;
136 return count;
140 /* wrapper for tm_workspace_load_global_tags().
141 * note that the tag count only counts new global tags added - if a tag has the same name,
142 * currently it replaces the existing tag, so loading a file twice will say 0 tags the 2nd time. */
143 static gboolean symbols_load_global_tags(const gchar *tags_file, GeanyFiletype *ft)
145 gboolean result;
146 gsize old_tag_count = get_tag_count();
148 result = tm_workspace_load_global_tags(tags_file, ft->lang);
149 if (result)
151 geany_debug("Loaded %s (%s), %u tag(s).", tags_file, ft->name,
152 (guint) (get_tag_count() - old_tag_count));
154 return result;
158 /* Ensure that the global tags file(s) for the file_type_idx filetype is loaded.
159 * This provides autocompletion, calltips, etc. */
160 void symbols_global_tags_loaded(gint file_type_idx)
162 TagFileInfo *tfi;
163 gint tag_type;
165 /* load ignore list for C/C++ parser */
166 if ((file_type_idx == GEANY_FILETYPES_C || file_type_idx == GEANY_FILETYPES_CPP) &&
167 c_tags_ignore == NULL)
169 load_c_ignore_tags();
172 if (cl_options.ignore_global_tags || app->tm_workspace == NULL)
173 return;
175 /* load config in case of custom filetypes */
176 filetypes_load_config(file_type_idx, FALSE);
178 load_user_tags(file_type_idx);
180 switch (file_type_idx)
182 case GEANY_FILETYPES_PHP:
183 case GEANY_FILETYPES_HTML:
184 html_tags_loaded();
186 switch (file_type_idx)
188 case GEANY_FILETYPES_CPP:
189 symbols_global_tags_loaded(GEANY_FILETYPES_C); /* load C global tags */
190 /* no C++ tagfile yet */
191 return;
192 case GEANY_FILETYPES_C: tag_type = GTF_C; break;
193 case GEANY_FILETYPES_PASCAL:tag_type = GTF_PASCAL; break;
194 case GEANY_FILETYPES_PHP: tag_type = GTF_PHP; break;
195 case GEANY_FILETYPES_LATEX: tag_type = GTF_LATEX; break;
196 case GEANY_FILETYPES_PYTHON:tag_type = GTF_PYTHON; break;
197 default:
198 return;
200 tfi = &tag_file_info[tag_type];
202 if (! tfi->tags_loaded)
204 gchar *fname = g_strconcat(app->datadir, G_DIR_SEPARATOR_S, tfi->tag_file, NULL);
206 symbols_load_global_tags(fname, filetypes[file_type_idx]);
207 tfi->tags_loaded = TRUE;
208 g_free(fname);
213 /* HTML tagfile is just a list of entities for autocompletion (e.g. '&amp;') */
214 static void html_tags_loaded(void)
216 TagFileInfo *tfi;
218 if (cl_options.ignore_global_tags)
219 return;
221 tfi = &tag_file_info[GTF_HTML_ENTITIES];
222 if (! tfi->tags_loaded)
224 gchar *file = g_strconcat(app->datadir, G_DIR_SEPARATOR_S, tfi->tag_file, NULL);
226 html_entities = utils_read_file_in_array(file);
227 tfi->tags_loaded = TRUE;
228 g_free(file);
233 GString *symbols_find_tags_as_string(GPtrArray *tags_array, guint tag_types, gint lang)
235 guint j;
236 TMTag *tag;
237 GString *s = NULL;
238 GPtrArray *typedefs;
239 gint tag_lang;
241 g_return_val_if_fail(tags_array != NULL, NULL);
243 typedefs = tm_tags_extract(tags_array, tag_types);
245 if ((typedefs) && (typedefs->len > 0))
247 s = g_string_sized_new(typedefs->len * 10);
248 for (j = 0; j < typedefs->len; ++j)
250 tag = TM_TAG(typedefs->pdata[j]);
251 /* tag->atts.file.lang contains (for some reason) the line of the tag if
252 * tag->atts.entry.file is not NULL */
253 tag_lang = (tag->atts.entry.file) ? tag->atts.entry.file->lang : tag->atts.file.lang;
255 /* the check for tag_lang == lang is necessary to avoid wrong type colouring of
256 * e.g. PHP classes in C++ files
257 * lang = -2 disables the check */
258 if (tag->name && (tag_lang == lang || lang == -2))
260 if (j != 0)
261 g_string_append_c(s, ' ');
262 g_string_append(s, tag->name);
266 if (typedefs)
267 g_ptr_array_free(typedefs, TRUE);
268 return s;
272 const gchar *symbols_get_context_separator(gint ft_id)
274 switch (ft_id)
276 case GEANY_FILETYPES_C: /* for C++ .h headers or C structs */
277 case GEANY_FILETYPES_CPP:
278 case GEANY_FILETYPES_GLSL: /* for structs */
279 /*case GEANY_FILETYPES_RUBY:*/ /* not sure what to use atm*/
280 return "::";
282 /* avoid confusion with other possible separators in group/section name */
283 case GEANY_FILETYPES_CONF:
284 case GEANY_FILETYPES_REST:
285 return ":::";
287 default:
288 return ".";
293 GString *symbols_get_macro_list(gint lang)
295 guint j, i;
296 GPtrArray *ftags;
297 GString *words;
298 gint tag_lang;
299 TMTag *tag;
301 if (app->tm_workspace->work_objects == NULL)
302 return NULL;
304 ftags = g_ptr_array_sized_new(50);
305 words = g_string_sized_new(200);
307 for (j = 0; j < app->tm_workspace->work_objects->len; j++)
309 GPtrArray *tags;
311 tags = tm_tags_extract(TM_WORK_OBJECT(app->tm_workspace->work_objects->pdata[j])->tags_array,
312 tm_tag_enum_t | tm_tag_variable_t | tm_tag_macro_t | tm_tag_macro_with_arg_t);
313 if (NULL != tags)
315 for (i = 0; ((i < tags->len) && (i < editor_prefs.autocompletion_max_entries)); ++i)
317 tag = TM_TAG(tags->pdata[i]);
318 tag_lang = (tag->atts.entry.file) ?
319 tag->atts.entry.file->lang : tag->atts.file.lang;
321 if (tag_lang == lang)
322 g_ptr_array_add(ftags, (gpointer) tags->pdata[i]);
324 g_ptr_array_free(tags, TRUE);
328 if (ftags->len == 0)
330 g_ptr_array_free(ftags, TRUE);
331 g_string_free(words, TRUE);
332 return NULL;
335 tm_tags_sort(ftags, NULL, FALSE);
336 for (j = 0; j < ftags->len; j++)
338 if (j > 0)
339 g_string_append_c(words, '\n');
340 g_string_append(words, TM_TAG(ftags->pdata[j])->name);
342 g_ptr_array_free(ftags, TRUE);
343 return words;
347 /* Note: if tags is sorted, we can use bsearch or tm_tags_find() to speed this up. */
348 static TMTag *
349 symbols_find_tm_tag(const GPtrArray *tags, const gchar *tag_name)
351 guint i;
352 g_return_val_if_fail(tags != NULL, NULL);
354 for (i = 0; i < tags->len; ++i)
356 if (utils_str_equal(TM_TAG(tags->pdata[i])->name, tag_name))
357 return TM_TAG(tags->pdata[i]);
359 return NULL;
363 static TMTag *find_work_object_tag(const TMWorkObject *workobj,
364 const gchar *tag_name, gint type)
366 GPtrArray *tags;
367 TMTag *tmtag;
369 if (G_LIKELY(workobj != NULL))
371 tags = tm_tags_extract(workobj->tags_array, type);
372 if (tags != NULL)
374 tmtag = symbols_find_tm_tag(tags, tag_name);
376 g_ptr_array_free(tags, TRUE);
378 if (tmtag != NULL)
379 return tmtag;
382 return NULL; /* not found */
386 static TMTag *find_workspace_tag(const gchar *tag_name, gint type)
388 guint j;
389 const GPtrArray *work_objects = NULL;
391 if (app->tm_workspace != NULL)
392 work_objects = app->tm_workspace->work_objects;
394 if (work_objects != NULL)
396 for (j = 0; j < work_objects->len; j++)
398 TMWorkObject *workobj = TM_WORK_OBJECT(work_objects->pdata[j]);
399 TMTag *tmtag;
401 tmtag = find_work_object_tag(workobj, tag_name, type);
402 if (tmtag != NULL)
403 return tmtag;
406 return NULL; /* not found */
410 const gchar **symbols_get_html_entities(void)
412 if (html_entities == NULL)
413 html_tags_loaded(); /* if not yet created, force creation of the array but shouldn't occur */
415 return (const gchar **) html_entities;
419 /* sort by name, then line */
420 static gint compare_symbol(const TMTag *tag_a, const TMTag *tag_b)
422 gint ret;
424 if (tag_a == NULL || tag_b == NULL)
425 return 0;
427 if (tag_a->name == NULL)
428 return -(tag_a->name != tag_b->name);
430 if (tag_b->name == NULL)
431 return tag_a->name != tag_b->name;
433 ret = strcmp(tag_a->name, tag_b->name);
434 if (ret == 0)
436 return tag_a->atts.entry.line - tag_b->atts.entry.line;
438 return ret;
442 /* sort by line only */
443 static gint compare_symbol_lines(gconstpointer a, gconstpointer b)
445 const TMTag *tag_a = TM_TAG(a);
446 const TMTag *tag_b = TM_TAG(b);
448 if (a == NULL || b == NULL)
449 return 0;
451 return tag_a->atts.entry.line - tag_b->atts.entry.line;
455 static GList *get_tag_list(GeanyDocument *doc, guint tag_types)
457 GList *tag_names = NULL;
458 TMTag *tag;
459 guint i;
461 g_return_val_if_fail(doc, NULL);
463 if (! doc->tm_file || ! doc->tm_file->tags_array)
464 return NULL;
466 for (i = 0; i < doc->tm_file->tags_array->len; ++i)
468 tag = TM_TAG(doc->tm_file->tags_array->pdata[i]);
469 if (G_UNLIKELY(tag == NULL))
470 return NULL;
472 if (tag->type & tag_types)
474 tag_names = g_list_append(tag_names, tag);
477 tag_names = g_list_sort(tag_names, compare_symbol_lines);
478 return tag_names;
482 /* amount of types in the symbol list (currently max. 8 are used) */
483 #define MAX_SYMBOL_TYPES (sizeof(tv_iters) / sizeof(GtkTreeIter))
485 struct TreeviewSymbols
487 GtkTreeIter tag_function;
488 GtkTreeIter tag_class;
489 GtkTreeIter tag_macro;
490 GtkTreeIter tag_member;
491 GtkTreeIter tag_variable;
492 GtkTreeIter tag_namespace;
493 GtkTreeIter tag_struct;
494 GtkTreeIter tag_type;
495 GtkTreeIter tag_other;
496 } tv_iters;
499 static void init_tag_iters(void)
501 /* init all GtkTreeIters with -1 to make them invalid to avoid crashes when switching between
502 * filetypes(e.g. config file to Python crashes Geany without this) */
503 tv_iters.tag_function.stamp = -1;
504 tv_iters.tag_class.stamp = -1;
505 tv_iters.tag_member.stamp = -1;
506 tv_iters.tag_macro.stamp = -1;
507 tv_iters.tag_variable.stamp = -1;
508 tv_iters.tag_namespace.stamp = -1;
509 tv_iters.tag_struct.stamp = -1;
510 tv_iters.tag_type.stamp = -1;
511 tv_iters.tag_other.stamp = -1;
515 static GdkPixbuf *get_tag_icon(const gchar *icon_name)
517 static GtkIconTheme *icon_theme = NULL;
518 static gint x, y;
520 if (G_UNLIKELY(icon_theme == NULL))
522 #ifndef G_OS_WIN32
523 gchar *path = g_strconcat(GEANY_DATADIR, "/icons", NULL);
524 #endif
525 gtk_icon_size_lookup(GTK_ICON_SIZE_MENU, &x, &y);
526 icon_theme = gtk_icon_theme_get_default();
527 #ifdef G_OS_WIN32
528 gtk_icon_theme_append_search_path(icon_theme, "share\\icons");
529 #else
530 gtk_icon_theme_append_search_path(icon_theme, path);
531 g_free(path);
532 #endif
534 return gtk_icon_theme_load_icon(icon_theme, icon_name, x, 0, NULL);
538 /* Adds symbol list groups in (iter*, title) pairs.
539 * The list must be ended with NULL. */
540 static void G_GNUC_NULL_TERMINATED
541 tag_list_add_groups(GtkTreeStore *tree_store, ...)
543 va_list args;
544 GtkTreeIter *iter;
546 g_return_if_fail(top_level_iter_names);
548 va_start(args, tree_store);
549 for (; iter = va_arg(args, GtkTreeIter*), iter != NULL;)
551 gchar *title = va_arg(args, gchar*);
552 gchar *icon_name = va_arg(args, gchar *);
553 GdkPixbuf *icon = NULL;
555 if (icon_name)
557 icon = get_tag_icon(icon_name);
560 g_assert(title != NULL);
561 g_ptr_array_add(top_level_iter_names, title);
563 gtk_tree_store_append(tree_store, iter, NULL);
565 if (G_IS_OBJECT(icon))
567 gtk_tree_store_set(tree_store, iter, SYMBOLS_COLUMN_ICON, icon, -1);
568 g_object_unref(icon);
570 gtk_tree_store_set(tree_store, iter, SYMBOLS_COLUMN_NAME, title, -1);
572 va_end(args);
576 static void add_top_level_items(GeanyDocument *doc)
578 filetype_id ft_id = doc->file_type->id;
579 GtkTreeStore *tag_store = doc->priv->tag_store;
581 if (top_level_iter_names == NULL)
582 top_level_iter_names = g_ptr_array_new();
583 else
584 g_ptr_array_set_size(top_level_iter_names, 0);
586 init_tag_iters();
588 switch (ft_id)
590 case GEANY_FILETYPES_DIFF:
592 tag_list_add_groups(tag_store,
593 &(tv_iters.tag_function), _("Files"), NULL, NULL);
594 break;
596 case GEANY_FILETYPES_DOCBOOK:
598 tag_list_add_groups(tag_store,
599 &(tv_iters.tag_function), _("Chapter"), NULL,
600 &(tv_iters.tag_class), _("Section"), NULL,
601 &(tv_iters.tag_member), _("Sect1"), NULL,
602 &(tv_iters.tag_macro), _("Sect2"), NULL,
603 &(tv_iters.tag_variable), _("Sect3"), NULL,
604 &(tv_iters.tag_struct), _("Appendix"), NULL,
605 &(tv_iters.tag_other), _("Other"), NULL,
606 NULL);
607 /* &(tv_iters.tag_namespace), _("Other"), NULL, NULL); */
608 break;
610 case GEANY_FILETYPES_HASKELL:
611 tag_list_add_groups(tag_store,
612 &tv_iters.tag_namespace, _("Module"), NULL,
613 &tv_iters.tag_type, _("Types"), NULL,
614 &tv_iters.tag_macro, _("Type constructors"), NULL,
615 &tv_iters.tag_function, _("Functions"), "classviewer-method",
616 NULL);
617 break;
618 case GEANY_FILETYPES_CONF:
619 tag_list_add_groups(tag_store,
620 &tv_iters.tag_namespace, _("Sections"), "classviewer-other",
621 &tv_iters.tag_macro, _("Keys"), "classviewer-var",
622 NULL);
623 break;
624 case GEANY_FILETYPES_NSIS:
625 tag_list_add_groups(tag_store,
626 &tv_iters.tag_namespace, _("Sections"), "classviewer-other",
627 &tv_iters.tag_function, _("Functions"), "classviewer-method",
628 &(tv_iters.tag_variable), _("Variables"), "classviewer-var",
629 NULL);
630 break;
631 case GEANY_FILETYPES_LATEX:
633 tag_list_add_groups(tag_store,
634 &(tv_iters.tag_function), _("Command"), NULL,
635 &(tv_iters.tag_class), _("Environment"), NULL,
636 &(tv_iters.tag_member), _("Section"), NULL,
637 &(tv_iters.tag_macro), _("Subsection"), NULL,
638 &(tv_iters.tag_variable), _("Subsubsection"), NULL,
639 &(tv_iters.tag_struct), _("Label"), NULL,
640 &(tv_iters.tag_namespace), _("Chapter"), NULL,
641 &(tv_iters.tag_other), _("Other"), NULL,
642 NULL);
643 break;
645 case GEANY_FILETYPES_MATLAB:
647 tag_list_add_groups(tag_store,
648 &(tv_iters.tag_function), _("Functions"), "classviewer-method",
649 &(tv_iters.tag_struct), _("Structures"), "classviewer-struct",
650 NULL);
651 break;
653 case GEANY_FILETYPES_R:
655 tag_list_add_groups(tag_store,
656 &(tv_iters.tag_function), _("Functions"), "classviewer-method",
657 &(tv_iters.tag_struct), _("Other"), NULL,
658 NULL);
659 break;
661 case GEANY_FILETYPES_PERL:
663 tag_list_add_groups(tag_store,
664 &(tv_iters.tag_namespace), _("Package"), "classviewer-namespace",
665 &(tv_iters.tag_function), _("Functions"), "classviewer-method",
666 &(tv_iters.tag_macro), _("Labels"), NULL,
667 &(tv_iters.tag_type), _("Constants"), NULL,
668 &(tv_iters.tag_other), _("Other"), "classviewer-other",
669 NULL);
670 break;
672 case GEANY_FILETYPES_PHP:
674 tag_list_add_groups(tag_store,
675 &(tv_iters.tag_struct), _("Interfaces"), "classviewer-struct",
676 &(tv_iters.tag_class), _("Classes"), "classviewer-class",
677 &(tv_iters.tag_function), _("Functions"), "classviewer-method",
678 &(tv_iters.tag_macro), _("Constants"), "classviewer-macro",
679 &(tv_iters.tag_variable), _("Variables"), "classviewer-var",
680 NULL);
681 /*&(tv_iters.tag_struct), _("Label"),*/
682 /*&(tv_iters.tag_namespace), _("Begin"),*/
683 /*&(tv_iters.tag_other), _("Other"), NULL);*/
684 break;
686 case GEANY_FILETYPES_HTML:
688 tag_list_add_groups(tag_store,
689 &(tv_iters.tag_function), _("Functions"), NULL,
690 &(tv_iters.tag_member), _("Anchors"), NULL,
691 &(tv_iters.tag_namespace), _("H1 Headings"), NULL,
692 &(tv_iters.tag_class), _("H2 Headings"), NULL,
693 &(tv_iters.tag_variable), _("H3 Headings"), NULL,
694 NULL);
695 break;
697 case GEANY_FILETYPES_CSS:
699 tag_list_add_groups(tag_store,
700 &(tv_iters.tag_class), _("Classes"), "classviewer-class",
701 &(tv_iters.tag_variable), _("ID Selectors"), "classviewer-var",
702 &(tv_iters.tag_struct), _("Type Selectors"), "classviewer-struct", NULL);
703 break;
705 case GEANY_FILETYPES_REST:
706 case GEANY_FILETYPES_TXT2TAGS:
707 case GEANY_FILETYPES_ABC:
709 tag_list_add_groups(tag_store,
710 &(tv_iters.tag_namespace), _("Chapter"), NULL,
711 &(tv_iters.tag_member), _("Section"), NULL,
712 &(tv_iters.tag_macro), _("Subsection"), NULL,
713 &(tv_iters.tag_variable), _("Subsubsection"), NULL,
714 NULL);
715 break;
717 case GEANY_FILETYPES_RUBY:
719 tag_list_add_groups(tag_store,
720 &(tv_iters.tag_namespace), _("Modules"), NULL,
721 &(tv_iters.tag_class), _("Classes"), "classviewer-class",
722 &(tv_iters.tag_member), _("Singletons"), "classviewer-struct",
723 &(tv_iters.tag_function), _("Methods"), "classviewer-method",
724 NULL);
725 /*&(tv_iters.tag_namespace), _("Begin"),*/
726 /*&(tv_iters.tag_other), _("Other"), NULL);*/
727 break;
729 case GEANY_FILETYPES_TCL:
731 tag_list_add_groups(tag_store,
732 &(tv_iters.tag_namespace), _("Namespaces"), "classviewer-namespace",
733 &(tv_iters.tag_class), _("Classes"), "classviewer-class",
734 &(tv_iters.tag_member), _("Methods"), "classviewer-method",
735 &(tv_iters.tag_function), _("Procedures"), "classviewer-other",
736 NULL);
737 break;
739 case GEANY_FILETYPES_PYTHON:
741 tag_list_add_groups(tag_store,
742 &(tv_iters.tag_class), _("Classes"), "classviewer-class",
743 &(tv_iters.tag_member), _("Methods"), "classviewer-macro",
744 &(tv_iters.tag_function), _("Functions"), "classviewer-method",
745 &(tv_iters.tag_variable), _("Variables"), "classviewer-var",
746 &(tv_iters.tag_namespace), _("Imports"), "classviewer-namespace",
747 NULL);
748 /*&(tv_iters.tag_macro), _("Mixin"),*/
749 /*&(tv_iters.tag_variable), _("Variables"),*/
750 /*&(tv_iters.tag_struct), _("Members"),*/
751 /*&(tv_iters.tag_namespace), _("Begin"),*/
752 /*&(tv_iters.tag_other), _("Other"), NULL);*/
753 break;
755 case GEANY_FILETYPES_VHDL:
757 tag_list_add_groups(tag_store,
758 &(tv_iters.tag_namespace), _("Package"), "classviewer-namespace",
759 &(tv_iters.tag_class), _("Entities"), "classviewer-class",
760 &(tv_iters.tag_struct), _("Architectures"), "classviewer-struct",
761 &(tv_iters.tag_type), _("Types"), "classviewer-other",
762 &(tv_iters.tag_function), _("Functions / Procedures"), "classviewer-method",
763 &(tv_iters.tag_variable), _("Variables / Signals"), "classviewer-var",
764 &(tv_iters.tag_member), _("Processes / Components"), "classviewer-member",
765 &(tv_iters.tag_other), _("Other"), "classviewer-other",
766 NULL);
767 break;
769 case GEANY_FILETYPES_VERILOG:
771 tag_list_add_groups(tag_store,
772 &(tv_iters.tag_type), _("Events"), "classviewer-macro",
773 &(tv_iters.tag_class), _("Modules"), "classviewer-class",
774 &(tv_iters.tag_function), _("Functions / Tasks"), "classviewer-method",
775 &(tv_iters.tag_variable), _("Variables"), "classviewer-var",
776 &(tv_iters.tag_other), _("Other"), "classviewer-other",
777 NULL);
778 break;
780 case GEANY_FILETYPES_JAVA:
782 tag_list_add_groups(tag_store,
783 &(tv_iters.tag_namespace), _("Package"), "classviewer-namespace",
784 &(tv_iters.tag_struct), _("Interfaces"), "classviewer-struct",
785 &(tv_iters.tag_class), _("Classes"), "classviewer-class",
786 &(tv_iters.tag_function), _("Methods"), "classviewer-method",
787 &(tv_iters.tag_member), _("Members"), "classviewer-member",
788 /*&(tv_iters.tag_macro), _("Macros"),*/
789 /*&(tv_iters.tag_variable), _("Variables"),*/
790 &(tv_iters.tag_other), _("Other"), "classviewer-other",
791 NULL);
792 break;
794 case GEANY_FILETYPES_AS:
796 tag_list_add_groups(tag_store,
797 &(tv_iters.tag_namespace), _("Package"), "classviewer-namespace",
798 &(tv_iters.tag_struct), _("Interfaces"), "classviewer-struct",
799 &(tv_iters.tag_class), _("Classes"), "classviewer-class",
800 &(tv_iters.tag_function), _("Functions"), "classviewer-method",
801 &(tv_iters.tag_member), _("Properties"), "classviewer-member",
802 &(tv_iters.tag_variable), _("Variables"), "classviewer-var",
803 &(tv_iters.tag_macro), _("Constants"), "classviewer-macro",
804 &(tv_iters.tag_other), _("Other"), "classviewer-other",
805 NULL);
806 break;
808 case GEANY_FILETYPES_HAXE:
810 tag_list_add_groups(tag_store,
811 &(tv_iters.tag_struct), _("Interfaces"), "classviewer-struct",
812 &(tv_iters.tag_class), _("Classes"), "classviewer-class",
813 &(tv_iters.tag_function), _("Methods"), "classviewer-method",
814 &(tv_iters.tag_type), _("Types"), "classviewer-macro",
815 &(tv_iters.tag_variable), _("Variables"), "classviewer-var",
816 &(tv_iters.tag_other), _("Other"), "classviewer-other",
817 NULL);
818 break;
820 case GEANY_FILETYPES_BASIC:
822 tag_list_add_groups(tag_store,
823 &(tv_iters.tag_function), _("Functions"), "classviewer-method",
824 &(tv_iters.tag_variable), _("Variables"), "classviewer-var",
825 &(tv_iters.tag_macro), _("Constants"), "classviewer-macro",
826 &(tv_iters.tag_struct), _("Types"), "classviewer-namespace",
827 &(tv_iters.tag_namespace), _("Labels"), "classviewer-member",
828 &(tv_iters.tag_other), _("Other"), "classviewer-other",
829 NULL);
830 break;
832 case GEANY_FILETYPES_F77:
833 case GEANY_FILETYPES_FORTRAN:
835 tag_list_add_groups(tag_store,
836 &(tv_iters.tag_namespace), _("Module"), "classviewer-class",
837 &(tv_iters.tag_struct), _("Interfaces"), "classviewer-struct",
838 &(tv_iters.tag_function), _("Functions"), "classviewer-method",
839 &(tv_iters.tag_member), _("Subroutines"), "classviewer-method",
840 &(tv_iters.tag_variable), _("Variables"), "classviewer-var",
841 &(tv_iters.tag_type), _("Types"), "classviewer-namespace",
842 &(tv_iters.tag_macro), _("Blocks"), "classviewer-member",
843 &(tv_iters.tag_other), _("Other"), "classviewer-other",
844 NULL);
845 break;
847 case GEANY_FILETYPES_ASM:
849 tag_list_add_groups(tag_store,
850 &(tv_iters.tag_namespace), _("Labels"), "classviewer-namespace",
851 &(tv_iters.tag_function), _("Macros"), "classviewer-method",
852 &(tv_iters.tag_macro), _("Defines"), "classviewer-macro",
853 &(tv_iters.tag_struct), _("Types"), "classviewer-struct",
854 NULL);
855 break;
857 case GEANY_FILETYPES_MAKE:
858 tag_list_add_groups(tag_store,
859 &tv_iters.tag_function, _("Targets"), "classviewer-method",
860 &tv_iters.tag_macro, _("Macros"), "classviewer-macro",
861 NULL);
862 break;
863 case GEANY_FILETYPES_D:
864 default:
866 if (ft_id == GEANY_FILETYPES_D)
867 tag_list_add_groups(tag_store,
868 &(tv_iters.tag_namespace), _("Module"), NULL, NULL);
869 else
870 tag_list_add_groups(tag_store,
871 &(tv_iters.tag_namespace), _("Namespaces"), "classviewer-namespace", NULL);
873 tag_list_add_groups(tag_store,
874 &(tv_iters.tag_class), _("Classes"), "classviewer-class",
875 &(tv_iters.tag_function), _("Functions"), "classviewer-method",
876 &(tv_iters.tag_member), _("Members"), "classviewer-member",
877 &(tv_iters.tag_struct), _("Structs"), "classviewer-struct",
878 &(tv_iters.tag_type), _("Typedefs / Enums"), "classviewer-struct",
879 NULL);
881 if (ft_id != GEANY_FILETYPES_D)
883 tag_list_add_groups(tag_store,
884 &(tv_iters.tag_macro), _("Macros"), "classviewer-macro", NULL);
886 tag_list_add_groups(tag_store,
887 &(tv_iters.tag_variable), _("Variables"), "classviewer-var",
888 &(tv_iters.tag_other), _("Other"), "classviewer-other", NULL);
894 /* the following code surely can be improved, at the moment it collects some iters
895 * for removal and after that the actual removal is done. I didn't find a way to find and remove
896 * an empty row in one loop (next iter fails then) */
897 static void hide_empty_rows(GtkTreeStore *store)
899 GtkTreeIter iter, *iters[MAX_SYMBOL_TYPES] = { NULL };
900 guint i = 0;
902 if (! gtk_tree_model_get_iter_first(GTK_TREE_MODEL(store), &iter))
903 return; /* stop when first iter is invalid, i.e. no elements */
905 do /* first collect the iters we need to delete empty rows */
907 if (! gtk_tree_model_iter_has_child(GTK_TREE_MODEL(store), &iter))
908 iters[i++] = gtk_tree_iter_copy(&iter);
909 } while (gtk_tree_model_iter_next(GTK_TREE_MODEL(store), &iter));
911 /* now actually delete the collected iters */
912 for (i = 0; i < MAX_SYMBOL_TYPES; i++)
914 if (G_UNLIKELY(iters[i] == NULL))
915 break;
916 gtk_tree_store_remove(store, iters[i]);
917 gtk_tree_iter_free(iters[i]);
922 static const gchar *get_symbol_name(GeanyDocument *doc, const TMTag *tag, gboolean found_parent)
924 gchar *utf8_name;
925 const gchar *scope = tag->atts.entry.scope;
926 static GString *buffer = NULL; /* buffer will be small so we can keep it for reuse */
927 gboolean doc_is_utf8 = FALSE;
929 /* encodings_convert_to_utf8_from_charset() fails with charset "None", so skip conversion
930 * for None at this point completely */
931 if (utils_str_equal(doc->encoding, "UTF-8") ||
932 utils_str_equal(doc->encoding, "None"))
933 doc_is_utf8 = TRUE;
935 if (! doc_is_utf8)
936 utf8_name = encodings_convert_to_utf8_from_charset(tag->name,
937 (gsize) -1, doc->encoding, TRUE);
938 else
939 utf8_name = tag->name;
941 if (utf8_name == NULL)
942 return NULL;
944 if (! buffer)
945 buffer = g_string_new(NULL);
946 else
947 g_string_truncate(buffer, 0);
949 /* check first char of scope is a wordchar */
950 if (!found_parent && scope &&
951 strpbrk(scope, GEANY_WORDCHARS) == scope)
953 const gchar *sep = symbols_get_context_separator(FILETYPE_ID(doc->file_type));
955 g_string_append(buffer, scope);
956 g_string_append(buffer, sep);
958 g_string_append(buffer, utf8_name);
960 if (! doc_is_utf8)
961 g_free(utf8_name);
963 g_string_append_printf(buffer, " [%lu]", tag->atts.entry.line);
965 return buffer->str;
969 static gchar *get_symbol_tooltip(GeanyDocument *doc, const TMTag *tag)
971 gchar *utf8_name = editor_get_calltip_text(doc->editor, tag);
973 /* encodings_convert_to_utf8_from_charset() fails with charset "None", so skip conversion
974 * for None at this point completely */
975 if (utf8_name != NULL &&
976 ! utils_str_equal(doc->encoding, "UTF-8") &&
977 ! utils_str_equal(doc->encoding, "None"))
979 setptr(utf8_name,
980 encodings_convert_to_utf8_from_charset(utf8_name, (gsize) -1, doc->encoding, TRUE));
983 if (utf8_name != NULL)
984 setptr(utf8_name, g_markup_escape_text(utf8_name, -1));
986 return utf8_name;
990 /* find the last word in "foo::bar::blah", e.g. "blah" */
991 const gchar *get_parent_name(const TMTag *tag, filetype_id ft_id)
993 const gchar *scope = tag->atts.entry.scope;
994 const gchar *separator = symbols_get_context_separator(ft_id);
995 const gchar *str, *ptr;
997 if (!scope)
998 return NULL;
1000 str = scope;
1002 while (1)
1004 ptr = strstr(str, separator);
1005 if (ptr)
1007 str = ptr + strlen(separator);
1009 else
1010 break;
1013 return NZV(str) ? str : NULL;
1017 static GtkTreeIter *get_tag_type_iter(TMTagType tag_type, filetype_id ft_id)
1019 GtkTreeIter *iter = NULL;
1021 switch (tag_type)
1023 case tm_tag_prototype_t:
1024 case tm_tag_method_t:
1025 case tm_tag_function_t:
1027 iter = &tv_iters.tag_function;
1028 break;
1030 case tm_tag_macro_t:
1031 case tm_tag_macro_with_arg_t:
1033 iter = &tv_iters.tag_macro;
1034 break;
1036 case tm_tag_class_t:
1038 iter = &tv_iters.tag_class;
1039 break;
1041 case tm_tag_member_t:
1042 case tm_tag_field_t:
1044 iter = &tv_iters.tag_member;
1045 break;
1047 case tm_tag_typedef_t:
1048 case tm_tag_enum_t:
1050 iter = &tv_iters.tag_type;
1051 break;
1053 case tm_tag_union_t:
1054 case tm_tag_struct_t:
1055 case tm_tag_interface_t:
1057 iter = &tv_iters.tag_struct;
1058 break;
1060 case tm_tag_variable_t:
1062 iter = &tv_iters.tag_variable;
1063 break;
1065 case tm_tag_namespace_t:
1066 case tm_tag_package_t:
1068 iter = &tv_iters.tag_namespace;
1069 break;
1071 default:
1073 iter = &tv_iters.tag_other;
1076 if (G_LIKELY(iter->stamp != -1))
1077 return iter;
1078 else
1079 return NULL;
1083 static GdkPixbuf *get_child_icon(GtkTreeStore *tree_store, GtkTreeIter *parent)
1085 GdkPixbuf *icon = NULL;
1087 if (parent == &tv_iters.tag_other)
1089 return get_tag_icon("classviewer-var");
1091 /* copy parent icon */
1092 gtk_tree_model_get(GTK_TREE_MODEL(tree_store), parent,
1093 SYMBOLS_COLUMN_ICON, &icon, -1);
1094 return icon;
1098 static void add_tree_tag(GeanyDocument *doc, const TMTag *tag, GHashTable *parent_hash)
1100 filetype_id ft_id = FILETYPE_ID(doc->file_type);
1101 GtkTreeStore *tree_store = doc->priv->tag_store;
1102 GtkTreeIter *parent = NULL;
1104 parent = get_tag_type_iter(tag->type, ft_id);
1106 if (G_LIKELY(parent))
1108 const gchar *name;
1109 const gchar *parent_name = get_parent_name(tag, ft_id);
1110 GtkTreeIter iter;
1111 GtkTreeIter *child = NULL;
1112 GdkPixbuf *icon = NULL;
1114 child = &iter;
1115 icon = get_child_icon(tree_store, parent);
1117 if (parent_name)
1119 GtkTreeIter *parent_search =
1120 (GtkTreeIter *)g_hash_table_lookup(parent_hash, parent_name);
1122 if (parent_search)
1123 parent = parent_search;
1124 else
1125 parent_name = NULL;
1128 /* check if the current tag is a parent of other tags */
1129 if (g_hash_table_lookup_extended(parent_hash, tag->name, NULL, NULL) &&
1130 !utils_str_equal(tag->name, parent_name)) /* prevent Foo::Foo from making parent = child */
1132 GtkTreeIter *new_iter = g_new0(GtkTreeIter, 1);
1134 /* set an iter value for the hash key */
1135 g_hash_table_insert(parent_hash, tag->name, new_iter);
1136 /* instead of ignoring the appended child iter below, use the one in the hash table */
1137 child = new_iter;
1140 gtk_tree_store_append(tree_store, child, parent);
1142 name = get_symbol_name(doc, tag, (parent_name != NULL));
1143 gtk_tree_store_set(tree_store, child,
1144 SYMBOLS_COLUMN_ICON, icon,
1145 SYMBOLS_COLUMN_NAME, name,
1146 SYMBOLS_COLUMN_TAG, tag,
1147 -1);
1149 if (gtk_check_version(2, 12, 0) == NULL)
1151 gchar *tooltip = get_symbol_tooltip(doc, tag);
1152 gtk_tree_store_set(tree_store, child, SYMBOLS_COLUMN_TOOLTIP, tooltip, -1);
1153 g_free(tooltip);
1156 if (G_LIKELY(G_IS_OBJECT(icon)))
1157 g_object_unref(icon);
1159 else
1160 geany_debug("Missing symbol-tree parent iter for type %d!", tag->type);
1164 static void add_tree_tags(GeanyDocument *doc, const GList *tags)
1166 const GList *item;
1167 GHashTable *parent_hash;
1169 /* Create a hash table "parent_tag_name":(GtkTreeIter*) */
1170 parent_hash = g_hash_table_new_full(g_str_hash, g_str_equal, NULL, g_free);
1172 /* find and store all parent names in the hash table */
1173 for (item = tags; item; item = g_list_next(item))
1175 const TMTag *tag = item->data;
1176 const gchar *name = get_parent_name(tag, FILETYPE_ID(doc->file_type));
1178 if (name)
1179 g_hash_table_insert(parent_hash, (gpointer)name, NULL);
1181 for (item = tags; item; item = g_list_next(item))
1183 const TMTag *tag = item->data;
1185 add_tree_tag(doc, tag, parent_hash);
1187 g_hash_table_destroy(parent_hash);
1191 /* we don't want to sort 1st-level nodes, but we can't return 0 because the tree sort
1192 * is not stable, so the order is already lost. */
1193 static gint compare_top_level_names(const gchar *a, const gchar *b)
1195 guint i;
1196 const gchar *name;
1198 foreach_ptr_array(name, i, top_level_iter_names)
1200 if (utils_str_equal(name, a))
1201 return -1;
1202 if (utils_str_equal(name, b))
1203 return 1;
1204 /* This should never happen as it would mean that two or more top
1205 * level items have the same name but it can happen by typos in the translations. */
1206 if (utils_str_equal(a, b))
1207 return 1;
1209 g_warning("Couldn't find top level node '%s' or '%s'!", a, b);
1210 return 0;
1214 static gboolean tag_has_missing_parent(const TMTag *tag, GtkTreeStore *store,
1215 GtkTreeIter *iter)
1217 /* if the tag has a parent tag, it should be at depth >= 2 */
1218 return NZV(tag->atts.entry.scope) &&
1219 gtk_tree_store_iter_depth(store, iter) == 1;
1223 static gint tree_sort_func(GtkTreeModel *model, GtkTreeIter *a, GtkTreeIter *b,
1224 gpointer user_data)
1226 gboolean sort_by_name = GPOINTER_TO_INT(user_data);
1227 const TMTag *tag_a, *tag_b;
1229 gtk_tree_model_get(model, a, SYMBOLS_COLUMN_TAG, &tag_a, -1);
1230 gtk_tree_model_get(model, b, SYMBOLS_COLUMN_TAG, &tag_b, -1);
1232 /* Check if the iters can be sorted based on tag name and line, not tree item name.
1233 * Sort by tree name if the scope was prepended, e.g. 'ScopeNameWithNoTag::TagName'. */
1234 if (tag_a && !tag_has_missing_parent(tag_a, GTK_TREE_STORE(model), a) &&
1235 tag_b && !tag_has_missing_parent(tag_b, GTK_TREE_STORE(model), b))
1237 return sort_by_name ? compare_symbol(tag_a, tag_b) :
1238 compare_symbol_lines(tag_a, tag_b);
1240 else
1242 gchar *astr, *bstr;
1243 gint cmp;
1245 gtk_tree_model_get(model, a, SYMBOLS_COLUMN_NAME, &astr, -1);
1246 gtk_tree_model_get(model, b, SYMBOLS_COLUMN_NAME, &bstr, -1);
1248 /* if a is toplevel, b must be also */
1249 if (gtk_tree_store_iter_depth(GTK_TREE_STORE(model), a) == 0)
1251 cmp = compare_top_level_names(astr, bstr);
1253 else
1255 cmp = strcmp(astr, bstr);
1257 /* sort duplicate 'ScopeName::OverloadedTagName' items by line as well */
1258 if (tag_a && tag_b)
1259 if (!sort_by_name ||
1260 (utils_str_equal(tag_a->name, tag_b->name) &&
1261 utils_str_equal(tag_a->atts.entry.scope, tag_b->atts.entry.scope)))
1262 cmp = compare_symbol_lines(tag_a, tag_b);
1264 g_free(astr);
1265 g_free(bstr);
1266 return cmp;
1271 static void sort_tree(GtkTreeStore *store, gboolean sort_by_name)
1273 gtk_tree_sortable_set_sort_func(GTK_TREE_SORTABLE(store), SYMBOLS_COLUMN_NAME, tree_sort_func,
1274 GINT_TO_POINTER(sort_by_name), NULL);
1276 gtk_tree_sortable_set_sort_column_id(GTK_TREE_SORTABLE(store), SYMBOLS_COLUMN_NAME, GTK_SORT_ASCENDING);
1280 gboolean symbols_recreate_tag_list(GeanyDocument *doc, gint sort_mode)
1282 GList *tags;
1284 g_return_val_if_fail(doc != NULL, FALSE);
1286 tags = get_tag_list(doc, tm_tag_max_t);
1287 if (tags == NULL)
1288 return FALSE;
1290 /* Make sure the model stays with us after the tree view unrefs it */
1291 g_object_ref(GTK_TREE_MODEL(doc->priv->tag_store));
1292 /* Detach model from view */
1293 gtk_tree_view_set_model(GTK_TREE_VIEW(doc->priv->tag_tree), NULL);
1294 /* Clear all contents */
1295 gtk_tree_store_clear(doc->priv->tag_store);
1297 /* add grandparent type iters */
1298 add_top_level_items(doc);
1300 add_tree_tags(doc, tags);
1301 g_list_free(tags);
1303 hide_empty_rows(doc->priv->tag_store);
1305 if (sort_mode == SYMBOLS_SORT_USE_PREVIOUS)
1306 sort_mode = doc->priv->symbol_list_sort_mode;
1308 sort_tree(doc->priv->tag_store, sort_mode == SYMBOLS_SORT_BY_NAME);
1309 doc->priv->symbol_list_sort_mode = sort_mode;
1311 /* Re-attach model to view */
1312 gtk_tree_view_set_model(GTK_TREE_VIEW(doc->priv->tag_tree),
1313 GTK_TREE_MODEL(doc->priv->tag_store));
1314 g_object_unref(GTK_TREE_MODEL(doc->priv->tag_store));
1315 gtk_tree_view_expand_all(GTK_TREE_VIEW(doc->priv->tag_tree));
1317 return TRUE;
1321 /* Detects a global tags filetype from the *.lang.* language extension.
1322 * Returns NULL if there was no matching TM language. */
1323 static GeanyFiletype *detect_global_tags_filetype(const gchar *utf8_filename)
1325 gchar *tags_ext;
1326 gchar *shortname = g_strdup(utf8_filename);
1327 GeanyFiletype *ft = NULL;
1329 tags_ext = strstr(shortname, ".tags");
1330 if (tags_ext)
1332 *tags_ext = '\0'; /* remove .tags extension */
1333 ft = filetypes_detect_from_extension(shortname);
1335 g_free(shortname);
1336 return ft;
1340 /* Adapted from anjuta-2.0.2/global-tags/tm_global_tags.c, thanks.
1341 * Needs full paths for filenames, except for C/C++ tag files, when CFLAGS includes
1342 * the relevant path.
1343 * Example:
1344 * CFLAGS=-I/home/user/libname-1.x geany -g libname.d.tags libname.h */
1345 int symbols_generate_global_tags(int argc, char **argv, gboolean want_preprocess)
1347 /* -E pre-process, -dD output user macros, -p prof info (?),
1348 * -undef remove builtin macros (seems to be needed with FC5 gcc 4.1.1) */
1349 const char pre_process[] = "gcc -E -dD -p -undef";
1351 if (argc > 2)
1353 /* Create global taglist */
1354 int status;
1355 char *command;
1356 const char *tags_file = argv[1];
1357 char *utf8_fname;
1358 GeanyFiletype *ft;
1360 utf8_fname = utils_get_utf8_from_locale(tags_file);
1361 ft = detect_global_tags_filetype(utf8_fname);
1362 g_free(utf8_fname);
1364 if (ft == NULL)
1366 g_printerr(_("Unknown filetype extension for \"%s\".\n"), tags_file);
1367 return 1;
1369 /* load config in case of custom filetypes */
1370 filetypes_load_config(ft->id, FALSE);
1372 /* load ignore list for C/C++ parser */
1373 if (ft->id == GEANY_FILETYPES_C || ft->id == GEANY_FILETYPES_CPP)
1374 load_c_ignore_tags();
1376 if (want_preprocess && (ft->id == GEANY_FILETYPES_C || ft->id == GEANY_FILETYPES_CPP))
1377 command = g_strdup_printf("%s %s", pre_process, NVL(getenv("CFLAGS"), ""));
1378 else
1379 command = NULL; /* don't preprocess */
1381 geany_debug("Generating %s tags file.", ft->name);
1382 tm_get_workspace();
1383 status = tm_workspace_create_global_tags(app->configdir, command,
1384 (const char **) (argv + 2),
1385 argc - 2, tags_file, ft->lang);
1386 g_free(command);
1387 symbols_finalize(); /* free c_tags_ignore data */
1388 if (! status)
1390 g_printerr(_("Failed to create tags file, perhaps because no tags "
1391 "were found.\n"));
1392 return 1;
1395 else
1397 g_printerr(_("Usage: %s -g <Tag File> <File list>\n\n"), argv[0]);
1398 g_printerr(_("Example:\n"
1399 "CFLAGS=`pkg-config gtk+-2.0 --cflags` %s -g gtk2.c.tags"
1400 " /usr/include/gtk-2.0/gtk/gtk.h\n"), argv[0]);
1401 return 1;
1403 return 0;
1407 void symbols_show_load_tags_dialog(void)
1409 GtkWidget *dialog;
1410 GtkFileFilter *filter;
1412 dialog = gtk_file_chooser_dialog_new(_("Load Tags"), GTK_WINDOW(main_widgets.window),
1413 GTK_FILE_CHOOSER_ACTION_OPEN,
1414 GTK_STOCK_CANCEL, GTK_RESPONSE_CANCEL,
1415 GTK_STOCK_OPEN, GTK_RESPONSE_OK,
1416 NULL);
1417 gtk_widget_set_name(dialog, "GeanyDialog");
1418 filter = gtk_file_filter_new();
1419 gtk_file_filter_set_name(filter, _("Geany tag files (*.tags)"));
1420 gtk_file_filter_add_pattern(filter, "*.tags");
1421 gtk_file_chooser_add_filter(GTK_FILE_CHOOSER(dialog), filter);
1423 if (gtk_dialog_run(GTK_DIALOG(dialog)) == GTK_RESPONSE_OK)
1425 GSList *flist = gtk_file_chooser_get_filenames(GTK_FILE_CHOOSER(dialog));
1426 GSList *item;
1428 for (item = flist; item != NULL; item = g_slist_next(item))
1430 gchar *fname = item->data;
1431 gchar *utf8_fname;
1432 GeanyFiletype *ft;
1434 utf8_fname = utils_get_utf8_from_locale(fname);
1435 ft = detect_global_tags_filetype(utf8_fname);
1437 if (ft != NULL && symbols_load_global_tags(fname, ft))
1438 /* For translators: the first wildcard is the filetype, the second the filename */
1439 ui_set_statusbar(TRUE, _("Loaded %s tags file '%s'."), ft->name, utf8_fname);
1440 else
1441 ui_set_statusbar(TRUE, _("Could not load tags file '%s'."), utf8_fname);
1443 g_free(utf8_fname);
1444 g_free(fname);
1446 g_slist_free(flist);
1448 gtk_widget_destroy(dialog);
1452 /* Fills a hash table with filetype keys that hold a linked list of filenames. */
1453 static GHashTable *get_tagfile_hash(const GSList *file_list)
1455 const GSList *node;
1456 GHashTable *hash = g_hash_table_new(NULL, NULL);
1458 for (node = file_list; node != NULL; node = g_slist_next(node))
1460 GList *fnames;
1461 gchar *fname = node->data;
1462 gchar *utf8_fname = utils_get_utf8_from_locale(fname);
1463 GeanyFiletype *ft = detect_global_tags_filetype(utf8_fname);
1465 g_free(utf8_fname);
1467 if (FILETYPE_ID(ft) != GEANY_FILETYPES_NONE)
1469 fnames = g_hash_table_lookup(hash, ft); /* may be NULL */
1470 fnames = g_list_append(fnames, fname);
1471 g_hash_table_insert(hash, ft, fnames);
1473 else
1474 geany_debug("Unknown filetype for file '%s'.", fname);
1476 return hash;
1480 static GHashTable *init_user_tags(void)
1482 GSList *file_list = NULL, *list = NULL;
1483 GHashTable *lang_hash;
1484 const gchar *dir;
1486 dir = utils_build_path(app->configdir, "tags", NULL);
1487 /* create the user tags dir for next time if it doesn't exist */
1488 if (! g_file_test(dir, G_FILE_TEST_IS_DIR))
1490 utils_mkdir(dir, FALSE);
1492 file_list = utils_get_file_list_full(dir, TRUE, TRUE, NULL);
1494 dir = utils_build_path(app->datadir, "tags", NULL);
1495 list = utils_get_file_list_full(dir, TRUE, TRUE, NULL);
1496 file_list = g_slist_concat(file_list, list);
1498 lang_hash = get_tagfile_hash(file_list);
1499 /* don't need to delete list contents because they are now used for hash contents */
1500 g_slist_free(file_list);
1502 return lang_hash;
1506 static void load_user_tags(filetype_id ft_id)
1508 static guchar *tags_loaded = NULL;
1509 static GHashTable *lang_hash = NULL;
1510 GList *fnames;
1511 const GList *node;
1512 GeanyFiletype *ft = filetypes[ft_id];
1514 g_return_if_fail(ft_id > 0);
1516 if (!tags_loaded)
1517 tags_loaded = g_new0(guchar, filetypes_array->len);
1518 if (tags_loaded[ft_id])
1519 return;
1520 tags_loaded[ft_id] = TRUE; /* prevent reloading */
1522 if (lang_hash == NULL)
1523 lang_hash = init_user_tags();
1525 fnames = g_hash_table_lookup(lang_hash, ft);
1527 for (node = fnames; node != NULL; node = g_list_next(node))
1529 const gchar *fname = node->data;
1531 symbols_load_global_tags(fname, ft);
1533 g_list_foreach(fnames, (GFunc) g_free, NULL);
1534 g_list_free(fnames);
1535 g_hash_table_remove(lang_hash, (gpointer) ft);
1539 gboolean symbols_goto_tag(const gchar *name, gboolean definition)
1541 const gint forward_types = tm_tag_prototype_t | tm_tag_externvar_t;
1542 gint type;
1543 TMTag *tmtag = NULL;
1544 GeanyDocument *old_doc = document_get_current();
1546 /* goto tag definition: all except prototypes / forward declarations / externs */
1547 type = (definition) ? tm_tag_max_t - forward_types : forward_types;
1549 /* first look in the current document */
1550 if (old_doc != NULL && old_doc->tm_file)
1551 tmtag = find_work_object_tag(old_doc->tm_file, name, type);
1553 /* if not found, look in the workspace */
1554 if (tmtag == NULL)
1555 tmtag = find_workspace_tag(name, type);
1557 if (tmtag != NULL)
1559 GeanyDocument *new_doc = document_find_by_real_path(
1560 tmtag->atts.entry.file->work_object.file_name);
1562 /* not found in opened document, should open */
1563 if (new_doc == NULL)
1565 new_doc = document_open_file(tmtag->atts.entry.file->work_object.file_name, FALSE, NULL, NULL);
1568 if (navqueue_goto_line(old_doc, new_doc, tmtag->atts.entry.line))
1569 return TRUE;
1571 /* if we are here, there was no match and we are beeping ;-) */
1572 utils_beep();
1573 if (type == forward_types)
1574 ui_set_statusbar(FALSE, _("Forward declaration \"%s\" not found."), name);
1575 else
1576 ui_set_statusbar(FALSE, _("Definition of \"%s\" not found."), name);
1577 return FALSE;
1581 /* This could perhaps be improved to check for #if, class etc. */
1582 static gint get_function_fold_number(GeanyDocument *doc)
1584 /* for Java the functions are always one fold level above the class scope */
1585 if (FILETYPE_ID(doc->file_type) == GEANY_FILETYPES_JAVA)
1586 return SC_FOLDLEVELBASE + 1;
1587 else
1588 return SC_FOLDLEVELBASE;
1592 /* Should be used only with symbols_get_current_function. */
1593 static gboolean current_function_changed(GeanyDocument *doc, gint cur_line, gint fold_level)
1595 static gint old_line = -2;
1596 static GeanyDocument *old_doc = NULL;
1597 static gint old_fold_num = -1;
1598 const gint fold_num = fold_level & SC_FOLDLEVELNUMBERMASK;
1599 gboolean ret;
1601 /* check if the cached line and file index have changed since last time: */
1602 if (doc == NULL || doc != old_doc)
1603 ret = TRUE;
1604 else
1605 if (cur_line == old_line)
1606 ret = FALSE;
1607 else
1609 /* if the line has only changed by 1 */
1610 if (abs(cur_line - old_line) == 1)
1612 const gint fn_fold =
1613 get_function_fold_number(doc);
1614 /* It's the same function if the fold number hasn't changed, or both the new
1615 * and old fold numbers are above the function fold number. */
1616 gboolean same =
1617 fold_num == old_fold_num ||
1618 (old_fold_num > fn_fold && fold_num > fn_fold);
1620 ret = ! same;
1622 else ret = TRUE;
1625 /* record current line and file index for next time */
1626 old_line = cur_line;
1627 old_doc = doc;
1628 old_fold_num = fold_num;
1629 return ret;
1633 /* Parse the function name up to 2 lines before tag_line.
1634 * C++ like syntax should be parsed by parse_cpp_function_at_line, otherwise the return
1635 * type or argument names can be confused with the function name. */
1636 static gchar *parse_function_at_line(ScintillaObject *sci, gint tag_line)
1638 gint start, end, max_pos;
1639 gchar *cur_tag;
1640 gint fn_style;
1642 switch (sci_get_lexer(sci))
1644 case SCLEX_RUBY: fn_style = SCE_RB_DEFNAME; break;
1645 case SCLEX_PYTHON: fn_style = SCE_P_DEFNAME; break;
1646 default: fn_style = SCE_C_IDENTIFIER; /* several lexers use SCE_C_IDENTIFIER */
1648 start = sci_get_position_from_line(sci, tag_line - 2);
1649 max_pos = sci_get_position_from_line(sci, tag_line + 1);
1650 while (sci_get_style_at(sci, start) != fn_style
1651 && start < max_pos) start++;
1653 end = start;
1654 while (sci_get_style_at(sci, end) == fn_style
1655 && end < max_pos) end++;
1657 if (start == end)
1658 return NULL;
1659 cur_tag = g_malloc(end - start + 1);
1660 sci_get_text_range(sci, start, end, cur_tag);
1661 return cur_tag;
1665 /* Parse the function name */
1666 static gchar *parse_cpp_function_at_line(ScintillaObject *sci, gint tag_line)
1668 gint start, end, first_pos, max_pos;
1669 gint tmp;
1670 gchar c;
1671 gchar *cur_tag;
1673 first_pos = end = sci_get_position_from_line(sci, tag_line);
1674 max_pos = sci_get_position_from_line(sci, tag_line + 1);
1675 tmp = 0;
1676 /* goto the begin of function body */
1677 while (end < max_pos &&
1678 (tmp = sci_get_char_at(sci, end)) != '{' &&
1679 tmp != 0) end++;
1680 if (tmp == 0) end --;
1682 /* go back to the end of function identifier */
1683 while (end > 0 && end > first_pos - 500 &&
1684 (tmp = sci_get_char_at(sci, end)) != '(' &&
1685 tmp != 0) end--;
1686 end--;
1687 if (end < 0) end = 0;
1689 /* skip whitespaces between identifier and ( */
1690 while (end > 0 && isspace(sci_get_char_at(sci, end))) end--;
1692 start = end;
1693 c = 0;
1694 /* Use tmp to find SCE_C_IDENTIFIER or SCE_C_GLOBALCLASS chars */
1695 while (start >= 0 && ((tmp = sci_get_style_at(sci, start)) == SCE_C_IDENTIFIER
1696 || tmp == SCE_C_GLOBALCLASS
1697 || (c = sci_get_char_at(sci, start)) == '~'
1698 || c == ':'))
1699 start--;
1700 if (start != 0 && start < end) start++; /* correct for last non-matching char */
1702 if (start == end) return NULL;
1703 cur_tag = g_malloc(end - start + 2);
1704 sci_get_text_range(sci, start, end + 1, cur_tag);
1705 return cur_tag;
1709 /* Sets *tagname to point at the current function or tag name.
1710 * If doc is NULL, reset the cached current tag data to ensure it will be reparsed on the next
1711 * call to this function.
1712 * Returns: line number of the current tag, or -1 if unknown. */
1713 gint symbols_get_current_function(GeanyDocument *doc, const gchar **tagname)
1715 static gint tag_line = -1;
1716 static gchar *cur_tag = NULL;
1717 gint line;
1718 gint fold_level;
1719 TMWorkObject *tm_file;
1721 if (doc == NULL) /* reset current function */
1723 current_function_changed(NULL, -1, -1);
1724 g_free(cur_tag);
1725 cur_tag = g_strdup(_("unknown"));
1726 if (tagname != NULL)
1727 *tagname = cur_tag;
1728 tag_line = -1;
1729 return tag_line;
1732 line = sci_get_current_line(doc->editor->sci);
1733 fold_level = sci_get_fold_level(doc->editor->sci, line);
1734 /* check if the cached line and file index have changed since last time: */
1735 if (! current_function_changed(doc, line, fold_level))
1737 /* we can assume same current function as before */
1738 *tagname = cur_tag;
1739 return tag_line;
1741 g_free(cur_tag); /* free the old tag, it will be replaced. */
1743 /* if line is at base fold level, we're not in a function */
1744 if ((fold_level & SC_FOLDLEVELNUMBERMASK) == SC_FOLDLEVELBASE)
1746 cur_tag = g_strdup(_("unknown"));
1747 *tagname = cur_tag;
1748 tag_line = -1;
1749 return tag_line;
1751 tm_file = doc->tm_file;
1753 /* if the document has no changes, get the previous function name from TM */
1754 if (! doc->changed && tm_file != NULL && tm_file->tags_array != NULL)
1756 const TMTag *tag = (const TMTag*) tm_get_current_function(tm_file->tags_array, line);
1758 if (tag != NULL)
1760 gchar *tmp;
1761 tmp = tag->atts.entry.scope;
1762 cur_tag = tmp ? g_strconcat(tmp, "::", tag->name, NULL) : g_strdup(tag->name);
1763 *tagname = cur_tag;
1764 tag_line = tag->atts.entry.line;
1765 return tag_line;
1769 /* parse the current function name here because TM line numbers may have changed,
1770 * and it would take too long to reparse the whole file. */
1771 if (doc->file_type != NULL && doc->file_type->id != GEANY_FILETYPES_NONE)
1773 const gint fn_fold = get_function_fold_number(doc);
1775 tag_line = line;
1776 do /* find the top level fold point */
1778 tag_line = sci_get_fold_parent(doc->editor->sci, tag_line);
1779 fold_level = sci_get_fold_level(doc->editor->sci, tag_line);
1780 } while (tag_line >= 0 &&
1781 (fold_level & SC_FOLDLEVELNUMBERMASK) != fn_fold);
1783 if (tag_line >= 0)
1785 if (sci_get_lexer(doc->editor->sci) == SCLEX_CPP)
1786 cur_tag = parse_cpp_function_at_line(doc->editor->sci, tag_line);
1787 else
1788 cur_tag = parse_function_at_line(doc->editor->sci, tag_line);
1790 if (cur_tag != NULL)
1792 *tagname = cur_tag;
1793 return tag_line;
1798 cur_tag = g_strdup(_("unknown"));
1799 *tagname = cur_tag;
1800 tag_line = -1;
1801 return tag_line;
1805 static void on_symbol_tree_sort_clicked(GtkMenuItem *menuitem, gpointer user_data)
1807 gint sort_mode = GPOINTER_TO_INT(user_data);
1808 GeanyDocument *doc = document_get_current();
1810 if (ignore_callback)
1811 return;
1813 if (doc != NULL)
1814 doc->has_tags = symbols_recreate_tag_list(doc, sort_mode);
1818 static void on_symbol_tree_menu_show(GtkWidget *widget,
1819 gpointer user_data)
1821 GeanyDocument *doc = document_get_current();
1822 gboolean enable;
1824 enable = doc && doc->has_tags;
1825 gtk_widget_set_sensitive(symbol_menu.sort_by_name, enable);
1826 gtk_widget_set_sensitive(symbol_menu.sort_by_appearance, enable);
1827 gtk_widget_set_sensitive(symbol_menu.expand_all, enable);
1828 gtk_widget_set_sensitive(symbol_menu.collapse_all, enable);
1830 if (! doc)
1831 return;
1833 ignore_callback = TRUE;
1835 if (doc->priv->symbol_list_sort_mode == SYMBOLS_SORT_BY_NAME)
1836 gtk_check_menu_item_set_active(GTK_CHECK_MENU_ITEM(symbol_menu.sort_by_name), TRUE);
1837 else
1838 gtk_check_menu_item_set_active(GTK_CHECK_MENU_ITEM(symbol_menu.sort_by_appearance), TRUE);
1840 ignore_callback = FALSE;
1844 static void on_expand_collapse(GtkWidget *widget, gpointer user_data)
1846 gboolean expand = utils_str_equal(user_data, GTK_STOCK_ADD);
1847 GeanyDocument *doc = document_get_current();
1849 if (! doc)
1850 return;
1852 g_return_if_fail(doc->priv->tag_tree);
1854 if (expand)
1855 gtk_tree_view_expand_all(GTK_TREE_VIEW(doc->priv->tag_tree));
1856 else
1857 gtk_tree_view_collapse_all(GTK_TREE_VIEW(doc->priv->tag_tree));
1861 static void create_taglist_popup_menu(void)
1863 GtkWidget *item, *menu;
1865 tv.popup_taglist = menu = gtk_menu_new();
1867 symbol_menu.expand_all = item = ui_image_menu_item_new(GTK_STOCK_ADD, _("_Expand All"));
1868 gtk_widget_show(item);
1869 gtk_container_add(GTK_CONTAINER(menu), item);
1870 g_signal_connect(item, "activate", G_CALLBACK(on_expand_collapse), GTK_STOCK_ADD);
1872 symbol_menu.collapse_all = item = ui_image_menu_item_new(GTK_STOCK_REMOVE, _("_Collapse All"));
1873 gtk_widget_show(item);
1874 gtk_container_add(GTK_CONTAINER(menu), item);
1875 g_signal_connect(item, "activate", G_CALLBACK(on_expand_collapse), GTK_STOCK_REMOVE);
1877 item = gtk_separator_menu_item_new();
1878 gtk_widget_show(item);
1879 gtk_container_add(GTK_CONTAINER(menu), item);
1881 symbol_menu.sort_by_name = item = gtk_radio_menu_item_new_with_mnemonic(NULL,
1882 _("Sort by _Name"));
1883 gtk_widget_show(item);
1884 gtk_container_add(GTK_CONTAINER(menu), item);
1885 g_signal_connect(item, "activate", G_CALLBACK(on_symbol_tree_sort_clicked),
1886 GINT_TO_POINTER(SYMBOLS_SORT_BY_NAME));
1888 symbol_menu.sort_by_appearance = item = gtk_radio_menu_item_new_with_mnemonic_from_widget(
1889 GTK_RADIO_MENU_ITEM(item), _("Sort by _Appearance"));
1890 gtk_widget_show(item);
1891 gtk_container_add(GTK_CONTAINER(menu), item);
1892 g_signal_connect(item, "activate", G_CALLBACK(on_symbol_tree_sort_clicked),
1893 GINT_TO_POINTER(SYMBOLS_SORT_BY_APPEARANCE));
1895 g_signal_connect(menu, "show", G_CALLBACK(on_symbol_tree_menu_show), NULL);
1897 sidebar_add_common_menu_items(GTK_MENU(menu));
1901 static void on_document_save(G_GNUC_UNUSED GObject *object, GeanyDocument *doc)
1903 g_return_if_fail(NZV(doc->real_path));
1905 if (utils_str_equal(doc->real_path,
1906 utils_build_path(app->configdir, "ignore.tags", NULL)))
1907 load_c_ignore_tags();
1911 void symbols_init(void)
1913 create_taglist_popup_menu();
1915 ui_add_config_file_menu_item(utils_build_path(app->configdir, "ignore.tags", NULL),
1916 NULL, NULL);
1917 g_signal_connect(geany_object, "document-save", G_CALLBACK(on_document_save), NULL);
1921 void symbols_finalize(void)
1923 g_strfreev(html_entities);
1924 g_strfreev(c_tags_ignore);