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` */
62 ppcondition *conditions;
69 #define ftepp_tokval(f) ((f)->lex->tok.value)
70 #define ftepp_ctx(f) ((f)->lex->tok.ctx)
72 static void ftepp_errorat(ftepp_t *ftepp, lex_ctx ctx, const char *fmt, ...)
79 con_vprintmsg(LVL_ERROR, ctx.file, ctx.line, "error", fmt, ap);
83 static void ftepp_error(ftepp_t *ftepp, const char *fmt, ...)
90 con_vprintmsg(LVL_ERROR, ftepp->lex->tok.ctx.file, ftepp->lex->tok.ctx.line, "error", fmt, ap);
94 static pptoken *pptoken_make(ftepp_t *ftepp)
96 pptoken *token = (pptoken*)mem_a(sizeof(pptoken));
97 token->token = ftepp->token;
98 if (token->token == TOKEN_WHITE)
99 token->value = util_strdup(" ");
101 token->value = util_strdup(ftepp_tokval(ftepp));
102 memcpy(&token->constval, &ftepp->lex->tok.constval, sizeof(token->constval));
106 static void pptoken_delete(pptoken *self)
112 static ppmacro *ppmacro_new(lex_ctx ctx, const char *name)
114 ppmacro *macro = (ppmacro*)mem_a(sizeof(ppmacro));
115 memset(macro, 0, sizeof(*macro));
116 macro->name = util_strdup(name);
120 static void ppmacro_delete(ppmacro *self)
123 for (i = 0; i < vec_size(self->params); ++i)
124 mem_d(self->params[i]);
125 vec_free(self->params);
126 for (i = 0; i < vec_size(self->output); ++i)
127 pptoken_delete(self->output[i]);
128 vec_free(self->output);
133 static ftepp_t* ftepp_init()
137 ftepp = (ftepp_t*)mem_a(sizeof(*ftepp));
138 memset(ftepp, 0, sizeof(*ftepp));
140 ftepp->output_on = true;
145 static void ftepp_delete(ftepp_t *self)
148 for (i = 0; i < vec_size(self->macros); ++i)
149 ppmacro_delete(self->macros[i]);
150 vec_free(self->macros);
151 vec_free(self->conditions);
152 lex_close(self->lex);
156 static void ftepp_out(ftepp_t *ftepp, const char *str, bool ignore_cond)
158 if (ignore_cond || ftepp->output_on)
162 if (!ftepp->output_string) {
167 data = vec_add(ftepp->output, len);
168 memcpy(data, str, len);
172 static void ftepp_update_output_condition(ftepp_t *ftepp)
175 ftepp->output_on = true;
176 for (i = 0; i < vec_size(ftepp->conditions); ++i)
177 ftepp->output_on = ftepp->output_on && ftepp->conditions[i].on;
180 static ppmacro* ftepp_macro_find(ftepp_t *ftepp, const char *name)
183 for (i = 0; i < vec_size(ftepp->macros); ++i) {
184 if (!strcmp(name, ftepp->macros[i]->name))
185 return ftepp->macros[i];
190 static inline int ftepp_next(ftepp_t *ftepp)
192 return (ftepp->token = lex_do(ftepp->lex));
195 /* Important: this does not skip newlines! */
196 static bool ftepp_skipspace(ftepp_t *ftepp)
198 if (ftepp->token != TOKEN_WHITE)
200 while (ftepp_next(ftepp) == TOKEN_WHITE) {}
201 if (ftepp->token >= TOKEN_EOF) {
202 ftepp_error(ftepp, "unexpected end of preprocessor directive");
208 /* this one skips EOLs as well */
209 static bool ftepp_skipallwhite(ftepp_t *ftepp)
211 if (ftepp->token != TOKEN_WHITE && ftepp->token != TOKEN_EOL)
215 } while (ftepp->token == TOKEN_WHITE || ftepp->token == TOKEN_EOL);
216 if (ftepp->token >= TOKEN_EOF) {
217 ftepp_error(ftepp, "unexpected end of preprocessor directive");
224 * The huge macro parsing code...
226 static bool ftepp_define_params(ftepp_t *ftepp, ppmacro *macro)
230 if (!ftepp_skipspace(ftepp))
232 if (ftepp->token == ')')
234 switch (ftepp->token) {
240 ftepp_error(ftepp, "unexpected token in parameter list");
243 vec_push(macro->params, util_strdup(ftepp_tokval(ftepp)));
245 if (!ftepp_skipspace(ftepp))
247 } while (ftepp->token == ',');
248 if (ftepp->token != ')') {
249 ftepp_error(ftepp, "expected closing paren after macro parameter list");
253 /* skipspace happens in ftepp_define */
257 static bool ftepp_define_body(ftepp_t *ftepp, ppmacro *macro)
260 while (ftepp->token != TOKEN_EOL && ftepp->token < TOKEN_EOF) {
261 ptok = pptoken_make(ftepp);
262 vec_push(macro->output, ptok);
265 if (ftepp->token != TOKEN_EOL) {
266 ftepp_error(ftepp, "unexpected junk after macro or unexpected end of file");
272 static bool ftepp_define(ftepp_t *ftepp)
275 (void)ftepp_next(ftepp);
276 if (!ftepp_skipspace(ftepp))
279 switch (ftepp->token) {
283 macro = ppmacro_new(ftepp_ctx(ftepp), ftepp_tokval(ftepp));
286 ftepp_error(ftepp, "expected macro name");
290 (void)ftepp_next(ftepp);
292 if (ftepp->token == '(') {
293 macro->has_params = true;
294 if (!ftepp_define_params(ftepp, macro))
298 if (!ftepp_skipspace(ftepp))
301 if (!ftepp_define_body(ftepp, macro))
304 vec_push(ftepp->macros, macro);
309 * When a macro is used we have to handle parameters as well
310 * as special-concatenation via ## or stringification via #
312 * Note: parenthesis can nest, so FOO((a),b) is valid, but only
313 * this kind of parens. Curly braces or [] don't count towards the
320 static void macroparam_clean(macroparam *self)
323 for (i = 0; i < vec_size(self->tokens); ++i)
324 pptoken_delete(self->tokens[i]);
325 vec_free(self->tokens);
328 static bool ftepp_macro_call_params(ftepp_t *ftepp, macroparam **out_params)
330 macroparam *params = NULL;
336 if (!ftepp_skipallwhite(ftepp))
338 while (ftepp->token != ')') {
340 if (!ftepp_skipallwhite(ftepp))
342 while (parens || ftepp->token != ',') {
343 if (ftepp->token == '(')
345 else if (ftepp->token == ')') {
350 ptok = pptoken_make(ftepp);
351 vec_push(mp.tokens, ptok);
352 if (ftepp_next(ftepp) >= TOKEN_EOF) {
353 ftepp_error(ftepp, "unexpected EOF in macro call");
357 vec_push(params, mp);
359 if (ftepp->token == ')')
361 if (ftepp->token != ',') {
362 ftepp_error(ftepp, "expected closing paren or comma in macro call");
365 if (ftepp_next(ftepp) >= TOKEN_EOF) {
366 ftepp_error(ftepp, "unexpected EOF in macro call");
370 if (ftepp_next(ftepp) >= TOKEN_EOF) {
371 ftepp_error(ftepp, "unexpected EOF in macro call");
374 *out_params = params;
379 macroparam_clean(&mp);
380 for (i = 0; i < vec_size(params); ++i)
381 macroparam_clean(¶ms[i]);
386 static bool macro_params_find(ppmacro *macro, const char *name, size_t *idx)
389 for (i = 0; i < vec_size(macro->params); ++i) {
390 if (!strcmp(macro->params[i], name)) {
398 static bool ftepp_macro_expand(ftepp_t *ftepp, ppmacro *macro, macroparam *params)
400 char *old_string = ftepp->output;
401 bool old_string_flag = ftepp->output_string;
407 if (!vec_size(macro->output))
410 ftepp->output = NULL;
411 ftepp->output_string = true;
412 for (o = 0; o < vec_size(macro->output); ++o) {
413 pptoken *out = macro->output[o];
414 switch (out->token) {
418 if (!macro_params_find(macro, out->value, &pi)) {
419 ftepp_out(ftepp, out->value, false);
422 for (pv = 0; pv < vec_size(params[pi].tokens); ++pv) {
423 out = params[pi].tokens[pv];
424 if (out->token == TOKEN_EOL)
425 ftepp_out(ftepp, "\n", false);
427 ftepp_out(ftepp, out->value, false);
432 ftepp_out(ftepp, "\n", false);
435 ftepp_out(ftepp, out->value, false);
439 vec_push(ftepp->output, 0);
440 printf("_________________\n%s\n=================\n", ftepp->output);
444 ftepp->output = old_string;
445 ftepp->output_string = old_string_flag;
449 static bool ftepp_macro_call(ftepp_t *ftepp, ppmacro *macro)
452 macroparam *params = NULL;
457 if (!macro->has_params) {
458 for (o = 0; o < vec_size(macro->output); ++o) {
459 ftepp_out(ftepp, macro->output[o]->value, false);
464 if (!ftepp_skipallwhite(ftepp))
467 if (ftepp->token != '(') {
468 ftepp_error(ftepp, "expected macro parameters in parenthesis");
473 if (!ftepp_macro_call_params(ftepp, ¶ms))
476 if (vec_size(params) != vec_size(macro->params)) {
477 ftepp_error(ftepp, "macro %s expects %u paramteters, %u provided", macro->name,
478 (unsigned int)vec_size(macro->params),
479 (unsigned int)vec_size(params));
484 if (!ftepp_macro_expand(ftepp, macro, params))
488 for (o = 0; o < vec_size(params); ++o)
489 macroparam_clean(¶ms[o]);
495 * #if - the FTEQCC way:
496 * defined(FOO) => true if FOO was #defined regardless of parameters or contents
497 * <numbers> => True if the number is not 0
498 * !<factor> => True if the factor yields false
499 * !!<factor> => ERROR on 2 or more unary nots
500 * <macro> => becomes the macro's FIRST token regardless of parameters
501 * <e> && <e> => True if both expressions are true
502 * <e> || <e> => True if either expression is true
504 * <ident> => False (remember for macros the <macro> rule applies instead)
505 * Unary + and - are weird and wrong in fteqcc so we don't allow them
506 * parenthesis in expressions are allowed
507 * parameter lists on macros are errors
508 * No mathematical calculations are executed
510 static bool ftepp_if_expr(ftepp_t *ftepp, bool *out)
515 if (!ftepp_skipspace(ftepp))
518 while (ftepp->token == '!') {
521 if (!ftepp_skipspace(ftepp))
525 switch (ftepp->token) {
529 if (!strcmp(ftepp_tokval(ftepp), "defined")) {
531 if (!ftepp_skipspace(ftepp))
533 if (ftepp->token != '(') {
534 ftepp_error(ftepp, "`defined` keyword in #if requires a macro name in parenthesis");
538 if (!ftepp_skipspace(ftepp))
540 if (ftepp->token != TOKEN_IDENT &&
541 ftepp->token != TOKEN_TYPENAME &&
542 ftepp->token != TOKEN_KEYWORD)
544 ftepp_error(ftepp, "defined() used on an unexpected token type");
547 macro = ftepp_macro_find(ftepp, ftepp_tokval(ftepp));
550 if (!ftepp_skipspace(ftepp))
552 if (ftepp->token != ')') {
553 ftepp_error(ftepp, "expected closing paren");
559 macro = ftepp_macro_find(ftepp, ftepp_tokval(ftepp));
560 if (!macro || !vec_size(macro->output)) {
563 /* This does not expand recursively! */
564 switch (macro->output[0]->token) {
566 *out = !!(macro->output[0]->constval.f);
568 case TOKEN_FLOATCONST:
569 *out = !!(macro->output[0]->constval.f);
577 case TOKEN_STRINGCONST:
581 *out = !!(ftepp->lex->tok.constval.i);
583 case TOKEN_FLOATCONST:
584 *out = !!(ftepp->lex->tok.constval.f);
589 if (!ftepp_if_expr(ftepp, out))
591 if (ftepp->token != ')') {
592 ftepp_error(ftepp, "expected closing paren in #if expression");
598 ftepp_error(ftepp, "junk in #if");
604 ftepp->lex->flags.noops = false;
606 if (!ftepp_skipspace(ftepp))
608 ftepp->lex->flags.noops = true;
610 if (ftepp->token == ')')
613 if (ftepp->token != TOKEN_OPERATOR)
616 if (!strcmp(ftepp_tokval(ftepp), "&&") ||
617 !strcmp(ftepp_tokval(ftepp), "||"))
620 char opc = ftepp_tokval(ftepp)[0];
623 if (!ftepp_if_expr(ftepp, &next))
633 ftepp_error(ftepp, "junk after #if");
638 static bool ftepp_if(ftepp_t *ftepp, ppcondition *cond)
642 memset(cond, 0, sizeof(*cond));
643 (void)ftepp_next(ftepp);
645 if (!ftepp_skipspace(ftepp))
647 if (ftepp->token == TOKEN_EOL) {
648 ftepp_error(ftepp, "expected expression for #if-directive");
652 if (!ftepp_if_expr(ftepp, &result))
660 * ifdef is rather simple
662 static bool ftepp_ifdef(ftepp_t *ftepp, ppcondition *cond)
665 memset(cond, 0, sizeof(*cond));
666 (void)ftepp_next(ftepp);
667 if (!ftepp_skipspace(ftepp))
670 switch (ftepp->token) {
674 macro = ftepp_macro_find(ftepp, ftepp_tokval(ftepp));
677 ftepp_error(ftepp, "expected macro name");
681 (void)ftepp_next(ftepp);
682 if (!ftepp_skipspace(ftepp))
684 if (ftepp->token != TOKEN_EOL) {
685 ftepp_error(ftepp, "stray tokens after #ifdef");
692 /* Basic structure handlers */
693 static bool ftepp_else_allowed(ftepp_t *ftepp)
695 if (!vec_size(ftepp->conditions)) {
696 ftepp_error(ftepp, "#else without #if");
699 if (vec_last(ftepp->conditions).had_else) {
700 ftepp_error(ftepp, "multiple #else for a single #if");
706 static bool ftepp_hash(ftepp_t *ftepp)
711 lex_ctx ctx = ftepp_ctx(ftepp);
713 if (!ftepp_skipspace(ftepp))
716 switch (ftepp->token) {
720 if (!strcmp(ftepp_tokval(ftepp), "define")) {
721 return ftepp_define(ftepp);
723 else if (!strcmp(ftepp_tokval(ftepp), "ifdef")) {
724 if (!ftepp_ifdef(ftepp, &cond))
726 cond.was_on = cond.on;
727 vec_push(ftepp->conditions, cond);
728 ftepp->output_on = ftepp->output_on && cond.on;
731 else if (!strcmp(ftepp_tokval(ftepp), "ifndef")) {
732 if (!ftepp_ifdef(ftepp, &cond))
735 cond.was_on = cond.on;
736 vec_push(ftepp->conditions, cond);
737 ftepp->output_on = ftepp->output_on && cond.on;
740 else if (!strcmp(ftepp_tokval(ftepp), "elifdef")) {
741 if (!ftepp_else_allowed(ftepp))
743 if (!ftepp_ifdef(ftepp, &cond))
745 pc = &vec_last(ftepp->conditions);
746 pc->on = !pc->was_on && cond.on;
747 pc->was_on = pc->was_on || pc->on;
748 ftepp_update_output_condition(ftepp);
751 else if (!strcmp(ftepp_tokval(ftepp), "elifndef")) {
752 if (!ftepp_else_allowed(ftepp))
754 if (!ftepp_ifdef(ftepp, &cond))
757 pc = &vec_last(ftepp->conditions);
758 pc->on = !pc->was_on && cond.on;
759 pc->was_on = pc->was_on || pc->on;
760 ftepp_update_output_condition(ftepp);
763 else if (!strcmp(ftepp_tokval(ftepp), "elif")) {
764 if (!ftepp_else_allowed(ftepp))
766 if (!ftepp_if(ftepp, &cond))
768 pc = &vec_last(ftepp->conditions);
769 pc->on = !pc->was_on && cond.on;
770 pc->was_on = pc->was_on || pc->on;
771 ftepp_update_output_condition(ftepp);
774 else if (!strcmp(ftepp_tokval(ftepp), "if")) {
775 if (!ftepp_if(ftepp, &cond))
777 cond.was_on = cond.on;
778 vec_push(ftepp->conditions, cond);
779 ftepp->output_on = ftepp->output_on && cond.on;
782 else if (!strcmp(ftepp_tokval(ftepp), "else")) {
783 if (!ftepp_else_allowed(ftepp))
785 pc = &vec_last(ftepp->conditions);
786 pc->on = !pc->was_on;
789 ftepp_update_output_condition(ftepp);
792 else if (!strcmp(ftepp_tokval(ftepp), "endif")) {
793 if (!vec_size(ftepp->conditions)) {
794 ftepp_error(ftepp, "#endif without #if");
797 vec_pop(ftepp->conditions);
799 ftepp_update_output_condition(ftepp);
803 ftepp_error(ftepp, "unrecognized preprocessor directive: `%s`", ftepp_tokval(ftepp));
808 ftepp_error(ftepp, "unexpected preprocessor token: `%s`", ftepp_tokval(ftepp));
811 ftepp_errorat(ftepp, ctx, "empty preprocessor directive");
814 ftepp_error(ftepp, "missing newline at end of file", ftepp_tokval(ftepp));
817 /* Builtins! Don't forget the builtins! */
819 case TOKEN_FLOATCONST:
820 ftepp_out(ftepp, "#", false);
823 if (!ftepp_skipspace(ftepp))
828 static bool ftepp_preprocess(ftepp_t *ftepp)
833 ftepp->lex->flags.preprocessing = true;
834 ftepp->lex->flags.mergelines = false;
835 ftepp->lex->flags.noops = true;
840 if (ftepp->token >= TOKEN_EOF)
843 ftepp->newline = newline;
846 /* For the sake of FTE compatibility... FU, really */
847 ftepp->newline = newline = true;
850 switch (ftepp->token) {
854 macro = ftepp_macro_find(ftepp, ftepp_tokval(ftepp));
856 ftepp_out(ftepp, ftepp_tokval(ftepp), false);
860 if (!ftepp_macro_call(ftepp, macro))
861 ftepp->token = TOKEN_ERROR;
864 if (!ftepp->newline) {
865 ftepp_out(ftepp, ftepp_tokval(ftepp), false);
869 ftepp->lex->flags.mergelines = true;
870 if (ftepp_next(ftepp) >= TOKEN_EOF) {
871 ftepp_error(ftepp, "error in preprocessor directive");
872 ftepp->token = TOKEN_ERROR;
875 if (!ftepp_hash(ftepp))
876 ftepp->token = TOKEN_ERROR;
877 ftepp->lex->flags.mergelines = false;
881 ftepp_out(ftepp, "\n", true);
885 ftepp_out(ftepp, ftepp_tokval(ftepp), false);
889 } while (!ftepp->errors && ftepp->token < TOKEN_EOF);
891 newline = ftepp->token == TOKEN_EOF;
895 bool ftepp_preprocess_file(const char *filename)
897 ftepp_t *ftepp = ftepp_init();
898 ftepp->lex = lex_open(filename);
900 con_out("failed to open file \"%s\"\n", filename);
903 if (!ftepp_preprocess(ftepp)) {
911 bool ftepp_preprocess_string(const char *name, const char *str)
913 ftepp_t *ftepp = ftepp_init();
914 ftepp->lex = lex_open_string(str, strlen(str), name);
916 con_out("failed to create lexer for string \"%s\"\n", name);
919 if (!ftepp_preprocess(ftepp)) {