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 "gmqcc.h"
  25 unsigned int opts_optimizationcount[COUNT_OPTIMIZATIONS];
  26 opts_cmd_t   opts; /* command lien options */
  27
  28 static void opts_setdefault() {
  29     memset(&opts, 0, sizeof(opts_cmd_t));
  30     OPTS_OPTION_BOOL(OPTION_CORRECTION) = true;
  31
  32     /* warnings */
  33     opts_set(opts.warn,  WARN_UNUSED_VARIABLE,           true);
  34     opts_set(opts.warn,  WARN_USED_UNINITIALIZED,        true);
  35     opts_set(opts.warn,  WARN_UNKNOWN_CONTROL_SEQUENCE,  true);
  36     opts_set(opts.warn,  WARN_EXTENSIONS,                true);
  37     opts_set(opts.warn,  WARN_FIELD_REDECLARED,          true);
  38     opts_set(opts.warn,  WARN_MISSING_RETURN_VALUES,     true);
  39     opts_set(opts.warn,  WARN_INVALID_PARAMETER_COUNT,   true);
  40     opts_set(opts.warn,  WARN_LOCAL_CONSTANTS,           true);
  41     opts_set(opts.warn,  WARN_VOID_VARIABLES,            true);
  42     opts_set(opts.warn,  WARN_IMPLICIT_FUNCTION_POINTER, true);
  43     opts_set(opts.warn,  WARN_VARIADIC_FUNCTION,         true);
  44     opts_set(opts.warn,  WARN_FRAME_MACROS,              true);
  45     opts_set(opts.warn,  WARN_EFFECTLESS_STATEMENT,      true);
  46     opts_set(opts.warn,  WARN_END_SYS_FIELDS,            true);
  47     opts_set(opts.warn,  WARN_ASSIGN_FUNCTION_TYPES,     true);
  48     opts_set(opts.warn,  WARN_CPP,                       true);
  49     opts_set(opts.warn,  WARN_MULTIFILE_IF,              true);
  50     opts_set(opts.warn,  WARN_DOUBLE_DECLARATION,        true);
  51     opts_set(opts.warn,  WARN_CONST_VAR,                 true);
  52     opts_set(opts.warn,  WARN_MULTIBYTE_CHARACTER,       true);
  53     opts_set(opts.warn,  WARN_UNKNOWN_PRAGMAS,           true);
  54     opts_set(opts.warn,  WARN_UNREACHABLE_CODE,          true);
  55     opts_set(opts.warn,  WARN_UNKNOWN_ATTRIBUTE,         true);
  56     opts_set(opts.warn,  WARN_RESERVED_NAMES,            true);
  57     opts_set(opts.warn,  WARN_UNINITIALIZED_CONSTANT,    true);
  58     opts_set(opts.warn,  WARN_DEPRECATED,                true);
  59     opts_set(opts.warn,  WARN_PARENTHESIS,               true);
  60
  61     /* flags */
  62     opts_set(opts.flags, ADJUST_VECTOR_FIELDS,           true);
  63     opts_set(opts.flags, CORRECT_TERNARY,                true);
  64     opts_set(opts.flags, BAIL_ON_WERROR,                 true);
  65     opts_set(opts.flags, LEGACY_VECTOR_MATHS,            true);
  66     opts_set(opts.flags, DARKPLACES_STRING_TABLE_BUG,    true);
  67 }
  68
  69 void opts_backup_non_Wall() {
  70     size_t i;
  71     for (i = 0; i <= WARN_DEBUG; ++i)
  72         opts_set(opts.warn_backup, i, OPTS_WARN(i));
  73 }
  74
  75 void opts_restore_non_Wall() {
  76     size_t i;
  77     for (i = 0; i <= WARN_DEBUG; ++i)
  78         opts_set(opts.warn, i, OPTS_GENERIC(opts.warn_backup, i));
  79 }
  80
  81 void opts_backup_non_Werror_all() {
  82     size_t i;
  83     for (i = 0; i <= WARN_DEBUG; ++i)
  84         opts_set(opts.werror_backup, i, OPTS_WERROR(i));
  85 }
  86
  87 void opts_restore_non_Werror_all() {
  88     size_t i;
  89     for (i = 0; i <= WARN_DEBUG; ++i)
  90         opts_set(opts.werror, i, OPTS_GENERIC(opts.werror_backup, i));
  91 }
  92
  93 void opts_init(const char *output, int standard, size_t arraysize) {
  94     opts_setdefault();
  95
  96     OPTS_OPTION_STR(OPTION_OUTPUT)         = (char*)output;
  97     OPTS_OPTION_U32(OPTION_STANDARD)       = standard;
  98     OPTS_OPTION_U32(OPTION_MAX_ARRAY_SIZE) = arraysize;
  99 }
 100
 101 static bool opts_setflag_all(const char *name, bool on, uint32_t *flags, const opts_flag_def *list, size_t listsize) {
 102     size_t i;
 103
 104     for (i = 0; i < listsize; ++i) {
 105         if (!strcmp(name, list[i].name)) {
 106             longbit lb = list[i].bit;
 107
 108             if (on)
 109                 flags[lb.idx] |= (1<<(lb.bit));
 110             else
 111                 flags[lb.idx] &= ~(1<<(lb.bit));
 112
 113             return true;
 114         }
 115     }
 116     return false;
 117 }
 118 bool opts_setflag  (const char *name, bool on) {
 119     return opts_setflag_all(name, on, opts.flags,        opts_flag_list, COUNT_FLAGS);
 120 }
 121 bool opts_setwarn  (const char *name, bool on) {
 122     return opts_setflag_all(name, on, opts.warn,         opts_warn_list, COUNT_WARNINGS);
 123 }
 124 bool opts_setwerror(const char *name, bool on) {
 125     return opts_setflag_all(name, on, opts.werror,       opts_warn_list, COUNT_WARNINGS);
 126 }
 127 bool opts_setoptim (const char *name, bool on) {
 128     return opts_setflag_all(name, on, opts.optimization, opts_opt_list,  COUNT_OPTIMIZATIONS);
 129 }
 130
 131 void opts_set(uint32_t *flags, size_t idx, bool on) {
 132     longbit lb;
 133     LONGBIT_SET(lb, idx);
 134
 135     if (on)
 136         flags[lb.idx] |= (1<<(lb.bit));
 137     else
 138         flags[lb.idx] &= ~(1<<(lb.bit));
 139 }
 140
 141 void opts_setoptimlevel(unsigned int level) {
 142     size_t i;
 143     for (i = 0; i < COUNT_OPTIMIZATIONS; ++i)
 144         opts_set(opts.optimization, i, level >= opts_opt_oflag[i]);
 145
 146     if (!level)
 147         opts.optimizeoff = true;
 148 }
 149
 150 /*
 151  * Standard configuration parser and subsystem.  Yes, optionally you may
 152  * create ini files or cfg (the driver accepts both) for a project opposed
 153  * to supplying just a progs.src (since you also may need to supply command
 154  * line arguments or set the options of the compiler) [which cannot be done
 155  * from a progs.src.
 156  */
 157 static char *opts_ini_rstrip(char *s) {
 158     char *p = s + strlen(s);
 159     while(p > s && isspace(*--p))
 160         *p = '\0';
 161     return s;
 162 }
 163
 164 static char *opts_ini_lskip(const char *s) {
 165     while (*s && isspace(*s))
 166         s++;
 167     return (char*)s;
 168 }
 169
 170 static char *opts_ini_next(const char *s, char c) {
 171     bool last = false;
 172     while (*s && *s != c && !(last && *s == ';'))
 173         last = !!isspace(*s), s++;
 174
 175     return (char*)s;
 176 }
 177
 178 static size_t opts_ini_parse (
 179     FILE   *filehandle,
 180     char *(*loadhandle)(const char *, const char *, const char *),
 181     char **errorhandle
 182 ) {
 183     size_t linesize;
 184     size_t lineno             = 1;
 185     size_t error              = 0;
 186     char  *line               = NULL;
 187     char   section_data[2048] = "";
 188     char   oldname_data[2048] = "";
 189
 190     /* parsing and reading variables */
 191     char *parse_beg;
 192     char *parse_end;
 193     char *read_name;
 194     char *read_value;
 195
 196     while (fs_file_getline(&line, &linesize, filehandle) != EOF) {
 197         parse_beg = line;
 198
 199         /* handle BOM */
 200         if (lineno == 1 && (
 201                 (unsigned char)parse_beg[0] == 0xEF &&
 202                 (unsigned char)parse_beg[1] == 0xBB &&
 203                 (unsigned char)parse_beg[2] == 0xBF
 204             )
 205         ) {
 206             parse_beg ++; /* 0xEF */
 207             parse_beg ++; /* 0xBB */
 208             parse_beg ++; /* 0xBF */
 209         }
 210
 211         if (*(parse_beg = opts_ini_lskip(opts_ini_rstrip(parse_beg))) == ';' || *parse_beg == '#') {
 212             /* ignore '#' is a perl extension */
 213         } else if (*parse_beg == '[') {
 214             /* section found */
 215             if (*(parse_end = opts_ini_next(parse_beg + 1, ']')) == ']') {
 216                 * parse_end = '\0'; /* terminate bro */
 217                 strncpy(section_data, parse_beg + 1, sizeof(section_data));
 218                 section_data[sizeof(section_data) - 1] = '\0';
 219                 *oldname_data                          = '\0';
 220             } else if (!error) {
 221                 /* otherwise set error to the current line number */
 222                 error = lineno;
 223             }
 224         } else if (*parse_beg && *parse_beg != ';') {
 225             /* not a comment, must be a name value pair :) */
 226             if (*(parse_end = opts_ini_next(parse_beg, '=')) != '=')
 227                   parse_end = opts_ini_next(parse_beg, ':');
 228
 229             if (*parse_end == '=' || *parse_end == ':') {
 230                 *parse_end = '\0'; /* terminate bro */
 231                 read_name  = opts_ini_rstrip(parse_beg);
 232                 read_value = opts_ini_lskip(parse_end + 1);
 233                 if (*(parse_end = opts_ini_next(read_value, '\0')) == ';')
 234                     * parse_end = '\0';
 235                 opts_ini_rstrip(read_value);
 236
 237                 /* valid name value pair, lets call down to handler */
 238                 strncpy(oldname_data, read_name, sizeof(oldname_data));
 239                 oldname_data[sizeof(oldname_data) - 1] ='\0';
 240
 241                 if ((*errorhandle = loadhandle(section_data, read_name, read_value)) && !error)
 242                     error = lineno;
 243             } else if (!error) {
 244                 /* otherwise set error to the current line number */
 245                 error = lineno;
 246             }
 247         }
 248         lineno++;
 249     }
 250     mem_d(line);
 251     return error;
 252 }
 253
 254 /*
 255  * returns true/false for a char that contains ("true" or "false" or numeric 0/1)
 256  */
 257 static bool opts_ini_bool(const char *value) {
 258     if (!strcmp(value, "true"))  return true;
 259     if (!strcmp(value, "false")) return false;
 260     return !!strtoul(value, NULL, 10);
 261 }
 262
 263 static char *opts_ini_load(const char *section, const char *name, const char *value) {
 264     char *error = NULL;
 265     bool  found = false;
 266
 267     /*
 268      * undef all of these because they may still be defined like in my
 269      * case they where.
 270      */
 271     #undef GMQCC_TYPE_FLAGS
 272     #undef GMQCC_TYPE_OPTIMIZATIONS
 273     #undef GMQCC_TYPE_WARNS
 274
 275     /* flags */
 276     #define GMQCC_TYPE_FLAGS
 277     #define GMQCC_DEFINE_FLAG(X)                                       \
 278     if (!strcmp(section, "flags") && !strcmp(name, #X)) {              \
 279         opts_set(opts.flags, X, opts_ini_bool(value));                 \
 280         found = true;                                                  \
 281     }
 282     #include "opts.def"
 283
 284     /* warnings */
 285     #define GMQCC_TYPE_WARNS
 286     #define GMQCC_DEFINE_FLAG(X)                                       \
 287     if (!strcmp(section, "warnings") && !strcmp(name, #X)) {           \
 288         opts_set(opts.warn, WARN_##X, opts_ini_bool(value));           \
 289         found = true;                                                  \
 290     }
 291     #include "opts.def"
 292
 293     /* Werror-individuals */
 294     #define GMQCC_TYPE_WARNS
 295     #define GMQCC_DEFINE_FLAG(X)                                       \
 296     if (!strcmp(section, "errors") && !strcmp(name, #X)) {             \
 297         opts_set(opts.werror, WARN_##X, opts_ini_bool(value));         \
 298         found = true;                                                  \
 299     }
 300     #include "opts.def"
 301
 302     /* optimizations */
 303     #define GMQCC_TYPE_OPTIMIZATIONS
 304     #define GMQCC_DEFINE_FLAG(X,Y)                                     \
 305     if (!strcmp(section, "optimizations") && !strcmp(name, #X)) {      \
 306         opts_set(opts.optimization, OPTIM_##X, opts_ini_bool(value));  \
 307         found = true;                                                  \
 308     }
 309     #include "opts.def"
 310
 311     /* nothing was found ever! */
 312     if (!found) {
 313         if (strcmp(section, "flags")         &&
 314             strcmp(section, "warnings")      &&
 315             strcmp(section, "optimizations"))
 316         {
 317             vec_upload(error, "invalid section `", 17);
 318             vec_upload(error, section, strlen(section));
 319             vec_push  (error, '`');
 320             vec_push  (error, '\0');
 321         } else {
 322             vec_upload(error, "invalid variable `", 18);
 323             vec_upload(error, name, strlen(name));
 324             vec_push  (error, '`');
 325             vec_upload(error, " in section: `", 14);
 326             vec_upload(error, section, strlen(section));
 327             vec_push  (error, '`');
 328             vec_push  (error, '\0');
 329         }
 330     }
 331     return error;
 332 }
 333
 334 /*
 335  * Actual loading subsystem, this finds the ini or cfg file, and properly
 336  * loads it and executes it to set compiler options.
 337  */
 338 void opts_ini_init(const char *file) {
 339     /*
 340      * Possible matches are:
 341      *  gmqcc.ini
 342      *  gmqcc.cfg
 343      */
 344     char       *error;
 345     size_t     line;
 346     FILE       *ini;
 347
 348
 349     if (!file) {
 350         /* try ini */
 351         if (!(ini = fs_file_open((file = "gmqcc.ini"), "r")))
 352             /* try cfg */
 353             if (!(ini = fs_file_open((file = "gmqcc.cfg"), "r")))
 354                 return;
 355     } else if (!(ini = fs_file_open(file, "r")))
 356         return;
 357
 358     con_out("found ini file `%s`\n", file);
 359
 360     if ((line = opts_ini_parse(ini, &opts_ini_load, &error)) != 0) {
 361         /* there was a parse error with the ini file */
 362         con_printmsg(LVL_ERROR, file, line, "error", error);
 363         vec_free(error);
 364     }
 365
 366     fs_file_close(ini);
 367 }