src/parse-decl.c

   1 /*
   2  * Parse and validate C declarations.
   3  * Copyright © 2011-2012, 2020-2021, 2023 Nick Bowler
   4  *
   5  * This program is free software: you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation, either version 3 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  17  */
  18
  19 #include <config.h>
  20 #include <stdio.h>
  21 #include <assert.h>
  22 #include <stdbool.h>
  23
  24 #include "cdecl.h"
  25 #include "cdecl-internal.h"
  26 #include "parse.h"
  27 #include "scan.h"
  28 #include "errmsg.h"
  29
  30 /*
  31  * We can represent type specifiers as a bitmap, which gives us a finite
  32  * list of acceptable bitmap values according to the C standard.  However,
  33  * the "long" specifier is allowed to occur more than once, but only at most
  34  * 2 times.  Treat it as a special case, assigning an unused bit to represent
  35  * the second long.
  36  */
  37 #define MAP_LLONG_BIT 31
  38 #define MAP_LONG_BIT (CDECL_TYPE_LONG-CDECL_SPEC_TYPE)
  39 #define CDECL_TYPE_LLONG (CDECL_SPEC_TYPE+MAP_LLONG_BIT)
  40
  41 #include "typemap.h"
  42
  43 /*
  44  * Convert the declaration specifiers to a bitmap with each bit
  45  * corresponding to one specific type specifier.
  46  */
  47 static int valid_typespec(struct cdecl_declspec *s)
  48 {
  49         unsigned long map = 0;
  50
  51         for (struct cdecl_declspec *c = s; c; c = c->next) {
  52                 unsigned long bit;
  53
  54                 if (cdecl_spec_kind(c) != CDECL_SPEC_TYPE)
  55                         continue;
  56
  57                 bit = c->type - CDECL_SPEC_TYPE;
  58                 assert(bit < MAP_LLONG_BIT);
  59                 bit = 1ul << bit;
  60
  61                 /* "long" special case */
  62                 if ((map & bit) == 1ul << MAP_LONG_BIT)
  63                         bit = 1ul << MAP_LLONG_BIT;
  64
  65                 if (map & bit) {
  66                         if (bit == 1ul << MAP_LLONG_BIT)
  67                                 cdecl__errmsg(CDECL__ETOOLONG);
  68                         else
  69                                 cdecl__errmsg(CDECL__EDUPTYPE);
  70                         return false;
  71                 }
  72                 map |= bit;
  73         }
  74
  75         if (typemap_is_valid(map))
  76                 return true;
  77
  78         if (map == 0)
  79                 cdecl__errmsg(CDECL__ENOTYPE);
  80         else
  81                 cdecl__errmsg(CDECL__EBADTYPE);
  82
  83         return false;
  84 }
  85
  86 /*
  87  * Verify the declaration specifiers of a declaration.  If top is true, treat
  88  * this as a top-level declaration.  Otherwise, treat this as a function
  89  * parameter (which carries additional constraints).
  90  */
  91 static bool valid_declspecs(struct cdecl *decl, bool top)
  92 {
  93         struct cdecl_declspec *specs = decl->specifiers;
  94         struct cdecl_declarator *d   = decl->declarators;
  95         bool abstract = cdecl_is_abstract(d);
  96         unsigned num_storage = 0;
  97
  98         if (!valid_typespec(specs))
  99                 return false;
 100
 101         for (struct cdecl_declspec *c = specs; c; c = c->next) {
 102                 switch (cdecl_spec_kind(c)) {
 103                 case CDECL_SPEC_TYPE:
 104                         if (c->type == CDECL_TYPE_VOID &&
 105                             (d->type == CDECL_DECL_IDENT
 106                              || d->type == CDECL_DECL_ARRAY)) {
 107                                 cdecl__errmsg(CDECL__EBADVOID);
 108                                 return false;
 109                         }
 110                         continue;
 111                 case CDECL_SPEC_STOR:
 112                         if (top && abstract) {
 113                                 cdecl__errmsg(CDECL__ETYPESTOR);
 114                                 return false;
 115                         }
 116
 117                         if (!top && c->type != CDECL_STOR_REGISTER) {
 118                                 cdecl__errmsg(CDECL__EFUNCSTOR);
 119                                 return false;
 120                         }
 121
 122                         if (++num_storage > 1) {
 123                                 cdecl__errmsg(CDECL__EMANYSTOR);
 124                                 return false;
 125                         }
 126                         break;
 127                 case CDECL_SPEC_QUAL:
 128                         /*
 129                          * Restrict qualifiers are only valid in the
 130                          * pointer qualifier list, which isn't checked here.
 131                          */
 132                         if (c->type == CDECL_QUAL_RESTRICT) {
 133                                 cdecl__errmsg(CDECL__EBADQUAL);
 134                                 return false;
 135                         }
 136                         break;
 137                 case CDECL_SPEC_FUNC:
 138                         if (abstract || !top || d->type != CDECL_DECL_FUNCTION) {
 139                                 cdecl__errmsg(CDECL__ENOTFUNC);
 140                                 return false;
 141                         }
 142
 143                         break;
 144                 default:
 145                         assert(0);
 146                 }
 147         }
 148
 149         return true;
 150 }
 151
 152 /*
 153  * The C grammar leaves ambiguous some cases where parentheses represent a
 154  * function declarator or just parentheses.  The language uses additional
 155  * context (whether or not a typedef is in scope, etc.) to resolve these
 156  * ambiguities, but we don't have access to that kind of information.
 157  *
 158  * The cdecl99 parser uses an unambiguous grammar which treats almost
 159  * everything as a function, and thus considers things like 'int (x)' to
 160  * be a function type with a single parameter of type 'x' (a typedef name),
 161  * returning int.  This can result in very complicated types for simple
 162  * declarations.  Ideally, cdecl99 should try and find the "simplest"
 163  * explanation for a given declaration.
 164  *
 165  * Whether or not it achieves the simplest explanation, we apply a simple rule:
 166  * if a declarator could be interpreted as something other than a function,
 167  * do that.
 168  *
 169  * Since cdecl99 supports things like [*] in any context (in C, such constructs
 170  * are only valid in function parameter lists), we don't treat them specially
 171  * here.
 172  */
 173
 174 static struct cdecl_declarator *reduce_function(struct cdecl *param)
 175 {
 176         struct cdecl_declspec   *spec = param->specifiers;
 177         struct cdecl_declarator *decl = param->declarators;
 178         struct cdecl_declarator *last;
 179
 180         for (last = decl; last && last->type != CDECL_DECL_NULL;)
 181                 last = last->child;
 182
 183         if (!last)
 184                 return NULL;
 185
 186         last->type = CDECL_DECL_IDENT;
 187         last->u.ident = spec->ident;
 188         free(param);
 189         free(spec);
 190
 191         return decl;
 192 }
 193
 194 static bool function_is_reducible(struct cdecl_declarator *d)
 195 {
 196         if (d->type != CDECL_DECL_FUNCTION)
 197                 return false;
 198         if (d->child->type != CDECL_DECL_NULL)
 199                 return false; /* e.g., int (*)(x) */
 200
 201         if (!d->u.function.parameters)
 202                 return false; /* e.g., int f() */
 203         if (d->u.function.parameters->next)
 204                 return false; /* e.g., int (x, y) */
 205         if (d->u.function.variadic)
 206                 return false; /* e.g., int (x, ...) */
 207
 208         if (d->u.function.parameters->specifiers->type != CDECL_TYPE_IDENT)
 209                 return false; /* e.g. int (int) */
 210         if (d->u.function.parameters->specifiers->next)
 211                 return false; /* e.g. int (size_t const) */
 212         if (d->u.function.parameters->declarators->type == CDECL_DECL_POINTER)
 213                 return false; /* e.g. int (x *) */
 214
 215         return true;
 216 }
 217
 218 static int
 219 simplify_functions(struct cdecl_declarator **p, struct cdecl_declarator *d)
 220 {
 221         struct cdecl_declarator *new;
 222
 223         if (!function_is_reducible(d))
 224                 return 0;
 225
 226         new = reduce_function(d->u.function.parameters);
 227         if (!new)
 228                 return 0; /* e.g. int (foo bar) */
 229         *p = new;
 230         free(d->child);
 231         free(d);
 232
 233         return 0;
 234 }
 235
 236 /*
 237  * The parser's bias towards considering things as functions whenever possible
 238  * makes nested parentheses tricky.  (x) is considered to be part of a function
 239  * declarator until simplify_functions converts it.  The problem is that
 240  * (((x))) is not valid as part of a function declarator, but it *is* valid
 241  * as an identifier enclosed 3 times in parentheses.  This is complicated by
 242  * the fact that things like (((int))) are not valid anywhere.
 243  *
 244  * To avoid ambiguities, the parser actually emits a "function" declarator for
 245  * every pair of parentheses.  The ones that can't reasonably be functions
 246  * consist of a single "parameter" with no declaration specifiers (note that
 247  * every valid function parameter will have at least one type specifier).
 248  *
 249  * This pass is to remove these fake functions from the parse tree.  We take
 250  * care to avoid turning invalid things like ((int)) into valid things like
 251  * (int) by observing that the only valid function declarators that appear
 252  * in these "fake" parentheses are those that have a non-null child declarator
 253  * (for instance, int ((*)(int)) *or* those that will be eliminated by the
 254  * simplify_functions pass.
 255  */
 256
 257 static int
 258 reduce_parentheses(struct cdecl_declarator **p, struct cdecl_declarator *d)
 259 {
 260         struct cdecl *param;
 261
 262         if (d->type != CDECL_DECL_FUNCTION)
 263                 return 0;
 264
 265         param = d->u.function.parameters;
 266         if (param && param->specifiers == NULL) {
 267                 struct cdecl_declarator *decl;
 268
 269                 assert(!param->next);
 270
 271                 decl = param->declarators;
 272                 if (decl->type == CDECL_DECL_NULL) {
 273                         free(decl);
 274                         free(param);
 275                         d->u.function.parameters = NULL;
 276                         return 0;
 277                 }
 278
 279                 if (d->child->type != CDECL_DECL_NULL) {
 280                         cdecl__errmsg(CDECL__EBADPARAM);
 281                         return -1;
 282                 }
 283
 284                 free(d->child);
 285                 free(param);
 286                 free(d);
 287                 *p = decl;
 288
 289                 /*
 290                  * We may have replaced d with another fake function which
 291                  * also needs to be eliminated.
 292                  */
 293                 if (reduce_parentheses(p, decl) < 0)
 294                         return -1;
 295
 296                 /*
 297                  * If the remaining declarator is a function, make sure it's
 298                  * valid by checking its reducibility.
 299                  */
 300                 decl = *p;
 301                 if (decl->type == CDECL_DECL_FUNCTION
 302                     && decl->child->type == CDECL_DECL_NULL
 303                     && !function_is_reducible(decl)) {
 304                         cdecl__errmsg(CDECL__EMANYPAREN);
 305                         return -1;
 306                 }
 307
 308                 return 0;
 309         }
 310
 311         return 0;
 312 }
 313
 314 /*
 315  * Returns nonzero iff the given specifier list contains a specifier
 316  * of the indicated type.
 317  */
 318 static int have_specifier(struct cdecl_declspec *s, unsigned type)
 319 {
 320         for (; s; s = s->next)
 321                 if (s->type == type)
 322                         return 1;
 323         return 0;
 324 }
 325
 326 /*
 327  * Check syntax restrictions on a function declarator's child declarator.
 328  * That is, "pointer to function", "array of function" and "function
 329  * returning function".
 330  *
 331  * Returns -1 if the declaration is invalid, or 0 otherwise.
 332  */
 333 static int check_function_child(struct cdecl_declarator *d)
 334 {
 335         struct cdecl_pointer *ptr;
 336
 337         switch (d->type) {
 338         case CDECL_DECL_POINTER:
 339                 ptr = &d->u.pointer;
 340                 if (have_specifier(ptr->qualifiers, CDECL_QUAL_RESTRICT)) {
 341                         /* pointer to function cannot be restrict qualified. */
 342                         cdecl__errmsg(CDECL__ERESTRICTFUNC);
 343                         return -1;
 344                 }
 345                 return 0;
 346         case CDECL_DECL_FUNCTION:
 347                 /* function returning function is never allowed. */
 348                 cdecl__errmsg(CDECL__ERETFUNC);
 349                 return -1;
 350         case CDECL_DECL_ARRAY:
 351                 /* array of function is never allowed. */
 352                 cdecl__errmsg(CDECL__EFUNCARRAY);
 353                 return -1;
 354         }
 355
 356         return 0;
 357 }
 358
 359 /*
 360  * Check a function parameter declaration for validity, which means it has a
 361  * valid combination of declaration specifiers and, if it is a void parameter,
 362  * that it is the one special case where this is allowed.
 363  *
 364  * Returns -1 if the declaration is invalid, or 0 otherwise.
 365  */
 366 static int check_function_param(struct cdecl_function *f, struct cdecl *param)
 367 {
 368         if (!valid_declspecs(param, false))
 369                 return -1;
 370
 371         /* Check for "void" function parameters as a special case. */
 372         if (param->declarators->type == CDECL_DECL_NULL
 373             && have_specifier(param->specifiers, CDECL_TYPE_VOID))
 374         {
 375                 struct cdecl *fp = f->parameters;
 376
 377                 if (f->variadic || fp->next || fp->specifiers->next) {
 378                         cdecl__errmsg(CDECL__EVOIDPARAM);
 379                         return -1;
 380                 }
 381         }
 382
 383         return 0;
 384 }
 385
 386 /*
 387  * Normalize the specifier lists for function parameters, and then check the
 388  * function declarator for validity.
 389  *
 390  * Returns -1 if the declaration is invalid, or 0 otherwise.
 391  */
 392 static int postproc_function(struct cdecl_declarator *d)
 393 {
 394         struct cdecl_function *func = &d->u.function;
 395         struct cdecl *param;
 396         int rc;
 397
 398         for (param = func->parameters; param; param = param->next) {
 399                 param->specifiers = cdecl__normalize_specs(param->specifiers);
 400
 401                 if ((rc = check_function_param(func, param)) < 0)
 402                         return rc;
 403         }
 404
 405         return check_function_child(d->child);
 406 }
 407
 408 static int
 409 postproc_common(struct cdecl_declarator **p, struct cdecl_declarator *d)
 410 {
 411         struct cdecl_pointer *ptr;
 412
 413         switch (d->type) {
 414         case CDECL_DECL_POINTER:
 415                 ptr = &d->u.pointer;
 416                 ptr->qualifiers = cdecl__normalize_specs(ptr->qualifiers);
 417                 return 0;
 418         case CDECL_DECL_FUNCTION:
 419                 return postproc_function(d);
 420         case CDECL_DECL_ARRAY:
 421                 if (d->child && d->child->type == CDECL_DECL_FUNCTION) {
 422                         /* function returning array is never allowed. */
 423                         cdecl__errmsg(CDECL__ERETARRAY);
 424                         return -1;
 425                 }
 426                 return 0;
 427         }
 428
 429         return 0;
 430 }
 431
 432 /*
 433  * Traverse the parse tree, calling a function on every declarator in a
 434  * depth-first preorder traversal.  The function is given a pointer to the
 435  * declarator as well as to the pointer which was used to reach that
 436  * declarator: this can be used to rewrite entire subtrees.
 437  *
 438  * The called function may return a negative value to indicate an error
 439  * which terminates traversal.
 440  *
 441  * Returns 0 on success, or a negative value on failure.
 442  */
 443 static int forall_declarators(struct cdecl *decl,
 444         int f(struct cdecl_declarator **, struct cdecl_declarator *))
 445 {
 446         struct cdecl_declarator *d, **p;
 447
 448         for (p = &decl->declarators; *p; p = &d->child) {
 449                 int rc;
 450
 451                 rc = f(p, *p);
 452                 if (rc < 0)
 453                         return rc;
 454                 d = *p;
 455
 456                 if (d->type == CDECL_DECL_FUNCTION) {
 457                         struct cdecl *i;
 458
 459                         for (i = d->u.function.parameters; i; i = i->next) {
 460                                 rc = forall_declarators(i, f);
 461                                 if (rc < 0)
 462                                         return rc;
 463                         }
 464                 }
 465         }
 466
 467         return 0;
 468 }
 469
 470 static struct cdecl *do_parse(const char *str, int english_mode)
 471 {
 472         YY_BUFFER_STATE state;
 473         yyscan_t scanner;
 474         struct cdecl *decl;
 475
 476 #if YYDEBUG
 477         extern int cdecl__yydebug;
 478         cdecl__yydebug = 1;
 479 #endif
 480
 481         cdecl__init_i18n();
 482         if (cdecl__yylex_init_extra(english_mode, &scanner) != 0)
 483                 return NULL;
 484
 485         state = cdecl__yy_scan_string(str, scanner);
 486         if (cdecl__yyparse(scanner, &decl) != 0)
 487                 decl = NULL;
 488         cdecl__yy_delete_buffer(state, scanner);
 489         cdecl__yylex_destroy(scanner);
 490
 491         return decl;
 492 }
 493
 494 static int do_postprocess(struct cdecl *decl, int english_mode)
 495 {
 496         struct cdecl_declspec *norm_specs;
 497         struct cdecl *i;
 498
 499         /*
 500          * For a C declaration with more than one full declarator, the
 501          * specifier list is common to all of them.  Normalize it once,
 502          * then propagate that to all the linked cdecl structures.
 503          *
 504          * In english mode, the cdecl structure list always has exactly
 505          * one entry so we don't need to do anything differently.
 506          */
 507         norm_specs = cdecl__normalize_specs(decl->specifiers);
 508         for (i = decl; i; i = i->next)
 509                 i->specifiers = norm_specs;
 510
 511         for (i = decl; i; i = i->next) {
 512                 if (!english_mode) {
 513                         if (forall_declarators(i, reduce_parentheses) < 0)
 514                                 return 0;
 515                         if (forall_declarators(i, simplify_functions) < 0)
 516                                 return 0;
 517                 }
 518
 519                 if (forall_declarators(i, postproc_common) < 0)
 520                         return 0;
 521
 522                 if (!valid_declspecs(i, true))
 523                         return 0;
 524
 525                 if (cdecl_is_abstract(i->declarators)
 526                     && (i != decl || i->next)) {
 527                         cdecl__errmsg(CDECL__EDECLTYPE);
 528                         return 0;
 529                 }
 530         }
 531
 532         return 1;
 533 }
 534
 535 static struct cdecl *parse_common(const char *str, int english_mode)
 536 {
 537         struct cdecl *decl;
 538
 539         if (!(decl = do_parse(str, english_mode)))
 540                 return NULL;
 541
 542         if (!do_postprocess(decl, english_mode)) {
 543                 cdecl__free(decl);
 544                 return NULL;
 545         }
 546
 547         return decl;
 548 }
 549
 550 struct cdecl *cdecl_parse_decl(const char *declstr)
 551 {
 552         return parse_common(declstr, false);
 553 }
 554
 555 struct cdecl *cdecl_parse_english(const char *english)
 556 {
 557         return parse_common(english, true);
 558 }
 559
 560 void cdecl_free(struct cdecl *decl)
 561 {
 562         cdecl__free(decl);
 563 }