src/project.h

   1 /*
   2  *      project.h - this file is part of Geany, a fast and lightweight IDE
   3  *
   4  *      Copyright 2007-2010 Enrico Tröger <enrico(dot)troeger(at)uvena(dot)de>
   5  *      Copyright 2007-2010 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
  18  *      along with this program; if not, write to the Free Software
  19  *      Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  20  *
  21  * $Id$
  22  */
  23
  24
  25 #ifndef GEANY_PROJECT_H
  26 #define GEANY_PROJECT_H 1
  27
  28 #define GEANY_PROJECT_EXT                               "geany"
  29
  30
  31 /** Structure for representing a project. */
  32 typedef struct GeanyProject
  33 {
  34         gchar *name;                    /**< The name of the project. */
  35         gchar *description;     /**< Short description of the project. */
  36         gchar *file_name;               /**< Where the project file is stored (in UTF-8). */
  37         gchar *base_path;               /**< Base path of the project directory (in UTF-8, maybe relative). */
  38         /** Identifier whether it is a pure Geany project or modified/extended
  39          * by a plugin. */
  40         gint type;
  41         gchar **file_patterns;  /**< Array of filename extension patterns. */
  42
  43         struct GeanyProjectPrivate      *priv;  /* must be last, append fields before this item */
  44 #ifdef GEANY_PRIVATE
  45         /* Do not use following fields in plugins */
  46         GPtrArray *build_filetypes_list; /* Project has custom filetype builds for these. */
  47         gint long_line_behaviour; /* 0 - disabled, 1 - follow global settings, 2 - enabled (custom) */
  48         gint long_line_column; /* Long line marker position. */
  49 #endif
  50 }
  51 GeanyProject;
  52
  53
  54 typedef struct ProjectPrefs
  55 {
  56         gchar *session_file;
  57         gboolean project_session;
  58         gboolean project_file_in_basedir;
  59 } ProjectPrefs;
  60
  61 extern ProjectPrefs project_prefs;
  62
  63
  64 void project_init(void);
  65
  66 void project_finalize(void);
  67
  68
  69 void project_new(void);
  70
  71 void project_open(void);
  72
  73 void project_close(gboolean open_default);
  74
  75 void project_properties(void);
  76
  77 void project_build_properties(void);
  78
  79 gboolean project_ask_close(void);
  80
  81
  82 gboolean project_load_file(const gchar *locale_file_name);
  83
  84 gboolean project_load_file_with_session(const gchar *locale_file_name);
  85
  86 gchar *project_get_base_path(void);
  87
  88
  89 void project_save_prefs(GKeyFile *config);
  90
  91 void project_load_prefs(GKeyFile *config);
  92
  93 void project_setup_prefs(void);
  94
  95 void project_apply_prefs(void);
  96
  97 #endif