]> git.draconx.ca Git - cdecl99.git/blobdiff - src/parse.y
libcdecl: Avoid redundant string literal in yyerror.
[cdecl99.git] / src / parse.y
index 5887e4dbadce7ce200f4fd5bad371ef0c68cc23c..abfccd20a5accb80404c9e5d399eb528742552da 100644 (file)
@@ -1,7 +1,7 @@
 %code top {
 /*
  *  Parser for C declarations.
- *  Copyright © 2011 Nick Bowler
+ *  Copyright © 2011-2012, 2021, 2023 Nick Bowler
  *
  *  This program is free software: you can redistribute it and/or modify
  *  it under the terms of the GNU General Public License as published by
@@ -18,7 +18,8 @@
  */
 }
 
-%parse-param {yyscan_t scanner}
+%name-prefix "cdecl__yy"
+%parse-param {void *scanner}
 %parse-param {struct cdecl **out}
 %lex-param {yyscan_t scanner}
 %define api.pure
 %locations
 
 %{
+#include <config.h>
 #include <assert.h>
 #include <stdbool.h>
 
 #include "scan.h"
 #include "cdecl.h"
+#include "cdecl-internal.h"
+#include "errmsg.h"
 
 #define FAIL(msg) do { \
        yyerror(&yylloc, NULL, NULL, msg); \
 
 #define ALLOC(ptr, size) do { \
        (ptr) = malloc(size); \
-       if (!(ptr)) \
-               FAIL("failed to allocate memory"); \
+       if (!(ptr)) { \
+               cdecl__errmsg(CDECL__ENOMEM); \
+               YYERROR; \
+       } \
 } while (0)
 
 #define ALLOC_STRUCT(ptr, type, ...) do { \
 }
 
 %code provides {
-void yyerror(YYLTYPE *, void *, struct cdecl **, const char *);
-int yyparse(void *scanner, struct cdecl **out);
+void cdecl__free(struct cdecl *);
+int cdecl__yyparse(void *scanner, struct cdecl **out);
+const char *cdecl__token_name(unsigned token);
 }
 
 %union {
        uintmax_t uintval;
+       unsigned spectype;
        _Bool boolval;
        char *strval;
        struct cdecl_declspec *declspec;
@@ -68,6 +76,7 @@ int yyparse(void *scanner, struct cdecl **out);
 }
 
 %{
+static void yyerror(YYLTYPE *, yyscan_t, struct cdecl **, const char *);
 static void free_decl(struct cdecl *);
 
 static void free_declspec(struct cdecl_declspec *x)
@@ -129,7 +138,7 @@ static void free_decl(struct cdecl *x)
        }
 }
 
-void cdecl_free(struct cdecl *decl)
+void cdecl__free(struct cdecl *decl)
 {
        free_decl(decl);
 }
@@ -140,7 +149,9 @@ void cdecl_free(struct cdecl *decl)
 %destructor { free_declarator($$); } <declarator>
 %destructor { free_decl($$); }       <decl>
 
+/* Magic tokens */
 %token T_LEX_ERROR
+%token T_ENGLISH
 
 %token <strval> T_IDENT "identifier"
 %token <uintval> T_UINT "integer constant"
@@ -154,38 +165,53 @@ void cdecl_free(struct cdecl *decl)
 %token T_COMMA     ","
 %token T_ELLIPSIS  "..."
 
-%token T_TYPEDEF   "typedef"
-%token T_EXTERN    "extern"
-%token T_STATIC    "static"
-%token T_AUTO      "auto"
-%token T_REGISTER  "register"
-
-%token T_INLINE    "inline"
-
-%token T_RESTRICT  "restrict"
-%token T_VOLATILE  "volatile"
-%token T_CONST     "const"
-
-%token T_VOID      "void"
-%token T_CHAR      "char"
-%token T_SHORT     "short"
-%token T_INT       "int"
-%token T_LONG      "long"
-%token T_FLOAT     "float"
-%token T_DOUBLE    "double"
-%token T_SIGNED    "signed"
-%token T_UNSIGNED  "unsigned"
-%token T_BOOL      "_Bool"
-%token T_COMPLEX   "_Complex"
-%token T_IMAGINARY "_Imaginary"
-
-%token T_STRUCT    "struct"
-%token T_UNION     "union"
-%token T_ENUM      "enum"
+%token <spectype> T_TYPEDEF   "typedef"
+%token <spectype> T_EXTERN    "extern"
+%token <spectype> T_STATIC    "static"
+%token <spectype> T_AUTO      "auto"
+%token <spectype> T_REGISTER  "register"
+
+%token <spectype> T_INLINE    "inline"
+
+%token <spectype> T_RESTRICT  "restrict"
+%token <spectype> T_VOLATILE  "volatile"
+%token <spectype> T_CONST     "const"
+
+%token <spectype> T_VOID      "void"
+%token <spectype> T_CHAR      "char"
+%token <spectype> T_SHORT     "short"
+%token <spectype> T_INT       "int"
+%token <spectype> T_LONG      "long"
+%token <spectype> T_FLOAT     "float"
+%token <spectype> T_DOUBLE    "double"
+%token <spectype> T_SIGNED    "signed"
+%token <spectype> T_UNSIGNED  "unsigned"
+%token <spectype> T_BOOL      "_Bool"
+%token <spectype> T_COMPLEX   "_Complex"
+%token <spectype> T_IMAGINARY "_Imaginary"
+
+%token <spectype> T_STRUCT    "struct"
+%token <spectype> T_UNION     "union"
+%token <spectype> T_ENUM      "enum"
+
+/*
+ * English keywords.
+ */
+%token T_TYPE      "type"
+%token T_DECLARE   "declare"
+%token T_POINTER   "pointer"
+%token T_FUNCTION  "function"
+%token T_RETURNING "returning"
+%token T_ARRAY     "array"
+%token T_TO        "to"
+%token T_OF        "of"
+%token T_AS        "as"
+%token T_VLA       "variable-length"
 
 %type <strval>     vla_ident
 %type <boolval>    varargs
