]> de.git.xonotic.org Git - xonotic/gmqcc.git/blobdiff - ftepp.c
don't error on non-EOL EOF at the end of a macro line
[xonotic/gmqcc.git] / ftepp.c
diff --git a/ftepp.c b/ftepp.c
index 51a83a15563908adfee19fb31a63c5a04ae38c32..ba8829d9ce7a2741c7acaf87206d44ce8c6bb88d 100644 (file)
--- a/ftepp.c
+++ b/ftepp.c
@@ -58,8 +58,12 @@ typedef struct {
     bool         newline;
     unsigned int errors;
 
+    bool         output_on;
     ppcondition *conditions;
     ppmacro    **macros;
+
+    bool         output_string;
+    char        *output;
 } ftepp_t;
 
 #define ftepp_tokval(f) ((f)->lex->tok.value)
@@ -87,7 +91,25 @@ static void ftepp_error(ftepp_t *ftepp, const char *fmt, ...)
     va_end(ap);
 }
 
-ppmacro *ppmacro_new(lex_ctx ctx, const char *name)
+static pptoken *pptoken_make(ftepp_t *ftepp)
+{
+    pptoken *token = (pptoken*)mem_a(sizeof(pptoken));
+    token->token = ftepp->token;
+    if (token->token == TOKEN_WHITE)
+        token->value = util_strdup(" ");
+    else
+        token->value = util_strdup(ftepp_tokval(ftepp));
+    memcpy(&token->constval, &ftepp->lex->tok.constval, sizeof(token->constval));
+    return token;
+}
+
+static void pptoken_delete(pptoken *self)
+{
+    mem_d(self->value);
+    mem_d(self);
+}
+
+static ppmacro *ppmacro_new(lex_ctx ctx, const char *name)
 {
     ppmacro *macro = (ppmacro*)mem_a(sizeof(ppmacro));
     memset(macro, 0, sizeof(*macro));
@@ -95,32 +117,67 @@ ppmacro *ppmacro_new(lex_ctx ctx, const char *name)
     return macro;
 }
 
-void ppmacro_delete(ppmacro *self)
+static void ppmacro_delete(ppmacro *self)
 {
+    size_t i;
+    for (i = 0; i < vec_size(self->params); ++i)
+        mem_d(self->params[i]);
     vec_free(self->params);
+    for (i = 0; i < vec_size(self->output); ++i)
+        pptoken_delete(self->output[i]);
     vec_free(self->output);
     mem_d(self->name);
     mem_d(self);
 }
 
-ftepp_t* ftepp_init()
+static ftepp_t* ftepp_init()
 {
     ftepp_t *ftepp;
 
     ftepp = (ftepp_t*)mem_a(sizeof(*ftepp));
     memset(ftepp, 0, sizeof(*ftepp));
 
+    ftepp->output_on = true;
+
     return ftepp;
 }
 
-void ftepp_delete(ftepp_t *self)
+static void ftepp_delete(ftepp_t *self)
 {
+    size_t i;
+    for (i = 0; i < vec_size(self->macros); ++i)
+        ppmacro_delete(self->macros[i]);
     vec_free(self->macros);
     vec_free(self->conditions);
+    lex_close(self->lex);
     mem_d(self);
 }
 
