Update HACKING for changed doc generation instructions
[geany-mirror.git] / src / symbols.h
blobdced9fe88d9eb14c7343cd7963441690e85ea460
1 /*
2 * symbols.h - 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>
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License along
18 * with this program; if not, write to the Free Software Foundation, Inc.,
19 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
23 #ifndef GEANY_SYMBOLS_H
24 #define GEANY_SYMBOLS_H 1
26 #include "document.h"
28 #include <glib.h>
30 G_BEGIN_DECLS
32 extern const guint TM_GLOBAL_TYPE_MASK;
34 enum
36 SYMBOLS_SORT_BY_NAME,
37 SYMBOLS_SORT_BY_APPEARANCE,
38 SYMBOLS_SORT_USE_PREVIOUS
42 void symbols_init(void);
44 void symbols_finalize(void);
46 void symbols_reload_config_files(void);
48 void symbols_global_tags_loaded(guint file_type_idx);
50 GString *symbols_find_tags_as_string(GPtrArray *tags_array, guint tag_types, gint lang);
52 const gchar *symbols_get_context_separator(gint ft_id);
54 const GList *symbols_get_tag_list(GeanyDocument *doc, guint tag_types);
56 GString *symbols_get_macro_list(gint lang);
58 const gchar **symbols_get_html_entities(void);
60 gboolean symbols_recreate_tag_list(GeanyDocument *doc, gint sort_mode);
62 gint symbols_generate_global_tags(gint argc, gchar **argv, gboolean want_preprocess);
64 void symbols_show_load_tags_dialog(void);
66 gboolean symbols_goto_tag(const gchar *name, gboolean definition);
68 gint symbols_get_current_function(GeanyDocument *doc, const gchar **tagname);
70 gint symbols_get_current_scope(GeanyDocument *doc, const gchar **tagname);
72 G_END_DECLS
74 #endif /* GEANY_SYMBOLS_H */