?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
c++: Fix handling of the `final` contextual keyword
[geany-mirror.git] / src / symbols.c
blob7d757c349730687a26c99be15e2751a177956ddf
1 /*
2 * symbols.c - this file is part of Geany, a fast and lightweight IDE
3 *
4 * Copyright 2006-2012 Enrico Tröger <enrico(dot)troeger(at)uvena(dot)de>
5 * Copyright 2006-2012 Nick Treleaven <nick(dot)treleaven(at)btinternet(dot)com>
6 * Copyright 2011-2012 Colomban Wendling <ban(at)herbesfolles(dot)org>
7 *
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
12 *
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
17 *
18 * You should have received a copy of the GNU General Public License along
19 * with this program; if not, write to the Free Software Foundation, Inc.,
20 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
21 */
22
23 /**
24 * @file symbols.h
25 * Tag-related functions.
26 **/
27
28 /*
29 * Symbol Tree and TagManager-related convenience functions.
30 * TagManager parses tags for each document, and also adds them to the workspace (session).
31 * Global tags are lists of tags for each filetype, loaded when a document with a
32 * matching filetype is first loaded.
33 */
34
35 #ifdef HAVE_CONFIG_H
36 # include "config.h"
37 #endif
38
39 #include "symbols.h"
40
41 #include "app.h"
42 #include "callbacks.h" /* FIXME: for ignore_callback */
43 #include "documentprivate.h"
44 #include "editor.h"
45 #include "encodings.h"
46 #include "filetypesprivate.h"
47 #include "geanyobject.h"
48 #include "main.h"
49 #include "navqueue.h"
50 #include "sciwrappers.h"
51 #include "sidebar.h"
52 #include "support.h"
53 #include "tm_parser.h"
54 #include "tm_tag.h"
55 #include "ui_utils.h"
56 #include "utils.h"
57
58 #include "SciLexer.h"
59
60 #include "gtkcompat.h"
61
62 #include <ctype.h>
63 #include <string.h>
64 #include <stdlib.h>
65
66
67 static gchar **html_entities = NULL;
68
69 typedef struct
70 {
71 gboolean tags_loaded;
72 const gchar *tag_file;
73 } TagFileInfo;
74
75 /* Check before adding any more tags files, usually they should be downloaded separately. */
76 enum /* Geany tag files */
77 {
78 GTF_C,
79 GTF_PASCAL,
80 GTF_PHP,
81 GTF_HTML_ENTITIES,
82 GTF_LATEX,
83 GTF_PYTHON,
84 GTF_MAX
85 };
86
87 static TagFileInfo tag_file_info[GTF_MAX] =
88 {
89 {FALSE, "c99.tags"},
90 {FALSE, "pascal.tags"},
91 {FALSE, "php.tags"},
92 {FALSE, "html_entities.tags"},
93 {FALSE, "latex.tags"},
94 {FALSE, "python.tags"}
95 };
96
97 static GPtrArray *top_level_iter_names = NULL;
98
99 enum
100 {
101 ICON_CLASS,
102 ICON_MACRO,
103 ICON_MEMBER,
104 ICON_METHOD,
105 ICON_NAMESPACE,
106 ICON_OTHER,
107 ICON_STRUCT,
108 ICON_VAR,
109 ICON_NONE,
110 N_ICONS = ICON_NONE
111 };
112
113 static struct
114 {
115 const gchar *icon_name;
116 GdkPixbuf *pixbuf;
117 }
118 symbols_icons[N_ICONS] = {
119 [ICON_CLASS] = { "classviewer-class", NULL },
120 [ICON_MACRO] = { "classviewer-macro", NULL },
121 [ICON_MEMBER] = { "classviewer-member", NULL },
122 [ICON_METHOD] = { "classviewer-method", NULL },
123 [ICON_NAMESPACE] = { "classviewer-namespace", NULL },
124 [ICON_OTHER] = { "classviewer-other", NULL },
125 [ICON_STRUCT] = { "classviewer-struct", NULL },
126 [ICON_VAR] = { "classviewer-var", NULL },
127 };
128
129 static struct
130 {
131 GtkWidget *expand_all;
132 GtkWidget *collapse_all;
133 GtkWidget *sort_by_name;
134 GtkWidget *sort_by_appearance;
135 GtkWidget *find_usage;
136 GtkWidget *find_doc_usage;
137 GtkWidget *find_in_files;
138 }
139 symbol_menu;
140
141 static void html_tags_loaded(void);
142 static void load_user_tags(filetype_id ft_id);
143
144 /* get the tags_ignore list, exported by tagmanager's options.c */
145 extern gchar **c_tags_ignore;
146
147 /* ignore certain tokens when parsing C-like syntax.
148 * Also works for reloading. */
149 static void load_c_ignore_tags(void)
150 {
151 gchar *path = g_build_filename(app->configdir, "ignore.tags", NULL);
152 gchar *content;
153
154 if (g_file_get_contents(path, &content, NULL, NULL))
155 {
156 /* historically we ignore the glib _DECLS for tag generation */
157 SETPTR(content, g_strconcat("G_BEGIN_DECLS G_END_DECLS\n", content, NULL));
158
159 g_strfreev(c_tags_ignore);
160 c_tags_ignore = g_strsplit_set(content, " \n\r", -1);
161 g_free(content);
162 }
163 g_free(path);
164 }
165
166
167 void symbols_reload_config_files(void)
168 {
169 load_c_ignore_tags();
170 }
171
172
173 static gsize get_tag_count(void)
174 {
175 GPtrArray *tags = tm_get_workspace()->global_tags;
176 gsize count = tags ? tags->len : 0;
177
178 return count;
179 }
180
181
182 /* wrapper for tm_workspace_load_global_tags().
183 * note that the tag count only counts new global tags added - if a tag has the same name,
184 * currently it replaces the existing tag, so loading a file twice will say 0 tags the 2nd time. */
185 static gboolean symbols_load_global_tags(const gchar *tags_file, GeanyFiletype *ft)
186 {
187 gboolean result;
188 gsize old_tag_count = get_tag_count();
189
190 result = tm_workspace_load_global_tags(tags_file, ft->lang);
191 if (result)
192 {
193 geany_debug("Loaded %s (%s), %u tag(s).", tags_file, ft->name,
194 (guint) (get_tag_count() - old_tag_count));
195 }
196 return result;
197 }
198
199
200 /* Ensure that the global tags file(s) for the file_type_idx filetype is loaded.
201 * This provides autocompletion, calltips, etc. */
202 void symbols_global_tags_loaded(guint file_type_idx)
203 {
204 TagFileInfo *tfi;
205 gint tag_type;
206
207 /* load ignore list for C/C++ parser */
208 if ((file_type_idx == GEANY_FILETYPES_C || file_type_idx == GEANY_FILETYPES_CPP) &&
209 c_tags_ignore == NULL)
210 {
211 load_c_ignore_tags();
212 }
213
214 if (cl_options.ignore_global_tags || app->tm_workspace == NULL)
215 return;
216
217 /* load config in case of custom filetypes */
218 filetypes_load_config(file_type_idx, FALSE);
219
220 load_user_tags(file_type_idx);
221
222 switch (file_type_idx)
223 {
224 case GEANY_FILETYPES_PHP:
225 case GEANY_FILETYPES_HTML:
226 html_tags_loaded();
227 }
228 switch (file_type_idx)
229 {
230 case GEANY_FILETYPES_CPP:
231 symbols_global_tags_loaded(GEANY_FILETYPES_C); /* load C global tags */
232 /* no C++ tagfile yet */
233 return;
234 case GEANY_FILETYPES_C: tag_type = GTF_C; break;
235 case GEANY_FILETYPES_PASCAL:tag_type = GTF_PASCAL; break;
236 case GEANY_FILETYPES_PHP: tag_type = GTF_PHP; break;
237 case GEANY_FILETYPES_LATEX: tag_type = GTF_LATEX; break;
238 case GEANY_FILETYPES_PYTHON:tag_type = GTF_PYTHON; break;
239 default:
240 return;
241 }
242 tfi = &tag_file_info[tag_type];
243
244 if (! tfi->tags_loaded)
245 {
246 gchar *fname = g_build_filename(app->datadir, tfi->tag_file, NULL);
247
248 symbols_load_global_tags(fname, filetypes[file_type_idx]);
249 tfi->tags_loaded = TRUE;
250 g_free(fname);
251 }
252 }
253
254
255 /* HTML tagfile is just a list of entities for autocompletion (e.g. '&amp;') */
256 static void html_tags_loaded(void)
257 {
258 TagFileInfo *tfi;
259
260 if (cl_options.ignore_global_tags)
261 return;
262
263 tfi = &tag_file_info[GTF_HTML_ENTITIES];
264 if (! tfi->tags_loaded)
265 {
266 gchar *file = g_build_filename(app->datadir, tfi->tag_file, NULL);
267
268 html_entities = utils_read_file_in_array(file);
269 tfi->tags_loaded = TRUE;
270 g_free(file);
271 }
272 }
273
274
275 GString *symbols_find_typenames_as_string(gint lang, gboolean global)
276 {
277 guint j;
278 TMTag *tag;
279 GString *s = NULL;
280 GPtrArray *typedefs;
281 gint tag_lang;
282
283 if (global)
284 typedefs = tm_tags_extract(app->tm_workspace->global_tags, TM_GLOBAL_TYPE_MASK);
285 else
286 typedefs = app->tm_workspace->typename_array;
287
288 if ((typedefs) && (typedefs->len > 0))
289 {
290 s = g_string_sized_new(typedefs->len * 10);
291 for (j = 0; j < typedefs->len; ++j)
292 {
293 tag = TM_TAG(typedefs->pdata[j]);
294 tag_lang = tag->lang;
295
296 /* the check for tag_lang == lang is necessary to avoid wrong type colouring of
297 * e.g. PHP classes in C++ files
298 * lang = -2 disables the check */
299 if (tag->name && (tag_lang == lang || lang == -2 ||
300 (lang == TM_PARSER_CPP && tag_lang == TM_PARSER_C)))
301 {
302 if (j != 0)
303 g_string_append_c(s, ' ');
304 g_string_append(s, tag->name);
305 }
306 }
307 }
308 if (typedefs && global)
309 g_ptr_array_free(typedefs, TRUE);
310 return s;
311 }
312
313
314 /** Gets the context separator used by the tag manager for a particular file
315 * type.
316 * @param ft_id File type identifier.
317 * @return The context separator string.
318 *
319 * Returns non-printing sequence "\x03" ie ETX (end of text) for filetypes
320 * without a context separator.
321 *
322 * @since 0.19
323 */
324 GEANY_API_SYMBOL
325 const gchar *symbols_get_context_separator(gint ft_id)
326 {
327 switch (ft_id)
328 {
329 case GEANY_FILETYPES_C: /* for C++ .h headers or C structs */
330 case GEANY_FILETYPES_CPP:
331 case GEANY_FILETYPES_GLSL: /* for structs */
332 /*case GEANY_FILETYPES_RUBY:*/ /* not sure what to use atm*/
333 case GEANY_FILETYPES_PHP:
334 case GEANY_FILETYPES_RUST:
335 case GEANY_FILETYPES_ZEPHIR:
336 return "::";
337
338 /* avoid confusion with other possible separators in group/section name */
339 case GEANY_FILETYPES_CONF:
340 case GEANY_FILETYPES_REST:
341 return ":::";
342
343 /* no context separator */
344 case GEANY_FILETYPES_ASCIIDOC:
345 case GEANY_FILETYPES_TXT2TAGS:
346 return "\x03";
347
348 default:
349 return ".";
350 }
351 }
352
353
354 /* Note: if tags is sorted, we can use bsearch or tm_tags_find() to speed this up. */
355 static TMTag *
356 symbols_find_tm_tag(const GPtrArray *tags, const gchar *tag_name)
357 {
358 guint i;
359 g_return_val_if_fail(tags != NULL, NULL);
360
361 for (i = 0; i < tags->len; ++i)
362 {
363 if (utils_str_equal(TM_TAG(tags->pdata[i])->name, tag_name))
364 return TM_TAG(tags->pdata[i]);
365 }
366 return NULL;
367 }
368
369
370 static TMTag *find_source_file_tag(GPtrArray *tags_array,
371 const gchar *tag_name, guint type)
372 {
373 GPtrArray *tags;
374 TMTag *tmtag;
375
376 tags = tm_tags_extract(tags_array, type);
377 if (tags != NULL)
378 {
379 tmtag = symbols_find_tm_tag(tags, tag_name);
380
381 g_ptr_array_free(tags, TRUE);
382
383 if (tmtag != NULL)
384 return tmtag;
385 }
386 return NULL; /* not found */
387 }
388
389
390 static TMTag *find_workspace_tag(const gchar *tag_name, guint type)
391 {
392 guint j;
393 const GPtrArray *source_files = NULL;
394
395 if (app->tm_workspace != NULL)
396 source_files = app->tm_workspace->source_files;
397
398 if (source_files != NULL)
399 {
400 for (j = 0; j < source_files->len; j++)
401 {
402 TMSourceFile *srcfile = source_files->pdata[j];
403 TMTag *tmtag;
404
405 tmtag = find_source_file_tag(srcfile->tags_array, tag_name, type);
406 if (tmtag != NULL)
407 return tmtag;
408 }
409 }
410 return NULL; /* not found */
411 }
412
413
414 const gchar **symbols_get_html_entities(void)
415 {
416 if (html_entities == NULL)
417 html_tags_loaded(); /* if not yet created, force creation of the array but shouldn't occur */
418
419 return (const gchar **) html_entities;
420 }
421
422
423 /* sort by name, then line */
424 static gint compare_symbol(const TMTag *tag_a, const TMTag *tag_b)
425 {
426 gint ret;
427
428 if (tag_a == NULL || tag_b == NULL)
429 return 0;
430
431 if (tag_a->name == NULL)
432 return -(tag_a->name != tag_b->name);
433
434 if (tag_b->name == NULL)
435 return tag_a->name != tag_b->name;
436
437 ret = strcmp(tag_a->name, tag_b->name);
438 if (ret == 0)
439 {
440 return tag_a->line - tag_b->line;
441 }
442 return ret;
443 }
444
445
446 /* sort by line, then scope */
447 static gint compare_symbol_lines(gconstpointer a, gconstpointer b)
448 {
449 const TMTag *tag_a = TM_TAG(a);
450 const TMTag *tag_b = TM_TAG(b);
451 gint ret;
452
453 if (a == NULL || b == NULL)
454 return 0;
455
456 ret = tag_a->line - tag_b->line;
457 if (ret == 0)
458 {
459 if (tag_a->scope == NULL)
460 return -(tag_a->scope != tag_b->scope);
461 if (tag_b->scope == NULL)
462 return tag_a->scope != tag_b->scope;
463 else
464 return strcmp(tag_a->scope, tag_b->scope);
465 }
466 return ret;
467 }
468
469
470 static GList *get_tag_list(GeanyDocument *doc, TMTagType tag_types)
471 {
472 GList *tag_names = NULL;
473 TMTag *tag;
474 guint i;
475
476 g_return_val_if_fail(doc, NULL);
477
478 if (! doc->tm_file || ! doc->tm_file->tags_array)
479 return NULL;
480
481 for (i = 0; i < doc->tm_file->tags_array->len; ++i)
482 {
483 tag = TM_TAG(doc->tm_file->tags_array->pdata[i]);
484 if (G_UNLIKELY(tag == NULL))
485 return NULL;
486
487 if (tag->type & tag_types)
488 {
489 tag_names = g_list_prepend(tag_names, tag);
490 }
491 }
492 tag_names = g_list_sort(tag_names, compare_symbol_lines);
493 return tag_names;
494 }
495
496
497 /* amount of types in the symbol list (currently max. 8 are used) */
498 #define MAX_SYMBOL_TYPES (sizeof(tv_iters) / sizeof(GtkTreeIter))
499
500 struct TreeviewSymbols
501 {
502 GtkTreeIter tag_function;
503 GtkTreeIter tag_class;
504 GtkTreeIter tag_macro;
505 GtkTreeIter tag_member;
506 GtkTreeIter tag_variable;
507 GtkTreeIter tag_externvar;
508 GtkTreeIter tag_namespace;
509 GtkTreeIter tag_struct;
510 GtkTreeIter tag_interface;
511 GtkTreeIter tag_type;
512 GtkTreeIter tag_other;
513 } tv_iters;
514
515
516 static void init_tag_iters(void)
517 {
518 /* init all GtkTreeIters with -1 to make them invalid to avoid crashes when switching between
519 * filetypes(e.g. config file to Python crashes Geany without this) */
520 tv_iters.tag_function.stamp = -1;
521 tv_iters.tag_class.stamp = -1;
522 tv_iters.tag_member.stamp = -1;
523 tv_iters.tag_macro.stamp = -1;
524 tv_iters.tag_variable.stamp = -1;
525 tv_iters.tag_externvar.stamp = -1;
526 tv_iters.tag_namespace.stamp = -1;
527 tv_iters.tag_struct.stamp = -1;
528 tv_iters.tag_interface.stamp = -1;
529 tv_iters.tag_type.stamp = -1;
530 tv_iters.tag_other.stamp = -1;
531 }
532
533
534 static GdkPixbuf *get_tag_icon(const gchar *icon_name)
535 {
536 static GtkIconTheme *icon_theme = NULL;
537 static gint x = -1;
538
539 if (G_UNLIKELY(x < 0))
540 {
541 gint dummy;
542 icon_theme = gtk_icon_theme_get_default();
543 gtk_icon_size_lookup(GTK_ICON_SIZE_MENU, &x, &dummy);
544 }
545 return gtk_icon_theme_load_icon(icon_theme, icon_name, x, 0, NULL);
546 }
547
548
549 static gboolean find_toplevel_iter(GtkTreeStore *store, GtkTreeIter *iter, const gchar *title)
550 {
551 GtkTreeModel *model = GTK_TREE_MODEL(store);
552
553 if (!gtk_tree_model_get_iter_first(model, iter))
554 return FALSE;
555 do
556 {
557 gchar *candidate;
558
559 gtk_tree_model_get(model, iter, SYMBOLS_COLUMN_NAME, &candidate, -1);
560 /* FIXME: what if 2 different items have the same name?
561 * this should never happen, but might be caused by a typo in a translation */
562 if (utils_str_equal(candidate, title))
563 {
564 g_free(candidate);
565 return TRUE;
566 }
567 else
568 g_free(candidate);
569 }
570 while (gtk_tree_model_iter_next(model, iter));
571
572 return FALSE;
573 }
574
575
576 /* Adds symbol list groups in (iter*, title) pairs.
577 * The list must be ended with NULL. */
578 static void G_GNUC_NULL_TERMINATED
579 tag_list_add_groups(GtkTreeStore *tree_store, ...)
580 {
581 va_list args;
582 GtkTreeIter *iter;
583
584 g_return_if_fail(top_level_iter_names);
585
586 va_start(args, tree_store);
587 for (; iter = va_arg(args, GtkTreeIter*), iter != NULL;)
588 {
589 gchar *title = va_arg(args, gchar*);
590 guint icon_id = va_arg(args, guint);
591 GdkPixbuf *icon = NULL;
592
593 if (icon_id < N_ICONS)
594 icon = symbols_icons[icon_id].pixbuf;
595
596 g_assert(title != NULL);
597 g_ptr_array_add(top_level_iter_names, title);
598
599 if (!find_toplevel_iter(tree_store, iter, title))
600 gtk_tree_store_append(tree_store, iter, NULL);
601
602 if (icon)
603 gtk_tree_store_set(tree_store, iter, SYMBOLS_COLUMN_ICON, icon, -1);
604 gtk_tree_store_set(tree_store, iter, SYMBOLS_COLUMN_NAME, title, -1);
605 }
606 va_end(args);
607 }
608
609
610 static void add_top_level_items(GeanyDocument *doc)
611 {
612 filetype_id ft_id = doc->file_type->id;
613 GtkTreeStore *tag_store = doc->priv->tag_store;
614
615 if (top_level_iter_names == NULL)
616 top_level_iter_names = g_ptr_array_new();
617 else
618 g_ptr_array_set_size(top_level_iter_names, 0);
619
620 init_tag_iters();
621
622 switch (ft_id)
623 {
624 case GEANY_FILETYPES_DIFF:
625 {
626 tag_list_add_groups(tag_store,
627 &(tv_iters.tag_function), _("Files"), ICON_NONE, NULL);
628 break;
629 }
630 case GEANY_FILETYPES_DOCBOOK:
631 {
632 tag_list_add_groups(tag_store,
633 &(tv_iters.tag_function), _("Chapter"), ICON_NONE,
634 &(tv_iters.tag_class), _("Section"), ICON_NONE,
635 &(tv_iters.tag_member), _("Sect1"), ICON_NONE,
636 &(tv_iters.tag_macro), _("Sect2"), ICON_NONE,
637 &(tv_iters.tag_variable), _("Sect3"), ICON_NONE,
638 &(tv_iters.tag_struct), _("Appendix"), ICON_NONE,
639 &(tv_iters.tag_other), _("Other"), ICON_NONE,
640 NULL);
641 break;
642 }
643 case GEANY_FILETYPES_HASKELL:
644 tag_list_add_groups(tag_store,
645 &tv_iters.tag_namespace, _("Module"), ICON_NONE,
646 &tv_iters.tag_type, _("Types"), ICON_NONE,
647 &tv_iters.tag_macro, _("Type constructors"), ICON_NONE,
648 &tv_iters.tag_function, _("Functions"), ICON_METHOD,
649 NULL);
650 break;
651 case GEANY_FILETYPES_COBOL:
652 tag_list_add_groups(tag_store,
653 &tv_iters.tag_class, _("Program"), ICON_CLASS,
654 &tv_iters.tag_function, _("File"), ICON_METHOD,
655 &tv_iters.tag_namespace, _("Sections"), ICON_NAMESPACE,
656 &tv_iters.tag_macro, _("Paragraph"), ICON_OTHER,
657 &tv_iters.tag_struct, _("Group"), ICON_STRUCT,
658 &tv_iters.tag_variable, _("Data"), ICON_VAR,
659 NULL);
660 break;
661 case GEANY_FILETYPES_CONF:
662 tag_list_add_groups(tag_store,
663 &tv_iters.tag_namespace, _("Sections"), ICON_OTHER,
664 &tv_iters.tag_macro, _("Keys"), ICON_VAR,
665 NULL);
666 break;
667 case GEANY_FILETYPES_NSIS:
668 tag_list_add_groups(tag_store,
669 &tv_iters.tag_namespace, _("Sections"), ICON_OTHER,
670 &tv_iters.tag_function, _("Functions"), ICON_METHOD,
671 &(tv_iters.tag_variable), _("Variables"), ICON_VAR,
672 NULL);
673 break;
674 case GEANY_FILETYPES_LATEX:
675 {
676 tag_list_add_groups(tag_store,
677 &(tv_iters.tag_function), _("Command"), ICON_NONE,
678 &(tv_iters.tag_class), _("Environment"), ICON_NONE,
679 &(tv_iters.tag_member), _("Section"), ICON_NONE,
680 &(tv_iters.tag_macro), _("Subsection"), ICON_NONE,
681 &(tv_iters.tag_variable), _("Subsubsection"), ICON_NONE,
682 &(tv_iters.tag_struct), _("Label"), ICON_NONE,
683 &(tv_iters.tag_namespace), _("Chapter"), ICON_NONE,
684 &(tv_iters.tag_other), _("Other"), ICON_NONE,
685 NULL);
686 break;
687 }
688 case GEANY_FILETYPES_MATLAB:
689 {
690 tag_list_add_groups(tag_store,
691 &(tv_iters.tag_function), _("Functions"), ICON_METHOD,
692 &(tv_iters.tag_struct), _("Structures"), ICON_STRUCT,
693 NULL);
694 break;
695 }
696 case GEANY_FILETYPES_ABAQUS:
697 {
698 tag_list_add_groups(tag_store,
699 &(tv_iters.tag_class), _("Parts"), ICON_NONE,
700 &(tv_iters.tag_member), _("Assembly"), ICON_NONE,
701 &(tv_iters.tag_namespace), _("Steps"), ICON_NONE,
702 NULL);
703 break;
704 }
705 case GEANY_FILETYPES_R:
706 {
707 tag_list_add_groups(tag_store,
708 &(tv_iters.tag_function), _("Functions"), ICON_METHOD,
709 &(tv_iters.tag_other), _("Other"), ICON_NONE,
710 NULL);
711 break;
712 }
713 case GEANY_FILETYPES_RUST:
714 {
715 tag_list_add_groups(tag_store,
716 &(tv_iters.tag_namespace), _("Modules"), ICON_NAMESPACE,
717 &(tv_iters.tag_struct), _("Structures"), ICON_STRUCT,
718 &(tv_iters.tag_interface), _("Traits"), ICON_CLASS,
719 &(tv_iters.tag_class), _("Implementations"), ICON_CLASS,
720 &(tv_iters.tag_function), _("Functions"), ICON_METHOD,
721 &(tv_iters.tag_type), _("Typedefs / Enums"), ICON_STRUCT,
722 &(tv_iters.tag_variable), _("Variables"), ICON_VAR,
723 &(tv_iters.tag_macro), _("Macros"), ICON_MACRO,
724 &(tv_iters.tag_member), _("Methods"), ICON_MEMBER,
725 &(tv_iters.tag_other), _("Other"), ICON_OTHER,
726 NULL);
727 break;
728 }
729 case GEANY_FILETYPES_GO:
730 {
731 tag_list_add_groups(tag_store,
732 &(tv_iters.tag_namespace), _("Package"), ICON_NAMESPACE,
733 &(tv_iters.tag_function), _("Functions"), ICON_METHOD,
734 &(tv_iters.tag_interface), _("Interfaces"), ICON_STRUCT,
735 &(tv_iters.tag_struct), _("Structs"), ICON_STRUCT,
736 &(tv_iters.tag_type), _("Types"), ICON_STRUCT,
737 &(tv_iters.tag_macro), _("Constants"), ICON_MACRO,
738 &(tv_iters.tag_variable), _("Variables"), ICON_VAR,
739 &(tv_iters.tag_member), _("Members"), ICON_MEMBER,
740 &(tv_iters.tag_other), _("Other"), ICON_OTHER,
741 NULL);
742 break;
743 }
744 case GEANY_FILETYPES_PERL:
745 {
746 tag_list_add_groups(tag_store,
747 &(tv_iters.tag_namespace), _("Package"), ICON_NAMESPACE,
748 &(tv_iters.tag_function), _("Functions"), ICON_METHOD,
749 &(tv_iters.tag_macro), _("Labels"), ICON_NONE,
750 &(tv_iters.tag_type), _("Constants"), ICON_NONE,
751 &(tv_iters.tag_other), _("Other"), ICON_OTHER,
752 NULL);
753 break;
754 }
755 case GEANY_FILETYPES_PHP:
756 case GEANY_FILETYPES_ZEPHIR:
757 {
758 tag_list_add_groups(tag_store,
759 &(tv_iters.tag_namespace), _("Namespaces"), ICON_NAMESPACE,
760 &(tv_iters.tag_interface), _("Interfaces"), ICON_STRUCT,
761 &(tv_iters.tag_class), _("Classes"), ICON_CLASS,
762 &(tv_iters.tag_function), _("Functions"), ICON_METHOD,
763 &(tv_iters.tag_macro), _("Constants"), ICON_MACRO,
764 &(tv_iters.tag_variable), _("Variables"), ICON_VAR,
765 &(tv_iters.tag_struct), _("Traits"), ICON_STRUCT,
766 NULL);
767 break;
768 }
769 case GEANY_FILETYPES_HTML:
770 {
771 tag_list_add_groups(tag_store,
772 &(tv_iters.tag_function), _("Functions"), ICON_NONE,
773 &(tv_iters.tag_member), _("Anchors"), ICON_NONE,
774 &(tv_iters.tag_namespace), _("H1 Headings"), ICON_NONE,
775 &(tv_iters.tag_class), _("H2 Headings"), ICON_NONE,
776 &(tv_iters.tag_variable), _("H3 Headings"), ICON_NONE,
777 NULL);
778 break;
779 }
780 case GEANY_FILETYPES_CSS:
781 {
782 tag_list_add_groups(tag_store,
783 &(tv_iters.tag_class), _("Classes"), ICON_CLASS,
784 &(tv_iters.tag_variable), _("ID Selectors"), ICON_VAR,
785 &(tv_iters.tag_struct), _("Type Selectors"), ICON_STRUCT, NULL);
786 break;
787 }
788 case GEANY_FILETYPES_REST:
789 case GEANY_FILETYPES_TXT2TAGS:
790 case GEANY_FILETYPES_ABC:
791 {
792 tag_list_add_groups(tag_store,
793 &(tv_iters.tag_namespace), _("Chapter"), ICON_NONE,
794 &(tv_iters.tag_member), _("Section"), ICON_NONE,
795 &(tv_iters.tag_macro), _("Subsection"), ICON_NONE,
796 &(tv_iters.tag_variable), _("Subsubsection"), ICON_NONE,
797 NULL);
798 break;
799 }
800 case GEANY_FILETYPES_ASCIIDOC:
801 {
802 tag_list_add_groups(tag_store,
803 &(tv_iters.tag_namespace), _("Document"), ICON_NONE,
804 &(tv_iters.tag_member), _("Section Level 1"), ICON_NONE,
805 &(tv_iters.tag_macro), _("Section Level 2"), ICON_NONE,
806 &(tv_iters.tag_variable), _("Section Level 3"), ICON_NONE,
807 &(tv_iters.tag_struct), _("Section Level 4"), ICON_NONE,
808 NULL);
809 break;
810 }
811 case GEANY_FILETYPES_RUBY:
812 {
813 tag_list_add_groups(tag_store,
814 &(tv_iters.tag_namespace), _("Modules"), ICON_NAMESPACE,
815 &(tv_iters.tag_class), _("Classes"), ICON_CLASS,
816 &(tv_iters.tag_member), _("Singletons"), ICON_STRUCT,
817 &(tv_iters.tag_function), _("Methods"), ICON_METHOD,
818 NULL);
819 break;
820 }
821 case GEANY_FILETYPES_TCL:
822 {
823 tag_list_add_groups(tag_store,
824 &(tv_iters.tag_namespace), _("Namespaces"), ICON_NAMESPACE,
825 &(tv_iters.tag_class), _("Classes"), ICON_CLASS,
826 &(tv_iters.tag_member), _("Methods"), ICON_METHOD,
827 &(tv_iters.tag_function), _("Procedures"), ICON_OTHER,
828 NULL);
829 break;
830 }
831 case GEANY_FILETYPES_PYTHON:
832 {
833 tag_list_add_groups(tag_store,
834 &(tv_iters.tag_class), _("Classes"), ICON_CLASS,
835 &(tv_iters.tag_member), _("Methods"), ICON_MACRO,
836 &(tv_iters.tag_function), _("Functions"), ICON_METHOD,
837 &(tv_iters.tag_variable), _("Variables"), ICON_VAR,
838 &(tv_iters.tag_externvar), _("Imports"), ICON_NAMESPACE,
839 NULL);
840 break;
841 }
842 case GEANY_FILETYPES_VHDL:
843 {
844 tag_list_add_groups(tag_store,
845 &(tv_iters.tag_namespace), _("Package"), ICON_NAMESPACE,
846 &(tv_iters.tag_class), _("Entities"), ICON_CLASS,
847 &(tv_iters.tag_struct), _("Architectures"), ICON_STRUCT,
848 &(tv_iters.tag_type), _("Types"), ICON_OTHER,
849 &(tv_iters.tag_function), _("Functions / Procedures"), ICON_METHOD,
850 &(tv_iters.tag_variable), _("Variables / Signals"), ICON_VAR,
851 &(tv_iters.tag_member), _("Processes / Blocks / Components"), ICON_MEMBER,
852 &(tv_iters.tag_other), _("Other"), ICON_OTHER,
853 NULL);
854 break;
855 }
856 case GEANY_FILETYPES_VERILOG:
857 {
858 tag_list_add_groups(tag_store,
859 &(tv_iters.tag_type), _("Events"), ICON_MACRO,
860 &(tv_iters.tag_class), _("Modules"), ICON_CLASS,
861 &(tv_iters.tag_function), _("Functions / Tasks"), ICON_METHOD,
862 &(tv_iters.tag_variable), _("Variables"), ICON_VAR,
863 &(tv_iters.tag_other), _("Other"), ICON_OTHER,
864 NULL);
865 break;
866 }
867 case GEANY_FILETYPES_JAVA:
868 {
869 tag_list_add_groups(tag_store,
870 &(tv_iters.tag_namespace), _("Package"), ICON_NAMESPACE,
871 &(tv_iters.tag_interface), _("Interfaces"), ICON_STRUCT,
872 &(tv_iters.tag_class), _("Classes"), ICON_CLASS,
873 &(tv_iters.tag_function), _("Methods"), ICON_METHOD,
874 &(tv_iters.tag_member), _("Members"), ICON_MEMBER,
875 &(tv_iters.tag_type), _("Enums"), ICON_STRUCT,
876 &(tv_iters.tag_other), _("Other"), ICON_OTHER,
877 NULL);
878 break;
879 }
880 case GEANY_FILETYPES_AS:
881 {
882 tag_list_add_groups(tag_store,
883 &(tv_iters.tag_namespace), _("Package"), ICON_NAMESPACE,
884 &(tv_iters.tag_interface), _("Interfaces"), ICON_STRUCT,
885 &(tv_iters.tag_class), _("Classes"), ICON_CLASS,
886 &(tv_iters.tag_function), _("Functions"), ICON_METHOD,
887 &(tv_iters.tag_member), _("Properties"), ICON_MEMBER,
888 &(tv_iters.tag_variable), _("Variables"), ICON_VAR,
889 &(tv_iters.tag_macro), _("Constants"), ICON_MACRO,
890 &(tv_iters.tag_other), _("Other"), ICON_OTHER,
891 NULL);
892 break;
893 }
894 case GEANY_FILETYPES_HAXE:
895 {
896 tag_list_add_groups(tag_store,
897 &(tv_iters.tag_interface), _("Interfaces"), ICON_STRUCT,
898 &(tv_iters.tag_class), _("Classes"), ICON_CLASS,
899 &(tv_iters.tag_function), _("Methods"), ICON_METHOD,
900 &(tv_iters.tag_type), _("Types"), ICON_MACRO,
901 &(tv_iters.tag_variable), _("Variables"), ICON_VAR,
902 &(tv_iters.tag_other), _("Other"), ICON_OTHER,
903 NULL);
904 break;
905 }
906 case GEANY_FILETYPES_BASIC:
907 {
908 tag_list_add_groups(tag_store,
909 &(tv_iters.tag_function), _("Functions"), ICON_METHOD,
910 &(tv_iters.tag_variable), _("Variables"), ICON_VAR,
911 &(tv_iters.tag_macro), _("Constants"), ICON_MACRO,
912 &(tv_iters.tag_struct), _("Types"), ICON_NAMESPACE,
913 &(tv_iters.tag_namespace), _("Labels"), ICON_MEMBER,
914 &(tv_iters.tag_other), _("Other"), ICON_OTHER,
915 NULL);
916 break;
917 }
918 case GEANY_FILETYPES_F77:
919 case GEANY_FILETYPES_FORTRAN:
920 {
921 tag_list_add_groups(tag_store,
922 &(tv_iters.tag_namespace), _("Module"), ICON_CLASS,
923 &(tv_iters.tag_struct), _("Programs"), ICON_CLASS,
924 &(tv_iters.tag_interface), _("Interfaces"), ICON_STRUCT,
925 &(tv_iters.tag_function), _("Functions / Subroutines"), ICON_METHOD,
926 &(tv_iters.tag_variable), _("Variables"), ICON_VAR,
927 &(tv_iters.tag_class), _("Types"), ICON_CLASS,
928 &(tv_iters.tag_member), _("Components"), ICON_MEMBER,
929 &(tv_iters.tag_macro), _("Blocks"), ICON_MEMBER,
930 &(tv_iters.tag_type), _("Enums"), ICON_STRUCT,
931 &(tv_iters.tag_other), _("Other"), ICON_OTHER,
932 NULL);
933 break;
934 }
935 case GEANY_FILETYPES_ASM:
936 {
937 tag_list_add_groups(tag_store,
938 &(tv_iters.tag_namespace), _("Labels"), ICON_NAMESPACE,
939 &(tv_iters.tag_function), _("Macros"), ICON_METHOD,
940 &(tv_iters.tag_macro), _("Defines"), ICON_MACRO,
941 &(tv_iters.tag_struct), _("Types"), ICON_STRUCT,
942 NULL);
943 break;
944 }
945 case GEANY_FILETYPES_MAKE:
946 tag_list_add_groups(tag_store,
947 &tv_iters.tag_function, _("Targets"), ICON_METHOD,
948 &tv_iters.tag_macro, _("Macros"), ICON_MACRO,
949 NULL);
950 break;
951 case GEANY_FILETYPES_SQL:
952 {
953 tag_list_add_groups(tag_store,
954 &(tv_iters.tag_function), _("Functions"), ICON_METHOD,
955 &(tv_iters.tag_namespace), _("Procedures"), ICON_NAMESPACE,
956 &(tv_iters.tag_struct), _("Indexes"), ICON_STRUCT,
957 &(tv_iters.tag_class), _("Tables"), ICON_CLASS,
958 &(tv_iters.tag_macro), _("Triggers"), ICON_MACRO,
959 &(tv_iters.tag_member), _("Views"), ICON_VAR,
960 &(tv_iters.tag_other), _("Other"), ICON_OTHER,
961 &(tv_iters.tag_variable), _("Variables"), ICON_VAR,
962 NULL);
963 break;
964 }
965 case GEANY_FILETYPES_D:
966 default:
967 {
968 if (ft_id == GEANY_FILETYPES_D)
969 tag_list_add_groups(tag_store,
970 &(tv_iters.tag_namespace), _("Module"), ICON_NONE, NULL);
971 else
972 tag_list_add_groups(tag_store,
973 &(tv_iters.tag_namespace), _("Namespaces"), ICON_NAMESPACE, NULL);
974
975 tag_list_add_groups(tag_store,
976 &(tv_iters.tag_class), _("Classes"), ICON_CLASS,
977 &(tv_iters.tag_interface), _("Interfaces"), ICON_STRUCT,
978 &(tv_iters.tag_function), _("Functions"), ICON_METHOD,
979 &(tv_iters.tag_member), _("Members"), ICON_MEMBER,
980 &(tv_iters.tag_struct), _("Structs"), ICON_STRUCT,
981 &(tv_iters.tag_type), _("Typedefs / Enums"), ICON_STRUCT,
982 NULL);
983
984 if (ft_id != GEANY_FILETYPES_D)
985 {
986 tag_list_add_groups(tag_store,
987 &(tv_iters.tag_macro), _("Macros"), ICON_MACRO, NULL);
988 }
989 tag_list_add_groups(tag_store,
990 &(tv_iters.tag_variable), _("Variables"), ICON_VAR,
991 &(tv_iters.tag_externvar), _("Extern Variables"), ICON_VAR,
992 &(tv_iters.tag_other), _("Other"), ICON_OTHER, NULL);
993 }
994 }
995 }
996
997
998 /* removes toplevel items that have no children */
999 static void hide_empty_rows(GtkTreeStore *store)
1000 {
1001 GtkTreeIter iter;
1002 gboolean cont = TRUE;
1003
1004 if (! gtk_tree_model_get_iter_first(GTK_TREE_MODEL(store), &iter))
1005 return; /* stop when first iter is invalid, i.e. no elements */
1006
1007 while (cont)
1008 {
1009 if (! gtk_tree_model_iter_has_child(GTK_TREE_MODEL(store), &iter))
1010 cont = gtk_tree_store_remove(store, &iter);
1011 else
1012 cont = gtk_tree_model_iter_next(GTK_TREE_MODEL(store), &iter);
1013 }
1014 }
1015
1016
1017 static const gchar *get_symbol_name(GeanyDocument *doc, const TMTag *tag, gboolean found_parent)
1018 {
1019 gchar *utf8_name;
1020 const gchar *scope = tag->scope;
1021 static GString *buffer = NULL; /* buffer will be small so we can keep it for reuse */
1022 gboolean doc_is_utf8 = FALSE;
1023
1024 /* encodings_convert_to_utf8_from_charset() fails with charset "None", so skip conversion
1025 * for None at this point completely */
1026 if (utils_str_equal(doc->encoding, "UTF-8") ||
1027 utils_str_equal(doc->encoding, "None"))
1028 doc_is_utf8 = TRUE;
1029 else /* normally the tags will always be in UTF-8 since we parse from our buffer, but a
1030 * plugin might have called tm_source_file_update(), so check to be sure */
1031 doc_is_utf8 = g_utf8_validate(tag->name, -1, NULL);
1032
1033 if (! doc_is_utf8)
1034 utf8_name = encodings_convert_to_utf8_from_charset(tag->name,
1035 -1, doc->encoding, TRUE);
1036 else
1037 utf8_name = tag->name;
1038
1039 if (utf8_name == NULL)
1040 return NULL;
1041
1042 if (! buffer)
1043 buffer = g_string_new(NULL);
1044 else
1045 g_string_truncate(buffer, 0);
1046
1047 /* check first char of scope is a wordchar */
1048 if (!found_parent && scope &&
1049 strpbrk(scope, GEANY_WORDCHARS) == scope)
1050 {
1051 const gchar *sep = symbols_get_context_separator(doc->file_type->id);
1052
1053 g_string_append(buffer, scope);
1054 g_string_append(buffer, sep);
1055 }
1056 g_string_append(buffer, utf8_name);
1057
1058 if (! doc_is_utf8)
1059 g_free(utf8_name);
1060
1061 g_string_append_printf(buffer, " [%lu]", tag->line);
1062
1063 return buffer->str;
1064 }
1065
1066
1067 static gchar *get_symbol_tooltip(GeanyDocument *doc, const TMTag *tag)
1068 {
1069 gchar *utf8_name = editor_get_calltip_text(doc->editor, tag);
1070
1071 /* encodings_convert_to_utf8_from_charset() fails with charset "None", so skip conversion
1072 * for None at this point completely */
1073 if (utf8_name != NULL &&
1074 ! utils_str_equal(doc->encoding, "UTF-8") &&
1075 ! utils_str_equal(doc->encoding, "None"))
1076 {
1077 SETPTR(utf8_name,
1078 encodings_convert_to_utf8_from_charset(utf8_name, -1, doc->encoding, TRUE));
1079 }
1080
1081 return utf8_name;
1082 }
1083
1084
1085 /* find the last word in "foo::bar::blah", e.g. "blah" */
1086 static const gchar *get_parent_name(const TMTag *tag, filetype_id ft_id)
1087 {
1088 const gchar *scope = tag->scope;
1089 const gchar *separator = symbols_get_context_separator(ft_id);
1090 const gchar *str, *ptr;
1091
1092 if (!scope)
1093 return NULL;
1094
1095 str = scope;
1096
1097 while (1)
1098 {
1099 ptr = strstr(str, separator);
1100 if (ptr)
1101 {
1102 str = ptr + strlen(separator);
1103 }
1104 else
1105 break;
1106 }
1107
1108 return !EMPTY(str) ? str : NULL;
1109 }
1110
1111
1112 static GtkTreeIter *get_tag_type_iter(TMTagType tag_type)
1113 {
1114 GtkTreeIter *iter = NULL;
1115
1116 switch (tag_type)
1117 {
1118 case tm_tag_prototype_t:
1119 case tm_tag_method_t:
1120 case tm_tag_function_t:
1121 {
1122 iter = &tv_iters.tag_function;
1123 break;
1124 }
1125 case tm_tag_externvar_t:
1126 {
1127 iter = &tv_iters.tag_externvar;
1128 break;
1129 }
1130 case tm_tag_macro_t:
1131 case tm_tag_macro_with_arg_t:
1132 {
1133 iter = &tv_iters.tag_macro;
1134 break;
1135 }
1136 case tm_tag_class_t:
1137 {
1138 iter = &tv_iters.tag_class;
1139 break;
1140 }
1141 case tm_tag_member_t:
1142 case tm_tag_field_t:
1143 {
1144 iter = &tv_iters.tag_member;
1145 break;
1146 }
1147 case tm_tag_typedef_t:
1148 case tm_tag_enum_t:
1149 {
1150 iter = &tv_iters.tag_type;
1151 break;
1152 }
1153 case tm_tag_union_t:
1154 case tm_tag_struct_t:
1155 {
1156 iter = &tv_iters.tag_struct;
1157 break;
1158 }
1159 case tm_tag_interface_t:
1160 iter = &tv_iters.tag_interface;
1161 break;
1162 case tm_tag_variable_t:
1163 {
1164 iter = &tv_iters.tag_variable;
1165 break;
1166 }
1167 case tm_tag_namespace_t:
1168 case tm_tag_package_t:
1169 {
1170 iter = &tv_iters.tag_namespace;
1171 break;
1172 }
1173 default:
1174 {
1175 iter = &tv_iters.tag_other;
1176 }
1177 }
1178 if (G_LIKELY(iter->stamp != -1))
1179 return iter;
1180 else
1181 return NULL;
1182 }
1183
1184
1185 static GdkPixbuf *get_child_icon(GtkTreeStore *tree_store, GtkTreeIter *parent)
1186 {
1187 GdkPixbuf *icon = NULL;
1188
1189 if (parent == &tv_iters.tag_other)
1190 {
1191 return g_object_ref(symbols_icons[ICON_VAR].pixbuf);
1192 }
1193 /* copy parent icon */
1194 gtk_tree_model_get(GTK_TREE_MODEL(tree_store), parent,
1195 SYMBOLS_COLUMN_ICON, &icon, -1);
1196 return icon;
1197 }
1198
1199
1200 static gboolean tag_equal(gconstpointer v1, gconstpointer v2)
1201 {
1202 const TMTag *t1 = v1;
1203 const TMTag *t2 = v2;
1204
1205 return (t1->type == t2->type && strcmp(t1->name, t2->name) == 0 &&
1206 utils_str_equal(t1->scope, t2->scope) &&
1207 /* include arglist in match to support e.g. C++ overloading */
1208 utils_str_equal(t1->arglist, t2->arglist));
1209 }
1210
1211
1212 /* inspired from g_str_hash() */
1213 static guint tag_hash(gconstpointer v)
1214 {
1215 const TMTag *tag = v;
1216 const gchar *p;
1217 guint32 h = 5381;
1218
1219 h = (h << 5) + h + tag->type;
1220 for (p = tag->name; *p != '\0'; p++)
1221 h = (h << 5) + h + *p;
1222 if (tag->scope)
1223 {
1224 for (p = tag->scope; *p != '\0'; p++)
1225 h = (h << 5) + h + *p;
1226 }
1227 /* for e.g. C++ overloading */
1228 if (tag->arglist)
1229 {
1230 for (p = tag->arglist; *p != '\0'; p++)
1231 h = (h << 5) + h + *p;
1232 }
1233
1234 return h;
1235 }
1236
1237
1238 /* like gtk_tree_view_expand_to_path() but with an iter */
1239 static void tree_view_expand_to_iter(GtkTreeView *view, GtkTreeIter *iter)
1240 {
1241 GtkTreeModel *model = gtk_tree_view_get_model(view);
1242 GtkTreePath *path = gtk_tree_model_get_path(model, iter);
1243
1244 gtk_tree_view_expand_to_path(view, path);
1245 gtk_tree_path_free(path);
1246 }
1247
1248
1249 /* like gtk_tree_store_remove() but finds the next iter at any level */
1250 static gboolean tree_store_remove_row(GtkTreeStore *store, GtkTreeIter *iter)
1251 {
1252 GtkTreeIter parent;
1253 gboolean has_parent;
1254 gboolean cont;
1255
1256 has_parent = gtk_tree_model_iter_parent(GTK_TREE_MODEL(store), &parent, iter);
1257 cont = gtk_tree_store_remove(store, iter);
1258 /* if there is no next at this level but there is a parent iter, continue from it */
1259 if (! cont && has_parent)
1260 {
1261 *iter = parent;
1262 cont = ui_tree_model_iter_any_next(GTK_TREE_MODEL(store), iter, FALSE);
1263 }
1264
1265 return cont;
1266 }
1267
1268
1269 /* adds a new element in the parent table if it's key is known.
1270 * duplicates are kept */
1271 static void update_parents_table(GHashTable *table, const TMTag *tag, const gchar *parent_name,
1272 const GtkTreeIter *iter)
1273 {
1274 GList **list;
1275 if (g_hash_table_lookup_extended(table, tag->name, NULL, (gpointer *) &list) &&
1276 ! utils_str_equal(parent_name, tag->name) /* prevent Foo::Foo from making parent = child */)
1277 {
1278 if (! list)
1279 {
1280 list = g_slice_alloc(sizeof *list);
1281 *list = NULL;
1282 g_hash_table_insert(table, tag->name, list);
1283 }
1284 *list = g_list_prepend(*list, g_slice_dup(GtkTreeIter, iter));
1285 }
1286 }
1287
1288
1289 static void free_iter_slice_list(gpointer data)
1290 {
1291 GList **list = data;
1292
1293 if (list)
1294 {
1295 GList *node;
1296 foreach_list(node, *list)
1297 g_slice_free(GtkTreeIter, node->data);
1298 g_list_free(*list);
1299 g_slice_free1(sizeof *list, list);
1300 }
1301 }
1302
1303
1304 /* inserts a @data in @table on key @tag.
1305 * previous data is not overwritten if the key is duplicated, but rather the
1306 * two values are kept in a list
1307 *
1308 * table is: GHashTable<TMTag, GList<GList<TMTag>>> */
1309 static void tags_table_insert(GHashTable *table, TMTag *tag, GList *data)
1310 {
1311 GList *list = g_hash_table_lookup(table, tag);
1312 list = g_list_prepend(list, data);
1313 g_hash_table_insert(table, tag, list);
1314 }
1315
1316
1317 /* looks up the entry in @table that better matches @tag.
1318 * if there are more than one candidate, the one that has closest line position to @tag is chosen */
1319 static GList *tags_table_lookup(GHashTable *table, TMTag *tag)
1320 {
1321 GList *data = NULL;
1322 GList *node = g_hash_table_lookup(table, tag);
1323 if (node)
1324 {
1325 glong delta;
1326 data = node->data;
1327
1328 #define TAG_DELTA(a, b) ABS((glong) TM_TAG(a)->line - (glong) TM_TAG(b)->line)
1329
1330 delta = TAG_DELTA(((GList *) node->data)->data, tag);
1331 for (node = node->next; node; node = node->next)
1332 {
1333 glong d = TAG_DELTA(((GList *) node->data)->data, tag);
1334
1335 if (d < delta)
1336 {
1337 data = node->data;
1338 delta = d;
1339 }
1340 }
1341
1342 #undef TAG_DELTA
1343
1344 }
1345 return data;
1346 }
1347
1348
1349 /* removes the element at @tag from @table.
1350 * @tag must be the exact pointer used at insertion time */
1351 static void tags_table_remove(GHashTable *table, TMTag *tag)
1352 {
1353 GList *list = g_hash_table_lookup(table, tag);
1354 if (list)
1355 {
1356 GList *node;
1357 foreach_list(node, list)
1358 {
1359 if (((GList *) node->data)->data == tag)
1360 break;
1361 }
1362 list = g_list_delete_link(list, node);
1363 if (list)
1364 g_hash_table_insert(table, tag, list);
1365 else
1366 g_hash_table_remove(table, tag);
1367 }
1368 }
1369
1370
1371 static void tags_table_destroy(GHashTable *table)
1372 {
1373 /* free any leftover elements. note that we can't register a value_free_func when
1374 * creating the hash table because we only want to free it when destroying the table,
1375 * not when inserting a duplicate (we handle this manually) */
1376 GHashTableIter iter;
1377 gpointer value;
1378
1379 g_hash_table_iter_init(&iter, table);
1380 while (g_hash_table_iter_next(&iter, NULL, &value))
1381 g_list_free(value);
1382 g_hash_table_destroy(table);
1383 }
1384
1385
1386 /*
1387 * Updates the tag tree for a document with the tags in *list.
1388 * @param doc a document
1389 * @param tags a pointer to a GList* holding the tags to add/update. This
1390 * list may be updated, removing updated elements.
1391 *
1392 * The update is done in two passes:
1393 * 1) walking the current tree, update tags that still exist and remove the
1394 * obsolescent ones;
1395 * 2) walking the remaining (non updated) tags, adds them in the list.
1396 *
1397 * For better performances, we use 2 hash tables:
1398 * - one containing all the tags for lookup in the first pass (actually stores a
1399 * reference in the tags list for removing it efficiently), avoiding list search
1400 * on each tag;
1401 * - the other holding "tag-name":row references for tags having children, used to
1402 * lookup for a parent in both passes, avoiding tree traversal.
1403 */
1404 static void update_tree_tags(GeanyDocument *doc, GList **tags)
1405 {
1406 GtkTreeStore *store = doc->priv->tag_store;
1407 GtkTreeModel *model = GTK_TREE_MODEL(store);
1408 GHashTable *parents_table;
1409 GHashTable *tags_table;
1410 GtkTreeIter iter;
1411 gboolean cont;
1412 GList *item;
1413
1414 /* Build hash tables holding tags and parents */
1415 /* parent table holds "tag-name":GtkTreeIter */
1416 parents_table = g_hash_table_new_full(g_str_hash, g_str_equal, NULL, free_iter_slice_list);
1417 /* tags table is another representation of the @tags list, TMTag:GList<TMTag> */
1418 tags_table = g_hash_table_new_full(tag_hash, tag_equal, NULL, NULL);
1419 foreach_list(item, *tags)
1420 {
1421 TMTag *tag = item->data;
1422 const gchar *name;
1423
1424 tags_table_insert(tags_table, tag, item);
1425
1426 name = get_parent_name(tag, doc->file_type->id);
1427 if (name)
1428 g_hash_table_insert(parents_table, (gpointer) name, NULL);
1429 }
1430
1431 /* First pass, update existing rows or delete them.
1432 * It is OK to delete them since we walk top down so we would remove
1433 * parents before checking for their children, thus never implicitly
1434 * deleting an updated child */
1435 cont = gtk_tree_model_get_iter_first(model, &iter);
1436 while (cont)
1437 {
1438 TMTag *tag;
1439
1440 gtk_tree_model_get(model, &iter, SYMBOLS_COLUMN_TAG, &tag, -1);
1441 if (! tag) /* most probably a toplevel, skip it */
1442 cont = ui_tree_model_iter_any_next(model, &iter, TRUE);
1443 else
1444 {
1445 GList *found_item;
1446
1447 found_item = tags_table_lookup(tags_table, tag);
1448 if (! found_item) /* tag doesn't exist, remove it */
1449 cont = tree_store_remove_row(store, &iter);
1450 else /* tag still exist, update it */
1451 {
1452 const gchar *parent_name;
1453 TMTag *found = found_item->data;
1454
1455 parent_name = get_parent_name(found, doc->file_type->id);
1456 /* if parent is unknown, ignore it */
1457 if (parent_name && ! g_hash_table_lookup(parents_table, parent_name))
1458 parent_name = NULL;
1459
1460 if (!tm_tags_equal(tag, found))
1461 {
1462 const gchar *name;
1463 gchar *tooltip;
1464
1465 /* only update fields that (can) have changed (name that holds line
1466 * number, tooltip, and the tag itself) */
1467 name = get_symbol_name(doc, found, parent_name != NULL);
1468 tooltip = get_symbol_tooltip(doc, found);
1469 gtk_tree_store_set(store, &iter,
1470 SYMBOLS_COLUMN_NAME, name,
1471 SYMBOLS_COLUMN_TOOLTIP, tooltip,
1472 SYMBOLS_COLUMN_TAG, found,
1473 -1);
1474 g_free(tooltip);
1475 }
1476
1477 update_parents_table(parents_table, found, parent_name, &iter);
1478
1479 /* remove the updated tag from the table and list */
1480 tags_table_remove(tags_table, found);
1481 *tags = g_list_delete_link(*tags, found_item);
1482
1483 cont = ui_tree_model_iter_any_next(model, &iter, TRUE);
1484 }
1485
1486 tm_tag_unref(tag);
1487 }
1488 }
1489
1490 /* Second pass, now we have a tree cleaned up from invalid rows,
1491 * we simply add new ones */
1492 foreach_list (item, *tags)
1493 {
1494 TMTag *tag = item->data;
1495 GtkTreeIter *parent;
1496
1497 parent = get_tag_type_iter(tag->type);
1498 if (G_UNLIKELY(! parent))
1499 geany_debug("Missing symbol-tree parent iter for type %d!", tag->type);
1500 else
1501 {
1502 gboolean expand;
1503 const gchar *name;
1504 const gchar *parent_name;
1505 gchar *tooltip;
1506 GdkPixbuf *icon = get_child_icon(store, parent);
1507
1508 parent_name = get_parent_name(tag, doc->file_type->id);
1509 if (parent_name)
1510 {
1511 GList **candidates;
1512 GtkTreeIter *parent_search = NULL;
1513
1514 /* walk parent candidates to find the better one.
1515 * if there are more than one, take the one that has the closest line number
1516 * after the tag we're searching the parent for */
1517 candidates = g_hash_table_lookup(parents_table, parent_name);
1518 if (candidates)
1519 {
1520 GList *node;
1521 glong delta = G_MAXLONG;
1522 foreach_list(node, *candidates)
1523 {
1524 TMTag *parent_tag;
1525 glong d;
1526
1527 gtk_tree_model_get(GTK_TREE_MODEL(store), node->data,
1528 SYMBOLS_COLUMN_TAG, &parent_tag, -1);
1529
1530 d = tag->line - parent_tag->line;
1531 if (! parent_search || (d >= 0 && d < delta))
1532 {
1533 delta = d;
1534 parent_search = node->data;
1535 }
1536 tm_tag_unref(parent_tag);
1537 }
1538 }
1539
1540 if (parent_search)
1541 parent = parent_search;
1542 else
1543 parent_name = NULL;
1544 }
1545
1546 /* only expand to the iter if the parent was empty, otherwise we let the
1547 * folding as it was before (already expanded, or closed by the user) */
1548 expand = ! gtk_tree_model_iter_has_child(model, parent);
1549
1550 /* insert the new element */
1551 name = get_symbol_name(doc, tag, parent_name != NULL);
1552 tooltip = get_symbol_tooltip(doc, tag);
1553 gtk_tree_store_insert_with_values(store, &iter, parent, 0,
1554 SYMBOLS_COLUMN_NAME, name,
1555 SYMBOLS_COLUMN_TOOLTIP, tooltip,
1556 SYMBOLS_COLUMN_ICON, icon,
1557 SYMBOLS_COLUMN_TAG, tag,
1558 -1);
1559 g_free(tooltip);
1560 if (G_LIKELY(icon))
1561 g_object_unref(icon);
1562
1563 update_parents_table(parents_table, tag, parent_name, &iter);
1564
1565 if (expand)
1566 tree_view_expand_to_iter(GTK_TREE_VIEW(doc->priv->tag_tree), &iter);
1567 }
1568 }
1569
1570 g_hash_table_destroy(parents_table);
1571 tags_table_destroy(tags_table);
1572 }
1573
1574
1575 /* we don't want to sort 1st-level nodes, but we can't return 0 because the tree sort
1576 * is not stable, so the order is already lost. */
1577 static gint compare_top_level_names(const gchar *a, const gchar *b)
1578 {
1579 guint i;
1580 const gchar *name;
1581
1582 /* This should never happen as it would mean that two or more top
1583 * level items have the same name but it can happen by typos in the translations. */
1584 if (utils_str_equal(a, b))
1585 return 1;
1586
1587 foreach_ptr_array(name, i, top_level_iter_names)
1588 {
1589 if (utils_str_equal(name, a))
1590 return -1;
1591 if (utils_str_equal(name, b))
1592 return 1;
1593 }
1594 g_warning("Couldn't find top level node '%s' or '%s'!", a, b);
1595 return 0;
1596 }
1597
1598
1599 static gboolean tag_has_missing_parent(const TMTag *tag, GtkTreeStore *store,
1600 GtkTreeIter *iter)
1601 {
1602 /* if the tag has a parent tag, it should be at depth >= 2 */
1603 return !EMPTY(tag->scope) &&
1604 gtk_tree_store_iter_depth(store, iter) == 1;
1605 }
1606
1607
1608 static gint tree_sort_func(GtkTreeModel *model, GtkTreeIter *a, GtkTreeIter *b,
1609 gpointer user_data)
1610 {
1611 gboolean sort_by_name = GPOINTER_TO_INT(user_data);
1612 TMTag *tag_a, *tag_b;
1613 gint cmp;
1614
1615 gtk_tree_model_get(model, a, SYMBOLS_COLUMN_TAG, &tag_a, -1);
1616 gtk_tree_model_get(model, b, SYMBOLS_COLUMN_TAG, &tag_b, -1);
1617
1618 /* Check if the iters can be sorted based on tag name and line, not tree item name.
1619 * Sort by tree name if the scope was prepended, e.g. 'ScopeNameWithNoTag::TagName'. */
1620 if (tag_a && !tag_has_missing_parent(tag_a, GTK_TREE_STORE(model), a) &&
1621 tag_b && !tag_has_missing_parent(tag_b, GTK_TREE_STORE(model), b))
1622 {
1623 cmp = sort_by_name ? compare_symbol(tag_a, tag_b) :
1624 compare_symbol_lines(tag_a, tag_b);
1625 }
1626 else
1627 {
1628 gchar *astr, *bstr;
1629
1630 gtk_tree_model_get(model, a, SYMBOLS_COLUMN_NAME, &astr, -1);
1631 gtk_tree_model_get(model, b, SYMBOLS_COLUMN_NAME, &bstr, -1);
1632
1633 /* if a is toplevel, b must be also */
1634 if (gtk_tree_store_iter_depth(GTK_TREE_STORE(model), a) == 0)
1635 {
1636 cmp = compare_top_level_names(astr, bstr);
1637 }
1638 else
1639 {
1640 /* this is what g_strcmp0() does */
1641 if (! astr)
1642 cmp = -(astr != bstr);
1643 else if (! bstr)
1644 cmp = astr != bstr;
1645 else
1646 {
1647 cmp = strcmp(astr, bstr);
1648
1649 /* sort duplicate 'ScopeName::OverloadedTagName' items by line as well */
1650 if (tag_a && tag_b)
1651 if (!sort_by_name ||
1652 (utils_str_equal(tag_a->name, tag_b->name) &&
1653 utils_str_equal(tag_a->scope, tag_b->scope)))
1654 cmp = compare_symbol_lines(tag_a, tag_b);
1655 }
1656 }
1657 g_free(astr);
1658 g_free(bstr);
1659 }
1660 tm_tag_unref(tag_a);
1661 tm_tag_unref(tag_b);
1662
1663 return cmp;
1664 }
1665
1666
1667 static void sort_tree(GtkTreeStore *store, gboolean sort_by_name)
1668 {
1669 gtk_tree_sortable_set_sort_func(GTK_TREE_SORTABLE(store), SYMBOLS_COLUMN_NAME, tree_sort_func,
1670 GINT_TO_POINTER(sort_by_name), NULL);
1671
1672 gtk_tree_sortable_set_sort_column_id(GTK_TREE_SORTABLE(store), SYMBOLS_COLUMN_NAME, GTK_SORT_ASCENDING);
1673 }
1674
1675
1676 gboolean symbols_recreate_tag_list(GeanyDocument *doc, gint sort_mode)
1677 {
1678 GList *tags;
1679
1680 g_return_val_if_fail(DOC_VALID(doc), FALSE);
1681
1682 tags = get_tag_list(doc, tm_tag_max_t);
1683 if (tags == NULL)
1684 return FALSE;
1685
1686 /* FIXME: Not sure why we detached the model here? */
1687
1688 /* disable sorting during update because the code doesn't support correctly
1689 * models that are currently being built */
1690 gtk_tree_sortable_set_sort_column_id(GTK_TREE_SORTABLE(doc->priv->tag_store), GTK_TREE_SORTABLE_UNSORTED_SORT_COLUMN_ID, 0);
1691
1692 /* add grandparent type iters */
1693 add_top_level_items(doc);
1694
1695 update_tree_tags(doc, &tags);
1696 g_list_free(tags);
1697
1698 hide_empty_rows(doc->priv->tag_store);
1699
1700 if (sort_mode == SYMBOLS_SORT_USE_PREVIOUS)
1701 sort_mode = doc->priv->symbol_list_sort_mode;
1702
1703 sort_tree(doc->priv->tag_store, sort_mode == SYMBOLS_SORT_BY_NAME);
1704 doc->priv->symbol_list_sort_mode = sort_mode;
1705
1706 return TRUE;
1707 }
1708
1709
1710 /* Detects a global tags filetype from the *.lang.* language extension.
1711 * Returns NULL if there was no matching TM language. */
1712 static GeanyFiletype *detect_global_tags_filetype(const gchar *utf8_filename)
1713 {
1714 gchar *tags_ext;
1715 gchar *shortname = utils_strdupa(utf8_filename);
1716 GeanyFiletype *ft = NULL;
1717
1718 tags_ext = g_strrstr(shortname, ".tags");
1719 if (tags_ext)
1720 {
1721 *tags_ext = '\0'; /* remove .tags extension */
1722 ft = filetypes_detect_from_extension(shortname);
1723 if (ft->id != GEANY_FILETYPES_NONE)
1724 return ft;
1725 }
1726 return NULL;
1727 }
1728
1729
1730 /* Adapted from anjuta-2.0.2/global-tags/tm_global_tags.c, thanks.
1731 * Needs full paths for filenames, except for C/C++ tag files, when CFLAGS includes
1732 * the relevant path.
1733 * Example:
1734 * CFLAGS=-I/home/user/libname-1.x geany -g libname.d.tags libname.h */
1735 int symbols_generate_global_tags(int argc, char **argv, gboolean want_preprocess)
1736 {
1737 /* -E pre-process, -dD output user macros, -p prof info (?) */
1738 const char pre_process[] = "gcc -E -dD -p -I.";
1739
1740 if (argc > 2)
1741 {
1742 /* Create global taglist */
1743 int status;
1744 char *command;
1745 const char *tags_file = argv[1];
1746 char *utf8_fname;
1747 GeanyFiletype *ft;
1748
1749 utf8_fname = utils_get_utf8_from_locale(tags_file);
1750 ft = detect_global_tags_filetype(utf8_fname);
1751 g_free(utf8_fname);
1752
1753 if (ft == NULL)
1754 {
1755 g_printerr(_("Unknown filetype extension for \"%s\".\n"), tags_file);
1756 return 1;
1757 }
1758 /* load config in case of custom filetypes */
1759 filetypes_load_config(ft->id, FALSE);
1760
1761 /* load ignore list for C/C++ parser */
1762 if (ft->id == GEANY_FILETYPES_C || ft->id == GEANY_FILETYPES_CPP)
1763 load_c_ignore_tags();
1764
1765 if (want_preprocess && (ft->id == GEANY_FILETYPES_C || ft->id == GEANY_FILETYPES_CPP))
1766 {
1767 const gchar *cflags = getenv("CFLAGS");
1768 command = g_strdup_printf("%s %s", pre_process, FALLBACK(cflags, ""));
1769 }
1770 else
1771 command = NULL; /* don't preprocess */
1772
1773 geany_debug("Generating %s tags file.", ft->name);
1774 tm_get_workspace();
1775 status = tm_workspace_create_global_tags(command, (const char **) (argv + 2),
1776 argc - 2, tags_file, ft->lang);
1777 g_free(command);
1778 symbols_finalize(); /* free c_tags_ignore data */
1779 if (! status)
1780 {
1781 g_printerr(_("Failed to create tags file, perhaps because no tags "
1782 "were found.\n"));
1783 return 1;
1784 }
1785 }
1786 else
1787 {
1788 g_printerr(_("Usage: %s -g <Tag File> <File list>\n\n"), argv[0]);
1789 g_printerr(_("Example:\n"
1790 "CFLAGS=`pkg-config gtk+-2.0 --cflags` %s -g gtk2.c.tags"
1791 " /usr/include/gtk-2.0/gtk/gtk.h\n"), argv[0]);
1792 return 1;
1793 }
1794 return 0;
1795 }
1796
1797
1798 void symbols_show_load_tags_dialog(void)
1799 {
1800 GtkWidget *dialog;
1801 GtkFileFilter *filter;
1802
1803 dialog = gtk_file_chooser_dialog_new(_("Load Tags"), GTK_WINDOW(main_widgets.window),
1804 GTK_FILE_CHOOSER_ACTION_OPEN,
1805 GTK_STOCK_CANCEL, GTK_RESPONSE_CANCEL,
1806 GTK_STOCK_OPEN, GTK_RESPONSE_OK,
1807 NULL);
1808 gtk_widget_set_name(dialog, "GeanyDialog");
1809 filter = gtk_file_filter_new();
1810 gtk_file_filter_set_name(filter, _("Geany tag files (*.*.tags)"));
1811 gtk_file_filter_add_pattern(filter, "*.*.tags");
1812 gtk_file_chooser_add_filter(GTK_FILE_CHOOSER(dialog), filter);
1813
1814 if (gtk_dialog_run(GTK_DIALOG(dialog)) == GTK_RESPONSE_OK)
1815 {
1816 GSList *flist = gtk_file_chooser_get_filenames(GTK_FILE_CHOOSER(dialog));
1817 GSList *item;
1818
1819 for (item = flist; item != NULL; item = g_slist_next(item))
1820 {
1821 gchar *fname = item->data;
1822 gchar *utf8_fname;
1823 GeanyFiletype *ft;
1824
1825 utf8_fname = utils_get_utf8_from_locale(fname);
1826 ft = detect_global_tags_filetype(utf8_fname);
1827
1828 if (ft != NULL && symbols_load_global_tags(fname, ft))
1829 /* For translators: the first wildcard is the filetype, the second the filename */
1830 ui_set_statusbar(TRUE, _("Loaded %s tags file '%s'."),
1831 filetypes_get_display_name(ft), utf8_fname);
1832 else
1833 ui_set_statusbar(TRUE, _("Could not load tags file '%s'."), utf8_fname);
1834
1835 g_free(utf8_fname);
1836 g_free(fname);
1837 }
1838 g_slist_free(flist);
1839 }
1840 gtk_widget_destroy(dialog);
1841 }
1842
1843
1844 static void init_user_tags(void)
1845 {
1846 GSList *file_list = NULL, *list = NULL;
1847 const GSList *node;
1848 gchar *dir;
1849
1850 dir = g_build_filename(app->configdir, "tags", NULL);
1851 /* create the user tags dir for next time if it doesn't exist */
1852 if (! g_file_test(dir, G_FILE_TEST_IS_DIR))
1853 utils_mkdir(dir, FALSE);
1854 file_list = utils_get_file_list_full(dir, TRUE, FALSE, NULL);
1855
1856 SETPTR(dir, g_build_filename(app->datadir, "tags", NULL));
1857 list = utils_get_file_list_full(dir, TRUE, FALSE, NULL);
1858 g_free(dir);
1859
1860 file_list = g_slist_concat(file_list, list);
1861
1862 /* populate the filetype-specific tag files lists */
1863 for (node = file_list; node != NULL; node = node->next)
1864 {
1865 gchar *fname = node->data;
1866 gchar *utf8_fname = utils_get_utf8_from_locale(fname);
1867 GeanyFiletype *ft = detect_global_tags_filetype(utf8_fname);
1868
1869 g_free(utf8_fname);
1870
1871 if (FILETYPE_ID(ft) != GEANY_FILETYPES_NONE)
1872 ft->priv->tag_files = g_slist_prepend(ft->priv->tag_files, fname);
1873 else
1874 {
1875 geany_debug("Unknown filetype for file '%s'.", fname);
1876 g_free(fname);
1877 }
1878 }
1879
1880 /* don't need to delete list contents because they are now stored in
1881 * ft->priv->tag_files */
1882 g_slist_free(file_list);
1883 }
1884
1885
1886 static void load_user_tags(filetype_id ft_id)
1887 {
1888 static guchar *tags_loaded = NULL;
1889 static gboolean init_tags = FALSE;
1890 const GSList *node;
1891 GeanyFiletype *ft = filetypes[ft_id];
1892
1893 g_return_if_fail(ft_id > 0);
1894
1895 if (!tags_loaded)
1896 tags_loaded = g_new0(guchar, filetypes_array->len);
1897 if (tags_loaded[ft_id])
1898 return;
1899 tags_loaded[ft_id] = TRUE; /* prevent reloading */
1900
1901 if (!init_tags)
1902 {
1903 init_user_tags();
1904 init_tags = TRUE;
1905 }
1906
1907 for (node = ft->priv->tag_files; node != NULL; node = g_slist_next(node))
1908 {
1909 const gchar *fname = node->data;
1910
1911 symbols_load_global_tags(fname, ft);
1912 }
1913 }
1914
1915
1916 static gboolean goto_tag(const gchar *name, gboolean definition)
1917 {
1918 const TMTagType forward_types = tm_tag_prototype_t | tm_tag_externvar_t;
1919 TMTagType type;
1920 TMTag *tmtag = NULL;
1921 GeanyDocument *old_doc = document_get_current();
1922
1923 /* goto tag definition: all except prototypes / forward declarations / externs */
1924 type = (definition) ? tm_tag_max_t - forward_types : forward_types;
1925
1926 /* first look in the current document */
1927 if (old_doc != NULL && old_doc->tm_file)
1928 tmtag = find_source_file_tag(old_doc->tm_file->tags_array, name, type);
1929
1930 /* if not found, look in the workspace */
1931 if (tmtag == NULL)
1932 tmtag = find_workspace_tag(name, type);
1933
1934 if (tmtag != NULL)
1935 {
1936 GeanyDocument *new_doc = document_find_by_real_path(
1937 tmtag->file->file_name);
1938
1939 if (new_doc)
1940 {
1941 /* If we are already on the tag line, swap definition/declaration */
1942 if (new_doc == old_doc &&
1943 tmtag->line == (guint)sci_get_current_line(old_doc->editor->sci) + 1)
1944 {
1945 if (goto_tag(name, !definition))
1946 return TRUE;
1947 }
1948 }
1949 else
1950 {
1951 /* not found in opened document, should open */
1952 new_doc = document_open_file(tmtag->file->file_name, FALSE, NULL, NULL);
1953 }
1954
1955 if (navqueue_goto_line(old_doc, new_doc, tmtag->line))
1956 return TRUE;
1957 }
1958 return FALSE;
1959 }
1960
1961
1962 gboolean symbols_goto_tag(const gchar *name, gboolean definition)
1963 {
1964 if (goto_tag(name, definition))
1965 return TRUE;
1966
1967 /* if we are here, there was no match and we are beeping ;-) */
1968 utils_beep();
1969
1970 if (!definition)
1971 ui_set_statusbar(FALSE, _("Forward declaration \"%s\" not found."), name);
1972 else
1973 ui_set_statusbar(FALSE, _("Definition of \"%s\" not found."), name);
1974 return FALSE;
1975 }
1976
1977
1978 /* This could perhaps be improved to check for #if, class etc. */
1979 static gint get_function_fold_number(GeanyDocument *doc)
1980 {
1981 /* for Java the functions are always one fold level above the class scope */
1982 if (doc->file_type->id == GEANY_FILETYPES_JAVA)
1983 return SC_FOLDLEVELBASE + 1;
1984 else
1985 return SC_FOLDLEVELBASE;
1986 }
1987
1988
1989 /* Should be used only with get_current_tag_cached.
1990 * tag_types caching might trigger recomputation too often but this isn't used differently often
1991 * enough to be an issue for now */
1992 static gboolean current_tag_changed(GeanyDocument *doc, gint cur_line, gint fold_level, guint tag_types)
1993 {
1994 static gint old_line = -2;
1995 static GeanyDocument *old_doc = NULL;
1996 static gint old_fold_num = -1;
1997 static guint old_tag_types = 0;
1998 const gint fold_num = fold_level & SC_FOLDLEVELNUMBERMASK;
1999 gboolean ret;
2000
2001 /* check if the cached line and file index have changed since last time: */
2002 if (doc == NULL || doc != old_doc || old_tag_types != tag_types)
2003 ret = TRUE;
2004 else if (cur_line == old_line)
2005 ret = FALSE;
2006 else
2007 {
2008 /* if the line has only changed by 1 */
2009 if (abs(cur_line - old_line) == 1)
2010 {
2011 /* It's the same function if the fold number hasn't changed */
2012 ret = (fold_num != old_fold_num);
2013 }
2014 else ret = TRUE;
2015 }
2016
2017 /* record current line and file index for next time */
2018 old_line = cur_line;
2019 old_doc = doc;
2020 old_fold_num = fold_num;
2021 old_tag_types = tag_types;
2022 return ret;
2023 }
2024
2025
2026 /* Parse the function name up to 2 lines before tag_line.
2027 * C++ like syntax should be parsed by parse_cpp_function_at_line, otherwise the return
2028 * type or argument names can be confused with the function name. */
2029 static gchar *parse_function_at_line(ScintillaObject *sci, gint tag_line)
2030 {
2031 gint start, end, max_pos;
2032 gint fn_style;
2033
2034 switch (sci_get_lexer(sci))
2035 {
2036 case SCLEX_RUBY: fn_style = SCE_RB_DEFNAME; break;
2037 case SCLEX_PYTHON: fn_style = SCE_P_DEFNAME; break;
2038 default: fn_style = SCE_C_IDENTIFIER; /* several lexers use SCE_C_IDENTIFIER */
2039 }
2040 start = sci_get_position_from_line(sci, tag_line - 2);
2041 max_pos = sci_get_position_from_line(sci, tag_line + 1);
2042 while (start < max_pos && sci_get_style_at(sci, start) != fn_style)
2043 start++;
2044
2045 end = start;
2046 while (end < max_pos && sci_get_style_at(sci, end) == fn_style)
2047 end++;
2048
2049 if (start == end)
2050 return NULL;
2051 return sci_get_contents_range(sci, start, end);
2052 }
2053
2054
2055 /* Parse the function name */
2056 static gchar *parse_cpp_function_at_line(ScintillaObject *sci, gint tag_line)
2057 {
2058 gint start, end, first_pos, max_pos;
2059 gint tmp;
2060 gchar c;
2061
2062 first_pos = end = sci_get_position_from_line(sci, tag_line);
2063 max_pos = sci_get_position_from_line(sci, tag_line + 1);
2064 tmp = 0;
2065 /* goto the begin of function body */
2066 while (end < max_pos &&
2067 (tmp = sci_get_char_at(sci, end)) != '{' &&
2068 tmp != 0) end++;
2069 if (tmp == 0) end --;
2070
2071 /* go back to the end of function identifier */
2072 while (end > 0 && end > first_pos - 500 &&
2073 (tmp = sci_get_char_at(sci, end)) != '(' &&
2074 tmp != 0) end--;
2075 end--;
2076 if (end < 0) end = 0;
2077
2078 /* skip whitespaces between identifier and ( */
2079 while (end > 0 && isspace(sci_get_char_at(sci, end))) end--;
2080
2081 start = end;
2082 /* Use tmp to find SCE_C_IDENTIFIER or SCE_C_GLOBALCLASS chars */
2083 while (start >= 0 && ((tmp = sci_get_style_at(sci, start)) == SCE_C_IDENTIFIER
2084 || tmp == SCE_C_GLOBALCLASS
2085 || (c = sci_get_char_at(sci, start)) == '~'
2086 || c == ':'))
2087 start--;
2088 if (start != 0 && start < end) start++; /* correct for last non-matching char */
2089
2090 if (start == end) return NULL;
2091 return sci_get_contents_range(sci, start, end + 1);
2092 }
2093
2094
2095 static gint get_fold_header_after(ScintillaObject *sci, gint line)
2096 {
2097 gint line_count = sci_get_line_count(sci);
2098
2099 for (; line < line_count; line++)
2100 {
2101 if (sci_get_fold_level(sci, line) & SC_FOLDLEVELHEADERFLAG)
2102 return line;
2103 }
2104
2105 return -1;
2106 }
2107
2108
2109 static gint get_current_tag_name(GeanyDocument *doc, gchar **tagname, TMTagType tag_types)
2110 {
2111 gint line;
2112 gint parent;
2113
2114 line = sci_get_current_line(doc->editor->sci);
2115 parent = sci_get_fold_parent(doc->editor->sci, line);
2116 /* if we're inside a fold level and we have up-to-date tags, get the function from TM */
2117 if (parent >= 0 && doc->tm_file != NULL && doc->tm_file->tags_array != NULL &&
2118 (! doc->changed || editor_prefs.autocompletion_update_freq > 0))
2119 {
2120 const TMTag *tag = tm_get_current_tag(doc->tm_file->tags_array, parent + 1, tag_types);
2121
2122 if (tag)
2123 {
2124 gint tag_line = tag->line - 1;
2125 gint last_child = line + 1;
2126
2127 /* if it may be a false positive because we're inside a fold level not inside anything
2128 * we match, e.g. a #if in C or C++, we check we're inside the fold level that start
2129 * right after the tag we got from TM */
2130 if (abs(tag_line - parent) > 1)
2131 {
2132 gint tag_fold = get_fold_header_after(doc->editor->sci, tag_line);
2133 if (tag_fold >= 0)
2134 last_child = scintilla_send_message(doc->editor->sci, SCI_GETLASTCHILD, tag_fold, -1);
2135 }
2136
2137 if (line <= last_child)
2138 {
2139 if (tag->scope)
2140 *tagname = g_strconcat(tag->scope,
2141 symbols_get_context_separator(doc->file_type->id), tag->name, NULL);
2142 else
2143 *tagname = g_strdup(tag->name);
2144
2145 return tag_line;
2146 }
2147 }
2148 }
2149 /* for the poor guy with a modified document and without real time tag parsing, we fallback
2150 * to dirty and inaccurate hand-parsing */
2151 else if (parent >= 0 && doc->file_type != NULL && doc->file_type->id != GEANY_FILETYPES_NONE)
2152 {
2153 const gint fn_fold = get_function_fold_number(doc);
2154 gint tag_line = parent;
2155 gint fold_level = sci_get_fold_level(doc->editor->sci, tag_line);
2156
2157 /* find the top level fold point */
2158 while (tag_line >= 0 && (fold_level & SC_FOLDLEVELNUMBERMASK) != fn_fold)
2159 {
2160 tag_line = sci_get_fold_parent(doc->editor->sci, tag_line);
2161 fold_level = sci_get_fold_level(doc->editor->sci, tag_line);
2162 }
2163
2164 if (tag_line >= 0)
2165 {
2166 gchar *cur_tag;
2167
2168 if (sci_get_lexer(doc->editor->sci) == SCLEX_CPP)
2169 cur_tag = parse_cpp_function_at_line(doc->editor->sci, tag_line);
2170 else
2171 cur_tag = parse_function_at_line(doc->editor->sci, tag_line);
2172
2173 if (cur_tag != NULL)
2174 {
2175 *tagname = cur_tag;
2176 return tag_line;
2177 }
2178 }
2179 }
2180
2181 *tagname = g_strdup(_("unknown"));
2182 return -1;
2183 }
2184
2185
2186 static gint get_current_tag_name_cached(GeanyDocument *doc, const gchar **tagname, TMTagType tag_types)
2187 {
2188 static gint tag_line = -1;
2189 static gchar *cur_tag = NULL;
2190
2191 g_return_val_if_fail(doc == NULL || doc->is_valid, -1);
2192
2193 if (doc == NULL) /* reset current function */
2194 {
2195 current_tag_changed(NULL, -1, -1, 0);
2196 g_free(cur_tag);
2197 cur_tag = g_strdup(_("unknown"));
2198 if (tagname != NULL)
2199 *tagname = cur_tag;
2200 tag_line = -1;
2201 }
2202 else
2203 {
2204 gint line = sci_get_current_line(doc->editor->sci);
2205 gint fold_level = sci_get_fold_level(doc->editor->sci, line);
2206
2207 if (current_tag_changed(doc, line, fold_level, tag_types))
2208 {
2209 g_free(cur_tag);
2210 tag_line = get_current_tag_name(doc, &cur_tag, tag_types);
2211 }
2212 *tagname = cur_tag;
2213 }
2214
2215 return tag_line;
2216 }
2217
2218
2219 /* Sets *tagname to point at the current function or tag name.
2220 * If doc is NULL, reset the cached current tag data to ensure it will be reparsed on the next
2221 * call to this function.
2222 * Returns: line number of the current tag, or -1 if unknown. */
2223 gint symbols_get_current_function(GeanyDocument *doc, const gchar **tagname)
2224 {
2225 return get_current_tag_name_cached(doc, tagname, tm_tag_function_t | tm_tag_method_t);
2226 }
2227
2228
2229 /* same as symbols_get_current_function() but finds class, namespaces and more */
2230 gint symbols_get_current_scope(GeanyDocument *doc, const gchar **tagname)
2231 {
2232 TMTagType tag_types = (tm_tag_function_t | tm_tag_method_t | tm_tag_class_t |
2233 tm_tag_struct_t | tm_tag_enum_t | tm_tag_union_t);
2234
2235 /* Python parser reports imports as namespaces which confuses the scope detection */
2236 if (doc && doc->file_type->lang != filetypes[GEANY_FILETYPES_PYTHON]->lang)
2237 tag_types |= tm_tag_namespace_t;
2238
2239 return get_current_tag_name_cached(doc, tagname, tag_types);
2240 }
2241
2242
2243 static void on_symbol_tree_sort_clicked(GtkMenuItem *menuitem, gpointer user_data)
2244 {
2245 gint sort_mode = GPOINTER_TO_INT(user_data);
2246 GeanyDocument *doc = document_get_current();
2247
2248 if (ignore_callback)
2249 return;
2250
2251 if (doc != NULL)
2252 doc->has_tags = symbols_recreate_tag_list(doc, sort_mode);
2253 }
2254
2255
2256 static void on_symbol_tree_menu_show(GtkWidget *widget,
2257 gpointer user_data)
2258 {
2259 GeanyDocument *doc = document_get_current();
2260 gboolean enable;
2261
2262 enable = doc && doc->has_tags;
2263 gtk_widget_set_sensitive(symbol_menu.sort_by_name, enable);
2264 gtk_widget_set_sensitive(symbol_menu.sort_by_appearance, enable);
2265 gtk_widget_set_sensitive(symbol_menu.expand_all, enable);
2266 gtk_widget_set_sensitive(symbol_menu.collapse_all, enable);
2267 gtk_widget_set_sensitive(symbol_menu.find_usage, enable);
2268 gtk_widget_set_sensitive(symbol_menu.find_doc_usage, enable);
2269
2270 if (! doc)
2271 return;
2272
2273 ignore_callback = TRUE;
2274
2275 if (doc->priv->symbol_list_sort_mode == SYMBOLS_SORT_BY_NAME)
2276 gtk_check_menu_item_set_active(GTK_CHECK_MENU_ITEM(symbol_menu.sort_by_name), TRUE);
2277 else
2278 gtk_check_menu_item_set_active(GTK_CHECK_MENU_ITEM(symbol_menu.sort_by_appearance), TRUE);
2279
2280 ignore_callback = FALSE;
2281 }
2282
2283
2284 static void on_expand_collapse(GtkWidget *widget, gpointer user_data)
2285 {
2286 gboolean expand = GPOINTER_TO_INT(user_data);
2287 GeanyDocument *doc = document_get_current();
2288
2289 if (! doc)
2290 return;
2291
2292 g_return_if_fail(doc->priv->tag_tree);
2293
2294 if (expand)
2295 gtk_tree_view_expand_all(GTK_TREE_VIEW(doc->priv->tag_tree));
2296 else
2297 gtk_tree_view_collapse_all(GTK_TREE_VIEW(doc->priv->tag_tree));
2298 }
2299
2300
2301 static void on_find_usage(GtkWidget *widget, G_GNUC_UNUSED gpointer unused)
2302 {
2303 GtkTreeIter iter;
2304 GtkTreeSelection *selection;
2305 GtkTreeModel *model;
2306 GeanyDocument *doc;
2307 TMTag *tag = NULL;
2308
2309 doc = document_get_current();
2310 if (!doc)
2311 return;
2312
2313 selection = gtk_tree_view_get_selection(GTK_TREE_VIEW(doc->priv->tag_tree));
2314 if (gtk_tree_selection_get_selected(selection, &model, &iter))
2315 gtk_tree_model_get(model, &iter, SYMBOLS_COLUMN_TAG, &tag, -1);
2316 if (tag)
2317 {
2318 if (widget == symbol_menu.find_in_files)
2319 search_show_find_in_files_dialog_full(tag->name, NULL);
2320 else
2321 search_find_usage(tag->name, tag->name, GEANY_FIND_WHOLEWORD | GEANY_FIND_MATCHCASE,
2322 widget == symbol_menu.find_usage);
2323
2324 tm_tag_unref(tag);
2325 }
2326 }
2327
2328
2329 static void create_taglist_popup_menu(void)
2330 {
2331 GtkWidget *item, *menu;
2332
2333 tv.popup_taglist = menu = gtk_menu_new();
2334
2335 symbol_menu.expand_all = item = ui_image_menu_item_new(GTK_STOCK_ADD, _("_Expand All"));
2336 gtk_widget_show(item);
2337 gtk_container_add(GTK_CONTAINER(menu), item);
2338 g_signal_connect(item, "activate", G_CALLBACK(on_expand_collapse), GINT_TO_POINTER(TRUE));
2339
2340 symbol_menu.collapse_all = item = ui_image_menu_item_new(GTK_STOCK_REMOVE, _("_Collapse All"));
2341 gtk_widget_show(item);
2342 gtk_container_add(GTK_CONTAINER(menu), item);
2343 g_signal_connect(item, "activate", G_CALLBACK(on_expand_collapse), GINT_TO_POINTER(FALSE));
2344
2345 item = gtk_separator_menu_item_new();
2346 gtk_widget_show(item);
2347 gtk_container_add(GTK_CONTAINER(menu), item);
2348
2349 symbol_menu.sort_by_name = item = gtk_radio_menu_item_new_with_mnemonic(NULL,
2350 _("Sort by _Name"));
2351 gtk_widget_show(item);
2352 gtk_container_add(GTK_CONTAINER(menu), item);
2353 g_signal_connect(item, "activate", G_CALLBACK(on_symbol_tree_sort_clicked),
2354 GINT_TO_POINTER(SYMBOLS_SORT_BY_NAME));
2355
2356 symbol_menu.sort_by_appearance = item = gtk_radio_menu_item_new_with_mnemonic_from_widget(
2357 GTK_RADIO_MENU_ITEM(item), _("Sort by _Appearance"));
2358 gtk_widget_show(item);
2359 gtk_container_add(GTK_CONTAINER(menu), item);
2360 g_signal_connect(item, "activate", G_CALLBACK(on_symbol_tree_sort_clicked),
2361 GINT_TO_POINTER(SYMBOLS_SORT_BY_APPEARANCE));
2362
2363 item = gtk_separator_menu_item_new();
2364 gtk_widget_show(item);
2365 gtk_container_add(GTK_CONTAINER(menu), item);
2366
2367 symbol_menu.find_usage = item = ui_image_menu_item_new(GTK_STOCK_FIND, _("Find _Usage"));
2368 gtk_widget_show(item);
2369 gtk_container_add(GTK_CONTAINER(menu), item);
2370 g_signal_connect(item, "activate", G_CALLBACK(on_find_usage), symbol_menu.find_usage);
2371
2372 symbol_menu.find_doc_usage = item = ui_image_menu_item_new(GTK_STOCK_FIND, _("Find _Document Usage"));
2373 gtk_widget_show(item);
2374 gtk_container_add(GTK_CONTAINER(menu), item);
2375 g_signal_connect(item, "activate", G_CALLBACK(on_find_usage), symbol_menu.find_doc_usage);
2376
2377 symbol_menu.find_in_files = item = ui_image_menu_item_new(GTK_STOCK_FIND, _("Find in F_iles..."));
2378 gtk_widget_show(item);
2379 gtk_container_add(GTK_CONTAINER(menu), item);
2380 g_signal_connect(item, "activate", G_CALLBACK(on_find_usage), NULL);
2381
2382 g_signal_connect(menu, "show", G_CALLBACK(on_symbol_tree_menu_show), NULL);
2383
2384 sidebar_add_common_menu_items(GTK_MENU(menu));
2385 }
2386
2387
2388 static void on_document_save(G_GNUC_UNUSED GObject *object, GeanyDocument *doc)
2389 {
2390 gchar *f;
2391
2392 g_return_if_fail(!EMPTY(doc->real_path));
2393
2394 f = g_build_filename(app->configdir, "ignore.tags", NULL);
2395 if (utils_str_equal(doc->real_path, f))
2396 load_c_ignore_tags();
2397
2398 g_free(f);
2399 }
2400
2401
2402 void symbols_init(void)
2403 {
2404 gchar *f;
2405 guint i;
2406
2407 create_taglist_popup_menu();
2408
2409 f = g_build_filename(app->configdir, "ignore.tags", NULL);
2410 ui_add_config_file_menu_item(f, NULL, NULL);
2411 g_free(f);
2412
2413 g_signal_connect(geany_object, "document-save", G_CALLBACK(on_document_save), NULL);
2414
2415 for (i = 0; i < G_N_ELEMENTS(symbols_icons); i++)
2416 symbols_icons[i].pixbuf = get_tag_icon(symbols_icons[i].icon_name);
2417 }
2418
2419
2420 void symbols_finalize(void)
2421 {
2422 guint i;
2423
2424 g_strfreev(html_entities);
2425 g_strfreev(c_tags_ignore);
2426
2427 for (i = 0; i < G_N_ELEMENTS(symbols_icons); i++)
2428 {
2429 if (symbols_icons[i].pixbuf)
2430 g_object_unref(symbols_icons[i].pixbuf);
2431 }
2432 }
A fast and lightweight IDE