5 * Permission is hereby granted, free of charge, to any person obtaining a copy of
6 * this software and associated documentation files (the "Software"), to deal in
7 * the Software without restriction, including without limitation the rights to
8 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
9 * of the Software, and to permit persons to whom the Software is furnished to do
10 * so, subject to the following conditions:
12 * The above copyright notice and this permission notice shall be included in all
13 * copies or substantial portions of the Software.
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
35 /* a copy from the lexer */
49 /* yes we need an extra flag since `#define FOO x` is not the same as `#define FOO() x` */
61 ppcondition *conditions;
65 #define ftepp_tokval(f) ((f)->lex->tok.value)
66 #define ftepp_ctx(f) ((f)->lex->tok.ctx)
68 static void ftepp_errorat(ftepp_t *ftepp, lex_ctx ctx, const char *fmt, ...)
75 con_vprintmsg(LVL_ERROR, ctx.file, ctx.line, "error", fmt, ap);
79 static void ftepp_error(ftepp_t *ftepp, const char *fmt, ...)
86 con_vprintmsg(LVL_ERROR, ftepp->lex->tok.ctx.file, ftepp->lex->tok.ctx.line, "error", fmt, ap);
90 pptoken *pptoken_make(ftepp_t *ftepp)
92 pptoken *token = (pptoken*)mem_a(sizeof(pptoken));
93 token->token = ftepp->token;
94 if (token->token == TOKEN_WHITE)
95 token->value = util_strdup(" ");
97 token->value = util_strdup(ftepp_tokval(ftepp));
98 memcpy(&token->constval, &ftepp->lex->tok.constval, sizeof(token->constval));
102 void pptoken_delete(pptoken *self)
108 ppmacro *ppmacro_new(lex_ctx ctx, const char *name)
110 ppmacro *macro = (ppmacro*)mem_a(sizeof(ppmacro));
111 memset(macro, 0, sizeof(*macro));
112 macro->name = util_strdup(name);
116 void ppmacro_delete(ppmacro *self)
119 for (i = 0; i < vec_size(self->params); ++i)
120 mem_d(self->params[i]);
121 vec_free(self->params);
122 for (i = 0; i < vec_size(self->output); ++i)
123 pptoken_delete(self->output[i]);
124 vec_free(self->output);
129 ftepp_t* ftepp_init()
133 ftepp = (ftepp_t*)mem_a(sizeof(*ftepp));
134 memset(ftepp, 0, sizeof(*ftepp));
139 void ftepp_delete(ftepp_t *self)
142 for (i = 0; i < vec_size(self->macros); ++i)
143 ppmacro_delete(self->macros[i]);
144 vec_free(self->macros);
145 vec_free(self->conditions);
146 lex_close(self->lex);
150 static void ftepp_out(ftepp_t *ftepp, const char *str, bool ignore_cond)
153 !vec_size(ftepp->conditions) ||
154 vec_last(ftepp->conditions).on)
160 ppmacro* ftepp_macro_find(ftepp_t *ftepp, const char *name)
163 for (i = 0; i < vec_size(ftepp->macros); ++i) {
164 if (!strcmp(name, ftepp->macros[i]->name))
165 return ftepp->macros[i];
170 static inline int ftepp_next(ftepp_t *ftepp)
172 return (ftepp->token = lex_do(ftepp->lex));
175 /* Important: this does not skip newlines! */
176 static bool ftepp_skipspace(ftepp_t *ftepp)
178 if (ftepp->token != TOKEN_WHITE)
180 while (ftepp_next(ftepp) == TOKEN_WHITE) {}
181 if (ftepp->token >= TOKEN_EOF) {
182 ftepp_error(ftepp, "unexpected end of preprocessor directive");
188 /* this one skips EOLs as well */
189 static bool ftepp_skipallwhite(ftepp_t *ftepp)
191 if (ftepp->token != TOKEN_WHITE && ftepp->token != TOKEN_EOL)
195 } while (ftepp->token == TOKEN_WHITE || ftepp->token == TOKEN_EOL);
196 if (ftepp->token >= TOKEN_EOF) {
197 ftepp_error(ftepp, "unexpected end of preprocessor directive");
204 * The huge macro parsing code...
206 static bool ftepp_define_params(ftepp_t *ftepp, ppmacro *macro)
210 if (!ftepp_skipspace(ftepp))
212 if (ftepp->token == ')')
214 switch (ftepp->token) {
220 ftepp_error(ftepp, "unexpected token in parameter list");
223 vec_push(macro->params, util_strdup(ftepp_tokval(ftepp)));
225 if (!ftepp_skipspace(ftepp))
227 } while (ftepp->token == ',');
228 if (ftepp->token != ')') {
229 ftepp_error(ftepp, "expected closing paren after macro parameter list");
233 /* skipspace happens in ftepp_define */
237 static bool ftepp_define_body(ftepp_t *ftepp, ppmacro *macro)
240 while (ftepp->token != TOKEN_EOL && ftepp->token < TOKEN_EOF) {
241 ptok = pptoken_make(ftepp);
242 vec_push(macro->output, ptok);
245 if (!ftepp_skipspace(ftepp))
248 if (ftepp->token != TOKEN_EOL) {
249 ftepp_error(ftepp, "unexpected junk after macro or unexpected end of file");
255 static bool ftepp_define(ftepp_t *ftepp)
258 (void)ftepp_next(ftepp);
259 if (!ftepp_skipspace(ftepp))
262 switch (ftepp->token) {
266 macro = ppmacro_new(ftepp_ctx(ftepp), ftepp_tokval(ftepp));
269 ftepp_error(ftepp, "expected macro name");
273 (void)ftepp_next(ftepp);
275 if (ftepp->token == '(') {
276 macro->has_params = true;
277 if (!ftepp_define_params(ftepp, macro))
281 if (!ftepp_skipspace(ftepp))
284 if (!ftepp_define_body(ftepp, macro))
287 vec_push(ftepp->macros, macro);
291 static bool ftepp_macro_call(ftepp_t *ftepp, ppmacro *macro)
296 if (!macro->has_params) {
297 for (o = 0; o < vec_size(macro->output); ++o) {
298 ftepp_out(ftepp, macro->output[o]->value, false);
303 if (!ftepp_skipallwhite(ftepp))
309 * When a macro is used we have to handle parameters as well
310 * as special-concatenation via ## or stringification via #
314 * #if - the FTEQCC way:
315 * defined(FOO) => true if FOO was #defined regardless of parameters or contents
316 * <numbers> => True if the number is not 0
317 * !<factor> => True if the factor yields false
318 * !!<factor> => ERROR on 2 or more unary nots
319 * <macro> => becomes the macro's FIRST token regardless of parameters
320 * <e> && <e> => True if both expressions are true
321 * <e> || <e> => True if either expression is true
323 * <ident> => False (remember for macros the <macro> rule applies instead)
324 * Unary + and - are weird and wrong in fteqcc so we don't allow them
325 * parenthesis in expressions are allowed
326 * parameter lists on macros are errors
327 * No mathematical calculations are executed
329 static bool ftepp_if_expr(ftepp_t *ftepp, bool *out)
334 if (!ftepp_skipspace(ftepp))
337 while (ftepp->token == '!') {
340 if (!ftepp_skipspace(ftepp))
344 switch (ftepp->token) {
348 if (!strcmp(ftepp_tokval(ftepp), "defined")) {
350 if (!ftepp_skipspace(ftepp))
352 if (ftepp->token != '(') {
353 ftepp_error(ftepp, "`defined` keyword in #if requires a macro name in parenthesis");
357 if (!ftepp_skipspace(ftepp))
359 if (ftepp->token != TOKEN_IDENT &&
360 ftepp->token != TOKEN_TYPENAME &&
361 ftepp->token != TOKEN_KEYWORD)
363 ftepp_error(ftepp, "defined() used on an unexpected token type");
366 macro = ftepp_macro_find(ftepp, ftepp_tokval(ftepp));
369 if (!ftepp_skipspace(ftepp))
371 if (ftepp->token != ')') {
372 ftepp_error(ftepp, "expected closing paren");
378 macro = ftepp_macro_find(ftepp, ftepp_tokval(ftepp));
379 if (!macro || !vec_size(macro->output)) {
382 /* This does not expand recursively! */
383 switch (macro->output[0]->token) {
385 *out = !!(macro->output[0]->constval.f);
387 case TOKEN_FLOATCONST:
388 *out = !!(macro->output[0]->constval.f);
396 case TOKEN_STRINGCONST:
400 *out = !!(ftepp->lex->tok.constval.i);
402 case TOKEN_FLOATCONST:
403 *out = !!(ftepp->lex->tok.constval.f);
408 if (!ftepp_if_expr(ftepp, out))
410 if (ftepp->token != ')') {
411 ftepp_error(ftepp, "expected closing paren in #if expression");
417 ftepp_error(ftepp, "junk in #if");
423 ftepp->lex->flags.noops = false;
425 if (!ftepp_skipspace(ftepp))
427 ftepp->lex->flags.noops = true;
429 if (ftepp->token == ')')
432 if (ftepp->token != TOKEN_OPERATOR)
435 if (!strcmp(ftepp_tokval(ftepp), "&&") ||
436 !strcmp(ftepp_tokval(ftepp), "||"))
439 char opc = ftepp_tokval(ftepp)[0];
442 if (!ftepp_if_expr(ftepp, &next))
452 ftepp_error(ftepp, "junk after #if");
457 static bool ftepp_if(ftepp_t *ftepp, ppcondition *cond)
461 memset(cond, 0, sizeof(*cond));
462 (void)ftepp_next(ftepp);
464 if (!ftepp_skipspace(ftepp))
466 if (ftepp->token == TOKEN_EOL) {
467 ftepp_error(ftepp, "expected expression for #if-directive");
471 if (!ftepp_if_expr(ftepp, &result))
479 * ifdef is rather simple
481 static bool ftepp_ifdef(ftepp_t *ftepp, ppcondition *cond)
484 memset(cond, 0, sizeof(*cond));
485 (void)ftepp_next(ftepp);
486 if (!ftepp_skipspace(ftepp))
489 switch (ftepp->token) {
493 macro = ftepp_macro_find(ftepp, ftepp_tokval(ftepp));
496 ftepp_error(ftepp, "expected macro name");
500 (void)ftepp_next(ftepp);
501 if (!ftepp_skipspace(ftepp))
503 if (ftepp->token != TOKEN_EOL) {
504 ftepp_error(ftepp, "stray tokens after #ifdef");
511 /* Basic structure handlers */
512 static bool ftepp_else_allowed(ftepp_t *ftepp)
514 if (!vec_size(ftepp->conditions)) {
515 ftepp_error(ftepp, "#else without #if");
518 if (vec_last(ftepp->conditions).had_else) {
519 ftepp_error(ftepp, "multiple #else for a single #if");
525 static bool ftepp_hash(ftepp_t *ftepp)
530 lex_ctx ctx = ftepp_ctx(ftepp);
532 if (!ftepp_skipspace(ftepp))
535 switch (ftepp->token) {
539 if (!strcmp(ftepp_tokval(ftepp), "define")) {
540 return ftepp_define(ftepp);
542 else if (!strcmp(ftepp_tokval(ftepp), "ifdef")) {
543 if (!ftepp_ifdef(ftepp, &cond))
545 cond.was_on = cond.on;
546 vec_push(ftepp->conditions, cond);
549 else if (!strcmp(ftepp_tokval(ftepp), "ifndef")) {
550 if (!ftepp_ifdef(ftepp, &cond))
553 cond.was_on = cond.on;
554 vec_push(ftepp->conditions, cond);
557 else if (!strcmp(ftepp_tokval(ftepp), "elifdef")) {
558 if (!ftepp_else_allowed(ftepp))
560 if (!ftepp_ifdef(ftepp, &cond))
562 pc = &vec_last(ftepp->conditions);
563 pc->on = !pc->was_on && cond.on;
564 pc->was_on = pc->was_on || pc->on;
567 else if (!strcmp(ftepp_tokval(ftepp), "elifndef")) {
568 if (!ftepp_else_allowed(ftepp))
570 if (!ftepp_ifdef(ftepp, &cond))
573 pc = &vec_last(ftepp->conditions);
574 pc->on = !pc->was_on && cond.on;
575 pc->was_on = pc->was_on || pc->on;
578 else if (!strcmp(ftepp_tokval(ftepp), "elif")) {
579 if (!ftepp_else_allowed(ftepp))
581 if (!ftepp_if(ftepp, &cond))
583 pc = &vec_last(ftepp->conditions);
584 pc->on = !pc->was_on && cond.on;
585 pc->was_on = pc->was_on || pc->on;
588 else if (!strcmp(ftepp_tokval(ftepp), "if")) {
589 if (!ftepp_if(ftepp, &cond))
591 cond.was_on = cond.on;
592 vec_push(ftepp->conditions, cond);
595 else if (!strcmp(ftepp_tokval(ftepp), "else")) {
596 if (!ftepp_else_allowed(ftepp))
598 pc = &vec_last(ftepp->conditions);
599 pc->on = !pc->was_on;
604 else if (!strcmp(ftepp_tokval(ftepp), "endif")) {
605 if (!vec_size(ftepp->conditions)) {
606 ftepp_error(ftepp, "#endif without #if");
609 vec_pop(ftepp->conditions);
614 ftepp_error(ftepp, "unrecognized preprocessor directive: `%s`", ftepp_tokval(ftepp));
619 ftepp_error(ftepp, "unexpected preprocessor token: `%s`", ftepp_tokval(ftepp));
622 ftepp_errorat(ftepp, ctx, "empty preprocessor directive");
625 ftepp_error(ftepp, "missing newline at end of file", ftepp_tokval(ftepp));
628 if (!ftepp_skipspace(ftepp))
633 static bool ftepp_preprocess(ftepp_t *ftepp)
638 ftepp->lex->flags.preprocessing = true;
639 ftepp->lex->flags.mergelines = false;
640 ftepp->lex->flags.noops = true;
645 if (ftepp->token >= TOKEN_EOF)
648 ftepp->newline = newline;
651 switch (ftepp->token) {
655 macro = ftepp_macro_find(ftepp, ftepp_tokval(ftepp));
657 ftepp_out(ftepp, ftepp_tokval(ftepp), false);
661 if (!ftepp_macro_call(ftepp, macro))
662 ftepp->token = TOKEN_ERROR;
665 if (!ftepp->newline) {
666 ftepp_out(ftepp, ftepp_tokval(ftepp), false);
670 ftepp->lex->flags.mergelines = true;
671 if (ftepp_next(ftepp) >= TOKEN_EOF) {
672 ftepp_error(ftepp, "error in preprocessor directive");
673 ftepp->token = TOKEN_ERROR;
676 if (!ftepp_hash(ftepp))
677 ftepp->token = TOKEN_ERROR;
678 ftepp->lex->flags.mergelines = false;
682 ftepp_out(ftepp, "\n", true);
686 ftepp_out(ftepp, ftepp_tokval(ftepp), false);
690 } while (!ftepp->errors && ftepp->token < TOKEN_EOF);
692 newline = ftepp->token == TOKEN_EOF;
697 bool ftepp_preprocess_file(const char *filename)
699 ftepp_t *ftepp = ftepp_init();
700 ftepp->lex = lex_open(filename);
702 con_out("failed to open file \"%s\"\n", filename);
705 return ftepp_preprocess(ftepp);
708 bool ftepp_preprocess_string(const char *name, const char *str)
710 ftepp_t *ftepp = ftepp_init();
711 ftepp->lex = lex_open_string(str, strlen(str), name);
713 con_out("failed to create lexer for string \"%s\"\n", name);
716 return ftepp_preprocess(ftepp);