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
  95     /* flags */
  96     opts_set(opts.flags, ADJUST_VECTOR_FIELDS,           true);
  97     opts_set(opts.flags, CORRECT_TERNARY,                true);
  98     opts_set(opts.flags, BAIL_ON_WERROR,                 true);
  99     opts_set(opts.flags, LEGACY_VECTOR_MATHS,            true);
 100     opts_set(opts.flags, DARKPLACES_STRING_TABLE_BUG,    true);
 101
 102 }
 103
 104 void opts_backup_non_Wall() {
 105     size_t i;
 106     for (i = 0; i <= WARN_DEBUG; ++i)
 107         opts_set(opts.warn_backup, i, OPTS_WARN(i));
 108 }
 109
 110 void opts_restore_non_Wall() {
 111     size_t i;
 112     for (i = 0; i <= WARN_DEBUG; ++i)
 113         opts_set(opts.warn, i, OPTS_GENERIC(opts.warn_backup, i));
 114 }
 115
 116 void opts_backup_non_Werror_all() {
 117     size_t i;
 118     for (i = 0; i <= WARN_DEBUG; ++i)
 119         opts_set(opts.werror_backup, i, OPTS_WERROR(i));
 120 }
 121
 122 void opts_restore_non_Werror_all() {
 123     size_t i;
 124     for (i = 0; i <= WARN_DEBUG; ++i)
 125         opts_set(opts.werror, i, OPTS_GENERIC(opts.werror_backup, i));
 126 }
 127
 128 void opts_init(const char *output, int standard, size_t arraysize) {
 129     opts_setdefault();
 130
 131     OPTS_OPTION_STR(OPTION_OUTPUT)         = (char*)output;
 132     OPTS_OPTION_U32(OPTION_STANDARD)       = standard;
 133     OPTS_OPTION_U32(OPTION_MAX_ARRAY_SIZE) = arraysize;
 134     OPTS_OPTION_U16(OPTION_MEMDUMPCOLS)    = 16;
 135 }
 136
 137 static bool opts_setflag_all(const char *name, bool on, uint32_t *flags, const opts_flag_def_t *list, size_t listsize) {
 138     size_t i;
 139
 140     for (i = 0; i < listsize; ++i) {
 141         if (!strcmp(name, list[i].name)) {
 142             longbit lb = list[i].bit;
 143
 144             if (on)
 145                 flags[lb.idx] |= (1<<(lb.bit));
 146             else
 147                 flags[lb.idx] &= ~(1<<(lb.bit));
 148
 149             return true;
 150         }
 151     }
 152     return false;
 153 }
 154 bool opts_setflag  (const char *name, bool on) {
 155     return opts_setflag_all(name, on, opts.flags,        opts_flag_list, COUNT_FLAGS);
 156 }
 157 bool opts_setwarn  (const char *name, bool on) {
 158     return opts_setflag_all(name, on, opts.warn,         opts_warn_list, COUNT_WARNINGS);
 159 }
 160 bool opts_setwerror(const char *name, bool on) {
 161     return opts_setflag_all(name, on, opts.werror,       opts_warn_list, COUNT_WARNINGS);
 162 }
 163 bool opts_setoptim (const char *name, bool on) {
 164     return opts_setflag_all(name, on, opts.optimization, opts_opt_list,  COUNT_OPTIMIZATIONS);
 165 }
 166
 167 void opts_set(uint32_t *flags, size_t idx, bool on) {
 168     longbit lb;
 169     LONGBIT_SET(lb, idx);
 170
 171     if (on)
 172         flags[lb.idx] |= (1<<(lb.bit));
 173     else
 174         flags[lb.idx] &= ~(1<<(lb.bit));
 175 }
 176
 177 void opts_setoptimlevel(unsigned int level) {
 178     size_t i;
 179     for (i = 0; i < COUNT_OPTIMIZATIONS; ++i)
 180         opts_set(opts.optimization, i, level >= opts_opt_oflag[i]);
 181
 182     if (!level)
 183         opts.optimizeoff = true;
 184 }
 185
 186 /*
 187  * Standard configuration parser and subsystem.  Yes, optionally you may
 188  * create ini files or cfg (the driver accepts both) for a project opposed
 189  * to supplying just a progs.src (since you also may need to supply command
 190  * line arguments or set the options of the compiler) [which cannot be done
 191  * from a progs.src.
 192  */
 193 static char *opts_ini_rstrip(char *s) {
 194     char *p = s + strlen(s);
 195     while(p > s && util_isspace(*--p))
 196         *p = '\0';
 197     return s;
 198 }
 199
 200 static char *opts_ini_lskip(const char *s) {
 201     while (*s && util_isspace(*s))
 202         s++;
 203     return (char*)s;
 204 }
 205
 206 static char *opts_ini_next(const char *s, char c) {
 207     bool last = false;
 208     while (*s && *s != c && !(last && *s == ';'))
 209         last = !!util_isspace(*s), s++;
 210
 211     return (char*)s;
 212 }
 213
 214 static size_t opts_ini_parse (
 215     FILE   *filehandle,
 216     char *(*loadhandle)(const char *, const char *, const char *),
 217     char **errorhandle
 218 ) {
 219     size_t linesize;
 220     size_t lineno             = 1;
 221     size_t error              = 0;
 222     char  *line               = NULL;
 223     char   section_data[2048] = "";
 224     char   oldname_data[2048] = "";
 225
 226     /* parsing and reading variables */
 227     char *parse_beg;
 228     char *parse_end;
 229     char *read_name;
 230     char *read_value;
 231
 232     while (fs_file_getline(&line, &linesize, filehandle) != EOF) {
 233         parse_beg = line;
 234
 235         /* handle BOM */
 236         if (lineno == 1 && (
 237                 (unsigned char)parse_beg[0] == 0xEF &&
 238                 (unsigned char)parse_beg[1] == 0xBB &&
 239                 (unsigned char)parse_beg[2] == 0xBF
 240             )
 241         ) {
 242             parse_beg ++; /* 0xEF */
 243             parse_beg ++; /* 0xBB */
 244             parse_beg ++; /* 0xBF */
 245         }
 246
 247         if (*(parse_beg = opts_ini_lskip(opts_ini_rstrip(parse_beg))) == ';' || *parse_beg == '#') {
 248             /* ignore '#' is a perl extension */
 249         } else if (*parse_beg == '[') {
 250             /* section found */
 251             if (*(parse_end = opts_ini_next(parse_beg + 1, ']')) == ']') {
 252                 * parse_end = '\0'; /* terminate bro */
 253                 util_strncpy(section_data, parse_beg + 1, sizeof(section_data));
 254                 section_data[sizeof(section_data) - 1] = '\0';
 255                 *oldname_data                          = '\0';
 256             } else if (!error) {
 257                 /* otherwise set error to the current line number */
 258                 error = lineno;
 259             }
 260         } else if (*parse_beg && *parse_beg != ';') {
 261             /* not a comment, must be a name value pair :) */
 262             if (*(parse_end = opts_ini_next(parse_beg, '=')) != '=')
 263                   parse_end = opts_ini_next(parse_beg, ':');
 264
 265             if (*parse_end == '=' || *parse_end == ':') {
 266                 *parse_end = '\0'; /* terminate bro */
 267                 read_name  = opts_ini_rstrip(parse_beg);
 268                 read_value = opts_ini_lskip(parse_end + 1);
 269                 if (*(parse_end = opts_ini_next(read_value, '\0')) == ';')
 270                     * parse_end = '\0';
 271                 opts_ini_rstrip(read_value);
 272
 273                 /* valid name value pair, lets call down to handler */
 274                 util_strncpy(oldname_data, read_name, sizeof(oldname_data));
 275                 oldname_data[sizeof(oldname_data) - 1] ='\0';
 276
 277                 if ((*errorhandle = loadhandle(section_data, read_name, read_value)) && !error)
 278                     error = lineno;
 279             } else if (!error) {
 280                 /* otherwise set error to the current line number */
 281                 error = lineno;
 282             }
 283         }
 284         lineno++;
 285     }
 286     mem_d(line);
 287     return error;
 288 }
 289
 290 /*
 291  * returns true/false for a char that contains ("true" or "false" or numeric 0/1)
 292  */
 293 static bool opts_ini_bool(const char *value) {
 294     if (!strcmp(value, "true"))  return true;
 295     if (!strcmp(value, "false")) return false;
 296     return !!strtol(value, NULL, 10);
 297 }
 298
 299 static char *opts_ini_load(const char *section, const char *name, const char *value) {
 300     char *error = NULL;
 301     bool  found = false;
 302
 303     /*
 304      * undef all of these because they may still be defined like in my
 305      * case they where.
 306      */
 307     #undef GMQCC_TYPE_FLAGS
 308     #undef GMQCC_TYPE_OPTIMIZATIONS
 309     #undef GMQCC_TYPE_WARNS
 310
 311     /* flags */
 312     #define GMQCC_TYPE_FLAGS
 313     #define GMQCC_DEFINE_FLAG(X)                                       \
 314     if (!strcmp(section, "flags") && !strcmp(name, #X)) {              \
 315         opts_set(opts.flags, X, opts_ini_bool(value));                 \
 316         found = true;                                                  \
 317     }
 318     #include "opts.def"
 319
 320     /* warnings */
 321     #define GMQCC_TYPE_WARNS
 322     #define GMQCC_DEFINE_FLAG(X)                                       \
 323     if (!strcmp(section, "warnings") && !strcmp(name, #X)) {           \
 324         opts_set(opts.warn, WARN_##X, opts_ini_bool(value));           \
 325         found = true;                                                  \
 326     }
 327     #include "opts.def"
 328
 329     /* Werror-individuals */
 330     #define GMQCC_TYPE_WARNS
 331     #define GMQCC_DEFINE_FLAG(X)                                       \
 332     if (!strcmp(section, "errors") && !strcmp(name, #X)) {             \
 333         opts_set(opts.werror, WARN_##X, opts_ini_bool(value));         \
 334         found = true;                                                  \
 335     }
 336     #include "opts.def"
 337
 338     /* optimizations */
 339     #define GMQCC_TYPE_OPTIMIZATIONS
 340     #define GMQCC_DEFINE_FLAG(X,Y)                                     \
 341     if (!strcmp(section, "optimizations") && !strcmp(name, #X)) {      \
 342         opts_set(opts.optimization, OPTIM_##X, opts_ini_bool(value));  \
 343         found = true;                                                  \
 344     }
 345     #include "opts.def"
 346
 347     /* nothing was found ever! */
 348     if (!found) {
 349         if (strcmp(section, "flags")         &&
 350             strcmp(section, "warnings")      &&
 351             strcmp(section, "optimizations"))
 352         {
 353             vec_append(error, 17,             "invalid section `");
 354             vec_append(error, strlen(section), section);
 355             vec_push  (error, '`');
 356             vec_push  (error, '\0');
 357         } else {
 358             vec_append(error, 18,             "invalid variable `");
 359             vec_append(error, strlen(name), name);
 360             vec_push  (error, '`');
 361             vec_append(error, 14,              " in section: `");
 362             vec_append(error, strlen(section), section);
 363             vec_push  (error, '`');
 364             vec_push  (error, '\0');
 365         }
 366     }
 367     return error;
 368 }
 369
 370 /*
 371  * Actual loading subsystem, this finds the ini or cfg file, and properly
 372  * loads it and executes it to set compiler options.
 373  */
 374 void opts_ini_init(const char *file) {
 375     /*
 376      * Possible matches are:
 377      *  gmqcc.ini
 378      *  gmqcc.cfg
 379      */
 380     char       *error = NULL;
 381     size_t     line;
 382     FILE       *ini;
 383
 384     if (!file) {
 385         /* try ini */
 386         if (!(ini = fs_file_open((file = "gmqcc.ini"), "r")))
 387             /* try cfg */
 388             if (!(ini = fs_file_open((file = "gmqcc.cfg"), "r")))
 389                 return;
 390     } else if (!(ini = fs_file_open(file, "r")))
 391         return;
 392
 393     con_out("found ini file `%s`\n", file);
 394
 395     if ((line = opts_ini_parse(ini, &opts_ini_load, &error)) != 0) {
 396         /* there was a parse error with the ini file */
 397         con_printmsg(LVL_ERROR, file, line, 0 /*TODO: column for ini error*/, "error", error);
 398         vec_free(error);
 399     }
 400
 401     fs_file_close(ini);
 402 }