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 memset (value, 0, length);
128 sprintf(value, "\"%s\"", context->name);
132 /* __COUNTER_LAST__ */
133 char *ftepp_predef_counterlast(lex_file *context) {
135 util_asprintf(&value, "%u", ftepp_predef_countval);
141 char *ftepp_predef_counter(lex_file *context) {
143 ftepp_predef_countval ++;
144 util_asprintf(&value, "%u", ftepp_predef_countval);
150 char *ftepp_predef_random(lex_file *context) {
152 ftepp_predef_randval = (util_rand() % 0xFF) + 1;
153 util_asprintf(&value, "%u", ftepp_predef_randval);
158 /* __RANDOM_LAST__ */
159 char *ftepp_predef_randomlast(lex_file *context) {
161 util_asprintf(&value, "%u", ftepp_predef_randval);
167 const ftepp_predef_t ftepp_predefs[FTEPP_PREDEF_COUNT] = {
168 { "__LINE__", &ftepp_predef_line },
169 { "__FILE__", &ftepp_predef_file },
170 { "__COUNTER__", &ftepp_predef_counter },
171 { "__COUNTER_LAST__", &ftepp_predef_counterlast },
172 { "__RANDOM__", &ftepp_predef_random },
173 { "__RANDOM_LAST__", &ftepp_predef_randomlast },
174 { "__DATE__", &ftepp_predef_date },
175 { "__TIME__", &ftepp_predef_time }
178 #define ftepp_tokval(f) ((f)->lex->tok.value)
179 #define ftepp_ctx(f) ((f)->lex->tok.ctx)
181 static void ftepp_errorat(ftepp_t *ftepp, lex_ctx ctx, const char *fmt, ...)
188 con_cvprintmsg((void*)&ctx, LVL_ERROR, "error", fmt, ap);
192 static void ftepp_error(ftepp_t *ftepp, const char *fmt, ...)
199 con_cvprintmsg((void*)&ftepp->lex->tok.ctx, LVL_ERROR, "error", fmt, ap);
203 static bool GMQCC_WARN ftepp_warn(ftepp_t *ftepp, int warntype, const char *fmt, ...)
209 r = vcompile_warning(ftepp->lex->tok.ctx, warntype, fmt, ap);
214 static pptoken *pptoken_make(ftepp_t *ftepp)
216 pptoken *token = (pptoken*)mem_a(sizeof(pptoken));
217 token->token = ftepp->token;
219 if (token->token == TOKEN_WHITE)
220 token->value = util_strdup(" ");
223 token->value = util_strdup(ftepp_tokval(ftepp));
225 memcpy(&token->constval, &ftepp->lex->tok.constval, sizeof(token->constval));
229 static void pptoken_delete(pptoken *self)
235 static ppmacro *ppmacro_new(lex_ctx ctx, const char *name)
237 ppmacro *macro = (ppmacro*)mem_a(sizeof(ppmacro));
240 memset(macro, 0, sizeof(*macro));
241 macro->name = util_strdup(name);
245 static void ppmacro_delete(ppmacro *self)
248 for (i = 0; i < vec_size(self->params); ++i)
249 mem_d(self->params[i]);
250 vec_free(self->params);
251 for (i = 0; i < vec_size(self->output); ++i)
252 pptoken_delete(self->output[i]);
253 vec_free(self->output);
258 static ftepp_t* ftepp_new()
262 ftepp = (ftepp_t*)mem_a(sizeof(*ftepp));
263 memset(ftepp, 0, sizeof(*ftepp));
265 ftepp->output_on = true;
270 static void ftepp_flush_do(ftepp_t *self)
272 vec_free(self->output_string);
275 static void ftepp_delete(ftepp_t *self)
278 ftepp_flush_do(self);
280 mem_d(self->itemname);
281 if (self->includename)
282 vec_free(self->includename);
283 for (i = 0; i < vec_size(self->macros); ++i)
284 ppmacro_delete(self->macros[i]);
285 vec_free(self->macros);
286 vec_free(self->conditions);
288 lex_close(self->lex);
292 static void ftepp_out(ftepp_t *ftepp, const char *str, bool ignore_cond)
294 if (ignore_cond || ftepp->output_on)
299 data = vec_add(ftepp->output_string, len);
300 memcpy(data, str, len);
304 static void ftepp_update_output_condition(ftepp_t *ftepp)
307 ftepp->output_on = true;
308 for (i = 0; i < vec_size(ftepp->conditions); ++i)
309 ftepp->output_on = ftepp->output_on && ftepp->conditions[i].on;
312 static ppmacro* ftepp_macro_find(ftepp_t *ftepp, const char *name)
315 for (i = 0; i < vec_size(ftepp->macros); ++i) {
316 if (!strcmp(name, ftepp->macros[i]->name))
317 return ftepp->macros[i];
322 static void ftepp_macro_delete(ftepp_t *ftepp, const char *name)
325 for (i = 0; i < vec_size(ftepp->macros); ++i) {
326 if (!strcmp(name, ftepp->macros[i]->name)) {
327 vec_remove(ftepp->macros, i, 1);
333 static GMQCC_INLINE int ftepp_next(ftepp_t *ftepp)
335 return (ftepp->token = lex_do(ftepp->lex));
338 /* Important: this does not skip newlines! */
339 static bool ftepp_skipspace(ftepp_t *ftepp)
341 if (ftepp->token != TOKEN_WHITE)
343 while (ftepp_next(ftepp) == TOKEN_WHITE) {}
344 if (ftepp->token >= TOKEN_EOF) {
345 ftepp_error(ftepp, "unexpected end of preprocessor directive");
351 /* this one skips EOLs as well */
352 static bool ftepp_skipallwhite(ftepp_t *ftepp)
354 if (ftepp->token != TOKEN_WHITE && ftepp->token != TOKEN_EOL)
358 } while (ftepp->token == TOKEN_WHITE || ftepp->token == TOKEN_EOL);
359 if (ftepp->token >= TOKEN_EOF) {
360 ftepp_error(ftepp, "unexpected end of preprocessor directive");
367 * The huge macro parsing code...
369 static bool ftepp_define_params(ftepp_t *ftepp, ppmacro *macro)
373 if (!ftepp_skipspace(ftepp))
375 if (ftepp->token == ')')
377 switch (ftepp->token) {
381 vec_push(macro->params, util_strdup(ftepp_tokval(ftepp)));
384 macro->variadic = true;
387 ftepp_error(ftepp, "unexpected token in parameter list");
391 if (!ftepp_skipspace(ftepp))
393 if (macro->variadic && ftepp->token != ')') {
394 ftepp_error(ftepp, "cannot have parameters after the variadic parameters");
397 } 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 = atoi(ftepp_tokval(ftepp));
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)
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))
507 if (!ftepp_skipspace(ftepp))
510 if (!ftepp_define_body(ftepp, macro))
513 if (ftepp->output_on)
514 vec_push(ftepp->macros, macro);
516 ppmacro_delete(macro);
519 for (; l < ftepp_ctx(ftepp).line; ++l)
520 ftepp_out(ftepp, "\n", true);
525 * When a macro is used we have to handle parameters as well
526 * as special-concatenation via ## or stringification via #
528 * Note: parenthesis can nest, so FOO((a),b) is valid, but only
529 * this kind of parens. Curly braces or [] don't count towards the
536 static void macroparam_clean(macroparam *self)
539 for (i = 0; i < vec_size(self->tokens); ++i)
540 pptoken_delete(self->tokens[i]);
541 vec_free(self->tokens);
544 /* need to leave the last token up */
545 static bool ftepp_macro_call_params(ftepp_t *ftepp, macroparam **out_params)
547 macroparam *params = NULL;
553 if (!ftepp_skipallwhite(ftepp))
555 while (ftepp->token != ')') {
557 if (!ftepp_skipallwhite(ftepp))
559 while (parens || ftepp->token != ',') {
560 if (ftepp->token == '(')
562 else if (ftepp->token == ')') {
567 ptok = pptoken_make(ftepp);
568 vec_push(mp.tokens, ptok);
569 if (ftepp_next(ftepp) >= TOKEN_EOF) {
570 ftepp_error(ftepp, "unexpected EOF in macro call");
574 vec_push(params, mp);
576 if (ftepp->token == ')')
578 if (ftepp->token != ',') {
579 ftepp_error(ftepp, "expected closing paren or comma in macro call");
582 if (ftepp_next(ftepp) >= TOKEN_EOF) {
583 ftepp_error(ftepp, "unexpected EOF in macro call");
587 /* need to leave that up
588 if (ftepp_next(ftepp) >= TOKEN_EOF) {
589 ftepp_error(ftepp, "unexpected EOF in macro call");
593 *out_params = params;
598 macroparam_clean(&mp);
599 for (i = 0; i < vec_size(params); ++i)
600 macroparam_clean(¶ms[i]);
605 static bool macro_params_find(ppmacro *macro, const char *name, size_t *idx)
608 for (i = 0; i < vec_size(macro->params); ++i) {
609 if (!strcmp(macro->params[i], name)) {
617 static void ftepp_stringify_token(ftepp_t *ftepp, pptoken *token)
622 switch (token->token) {
623 case TOKEN_STRINGCONST:
626 /* in preprocessor mode strings already are string,
627 * so we don't get actual newline bytes here.
628 * Still need to escape backslashes and quotes.
631 case '\\': ftepp_out(ftepp, "\\\\", false); break;
632 case '"': ftepp_out(ftepp, "\\\"", false); break;
635 ftepp_out(ftepp, chs, false);
642 ftepp_out(ftepp, " ", false);
645 ftepp_out(ftepp, "\\n", false);
648 ftepp_out(ftepp, token->value, false);
653 static void ftepp_stringify(ftepp_t *ftepp, macroparam *param)
656 ftepp_out(ftepp, "\"", false);
657 for (i = 0; i < vec_size(param->tokens); ++i)
658 ftepp_stringify_token(ftepp, param->tokens[i]);
659 ftepp_out(ftepp, "\"", false);
662 static void ftepp_recursion_header(ftepp_t *ftepp)
664 ftepp_out(ftepp, "\n#pragma push(line)\n", false);
667 static void ftepp_recursion_footer(ftepp_t *ftepp)
669 ftepp_out(ftepp, "\n#pragma pop(line)\n", false);
672 static void ftepp_param_out(ftepp_t *ftepp, macroparam *param)
676 for (i = 0; i < vec_size(param->tokens); ++i) {
677 out = param->tokens[i];
678 if (out->token == TOKEN_EOL)
679 ftepp_out(ftepp, "\n", false);
681 ftepp_out(ftepp, out->value, false);
685 static bool ftepp_preprocess(ftepp_t *ftepp);
686 static bool ftepp_macro_expand(ftepp_t *ftepp, ppmacro *macro, macroparam *params, bool resetline)
689 char *old_string = ftepp->output_string;
691 lex_file *old_lexer = ftepp->lex;
692 size_t vararg_start = vec_size(macro->params);
704 if (vararg_start < vec_size(params))
705 varargs = vec_size(params) - vararg_start;
710 if (!vec_size(macro->output))
713 ftepp->output_string = NULL;
714 for (o = 0; o < vec_size(macro->output); ++o) {
715 pptoken *out = macro->output[o];
716 switch (out->token) {
718 if (!macro->variadic) {
719 ftepp_error(ftepp, "internal preprocessor error: TOKEN_VA_ARGS in non-variadic macro");
720 vec_free(old_string);
727 ftepp_param_out(ftepp, ¶ms[pi + vararg_start]);
728 for (++pi; pi < varargs; ++pi) {
729 ftepp_out(ftepp, ", ", false);
730 ftepp_param_out(ftepp, ¶ms[pi + vararg_start]);
734 case TOKEN_VA_ARGS_ARRAY:
735 if ((size_t)out->constval.i >= varargs) {
736 ftepp_error(ftepp, "subscript of `[%u]` is out of bounds for `__VA_ARGS__`", out->constval.i);
737 vec_free(old_string);
741 ftepp_param_out(ftepp, ¶ms[out->constval.i + vararg_start]);
745 util_asprintf(&buffer, "%d", varargs);
746 ftepp_out(ftepp, buffer, false);
753 if (!macro_params_find(macro, out->value, &pi)) {
754 ftepp_out(ftepp, out->value, false);
757 ftepp_param_out(ftepp, ¶ms[pi]);
760 if (o + 1 < vec_size(macro->output)) {
761 nextok = macro->output[o+1]->token;
763 /* raw concatenation */
767 if ( (nextok == TOKEN_IDENT ||
768 nextok == TOKEN_KEYWORD ||
769 nextok == TOKEN_TYPENAME) &&
770 macro_params_find(macro, macro->output[o+1]->value, &pi))
773 ftepp_stringify(ftepp, ¶ms[pi]);
777 ftepp_out(ftepp, "#", false);
780 ftepp_out(ftepp, "\n", false);
783 ftepp_out(ftepp, out->value, false);
787 vec_push(ftepp->output_string, 0);
788 /* Now run the preprocessor recursively on this string buffer */
790 printf("__________\n%s\n=========\n", ftepp->output_string);
792 inlex = lex_open_string(ftepp->output_string, vec_size(ftepp->output_string)-1, ftepp->lex->name);
794 ftepp_error(ftepp, "internal error: failed to instantiate lexer");
799 inlex->line = ftepp->lex->line;
800 inlex->sline = ftepp->lex->sline;
803 old_inmacro = ftepp->in_macro;
804 ftepp->in_macro = true;
805 ftepp->output_string = NULL;
806 if (!ftepp_preprocess(ftepp)) {
807 ftepp->in_macro = old_inmacro;
808 vec_free(ftepp->lex->open_string);
809 vec_free(ftepp->output_string);
810 lex_close(ftepp->lex);
814 ftepp->in_macro = old_inmacro;
815 vec_free(ftepp->lex->open_string);
816 lex_close(ftepp->lex);
818 inner_string = ftepp->output_string;
819 ftepp->output_string = old_string;
821 has_newlines = (strchr(inner_string, '\n') != NULL);
823 if (has_newlines && !old_inmacro)
824 ftepp_recursion_header(ftepp);
826 vec_append(ftepp->output_string, vec_size(inner_string), inner_string);
827 vec_free(inner_string);
829 if (has_newlines && !old_inmacro)
830 ftepp_recursion_footer(ftepp);
832 if (resetline && !ftepp->in_macro) {
834 sprintf(lineno, "\n#pragma line(%lu)\n", (unsigned long)(old_lexer->sline));
835 ftepp_out(ftepp, lineno, false);
838 old_string = ftepp->output_string;
840 ftepp->lex = old_lexer;
841 ftepp->output_string = old_string;
845 static bool ftepp_macro_call(ftepp_t *ftepp, ppmacro *macro)
848 macroparam *params = NULL;
852 if (!macro->has_params) {
853 if (!ftepp_macro_expand(ftepp, macro, NULL, false))
860 if (!ftepp_skipallwhite(ftepp))
863 if (ftepp->token != '(') {
864 ftepp_error(ftepp, "expected macro parameters in parenthesis");
869 paramline = ftepp->lex->sline;
870 if (!ftepp_macro_call_params(ftepp, ¶ms))
873 if ( vec_size(params) < vec_size(macro->params) ||
874 (vec_size(params) > vec_size(macro->params) && !macro->variadic) )
876 ftepp_error(ftepp, "macro %s expects%s %u paramteters, %u provided", macro->name,
877 (macro->variadic ? " at least" : ""),
878 (unsigned int)vec_size(macro->params),
879 (unsigned int)vec_size(params));
884 if (!ftepp_macro_expand(ftepp, macro, params, (paramline != ftepp->lex->sline)))
889 for (o = 0; o < vec_size(params); ++o)
890 macroparam_clean(¶ms[o]);
896 * #if - the FTEQCC way:
897 * defined(FOO) => true if FOO was #defined regardless of parameters or contents
898 * <numbers> => True if the number is not 0
899 * !<factor> => True if the factor yields false
900 * !!<factor> => ERROR on 2 or more unary nots
901 * <macro> => becomes the macro's FIRST token regardless of parameters
902 * <e> && <e> => True if both expressions are true
903 * <e> || <e> => True if either expression is true
905 * <ident> => False (remember for macros the <macro> rule applies instead)
906 * Unary + and - are weird and wrong in fteqcc so we don't allow them
907 * parenthesis in expressions are allowed
908 * parameter lists on macros are errors
909 * No mathematical calculations are executed
911 static bool ftepp_if_expr(ftepp_t *ftepp, bool *out, double *value_out);
912 static bool ftepp_if_op(ftepp_t *ftepp)
914 ftepp->lex->flags.noops = false;
916 if (!ftepp_skipspace(ftepp))
918 ftepp->lex->flags.noops = true;
921 static bool ftepp_if_value(ftepp_t *ftepp, bool *out, double *value_out)
927 if (!ftepp_skipspace(ftepp))
930 while (ftepp->token == '!') {
933 if (!ftepp_skipspace(ftepp))
937 if (ftepp->token == TOKEN_OPERATOR && !strcmp(ftepp_tokval(ftepp), "-"))
941 if (!ftepp_skipspace(ftepp))
945 switch (ftepp->token) {
949 if (!strcmp(ftepp_tokval(ftepp), "defined")) {
951 if (!ftepp_skipspace(ftepp))
953 if (ftepp->token != '(') {
954 ftepp_error(ftepp, "`defined` keyword in #if requires a macro name in parenthesis");
958 if (!ftepp_skipspace(ftepp))
960 if (ftepp->token != TOKEN_IDENT &&
961 ftepp->token != TOKEN_TYPENAME &&
962 ftepp->token != TOKEN_KEYWORD)
964 ftepp_error(ftepp, "defined() used on an unexpected token type");
967 macro = ftepp_macro_find(ftepp, ftepp_tokval(ftepp));
970 if (!ftepp_skipspace(ftepp))
972 if (ftepp->token != ')') {
973 ftepp_error(ftepp, "expected closing paren");
979 macro = ftepp_macro_find(ftepp, ftepp_tokval(ftepp));
980 if (!macro || !vec_size(macro->output)) {
984 /* This does not expand recursively! */
985 switch (macro->output[0]->token) {
987 *value_out = macro->output[0]->constval.i;
988 *out = !!(macro->output[0]->constval.i);
990 case TOKEN_FLOATCONST:
991 *value_out = macro->output[0]->constval.f;
992 *out = !!(macro->output[0]->constval.f);
1000 case TOKEN_STRINGCONST:
1004 case TOKEN_INTCONST:
1005 *value_out = ftepp->lex->tok.constval.i;
1006 *out = !!(ftepp->lex->tok.constval.i);
1008 case TOKEN_FLOATCONST:
1009 *value_out = ftepp->lex->tok.constval.f;
1010 *out = !!(ftepp->lex->tok.constval.f);
1015 if (!ftepp_if_expr(ftepp, out, value_out))
1017 if (ftepp->token != ')') {
1018 ftepp_error(ftepp, "expected closing paren in #if expression");
1024 ftepp_error(ftepp, "junk in #if: `%s` ...", ftepp_tokval(ftepp));
1025 if (OPTS_OPTION_BOOL(OPTION_DEBUG))
1026 ftepp_error(ftepp, "internal: token %i\n", ftepp->token);
1030 *value_out = -*value_out;
1033 *value_out = (*out ? 1 : 0);
1039 static bool ftepp_if_nextvalue(ftepp_t *ftepp, bool *out, double *value_out)
1041 if (!ftepp_next(ftepp))
1043 return ftepp_if_value(ftepp, out, value_out);
1047 static bool ftepp_if_expr(ftepp_t *ftepp, bool *out, double *value_out)
1049 if (!ftepp_if_value(ftepp, out, value_out))
1052 if (!ftepp_if_op(ftepp))
1055 if (ftepp->token == ')' || ftepp->token != TOKEN_OPERATOR)
1058 /* FTEQCC is all right-associative and no precedence here */
1059 if (!strcmp(ftepp_tokval(ftepp), "&&") ||
1060 !strcmp(ftepp_tokval(ftepp), "||"))
1063 char opc = ftepp_tokval(ftepp)[0];
1067 if (!ftepp_next(ftepp))
1069 if (!ftepp_if_expr(ftepp, &next, &nextvalue))
1073 *out = *out && next;
1075 *out = *out || next;
1077 *value_out = (*out ? 1 : 0);
1080 else if (!strcmp(ftepp_tokval(ftepp), "==") ||
1081 !strcmp(ftepp_tokval(ftepp), "!=") ||
1082 !strcmp(ftepp_tokval(ftepp), ">=") ||
1083 !strcmp(ftepp_tokval(ftepp), "<=") ||
1084 !strcmp(ftepp_tokval(ftepp), ">") ||
1085 !strcmp(ftepp_tokval(ftepp), "<"))
1088 const char opc0 = ftepp_tokval(ftepp)[0];
1089 const char opc1 = ftepp_tokval(ftepp)[1];
1092 if (!ftepp_next(ftepp))
1094 if (!ftepp_if_expr(ftepp, &next, &other))
1098 *out = (*value_out == other);
1099 else if (opc0 == '!')
1100 *out = (*value_out != other);
1101 else if (opc0 == '>') {
1102 if (opc1 == '=') *out = (*value_out >= other);
1103 else *out = (*value_out > other);
1105 else if (opc0 == '<') {
1106 if (opc1 == '=') *out = (*value_out <= other);
1107 else *out = (*value_out < other);
1109 *value_out = (*out ? 1 : 0);
1114 ftepp_error(ftepp, "junk after #if");
1119 static bool ftepp_if(ftepp_t *ftepp, ppcondition *cond)
1121 bool result = false;
1124 memset(cond, 0, sizeof(*cond));
1125 (void)ftepp_next(ftepp);
1127 if (!ftepp_skipspace(ftepp))
1129 if (ftepp->token == TOKEN_EOL) {
1130 ftepp_error(ftepp, "expected expression for #if-directive");
1134 if (!ftepp_if_expr(ftepp, &result, &dummy))
1142 * ifdef is rather simple
1144 static bool ftepp_ifdef(ftepp_t *ftepp, ppcondition *cond)
1147 memset(cond, 0, sizeof(*cond));
1148 (void)ftepp_next(ftepp);
1149 if (!ftepp_skipspace(ftepp))
1152 switch (ftepp->token) {
1154 case TOKEN_TYPENAME:
1156 macro = ftepp_macro_find(ftepp, ftepp_tokval(ftepp));
1159 ftepp_error(ftepp, "expected macro name");
1163 (void)ftepp_next(ftepp);
1164 if (!ftepp_skipspace(ftepp))
1166 /* relaxing this condition
1167 if (ftepp->token != TOKEN_EOL && ftepp->token != TOKEN_EOF) {
1168 ftepp_error(ftepp, "stray tokens after #ifdef");
1177 * undef is also simple
1179 static bool ftepp_undef(ftepp_t *ftepp)
1181 (void)ftepp_next(ftepp);
1182 if (!ftepp_skipspace(ftepp))
1185 if (ftepp->output_on) {
1186 switch (ftepp->token) {
1188 case TOKEN_TYPENAME:
1190 ftepp_macro_delete(ftepp, ftepp_tokval(ftepp));
1193 ftepp_error(ftepp, "expected macro name");
1198 (void)ftepp_next(ftepp);
1199 if (!ftepp_skipspace(ftepp))
1201 /* relaxing this condition
1202 if (ftepp->token != TOKEN_EOL && ftepp->token != TOKEN_EOF) {
1203 ftepp_error(ftepp, "stray tokens after #ifdef");
1210 /* Special unescape-string function which skips a leading quote
1211 * and stops at a quote, not just at \0
1213 static void unescape(const char *str, char *out) {
1215 while (*str && *str != '"') {
1219 case '\\': *out++ = *str; break;
1220 case '"': *out++ = *str; break;
1221 case 'a': *out++ = '\a'; break;
1222 case 'b': *out++ = '\b'; break;
1223 case 'r': *out++ = '\r'; break;
1224 case 'n': *out++ = '\n'; break;
1225 case 't': *out++ = '\t'; break;
1226 case 'f': *out++ = '\f'; break;
1227 case 'v': *out++ = '\v'; break;
1242 static char *ftepp_include_find_path(const char *file, const char *pathfile)
1245 char *filename = NULL;
1246 const char *last_slash;
1252 last_slash = strrchr(pathfile, '/');
1255 len = last_slash - pathfile;
1256 memcpy(vec_add(filename, len), pathfile, len);
1257 vec_push(filename, '/');
1261 memcpy(vec_add(filename, len+1), file, len);
1262 vec_last(filename) = 0;
1264 fp = fs_file_open(filename, "rb");
1273 static char *ftepp_include_find(ftepp_t *ftepp, const char *file)
1275 char *filename = NULL;
1277 filename = ftepp_include_find_path(file, ftepp->includename);
1279 filename = ftepp_include_find_path(file, ftepp->itemname);
1283 static bool ftepp_directive_warning(ftepp_t *ftepp) {
1284 char *message = NULL;
1286 if (!ftepp_skipspace(ftepp))
1289 /* handle the odd non string constant case so it works like C */
1290 if (ftepp->token != TOKEN_STRINGCONST) {
1292 vec_upload(message, "#warning", 8);
1294 while (ftepp->token != TOKEN_EOL) {
1295 vec_upload(message, ftepp_tokval(ftepp), strlen(ftepp_tokval(ftepp)));
1298 vec_push(message, '\0');
1299 if (ftepp->output_on)
1300 store = ftepp_warn(ftepp, WARN_CPP, message);
1307 if (!ftepp->output_on)
1310 unescape (ftepp_tokval(ftepp), ftepp_tokval(ftepp));
1311 return ftepp_warn(ftepp, WARN_CPP, "#warning %s", ftepp_tokval(ftepp));
1314 static void ftepp_directive_error(ftepp_t *ftepp) {
1315 char *message = NULL;
1317 if (!ftepp_skipspace(ftepp))
1320 /* handle the odd non string constant case so it works like C */
1321 if (ftepp->token != TOKEN_STRINGCONST) {
1322 vec_upload(message, "#error", 6);
1324 while (ftepp->token != TOKEN_EOL) {
1325 vec_upload(message, ftepp_tokval(ftepp), strlen(ftepp_tokval(ftepp)));
1328 vec_push(message, '\0');
1329 if (ftepp->output_on)
1330 ftepp_error(ftepp, message);
1335 if (!ftepp->output_on)
1338 unescape (ftepp_tokval(ftepp), ftepp_tokval(ftepp));
1339 ftepp_error(ftepp, "#error %s", ftepp_tokval(ftepp));
1342 static void ftepp_directive_message(ftepp_t *ftepp) {
1343 char *message = NULL;
1345 if (!ftepp_skipspace(ftepp))
1348 /* handle the odd non string constant case so it works like C */
1349 if (ftepp->token != TOKEN_STRINGCONST) {
1350 vec_upload(message, "#message", 8);
1352 while (ftepp->token != TOKEN_EOL) {
1353 vec_upload(message, ftepp_tokval(ftepp), strlen(ftepp_tokval(ftepp)));
1356 vec_push(message, '\0');
1357 if (ftepp->output_on)
1358 con_cprintmsg(&ftepp->lex->tok.ctx, LVL_MSG, "message", message);
1363 if (!ftepp->output_on)
1366 unescape (ftepp_tokval(ftepp), ftepp_tokval(ftepp));
1367 con_cprintmsg(&ftepp->lex->tok.ctx, LVL_MSG, "message", ftepp_tokval(ftepp));
1372 * FIXME: do we need/want a -I option?
1373 * FIXME: what about when dealing with files in subdirectories coming from a progs.src?
1375 static bool ftepp_include(ftepp_t *ftepp)
1377 lex_file *old_lexer = ftepp->lex;
1382 char *old_includename;
1384 (void)ftepp_next(ftepp);
1385 if (!ftepp_skipspace(ftepp))
1388 if (ftepp->token != TOKEN_STRINGCONST) {
1389 ftepp_error(ftepp, "expected filename to include");
1393 ctx = ftepp_ctx(ftepp);
1395 unescape(ftepp_tokval(ftepp), ftepp_tokval(ftepp));
1397 ftepp_out(ftepp, "\n#pragma file(", false);
1398 ftepp_out(ftepp, ftepp_tokval(ftepp), false);
1399 ftepp_out(ftepp, ")\n#pragma line(1)\n", false);
1401 filename = ftepp_include_find(ftepp, ftepp_tokval(ftepp));
1403 ftepp_error(ftepp, "failed to open include file `%s`", ftepp_tokval(ftepp));
1406 inlex = lex_open(filename);
1408 ftepp_error(ftepp, "open failed on include file `%s`", filename);
1413 old_includename = ftepp->includename;
1414 ftepp->includename = filename;
1415 if (!ftepp_preprocess(ftepp)) {
1416 vec_free(ftepp->includename);
1417 ftepp->includename = old_includename;
1418 lex_close(ftepp->lex);
1419 ftepp->lex = old_lexer;
1422 vec_free(ftepp->includename);
1423 ftepp->includename = old_includename;
1424 lex_close(ftepp->lex);
1425 ftepp->lex = old_lexer;
1427 ftepp_out(ftepp, "\n#pragma file(", false);
1428 ftepp_out(ftepp, ctx.file, false);
1429 snprintf(lineno, sizeof(lineno), ")\n#pragma line(%lu)\n", (unsigned long)(ctx.line+1));
1430 ftepp_out(ftepp, lineno, false);
1433 (void)ftepp_next(ftepp);
1434 if (!ftepp_skipspace(ftepp))
1436 if (ftepp->token != TOKEN_EOL) {
1437 ftepp_error(ftepp, "stray tokens after #include");
1440 (void)ftepp_next(ftepp);
1445 /* Basic structure handlers */
1446 static bool ftepp_else_allowed(ftepp_t *ftepp)
1448 if (!vec_size(ftepp->conditions)) {
1449 ftepp_error(ftepp, "#else without #if");
1452 if (vec_last(ftepp->conditions).had_else) {
1453 ftepp_error(ftepp, "multiple #else for a single #if");
1459 static bool ftepp_hash(ftepp_t *ftepp)
1464 lex_ctx ctx = ftepp_ctx(ftepp);
1466 if (!ftepp_skipspace(ftepp))
1469 switch (ftepp->token) {
1472 case TOKEN_TYPENAME:
1473 if (!strcmp(ftepp_tokval(ftepp), "define")) {
1474 return ftepp_define(ftepp);
1476 else if (!strcmp(ftepp_tokval(ftepp), "undef")) {
1477 return ftepp_undef(ftepp);
1479 else if (!strcmp(ftepp_tokval(ftepp), "ifdef")) {
1480 if (!ftepp_ifdef(ftepp, &cond))
1482 cond.was_on = cond.on;
1483 vec_push(ftepp->conditions, cond);
1484 ftepp->output_on = ftepp->output_on && cond.on;
1487 else if (!strcmp(ftepp_tokval(ftepp), "ifndef")) {
1488 if (!ftepp_ifdef(ftepp, &cond))
1491 cond.was_on = cond.on;
1492 vec_push(ftepp->conditions, cond);
1493 ftepp->output_on = ftepp->output_on && cond.on;
1496 else if (!strcmp(ftepp_tokval(ftepp), "elifdef")) {
1497 if (!ftepp_else_allowed(ftepp))
1499 if (!ftepp_ifdef(ftepp, &cond))
1501 pc = &vec_last(ftepp->conditions);
1502 pc->on = !pc->was_on && cond.on;
1503 pc->was_on = pc->was_on || pc->on;
1504 ftepp_update_output_condition(ftepp);
1507 else if (!strcmp(ftepp_tokval(ftepp), "elifndef")) {
1508 if (!ftepp_else_allowed(ftepp))
1510 if (!ftepp_ifdef(ftepp, &cond))
1513 pc = &vec_last(ftepp->conditions);
1514 pc->on = !pc->was_on && cond.on;
1515 pc->was_on = pc->was_on || pc->on;
1516 ftepp_update_output_condition(ftepp);
1519 else if (!strcmp(ftepp_tokval(ftepp), "elif")) {
1520 if (!ftepp_else_allowed(ftepp))
1522 if (!ftepp_if(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), "if")) {
1531 if (!ftepp_if(ftepp, &cond))
1533 cond.was_on = cond.on;
1534 vec_push(ftepp->conditions, cond);
1535 ftepp->output_on = ftepp->output_on && cond.on;
1538 else if (!strcmp(ftepp_tokval(ftepp), "else")) {
1539 if (!ftepp_else_allowed(ftepp))
1541 pc = &vec_last(ftepp->conditions);
1542 pc->on = !pc->was_on;
1543 pc->had_else = true;
1545 ftepp_update_output_condition(ftepp);
1548 else if (!strcmp(ftepp_tokval(ftepp), "endif")) {
1549 if (!vec_size(ftepp->conditions)) {
1550 ftepp_error(ftepp, "#endif without #if");
1553 vec_pop(ftepp->conditions);
1555 ftepp_update_output_condition(ftepp);
1558 else if (!strcmp(ftepp_tokval(ftepp), "include")) {
1559 return ftepp_include(ftepp);
1561 else if (!strcmp(ftepp_tokval(ftepp), "pragma")) {
1562 ftepp_out(ftepp, "#", false);
1565 else if (!strcmp(ftepp_tokval(ftepp), "warning")) {
1566 ftepp_directive_warning(ftepp);
1569 else if (!strcmp(ftepp_tokval(ftepp), "error")) {
1570 ftepp_directive_error(ftepp);
1573 else if (!strcmp(ftepp_tokval(ftepp), "message")) {
1574 ftepp_directive_message(ftepp);
1578 if (ftepp->output_on) {
1579 ftepp_error(ftepp, "unrecognized preprocessor directive: `%s`", ftepp_tokval(ftepp));
1586 /* break; never reached */
1588 ftepp_error(ftepp, "unexpected preprocessor token: `%s`", ftepp_tokval(ftepp));
1591 ftepp_errorat(ftepp, ctx, "empty preprocessor directive");
1594 ftepp_error(ftepp, "missing newline at end of file", ftepp_tokval(ftepp));
1597 /* Builtins! Don't forget the builtins! */
1598 case TOKEN_INTCONST:
1599 case TOKEN_FLOATCONST:
1600 ftepp_out(ftepp, "#", false);
1603 if (!ftepp_skipspace(ftepp))
1608 static bool ftepp_preprocess(ftepp_t *ftepp)
1611 bool newline = true;
1614 char *expand = NULL;
1617 ftepp->lex->flags.preprocessing = true;
1618 ftepp->lex->flags.mergelines = false;
1619 ftepp->lex->flags.noops = true;
1624 if (ftepp->token >= TOKEN_EOF)
1630 switch (ftepp->token) {
1633 case TOKEN_TYPENAME:
1634 /* is it a predef? */
1635 if (OPTS_FLAG(FTEPP_PREDEFS)) {
1636 for (i = 0; i < sizeof(ftepp_predefs) / sizeof (*ftepp_predefs); i++) {
1637 if (!strcmp(ftepp_predefs[i].name, ftepp_tokval(ftepp))) {
1638 expand = ftepp_predefs[i].func(ftepp->lex);
1639 ftepp_out(ftepp, expand, false);
1640 ftepp_next(ftepp); /* skip */
1642 mem_d(expand); /* free memory */
1648 if (ftepp->output_on)
1649 macro = ftepp_macro_find(ftepp, ftepp_tokval(ftepp));
1654 ftepp_out(ftepp, ftepp_tokval(ftepp), false);
1658 if (!ftepp_macro_call(ftepp, macro))
1659 ftepp->token = TOKEN_ERROR;
1663 ftepp_out(ftepp, ftepp_tokval(ftepp), false);
1667 ftepp->lex->flags.mergelines = true;
1668 if (ftepp_next(ftepp) >= TOKEN_EOF) {
1669 ftepp_error(ftepp, "error in preprocessor directive");
1670 ftepp->token = TOKEN_ERROR;
1673 if (!ftepp_hash(ftepp))
1674 ftepp->token = TOKEN_ERROR;
1675 ftepp->lex->flags.mergelines = false;
1679 ftepp_out(ftepp, "\n", true);
1683 /* same as default but don't set newline=false */
1684 ftepp_out(ftepp, ftepp_tokval(ftepp), true);
1689 ftepp_out(ftepp, ftepp_tokval(ftepp), false);
1693 } while (!ftepp->errors && ftepp->token < TOKEN_EOF);
1695 /* force a 0 at the end but don't count it as added to the output */
1696 vec_push(ftepp->output_string, 0);
1697 vec_shrinkby(ftepp->output_string, 1);
1699 return (ftepp->token == TOKEN_EOF);
1702 /* Like in parser.c - files keep the previous state so we have one global
1703 * preprocessor. Except here we will want to warn about dangling #ifs.
1705 static ftepp_t *ftepp;
1707 static bool ftepp_preprocess_done()
1710 if (vec_size(ftepp->conditions)) {
1711 if (ftepp_warn(ftepp, WARN_MULTIFILE_IF, "#if spanning multiple files, is this intended?"))
1714 lex_close(ftepp->lex);
1716 if (ftepp->itemname) {
1717 mem_d(ftepp->itemname);
1718 ftepp->itemname = NULL;
1723 bool ftepp_preprocess_file(const char *filename)
1725 ftepp->lex = lex_open(filename);
1726 ftepp->itemname = util_strdup(filename);
1728 con_out("failed to open file \"%s\"\n", filename);
1731 if (!ftepp_preprocess(ftepp))
1733 return ftepp_preprocess_done();
1736 bool ftepp_preprocess_string(const char *name, const char *str)
1738 ftepp->lex = lex_open_string(str, strlen(str), name);
1739 ftepp->itemname = util_strdup(name);
1741 con_out("failed to create lexer for string \"%s\"\n", name);
1744 if (!ftepp_preprocess(ftepp))
1746 return ftepp_preprocess_done();
1750 void ftepp_add_macro(const char *name, const char *value) {
1751 char *create = NULL;
1753 /* use saner path for empty macros */
1755 ftepp_add_define("__builtin__", name);
1759 vec_upload(create, "#define ", 8);
1760 vec_upload(create, name, strlen(name));
1761 vec_push (create, ' ');
1762 vec_upload(create, value, strlen(value));
1763 vec_push (create, 0);
1765 ftepp_preprocess_string("__builtin__", create);
1774 ftepp = ftepp_new();
1778 memset(minor, 0, sizeof(minor));
1779 memset(major, 0, sizeof(major));
1781 /* set the right macro based on the selected standard */
1782 ftepp_add_define(NULL, "GMQCC");
1783 if (OPTS_OPTION_U32(OPTION_STANDARD) == COMPILER_FTEQCC) {
1784 ftepp_add_define(NULL, "__STD_FTEQCC__");
1793 } else if (OPTS_OPTION_U32(OPTION_STANDARD) == COMPILER_GMQCC) {
1794 ftepp_add_define(NULL, "__STD_GMQCC__");
1795 sprintf(major, "\"%d\"", GMQCC_VERSION_MAJOR);
1796 sprintf(minor, "\"%d\"", GMQCC_VERSION_MINOR);
1797 } else if (OPTS_OPTION_U32(OPTION_STANDARD) == COMPILER_QCCX) {
1798 ftepp_add_define(NULL, "__STD_QCCX__");
1799 sprintf(major, "\"%d\"", GMQCC_VERSION_MAJOR);
1800 sprintf(minor, "\"%d\"", GMQCC_VERSION_MINOR);
1801 } else if (OPTS_OPTION_U32(OPTION_STANDARD) == COMPILER_QCC) {
1802 ftepp_add_define(NULL, "__STD_QCC__");
1813 ftepp_add_macro("__STD_VERSION_MINOR__", minor);
1814 ftepp_add_macro("__STD_VERSION_MAJOR__", major);
1819 void ftepp_add_define(const char *source, const char *name)
1822 lex_ctx ctx = { "__builtin__", 0 };
1824 macro = ppmacro_new(ctx, name);
1825 vec_push(ftepp->macros, macro);
1828 const char *ftepp_get()
1830 return ftepp->output_string;
1835 ftepp_flush_do(ftepp);
1842 ftepp_delete(ftepp);