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