src/explain.c

   1 /*
   2  *  Render C declarations as English.
   3  *  Copyright © 2011, 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 <http://www.gnu.org/licenses/>.
  17  */
  18
  19 #include <config.h>
  20 #include <stdio.h>
  21 #include <inttypes.h>
  22 #include <assert.h>
  23
  24 #include "cdecl.h"
  25 #include "cdecl-internal.h"
  26
  27 #define PRE_SPECS (CDECL_SPEC_FUNC|CDECL_SPEC_STOR)
  28 #define POST_SPECS (CDECL_SPEC_QUAL|CDECL_SPEC_TYPE)
  29
  30 static void explain_specs(struct output_state *dst, struct cdecl_declspec *s, unsigned mask)
  31 {
  32         cdecl__emit(dst, cdecl__emit_specs(dst, s, mask));
  33 }
  34
  35 /*
  36  * If declarator declares an identifier foo, then emit "foo as "; otherwise
  37  * emit nothing.
  38  */
  39 static void
  40 explain_name(struct output_state *dst, struct cdecl_declarator *d)
  41 {
  42         while (d->child)
  43                 d = d->child;
  44
  45         if (d->type == CDECL_DECL_IDENT) {
  46                 cdecl__emit(dst, d->u.ident);
  47                 cdecl__emit(dst, " as ");
  48         }
  49 }
  50
  51 /*
  52  * For a pointer declarator, emit "[QUAL ]pointer to ", where
  53  * QUAL is the (possibly empty) list of qualifiers.
  54  */
  55 static void
  56 explain_pointer(struct output_state *dst, struct cdecl_pointer *p)
  57 {
  58         explain_specs(dst, p->qualifiers, -1);
  59         cdecl__emit(dst, "pointer to ");
  60 }
  61
  62 /*
  63  * For an array declarator, emit "[variable-length ]array [X ]of ", where
  64  * for a variable-length array X is the (possibly omitted) identifier name,
  65  * and for normal arrays X is the (possibly omitted) length.
  66  */
  67 static void
  68 explain_array(struct output_state *dst, struct cdecl_array *a)
  69 {
  70         size_t rc = 0;
  71
  72         if (a->vla)
  73                 cdecl__emit(dst, "variable-length ");
  74         cdecl__emit(dst, "array ");
  75
  76         if (a->vla) {
  77                 rc = cdecl__emit(dst, a->vla);
  78         } else {
  79                 rc = snprintf(dst->dst, dst->dstlen, "%.0" PRIuMAX, a->length);
  80                 cdecl__advance(dst, rc);
  81         }
  82
  83         cdecl__emit(dst, " of " + !rc);
  84 }
  85
  86 static void
  87 explain_declarators(struct output_state *dst, struct cdecl_declarator *decl);
  88
  89 static void explain_decl(struct output_state *dst, struct cdecl *decl)
  90 {
  91         explain_name(dst, decl->declarators);
  92         explain_specs(dst, decl->specifiers, PRE_SPECS);
  93         explain_declarators(dst, decl->declarators);
  94         cdecl__emit_specs(dst, decl->specifiers, POST_SPECS);
  95 }
  96
  97 /*
  98  * For a function declarator, emit "function [PARAM ]returning ", where
  99  * PARAM is the (omitted in the case of an empty non-prototype identifier
 100  * list) parameter or identifier lists enclosed in parentheses.
 101  */
 102 static void
 103 explain_function(struct output_state *dst, struct cdecl_function *f)
 104 {
 105         cdecl__emit(dst, "function ");
 106
 107         if (f->parameters) {
 108                 struct cdecl *p;
 109
 110                 cdecl__emit(dst, "(");
 111
 112                 for (p = f->parameters; p; p = p->next) {
 113                         explain_decl(dst, p);
 114                         if (p->next)
 115                                 cdecl__emit(dst, ", ");
 116                 }
 117
 118                 if (f->variadic)
 119                         cdecl__emit(dst, ", ...) ");
 120                 else
 121                         cdecl__emit(dst, ") ");
 122         }
 123
 124         cdecl__emit(dst, "returning ");
 125 }
 126
 127 static void
 128 explain_declarators(struct output_state *dst, struct cdecl_declarator *d)
 129 {
 130         if (d->type == CDECL_DECL_IDENT || d->type == CDECL_DECL_NULL)
 131                 return;
 132
 133         explain_declarators(dst, d->child);
 134
 135         switch (d->type) {
 136         case CDECL_DECL_POINTER:
 137                 explain_pointer(dst, &d->u.pointer);
 138                 return;
 139         case CDECL_DECL_ARRAY:
 140                 explain_array(dst, &d->u.array);
 141                 return;
 142         case CDECL_DECL_FUNCTION:
 143                 explain_function(dst, &d->u.function);
 144                 return;
 145         default:
 146                 assert(0);
 147         }
 148 }
 149
 150 size_t cdecl_explain(char *buf, size_t n, struct cdecl *decl)
 151 {
 152         struct output_state dst = { buf, n };
 153
 154         if (cdecl_is_abstract(decl->declarators))
 155                 cdecl__emit(&dst, "type ");
 156         else
 157                 cdecl__emit(&dst, "declare ");
 158
 159         explain_decl(&dst, decl);
 160         return dst.accum;
 161 }