src/app.h

   1 /*
   2  *      app.h - this file is part of Geany, a fast and lightweight IDE
   3  *
   4  *      Copyright 2005-2014 Enrico Tröger <enrico(dot)troeger(at)uvena(dot)de>
   5  *      Copyright 2006-2014 Nick Treleaven <nick(dot)treleaven(at)btinternet(dot)com>
   6  *      Copyright 2014 Matthew Brush <matt@geany.org>
   7  *
   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.
  12  *
  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.
  17  *
  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.
  21  */
  22
  23 /**
  24  * @file app.h
  25  * Contains the GeanyApp.
  26  */
  27
  28 #ifndef GEANY_APP_H
  29 #define GEANY_APP_H 1
  30
  31 #include "tm_tag.h" /* FIXME: should be included in tm_workspace.h */
  32 #include "tm_workspace.h"
  33 #include "project.h"
  34
  35 #include <glib.h>
  36
  37 G_BEGIN_DECLS
  38
  39 /** Important application fields. */
  40 typedef struct GeanyApp
  41 {
  42         gboolean                        debug_mode;             /**< @c TRUE if debug messages should be printed. */
  43         /** User configuration directory, usually @c ~/.config/geany.
  44          * This is a full path read by @ref tm_get_real_path().
  45          * @note Plugin configuration files should be saved as:
  46          * @code g_build_path(G_DIR_SEPARATOR_S, geany->app->configdir, "plugins", "pluginname",
  47          *      "file.conf", NULL); @endcode */
  48         gchar                           *configdir;
  49         gchar                           *datadir;
  50         gchar                           *docdir;
  51         const TMWorkspace       *tm_workspace;  /**< TagManager workspace/session tags. */
  52         struct GeanyProject     *project;               /**< Currently active project or @c NULL if none is open. */
  53 }
  54 GeanyApp;
  55
  56 extern GeanyApp *app;
  57
  58 G_END_DECLS
  59
  60 #endif /* GEANY_APP_H */