Arithmetic exception flag and a plethora of tests.
[xonotic/gmqcc.git] / ftepp.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 #include <sys/stat.h>
27
28 #include "gmqcc.h"
29 #include "lexer.h"
30
31 #define HT_MACROS 1024
32
33 typedef struct {
34     bool on;
35     bool was_on;
36     bool had_else;
37 } ppcondition;
38
39 typedef struct {
40     int   token;
41     char *value;
42     /* a copy from the lexer */
43     union {
44         vec3_t v;
45         int    i;
46         double f;
47         int    t; /* type */
48     } constval;
49 } pptoken;
50
51 typedef struct {
52     lex_ctx_t ctx;
53
54     char   *name;
55     char  **params;
56     /* yes we need an extra flag since `#define FOO x` is not the same as `#define FOO() x` */
57     bool    has_params;
58     bool    variadic;
59
60     pptoken **output;
61 } ppmacro;
62
63 typedef struct ftepp_s {
64     lex_file    *lex;
65     int          token;
66     unsigned int errors;
67
68     bool         output_on;
69     ppcondition *conditions;
70     /*ppmacro    **macros;*/
71     ht           macros;  /* hashtable<string, ppmacro*> */
72     char        *output_string;
73
74     char        *itemname;
75     char        *includename;
76     bool         in_macro;
77
78     uint32_t predef_countval;
79     uint32_t predef_randval;
80 } ftepp_t;
81
82 /* __DATE__ */
83 static char *ftepp_predef_date(ftepp_t *context) {
84     const struct tm *itime = NULL;
85     char            *value = (char*)mem_a(82);
86     time_t           rtime;
87
88     (void)context;
89
90     time (&rtime);
91     itime = util_localtime(&rtime);
92     strftime(value, 82, "\"%b %d %Y\"", itime);
93
94     return value;
95 }
96
97 /* __TIME__ */
98 static char *ftepp_predef_time(ftepp_t *context) {
99     const struct tm *itime = NULL;
100     char            *value = (char*)mem_a(82);
101     time_t           rtime;
102
103     (void)context;
104
105     time (&rtime);
106     itime = util_localtime(&rtime);
107     strftime(value, 82, "\"%X\"", itime);
108
109     return value;
110 }
111
112 /* __LINE__ */
113 static char *ftepp_predef_line(ftepp_t *context) {
114     char *value;
115
116     util_asprintf(&value, "%d", (int)context->lex->line);
117     return value;
118 }
119 /* __FILE__ */
120 static char *ftepp_predef_file(ftepp_t *context) {
121     size_t length = strlen(context->lex->name) + 3; /* two quotes and a terminator */
122     char  *value  = (char*)mem_a(length);
123
124     util_snprintf(value, length, "\"%s\"", context->lex->name);
125     return value;
126 }
127 /* __COUNTER_LAST__ */
128 static char *ftepp_predef_counterlast(ftepp_t *context) {
129     char *value;
130     util_asprintf(&value, "%u", context->predef_countval);
131     return value;
132 }
133 /* __COUNTER__ */
134 static char *ftepp_predef_counter(ftepp_t *context) {
135     char *value;
136
137     context->predef_countval ++;
138     util_asprintf(&value, "%u", context->predef_countval);
139
140     return value;
141 }
142 /* __RANDOM__ */
143 static char *ftepp_predef_random(ftepp_t *context) {
144     char *value;
145
146     context->predef_randval = (util_rand() % 0xFF) + 1;
147     util_asprintf(&value, "%u", context->predef_randval);
148     return value;
149 }
150 /* __RANDOM_LAST__ */
151 static char *ftepp_predef_randomlast(ftepp_t *context) {
152     char *value;
153
154     util_asprintf(&value, "%u", context->predef_randval);
155     return value;
156 }
157 /* __TIMESTAMP__ */
158 static char *ftepp_predef_timestamp(ftepp_t *context) {
159     struct stat finfo;
160     const char *find;
161     char       *value;
162     size_t      size;
163
164     if (stat(context->lex->name, &finfo))
165         return util_strdup("\"<failed to determine timestamp>\"");
166
167     find = util_ctime(&finfo.st_mtime);
168     value = (char*)mem_a(strlen(find) + 1);
169     memcpy(&value[1], find, (size = strlen(find)) - 1);
170
171     value[0]    = '"';
172     value[size] = '"';
173
174     return value;
175 }
176
177 typedef struct {
178     const char   *name;
179     char       *(*func)(ftepp_t *);
180 } ftepp_predef_t;
181
182 static const ftepp_predef_t ftepp_predefs[] = {
183     { "__LINE__",         &ftepp_predef_line        },
184     { "__FILE__",         &ftepp_predef_file        },
185     { "__COUNTER__",      &ftepp_predef_counter     },
186     { "__COUNTER_LAST__", &ftepp_predef_counterlast },
187     { "__RANDOM__",       &ftepp_predef_random      },
188     { "__RANDOM_LAST__",  &ftepp_predef_randomlast  },
189     { "__DATE__",         &ftepp_predef_date        },
190     { "__TIME__",         &ftepp_predef_time        },
191     { "__TIME_STAMP__",   &ftepp_predef_timestamp   }
192 };
193
194 static GMQCC_INLINE size_t ftepp_predef_index(const char *name) {
195     /* no hashtable here, we simply check for one to exist the naive way */
196     size_t i;
197     for(i = 1; i < GMQCC_ARRAY_COUNT(ftepp_predefs) + 1; i++)
198         if (!strcmp(ftepp_predefs[i-1].name, name))
199             return i;
200     return 0;
201 }
202
203 bool ftepp_predef_exists(const char *name);
204 bool ftepp_predef_exists(const char *name) {
205     return ftepp_predef_index(name) != 0;
206 }
207
208 /* singleton because we're allowed */
209 static GMQCC_INLINE char *(*ftepp_predef(const char *name))(ftepp_t *context) {
210     size_t i = ftepp_predef_index(name);
211     return (i != 0) ? ftepp_predefs[i-1].func : NULL;
212 }
213
214 #define ftepp_tokval(f) ((f)->lex->tok.value)
215 #define ftepp_ctx(f)    ((f)->lex->tok.ctx)
216
217 static void ftepp_errorat(ftepp_t *ftepp, lex_ctx_t ctx, const char *fmt, ...)
218 {
219     va_list ap;
220
221     ftepp->errors++;
222
223     va_start(ap, fmt);
224     con_cvprintmsg(ctx, LVL_ERROR, "error", fmt, ap);
225     va_end(ap);
226 }
227
228 static void ftepp_error(ftepp_t *ftepp, const char *fmt, ...)
229 {
230     va_list ap;
231
232     ftepp->errors++;
233
234     va_start(ap, fmt);
235     con_cvprintmsg(ftepp->lex->tok.ctx, LVL_ERROR, "error", fmt, ap);
236     va_end(ap);
237 }
238
239 static bool GMQCC_WARN ftepp_warn(ftepp_t *ftepp, int warntype, const char *fmt, ...)
240 {
241     bool    r;
242     va_list ap;
243
244     va_start(ap, fmt);
245     r = vcompile_warning(ftepp->lex->tok.ctx, warntype, fmt, ap);
246     va_end(ap);
247     return r;
248 }
249
250 static pptoken *pptoken_make(ftepp_t *ftepp)
251 {
252     pptoken *token = (pptoken*)mem_a(sizeof(pptoken));
253     token->token = ftepp->token;
254 #if 0
255     if (token->token == TOKEN_WHITE)
256         token->value = util_strdup(" ");
257     else
258 #else
259         token->value = util_strdup(ftepp_tokval(ftepp));
260 #endif
261     memcpy(&token->constval, &ftepp->lex->tok.constval, sizeof(token->constval));
262     return token;
263 }
264
265 static GMQCC_INLINE void pptoken_delete(pptoken *self)
266 {
267     mem_d(self->value);
268     mem_d(self);
269 }
270
271 static ppmacro *ppmacro_new(lex_ctx_t ctx, const char *name)
272 {
273     ppmacro *macro = (ppmacro*)mem_a(sizeof(ppmacro));
274
275     (void)ctx;
276     memset(macro, 0, sizeof(*macro));
277     macro->name = util_strdup(name);
278     return macro;
279 }
280
281 static void ppmacro_delete(ppmacro *self)
282 {
283     size_t i;
284     for (i = 0; i < vec_size(self->params); ++i)
285         mem_d(self->params[i]);
286     vec_free(self->params);
287     for (i = 0; i < vec_size(self->output); ++i)
288         pptoken_delete(self->output[i]);
289     vec_free(self->output);
290     mem_d(self->name);
291     mem_d(self);
292 }
293
294 static ftepp_t* ftepp_new(void)
295 {
296     ftepp_t *ftepp;
297
298     ftepp = (ftepp_t*)mem_a(sizeof(*ftepp));
299     memset(ftepp, 0, sizeof(*ftepp));
300
301     ftepp->macros          = util_htnew(HT_MACROS);
302     ftepp->output_on       = true;
303     ftepp->predef_countval = 0;
304     ftepp->predef_randval  = 0;
305
306     return ftepp;
307 }
308
309 static GMQCC_INLINE void ftepp_flush_do(ftepp_t *self)
310 {
311     vec_free(self->output_string);
312 }
313
314 static void ftepp_delete(ftepp_t *self)
315 {
316     ftepp_flush_do(self);
317     if (self->itemname)
318         mem_d(self->itemname);
319     if (self->includename)
320         vec_free(self->includename);
321
322     util_htrem(self->macros, (void (*)(void*))&ppmacro_delete);
323
324     vec_free(self->conditions);
325     if (self->lex)
326         lex_close(self->lex);
327     mem_d(self);
328 }
329
330 static void ftepp_out(ftepp_t *ftepp, const char *str, bool ignore_cond)
331 {
332     if (ignore_cond || ftepp->output_on)
333     {
334         size_t len;
335         char  *data;
336         len = strlen(str);
337         data = vec_add(ftepp->output_string, len);
338         memcpy(data, str, len);
339     }
340 }
341
342 static GMQCC_INLINE void ftepp_update_output_condition(ftepp_t *ftepp)
343 {
344     size_t i;
345     ftepp->output_on = true;
346     for (i = 0; i < vec_size(ftepp->conditions); ++i)
347         ftepp->output_on = ftepp->output_on && ftepp->conditions[i].on;
348 }
349
350 static GMQCC_INLINE ppmacro* ftepp_macro_find(ftepp_t *ftepp, const char *name)
351 {
352     return (ppmacro*)util_htget(ftepp->macros, name);
353 }
354
355 static GMQCC_INLINE void ftepp_macro_delete(ftepp_t *ftepp, const char *name)
356 {
357     util_htrm(ftepp->macros, name, (void (*)(void*))&ppmacro_delete);
358 }
359
360 static GMQCC_INLINE int ftepp_next(ftepp_t *ftepp)
361 {
362     return (ftepp->token = lex_do(ftepp->lex));
363 }
364
365 /* Important: this does not skip newlines! */
366 static bool ftepp_skipspace(ftepp_t *ftepp)
367 {
368     if (ftepp->token != TOKEN_WHITE)
369         return true;
370     while (ftepp_next(ftepp) == TOKEN_WHITE) {}
371     if (ftepp->token >= TOKEN_EOF) {
372         ftepp_error(ftepp, "unexpected end of preprocessor directive");
373         return false;
374     }
375     return true;
376 }
377
378 /* this one skips EOLs as well */
379 static bool ftepp_skipallwhite(ftepp_t *ftepp)
380 {
381     if (ftepp->token != TOKEN_WHITE && ftepp->token != TOKEN_EOL)
382         return true;
383     do {
384         ftepp_next(ftepp);
385     } while (ftepp->token == TOKEN_WHITE || ftepp->token == TOKEN_EOL);
386     if (ftepp->token >= TOKEN_EOF) {
387         ftepp_error(ftepp, "unexpected end of preprocessor directive");
388         return false;
389     }
390     return true;
391 }
392
393 /**
394  * The huge macro parsing code...
395  */
396 static bool ftepp_define_params(ftepp_t *ftepp, ppmacro *macro)
397 {
398     do {
399         ftepp_next(ftepp);
400         if (!ftepp_skipspace(ftepp))
401             return false;
402         if (ftepp->token == ')')
403             break;
404         switch (ftepp->token) {
405             case TOKEN_IDENT:
406             case TOKEN_TYPENAME:
407             case TOKEN_KEYWORD:
408                 vec_push(macro->params, util_strdup(ftepp_tokval(ftepp)));
409                 break;
410             case TOKEN_DOTS:
411                 macro->variadic = true;
412                 break;
413             default:
414                 ftepp_error(ftepp, "unexpected token in parameter list");
415                 return false;
416         }
417         ftepp_next(ftepp);
418         if (!ftepp_skipspace(ftepp))
419             return false;
420         if (macro->variadic && ftepp->token != ')') {
421             ftepp_error(ftepp, "cannot have parameters after the variadic parameters");
422             return false;
423         }
424     } while (ftepp->token == ',');
425
426     if (ftepp->token != ')') {
427         ftepp_error(ftepp, "expected closing paren after macro parameter list");
428         return false;
429     }
430     ftepp_next(ftepp);
431     /* skipspace happens in ftepp_define */
432     return true;
433 }
434
435 static bool ftepp_define_body(ftepp_t *ftepp, ppmacro *macro)
436 {
437     pptoken *ptok;
438     while (ftepp->token != TOKEN_EOL && ftepp->token < TOKEN_EOF) {
439         bool   subscript = false;
440         size_t index     = 0;
441         if (macro->variadic && !strcmp(ftepp_tokval(ftepp), "__VA_ARGS__")) {
442             subscript = !!(ftepp_next(ftepp) == '#');
443
444             if (subscript && ftepp_next(ftepp) != '#') {
445                 ftepp_error(ftepp, "expected `##` in __VA_ARGS__ for subscripting");
446                 return false;
447             } else if (subscript) {
448                 if (ftepp_next(ftepp) == '[') {
449                     if (ftepp_next(ftepp) != TOKEN_INTCONST) {
450                         ftepp_error(ftepp, "expected index for __VA_ARGS__ subscript");
451                         return false;
452                     }
453
454                     index = (int)strtol(ftepp_tokval(ftepp), NULL, 10);
455
456                     if (ftepp_next(ftepp) != ']') {
457                         ftepp_error(ftepp, "expected `]` in __VA_ARGS__ subscript");
458                         return false;
459                     }
460
461                     /*
462                      * mark it as an array to be handled later as such and not
463                      * as traditional __VA_ARGS__
464                      */
465                     ftepp->token = TOKEN_VA_ARGS_ARRAY;
466                     ptok = pptoken_make(ftepp);
467                     ptok->constval.i = index;
468                     vec_push(macro->output, ptok);
469                     ftepp_next(ftepp);
470                 } else {
471                     ftepp_error(ftepp, "expected `[` for subscripting of __VA_ARGS__");
472                     return false;
473                 }
474             } else {
475                 int old = ftepp->token;
476                 ftepp->token = TOKEN_VA_ARGS;
477                 ptok = pptoken_make(ftepp);
478                 vec_push(macro->output, ptok);
479                 ftepp->token = old;
480             }
481         }
482         else if (macro->variadic && !strcmp(ftepp_tokval(ftepp), "__VA_COUNT__")) {
483             ftepp->token = TOKEN_VA_COUNT;
484             ptok         = pptoken_make(ftepp);
485             vec_push(macro->output, ptok);
486             ftepp_next(ftepp);
487         } else {
488             ptok = pptoken_make(ftepp);
489             vec_push(macro->output, ptok);
490             ftepp_next(ftepp);
491         }
492     }
493     /* recursive expansion can cause EOFs here */
494     if (ftepp->token != TOKEN_EOL && ftepp->token != TOKEN_EOF) {
495         ftepp_error(ftepp, "unexpected junk after macro or unexpected end of file");
496         return false;
497     }
498     return true;
499 }
500
501 static const char *ftepp_math_constants[][2] = {
502     { "M_E",        "2.7182818284590452354"  }, /* e          */
503     { "M_LOG2E",    "1.4426950408889634074"  }, /* log_2 e    */
504     { "M_LOG10E",   "0.43429448190325182765" }, /* log_10 e   */
505     { "M_LN2",      "0.69314718055994530942" }, /* log_e 2    */
506     { "M_LN10",     "2.30258509299404568402" }, /* log_e 10   */
507     { "M_PI",       "3.14159265358979323846" }, /* pi         */
508     { "M_PI_2",     "1.57079632679489661923" }, /* pi/2       */
509     { "M_PI_4",     "0.78539816339744830962" }, /* pi/4       */
510     { "M_1_PI",     "0.31830988618379067154" }, /* 1/pi       */
511     { "M_2_PI",     "0.63661977236758134308" }, /* 2/pi       */
512     { "M_2_SQRTPI", "1.12837916709551257390" }, /* 2/sqrt(pi) */
513     { "M_SQRT2",    "1.41421356237309504880" }, /* sqrt(2)    */
514     { "M_SQRT1_2",  "0.70710678118654752440" }, /* 1/sqrt(2)  */
515     { "M_TAU",      "6.28318530717958647692" }  /* pi*2       */
516 };
517
518 static bool ftepp_define(ftepp_t *ftepp)
519 {
520     ppmacro *macro = NULL;
521     size_t l = ftepp_ctx(ftepp).line;
522     size_t i;
523     bool   mathconstant = false;
524
525     (void)ftepp_next(ftepp);
526     if (!ftepp_skipspace(ftepp))
527         return false;
528
529     switch (ftepp->token) {
530         case TOKEN_IDENT:
531         case TOKEN_TYPENAME:
532         case TOKEN_KEYWORD:
533             if (OPTS_FLAG(FTEPP_MATHDEFS)) {
534                 for (i = 0; i < GMQCC_ARRAY_COUNT(ftepp_math_constants); i++) {
535                     if (!strcmp(ftepp_math_constants[i][0], ftepp_tokval(ftepp))) {
536                         mathconstant = true;
537                         break;
538                     }
539                 }
540             }
541
542             macro = ftepp_macro_find(ftepp, ftepp_tokval(ftepp));
543
544             if (OPTS_FLAG(FTEPP_MATHDEFS)) {
545                 /* user defined ones take precedence */
546                 if (macro && mathconstant) {
547                     ftepp_macro_delete(ftepp, ftepp_tokval(ftepp));
548                     macro = NULL;
549                 }
550             }
551
552             if (macro && ftepp->output_on) {
553                 if (ftepp_warn(ftepp, WARN_CPP, "redefining `%s`", ftepp_tokval(ftepp)))
554                     return false;
555                 ftepp_macro_delete(ftepp, ftepp_tokval(ftepp));
556             }
557             macro = ppmacro_new(ftepp_ctx(ftepp), ftepp_tokval(ftepp));
558             break;
559         default:
560             ftepp_error(ftepp, "expected macro name");
561             return false;
562     }
563
564     (void)ftepp_next(ftepp);
565
566     if (ftepp->token == '(') {
567         macro->has_params = true;
568         if (!ftepp_define_params(ftepp, macro)) {
569             ppmacro_delete(macro);
570             return false;
571         }
572     }
573
574     if (!ftepp_skipspace(ftepp)) {
575         ppmacro_delete(macro);
576         return false;
577     }
578
579     if (!ftepp_define_body(ftepp, macro)) {
580         ppmacro_delete(macro);
581         return false;
582     }
583
584     if (ftepp->output_on)
585         util_htset(ftepp->macros, macro->name, (void*)macro);
586     else {
587         ppmacro_delete(macro);
588     }
589
590     for (; l < ftepp_ctx(ftepp).line; ++l)
591         ftepp_out(ftepp, "\n", true);
592     return true;
593 }
594
595 /**
596  * When a macro is used we have to handle parameters as well
597  * as special-concatenation via ## or stringification via #
598  *
599  * Note: parenthesis can nest, so FOO((a),b) is valid, but only
600  * this kind of parens. Curly braces or [] don't count towards the
601  * paren-level.
602  */
603 typedef struct {
604     pptoken **tokens;
605 } macroparam;
606
607 static void macroparam_clean(macroparam *self)
608 {
609     size_t i;
610     for (i = 0; i < vec_size(self->tokens); ++i)
611         pptoken_delete(self->tokens[i]);
612     vec_free(self->tokens);
613 }
614
615 /* need to leave the last token up */
616 static bool ftepp_macro_call_params(ftepp_t *ftepp, macroparam **out_params)
617 {
618     macroparam *params = NULL;
619     pptoken    *ptok;
620     macroparam  mp;
621     size_t      parens = 0;
622     size_t      i;
623
624     if (!ftepp_skipallwhite(ftepp))
625         return false;
626     while (ftepp->token != ')') {
627         mp.tokens = NULL;
628         if (!ftepp_skipallwhite(ftepp))
629             return false;
630         while (parens || ftepp->token != ',') {
631             if (ftepp->token == '(')
632                 ++parens;
633             else if (ftepp->token == ')') {
634                 if (!parens)
635                     break;
636                 --parens;
637             }
638             ptok = pptoken_make(ftepp);
639             vec_push(mp.tokens, ptok);
640             if (ftepp_next(ftepp) >= TOKEN_EOF) {
641                 ftepp_error(ftepp, "unexpected end of file in macro call");
642                 goto on_error;
643             }
644         }
645         vec_push(params, mp);
646         mp.tokens = NULL;
647         if (ftepp->token == ')')
648             break;
649         if (ftepp->token != ',') {
650             ftepp_error(ftepp, "expected closing paren or comma in macro call");
651             goto on_error;
652         }
653         if (ftepp_next(ftepp) >= TOKEN_EOF) {
654             ftepp_error(ftepp, "unexpected end of file in macro call");
655             goto on_error;
656         }
657     }
658     *out_params = params;
659     return true;
660
661 on_error:
662     if (mp.tokens)
663         macroparam_clean(&mp);
664     for (i = 0; i < vec_size(params); ++i)
665         macroparam_clean(&params[i]);
666     vec_free(params);
667     return false;
668 }
669
670 static bool macro_params_find(ppmacro *macro, const char *name, size_t *idx)
671 {
672     size_t i;
673     for (i = 0; i < vec_size(macro->params); ++i) {
674         if (!strcmp(macro->params[i], name)) {
675             *idx = i;
676             return true;
677         }
678     }
679     return false;
680 }
681
682 static void ftepp_stringify_token(ftepp_t *ftepp, pptoken *token)
683 {
684     char        chs[2];
685     const char *ch;
686     chs[1] = 0;
687     switch (token->token) {
688         case TOKEN_STRINGCONST:
689             ch = token->value;
690             while (*ch) {
691                 /* in preprocessor mode strings already are string,
692                  * so we don't get actual newline bytes here.
693                  * Still need to escape backslashes and quotes.
694                  */
695                 switch (*ch) {
696                     case '\\': ftepp_out(ftepp, "\\\\", false); break;
697                     case '"':  ftepp_out(ftepp, "\\\"", false); break;
698                     default:
699                         chs[0] = *ch;
700                         ftepp_out(ftepp, chs, false);
701                         break;
702                 }
703                 ++ch;
704             }
705             break;
706         case TOKEN_WHITE:
707             ftepp_out(ftepp, " ", false);
708             break;
709         case TOKEN_EOL:
710             ftepp_out(ftepp, "\\n", false);
711             break;
712         default:
713             ftepp_out(ftepp, token->value, false);
714             break;
715     }
716 }
717
718 static void ftepp_stringify(ftepp_t *ftepp, macroparam *param)
719 {
720     size_t i;
721     ftepp_out(ftepp, "\"", false);
722     for (i = 0; i < vec_size(param->tokens); ++i)
723         ftepp_stringify_token(ftepp, param->tokens[i]);
724     ftepp_out(ftepp, "\"", false);
725 }
726
727 static void ftepp_recursion_header(ftepp_t *ftepp)
728 {
729     ftepp_out(ftepp, "\n#pragma push(line)\n", false);
730 }
731
732 static void ftepp_recursion_footer(ftepp_t *ftepp)
733 {
734     ftepp_out(ftepp, "\n#pragma pop(line)\n", false);
735 }
736
737 static void ftepp_param_out(ftepp_t *ftepp, macroparam *param)
738 {
739     size_t   i;
740     pptoken *out;
741     for (i = 0; i < vec_size(param->tokens); ++i) {
742         out = param->tokens[i];
743         if (out->token == TOKEN_EOL)
744             ftepp_out(ftepp, "\n", false);
745         else
746             ftepp_out(ftepp, out->value, false);
747     }
748 }
749
750 static bool ftepp_preprocess(ftepp_t *ftepp);
751 static bool ftepp_macro_expand(ftepp_t *ftepp, ppmacro *macro, macroparam *params, bool resetline)
752 {
753     char     *buffer       = NULL;
754     char     *old_string   = ftepp->output_string;
755     char     *inner_string;
756     lex_file *old_lexer    = ftepp->lex;
757     size_t    vararg_start = vec_size(macro->params);
758     bool      retval       = true;
759     bool      has_newlines;
760     size_t    varargs;
761
762     size_t    o, pi;
763     lex_file *inlex;
764
765     bool      old_inmacro;
766     bool      strip = false;
767
768     int nextok;
769
770     if (vararg_start < vec_size(params))
771         varargs = vec_size(params) - vararg_start;
772     else
773         varargs = 0;
774
775     /* really ... */
776     if (!vec_size(macro->output))
777         return true;
778
779     ftepp->output_string = NULL;
780     for (o = 0; o < vec_size(macro->output); ++o) {
781         pptoken *out = macro->output[o];
782         switch (out->token) {
783             case TOKEN_VA_ARGS:
784                 if (!macro->variadic) {
785                     ftepp_error(ftepp, "internal preprocessor error: TOKEN_VA_ARGS in non-variadic macro");
786                     vec_free(old_string);
787                     return false;
788                 }
789                 if (!varargs)
790                     break;
791
792                 pi = 0;
793                 ftepp_param_out(ftepp, &params[pi + vararg_start]);
794                 for (++pi; pi < varargs; ++pi) {
795                     ftepp_out(ftepp, ", ", false);
796                     ftepp_param_out(ftepp, &params[pi + vararg_start]);
797                 }
798                 break;
799
800             case TOKEN_VA_ARGS_ARRAY:
801                 if ((size_t)out->constval.i >= varargs) {
802                     ftepp_error(ftepp, "subscript of `[%u]` is out of bounds for `__VA_ARGS__`", out->constval.i);
803                     vec_free(old_string);
804                     return false;
805                 }
806
807                 ftepp_param_out(ftepp, &params[out->constval.i + vararg_start]);
808                 break;
809
810             case TOKEN_VA_COUNT:
811                 util_asprintf(&buffer, "%d", varargs);
812                 ftepp_out(ftepp, buffer, false);
813                 mem_d(buffer);
814                 break;
815
816             case TOKEN_IDENT:
817             case TOKEN_TYPENAME:
818             case TOKEN_KEYWORD:
819                 if (!macro_params_find(macro, out->value, &pi)) {
820                     ftepp_out(ftepp, out->value, false);
821                     break;
822                 } else
823                     ftepp_param_out(ftepp, &params[pi]);
824                 break;
825             case '#':
826                 if (o + 1 < vec_size(macro->output)) {
827                     nextok = macro->output[o+1]->token;
828                     if (nextok == '#') {
829                         /* raw concatenation */
830                         ++o;
831                         strip = true;
832                         break;
833                     }
834                     if ( (nextok == TOKEN_IDENT    ||
835                           nextok == TOKEN_KEYWORD  ||
836                           nextok == TOKEN_TYPENAME) &&
837                         macro_params_find(macro, macro->output[o+1]->value, &pi))
838                     {
839                         ++o;
840
841                         ftepp_stringify(ftepp, &params[pi]);
842                         break;
843                     }
844                 }
845                 ftepp_out(ftepp, "#", false);
846                 break;
847             case TOKEN_EOL:
848                 ftepp_out(ftepp, "\n", false);
849                 break;
850             default:
851                 buffer = out->value;
852                 #define buffer_stripable(X) ((X) == ' ' || (X) == '\t')
853                 if (vec_size(macro->output) > o + 1 && macro->output[o+1]->token == '#' && buffer_stripable(*buffer))
854                     buffer++;
855                 if (strip) {
856                     while (buffer_stripable(*buffer)) buffer++;
857                     strip = false;
858                 }
859                 ftepp_out(ftepp, buffer, false);
860                 break;
861         }
862     }
863     vec_push(ftepp->output_string, 0);
864     /* Now run the preprocessor recursively on this string buffer */
865     /*
866     printf("__________\n%s\n=========\n", ftepp->output_string);
867     */
868     inlex = lex_open_string(ftepp->output_string, vec_size(ftepp->output_string)-1, ftepp->lex->name);
869     if (!inlex) {
870         ftepp_error(ftepp, "internal error: failed to instantiate lexer");
871         retval = false;
872         goto cleanup;
873     }
874
875     inlex->line  = ftepp->lex->line;
876     inlex->sline = ftepp->lex->sline;
877     ftepp->lex   = inlex;
878
879     old_inmacro     = ftepp->in_macro;
880     ftepp->in_macro = true;
881     ftepp->output_string = NULL;
882     if (!ftepp_preprocess(ftepp)) {
883         ftepp->in_macro = old_inmacro;
884         vec_free(ftepp->lex->open_string);
885         vec_free(ftepp->output_string);
886         lex_close(ftepp->lex);
887         retval = false;
888         goto cleanup;
889     }
890     ftepp->in_macro = old_inmacro;
891     vec_free(ftepp->lex->open_string);
892     lex_close(ftepp->lex);
893
894     inner_string = ftepp->output_string;
895     ftepp->output_string = old_string;
896
897     has_newlines = (strchr(inner_string, '\n') != NULL);
898
899     if (has_newlines && !old_inmacro)
900         ftepp_recursion_header(ftepp);
901
902     vec_append(ftepp->output_string, vec_size(inner_string), inner_string);
903     vec_free(inner_string);
904
905     if (has_newlines && !old_inmacro)
906         ftepp_recursion_footer(ftepp);
907
908     if (resetline && !ftepp->in_macro) {
909         char lineno[128];
910         util_snprintf(lineno, 128, "\n#pragma line(%lu)\n", (unsigned long)(old_lexer->sline));
911         ftepp_out(ftepp, lineno, false);
912     }
913
914     old_string = ftepp->output_string;
915 cleanup:
916     ftepp->lex           = old_lexer;
917     ftepp->output_string = old_string;
918     return retval;
919 }
920
921 static bool ftepp_macro_call(ftepp_t *ftepp, ppmacro *macro)
922 {
923     size_t     o;
924     macroparam *params = NULL;
925     bool        retval = true;
926     size_t      paramline;
927
928     if (!macro->has_params) {
929         if (!ftepp_macro_expand(ftepp, macro, NULL, false))
930             return false;
931         ftepp_next(ftepp);
932         return true;
933     }
934     ftepp_next(ftepp);
935
936     if (!ftepp_skipallwhite(ftepp))
937         return false;
938
939     if (ftepp->token != '(') {
940         ftepp_error(ftepp, "expected macro parameters in parenthesis");
941         return false;
942     }
943
944     ftepp_next(ftepp);
945     paramline = ftepp->lex->sline;
946     if (!ftepp_macro_call_params(ftepp, &params))
947         return false;
948
949     if ( vec_size(params) < vec_size(macro->params) ||
950         (vec_size(params) > vec_size(macro->params) && !macro->variadic) )
951     {
952         ftepp_error(ftepp, "macro %s expects%s %u paramteters, %u provided", macro->name,
953                     (macro->variadic ? " at least" : ""),
954                     (unsigned int)vec_size(macro->params),
955                     (unsigned int)vec_size(params));
956         retval = false;
957         goto cleanup;
958     }
959
960     if (!ftepp_macro_expand(ftepp, macro, params, (paramline != ftepp->lex->sline)))
961         retval = false;
962     ftepp_next(ftepp);
963
964 cleanup:
965     for (o = 0; o < vec_size(params); ++o)
966         macroparam_clean(&params[o]);
967     vec_free(params);
968     return retval;
969 }
970
971 /**
972  * #if - the FTEQCC way:
973  *    defined(FOO) => true if FOO was #defined regardless of parameters or contents
974  *    <numbers>    => True if the number is not 0
975  *    !<factor>    => True if the factor yields false
976  *    !!<factor>   => ERROR on 2 or more unary nots
977  *    <macro>      => becomes the macro's FIRST token regardless of parameters
978  *    <e> && <e>   => True if both expressions are true
979  *    <e> || <e>   => True if either expression is true
980  *    <string>     => False
981  *    <ident>      => False (remember for macros the <macro> rule applies instead)
982  * Unary + and - are weird and wrong in fteqcc so we don't allow them
983  * parenthesis in expressions are allowed
984  * parameter lists on macros are errors
985  * No mathematical calculations are executed
986  */
987 static bool ftepp_if_expr(ftepp_t *ftepp, bool *out, double *value_out);
988 static bool ftepp_if_op(ftepp_t *ftepp)
989 {
990     ftepp->lex->flags.noops = false;
991     ftepp_next(ftepp);
992     if (!ftepp_skipspace(ftepp))
993         return false;
994     ftepp->lex->flags.noops = true;
995     return true;
996 }
997 static bool ftepp_if_value(ftepp_t *ftepp, bool *out, double *value_out)
998 {
999     ppmacro *macro;
1000     bool     wasnot = false;
1001     bool     wasneg = false;
1002
1003     if (!ftepp_skipspace(ftepp))
1004         return false;
1005
1006     while (ftepp->token == '!') {
1007         wasnot = true;
1008         ftepp_next(ftepp);
1009         if (!ftepp_skipspace(ftepp))
1010             return false;
1011     }
1012
1013     if (ftepp->token == TOKEN_OPERATOR && !strcmp(ftepp_tokval(ftepp), "-"))
1014     {
1015         wasneg = true;
1016         ftepp_next(ftepp);
1017         if (!ftepp_skipspace(ftepp))
1018             return false;
1019     }
1020
1021     switch (ftepp->token) {
1022         case TOKEN_IDENT:
1023         case TOKEN_TYPENAME:
1024         case TOKEN_KEYWORD:
1025             if (!strcmp(ftepp_tokval(ftepp), "defined")) {
1026                 ftepp_next(ftepp);
1027                 if (!ftepp_skipspace(ftepp))
1028                     return false;
1029                 if (ftepp->token != '(') {
1030                     ftepp_error(ftepp, "`defined` keyword in #if requires a macro name in parenthesis");
1031                     return false;
1032                 }
1033                 ftepp_next(ftepp);
1034                 if (!ftepp_skipspace(ftepp))
1035                     return false;
1036                 if (ftepp->token != TOKEN_IDENT &&
1037                     ftepp->token != TOKEN_TYPENAME &&
1038                     ftepp->token != TOKEN_KEYWORD)
1039                 {
1040                     ftepp_error(ftepp, "defined() used on an unexpected token type");
1041                     return false;
1042                 }
1043                 macro = ftepp_macro_find(ftepp, ftepp_tokval(ftepp));
1044                 *out = !!macro;
1045                 ftepp_next(ftepp);
1046                 if (!ftepp_skipspace(ftepp))
1047                     return false;
1048                 if (ftepp->token != ')') {
1049                     ftepp_error(ftepp, "expected closing paren");
1050                     return false;
1051                 }
1052                 break;
1053             }
1054
1055             macro = ftepp_macro_find(ftepp, ftepp_tokval(ftepp));
1056             if (!macro || !vec_size(macro->output)) {
1057                 *out = false;
1058                 *value_out = 0;
1059             } else {
1060                 /* This does not expand recursively! */
1061                 switch (macro->output[0]->token) {
1062                     case TOKEN_INTCONST:
1063                         *value_out = macro->output[0]->constval.i;
1064                         *out = !!(macro->output[0]->constval.i);
1065                         break;
1066                     case TOKEN_FLOATCONST:
1067                         *value_out = macro->output[0]->constval.f;
1068                         *out = !!(macro->output[0]->constval.f);
1069                         break;
1070                     default:
1071                         *out = false;
1072                         break;
1073                 }
1074             }
1075             break;
1076         case TOKEN_STRINGCONST:
1077             *value_out = 0;
1078             *out = false;
1079             break;
1080         case TOKEN_INTCONST:
1081             *value_out = ftepp->lex->tok.constval.i;
1082             *out = !!(ftepp->lex->tok.constval.i);
1083             break;
1084         case TOKEN_FLOATCONST:
1085             *value_out = ftepp->lex->tok.constval.f;
1086             *out = !!(ftepp->lex->tok.constval.f);
1087             break;
1088
1089         case '(':
1090             ftepp_next(ftepp);
1091             if (!ftepp_if_expr(ftepp, out, value_out))
1092                 return false;
1093             if (ftepp->token != ')') {
1094                 ftepp_error(ftepp, "expected closing paren in #if expression");
1095                 return false;
1096             }
1097             break;
1098
1099         default:
1100             ftepp_error(ftepp, "junk in #if: `%s` ...", ftepp_tokval(ftepp));
1101             if (OPTS_OPTION_BOOL(OPTION_DEBUG))
1102                 ftepp_error(ftepp, "internal: token %i\n", ftepp->token);
1103             return false;
1104     }
1105     if (wasneg)
1106         *value_out = -*value_out;
1107     if (wasnot) {
1108         *out = !*out;
1109         *value_out = (*out ? 1 : 0);
1110     }
1111     return true;
1112 }
1113
1114 /*
1115 static bool ftepp_if_nextvalue(ftepp_t *ftepp, bool *out, double *value_out)
1116 {
1117     if (!ftepp_next(ftepp))
1118         return false;
1119     return ftepp_if_value(ftepp, out, value_out);
1120 }
1121 */
1122
1123 static bool ftepp_if_expr(ftepp_t *ftepp, bool *out, double *value_out)
1124 {
1125     if (!ftepp_if_value(ftepp, out, value_out))
1126         return false;
1127
1128     if (!ftepp_if_op(ftepp))
1129         return false;
1130
1131     if (ftepp->token == ')' || ftepp->token != TOKEN_OPERATOR)
1132         return true;
1133
1134     /* FTEQCC is all right-associative and no precedence here */
1135     if (!strcmp(ftepp_tokval(ftepp), "&&") ||
1136         !strcmp(ftepp_tokval(ftepp), "||"))
1137     {
1138         bool next = false;
1139         char opc  = ftepp_tokval(ftepp)[0];
1140         double nextvalue;
1141
1142         (void)nextvalue;
1143         if (!ftepp_next(ftepp))
1144             return false;
1145         if (!ftepp_if_expr(ftepp, &next, &nextvalue))
1146             return false;
1147
1148         if (opc == '&')
1149             *out = *out && next;
1150         else
1151             *out = *out || next;
1152
1153         *value_out = (*out ? 1 : 0);
1154         return true;
1155     }
1156     else if (!strcmp(ftepp_tokval(ftepp), "==") ||
1157              !strcmp(ftepp_tokval(ftepp), "!=") ||
1158              !strcmp(ftepp_tokval(ftepp), ">=") ||
1159              !strcmp(ftepp_tokval(ftepp), "<=") ||
1160              !strcmp(ftepp_tokval(ftepp), ">") ||
1161              !strcmp(ftepp_tokval(ftepp), "<"))
1162     {
1163         bool next = false;
1164         const char opc0 = ftepp_tokval(ftepp)[0];
1165         const char opc1 = ftepp_tokval(ftepp)[1];
1166         double other;
1167
1168         if (!ftepp_next(ftepp))
1169             return false;
1170         if (!ftepp_if_expr(ftepp, &next, &other))
1171             return false;
1172
1173         if (opc0 == '=')
1174             *out = (*value_out == other);
1175         else if (opc0 == '!')
1176             *out = (*value_out != other);
1177         else if (opc0 == '>') {
1178             if (opc1 == '=') *out = (*value_out >= other);
1179             else             *out = (*value_out > other);
1180         }
1181         else if (opc0 == '<') {
1182             if (opc1 == '=') *out = (*value_out <= other);
1183             else             *out = (*value_out < other);
1184         }
1185         *value_out = (*out ? 1 : 0);
1186
1187         return true;
1188     }
1189     else {
1190         ftepp_error(ftepp, "junk after #if");
1191         return false;
1192     }
1193 }
1194
1195 static bool ftepp_if(ftepp_t *ftepp, ppcondition *cond)
1196 {
1197     bool result = false;
1198     double dummy = 0;
1199
1200     memset(cond, 0, sizeof(*cond));
1201     (void)ftepp_next(ftepp);
1202
1203     if (!ftepp_skipspace(ftepp))
1204         return false;
1205     if (ftepp->token == TOKEN_EOL) {
1206         ftepp_error(ftepp, "expected expression for #if-directive");
1207         return false;
1208     }
1209
1210     if (!ftepp_if_expr(ftepp, &result, &dummy))
1211         return false;
1212
1213     cond->on = result;
1214     return true;
1215 }
1216
1217 /**
1218  * ifdef is rather simple
1219  */
1220 static bool ftepp_ifdef(ftepp_t *ftepp, ppcondition *cond)
1221 {
1222     ppmacro *macro;
1223     memset(cond, 0, sizeof(*cond));
1224     (void)ftepp_next(ftepp);
1225     if (!ftepp_skipspace(ftepp))
1226         return false;
1227
1228     switch (ftepp->token) {
1229         case TOKEN_IDENT:
1230         case TOKEN_TYPENAME:
1231         case TOKEN_KEYWORD:
1232             macro = ftepp_macro_find(ftepp, ftepp_tokval(ftepp));
1233             break;
1234         default:
1235             ftepp_error(ftepp, "expected macro name");
1236             return false;
1237     }
1238
1239     (void)ftepp_next(ftepp);
1240     if (!ftepp_skipspace(ftepp))
1241         return false;
1242     /* relaxing this condition
1243     if (ftepp->token != TOKEN_EOL && ftepp->token != TOKEN_EOF) {
1244         ftepp_error(ftepp, "stray tokens after #ifdef");
1245         return false;
1246     }
1247     */
1248     cond->on = !!macro;
1249     return true;
1250 }
1251
1252 /**
1253  * undef is also simple
1254  */
1255 static bool ftepp_undef(ftepp_t *ftepp)
1256 {
1257     (void)ftepp_next(ftepp);
1258     if (!ftepp_skipspace(ftepp))
1259         return false;
1260
1261     if (ftepp->output_on) {
1262         switch (ftepp->token) {
1263             case TOKEN_IDENT:
1264             case TOKEN_TYPENAME:
1265             case TOKEN_KEYWORD:
1266                 ftepp_macro_delete(ftepp, ftepp_tokval(ftepp));
1267                 break;
1268             default:
1269                 ftepp_error(ftepp, "expected macro name");
1270                 return false;
1271         }
1272     }
1273
1274     (void)ftepp_next(ftepp);
1275     if (!ftepp_skipspace(ftepp))
1276         return false;
1277     /* relaxing this condition
1278     if (ftepp->token != TOKEN_EOL && ftepp->token != TOKEN_EOF) {
1279         ftepp_error(ftepp, "stray tokens after #ifdef");
1280         return false;
1281     }
1282     */
1283     return true;
1284 }
1285
1286 /* Special unescape-string function which skips a leading quote
1287  * and stops at a quote, not just at \0
1288  */
1289 static void unescape(const char *str, char *out) {
1290     ++str;
1291     while (*str && *str != '"') {
1292         if (*str == '\\') {
1293             ++str;
1294             switch (*str) {
1295                 case '\\': *out++ = *str; break;
1296                 case '"':  *out++ = *str; break;
1297                 case 'a':  *out++ = '\a'; break;
1298                 case 'b':  *out++ = '\b'; break;
1299                 case 'r':  *out++ = '\r'; break;
1300                 case 'n':  *out++ = '\n'; break;
1301                 case 't':  *out++ = '\t'; break;
1302                 case 'f':  *out++ = '\f'; break;
1303                 case 'v':  *out++ = '\v'; break;
1304                 default:
1305                     *out++ = '\\';
1306                     *out++ = *str;
1307                     break;
1308             }
1309             ++str;
1310             continue;
1311         }
1312
1313         *out++ = *str++;
1314     }
1315     *out = 0;
1316 }
1317
1318 static char *ftepp_include_find_path(const char *file, const char *pathfile)
1319 {
1320     fs_file_t  *fp;
1321     char       *filename = NULL;
1322     const char *last_slash;
1323     size_t      len;
1324
1325     if (!pathfile)
1326         return NULL;
1327
1328     last_slash = strrchr(pathfile, '/');
1329
1330     if (last_slash) {
1331         len = last_slash - pathfile;
1332         memcpy(vec_add(filename, len), pathfile, len);
1333         vec_push(filename, '/');
1334     }
1335
1336     len = strlen(file);
1337     memcpy(vec_add(filename, len+1), file, len);
1338     vec_last(filename) = 0;
1339
1340     fp = fs_file_open(filename, "rb");
1341     if (fp) {
1342         fs_file_close(fp);
1343         return filename;
1344     }
1345     vec_free(filename);
1346     return NULL;
1347 }
1348
1349 static char *ftepp_include_find(ftepp_t *ftepp, const char *file)
1350 {
1351     char *filename = NULL;
1352
1353     filename = ftepp_include_find_path(file, ftepp->includename);
1354     if (!filename)
1355         filename = ftepp_include_find_path(file, ftepp->itemname);
1356     return filename;
1357 }
1358
1359 static bool ftepp_directive_warning(ftepp_t *ftepp) {
1360     char *message = NULL;
1361
1362     if (!ftepp_skipspace(ftepp))
1363         return false;
1364
1365     /* handle the odd non string constant case so it works like C */
1366     if (ftepp->token != TOKEN_STRINGCONST) {
1367         bool  store   = false;
1368         vec_append(message, 8, "#warning");
1369         ftepp_next(ftepp);
1370         while (ftepp->token != TOKEN_EOL) {
1371             vec_append(message, strlen(ftepp_tokval(ftepp)), ftepp_tokval(ftepp));
1372             ftepp_next(ftepp);
1373         }
1374         vec_push(message, '\0');
1375         if (ftepp->output_on)
1376             store = ftepp_warn(ftepp, WARN_CPP, message);
1377         else
1378             store = false;
1379         vec_free(message);
1380         return store;
1381     }
1382
1383     if (!ftepp->output_on)
1384         return false;
1385
1386     unescape  (ftepp_tokval(ftepp), ftepp_tokval(ftepp));
1387     return ftepp_warn(ftepp, WARN_CPP, "#warning %s", ftepp_tokval(ftepp));
1388 }
1389
1390 static void ftepp_directive_error(ftepp_t *ftepp) {
1391     char *message = NULL;
1392
1393     if (!ftepp_skipspace(ftepp))
1394         return;
1395
1396     /* handle the odd non string constant case so it works like C */
1397     if (ftepp->token != TOKEN_STRINGCONST) {
1398         vec_append(message, 6, "#error");
1399         ftepp_next(ftepp);
1400         while (ftepp->token != TOKEN_EOL) {
1401             vec_append(message, strlen(ftepp_tokval(ftepp)), ftepp_tokval(ftepp));
1402             ftepp_next(ftepp);
1403         }
1404         vec_push(message, '\0');
1405         if (ftepp->output_on)
1406             ftepp_error(ftepp, message);
1407         vec_free(message);
1408         return;
1409     }
1410
1411     if (!ftepp->output_on)
1412         return;
1413
1414     unescape  (ftepp_tokval(ftepp), ftepp_tokval(ftepp));
1415     ftepp_error(ftepp, "#error %s", ftepp_tokval(ftepp));
1416 }
1417
1418 static void ftepp_directive_message(ftepp_t *ftepp) {
1419     char *message = NULL;
1420
1421     if (!ftepp_skipspace(ftepp))
1422         return;
1423
1424     /* handle the odd non string constant case so it works like C */
1425     if (ftepp->token != TOKEN_STRINGCONST) {
1426         vec_append(message, 8, "#message");
1427         ftepp_next(ftepp);
1428         while (ftepp->token != TOKEN_EOL) {
1429             vec_append(message, strlen(ftepp_tokval(ftepp)), ftepp_tokval(ftepp));
1430             ftepp_next(ftepp);
1431         }
1432         vec_push(message, '\0');
1433         if (ftepp->output_on)
1434             con_cprintmsg(ftepp->lex->tok.ctx, LVL_MSG, "message", message);
1435         vec_free(message);
1436         return;
1437     }
1438
1439     if (!ftepp->output_on)
1440         return;
1441
1442     unescape     (ftepp_tokval(ftepp), ftepp_tokval(ftepp));
1443     con_cprintmsg(ftepp->lex->tok.ctx, LVL_MSG, "message",  ftepp_tokval(ftepp));
1444 }
1445
1446 /**
1447  * Include a file.
1448  * FIXME: do we need/want a -I option?
1449  * FIXME: what about when dealing with files in subdirectories coming from a progs.src?
1450  */
1451 static bool ftepp_include(ftepp_t *ftepp)
1452 {
1453     lex_file *old_lexer = ftepp->lex;
1454     lex_file *inlex;
1455     lex_ctx_t ctx;
1456     char     lineno[128];
1457     char     *filename;
1458     char     *old_includename;
1459
1460     (void)ftepp_next(ftepp);
1461     if (!ftepp_skipspace(ftepp))
1462         return false;
1463
1464     if (ftepp->token != TOKEN_STRINGCONST) {
1465         ftepp_error(ftepp, "expected filename to include");
1466         return false;
1467     }
1468
1469     if (!ftepp->output_on) {
1470         ftepp_next(ftepp);
1471         return true;
1472     }
1473
1474     ctx = ftepp_ctx(ftepp);
1475
1476     unescape(ftepp_tokval(ftepp), ftepp_tokval(ftepp));
1477
1478     ftepp_out(ftepp, "\n#pragma file(", false);
1479     ftepp_out(ftepp, ftepp_tokval(ftepp), false);
1480     ftepp_out(ftepp, ")\n#pragma line(1)\n", false);
1481
1482     filename = ftepp_include_find(ftepp, ftepp_tokval(ftepp));
1483     if (!filename) {
1484         ftepp_error(ftepp, "failed to open include file `%s`", ftepp_tokval(ftepp));
1485         return false;
1486     }
1487     inlex = lex_open(filename);
1488     if (!inlex) {
1489         ftepp_error(ftepp, "open failed on include file `%s`", filename);
1490         vec_free(filename);
1491         return false;
1492     }
1493     ftepp->lex = inlex;
1494     old_includename = ftepp->includename;
1495     ftepp->includename = filename;
1496     if (!ftepp_preprocess(ftepp)) {
1497         vec_free(ftepp->includename);
1498         ftepp->includename = old_includename;
1499         lex_close(ftepp->lex);
1500         ftepp->lex = old_lexer;
1501         return false;
1502     }
1503     vec_free(ftepp->includename);
1504     ftepp->includename = old_includename;
1505     lex_close(ftepp->lex);
1506     ftepp->lex = old_lexer;
1507
1508     ftepp_out(ftepp, "\n#pragma file(", false);
1509     ftepp_out(ftepp, ctx.file, false);
1510     util_snprintf(lineno, sizeof(lineno), ")\n#pragma line(%lu)\n", (unsigned long)(ctx.line+1));
1511     ftepp_out(ftepp, lineno, false);
1512
1513     /* skip the line */
1514     (void)ftepp_next(ftepp);
1515     if (!ftepp_skipspace(ftepp))
1516         return false;
1517     if (ftepp->token != TOKEN_EOL) {
1518         ftepp_error(ftepp, "stray tokens after #include");
1519         return false;
1520     }
1521     (void)ftepp_next(ftepp);
1522
1523     return true;
1524 }
1525
1526 /* Basic structure handlers */
1527 static bool ftepp_else_allowed(ftepp_t *ftepp)
1528 {
1529     if (!vec_size(ftepp->conditions)) {
1530         ftepp_error(ftepp, "#else without #if");
1531         return false;
1532     }
1533     if (vec_last(ftepp->conditions).had_else) {
1534         ftepp_error(ftepp, "multiple #else for a single #if");
1535         return false;
1536     }
1537     return true;
1538 }
1539
1540 static GMQCC_INLINE void ftepp_inmacro(ftepp_t *ftepp, const char *hash) {
1541     if (ftepp->in_macro)
1542         (void)!ftepp_warn(ftepp, WARN_DIRECTIVE_INMACRO, "`#%s` directive in macro", hash);
1543 }
1544
1545 static bool ftepp_hash(ftepp_t *ftepp)
1546 {
1547     ppcondition cond;
1548     ppcondition *pc;
1549
1550     lex_ctx_t ctx = ftepp_ctx(ftepp);
1551
1552     if (!ftepp_skipspace(ftepp))
1553         return false;
1554
1555     switch (ftepp->token) {
1556         case TOKEN_KEYWORD:
1557         case TOKEN_IDENT:
1558         case TOKEN_TYPENAME:
1559             if (!strcmp(ftepp_tokval(ftepp), "define")) {
1560                 ftepp_inmacro(ftepp, "define");
1561                 return ftepp_define(ftepp);
1562             }
1563             else if (!strcmp(ftepp_tokval(ftepp), "undef")) {
1564                 ftepp_inmacro(ftepp, "undef");
1565                 return ftepp_undef(ftepp);
1566             }
1567             else if (!strcmp(ftepp_tokval(ftepp), "ifdef")) {
1568                 ftepp_inmacro(ftepp, "ifdef");
1569                 if (!ftepp_ifdef(ftepp, &cond))
1570                     return false;
1571                 cond.was_on = cond.on;
1572                 vec_push(ftepp->conditions, cond);
1573                 ftepp->output_on = ftepp->output_on && cond.on;
1574                 break;
1575             }
1576             else if (!strcmp(ftepp_tokval(ftepp), "ifndef")) {
1577                 ftepp_inmacro(ftepp, "ifndef");
1578                 if (!ftepp_ifdef(ftepp, &cond))
1579                     return false;
1580                 cond.on = !cond.on;
1581                 cond.was_on = cond.on;
1582                 vec_push(ftepp->conditions, cond);
1583                 ftepp->output_on = ftepp->output_on && cond.on;
1584                 break;
1585             }
1586             else if (!strcmp(ftepp_tokval(ftepp), "elifdef")) {
1587                 ftepp_inmacro(ftepp, "elifdef");
1588                 if (!ftepp_else_allowed(ftepp))
1589                     return false;
1590                 if (!ftepp_ifdef(ftepp, &cond))
1591                     return false;
1592                 pc = &vec_last(ftepp->conditions);
1593                 pc->on     = !pc->was_on && cond.on;
1594                 pc->was_on = pc->was_on || pc->on;
1595                 ftepp_update_output_condition(ftepp);
1596                 break;
1597             }
1598             else if (!strcmp(ftepp_tokval(ftepp), "elifndef")) {
1599                 ftepp_inmacro(ftepp, "elifndef");
1600                 if (!ftepp_else_allowed(ftepp))
1601                     return false;
1602                 if (!ftepp_ifdef(ftepp, &cond))
1603                     return false;
1604                 cond.on = !cond.on;
1605                 pc = &vec_last(ftepp->conditions);
1606                 pc->on     = !pc->was_on && cond.on;
1607                 pc->was_on = pc->was_on || pc->on;
1608                 ftepp_update_output_condition(ftepp);
1609                 break;
1610             }
1611             else if (!strcmp(ftepp_tokval(ftepp), "elif")) {
1612                 ftepp_inmacro(ftepp, "elif");
1613                 if (!ftepp_else_allowed(ftepp))
1614                     return false;
1615                 if (!ftepp_if(ftepp, &cond))
1616                     return false;
1617                 pc = &vec_last(ftepp->conditions);
1618                 pc->on     = !pc->was_on && cond.on;
1619                 pc->was_on = pc->was_on  || pc->on;
1620                 ftepp_update_output_condition(ftepp);
1621                 break;
1622             }
1623             else if (!strcmp(ftepp_tokval(ftepp), "if")) {
1624                 ftepp_inmacro(ftepp, "if");
1625                 if (!ftepp_if(ftepp, &cond))
1626                     return false;
1627                 cond.was_on = cond.on;
1628                 vec_push(ftepp->conditions, cond);
1629                 ftepp->output_on = ftepp->output_on && cond.on;
1630                 break;
1631             }
1632             else if (!strcmp(ftepp_tokval(ftepp), "else")) {
1633                 ftepp_inmacro(ftepp, "else");
1634                 if (!ftepp_else_allowed(ftepp))
1635                     return false;
1636                 pc = &vec_last(ftepp->conditions);
1637                 pc->on = !pc->was_on;
1638                 pc->had_else = true;
1639                 ftepp_next(ftepp);
1640                 ftepp_update_output_condition(ftepp);
1641                 break;
1642             }
1643             else if (!strcmp(ftepp_tokval(ftepp), "endif")) {
1644                 ftepp_inmacro(ftepp, "endif");
1645                 if (!vec_size(ftepp->conditions)) {
1646                     ftepp_error(ftepp, "#endif without #if");
1647                     return false;
1648                 }
1649                 vec_pop(ftepp->conditions);
1650                 ftepp_next(ftepp);
1651                 ftepp_update_output_condition(ftepp);
1652                 break;
1653             }
1654             else if (!strcmp(ftepp_tokval(ftepp), "include")) {
1655                 ftepp_inmacro(ftepp, "include");
1656                 return ftepp_include(ftepp);
1657             }
1658             else if (!strcmp(ftepp_tokval(ftepp), "pragma")) {
1659                 ftepp_out(ftepp, "#", false);
1660                 break;
1661             }
1662             else if (!strcmp(ftepp_tokval(ftepp), "warning")) {
1663                 ftepp_directive_warning(ftepp);
1664                 break;
1665             }
1666             else if (!strcmp(ftepp_tokval(ftepp), "error")) {
1667                 ftepp_directive_error(ftepp);
1668                 break;
1669             }
1670             else if (!strcmp(ftepp_tokval(ftepp), "message")) {
1671                 ftepp_directive_message(ftepp);
1672                 break;
1673             }
1674             else {
1675                 if (ftepp->output_on) {
1676                     ftepp_error(ftepp, "unrecognized preprocessor directive: `%s`", ftepp_tokval(ftepp));
1677                     return false;
1678                 } else {
1679                     ftepp_next(ftepp);
1680                     break;
1681                 }
1682             }
1683             /* break; never reached */
1684         default:
1685             ftepp_error(ftepp, "unexpected preprocessor token: `%s`", ftepp_tokval(ftepp));
1686             return false;
1687         case TOKEN_EOL:
1688             ftepp_errorat(ftepp, ctx, "empty preprocessor directive");
1689             return false;
1690         case TOKEN_EOF:
1691             ftepp_error(ftepp, "missing newline at end of file", ftepp_tokval(ftepp));
1692             return false;
1693
1694         /* Builtins! Don't forget the builtins! */
1695         case TOKEN_INTCONST:
1696         case TOKEN_FLOATCONST:
1697             ftepp_out(ftepp, "#", false);
1698             return true;
1699     }
1700     if (!ftepp_skipspace(ftepp))
1701         return false;
1702     return true;
1703 }
1704
1705 static bool ftepp_preprocess(ftepp_t *ftepp)
1706 {
1707     ppmacro *macro;
1708     bool     newline = true;
1709
1710     /* predef stuff */
1711     char    *expand  = NULL;
1712
1713     ftepp->lex->flags.preprocessing = true;
1714     ftepp->lex->flags.mergelines    = false;
1715     ftepp->lex->flags.noops         = true;
1716
1717     ftepp_next(ftepp);
1718     do
1719     {
1720         if (ftepp->token >= TOKEN_EOF)
1721             break;
1722 #if 0
1723         newline = true;
1724 #endif
1725
1726         switch (ftepp->token) {
1727             case TOKEN_KEYWORD:
1728             case TOKEN_IDENT:
1729             case TOKEN_TYPENAME:
1730                 /* is it a predef? */
1731                 if (OPTS_FLAG(FTEPP_PREDEFS)) {
1732                     char *(*predef)(ftepp_t*) = ftepp_predef(ftepp_tokval(ftepp));
1733                     if (predef) {
1734                         expand = predef(ftepp);
1735                         ftepp_out (ftepp, expand, false);
1736                         ftepp_next(ftepp);
1737
1738                         mem_d(expand);
1739                         break;
1740                     }
1741                 }
1742
1743                 if (ftepp->output_on)
1744                     macro = ftepp_macro_find(ftepp, ftepp_tokval(ftepp));
1745                 else
1746                     macro = NULL;
1747
1748                 if (!macro) {
1749                     ftepp_out(ftepp, ftepp_tokval(ftepp), false);
1750                     ftepp_next(ftepp);
1751                     break;
1752                 }
1753                 if (!ftepp_macro_call(ftepp, macro))
1754                     ftepp->token = TOKEN_ERROR;
1755                 break;
1756             case '#':
1757                 if (!newline) {
1758                     ftepp_out(ftepp, ftepp_tokval(ftepp), false);
1759                     ftepp_next(ftepp);
1760                     break;
1761                 }
1762                 ftepp->lex->flags.mergelines = true;
1763                 if (ftepp_next(ftepp) >= TOKEN_EOF) {
1764                     ftepp_error(ftepp, "error in preprocessor directive");
1765                     ftepp->token = TOKEN_ERROR;
1766                     break;
1767                 }
1768                 if (!ftepp_hash(ftepp))
1769                     ftepp->token = TOKEN_ERROR;
1770                 ftepp->lex->flags.mergelines = false;
1771                 break;
1772             case TOKEN_EOL:
1773                 newline = true;
1774                 ftepp_out(ftepp, "\n", true);
1775                 ftepp_next(ftepp);
1776                 break;
1777             case TOKEN_WHITE:
1778                 /* same as default but don't set newline=false */
1779                 ftepp_out(ftepp, ftepp_tokval(ftepp), true);
1780                 ftepp_next(ftepp);
1781                 break;
1782             default:
1783                 newline = false;
1784                 ftepp_out(ftepp, ftepp_tokval(ftepp), false);
1785                 ftepp_next(ftepp);
1786                 break;
1787         }
1788     } while (!ftepp->errors && ftepp->token < TOKEN_EOF);
1789
1790     /* force a 0 at the end but don't count it as added to the output */
1791     vec_push(ftepp->output_string, 0);
1792     vec_shrinkby(ftepp->output_string, 1);
1793
1794     return (ftepp->token == TOKEN_EOF);
1795 }
1796
1797 /* Like in parser.c - files keep the previous state so we have one global
1798  * preprocessor. Except here we will want to warn about dangling #ifs.
1799  */
1800 static bool ftepp_preprocess_done(ftepp_t *ftepp)
1801 {
1802     bool retval = true;
1803     if (vec_size(ftepp->conditions)) {
1804         if (ftepp_warn(ftepp, WARN_MULTIFILE_IF, "#if spanning multiple files, is this intended?"))
1805             retval = false;
1806     }
1807     lex_close(ftepp->lex);
1808     ftepp->lex = NULL;
1809     if (ftepp->itemname) {
1810         mem_d(ftepp->itemname);
1811         ftepp->itemname = NULL;
1812     }
1813     return retval;
1814 }
1815
1816 bool ftepp_preprocess_file(ftepp_t *ftepp, const char *filename)
1817 {
1818     ftepp->lex = lex_open(filename);
1819     ftepp->itemname = util_strdup(filename);
1820     if (!ftepp->lex) {
1821         con_out("failed to open file \"%s\"\n", filename);
1822         return false;
1823     }
1824     if (!ftepp_preprocess(ftepp))
1825         return false;
1826     return ftepp_preprocess_done(ftepp);
1827 }
1828
1829 bool ftepp_preprocess_string(ftepp_t *ftepp, const char *name, const char *str)
1830 {
1831     ftepp->lex = lex_open_string(str, strlen(str), name);
1832     ftepp->itemname = util_strdup(name);
1833     if (!ftepp->lex) {
1834         con_out("failed to create lexer for string \"%s\"\n", name);
1835         return false;
1836     }
1837     if (!ftepp_preprocess(ftepp))
1838         return false;
1839     return ftepp_preprocess_done(ftepp);
1840 }
1841
1842
1843 void ftepp_add_macro(ftepp_t *ftepp, const char *name, const char *value) {
1844     char *create = NULL;
1845
1846     /* use saner path for empty macros */
1847     if (!value) {
1848         ftepp_add_define(ftepp, "__builtin__", name);
1849         return;
1850     }
1851
1852     vec_append(create, 8,           "#define ");
1853     vec_append(create, strlen(name), name);
1854     vec_push  (create, ' ');
1855     vec_append(create, strlen(value), value);
1856     vec_push  (create, 0);
1857
1858     ftepp_preprocess_string(ftepp, "__builtin__", create);
1859     vec_free  (create);
1860 }
1861
1862 ftepp_t *ftepp_create()
1863 {
1864     ftepp_t *ftepp;
1865     char minor[32];
1866     char major[32];
1867     size_t i;
1868
1869     ftepp = ftepp_new();
1870     if (!ftepp)
1871         return NULL;
1872
1873     memset(minor, 0, sizeof(minor));
1874     memset(major, 0, sizeof(major));
1875
1876     /* set the right macro based on the selected standard */
1877     ftepp_add_define(ftepp, NULL, "GMQCC");
1878     if (OPTS_OPTION_U32(OPTION_STANDARD) == COMPILER_FTEQCC) {
1879         ftepp_add_define(ftepp, NULL, "__STD_FTEQCC__");
1880         /* 1.00 */
1881         major[0] = '"';
1882         major[1] = '1';
1883         major[2] = '"';
1884
1885         minor[0] = '"';
1886         minor[1] = '0';
1887         minor[2] = '"';
1888     } else if (OPTS_OPTION_U32(OPTION_STANDARD) == COMPILER_GMQCC) {
1889         ftepp_add_define(ftepp, NULL, "__STD_GMQCC__");
1890         util_snprintf(major, 32, "\"%d\"", GMQCC_VERSION_MAJOR);
1891         util_snprintf(minor, 32, "\"%d\"", GMQCC_VERSION_MINOR);
1892     } else if (OPTS_OPTION_U32(OPTION_STANDARD) == COMPILER_QCCX) {
1893         ftepp_add_define(ftepp, NULL, "__STD_QCCX__");
1894         util_snprintf(major, 32, "\"%d\"", GMQCC_VERSION_MAJOR);
1895         util_snprintf(minor, 32, "\"%d\"", GMQCC_VERSION_MINOR);
1896     } else if (OPTS_OPTION_U32(OPTION_STANDARD) == COMPILER_QCC) {
1897         ftepp_add_define(ftepp, NULL, "__STD_QCC__");
1898         /* 1.0 */
1899         major[0] = '"';
1900         major[1] = '1';
1901         major[2] = '"';
1902
1903         minor[0] = '"';
1904         minor[1] = '0';
1905         minor[2] = '"';
1906     }
1907
1908     ftepp_add_macro(ftepp, "__STD_VERSION_MINOR__", minor);
1909     ftepp_add_macro(ftepp, "__STD_VERSION_MAJOR__", major);
1910
1911     /*
1912      * We're going to just make __NULL__ nil, which works for 60% of the
1913      * cases of __NULL_ for fteqcc.
1914      */
1915     ftepp_add_macro(ftepp, "__NULL__", "nil");
1916
1917     /* add all the math constants if they can be */
1918     if (OPTS_FLAG(FTEPP_MATHDEFS)) {
1919         for (i = 0; i < GMQCC_ARRAY_COUNT(ftepp_math_constants); i++)
1920             if (!ftepp_macro_find(ftepp, ftepp_math_constants[i][0]))
1921                 ftepp_add_macro(ftepp, ftepp_math_constants[i][0], ftepp_math_constants[i][1]);
1922     }
1923
1924     return ftepp;
1925 }
1926
1927 void ftepp_add_define(ftepp_t *ftepp, const char *source, const char *name)
1928 {
1929     ppmacro *macro;
1930     lex_ctx_t ctx = { "__builtin__", 0, 0 };
1931     ctx.file = source;
1932     macro = ppmacro_new(ctx, name);
1933     /*vec_push(ftepp->macros, macro);*/
1934     util_htset(ftepp->macros, name, macro);
1935 }
1936
1937 const char *ftepp_get(ftepp_t *ftepp)
1938 {
1939     return ftepp->output_string;
1940 }
1941
1942 void ftepp_flush(ftepp_t *ftepp)
1943 {
1944     ftepp_flush_do(ftepp);
1945 }
1946
1947 void ftepp_finish(ftepp_t *ftepp)
1948 {
1949     if (!ftepp)
1950         return;
1951     ftepp_delete(ftepp);
1952 }