-ppmacro* ftepp_macro_find(ftepp_t *ftepp, const char *name)
+static void ftepp_out(ftepp_t *ftepp, const char *str, bool ignore_cond)
+{
+    if (ignore_cond || ftepp->output_on)
+    {
+        size_t len;
+        char  *data;
+        if (!ftepp->output_string) {
+            printf("%s", str);
+            return;
+        }
+        len = strlen(str);
+        data = vec_add(ftepp->output, len);
+        memcpy(data, str, len);
+    }
+}
+
+static void ftepp_update_output_condition(ftepp_t *ftepp)
+{
+    size_t i;
+    ftepp->output_on = true;
+    for (i = 0; i < vec_size(ftepp->conditions); ++i)
+        ftepp->output_on = ftepp->output_on && ftepp->conditions[i].on;
+}
+
+static ppmacro* ftepp_macro_find(ftepp_t *ftepp, const char *name)
 {
     size_t i;
     for (i = 0; i < vec_size(ftepp->macros); ++i) {
@@ -148,9 +205,71 @@ static bool ftepp_skipspace(ftepp_t *ftepp)
     return true;
 }
 
+/* this one skips EOLs as well */
+static bool ftepp_skipallwhite(ftepp_t *ftepp)
+{
+    if (ftepp->token != TOKEN_WHITE && ftepp->token != TOKEN_EOL)
+        return true;
+    do {
+        ftepp_next(ftepp);
+    } while (ftepp->token == TOKEN_WHITE || ftepp->token == TOKEN_EOL);
+    if (ftepp->token >= TOKEN_EOF) {
+        ftepp_error(ftepp, "unexpected end of preprocessor directive");
+        return false;
+    }
+    return true;
+}
+
 /**
  * The huge macro parsing code...
  */
+static bool ftepp_define_params(ftepp_t *ftepp, ppmacro *macro)
+{
+    do {
+        ftepp_next(ftepp);
+        if (!ftepp_skipspace(ftepp))
+            return false;
+        if (ftepp->token == ')')
+            break;
+        switch (ftepp->token) {
+            case TOKEN_IDENT:
+            case TOKEN_TYPENAME:
+            case TOKEN_KEYWORD:
+                break;
+            default:
+                ftepp_error(ftepp, "unexpected token in parameter list");
+                return false;
+        }
+        vec_push(macro->params, util_strdup(ftepp_tokval(ftepp)));
+        ftepp_next(ftepp);
+        if (!ftepp_skipspace(ftepp))
+            return false;
+    } while (ftepp->token == ',');
+    if (ftepp->token != ')') {
+        ftepp_error(ftepp, "expected closing paren after macro parameter list");
+        return false;
+    }
+    ftepp_next(ftepp);
+    /* skipspace happens in ftepp_define */
+    return true;
+}
+
+static bool ftepp_define_body(ftepp_t *ftepp, ppmacro *macro)
+{
+    pptoken *ptok;
+    while (ftepp->token != TOKEN_EOL && ftepp->token < TOKEN_EOF) {
+        ptok = pptoken_make(ftepp);
+        vec_push(macro->output, ptok);
+        ftepp_next(ftepp);
+    }
+    /* recursive expansion can cause EOFs here */
+    if (ftepp->token != TOKEN_EOL && ftepp->token != TOKEN_EOF) {
+        ftepp_error(ftepp, "unexpected junk after macro or unexpected end of file");
+        return false;
+    }
+    return true;
+}
+
 static bool ftepp_define(ftepp_t *ftepp)
 {
     ppmacro *macro;
@@ -170,27 +289,243 @@ static bool ftepp_define(ftepp_t *ftepp)
     }
 
     (void)ftepp_next(ftepp);
+
+    if (ftepp->token == '(') {
+        macro->has_params = true;
+        if (!ftepp_define_params(ftepp, macro))
+            return false;
+    }
+
     if (!ftepp_skipspace(ftepp))
         return false;
-    if (ftepp->token != TOKEN_EOL) {
-        ftepp_error(ftepp, "stray tokens after macro");
+
+    if (!ftepp_define_body(ftepp, macro))
         return false;
-    }
+
     vec_push(ftepp->macros, macro);
     return true;
 }
 
