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