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