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 == ',');
398 if (ftepp->token != ')') {
399 ftepp_error(ftepp, "expected closing paren after macro parameter list");
403 /* skipspace happens in ftepp_define */
407 static bool ftepp_define_body(ftepp_t *ftepp, ppmacro *macro)
410 while (ftepp->token != TOKEN_EOL && ftepp->token < TOKEN_EOF) {
411 bool subscript = false;
413 if (macro->variadic && !strcmp(ftepp_tokval(ftepp), "__VA_ARGS__")) {
414 subscript = !!(ftepp_next(ftepp) == '#');
416 if (subscript && ftepp_next(ftepp) != '#') {
417 ftepp_error(ftepp, "expected `##` in __VA_ARGS__ for subscripting");
419 } else if (subscript) {
420 if (ftepp_next(ftepp) == '[') {
421 if (ftepp_next(ftepp) != TOKEN_INTCONST) {
422 ftepp_error(ftepp, "expected index for __VA_ARGS__ subscript");
426 index = (int)strtol(ftepp_tokval(ftepp), NULL, 10);
428 if (ftepp_next(ftepp) != ']') {
429 ftepp_error(ftepp, "expected `]` in __VA_ARGS__ subscript");
434 * mark it as an array to be handled later as such and not
435 * as traditional __VA_ARGS__
437 ftepp->token = TOKEN_VA_ARGS_ARRAY;
438 ptok = pptoken_make(ftepp);
439 ptok->constval.i = index;
440 vec_push(macro->output, ptok);
443 ftepp_error(ftepp, "expected `[` for subscripting of __VA_ARGS__");
447 int old = ftepp->token;
448 ftepp->token = TOKEN_VA_ARGS;
449 ptok = pptoken_make(ftepp);
450 vec_push(macro->output, ptok);
454 else if (macro->variadic && !strcmp(ftepp_tokval(ftepp), "__VA_COUNT__")) {
455 ftepp->token = TOKEN_VA_COUNT;
456 ptok = pptoken_make(ftepp);
457 vec_push(macro->output, ptok);
460 ptok = pptoken_make(ftepp);
461 vec_push(macro->output, ptok);
465 /* recursive expansion can cause EOFs here */
466 if (ftepp->token != TOKEN_EOL && ftepp->token != TOKEN_EOF) {
467 ftepp_error(ftepp, "unexpected junk after macro or unexpected end of file");
473 static bool ftepp_define(ftepp_t *ftepp)
475 ppmacro *macro = NULL;
476 size_t l = ftepp_ctx(ftepp).line;
478 (void)ftepp_next(ftepp);
479 if (!ftepp_skipspace(ftepp))
482 switch (ftepp->token) {
486 macro = ftepp_macro_find(ftepp, ftepp_tokval(ftepp));
487 if (macro && ftepp->output_on) {
488 if (ftepp_warn(ftepp, WARN_CPP, "redefining `%s`", ftepp_tokval(ftepp)))
490 ftepp_macro_delete(ftepp, ftepp_tokval(ftepp));
492 macro = ppmacro_new(ftepp_ctx(ftepp), ftepp_tokval(ftepp));
495 ftepp_error(ftepp, "expected macro name");
499 (void)ftepp_next(ftepp);
501 if (ftepp->token == '(') {
502 macro->has_params = true;
503 if (!ftepp_define_params(ftepp, macro)) {
504 ppmacro_delete(macro);
509 if (!ftepp_skipspace(ftepp)) {
510 ppmacro_delete(macro);
514 if (!ftepp_define_body(ftepp, macro)) {
515 ppmacro_delete(macro);
519 if (ftepp->output_on)
520 vec_push(ftepp->macros, macro);
522 ppmacro_delete(macro);
525 for (; l < ftepp_ctx(ftepp).line; ++l)
526 ftepp_out(ftepp, "\n", true);
531 * When a macro is used we have to handle parameters as well
532 * as special-concatenation via ## or stringification via #
534 * Note: parenthesis can nest, so FOO((a),b) is valid, but only
535 * this kind of parens. Curly braces or [] don't count towards the
542 static void macroparam_clean(macroparam *self)
545 for (i = 0; i < vec_size(self->tokens); ++i)
546 pptoken_delete(self->tokens[i]);
547 vec_free(self->tokens);
550 /* need to leave the last token up */
551 static bool ftepp_macro_call_params(ftepp_t *ftepp, macroparam **out_params)
553 macroparam *params = NULL;
559 if (!ftepp_skipallwhite(ftepp))
561 while (ftepp->token != ')') {
563 if (!ftepp_skipallwhite(ftepp))
565 while (parens || ftepp->token != ',') {
566 if (ftepp->token == '(')
568 else if (ftepp->token == ')') {
573 ptok = pptoken_make(ftepp);
574 vec_push(mp.tokens, ptok);
575 if (ftepp_next(ftepp) >= TOKEN_EOF) {
576 ftepp_error(ftepp, "unexpected EOF in macro call");
580 vec_push(params, mp);
582 if (ftepp->token == ')')
584 if (ftepp->token != ',') {
585 ftepp_error(ftepp, "expected closing paren or comma in macro call");
588 if (ftepp_next(ftepp) >= TOKEN_EOF) {
589 ftepp_error(ftepp, "unexpected EOF in macro call");
593 /* need to leave that up
594 if (ftepp_next(ftepp) >= TOKEN_EOF) {
595 ftepp_error(ftepp, "unexpected EOF in macro call");
599 *out_params = params;
604 macroparam_clean(&mp);
605 for (i = 0; i < vec_size(params); ++i)
606 macroparam_clean(¶ms[i]);
611 static bool macro_params_find(ppmacro *macro, const char *name, size_t *idx)
614 for (i = 0; i < vec_size(macro->params); ++i) {
615 if (!strcmp(macro->params[i], name)) {
623 static void ftepp_stringify_token(ftepp_t *ftepp, pptoken *token)
628 switch (token->token) {
629 case TOKEN_STRINGCONST:
632 /* in preprocessor mode strings already are string,
633 * so we don't get actual newline bytes here.
634 * Still need to escape backslashes and quotes.
637 case '\\': ftepp_out(ftepp, "\\\\", false); break;
638 case '"': ftepp_out(ftepp, "\\\"", false); break;
641 ftepp_out(ftepp, chs, false);
648 ftepp_out(ftepp, " ", false);
651 ftepp_out(ftepp, "\\n", false);
654 ftepp_out(ftepp, token->value, false);
659 static void ftepp_stringify(ftepp_t *ftepp, macroparam *param)
662 ftepp_out(ftepp, "\"", false);
663 for (i = 0; i < vec_size(param->tokens); ++i)
664 ftepp_stringify_token(ftepp, param->tokens[i]);
665 ftepp_out(ftepp, "\"", false);
668 static void ftepp_recursion_header(ftepp_t *ftepp)
670 ftepp_out(ftepp, "\n#pragma push(line)\n", false);
673 static void ftepp_recursion_footer(ftepp_t *ftepp)
675 ftepp_out(ftepp, "\n#pragma pop(line)\n", false);
678 static void ftepp_param_out(ftepp_t *ftepp, macroparam *param)
682 for (i = 0; i < vec_size(param->tokens); ++i) {
683 out = param->tokens[i];
684 if (out->token == TOKEN_EOL)
685 ftepp_out(ftepp, "\n", false);
687 ftepp_out(ftepp, out->value, false);
691 static bool ftepp_preprocess(ftepp_t *ftepp);
692 static bool ftepp_macro_expand(ftepp_t *ftepp, ppmacro *macro, macroparam *params, bool resetline)
695 char *old_string = ftepp->output_string;
697 lex_file *old_lexer = ftepp->lex;
698 size_t vararg_start = vec_size(macro->params);
710 if (vararg_start < vec_size(params))
711 varargs = vec_size(params) - vararg_start;
716 if (!vec_size(macro->output))
719 ftepp->output_string = NULL;
720 for (o = 0; o < vec_size(macro->output); ++o) {
721 pptoken *out = macro->output[o];
722 switch (out->token) {
724 if (!macro->variadic) {
725 ftepp_error(ftepp, "internal preprocessor error: TOKEN_VA_ARGS in non-variadic macro");
726 vec_free(old_string);
733 ftepp_param_out(ftepp, ¶ms[pi + vararg_start]);
734 for (++pi; pi < varargs; ++pi) {
735 ftepp_out(ftepp, ", ", false);
736 ftepp_param_out(ftepp, ¶ms[pi + vararg_start]);
740 case TOKEN_VA_ARGS_ARRAY:
741 if ((size_t)out->constval.i >= varargs) {
742 ftepp_error(ftepp, "subscript of `[%u]` is out of bounds for `__VA_ARGS__`", out->constval.i);
743 vec_free(old_string);
747 ftepp_param_out(ftepp, ¶ms[out->constval.i + vararg_start]);
751 util_asprintf(&buffer, "%d", varargs);
752 ftepp_out(ftepp, buffer, false);
759 if (!macro_params_find(macro, out->value, &pi)) {
760 ftepp_out(ftepp, out->value, false);
763 ftepp_param_out(ftepp, ¶ms[pi]);
766 if (o + 1 < vec_size(macro->output)) {
767 nextok = macro->output[o+1]->token;
769 /* raw concatenation */
773 if ( (nextok == TOKEN_IDENT ||
774 nextok == TOKEN_KEYWORD ||
775 nextok == TOKEN_TYPENAME) &&
776 macro_params_find(macro, macro->output[o+1]->value, &pi))
779 ftepp_stringify(ftepp, ¶ms[pi]);
783 ftepp_out(ftepp, "#", false);
786 ftepp_out(ftepp, "\n", false);
789 ftepp_out(ftepp, out->value, false);
793 vec_push(ftepp->output_string, 0);
794 /* Now run the preprocessor recursively on this string buffer */
796 printf("__________\n%s\n=========\n", ftepp->output_string);
798 inlex = lex_open_string(ftepp->output_string, vec_size(ftepp->output_string)-1, ftepp->lex->name);
800 ftepp_error(ftepp, "internal error: failed to instantiate lexer");
805 inlex->line = ftepp->lex->line;
806 inlex->sline = ftepp->lex->sline;
809 old_inmacro = ftepp->in_macro;
810 ftepp->in_macro = true;
811 ftepp->output_string = NULL;
812 if (!ftepp_preprocess(ftepp)) {
813 ftepp->in_macro = old_inmacro;
814 vec_free(ftepp->lex->open_string);
815 vec_free(ftepp->output_string);
816 lex_close(ftepp->lex);
820 ftepp->in_macro = old_inmacro;
821 vec_free(ftepp->lex->open_string);
822 lex_close(ftepp->lex);
824 inner_string = ftepp->output_string;
825 ftepp->output_string = old_string;
827 has_newlines = (strchr(inner_string, '\n') != NULL);
829 if (has_newlines && !old_inmacro)
830 ftepp_recursion_header(ftepp);
832 vec_append(ftepp->output_string, vec_size(inner_string), inner_string);
833 vec_free(inner_string);
835 if (has_newlines && !old_inmacro)
836 ftepp_recursion_footer(ftepp);
838 if (resetline && !ftepp->in_macro) {
840 snprintf(lineno, 128, "\n#pragma line(%lu)\n", (unsigned long)(old_lexer->sline));
841 ftepp_out(ftepp, lineno, false);
844 old_string = ftepp->output_string;
846 ftepp->lex = old_lexer;
847 ftepp->output_string = old_string;
851 static bool ftepp_macro_call(ftepp_t *ftepp, ppmacro *macro)
854 macroparam *params = NULL;
858 if (!macro->has_params) {
859 if (!ftepp_macro_expand(ftepp, macro, NULL, false))
866 if (!ftepp_skipallwhite(ftepp))
869 if (ftepp->token != '(') {
870 ftepp_error(ftepp, "expected macro parameters in parenthesis");
875 paramline = ftepp->lex->sline;
876 if (!ftepp_macro_call_params(ftepp, ¶ms))
879 if ( vec_size(params) < vec_size(macro->params) ||
880 (vec_size(params) > vec_size(macro->params) && !macro->variadic) )
882 ftepp_error(ftepp, "macro %s expects%s %u paramteters, %u provided", macro->name,
883 (macro->variadic ? " at least" : ""),
884 (unsigned int)vec_size(macro->params),
885 (unsigned int)vec_size(params));
890 if (!ftepp_macro_expand(ftepp, macro, params, (paramline != ftepp->lex->sline)))
895 for (o = 0; o < vec_size(params); ++o)
896 macroparam_clean(¶ms[o]);
902 * #if - the FTEQCC way:
903 * defined(FOO) => true if FOO was #defined regardless of parameters or contents
904 * <numbers> => True if the number is not 0
905 * !<factor> => True if the factor yields false
906 * !!<factor> => ERROR on 2 or more unary nots
907 * <macro> => becomes the macro's FIRST token regardless of parameters
908 * <e> && <e> => True if both expressions are true
909 * <e> || <e> => True if either expression is true
911 * <ident> => False (remember for macros the <macro> rule applies instead)
912 * Unary + and - are weird and wrong in fteqcc so we don't allow them
913 * parenthesis in expressions are allowed
914 * parameter lists on macros are errors
915 * No mathematical calculations are executed
917 static bool ftepp_if_expr(ftepp_t *ftepp, bool *out, double *value_out);
918 static bool ftepp_if_op(ftepp_t *ftepp)
920 ftepp->lex->flags.noops = false;
922 if (!ftepp_skipspace(ftepp))
924 ftepp->lex->flags.noops = true;
927 static bool ftepp_if_value(ftepp_t *ftepp, bool *out, double *value_out)
933 if (!ftepp_skipspace(ftepp))
936 while (ftepp->token == '!') {
939 if (!ftepp_skipspace(ftepp))
943 if (ftepp->token == TOKEN_OPERATOR && !strcmp(ftepp_tokval(ftepp), "-"))
947 if (!ftepp_skipspace(ftepp))
951 switch (ftepp->token) {
955 if (!strcmp(ftepp_tokval(ftepp), "defined")) {
957 if (!ftepp_skipspace(ftepp))
959 if (ftepp->token != '(') {
960 ftepp_error(ftepp, "`defined` keyword in #if requires a macro name in parenthesis");
964 if (!ftepp_skipspace(ftepp))
966 if (ftepp->token != TOKEN_IDENT &&
967 ftepp->token != TOKEN_TYPENAME &&
968 ftepp->token != TOKEN_KEYWORD)
970 ftepp_error(ftepp, "defined() used on an unexpected token type");
973 macro = ftepp_macro_find(ftepp, ftepp_tokval(ftepp));
976 if (!ftepp_skipspace(ftepp))
978 if (ftepp->token != ')') {
979 ftepp_error(ftepp, "expected closing paren");
985 macro = ftepp_macro_find(ftepp, ftepp_tokval(ftepp));
986 if (!macro || !vec_size(macro->output)) {
990 /* This does not expand recursively! */
991 switch (macro->output[0]->token) {
993 *value_out = macro->output[0]->constval.i;
994 *out = !!(macro->output[0]->constval.i);
996 case TOKEN_FLOATCONST:
997 *value_out = macro->output[0]->constval.f;
998 *out = !!(macro->output[0]->constval.f);
1006 case TOKEN_STRINGCONST:
1010 case TOKEN_INTCONST:
1011 *value_out = ftepp->lex->tok.constval.i;
1012 *out = !!(ftepp->lex->tok.constval.i);
1014 case TOKEN_FLOATCONST:
1015 *value_out = ftepp->lex->tok.constval.f;
1016 *out = !!(ftepp->lex->tok.constval.f);
1021 if (!ftepp_if_expr(ftepp, out, value_out))
1023 if (ftepp->token != ')') {
1024 ftepp_error(ftepp, "expected closing paren in #if expression");
1030 ftepp_error(ftepp, "junk in #if: `%s` ...", ftepp_tokval(ftepp));
1031 if (OPTS_OPTION_BOOL(OPTION_DEBUG))
1032 ftepp_error(ftepp, "internal: token %i\n", ftepp->token);
1036 *value_out = -*value_out;
1039 *value_out = (*out ? 1 : 0);
1045 static bool ftepp_if_nextvalue(ftepp_t *ftepp, bool *out, double *value_out)
1047 if (!ftepp_next(ftepp))
1049 return ftepp_if_value(ftepp, out, value_out);
1053 static bool ftepp_if_expr(ftepp_t *ftepp, bool *out, double *value_out)
1055 if (!ftepp_if_value(ftepp, out, value_out))
1058 if (!ftepp_if_op(ftepp))
1061 if (ftepp->token == ')' || ftepp->token != TOKEN_OPERATOR)
1064 /* FTEQCC is all right-associative and no precedence here */
1065 if (!strcmp(ftepp_tokval(ftepp), "&&") ||
1066 !strcmp(ftepp_tokval(ftepp), "||"))
1069 char opc = ftepp_tokval(ftepp)[0];
1073 if (!ftepp_next(ftepp))
1075 if (!ftepp_if_expr(ftepp, &next, &nextvalue))
1079 *out = *out && next;
1081 *out = *out || next;
1083 *value_out = (*out ? 1 : 0);
1086 else if (!strcmp(ftepp_tokval(ftepp), "==") ||
1087 !strcmp(ftepp_tokval(ftepp), "!=") ||
1088 !strcmp(ftepp_tokval(ftepp), ">=") ||
1089 !strcmp(ftepp_tokval(ftepp), "<=") ||
1090 !strcmp(ftepp_tokval(ftepp), ">") ||
1091 !strcmp(ftepp_tokval(ftepp), "<"))
1094 const char opc0 = ftepp_tokval(ftepp)[0];
1095 const char opc1 = ftepp_tokval(ftepp)[1];
1098 if (!ftepp_next(ftepp))
1100 if (!ftepp_if_expr(ftepp, &next, &other))
1104 *out = (*value_out == other);
1105 else if (opc0 == '!')
1106 *out = (*value_out != other);
1107 else if (opc0 == '>') {
1108 if (opc1 == '=') *out = (*value_out >= other);
1109 else *out = (*value_out > other);
1111 else if (opc0 == '<') {
1112 if (opc1 == '=') *out = (*value_out <= other);
1113 else *out = (*value_out < other);
1115 *value_out = (*out ? 1 : 0);
1120 ftepp_error(ftepp, "junk after #if");
1125 static bool ftepp_if(ftepp_t *ftepp, ppcondition *cond)
1127 bool result = false;
1130 memset(cond, 0, sizeof(*cond));
1131 (void)ftepp_next(ftepp);
1133 if (!ftepp_skipspace(ftepp))
1135 if (ftepp->token == TOKEN_EOL) {
1136 ftepp_error(ftepp, "expected expression for #if-directive");
1140 if (!ftepp_if_expr(ftepp, &result, &dummy))
1148 * ifdef is rather simple
1150 static bool ftepp_ifdef(ftepp_t *ftepp, ppcondition *cond)
1153 memset(cond, 0, sizeof(*cond));
1154 (void)ftepp_next(ftepp);
1155 if (!ftepp_skipspace(ftepp))
1158 switch (ftepp->token) {
1160 case TOKEN_TYPENAME:
1162 macro = ftepp_macro_find(ftepp, ftepp_tokval(ftepp));
1165 ftepp_error(ftepp, "expected macro name");
1169 (void)ftepp_next(ftepp);
1170 if (!ftepp_skipspace(ftepp))
1172 /* relaxing this condition
1173 if (ftepp->token != TOKEN_EOL && ftepp->token != TOKEN_EOF) {
1174 ftepp_error(ftepp, "stray tokens after #ifdef");
1183 * undef is also simple
1185 static bool ftepp_undef(ftepp_t *ftepp)
1187 (void)ftepp_next(ftepp);
1188 if (!ftepp_skipspace(ftepp))
1191 if (ftepp->output_on) {
1192 switch (ftepp->token) {
1194 case TOKEN_TYPENAME:
1196 ftepp_macro_delete(ftepp, ftepp_tokval(ftepp));
1199 ftepp_error(ftepp, "expected macro name");
1204 (void)ftepp_next(ftepp);
1205 if (!ftepp_skipspace(ftepp))
1207 /* relaxing this condition
1208 if (ftepp->token != TOKEN_EOL && ftepp->token != TOKEN_EOF) {
1209 ftepp_error(ftepp, "stray tokens after #ifdef");
1216 /* Special unescape-string function which skips a leading quote
1217 * and stops at a quote, not just at \0
1219 static void unescape(const char *str, char *out) {
1221 while (*str && *str != '"') {
1225 case '\\': *out++ = *str; break;
1226 case '"': *out++ = *str; break;
1227 case 'a': *out++ = '\a'; break;
1228 case 'b': *out++ = '\b'; break;
1229 case 'r': *out++ = '\r'; break;
1230 case 'n': *out++ = '\n'; break;
1231 case 't': *out++ = '\t'; break;
1232 case 'f': *out++ = '\f'; break;
1233 case 'v': *out++ = '\v'; break;
1248 static char *ftepp_include_find_path(const char *file, const char *pathfile)
1251 char *filename = NULL;
1252 const char *last_slash;
1258 last_slash = strrchr(pathfile, '/');
1261 len = last_slash - pathfile;
1262 memcpy(vec_add(filename, len), pathfile, len);
1263 vec_push(filename, '/');
1267 memcpy(vec_add(filename, len+1), file, len);
1268 vec_last(filename) = 0;
1270 fp = fs_file_open(filename, "rb");
1279 static char *ftepp_include_find(ftepp_t *ftepp, const char *file)
1281 char *filename = NULL;
1283 filename = ftepp_include_find_path(file, ftepp->includename);
1285 filename = ftepp_include_find_path(file, ftepp->itemname);
1289 static bool ftepp_directive_warning(ftepp_t *ftepp) {
1290 char *message = NULL;
1292 if (!ftepp_skipspace(ftepp))
1295 /* handle the odd non string constant case so it works like C */
1296 if (ftepp->token != TOKEN_STRINGCONST) {
1298 vec_upload(message, "#warning", 8);
1300 while (ftepp->token != TOKEN_EOL) {
1301 vec_upload(message, ftepp_tokval(ftepp), strlen(ftepp_tokval(ftepp)));
1304 vec_push(message, '\0');
1305 if (ftepp->output_on)
1306 store = ftepp_warn(ftepp, WARN_CPP, message);
1313 if (!ftepp->output_on)
1316 unescape (ftepp_tokval(ftepp), ftepp_tokval(ftepp));
1317 return ftepp_warn(ftepp, WARN_CPP, "#warning %s", ftepp_tokval(ftepp));
1320 static void ftepp_directive_error(ftepp_t *ftepp) {
1321 char *message = NULL;
1323 if (!ftepp_skipspace(ftepp))
1326 /* handle the odd non string constant case so it works like C */
1327 if (ftepp->token != TOKEN_STRINGCONST) {
1328 vec_upload(message, "#error", 6);
1330 while (ftepp->token != TOKEN_EOL) {
1331 vec_upload(message, ftepp_tokval(ftepp), strlen(ftepp_tokval(ftepp)));
1334 vec_push(message, '\0');
1335 if (ftepp->output_on)
1336 ftepp_error(ftepp, message);
1341 if (!ftepp->output_on)
1344 unescape (ftepp_tokval(ftepp), ftepp_tokval(ftepp));
1345 ftepp_error(ftepp, "#error %s", ftepp_tokval(ftepp));
1348 static void ftepp_directive_message(ftepp_t *ftepp) {
1349 char *message = NULL;
1351 if (!ftepp_skipspace(ftepp))
1354 /* handle the odd non string constant case so it works like C */
1355 if (ftepp->token != TOKEN_STRINGCONST) {
1356 vec_upload(message, "#message", 8);
1358 while (ftepp->token != TOKEN_EOL) {
1359 vec_upload(message, ftepp_tokval(ftepp), strlen(ftepp_tokval(ftepp)));
1362 vec_push(message, '\0');
1363 if (ftepp->output_on)
1364 con_cprintmsg(&ftepp->lex->tok.ctx, LVL_MSG, "message", message);
1369 if (!ftepp->output_on)
1372 unescape (ftepp_tokval(ftepp), ftepp_tokval(ftepp));
1373 con_cprintmsg(&ftepp->lex->tok.ctx, LVL_MSG, "message", ftepp_tokval(ftepp));
1378 * FIXME: do we need/want a -I option?
1379 * FIXME: what about when dealing with files in subdirectories coming from a progs.src?
1381 static bool ftepp_include(ftepp_t *ftepp)
1383 lex_file *old_lexer = ftepp->lex;
1388 char *old_includename;
1390 (void)ftepp_next(ftepp);
1391 if (!ftepp_skipspace(ftepp))
1394 if (ftepp->token != TOKEN_STRINGCONST) {
1395 ftepp_error(ftepp, "expected filename to include");
1399 if (!ftepp->output_on) {
1404 ctx = ftepp_ctx(ftepp);
1406 unescape(ftepp_tokval(ftepp), ftepp_tokval(ftepp));
1408 ftepp_out(ftepp, "\n#pragma file(", false);
1409 ftepp_out(ftepp, ftepp_tokval(ftepp), false);
1410 ftepp_out(ftepp, ")\n#pragma line(1)\n", false);
1412 filename = ftepp_include_find(ftepp, ftepp_tokval(ftepp));
1414 ftepp_error(ftepp, "failed to open include file `%s`", ftepp_tokval(ftepp));
1417 inlex = lex_open(filename);
1419 ftepp_error(ftepp, "open failed on include file `%s`", filename);
1424 old_includename = ftepp->includename;
1425 ftepp->includename = filename;
1426 if (!ftepp_preprocess(ftepp)) {
1427 vec_free(ftepp->includename);
1428 ftepp->includename = old_includename;
1429 lex_close(ftepp->lex);
1430 ftepp->lex = old_lexer;
1433 vec_free(ftepp->includename);
1434 ftepp->includename = old_includename;
1435 lex_close(ftepp->lex);
1436 ftepp->lex = old_lexer;
1438 ftepp_out(ftepp, "\n#pragma file(", false);
1439 ftepp_out(ftepp, ctx.file, false);
1440 snprintf(lineno, sizeof(lineno), ")\n#pragma line(%lu)\n", (unsigned long)(ctx.line+1));
1441 ftepp_out(ftepp, lineno, false);
1444 (void)ftepp_next(ftepp);
1445 if (!ftepp_skipspace(ftepp))
1447 if (ftepp->token != TOKEN_EOL) {
1448 ftepp_error(ftepp, "stray tokens after #include");
1451 (void)ftepp_next(ftepp);
1456 /* Basic structure handlers */
1457 static bool ftepp_else_allowed(ftepp_t *ftepp)
1459 if (!vec_size(ftepp->conditions)) {
1460 ftepp_error(ftepp, "#else without #if");
1463 if (vec_last(ftepp->conditions).had_else) {
1464 ftepp_error(ftepp, "multiple #else for a single #if");
1470 static bool ftepp_hash(ftepp_t *ftepp)
1475 lex_ctx ctx = ftepp_ctx(ftepp);
1477 if (!ftepp_skipspace(ftepp))
1480 switch (ftepp->token) {
1483 case TOKEN_TYPENAME:
1484 if (!strcmp(ftepp_tokval(ftepp), "define")) {
1485 return ftepp_define(ftepp);
1487 else if (!strcmp(ftepp_tokval(ftepp), "undef")) {
1488 return ftepp_undef(ftepp);
1490 else if (!strcmp(ftepp_tokval(ftepp), "ifdef")) {
1491 if (!ftepp_ifdef(ftepp, &cond))
1493 cond.was_on = cond.on;
1494 vec_push(ftepp->conditions, cond);
1495 ftepp->output_on = ftepp->output_on && cond.on;
1498 else if (!strcmp(ftepp_tokval(ftepp), "ifndef")) {
1499 if (!ftepp_ifdef(ftepp, &cond))
1502 cond.was_on = cond.on;
1503 vec_push(ftepp->conditions, cond);
1504 ftepp->output_on = ftepp->output_on && cond.on;
1507 else if (!strcmp(ftepp_tokval(ftepp), "elifdef")) {
1508 if (!ftepp_else_allowed(ftepp))
1510 if (!ftepp_ifdef(ftepp, &cond))
1512 pc = &vec_last(ftepp->conditions);
1513 pc->on = !pc->was_on && cond.on;
1514 pc->was_on = pc->was_on || pc->on;
1515 ftepp_update_output_condition(ftepp);
1518 else if (!strcmp(ftepp_tokval(ftepp), "elifndef")) {
1519 if (!ftepp_else_allowed(ftepp))
1521 if (!ftepp_ifdef(ftepp, &cond))
1524 pc = &vec_last(ftepp->conditions);
1525 pc->on = !pc->was_on && cond.on;
1526 pc->was_on = pc->was_on || pc->on;
1527 ftepp_update_output_condition(ftepp);
1530 else if (!strcmp(ftepp_tokval(ftepp), "elif")) {
1531 if (!ftepp_else_allowed(ftepp))
1533 if (!ftepp_if(ftepp, &cond))
1535 pc = &vec_last(ftepp->conditions);
1536 pc->on = !pc->was_on && cond.on;
1537 pc->was_on = pc->was_on || pc->on;
1538 ftepp_update_output_condition(ftepp);
1541 else if (!strcmp(ftepp_tokval(ftepp), "if")) {
1542 if (!ftepp_if(ftepp, &cond))
1544 cond.was_on = cond.on;
1545 vec_push(ftepp->conditions, cond);
1546 ftepp->output_on = ftepp->output_on && cond.on;
1549 else if (!strcmp(ftepp_tokval(ftepp), "else")) {
1550 if (!ftepp_else_allowed(ftepp))
1552 pc = &vec_last(ftepp->conditions);
1553 pc->on = !pc->was_on;
1554 pc->had_else = true;
1556 ftepp_update_output_condition(ftepp);
1559 else if (!strcmp(ftepp_tokval(ftepp), "endif")) {
1560 if (!vec_size(ftepp->conditions)) {
1561 ftepp_error(ftepp, "#endif without #if");
1564 vec_pop(ftepp->conditions);
1566 ftepp_update_output_condition(ftepp);
1569 else if (!strcmp(ftepp_tokval(ftepp), "include")) {
1570 return ftepp_include(ftepp);
1572 else if (!strcmp(ftepp_tokval(ftepp), "pragma")) {
1573 ftepp_out(ftepp, "#", false);
1576 else if (!strcmp(ftepp_tokval(ftepp), "warning")) {
1577 ftepp_directive_warning(ftepp);
1580 else if (!strcmp(ftepp_tokval(ftepp), "error")) {
1581 ftepp_directive_error(ftepp);
1584 else if (!strcmp(ftepp_tokval(ftepp), "message")) {
1585 ftepp_directive_message(ftepp);
1589 if (ftepp->output_on) {
1590 ftepp_error(ftepp, "unrecognized preprocessor directive: `%s`", ftepp_tokval(ftepp));
1597 /* break; never reached */
1599 ftepp_error(ftepp, "unexpected preprocessor token: `%s`", ftepp_tokval(ftepp));
1602 ftepp_errorat(ftepp, ctx, "empty preprocessor directive");
1605 ftepp_error(ftepp, "missing newline at end of file", ftepp_tokval(ftepp));
1608 /* Builtins! Don't forget the builtins! */
1609 case TOKEN_INTCONST:
1610 case TOKEN_FLOATCONST:
1611 ftepp_out(ftepp, "#", false);
1614 if (!ftepp_skipspace(ftepp))
1619 static bool ftepp_preprocess(ftepp_t *ftepp)
1622 bool newline = true;
1625 char *expand = NULL;
1628 ftepp->lex->flags.preprocessing = true;
1629 ftepp->lex->flags.mergelines = false;
1630 ftepp->lex->flags.noops = true;
1635 if (ftepp->token >= TOKEN_EOF)
1641 switch (ftepp->token) {
1644 case TOKEN_TYPENAME:
1645 /* is it a predef? */
1646 if (OPTS_FLAG(FTEPP_PREDEFS)) {
1647 for (i = 0; i < sizeof(ftepp_predefs) / sizeof (*ftepp_predefs); i++) {
1648 if (!strcmp(ftepp_predefs[i].name, ftepp_tokval(ftepp))) {
1649 expand = ftepp_predefs[i].func(ftepp->lex);
1650 ftepp_out(ftepp, expand, false);
1651 ftepp_next(ftepp); /* skip */
1653 mem_d(expand); /* free memory */
1659 if (ftepp->output_on)
1660 macro = ftepp_macro_find(ftepp, ftepp_tokval(ftepp));
1665 ftepp_out(ftepp, ftepp_tokval(ftepp), false);
1669 if (!ftepp_macro_call(ftepp, macro))
1670 ftepp->token = TOKEN_ERROR;
1674 ftepp_out(ftepp, ftepp_tokval(ftepp), false);
1678 ftepp->lex->flags.mergelines = true;
1679 if (ftepp_next(ftepp) >= TOKEN_EOF) {
1680 ftepp_error(ftepp, "error in preprocessor directive");
1681 ftepp->token = TOKEN_ERROR;
1684 if (!ftepp_hash(ftepp))
1685 ftepp->token = TOKEN_ERROR;
1686 ftepp->lex->flags.mergelines = false;
1690 ftepp_out(ftepp, "\n", true);
1694 /* same as default but don't set newline=false */
1695 ftepp_out(ftepp, ftepp_tokval(ftepp), true);
1700 ftepp_out(ftepp, ftepp_tokval(ftepp), false);
1704 } while (!ftepp->errors && ftepp->token < TOKEN_EOF);
1706 /* force a 0 at the end but don't count it as added to the output */
1707 vec_push(ftepp->output_string, 0);
1708 vec_shrinkby(ftepp->output_string, 1);
1710 return (ftepp->token == TOKEN_EOF);
1713 /* Like in parser.c - files keep the previous state so we have one global
1714 * preprocessor. Except here we will want to warn about dangling #ifs.
1716 static ftepp_t *ftepp;
1718 static bool ftepp_preprocess_done()
1721 if (vec_size(ftepp->conditions)) {
1722 if (ftepp_warn(ftepp, WARN_MULTIFILE_IF, "#if spanning multiple files, is this intended?"))
1725 lex_close(ftepp->lex);
1727 if (ftepp->itemname) {
1728 mem_d(ftepp->itemname);
1729 ftepp->itemname = NULL;
1734 bool ftepp_preprocess_file(const char *filename)
1736 ftepp->lex = lex_open(filename);
1737 ftepp->itemname = util_strdup(filename);
1739 con_out("failed to open file \"%s\"\n", filename);
1742 if (!ftepp_preprocess(ftepp))
1744 return ftepp_preprocess_done();
1747 bool ftepp_preprocess_string(const char *name, const char *str)
1749 ftepp->lex = lex_open_string(str, strlen(str), name);
1750 ftepp->itemname = util_strdup(name);
1752 con_out("failed to create lexer for string \"%s\"\n", name);
1755 if (!ftepp_preprocess(ftepp))
1757 return ftepp_preprocess_done();
1761 void ftepp_add_macro(const char *name, const char *value) {
1762 char *create = NULL;
1764 /* use saner path for empty macros */
1766 ftepp_add_define("__builtin__", name);
1770 vec_upload(create, "#define ", 8);
1771 vec_upload(create, name, strlen(name));
1772 vec_push (create, ' ');
1773 vec_upload(create, value, strlen(value));
1774 vec_push (create, 0);
1776 ftepp_preprocess_string("__builtin__", create);
1785 ftepp = ftepp_new();
1789 memset(minor, 0, sizeof(minor));
1790 memset(major, 0, sizeof(major));
1792 /* set the right macro based on the selected standard */
1793 ftepp_add_define(NULL, "GMQCC");
1794 if (OPTS_OPTION_U32(OPTION_STANDARD) == COMPILER_FTEQCC) {
1795 ftepp_add_define(NULL, "__STD_FTEQCC__");
1804 } else if (OPTS_OPTION_U32(OPTION_STANDARD) == COMPILER_GMQCC) {
1805 ftepp_add_define(NULL, "__STD_GMQCC__");
1806 snprintf(major, 32, "\"%d\"", GMQCC_VERSION_MAJOR);
1807 snprintf(minor, 32, "\"%d\"", GMQCC_VERSION_MINOR);
1808 } else if (OPTS_OPTION_U32(OPTION_STANDARD) == COMPILER_QCCX) {
1809 ftepp_add_define(NULL, "__STD_QCCX__");
1810 snprintf(major, 32, "\"%d\"", GMQCC_VERSION_MAJOR);
1811 snprintf(minor, 32, "\"%d\"", GMQCC_VERSION_MINOR);
1812 } else if (OPTS_OPTION_U32(OPTION_STANDARD) == COMPILER_QCC) {
1813 ftepp_add_define(NULL, "__STD_QCC__");
1824 ftepp_add_macro("__STD_VERSION_MINOR__", minor);
1825 ftepp_add_macro("__STD_VERSION_MAJOR__", major);
1830 void ftepp_add_define(const char *source, const char *name)
1833 lex_ctx ctx = { "__builtin__", 0 };
1835 macro = ppmacro_new(ctx, name);
1836 vec_push(ftepp->macros, macro);
1839 const char *ftepp_get()
1841 return ftepp->output_string;
1846 ftepp_flush_do(ftepp);
1853 ftepp_delete(ftepp);