2 * symbols.c - this file is part of Geany, a fast and lightweight IDE
4 * Copyright 2006-2012 Enrico Tröger <enrico(dot)troeger(at)uvena(dot)de>
5 * Copyright 2006-2012 Nick Treleaven <nick(dot)treleaven(at)btinternet(dot)com>
6 * Copyright 2011-2012 Colomban Wendling <ban(at)herbesfolles(dot)org>
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License along
19 * with this program; if not, write to the Free Software Foundation, Inc.,
20 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
25 * Tag-related functions.
29 * Symbol Tree and TagManager-related convenience functions.
30 * TagManager parses tags for each document, and also adds them to the workspace (session).
31 * Global tags are lists of tags for each filetype, loaded when a document with a
32 * matching filetype is first loaded.
42 #include "callbacks.h" /* FIXME: for ignore_callback */
43 #include "documentprivate.h"
45 #include "encodings.h"
46 #include "filetypesprivate.h"
47 #include "geanyobject.h"
50 #include "sciwrappers.h"
53 #include "tm_parser.h"
60 #include "gtkcompat.h"
67 static gchar
**html_entities
= NULL
;
72 const gchar
*tag_file
;
75 /* Check before adding any more tags files, usually they should be downloaded separately. */
76 enum /* Geany tag files */
87 static TagFileInfo tag_file_info
[GTF_MAX
] =
90 {FALSE
, "pascal.tags"},
92 {FALSE
, "html_entities.tags"},
93 {FALSE
, "latex.tags"},
94 {FALSE
, "python.tags"}
97 static GPtrArray
*top_level_iter_names
= NULL
;
115 const gchar
*icon_name
;
118 symbols_icons
[N_ICONS
] = {
119 [ICON_CLASS
] = { "classviewer-class", NULL
},
120 [ICON_MACRO
] = { "classviewer-macro", NULL
},
121 [ICON_MEMBER
] = { "classviewer-member", NULL
},
122 [ICON_METHOD
] = { "classviewer-method", NULL
},
123 [ICON_NAMESPACE
] = { "classviewer-namespace", NULL
},
124 [ICON_OTHER
] = { "classviewer-other", NULL
},
125 [ICON_STRUCT
] = { "classviewer-struct", NULL
},
126 [ICON_VAR
] = { "classviewer-var", NULL
},
131 GtkWidget
*expand_all
;
132 GtkWidget
*collapse_all
;
133 GtkWidget
*sort_by_name
;
134 GtkWidget
*sort_by_appearance
;
135 GtkWidget
*find_usage
;
136 GtkWidget
*find_doc_usage
;
137 GtkWidget
*find_in_files
;
141 static void html_tags_loaded(void);
142 static void load_user_tags(GeanyFiletypeID ft_id
);
144 /* get the tags_ignore list, exported by tagmanager's options.c */
145 extern gchar
**c_tags_ignore
;
147 /* ignore certain tokens when parsing C-like syntax.
148 * Also works for reloading. */
149 static void load_c_ignore_tags(void)
151 gchar
*path
= g_build_filename(app
->configdir
, "ignore.tags", NULL
);
154 if (g_file_get_contents(path
, &content
, NULL
, NULL
))
156 /* historically we ignore the glib _DECLS for tag generation */
157 SETPTR(content
, g_strconcat("G_BEGIN_DECLS G_END_DECLS\n", content
, NULL
));
159 g_strfreev(c_tags_ignore
);
160 c_tags_ignore
= g_strsplit_set(content
, " \n\r", -1);
167 void symbols_reload_config_files(void)
169 load_c_ignore_tags();
173 static gsize
get_tag_count(void)
175 GPtrArray
*tags
= tm_get_workspace()->global_tags
;
176 gsize count
= tags
? tags
->len
: 0;
182 /* wrapper for tm_workspace_load_global_tags().
183 * note that the tag count only counts new global tags added - if a tag has the same name,
184 * currently it replaces the existing tag, so loading a file twice will say 0 tags the 2nd time. */
185 static gboolean
symbols_load_global_tags(const gchar
*tags_file
, GeanyFiletype
*ft
)
188 gsize old_tag_count
= get_tag_count();
190 result
= tm_workspace_load_global_tags(tags_file
, ft
->lang
);
193 geany_debug("Loaded %s (%s), %u symbol(s).", tags_file
, ft
->name
,
194 (guint
) (get_tag_count() - old_tag_count
));
200 /* Ensure that the global tags file(s) for the file_type_idx filetype is loaded.
201 * This provides autocompletion, calltips, etc. */
202 void symbols_global_tags_loaded(guint file_type_idx
)
207 /* load ignore list for C/C++ parser */
208 if ((file_type_idx
== GEANY_FILETYPES_C
|| file_type_idx
== GEANY_FILETYPES_CPP
) &&
209 c_tags_ignore
== NULL
)
211 load_c_ignore_tags();
214 if (cl_options
.ignore_global_tags
|| app
->tm_workspace
== NULL
)
217 /* load config in case of custom filetypes */
218 filetypes_load_config(file_type_idx
, FALSE
);
220 load_user_tags(file_type_idx
);
222 switch (file_type_idx
)
224 case GEANY_FILETYPES_PHP
:
225 case GEANY_FILETYPES_HTML
:
228 switch (file_type_idx
)
230 case GEANY_FILETYPES_CPP
:
231 symbols_global_tags_loaded(GEANY_FILETYPES_C
); /* load C global tags */
232 /* no C++ tagfile yet */
234 case GEANY_FILETYPES_C
: tag_type
= GTF_C
; break;
235 case GEANY_FILETYPES_PASCAL
:tag_type
= GTF_PASCAL
; break;
236 case GEANY_FILETYPES_PHP
: tag_type
= GTF_PHP
; break;
237 case GEANY_FILETYPES_LATEX
: tag_type
= GTF_LATEX
; break;
238 case GEANY_FILETYPES_PYTHON
:tag_type
= GTF_PYTHON
; break;
242 tfi
= &tag_file_info
[tag_type
];
244 if (! tfi
->tags_loaded
)
246 gchar
*fname
= g_build_filename(app
->datadir
, tfi
->tag_file
, NULL
);
248 symbols_load_global_tags(fname
, filetypes
[file_type_idx
]);
249 tfi
->tags_loaded
= TRUE
;
255 /* HTML tagfile is just a list of entities for autocompletion (e.g. '&') */
256 static void html_tags_loaded(void)
260 if (cl_options
.ignore_global_tags
)
263 tfi
= &tag_file_info
[GTF_HTML_ENTITIES
];
264 if (! tfi
->tags_loaded
)
266 gchar
*file
= g_build_filename(app
->datadir
, tfi
->tag_file
, NULL
);
268 html_entities
= utils_read_file_in_array(file
);
269 tfi
->tags_loaded
= TRUE
;
275 GString
*symbols_find_typenames_as_string(TMParserType lang
, gboolean global
)
281 TMParserType tag_lang
;
284 typedefs
= app
->tm_workspace
->global_typename_array
;
286 typedefs
= app
->tm_workspace
->typename_array
;
288 if ((typedefs
) && (typedefs
->len
> 0))
290 const gchar
*last_name
= "";
292 s
= g_string_sized_new(typedefs
->len
* 10);
293 for (j
= 0; j
< typedefs
->len
; ++j
)
295 tag
= TM_TAG(typedefs
->pdata
[j
]);
296 tag_lang
= tag
->lang
;
298 if (tag
->name
&& tm_tag_langs_compatible(lang
, tag_lang
) &&
299 strcmp(tag
->name
, last_name
) != 0)
302 g_string_append_c(s
, ' ');
303 g_string_append(s
, tag
->name
);
304 last_name
= tag
->name
;
312 /** Gets the context separator used by the tag manager for a particular file
314 * @param ft_id File type identifier.
315 * @return The context separator string.
317 * Returns non-printing sequence "\x03" ie ETX (end of text) for filetypes
318 * without a context separator.
323 const gchar
*symbols_get_context_separator(gint ft_id
)
325 return tm_tag_context_separator(filetypes
[ft_id
]->lang
);
329 const gchar
**symbols_get_html_entities(void)
331 if (html_entities
== NULL
)
332 html_tags_loaded(); /* if not yet created, force creation of the array but shouldn't occur */
334 return (const gchar
**) html_entities
;
338 /* sort by name, then line */
339 static gint
compare_symbol(const TMTag
*tag_a
, const TMTag
*tag_b
)
343 if (tag_a
== NULL
|| tag_b
== NULL
)
346 if (tag_a
->name
== NULL
)
347 return -(tag_a
->name
!= tag_b
->name
);
349 if (tag_b
->name
== NULL
)
350 return tag_a
->name
!= tag_b
->name
;
352 ret
= strcmp(tag_a
->name
, tag_b
->name
);
355 return tag_a
->line
- tag_b
->line
;
361 /* sort by line, then scope */
362 static gint
compare_symbol_lines(gconstpointer a
, gconstpointer b
)
364 const TMTag
*tag_a
= TM_TAG(a
);
365 const TMTag
*tag_b
= TM_TAG(b
);
368 if (a
== NULL
|| b
== NULL
)
371 ret
= tag_a
->line
- tag_b
->line
;
374 if (tag_a
->scope
== NULL
)
375 return -(tag_a
->scope
!= tag_b
->scope
);
376 if (tag_b
->scope
== NULL
)
377 return tag_a
->scope
!= tag_b
->scope
;
379 return strcmp(tag_a
->scope
, tag_b
->scope
);
385 static GList
*get_tag_list(GeanyDocument
*doc
, TMTagType tag_types
)
387 GList
*tag_names
= NULL
;
391 g_return_val_if_fail(doc
, NULL
);
393 if (! doc
->tm_file
|| ! doc
->tm_file
->tags_array
)
396 for (i
= 0; i
< doc
->tm_file
->tags_array
->len
; ++i
)
398 tag
= TM_TAG(doc
->tm_file
->tags_array
->pdata
[i
]);
399 if (G_UNLIKELY(tag
== NULL
))
402 if (tag
->type
& tag_types
)
404 tag_names
= g_list_prepend(tag_names
, tag
);
407 tag_names
= g_list_sort(tag_names
, compare_symbol_lines
);
412 /* amount of types in the symbol list (currently max. 8 are used) */
413 #define MAX_SYMBOL_TYPES (sizeof(tv_iters) / sizeof(GtkTreeIter))
415 struct TreeviewSymbols
417 GtkTreeIter tag_function
;
418 GtkTreeIter tag_class
;
419 GtkTreeIter tag_macro
;
420 GtkTreeIter tag_member
;
421 GtkTreeIter tag_variable
;
422 GtkTreeIter tag_externvar
;
423 GtkTreeIter tag_namespace
;
424 GtkTreeIter tag_struct
;
425 GtkTreeIter tag_interface
;
426 GtkTreeIter tag_type
;
427 GtkTreeIter tag_other
;
431 static void init_tag_iters(void)
433 /* init all GtkTreeIters with -1 to make them invalid to avoid crashes when switching between
434 * filetypes(e.g. config file to Python crashes Geany without this) */
435 tv_iters
.tag_function
.stamp
= -1;
436 tv_iters
.tag_class
.stamp
= -1;
437 tv_iters
.tag_member
.stamp
= -1;
438 tv_iters
.tag_macro
.stamp
= -1;
439 tv_iters
.tag_variable
.stamp
= -1;
440 tv_iters
.tag_externvar
.stamp
= -1;
441 tv_iters
.tag_namespace
.stamp
= -1;
442 tv_iters
.tag_struct
.stamp
= -1;
443 tv_iters
.tag_interface
.stamp
= -1;
444 tv_iters
.tag_type
.stamp
= -1;
445 tv_iters
.tag_other
.stamp
= -1;
449 static GdkPixbuf
*get_tag_icon(const gchar
*icon_name
)
451 static GtkIconTheme
*icon_theme
= NULL
;
454 if (G_UNLIKELY(x
< 0))
457 icon_theme
= gtk_icon_theme_get_default();
458 gtk_icon_size_lookup(GTK_ICON_SIZE_MENU
, &x
, &dummy
);
460 return gtk_icon_theme_load_icon(icon_theme
, icon_name
, x
, 0, NULL
);
464 static gboolean
find_toplevel_iter(GtkTreeStore
*store
, GtkTreeIter
*iter
, const gchar
*title
)
466 GtkTreeModel
*model
= GTK_TREE_MODEL(store
);
468 if (!gtk_tree_model_get_iter_first(model
, iter
))
474 gtk_tree_model_get(model
, iter
, SYMBOLS_COLUMN_NAME
, &candidate
, -1);
475 /* FIXME: what if 2 different items have the same name?
476 * this should never happen, but might be caused by a typo in a translation */
477 if (utils_str_equal(candidate
, title
))
485 while (gtk_tree_model_iter_next(model
, iter
));
491 /* Adds symbol list groups in (iter*, title) pairs.
492 * The list must be ended with NULL. */
493 static void G_GNUC_NULL_TERMINATED
494 tag_list_add_groups(GtkTreeStore
*tree_store
, ...)
499 g_return_if_fail(top_level_iter_names
);
501 va_start(args
, tree_store
);
502 for (; iter
= va_arg(args
, GtkTreeIter
*), iter
!= NULL
;)
504 gchar
*title
= va_arg(args
, gchar
*);
505 guint icon_id
= va_arg(args
, guint
);
506 GdkPixbuf
*icon
= NULL
;
508 if (icon_id
< N_ICONS
)
509 icon
= symbols_icons
[icon_id
].pixbuf
;
511 g_assert(title
!= NULL
);
512 g_ptr_array_add(top_level_iter_names
, title
);
514 if (!find_toplevel_iter(tree_store
, iter
, title
))
515 gtk_tree_store_append(tree_store
, iter
, NULL
);
518 gtk_tree_store_set(tree_store
, iter
, SYMBOLS_COLUMN_ICON
, icon
, -1);
519 gtk_tree_store_set(tree_store
, iter
, SYMBOLS_COLUMN_NAME
, title
, -1);
525 static void add_top_level_items(GeanyDocument
*doc
)
527 GeanyFiletypeID ft_id
= doc
->file_type
->id
;
528 GtkTreeStore
*tag_store
= doc
->priv
->tag_store
;
530 if (top_level_iter_names
== NULL
)
531 top_level_iter_names
= g_ptr_array_new();
533 g_ptr_array_set_size(top_level_iter_names
, 0);
539 case GEANY_FILETYPES_DIFF
:
541 tag_list_add_groups(tag_store
,
542 &(tv_iters
.tag_function
), _("Files"), ICON_NONE
, NULL
);
545 case GEANY_FILETYPES_DOCBOOK
:
547 tag_list_add_groups(tag_store
,
548 &(tv_iters
.tag_function
), _("Chapter"), ICON_NONE
,
549 &(tv_iters
.tag_class
), _("Section"), ICON_NONE
,
550 &(tv_iters
.tag_member
), _("Sect1"), ICON_NONE
,
551 &(tv_iters
.tag_macro
), _("Sect2"), ICON_NONE
,
552 &(tv_iters
.tag_variable
), _("Sect3"), ICON_NONE
,
553 &(tv_iters
.tag_struct
), _("Appendix"), ICON_NONE
,
554 &(tv_iters
.tag_other
), _("Other"), ICON_NONE
,
558 case GEANY_FILETYPES_HASKELL
:
559 tag_list_add_groups(tag_store
,
560 &tv_iters
.tag_namespace
, _("Module"), ICON_NONE
,
561 &tv_iters
.tag_type
, _("Types"), ICON_NONE
,
562 &tv_iters
.tag_macro
, _("Type constructors"), ICON_NONE
,
563 &tv_iters
.tag_function
, _("Functions"), ICON_METHOD
,
566 case GEANY_FILETYPES_COBOL
:
567 tag_list_add_groups(tag_store
,
568 &tv_iters
.tag_class
, _("Program"), ICON_CLASS
,
569 &tv_iters
.tag_function
, _("File"), ICON_METHOD
,
570 &tv_iters
.tag_namespace
, _("Sections"), ICON_NAMESPACE
,
571 &tv_iters
.tag_macro
, _("Paragraph"), ICON_OTHER
,
572 &tv_iters
.tag_struct
, _("Group"), ICON_STRUCT
,
573 &tv_iters
.tag_variable
, _("Data"), ICON_VAR
,
576 case GEANY_FILETYPES_CONF
:
577 tag_list_add_groups(tag_store
,
578 &tv_iters
.tag_namespace
, _("Sections"), ICON_OTHER
,
579 &tv_iters
.tag_macro
, _("Keys"), ICON_VAR
,
582 case GEANY_FILETYPES_NSIS
:
583 tag_list_add_groups(tag_store
,
584 &tv_iters
.tag_namespace
, _("Sections"), ICON_OTHER
,
585 &tv_iters
.tag_function
, _("Functions"), ICON_METHOD
,
586 &(tv_iters
.tag_variable
), _("Variables"), ICON_VAR
,
589 case GEANY_FILETYPES_LATEX
:
591 tag_list_add_groups(tag_store
,
592 &(tv_iters
.tag_function
), _("Command"), ICON_NONE
,
593 &(tv_iters
.tag_class
), _("Environment"), ICON_NONE
,
594 &(tv_iters
.tag_member
), _("Section"), ICON_NONE
,
595 &(tv_iters
.tag_macro
), _("Subsection"), ICON_NONE
,
596 &(tv_iters
.tag_variable
), _("Subsubsection"), ICON_NONE
,
597 &(tv_iters
.tag_struct
), _("Label"), ICON_NONE
,
598 &(tv_iters
.tag_namespace
), _("Chapter"), ICON_NONE
,
599 &(tv_iters
.tag_other
), _("Other"), ICON_NONE
,
603 case GEANY_FILETYPES_MATLAB
:
605 tag_list_add_groups(tag_store
,
606 &(tv_iters
.tag_function
), _("Functions"), ICON_METHOD
,
607 &(tv_iters
.tag_struct
), _("Structures"), ICON_STRUCT
,
611 case GEANY_FILETYPES_ABAQUS
:
613 tag_list_add_groups(tag_store
,
614 &(tv_iters
.tag_class
), _("Parts"), ICON_NONE
,
615 &(tv_iters
.tag_member
), _("Assembly"), ICON_NONE
,
616 &(tv_iters
.tag_namespace
), _("Steps"), ICON_NONE
,
620 case GEANY_FILETYPES_R
:
622 tag_list_add_groups(tag_store
,
623 &(tv_iters
.tag_function
), _("Functions"), ICON_METHOD
,
624 &(tv_iters
.tag_other
), _("Other"), ICON_NONE
,
628 case GEANY_FILETYPES_RUST
:
630 tag_list_add_groups(tag_store
,
631 &(tv_iters
.tag_namespace
), _("Modules"), ICON_NAMESPACE
,
632 &(tv_iters
.tag_struct
), _("Structures"), ICON_STRUCT
,
633 &(tv_iters
.tag_interface
), _("Traits"), ICON_CLASS
,
634 &(tv_iters
.tag_class
), _("Implementations"), ICON_CLASS
,
635 &(tv_iters
.tag_function
), _("Functions"), ICON_METHOD
,
636 &(tv_iters
.tag_type
), _("Typedefs / Enums"), ICON_STRUCT
,
637 &(tv_iters
.tag_variable
), _("Variables"), ICON_VAR
,
638 &(tv_iters
.tag_macro
), _("Macros"), ICON_MACRO
,
639 &(tv_iters
.tag_member
), _("Methods"), ICON_MEMBER
,
640 &(tv_iters
.tag_other
), _("Other"), ICON_OTHER
,
644 case GEANY_FILETYPES_GO
:
646 tag_list_add_groups(tag_store
,
647 &(tv_iters
.tag_namespace
), _("Package"), ICON_NAMESPACE
,
648 &(tv_iters
.tag_function
), _("Functions"), ICON_METHOD
,
649 &(tv_iters
.tag_interface
), _("Interfaces"), ICON_STRUCT
,
650 &(tv_iters
.tag_struct
), _("Structs"), ICON_STRUCT
,
651 &(tv_iters
.tag_type
), _("Types"), ICON_STRUCT
,
652 &(tv_iters
.tag_macro
), _("Constants"), ICON_MACRO
,
653 &(tv_iters
.tag_variable
), _("Variables"), ICON_VAR
,
654 &(tv_iters
.tag_member
), _("Members"), ICON_MEMBER
,
655 &(tv_iters
.tag_other
), _("Other"), ICON_OTHER
,
659 case GEANY_FILETYPES_PERL
:
661 tag_list_add_groups(tag_store
,
662 &(tv_iters
.tag_namespace
), _("Package"), ICON_NAMESPACE
,
663 &(tv_iters
.tag_function
), _("Functions"), ICON_METHOD
,
664 &(tv_iters
.tag_macro
), _("Labels"), ICON_NONE
,
665 &(tv_iters
.tag_type
), _("Constants"), ICON_NONE
,
666 &(tv_iters
.tag_other
), _("Other"), ICON_OTHER
,
670 case GEANY_FILETYPES_PHP
:
671 case GEANY_FILETYPES_ZEPHIR
:
673 tag_list_add_groups(tag_store
,
674 &(tv_iters
.tag_namespace
), _("Namespaces"), ICON_NAMESPACE
,
675 &(tv_iters
.tag_interface
), _("Interfaces"), ICON_STRUCT
,
676 &(tv_iters
.tag_class
), _("Classes"), ICON_CLASS
,
677 &(tv_iters
.tag_function
), _("Functions"), ICON_METHOD
,
678 &(tv_iters
.tag_macro
), _("Constants"), ICON_MACRO
,
679 &(tv_iters
.tag_variable
), _("Variables"), ICON_VAR
,
680 &(tv_iters
.tag_struct
), _("Traits"), ICON_STRUCT
,
684 case GEANY_FILETYPES_HTML
:
686 tag_list_add_groups(tag_store
,
687 &(tv_iters
.tag_function
), _("Functions"), ICON_NONE
,
688 &(tv_iters
.tag_member
), _("Anchors"), ICON_NONE
,
689 &(tv_iters
.tag_namespace
), _("H1 Headings"), ICON_NONE
,
690 &(tv_iters
.tag_class
), _("H2 Headings"), ICON_NONE
,
691 &(tv_iters
.tag_variable
), _("H3 Headings"), ICON_NONE
,
695 case GEANY_FILETYPES_CSS
:
697 tag_list_add_groups(tag_store
,
698 &(tv_iters
.tag_class
), _("Classes"), ICON_CLASS
,
699 &(tv_iters
.tag_variable
), _("ID Selectors"), ICON_VAR
,
700 &(tv_iters
.tag_struct
), _("Type Selectors"), ICON_STRUCT
, NULL
);
703 case GEANY_FILETYPES_REST
:
704 case GEANY_FILETYPES_TXT2TAGS
:
705 case GEANY_FILETYPES_ABC
:
707 tag_list_add_groups(tag_store
,
708 &(tv_iters
.tag_namespace
), _("Chapter"), ICON_NONE
,
709 &(tv_iters
.tag_member
), _("Section"), ICON_NONE
,
710 &(tv_iters
.tag_macro
), _("Subsection"), ICON_NONE
,
711 &(tv_iters
.tag_variable
), _("Subsubsection"), ICON_NONE
,
715 case GEANY_FILETYPES_ASCIIDOC
:
717 tag_list_add_groups(tag_store
,
718 &(tv_iters
.tag_namespace
), _("Document"), ICON_NONE
,
719 &(tv_iters
.tag_member
), _("Section Level 1"), ICON_NONE
,
720 &(tv_iters
.tag_macro
), _("Section Level 2"), ICON_NONE
,
721 &(tv_iters
.tag_variable
), _("Section Level 3"), ICON_NONE
,
722 &(tv_iters
.tag_struct
), _("Section Level 4"), ICON_NONE
,
726 case GEANY_FILETYPES_RUBY
:
728 tag_list_add_groups(tag_store
,
729 &(tv_iters
.tag_namespace
), _("Modules"), ICON_NAMESPACE
,
730 &(tv_iters
.tag_class
), _("Classes"), ICON_CLASS
,
731 &(tv_iters
.tag_member
), _("Singletons"), ICON_STRUCT
,
732 &(tv_iters
.tag_function
), _("Methods"), ICON_METHOD
,
736 case GEANY_FILETYPES_TCL
:
738 tag_list_add_groups(tag_store
,
739 &(tv_iters
.tag_namespace
), _("Namespaces"), ICON_NAMESPACE
,
740 &(tv_iters
.tag_class
), _("Classes"), ICON_CLASS
,
741 &(tv_iters
.tag_member
), _("Methods"), ICON_METHOD
,
742 &(tv_iters
.tag_function
), _("Procedures"), ICON_OTHER
,
746 case GEANY_FILETYPES_PYTHON
:
748 tag_list_add_groups(tag_store
,
749 &(tv_iters
.tag_class
), _("Classes"), ICON_CLASS
,
750 &(tv_iters
.tag_member
), _("Methods"), ICON_MACRO
,
751 &(tv_iters
.tag_function
), _("Functions"), ICON_METHOD
,
752 &(tv_iters
.tag_variable
), _("Variables"), ICON_VAR
,
753 &(tv_iters
.tag_externvar
), _("Imports"), ICON_NAMESPACE
,
757 case GEANY_FILETYPES_VHDL
:
759 tag_list_add_groups(tag_store
,
760 &(tv_iters
.tag_namespace
), _("Package"), ICON_NAMESPACE
,
761 &(tv_iters
.tag_class
), _("Entities"), ICON_CLASS
,
762 &(tv_iters
.tag_struct
), _("Architectures"), ICON_STRUCT
,
763 &(tv_iters
.tag_type
), _("Types"), ICON_OTHER
,
764 &(tv_iters
.tag_function
), _("Functions / Procedures"), ICON_METHOD
,
765 &(tv_iters
.tag_variable
), _("Variables / Signals"), ICON_VAR
,
766 &(tv_iters
.tag_member
), _("Processes / Blocks / Components"), ICON_MEMBER
,
767 &(tv_iters
.tag_other
), _("Other"), ICON_OTHER
,
771 case GEANY_FILETYPES_VERILOG
:
773 tag_list_add_groups(tag_store
,
774 &(tv_iters
.tag_type
), _("Events"), ICON_MACRO
,
775 &(tv_iters
.tag_class
), _("Modules"), ICON_CLASS
,
776 &(tv_iters
.tag_function
), _("Functions / Tasks"), ICON_METHOD
,
777 &(tv_iters
.tag_variable
), _("Variables"), ICON_VAR
,
778 &(tv_iters
.tag_other
), _("Other"), ICON_OTHER
,
782 case GEANY_FILETYPES_JAVA
:
784 tag_list_add_groups(tag_store
,
785 &(tv_iters
.tag_namespace
), _("Package"), ICON_NAMESPACE
,
786 &(tv_iters
.tag_interface
), _("Interfaces"), ICON_STRUCT
,
787 &(tv_iters
.tag_class
), _("Classes"), ICON_CLASS
,
788 &(tv_iters
.tag_function
), _("Methods"), ICON_METHOD
,
789 &(tv_iters
.tag_member
), _("Members"), ICON_MEMBER
,
790 &(tv_iters
.tag_type
), _("Enums"), ICON_STRUCT
,
791 &(tv_iters
.tag_other
), _("Other"), ICON_OTHER
,
795 case GEANY_FILETYPES_AS
:
797 tag_list_add_groups(tag_store
,
798 &(tv_iters
.tag_namespace
), _("Package"), ICON_NAMESPACE
,
799 &(tv_iters
.tag_interface
), _("Interfaces"), ICON_STRUCT
,
800 &(tv_iters
.tag_class
), _("Classes"), ICON_CLASS
,
801 &(tv_iters
.tag_function
), _("Functions"), ICON_METHOD
,
802 &(tv_iters
.tag_member
), _("Properties"), ICON_MEMBER
,
803 &(tv_iters
.tag_variable
), _("Variables"), ICON_VAR
,
804 &(tv_iters
.tag_macro
), _("Constants"), ICON_MACRO
,
805 &(tv_iters
.tag_other
), _("Other"), ICON_OTHER
,
809 case GEANY_FILETYPES_HAXE
:
811 tag_list_add_groups(tag_store
,
812 &(tv_iters
.tag_interface
), _("Interfaces"), ICON_STRUCT
,
813 &(tv_iters
.tag_class
), _("Classes"), ICON_CLASS
,
814 &(tv_iters
.tag_function
), _("Methods"), ICON_METHOD
,
815 &(tv_iters
.tag_type
), _("Types"), ICON_MACRO
,
816 &(tv_iters
.tag_variable
), _("Variables"), ICON_VAR
,
817 &(tv_iters
.tag_other
), _("Other"), ICON_OTHER
,
821 case GEANY_FILETYPES_BASIC
:
823 tag_list_add_groups(tag_store
,
824 &(tv_iters
.tag_function
), _("Functions"), ICON_METHOD
,
825 &(tv_iters
.tag_variable
), _("Variables"), ICON_VAR
,
826 &(tv_iters
.tag_macro
), _("Constants"), ICON_MACRO
,
827 &(tv_iters
.tag_struct
), _("Types"), ICON_NAMESPACE
,
828 &(tv_iters
.tag_namespace
), _("Labels"), ICON_MEMBER
,
829 &(tv_iters
.tag_other
), _("Other"), ICON_OTHER
,
833 case GEANY_FILETYPES_F77
:
834 case GEANY_FILETYPES_FORTRAN
:
836 tag_list_add_groups(tag_store
,
837 &(tv_iters
.tag_namespace
), _("Module"), ICON_CLASS
,
838 &(tv_iters
.tag_struct
), _("Programs"), ICON_CLASS
,
839 &(tv_iters
.tag_interface
), _("Interfaces"), ICON_STRUCT
,
840 &(tv_iters
.tag_function
), _("Functions / Subroutines"), ICON_METHOD
,
841 &(tv_iters
.tag_variable
), _("Variables"), ICON_VAR
,
842 &(tv_iters
.tag_class
), _("Types"), ICON_CLASS
,
843 &(tv_iters
.tag_member
), _("Components"), ICON_MEMBER
,
844 &(tv_iters
.tag_macro
), _("Blocks"), ICON_MEMBER
,
845 &(tv_iters
.tag_type
), _("Enums"), ICON_STRUCT
,
846 &(tv_iters
.tag_other
), _("Other"), ICON_OTHER
,
850 case GEANY_FILETYPES_ASM
:
852 tag_list_add_groups(tag_store
,
853 &(tv_iters
.tag_namespace
), _("Labels"), ICON_NAMESPACE
,
854 &(tv_iters
.tag_function
), _("Macros"), ICON_METHOD
,
855 &(tv_iters
.tag_macro
), _("Defines"), ICON_MACRO
,
856 &(tv_iters
.tag_struct
), _("Types"), ICON_STRUCT
,
860 case GEANY_FILETYPES_MAKE
:
861 tag_list_add_groups(tag_store
,
862 &tv_iters
.tag_function
, _("Targets"), ICON_METHOD
,
863 &tv_iters
.tag_macro
, _("Macros"), ICON_MACRO
,
866 case GEANY_FILETYPES_SQL
:
868 tag_list_add_groups(tag_store
,
869 &(tv_iters
.tag_function
), _("Functions"), ICON_METHOD
,
870 &(tv_iters
.tag_namespace
), _("Procedures"), ICON_NAMESPACE
,
871 &(tv_iters
.tag_struct
), _("Indexes"), ICON_STRUCT
,
872 &(tv_iters
.tag_class
), _("Tables"), ICON_CLASS
,
873 &(tv_iters
.tag_macro
), _("Triggers"), ICON_MACRO
,
874 &(tv_iters
.tag_member
), _("Views"), ICON_VAR
,
875 &(tv_iters
.tag_other
), _("Other"), ICON_OTHER
,
876 &(tv_iters
.tag_variable
), _("Variables"), ICON_VAR
,
880 case GEANY_FILETYPES_D
:
883 if (ft_id
== GEANY_FILETYPES_D
)
884 tag_list_add_groups(tag_store
,
885 &(tv_iters
.tag_namespace
), _("Module"), ICON_NONE
, NULL
);
887 tag_list_add_groups(tag_store
,
888 &(tv_iters
.tag_namespace
), _("Namespaces"), ICON_NAMESPACE
, NULL
);
890 tag_list_add_groups(tag_store
,
891 &(tv_iters
.tag_class
), _("Classes"), ICON_CLASS
,
892 &(tv_iters
.tag_interface
), _("Interfaces"), ICON_STRUCT
,
893 &(tv_iters
.tag_function
), _("Functions"), ICON_METHOD
,
894 &(tv_iters
.tag_member
), _("Members"), ICON_MEMBER
,
895 &(tv_iters
.tag_struct
), _("Structs"), ICON_STRUCT
,
896 &(tv_iters
.tag_type
), _("Typedefs / Enums"), ICON_STRUCT
,
899 if (ft_id
!= GEANY_FILETYPES_D
)
901 tag_list_add_groups(tag_store
,
902 &(tv_iters
.tag_macro
), _("Macros"), ICON_MACRO
, NULL
);
904 tag_list_add_groups(tag_store
,
905 &(tv_iters
.tag_variable
), _("Variables"), ICON_VAR
,
906 &(tv_iters
.tag_externvar
), _("Extern Variables"), ICON_VAR
,
907 &(tv_iters
.tag_other
), _("Other"), ICON_OTHER
, NULL
);
913 /* removes toplevel items that have no children */
914 static void hide_empty_rows(GtkTreeStore
*store
)
917 gboolean cont
= TRUE
;
919 if (! gtk_tree_model_get_iter_first(GTK_TREE_MODEL(store
), &iter
))
920 return; /* stop when first iter is invalid, i.e. no elements */
924 if (! gtk_tree_model_iter_has_child(GTK_TREE_MODEL(store
), &iter
))
925 cont
= gtk_tree_store_remove(store
, &iter
);
927 cont
= gtk_tree_model_iter_next(GTK_TREE_MODEL(store
), &iter
);
932 static const gchar
*get_symbol_name(GeanyDocument
*doc
, const TMTag
*tag
, gboolean found_parent
)
935 const gchar
*scope
= tag
->scope
;
936 static GString
*buffer
= NULL
; /* buffer will be small so we can keep it for reuse */
937 gboolean doc_is_utf8
= FALSE
;
939 /* encodings_convert_to_utf8_from_charset() fails with charset "None", so skip conversion
940 * for None at this point completely */
941 if (utils_str_equal(doc
->encoding
, "UTF-8") ||
942 utils_str_equal(doc
->encoding
, "None"))
944 else /* normally the tags will always be in UTF-8 since we parse from our buffer, but a
945 * plugin might have called tm_source_file_update(), so check to be sure */
946 doc_is_utf8
= g_utf8_validate(tag
->name
, -1, NULL
);
949 utf8_name
= encodings_convert_to_utf8_from_charset(tag
->name
,
950 -1, doc
->encoding
, TRUE
);
952 utf8_name
= tag
->name
;
954 if (utf8_name
== NULL
)
958 buffer
= g_string_new(NULL
);
960 g_string_truncate(buffer
, 0);
962 /* check first char of scope is a wordchar */
963 if (!found_parent
&& scope
&&
964 strpbrk(scope
, GEANY_WORDCHARS
) == scope
)
966 const gchar
*sep
= symbols_get_context_separator(doc
->file_type
->id
);
968 g_string_append(buffer
, scope
);
969 g_string_append(buffer
, sep
);
971 g_string_append(buffer
, utf8_name
);
976 g_string_append_printf(buffer
, " [%lu]", tag
->line
);
982 static gchar
*get_symbol_tooltip(GeanyDocument
*doc
, const TMTag
*tag
)
984 gchar
*utf8_name
= editor_get_calltip_text(doc
->editor
, tag
);
986 /* encodings_convert_to_utf8_from_charset() fails with charset "None", so skip conversion
987 * for None at this point completely */
988 if (utf8_name
!= NULL
&&
989 ! utils_str_equal(doc
->encoding
, "UTF-8") &&
990 ! utils_str_equal(doc
->encoding
, "None"))
993 encodings_convert_to_utf8_from_charset(utf8_name
, -1, doc
->encoding
, TRUE
));
1000 /* find the last word in "foo::bar::blah", e.g. "blah" */
1001 static const gchar
*get_parent_name(const TMTag
*tag
, GeanyFiletypeID ft_id
)
1003 const gchar
*scope
= tag
->scope
;
1004 const gchar
*separator
= symbols_get_context_separator(ft_id
);
1005 const gchar
*str
, *ptr
;
1014 ptr
= strstr(str
, separator
);
1017 str
= ptr
+ strlen(separator
);
1023 return !EMPTY(str
) ? str
: NULL
;
1027 static GtkTreeIter
*get_tag_type_iter(TMTagType tag_type
)
1029 GtkTreeIter
*iter
= NULL
;
1033 case tm_tag_prototype_t
:
1034 case tm_tag_method_t
:
1035 case tm_tag_function_t
:
1037 iter
= &tv_iters
.tag_function
;
1040 case tm_tag_externvar_t
:
1042 iter
= &tv_iters
.tag_externvar
;
1045 case tm_tag_macro_t
:
1046 case tm_tag_macro_with_arg_t
:
1048 iter
= &tv_iters
.tag_macro
;
1051 case tm_tag_class_t
:
1053 iter
= &tv_iters
.tag_class
;
1056 case tm_tag_member_t
:
1057 case tm_tag_field_t
:
1059 iter
= &tv_iters
.tag_member
;
1062 case tm_tag_typedef_t
:
1065 iter
= &tv_iters
.tag_type
;
1068 case tm_tag_union_t
:
1069 case tm_tag_struct_t
:
1071 iter
= &tv_iters
.tag_struct
;
1074 case tm_tag_interface_t
:
1075 iter
= &tv_iters
.tag_interface
;
1077 case tm_tag_variable_t
:
1079 iter
= &tv_iters
.tag_variable
;
1082 case tm_tag_namespace_t
:
1083 case tm_tag_package_t
:
1085 iter
= &tv_iters
.tag_namespace
;
1090 iter
= &tv_iters
.tag_other
;
1093 if (G_LIKELY(iter
->stamp
!= -1))
1100 static GdkPixbuf
*get_child_icon(GtkTreeStore
*tree_store
, GtkTreeIter
*parent
)
1102 GdkPixbuf
*icon
= NULL
;
1104 if (parent
== &tv_iters
.tag_other
)
1106 return g_object_ref(symbols_icons
[ICON_VAR
].pixbuf
);
1108 /* copy parent icon */
1109 gtk_tree_model_get(GTK_TREE_MODEL(tree_store
), parent
,
1110 SYMBOLS_COLUMN_ICON
, &icon
, -1);
1115 static gboolean
tag_equal(gconstpointer v1
, gconstpointer v2
)
1117 const TMTag
*t1
= v1
;
1118 const TMTag
*t2
= v2
;
1120 return (t1
->type
== t2
->type
&& strcmp(t1
->name
, t2
->name
) == 0 &&
1121 utils_str_equal(t1
->scope
, t2
->scope
) &&
1122 /* include arglist in match to support e.g. C++ overloading */
1123 utils_str_equal(t1
->arglist
, t2
->arglist
));
1127 /* inspired from g_str_hash() */
1128 static guint
tag_hash(gconstpointer v
)
1130 const TMTag
*tag
= v
;
1134 h
= (h
<< 5) + h
+ tag
->type
;
1135 for (p
= tag
->name
; *p
!= '\0'; p
++)
1136 h
= (h
<< 5) + h
+ *p
;
1139 for (p
= tag
->scope
; *p
!= '\0'; p
++)
1140 h
= (h
<< 5) + h
+ *p
;
1142 /* for e.g. C++ overloading */
1145 for (p
= tag
->arglist
; *p
!= '\0'; p
++)
1146 h
= (h
<< 5) + h
+ *p
;
1153 /* like gtk_tree_view_expand_to_path() but with an iter */
1154 static void tree_view_expand_to_iter(GtkTreeView
*view
, GtkTreeIter
*iter
)
1156 GtkTreeModel
*model
= gtk_tree_view_get_model(view
);
1157 GtkTreePath
*path
= gtk_tree_model_get_path(model
, iter
);
1159 gtk_tree_view_expand_to_path(view
, path
);
1160 gtk_tree_path_free(path
);
1164 /* like gtk_tree_store_remove() but finds the next iter at any level */
1165 static gboolean
tree_store_remove_row(GtkTreeStore
*store
, GtkTreeIter
*iter
)
1168 gboolean has_parent
;
1171 has_parent
= gtk_tree_model_iter_parent(GTK_TREE_MODEL(store
), &parent
, iter
);
1172 cont
= gtk_tree_store_remove(store
, iter
);
1173 /* if there is no next at this level but there is a parent iter, continue from it */
1174 if (! cont
&& has_parent
)
1177 cont
= ui_tree_model_iter_any_next(GTK_TREE_MODEL(store
), iter
, FALSE
);
1184 /* adds a new element in the parent table if it's key is known.
1185 * duplicates are kept */
1186 static void update_parents_table(GHashTable
*table
, const TMTag
*tag
, const gchar
*parent_name
,
1187 const GtkTreeIter
*iter
)
1190 if (g_hash_table_lookup_extended(table
, tag
->name
, NULL
, (gpointer
*) &list
) &&
1191 ! utils_str_equal(parent_name
, tag
->name
) /* prevent Foo::Foo from making parent = child */)
1195 list
= g_slice_alloc(sizeof *list
);
1197 g_hash_table_insert(table
, tag
->name
, list
);
1199 *list
= g_list_prepend(*list
, g_slice_dup(GtkTreeIter
, iter
));
1204 static void free_iter_slice_list(gpointer data
)
1206 GList
**list
= data
;
1211 foreach_list(node
, *list
)
1212 g_slice_free(GtkTreeIter
, node
->data
);
1214 g_slice_free1(sizeof *list
, list
);
1219 /* inserts a @data in @table on key @tag.
1220 * previous data is not overwritten if the key is duplicated, but rather the
1221 * two values are kept in a list
1223 * table is: GHashTable<TMTag, GList<GList<TMTag>>> */
1224 static void tags_table_insert(GHashTable
*table
, TMTag
*tag
, GList
*data
)
1226 GList
*list
= g_hash_table_lookup(table
, tag
);
1227 list
= g_list_prepend(list
, data
);
1228 g_hash_table_insert(table
, tag
, list
);
1232 /* looks up the entry in @table that better matches @tag.
1233 * if there are more than one candidate, the one that has closest line position to @tag is chosen */
1234 static GList
*tags_table_lookup(GHashTable
*table
, TMTag
*tag
)
1237 GList
*node
= g_hash_table_lookup(table
, tag
);
1243 #define TAG_DELTA(a, b) ABS((glong) TM_TAG(a)->line - (glong) TM_TAG(b)->line)
1245 delta
= TAG_DELTA(((GList
*) node
->data
)->data
, tag
);
1246 for (node
= node
->next
; node
; node
= node
->next
)
1248 glong d
= TAG_DELTA(((GList
*) node
->data
)->data
, tag
);
1264 /* removes the element at @tag from @table.
1265 * @tag must be the exact pointer used at insertion time */
1266 static void tags_table_remove(GHashTable
*table
, TMTag
*tag
)
1268 GList
*list
= g_hash_table_lookup(table
, tag
);
1272 foreach_list(node
, list
)
1274 if (((GList
*) node
->data
)->data
== tag
)
1277 list
= g_list_delete_link(list
, node
);
1279 g_hash_table_insert(table
, tag
, list
);
1281 g_hash_table_remove(table
, tag
);
1286 static void tags_table_destroy(GHashTable
*table
)
1288 /* free any leftover elements. note that we can't register a value_free_func when
1289 * creating the hash table because we only want to free it when destroying the table,
1290 * not when inserting a duplicate (we handle this manually) */
1291 GHashTableIter iter
;
1294 g_hash_table_iter_init(&iter
, table
);
1295 while (g_hash_table_iter_next(&iter
, NULL
, &value
))
1297 g_hash_table_destroy(table
);
1302 * Updates the tag tree for a document with the tags in *list.
1303 * @param doc a document
1304 * @param tags a pointer to a GList* holding the tags to add/update. This
1305 * list may be updated, removing updated elements.
1307 * The update is done in two passes:
1308 * 1) walking the current tree, update tags that still exist and remove the
1310 * 2) walking the remaining (non updated) tags, adds them in the list.
1312 * For better performances, we use 2 hash tables:
1313 * - one containing all the tags for lookup in the first pass (actually stores a
1314 * reference in the tags list for removing it efficiently), avoiding list search
1316 * - the other holding "tag-name":row references for tags having children, used to
1317 * lookup for a parent in both passes, avoiding tree traversal.
1319 static void update_tree_tags(GeanyDocument
*doc
, GList
**tags
)
1321 GtkTreeStore
*store
= doc
->priv
->tag_store
;
1322 GtkTreeModel
*model
= GTK_TREE_MODEL(store
);
1323 GHashTable
*parents_table
;
1324 GHashTable
*tags_table
;
1329 /* Build hash tables holding tags and parents */
1330 /* parent table holds "tag-name":GtkTreeIter */
1331 parents_table
= g_hash_table_new_full(g_str_hash
, g_str_equal
, NULL
, free_iter_slice_list
);
1332 /* tags table is another representation of the @tags list, TMTag:GList<TMTag> */
1333 tags_table
= g_hash_table_new_full(tag_hash
, tag_equal
, NULL
, NULL
);
1334 foreach_list(item
, *tags
)
1336 TMTag
*tag
= item
->data
;
1339 tags_table_insert(tags_table
, tag
, item
);
1341 name
= get_parent_name(tag
, doc
->file_type
->id
);
1343 g_hash_table_insert(parents_table
, (gpointer
) name
, NULL
);
1346 /* First pass, update existing rows or delete them.
1347 * It is OK to delete them since we walk top down so we would remove
1348 * parents before checking for their children, thus never implicitly
1349 * deleting an updated child */
1350 cont
= gtk_tree_model_get_iter_first(model
, &iter
);
1355 gtk_tree_model_get(model
, &iter
, SYMBOLS_COLUMN_TAG
, &tag
, -1);
1356 if (! tag
) /* most probably a toplevel, skip it */
1357 cont
= ui_tree_model_iter_any_next(model
, &iter
, TRUE
);
1362 found_item
= tags_table_lookup(tags_table
, tag
);
1363 if (! found_item
) /* tag doesn't exist, remove it */
1364 cont
= tree_store_remove_row(store
, &iter
);
1365 else /* tag still exist, update it */
1367 const gchar
*parent_name
;
1368 TMTag
*found
= found_item
->data
;
1370 parent_name
= get_parent_name(found
, doc
->file_type
->id
);
1371 /* if parent is unknown, ignore it */
1372 if (parent_name
&& ! g_hash_table_lookup(parents_table
, parent_name
))
1375 if (!tm_tags_equal(tag
, found
))
1380 /* only update fields that (can) have changed (name that holds line
1381 * number, tooltip, and the tag itself) */
1382 name
= get_symbol_name(doc
, found
, parent_name
!= NULL
);
1383 tooltip
= get_symbol_tooltip(doc
, found
);
1384 gtk_tree_store_set(store
, &iter
,
1385 SYMBOLS_COLUMN_NAME
, name
,
1386 SYMBOLS_COLUMN_TOOLTIP
, tooltip
,
1387 SYMBOLS_COLUMN_TAG
, found
,
1392 update_parents_table(parents_table
, found
, parent_name
, &iter
);
1394 /* remove the updated tag from the table and list */
1395 tags_table_remove(tags_table
, found
);
1396 *tags
= g_list_delete_link(*tags
, found_item
);
1398 cont
= ui_tree_model_iter_any_next(model
, &iter
, TRUE
);
1405 /* Second pass, now we have a tree cleaned up from invalid rows,
1406 * we simply add new ones */
1407 foreach_list (item
, *tags
)
1409 TMTag
*tag
= item
->data
;
1410 GtkTreeIter
*parent
;
1412 parent
= get_tag_type_iter(tag
->type
);
1413 if (G_UNLIKELY(! parent
))
1414 geany_debug("Missing symbol-tree parent iter for type %d!", tag
->type
);
1419 const gchar
*parent_name
;
1421 GdkPixbuf
*icon
= get_child_icon(store
, parent
);
1423 parent_name
= get_parent_name(tag
, doc
->file_type
->id
);
1427 GtkTreeIter
*parent_search
= NULL
;
1429 /* walk parent candidates to find the better one.
1430 * if there are more than one, take the one that has the closest line number
1431 * after the tag we're searching the parent for */
1432 candidates
= g_hash_table_lookup(parents_table
, parent_name
);
1436 glong delta
= G_MAXLONG
;
1437 foreach_list(node
, *candidates
)
1442 gtk_tree_model_get(GTK_TREE_MODEL(store
), node
->data
,
1443 SYMBOLS_COLUMN_TAG
, &parent_tag
, -1);
1445 d
= tag
->line
- parent_tag
->line
;
1446 if (! parent_search
|| (d
>= 0 && d
< delta
))
1449 parent_search
= node
->data
;
1451 tm_tag_unref(parent_tag
);
1456 parent
= parent_search
;
1461 /* only expand to the iter if the parent was empty, otherwise we let the
1462 * folding as it was before (already expanded, or closed by the user) */
1463 expand
= ! gtk_tree_model_iter_has_child(model
, parent
);
1465 /* insert the new element */
1466 name
= get_symbol_name(doc
, tag
, parent_name
!= NULL
);
1467 tooltip
= get_symbol_tooltip(doc
, tag
);
1468 gtk_tree_store_insert_with_values(store
, &iter
, parent
, 0,
1469 SYMBOLS_COLUMN_NAME
, name
,
1470 SYMBOLS_COLUMN_TOOLTIP
, tooltip
,
1471 SYMBOLS_COLUMN_ICON
, icon
,
1472 SYMBOLS_COLUMN_TAG
, tag
,
1476 g_object_unref(icon
);
1478 update_parents_table(parents_table
, tag
, parent_name
, &iter
);
1481 tree_view_expand_to_iter(GTK_TREE_VIEW(doc
->priv
->tag_tree
), &iter
);
1485 g_hash_table_destroy(parents_table
);
1486 tags_table_destroy(tags_table
);
1490 /* we don't want to sort 1st-level nodes, but we can't return 0 because the tree sort
1491 * is not stable, so the order is already lost. */
1492 static gint
compare_top_level_names(const gchar
*a
, const gchar
*b
)
1497 /* This should never happen as it would mean that two or more top
1498 * level items have the same name but it can happen by typos in the translations. */
1499 if (utils_str_equal(a
, b
))
1502 foreach_ptr_array(name
, i
, top_level_iter_names
)
1504 if (utils_str_equal(name
, a
))
1506 if (utils_str_equal(name
, b
))
1509 g_warning("Couldn't find top level node '%s' or '%s'!", a
, b
);
1514 static gboolean
tag_has_missing_parent(const TMTag
*tag
, GtkTreeStore
*store
,
1517 /* if the tag has a parent tag, it should be at depth >= 2 */
1518 return !EMPTY(tag
->scope
) &&
1519 gtk_tree_store_iter_depth(store
, iter
) == 1;
1523 static gint
tree_sort_func(GtkTreeModel
*model
, GtkTreeIter
*a
, GtkTreeIter
*b
,
1526 gboolean sort_by_name
= GPOINTER_TO_INT(user_data
);
1527 TMTag
*tag_a
, *tag_b
;
1530 gtk_tree_model_get(model
, a
, SYMBOLS_COLUMN_TAG
, &tag_a
, -1);
1531 gtk_tree_model_get(model
, b
, SYMBOLS_COLUMN_TAG
, &tag_b
, -1);
1533 /* Check if the iters can be sorted based on tag name and line, not tree item name.
1534 * Sort by tree name if the scope was prepended, e.g. 'ScopeNameWithNoTag::TagName'. */
1535 if (tag_a
&& !tag_has_missing_parent(tag_a
, GTK_TREE_STORE(model
), a
) &&
1536 tag_b
&& !tag_has_missing_parent(tag_b
, GTK_TREE_STORE(model
), b
))
1538 cmp
= sort_by_name
? compare_symbol(tag_a
, tag_b
) :
1539 compare_symbol_lines(tag_a
, tag_b
);
1545 gtk_tree_model_get(model
, a
, SYMBOLS_COLUMN_NAME
, &astr
, -1);
1546 gtk_tree_model_get(model
, b
, SYMBOLS_COLUMN_NAME
, &bstr
, -1);
1548 /* if a is toplevel, b must be also */
1549 if (gtk_tree_store_iter_depth(GTK_TREE_STORE(model
), a
) == 0)
1551 cmp
= compare_top_level_names(astr
, bstr
);
1555 /* this is what g_strcmp0() does */
1557 cmp
= -(astr
!= bstr
);
1562 cmp
= strcmp(astr
, bstr
);
1564 /* sort duplicate 'ScopeName::OverloadedTagName' items by line as well */
1566 if (!sort_by_name
||
1567 (utils_str_equal(tag_a
->name
, tag_b
->name
) &&
1568 utils_str_equal(tag_a
->scope
, tag_b
->scope
)))
1569 cmp
= compare_symbol_lines(tag_a
, tag_b
);
1575 tm_tag_unref(tag_a
);
1576 tm_tag_unref(tag_b
);
1582 static void sort_tree(GtkTreeStore
*store
, gboolean sort_by_name
)
1584 gtk_tree_sortable_set_sort_func(GTK_TREE_SORTABLE(store
), SYMBOLS_COLUMN_NAME
, tree_sort_func
,
1585 GINT_TO_POINTER(sort_by_name
), NULL
);
1587 gtk_tree_sortable_set_sort_column_id(GTK_TREE_SORTABLE(store
), SYMBOLS_COLUMN_NAME
, GTK_SORT_ASCENDING
);
1591 gboolean
symbols_recreate_tag_list(GeanyDocument
*doc
, gint sort_mode
)
1595 g_return_val_if_fail(DOC_VALID(doc
), FALSE
);
1597 tags
= get_tag_list(doc
, tm_tag_max_t
);
1601 /* FIXME: Not sure why we detached the model here? */
1603 /* disable sorting during update because the code doesn't support correctly
1604 * models that are currently being built */
1605 gtk_tree_sortable_set_sort_column_id(GTK_TREE_SORTABLE(doc
->priv
->tag_store
), GTK_TREE_SORTABLE_UNSORTED_SORT_COLUMN_ID
, 0);
1607 /* add grandparent type iters */
1608 add_top_level_items(doc
);
1610 update_tree_tags(doc
, &tags
);
1613 hide_empty_rows(doc
->priv
->tag_store
);
1615 if (sort_mode
== SYMBOLS_SORT_USE_PREVIOUS
)
1616 sort_mode
= doc
->priv
->symbol_list_sort_mode
;
1618 sort_tree(doc
->priv
->tag_store
, sort_mode
== SYMBOLS_SORT_BY_NAME
);
1619 doc
->priv
->symbol_list_sort_mode
= sort_mode
;
1625 /* Detects a global tags filetype from the *.lang.* language extension.
1626 * Returns NULL if there was no matching TM language. */
1627 static GeanyFiletype
*detect_global_tags_filetype(const gchar
*utf8_filename
)
1630 gchar
*shortname
= utils_strdupa(utf8_filename
);
1631 GeanyFiletype
*ft
= NULL
;
1633 tags_ext
= g_strrstr(shortname
, ".tags");
1636 *tags_ext
= '\0'; /* remove .tags extension */
1637 ft
= filetypes_detect_from_extension(shortname
);
1638 if (ft
->id
!= GEANY_FILETYPES_NONE
)
1645 /* Adapted from anjuta-2.0.2/global-tags/tm_global_tags.c, thanks.
1646 * Needs full paths for filenames, except for C/C++ tag files, when CFLAGS includes
1647 * the relevant path.
1649 * CFLAGS=-I/home/user/libname-1.x geany -g libname.d.tags libname.h */
1650 int symbols_generate_global_tags(int argc
, char **argv
, gboolean want_preprocess
)
1652 /* -E pre-process, -dD output user macros, -p prof info (?) */
1653 const char pre_process
[] = "gcc -E -dD -p -I.";
1657 /* Create global taglist */
1660 const char *tags_file
= argv
[1];
1664 utf8_fname
= utils_get_utf8_from_locale(tags_file
);
1665 ft
= detect_global_tags_filetype(utf8_fname
);
1670 g_printerr(_("Unknown filetype extension for \"%s\".\n"), tags_file
);
1673 /* load config in case of custom filetypes */
1674 filetypes_load_config(ft
->id
, FALSE
);
1676 /* load ignore list for C/C++ parser */
1677 if (ft
->id
== GEANY_FILETYPES_C
|| ft
->id
== GEANY_FILETYPES_CPP
)
1678 load_c_ignore_tags();
1680 if (want_preprocess
&& (ft
->id
== GEANY_FILETYPES_C
|| ft
->id
== GEANY_FILETYPES_CPP
))
1682 const gchar
*cflags
= getenv("CFLAGS");
1683 command
= g_strdup_printf("%s %s", pre_process
, FALLBACK(cflags
, ""));
1686 command
= NULL
; /* don't preprocess */
1688 geany_debug("Generating %s tags file.", ft
->name
);
1690 status
= tm_workspace_create_global_tags(command
, (const char **) (argv
+ 2),
1691 argc
- 2, tags_file
, ft
->lang
);
1693 symbols_finalize(); /* free c_tags_ignore data */
1696 g_printerr(_("Failed to create tags file, perhaps because no symbols "
1703 g_printerr(_("Usage: %s -g <Tags File> <File list>\n\n"), argv
[0]);
1704 g_printerr(_("Example:\n"
1705 "CFLAGS=`pkg-config gtk+-2.0 --cflags` %s -g gtk2.c.tags"
1706 " /usr/include/gtk-2.0/gtk/gtk.h\n"), argv
[0]);
1713 void symbols_show_load_tags_dialog(void)
1716 GtkFileFilter
*filter
;
1718 dialog
= gtk_file_chooser_dialog_new(_("Load Tags File"), GTK_WINDOW(main_widgets
.window
),
1719 GTK_FILE_CHOOSER_ACTION_OPEN
,
1720 GTK_STOCK_CANCEL
, GTK_RESPONSE_CANCEL
,
1721 GTK_STOCK_OPEN
, GTK_RESPONSE_OK
,
1723 gtk_widget_set_name(dialog
, "GeanyDialog");
1724 filter
= gtk_file_filter_new();
1725 gtk_file_filter_set_name(filter
, _("Geany tags file (*.*.tags)"));
1726 gtk_file_filter_add_pattern(filter
, "*.*.tags");
1727 gtk_file_chooser_add_filter(GTK_FILE_CHOOSER(dialog
), filter
);
1729 if (gtk_dialog_run(GTK_DIALOG(dialog
)) == GTK_RESPONSE_OK
)
1731 GSList
*flist
= gtk_file_chooser_get_filenames(GTK_FILE_CHOOSER(dialog
));
1734 for (item
= flist
; item
!= NULL
; item
= g_slist_next(item
))
1736 gchar
*fname
= item
->data
;
1740 utf8_fname
= utils_get_utf8_from_locale(fname
);
1741 ft
= detect_global_tags_filetype(utf8_fname
);
1743 if (ft
!= NULL
&& symbols_load_global_tags(fname
, ft
))
1744 /* For translators: the first wildcard is the filetype, the second the filename */
1745 ui_set_statusbar(TRUE
, _("Loaded %s tags file '%s'."),
1746 filetypes_get_display_name(ft
), utf8_fname
);
1748 ui_set_statusbar(TRUE
, _("Could not load tags file '%s'."), utf8_fname
);
1753 g_slist_free(flist
);
1755 gtk_widget_destroy(dialog
);
1759 static void init_user_tags(void)
1761 GSList
*file_list
= NULL
, *list
= NULL
;
1765 dir
= g_build_filename(app
->configdir
, "tags", NULL
);
1766 /* create the user tags dir for next time if it doesn't exist */
1767 if (! g_file_test(dir
, G_FILE_TEST_IS_DIR
))
1768 utils_mkdir(dir
, FALSE
);
1769 file_list
= utils_get_file_list_full(dir
, TRUE
, FALSE
, NULL
);
1771 SETPTR(dir
, g_build_filename(app
->datadir
, "tags", NULL
));
1772 list
= utils_get_file_list_full(dir
, TRUE
, FALSE
, NULL
);
1775 file_list
= g_slist_concat(file_list
, list
);
1777 /* populate the filetype-specific tag files lists */
1778 for (node
= file_list
; node
!= NULL
; node
= node
->next
)
1780 gchar
*fname
= node
->data
;
1781 gchar
*utf8_fname
= utils_get_utf8_from_locale(fname
);
1782 GeanyFiletype
*ft
= detect_global_tags_filetype(utf8_fname
);
1786 if (FILETYPE_ID(ft
) != GEANY_FILETYPES_NONE
)
1787 ft
->priv
->tag_files
= g_slist_prepend(ft
->priv
->tag_files
, fname
);
1790 geany_debug("Unknown filetype for file '%s'.", fname
);
1795 /* don't need to delete list contents because they are now stored in
1796 * ft->priv->tag_files */
1797 g_slist_free(file_list
);
1801 static void load_user_tags(GeanyFiletypeID ft_id
)
1803 static guchar
*tags_loaded
= NULL
;
1804 static gboolean init_tags
= FALSE
;
1806 GeanyFiletype
*ft
= filetypes
[ft_id
];
1808 g_return_if_fail(ft_id
> 0);
1811 tags_loaded
= g_new0(guchar
, filetypes_array
->len
);
1812 if (tags_loaded
[ft_id
])
1814 tags_loaded
[ft_id
] = TRUE
; /* prevent reloading */
1822 for (node
= ft
->priv
->tag_files
; node
!= NULL
; node
= g_slist_next(node
))
1824 const gchar
*fname
= node
->data
;
1826 symbols_load_global_tags(fname
, ft
);
1831 static void on_goto_popup_item_activate(GtkMenuItem
*item
, TMTag
*tag
)
1833 GeanyDocument
*new_doc
, *old_doc
;
1835 g_return_if_fail(tag
);
1837 old_doc
= document_get_current();
1838 new_doc
= document_open_file(tag
->file
->file_name
, FALSE
, NULL
, NULL
);
1841 navqueue_goto_line(old_doc
, new_doc
, tag
->line
);
1845 /* FIXME: use the same icons as in the symbols tree defined in add_top_level_items() */
1846 static guint
get_tag_class(const TMTag
*tag
)
1850 case tm_tag_prototype_t
:
1851 case tm_tag_method_t
:
1852 case tm_tag_function_t
:
1854 case tm_tag_variable_t
:
1855 case tm_tag_externvar_t
:
1857 case tm_tag_macro_t
:
1858 case tm_tag_macro_with_arg_t
:
1860 case tm_tag_class_t
:
1862 case tm_tag_member_t
:
1863 case tm_tag_field_t
:
1865 case tm_tag_typedef_t
:
1867 case tm_tag_union_t
:
1868 case tm_tag_struct_t
:
1870 case tm_tag_namespace_t
:
1871 case tm_tag_package_t
:
1872 return ICON_NAMESPACE
;
1880 /* positions a popup at the caret from the ScintillaObject in @p data */
1881 static void goto_popup_position_func(GtkMenu
*menu
, gint
*x
, gint
*y
, gboolean
*push_in
, gpointer data
)
1884 GdkScreen
*screen
= gtk_widget_get_screen(GTK_WIDGET(menu
));
1886 GdkRectangle monitor
;
1888 GdkEventButton
*event_button
= g_object_get_data(G_OBJECT(menu
), "geany-button-event");
1892 /* if we got a mouse click, popup at that position */
1893 *x
= (gint
) event_button
->x_root
;
1894 *y
= (gint
) event_button
->y_root
;
1895 line_height
= 0; /* we don't want to offset below the line or anything */
1897 else /* keyboard positioning */
1899 ScintillaObject
*sci
= data
;
1900 GdkWindow
*window
= gtk_widget_get_window(GTK_WIDGET(sci
));
1901 gint pos
= sci_get_current_position(sci
);
1902 gint line
= sci_get_line_from_position(sci
, pos
);
1903 gint pos_x
= scintilla_send_message(sci
, SCI_POINTXFROMPOSITION
, 0, pos
);
1904 gint pos_y
= scintilla_send_message(sci
, SCI_POINTYFROMPOSITION
, 0, pos
);
1906 line_height
= scintilla_send_message(sci
, SCI_TEXTHEIGHT
, line
, 0);
1908 gdk_window_get_origin(window
, x
, y
);
1913 monitor_num
= gdk_screen_get_monitor_at_point(screen
, *x
, *y
);
1915 #if GTK_CHECK_VERSION(3, 0, 0)
1916 gtk_widget_get_preferred_size(GTK_WIDGET(menu
), NULL
, &req
);
1918 gtk_widget_size_request(GTK_WIDGET(menu
), &req
);
1921 #if GTK_CHECK_VERSION(3, 4, 0)
1922 gdk_screen_get_monitor_workarea(screen
, monitor_num
, &monitor
);
1924 gdk_screen_get_monitor_geometry(screen
, monitor_num
, &monitor
);
1927 /* put on one size of the X position, but within the monitor */
1928 if (gtk_widget_get_direction(GTK_WIDGET(menu
)) == GTK_TEXT_DIR_RTL
)
1930 if (*x
- req
.width
- 1 >= monitor
.x
)
1931 *x
-= req
.width
+ 1;
1932 else if (*x
+ req
.width
> monitor
.x
+ monitor
.width
)
1939 if (*x
+ req
.width
+ 1 <= monitor
.x
+ monitor
.width
)
1940 *x
= MAX(monitor
.x
, *x
+ 1);
1941 else if (*x
- req
.width
- 1 >= monitor
.x
)
1942 *x
-= req
.width
+ 1;
1944 *x
= monitor
.x
+ MAX(0, monitor
.width
- req
.width
);
1947 /* try to put, in order:
1948 * 1. below the Y position, under the line
1949 * 2. above the Y position
1950 * 3. within the monitor */
1951 if (*y
+ line_height
+ req
.height
<= monitor
.y
+ monitor
.height
)
1952 *y
= MAX(monitor
.y
, *y
+ line_height
);
1953 else if (*y
- req
.height
>= monitor
.y
)
1954 *y
= *y
- req
.height
;
1956 *y
= monitor
.y
+ MAX(0, monitor
.height
- req
.height
);
1962 static void show_goto_popup(GeanyDocument
*doc
, GPtrArray
*tags
, gboolean have_best
)
1964 GtkWidget
*first
= NULL
;
1967 GdkEventButton
*button_event
= NULL
;
1971 menu
= gtk_menu_new();
1973 foreach_ptr_array(tmtag
, i
, tags
)
1978 gchar
*fname
= g_path_get_basename(tmtag
->file
->file_name
);
1981 if (! first
&& have_best
)
1982 /* For translators: it's the filename and line number of a symbol in the goto-symbol popup menu */
1983 text
= g_markup_printf_escaped(_("<b>%s: %lu</b>"), fname
, tmtag
->line
);
1985 /* For translators: it's the filename and line number of a symbol in the goto-symbol popup menu */
1986 text
= g_markup_printf_escaped(_("%s: %lu"), fname
, tmtag
->line
);
1988 image
= gtk_image_new_from_pixbuf(symbols_icons
[get_tag_class(tmtag
)].pixbuf
);
1989 label
= g_object_new(GTK_TYPE_LABEL
, "label", text
, "use-markup", TRUE
, "xalign", 0.0, NULL
);
1990 item
= g_object_new(GTK_TYPE_IMAGE_MENU_ITEM
, "image", image
, "child", label
, NULL
);
1991 g_signal_connect_data(item
, "activate", G_CALLBACK(on_goto_popup_item_activate
),
1992 tm_tag_ref(tmtag
), (GClosureNotify
) tm_tag_unref
, 0);
1993 gtk_menu_shell_append(GTK_MENU_SHELL(menu
), item
);
2002 gtk_widget_show_all(menu
);
2004 if (first
) /* always select the first item for better keyboard navigation */
2005 g_signal_connect(menu
, "realize", G_CALLBACK(gtk_menu_shell_select_item
), first
);
2007 event
= gtk_get_current_event();
2008 if (event
&& event
->type
== GDK_BUTTON_PRESS
)
2009 button_event
= (GdkEventButton
*) event
;
2011 gdk_event_free(event
);
2013 g_object_set_data_full(G_OBJECT(menu
), "geany-button-event", button_event
,
2014 button_event
? (GDestroyNotify
) gdk_event_free
: NULL
);
2015 gtk_menu_popup(GTK_MENU(menu
), NULL
, NULL
, goto_popup_position_func
, doc
->editor
->sci
,
2016 button_event
? button_event
->button
: 0, gtk_get_current_event_time ());
2020 static gint
compare_tags_by_name_line(gconstpointer ptr1
, gconstpointer ptr2
)
2023 TMTag
*t1
= *((TMTag
**) ptr1
);
2024 TMTag
*t2
= *((TMTag
**) ptr2
);
2026 res
= g_strcmp0(t1
->file
->short_name
, t2
->file
->short_name
);
2029 return t1
->line
- t2
->line
;
2033 static TMTag
*find_best_goto_tag(GeanyDocument
*doc
, GPtrArray
*tags
)
2038 /* first check if we have a tag in the current file */
2039 foreach_ptr_array(tag
, i
, tags
)
2041 if (g_strcmp0(doc
->real_path
, tag
->file
->file_name
) == 0)
2045 /* next check if we have a tag for some of the open documents */
2046 foreach_ptr_array(tag
, i
, tags
)
2052 if (g_strcmp0(documents
[j
]->real_path
, tag
->file
->file_name
) == 0)
2057 /* next check if we have a tag for a file inside the current document's directory */
2058 foreach_ptr_array(tag
, i
, tags
)
2060 gchar
*dir
= g_path_get_dirname(doc
->real_path
);
2062 if (g_str_has_prefix(tag
->file
->file_name
, dir
))
2074 static gboolean
goto_tag(const gchar
*name
, gboolean definition
)
2076 const TMTagType forward_types
= tm_tag_prototype_t
| tm_tag_externvar_t
;
2078 TMTag
*tmtag
= NULL
;
2079 GeanyDocument
*old_doc
= document_get_current();
2080 gboolean found
= FALSE
;
2081 const GPtrArray
*all_tags
;
2082 GPtrArray
*workspace_tags
;
2085 /* goto tag definition: all except prototypes / forward declarations / externs */
2086 type
= (definition
) ? tm_tag_max_t
- forward_types
: forward_types
;
2087 all_tags
= tm_workspace_find(name
, NULL
, type
, NULL
, old_doc
->file_type
->lang
);
2089 /* get rid of global tags */
2090 workspace_tags
= g_ptr_array_new();
2091 foreach_ptr_array(tmtag
, i
, all_tags
)
2094 g_ptr_array_add(workspace_tags
, tmtag
);
2097 if (workspace_tags
->len
== 1)
2099 GeanyDocument
*new_doc
;
2101 tmtag
= workspace_tags
->pdata
[0];
2102 new_doc
= document_find_by_real_path(
2103 tmtag
->file
->file_name
);
2107 /* If we are already on the tag line, swap definition/declaration */
2108 if (new_doc
== old_doc
&&
2109 tmtag
->line
== (guint
)sci_get_current_line(old_doc
->editor
->sci
) + 1)
2111 if (goto_tag(name
, !definition
))
2117 /* not found in opened document, should open */
2118 new_doc
= document_open_file(tmtag
->file
->file_name
, FALSE
, NULL
, NULL
);
2121 if (!found
&& navqueue_goto_line(old_doc
, new_doc
, tmtag
->line
))
2124 else if (workspace_tags
->len
> 1)
2127 TMTag
*tag
, *best_tag
;
2129 g_ptr_array_sort(workspace_tags
, compare_tags_by_name_line
);
2130 best_tag
= find_best_goto_tag(old_doc
, workspace_tags
);
2132 tags
= g_ptr_array_new();
2134 g_ptr_array_add(tags
, best_tag
);
2135 foreach_ptr_array(tag
, i
, workspace_tags
)
2137 if (tag
!= best_tag
)
2138 g_ptr_array_add(tags
, tag
);
2140 show_goto_popup(old_doc
, tags
, best_tag
!= NULL
);
2142 g_ptr_array_free(tags
, TRUE
);
2146 g_ptr_array_free(workspace_tags
, TRUE
);
2152 gboolean
symbols_goto_tag(const gchar
*name
, gboolean definition
)
2154 if (goto_tag(name
, definition
))
2157 /* if we are here, there was no match and we are beeping ;-) */
2161 ui_set_statusbar(FALSE
, _("Forward declaration \"%s\" not found."), name
);
2163 ui_set_statusbar(FALSE
, _("Definition of \"%s\" not found."), name
);
2168 /* This could perhaps be improved to check for #if, class etc. */
2169 static gint
get_function_fold_number(GeanyDocument
*doc
)
2171 /* for Java the functions are always one fold level above the class scope */
2172 if (doc
->file_type
->id
== GEANY_FILETYPES_JAVA
)
2173 return SC_FOLDLEVELBASE
+ 1;
2175 return SC_FOLDLEVELBASE
;
2179 /* Should be used only with get_current_tag_cached.
2180 * tag_types caching might trigger recomputation too often but this isn't used differently often
2181 * enough to be an issue for now */
2182 static gboolean
current_tag_changed(GeanyDocument
*doc
, gint cur_line
, gint fold_level
, guint tag_types
)
2184 static gint old_line
= -2;
2185 static GeanyDocument
*old_doc
= NULL
;
2186 static gint old_fold_num
= -1;
2187 static guint old_tag_types
= 0;
2188 const gint fold_num
= fold_level
& SC_FOLDLEVELNUMBERMASK
;
2191 /* check if the cached line and file index have changed since last time: */
2192 if (doc
== NULL
|| doc
!= old_doc
|| old_tag_types
!= tag_types
)
2194 else if (cur_line
== old_line
)
2198 /* if the line has only changed by 1 */
2199 if (abs(cur_line
- old_line
) == 1)
2201 /* It's the same function if the fold number hasn't changed */
2202 ret
= (fold_num
!= old_fold_num
);
2207 /* record current line and file index for next time */
2208 old_line
= cur_line
;
2210 old_fold_num
= fold_num
;
2211 old_tag_types
= tag_types
;
2216 /* Parse the function name up to 2 lines before tag_line.
2217 * C++ like syntax should be parsed by parse_cpp_function_at_line, otherwise the return
2218 * type or argument names can be confused with the function name. */
2219 static gchar
*parse_function_at_line(ScintillaObject
*sci
, gint tag_line
)
2221 gint start
, end
, max_pos
;
2224 switch (sci_get_lexer(sci
))
2226 case SCLEX_RUBY
: fn_style
= SCE_RB_DEFNAME
; break;
2227 case SCLEX_PYTHON
: fn_style
= SCE_P_DEFNAME
; break;
2228 default: fn_style
= SCE_C_IDENTIFIER
; /* several lexers use SCE_C_IDENTIFIER */
2230 start
= sci_get_position_from_line(sci
, tag_line
- 2);
2231 max_pos
= sci_get_position_from_line(sci
, tag_line
+ 1);
2232 while (start
< max_pos
&& sci_get_style_at(sci
, start
) != fn_style
)
2236 while (end
< max_pos
&& sci_get_style_at(sci
, end
) == fn_style
)
2241 return sci_get_contents_range(sci
, start
, end
);
2245 /* Parse the function name */
2246 static gchar
*parse_cpp_function_at_line(ScintillaObject
*sci
, gint tag_line
)
2248 gint start
, end
, first_pos
, max_pos
;
2252 first_pos
= end
= sci_get_position_from_line(sci
, tag_line
);
2253 max_pos
= sci_get_position_from_line(sci
, tag_line
+ 1);
2255 /* goto the begin of function body */
2256 while (end
< max_pos
&&
2257 (tmp
= sci_get_char_at(sci
, end
)) != '{' &&
2259 if (tmp
== 0) end
--;
2261 /* go back to the end of function identifier */
2262 while (end
> 0 && end
> first_pos
- 500 &&
2263 (tmp
= sci_get_char_at(sci
, end
)) != '(' &&
2266 if (end
< 0) end
= 0;
2268 /* skip whitespaces between identifier and ( */
2269 while (end
> 0 && isspace(sci_get_char_at(sci
, end
))) end
--;
2272 /* Use tmp to find SCE_C_IDENTIFIER or SCE_C_GLOBALCLASS chars */
2273 while (start
>= 0 && ((tmp
= sci_get_style_at(sci
, start
)) == SCE_C_IDENTIFIER
2274 || tmp
== SCE_C_GLOBALCLASS
2275 || (c
= sci_get_char_at(sci
, start
)) == '~'
2278 if (start
!= 0 && start
< end
) start
++; /* correct for last non-matching char */
2280 if (start
== end
) return NULL
;
2281 return sci_get_contents_range(sci
, start
, end
+ 1);
2285 static gint
get_fold_header_after(ScintillaObject
*sci
, gint line
)
2287 gint line_count
= sci_get_line_count(sci
);
2289 for (; line
< line_count
; line
++)
2291 if (sci_get_fold_level(sci
, line
) & SC_FOLDLEVELHEADERFLAG
)
2299 static gint
get_current_tag_name(GeanyDocument
*doc
, gchar
**tagname
, TMTagType tag_types
)
2304 line
= sci_get_current_line(doc
->editor
->sci
);
2305 parent
= sci_get_fold_parent(doc
->editor
->sci
, line
);
2306 /* if we're inside a fold level and we have up-to-date tags, get the function from TM */
2307 if (parent
>= 0 && doc
->tm_file
!= NULL
&& doc
->tm_file
->tags_array
!= NULL
&&
2308 (! doc
->changed
|| editor_prefs
.autocompletion_update_freq
> 0))
2310 const TMTag
*tag
= tm_get_current_tag(doc
->tm_file
->tags_array
, parent
+ 1, tag_types
);
2314 gint tag_line
= tag
->line
- 1;
2315 gint last_child
= line
+ 1;
2317 /* if it may be a false positive because we're inside a fold level not inside anything
2318 * we match, e.g. a #if in C or C++, we check we're inside the fold level that start
2319 * right after the tag we got from TM */
2320 if (abs(tag_line
- parent
) > 1)
2322 gint tag_fold
= get_fold_header_after(doc
->editor
->sci
, tag_line
);
2324 last_child
= scintilla_send_message(doc
->editor
->sci
, SCI_GETLASTCHILD
, tag_fold
, -1);
2327 if (line
<= last_child
)
2330 *tagname
= g_strconcat(tag
->scope
,
2331 symbols_get_context_separator(doc
->file_type
->id
), tag
->name
, NULL
);
2333 *tagname
= g_strdup(tag
->name
);
2339 /* for the poor guy with a modified document and without real time tag parsing, we fallback
2340 * to dirty and inaccurate hand-parsing */
2341 else if (parent
>= 0 && doc
->file_type
!= NULL
&& doc
->file_type
->id
!= GEANY_FILETYPES_NONE
)
2343 const gint fn_fold
= get_function_fold_number(doc
);
2344 gint tag_line
= parent
;
2345 gint fold_level
= sci_get_fold_level(doc
->editor
->sci
, tag_line
);
2347 /* find the top level fold point */
2348 while (tag_line
>= 0 && (fold_level
& SC_FOLDLEVELNUMBERMASK
) != fn_fold
)
2350 tag_line
= sci_get_fold_parent(doc
->editor
->sci
, tag_line
);
2351 fold_level
= sci_get_fold_level(doc
->editor
->sci
, tag_line
);
2358 if (sci_get_lexer(doc
->editor
->sci
) == SCLEX_CPP
)
2359 cur_tag
= parse_cpp_function_at_line(doc
->editor
->sci
, tag_line
);
2361 cur_tag
= parse_function_at_line(doc
->editor
->sci
, tag_line
);
2363 if (cur_tag
!= NULL
)
2371 *tagname
= g_strdup(_("unknown"));
2376 static gint
get_current_tag_name_cached(GeanyDocument
*doc
, const gchar
**tagname
, TMTagType tag_types
)
2378 static gint tag_line
= -1;
2379 static gchar
*cur_tag
= NULL
;
2381 g_return_val_if_fail(doc
== NULL
|| doc
->is_valid
, -1);
2383 if (doc
== NULL
) /* reset current function */
2385 current_tag_changed(NULL
, -1, -1, 0);
2387 cur_tag
= g_strdup(_("unknown"));
2388 if (tagname
!= NULL
)
2394 gint line
= sci_get_current_line(doc
->editor
->sci
);
2395 gint fold_level
= sci_get_fold_level(doc
->editor
->sci
, line
);
2397 if (current_tag_changed(doc
, line
, fold_level
, tag_types
))
2400 tag_line
= get_current_tag_name(doc
, &cur_tag
, tag_types
);
2409 /* Sets *tagname to point at the current function or tag name.
2410 * If doc is NULL, reset the cached current tag data to ensure it will be reparsed on the next
2411 * call to this function.
2412 * Returns: line number of the current tag, or -1 if unknown. */
2413 gint
symbols_get_current_function(GeanyDocument
*doc
, const gchar
**tagname
)
2415 return get_current_tag_name_cached(doc
, tagname
, tm_tag_function_t
| tm_tag_method_t
);
2419 /* same as symbols_get_current_function() but finds class, namespaces and more */
2420 gint
symbols_get_current_scope(GeanyDocument
*doc
, const gchar
**tagname
)
2422 TMTagType tag_types
= (tm_tag_function_t
| tm_tag_method_t
| tm_tag_class_t
|
2423 tm_tag_struct_t
| tm_tag_enum_t
| tm_tag_union_t
);
2425 /* Python parser reports imports as namespaces which confuses the scope detection */
2426 if (doc
&& doc
->file_type
->lang
!= filetypes
[GEANY_FILETYPES_PYTHON
]->lang
)
2427 tag_types
|= tm_tag_namespace_t
;
2429 return get_current_tag_name_cached(doc
, tagname
, tag_types
);
2433 static void on_symbol_tree_sort_clicked(GtkMenuItem
*menuitem
, gpointer user_data
)
2435 gint sort_mode
= GPOINTER_TO_INT(user_data
);
2436 GeanyDocument
*doc
= document_get_current();
2438 if (ignore_callback
)
2442 doc
->has_tags
= symbols_recreate_tag_list(doc
, sort_mode
);
2446 static void on_symbol_tree_menu_show(GtkWidget
*widget
,
2449 GeanyDocument
*doc
= document_get_current();
2452 enable
= doc
&& doc
->has_tags
;
2453 gtk_widget_set_sensitive(symbol_menu
.sort_by_name
, enable
);
2454 gtk_widget_set_sensitive(symbol_menu
.sort_by_appearance
, enable
);
2455 gtk_widget_set_sensitive(symbol_menu
.expand_all
, enable
);
2456 gtk_widget_set_sensitive(symbol_menu
.collapse_all
, enable
);
2457 gtk_widget_set_sensitive(symbol_menu
.find_usage
, enable
);
2458 gtk_widget_set_sensitive(symbol_menu
.find_doc_usage
, enable
);
2463 ignore_callback
= TRUE
;
2465 if (doc
->priv
->symbol_list_sort_mode
== SYMBOLS_SORT_BY_NAME
)
2466 gtk_check_menu_item_set_active(GTK_CHECK_MENU_ITEM(symbol_menu
.sort_by_name
), TRUE
);
2468 gtk_check_menu_item_set_active(GTK_CHECK_MENU_ITEM(symbol_menu
.sort_by_appearance
), TRUE
);
2470 ignore_callback
= FALSE
;
2474 static void on_expand_collapse(GtkWidget
*widget
, gpointer user_data
)
2476 gboolean expand
= GPOINTER_TO_INT(user_data
);
2477 GeanyDocument
*doc
= document_get_current();
2482 g_return_if_fail(doc
->priv
->tag_tree
);
2485 gtk_tree_view_expand_all(GTK_TREE_VIEW(doc
->priv
->tag_tree
));
2487 gtk_tree_view_collapse_all(GTK_TREE_VIEW(doc
->priv
->tag_tree
));
2491 static void on_find_usage(GtkWidget
*widget
, G_GNUC_UNUSED gpointer unused
)
2494 GtkTreeSelection
*selection
;
2495 GtkTreeModel
*model
;
2499 doc
= document_get_current();
2503 selection
= gtk_tree_view_get_selection(GTK_TREE_VIEW(doc
->priv
->tag_tree
));
2504 if (gtk_tree_selection_get_selected(selection
, &model
, &iter
))
2505 gtk_tree_model_get(model
, &iter
, SYMBOLS_COLUMN_TAG
, &tag
, -1);
2508 if (widget
== symbol_menu
.find_in_files
)
2509 search_show_find_in_files_dialog_full(tag
->name
, NULL
);
2511 search_find_usage(tag
->name
, tag
->name
, GEANY_FIND_WHOLEWORD
| GEANY_FIND_MATCHCASE
,
2512 widget
== symbol_menu
.find_usage
);
2519 static void create_taglist_popup_menu(void)
2521 GtkWidget
*item
, *menu
;
2523 tv
.popup_taglist
= menu
= gtk_menu_new();
2525 symbol_menu
.expand_all
= item
= ui_image_menu_item_new(GTK_STOCK_ADD
, _("_Expand All"));
2526 gtk_widget_show(item
);
2527 gtk_container_add(GTK_CONTAINER(menu
), item
);
2528 g_signal_connect(item
, "activate", G_CALLBACK(on_expand_collapse
), GINT_TO_POINTER(TRUE
));
2530 symbol_menu
.collapse_all
= item
= ui_image_menu_item_new(GTK_STOCK_REMOVE
, _("_Collapse All"));
2531 gtk_widget_show(item
);
2532 gtk_container_add(GTK_CONTAINER(menu
), item
);
2533 g_signal_connect(item
, "activate", G_CALLBACK(on_expand_collapse
), GINT_TO_POINTER(FALSE
));
2535 item
= gtk_separator_menu_item_new();
2536 gtk_widget_show(item
);
2537 gtk_container_add(GTK_CONTAINER(menu
), item
);
2539 symbol_menu
.sort_by_name
= item
= gtk_radio_menu_item_new_with_mnemonic(NULL
,
2540 _("Sort by _Name"));
2541 gtk_widget_show(item
);
2542 gtk_container_add(GTK_CONTAINER(menu
), item
);
2543 g_signal_connect(item
, "activate", G_CALLBACK(on_symbol_tree_sort_clicked
),
2544 GINT_TO_POINTER(SYMBOLS_SORT_BY_NAME
));
2546 symbol_menu
.sort_by_appearance
= item
= gtk_radio_menu_item_new_with_mnemonic_from_widget(
2547 GTK_RADIO_MENU_ITEM(item
), _("Sort by _Appearance"));
2548 gtk_widget_show(item
);
2549 gtk_container_add(GTK_CONTAINER(menu
), item
);
2550 g_signal_connect(item
, "activate", G_CALLBACK(on_symbol_tree_sort_clicked
),
2551 GINT_TO_POINTER(SYMBOLS_SORT_BY_APPEARANCE
));
2553 item
= gtk_separator_menu_item_new();
2554 gtk_widget_show(item
);
2555 gtk_container_add(GTK_CONTAINER(menu
), item
);
2557 symbol_menu
.find_usage
= item
= ui_image_menu_item_new(GTK_STOCK_FIND
, _("Find _Usage"));
2558 gtk_widget_show(item
);
2559 gtk_container_add(GTK_CONTAINER(menu
), item
);
2560 g_signal_connect(item
, "activate", G_CALLBACK(on_find_usage
), symbol_menu
.find_usage
);
2562 symbol_menu
.find_doc_usage
= item
= ui_image_menu_item_new(GTK_STOCK_FIND
, _("Find _Document Usage"));
2563 gtk_widget_show(item
);
2564 gtk_container_add(GTK_CONTAINER(menu
), item
);
2565 g_signal_connect(item
, "activate", G_CALLBACK(on_find_usage
), symbol_menu
.find_doc_usage
);
2567 symbol_menu
.find_in_files
= item
= ui_image_menu_item_new(GTK_STOCK_FIND
, _("Find in F_iles..."));
2568 gtk_widget_show(item
);
2569 gtk_container_add(GTK_CONTAINER(menu
), item
);
2570 g_signal_connect(item
, "activate", G_CALLBACK(on_find_usage
), NULL
);
2572 g_signal_connect(menu
, "show", G_CALLBACK(on_symbol_tree_menu_show
), NULL
);
2574 sidebar_add_common_menu_items(GTK_MENU(menu
));
2578 static void on_document_save(G_GNUC_UNUSED GObject
*object
, GeanyDocument
*doc
)
2582 g_return_if_fail(!EMPTY(doc
->real_path
));
2584 f
= g_build_filename(app
->configdir
, "ignore.tags", NULL
);
2585 if (utils_str_equal(doc
->real_path
, f
))
2586 load_c_ignore_tags();
2592 void symbols_init(void)
2597 create_taglist_popup_menu();
2599 f
= g_build_filename(app
->configdir
, "ignore.tags", NULL
);
2600 ui_add_config_file_menu_item(f
, NULL
, NULL
);
2603 g_signal_connect(geany_object
, "document-save", G_CALLBACK(on_document_save
), NULL
);
2605 for (i
= 0; i
< G_N_ELEMENTS(symbols_icons
); i
++)
2606 symbols_icons
[i
].pixbuf
= get_tag_icon(symbols_icons
[i
].icon_name
);
2610 void symbols_finalize(void)
2614 g_strfreev(html_entities
);
2615 g_strfreev(c_tags_ignore
);
2617 for (i
= 0; i
< G_N_ELEMENTS(symbols_icons
); i
++)
2619 if (symbols_icons
[i
].pixbuf
)
2620 g_object_unref(symbols_icons
[i
].pixbuf
);