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 while (ftepp->token != ')') {
338 while (parens || ftepp->token != ',') {
339 if (ftepp->token == '(')
341 else if (ftepp->token == ')') {
346 ptok = pptoken_make(ftepp);
347 vec_push(mp.tokens, ptok);
348 if (ftepp_next(ftepp) >= TOKEN_EOF) {
349 ftepp_error(ftepp, "unexpected EOF in macro call");
353 vec_push(params, mp);
355 if (ftepp->token == ')')
357 if (ftepp->token != ',') {
358 ftepp_error(ftepp, "expected closing paren or comma in macro call");
361 if (ftepp_next(ftepp) >= TOKEN_EOF) {
362 ftepp_error(ftepp, "unexpected EOF in macro call");
366 if (ftepp_next(ftepp) >= TOKEN_EOF) {
367 ftepp_error(ftepp, "unexpected EOF in macro call");
370 *out_params = params;
375 macroparam_clean(&mp);
376 for (i = 0; i < vec_size(params); ++i)
377 macroparam_clean(¶ms[i]);
382 static bool ftepp_macro_expand(ftepp_t *ftepp, ppmacro *macro, macroparam *params)
387 static bool ftepp_macro_call(ftepp_t *ftepp, ppmacro *macro)
390 macroparam *params = NULL;
395 if (!macro->has_params) {
396 for (o = 0; o < vec_size(macro->output); ++o) {
397 ftepp_out(ftepp, macro->output[o]->value, false);
402 if (!ftepp_skipallwhite(ftepp))
405 if (ftepp->token != '(') {
406 ftepp_error(ftepp, "expected macro parameters in parenthesis");
411 if (!ftepp_macro_call_params(ftepp, ¶ms))
414 if (vec_size(params) != vec_size(macro->params)) {
415 ftepp_error(ftepp, "macro %s expects %u paramteters, %u provided", macro->name,
416 (unsigned int)vec_size(macro->params),
417 (unsigned int)vec_size(params));
422 if (!ftepp_macro_expand(ftepp, macro, params))
426 for (o = 0; o < vec_size(params); ++o)
427 macroparam_clean(¶ms[o]);
433 * #if - the FTEQCC way:
434 * defined(FOO) => true if FOO was #defined regardless of parameters or contents
435 * <numbers> => True if the number is not 0
436 * !<factor> => True if the factor yields false
437 * !!<factor> => ERROR on 2 or more unary nots
438 * <macro> => becomes the macro's FIRST token regardless of parameters
439 * <e> && <e> => True if both expressions are true
440 * <e> || <e> => True if either expression is true
442 * <ident> => False (remember for macros the <macro> rule applies instead)
443 * Unary + and - are weird and wrong in fteqcc so we don't allow them
444 * parenthesis in expressions are allowed
445 * parameter lists on macros are errors
446 * No mathematical calculations are executed
448 static bool ftepp_if_expr(ftepp_t *ftepp, bool *out)
453 if (!ftepp_skipspace(ftepp))
456 while (ftepp->token == '!') {
459 if (!ftepp_skipspace(ftepp))
463 switch (ftepp->token) {
467 if (!strcmp(ftepp_tokval(ftepp), "defined")) {
469 if (!ftepp_skipspace(ftepp))
471 if (ftepp->token != '(') {
472 ftepp_error(ftepp, "`defined` keyword in #if requires a macro name in parenthesis");
476 if (!ftepp_skipspace(ftepp))
478 if (ftepp->token != TOKEN_IDENT &&
479 ftepp->token != TOKEN_TYPENAME &&
480 ftepp->token != TOKEN_KEYWORD)
482 ftepp_error(ftepp, "defined() used on an unexpected token type");
485 macro = ftepp_macro_find(ftepp, ftepp_tokval(ftepp));
488 if (!ftepp_skipspace(ftepp))
490 if (ftepp->token != ')') {
491 ftepp_error(ftepp, "expected closing paren");
497 macro = ftepp_macro_find(ftepp, ftepp_tokval(ftepp));
498 if (!macro || !vec_size(macro->output)) {
501 /* This does not expand recursively! */
502 switch (macro->output[0]->token) {
504 *out = !!(macro->output[0]->constval.f);
506 case TOKEN_FLOATCONST:
507 *out = !!(macro->output[0]->constval.f);
515 case TOKEN_STRINGCONST:
519 *out = !!(ftepp->lex->tok.constval.i);
521 case TOKEN_FLOATCONST:
522 *out = !!(ftepp->lex->tok.constval.f);
527 if (!ftepp_if_expr(ftepp, out))
529 if (ftepp->token != ')') {
530 ftepp_error(ftepp, "expected closing paren in #if expression");
536 ftepp_error(ftepp, "junk in #if");
542 ftepp->lex->flags.noops = false;
544 if (!ftepp_skipspace(ftepp))
546 ftepp->lex->flags.noops = true;
548 if (ftepp->token == ')')
551 if (ftepp->token != TOKEN_OPERATOR)
554 if (!strcmp(ftepp_tokval(ftepp), "&&") ||
555 !strcmp(ftepp_tokval(ftepp), "||"))
558 char opc = ftepp_tokval(ftepp)[0];
561 if (!ftepp_if_expr(ftepp, &next))
571 ftepp_error(ftepp, "junk after #if");
576 static bool ftepp_if(ftepp_t *ftepp, ppcondition *cond)
580 memset(cond, 0, sizeof(*cond));
581 (void)ftepp_next(ftepp);
583 if (!ftepp_skipspace(ftepp))
585 if (ftepp->token == TOKEN_EOL) {
586 ftepp_error(ftepp, "expected expression for #if-directive");
590 if (!ftepp_if_expr(ftepp, &result))
598 * ifdef is rather simple
600 static bool ftepp_ifdef(ftepp_t *ftepp, ppcondition *cond)
603 memset(cond, 0, sizeof(*cond));
604 (void)ftepp_next(ftepp);
605 if (!ftepp_skipspace(ftepp))
608 switch (ftepp->token) {
612 macro = ftepp_macro_find(ftepp, ftepp_tokval(ftepp));
615 ftepp_error(ftepp, "expected macro name");
619 (void)ftepp_next(ftepp);
620 if (!ftepp_skipspace(ftepp))
622 if (ftepp->token != TOKEN_EOL) {
623 ftepp_error(ftepp, "stray tokens after #ifdef");
630 /* Basic structure handlers */
631 static bool ftepp_else_allowed(ftepp_t *ftepp)
633 if (!vec_size(ftepp->conditions)) {
634 ftepp_error(ftepp, "#else without #if");
637 if (vec_last(ftepp->conditions).had_else) {
638 ftepp_error(ftepp, "multiple #else for a single #if");
644 static bool ftepp_hash(ftepp_t *ftepp)
649 lex_ctx ctx = ftepp_ctx(ftepp);
651 if (!ftepp_skipspace(ftepp))
654 switch (ftepp->token) {
658 if (!strcmp(ftepp_tokval(ftepp), "define")) {
659 return ftepp_define(ftepp);
661 else if (!strcmp(ftepp_tokval(ftepp), "ifdef")) {
662 if (!ftepp_ifdef(ftepp, &cond))
664 cond.was_on = cond.on;
665 vec_push(ftepp->conditions, cond);
666 ftepp->output_on = ftepp->output_on && cond.on;
669 else if (!strcmp(ftepp_tokval(ftepp), "ifndef")) {
670 if (!ftepp_ifdef(ftepp, &cond))
673 cond.was_on = cond.on;
674 vec_push(ftepp->conditions, cond);
675 ftepp->output_on = ftepp->output_on && cond.on;
678 else if (!strcmp(ftepp_tokval(ftepp), "elifdef")) {
679 if (!ftepp_else_allowed(ftepp))
681 if (!ftepp_ifdef(ftepp, &cond))
683 pc = &vec_last(ftepp->conditions);
684 pc->on = !pc->was_on && cond.on;
685 pc->was_on = pc->was_on || pc->on;
686 ftepp_update_output_condition(ftepp);
689 else if (!strcmp(ftepp_tokval(ftepp), "elifndef")) {
690 if (!ftepp_else_allowed(ftepp))
692 if (!ftepp_ifdef(ftepp, &cond))
695 pc = &vec_last(ftepp->conditions);
696 pc->on = !pc->was_on && cond.on;
697 pc->was_on = pc->was_on || pc->on;
698 ftepp_update_output_condition(ftepp);
701 else if (!strcmp(ftepp_tokval(ftepp), "elif")) {
702 if (!ftepp_else_allowed(ftepp))
704 if (!ftepp_if(ftepp, &cond))
706 pc = &vec_last(ftepp->conditions);
707 pc->on = !pc->was_on && cond.on;
708 pc->was_on = pc->was_on || pc->on;
709 ftepp_update_output_condition(ftepp);
712 else if (!strcmp(ftepp_tokval(ftepp), "if")) {
713 if (!ftepp_if(ftepp, &cond))
715 cond.was_on = cond.on;
716 vec_push(ftepp->conditions, cond);
717 ftepp->output_on = ftepp->output_on && cond.on;
720 else if (!strcmp(ftepp_tokval(ftepp), "else")) {
721 if (!ftepp_else_allowed(ftepp))
723 pc = &vec_last(ftepp->conditions);
724 pc->on = !pc->was_on;
727 ftepp_update_output_condition(ftepp);
730 else if (!strcmp(ftepp_tokval(ftepp), "endif")) {
731 if (!vec_size(ftepp->conditions)) {
732 ftepp_error(ftepp, "#endif without #if");
735 vec_pop(ftepp->conditions);
737 ftepp_update_output_condition(ftepp);
741 ftepp_error(ftepp, "unrecognized preprocessor directive: `%s`", ftepp_tokval(ftepp));
746 ftepp_error(ftepp, "unexpected preprocessor token: `%s`", ftepp_tokval(ftepp));
749 ftepp_errorat(ftepp, ctx, "empty preprocessor directive");
752 ftepp_error(ftepp, "missing newline at end of file", ftepp_tokval(ftepp));
755 /* Builtins! Don't forget the builtins! */
757 case TOKEN_FLOATCONST:
758 ftepp_out(ftepp, "#", false);
761 if (!ftepp_skipspace(ftepp))
766 static bool ftepp_preprocess(ftepp_t *ftepp)
771 ftepp->lex->flags.preprocessing = true;
772 ftepp->lex->flags.mergelines = false;
773 ftepp->lex->flags.noops = true;
778 if (ftepp->token >= TOKEN_EOF)
781 ftepp->newline = newline;
784 /* For the sake of FTE compatibility... FU, really */
785 ftepp->newline = newline = true;
788 switch (ftepp->token) {
792 macro = ftepp_macro_find(ftepp, ftepp_tokval(ftepp));
794 ftepp_out(ftepp, ftepp_tokval(ftepp), false);
798 if (!ftepp_macro_call(ftepp, macro))
799 ftepp->token = TOKEN_ERROR;
802 if (!ftepp->newline) {
803 ftepp_out(ftepp, ftepp_tokval(ftepp), false);
807 ftepp->lex->flags.mergelines = true;
808 if (ftepp_next(ftepp) >= TOKEN_EOF) {
809 ftepp_error(ftepp, "error in preprocessor directive");
810 ftepp->token = TOKEN_ERROR;
813 if (!ftepp_hash(ftepp))
814 ftepp->token = TOKEN_ERROR;
815 ftepp->lex->flags.mergelines = false;
819 ftepp_out(ftepp, "\n", true);
823 ftepp_out(ftepp, ftepp_tokval(ftepp), false);
827 } while (!ftepp->errors && ftepp->token < TOKEN_EOF);
829 newline = ftepp->token == TOKEN_EOF;
833 bool ftepp_preprocess_file(const char *filename)
835 ftepp_t *ftepp = ftepp_init();
836 ftepp->lex = lex_open(filename);
838 con_out("failed to open file \"%s\"\n", filename);
841 if (!ftepp_preprocess(ftepp)) {
849 bool ftepp_preprocess_string(const char *name, const char *str)
851 ftepp_t *ftepp = ftepp_init();
852 ftepp->lex = lex_open_string(str, strlen(str), name);
854 con_out("failed to create lexer for string \"%s\"\n", name);
857 if (!ftepp_preprocess(ftepp)) {