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