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 /* need to leave the last token up */
329 static bool ftepp_macro_call_params(ftepp_t *ftepp, macroparam **out_params)
331 macroparam *params = NULL;
337 if (!ftepp_skipallwhite(ftepp))
339 while (ftepp->token != ')') {
341 if (!ftepp_skipallwhite(ftepp))
343 while (parens || ftepp->token != ',') {
344 if (ftepp->token == '(')
346 else if (ftepp->token == ')') {
351 ptok = pptoken_make(ftepp);
352 vec_push(mp.tokens, ptok);
353 if (ftepp_next(ftepp) >= TOKEN_EOF) {
354 ftepp_error(ftepp, "unexpected EOF in macro call");
358 vec_push(params, mp);
360 if (ftepp->token == ')')
362 if (ftepp->token != ',') {
363 ftepp_error(ftepp, "expected closing paren or comma in macro call");
366 if (ftepp_next(ftepp) >= TOKEN_EOF) {
367 ftepp_error(ftepp, "unexpected EOF in macro call");
371 /* need to leave that up
372 if (ftepp_next(ftepp) >= TOKEN_EOF) {
373 ftepp_error(ftepp, "unexpected EOF in macro call");
377 *out_params = params;
382 macroparam_clean(&mp);
383 for (i = 0; i < vec_size(params); ++i)
384 macroparam_clean(¶ms[i]);
389 static bool macro_params_find(ppmacro *macro, const char *name, size_t *idx)
392 for (i = 0; i < vec_size(macro->params); ++i) {
393 if (!strcmp(macro->params[i], name)) {
401 static bool ftepp_preprocess(ftepp_t *ftepp);
402 static bool ftepp_macro_expand(ftepp_t *ftepp, ppmacro *macro, macroparam *params)
404 char *old_string = ftepp->output;
405 bool old_string_flag = ftepp->output_string;
406 lex_file *old_lexer = ftepp->lex;
413 if (!vec_size(macro->output))
416 ftepp->output = NULL;
417 ftepp->output_string = true;
418 for (o = 0; o < vec_size(macro->output); ++o) {
419 pptoken *out = macro->output[o];
420 switch (out->token) {
424 if (!macro_params_find(macro, out->value, &pi)) {
425 ftepp_out(ftepp, out->value, false);
428 for (pv = 0; pv < vec_size(params[pi].tokens); ++pv) {
429 out = params[pi].tokens[pv];
430 if (out->token == TOKEN_EOL)
431 ftepp_out(ftepp, "\n", false);
433 ftepp_out(ftepp, out->value, false);
438 ftepp_out(ftepp, "\n", false);
441 ftepp_out(ftepp, out->value, false);
445 vec_push(ftepp->output, 0);
446 /* Now run the preprocessor recursively on this string buffer */
447 printf("__________\n%s\n=========\n", ftepp->output);
448 inlex = lex_open_string(ftepp->output, vec_size(ftepp->output)-1, ftepp->lex->name);
450 ftepp_error(ftepp, "internal error: failed to instantiate lexer");
454 ftepp->output = old_string;
455 ftepp->output_string = old_string_flag;
457 if (!ftepp_preprocess(ftepp)) {
463 ftepp->lex = old_lexer;
464 ftepp->output = old_string;
465 ftepp->output_string = old_string_flag;
469 static bool ftepp_macro_call(ftepp_t *ftepp, ppmacro *macro)
472 macroparam *params = NULL;
475 if (!macro->has_params) {
476 if (!ftepp_macro_expand(ftepp, macro, NULL))
483 if (!ftepp_skipallwhite(ftepp))
486 if (ftepp->token != '(') {
487 ftepp_error(ftepp, "expected macro parameters in parenthesis");
492 if (!ftepp_macro_call_params(ftepp, ¶ms))
495 if (vec_size(params) != vec_size(macro->params)) {
496 ftepp_error(ftepp, "macro %s expects %u paramteters, %u provided", macro->name,
497 (unsigned int)vec_size(macro->params),
498 (unsigned int)vec_size(params));
503 if (!ftepp_macro_expand(ftepp, macro, params))
508 for (o = 0; o < vec_size(params); ++o)
509 macroparam_clean(¶ms[o]);
515 * #if - the FTEQCC way:
516 * defined(FOO) => true if FOO was #defined regardless of parameters or contents
517 * <numbers> => True if the number is not 0
518 * !<factor> => True if the factor yields false
519 * !!<factor> => ERROR on 2 or more unary nots
520 * <macro> => becomes the macro's FIRST token regardless of parameters
521 * <e> && <e> => True if both expressions are true
522 * <e> || <e> => True if either expression is true
524 * <ident> => False (remember for macros the <macro> rule applies instead)
525 * Unary + and - are weird and wrong in fteqcc so we don't allow them
526 * parenthesis in expressions are allowed
527 * parameter lists on macros are errors
528 * No mathematical calculations are executed
530 static bool ftepp_if_expr(ftepp_t *ftepp, bool *out)
535 if (!ftepp_skipspace(ftepp))
538 while (ftepp->token == '!') {
541 if (!ftepp_skipspace(ftepp))
545 switch (ftepp->token) {
549 if (!strcmp(ftepp_tokval(ftepp), "defined")) {
551 if (!ftepp_skipspace(ftepp))
553 if (ftepp->token != '(') {
554 ftepp_error(ftepp, "`defined` keyword in #if requires a macro name in parenthesis");
558 if (!ftepp_skipspace(ftepp))
560 if (ftepp->token != TOKEN_IDENT &&
561 ftepp->token != TOKEN_TYPENAME &&
562 ftepp->token != TOKEN_KEYWORD)
564 ftepp_error(ftepp, "defined() used on an unexpected token type");
567 macro = ftepp_macro_find(ftepp, ftepp_tokval(ftepp));
570 if (!ftepp_skipspace(ftepp))
572 if (ftepp->token != ')') {
573 ftepp_error(ftepp, "expected closing paren");
579 macro = ftepp_macro_find(ftepp, ftepp_tokval(ftepp));
580 if (!macro || !vec_size(macro->output)) {
583 /* This does not expand recursively! */
584 switch (macro->output[0]->token) {
586 *out = !!(macro->output[0]->constval.f);
588 case TOKEN_FLOATCONST:
589 *out = !!(macro->output[0]->constval.f);
597 case TOKEN_STRINGCONST:
601 *out = !!(ftepp->lex->tok.constval.i);
603 case TOKEN_FLOATCONST:
604 *out = !!(ftepp->lex->tok.constval.f);
609 if (!ftepp_if_expr(ftepp, out))
611 if (ftepp->token != ')') {
612 ftepp_error(ftepp, "expected closing paren in #if expression");
618 ftepp_error(ftepp, "junk in #if");
624 ftepp->lex->flags.noops = false;
626 if (!ftepp_skipspace(ftepp))
628 ftepp->lex->flags.noops = true;
630 if (ftepp->token == ')')
633 if (ftepp->token != TOKEN_OPERATOR)
636 if (!strcmp(ftepp_tokval(ftepp), "&&") ||
637 !strcmp(ftepp_tokval(ftepp), "||"))
640 char opc = ftepp_tokval(ftepp)[0];
643 if (!ftepp_if_expr(ftepp, &next))
653 ftepp_error(ftepp, "junk after #if");
658 static bool ftepp_if(ftepp_t *ftepp, ppcondition *cond)
662 memset(cond, 0, sizeof(*cond));
663 (void)ftepp_next(ftepp);
665 if (!ftepp_skipspace(ftepp))
667 if (ftepp->token == TOKEN_EOL) {
668 ftepp_error(ftepp, "expected expression for #if-directive");
672 if (!ftepp_if_expr(ftepp, &result))
680 * ifdef is rather simple
682 static bool ftepp_ifdef(ftepp_t *ftepp, ppcondition *cond)
685 memset(cond, 0, sizeof(*cond));
686 (void)ftepp_next(ftepp);
687 if (!ftepp_skipspace(ftepp))
690 switch (ftepp->token) {
694 macro = ftepp_macro_find(ftepp, ftepp_tokval(ftepp));
697 ftepp_error(ftepp, "expected macro name");
701 (void)ftepp_next(ftepp);
702 if (!ftepp_skipspace(ftepp))
704 if (ftepp->token != TOKEN_EOL) {
705 ftepp_error(ftepp, "stray tokens after #ifdef");
712 /* Basic structure handlers */
713 static bool ftepp_else_allowed(ftepp_t *ftepp)
715 if (!vec_size(ftepp->conditions)) {
716 ftepp_error(ftepp, "#else without #if");
719 if (vec_last(ftepp->conditions).had_else) {
720 ftepp_error(ftepp, "multiple #else for a single #if");
726 static bool ftepp_hash(ftepp_t *ftepp)
731 lex_ctx ctx = ftepp_ctx(ftepp);
733 if (!ftepp_skipspace(ftepp))
736 switch (ftepp->token) {
740 if (!strcmp(ftepp_tokval(ftepp), "define")) {
741 return ftepp_define(ftepp);
743 else if (!strcmp(ftepp_tokval(ftepp), "ifdef")) {
744 if (!ftepp_ifdef(ftepp, &cond))
746 cond.was_on = cond.on;
747 vec_push(ftepp->conditions, cond);
748 ftepp->output_on = ftepp->output_on && cond.on;
751 else if (!strcmp(ftepp_tokval(ftepp), "ifndef")) {
752 if (!ftepp_ifdef(ftepp, &cond))
755 cond.was_on = cond.on;
756 vec_push(ftepp->conditions, cond);
757 ftepp->output_on = ftepp->output_on && cond.on;
760 else if (!strcmp(ftepp_tokval(ftepp), "elifdef")) {
761 if (!ftepp_else_allowed(ftepp))
763 if (!ftepp_ifdef(ftepp, &cond))
765 pc = &vec_last(ftepp->conditions);
766 pc->on = !pc->was_on && cond.on;
767 pc->was_on = pc->was_on || pc->on;
768 ftepp_update_output_condition(ftepp);
771 else if (!strcmp(ftepp_tokval(ftepp), "elifndef")) {
772 if (!ftepp_else_allowed(ftepp))
774 if (!ftepp_ifdef(ftepp, &cond))
777 pc = &vec_last(ftepp->conditions);
778 pc->on = !pc->was_on && cond.on;
779 pc->was_on = pc->was_on || pc->on;
780 ftepp_update_output_condition(ftepp);
783 else if (!strcmp(ftepp_tokval(ftepp), "elif")) {
784 if (!ftepp_else_allowed(ftepp))
786 if (!ftepp_if(ftepp, &cond))
788 pc = &vec_last(ftepp->conditions);
789 pc->on = !pc->was_on && cond.on;
790 pc->was_on = pc->was_on || pc->on;
791 ftepp_update_output_condition(ftepp);
794 else if (!strcmp(ftepp_tokval(ftepp), "if")) {
795 if (!ftepp_if(ftepp, &cond))
797 cond.was_on = cond.on;
798 vec_push(ftepp->conditions, cond);
799 ftepp->output_on = ftepp->output_on && cond.on;
802 else if (!strcmp(ftepp_tokval(ftepp), "else")) {
803 if (!ftepp_else_allowed(ftepp))
805 pc = &vec_last(ftepp->conditions);
806 pc->on = !pc->was_on;
809 ftepp_update_output_condition(ftepp);
812 else if (!strcmp(ftepp_tokval(ftepp), "endif")) {
813 if (!vec_size(ftepp->conditions)) {
814 ftepp_error(ftepp, "#endif without #if");
817 vec_pop(ftepp->conditions);
819 ftepp_update_output_condition(ftepp);
823 ftepp_error(ftepp, "unrecognized preprocessor directive: `%s`", ftepp_tokval(ftepp));
828 ftepp_error(ftepp, "unexpected preprocessor token: `%s`", ftepp_tokval(ftepp));
831 ftepp_errorat(ftepp, ctx, "empty preprocessor directive");
834 ftepp_error(ftepp, "missing newline at end of file", ftepp_tokval(ftepp));
837 /* Builtins! Don't forget the builtins! */
839 case TOKEN_FLOATCONST:
840 ftepp_out(ftepp, "#", false);
843 if (!ftepp_skipspace(ftepp))
848 static bool ftepp_preprocess(ftepp_t *ftepp)
853 ftepp->lex->flags.preprocessing = true;
854 ftepp->lex->flags.mergelines = false;
855 ftepp->lex->flags.noops = true;
860 if (ftepp->token >= TOKEN_EOF)
863 ftepp->newline = newline;
866 /* For the sake of FTE compatibility... FU, really */
867 ftepp->newline = newline = true;
870 switch (ftepp->token) {
874 macro = ftepp_macro_find(ftepp, ftepp_tokval(ftepp));
876 ftepp_out(ftepp, ftepp_tokval(ftepp), false);
880 if (!ftepp_macro_call(ftepp, macro))
881 ftepp->token = TOKEN_ERROR;
884 if (!ftepp->newline) {
885 ftepp_out(ftepp, ftepp_tokval(ftepp), false);
889 ftepp->lex->flags.mergelines = true;
890 if (ftepp_next(ftepp) >= TOKEN_EOF) {
891 ftepp_error(ftepp, "error in preprocessor directive");
892 ftepp->token = TOKEN_ERROR;
895 if (!ftepp_hash(ftepp))
896 ftepp->token = TOKEN_ERROR;
897 ftepp->lex->flags.mergelines = false;
901 ftepp_out(ftepp, "\n", true);
905 ftepp_out(ftepp, ftepp_tokval(ftepp), false);
909 } while (!ftepp->errors && ftepp->token < TOKEN_EOF);
911 newline = ftepp->token == TOKEN_EOF;
915 bool ftepp_preprocess_file(const char *filename)
917 ftepp_t *ftepp = ftepp_init();
918 ftepp->lex = lex_open(filename);
920 con_out("failed to open file \"%s\"\n", filename);
923 if (!ftepp_preprocess(ftepp)) {
931 bool ftepp_preprocess_string(const char *name, const char *str)
933 ftepp_t *ftepp = ftepp_init();
934 ftepp->lex = lex_open_string(str, strlen(str), name);
936 con_out("failed to create lexer for string \"%s\"\n", name);
939 if (!ftepp_preprocess(ftepp)) {