Update doc/specification.tex
[xonotic/gmqcc.git] / 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
147 /*
148  * Standard configuration parser and subsystem.  Yes, optionally you may
149  * create ini files or cfg (the driver accepts both) for a project opposed
150  * to supplying just a progs.src (since you also may need to supply command
151  * line arguments or set the options of the compiler) [which cannot be done
152  * from a progs.src.
153  */
154 static char *opts_ini_rstrip(char *s) {
155     char *p = s + strlen(s);
156     while(p > s && isspace(*--p))
157         *p = '\0';
158     return s;
159 }
160
161 static char *opts_ini_lskip(const char *s) {
162     while (*s && isspace(*s))
163         s++;
164     return (char*)s;
165 }
166
167 static char *opts_ini_next(const char *s, char c) {
168     bool last = false;
169     while (*s && *s != c && !(last && *s == ';'))
170         last = !!isspace(*s), s++;
171
172     return (char*)s;
173 }
174
175 static size_t opts_ini_parse (
176     FILE   *filehandle,
177     char *(*loadhandle)(const char *, const char *, const char *),
178     char **errorhandle
179 ) {
180     size_t linesize;
181     size_t lineno             = 1;
182     size_t error              = 0;
183     char  *line               = NULL;
184     char   section_data[2048] = "";
185     char   oldname_data[2048] = "";
186
187     /* parsing and reading variables */
188     char *parse_beg;
189     char *parse_end;
190     char *read_name;
191     char *read_value;
192
193     while (file_getline(&line, &linesize, filehandle) != EOF) {
194         parse_beg = line;
195
196         /* handle BOM */
197         if (lineno == 1 && (
198                 (unsigned char)parse_beg[0] == 0xEF &&
199                 (unsigned char)parse_beg[1] == 0xBB &&
200                 (unsigned char)parse_beg[2] == 0xBF
201             )
202         ) {
203             parse_beg ++; /* 0xEF */
204             parse_beg ++; /* 0xBB */
205             parse_beg ++; /* 0xBF */
206         }
207
208         if (*(parse_beg = opts_ini_lskip(opts_ini_rstrip(parse_beg))) == ';' || *parse_beg == '#') {
209             /* ignore '#' is a perl extension */
210         } else if (*parse_beg == '[') {
211             /* section found */
212             if (*(parse_end = opts_ini_next(parse_beg + 1, ']')) == ']') {
213                 * parse_end = '\0'; /* terminate bro */
214                 strncpy(section_data, parse_beg + 1, sizeof(section_data));
215                 section_data[sizeof(section_data) - 1] = '\0';
216                 *oldname_data                          = '\0';
217             } else if (!error) {
218                 /* otherwise set error to the current line number */
219                 error = lineno;
220             }
221         } else if (*parse_beg && *parse_beg != ';') {
222             /* not a comment, must be a name value pair :) */
223             if (*(parse_end = opts_ini_next(parse_beg, '=')) != '=')
224                   parse_end = opts_ini_next(parse_beg, ':');
225
226             if (*parse_end == '=' || *parse_end == ':') {
227                 *parse_end = '\0'; /* terminate bro */
228                 read_name  = opts_ini_rstrip(parse_beg);
229                 read_value = opts_ini_lskip(parse_end + 1);
230                 if (*(parse_end = opts_ini_next(read_value, '\0')) == ';')
231                     * parse_end = '\0';
232                 opts_ini_rstrip(read_value);
233
234                 /* valid name value pair, lets call down to handler */
235                 strncpy(oldname_data, read_name, sizeof(oldname_data));
236                 oldname_data[sizeof(oldname_data) - 1] ='\0';
237
238                 if ((*errorhandle = loadhandle(section_data, read_name, read_value)) && !error)
239                     error = lineno;
240             } else if (!error) {
241                 /* otherwise set error to the current line number */
242                 error = lineno;
243             }
244         }
245         lineno++;
246     }
247     mem_d(line);
248     return error;
249 }
250
251 /*
252  * returns true/false for a char that contains ("true" or "false" or numeric 0/1)
253  */
254 static bool opts_ini_bool(const char *value) {
255     if (!strcmp(value, "true"))  return true;
256     if (!strcmp(value, "false")) return false;
257     return !!atoi(value);
258 }
259
260 static char *opts_ini_load(const char *section, const char *name, const char *value) {
261     char *error = NULL;
262     bool  found = false;
263
264     /*
265      * undef all of these because they may still be defined like in my
266      * case they where.
267      */  
268     #undef GMQCC_TYPE_FLAGS
269     #undef GMQCC_TYPE_OPTIMIZATIONS
270     #undef GMQCC_TYPE_WARNS
271
272     /* flags */
273     #define GMQCC_TYPE_FLAGS
274     #define GMQCC_DEFINE_FLAG(X)                                       \
275     if (!strcmp(section, "flags") && !strcmp(name, #X)) {              \
276         opts_set(opts.flags, X, opts_ini_bool(value));                 \
277         found = true;                                                  \
278     }
279     #include "opts.def"
280
281     /* warnings */
282     #define GMQCC_TYPE_WARNS
283     #define GMQCC_DEFINE_FLAG(X)                                       \
284     if (!strcmp(section, "warnings") && !strcmp(name, #X)) {           \
285         opts_set(opts.warn, WARN_##X, opts_ini_bool(value));           \
286         found = true;                                                  \
287     }
288     #include "opts.def"
289
290     /* Werror-individuals */
291     #define GMQCC_TYPE_WARNS
292     #define GMQCC_DEFINE_FLAG(X)                                       \
293     if (!strcmp(section, "errors") && !strcmp(name, #X)) {             \
294         opts_set(opts.werror, WARN_##X, opts_ini_bool(value));         \
295         found = true;                                                  \
296     }
297     #include "opts.def"
298
299     /* optimizations */
300     #define GMQCC_TYPE_OPTIMIZATIONS
301     #define GMQCC_DEFINE_FLAG(X,Y)                                     \
302     if (!strcmp(section, "optimizations") && !strcmp(name, #X)) {      \
303         opts_set(opts.optimization, OPTIM_##X, opts_ini_bool(value));  \
304         found = true;                                                  \
305     }
306     #include "opts.def"
307
308     /* nothing was found ever! */
309     if (!found) {
310         if (strcmp(section, "flags")         &&
311             strcmp(section, "warnings")      &&
312             strcmp(section, "optimizations"))
313         {
314             vec_upload(error, "invalid section `", 17);
315             vec_upload(error, section, strlen(section));
316             vec_push  (error, '`');
317             vec_push  (error, '\0');
318         } else {
319             vec_upload(error, "invalid variable `", 18);
320             vec_upload(error, name, strlen(name));
321             vec_push  (error, '`');
322             vec_upload(error, " in section: `", 14);
323             vec_upload(error, section, strlen(section));
324             vec_push  (error, '`');
325             vec_push  (error, '\0');
326         }
327     }
328     return error;
329 }
330
331 /*
332  * Actual loading subsystem, this finds the ini or cfg file, and properly
333  * loads it and executes it to set compiler options.
334  */
335 void opts_ini_init(const char *file) {
336     /*
337      * Possible matches are:
338      *  gmqcc.ini
339      *  gmqcc.cfg
340      */
341     char       *error;
342     size_t     line;
343     FILE       *ini;
344
345     
346     if (!file) {
347         /* try ini */
348         if (!(ini = file_open((file = "gmqcc.ini"), "r")))
349             /* try cfg */
350             if (!(ini = file_open((file = "gmqcc.cfg"), "r")))
351                 return;
352     } else if (!(ini = file_open(file, "r")))
353         return;
354
355     con_out("found ini file `%s`\n", file);
356
357     if ((line = opts_ini_parse(ini, &opts_ini_load, &error)) != 0) {
358         /* there was a parse error with the ini file */
359         con_printmsg(LVL_ERROR, file, line, "error", error);
360         vec_free(error);
361     }
362
363     file_close(ini);
364 }