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 = 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 = 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 if (macro->variadic && !strcmp(ftepp_tokval(ftepp), "__VA_ARGS__"))
412 ftepp->token = TOKEN_VA_ARGS;
413 ptok = pptoken_make(ftepp);
414 vec_push(macro->output, ptok);
417 /* recursive expansion can cause EOFs here */
418 if (ftepp->token != TOKEN_EOL && ftepp->token != TOKEN_EOF) {
419 ftepp_error(ftepp, "unexpected junk after macro or unexpected end of file");
425 static bool ftepp_define(ftepp_t *ftepp)
428 size_t l = ftepp_ctx(ftepp).line;
430 (void)ftepp_next(ftepp);
431 if (!ftepp_skipspace(ftepp))
434 switch (ftepp->token) {
438 macro = ftepp_macro_find(ftepp, ftepp_tokval(ftepp));
439 if (macro && ftepp->output_on) {
440 if (ftepp_warn(ftepp, WARN_PREPROCESSOR, "redefining `%s`", ftepp_tokval(ftepp)))
442 ftepp_macro_delete(ftepp, ftepp_tokval(ftepp));
444 macro = ppmacro_new(ftepp_ctx(ftepp), ftepp_tokval(ftepp));
447 ftepp_error(ftepp, "expected macro name");
451 (void)ftepp_next(ftepp);
453 if (ftepp->token == '(') {
454 macro->has_params = true;
455 if (!ftepp_define_params(ftepp, macro))
459 if (!ftepp_skipspace(ftepp))
462 if (!ftepp_define_body(ftepp, macro))
465 if (ftepp->output_on)
466 vec_push(ftepp->macros, macro);
468 ppmacro_delete(macro);
471 for (; l < ftepp_ctx(ftepp).line; ++l)
472 ftepp_out(ftepp, "\n", true);
477 * When a macro is used we have to handle parameters as well
478 * as special-concatenation via ## or stringification via #
480 * Note: parenthesis can nest, so FOO((a),b) is valid, but only
481 * this kind of parens. Curly braces or [] don't count towards the
488 static void macroparam_clean(macroparam *self)
491 for (i = 0; i < vec_size(self->tokens); ++i)
492 pptoken_delete(self->tokens[i]);
493 vec_free(self->tokens);
496 /* need to leave the last token up */
497 static bool ftepp_macro_call_params(ftepp_t *ftepp, macroparam **out_params)
499 macroparam *params = NULL;
505 if (!ftepp_skipallwhite(ftepp))
507 while (ftepp->token != ')') {
509 if (!ftepp_skipallwhite(ftepp))
511 while (parens || ftepp->token != ',') {
512 if (ftepp->token == '(')
514 else if (ftepp->token == ')') {
519 ptok = pptoken_make(ftepp);
520 vec_push(mp.tokens, ptok);
521 if (ftepp_next(ftepp) >= TOKEN_EOF) {
522 ftepp_error(ftepp, "unexpected EOF in macro call");
526 vec_push(params, mp);
528 if (ftepp->token == ')')
530 if (ftepp->token != ',') {
531 ftepp_error(ftepp, "expected closing paren or comma in macro call");
534 if (ftepp_next(ftepp) >= TOKEN_EOF) {
535 ftepp_error(ftepp, "unexpected EOF in macro call");
539 /* need to leave that up
540 if (ftepp_next(ftepp) >= TOKEN_EOF) {
541 ftepp_error(ftepp, "unexpected EOF in macro call");
545 *out_params = params;
550 macroparam_clean(&mp);
551 for (i = 0; i < vec_size(params); ++i)
552 macroparam_clean(¶ms[i]);
557 static bool macro_params_find(ppmacro *macro, const char *name, size_t *idx)
560 for (i = 0; i < vec_size(macro->params); ++i) {
561 if (!strcmp(macro->params[i], name)) {
569 static void ftepp_stringify_token(ftepp_t *ftepp, pptoken *token)
574 switch (token->token) {
575 case TOKEN_STRINGCONST:
578 /* in preprocessor mode strings already are string,
579 * so we don't get actual newline bytes here.
580 * Still need to escape backslashes and quotes.
583 case '\\': ftepp_out(ftepp, "\\\\", false); break;
584 case '"': ftepp_out(ftepp, "\\\"", false); break;
587 ftepp_out(ftepp, chs, false);
594 ftepp_out(ftepp, " ", false);
597 ftepp_out(ftepp, "\\n", false);
600 ftepp_out(ftepp, token->value, false);
605 static void ftepp_stringify(ftepp_t *ftepp, macroparam *param)
608 ftepp_out(ftepp, "\"", false);
609 for (i = 0; i < vec_size(param->tokens); ++i)
610 ftepp_stringify_token(ftepp, param->tokens[i]);
611 ftepp_out(ftepp, "\"", false);
614 static void ftepp_recursion_header(ftepp_t *ftepp)
616 ftepp_out(ftepp, "\n#pragma push(line)\n", false);
619 static void ftepp_recursion_footer(ftepp_t *ftepp)
621 ftepp_out(ftepp, "\n#pragma pop(line)\n", false);
624 static void ftepp_param_out(ftepp_t *ftepp, macroparam *param)
628 for (i = 0; i < vec_size(param->tokens); ++i) {
629 out = param->tokens[i];
630 if (out->token == TOKEN_EOL)
631 ftepp_out(ftepp, "\n", false);
633 ftepp_out(ftepp, out->value, false);
637 static bool ftepp_preprocess(ftepp_t *ftepp);
638 static bool ftepp_macro_expand(ftepp_t *ftepp, ppmacro *macro, macroparam *params, bool resetline)
640 char *old_string = ftepp->output_string;
642 lex_file *old_lexer = ftepp->lex;
643 size_t vararg_start = vec_size(macro->params);
655 if (vararg_start < vec_size(params))
656 varargs = vec_size(params) - vararg_start;
661 if (!vec_size(macro->output))
664 ftepp->output_string = NULL;
665 for (o = 0; o < vec_size(macro->output); ++o) {
666 pptoken *out = macro->output[o];
667 switch (out->token) {
669 if (!macro->variadic) {
670 ftepp_error(ftepp, "internal preprocessor error: TOKEN_VA_ARGS in non-variadic macro");
671 vec_free(old_string);
677 ftepp_param_out(ftepp, ¶ms[pi + vararg_start]);
678 for (++pi; pi < varargs; ++pi) {
679 ftepp_out(ftepp, ", ", false);
680 ftepp_param_out(ftepp, ¶ms[pi + vararg_start]);
686 if (!macro_params_find(macro, out->value, &pi)) {
687 ftepp_out(ftepp, out->value, false);
690 ftepp_param_out(ftepp, ¶ms[pi]);
693 if (o + 1 < vec_size(macro->output)) {
694 nextok = macro->output[o+1]->token;
696 /* raw concatenation */
700 if ( (nextok == TOKEN_IDENT ||
701 nextok == TOKEN_KEYWORD ||
702 nextok == TOKEN_TYPENAME) &&
703 macro_params_find(macro, macro->output[o+1]->value, &pi))
706 ftepp_stringify(ftepp, ¶ms[pi]);
710 ftepp_out(ftepp, "#", false);
713 ftepp_out(ftepp, "\n", false);
716 ftepp_out(ftepp, out->value, false);
720 vec_push(ftepp->output_string, 0);
721 /* Now run the preprocessor recursively on this string buffer */
723 printf("__________\n%s\n=========\n", ftepp->output_string);
725 inlex = lex_open_string(ftepp->output_string, vec_size(ftepp->output_string)-1, ftepp->lex->name);
727 ftepp_error(ftepp, "internal error: failed to instantiate lexer");
732 inlex->line = ftepp->lex->line;
733 inlex->sline = ftepp->lex->sline;
736 old_inmacro = ftepp->in_macro;
737 ftepp->in_macro = true;
738 ftepp->output_string = NULL;
739 if (!ftepp_preprocess(ftepp)) {
740 ftepp->in_macro = old_inmacro;
741 vec_free(ftepp->lex->open_string);
742 vec_free(ftepp->output_string);
743 lex_close(ftepp->lex);
747 ftepp->in_macro = old_inmacro;
748 vec_free(ftepp->lex->open_string);
749 lex_close(ftepp->lex);
751 inner_string = ftepp->output_string;
752 ftepp->output_string = old_string;
754 has_newlines = (strchr(inner_string, '\n') != NULL);
756 if (has_newlines && !old_inmacro)
757 ftepp_recursion_header(ftepp);
759 vec_append(ftepp->output_string, vec_size(inner_string), inner_string);
760 vec_free(inner_string);
762 if (has_newlines && !old_inmacro)
763 ftepp_recursion_footer(ftepp);
765 if (resetline && !ftepp->in_macro) {
767 sprintf(lineno, "\n#pragma line(%lu)\n", (unsigned long)(old_lexer->sline));
768 ftepp_out(ftepp, lineno, false);
771 old_string = ftepp->output_string;
773 ftepp->lex = old_lexer;
774 ftepp->output_string = old_string;
778 static bool ftepp_macro_call(ftepp_t *ftepp, ppmacro *macro)
781 macroparam *params = NULL;
785 if (!macro->has_params) {
786 if (!ftepp_macro_expand(ftepp, macro, NULL, false))
793 if (!ftepp_skipallwhite(ftepp))
796 if (ftepp->token != '(') {
797 ftepp_error(ftepp, "expected macro parameters in parenthesis");
802 paramline = ftepp->lex->sline;
803 if (!ftepp_macro_call_params(ftepp, ¶ms))
806 if ( vec_size(params) < vec_size(macro->params) ||
807 (vec_size(params) > vec_size(macro->params) && !macro->variadic) )
809 ftepp_error(ftepp, "macro %s expects%s %u paramteters, %u provided", macro->name,
810 (macro->variadic ? " at least" : ""),
811 (unsigned int)vec_size(macro->params),
812 (unsigned int)vec_size(params));
817 if (!ftepp_macro_expand(ftepp, macro, params, (paramline != ftepp->lex->sline)))
822 for (o = 0; o < vec_size(params); ++o)
823 macroparam_clean(¶ms[o]);
829 * #if - the FTEQCC way:
830 * defined(FOO) => true if FOO was #defined regardless of parameters or contents
831 * <numbers> => True if the number is not 0
832 * !<factor> => True if the factor yields false
833 * !!<factor> => ERROR on 2 or more unary nots
834 * <macro> => becomes the macro's FIRST token regardless of parameters
835 * <e> && <e> => True if both expressions are true
836 * <e> || <e> => True if either expression is true
838 * <ident> => False (remember for macros the <macro> rule applies instead)
839 * Unary + and - are weird and wrong in fteqcc so we don't allow them
840 * parenthesis in expressions are allowed
841 * parameter lists on macros are errors
842 * No mathematical calculations are executed
844 static bool ftepp_if_expr(ftepp_t *ftepp, bool *out, double *value_out);
845 static bool ftepp_if_op(ftepp_t *ftepp)
847 ftepp->lex->flags.noops = false;
849 if (!ftepp_skipspace(ftepp))
851 ftepp->lex->flags.noops = true;
854 static bool ftepp_if_value(ftepp_t *ftepp, bool *out, double *value_out)
860 if (!ftepp_skipspace(ftepp))
863 while (ftepp->token == '!') {
866 if (!ftepp_skipspace(ftepp))
870 if (ftepp->token == TOKEN_OPERATOR && !strcmp(ftepp_tokval(ftepp), "-"))
874 if (!ftepp_skipspace(ftepp))
878 switch (ftepp->token) {
882 if (!strcmp(ftepp_tokval(ftepp), "defined")) {
884 if (!ftepp_skipspace(ftepp))
886 if (ftepp->token != '(') {
887 ftepp_error(ftepp, "`defined` keyword in #if requires a macro name in parenthesis");
891 if (!ftepp_skipspace(ftepp))
893 if (ftepp->token != TOKEN_IDENT &&
894 ftepp->token != TOKEN_TYPENAME &&
895 ftepp->token != TOKEN_KEYWORD)
897 ftepp_error(ftepp, "defined() used on an unexpected token type");
900 macro = ftepp_macro_find(ftepp, ftepp_tokval(ftepp));
903 if (!ftepp_skipspace(ftepp))
905 if (ftepp->token != ')') {
906 ftepp_error(ftepp, "expected closing paren");
912 macro = ftepp_macro_find(ftepp, ftepp_tokval(ftepp));
913 if (!macro || !vec_size(macro->output)) {
917 /* This does not expand recursively! */
918 switch (macro->output[0]->token) {
920 *value_out = macro->output[0]->constval.i;
921 *out = !!(macro->output[0]->constval.i);
923 case TOKEN_FLOATCONST:
924 *value_out = macro->output[0]->constval.f;
925 *out = !!(macro->output[0]->constval.f);
933 case TOKEN_STRINGCONST:
938 *value_out = ftepp->lex->tok.constval.i;
939 *out = !!(ftepp->lex->tok.constval.i);
941 case TOKEN_FLOATCONST:
942 *value_out = ftepp->lex->tok.constval.f;
943 *out = !!(ftepp->lex->tok.constval.f);
948 if (!ftepp_if_expr(ftepp, out, value_out))
950 if (ftepp->token != ')') {
951 ftepp_error(ftepp, "expected closing paren in #if expression");
957 ftepp_error(ftepp, "junk in #if: `%s` ...", ftepp_tokval(ftepp));
959 ftepp_error(ftepp, "internal: token %i\n", ftepp->token);
963 *value_out = -*value_out;
966 *value_out = (*out ? 1 : 0);
972 static bool ftepp_if_nextvalue(ftepp_t *ftepp, bool *out, double *value_out)
974 if (!ftepp_next(ftepp))
976 return ftepp_if_value(ftepp, out, value_out);
980 static bool ftepp_if_expr(ftepp_t *ftepp, bool *out, double *value_out)
982 if (!ftepp_if_value(ftepp, out, value_out))
985 if (!ftepp_if_op(ftepp))
988 if (ftepp->token == ')' || ftepp->token != TOKEN_OPERATOR)
991 /* FTEQCC is all right-associative and no precedence here */
992 if (!strcmp(ftepp_tokval(ftepp), "&&") ||
993 !strcmp(ftepp_tokval(ftepp), "||"))
996 char opc = ftepp_tokval(ftepp)[0];
1000 if (!ftepp_next(ftepp))
1002 if (!ftepp_if_expr(ftepp, &next, &nextvalue))
1006 *out = *out && next;
1008 *out = *out || next;
1010 *value_out = (*out ? 1 : 0);
1013 else if (!strcmp(ftepp_tokval(ftepp), "==") ||
1014 !strcmp(ftepp_tokval(ftepp), "!=") ||
1015 !strcmp(ftepp_tokval(ftepp), ">=") ||
1016 !strcmp(ftepp_tokval(ftepp), "<=") ||
1017 !strcmp(ftepp_tokval(ftepp), ">") ||
1018 !strcmp(ftepp_tokval(ftepp), "<"))
1021 const char opc0 = ftepp_tokval(ftepp)[0];
1022 const char opc1 = ftepp_tokval(ftepp)[1];
1025 if (!ftepp_next(ftepp))
1027 if (!ftepp_if_expr(ftepp, &next, &other))
1031 *out = (*value_out == other);
1032 else if (opc0 == '!')
1033 *out = (*value_out != other);
1034 else if (opc0 == '>') {
1035 if (opc1 == '=') *out = (*value_out >= other);
1036 else *out = (*value_out > other);
1038 else if (opc0 == '<') {
1039 if (opc1 == '=') *out = (*value_out <= other);
1040 else *out = (*value_out < other);
1042 *value_out = (*out ? 1 : 0);
1047 ftepp_error(ftepp, "junk after #if");
1052 static bool ftepp_if(ftepp_t *ftepp, ppcondition *cond)
1054 bool result = false;
1057 memset(cond, 0, sizeof(*cond));
1058 (void)ftepp_next(ftepp);
1060 if (!ftepp_skipspace(ftepp))
1062 if (ftepp->token == TOKEN_EOL) {
1063 ftepp_error(ftepp, "expected expression for #if-directive");
1067 if (!ftepp_if_expr(ftepp, &result, &dummy))
1075 * ifdef is rather simple
1077 static bool ftepp_ifdef(ftepp_t *ftepp, ppcondition *cond)
1080 memset(cond, 0, sizeof(*cond));
1081 (void)ftepp_next(ftepp);
1082 if (!ftepp_skipspace(ftepp))
1085 switch (ftepp->token) {
1087 case TOKEN_TYPENAME:
1089 macro = ftepp_macro_find(ftepp, ftepp_tokval(ftepp));
1092 ftepp_error(ftepp, "expected macro name");
1096 (void)ftepp_next(ftepp);
1097 if (!ftepp_skipspace(ftepp))
1099 /* relaxing this condition
1100 if (ftepp->token != TOKEN_EOL && ftepp->token != TOKEN_EOF) {
1101 ftepp_error(ftepp, "stray tokens after #ifdef");
1110 * undef is also simple
1112 static bool ftepp_undef(ftepp_t *ftepp)
1114 (void)ftepp_next(ftepp);
1115 if (!ftepp_skipspace(ftepp))
1118 if (ftepp->output_on) {
1119 switch (ftepp->token) {
1121 case TOKEN_TYPENAME:
1123 ftepp_macro_delete(ftepp, ftepp_tokval(ftepp));
1126 ftepp_error(ftepp, "expected macro name");
1131 (void)ftepp_next(ftepp);
1132 if (!ftepp_skipspace(ftepp))
1134 /* relaxing this condition
1135 if (ftepp->token != TOKEN_EOL && ftepp->token != TOKEN_EOF) {
1136 ftepp_error(ftepp, "stray tokens after #ifdef");
1143 /* Special unescape-string function which skips a leading quote
1144 * and stops at a quote, not just at \0
1146 static void unescape(const char *str, char *out) {
1148 while (*str && *str != '"') {
1152 case '\\': *out++ = *str; break;
1153 case '"': *out++ = *str; break;
1154 case 'a': *out++ = '\a'; break;
1155 case 'b': *out++ = '\b'; break;
1156 case 'r': *out++ = '\r'; break;
1157 case 'n': *out++ = '\n'; break;
1158 case 't': *out++ = '\t'; break;
1159 case 'f': *out++ = '\f'; break;
1160 case 'v': *out++ = '\v'; break;
1175 static char *ftepp_include_find_path(const char *file, const char *pathfile)
1178 char *filename = NULL;
1179 const char *last_slash;
1185 last_slash = strrchr(pathfile, '/');
1188 len = last_slash - pathfile;
1189 memcpy(vec_add(filename, len), pathfile, len);
1190 vec_push(filename, '/');
1194 memcpy(vec_add(filename, len+1), file, len);
1195 vec_last(filename) = 0;
1197 fp = file_open(filename, "rb");
1206 static char *ftepp_include_find(ftepp_t *ftepp, const char *file)
1208 char *filename = NULL;
1210 filename = ftepp_include_find_path(file, ftepp->includename);
1212 filename = ftepp_include_find_path(file, ftepp->itemname);
1216 static bool ftepp_directive_warning(ftepp_t *ftepp) {
1217 char *message = NULL;
1219 if (!ftepp_skipspace(ftepp))
1222 /* handle the odd non string constant case so it works like C */
1223 if (ftepp->token != TOKEN_STRINGCONST) {
1225 vec_upload(message, "#warning", 8);
1227 while (ftepp->token != TOKEN_EOL) {
1228 vec_upload(message, ftepp_tokval(ftepp), strlen(ftepp_tokval(ftepp)));
1231 vec_push(message, '\0');
1232 store = ftepp_warn(ftepp, WARN_CPP, message);
1237 unescape (ftepp_tokval(ftepp), ftepp_tokval(ftepp));
1238 return ftepp_warn(ftepp, WARN_CPP, "#warning %s", ftepp_tokval(ftepp));
1241 static void ftepp_directive_error(ftepp_t *ftepp) {
1242 char *message = NULL;
1244 if (!ftepp_skipspace(ftepp))
1247 /* handle the odd non string constant case so it works like C */
1248 if (ftepp->token != TOKEN_STRINGCONST) {
1249 vec_upload(message, "#error", 6);
1251 while (ftepp->token != TOKEN_EOL) {
1252 vec_upload(message, ftepp_tokval(ftepp), strlen(ftepp_tokval(ftepp)));
1255 vec_push(message, '\0');
1256 ftepp_error(ftepp, message);
1261 unescape (ftepp_tokval(ftepp), ftepp_tokval(ftepp));
1262 ftepp_error(ftepp, "#error %s", ftepp_tokval(ftepp));
1267 * FIXME: do we need/want a -I option?
1268 * FIXME: what about when dealing with files in subdirectories coming from a progs.src?
1270 static bool ftepp_include(ftepp_t *ftepp)
1272 lex_file *old_lexer = ftepp->lex;
1277 char *old_includename;
1279 (void)ftepp_next(ftepp);
1280 if (!ftepp_skipspace(ftepp))
1283 if (ftepp->token != TOKEN_STRINGCONST) {
1284 ftepp_error(ftepp, "expected filename to include");
1288 ctx = ftepp_ctx(ftepp);
1290 unescape(ftepp_tokval(ftepp), ftepp_tokval(ftepp));
1292 ftepp_out(ftepp, "\n#pragma file(", false);
1293 ftepp_out(ftepp, ftepp_tokval(ftepp), false);
1294 ftepp_out(ftepp, ")\n#pragma line(1)\n", false);
1296 filename = ftepp_include_find(ftepp, ftepp_tokval(ftepp));
1298 ftepp_error(ftepp, "failed to open include file `%s`", ftepp_tokval(ftepp));
1301 inlex = lex_open(filename);
1303 ftepp_error(ftepp, "open failed on include file `%s`", filename);
1308 old_includename = ftepp->includename;
1309 ftepp->includename = filename;
1310 if (!ftepp_preprocess(ftepp)) {
1311 vec_free(ftepp->includename);
1312 ftepp->includename = old_includename;
1313 lex_close(ftepp->lex);
1314 ftepp->lex = old_lexer;
1317 vec_free(ftepp->includename);
1318 ftepp->includename = old_includename;
1319 lex_close(ftepp->lex);
1320 ftepp->lex = old_lexer;
1322 ftepp_out(ftepp, "\n#pragma file(", false);
1323 ftepp_out(ftepp, ctx.file, false);
1324 snprintf(lineno, sizeof(lineno), ")\n#pragma line(%lu)\n", (unsigned long)(ctx.line+1));
1325 ftepp_out(ftepp, lineno, false);
1328 (void)ftepp_next(ftepp);
1329 if (!ftepp_skipspace(ftepp))
1331 if (ftepp->token != TOKEN_EOL) {
1332 ftepp_error(ftepp, "stray tokens after #include");
1335 (void)ftepp_next(ftepp);
1340 /* Basic structure handlers */
1341 static bool ftepp_else_allowed(ftepp_t *ftepp)
1343 if (!vec_size(ftepp->conditions)) {
1344 ftepp_error(ftepp, "#else without #if");
1347 if (vec_last(ftepp->conditions).had_else) {
1348 ftepp_error(ftepp, "multiple #else for a single #if");
1354 static bool ftepp_hash(ftepp_t *ftepp)
1359 lex_ctx ctx = ftepp_ctx(ftepp);
1361 if (!ftepp_skipspace(ftepp))
1364 switch (ftepp->token) {
1367 case TOKEN_TYPENAME:
1368 if (!strcmp(ftepp_tokval(ftepp), "define")) {
1369 return ftepp_define(ftepp);
1371 else if (!strcmp(ftepp_tokval(ftepp), "undef")) {
1372 return ftepp_undef(ftepp);
1374 else if (!strcmp(ftepp_tokval(ftepp), "ifdef")) {
1375 if (!ftepp_ifdef(ftepp, &cond))
1377 cond.was_on = cond.on;
1378 vec_push(ftepp->conditions, cond);
1379 ftepp->output_on = ftepp->output_on && cond.on;
1382 else if (!strcmp(ftepp_tokval(ftepp), "ifndef")) {
1383 if (!ftepp_ifdef(ftepp, &cond))
1386 cond.was_on = cond.on;
1387 vec_push(ftepp->conditions, cond);
1388 ftepp->output_on = ftepp->output_on && cond.on;
1391 else if (!strcmp(ftepp_tokval(ftepp), "elifdef")) {
1392 if (!ftepp_else_allowed(ftepp))
1394 if (!ftepp_ifdef(ftepp, &cond))
1396 pc = &vec_last(ftepp->conditions);
1397 pc->on = !pc->was_on && cond.on;
1398 pc->was_on = pc->was_on || pc->on;
1399 ftepp_update_output_condition(ftepp);
1402 else if (!strcmp(ftepp_tokval(ftepp), "elifndef")) {
1403 if (!ftepp_else_allowed(ftepp))
1405 if (!ftepp_ifdef(ftepp, &cond))
1408 pc = &vec_last(ftepp->conditions);
1409 pc->on = !pc->was_on && cond.on;
1410 pc->was_on = pc->was_on || pc->on;
1411 ftepp_update_output_condition(ftepp);
1414 else if (!strcmp(ftepp_tokval(ftepp), "elif")) {
1415 if (!ftepp_else_allowed(ftepp))
1417 if (!ftepp_if(ftepp, &cond))
1419 pc = &vec_last(ftepp->conditions);
1420 pc->on = !pc->was_on && cond.on;
1421 pc->was_on = pc->was_on || pc->on;
1422 ftepp_update_output_condition(ftepp);
1425 else if (!strcmp(ftepp_tokval(ftepp), "if")) {
1426 if (!ftepp_if(ftepp, &cond))
1428 cond.was_on = cond.on;
1429 vec_push(ftepp->conditions, cond);
1430 ftepp->output_on = ftepp->output_on && cond.on;
1433 else if (!strcmp(ftepp_tokval(ftepp), "else")) {
1434 if (!ftepp_else_allowed(ftepp))
1436 pc = &vec_last(ftepp->conditions);
1437 pc->on = !pc->was_on;
1438 pc->had_else = true;
1440 ftepp_update_output_condition(ftepp);
1443 else if (!strcmp(ftepp_tokval(ftepp), "endif")) {
1444 if (!vec_size(ftepp->conditions)) {
1445 ftepp_error(ftepp, "#endif without #if");
1448 vec_pop(ftepp->conditions);
1450 ftepp_update_output_condition(ftepp);
1453 else if (!strcmp(ftepp_tokval(ftepp), "include")) {
1454 return ftepp_include(ftepp);
1456 else if (!strcmp(ftepp_tokval(ftepp), "pragma")) {
1457 ftepp_out(ftepp, "#", false);
1460 else if (!strcmp(ftepp_tokval(ftepp), "warning")) {
1461 ftepp_directive_warning(ftepp);
1464 else if (!strcmp(ftepp_tokval(ftepp), "error")) {
1465 ftepp_directive_error(ftepp);
1469 if (ftepp->output_on) {
1470 ftepp_error(ftepp, "unrecognized preprocessor directive: `%s`", ftepp_tokval(ftepp));
1477 /* break; never reached */
1479 ftepp_error(ftepp, "unexpected preprocessor token: `%s`", ftepp_tokval(ftepp));
1482 ftepp_errorat(ftepp, ctx, "empty preprocessor directive");
1485 ftepp_error(ftepp, "missing newline at end of file", ftepp_tokval(ftepp));
1488 /* Builtins! Don't forget the builtins! */
1489 case TOKEN_INTCONST:
1490 case TOKEN_FLOATCONST:
1491 ftepp_out(ftepp, "#", false);
1494 if (!ftepp_skipspace(ftepp))
1499 static bool ftepp_preprocess(ftepp_t *ftepp)
1502 bool newline = true;
1505 char *expand = NULL;
1508 ftepp->lex->flags.preprocessing = true;
1509 ftepp->lex->flags.mergelines = false;
1510 ftepp->lex->flags.noops = true;
1515 if (ftepp->token >= TOKEN_EOF)
1521 switch (ftepp->token) {
1524 case TOKEN_TYPENAME:
1525 /* is it a predef? */
1526 if (OPTS_FLAG(FTEPP_PREDEFS)) {
1527 for (i = 0; i < sizeof(ftepp_predefs) / sizeof (*ftepp_predefs); i++) {
1528 if (!strcmp(ftepp_predefs[i].name, ftepp_tokval(ftepp))) {
1529 expand = ftepp_predefs[i].func(ftepp->lex);
1530 ftepp_out(ftepp, expand, false);
1531 ftepp_next(ftepp); /* skip */
1533 mem_d(expand); /* free memory */
1539 if (ftepp->output_on)
1540 macro = ftepp_macro_find(ftepp, ftepp_tokval(ftepp));
1545 ftepp_out(ftepp, ftepp_tokval(ftepp), false);
1549 if (!ftepp_macro_call(ftepp, macro))
1550 ftepp->token = TOKEN_ERROR;
1554 ftepp_out(ftepp, ftepp_tokval(ftepp), false);
1558 ftepp->lex->flags.mergelines = true;
1559 if (ftepp_next(ftepp) >= TOKEN_EOF) {
1560 ftepp_error(ftepp, "error in preprocessor directive");
1561 ftepp->token = TOKEN_ERROR;
1564 if (!ftepp_hash(ftepp))
1565 ftepp->token = TOKEN_ERROR;
1566 ftepp->lex->flags.mergelines = false;
1570 ftepp_out(ftepp, "\n", true);
1574 /* same as default but don't set newline=false */
1575 ftepp_out(ftepp, ftepp_tokval(ftepp), true);
1580 ftepp_out(ftepp, ftepp_tokval(ftepp), false);
1584 } while (!ftepp->errors && ftepp->token < TOKEN_EOF);
1586 /* force a 0 at the end but don't count it as added to the output */
1587 vec_push(ftepp->output_string, 0);
1588 vec_shrinkby(ftepp->output_string, 1);
1590 return (ftepp->token == TOKEN_EOF);
1593 /* Like in parser.c - files keep the previous state so we have one global
1594 * preprocessor. Except here we will want to warn about dangling #ifs.
1596 static ftepp_t *ftepp;
1598 static bool ftepp_preprocess_done()
1601 if (vec_size(ftepp->conditions)) {
1602 if (ftepp_warn(ftepp, WARN_MULTIFILE_IF, "#if spanning multiple files, is this intended?"))
1605 lex_close(ftepp->lex);
1607 if (ftepp->itemname) {
1608 mem_d(ftepp->itemname);
1609 ftepp->itemname = NULL;
1614 bool ftepp_preprocess_file(const char *filename)
1616 ftepp->lex = lex_open(filename);
1617 ftepp->itemname = util_strdup(filename);
1619 con_out("failed to open file \"%s\"\n", filename);
1622 if (!ftepp_preprocess(ftepp))
1624 return ftepp_preprocess_done();
1627 bool ftepp_preprocess_string(const char *name, const char *str)
1629 ftepp->lex = lex_open_string(str, strlen(str), name);
1630 ftepp->itemname = util_strdup(name);
1632 con_out("failed to create lexer for string \"%s\"\n", name);
1635 if (!ftepp_preprocess(ftepp))
1637 return ftepp_preprocess_done();
1641 void ftepp_add_macro(const char *name, const char *value) {
1642 char *create = NULL;
1644 /* use saner path for empty macros */
1646 ftepp_add_define("__builtin__", name);
1650 vec_upload(create, "#define ", 8);
1651 vec_upload(create, name, strlen(name));
1652 vec_push (create, ' ');
1653 vec_upload(create, value, strlen(value));
1654 vec_push (create, 0);
1656 ftepp_preprocess_string("__builtin__", create);
1665 ftepp = ftepp_new();
1669 memset(minor, 0, sizeof(minor));
1670 memset(major, 0, sizeof(major));
1672 /* set the right macro based on the selected standard */
1673 ftepp_add_define(NULL, "GMQCC");
1674 if (opts.standard == COMPILER_FTEQCC) {
1675 ftepp_add_define(NULL, "__STD_FTEQCC__");
1684 } else if (opts.standard == COMPILER_GMQCC) {
1685 ftepp_add_define(NULL, "__STD_GMQCC__");
1686 sprintf(major, "\"%d\"", GMQCC_VERSION_MAJOR);
1687 sprintf(minor, "\"%d\"", GMQCC_VERSION_MINOR);
1688 } else if (opts.standard == COMPILER_QCCX) {
1689 ftepp_add_define(NULL, "__STD_QCCX__");
1690 sprintf(major, "\"%d\"", GMQCC_VERSION_MAJOR);
1691 sprintf(minor, "\"%d\"", GMQCC_VERSION_MINOR);
1692 } else if (opts.standard == COMPILER_QCC) {
1693 ftepp_add_define(NULL, "__STD_QCC__");
1704 ftepp_add_macro("__STD_VERSION_MINOR__", minor);
1705 ftepp_add_macro("__STD_VERSION_MAJOR__", major);
1710 void ftepp_add_define(const char *source, const char *name)
1713 lex_ctx ctx = { "__builtin__", 0 };
1715 macro = ppmacro_new(ctx, name);
1716 vec_push(ftepp->macros, macro);
1719 const char *ftepp_get()
1721 return ftepp->output_string;
1726 ftepp_flush_do(ftepp);
1733 ftepp_delete(ftepp);