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