3 * Parser for C declarations.
4 * Copyright © 2011-2012, 2021, 2023 Nick Bowler
6 * This program is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program. If not, see <http://www.gnu.org/licenses/>.
21 %name-prefix "cdecl__yy"
22 %parse-param {void *scanner}
23 %parse-param {struct cdecl **out}
24 %lex-param {yyscan_t scanner}
36 #include "cdecl-internal.h"
39 #define FAIL(msg) do { \
40 yyerror(&yylloc, NULL, NULL, msg); \
44 #define ALLOC(ptr, size) do { \
45 (ptr) = malloc(size); \
47 cdecl__errmsg(CDECL__ENOMEM); \
52 #define ALLOC_STRUCT(ptr, type, ...) do { \
53 ALLOC(ptr, sizeof (type)); \
54 *(ptr) = (type) { __VA_ARGS__ }; \
63 void cdecl__free(struct cdecl *);
64 int cdecl__yyparse(void *scanner, struct cdecl **out);
65 const char *cdecl__token_name(unsigned token);
73 struct cdecl_declspec *declspec;
74 struct cdecl_declarator *declarator;
79 static void free_decl(struct cdecl *);
81 static void free_declspec(struct cdecl_declspec *x)
83 struct cdecl_declspec *p;
92 static void free_declarator(struct cdecl_declarator *x)
94 struct cdecl_declarator *p;
100 case CDECL_DECL_NULL:
102 case CDECL_DECL_IDENT:
105 case CDECL_DECL_POINTER:
106 free_declspec(x->u.pointer.qualifiers);
108 case CDECL_DECL_ARRAY:
109 free(x->u.array.vla);
111 case CDECL_DECL_FUNCTION:
112 free_decl(x->u.function.parameters);
123 static void free_decl(struct cdecl *x)
130 /* The specifiers may be shared by an entire chain. */
131 if (!p || p->specifiers != x->specifiers)
132 free_declspec(x->specifiers);
134 free_declarator(x->declarators);
140 void cdecl__free(struct cdecl *decl)
146 yyerror(YYLTYPE *loc, yyscan_t scanner, struct cdecl **out, const char *err)
148 if (strstr(err, "T_LEX_ERROR"))
151 cdecl__err(CDECL_ENOPARSE, "%s", err);
155 %destructor { free($$); } <strval>
156 %destructor { free_declspec($$); } <declspec>
157 %destructor { free_declarator($$); } <declarator>
158 %destructor { free_decl($$); } <decl>
164 %token <strval> T_IDENT "identifier"
165 %token <uintval> T_UINT "integer constant"
167 %token T_SEMICOLON ";"
168 %token T_ASTERISK "*"
171 %token T_LBRACKET "["
172 %token T_RBRACKET "]"
174 %token T_ELLIPSIS "..."
176 %token <spectype> T_TYPEDEF "typedef"
177 %token <spectype> T_EXTERN "extern"
178 %token <spectype> T_STATIC "static"
179 %token <spectype> T_AUTO "auto"
180 %token <spectype> T_REGISTER "register"
182 %token <spectype> T_INLINE "inline"
184 %token <spectype> T_RESTRICT "restrict"
185 %token <spectype> T_VOLATILE "volatile"
186 %token <spectype> T_CONST "const"
188 %token <spectype> T_VOID "void"
189 %token <spectype> T_CHAR "char"
190 %token <spectype> T_SHORT "short"
191 %token <spectype> T_INT "int"
192 %token <spectype> T_LONG "long"
193 %token <spectype> T_FLOAT "float"
194 %token <spectype> T_DOUBLE "double"
195 %token <spectype> T_SIGNED "signed"
196 %token <spectype> T_UNSIGNED "unsigned"
197 %token <spectype> T_BOOL "_Bool"
198 %token <spectype> T_COMPLEX "_Complex"
199 %token <spectype> T_IMAGINARY "_Imaginary"
201 %token <spectype> T_STRUCT "struct"
202 %token <spectype> T_UNION "union"
203 %token <spectype> T_ENUM "enum"
209 %token T_DECLARE "declare"
210 %token T_POINTER "pointer"
211 %token T_FUNCTION "function"
212 %token T_RETURNING "returning"
213 %token T_ARRAY "array"
217 %token T_VLA "variable-length"
219 %type <strval> vla_ident
220 %type <boolval> varargs
221 %type <spectype> declspec_simple qualifier_simple
222 %type <spectype> typespec_simple typespec_tagged
223 %type <declspec> declspec_notype declspec_noid typespec_noid typespec
224 %type <declspec> qualifier qualifiers
225 %type <declspec> declspecs declspecs_noid
226 %type <declarator> direct_declarator declarator pointer array parens postfix
227 %type <declarator> direct_declarator_ish declarator_ish parameter_type_list
228 %type <decl> declaration declarators declarator_wrap
229 %type <decl> parameter parameters
231 %type <strval> english_vla
232 %type <declspec> storage_func_specs post_specs
233 %type <declspec> type_qual_spec type_qual_specs typedef_name_qual
234 %type <declarator> english_declarator english_array english_function
235 %type <declarator> english_parameter_list null_decl
236 %type <decl> english_parameter english_parameters
237 %type <decl> english english_declaration
240 * Harmless shift/reduce conflicts in english_parameter. See comments below
247 input: T_ENGLISH english {
255 declaration: declspecs declarators semi {
258 for (struct cdecl *i = $$; i; i = i->next)
263 * We support parsing declarations using arbitrary identifiers as type
264 * specifiers (a la C typedef). To avoid confusion with identifiers that
265 * may also be used as declarators, note the following:
267 * (a) Every valid C declaration must have at least one type specifier, and
268 * (b) Valid declarations with typedef names have exactly one type specifier.
270 * So the rule applied when parsing specifiers is: an identifier is a type
271 * specifier only if we have not yet seen any type specifiers whatsoever
272 * (within one declaration specifier list).
274 * Treating identifiers as type specifiers by default can lead to strange and
275 * unexpected parses; libcdecl applies a simplification step to the resulting
276 * parse tree afterwards.
278 declspecs: declspec_notype declspecs {
281 } | typespec declspecs_noid {
286 declspecs_noid: { $$ = NULL; } | declspec_noid declspecs_noid {
291 qualifiers: { $$ = NULL; } | qualifiers qualifier {
296 declarators: declarator_wrap | declarator_wrap T_COMMA declarators {
301 declarator_wrap: declarator {
302 ALLOC_STRUCT($$, struct cdecl, .declarators = $1);
305 declspec_simple: T_AUTO
312 typespec_simple: T_VOID
325 typespec_tagged: T_STRUCT | T_UNION | T_ENUM
327 qualifier_simple: T_CONST
331 declspec_notype: qualifier | declspec_simple {
332 ALLOC_STRUCT($$, struct cdecl_declspec, .type = $1);
335 typespec_noid: typespec_simple {
336 ALLOC_STRUCT($$, struct cdecl_declspec, .type = $1);
339 qualifier: qualifier_simple {
340 ALLOC_STRUCT($$, struct cdecl_declspec, .type = $1);
343 typespec: typespec_noid | typespec_tagged T_IDENT {
344 ALLOC_STRUCT($$, struct cdecl_declspec,
348 ALLOC_STRUCT($$, struct cdecl_declspec,
349 .type = CDECL_TYPE_IDENT,
353 declspec_noid: declspec_notype | typespec_noid
355 vla_ident: T_IDENT | T_ASTERISK {
356 ALLOC($$, sizeof "");
360 array: T_LBRACKET T_UINT T_RBRACKET {
362 FAIL(_("array length must be positive"));
364 ALLOC_STRUCT($$, struct cdecl_declarator,
365 .type = CDECL_DECL_ARRAY,
366 .u.array.length = $2);
367 } | T_LBRACKET vla_ident T_RBRACKET {
368 ALLOC_STRUCT($$, struct cdecl_declarator,
369 .type = CDECL_DECL_ARRAY,
371 } | T_LBRACKET T_RBRACKET {
372 ALLOC_STRUCT($$, struct cdecl_declarator,
373 .type = CDECL_DECL_ARRAY);
376 parameter: declspecs declarator {
377 ALLOC_STRUCT($$, struct cdecl,
382 parameters: parameter | parameters T_COMMA parameter {
387 varargs: { $$ = false; } | T_COMMA T_ELLIPSIS { $$ = true; }
389 parameter_type_list: parameters varargs {
390 struct cdecl *p, *c, *n;
392 /* Parameters were accumulated in reverse order. */
393 for (p = NULL, c = $1; c; p = c, c = n) {
398 ALLOC_STRUCT($$, struct cdecl_declarator,
399 .type = CDECL_DECL_FUNCTION,
400 .u.function.parameters = p,
401 .u.function.variadic = $2);
404 parens: T_LPAREN parameter_type_list T_RPAREN {
406 } | T_LPAREN declarator_ish T_RPAREN {
407 ALLOC_STRUCT($$, struct cdecl_declarator,
408 .type = CDECL_DECL_FUNCTION);
409 ALLOC_STRUCT($$->u.function.parameters, struct cdecl,
413 pointer: T_ASTERISK qualifiers direct_declarator {
414 ALLOC_STRUCT($$, struct cdecl_declarator,
415 .type = CDECL_DECL_POINTER,
416 .u.pointer.qualifiers = $2,
418 } | T_ASTERISK qualifiers pointer {
419 ALLOC_STRUCT($$, struct cdecl_declarator,
420 .type = CDECL_DECL_POINTER,
421 .u.pointer.qualifiers = $2,
425 declarator: direct_declarator | pointer
426 declarator_ish: direct_declarator_ish | pointer
427 postfix: array | parens
429 direct_declarator_ish: {
430 ALLOC_STRUCT($$, struct cdecl_declarator,
431 .type = CDECL_DECL_NULL);
432 } | direct_declarator_ish postfix {
438 ALLOC_STRUCT($$, struct cdecl_declarator,
439 .type = CDECL_DECL_NULL);
441 ALLOC_STRUCT($$, struct cdecl_declarator,
442 .type = CDECL_DECL_IDENT,
444 } | direct_declarator postfix {
449 english: T_DECLARE T_IDENT T_AS english_declaration {
451 for (struct cdecl_declarator *d = $$->declarators; d; d = d->child) {
452 if (d->type == CDECL_DECL_NULL) {
453 d->type = CDECL_DECL_IDENT;
457 } | T_TYPE english_declaration {
461 storage_func_specs: { $$ = NULL; } | declspec_simple storage_func_specs {
462 ALLOC_STRUCT($$, struct cdecl_declspec,
467 type_qual_spec: typespec_noid | qualifier
469 type_qual_specs: { $$ = NULL; } | type_qual_spec type_qual_specs {
475 * The "qualifiers" nonterminal needs to be used here to avoid shift/reduce
476 * conflicts with pointer declarators. So we end up needing to stitch
477 * together three different specifiers lists.
479 post_specs: qualifiers typespec type_qual_specs {
482 for (struct cdecl_declspec *s = $$; s; s = s->next) {
490 english_declaration: storage_func_specs english_declarator post_specs {
491 ALLOC_STRUCT($$, struct cdecl,
495 for (struct cdecl_declspec *s = $$->specifiers; s; s = s->next) {
503 english_declarator: {
504 ALLOC_STRUCT($$, struct cdecl_declarator,
505 .type = CDECL_DECL_NULL);
506 } | english_declarator qualifiers T_POINTER T_TO {
507 ALLOC_STRUCT($$, struct cdecl_declarator,
508 .type = CDECL_DECL_POINTER,
510 .u.pointer.qualifiers = $2);
511 } | english_declarator english_array {
514 } | english_declarator english_function {
519 english_function: T_FUNCTION T_RETURNING {
520 ALLOC_STRUCT($$, struct cdecl_declarator,
521 .type = CDECL_DECL_FUNCTION,
522 .u.function.parameters = NULL);
523 } | T_FUNCTION T_LPAREN english_parameter_list T_RPAREN T_RETURNING {
527 english_parameter_list: english_parameters varargs {
528 struct cdecl *p, *c, *n;
530 /* Parameters were accumulated in reverse order. */
531 for (p = NULL, c = $1; c; p = c, c = n) {
536 ALLOC_STRUCT($$, struct cdecl_declarator,
537 .type = CDECL_DECL_FUNCTION,
538 .u.function.parameters = p,
539 .u.function.variadic = $2);
542 english_parameters: english_parameters T_COMMA english_parameter {
545 } | english_parameter
547 typedef_name_qual: T_IDENT qualifiers {
548 ALLOC_STRUCT($$, struct cdecl_declspec,
549 .type = CDECL_TYPE_IDENT,
555 ALLOC_STRUCT($$, struct cdecl_declarator,
556 .type = CDECL_DECL_NULL);
560 * There is a small shift/reduce conflict here. An unadorned identifier
561 * as the first thing in the parameter might be a typedef name deep in the
562 * first english_declaration (thus empty storage_func_specs and empty
563 * english_declarator need to be reduced) or it might be the identifier
564 * before the "as" (thus the identifier should be shifted).
566 * The typedef name conflict is the only issue, so treating it as a special
567 * case makes the shift harmless.
569 english_parameter: english_declaration | typedef_name_qual null_decl {
570 ALLOC_STRUCT($$, struct cdecl,
573 } | T_IDENT T_AS english_declaration {
575 for (struct cdecl_declarator *d = $$->declarators; d; d = d->child) {
576 if (d->type == CDECL_DECL_NULL) {
577 d->type = CDECL_DECL_IDENT;
583 english_array: T_VLA T_ARRAY english_vla T_OF {
584 ALLOC_STRUCT($$, struct cdecl_declarator,
585 .type = CDECL_DECL_ARRAY,
587 } | T_ARRAY T_UINT T_OF {
589 FAIL(_("array length must be positive"));
591 ALLOC_STRUCT($$, struct cdecl_declarator,
592 .type = CDECL_DECL_ARRAY,
593 .u.array.length = $2);
595 ALLOC_STRUCT($$, struct cdecl_declarator,
596 .type = CDECL_DECL_ARRAY,
597 .u.array.length = 0);
600 english_vla: T_IDENT | {
601 ALLOC($$, sizeof "");
608 * Expose the token string table to the rest of the library, in order to
609 * produce strings that match parser keywords.
611 * In order for this to work properly, the Bison output must be postprocessed
612 * by fix-yytname.awk to remove pointless quotation marks from the keyword
615 const char *cdecl__token_name(unsigned token)
617 return yytname[YYTRANSLATE(token)];