+/**
+ * When a macro is used we have to handle parameters as well
+ * as special-concatenation via ## or stringification via #
+ *
+ * Note: parenthesis can nest, so FOO((a),b) is valid, but only
+ * this kind of parens. Curly braces or [] don't count towards the
+ * paren-level.
+ */
+typedef struct {
+    pptoken **tokens;
+} macroparam;
+
+static void macroparam_clean(macroparam *self)
+{
+    size_t i;
+    for (i = 0; i < vec_size(self->tokens); ++i)
+        pptoken_delete(self->tokens[i]);
+    vec_free(self->tokens);
+}
+
+/* need to leave the last token up */
+static bool ftepp_macro_call_params(ftepp_t *ftepp, macroparam **out_params)
+{
+    macroparam *params = NULL;
+    pptoken    *ptok;
+    macroparam  mp;
+    size_t      parens = 0;
+    size_t      i;
+
+    if (!ftepp_skipallwhite(ftepp))
+        return false;
+    while (ftepp->token != ')') {
+        mp.tokens = NULL;
+        if (!ftepp_skipallwhite(ftepp))
+            return false;
+        while (parens || ftepp->token != ',') {
+            if (ftepp->token == '(')
+                ++parens;
+            else if (ftepp->token == ')') {
+                if (!parens)
+                    break;
+                --parens;
+            }
+            ptok = pptoken_make(ftepp);
+            vec_push(mp.tokens, ptok);
+            if (ftepp_next(ftepp) >= TOKEN_EOF) {
+                ftepp_error(ftepp, "unexpected EOF in macro call");
+                goto on_error;
+            }
+        }
+        vec_push(params, mp);
+        mp.tokens = NULL;
+        if (ftepp->token == ')')
+            break;
+        if (ftepp->token != ',') {
+            ftepp_error(ftepp, "expected closing paren or comma in macro call");
+            goto on_error;
+        }
+        if (ftepp_next(ftepp) >= TOKEN_EOF) {
+            ftepp_error(ftepp, "unexpected EOF in macro call");
+            goto on_error;
+        }
+    }
+    /* need to leave that up
+    if (ftepp_next(ftepp) >= TOKEN_EOF) {
+        ftepp_error(ftepp, "unexpected EOF in macro call");
+        goto on_error;
+    }
+    */
+    *out_params = params;
+    return true;
+
+on_error:
+    if (mp.tokens)
+        macroparam_clean(&mp);
+    for (i = 0; i < vec_size(params); ++i)
+        macroparam_clean(&params[i]);
+    vec_free(params);
+    return false;
+}
+
+static bool macro_params_find(ppmacro *macro, const char *name, size_t *idx)
+{
+    size_t i;
+    for (i = 0; i < vec_size(macro->params); ++i) {
+        if (!strcmp(macro->params[i], name)) {
+            *idx = i;
+            return true;
+        }
+    }
+    return false;
+}
+
+static bool ftepp_preprocess(ftepp_t *ftepp);
+static bool ftepp_macro_expand(ftepp_t *ftepp, ppmacro *macro, macroparam *params)
+{
+    char     *old_string = ftepp->output;
+    bool      old_string_flag = ftepp->output_string;
+    lex_file *old_lexer = ftepp->lex;
+    bool retval = true;
+
+    size_t    o, pi, pv;
+    lex_file *inlex;
+
+    /* really ... */
+    if (!vec_size(macro->output))
+        return true;
+
+    ftepp->output = NULL;
+    ftepp->output_string = true;
+    for (o = 0; o < vec_size(macro->output); ++o) {
+        pptoken *out = macro->output[o];
+        switch (out->token) {
+            case TOKEN_IDENT:
+            case TOKEN_TYPENAME:
+            case TOKEN_KEYWORD:
+                if (!macro_params_find(macro, out->value, &pi)) {
+                    ftepp_out(ftepp, out->value, false);
+                    break;
+                } else {
+                    for (pv = 0; pv < vec_size(params[pi].tokens); ++pv) {
+                        out = params[pi].tokens[pv];
+                        if (out->token == TOKEN_EOL)
+                            ftepp_out(ftepp, "\n", false);
+                        else
+                            ftepp_out(ftepp, out->value, false);
+                    }
+                }
+                break;
+            case TOKEN_EOL:
+                ftepp_out(ftepp, "\n", false);
+                break;
+            default:
+                ftepp_out(ftepp, out->value, false);
+                break;
+        }
+    }
+    vec_push(ftepp->output, 0);
+    /* Now run the preprocessor recursively on this string buffer */
+    /*
+    printf("__________\n%s\n=========\n", ftepp->output);
+    */
+    inlex = lex_open_string(ftepp->output, vec_size(ftepp->output)-1, ftepp->lex->name);
+    if (!inlex) {
+        ftepp_error(ftepp, "internal error: failed to instantiate lexer");
+        retval = false;
+        goto cleanup;
+    }
+    ftepp->output        = old_string;
+    ftepp->output_string = old_string_flag;
+    ftepp->lex = inlex;
+    if (!ftepp_preprocess(ftepp)) {
+        retval = false;
+        goto cleanup;
+    }
+
+cleanup:
+    ftepp->lex           = old_lexer;
+    ftepp->output        = old_string;
+    ftepp->output_string = old_string_flag;
+    return retval;
+}
+
+static bool ftepp_macro_call(ftepp_t *ftepp, ppmacro *macro)
+{
+    size_t     o;
+    macroparam *params = NULL;
+    bool        retval = true;
+
+    if (!macro->has_params) {
+        if (!ftepp_macro_expand(ftepp, macro, NULL))
+            return false;
+        ftepp_next(ftepp);
+        return true;
+    }
+    ftepp_next(ftepp);
+
+    if (!ftepp_skipallwhite(ftepp))
+        return false;
+
+    if (ftepp->token != '(') {
+        ftepp_error(ftepp, "expected macro parameters in parenthesis");
+        return false;
+    }
+
+    ftepp_next(ftepp);
+    if (!ftepp_macro_call_params(ftepp, &params))
+        return false;
+
+    if (vec_size(params) != vec_size(macro->params)) {
+        ftepp_error(ftepp, "macro %s expects %u paramteters, %u provided", macro->name,
+                    (unsigned int)vec_size(macro->params),
+                    (unsigned int)vec_size(params));
+        retval = false;
+        goto cleanup;
+    }
+
+    if (!ftepp_macro_expand(ftepp, macro, params))
+        retval = false;
+    ftepp_next(ftepp);
+
+cleanup:
+    for (o = 0; o < vec_size(params); ++o)
+        macroparam_clean(&params[o]);
+    vec_free(params);
+    return retval;
+}
+
 /**
  * #if - the FTEQCC way:
  *    defined(FOO) => true if FOO was #defined regardless of parameters or contents
  *    <numbers>    => True if the number is not 0
  *    !<factor>    => True if the factor yields false
+ *    !!<factor>   => ERROR on 2 or more unary nots
  *    <macro>      => becomes the macro's FIRST token regardless of parameters
  *    <e> && <e>   => True if both expressions are true
  *    <e> || <e>   => True if either expression is true
  *    <string>     => False
  *    <ident>      => False (remember for macros the <macro> rule applies instead)
- * Unary + and - are skipped
+ * Unary + and - are weird and wrong in fteqcc so we don't allow them
  * parenthesis in expressions are allowed
  * parameter lists on macros are errors
  * No mathematical calculations are executed
@@ -198,16 +533,23 @@ static bool ftepp_define(ftepp_t *ftepp)
 static bool ftepp_if_expr(ftepp_t *ftepp, bool *out)
 {
     ppmacro *macro;
+    bool     wasnot = false;
 
     if (!ftepp_skipspace(ftepp))
         return false;
 
+    while (ftepp->token == '!') {
+        wasnot = true;
+        ftepp_next(ftepp);
+        if (!ftepp_skipspace(ftepp))
+            return false;
+    }
+
     switch (ftepp->token) {
         case TOKEN_IDENT:
         case TOKEN_TYPENAME:
         case TOKEN_KEYWORD:
             if (!strcmp(ftepp_tokval(ftepp), "defined")) {
-                ftepp->lex->flags.noops = true;
                 ftepp_next(ftepp);
                 if (!ftepp_skipspace(ftepp))
                     return false;
@@ -215,7 +557,6 @@ static bool ftepp_if_expr(ftepp_t *ftepp, bool *out)
                     ftepp_error(ftepp, "`defined` keyword in #if requires a macro name in parenthesis");
                     return false;
                 }
-                ftepp->lex->flags.noops = false;
                 ftepp_next(ftepp);
                 if (!ftepp_skipspace(ftepp))
                     return false;
@@ -280,10 +621,14 @@ static bool ftepp_if_expr(ftepp_t *ftepp, bool *out)
             ftepp_error(ftepp, "junk in #if");
             return false;
     }
+    if (wasnot)
+        *out = !*out;
 
+    ftepp->lex->flags.noops = false;
     ftepp_next(ftepp);
     if (!ftepp_skipspace(ftepp))
         return false;
+    ftepp->lex->flags.noops = true;
 
     if (ftepp->token == ')')
         return true;
@@ -317,8 +662,6 @@ static bool ftepp_if(ftepp_t *ftepp, ppcondition *cond)
 {
     bool result = false;
 
-    ftepp->lex->flags.noops = false;
-
     memset(cond, 0, sizeof(*cond));
     (void)ftepp_next(ftepp);
 
@@ -331,7 +674,6 @@ static bool ftepp_if(ftepp_t *ftepp, ppcondition *cond)
 
     if (!ftepp_if_expr(ftepp, &result))
         return false;
-    ftepp->lex->flags.noops = true;
 
     cond->on = result;
     return true;
@@ -406,6 +748,7 @@ static bool ftepp_hash(ftepp_t *ftepp)
                     return false;
                 cond.was_on = cond.on;
                 vec_push(ftepp->conditions, cond);
+                ftepp->output_on = ftepp->output_on && cond.on;
                 break;
             }
             else if (!strcmp(ftepp_tokval(ftepp), "ifndef")) {
@@ -414,6 +757,7 @@ static bool ftepp_hash(ftepp_t *ftepp)
                 cond.on = !cond.on;
                 cond.was_on = cond.on;
                 vec_push(ftepp->conditions, cond);
+                ftepp->output_on = ftepp->output_on && cond.on;
                 break;
             }
             else if (!strcmp(ftepp_tokval(ftepp), "elifdef")) {
@@ -424,6 +768,7 @@ static bool ftepp_hash(ftepp_t *ftepp)
                 pc = &vec_last(ftepp->conditions);
                 pc->on     = !pc->was_on && cond.on;
                 pc->was_on = pc->was_on || pc->on;
+                ftepp_update_output_condition(ftepp);
                 break;
             }
             else if (!strcmp(ftepp_tokval(ftepp), "elifndef")) {
@@ -435,6 +780,7 @@ static bool ftepp_hash(ftepp_t *ftepp)
                 pc = &vec_last(ftepp->conditions);
                 pc->on     = !pc->was_on && cond.on;
                 pc->was_on = pc->was_on || pc->on;
+                ftepp_update_output_condition(ftepp);
                 break;
             }
             else if (!strcmp(ftepp_tokval(ftepp), "elif")) {
@@ -445,6 +791,7 @@ static bool ftepp_hash(ftepp_t *ftepp)
                 pc = &vec_last(ftepp->conditions);
                 pc->on     = !pc->was_on && cond.on;
                 pc->was_on = pc->was_on  || pc->on;
+                ftepp_update_output_condition(ftepp);
                 break;
             }
             else if (!strcmp(ftepp_tokval(ftepp), "if")) {
@@ -452,6 +799,7 @@ static bool ftepp_hash(ftepp_t *ftepp)
                     return false;
                 cond.was_on = cond.on;
                 vec_push(ftepp->conditions, cond);
+                ftepp->output_on = ftepp->output_on && cond.on;
                 break;
             }
             else if (!strcmp(ftepp_tokval(ftepp), "else")) {
@@ -461,6 +809,7 @@ static bool ftepp_hash(ftepp_t *ftepp)
                 pc->on = !pc->was_on;
                 pc->had_else = true;
                 ftepp_next(ftepp);
+                ftepp_update_output_condition(ftepp);
                 break;
             }
             else if (!strcmp(ftepp_tokval(ftepp), "endif")) {
@@ -470,6 +819,7 @@ static bool ftepp_hash(ftepp_t *ftepp)
                 }
                 vec_pop(ftepp->conditions);
                 ftepp_next(ftepp);
+                ftepp_update_output_condition(ftepp);
                 break;
             }
             else {
@@ -486,44 +836,60 @@ static bool ftepp_hash(ftepp_t *ftepp)
         case TOKEN_EOF:
             ftepp_error(ftepp, "missing newline at end of file", ftepp_tokval(ftepp));
             return false;
+
+        /* Builtins! Don't forget the builtins! */
+        case TOKEN_INTCONST:
+        case TOKEN_FLOATCONST:
+            ftepp_out(ftepp, "#", false);
+            return true;
     }
     if (!ftepp_skipspace(ftepp))
         return false;
     return true;
 }
 
