review tweaks
[geany-mirror.git] / src / geany.h
blob3bb497178b94affc95256d8fd95fc0dd7ebb0600
1 /*
2 * geany.h - this file is part of Geany, a fast and lightweight IDE
4 * Copyright 2005 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.
21 /* Main header - should be included first in all source files.
22 * externs and function prototypes are implemented in main.c. */
24 #ifndef GEANY_H
25 #define GEANY_H 1
27 /* This is included here for compatibility with when GeanyApp used to be
28 * defined in this header. Some plugins (ex. GeanyLua) include individual
29 * headers instead of geanyplugin.h for some reason so they wouldn't
30 * get the GeanyApp definition if this isn't here. */
31 #include "app.h"
33 #include <glib.h>
36 G_BEGIN_DECLS
39 /* for detailed description look in the documentation, things are not
40 * listed in the documentation should not be changed */
41 #define GEANY_FILEDEFS_SUBDIR "filedefs"
42 #define GEANY_TEMPLATES_SUBDIR "templates"
43 #define GEANY_TAGS_SUBDIR "tags"
44 #define GEANY_CODENAME "Wolbam"
45 #define GEANY_HOMEPAGE "https://www.geany.org/"
46 #define GEANY_WIKI "https://wiki.geany.org/"
47 #define GEANY_BUG_REPORT "https://www.geany.org/Support/Bugs"
48 #define GEANY_DONATE "https://www.geany.org/service/donate/"
49 #define GEANY_STRING_UNTITLED _("untitled")
50 #define GEANY_DEFAULT_DIALOG_HEIGHT 350
51 #define GEANY_WINDOW_DEFAULT_WIDTH 900
52 #define GEANY_WINDOW_DEFAULT_HEIGHT 600
54 #ifndef G_GNUC_WARN_UNUSED_RESULT
55 #define G_GNUC_WARN_UNUSED_RESULT
56 #endif
58 #if defined(GEANY_PRIVATE) || defined(GEANY_DISABLE_DEPRECATION_WARNINGS)
59 # define GEANY_DEPRECATED
60 # define GEANY_DEPRECATED_FOR(x)
61 #else
62 # define GEANY_DEPRECATED G_GNUC_DEPRECATED
63 # define GEANY_DEPRECATED_FOR(x) G_GNUC_DEPRECATED_FOR(x)
64 #endif
66 /* Re-defined by plugindata.h as something else */
67 #ifndef GEANY
68 # define GEANY(symbol_name) symbol_name
69 #endif
72 #ifdef GEANY_PRIVATE
74 /* prototype is here so that all files can use it. */
75 void geany_debug(gchar const *format, ...) G_GNUC_PRINTF (1, 2);
77 #endif /* GEANY_PRIVATE */
79 G_END_DECLS
81 #endif /* GEANY_H */