Debian Codegraph @

geanygendoc/src/ggd-plugin.h

raw
1 /*
2 *
3 * GeanyGenDoc, a Geany plugin to ease generation of source code documentation
4 * Copyright (C) 2009-2011 Colomban Wendling <[email protected]>
5 *
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 3 of the License, or
9 * (at your option) any later version.
10 *
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.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program. If not, see <http://www.gnu.org/licenses/>.
18 *
19 */
20
21 #ifndef H_GGD_PLUGIN
22 #define H_GGD_PLUGIN
23
24 #ifdef HAVE_CONFIG_H
25 # include "config.h"
26 #endif
27
28 #include <glib.h>
29 #include <geanyplugin.h>
30
31 #include "ggd-macros.h"
32
33 G_BEGIN_DECLS
34
35
36 /* pretty funny hack, because Geany doesn't use a shared library for it's API,
37 * then we need that global function table pointer, that Geany gives at plugin
38 * loading time */
39 /* Note that this cannot be hidden since it is accessed by the Geany instance */
40 extern GeanyPlugin *geany_plugin;
41 extern GeanyData *geany_data;
42
43
44 /* Begin of the plugin's self API */
45 GGD_BEGIN_PLUGIN_API
46
47
48 #define GGD_PLUGIN_ONAME geanygendoc
49 #define GGD_PLUGIN_CNAME G_STRINGIFY (GGD_PLUGIN_ONAME)
50 #define GGD_PLUGIN_NAME "GeanyGenDoc"
51 #define GGD_PLUGIN_VERSION "0.2" /* Don't use Geany-Plugin's version */
52
53
54 /* global plugin options */
55 extern gchar *GGD_OPT_doctype[GEANY_MAX_BUILT_IN_FILETYPES];
56 extern gboolean GGD_OPT_save_to_refresh;
57 extern gboolean GGD_OPT_indent;
58 extern gchar *GGD_OPT_environ;
59
60
61 GGD_END_PLUGIN_API
62 G_END_DECLS
63
64 #endif /* guard */