-%type <uintval>    declspec_simple typespec_simple qualifier_simple
+%type <spectype>   declspec_simple qualifier_simple
+%type <spectype>   typespec_simple typespec_tagged
 %type <declspec>   declspec_notype declspec_noid typespec_noid typespec
 %type <declspec>   qualifier qualifiers
 %type <declspec>   declspecs declspecs_noid
@@ -194,19 +220,51 @@ void cdecl_free(struct cdecl *decl)
 %type <decl>       declaration declarators declarator_wrap
 %type <decl>       parameter parameters
 
+%type <strval>     english_vla
+%type <declspec>   storage_func_specs post_specs
+%type <declspec>   type_qual_spec type_qual_specs typedef_name_qual
+%type <declarator> english_declarator english_array english_function
+%type <declarator> english_parameter_list null_decl
+%type <decl>       english_parameter english_parameters
+%type <decl>       english english_declaration
+
+/*
+ * Harmless shift/reduce conflicts in english_parameter.  See comments below
+ * for more details.
+ */
+%expect 2
+
 %%
 
-input: declaration {
+input: T_ENGLISH english {
+       *out = $2;
+} | declaration {
        *out = $1;
 };
 
-declaration: declspecs declarators T_SEMICOLON {
-       $$ = $2;
+semi: | T_SEMICOLON
 
-       for (struct cdecl *i = $$; i; i = i->next)
-               i->specifiers = $1;
+declaration: declspecs declarators semi {
+       $$ = $2;
+       $$->specifiers = $1;
 };
 
+/*
+ * We support parsing declarations using arbitrary identifiers as type
+ * specifiers (a la C typedef).  To avoid confusion with identifiers that
+ * may also be used as declarators, note the following:
+ *
+ *  (a) Every valid C declaration must have at least one type specifier, and
+ *  (b) Valid declarations with typedef names have exactly one type specifier.
+ *
+ * So the rule applied when parsing specifiers is: an identifier is a type
+ * specifier only if we have not yet seen any type specifiers whatsoever
+ * (within one declaration specifier list).
+ *
+ * Treating identifiers as type specifiers by default can lead to strange and
+ * unexpected parses; libcdecl applies a simplification step to the resulting
+ * parse tree afterwards.
+ */
 declspecs: declspec_notype declspecs {
        $$ = $1;
        $$->next = $2;
@@ -234,29 +292,31 @@ declarator_wrap: declarator {
        ALLOC_STRUCT($$, struct cdecl, .declarators = $1);
 }
 
-declspec_simple: T_AUTO { $$ = CDECL_STOR_AUTO;     }
-       | T_TYPEDEF     { $$ = CDECL_STOR_TYPEDEF;  }
-       | T_EXTERN      { $$ = CDECL_STOR_EXTERN;   }
-       | T_STATIC      { $$ = CDECL_STOR_STATIC;   }
-       | T_REGISTER    { $$ = CDECL_STOR_REGISTER; }
-       | T_INLINE      { $$ = CDECL_FUNC_INLINE;   }
-
-typespec_simple: T_VOID { $$ = CDECL_TYPE_VOID;      }
-       | T_CHAR        { $$ = CDECL_TYPE_CHAR;      }
-       | T_SHORT       { $$ = CDECL_TYPE_SHORT;     }
-       | T_INT         { $$ = CDECL_TYPE_INT;       }
-       | T_LONG        { $$ = CDECL_TYPE_LONG;      }
-       | T_FLOAT       { $$ = CDECL_TYPE_FLOAT;     }
-       | T_DOUBLE      { $$ = CDECL_TYPE_DOUBLE;    }
-       | T_SIGNED      { $$ = CDECL_TYPE_SIGNED;    }
-       | T_UNSIGNED    { $$ = CDECL_TYPE_UNSIGNED;  }
-       | T_BOOL        { $$ = CDECL_TYPE_BOOL;      }
-       | T_COMPLEX     { $$ = CDECL_TYPE_COMPLEX;   }
-       | T_IMAGINARY   { $$ = CDECL_TYPE_IMAGINARY; }
-
-qualifier_simple: T_CONST { $$ = CDECL_QUAL_CONST;    }
-       | T_RESTRICT      { $$ = CDECL_QUAL_RESTRICT; }
-       | T_VOLATILE      { $$ = CDECL_QUAL_VOLATILE; }
+declspec_simple: T_AUTO
+       | T_TYPEDEF
+       | T_EXTERN
+       | T_STATIC
+       | T_REGISTER
+       | T_INLINE
+
+typespec_simple: T_VOID
+       | T_CHAR
+       | T_SHORT
+       | T_INT
+       | T_LONG
+       | T_FLOAT
+       | T_DOUBLE
+       | T_SIGNED
+       | T_UNSIGNED
+       | T_BOOL
+       | T_COMPLEX
+       | T_IMAGINARY
+
+typespec_tagged: T_STRUCT | T_UNION | T_ENUM
+
+qualifier_simple: T_CONST
+       | T_RESTRICT
+       | T_VOLATILE
 
 declspec_notype: qualifier | declspec_simple {
        ALLOC_STRUCT($$, struct cdecl_declspec, .type = $1);
@@ -270,17 +330,9 @@ qualifier: qualifier_simple {
        ALLOC_STRUCT($$, struct cdecl_declspec, .type = $1);
 }
 
-typespec: typespec_noid | T_STRUCT T_IDENT {
-       ALLOC_STRUCT($$, struct cdecl_declspec,
-               .type = CDECL_TYPE_STRUCT,
-               .ident = $2);
-} | T_UNION T_IDENT {
+typespec: typespec_noid | typespec_tagged T_IDENT {
        ALLOC_STRUCT($$, struct cdecl_declspec,
-               .type = CDECL_TYPE_UNION,
-               .ident = $2);
-} | T_ENUM T_IDENT {
-       ALLOC_STRUCT($$, struct cdecl_declspec,
-               .type = CDECL_TYPE_ENUM,
+               .type  = $1,
                .ident = $2);
 } | T_IDENT {
        ALLOC_STRUCT($$, struct cdecl_declspec,
@@ -297,7 +349,7 @@ vla_ident: T_IDENT | T_ASTERISK {
 
 array: T_LBRACKET T_UINT T_RBRACKET {
        if ($2 == 0)
-               FAIL("array length must be positive");
+               FAIL(_("array length must be positive"));
 
        ALLOC_STRUCT($$, struct cdecl_declarator,
                .type = CDECL_DECL_ARRAY,
@@ -384,13 +436,182 @@ direct_declarator: {
        $$->child = $1;
 }
 
+english: T_DECLARE T_IDENT T_AS english_declaration {
+       $$ = $4;
+       for (struct cdecl_declarator *d = $$->declarators; d; d = d->child) {
+               if (d->type == CDECL_DECL_NULL) {
+                       d->type = CDECL_DECL_IDENT;
+                       d->u.ident = $2;
+               }
+       }
+} | T_TYPE english_declaration {
+       $$ = $2;
+}
+
+storage_func_specs: { $$ = NULL; } | declspec_simple storage_func_specs {
+       ALLOC_STRUCT($$, struct cdecl_declspec,
+               .type = $1,
+               .next = $2);
+}
+
+type_qual_spec: typespec_noid | qualifier
+
+type_qual_specs: { $$ = NULL; } | type_qual_spec type_qual_specs {
+       $$ = $1;
+       $$->next = $2;
+}
+
+/*
+ * The "qualifiers" nonterminal needs to be used here to avoid shift/reduce
+ * conflicts with pointer declarators.  So we end up needing to stitch
+ * together three different specifiers lists.
+ */
+post_specs: qualifiers typespec type_qual_specs {
+       $$ = $2;
+       $$->next = $1;
+       for (struct cdecl_declspec *s = $$; s; s = s->next) {
+               if (!s->next) {
+                       s->next = $3;
+                       break;
+               }
+       }
+}
+
+english_declaration: storage_func_specs english_declarator post_specs {
+       ALLOC_STRUCT($$, struct cdecl,
+               .specifiers = $3,
+               .declarators = $2);
+
+       for (struct cdecl_declspec *s = $$->specifiers; s; s = s->next) {
+               if (!s->next) {
+                       s->next = $1;
+                       break;
+               }
+       }
+}
+
+english_declarator: {
+       ALLOC_STRUCT($$, struct cdecl_declarator,
+               .type = CDECL_DECL_NULL);
+} | english_declarator qualifiers T_POINTER T_TO {
+       ALLOC_STRUCT($$, struct cdecl_declarator,
+               .type = CDECL_DECL_POINTER,
+               .child = $1,
+               .u.pointer.qualifiers = $2);
+} | english_declarator english_array {
+       $$ = $2;
+       $$->child = $1;
+} | english_declarator english_function {
+       $$ = $2;
+       $$->child = $1;
+}
+
+english_function: T_FUNCTION T_RETURNING {
+       ALLOC_STRUCT($$, struct cdecl_declarator,
+               .type = CDECL_DECL_FUNCTION,
+               .u.function.parameters = NULL);
+} | T_FUNCTION T_LPAREN english_parameter_list T_RPAREN T_RETURNING {
+       $$ = $3;
+}
+
+english_parameter_list: english_parameters varargs {
+       struct cdecl *p, *c, *n;
+
+       /* Parameters were accumulated in reverse order. */
+       for (p = NULL, c = $1; c; p = c, c = n) {
+               n = c->next;
+               c->next = p;
+       }
+
+       ALLOC_STRUCT($$, struct cdecl_declarator,
+               .type = CDECL_DECL_FUNCTION,
+               .u.function.parameters = p,
+               .u.function.variadic = $2);
+}
+
+english_parameters: english_parameters T_COMMA english_parameter {
+       $$ = $3;
+       $$->next = $1;
+} | english_parameter
+
+typedef_name_qual: T_IDENT qualifiers {
+       ALLOC_STRUCT($$, struct cdecl_declspec,
+               .type = CDECL_TYPE_IDENT,
+               .ident = $1,
+               .next = $2);
+}
+
+null_decl: {
+       ALLOC_STRUCT($$, struct cdecl_declarator,
+               .type = CDECL_DECL_NULL);
+}
+
+/*
+ * There is a small shift/reduce conflict here.  An unadorned identifier
+ * as the first thing in the parameter might be a typedef name deep in the
+ * first english_declaration (thus empty storage_func_specs and empty
+ * english_declarator need to be reduced) or it might be the identifier
+ * before the "as" (thus the identifier should be shifted).
+ *
+ * The typedef name conflict is the only issue, so treating it as a special
+ * case makes the shift harmless.
+ */
+english_parameter: english_declaration | typedef_name_qual null_decl {
+       ALLOC_STRUCT($$, struct cdecl,
+               .specifiers = $1,
+               .declarators = $2);
+} | T_IDENT T_AS english_declaration {
+       $$ = $3;
+       for (struct cdecl_declarator *d = $$->declarators; d; d = d->child) {
+               if (d->type == CDECL_DECL_NULL) {
+                       d->type = CDECL_DECL_IDENT;
+                       d->u.ident = $1;
+               }
+       }
+}
+
+english_array: T_VLA T_ARRAY english_vla T_OF {
+       ALLOC_STRUCT($$, struct cdecl_declarator,
+               .type = CDECL_DECL_ARRAY,
+               .u.array.vla = $3);
+} | T_ARRAY T_UINT T_OF {
+       if ($2 == 0)
+               FAIL(_("array length must be positive"));
+
+       ALLOC_STRUCT($$, struct cdecl_declarator,
+               .type = CDECL_DECL_ARRAY,
+               .u.array.length = $2);
+} | T_ARRAY T_OF {
+       ALLOC_STRUCT($$, struct cdecl_declarator,
+               .type = CDECL_DECL_ARRAY,
+               .u.array.length = 0);
+}
+
+english_vla: T_IDENT | {
+       ALLOC($$, sizeof "");
+       strcpy($$, "");
+}
+
 %%
-void
-yyerror(YYLTYPE *loc, yyscan_t scanner, struct cdecl **out,
-        const char *err)
+
+/*
+ * Expose the token string table to the rest of the library, in order to
+ * produce strings that match parser keywords.
+ *
+ * In order for this to work properly, the Bison output must be postprocessed
+ * by fix-yytname.awk to remove pointless quotation marks from the keyword
+ * strings.
+ */
+const char *cdecl__token_name(unsigned token)
+{
+       return yytname[YYTRANSLATE(token)];
+}
+
+static void
+yyerror(YYLTYPE *loc, yyscan_t scanner, struct cdecl **out, const char *err)
 {
-       if (strstr(err, "T_LEX_ERROR"))
+       if (strstr(err, yytname[YYTRANSLATE(T_LEX_ERROR)]))
                return;
 
-       fprintf(stderr, "%s\n", err);
+       cdecl__err(CDECL_ENOPARSE, "%s", err);
 }