2 * symbols.c - this file is part of Geany, a fast and lightweight IDE
4 * Copyright 2006 The Geany contributors
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License along
17 * with this program; if not, write to the Free Software Foundation, Inc.,
18 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
23 * Tag-related functions.
27 * Symbol Tree and TagManager-related convenience functions.
28 * TagManager parses tags for each document, and also adds them to the workspace (session).
29 * Global tags are lists of tags for each filetype, loaded when a document with a
30 * matching filetype is first loaded.
40 #include "callbacks.h" /* FIXME: for ignore_callback */
41 #include "documentprivate.h"
43 #include "encodings.h"
44 #include "filetypesprivate.h"
45 #include "geanyobject.h"
46 #include "highlighting.h"
49 #include "sciwrappers.h"
52 #include "tm_parser.h"
68 gint found_line
; /* return: the nearest line found */
69 gint line
; /* input: the line to look for */
70 gboolean lower
/* input: search only for lines with lower number than @line */;
74 static GPtrArray
*top_level_iter_names
= NULL
;
92 const gchar
*icon_name
;
95 symbols_icons
[N_ICONS
] = {
96 [ICON_CLASS
] = { "classviewer-class", NULL
},
97 [ICON_MACRO
] = { "classviewer-macro", NULL
},
98 [ICON_MEMBER
] = { "classviewer-member", NULL
},
99 [ICON_METHOD
] = { "classviewer-method", NULL
},
100 [ICON_NAMESPACE
] = { "classviewer-namespace", NULL
},
101 [ICON_OTHER
] = { "classviewer-other", NULL
},
102 [ICON_STRUCT
] = { "classviewer-struct", NULL
},
103 [ICON_VAR
] = { "classviewer-var", NULL
},
108 GtkWidget
*expand_all
;
109 GtkWidget
*collapse_all
;
110 GtkWidget
*sort_by_name
;
111 GtkWidget
*sort_by_appearance
;
112 GtkWidget
*find_usage
;
113 GtkWidget
*find_doc_usage
;
114 GtkWidget
*find_in_files
;
118 static void load_user_tags(GeanyFiletypeID ft_id
);
120 /* get the tags_ignore list, exported by geany_lcpp.c */
121 extern gchar
**c_tags_ignore
;
123 /* ignore certain tokens when parsing C-like syntax.
124 * Also works for reloading. */
125 static void load_c_ignore_tags(void)
127 gchar
*path
= g_build_filename(app
->configdir
, "ignore.tags", NULL
);
130 if (g_file_get_contents(path
, &content
, NULL
, NULL
))
134 /* historically we ignore the glib _DECLS for tag generation */
135 SETPTR(content
, g_strconcat("G_BEGIN_DECLS G_END_DECLS\n", content
, NULL
));
137 g_strfreev(c_tags_ignore
);
138 tm_ctags_clear_ignore_symbols();
140 /* for old c.c parser */
141 c_tags_ignore
= g_strsplit_set(content
, " \n\r", -1);
142 /* for new cxx parser */
143 foreach_strv(line
, c_tags_ignore
)
145 tm_ctags_add_ignore_symbol(*line
);
154 void symbols_reload_config_files(void)
156 load_c_ignore_tags();
160 static gsize
get_tag_count(void)
162 GPtrArray
*tags
= tm_get_workspace()->global_tags
;
163 gsize count
= tags
? tags
->len
: 0;
169 /* wrapper for tm_workspace_load_global_tags().
170 * note that the tag count only counts new global tags added - if a tag has the same name,
171 * currently it replaces the existing tag, so loading a file twice will say 0 tags the 2nd time. */
172 static gboolean
symbols_load_global_tags(const gchar
*tags_file
, GeanyFiletype
*ft
)
175 gsize old_tag_count
= get_tag_count();
177 result
= tm_workspace_load_global_tags(tags_file
, ft
->lang
);
180 geany_debug("Loaded %s (%s), %u symbol(s).", tags_file
, ft
->name
,
181 (guint
) (get_tag_count() - old_tag_count
));
187 /* Ensure that the global tags file(s) for the file_type_idx filetype is loaded.
188 * This provides autocompletion, calltips, etc. */
189 void symbols_global_tags_loaded(guint file_type_idx
)
191 /* load ignore list for C/C++ parser */
192 if ((file_type_idx
== GEANY_FILETYPES_C
|| file_type_idx
== GEANY_FILETYPES_CPP
) &&
193 c_tags_ignore
== NULL
)
195 load_c_ignore_tags();
198 if (cl_options
.ignore_global_tags
|| app
->tm_workspace
== NULL
)
201 /* load config in case of custom filetypes */
202 filetypes_load_config(file_type_idx
, FALSE
);
204 load_user_tags(file_type_idx
);
206 switch (file_type_idx
)
208 case GEANY_FILETYPES_CPP
:
209 symbols_global_tags_loaded(GEANY_FILETYPES_C
); /* load C global tags */
211 case GEANY_FILETYPES_PHP
:
212 symbols_global_tags_loaded(GEANY_FILETYPES_HTML
); /* load HTML global tags */
218 GString
*symbols_find_typenames_as_string(TMParserType lang
, gboolean global
)
224 TMParserType tag_lang
;
227 typedefs
= app
->tm_workspace
->global_typename_array
;
229 typedefs
= app
->tm_workspace
->typename_array
;
231 if ((typedefs
) && (typedefs
->len
> 0))
233 const gchar
*last_name
= "";
235 s
= g_string_sized_new(typedefs
->len
* 10);
236 for (j
= 0; j
< typedefs
->len
; ++j
)
238 tag
= TM_TAG(typedefs
->pdata
[j
]);
239 tag_lang
= tag
->lang
;
241 if (tag
->name
&& tm_parser_langs_compatible(lang
, tag_lang
) &&
242 strcmp(tag
->name
, last_name
) != 0)
245 g_string_append_c(s
, ' ');
246 g_string_append(s
, tag
->name
);
247 last_name
= tag
->name
;
255 /** Gets the context separator used by the tag manager for a particular file
257 * @param ft_id File type identifier.
258 * @return The context separator string.
260 * Returns non-printing sequence "\x03" ie ETX (end of text) for filetypes
261 * without a context separator.
266 const gchar
*symbols_get_context_separator(gint ft_id
)
268 return tm_parser_scope_separator(filetypes
[ft_id
]->lang
);
272 /* sort by name, then line */
273 static gint
compare_symbol(const TMTag
*tag_a
, const TMTag
*tag_b
)
277 if (tag_a
== NULL
|| tag_b
== NULL
)
280 if (tag_a
->name
== NULL
)
281 return -(tag_a
->name
!= tag_b
->name
);
283 if (tag_b
->name
== NULL
)
284 return tag_a
->name
!= tag_b
->name
;
286 ret
= strcmp(tag_a
->name
, tag_b
->name
);
289 return tag_a
->line
- tag_b
->line
;
295 /* sort by line, then scope */
296 static gint
compare_symbol_lines(gconstpointer a
, gconstpointer b
)
298 const TMTag
*tag_a
= TM_TAG(a
);
299 const TMTag
*tag_b
= TM_TAG(b
);
302 if (a
== NULL
|| b
== NULL
)
305 ret
= tag_a
->line
- tag_b
->line
;
308 if (tag_a
->scope
== NULL
)
309 return -(tag_a
->scope
!= tag_b
->scope
);
310 if (tag_b
->scope
== NULL
)
311 return tag_a
->scope
!= tag_b
->scope
;
313 return strcmp(tag_a
->scope
, tag_b
->scope
);
319 static GList
*get_tag_list(GeanyDocument
*doc
, TMTagType tag_types
)
321 GList
*tag_names
= NULL
;
325 g_return_val_if_fail(doc
, NULL
);
327 if (! doc
->tm_file
|| ! doc
->tm_file
->tags_array
)
330 tf_strv
= g_strsplit_set(doc
->priv
->tag_filter
, " ", -1);
332 for (i
= 0; i
< doc
->tm_file
->tags_array
->len
; ++i
)
334 TMTag
*tag
= TM_TAG(doc
->tm_file
->tags_array
->pdata
[i
]);
336 if (tag
->type
& tag_types
)
338 gboolean filtered
= FALSE
;
340 gchar
*full_tagname
= g_strconcat(tag
->scope
? tag
->scope
: "",
341 tag
->scope
? tm_parser_scope_separator(tag
->lang
) : "",
343 gchar
*normalized_tagname
= g_utf8_normalize(full_tagname
, -1, G_NORMALIZE_ALL
);
345 foreach_strv(val
, tf_strv
)
347 gchar
*normalized_val
= g_utf8_normalize(*val
, -1, G_NORMALIZE_ALL
);
349 if (normalized_tagname
!= NULL
&& normalized_val
!= NULL
)
351 gchar
*case_normalized_tagname
= g_utf8_casefold(normalized_tagname
, -1);
352 gchar
*case_normalized_val
= g_utf8_casefold(normalized_val
, -1);
354 filtered
= strstr(case_normalized_tagname
, case_normalized_val
) == NULL
;
355 g_free(case_normalized_tagname
);
356 g_free(case_normalized_val
);
358 g_free(normalized_val
);
364 tag_names
= g_list_prepend(tag_names
, tag
);
366 g_free(normalized_tagname
);
367 g_free(full_tagname
);
370 tag_names
= g_list_sort(tag_names
, compare_symbol_lines
);
378 /* amount of types in the symbol list (currently max. 8 are used) */
379 #define MAX_SYMBOL_TYPES (sizeof(tv_iters) / sizeof(GtkTreeIter))
381 struct TreeviewSymbols
383 GtkTreeIter tag_function
;
384 GtkTreeIter tag_class
;
385 GtkTreeIter tag_macro
;
386 GtkTreeIter tag_member
;
387 GtkTreeIter tag_variable
;
388 GtkTreeIter tag_externvar
;
389 GtkTreeIter tag_namespace
;
390 GtkTreeIter tag_struct
;
391 GtkTreeIter tag_interface
;
392 GtkTreeIter tag_type
;
393 GtkTreeIter tag_other
;
397 static void init_tag_iters(void)
399 /* init all GtkTreeIters with -1 to make them invalid to avoid crashes when switching between
400 * filetypes(e.g. config file to Python crashes Geany without this) */
401 tv_iters
.tag_function
.stamp
= -1;
402 tv_iters
.tag_class
.stamp
= -1;
403 tv_iters
.tag_member
.stamp
= -1;
404 tv_iters
.tag_macro
.stamp
= -1;
405 tv_iters
.tag_variable
.stamp
= -1;
406 tv_iters
.tag_externvar
.stamp
= -1;
407 tv_iters
.tag_namespace
.stamp
= -1;
408 tv_iters
.tag_struct
.stamp
= -1;
409 tv_iters
.tag_interface
.stamp
= -1;
410 tv_iters
.tag_type
.stamp
= -1;
411 tv_iters
.tag_other
.stamp
= -1;
415 static GdkPixbuf
*get_tag_icon(const gchar
*icon_name
)
417 static GtkIconTheme
*icon_theme
= NULL
;
420 if (G_UNLIKELY(x
< 0))
423 icon_theme
= gtk_icon_theme_get_default();
424 gtk_icon_size_lookup(GTK_ICON_SIZE_MENU
, &x
, &dummy
);
426 return gtk_icon_theme_load_icon(icon_theme
, icon_name
, x
, 0, NULL
);
430 static gboolean
find_toplevel_iter(GtkTreeStore
*store
, GtkTreeIter
*iter
, const gchar
*title
)
432 GtkTreeModel
*model
= GTK_TREE_MODEL(store
);
434 if (!gtk_tree_model_get_iter_first(model
, iter
))
440 gtk_tree_model_get(model
, iter
, SYMBOLS_COLUMN_NAME
, &candidate
, -1);
441 /* FIXME: what if 2 different items have the same name?
442 * this should never happen, but might be caused by a typo in a translation */
443 if (utils_str_equal(candidate
, title
))
451 while (gtk_tree_model_iter_next(model
, iter
));
457 /* Adds symbol list groups in (iter*, title) pairs.
458 * The list must be ended with NULL. */
459 static void G_GNUC_NULL_TERMINATED
460 tag_list_add_groups(GtkTreeStore
*tree_store
, ...)
465 g_return_if_fail(top_level_iter_names
);
467 va_start(args
, tree_store
);
468 for (; iter
= va_arg(args
, GtkTreeIter
*), iter
!= NULL
;)
470 gchar
*title
= va_arg(args
, gchar
*);
471 guint icon_id
= va_arg(args
, guint
);
472 GdkPixbuf
*icon
= NULL
;
474 if (icon_id
< N_ICONS
)
475 icon
= symbols_icons
[icon_id
].pixbuf
;
477 g_assert(title
!= NULL
);
478 g_ptr_array_add(top_level_iter_names
, title
);
480 if (!find_toplevel_iter(tree_store
, iter
, title
))
481 gtk_tree_store_append(tree_store
, iter
, NULL
);
484 gtk_tree_store_set(tree_store
, iter
, SYMBOLS_COLUMN_ICON
, icon
, -1);
485 gtk_tree_store_set(tree_store
, iter
, SYMBOLS_COLUMN_NAME
, title
, -1);
491 static void add_top_level_items(GeanyDocument
*doc
)
493 GeanyFiletypeID ft_id
= doc
->file_type
->id
;
494 GtkTreeStore
*tag_store
= doc
->priv
->tag_store
;
496 if (top_level_iter_names
== NULL
)
497 top_level_iter_names
= g_ptr_array_new();
499 g_ptr_array_set_size(top_level_iter_names
, 0);
505 case GEANY_FILETYPES_DIFF
:
507 tag_list_add_groups(tag_store
,
508 &(tv_iters
.tag_function
), _("Files"), ICON_NONE
, NULL
);
511 case GEANY_FILETYPES_DOCBOOK
:
513 tag_list_add_groups(tag_store
,
514 &(tv_iters
.tag_function
), _("Chapter"), ICON_NONE
,
515 &(tv_iters
.tag_class
), _("Section"), ICON_NONE
,
516 &(tv_iters
.tag_member
), _("Sect1"), ICON_NONE
,
517 &(tv_iters
.tag_macro
), _("Sect2"), ICON_NONE
,
518 &(tv_iters
.tag_variable
), _("Sect3"), ICON_NONE
,
519 &(tv_iters
.tag_struct
), _("Appendix"), ICON_NONE
,
520 &(tv_iters
.tag_other
), _("Other"), ICON_NONE
,
524 case GEANY_FILETYPES_HASKELL
:
525 tag_list_add_groups(tag_store
,
526 &tv_iters
.tag_namespace
, _("Module"), ICON_NONE
,
527 &tv_iters
.tag_type
, _("Types"), ICON_NONE
,
528 &tv_iters
.tag_macro
, _("Type constructors"), ICON_NONE
,
529 &tv_iters
.tag_function
, _("Functions"), ICON_METHOD
,
532 case GEANY_FILETYPES_COBOL
:
533 tag_list_add_groups(tag_store
,
534 &tv_iters
.tag_class
, _("Program"), ICON_CLASS
,
535 &tv_iters
.tag_function
, _("File"), ICON_METHOD
,
536 &tv_iters
.tag_interface
, _("Divisions"), ICON_NAMESPACE
,
537 &tv_iters
.tag_namespace
, _("Sections"), ICON_NAMESPACE
,
538 &tv_iters
.tag_macro
, _("Paragraph"), ICON_OTHER
,
539 &tv_iters
.tag_struct
, _("Group"), ICON_STRUCT
,
540 &tv_iters
.tag_variable
, _("Data"), ICON_VAR
,
541 &tv_iters
.tag_externvar
, _("Copies"), ICON_NAMESPACE
,
544 case GEANY_FILETYPES_CONF
:
545 tag_list_add_groups(tag_store
,
546 &tv_iters
.tag_namespace
, _("Sections"), ICON_OTHER
,
547 &tv_iters
.tag_macro
, _("Keys"), ICON_VAR
,
550 case GEANY_FILETYPES_NSIS
:
551 tag_list_add_groups(tag_store
,
552 &tv_iters
.tag_namespace
, _("Sections"), ICON_OTHER
,
553 &tv_iters
.tag_function
, _("Functions"), ICON_METHOD
,
554 &(tv_iters
.tag_variable
), _("Variables"), ICON_VAR
,
557 case GEANY_FILETYPES_LATEX
:
559 tag_list_add_groups(tag_store
,
560 &(tv_iters
.tag_function
), _("Command"), ICON_NONE
,
561 &(tv_iters
.tag_class
), _("Environment"), ICON_NONE
,
562 &(tv_iters
.tag_member
), _("Section"), ICON_NONE
,
563 &(tv_iters
.tag_macro
), _("Subsection"), ICON_NONE
,
564 &(tv_iters
.tag_variable
), _("Subsubsection"), ICON_NONE
,
565 &(tv_iters
.tag_struct
), _("Label"), ICON_NONE
,
566 &(tv_iters
.tag_namespace
), _("Chapter"), ICON_NONE
,
567 &(tv_iters
.tag_other
), _("Other"), ICON_NONE
,
571 case GEANY_FILETYPES_BIBTEX
:
573 tag_list_add_groups(tag_store
,
574 &(tv_iters
.tag_function
), _("Articles"), ICON_NONE
,
575 &(tv_iters
.tag_macro
), _("Book Chapters"), ICON_NONE
,
576 &(tv_iters
.tag_class
), _("Books & Conference Proceedings"), ICON_NONE
,
577 &(tv_iters
.tag_member
), _("Conference Papers"), ICON_NONE
,
578 &(tv_iters
.tag_variable
), _("Theses"), ICON_NONE
,
579 &(tv_iters
.tag_namespace
), _("Strings"), ICON_NONE
,
580 &(tv_iters
.tag_externvar
), _("Unpublished"), ICON_NONE
,
581 &(tv_iters
.tag_other
), _("Other"), ICON_NONE
,
585 case GEANY_FILETYPES_MATLAB
:
587 tag_list_add_groups(tag_store
,
588 &(tv_iters
.tag_function
), _("Functions"), ICON_METHOD
,
589 &(tv_iters
.tag_struct
), _("Structures"), ICON_STRUCT
,
593 case GEANY_FILETYPES_ABAQUS
:
595 tag_list_add_groups(tag_store
,
596 &(tv_iters
.tag_class
), _("Parts"), ICON_NONE
,
597 &(tv_iters
.tag_member
), _("Assembly"), ICON_NONE
,
598 &(tv_iters
.tag_namespace
), _("Steps"), ICON_NONE
,
602 case GEANY_FILETYPES_R
:
604 tag_list_add_groups(tag_store
,
605 &(tv_iters
.tag_function
), _("Functions"), ICON_METHOD
,
606 &(tv_iters
.tag_other
), _("Other"), ICON_NONE
,
610 case GEANY_FILETYPES_RUST
:
612 tag_list_add_groups(tag_store
,
613 &(tv_iters
.tag_namespace
), _("Modules"), ICON_NAMESPACE
,
614 &(tv_iters
.tag_struct
), _("Structures"), ICON_STRUCT
,
615 &(tv_iters
.tag_interface
), _("Traits"), ICON_CLASS
,
616 &(tv_iters
.tag_class
), _("Implementations"), ICON_CLASS
,
617 &(tv_iters
.tag_function
), _("Functions"), ICON_METHOD
,
618 &(tv_iters
.tag_type
), _("Typedefs / Enums"), ICON_STRUCT
,
619 &(tv_iters
.tag_variable
), _("Variables"), ICON_VAR
,
620 &(tv_iters
.tag_macro
), _("Macros"), ICON_MACRO
,
621 &(tv_iters
.tag_member
), _("Methods"), ICON_MEMBER
,
622 &(tv_iters
.tag_other
), _("Other"), ICON_OTHER
,
626 case GEANY_FILETYPES_GO
:
628 tag_list_add_groups(tag_store
,
629 &(tv_iters
.tag_namespace
), _("Package"), ICON_NAMESPACE
,
630 &(tv_iters
.tag_function
), _("Functions"), ICON_METHOD
,
631 &(tv_iters
.tag_interface
), _("Interfaces"), ICON_STRUCT
,
632 &(tv_iters
.tag_struct
), _("Structs"), ICON_STRUCT
,
633 &(tv_iters
.tag_type
), _("Types"), ICON_STRUCT
,
634 &(tv_iters
.tag_macro
), _("Constants"), ICON_MACRO
,
635 &(tv_iters
.tag_variable
), _("Variables"), ICON_VAR
,
636 &(tv_iters
.tag_member
), _("Members"), ICON_MEMBER
,
637 &(tv_iters
.tag_other
), _("Other"), ICON_OTHER
,
641 case GEANY_FILETYPES_PERL
:
643 tag_list_add_groups(tag_store
,
644 &(tv_iters
.tag_namespace
), _("Package"), ICON_NAMESPACE
,
645 &(tv_iters
.tag_function
), _("Functions"), ICON_METHOD
,
646 &(tv_iters
.tag_macro
), _("Labels"), ICON_NONE
,
647 &(tv_iters
.tag_type
), _("Constants"), ICON_NONE
,
648 &(tv_iters
.tag_other
), _("Other"), ICON_OTHER
,
652 case GEANY_FILETYPES_PHP
:
653 case GEANY_FILETYPES_ZEPHIR
:
655 tag_list_add_groups(tag_store
,
656 &(tv_iters
.tag_namespace
), _("Namespaces"), ICON_NAMESPACE
,
657 &(tv_iters
.tag_interface
), _("Interfaces"), ICON_STRUCT
,
658 &(tv_iters
.tag_class
), _("Classes"), ICON_CLASS
,
659 &(tv_iters
.tag_function
), _("Functions"), ICON_METHOD
,
660 &(tv_iters
.tag_macro
), _("Constants"), ICON_MACRO
,
661 &(tv_iters
.tag_variable
), _("Variables"), ICON_VAR
,
662 &(tv_iters
.tag_struct
), _("Traits"), ICON_STRUCT
,
666 case GEANY_FILETYPES_JULIA
:
668 tag_list_add_groups(tag_store
,
669 &(tv_iters
.tag_variable
), _("Constants"), ICON_VAR
,
670 &(tv_iters
.tag_namespace
), _("Modules"), ICON_NAMESPACE
,
671 &(tv_iters
.tag_function
), _("Functions"), ICON_METHOD
,
672 &(tv_iters
.tag_member
), _("Fields"), ICON_MEMBER
,
673 &(tv_iters
.tag_macro
), _("Macros"), ICON_MACRO
,
674 &(tv_iters
.tag_struct
), _("Structures"), ICON_STRUCT
,
675 &(tv_iters
.tag_type
), _("Types"), ICON_CLASS
,
676 &(tv_iters
.tag_externvar
), _("Unknowns"), ICON_OTHER
,
680 case GEANY_FILETYPES_HTML
:
682 tag_list_add_groups(tag_store
,
683 &(tv_iters
.tag_function
), _("Functions"), ICON_NONE
,
684 &(tv_iters
.tag_member
), _("Anchors"), ICON_NONE
,
685 &(tv_iters
.tag_namespace
), _("H1 Headings"), ICON_NONE
,
686 &(tv_iters
.tag_class
), _("H2 Headings"), ICON_NONE
,
687 &(tv_iters
.tag_variable
), _("H3 Headings"), ICON_NONE
,
691 case GEANY_FILETYPES_CSS
:
693 tag_list_add_groups(tag_store
,
694 &(tv_iters
.tag_class
), _("Classes"), ICON_CLASS
,
695 &(tv_iters
.tag_variable
), _("ID Selectors"), ICON_VAR
,
696 &(tv_iters
.tag_struct
), _("Type Selectors"), ICON_STRUCT
, NULL
);
699 case GEANY_FILETYPES_REST
:
700 case GEANY_FILETYPES_TXT2TAGS
:
701 case GEANY_FILETYPES_ABC
:
703 tag_list_add_groups(tag_store
,
704 &(tv_iters
.tag_namespace
), _("Chapter"), ICON_NONE
,
705 &(tv_iters
.tag_member
), _("Section"), ICON_NONE
,
706 &(tv_iters
.tag_macro
), _("Subsection"), ICON_NONE
,
707 &(tv_iters
.tag_variable
), _("Subsubsection"), ICON_NONE
,
711 case GEANY_FILETYPES_ASCIIDOC
:
713 tag_list_add_groups(tag_store
,
714 &(tv_iters
.tag_namespace
), _("Document"), ICON_NONE
,
715 &(tv_iters
.tag_member
), _("Section Level 1"), ICON_NONE
,
716 &(tv_iters
.tag_macro
), _("Section Level 2"), ICON_NONE
,
717 &(tv_iters
.tag_variable
), _("Section Level 3"), ICON_NONE
,
718 &(tv_iters
.tag_struct
), _("Section Level 4"), ICON_NONE
,
722 case GEANY_FILETYPES_RUBY
:
724 tag_list_add_groups(tag_store
,
725 &(tv_iters
.tag_namespace
), _("Modules"), ICON_NAMESPACE
,
726 &(tv_iters
.tag_class
), _("Classes"), ICON_CLASS
,
727 &(tv_iters
.tag_member
), _("Singletons"), ICON_STRUCT
,
728 &(tv_iters
.tag_function
), _("Methods"), ICON_METHOD
,
732 case GEANY_FILETYPES_TCL
:
734 tag_list_add_groups(tag_store
,
735 &(tv_iters
.tag_namespace
), _("Namespaces"), ICON_NAMESPACE
,
736 &(tv_iters
.tag_class
), _("Classes"), ICON_CLASS
,
737 &(tv_iters
.tag_member
), _("Methods"), ICON_METHOD
,
738 &(tv_iters
.tag_function
), _("Procedures"), ICON_OTHER
,
742 case GEANY_FILETYPES_PYTHON
:
744 tag_list_add_groups(tag_store
,
745 &(tv_iters
.tag_class
), _("Classes"), ICON_CLASS
,
746 &(tv_iters
.tag_member
), _("Methods"), ICON_MACRO
,
747 &(tv_iters
.tag_function
), _("Functions"), ICON_METHOD
,
748 &(tv_iters
.tag_variable
), _("Variables"), ICON_VAR
,
749 &(tv_iters
.tag_externvar
), _("Imports"), ICON_NAMESPACE
,
753 case GEANY_FILETYPES_VHDL
:
755 tag_list_add_groups(tag_store
,
756 &(tv_iters
.tag_namespace
), _("Package"), ICON_NAMESPACE
,
757 &(tv_iters
.tag_class
), _("Entities"), ICON_CLASS
,
758 &(tv_iters
.tag_struct
), _("Architectures"), ICON_STRUCT
,
759 &(tv_iters
.tag_type
), _("Types"), ICON_OTHER
,
760 &(tv_iters
.tag_function
), _("Functions / Procedures"), ICON_METHOD
,
761 &(tv_iters
.tag_variable
), _("Variables / Signals"), ICON_VAR
,
762 &(tv_iters
.tag_member
), _("Processes / Blocks / Components"), ICON_MEMBER
,
763 &(tv_iters
.tag_other
), _("Other"), ICON_OTHER
,
767 case GEANY_FILETYPES_VERILOG
:
769 tag_list_add_groups(tag_store
,
770 &(tv_iters
.tag_type
), _("Events"), ICON_MACRO
,
771 &(tv_iters
.tag_class
), _("Modules"), ICON_CLASS
,
772 &(tv_iters
.tag_function
), _("Functions / Tasks"), ICON_METHOD
,
773 &(tv_iters
.tag_variable
), _("Variables"), ICON_VAR
,
774 &(tv_iters
.tag_other
), _("Other"), ICON_OTHER
,
778 case GEANY_FILETYPES_JAVA
:
780 tag_list_add_groups(tag_store
,
781 &(tv_iters
.tag_namespace
), _("Package"), ICON_NAMESPACE
,
782 &(tv_iters
.tag_interface
), _("Interfaces"), ICON_STRUCT
,
783 &(tv_iters
.tag_class
), _("Classes"), ICON_CLASS
,
784 &(tv_iters
.tag_function
), _("Methods"), ICON_METHOD
,
785 &(tv_iters
.tag_member
), _("Members"), ICON_MEMBER
,
786 &(tv_iters
.tag_type
), _("Enums"), ICON_STRUCT
,
787 &(tv_iters
.tag_other
), _("Other"), ICON_OTHER
,
791 case GEANY_FILETYPES_AS
:
793 tag_list_add_groups(tag_store
,
794 &(tv_iters
.tag_externvar
), _("Imports"), ICON_NAMESPACE
,
795 &(tv_iters
.tag_namespace
), _("Package"), ICON_NAMESPACE
,
796 &(tv_iters
.tag_interface
), _("Interfaces"), ICON_STRUCT
,
797 &(tv_iters
.tag_class
), _("Classes"), ICON_CLASS
,
798 &(tv_iters
.tag_function
), _("Functions"), ICON_METHOD
,
799 &(tv_iters
.tag_member
), _("Properties"), ICON_MEMBER
,
800 &(tv_iters
.tag_variable
), _("Variables"), ICON_VAR
,
801 &(tv_iters
.tag_macro
), _("Constants"), ICON_MACRO
,
802 &(tv_iters
.tag_other
), _("Other"), ICON_OTHER
,
806 case GEANY_FILETYPES_HAXE
:
808 tag_list_add_groups(tag_store
,
809 &(tv_iters
.tag_interface
), _("Interfaces"), ICON_STRUCT
,
810 &(tv_iters
.tag_class
), _("Classes"), ICON_CLASS
,
811 &(tv_iters
.tag_function
), _("Methods"), ICON_METHOD
,
812 &(tv_iters
.tag_type
), _("Types"), ICON_MACRO
,
813 &(tv_iters
.tag_variable
), _("Variables"), ICON_VAR
,
814 &(tv_iters
.tag_other
), _("Other"), ICON_OTHER
,
818 case GEANY_FILETYPES_BASIC
:
820 tag_list_add_groups(tag_store
,
821 &(tv_iters
.tag_function
), _("Functions"), ICON_METHOD
,
822 &(tv_iters
.tag_variable
), _("Variables"), ICON_VAR
,
823 &(tv_iters
.tag_macro
), _("Constants"), ICON_MACRO
,
824 &(tv_iters
.tag_struct
), _("Types"), ICON_NAMESPACE
,
825 &(tv_iters
.tag_namespace
), _("Labels"), ICON_MEMBER
,
826 &(tv_iters
.tag_other
), _("Other"), ICON_OTHER
,
830 case GEANY_FILETYPES_F77
:
831 case GEANY_FILETYPES_FORTRAN
:
833 tag_list_add_groups(tag_store
,
834 &(tv_iters
.tag_namespace
), _("Module"), ICON_CLASS
,
835 &(tv_iters
.tag_struct
), _("Programs"), ICON_CLASS
,
836 &(tv_iters
.tag_interface
), _("Interfaces"), ICON_STRUCT
,
837 &(tv_iters
.tag_function
), _("Functions / Subroutines"), ICON_METHOD
,
838 &(tv_iters
.tag_variable
), _("Variables"), ICON_VAR
,
839 &(tv_iters
.tag_class
), _("Types"), ICON_CLASS
,
840 &(tv_iters
.tag_member
), _("Components"), ICON_MEMBER
,
841 &(tv_iters
.tag_macro
), _("Blocks"), ICON_MEMBER
,
842 &(tv_iters
.tag_type
), _("Enums"), ICON_STRUCT
,
843 &(tv_iters
.tag_other
), _("Other"), ICON_OTHER
,
847 case GEANY_FILETYPES_ASM
:
849 tag_list_add_groups(tag_store
,
850 &(tv_iters
.tag_namespace
), _("Labels"), ICON_NAMESPACE
,
851 &(tv_iters
.tag_function
), _("Macros"), ICON_METHOD
,
852 &(tv_iters
.tag_macro
), _("Defines"), ICON_MACRO
,
853 &(tv_iters
.tag_struct
), _("Types"), ICON_STRUCT
,
857 case GEANY_FILETYPES_MAKE
:
858 tag_list_add_groups(tag_store
,
859 &tv_iters
.tag_function
, _("Targets"), ICON_METHOD
,
860 &tv_iters
.tag_macro
, _("Macros"), ICON_MACRO
,
863 case GEANY_FILETYPES_SQL
:
865 tag_list_add_groups(tag_store
,
866 &(tv_iters
.tag_function
), _("Functions"), ICON_METHOD
,
867 &(tv_iters
.tag_namespace
), _("Procedures"), ICON_NAMESPACE
,
868 &(tv_iters
.tag_struct
), _("Indexes"), ICON_STRUCT
,
869 &(tv_iters
.tag_class
), _("Tables"), ICON_CLASS
,
870 &(tv_iters
.tag_macro
), _("Triggers"), ICON_MACRO
,
871 &(tv_iters
.tag_member
), _("Views"), ICON_VAR
,
872 &(tv_iters
.tag_other
), _("Other"), ICON_OTHER
,
873 &(tv_iters
.tag_variable
), _("Variables"), ICON_VAR
,
877 case GEANY_FILETYPES_D
:
880 if (ft_id
== GEANY_FILETYPES_D
)
881 tag_list_add_groups(tag_store
,
882 &(tv_iters
.tag_namespace
), _("Module"), ICON_NONE
, NULL
);
884 tag_list_add_groups(tag_store
,
885 &(tv_iters
.tag_namespace
), _("Namespaces"), ICON_NAMESPACE
, NULL
);
887 tag_list_add_groups(tag_store
,
888 &(tv_iters
.tag_class
), _("Classes"), ICON_CLASS
,
889 &(tv_iters
.tag_interface
), _("Interfaces"), ICON_STRUCT
,
890 &(tv_iters
.tag_function
), _("Functions"), ICON_METHOD
,
891 &(tv_iters
.tag_member
), _("Members"), ICON_MEMBER
,
892 &(tv_iters
.tag_struct
), _("Structs"), ICON_STRUCT
,
893 &(tv_iters
.tag_type
), _("Typedefs / Enums"), ICON_STRUCT
,
896 if (ft_id
!= GEANY_FILETYPES_D
)
898 tag_list_add_groups(tag_store
,
899 &(tv_iters
.tag_macro
), _("Macros"), ICON_MACRO
, NULL
);
901 tag_list_add_groups(tag_store
,
902 &(tv_iters
.tag_variable
), _("Variables"), ICON_VAR
,
903 &(tv_iters
.tag_externvar
), _("Extern Variables"), ICON_VAR
,
904 &(tv_iters
.tag_other
), _("Other"), ICON_OTHER
, NULL
);
910 /* removes toplevel items that have no children */
911 static void hide_empty_rows(GtkTreeStore
*store
)
914 gboolean cont
= TRUE
;
916 if (! gtk_tree_model_get_iter_first(GTK_TREE_MODEL(store
), &iter
))
917 return; /* stop when first iter is invalid, i.e. no elements */
921 if (! gtk_tree_model_iter_has_child(GTK_TREE_MODEL(store
), &iter
))
922 cont
= gtk_tree_store_remove(store
, &iter
);
924 cont
= gtk_tree_model_iter_next(GTK_TREE_MODEL(store
), &iter
);
929 static const gchar
*get_symbol_name(GeanyDocument
*doc
, const TMTag
*tag
, gboolean found_parent
)
932 const gchar
*scope
= tag
->scope
;
933 static GString
*buffer
= NULL
; /* buffer will be small so we can keep it for reuse */
934 gboolean doc_is_utf8
= FALSE
;
936 /* encodings_convert_to_utf8_from_charset() fails with charset "None", so skip conversion
937 * for None at this point completely */
938 if (utils_str_equal(doc
->encoding
, "UTF-8") ||
939 utils_str_equal(doc
->encoding
, "None"))
941 else /* normally the tags will always be in UTF-8 since we parse from our buffer, but a
942 * plugin might have called tm_source_file_update(), so check to be sure */
943 doc_is_utf8
= g_utf8_validate(tag
->name
, -1, NULL
);
946 utf8_name
= encodings_convert_to_utf8_from_charset(tag
->name
,
947 -1, doc
->encoding
, TRUE
);
949 utf8_name
= tag
->name
;
951 if (utf8_name
== NULL
)
955 buffer
= g_string_new(NULL
);
957 g_string_truncate(buffer
, 0);
959 /* check first char of scope is a wordchar */
960 if (!found_parent
&& scope
&&
961 strpbrk(scope
, GEANY_WORDCHARS
) == scope
)
963 const gchar
*sep
= tm_parser_scope_separator(tag
->lang
);
965 g_string_append(buffer
, scope
);
966 g_string_append(buffer
, sep
);
968 g_string_append(buffer
, utf8_name
);
973 g_string_append_printf(buffer
, " [%lu]", tag
->line
);
979 static gchar
*get_symbol_tooltip(GeanyDocument
*doc
, const TMTag
*tag
)
981 gchar
*utf8_name
= tm_parser_format_function(tag
->lang
, tag
->name
,
982 tag
->arglist
, tag
->var_type
, tag
->scope
);
984 if (!utf8_name
&& tag
->var_type
&&
985 tag
->type
& (tm_tag_field_t
| tm_tag_member_t
| tm_tag_variable_t
| tm_tag_externvar_t
))
987 utf8_name
= tm_parser_format_variable(tag
->lang
, tag
->name
, tag
->var_type
);
990 /* encodings_convert_to_utf8_from_charset() fails with charset "None", so skip conversion
991 * for None at this point completely */
992 if (utf8_name
!= NULL
&&
993 ! utils_str_equal(doc
->encoding
, "UTF-8") &&
994 ! utils_str_equal(doc
->encoding
, "None"))
997 encodings_convert_to_utf8_from_charset(utf8_name
, -1, doc
->encoding
, TRUE
));
1004 static const gchar
*get_parent_name(const TMTag
*tag
)
1006 return !EMPTY(tag
->scope
) ? tag
->scope
: NULL
;
1010 static GtkTreeIter
*get_tag_type_iter(TMTagType tag_type
)
1012 GtkTreeIter
*iter
= NULL
;
1016 case tm_tag_prototype_t
:
1017 case tm_tag_method_t
:
1018 case tm_tag_function_t
:
1020 iter
= &tv_iters
.tag_function
;
1023 case tm_tag_externvar_t
:
1025 iter
= &tv_iters
.tag_externvar
;
1028 case tm_tag_macro_t
:
1029 case tm_tag_macro_with_arg_t
:
1031 iter
= &tv_iters
.tag_macro
;
1034 case tm_tag_class_t
:
1036 iter
= &tv_iters
.tag_class
;
1039 case tm_tag_member_t
:
1040 case tm_tag_field_t
:
1042 iter
= &tv_iters
.tag_member
;
1045 case tm_tag_typedef_t
:
1048 iter
= &tv_iters
.tag_type
;
1051 case tm_tag_union_t
:
1052 case tm_tag_struct_t
:
1054 iter
= &tv_iters
.tag_struct
;
1057 case tm_tag_interface_t
:
1058 iter
= &tv_iters
.tag_interface
;
1060 case tm_tag_variable_t
:
1062 iter
= &tv_iters
.tag_variable
;
1065 case tm_tag_namespace_t
:
1066 case tm_tag_package_t
:
1068 iter
= &tv_iters
.tag_namespace
;
1073 iter
= &tv_iters
.tag_other
;
1076 if (G_LIKELY(iter
->stamp
!= -1))
1083 static GdkPixbuf
*get_child_icon(GtkTreeStore
*tree_store
, GtkTreeIter
*parent
)
1085 GdkPixbuf
*icon
= NULL
;
1087 if (parent
== &tv_iters
.tag_other
)
1089 return g_object_ref(symbols_icons
[ICON_VAR
].pixbuf
);
1091 /* copy parent icon */
1092 gtk_tree_model_get(GTK_TREE_MODEL(tree_store
), parent
,
1093 SYMBOLS_COLUMN_ICON
, &icon
, -1);
1098 static gboolean
tag_equal(gconstpointer v1
, gconstpointer v2
)
1100 const TMTag
*t1
= v1
;
1101 const TMTag
*t2
= v2
;
1103 return (t1
->type
== t2
->type
&& strcmp(t1
->name
, t2
->name
) == 0 &&
1104 utils_str_equal(t1
->scope
, t2
->scope
) &&
1105 /* include arglist in match to support e.g. C++ overloading */
1106 utils_str_equal(t1
->arglist
, t2
->arglist
));
1110 /* inspired from g_str_hash() */
1111 static guint
tag_hash(gconstpointer v
)
1113 const TMTag
*tag
= v
;
1117 h
= (h
<< 5) + h
+ tag
->type
;
1118 for (p
= tag
->name
; *p
!= '\0'; p
++)
1119 h
= (h
<< 5) + h
+ *p
;
1122 for (p
= tag
->scope
; *p
!= '\0'; p
++)
1123 h
= (h
<< 5) + h
+ *p
;
1125 /* for e.g. C++ overloading */
1128 for (p
= tag
->arglist
; *p
!= '\0'; p
++)
1129 h
= (h
<< 5) + h
+ *p
;
1136 /* like gtk_tree_view_expand_to_path() but with an iter */
1137 static void tree_view_expand_to_iter(GtkTreeView
*view
, GtkTreeIter
*iter
)
1139 GtkTreeModel
*model
= gtk_tree_view_get_model(view
);
1140 GtkTreePath
*path
= gtk_tree_model_get_path(model
, iter
);
1142 gtk_tree_view_expand_to_path(view
, path
);
1143 gtk_tree_path_free(path
);
1147 /* like gtk_tree_store_remove() but finds the next iter at any level */
1148 static gboolean
tree_store_remove_row(GtkTreeStore
*store
, GtkTreeIter
*iter
)
1151 gboolean has_parent
;
1154 has_parent
= gtk_tree_model_iter_parent(GTK_TREE_MODEL(store
), &parent
, iter
);
1155 cont
= gtk_tree_store_remove(store
, iter
);
1156 /* if there is no next at this level but there is a parent iter, continue from it */
1157 if (! cont
&& has_parent
)
1160 cont
= ui_tree_model_iter_any_next(GTK_TREE_MODEL(store
), iter
, FALSE
);
1167 static gint
tree_search_func(gconstpointer key
, gpointer user_data
)
1169 TreeSearchData
*data
= user_data
;
1170 gint parent_line
= GPOINTER_TO_INT(key
);
1171 gboolean new_nearest
;
1173 if (data
->found_line
== -1)
1174 data
->found_line
= parent_line
; /* initial value */
1176 new_nearest
= ABS(data
->line
- parent_line
) < ABS(data
->line
- data
->found_line
);
1178 if (parent_line
> data
->line
)
1180 if (new_nearest
&& !data
->lower
)
1181 data
->found_line
= parent_line
;
1186 data
->found_line
= parent_line
;
1188 if (parent_line
< data
->line
)
1195 static gint
tree_cmp(gconstpointer a
, gconstpointer b
, gpointer user_data
)
1197 return GPOINTER_TO_INT(a
) - GPOINTER_TO_INT(b
);
1201 static void parents_table_tree_value_free(gpointer data
)
1203 g_slice_free(GtkTreeIter
, data
);
1207 /* adds a new element in the parent table if its key is known. */
1208 static void update_parents_table(GHashTable
*table
, const TMTag
*tag
, const GtkTreeIter
*iter
)
1211 gchar
*name_free
= NULL
;
1214 if (EMPTY(tag
->scope
))
1216 /* simple case, just use the tag name */
1219 else if (! tm_parser_has_full_scope(tag
->lang
))
1221 /* if the parser doesn't use fully qualified scope, use the name alone but
1222 * prevent Foo::Foo from making parent = child */
1223 if (utils_str_equal(tag
->scope
, tag
->name
))
1230 /* build the fully qualified scope as get_parent_name() would return it for a child tag */
1231 name_free
= g_strconcat(tag
->scope
, tm_parser_scope_separator(tag
->lang
), tag
->name
, NULL
);
1235 if (name
&& g_hash_table_lookup_extended(table
, name
, NULL
, (gpointer
*) &tree
))
1239 tree
= g_tree_new_full(tree_cmp
, NULL
, NULL
, parents_table_tree_value_free
);
1240 g_hash_table_insert(table
, name_free
? name_free
: g_strdup(name
), tree
);
1244 g_tree_insert(tree
, GINT_TO_POINTER(tag
->line
), g_slice_dup(GtkTreeIter
, iter
));
1251 static GtkTreeIter
*parents_table_lookup(GHashTable
*table
, const gchar
*name
, guint line
)
1253 GtkTreeIter
*parent_search
= NULL
;
1256 tree
= g_hash_table_lookup(table
, name
);
1259 TreeSearchData user_data
= {-1, line
, TRUE
};
1261 /* search parent candidates for the one with the nearest
1262 * line number which is lower than the tag's line number */
1263 g_tree_search(tree
, (GCompareFunc
)tree_search_func
, &user_data
);
1264 parent_search
= g_tree_lookup(tree
, GINT_TO_POINTER(user_data
.found_line
));
1267 return parent_search
;
1271 static void parents_table_value_free(gpointer data
)
1275 g_tree_destroy(tree
);
1279 /* inserts a @data in @table on key @tag.
1280 * previous data is not overwritten if the key is duplicated, but rather the
1281 * two values are kept in a list
1283 * table is: GHashTable<TMTag, GTree<line_num, GList<GList<TMTag>>>> */
1284 static void tags_table_insert(GHashTable
*table
, TMTag
*tag
, GList
*data
)
1286 GTree
*tree
= g_hash_table_lookup(table
, tag
);
1289 tree
= g_tree_new_full(tree_cmp
, NULL
, NULL
, NULL
);
1290 g_hash_table_insert(table
, tag
, tree
);
1292 GList
*list
= g_tree_lookup(tree
, GINT_TO_POINTER(tag
->line
));
1293 list
= g_list_prepend(list
, data
);
1294 g_tree_insert(tree
, GINT_TO_POINTER(tag
->line
), list
);
1298 /* looks up the entry in @table that best matches @tag.
1299 * if there is more than one candidate, the one that has closest line position to @tag is chosen */
1300 static GList
*tags_table_lookup(GHashTable
*table
, TMTag
*tag
)
1302 TreeSearchData user_data
= {-1, tag
->line
, FALSE
};
1303 GTree
*tree
= g_hash_table_lookup(table
, tag
);
1309 g_tree_search(tree
, (GCompareFunc
)tree_search_func
, &user_data
);
1310 list
= g_tree_lookup(tree
, GINT_TO_POINTER(user_data
.found_line
));
1311 /* return the first value in the list - we don't care which of the
1312 * tags with identical names defined on the same line we get */
1320 /* removes the element at @tag from @table.
1321 * @tag must be the exact pointer used at insertion time */
1322 static void tags_table_remove(GHashTable
*table
, TMTag
*tag
)
1324 GTree
*tree
= g_hash_table_lookup(table
, tag
);
1327 GList
*list
= g_tree_lookup(tree
, GINT_TO_POINTER(tag
->line
));
1331 /* should always be the first element as we returned the first one in
1332 * tags_table_lookup() */
1333 foreach_list(node
, list
)
1335 if (((GList
*) node
->data
)->data
== tag
)
1338 list
= g_list_delete_link(list
, node
);
1340 g_tree_remove(tree
, GINT_TO_POINTER(tag
->line
));
1342 g_tree_insert(tree
, GINT_TO_POINTER(tag
->line
), list
);
1348 static gboolean
tags_table_tree_value_free(gpointer key
, gpointer value
, gpointer data
)
1350 GList
*list
= value
;
1356 static void tags_table_value_free(gpointer data
)
1361 /* free any leftover elements. note that we can't register a value_free_func when
1362 * creating the tree because we only want to free it when destroying the tree,
1363 * not when inserting a duplicate (we handle this manually) */
1364 g_tree_foreach(tree
, tags_table_tree_value_free
, NULL
);
1365 g_tree_destroy(tree
);
1371 * Updates the tag tree for a document with the tags in *list.
1372 * @param doc a document
1373 * @param tags a pointer to a GList* holding the tags to add/update. This
1374 * list may be updated, removing updated elements.
1376 * The update is done in two passes:
1377 * 1) walking the current tree, update tags that still exist and remove the
1379 * 2) walking the remaining (non updated) tags, adds them in the list.
1381 * For better performances, we use 2 hash tables:
1382 * - one containing all the tags for lookup in the first pass (actually stores a
1383 * reference in the tags list for removing it efficiently), avoiding list search
1385 * - the other holding "tag-name":row references for tags having children, used to
1386 * lookup for a parent in both passes, avoiding tree traversal.
1388 static void update_tree_tags(GeanyDocument
*doc
, GList
**tags
)
1390 GtkTreeStore
*store
= doc
->priv
->tag_store
;
1391 GtkTreeModel
*model
= GTK_TREE_MODEL(store
);
1392 GHashTable
*parents_table
;
1393 GHashTable
*tags_table
;
1398 /* Build hash tables holding tags and parents */
1399 /* parent table is GHashTable<tag_name, GTree<line_num, GtkTreeIter>>
1400 * where tag_name might be a fully qualified name (with scope) if the language
1401 * parser reports scope properly (see tm_parser_has_full_scope()). */
1402 parents_table
= g_hash_table_new_full(g_str_hash
, g_str_equal
, g_free
, parents_table_value_free
);
1403 /* tags table is another representation of the @tags list,
1404 * GHashTable<TMTag, GTree<line_num, GList<GList<TMTag>>>> */
1405 tags_table
= g_hash_table_new_full(tag_hash
, tag_equal
, NULL
, tags_table_value_free
);
1406 foreach_list(item
, *tags
)
1408 TMTag
*tag
= item
->data
;
1409 const gchar
*parent_name
;
1411 tags_table_insert(tags_table
, tag
, item
);
1413 parent_name
= get_parent_name(tag
);
1415 g_hash_table_insert(parents_table
, g_strdup(parent_name
), NULL
);
1418 /* First pass, update existing rows or delete them.
1419 * It is OK to delete them since we walk top down so we would remove
1420 * parents before checking for their children, thus never implicitly
1421 * deleting an updated child */
1422 cont
= gtk_tree_model_get_iter_first(model
, &iter
);
1427 gtk_tree_model_get(model
, &iter
, SYMBOLS_COLUMN_TAG
, &tag
, -1);
1428 if (! tag
) /* most probably a toplevel, skip it */
1429 cont
= ui_tree_model_iter_any_next(model
, &iter
, TRUE
);
1434 found_item
= tags_table_lookup(tags_table
, tag
);
1435 if (! found_item
) /* tag doesn't exist, remove it */
1436 cont
= tree_store_remove_row(store
, &iter
);
1437 else /* tag still exist, update it */
1439 const gchar
*parent_name
;
1440 TMTag
*found
= found_item
->data
;
1442 parent_name
= get_parent_name(found
);
1443 /* if parent is unknown, ignore it */
1444 if (parent_name
&& ! g_hash_table_lookup(parents_table
, parent_name
))
1447 if (!tm_tags_equal(tag
, found
))
1452 /* only update fields that (can) have changed (name that holds line
1453 * number, tooltip, and the tag itself) */
1454 name
= get_symbol_name(doc
, found
, parent_name
!= NULL
);
1455 tooltip
= get_symbol_tooltip(doc
, found
);
1456 gtk_tree_store_set(store
, &iter
,
1457 SYMBOLS_COLUMN_NAME
, name
,
1458 SYMBOLS_COLUMN_TOOLTIP
, tooltip
,
1459 SYMBOLS_COLUMN_TAG
, found
,
1464 update_parents_table(parents_table
, found
, &iter
);
1466 /* remove the updated tag from the table and list */
1467 tags_table_remove(tags_table
, found
);
1468 *tags
= g_list_delete_link(*tags
, found_item
);
1470 cont
= ui_tree_model_iter_any_next(model
, &iter
, TRUE
);
1477 /* Second pass, now we have a tree cleaned up from invalid rows,
1478 * we simply add new ones */
1479 foreach_list (item
, *tags
)
1481 TMTag
*tag
= item
->data
;
1482 GtkTreeIter
*parent
;
1484 parent
= get_tag_type_iter(tag
->type
);
1485 if (G_UNLIKELY(! parent
))
1486 geany_debug("Missing symbol-tree parent iter for type %d!", tag
->type
);
1491 const gchar
*parent_name
;
1493 GdkPixbuf
*icon
= get_child_icon(store
, parent
);
1495 parent_name
= get_parent_name(tag
);
1498 GtkTreeIter
*parent_search
= parents_table_lookup(parents_table
, parent_name
, tag
->line
);
1501 parent
= parent_search
;
1506 /* only expand to the iter if the parent was empty, otherwise we let the
1507 * folding as it was before (already expanded, or closed by the user) */
1508 expand
= ! gtk_tree_model_iter_has_child(model
, parent
);
1510 /* insert the new element */
1511 name
= get_symbol_name(doc
, tag
, parent_name
!= NULL
);
1512 tooltip
= get_symbol_tooltip(doc
, tag
);
1513 gtk_tree_store_insert_with_values(store
, &iter
, parent
, 0,
1514 SYMBOLS_COLUMN_NAME
, name
,
1515 SYMBOLS_COLUMN_TOOLTIP
, tooltip
,
1516 SYMBOLS_COLUMN_ICON
, icon
,
1517 SYMBOLS_COLUMN_TAG
, tag
,
1521 g_object_unref(icon
);
1523 update_parents_table(parents_table
, tag
, &iter
);
1526 tree_view_expand_to_iter(GTK_TREE_VIEW(doc
->priv
->tag_tree
), &iter
);
1530 g_hash_table_destroy(parents_table
);
1531 g_hash_table_destroy(tags_table
);
1535 /* we don't want to sort 1st-level nodes, but we can't return 0 because the tree sort
1536 * is not stable, so the order is already lost. */
1537 static gint
compare_top_level_names(const gchar
*a
, const gchar
*b
)
1542 /* This should never happen as it would mean that two or more top
1543 * level items have the same name but it can happen by typos in the translations. */
1544 if (utils_str_equal(a
, b
))
1547 foreach_ptr_array(name
, i
, top_level_iter_names
)
1549 if (utils_str_equal(name
, a
))
1551 if (utils_str_equal(name
, b
))
1554 g_warning("Couldn't find top level node '%s' or '%s'!", a
, b
);
1559 static gboolean
tag_has_missing_parent(const TMTag
*tag
, GtkTreeStore
*store
,
1562 /* if the tag has a parent tag, it should be at depth >= 2 */
1563 return !EMPTY(tag
->scope
) &&
1564 gtk_tree_store_iter_depth(store
, iter
) == 1;
1568 static gint
tree_sort_func(GtkTreeModel
*model
, GtkTreeIter
*a
, GtkTreeIter
*b
,
1571 gboolean sort_by_name
= GPOINTER_TO_INT(user_data
);
1572 TMTag
*tag_a
, *tag_b
;
1575 gtk_tree_model_get(model
, a
, SYMBOLS_COLUMN_TAG
, &tag_a
, -1);
1576 gtk_tree_model_get(model
, b
, SYMBOLS_COLUMN_TAG
, &tag_b
, -1);
1578 /* Check if the iters can be sorted based on tag name and line, not tree item name.
1579 * Sort by tree name if the scope was prepended, e.g. 'ScopeNameWithNoTag::TagName'. */
1580 if (tag_a
&& !tag_has_missing_parent(tag_a
, GTK_TREE_STORE(model
), a
) &&
1581 tag_b
&& !tag_has_missing_parent(tag_b
, GTK_TREE_STORE(model
), b
))
1583 cmp
= sort_by_name
? compare_symbol(tag_a
, tag_b
) :
1584 compare_symbol_lines(tag_a
, tag_b
);
1590 gtk_tree_model_get(model
, a
, SYMBOLS_COLUMN_NAME
, &astr
, -1);
1591 gtk_tree_model_get(model
, b
, SYMBOLS_COLUMN_NAME
, &bstr
, -1);
1593 /* if a is toplevel, b must be also */
1594 if (gtk_tree_store_iter_depth(GTK_TREE_STORE(model
), a
) == 0)
1596 cmp
= compare_top_level_names(astr
, bstr
);
1600 /* this is what g_strcmp0() does */
1602 cmp
= -(astr
!= bstr
);
1607 cmp
= strcmp(astr
, bstr
);
1609 /* sort duplicate 'ScopeName::OverloadedTagName' items by line as well */
1611 if (!sort_by_name
||
1612 (utils_str_equal(tag_a
->name
, tag_b
->name
) &&
1613 utils_str_equal(tag_a
->scope
, tag_b
->scope
)))
1614 cmp
= compare_symbol_lines(tag_a
, tag_b
);
1620 tm_tag_unref(tag_a
);
1621 tm_tag_unref(tag_b
);
1627 static void sort_tree(GtkTreeStore
*store
, gboolean sort_by_name
)
1629 gtk_tree_sortable_set_sort_func(GTK_TREE_SORTABLE(store
), SYMBOLS_COLUMN_NAME
, tree_sort_func
,
1630 GINT_TO_POINTER(sort_by_name
), NULL
);
1632 gtk_tree_sortable_set_sort_column_id(GTK_TREE_SORTABLE(store
), SYMBOLS_COLUMN_NAME
, GTK_SORT_ASCENDING
);
1636 gboolean
symbols_recreate_tag_list(GeanyDocument
*doc
, gint sort_mode
)
1640 g_return_val_if_fail(DOC_VALID(doc
), FALSE
);
1642 tags
= get_tag_list(doc
, tm_tag_max_t
);
1646 /* FIXME: Not sure why we detached the model here? */
1648 /* disable sorting during update because the code doesn't support correctly
1649 * models that are currently being built */
1650 gtk_tree_sortable_set_sort_column_id(GTK_TREE_SORTABLE(doc
->priv
->tag_store
), GTK_TREE_SORTABLE_UNSORTED_SORT_COLUMN_ID
, 0);
1652 /* add grandparent type iters */
1653 add_top_level_items(doc
);
1655 update_tree_tags(doc
, &tags
);
1658 hide_empty_rows(doc
->priv
->tag_store
);
1660 if (sort_mode
== SYMBOLS_SORT_USE_PREVIOUS
)
1661 sort_mode
= doc
->priv
->symbol_list_sort_mode
;
1663 sort_tree(doc
->priv
->tag_store
, sort_mode
== SYMBOLS_SORT_BY_NAME
);
1664 doc
->priv
->symbol_list_sort_mode
= sort_mode
;
1670 /* Detects a global tags filetype from the *.lang.* language extension.
1671 * Returns NULL if there was no matching TM language. */
1672 static GeanyFiletype
*detect_global_tags_filetype(const gchar
*utf8_filename
)
1675 gchar
*shortname
= utils_strdupa(utf8_filename
);
1676 GeanyFiletype
*ft
= NULL
;
1678 tags_ext
= g_strrstr(shortname
, ".tags");
1681 *tags_ext
= '\0'; /* remove .tags extension */
1682 ft
= filetypes_detect_from_extension(shortname
);
1683 if (ft
->id
!= GEANY_FILETYPES_NONE
)
1690 /* Adapted from anjuta-2.0.2/global-tags/tm_global_tags.c, thanks.
1691 * Needs full paths for filenames, except for C/C++ tag files, when CFLAGS includes
1692 * the relevant path.
1694 * CFLAGS=-I/home/user/libname-1.x geany -g libname.d.tags libname.h */
1695 int symbols_generate_global_tags(int argc
, char **argv
, gboolean want_preprocess
)
1697 /* -E pre-process, -dD output user macros, -p prof info (?) */
1698 const char pre_process
[] = "gcc -E -dD -p -I.";
1702 /* Create global taglist */
1705 const char *tags_file
= argv
[1];
1709 utf8_fname
= utils_get_utf8_from_locale(tags_file
);
1710 ft
= detect_global_tags_filetype(utf8_fname
);
1715 g_printerr(_("Unknown filetype extension for \"%s\".\n"), tags_file
);
1718 /* load config in case of custom filetypes */
1719 filetypes_load_config(ft
->id
, FALSE
);
1721 /* load ignore list for C/C++ parser */
1722 if (ft
->id
== GEANY_FILETYPES_C
|| ft
->id
== GEANY_FILETYPES_CPP
)
1723 load_c_ignore_tags();
1725 if (want_preprocess
&& (ft
->id
== GEANY_FILETYPES_C
|| ft
->id
== GEANY_FILETYPES_CPP
))
1727 const gchar
*cflags
= getenv("CFLAGS");
1728 command
= g_strdup_printf("%s %s", pre_process
, FALLBACK(cflags
, ""));
1731 command
= NULL
; /* don't preprocess */
1733 geany_debug("Generating %s tags file.", ft
->name
);
1735 status
= tm_workspace_create_global_tags(command
, (const char **) (argv
+ 2),
1736 argc
- 2, tags_file
, ft
->lang
);
1738 symbols_finalize(); /* free c_tags_ignore data */
1741 g_printerr(_("Failed to create tags file, perhaps because no symbols "
1748 g_printerr(_("Usage: %s -g <Tags File> <File list>\n\n"), argv
[0]);
1749 g_printerr(_("Example:\n"
1750 "CFLAGS=`pkg-config gtk+-2.0 --cflags` %s -g gtk2.c.tags"
1751 " /usr/include/gtk-2.0/gtk/gtk.h\n"), argv
[0]);
1758 void symbols_show_load_tags_dialog(void)
1761 GtkFileFilter
*filter
;
1763 dialog
= gtk_file_chooser_dialog_new(_("Load Tags File"), GTK_WINDOW(main_widgets
.window
),
1764 GTK_FILE_CHOOSER_ACTION_OPEN
,
1765 GTK_STOCK_CANCEL
, GTK_RESPONSE_CANCEL
,
1766 GTK_STOCK_OPEN
, GTK_RESPONSE_OK
,
1768 gtk_widget_set_name(dialog
, "GeanyDialog");
1769 filter
= gtk_file_filter_new();
1770 gtk_file_filter_set_name(filter
, _("Geany tags file (*.*.tags)"));
1771 gtk_file_filter_add_pattern(filter
, "*.*.tags");
1772 gtk_file_chooser_add_filter(GTK_FILE_CHOOSER(dialog
), filter
);
1774 if (gtk_dialog_run(GTK_DIALOG(dialog
)) == GTK_RESPONSE_OK
)
1776 GSList
*flist
= gtk_file_chooser_get_filenames(GTK_FILE_CHOOSER(dialog
));
1779 for (item
= flist
; item
!= NULL
; item
= g_slist_next(item
))
1781 gchar
*fname
= item
->data
;
1785 utf8_fname
= utils_get_utf8_from_locale(fname
);
1786 ft
= detect_global_tags_filetype(utf8_fname
);
1788 if (ft
!= NULL
&& symbols_load_global_tags(fname
, ft
))
1789 /* For translators: the first wildcard is the filetype, the second the filename */
1790 ui_set_statusbar(TRUE
, _("Loaded %s tags file '%s'."),
1791 filetypes_get_display_name(ft
), utf8_fname
);
1793 ui_set_statusbar(TRUE
, _("Could not load tags file '%s'."), utf8_fname
);
1798 g_slist_free(flist
);
1800 gtk_widget_destroy(dialog
);
1804 static void init_user_tags(void)
1806 GSList
*file_list
= NULL
, *list
= NULL
;
1810 dir
= g_build_filename(app
->configdir
, GEANY_TAGS_SUBDIR
, NULL
);
1811 /* create the user tags dir for next time if it doesn't exist */
1812 if (! g_file_test(dir
, G_FILE_TEST_IS_DIR
))
1813 utils_mkdir(dir
, FALSE
);
1814 file_list
= utils_get_file_list_full(dir
, TRUE
, FALSE
, NULL
);
1816 SETPTR(dir
, g_build_filename(app
->datadir
, GEANY_TAGS_SUBDIR
, NULL
));
1817 list
= utils_get_file_list_full(dir
, TRUE
, FALSE
, NULL
);
1820 file_list
= g_slist_concat(file_list
, list
);
1822 /* populate the filetype-specific tag files lists */
1823 for (node
= file_list
; node
!= NULL
; node
= node
->next
)
1825 gchar
*fname
= node
->data
;
1826 gchar
*utf8_fname
= utils_get_utf8_from_locale(fname
);
1827 GeanyFiletype
*ft
= detect_global_tags_filetype(utf8_fname
);
1831 if (FILETYPE_ID(ft
) != GEANY_FILETYPES_NONE
)
1832 ft
->priv
->tag_files
= g_slist_prepend(ft
->priv
->tag_files
, fname
);
1835 geany_debug("Unknown filetype for file '%s'.", fname
);
1840 /* don't need to delete list contents because they are now stored in
1841 * ft->priv->tag_files */
1842 g_slist_free(file_list
);
1846 static void load_user_tags(GeanyFiletypeID ft_id
)
1848 static guchar
*tags_loaded
= NULL
;
1849 static gboolean init_tags
= FALSE
;
1851 GeanyFiletype
*ft
= filetypes
[ft_id
];
1853 g_return_if_fail(ft_id
> 0);
1856 tags_loaded
= g_new0(guchar
, filetypes_array
->len
);
1857 if (tags_loaded
[ft_id
])
1859 tags_loaded
[ft_id
] = TRUE
; /* prevent reloading */
1867 for (node
= ft
->priv
->tag_files
; node
!= NULL
; node
= g_slist_next(node
))
1869 const gchar
*fname
= node
->data
;
1871 symbols_load_global_tags(fname
, ft
);
1876 static void on_goto_popup_item_activate(GtkMenuItem
*item
, TMTag
*tag
)
1878 GeanyDocument
*new_doc
, *old_doc
;
1880 g_return_if_fail(tag
);
1882 old_doc
= document_get_current();
1883 new_doc
= document_open_file(tag
->file
->file_name
, FALSE
, NULL
, NULL
);
1886 navqueue_goto_line(old_doc
, new_doc
, tag
->line
);
1890 /* FIXME: use the same icons as in the symbols tree defined in add_top_level_items() */
1891 static guint
get_tag_class(const TMTag
*tag
)
1895 case tm_tag_prototype_t
:
1896 case tm_tag_method_t
:
1897 case tm_tag_function_t
:
1899 case tm_tag_variable_t
:
1900 case tm_tag_externvar_t
:
1902 case tm_tag_macro_t
:
1903 case tm_tag_macro_with_arg_t
:
1905 case tm_tag_class_t
:
1907 case tm_tag_member_t
:
1908 case tm_tag_field_t
:
1910 case tm_tag_typedef_t
:
1912 case tm_tag_union_t
:
1913 case tm_tag_struct_t
:
1915 case tm_tag_namespace_t
:
1916 case tm_tag_package_t
:
1917 return ICON_NAMESPACE
;
1925 /* positions a popup at the caret from the ScintillaObject in @p data */
1926 static void goto_popup_position_func(GtkMenu
*menu
, gint
*x
, gint
*y
, gboolean
*push_in
, gpointer data
)
1929 GdkScreen
*screen
= gtk_widget_get_screen(GTK_WIDGET(menu
));
1931 GdkRectangle monitor
;
1933 GdkEventButton
*event_button
= g_object_get_data(G_OBJECT(menu
), "geany-button-event");
1937 /* if we got a mouse click, popup at that position */
1938 *x
= (gint
) event_button
->x_root
;
1939 *y
= (gint
) event_button
->y_root
;
1940 line_height
= 0; /* we don't want to offset below the line or anything */
1942 else /* keyboard positioning */
1944 ScintillaObject
*sci
= data
;
1945 GdkWindow
*window
= gtk_widget_get_window(GTK_WIDGET(sci
));
1946 gint pos
= sci_get_current_position(sci
);
1947 gint line
= sci_get_line_from_position(sci
, pos
);
1948 gint pos_x
= SSM(sci
, SCI_POINTXFROMPOSITION
, 0, pos
);
1949 gint pos_y
= SSM(sci
, SCI_POINTYFROMPOSITION
, 0, pos
);
1951 line_height
= SSM(sci
, SCI_TEXTHEIGHT
, line
, 0);
1953 gdk_window_get_origin(window
, x
, y
);
1958 monitor_num
= gdk_screen_get_monitor_at_point(screen
, *x
, *y
);
1960 gtk_widget_get_preferred_size(GTK_WIDGET(menu
), NULL
, &req
);
1962 #if GTK_CHECK_VERSION(3, 4, 0)
1963 gdk_screen_get_monitor_workarea(screen
, monitor_num
, &monitor
);
1965 gdk_screen_get_monitor_geometry(screen
, monitor_num
, &monitor
);
1968 /* put on one size of the X position, but within the monitor */
1969 if (gtk_widget_get_direction(GTK_WIDGET(menu
)) == GTK_TEXT_DIR_RTL
)
1971 if (*x
- req
.width
- 1 >= monitor
.x
)
1972 *x
-= req
.width
+ 1;
1973 else if (*x
+ req
.width
> monitor
.x
+ monitor
.width
)
1980 if (*x
+ req
.width
+ 1 <= monitor
.x
+ monitor
.width
)
1981 *x
= MAX(monitor
.x
, *x
+ 1);
1982 else if (*x
- req
.width
- 1 >= monitor
.x
)
1983 *x
-= req
.width
+ 1;
1985 *x
= monitor
.x
+ MAX(0, monitor
.width
- req
.width
);
1988 /* try to put, in order:
1989 * 1. below the Y position, under the line
1990 * 2. above the Y position
1991 * 3. within the monitor */
1992 if (*y
+ line_height
+ req
.height
<= monitor
.y
+ monitor
.height
)
1993 *y
= MAX(monitor
.y
, *y
+ line_height
);
1994 else if (*y
- req
.height
>= monitor
.y
)
1995 *y
= *y
- req
.height
;
1997 *y
= monitor
.y
+ MAX(0, monitor
.height
- req
.height
);
2003 static void show_goto_popup(GeanyDocument
*doc
, GPtrArray
*tags
, gboolean have_best
)
2005 GtkWidget
*first
= NULL
;
2008 GdkEventButton
*button_event
= NULL
;
2011 gchar
**short_names
, **file_names
;
2012 menu
= gtk_menu_new();
2014 /* If popup would show multiple files present a smart file list that allows
2015 * to easily distinguish the files while avoiding the file paths in their entirety */
2016 file_names
= g_new(gchar
*, tags
->len
);
2017 foreach_ptr_array(tmtag
, i
, tags
)
2018 file_names
[i
] = tmtag
->file
->file_name
;
2019 short_names
= utils_strv_shorten_file_list(file_names
, tags
->len
);
2022 foreach_ptr_array(tmtag
, i
, tags
)
2027 gchar
*fname
= short_names
[i
];
2030 if (! first
&& have_best
)
2031 /* For translators: it's the filename and line number of a symbol in the goto-symbol popup menu */
2032 text
= g_markup_printf_escaped(_("<b>%s: %lu</b>"), fname
, tmtag
->line
);
2034 /* For translators: it's the filename and line number of a symbol in the goto-symbol popup menu */
2035 text
= g_markup_printf_escaped(_("%s: %lu"), fname
, tmtag
->line
);
2037 image
= gtk_image_new_from_pixbuf(symbols_icons
[get_tag_class(tmtag
)].pixbuf
);
2038 label
= g_object_new(GTK_TYPE_LABEL
, "label", text
, "use-markup", TRUE
, "xalign", 0.0, NULL
);
2039 item
= g_object_new(GTK_TYPE_IMAGE_MENU_ITEM
, "image", image
, "child", label
, "always-show-image", TRUE
, NULL
);
2040 g_signal_connect_data(item
, "activate", G_CALLBACK(on_goto_popup_item_activate
),
2041 tm_tag_ref(tmtag
), (GClosureNotify
) tm_tag_unref
, 0);
2042 gtk_menu_shell_append(GTK_MENU_SHELL(menu
), item
);
2050 g_free(short_names
);
2052 gtk_widget_show_all(menu
);
2054 if (first
) /* always select the first item for better keyboard navigation */
2055 g_signal_connect(menu
, "realize", G_CALLBACK(gtk_menu_shell_select_item
), first
);
2057 event
= gtk_get_current_event();
2058 if (event
&& event
->type
== GDK_BUTTON_PRESS
)
2059 button_event
= (GdkEventButton
*) event
;
2061 gdk_event_free(event
);
2063 g_object_set_data_full(G_OBJECT(menu
), "geany-button-event", button_event
,
2064 button_event
? (GDestroyNotify
) gdk_event_free
: NULL
);
2065 gtk_menu_popup(GTK_MENU(menu
), NULL
, NULL
, goto_popup_position_func
, doc
->editor
->sci
,
2066 button_event
? button_event
->button
: 0, gtk_get_current_event_time ());
2070 static gint
compare_tags_by_name_line(gconstpointer ptr1
, gconstpointer ptr2
)
2073 TMTag
*t1
= *((TMTag
**) ptr1
);
2074 TMTag
*t2
= *((TMTag
**) ptr2
);
2076 res
= g_strcmp0(t1
->file
->short_name
, t2
->file
->short_name
);
2079 return t1
->line
- t2
->line
;
2083 static TMTag
*find_best_goto_tag(GeanyDocument
*doc
, GPtrArray
*tags
)
2088 /* first check if we have a tag in the current file */
2089 foreach_ptr_array(tag
, i
, tags
)
2091 if (g_strcmp0(doc
->real_path
, tag
->file
->file_name
) == 0)
2095 /* next check if we have a tag for some of the open documents */
2096 foreach_ptr_array(tag
, i
, tags
)
2102 if (g_strcmp0(documents
[j
]->real_path
, tag
->file
->file_name
) == 0)
2107 /* next check if we have a tag for a file inside the current document's directory */
2108 foreach_ptr_array(tag
, i
, tags
)
2110 gchar
*dir
= g_path_get_dirname(doc
->real_path
);
2112 if (g_str_has_prefix(tag
->file
->file_name
, dir
))
2124 static GPtrArray
*filter_tags(GPtrArray
*tags
, TMTag
*current_tag
, gboolean definition
)
2126 const TMTagType forward_types
= tm_tag_prototype_t
| tm_tag_externvar_t
;
2127 TMTag
*tmtag
, *last_tag
= NULL
;
2128 GPtrArray
*filtered_tags
= g_ptr_array_new();
2131 foreach_ptr_array(tmtag
, i
, tags
)
2133 if ((definition
&& !(tmtag
->type
& forward_types
)) ||
2134 (!definition
&& (tmtag
->type
& forward_types
)))
2136 /* If there are typedefs of e.g. a struct such as
2137 * "typedef struct Foo {} Foo;", filter out the typedef unless
2138 * cursor is at the struct name. */
2139 if (last_tag
!= NULL
&& last_tag
->file
== tmtag
->file
&&
2140 last_tag
->type
!= tm_tag_typedef_t
&& tmtag
->type
== tm_tag_typedef_t
)
2142 if (last_tag
== current_tag
)
2143 g_ptr_array_add(filtered_tags
, tmtag
);
2145 else if (tmtag
!= current_tag
)
2146 g_ptr_array_add(filtered_tags
, tmtag
);
2152 return filtered_tags
;
2156 static gboolean
goto_tag(const gchar
*name
, gboolean definition
)
2158 const TMTagType forward_types
= tm_tag_prototype_t
| tm_tag_externvar_t
;
2159 TMTag
*tmtag
, *current_tag
= NULL
;
2160 GeanyDocument
*old_doc
= document_get_current();
2161 gboolean found
= FALSE
;
2162 const GPtrArray
*all_tags
;
2163 GPtrArray
*tags
, *filtered_tags
;
2165 guint current_line
= sci_get_current_line(old_doc
->editor
->sci
) + 1;
2167 all_tags
= tm_workspace_find(name
, NULL
, tm_tag_max_t
, NULL
, old_doc
->file_type
->lang
);
2169 /* get rid of global tags and find tag at current line */
2170 tags
= g_ptr_array_new();
2171 foreach_ptr_array(tmtag
, i
, all_tags
)
2175 g_ptr_array_add(tags
, tmtag
);
2176 if (tmtag
->file
== old_doc
->tm_file
&& tmtag
->line
== current_line
)
2177 current_tag
= tmtag
;
2182 /* swap definition/declaration search */
2183 definition
= current_tag
->type
& forward_types
;
2185 filtered_tags
= filter_tags(tags
, current_tag
, definition
);
2186 if (filtered_tags
->len
== 0)
2188 /* if we didn't find anything, try again with the opposite type */
2189 g_ptr_array_free(filtered_tags
, TRUE
);
2190 filtered_tags
= filter_tags(tags
, current_tag
, !definition
);
2192 g_ptr_array_free(tags
, TRUE
);
2193 tags
= filtered_tags
;
2197 GeanyDocument
*new_doc
;
2199 tmtag
= tags
->pdata
[0];
2200 new_doc
= document_find_by_real_path(tmtag
->file
->file_name
);
2203 /* not found in opened document, should open */
2204 new_doc
= document_open_file(tmtag
->file
->file_name
, FALSE
, NULL
, NULL
);
2206 navqueue_goto_line(old_doc
, new_doc
, tmtag
->line
);
2208 else if (tags
->len
> 1)
2210 GPtrArray
*tag_list
;
2211 TMTag
*tag
, *best_tag
;
2213 g_ptr_array_sort(tags
, compare_tags_by_name_line
);
2214 best_tag
= find_best_goto_tag(old_doc
, tags
);
2216 tag_list
= g_ptr_array_new();
2218 g_ptr_array_add(tag_list
, best_tag
);
2219 foreach_ptr_array(tag
, i
, tags
)
2221 if (tag
!= best_tag
)
2222 g_ptr_array_add(tag_list
, tag
);
2224 show_goto_popup(old_doc
, tag_list
, best_tag
!= NULL
);
2226 g_ptr_array_free(tag_list
, TRUE
);
2229 found
= tags
->len
> 0;
2230 g_ptr_array_free(tags
, TRUE
);
2236 gboolean
symbols_goto_tag(const gchar
*name
, gboolean definition
)
2238 if (goto_tag(name
, definition
))
2241 /* if we are here, there was no match and we are beeping ;-) */
2245 ui_set_statusbar(FALSE
, _("Forward declaration \"%s\" not found."), name
);
2247 ui_set_statusbar(FALSE
, _("Definition of \"%s\" not found."), name
);
2252 /* This could perhaps be improved to check for #if, class etc. */
2253 static gint
get_function_fold_number(GeanyDocument
*doc
)
2255 /* for Java the functions are always one fold level above the class scope */
2256 if (doc
->file_type
->id
== GEANY_FILETYPES_JAVA
)
2257 return SC_FOLDLEVELBASE
+ 1;
2259 return SC_FOLDLEVELBASE
;
2263 /* Should be used only with get_current_tag_cached.
2264 * tag_types caching might trigger recomputation too often but this isn't used differently often
2265 * enough to be an issue for now */
2266 static gboolean
current_tag_changed(GeanyDocument
*doc
, gint cur_line
, gint fold_level
, guint tag_types
)
2268 static gint old_line
= -2;
2269 static GeanyDocument
*old_doc
= NULL
;
2270 static gint old_fold_num
= -1;
2271 static guint old_tag_types
= 0;
2272 const gint fold_num
= fold_level
& SC_FOLDLEVELNUMBERMASK
;
2275 /* check if the cached line and file index have changed since last time: */
2276 if (doc
== NULL
|| doc
!= old_doc
|| old_tag_types
!= tag_types
)
2278 else if (cur_line
== old_line
)
2282 /* if the line has only changed by 1 */
2283 if (abs(cur_line
- old_line
) == 1)
2285 /* It's the same function if the fold number hasn't changed */
2286 ret
= (fold_num
!= old_fold_num
);
2291 /* record current line and file index for next time */
2292 old_line
= cur_line
;
2294 old_fold_num
= fold_num
;
2295 old_tag_types
= tag_types
;
2300 /* Parse the function name up to 2 lines before tag_line.
2301 * C++ like syntax should be parsed by parse_cpp_function_at_line, otherwise the return
2302 * type or argument names can be confused with the function name. */
2303 static gchar
*parse_function_at_line(ScintillaObject
*sci
, gint tag_line
)
2305 gint start
, end
, max_pos
;
2308 switch (sci_get_lexer(sci
))
2310 case SCLEX_RUBY
: fn_style
= SCE_RB_DEFNAME
; break;
2311 case SCLEX_PYTHON
: fn_style
= SCE_P_DEFNAME
; break;
2312 default: fn_style
= SCE_C_IDENTIFIER
; /* several lexers use SCE_C_IDENTIFIER */
2314 start
= sci_get_position_from_line(sci
, tag_line
- 2);
2315 max_pos
= sci_get_position_from_line(sci
, tag_line
+ 1);
2316 while (start
< max_pos
&& sci_get_style_at(sci
, start
) != fn_style
)
2320 while (end
< max_pos
&& sci_get_style_at(sci
, end
) == fn_style
)
2325 return sci_get_contents_range(sci
, start
, end
);
2329 /* Parse the function name */
2330 static gchar
*parse_cpp_function_at_line(ScintillaObject
*sci
, gint tag_line
)
2332 gint start
, end
, first_pos
, max_pos
;
2336 first_pos
= end
= sci_get_position_from_line(sci
, tag_line
);
2337 max_pos
= sci_get_position_from_line(sci
, tag_line
+ 1);
2339 /* goto the begin of function body */
2340 while (end
< max_pos
&&
2341 (tmp
= sci_get_char_at(sci
, end
)) != '{' &&
2343 if (tmp
== 0) end
--;
2345 /* go back to the end of function identifier */
2346 while (end
> 0 && end
> first_pos
- 500 &&
2347 (tmp
= sci_get_char_at(sci
, end
)) != '(' &&
2350 if (end
< 0) end
= 0;
2352 /* skip whitespaces between identifier and ( */
2353 while (end
> 0 && isspace(sci_get_char_at(sci
, end
))) end
--;
2356 /* Use tmp to find SCE_C_IDENTIFIER or SCE_C_GLOBALCLASS chars */
2357 while (start
>= 0 && ((tmp
= sci_get_style_at(sci
, start
)) == SCE_C_IDENTIFIER
2358 || tmp
== SCE_C_GLOBALCLASS
2359 || (c
= sci_get_char_at(sci
, start
)) == '~'
2362 if (start
!= 0 && start
< end
) start
++; /* correct for last non-matching char */
2364 if (start
== end
) return NULL
;
2365 return sci_get_contents_range(sci
, start
, end
+ 1);
2369 /* gets the fold header after or on @line, but skipping folds created because of parentheses */
2370 static gint
get_fold_header_after(ScintillaObject
*sci
, gint line
)
2372 const gint line_count
= sci_get_line_count(sci
);
2374 for (; line
< line_count
; line
++)
2376 if (sci_get_fold_level(sci
, line
) & SC_FOLDLEVELHEADERFLAG
)
2378 const gint last_child
= SSM(sci
, SCI_GETLASTCHILD
, line
, -1);
2379 const gint line_end
= sci_get_line_end_position(sci
, line
);
2380 const gint lexer
= sci_get_lexer(sci
);
2381 gint parenthesis_match_line
= -1;
2383 /* now find any unbalanced open parenthesis on the line and see where the matching
2384 * brace would be, mimicking what folding on () does */
2385 for (gint pos
= sci_get_position_from_line(sci
, line
); pos
< line_end
; pos
++)
2387 if (highlighting_is_code_style(lexer
, sci_get_style_at(sci
, pos
)) &&
2388 sci_get_char_at(sci
, pos
) == '(')
2390 const gint matching
= sci_find_matching_brace(sci
, pos
);
2394 parenthesis_match_line
= sci_get_line_from_position(sci
, matching
);
2395 if (parenthesis_match_line
!= line
)
2396 break; /* match is on a different line, we found a possible fold */
2398 pos
= matching
; /* just skip the range and continue searching */
2403 /* if the matching parenthesis matches the fold level, skip it and continue.
2404 * it matches if it either spans the same lines, or spans one more but the next one is
2405 * a fold header (in which case the last child of the fold is one less to let the
2406 * header be at the parent level) */
2407 if ((parenthesis_match_line
== last_child
) ||
2408 (parenthesis_match_line
== last_child
+ 1 &&
2409 sci_get_fold_level(sci
, parenthesis_match_line
) & SC_FOLDLEVELHEADERFLAG
))
2420 static gint
get_current_tag_name(GeanyDocument
*doc
, gchar
**tagname
, TMTagType tag_types
)
2425 line
= sci_get_current_line(doc
->editor
->sci
);
2426 parent
= sci_get_fold_parent(doc
->editor
->sci
, line
);
2427 /* if we're inside a fold level and we have up-to-date tags, get the function from TM */
2428 if (parent
>= 0 && doc
->tm_file
!= NULL
&& doc
->tm_file
->tags_array
!= NULL
&&
2429 (! doc
->changed
|| editor_prefs
.autocompletion_update_freq
> 0))
2431 const TMTag
*tag
= tm_get_current_tag(doc
->tm_file
->tags_array
, parent
+ 1, tag_types
);
2435 gint tag_line
= tag
->line
- 1;
2436 gint last_child
= line
+ 1;
2438 /* if it may be a false positive because we're inside a fold level not inside anything
2439 * we match, e.g. a #if in C or C++, we check we're inside the fold level that start
2440 * right after the tag we got from TM.
2441 * Additionally, we perform parentheses matching on the initial line not to get confused
2442 * by folding on () in case the parameter list spans multiple lines */
2443 if (abs(tag_line
- parent
) > 1)
2445 const gint tag_fold
= get_fold_header_after(doc
->editor
->sci
, tag_line
);
2447 last_child
= SSM(doc
->editor
->sci
, SCI_GETLASTCHILD
, tag_fold
, -1);
2450 if (line
<= last_child
)
2453 *tagname
= g_strconcat(tag
->scope
,
2454 tm_parser_scope_separator(tag
->lang
), tag
->name
, NULL
);
2456 *tagname
= g_strdup(tag
->name
);
2462 /* for the poor guy with a modified document and without real time tag parsing, we fallback
2463 * to dirty and inaccurate hand-parsing */
2464 else if (parent
>= 0 && doc
->file_type
!= NULL
&& doc
->file_type
->id
!= GEANY_FILETYPES_NONE
)
2466 const gint fn_fold
= get_function_fold_number(doc
);
2467 gint tag_line
= parent
;
2468 gint fold_level
= sci_get_fold_level(doc
->editor
->sci
, tag_line
);
2470 /* find the top level fold point */
2471 while (tag_line
>= 0 && (fold_level
& SC_FOLDLEVELNUMBERMASK
) != fn_fold
)
2473 tag_line
= sci_get_fold_parent(doc
->editor
->sci
, tag_line
);
2474 fold_level
= sci_get_fold_level(doc
->editor
->sci
, tag_line
);
2481 if (sci_get_lexer(doc
->editor
->sci
) == SCLEX_CPP
)
2482 cur_tag
= parse_cpp_function_at_line(doc
->editor
->sci
, tag_line
);
2484 cur_tag
= parse_function_at_line(doc
->editor
->sci
, tag_line
);
2486 if (cur_tag
!= NULL
)
2494 *tagname
= g_strdup(_("unknown"));
2499 static gint
get_current_tag_name_cached(GeanyDocument
*doc
, const gchar
**tagname
, TMTagType tag_types
)
2501 static gint tag_line
= -1;
2502 static gchar
*cur_tag
= NULL
;
2504 g_return_val_if_fail(doc
== NULL
|| doc
->is_valid
, -1);
2506 if (doc
== NULL
) /* reset current function */
2508 current_tag_changed(NULL
, -1, -1, 0);
2510 cur_tag
= g_strdup(_("unknown"));
2511 if (tagname
!= NULL
)
2517 gint line
= sci_get_current_line(doc
->editor
->sci
);
2518 gint fold_level
= sci_get_fold_level(doc
->editor
->sci
, line
);
2520 if (current_tag_changed(doc
, line
, fold_level
, tag_types
))
2523 tag_line
= get_current_tag_name(doc
, &cur_tag
, tag_types
);
2532 /* Sets *tagname to point at the current function or tag name.
2533 * If doc is NULL, reset the cached current tag data to ensure it will be reparsed on the next
2534 * call to this function.
2535 * Returns: line number of the current tag, or -1 if unknown. */
2536 gint
symbols_get_current_function(GeanyDocument
*doc
, const gchar
**tagname
)
2538 return get_current_tag_name_cached(doc
, tagname
, tm_tag_function_t
| tm_tag_method_t
);
2542 /* same as symbols_get_current_function() but finds class, namespaces and more */
2543 gint
symbols_get_current_scope(GeanyDocument
*doc
, const gchar
**tagname
)
2545 TMTagType tag_types
= (tm_tag_function_t
| tm_tag_method_t
| tm_tag_class_t
|
2546 tm_tag_struct_t
| tm_tag_enum_t
| tm_tag_union_t
| tm_tag_namespace_t
);
2548 return get_current_tag_name_cached(doc
, tagname
, tag_types
);
2552 static void on_symbol_tree_sort_clicked(GtkMenuItem
*menuitem
, gpointer user_data
)
2554 gint sort_mode
= GPOINTER_TO_INT(user_data
);
2555 GeanyDocument
*doc
= document_get_current();
2557 if (ignore_callback
)
2561 doc
->has_tags
= symbols_recreate_tag_list(doc
, sort_mode
);
2565 static void on_symbol_tree_menu_show(GtkWidget
*widget
,
2568 GeanyDocument
*doc
= document_get_current();
2571 enable
= doc
&& doc
->has_tags
;
2572 gtk_widget_set_sensitive(symbol_menu
.sort_by_name
, enable
);
2573 gtk_widget_set_sensitive(symbol_menu
.sort_by_appearance
, enable
);
2574 gtk_widget_set_sensitive(symbol_menu
.expand_all
, enable
);
2575 gtk_widget_set_sensitive(symbol_menu
.collapse_all
, enable
);
2576 gtk_widget_set_sensitive(symbol_menu
.find_usage
, enable
);
2577 gtk_widget_set_sensitive(symbol_menu
.find_doc_usage
, enable
);
2582 ignore_callback
= TRUE
;
2584 if (doc
->priv
->symbol_list_sort_mode
== SYMBOLS_SORT_BY_NAME
)
2585 gtk_check_menu_item_set_active(GTK_CHECK_MENU_ITEM(symbol_menu
.sort_by_name
), TRUE
);
2587 gtk_check_menu_item_set_active(GTK_CHECK_MENU_ITEM(symbol_menu
.sort_by_appearance
), TRUE
);
2589 ignore_callback
= FALSE
;
2593 static void on_expand_collapse(GtkWidget
*widget
, gpointer user_data
)
2595 gboolean expand
= GPOINTER_TO_INT(user_data
);
2596 GeanyDocument
*doc
= document_get_current();
2601 g_return_if_fail(doc
->priv
->tag_tree
);
2604 gtk_tree_view_expand_all(GTK_TREE_VIEW(doc
->priv
->tag_tree
));
2606 gtk_tree_view_collapse_all(GTK_TREE_VIEW(doc
->priv
->tag_tree
));
2610 static void on_find_usage(GtkWidget
*widget
, G_GNUC_UNUSED gpointer unused
)
2613 GtkTreeSelection
*selection
;
2614 GtkTreeModel
*model
;
2618 doc
= document_get_current();
2622 selection
= gtk_tree_view_get_selection(GTK_TREE_VIEW(doc
->priv
->tag_tree
));
2623 if (gtk_tree_selection_get_selected(selection
, &model
, &iter
))
2624 gtk_tree_model_get(model
, &iter
, SYMBOLS_COLUMN_TAG
, &tag
, -1);
2627 if (widget
== symbol_menu
.find_in_files
)
2628 search_show_find_in_files_dialog_full(tag
->name
, NULL
);
2630 search_find_usage(tag
->name
, tag
->name
, GEANY_FIND_WHOLEWORD
| GEANY_FIND_MATCHCASE
,
2631 widget
== symbol_menu
.find_usage
);
2638 static void create_taglist_popup_menu(void)
2640 GtkWidget
*item
, *menu
;
2642 tv
.popup_taglist
= menu
= gtk_menu_new();
2644 symbol_menu
.expand_all
= item
= ui_image_menu_item_new(GTK_STOCK_ADD
, _("_Expand All"));
2645 gtk_widget_show(item
);
2646 gtk_container_add(GTK_CONTAINER(menu
), item
);
2647 g_signal_connect(item
, "activate", G_CALLBACK(on_expand_collapse
), GINT_TO_POINTER(TRUE
));
2649 symbol_menu
.collapse_all
= item
= ui_image_menu_item_new(GTK_STOCK_REMOVE
, _("_Collapse All"));
2650 gtk_widget_show(item
);
2651 gtk_container_add(GTK_CONTAINER(menu
), item
);
2652 g_signal_connect(item
, "activate", G_CALLBACK(on_expand_collapse
), GINT_TO_POINTER(FALSE
));
2654 item
= gtk_separator_menu_item_new();
2655 gtk_widget_show(item
);
2656 gtk_container_add(GTK_CONTAINER(menu
), item
);
2658 symbol_menu
.sort_by_name
= item
= gtk_radio_menu_item_new_with_mnemonic(NULL
,
2659 _("Sort by _Name"));
2660 gtk_widget_show(item
);
2661 gtk_container_add(GTK_CONTAINER(menu
), item
);
2662 g_signal_connect(item
, "activate", G_CALLBACK(on_symbol_tree_sort_clicked
),
2663 GINT_TO_POINTER(SYMBOLS_SORT_BY_NAME
));
2665 symbol_menu
.sort_by_appearance
= item
= gtk_radio_menu_item_new_with_mnemonic_from_widget(
2666 GTK_RADIO_MENU_ITEM(item
), _("Sort by _Appearance"));
2667 gtk_widget_show(item
);
2668 gtk_container_add(GTK_CONTAINER(menu
), item
);
2669 g_signal_connect(item
, "activate", G_CALLBACK(on_symbol_tree_sort_clicked
),
2670 GINT_TO_POINTER(SYMBOLS_SORT_BY_APPEARANCE
));
2672 item
= gtk_separator_menu_item_new();
2673 gtk_widget_show(item
);
2674 gtk_container_add(GTK_CONTAINER(menu
), item
);
2676 symbol_menu
.find_usage
= item
= ui_image_menu_item_new(GTK_STOCK_FIND
, _("Find _Usage"));
2677 gtk_widget_show(item
);
2678 gtk_container_add(GTK_CONTAINER(menu
), item
);
2679 g_signal_connect(item
, "activate", G_CALLBACK(on_find_usage
), symbol_menu
.find_usage
);
2681 symbol_menu
.find_doc_usage
= item
= ui_image_menu_item_new(GTK_STOCK_FIND
, _("Find _Document Usage"));
2682 gtk_widget_show(item
);
2683 gtk_container_add(GTK_CONTAINER(menu
), item
);
2684 g_signal_connect(item
, "activate", G_CALLBACK(on_find_usage
), symbol_menu
.find_doc_usage
);
2686 symbol_menu
.find_in_files
= item
= ui_image_menu_item_new(GTK_STOCK_FIND
, _("Find in F_iles..."));
2687 gtk_widget_show(item
);
2688 gtk_container_add(GTK_CONTAINER(menu
), item
);
2689 g_signal_connect(item
, "activate", G_CALLBACK(on_find_usage
), NULL
);
2691 g_signal_connect(menu
, "show", G_CALLBACK(on_symbol_tree_menu_show
), NULL
);
2693 sidebar_add_common_menu_items(GTK_MENU(menu
));
2697 static void on_document_save(G_GNUC_UNUSED GObject
*object
, GeanyDocument
*doc
)
2701 g_return_if_fail(!EMPTY(doc
->real_path
));
2703 f
= g_build_filename(app
->configdir
, "ignore.tags", NULL
);
2704 if (utils_str_equal(doc
->real_path
, f
))
2705 load_c_ignore_tags();
2711 void symbols_init(void)
2716 create_taglist_popup_menu();
2718 f
= g_build_filename(app
->configdir
, "ignore.tags", NULL
);
2719 ui_add_config_file_menu_item(f
, NULL
, NULL
);
2722 g_signal_connect(geany_object
, "document-save", G_CALLBACK(on_document_save
), NULL
);
2724 for (i
= 0; i
< G_N_ELEMENTS(symbols_icons
); i
++)
2725 symbols_icons
[i
].pixbuf
= get_tag_icon(symbols_icons
[i
].icon_name
);
2729 void symbols_finalize(void)
2733 g_strfreev(c_tags_ignore
);
2735 for (i
= 0; i
< G_N_ELEMENTS(symbols_icons
); i
++)
2737 if (symbols_icons
[i
].pixbuf
)
2738 g_object_unref(symbols_icons
[i
].pixbuf
);