-static void ftepp_out(ftepp_t *ftepp, const char *str, bool ignore_cond)
-{
-    if (ignore_cond ||
-        !vec_size(ftepp->conditions) ||
-        vec_last(ftepp->conditions).on)
-    {
-        printf("%s", str);
-    }
-}
-
 static bool ftepp_preprocess(ftepp_t *ftepp)
 {
-    bool newline = true;
+    ppmacro *macro;
+    bool     newline = true;
 
     ftepp->lex->flags.preprocessing = true;
+    ftepp->lex->flags.mergelines    = false;
+    ftepp->lex->flags.noops         = true;
 
     ftepp_next(ftepp);
     do
     {
         if (ftepp->token >= TOKEN_EOF)
             break;
-
+#if 0
         ftepp->newline = newline;
         newline = false;
+#else
+        /* For the sake of FTE compatibility... FU, really */
+        ftepp->newline = newline = true;
+#endif
 
         switch (ftepp->token) {
+            case TOKEN_KEYWORD:
+            case TOKEN_IDENT:
+            case TOKEN_TYPENAME:
+                macro = ftepp_macro_find(ftepp, ftepp_tokval(ftepp));
+                if (!macro) {
+                    ftepp_out(ftepp, ftepp_tokval(ftepp), false);
+                    ftepp_next(ftepp);
+                    break;
+                }
+                if (!ftepp_macro_call(ftepp, macro))
+                    ftepp->token = TOKEN_ERROR;
+                break;
             case '#':
                 if (!ftepp->newline) {
                     ftepp_out(ftepp, ftepp_tokval(ftepp), false);
                     ftepp_next(ftepp);
                     break;
                 }
+                ftepp->lex->flags.mergelines = true;
                 if (ftepp_next(ftepp) >= TOKEN_EOF) {
                     ftepp_error(ftepp, "error in preprocessor directive");
                     ftepp->token = TOKEN_ERROR;
@@ -531,6 +897,7 @@ static bool ftepp_preprocess(ftepp_t *ftepp)
                 }
                 if (!ftepp_hash(ftepp))
                     ftepp->token = TOKEN_ERROR;
+                ftepp->lex->flags.mergelines = false;
                 break;
             case TOKEN_EOL:
                 newline = true;
@@ -544,8 +911,8 @@ static bool ftepp_preprocess(ftepp_t *ftepp)
         }
     } while (!ftepp->errors && ftepp->token < TOKEN_EOF);
 
-    ftepp_delete(ftepp);
-    return (ftepp->token == TOKEN_EOF);
+    newline = ftepp->token == TOKEN_EOF;
+    return newline;
 }
 
 bool ftepp_preprocess_file(const char *filename)
@@ -556,7 +923,12 @@ bool ftepp_preprocess_file(const char *filename)
         con_out("failed to open file \"%s\"\n", filename);
         return false;
     }
-    return ftepp_preprocess(ftepp);
+    if (!ftepp_preprocess(ftepp)) {
+        ftepp_delete(ftepp);
+        return false;
+    }
+    ftepp_delete(ftepp);
+    return true;
 }
 
 bool ftepp_preprocess_string(const char *name, const char *str)
@@ -567,5 +939,10 @@ bool ftepp_preprocess_string(const char *name, const char *str)
         con_out("failed to create lexer for string \"%s\"\n", name);
         return false;
     }
-    return ftepp_preprocess(ftepp);
+    if (!ftepp_preprocess(ftepp)) {
+        ftepp_delete(ftepp);
+        return false;
+    }
+    ftepp_delete(ftepp);
+    return true;
 }