be5644627b58444f0385ee09c021d8c78661e30d
[xonotic/gmqcc.git] / ftepp.c
1 /*
2  * Copyright (C) 2012, 2013
3  *     Wolfgang Bumiller
4  *     Dale Weiler
5  *
6  * Permission is hereby granted, free of charge, to any person obtaining a copy of
7  * this software and associated documentation files (the "Software"), to deal in
8  * the Software without restriction, including without limitation the rights to
9  * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
10  * of the Software, and to permit persons to whom the Software is furnished to do
11  * so, subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be included in all
14  * copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22  * SOFTWARE.
23  */
24 #include <string.h>
25 #include <stdlib.h>
26 #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
767     int nextok;
768
769     if (vararg_start < vec_size(params))
770         varargs = vec_size(params) - vararg_start;
771     else
772         varargs = 0;
773
774     /* really ... */
775     if (!vec_size(macro->output))
776         return true;
777
778     ftepp->output_string = NULL;
779     for (o = 0; o < vec_size(macro->output); ++o) {
780         pptoken *out = macro->output[o];
781         switch (out->token) {
782             case TOKEN_VA_ARGS:
783                 if (!macro->variadic) {
784                     ftepp_error(ftepp, "internal preprocessor error: TOKEN_VA_ARGS in non-variadic macro");
785                     vec_free(old_string);
786                     return false;
787                 }
788                 if (!varargs)
789                     break;
790
791                 pi = 0;
792                 ftepp_param_out(ftepp, &params[pi + vararg_start]);
793                 for (++pi; pi < varargs; ++pi) {
794                     ftepp_out(ftepp, ", ", false);
795                     ftepp_param_out(ftepp, &params[pi + vararg_start]);
796                 }
797                 break;
798
799             case TOKEN_VA_ARGS_ARRAY:
800                 if ((size_t)out->constval.i >= varargs) {
801                     ftepp_error(ftepp, "subscript of `[%u]` is out of bounds for `__VA_ARGS__`", out->constval.i);
802                     vec_free(old_string);
803                     return false;
804                 }
805
806                 ftepp_param_out(ftepp, &params[out->constval.i + vararg_start]);
807                 break;
808
809             case TOKEN_VA_COUNT:
810                 util_asprintf(&buffer, "%d", varargs);
811                 ftepp_out(ftepp, buffer, false);
812                 mem_d(buffer);
813                 break;
814
815             case TOKEN_IDENT:
816             case TOKEN_TYPENAME:
817             case TOKEN_KEYWORD:
818                 if (!macro_params_find(macro, out->value, &pi)) {
819                     ftepp_out(ftepp, out->value, false);
820                     break;
821                 } else
822                     ftepp_param_out(ftepp, &params[pi]);
823                 break;
824             case '#':
825                 if (o + 1 < vec_size(macro->output)) {
826                     nextok = macro->output[o+1]->token;
827                     if (nextok == '#') {
828                         /* raw concatenation */
829                         ++o;
830                         break;
831                     }
832                     if ( (nextok == TOKEN_IDENT    ||
833                           nextok == TOKEN_KEYWORD  ||
834                           nextok == TOKEN_TYPENAME) &&
835                         macro_params_find(macro, macro->output[o+1]->value, &pi))
836                     {
837                         ++o;
838                         ftepp_stringify(ftepp, &params[pi]);
839                         break;
840                     }
841                 }
842                 ftepp_out(ftepp, "#", false);
843                 break;
844             case TOKEN_EOL:
845                 ftepp_out(ftepp, "\n", false);
846                 break;
847             default:
848                 ftepp_out(ftepp, out->value, false);
849                 break;
850         }
851     }
852     vec_push(ftepp->output_string, 0);
853     /* Now run the preprocessor recursively on this string buffer */
854     /*
855     printf("__________\n%s\n=========\n", ftepp->output_string);
856     */
857     inlex = lex_open_string(ftepp->output_string, vec_size(ftepp->output_string)-1, ftepp->lex->name);
858     if (!inlex) {
859         ftepp_error(ftepp, "internal error: failed to instantiate lexer");
860         retval = false;
861         goto cleanup;
862     }
863
864     inlex->line  = ftepp->lex->line;
865     inlex->sline = ftepp->lex->sline;
866     ftepp->lex   = inlex;
867
868     old_inmacro     = ftepp->in_macro;
869     ftepp->in_macro = true;
870     ftepp->output_string = NULL;
871     if (!ftepp_preprocess(ftepp)) {
872         ftepp->in_macro = old_inmacro;
873         vec_free(ftepp->lex->open_string);
874         vec_free(ftepp->output_string);
875         lex_close(ftepp->lex);
876         retval = false;
877         goto cleanup;
878     }
879     ftepp->in_macro = old_inmacro;
880     vec_free(ftepp->lex->open_string);
881     lex_close(ftepp->lex);
882
883     inner_string = ftepp->output_string;
884     ftepp->output_string = old_string;
885
886     has_newlines = (strchr(inner_string, '\n') != NULL);
887
888     if (has_newlines && !old_inmacro)
889         ftepp_recursion_header(ftepp);
890
891     vec_append(ftepp->output_string, vec_size(inner_string), inner_string);
892     vec_free(inner_string);
893
894     if (has_newlines && !old_inmacro)
895         ftepp_recursion_footer(ftepp);
896
897     if (resetline && !ftepp->in_macro) {
898         char lineno[128];
899         util_snprintf(lineno, 128, "\n#pragma line(%lu)\n", (unsigned long)(old_lexer->sline));
900         ftepp_out(ftepp, lineno, false);
901     }
902
903     old_string = ftepp->output_string;
904 cleanup:
905     ftepp->lex           = old_lexer;
906     ftepp->output_string = old_string;
907     return retval;
908 }
909
910 static bool ftepp_macro_call(ftepp_t *ftepp, ppmacro *macro)
911 {
912     size_t     o;
913     macroparam *params = NULL;
914     bool        retval = true;
915     size_t      paramline;
916
917     if (!macro->has_params) {
918         if (!ftepp_macro_expand(ftepp, macro, NULL, false))
919             return false;
920         ftepp_next(ftepp);
921         return true;
922     }
923     ftepp_next(ftepp);
924
925     if (!ftepp_skipallwhite(ftepp))
926         return false;
927
928     if (ftepp->token != '(') {
929         ftepp_error(ftepp, "expected macro parameters in parenthesis");
930         return false;
931     }
932
933     ftepp_next(ftepp);
934     paramline = ftepp->lex->sline;
935     if (!ftepp_macro_call_params(ftepp, &params))
936         return false;
937
938     if ( vec_size(params) < vec_size(macro->params) ||
939         (vec_size(params) > vec_size(macro->params) && !macro->variadic) )
940     {
941         ftepp_error(ftepp, "macro %s expects%s %u paramteters, %u provided", macro->name,
942                     (macro->variadic ? " at least" : ""),
943                     (unsigned int)vec_size(macro->params),
944                     (unsigned int)vec_size(params));
945         retval = false;
946         goto cleanup;
947     }
948
949     if (!ftepp_macro_expand(ftepp, macro, params, (paramline != ftepp->lex->sline)))
950         retval = false;
951     ftepp_next(ftepp);
952
953 cleanup:
954     for (o = 0; o < vec_size(params); ++o)
955         macroparam_clean(&params[o]);
956     vec_free(params);
957     return retval;
958 }
959
960 /**
961  * #if - the FTEQCC way:
962  *    defined(FOO) => true if FOO was #defined regardless of parameters or contents
963  *    <numbers>    => True if the number is not 0
964  *    !<factor>    => True if the factor yields false
965  *    !!<factor>   => ERROR on 2 or more unary nots
966  *    <macro>      => becomes the macro's FIRST token regardless of parameters
967  *    <e> && <e>   => True if both expressions are true
968  *    <e> || <e>   => True if either expression is true
969  *    <string>     => False
970  *    <ident>      => False (remember for macros the <macro> rule applies instead)
971  * Unary + and - are weird and wrong in fteqcc so we don't allow them
972  * parenthesis in expressions are allowed
973  * parameter lists on macros are errors
974  * No mathematical calculations are executed
975  */
976 static bool ftepp_if_expr(ftepp_t *ftepp, bool *out, double *value_out);
977 static bool ftepp_if_op(ftepp_t *ftepp)
978 {
979     ftepp->lex->flags.noops = false;
980     ftepp_next(ftepp);
981     if (!ftepp_skipspace(ftepp))
982         return false;
983     ftepp->lex->flags.noops = true;
984     return true;
985 }
986 static bool ftepp_if_value(ftepp_t *ftepp, bool *out, double *value_out)
987 {
988     ppmacro *macro;
989     bool     wasnot = false;
990     bool     wasneg = false;
991
992     if (!ftepp_skipspace(ftepp))
993         return false;
994
995     while (ftepp->token == '!') {
996         wasnot = true;
997         ftepp_next(ftepp);
998         if (!ftepp_skipspace(ftepp))
999             return false;
1000     }
1001
1002     if (ftepp->token == TOKEN_OPERATOR && !strcmp(ftepp_tokval(ftepp), "-"))
1003     {
1004         wasneg = true;
1005         ftepp_next(ftepp);
1006         if (!ftepp_skipspace(ftepp))
1007             return false;
1008     }
1009
1010     switch (ftepp->token) {
1011         case TOKEN_IDENT:
1012         case TOKEN_TYPENAME:
1013         case TOKEN_KEYWORD:
1014             if (!strcmp(ftepp_tokval(ftepp), "defined")) {
1015                 ftepp_next(ftepp);
1016                 if (!ftepp_skipspace(ftepp))
1017                     return false;
1018                 if (ftepp->token != '(') {
1019                     ftepp_error(ftepp, "`defined` keyword in #if requires a macro name in parenthesis");
1020                     return false;
1021                 }
1022                 ftepp_next(ftepp);
1023                 if (!ftepp_skipspace(ftepp))
1024                     return false;
1025                 if (ftepp->token != TOKEN_IDENT &&
1026                     ftepp->token != TOKEN_TYPENAME &&
1027                     ftepp->token != TOKEN_KEYWORD)
1028                 {
1029                     ftepp_error(ftepp, "defined() used on an unexpected token type");
1030                     return false;
1031                 }
1032                 macro = ftepp_macro_find(ftepp, ftepp_tokval(ftepp));
1033                 *out = !!macro;
1034                 ftepp_next(ftepp);
1035                 if (!ftepp_skipspace(ftepp))
1036                     return false;
1037                 if (ftepp->token != ')') {
1038                     ftepp_error(ftepp, "expected closing paren");
1039                     return false;
1040                 }
1041                 break;
1042             }
1043
1044             macro = ftepp_macro_find(ftepp, ftepp_tokval(ftepp));
1045             if (!macro || !vec_size(macro->output)) {
1046                 *out = false;
1047                 *value_out = 0;
1048             } else {
1049                 /* This does not expand recursively! */
1050                 switch (macro->output[0]->token) {
1051                     case TOKEN_INTCONST:
1052                         *value_out = macro->output[0]->constval.i;
1053                         *out = !!(macro->output[0]->constval.i);
1054                         break;
1055                     case TOKEN_FLOATCONST:
1056                         *value_out = macro->output[0]->constval.f;
1057                         *out = !!(macro->output[0]->constval.f);
1058                         break;
1059                     default:
1060                         *out = false;
1061                         break;
1062                 }
1063             }
1064             break;
1065         case TOKEN_STRINGCONST:
1066             *value_out = 0;
1067             *out = false;
1068             break;
1069         case TOKEN_INTCONST:
1070             *value_out = ftepp->lex->tok.constval.i;
1071             *out = !!(ftepp->lex->tok.constval.i);
1072             break;
1073         case TOKEN_FLOATCONST:
1074             *value_out = ftepp->lex->tok.constval.f;
1075             *out = !!(ftepp->lex->tok.constval.f);
1076             break;
1077
1078         case '(':
1079             ftepp_next(ftepp);
1080             if (!ftepp_if_expr(ftepp, out, value_out))
1081                 return false;
1082             if (ftepp->token != ')') {
1083                 ftepp_error(ftepp, "expected closing paren in #if expression");
1084                 return false;
1085             }
1086             break;
1087
1088         default:
1089             ftepp_error(ftepp, "junk in #if: `%s` ...", ftepp_tokval(ftepp));
1090             if (OPTS_OPTION_BOOL(OPTION_DEBUG))
1091                 ftepp_error(ftepp, "internal: token %i\n", ftepp->token);
1092             return false;
1093     }
1094     if (wasneg)
1095         *value_out = -*value_out;
1096     if (wasnot) {
1097         *out = !*out;
1098         *value_out = (*out ? 1 : 0);
1099     }
1100     return true;
1101 }
1102
1103 /*
1104 static bool ftepp_if_nextvalue(ftepp_t *ftepp, bool *out, double *value_out)
1105 {
1106     if (!ftepp_next(ftepp))
1107         return false;
1108     return ftepp_if_value(ftepp, out, value_out);
1109 }
1110 */
1111
1112 static bool ftepp_if_expr(ftepp_t *ftepp, bool *out, double *value_out)
1113 {
1114     if (!ftepp_if_value(ftepp, out, value_out))
1115         return false;
1116
1117     if (!ftepp_if_op(ftepp))
1118         return false;
1119
1120     if (ftepp->token == ')' || ftepp->token != TOKEN_OPERATOR)
1121         return true;
1122
1123     /* FTEQCC is all right-associative and no precedence here */
1124     if (!strcmp(ftepp_tokval(ftepp), "&&") ||
1125         !strcmp(ftepp_tokval(ftepp), "||"))
1126     {
1127         bool next = false;
1128         char opc  = ftepp_tokval(ftepp)[0];
1129         double nextvalue;
1130
1131         (void)nextvalue;
1132         if (!ftepp_next(ftepp))
1133             return false;
1134         if (!ftepp_if_expr(ftepp, &next, &nextvalue))
1135             return false;
1136
1137         if (opc == '&')
1138             *out = *out && next;
1139         else
1140             *out = *out || next;
1141
1142         *value_out = (*out ? 1 : 0);
1143         return true;
1144     }
1145     else if (!strcmp(ftepp_tokval(ftepp), "==") ||
1146              !strcmp(ftepp_tokval(ftepp), "!=") ||
1147              !strcmp(ftepp_tokval(ftepp), ">=") ||
1148              !strcmp(ftepp_tokval(ftepp), "<=") ||
1149              !strcmp(ftepp_tokval(ftepp), ">") ||
1150              !strcmp(ftepp_tokval(ftepp), "<"))
1151     {
1152         bool next = false;
1153         const char opc0 = ftepp_tokval(ftepp)[0];
1154         const char opc1 = ftepp_tokval(ftepp)[1];
1155         double other;
1156
1157         if (!ftepp_next(ftepp))
1158             return false;
1159         if (!ftepp_if_expr(ftepp, &next, &other))
1160             return false;
1161
1162         if (opc0 == '=')
1163             *out = (*value_out == other);
1164         else if (opc0 == '!')
1165             *out = (*value_out != other);
1166         else if (opc0 == '>') {
1167             if (opc1 == '=') *out = (*value_out >= other);
1168             else             *out = (*value_out > other);
1169         }
1170         else if (opc0 == '<') {
1171             if (opc1 == '=') *out = (*value_out <= other);
1172             else             *out = (*value_out < other);
1173         }
1174         *value_out = (*out ? 1 : 0);
1175
1176         return true;
1177     }
1178     else {
1179         ftepp_error(ftepp, "junk after #if");
1180         return false;
1181     }
1182 }
1183
1184 static bool ftepp_if(ftepp_t *ftepp, ppcondition *cond)
1185 {
1186     bool result = false;
1187     double dummy = 0;
1188
1189     memset(cond, 0, sizeof(*cond));
1190     (void)ftepp_next(ftepp);
1191
1192     if (!ftepp_skipspace(ftepp))
1193         return false;
1194     if (ftepp->token == TOKEN_EOL) {
1195         ftepp_error(ftepp, "expected expression for #if-directive");
1196         return false;
1197     }
1198
1199     if (!ftepp_if_expr(ftepp, &result, &dummy))
1200         return false;
1201
1202     cond->on = result;
1203     return true;
1204 }
1205
1206 /**
1207  * ifdef is rather simple
1208  */
1209 static bool ftepp_ifdef(ftepp_t *ftepp, ppcondition *cond)
1210 {
1211     ppmacro *macro;
1212     memset(cond, 0, sizeof(*cond));
1213     (void)ftepp_next(ftepp);
1214     if (!ftepp_skipspace(ftepp))
1215         return false;
1216
1217     switch (ftepp->token) {
1218         case TOKEN_IDENT:
1219         case TOKEN_TYPENAME:
1220         case TOKEN_KEYWORD:
1221             macro = ftepp_macro_find(ftepp, ftepp_tokval(ftepp));
1222             break;
1223         default:
1224             ftepp_error(ftepp, "expected macro name");
1225             return false;
1226     }
1227
1228     (void)ftepp_next(ftepp);
1229     if (!ftepp_skipspace(ftepp))
1230         return false;
1231     /* relaxing this condition
1232     if (ftepp->token != TOKEN_EOL && ftepp->token != TOKEN_EOF) {
1233         ftepp_error(ftepp, "stray tokens after #ifdef");
1234         return false;
1235     }
1236     */
1237     cond->on = !!macro;
1238     return true;
1239 }
1240
1241 /**
1242  * undef is also simple
1243  */
1244 static bool ftepp_undef(ftepp_t *ftepp)
1245 {
1246     (void)ftepp_next(ftepp);
1247     if (!ftepp_skipspace(ftepp))
1248         return false;
1249
1250     if (ftepp->output_on) {
1251         switch (ftepp->token) {
1252             case TOKEN_IDENT:
1253             case TOKEN_TYPENAME:
1254             case TOKEN_KEYWORD:
1255                 ftepp_macro_delete(ftepp, ftepp_tokval(ftepp));
1256                 break;
1257             default:
1258                 ftepp_error(ftepp, "expected macro name");
1259                 return false;
1260         }
1261     }
1262
1263     (void)ftepp_next(ftepp);
1264     if (!ftepp_skipspace(ftepp))
1265         return false;
1266     /* relaxing this condition
1267     if (ftepp->token != TOKEN_EOL && ftepp->token != TOKEN_EOF) {
1268         ftepp_error(ftepp, "stray tokens after #ifdef");
1269         return false;
1270     }
1271     */
1272     return true;
1273 }
1274
1275 /* Special unescape-string function which skips a leading quote
1276  * and stops at a quote, not just at \0
1277  */
1278 static void unescape(const char *str, char *out) {
1279     ++str;
1280     while (*str && *str != '"') {
1281         if (*str == '\\') {
1282             ++str;
1283             switch (*str) {
1284                 case '\\': *out++ = *str; break;
1285                 case '"':  *out++ = *str; break;
1286                 case 'a':  *out++ = '\a'; break;
1287                 case 'b':  *out++ = '\b'; break;
1288                 case 'r':  *out++ = '\r'; break;
1289                 case 'n':  *out++ = '\n'; break;
1290                 case 't':  *out++ = '\t'; break;
1291                 case 'f':  *out++ = '\f'; break;
1292                 case 'v':  *out++ = '\v'; break;
1293                 default:
1294                     *out++ = '\\';
1295                     *out++ = *str;
1296                     break;
1297             }
1298             ++str;
1299             continue;
1300         }
1301
1302         *out++ = *str++;
1303     }
1304     *out = 0;
1305 }
1306
1307 static char *ftepp_include_find_path(const char *file, const char *pathfile)
1308 {
1309     fs_file_t  *fp;
1310     char       *filename = NULL;
1311     const char *last_slash;
1312     size_t      len;
1313
1314     if (!pathfile)
1315         return NULL;
1316
1317     last_slash = strrchr(pathfile, '/');
1318
1319     if (last_slash) {
1320         len = last_slash - pathfile;
1321         memcpy(vec_add(filename, len), pathfile, len);
1322         vec_push(filename, '/');
1323     }
1324
1325     len = strlen(file);
1326     memcpy(vec_add(filename, len+1), file, len);
1327     vec_last(filename) = 0;
1328
1329     fp = fs_file_open(filename, "rb");
1330     if (fp) {
1331         fs_file_close(fp);
1332         return filename;
1333     }
1334     vec_free(filename);
1335     return NULL;
1336 }
1337
1338 static char *ftepp_include_find(ftepp_t *ftepp, const char *file)
1339 {
1340     char *filename = NULL;
1341
1342     filename = ftepp_include_find_path(file, ftepp->includename);
1343     if (!filename)
1344         filename = ftepp_include_find_path(file, ftepp->itemname);
1345     return filename;
1346 }
1347
1348 static bool ftepp_directive_warning(ftepp_t *ftepp) {
1349     char *message = NULL;
1350
1351     if (!ftepp_skipspace(ftepp))
1352         return false;
1353
1354     /* handle the odd non string constant case so it works like C */
1355     if (ftepp->token != TOKEN_STRINGCONST) {
1356         bool  store   = false;
1357         vec_append(message, 8, "#warning");
1358         ftepp_next(ftepp);
1359         while (ftepp->token != TOKEN_EOL) {
1360             vec_append(message, strlen(ftepp_tokval(ftepp)), ftepp_tokval(ftepp));
1361             ftepp_next(ftepp);
1362         }
1363         vec_push(message, '\0');
1364         if (ftepp->output_on)
1365             store = ftepp_warn(ftepp, WARN_CPP, message);
1366         else
1367             store = false;
1368         vec_free(message);
1369         return store;
1370     }
1371
1372     if (!ftepp->output_on)
1373         return false;
1374
1375     unescape  (ftepp_tokval(ftepp), ftepp_tokval(ftepp));
1376     return ftepp_warn(ftepp, WARN_CPP, "#warning %s", ftepp_tokval(ftepp));
1377 }
1378
1379 static void ftepp_directive_error(ftepp_t *ftepp) {
1380     char *message = NULL;
1381
1382     if (!ftepp_skipspace(ftepp))
1383         return;
1384
1385     /* handle the odd non string constant case so it works like C */
1386     if (ftepp->token != TOKEN_STRINGCONST) {
1387         vec_append(message, 6, "#error");
1388         ftepp_next(ftepp);
1389         while (ftepp->token != TOKEN_EOL) {
1390             vec_append(message, strlen(ftepp_tokval(ftepp)), ftepp_tokval(ftepp));
1391             ftepp_next(ftepp);
1392         }
1393         vec_push(message, '\0');
1394         if (ftepp->output_on)
1395             ftepp_error(ftepp, message);
1396         vec_free(message);
1397         return;
1398     }
1399
1400     if (!ftepp->output_on)
1401         return;
1402
1403     unescape  (ftepp_tokval(ftepp), ftepp_tokval(ftepp));
1404     ftepp_error(ftepp, "#error %s", ftepp_tokval(ftepp));
1405 }
1406
1407 static void ftepp_directive_message(ftepp_t *ftepp) {
1408     char *message = NULL;
1409
1410     if (!ftepp_skipspace(ftepp))
1411         return;
1412
1413     /* handle the odd non string constant case so it works like C */
1414     if (ftepp->token != TOKEN_STRINGCONST) {
1415         vec_append(message, 8, "#message");
1416         ftepp_next(ftepp);
1417         while (ftepp->token != TOKEN_EOL) {
1418             vec_append(message, strlen(ftepp_tokval(ftepp)), ftepp_tokval(ftepp));
1419             ftepp_next(ftepp);
1420         }
1421         vec_push(message, '\0');
1422         if (ftepp->output_on)
1423             con_cprintmsg(ftepp->lex->tok.ctx, LVL_MSG, "message", message);
1424         vec_free(message);
1425         return;
1426     }
1427
1428     if (!ftepp->output_on)
1429         return;
1430
1431     unescape     (ftepp_tokval(ftepp), ftepp_tokval(ftepp));
1432     con_cprintmsg(ftepp->lex->tok.ctx, LVL_MSG, "message",  ftepp_tokval(ftepp));
1433 }
1434
1435 /**
1436  * Include a file.
1437  * FIXME: do we need/want a -I option?
1438  * FIXME: what about when dealing with files in subdirectories coming from a progs.src?
1439  */
1440 static bool ftepp_include(ftepp_t *ftepp)
1441 {
1442     lex_file *old_lexer = ftepp->lex;
1443     lex_file *inlex;
1444     lex_ctx_t ctx;
1445     char     lineno[128];
1446     char     *filename;
1447     char     *old_includename;
1448
1449     (void)ftepp_next(ftepp);
1450     if (!ftepp_skipspace(ftepp))
1451         return false;
1452
1453     if (ftepp->token != TOKEN_STRINGCONST) {
1454         ftepp_error(ftepp, "expected filename to include");
1455         return false;
1456     }
1457
1458     if (!ftepp->output_on) {
1459         ftepp_next(ftepp);
1460         return true;
1461     }
1462
1463     ctx = ftepp_ctx(ftepp);
1464
1465     unescape(ftepp_tokval(ftepp), ftepp_tokval(ftepp));
1466
1467     ftepp_out(ftepp, "\n#pragma file(", false);
1468     ftepp_out(ftepp, ftepp_tokval(ftepp), false);
1469     ftepp_out(ftepp, ")\n#pragma line(1)\n", false);
1470
1471     filename = ftepp_include_find(ftepp, ftepp_tokval(ftepp));
1472     if (!filename) {
1473         ftepp_error(ftepp, "failed to open include file `%s`", ftepp_tokval(ftepp));
1474         return false;
1475     }
1476     inlex = lex_open(filename);
1477     if (!inlex) {
1478         ftepp_error(ftepp, "open failed on include file `%s`", filename);
1479         vec_free(filename);
1480         return false;
1481     }
1482     ftepp->lex = inlex;
1483     old_includename = ftepp->includename;
1484     ftepp->includename = filename;
1485     if (!ftepp_preprocess(ftepp)) {
1486         vec_free(ftepp->includename);
1487         ftepp->includename = old_includename;
1488         lex_close(ftepp->lex);
1489         ftepp->lex = old_lexer;
1490         return false;
1491     }
1492     vec_free(ftepp->includename);
1493     ftepp->includename = old_includename;
1494     lex_close(ftepp->lex);
1495     ftepp->lex = old_lexer;
1496
1497     ftepp_out(ftepp, "\n#pragma file(", false);
1498     ftepp_out(ftepp, ctx.file, false);
1499     util_snprintf(lineno, sizeof(lineno), ")\n#pragma line(%lu)\n", (unsigned long)(ctx.line+1));
1500     ftepp_out(ftepp, lineno, false);
1501
1502     /* skip the line */
1503     (void)ftepp_next(ftepp);
1504     if (!ftepp_skipspace(ftepp))
1505         return false;
1506     if (ftepp->token != TOKEN_EOL) {
1507         ftepp_error(ftepp, "stray tokens after #include");
1508         return false;
1509     }
1510     (void)ftepp_next(ftepp);
1511
1512     return true;
1513 }
1514
1515 /* Basic structure handlers */
1516 static bool ftepp_else_allowed(ftepp_t *ftepp)
1517 {
1518     if (!vec_size(ftepp->conditions)) {
1519         ftepp_error(ftepp, "#else without #if");
1520         return false;
1521     }
1522     if (vec_last(ftepp->conditions).had_else) {
1523         ftepp_error(ftepp, "multiple #else for a single #if");
1524         return false;
1525     }
1526     return true;
1527 }
1528
1529 static GMQCC_INLINE void ftepp_inmacro(ftepp_t *ftepp, const char *hash) {
1530     if (ftepp->in_macro)
1531         (void)!ftepp_warn(ftepp, WARN_DIRECTIVE_INMACRO, "`#%s` directive in macro", hash);
1532 }
1533
1534 static bool ftepp_hash(ftepp_t *ftepp)
1535 {
1536     ppcondition cond;
1537     ppcondition *pc;
1538
1539     lex_ctx_t ctx = ftepp_ctx(ftepp);
1540
1541     if (!ftepp_skipspace(ftepp))
1542         return false;
1543
1544     switch (ftepp->token) {
1545         case TOKEN_KEYWORD:
1546         case TOKEN_IDENT:
1547         case TOKEN_TYPENAME:
1548             if (!strcmp(ftepp_tokval(ftepp), "define")) {
1549                 ftepp_inmacro(ftepp, "define");
1550                 return ftepp_define(ftepp);
1551             }
1552             else if (!strcmp(ftepp_tokval(ftepp), "undef")) {
1553                 ftepp_inmacro(ftepp, "undef");
1554                 return ftepp_undef(ftepp);
1555             }
1556             else if (!strcmp(ftepp_tokval(ftepp), "ifdef")) {
1557                 ftepp_inmacro(ftepp, "ifdef");
1558                 if (!ftepp_ifdef(ftepp, &cond))
1559                     return false;
1560                 cond.was_on = cond.on;
1561                 vec_push(ftepp->conditions, cond);
1562                 ftepp->output_on = ftepp->output_on && cond.on;
1563                 break;
1564             }
1565             else if (!strcmp(ftepp_tokval(ftepp), "ifndef")) {
1566                 ftepp_inmacro(ftepp, "ifndef");
1567                 if (!ftepp_ifdef(ftepp, &cond))
1568                     return false;
1569                 cond.on = !cond.on;
1570                 cond.was_on = cond.on;
1571                 vec_push(ftepp->conditions, cond);
1572                 ftepp->output_on = ftepp->output_on && cond.on;
1573                 break;
1574             }
1575             else if (!strcmp(ftepp_tokval(ftepp), "elifdef")) {
1576                 ftepp_inmacro(ftepp, "elifdef");
1577                 if (!ftepp_else_allowed(ftepp))
1578                     return false;
1579                 if (!ftepp_ifdef(ftepp, &cond))
1580                     return false;
1581                 pc = &vec_last(ftepp->conditions);
1582                 pc->on     = !pc->was_on && cond.on;
1583                 pc->was_on = pc->was_on || pc->on;
1584                 ftepp_update_output_condition(ftepp);
1585                 break;
1586             }
1587             else if (!strcmp(ftepp_tokval(ftepp), "elifndef")) {
1588                 ftepp_inmacro(ftepp, "elifndef");
1589                 if (!ftepp_else_allowed(ftepp))
1590                     return false;
1591                 if (!ftepp_ifdef(ftepp, &cond))
1592                     return false;
1593                 cond.on = !cond.on;
1594                 pc = &vec_last(ftepp->conditions);
1595                 pc->on     = !pc->was_on && cond.on;
1596                 pc->was_on = pc->was_on || pc->on;
1597                 ftepp_update_output_condition(ftepp);
1598                 break;
1599             }
1600             else if (!strcmp(ftepp_tokval(ftepp), "elif")) {
1601                 ftepp_inmacro(ftepp, "elif");
1602                 if (!ftepp_else_allowed(ftepp))
1603                     return false;
1604                 if (!ftepp_if(ftepp, &cond))
1605                     return false;
1606                 pc = &vec_last(ftepp->conditions);
1607                 pc->on     = !pc->was_on && cond.on;
1608                 pc->was_on = pc->was_on  || pc->on;
1609                 ftepp_update_output_condition(ftepp);
1610                 break;
1611             }
1612             else if (!strcmp(ftepp_tokval(ftepp), "if")) {
1613                 ftepp_inmacro(ftepp, "if");
1614                 if (!ftepp_if(ftepp, &cond))
1615                     return false;
1616                 cond.was_on = cond.on;
1617                 vec_push(ftepp->conditions, cond);
1618                 ftepp->output_on = ftepp->output_on && cond.on;
1619                 break;
1620             }
1621             else if (!strcmp(ftepp_tokval(ftepp), "else")) {
1622                 ftepp_inmacro(ftepp, "else");
1623                 if (!ftepp_else_allowed(ftepp))
1624                     return false;
1625                 pc = &vec_last(ftepp->conditions);
1626                 pc->on = !pc->was_on;
1627                 pc->had_else = true;
1628                 ftepp_next(ftepp);
1629                 ftepp_update_output_condition(ftepp);
1630                 break;
1631             }
1632             else if (!strcmp(ftepp_tokval(ftepp), "endif")) {
1633                 ftepp_inmacro(ftepp, "endif");
1634                 if (!vec_size(ftepp->conditions)) {
1635                     ftepp_error(ftepp, "#endif without #if");
1636                     return false;
1637                 }
1638                 vec_pop(ftepp->conditions);
1639                 ftepp_next(ftepp);
1640                 ftepp_update_output_condition(ftepp);
1641                 break;
1642             }
1643             else if (!strcmp(ftepp_tokval(ftepp), "include")) {
1644                 ftepp_inmacro(ftepp, "include");
1645                 return ftepp_include(ftepp);
1646             }
1647             else if (!strcmp(ftepp_tokval(ftepp), "pragma")) {
1648                 ftepp_out(ftepp, "#", false);
1649                 break;
1650             }
1651             else if (!strcmp(ftepp_tokval(ftepp), "warning")) {
1652                 ftepp_directive_warning(ftepp);
1653                 break;
1654             }
1655             else if (!strcmp(ftepp_tokval(ftepp), "error")) {
1656                 ftepp_directive_error(ftepp);
1657                 break;
1658             }
1659             else if (!strcmp(ftepp_tokval(ftepp), "message")) {
1660                 ftepp_directive_message(ftepp);
1661                 break;
1662             }
1663             else {
1664                 if (ftepp->output_on) {
1665                     ftepp_error(ftepp, "unrecognized preprocessor directive: `%s`", ftepp_tokval(ftepp));
1666                     return false;
1667                 } else {
1668                     ftepp_next(ftepp);
1669                     break;
1670                 }
1671             }
1672             /* break; never reached */
1673         default:
1674             ftepp_error(ftepp, "unexpected preprocessor token: `%s`", ftepp_tokval(ftepp));
1675             return false;
1676         case TOKEN_EOL:
1677             ftepp_errorat(ftepp, ctx, "empty preprocessor directive");
1678             return false;
1679         case TOKEN_EOF:
1680             ftepp_error(ftepp, "missing newline at end of file", ftepp_tokval(ftepp));
1681             return false;
1682
1683         /* Builtins! Don't forget the builtins! */
1684         case TOKEN_INTCONST:
1685         case TOKEN_FLOATCONST:
1686             ftepp_out(ftepp, "#", false);
1687             return true;
1688     }
1689     if (!ftepp_skipspace(ftepp))
1690         return false;
1691     return true;
1692 }
1693
1694 static bool ftepp_preprocess(ftepp_t *ftepp)
1695 {
1696     ppmacro *macro;
1697     bool     newline = true;
1698
1699     /* predef stuff */
1700     char    *expand  = NULL;
1701
1702     ftepp->lex->flags.preprocessing = true;
1703     ftepp->lex->flags.mergelines    = false;
1704     ftepp->lex->flags.noops         = true;
1705
1706     ftepp_next(ftepp);
1707     do
1708     {
1709         if (ftepp->token >= TOKEN_EOF)
1710             break;
1711 #if 0
1712         newline = true;
1713 #endif
1714
1715         switch (ftepp->token) {
1716             case TOKEN_KEYWORD:
1717             case TOKEN_IDENT:
1718             case TOKEN_TYPENAME:
1719                 /* is it a predef? */
1720                 if (OPTS_FLAG(FTEPP_PREDEFS)) {
1721                     char *(*predef)(ftepp_t*) = ftepp_predef(ftepp_tokval(ftepp));
1722                     if (predef) {
1723                         expand = predef(ftepp);
1724                         ftepp_out (ftepp, expand, false);
1725                         ftepp_next(ftepp);
1726
1727                         mem_d(expand);
1728                         break;
1729                     }
1730                 }
1731
1732                 if (ftepp->output_on)
1733                     macro = ftepp_macro_find(ftepp, ftepp_tokval(ftepp));
1734                 else
1735                     macro = NULL;
1736
1737                 if (!macro) {
1738                     ftepp_out(ftepp, ftepp_tokval(ftepp), false);
1739                     ftepp_next(ftepp);
1740                     break;
1741                 }
1742                 if (!ftepp_macro_call(ftepp, macro))
1743                     ftepp->token = TOKEN_ERROR;
1744                 break;
1745             case '#':
1746                 if (!newline) {
1747                     ftepp_out(ftepp, ftepp_tokval(ftepp), false);
1748                     ftepp_next(ftepp);
1749                     break;
1750                 }
1751                 ftepp->lex->flags.mergelines = true;
1752                 if (ftepp_next(ftepp) >= TOKEN_EOF) {
1753                     ftepp_error(ftepp, "error in preprocessor directive");
1754                     ftepp->token = TOKEN_ERROR;
1755                     break;
1756                 }
1757                 if (!ftepp_hash(ftepp))
1758                     ftepp->token = TOKEN_ERROR;
1759                 ftepp->lex->flags.mergelines = false;
1760                 break;
1761             case TOKEN_EOL:
1762                 newline = true;
1763                 ftepp_out(ftepp, "\n", true);
1764                 ftepp_next(ftepp);
1765                 break;
1766             case TOKEN_WHITE:
1767                 /* same as default but don't set newline=false */
1768                 ftepp_out(ftepp, ftepp_tokval(ftepp), true);
1769                 ftepp_next(ftepp);
1770                 break;
1771             default:
1772                 newline = false;
1773                 ftepp_out(ftepp, ftepp_tokval(ftepp), false);
1774                 ftepp_next(ftepp);
1775                 break;
1776         }
1777     } while (!ftepp->errors && ftepp->token < TOKEN_EOF);
1778
1779     /* force a 0 at the end but don't count it as added to the output */
1780     vec_push(ftepp->output_string, 0);
1781     vec_shrinkby(ftepp->output_string, 1);
1782
1783     return (ftepp->token == TOKEN_EOF);
1784 }
1785
1786 /* Like in parser.c - files keep the previous state so we have one global
1787  * preprocessor. Except here we will want to warn about dangling #ifs.
1788  */
1789 static bool ftepp_preprocess_done(ftepp_t *ftepp)
1790 {
1791     bool retval = true;
1792     if (vec_size(ftepp->conditions)) {
1793         if (ftepp_warn(ftepp, WARN_MULTIFILE_IF, "#if spanning multiple files, is this intended?"))
1794             retval = false;
1795     }
1796     lex_close(ftepp->lex);
1797     ftepp->lex = NULL;
1798     if (ftepp->itemname) {
1799         mem_d(ftepp->itemname);
1800         ftepp->itemname = NULL;
1801     }
1802     return retval;
1803 }
1804
1805 bool ftepp_preprocess_file(ftepp_t *ftepp, const char *filename)
1806 {
1807     ftepp->lex = lex_open(filename);
1808     ftepp->itemname = util_strdup(filename);
1809     if (!ftepp->lex) {
1810         con_out("failed to open file \"%s\"\n", filename);
1811         return false;
1812     }
1813     if (!ftepp_preprocess(ftepp))
1814         return false;
1815     return ftepp_preprocess_done(ftepp);
1816 }
1817
1818 bool ftepp_preprocess_string(ftepp_t *ftepp, const char *name, const char *str)
1819 {
1820     ftepp->lex = lex_open_string(str, strlen(str), name);
1821     ftepp->itemname = util_strdup(name);
1822     if (!ftepp->lex) {
1823         con_out("failed to create lexer for string \"%s\"\n", name);
1824         return false;
1825     }
1826     if (!ftepp_preprocess(ftepp))
1827         return false;
1828     return ftepp_preprocess_done(ftepp);
1829 }
1830
1831
1832 void ftepp_add_macro(ftepp_t *ftepp, const char *name, const char *value) {
1833     char *create = NULL;
1834
1835     /* use saner path for empty macros */
1836     if (!value) {
1837         ftepp_add_define(ftepp, "__builtin__", name);
1838         return;
1839     }
1840
1841     vec_append(create, 8,           "#define ");
1842     vec_append(create, strlen(name), name);
1843     vec_push  (create, ' ');
1844     vec_append(create, strlen(value), value);
1845     vec_push  (create, 0);
1846
1847     ftepp_preprocess_string(ftepp, "__builtin__", create);
1848     vec_free  (create);
1849 }
1850
1851 ftepp_t *ftepp_create()
1852 {
1853     ftepp_t *ftepp;
1854     char minor[32];
1855     char major[32];
1856     size_t i;
1857
1858     ftepp = ftepp_new();
1859     if (!ftepp)
1860         return NULL;
1861
1862     memset(minor, 0, sizeof(minor));
1863     memset(major, 0, sizeof(major));
1864
1865     /* set the right macro based on the selected standard */
1866     ftepp_add_define(ftepp, NULL, "GMQCC");
1867     if (OPTS_OPTION_U32(OPTION_STANDARD) == COMPILER_FTEQCC) {
1868         ftepp_add_define(ftepp, NULL, "__STD_FTEQCC__");
1869         /* 1.00 */
1870         major[0] = '"';
1871         major[1] = '1';
1872         major[2] = '"';
1873
1874         minor[0] = '"';
1875         minor[1] = '0';
1876         minor[2] = '"';
1877     } else if (OPTS_OPTION_U32(OPTION_STANDARD) == COMPILER_GMQCC) {
1878         ftepp_add_define(ftepp, NULL, "__STD_GMQCC__");
1879         util_snprintf(major, 32, "\"%d\"", GMQCC_VERSION_MAJOR);
1880         util_snprintf(minor, 32, "\"%d\"", GMQCC_VERSION_MINOR);
1881     } else if (OPTS_OPTION_U32(OPTION_STANDARD) == COMPILER_QCCX) {
1882         ftepp_add_define(ftepp, NULL, "__STD_QCCX__");
1883         util_snprintf(major, 32, "\"%d\"", GMQCC_VERSION_MAJOR);
1884         util_snprintf(minor, 32, "\"%d\"", GMQCC_VERSION_MINOR);
1885     } else if (OPTS_OPTION_U32(OPTION_STANDARD) == COMPILER_QCC) {
1886         ftepp_add_define(ftepp, NULL, "__STD_QCC__");
1887         /* 1.0 */
1888         major[0] = '"';
1889         major[1] = '1';
1890         major[2] = '"';
1891
1892         minor[0] = '"';
1893         minor[1] = '0';
1894         minor[2] = '"';
1895     }
1896
1897     ftepp_add_macro(ftepp, "__STD_VERSION_MINOR__", minor);
1898     ftepp_add_macro(ftepp, "__STD_VERSION_MAJOR__", major);
1899
1900     /*
1901      * We're going to just make __NULL__ nil, which works for 60% of the
1902      * cases of __NULL_ for fteqcc.
1903      */
1904     ftepp_add_macro(ftepp, "__NULL__", "nil");
1905
1906     /* add all the math constants if they can be */
1907     if (OPTS_FLAG(FTEPP_MATHDEFS)) {
1908         for (i = 0; i < GMQCC_ARRAY_COUNT(ftepp_math_constants); i++)
1909             if (!ftepp_macro_find(ftepp, ftepp_math_constants[i][0]))
1910                 ftepp_add_macro(ftepp, ftepp_math_constants[i][0], ftepp_math_constants[i][1]);
1911     }
1912
1913     return ftepp;
1914 }
1915
1916 void ftepp_add_define(ftepp_t *ftepp, const char *source, const char *name)
1917 {
1918     ppmacro *macro;
1919     lex_ctx_t ctx = { "__builtin__", 0, 0 };
1920     ctx.file = source;
1921     macro = ppmacro_new(ctx, name);
1922     /*vec_push(ftepp->macros, macro);*/
1923     util_htset(ftepp->macros, name, macro);
1924 }
1925
1926 const char *ftepp_get(ftepp_t *ftepp)
1927 {
1928     return ftepp->output_string;
1929 }
1930
1931 void ftepp_flush(ftepp_t *ftepp)
1932 {
1933     ftepp_flush_do(ftepp);
1934 }
1935
1936 void ftepp_finish(ftepp_t *ftepp)
1937 {
1938     if (!ftepp)
1939         return;
1940     ftepp_delete(ftepp);
1941 }