src/build.h

   1 /*
   2  *      build.h - this file is part of Geany, a fast and lightweight IDE
   3  *
   4  *      Copyright 2005-2011 Enrico Tröger <enrico(dot)troeger(at)uvena(dot)de>
   5  *      Copyright 2006-2011 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., 675 Mass Ave, Cambridge, MA 02139, USA.
  20  */
  21
  22 /* * @file build.h Interface to the Build menu functionality. */
  23
  24 #ifndef GEANY_BUILD_H
  25 #define GEANY_BUILD_H 1
  26
  27 /* Order is important (see GBO_TO_GBG, GBO_TO_CMD below) */
  28 /* * Geany Known Build Commands.
  29  * These commands are named after their default use.
  30  * Only these commands can currently have keybindings.
  31  **/
  32 typedef enum
  33 {
  34         GEANY_GBO_COMPILE,              /* *< default compile file */
  35         GEANY_GBO_BUILD,                /* *< default build file */
  36         GEANY_GBO_MAKE_ALL,             /* *< default make */
  37         GEANY_GBO_CUSTOM,               /* *< default make user specified target */
  38         GEANY_GBO_MAKE_OBJECT,  /* *< default make object, make %e.o */
  39         GEANY_GBO_EXEC,                 /* *< default execute ./%e */
  40         GEANY_GBO_COUNT                 /* *< count of how many */
  41 } GeanyBuildType;
  42
  43 /* * Groups of Build menu items. */
  44 typedef enum
  45 {
  46         GEANY_GBG_FT,           /* *< filetype items */
  47         GEANY_GBG_NON_FT,       /* *< non filetype items.*/
  48         GEANY_GBG_EXEC,         /* *< execute items */
  49         GEANY_GBG_COUNT         /* *< count of groups. */
  50 } GeanyBuildGroup;
  51
  52 /* include the fixed widgets in an array indexed by groups */
  53 #define GBG_FIXED GEANY_GBG_COUNT
  54
  55 /* * Convert @c GeanyBuildType to @c GeanyBuildGroup.
  56  *
  57  * This macro converts @c GeanyBuildType enum values (the "known" commands)
  58  * to the group they are part of.
  59  *
  60  * @param gbo the @c GeanyBuildType value.
  61  *
  62  * @return the @c GeanyBuildGroup group that @a gbo is in.
  63  *
  64  * Note this is a macro so that it can be used in static initialisers.
  65  **/
  66 #define GBO_TO_GBG(gbo) ((gbo)>GEANY_GBO_EXEC?GEANY_GBG_COUNT:((gbo)>=GEANY_GBO_EXEC?GEANY_GBG_EXEC: \
  67                                                  ((gbo) >= GEANY_GBO_MAKE_ALL ? GEANY_GBG_NON_FT : GEANY_GBG_FT)))
  68
  69 /* * Convert @c GeanyBuildType to command index.
  70  *
  71  * This macro converts @c GeanyBuildType enum values (the "known" commands)
  72  * to the index within the group.
  73  *
  74  * @param gbo the @c GeanyBuildType value.
  75  *
  76  * @return the index of the @a gbo command in its group.
  77  *
  78  * Note this is a macro so that it can be used in static initialisers.
  79  **/
  80 #define GBO_TO_CMD(gbo) ((gbo)>=GEANY_GBO_COUNT?(gbo)-GEANY_GBO_COUNT:((gbo)>=GEANY_GBO_EXEC?(gbo)-GEANY_GBO_EXEC: \
  81                                                  ((gbo) >= GEANY_GBO_MAKE_ALL ? (gbo)-GEANY_GBO_MAKE_ALL : (gbo))))
  82
  83 enum GeanyBuildFixedMenuItems
  84 {
  85         GBF_NEXT_ERROR,
  86         GBF_PREV_ERROR,
  87         GBF_COMMANDS,
  88         GBF_SEP_1,
  89         GBF_SEP_2,
  90         GBF_SEP_3,
  91         GBF_SEP_4,
  92         GBF_COUNT
  93 };
  94
  95 /* * Build menu item sources in increasing priority */
  96 typedef enum
  97 {
  98         GEANY_BCS_DEF,          /* *< Default values. */
  99         GEANY_BCS_FT,           /* *< System filetype values. */
 100         GEANY_BCS_HOME_FT,      /* *< Filetypes in ~/.config/geany/filedefs */
 101         GEANY_BCS_PREF,         /* *< Preferences file ~/.config/geany/geany.conf */
 102         GEANY_BCS_PROJ_FT,      /* *< Project file filetype command */
 103         GEANY_BCS_PROJ,         /* *< Project file if open. */
 104         GEANY_BCS_COUNT         /* *< Count of sources. */
 105 } GeanyBuildSource;
 106
 107 typedef struct GeanyBuildInfo
 108 {
 109         GeanyBuildGroup  grp;
 110         guint                    cmd;
 111         GPid                     pid;   /* process id of the spawned process */
 112         gchar                   *dir;
 113         guint                    file_type_id;
 114         gchar                   *custom_target;
 115         gint                     message_count;
 116 } GeanyBuildInfo;
 117
 118 extern GeanyBuildInfo build_info;
 119
 120 /* * The entries of a command for a menu item */
 121 typedef enum GeanyBuildCmdEntries
 122 {
 123         GEANY_BC_LABEL,                         /* *< The menu item label, _ marks mnemonic */
 124         GEANY_BC_COMMAND,                       /* *< The command to run. */
 125         GEANY_BC_WORKING_DIR,           /* *< The directory to run in */
 126         GEANY_BC_CMDENTRIES_COUNT       /* *< Count of entries */
 127 } GeanyBuildCmdEntries;
 128
 129 /* * The command for a menu item. */
 130 typedef struct GeanyBuildCommand
 131 {
 132         /* * Pointers to g_string values of the command entries.
 133          * Must be freed if the pointer is changed. */
 134         gchar           *label;                                         /* *< Menu item label */
 135         gchar           *command;                                       /* *< Command to run */
 136         gchar           *working_dir;                           /* *< working directory */
 137         gboolean         exists;                                        /* *< If the entries have valid values. */
 138         gboolean         changed;                                       /* *< Save on exit if @c changed, remove if not @c exist. */
 139         gboolean         old;                                           /* *< Converted from old format. */
 140 } GeanyBuildCommand;
 141
 142 typedef struct BuildMenuItems
 143 {
 144         GtkWidget               *menu;
 145         GtkWidget               **menu_item[GEANY_GBG_COUNT + 1];  /* +1 for fixed items */
 146 } BuildMenuItems;
 147
 148 /* a structure defining the destinations for a set of groups of commands & regex */
 149 typedef struct BuildDestination
 150 {
 151         GeanyBuildCommand       **dst[GEANY_GBG_COUNT];
 152         gchar                           **fileregexstr;
 153         gchar                           **nonfileregexstr;
 154 } BuildDestination;
 155
 156 /* opaque pointers returned from build functions and passed back to them */
 157 typedef struct BuildTableFields *BuildTableData;
 158
 159
 160 void build_init(void);
 161
 162 void build_finalize(void);
 163
 164 /* menu configuration dialog functions */
 165 GtkWidget *build_commands_table(GeanyDocument *doc, GeanyBuildSource dst, BuildTableData *data, GeanyFiletype *ft);
 166
 167 void build_read_project(GeanyFiletype *ft, BuildTableData build_properties);
 168
 169 void build_free_fields(BuildTableData data);
 170
 171 /* build response decode assistance function */
 172 gboolean build_parse_make_dir(const gchar *string, gchar **prefix);
 173
 174 /* build menu functions */
 175
 176 void build_menu_update(GeanyDocument *doc);
 177
 178 void build_toolbutton_build_clicked(GtkAction *action, gpointer user_data);
 179
 180 void build_remove_menu_item(GeanyBuildSource src, GeanyBuildGroup grp, gint cmd);
 181
 182 GeanyBuildCommand *build_get_menu_item(GeanyBuildSource src, GeanyBuildGroup grp, guint cmd);
 183
 184 GeanyBuildCommand *build_get_current_menu_item(GeanyBuildGroup grp, guint cmd, guint *src);
 185
 186 BuildMenuItems *build_get_menu_items(gint filetype_idx);
 187
 188 /* load and store menu configuration */
 189 void build_load_menu(GKeyFile *config, GeanyBuildSource dst, gpointer ptr);
 190
 191 void build_save_menu(GKeyFile *config, gpointer ptr, GeanyBuildSource src);
 192
 193 void build_set_group_count(GeanyBuildGroup grp, gint count);
 194
 195 guint build_get_group_count(GeanyBuildGroup grp);
 196
 197 gchar **build_get_regex(GeanyBuildGroup grp, GeanyFiletype *ft, guint *from);
 198
 199 #endif