2 * Copyright (C) 2012, 2013
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:
13 * The above copyright notice and this permission notice shall be included in all
14 * copies or substantial portions of the Software.
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
37 /* a copy from the lexer */
51 /* yes we need an extra flag since `#define FOO x` is not the same as `#define FOO() x` */
64 ppcondition *conditions;
75 * Implement the predef subsystem now. We can do this safely with the
76 * help of lexer contexts.
78 static uint32_t ftepp_predef_countval = 0;
79 static uint32_t ftepp_predef_randval = 0;
82 char *ftepp_predef_date(lex_file *context) {
85 char *value = (char*)mem_a(82);
86 /* 82 is enough for strftime but we also have " " in our string */
92 itime = localtime(&rtime);
94 strftime(value, 82, "\"%b %d %Y\"", itime);
100 char *ftepp_predef_time(lex_file *context) {
103 char *value = (char*)mem_a(82);
104 /* 82 is enough for strftime but we also have " " in our string */
110 itime = localtime(&rtime);
112 strftime(value, 82, "\"%X\"", itime);
118 char *ftepp_predef_line(lex_file *context) {
120 util_asprintf(&value, "%d", (int)context->line);
124 char *ftepp_predef_file(lex_file *context) {
125 size_t length = strlen(context->name) + 3; /* two quotes and a terminator */
126 char *value = (char*)mem_a(length);
127 snprintf(value, length, "\"%s\"", context->name);
131 /* __COUNTER_LAST__ */
132 char *ftepp_predef_counterlast(lex_file *context) {
134 util_asprintf(&value, "%u", ftepp_predef_countval);
140 char *ftepp_predef_counter(lex_file *context) {
142 ftepp_predef_countval ++;
143 util_asprintf(&value, "%u", ftepp_predef_countval);
149 char *ftepp_predef_random(lex_file *context) {
151 ftepp_predef_randval = (util_rand() % 0xFF) + 1;
152 util_asprintf(&value, "%u", ftepp_predef_randval);
157 /* __RANDOM_LAST__ */
158 char *ftepp_predef_randomlast(lex_file *context) {
160 util_asprintf(&value, "%u", ftepp_predef_randval);
166 const ftepp_predef_t ftepp_predefs[FTEPP_PREDEF_COUNT] = {
167 { "__LINE__", &ftepp_predef_line },
168 { "__FILE__", &ftepp_predef_file },
169 { "__COUNTER__", &ftepp_predef_counter },
170 { "__COUNTER_LAST__", &ftepp_predef_counterlast },
171 { "__RANDOM__", &ftepp_predef_random },
172 { "__RANDOM_LAST__", &ftepp_predef_randomlast },
173 { "__DATE__", &ftepp_predef_date },
174 { "__TIME__", &ftepp_predef_time }
177 #define ftepp_tokval(f) ((f)->lex->tok.value)
178 #define ftepp_ctx(f) ((f)->lex->tok.ctx)
180 static void ftepp_errorat(ftepp_t *ftepp, lex_ctx ctx, const char *fmt, ...)
187 con_cvprintmsg((void*)&ctx, LVL_ERROR, "error", fmt, ap);
191 static void ftepp_error(ftepp_t *ftepp, const char *fmt, ...)
198 con_cvprintmsg((void*)&ftepp->lex->tok.ctx, LVL_ERROR, "error", fmt, ap);
202 static bool GMQCC_WARN ftepp_warn(ftepp_t *ftepp, int warntype, const char *fmt, ...)
208 r = vcompile_warning(ftepp->lex->tok.ctx, warntype, fmt, ap);
213 static pptoken *pptoken_make(ftepp_t *ftepp)
215 pptoken *token = (pptoken*)mem_a(sizeof(pptoken));
216 token->token = ftepp->token;
218 if (token->token == TOKEN_WHITE)
219 token->value = util_strdup(" ");
222 token->value = util_strdup(ftepp_tokval(ftepp));
224 memcpy(&token->constval, &ftepp->lex->tok.constval, sizeof(token->constval));
228 static void pptoken_delete(pptoken *self)
234 static ppmacro *ppmacro_new(lex_ctx ctx, const char *name)
236 ppmacro *macro = (ppmacro*)mem_a(sizeof(ppmacro));
239 memset(macro, 0, sizeof(*macro));
240 macro->name = util_strdup(name);
244 static void ppmacro_delete(ppmacro *self)
247 for (i = 0; i < vec_size(self->params); ++i)
248 mem_d(self->params[i]);
249 vec_free(self->params);
250 for (i = 0; i < vec_size(self->output); ++i)
251 pptoken_delete(self->output[i]);
252 vec_free(self->output);
257 static ftepp_t* ftepp_new()
261 ftepp = (ftepp_t*)mem_a(sizeof(*ftepp));
262 memset(ftepp, 0, sizeof(*ftepp));
264 ftepp->output_on = true;
269 static void ftepp_flush_do(ftepp_t *self)
271 vec_free(self->output_string);
274 static void ftepp_delete(ftepp_t *self)
277 ftepp_flush_do(self);
279 mem_d(self->itemname);
280 if (self->includename)
281 vec_free(self->includename);
282 for (i = 0; i < vec_size(self->macros); ++i)
283 ppmacro_delete(self->macros[i]);
284 vec_free(self->macros);
285 vec_free(self->conditions);
287 lex_close(self->lex);
291 static void ftepp_out(ftepp_t *ftepp, const char *str, bool ignore_cond)
293 if (ignore_cond || ftepp->output_on)
298 data = vec_add(ftepp->output_string, len);
299 memcpy(data, str, len);
303 static void ftepp_update_output_condition(ftepp_t *ftepp)
306 ftepp->output_on = true;
307 for (i = 0; i < vec_size(ftepp->conditions); ++i)
308 ftepp->output_on = ftepp->output_on && ftepp->conditions[i].on;
311 static ppmacro* ftepp_macro_find(ftepp_t *ftepp, const char *name)
314 for (i = 0; i < vec_size(ftepp->macros); ++i) {
315 if (!strcmp(name, ftepp->macros[i]->name))
316 return ftepp->macros[i];
321 static void ftepp_macro_delete(ftepp_t *ftepp, const char *name)
324 for (i = 0; i < vec_size(ftepp->macros); ++i) {
325 if (!strcmp(name, ftepp->macros[i]->name)) {
326 vec_remove(ftepp->macros, i, 1);
332 static GMQCC_INLINE int ftepp_next(ftepp_t *ftepp)
334 return (ftepp->token = lex_do(ftepp->lex));
337 /* Important: this does not skip newlines! */
338 static bool ftepp_skipspace(ftepp_t *ftepp)
340 if (ftepp->token != TOKEN_WHITE)
342 while (ftepp_next(ftepp) == TOKEN_WHITE) {}
343 if (ftepp->token >= TOKEN_EOF) {
344 ftepp_error(ftepp, "unexpected end of preprocessor directive");
350 /* this one skips EOLs as well */
351 static bool ftepp_skipallwhite(ftepp_t *ftepp)
353 if (ftepp->token != TOKEN_WHITE && ftepp->token != TOKEN_EOL)
357 } while (ftepp->token == TOKEN_WHITE || ftepp->token == TOKEN_EOL);
358 if (ftepp->token >= TOKEN_EOF) {
359 ftepp_error(ftepp, "unexpected end of preprocessor directive");
366 * The huge macro parsing code...
368 static bool ftepp_define_params(ftepp_t *ftepp, ppmacro *macro)
372 if (!ftepp_skipspace(ftepp))
374 if (ftepp->token == ')')
376 switch (ftepp->token) {
380 vec_push(macro->params, util_strdup(ftepp_tokval(ftepp)));
383 macro->variadic = true;
386 ftepp_error(ftepp, "unexpected token in parameter list");
390 if (!ftepp_skipspace(ftepp))
392 if (macro->variadic && ftepp->token != ')') {
393 ftepp_error(ftepp, "cannot have parameters after the variadic parameters");
396 } while (ftepp->token == ',');
397 if (ftepp->token != ')') {
398 ftepp_error(ftepp, "expected closing paren after macro parameter list");
402 /* skipspace happens in ftepp_define */
406 static bool ftepp_define_body(ftepp_t *ftepp, ppmacro *macro)
409 while (ftepp->token != TOKEN_EOL && ftepp->token < TOKEN_EOF) {
410 bool subscript = false;
412 if (macro->variadic && !strcmp(ftepp_tokval(ftepp), "__VA_ARGS__")) {
413 subscript = !!(ftepp_next(ftepp) == '#');
415 if (subscript && ftepp_next(ftepp) != '#') {
416 ftepp_error(ftepp, "expected `##` in __VA_ARGS__ for subscripting");
418 } else if (subscript) {
419 if (ftepp_next(ftepp) == '[') {
420 if (ftepp_next(ftepp) != TOKEN_INTCONST) {
421 ftepp_error(ftepp, "expected index for __VA_ARGS__ subscript");
425 index = (int)strtol(ftepp_tokval(ftepp), NULL, 10);
427 if (ftepp_next(ftepp) != ']') {
428 ftepp_error(ftepp, "expected `]` in __VA_ARGS__ subscript");
433 * mark it as an array to be handled later as such and not
434 * as traditional __VA_ARGS__
436 ftepp->token = TOKEN_VA_ARGS_ARRAY;
437 ptok = pptoken_make(ftepp);
438 ptok->constval.i = index;
439 vec_push(macro->output, ptok);
442 ftepp_error(ftepp, "expected `[` for subscripting of __VA_ARGS__");
446 int old = ftepp->token;
447 ftepp->token = TOKEN_VA_ARGS;
448 ptok = pptoken_make(ftepp);
449 vec_push(macro->output, ptok);
453 else if (macro->variadic && !strcmp(ftepp_tokval(ftepp), "__VA_COUNT__")) {
454 ftepp->token = TOKEN_VA_COUNT;
455 ptok = pptoken_make(ftepp);
456 vec_push(macro->output, ptok);
459 ptok = pptoken_make(ftepp);
460 vec_push(macro->output, ptok);
464 /* recursive expansion can cause EOFs here */
465 if (ftepp->token != TOKEN_EOL && ftepp->token != TOKEN_EOF) {
466 ftepp_error(ftepp, "unexpected junk after macro or unexpected end of file");
472 static bool ftepp_define(ftepp_t *ftepp)
474 ppmacro *macro = NULL;
475 size_t l = ftepp_ctx(ftepp).line;
477 (void)ftepp_next(ftepp);
478 if (!ftepp_skipspace(ftepp))
481 switch (ftepp->token) {
485 macro = ftepp_macro_find(ftepp, ftepp_tokval(ftepp));
486 if (macro && ftepp->output_on) {
487 if (ftepp_warn(ftepp, WARN_CPP, "redefining `%s`", ftepp_tokval(ftepp)))
489 ftepp_macro_delete(ftepp, ftepp_tokval(ftepp));
491 macro = ppmacro_new(ftepp_ctx(ftepp), ftepp_tokval(ftepp));
494 ftepp_error(ftepp, "expected macro name");
498 (void)ftepp_next(ftepp);
500 if (ftepp->token == '(') {
501 macro->has_params = true;
502 if (!ftepp_define_params(ftepp, macro))
506 if (!ftepp_skipspace(ftepp))
509 if (!ftepp_define_body(ftepp, macro))
512 if (ftepp->output_on)
513 vec_push(ftepp->macros, macro);
515 ppmacro_delete(macro);
518 for (; l < ftepp_ctx(ftepp).line; ++l)
519 ftepp_out(ftepp, "\n", true);
523 if (macro) ppmacro_delete(macro);
528 * When a macro is used we have to handle parameters as well
529 * as special-concatenation via ## or stringification via #
531 * Note: parenthesis can nest, so FOO((a),b) is valid, but only
532 * this kind of parens. Curly braces or [] don't count towards the
539 static void macroparam_clean(macroparam *self)
542 for (i = 0; i < vec_size(self->tokens); ++i)
543 pptoken_delete(self->tokens[i]);
544 vec_free(self->tokens);
547 /* need to leave the last token up */
548 static bool ftepp_macro_call_params(ftepp_t *ftepp, macroparam **out_params)
550 macroparam *params = NULL;
556 if (!ftepp_skipallwhite(ftepp))
558 while (ftepp->token != ')') {
560 if (!ftepp_skipallwhite(ftepp))
562 while (parens || ftepp->token != ',') {
563 if (ftepp->token == '(')
565 else if (ftepp->token == ')') {
570 ptok = pptoken_make(ftepp);
571 vec_push(mp.tokens, ptok);
572 if (ftepp_next(ftepp) >= TOKEN_EOF) {
573 ftepp_error(ftepp, "unexpected EOF in macro call");
577 vec_push(params, mp);
579 if (ftepp->token == ')')
581 if (ftepp->token != ',') {
582 ftepp_error(ftepp, "expected closing paren or comma in macro call");
585 if (ftepp_next(ftepp) >= TOKEN_EOF) {
586 ftepp_error(ftepp, "unexpected EOF in macro call");
590 /* need to leave that up
591 if (ftepp_next(ftepp) >= TOKEN_EOF) {
592 ftepp_error(ftepp, "unexpected EOF in macro call");
596 *out_params = params;
601 macroparam_clean(&mp);
602 for (i = 0; i < vec_size(params); ++i)
603 macroparam_clean(¶ms[i]);
608 static bool macro_params_find(ppmacro *macro, const char *name, size_t *idx)
611 for (i = 0; i < vec_size(macro->params); ++i) {
612 if (!strcmp(macro->params[i], name)) {
620 static void ftepp_stringify_token(ftepp_t *ftepp, pptoken *token)
625 switch (token->token) {
626 case TOKEN_STRINGCONST:
629 /* in preprocessor mode strings already are string,
630 * so we don't get actual newline bytes here.
631 * Still need to escape backslashes and quotes.
634 case '\\': ftepp_out(ftepp, "\\\\", false); break;
635 case '"': ftepp_out(ftepp, "\\\"", false); break;
638 ftepp_out(ftepp, chs, false);
645 ftepp_out(ftepp, " ", false);
648 ftepp_out(ftepp, "\\n", false);
651 ftepp_out(ftepp, token->value, false);
656 static void ftepp_stringify(ftepp_t *ftepp, macroparam *param)
659 ftepp_out(ftepp, "\"", false);
660 for (i = 0; i < vec_size(param->tokens); ++i)
661 ftepp_stringify_token(ftepp, param->tokens[i]);
662 ftepp_out(ftepp, "\"", false);
665 static void ftepp_recursion_header(ftepp_t *ftepp)
667 ftepp_out(ftepp, "\n#pragma push(line)\n", false);
670 static void ftepp_recursion_footer(ftepp_t *ftepp)
672 ftepp_out(ftepp, "\n#pragma pop(line)\n", false);
675 static void ftepp_param_out(ftepp_t *ftepp, macroparam *param)
679 for (i = 0; i < vec_size(param->tokens); ++i) {
680 out = param->tokens[i];
681 if (out->token == TOKEN_EOL)
682 ftepp_out(ftepp, "\n", false);
684 ftepp_out(ftepp, out->value, false);
688 static bool ftepp_preprocess(ftepp_t *ftepp);
689 static bool ftepp_macro_expand(ftepp_t *ftepp, ppmacro *macro, macroparam *params, bool resetline)
692 char *old_string = ftepp->output_string;
694 lex_file *old_lexer = ftepp->lex;
695 size_t vararg_start = vec_size(macro->params);
707 if (vararg_start < vec_size(params))
708 varargs = vec_size(params) - vararg_start;
713 if (!vec_size(macro->output))
716 ftepp->output_string = NULL;
717 for (o = 0; o < vec_size(macro->output); ++o) {
718 pptoken *out = macro->output[o];
719 switch (out->token) {
721 if (!macro->variadic) {
722 ftepp_error(ftepp, "internal preprocessor error: TOKEN_VA_ARGS in non-variadic macro");
723 vec_free(old_string);
730 ftepp_param_out(ftepp, ¶ms[pi + vararg_start]);
731 for (++pi; pi < varargs; ++pi) {
732 ftepp_out(ftepp, ", ", false);
733 ftepp_param_out(ftepp, ¶ms[pi + vararg_start]);
737 case TOKEN_VA_ARGS_ARRAY:
738 if ((size_t)out->constval.i >= varargs) {
739 ftepp_error(ftepp, "subscript of `[%u]` is out of bounds for `__VA_ARGS__`", out->constval.i);
740 vec_free(old_string);
744 ftepp_param_out(ftepp, ¶ms[out->constval.i + vararg_start]);
748 util_asprintf(&buffer, "%d", varargs);
749 ftepp_out(ftepp, buffer, false);
756 if (!macro_params_find(macro, out->value, &pi)) {
757 ftepp_out(ftepp, out->value, false);
760 ftepp_param_out(ftepp, ¶ms[pi]);
763 if (o + 1 < vec_size(macro->output)) {
764 nextok = macro->output[o+1]->token;
766 /* raw concatenation */
770 if ( (nextok == TOKEN_IDENT ||
771 nextok == TOKEN_KEYWORD ||
772 nextok == TOKEN_TYPENAME) &&
773 macro_params_find(macro, macro->output[o+1]->value, &pi))
776 ftepp_stringify(ftepp, ¶ms[pi]);
780 ftepp_out(ftepp, "#", false);
783 ftepp_out(ftepp, "\n", false);
786 ftepp_out(ftepp, out->value, false);
790 vec_push(ftepp->output_string, 0);
791 /* Now run the preprocessor recursively on this string buffer */
793 printf("__________\n%s\n=========\n", ftepp->output_string);
795 inlex = lex_open_string(ftepp->output_string, vec_size(ftepp->output_string)-1, ftepp->lex->name);
797 ftepp_error(ftepp, "internal error: failed to instantiate lexer");
802 inlex->line = ftepp->lex->line;
803 inlex->sline = ftepp->lex->sline;
806 old_inmacro = ftepp->in_macro;
807 ftepp->in_macro = true;
808 ftepp->output_string = NULL;
809 if (!ftepp_preprocess(ftepp)) {
810 ftepp->in_macro = old_inmacro;
811 vec_free(ftepp->lex->open_string);
812 vec_free(ftepp->output_string);
813 lex_close(ftepp->lex);
817 ftepp->in_macro = old_inmacro;
818 vec_free(ftepp->lex->open_string);
819 lex_close(ftepp->lex);
821 inner_string = ftepp->output_string;
822 ftepp->output_string = old_string;
824 has_newlines = (strchr(inner_string, '\n') != NULL);
826 if (has_newlines && !old_inmacro)
827 ftepp_recursion_header(ftepp);
829 vec_append(ftepp->output_string, vec_size(inner_string), inner_string);
830 vec_free(inner_string);
832 if (has_newlines && !old_inmacro)
833 ftepp_recursion_footer(ftepp);
835 if (resetline && !ftepp->in_macro) {
837 snprintf(lineno, 128, "\n#pragma line(%lu)\n", (unsigned long)(old_lexer->sline));
838 ftepp_out(ftepp, lineno, false);
841 old_string = ftepp->output_string;
843 ftepp->lex = old_lexer;
844 ftepp->output_string = old_string;
848 static bool ftepp_macro_call(ftepp_t *ftepp, ppmacro *macro)
851 macroparam *params = NULL;
855 if (!macro->has_params) {
856 if (!ftepp_macro_expand(ftepp, macro, NULL, false))
863 if (!ftepp_skipallwhite(ftepp))
866 if (ftepp->token != '(') {
867 ftepp_error(ftepp, "expected macro parameters in parenthesis");
872 paramline = ftepp->lex->sline;
873 if (!ftepp_macro_call_params(ftepp, ¶ms))
876 if ( vec_size(params) < vec_size(macro->params) ||
877 (vec_size(params) > vec_size(macro->params) && !macro->variadic) )
879 ftepp_error(ftepp, "macro %s expects%s %u paramteters, %u provided", macro->name,
880 (macro->variadic ? " at least" : ""),
881 (unsigned int)vec_size(macro->params),
882 (unsigned int)vec_size(params));
887 if (!ftepp_macro_expand(ftepp, macro, params, (paramline != ftepp->lex->sline)))
892 for (o = 0; o < vec_size(params); ++o)
893 macroparam_clean(¶ms[o]);
899 * #if - the FTEQCC way:
900 * defined(FOO) => true if FOO was #defined regardless of parameters or contents
901 * <numbers> => True if the number is not 0
902 * !<factor> => True if the factor yields false
903 * !!<factor> => ERROR on 2 or more unary nots
904 * <macro> => becomes the macro's FIRST token regardless of parameters
905 * <e> && <e> => True if both expressions are true
906 * <e> || <e> => True if either expression is true
908 * <ident> => False (remember for macros the <macro> rule applies instead)
909 * Unary + and - are weird and wrong in fteqcc so we don't allow them
910 * parenthesis in expressions are allowed
911 * parameter lists on macros are errors
912 * No mathematical calculations are executed
914 static bool ftepp_if_expr(ftepp_t *ftepp, bool *out, double *value_out);
915 static bool ftepp_if_op(ftepp_t *ftepp)
917 ftepp->lex->flags.noops = false;
919 if (!ftepp_skipspace(ftepp))
921 ftepp->lex->flags.noops = true;
924 static bool ftepp_if_value(ftepp_t *ftepp, bool *out, double *value_out)
930 if (!ftepp_skipspace(ftepp))
933 while (ftepp->token == '!') {
936 if (!ftepp_skipspace(ftepp))
940 if (ftepp->token == TOKEN_OPERATOR && !strcmp(ftepp_tokval(ftepp), "-"))
944 if (!ftepp_skipspace(ftepp))
948 switch (ftepp->token) {
952 if (!strcmp(ftepp_tokval(ftepp), "defined")) {
954 if (!ftepp_skipspace(ftepp))
956 if (ftepp->token != '(') {
957 ftepp_error(ftepp, "`defined` keyword in #if requires a macro name in parenthesis");
961 if (!ftepp_skipspace(ftepp))
963 if (ftepp->token != TOKEN_IDENT &&
964 ftepp->token != TOKEN_TYPENAME &&
965 ftepp->token != TOKEN_KEYWORD)
967 ftepp_error(ftepp, "defined() used on an unexpected token type");
970 macro = ftepp_macro_find(ftepp, ftepp_tokval(ftepp));
973 if (!ftepp_skipspace(ftepp))
975 if (ftepp->token != ')') {
976 ftepp_error(ftepp, "expected closing paren");
982 macro = ftepp_macro_find(ftepp, ftepp_tokval(ftepp));
983 if (!macro || !vec_size(macro->output)) {
987 /* This does not expand recursively! */
988 switch (macro->output[0]->token) {
990 *value_out = macro->output[0]->constval.i;
991 *out = !!(macro->output[0]->constval.i);
993 case TOKEN_FLOATCONST:
994 *value_out = macro->output[0]->constval.f;
995 *out = !!(macro->output[0]->constval.f);
1003 case TOKEN_STRINGCONST:
1007 case TOKEN_INTCONST:
1008 *value_out = ftepp->lex->tok.constval.i;
1009 *out = !!(ftepp->lex->tok.constval.i);
1011 case TOKEN_FLOATCONST:
1012 *value_out = ftepp->lex->tok.constval.f;
1013 *out = !!(ftepp->lex->tok.constval.f);
1018 if (!ftepp_if_expr(ftepp, out, value_out))
1020 if (ftepp->token != ')') {
1021 ftepp_error(ftepp, "expected closing paren in #if expression");
1027 ftepp_error(ftepp, "junk in #if: `%s` ...", ftepp_tokval(ftepp));
1028 if (OPTS_OPTION_BOOL(OPTION_DEBUG))
1029 ftepp_error(ftepp, "internal: token %i\n", ftepp->token);
1033 *value_out = -*value_out;
1036 *value_out = (*out ? 1 : 0);
1042 static bool ftepp_if_nextvalue(ftepp_t *ftepp, bool *out, double *value_out)
1044 if (!ftepp_next(ftepp))
1046 return ftepp_if_value(ftepp, out, value_out);
1050 static bool ftepp_if_expr(ftepp_t *ftepp, bool *out, double *value_out)
1052 if (!ftepp_if_value(ftepp, out, value_out))
1055 if (!ftepp_if_op(ftepp))
1058 if (ftepp->token == ')' || ftepp->token != TOKEN_OPERATOR)
1061 /* FTEQCC is all right-associative and no precedence here */
1062 if (!strcmp(ftepp_tokval(ftepp), "&&") ||
1063 !strcmp(ftepp_tokval(ftepp), "||"))
1066 char opc = ftepp_tokval(ftepp)[0];
1070 if (!ftepp_next(ftepp))
1072 if (!ftepp_if_expr(ftepp, &next, &nextvalue))
1076 *out = *out && next;
1078 *out = *out || next;
1080 *value_out = (*out ? 1 : 0);
1083 else if (!strcmp(ftepp_tokval(ftepp), "==") ||
1084 !strcmp(ftepp_tokval(ftepp), "!=") ||
1085 !strcmp(ftepp_tokval(ftepp), ">=") ||
1086 !strcmp(ftepp_tokval(ftepp), "<=") ||
1087 !strcmp(ftepp_tokval(ftepp), ">") ||
1088 !strcmp(ftepp_tokval(ftepp), "<"))
1091 const char opc0 = ftepp_tokval(ftepp)[0];
1092 const char opc1 = ftepp_tokval(ftepp)[1];
1095 if (!ftepp_next(ftepp))
1097 if (!ftepp_if_expr(ftepp, &next, &other))
1101 *out = (*value_out == other);
1102 else if (opc0 == '!')
1103 *out = (*value_out != other);
1104 else if (opc0 == '>') {
1105 if (opc1 == '=') *out = (*value_out >= other);
1106 else *out = (*value_out > other);
1108 else if (opc0 == '<') {
1109 if (opc1 == '=') *out = (*value_out <= other);
1110 else *out = (*value_out < other);
1112 *value_out = (*out ? 1 : 0);
1117 ftepp_error(ftepp, "junk after #if");
1122 static bool ftepp_if(ftepp_t *ftepp, ppcondition *cond)
1124 bool result = false;
1127 memset(cond, 0, sizeof(*cond));
1128 (void)ftepp_next(ftepp);
1130 if (!ftepp_skipspace(ftepp))
1132 if (ftepp->token == TOKEN_EOL) {
1133 ftepp_error(ftepp, "expected expression for #if-directive");
1137 if (!ftepp_if_expr(ftepp, &result, &dummy))
1145 * ifdef is rather simple
1147 static bool ftepp_ifdef(ftepp_t *ftepp, ppcondition *cond)
1150 memset(cond, 0, sizeof(*cond));
1151 (void)ftepp_next(ftepp);
1152 if (!ftepp_skipspace(ftepp))
1155 switch (ftepp->token) {
1157 case TOKEN_TYPENAME:
1159 macro = ftepp_macro_find(ftepp, ftepp_tokval(ftepp));
1162 ftepp_error(ftepp, "expected macro name");
1166 (void)ftepp_next(ftepp);
1167 if (!ftepp_skipspace(ftepp))
1169 /* relaxing this condition
1170 if (ftepp->token != TOKEN_EOL && ftepp->token != TOKEN_EOF) {
1171 ftepp_error(ftepp, "stray tokens after #ifdef");
1180 * undef is also simple
1182 static bool ftepp_undef(ftepp_t *ftepp)
1184 (void)ftepp_next(ftepp);
1185 if (!ftepp_skipspace(ftepp))
1188 if (ftepp->output_on) {
1189 switch (ftepp->token) {
1191 case TOKEN_TYPENAME:
1193 ftepp_macro_delete(ftepp, ftepp_tokval(ftepp));
1196 ftepp_error(ftepp, "expected macro name");
1201 (void)ftepp_next(ftepp);
1202 if (!ftepp_skipspace(ftepp))
1204 /* relaxing this condition
1205 if (ftepp->token != TOKEN_EOL && ftepp->token != TOKEN_EOF) {
1206 ftepp_error(ftepp, "stray tokens after #ifdef");
1213 /* Special unescape-string function which skips a leading quote
1214 * and stops at a quote, not just at \0
1216 static void unescape(const char *str, char *out) {
1218 while (*str && *str != '"') {
1222 case '\\': *out++ = *str; break;
1223 case '"': *out++ = *str; break;
1224 case 'a': *out++ = '\a'; break;
1225 case 'b': *out++ = '\b'; break;
1226 case 'r': *out++ = '\r'; break;
1227 case 'n': *out++ = '\n'; break;
1228 case 't': *out++ = '\t'; break;
1229 case 'f': *out++ = '\f'; break;
1230 case 'v': *out++ = '\v'; break;
1245 static char *ftepp_include_find_path(const char *file, const char *pathfile)
1248 char *filename = NULL;
1249 const char *last_slash;
1255 last_slash = strrchr(pathfile, '/');
1258 len = last_slash - pathfile;
1259 memcpy(vec_add(filename, len), pathfile, len);
1260 vec_push(filename, '/');
1264 memcpy(vec_add(filename, len+1), file, len);
1265 vec_last(filename) = 0;
1267 fp = fs_file_open(filename, "rb");
1276 static char *ftepp_include_find(ftepp_t *ftepp, const char *file)
1278 char *filename = NULL;
1280 filename = ftepp_include_find_path(file, ftepp->includename);
1282 filename = ftepp_include_find_path(file, ftepp->itemname);
1286 static bool ftepp_directive_warning(ftepp_t *ftepp) {
1287 char *message = NULL;
1289 if (!ftepp_skipspace(ftepp))
1292 /* handle the odd non string constant case so it works like C */
1293 if (ftepp->token != TOKEN_STRINGCONST) {
1295 vec_upload(message, "#warning", 8);
1297 while (ftepp->token != TOKEN_EOL) {
1298 vec_upload(message, ftepp_tokval(ftepp), strlen(ftepp_tokval(ftepp)));
1301 vec_push(message, '\0');
1302 if (ftepp->output_on)
1303 store = ftepp_warn(ftepp, WARN_CPP, message);
1310 if (!ftepp->output_on)
1313 unescape (ftepp_tokval(ftepp), ftepp_tokval(ftepp));
1314 return ftepp_warn(ftepp, WARN_CPP, "#warning %s", ftepp_tokval(ftepp));
1317 static void ftepp_directive_error(ftepp_t *ftepp) {
1318 char *message = NULL;
1320 if (!ftepp_skipspace(ftepp))
1323 /* handle the odd non string constant case so it works like C */
1324 if (ftepp->token != TOKEN_STRINGCONST) {
1325 vec_upload(message, "#error", 6);
1327 while (ftepp->token != TOKEN_EOL) {
1328 vec_upload(message, ftepp_tokval(ftepp), strlen(ftepp_tokval(ftepp)));
1331 vec_push(message, '\0');
1332 if (ftepp->output_on)
1333 ftepp_error(ftepp, message);
1338 if (!ftepp->output_on)
1341 unescape (ftepp_tokval(ftepp), ftepp_tokval(ftepp));
1342 ftepp_error(ftepp, "#error %s", ftepp_tokval(ftepp));
1345 static void ftepp_directive_message(ftepp_t *ftepp) {
1346 char *message = NULL;
1348 if (!ftepp_skipspace(ftepp))
1351 /* handle the odd non string constant case so it works like C */
1352 if (ftepp->token != TOKEN_STRINGCONST) {
1353 vec_upload(message, "#message", 8);
1355 while (ftepp->token != TOKEN_EOL) {
1356 vec_upload(message, ftepp_tokval(ftepp), strlen(ftepp_tokval(ftepp)));
1359 vec_push(message, '\0');
1360 if (ftepp->output_on)
1361 con_cprintmsg(&ftepp->lex->tok.ctx, LVL_MSG, "message", message);
1366 if (!ftepp->output_on)
1369 unescape (ftepp_tokval(ftepp), ftepp_tokval(ftepp));
1370 con_cprintmsg(&ftepp->lex->tok.ctx, LVL_MSG, "message", ftepp_tokval(ftepp));
1375 * FIXME: do we need/want a -I option?
1376 * FIXME: what about when dealing with files in subdirectories coming from a progs.src?
1378 static bool ftepp_include(ftepp_t *ftepp)
1380 lex_file *old_lexer = ftepp->lex;
1385 char *old_includename;
1387 (void)ftepp_next(ftepp);
1388 if (!ftepp_skipspace(ftepp))
1391 if (ftepp->token != TOKEN_STRINGCONST) {
1392 ftepp_error(ftepp, "expected filename to include");
1396 if (!ftepp->output_on) {
1401 ctx = ftepp_ctx(ftepp);
1403 unescape(ftepp_tokval(ftepp), ftepp_tokval(ftepp));
1405 ftepp_out(ftepp, "\n#pragma file(", false);
1406 ftepp_out(ftepp, ftepp_tokval(ftepp), false);
1407 ftepp_out(ftepp, ")\n#pragma line(1)\n", false);
1409 filename = ftepp_include_find(ftepp, ftepp_tokval(ftepp));
1411 ftepp_error(ftepp, "failed to open include file `%s`", ftepp_tokval(ftepp));
1414 inlex = lex_open(filename);
1416 ftepp_error(ftepp, "open failed on include file `%s`", filename);
1421 old_includename = ftepp->includename;
1422 ftepp->includename = filename;
1423 if (!ftepp_preprocess(ftepp)) {
1424 vec_free(ftepp->includename);
1425 ftepp->includename = old_includename;
1426 lex_close(ftepp->lex);
1427 ftepp->lex = old_lexer;
1430 vec_free(ftepp->includename);
1431 ftepp->includename = old_includename;
1432 lex_close(ftepp->lex);
1433 ftepp->lex = old_lexer;
1435 ftepp_out(ftepp, "\n#pragma file(", false);
1436 ftepp_out(ftepp, ctx.file, false);
1437 snprintf(lineno, sizeof(lineno), ")\n#pragma line(%lu)\n", (unsigned long)(ctx.line+1));
1438 ftepp_out(ftepp, lineno, false);
1441 (void)ftepp_next(ftepp);
1442 if (!ftepp_skipspace(ftepp))
1444 if (ftepp->token != TOKEN_EOL) {
1445 ftepp_error(ftepp, "stray tokens after #include");
1448 (void)ftepp_next(ftepp);
1453 /* Basic structure handlers */
1454 static bool ftepp_else_allowed(ftepp_t *ftepp)
1456 if (!vec_size(ftepp->conditions)) {
1457 ftepp_error(ftepp, "#else without #if");
1460 if (vec_last(ftepp->conditions).had_else) {
1461 ftepp_error(ftepp, "multiple #else for a single #if");
1467 static bool ftepp_hash(ftepp_t *ftepp)
1472 lex_ctx ctx = ftepp_ctx(ftepp);
1474 if (!ftepp_skipspace(ftepp))
1477 switch (ftepp->token) {
1480 case TOKEN_TYPENAME:
1481 if (!strcmp(ftepp_tokval(ftepp), "define")) {
1482 return ftepp_define(ftepp);
1484 else if (!strcmp(ftepp_tokval(ftepp), "undef")) {
1485 return ftepp_undef(ftepp);
1487 else if (!strcmp(ftepp_tokval(ftepp), "ifdef")) {
1488 if (!ftepp_ifdef(ftepp, &cond))
1490 cond.was_on = cond.on;
1491 vec_push(ftepp->conditions, cond);
1492 ftepp->output_on = ftepp->output_on && cond.on;
1495 else if (!strcmp(ftepp_tokval(ftepp), "ifndef")) {
1496 if (!ftepp_ifdef(ftepp, &cond))
1499 cond.was_on = cond.on;
1500 vec_push(ftepp->conditions, cond);
1501 ftepp->output_on = ftepp->output_on && cond.on;
1504 else if (!strcmp(ftepp_tokval(ftepp), "elifdef")) {
1505 if (!ftepp_else_allowed(ftepp))
1507 if (!ftepp_ifdef(ftepp, &cond))
1509 pc = &vec_last(ftepp->conditions);
1510 pc->on = !pc->was_on && cond.on;
1511 pc->was_on = pc->was_on || pc->on;
1512 ftepp_update_output_condition(ftepp);
1515 else if (!strcmp(ftepp_tokval(ftepp), "elifndef")) {
1516 if (!ftepp_else_allowed(ftepp))
1518 if (!ftepp_ifdef(ftepp, &cond))
1521 pc = &vec_last(ftepp->conditions);
1522 pc->on = !pc->was_on && cond.on;
1523 pc->was_on = pc->was_on || pc->on;
1524 ftepp_update_output_condition(ftepp);
1527 else if (!strcmp(ftepp_tokval(ftepp), "elif")) {
1528 if (!ftepp_else_allowed(ftepp))
1530 if (!ftepp_if(ftepp, &cond))
1532 pc = &vec_last(ftepp->conditions);
1533 pc->on = !pc->was_on && cond.on;
1534 pc->was_on = pc->was_on || pc->on;
1535 ftepp_update_output_condition(ftepp);
1538 else if (!strcmp(ftepp_tokval(ftepp), "if")) {
1539 if (!ftepp_if(ftepp, &cond))
1541 cond.was_on = cond.on;
1542 vec_push(ftepp->conditions, cond);
1543 ftepp->output_on = ftepp->output_on && cond.on;
1546 else if (!strcmp(ftepp_tokval(ftepp), "else")) {
1547 if (!ftepp_else_allowed(ftepp))
1549 pc = &vec_last(ftepp->conditions);
1550 pc->on = !pc->was_on;
1551 pc->had_else = true;
1553 ftepp_update_output_condition(ftepp);
1556 else if (!strcmp(ftepp_tokval(ftepp), "endif")) {
1557 if (!vec_size(ftepp->conditions)) {
1558 ftepp_error(ftepp, "#endif without #if");
1561 vec_pop(ftepp->conditions);
1563 ftepp_update_output_condition(ftepp);
1566 else if (!strcmp(ftepp_tokval(ftepp), "include")) {
1567 return ftepp_include(ftepp);
1569 else if (!strcmp(ftepp_tokval(ftepp), "pragma")) {
1570 ftepp_out(ftepp, "#", false);
1573 else if (!strcmp(ftepp_tokval(ftepp), "warning")) {
1574 ftepp_directive_warning(ftepp);
1577 else if (!strcmp(ftepp_tokval(ftepp), "error")) {
1578 ftepp_directive_error(ftepp);
1581 else if (!strcmp(ftepp_tokval(ftepp), "message")) {
1582 ftepp_directive_message(ftepp);
1586 if (ftepp->output_on) {
1587 ftepp_error(ftepp, "unrecognized preprocessor directive: `%s`", ftepp_tokval(ftepp));
1594 /* break; never reached */
1596 ftepp_error(ftepp, "unexpected preprocessor token: `%s`", ftepp_tokval(ftepp));
1599 ftepp_errorat(ftepp, ctx, "empty preprocessor directive");
1602 ftepp_error(ftepp, "missing newline at end of file", ftepp_tokval(ftepp));
1605 /* Builtins! Don't forget the builtins! */
1606 case TOKEN_INTCONST:
1607 case TOKEN_FLOATCONST:
1608 ftepp_out(ftepp, "#", false);
1611 if (!ftepp_skipspace(ftepp))
1616 static bool ftepp_preprocess(ftepp_t *ftepp)
1619 bool newline = true;
1622 char *expand = NULL;
1625 ftepp->lex->flags.preprocessing = true;
1626 ftepp->lex->flags.mergelines = false;
1627 ftepp->lex->flags.noops = true;
1632 if (ftepp->token >= TOKEN_EOF)
1638 switch (ftepp->token) {
1641 case TOKEN_TYPENAME:
1642 /* is it a predef? */
1643 if (OPTS_FLAG(FTEPP_PREDEFS)) {
1644 for (i = 0; i < sizeof(ftepp_predefs) / sizeof (*ftepp_predefs); i++) {
1645 if (!strcmp(ftepp_predefs[i].name, ftepp_tokval(ftepp))) {
1646 expand = ftepp_predefs[i].func(ftepp->lex);
1647 ftepp_out(ftepp, expand, false);
1648 ftepp_next(ftepp); /* skip */
1650 mem_d(expand); /* free memory */
1656 if (ftepp->output_on)
1657 macro = ftepp_macro_find(ftepp, ftepp_tokval(ftepp));
1662 ftepp_out(ftepp, ftepp_tokval(ftepp), false);
1666 if (!ftepp_macro_call(ftepp, macro))
1667 ftepp->token = TOKEN_ERROR;
1671 ftepp_out(ftepp, ftepp_tokval(ftepp), false);
1675 ftepp->lex->flags.mergelines = true;
1676 if (ftepp_next(ftepp) >= TOKEN_EOF) {
1677 ftepp_error(ftepp, "error in preprocessor directive");
1678 ftepp->token = TOKEN_ERROR;
1681 if (!ftepp_hash(ftepp))
1682 ftepp->token = TOKEN_ERROR;
1683 ftepp->lex->flags.mergelines = false;
1687 ftepp_out(ftepp, "\n", true);
1691 /* same as default but don't set newline=false */
1692 ftepp_out(ftepp, ftepp_tokval(ftepp), true);
1697 ftepp_out(ftepp, ftepp_tokval(ftepp), false);
1701 } while (!ftepp->errors && ftepp->token < TOKEN_EOF);
1703 /* force a 0 at the end but don't count it as added to the output */
1704 vec_push(ftepp->output_string, 0);
1705 vec_shrinkby(ftepp->output_string, 1);
1707 return (ftepp->token == TOKEN_EOF);
1710 /* Like in parser.c - files keep the previous state so we have one global
1711 * preprocessor. Except here we will want to warn about dangling #ifs.
1713 static ftepp_t *ftepp;
1715 static bool ftepp_preprocess_done()
1718 if (vec_size(ftepp->conditions)) {
1719 if (ftepp_warn(ftepp, WARN_MULTIFILE_IF, "#if spanning multiple files, is this intended?"))
1722 lex_close(ftepp->lex);
1724 if (ftepp->itemname) {
1725 mem_d(ftepp->itemname);
1726 ftepp->itemname = NULL;
1731 bool ftepp_preprocess_file(const char *filename)
1733 ftepp->lex = lex_open(filename);
1734 ftepp->itemname = util_strdup(filename);
1736 con_out("failed to open file \"%s\"\n", filename);
1739 if (!ftepp_preprocess(ftepp))
1741 return ftepp_preprocess_done();
1744 bool ftepp_preprocess_string(const char *name, const char *str)
1746 ftepp->lex = lex_open_string(str, strlen(str), name);
1747 ftepp->itemname = util_strdup(name);
1749 con_out("failed to create lexer for string \"%s\"\n", name);
1752 if (!ftepp_preprocess(ftepp))
1754 return ftepp_preprocess_done();
1758 void ftepp_add_macro(const char *name, const char *value) {
1759 char *create = NULL;
1761 /* use saner path for empty macros */
1763 ftepp_add_define("__builtin__", name);
1767 vec_upload(create, "#define ", 8);
1768 vec_upload(create, name, strlen(name));
1769 vec_push (create, ' ');
1770 vec_upload(create, value, strlen(value));
1771 vec_push (create, 0);
1773 ftepp_preprocess_string("__builtin__", create);
1782 ftepp = ftepp_new();
1786 memset(minor, 0, sizeof(minor));
1787 memset(major, 0, sizeof(major));
1789 /* set the right macro based on the selected standard */
1790 ftepp_add_define(NULL, "GMQCC");
1791 if (OPTS_OPTION_U32(OPTION_STANDARD) == COMPILER_FTEQCC) {
1792 ftepp_add_define(NULL, "__STD_FTEQCC__");
1801 } else if (OPTS_OPTION_U32(OPTION_STANDARD) == COMPILER_GMQCC) {
1802 ftepp_add_define(NULL, "__STD_GMQCC__");
1803 snprintf(major, 32, "\"%d\"", GMQCC_VERSION_MAJOR);
1804 snprintf(minor, 32, "\"%d\"", GMQCC_VERSION_MINOR);
1805 } else if (OPTS_OPTION_U32(OPTION_STANDARD) == COMPILER_QCCX) {
1806 ftepp_add_define(NULL, "__STD_QCCX__");
1807 snprintf(major, 32, "\"%d\"", GMQCC_VERSION_MAJOR);
1808 snprintf(minor, 32, "\"%d\"", GMQCC_VERSION_MINOR);
1809 } else if (OPTS_OPTION_U32(OPTION_STANDARD) == COMPILER_QCC) {
1810 ftepp_add_define(NULL, "__STD_QCC__");
1821 ftepp_add_macro("__STD_VERSION_MINOR__", minor);
1822 ftepp_add_macro("__STD_VERSION_MAJOR__", major);
1827 void ftepp_add_define(const char *source, const char *name)
1830 lex_ctx ctx = { "__builtin__", 0 };
1832 macro = ppmacro_new(ctx, name);
1833 vec_push(ftepp->macros, macro);
1836 const char *ftepp_get()
1838 return ftepp->output_string;
1843 ftepp_flush_do(ftepp);
1850 ftepp_delete(ftepp);