opts.c

   1 /*
   2  * Copyright (C) 2012, 2013
   3  *     Wolfgang Bumiller
   4  *     Dale Weiler
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a copy of
   7  * this software and associated documentation files (the "Software"), to deal in
   8  * the Software without restriction, including without limitation the rights to
   9  * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
  10  * of the Software, and to permit persons to whom the Software is furnished to do
  11  * so, subject to the following conditions:
  12  *
  13  * The above copyright notice and this permission notice shall be included in all
  14  * copies or substantial portions of the Software.
  15  *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  19  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  22  * SOFTWARE.
  23  */
  24 #include <string.h>
  25 #include <stdlib.h>
  26
  27 #include "gmqcc.h"
  28
  29 const unsigned int opts_opt_oflag[COUNT_OPTIMIZATIONS+1] = {
  30 # define GMQCC_TYPE_OPTIMIZATIONS
  31 # define GMQCC_DEFINE_FLAG(NAME, MIN_O) MIN_O,
  32 #  include "opts.def"
  33     0
  34 };
  35
  36 const opts_flag_def_t opts_opt_list[COUNT_OPTIMIZATIONS+1] = {
  37 # define GMQCC_TYPE_OPTIMIZATIONS
  38 # define GMQCC_DEFINE_FLAG(NAME, MIN_O) { #NAME, LONGBIT(OPTIM_##NAME) },
  39 #  include "opts.def"
  40     { NULL, LONGBIT(0) }
  41 };
  42
  43 const opts_flag_def_t opts_warn_list[COUNT_WARNINGS+1] = {
  44 # define GMQCC_TYPE_WARNS
  45 # define GMQCC_DEFINE_FLAG(X) { #X, LONGBIT(WARN_##X) },
  46 #  include "opts.def"
  47     { NULL, LONGBIT(0) }
  48 };
  49
  50 const opts_flag_def_t opts_flag_list[COUNT_FLAGS+1] = {
  51 # define GMQCC_TYPE_FLAGS
  52 # define GMQCC_DEFINE_FLAG(X) { #X, LONGBIT(X) },
  53 #  include "opts.def"
  54     { NULL, LONGBIT(0) }
  55 };
  56
  57 unsigned int opts_optimizationcount[COUNT_OPTIMIZATIONS];
  58 opts_cmd_t   opts; /* command line options */
  59
  60 static void opts_setdefault(void) {
  61     memset(&opts, 0, sizeof(opts_cmd_t));
  62     OPTS_OPTION_BOOL(OPTION_CORRECTION) = true;
  63     OPTS_OPTION_STR(OPTION_PROGSRC) = "progs.src";
  64
  65     /* warnings */
  66     opts_set(opts.warn,  WARN_UNUSED_VARIABLE,           true);
  67     opts_set(opts.warn,  WARN_USED_UNINITIALIZED,        true);
  68     opts_set(opts.warn,  WARN_UNKNOWN_CONTROL_SEQUENCE,  true);
  69     opts_set(opts.warn,  WARN_EXTENSIONS,                true);
  70     opts_set(opts.warn,  WARN_FIELD_REDECLARED,          true);
  71     opts_set(opts.warn,  WARN_MISSING_RETURN_VALUES,     true);
  72     opts_set(opts.warn,  WARN_INVALID_PARAMETER_COUNT,   true);
  73     opts_set(opts.warn,  WARN_LOCAL_CONSTANTS,           true);
  74     opts_set(opts.warn,  WARN_VOID_VARIABLES,            true);
  75     opts_set(opts.warn,  WARN_IMPLICIT_FUNCTION_POINTER, true);
  76     opts_set(opts.warn,  WARN_VARIADIC_FUNCTION,         true);
  77     opts_set(opts.warn,  WARN_FRAME_MACROS,              true);
  78     opts_set(opts.warn,  WARN_EFFECTLESS_STATEMENT,      true);
  79     opts_set(opts.warn,  WARN_END_SYS_FIELDS,            true);
  80     opts_set(opts.warn,  WARN_ASSIGN_FUNCTION_TYPES,     true);
  81     opts_set(opts.warn,  WARN_CPP,                       true);
  82     opts_set(opts.warn,  WARN_MULTIFILE_IF,              true);
  83     opts_set(opts.warn,  WARN_DOUBLE_DECLARATION,        true);
  84     opts_set(opts.warn,  WARN_CONST_VAR,                 true);
  85     opts_set(opts.warn,  WARN_MULTIBYTE_CHARACTER,       true);
  86     opts_set(opts.warn,  WARN_UNKNOWN_PRAGMAS,           true);
  87     opts_set(opts.warn,  WARN_UNREACHABLE_CODE,          true);
  88     opts_set(opts.warn,  WARN_UNKNOWN_ATTRIBUTE,         true);
  89     opts_set(opts.warn,  WARN_RESERVED_NAMES,            true);
  90     opts_set(opts.warn,  WARN_UNINITIALIZED_CONSTANT,    true);
  91     opts_set(opts.warn,  WARN_DEPRECATED,                true);
  92     opts_set(opts.warn,  WARN_PARENTHESIS,               true);
  93     opts_set(opts.warn,  WARN_CONST_OVERWRITE,           true);
  94     opts_set(opts.warn,  WARN_DIRECTIVE_INMACRO,         true);
  95
  96     /* flags */
  97     opts_set(opts.flags, ADJUST_VECTOR_FIELDS,           true);
  98     opts_set(opts.flags, CORRECT_TERNARY,                true);
  99     opts_set(opts.flags, BAIL_ON_WERROR,                 true);
 100     opts_set(opts.flags, LEGACY_VECTOR_MATHS,            true);
 101     opts_set(opts.flags, DARKPLACES_STRING_TABLE_BUG,    true);
 102
 103 }
 104
 105 void opts_backup_non_Wall() {
 106     size_t i;
 107     for (i = 0; i <= WARN_DEBUG; ++i)
 108         opts_set(opts.warn_backup, i, OPTS_WARN(i));
 109 }
 110
 111 void opts_restore_non_Wall() {
 112     size_t i;
 113     for (i = 0; i <= WARN_DEBUG; ++i)
 114         opts_set(opts.warn, i, OPTS_GENERIC(opts.warn_backup, i));
 115 }
 116
 117 void opts_backup_non_Werror_all() {
 118     size_t i;
 119     for (i = 0; i <= WARN_DEBUG; ++i)
 120         opts_set(opts.werror_backup, i, OPTS_WERROR(i));
 121 }
 122
 123 void opts_restore_non_Werror_all() {
 124     size_t i;
 125     for (i = 0; i <= WARN_DEBUG; ++i)
 126         opts_set(opts.werror, i, OPTS_GENERIC(opts.werror_backup, i));
 127 }
 128
 129 void opts_init(const char *output, int standard, size_t arraysize) {
 130     opts_setdefault();
 131
 132     OPTS_OPTION_STR(OPTION_OUTPUT)         = (char*)output;
 133     OPTS_OPTION_U32(OPTION_STANDARD)       = standard;
 134     OPTS_OPTION_U32(OPTION_MAX_ARRAY_SIZE) = arraysize;
 135     OPTS_OPTION_U16(OPTION_MEMDUMPCOLS)    = 16;
 136 }
 137
 138 static bool opts_setflag_all(const char *name, bool on, uint32_t *flags, const opts_flag_def_t *list, size_t listsize) {
 139     size_t i;
 140
 141     for (i = 0; i < listsize; ++i) {
 142         if (!strcmp(name, list[i].name)) {
 143             longbit lb = list[i].bit;
 144
 145             if (on)
 146                 flags[lb.idx] |= (1<<(lb.bit));
 147             else
 148                 flags[lb.idx] &= ~(1<<(lb.bit));
 149
 150             return true;
 151         }
 152     }
 153     return false;
 154 }
 155 bool opts_setflag  (const char *name, bool on) {
 156     return opts_setflag_all(name, on, opts.flags,        opts_flag_list, COUNT_FLAGS);
 157 }
 158 bool opts_setwarn  (const char *name, bool on) {
 159     return opts_setflag_all(name, on, opts.warn,         opts_warn_list, COUNT_WARNINGS);
 160 }
 161 bool opts_setwerror(const char *name, bool on) {
 162     return opts_setflag_all(name, on, opts.werror,       opts_warn_list, COUNT_WARNINGS);
 163 }
 164 bool opts_setoptim (const char *name, bool on) {
 165     return opts_setflag_all(name, on, opts.optimization, opts_opt_list,  COUNT_OPTIMIZATIONS);
 166 }
 167
 168 void opts_set(uint32_t *flags, size_t idx, bool on) {
 169     longbit lb;
 170     LONGBIT_SET(lb, idx);
 171
 172     if (on)
 173         flags[lb.idx] |= (1<<(lb.bit));
 174     else
 175         flags[lb.idx] &= ~(1<<(lb.bit));
 176 }
 177
 178 void opts_setoptimlevel(unsigned int level) {
 179     size_t i;
 180     for (i = 0; i < COUNT_OPTIMIZATIONS; ++i)
 181         opts_set(opts.optimization, i, level >= opts_opt_oflag[i]);
 182
 183     if (!level)
 184         opts.optimizeoff = true;
 185 }
 186
 187 /*
 188  * Standard configuration parser and subsystem.  Yes, optionally you may
 189  * create ini files or cfg (the driver accepts both) for a project opposed
 190  * to supplying just a progs.src (since you also may need to supply command
 191  * line arguments or set the options of the compiler) [which cannot be done
 192  * from a progs.src.
 193  */
 194 static char *opts_ini_rstrip(char *s) {
 195     char *p = s + strlen(s);
 196     while(p > s && util_isspace(*--p))
 197         *p = '\0';
 198     return s;
 199 }
 200
 201 static char *opts_ini_lskip(const char *s) {
 202     while (*s && util_isspace(*s))
 203         s++;
 204     return (char*)s;
 205 }
 206
 207 static char *opts_ini_next(const char *s, char c) {
 208     bool last = false;
 209     while (*s && *s != c && !(last && *s == ';'))
 210         last = !!util_isspace(*s), s++;
 211
 212     return (char*)s;
 213 }
 214
 215 static size_t opts_ini_parse (
 216     fs_file_t *filehandle,
 217     char *(*loadhandle)(const char *, const char *, const char *),
 218     char **errorhandle
 219 ) {
 220     size_t linesize;
 221     size_t lineno             = 1;
 222     size_t error              = 0;
 223     char  *line               = NULL;
 224     char   section_data[2048] = "";
 225     char   oldname_data[2048] = "";
 226
 227     /* parsing and reading variables */
 228     char *parse_beg;
 229     char *parse_end;
 230     char *read_name;
 231     char *read_value;
 232
 233     while (fs_file_getline(&line, &linesize, filehandle) != FS_FILE_EOF) {
 234         parse_beg = line;
 235
 236         /* handle BOM */
 237         if (lineno == 1 && (
 238                 (unsigned char)parse_beg[0] == 0xEF &&
 239                 (unsigned char)parse_beg[1] == 0xBB &&
 240                 (unsigned char)parse_beg[2] == 0xBF
 241             )
 242         ) {
 243             parse_beg ++; /* 0xEF */
 244             parse_beg ++; /* 0xBB */
 245             parse_beg ++; /* 0xBF */
 246         }
 247
 248         if (*(parse_beg = opts_ini_lskip(opts_ini_rstrip(parse_beg))) == ';' || *parse_beg == '#') {
 249             /* ignore '#' is a perl extension */
 250         } else if (*parse_beg == '[') {
 251             /* section found */
 252             if (*(parse_end = opts_ini_next(parse_beg + 1, ']')) == ']') {
 253                 * parse_end = '\0'; /* terminate bro */
 254                 util_strncpy(section_data, parse_beg + 1, sizeof(section_data));
 255                 section_data[sizeof(section_data) - 1] = '\0';
 256                 *oldname_data                          = '\0';
 257             } else if (!error) {
 258                 /* otherwise set error to the current line number */
 259                 error = lineno;
 260             }
 261         } else if (*parse_beg && *parse_beg != ';') {
 262             /* not a comment, must be a name value pair :) */
 263             if (*(parse_end = opts_ini_next(parse_beg, '=')) != '=')
 264                   parse_end = opts_ini_next(parse_beg, ':');
 265
 266             if (*parse_end == '=' || *parse_end == ':') {
 267                 *parse_end = '\0'; /* terminate bro */
 268                 read_name  = opts_ini_rstrip(parse_beg);
 269                 read_value = opts_ini_lskip(parse_end + 1);
 270                 if (*(parse_end = opts_ini_next(read_value, '\0')) == ';')
 271                     * parse_end = '\0';
 272                 opts_ini_rstrip(read_value);
 273
 274                 /* valid name value pair, lets call down to handler */
 275                 util_strncpy(oldname_data, read_name, sizeof(oldname_data));
 276                 oldname_data[sizeof(oldname_data) - 1] ='\0';
 277
 278                 if ((*errorhandle = loadhandle(section_data, read_name, read_value)) && !error)
 279                     error = lineno;
 280             } else if (!error) {
 281                 /* otherwise set error to the current line number */
 282                 error = lineno;
 283             }
 284         }
 285         lineno++;
 286     }
 287     mem_d(line);
 288     return error;
 289 }
 290
 291 /*
 292  * returns true/false for a char that contains ("true" or "false" or numeric 0/1)
 293  */
 294 static bool opts_ini_bool(const char *value) {
 295     if (!strcmp(value, "true"))  return true;
 296     if (!strcmp(value, "false")) return false;
 297     return !!strtol(value, NULL, 10);
 298 }
 299
 300 static char *opts_ini_load(const char *section, const char *name, const char *value) {
 301     char *error = NULL;
 302     bool  found = false;
 303
 304     /*
 305      * undef all of these because they may still be defined like in my
 306      * case they where.
 307      */
 308     #undef GMQCC_TYPE_FLAGS
 309     #undef GMQCC_TYPE_OPTIMIZATIONS
 310     #undef GMQCC_TYPE_WARNS
 311
 312     /* flags */
 313     #define GMQCC_TYPE_FLAGS
 314     #define GMQCC_DEFINE_FLAG(X)                                       \
 315     if (!strcmp(section, "flags") && !strcmp(name, #X)) {              \
 316         opts_set(opts.flags, X, opts_ini_bool(value));                 \
 317         found = true;                                                  \
 318     }
 319     #include "opts.def"
 320
 321     /* warnings */
 322     #define GMQCC_TYPE_WARNS
 323     #define GMQCC_DEFINE_FLAG(X)                                       \
 324     if (!strcmp(section, "warnings") && !strcmp(name, #X)) {           \
 325         opts_set(opts.warn, WARN_##X, opts_ini_bool(value));           \
 326         found = true;                                                  \
 327     }
 328     #include "opts.def"
 329
 330     /* Werror-individuals */
 331     #define GMQCC_TYPE_WARNS
 332     #define GMQCC_DEFINE_FLAG(X)                                       \
 333     if (!strcmp(section, "errors") && !strcmp(name, #X)) {             \
 334         opts_set(opts.werror, WARN_##X, opts_ini_bool(value));         \
 335         found = true;                                                  \
 336     }
 337     #include "opts.def"
 338
 339     /* optimizations */
 340     #define GMQCC_TYPE_OPTIMIZATIONS
 341     #define GMQCC_DEFINE_FLAG(X,Y)                                     \
 342     if (!strcmp(section, "optimizations") && !strcmp(name, #X)) {      \
 343         opts_set(opts.optimization, OPTIM_##X, opts_ini_bool(value));  \
 344         found = true;                                                  \
 345     }
 346     #include "opts.def"
 347
 348     /* nothing was found ever! */
 349     if (!found) {
 350         if (strcmp(section, "flags")         &&
 351             strcmp(section, "warnings")      &&
 352             strcmp(section, "optimizations"))
 353         {
 354             vec_append(error, 17,             "invalid section `");
 355             vec_append(error, strlen(section), section);
 356             vec_push  (error, '`');
 357             vec_push  (error, '\0');
 358         } else {
 359             vec_append(error, 18,             "invalid variable `");
 360             vec_append(error, strlen(name), name);
 361             vec_push  (error, '`');
 362             vec_append(error, 14,              " in section: `");
 363             vec_append(error, strlen(section), section);
 364             vec_push  (error, '`');
 365             vec_push  (error, '\0');
 366         }
 367     }
 368     return error;
 369 }
 370
 371 /*
 372  * Actual loading subsystem, this finds the ini or cfg file, and properly
 373  * loads it and executes it to set compiler options.
 374  */
 375 void opts_ini_init(const char *file) {
 376     /*
 377      * Possible matches are:
 378      *  gmqcc.ini
 379      *  gmqcc.cfg
 380      */
 381     char       *error = NULL;
 382     size_t     line;
 383     fs_file_t  *ini;
 384
 385     if (!file) {
 386         /* try ini */
 387         if (!(ini = fs_file_open((file = "gmqcc.ini"), "r")))
 388             /* try cfg */
 389             if (!(ini = fs_file_open((file = "gmqcc.cfg"), "r")))
 390                 return;
 391     } else if (!(ini = fs_file_open(file, "r")))
 392         return;
 393
 394     con_out("found ini file `%s`\n", file);
 395
 396     if ((line = opts_ini_parse(ini, &opts_ini_load, &error)) != 0) {
 397         /* there was a parse error with the ini file */
 398         con_printmsg(LVL_ERROR, file, line, 0 /*TODO: column for ini error*/, "error", error);
 399         vec_free(error);
 400     }
 401
 402     fs_file_close(ini);
 403 }