src/geany.h

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