opts.c

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