src/explain.c

   1 #include <stdio.h>
   2 #include <stdlib.h>
   3 #include <stdarg.h>
   4 #include <assert.h>
   5
   6 #include "cdecl.h"
   7 #include "typemap.h"
   8
   9 /* declare [ident] as [storage] [function specs] [other crap] [qualifiers] [type specs] */
  10
  11 static size_t
  12 voutput(char *buf, size_t n, size_t off, const char *fmt, va_list ap)
  13 {
  14         if (off >= n)
  15                 return vsnprintf(NULL, 0, fmt, ap);
  16         return vsnprintf(buf+off, n-off, fmt, ap);
  17 }
  18
  19 static size_t output(char *buf, size_t n, size_t off, const char *fmt, ...)
  20 {
  21         va_list ap;
  22         size_t ret;
  23
  24         va_start(ap, fmt);
  25         ret = voutput(buf, n, off, fmt, ap);
  26         va_end(ap);
  27
  28         return ret;
  29 }
  30
  31 static size_t advance_(char **buf, size_t *n, size_t amount)
  32 {
  33         if (amount >= *n) {
  34                 *n   = 0;
  35                 *buf = 0;
  36         } else {
  37                 *buf += amount;
  38                 *n   -= amount;
  39         }
  40
  41         return amount;
  42 }
  43
  44 static size_t advance(char **buf, size_t *n, size_t amount)
  45 {
  46         size_t ret, rc;
  47
  48         if (!amount)
  49                 return 0;
  50
  51         ret = advance_(buf, n, amount);
  52         rc = snprintf(*buf, *n, " ");
  53         return ret + advance_(buf, n, rc);
  54 }
  55
  56 static size_t
  57 explain_qualifiers(char *buf, size_t n, struct cdecl_declspec *s)
  58 {
  59         unsigned long qualmap = 0;
  60         size_t ret = 0, rc = 0;
  61
  62         for (struct cdecl_declspec *c = s; c; c = c->next) {
  63                 if (cdecl_spec_kind(c) != CDECL_SPEC_QUAL)
  64                         continue;
  65                 qualmap |= 1ul << (c->type & 0xff);
  66         }
  67
  68         if (qualmap & (1ul << (CDECL_QUAL_RESTRICT & 0xff))) {
  69                 ret += advance(&buf, &n, rc);
  70                 rc = snprintf(buf, n, "restrict");
  71         }
  72         if (qualmap & (1ul << (CDECL_QUAL_VOLATILE & 0xff))) {
  73                 ret += advance(&buf, &n, rc);
  74                 rc = snprintf(buf, n, "volatile");
  75         }
  76         if (qualmap & (1ul << (CDECL_QUAL_CONST & 0xff))) {
  77                 ret += advance(&buf, &n, rc);
  78                 rc = snprintf(buf, n, "const");
  79         }
  80
  81         return ret + rc;
  82 }
  83
  84 /* Renders the type qualifiers and type specifiers in canonical form. */
  85 static size_t
  86 explain_post_specs(char *buf, size_t n, struct cdecl_declspec *s)
  87 {
  88         const char *tag = NULL;
  89         unsigned long typemap;
  90         size_t ret = 0, rc;
  91
  92         typemap = cdecl__build_typemap(s);
  93         if (typemap == -1)
  94                 return 0;
  95
  96         for (struct cdecl_declspec *c = s; c; c = c->next) {
  97                 if (cdecl_spec_kind(c) != CDECL_SPEC_TYPE)
  98                         continue;
  99
 100                 /* Valid C types have at most one identifier. */
 101                 if (c->ident)
 102                         tag = c->ident;
 103         }
 104
 105         rc = explain_qualifiers(buf, n, s);
 106         ret += advance(&buf, &n, rc);
 107
 108         rc = snprintf(buf, n, "%s", cdecl__explain_typemap(typemap));
 109         if (tag) {
 110                 ret += advance(&buf, &n, rc);
 111                 rc = snprintf(buf, n, "%s", tag);
 112         }
 113
 114         return ret + rc;
 115 }
 116
 117 static const char *explain_storage(unsigned spec)
 118 {
 119         switch (spec) {
 120         case CDECL_STOR_TYPEDEF:
 121                 return "typedef";
 122         case CDECL_STOR_EXTERN:
 123                 return "extern";
 124         case CDECL_STOR_STATIC:
 125                 return "static";
 126         case CDECL_STOR_AUTO:
 127                 return "auto";
 128         case CDECL_STOR_REGISTER:
 129                 return "register";
 130         default:
 131                 assert(0);
 132         }
 133 }
 134
 135 /* Renders the storage-class and function specifiers in canonical form. */
 136 static size_t explain_pre_specs(char *buf, size_t n, struct cdecl_declspec *s)
 137 {
 138         unsigned long funcmap = 0;
 139         const char *storage = NULL;
 140         size_t ret = 0;
 141
 142         for (struct cdecl_declspec *c = s; c; c = c->next) {
 143                 switch (cdecl_spec_kind(c)) {
 144                 case CDECL_SPEC_FUNC:
 145                         funcmap |= 1ul << (c->type & 0xff);
 146                         break;
 147                 case CDECL_SPEC_STOR:
 148                         /* Valid C declarations have at most one
 149                          * storage-class specifier. */
 150                         storage = explain_storage(c->type);
 151                         break;
 152                 }
 153         }
 154
 155         if (storage)
 156                 ret += output(buf, n, ret, "%s", storage);
 157         if (funcmap & (1ul << (CDECL_FUNC_INLINE & 0xff)))
 158                 ret += output(buf, n, ret, "%.*s%s", !!ret, "", "inline");
 159         return ret;
 160 }
 161
 162 /* Renders the name of the thing being declared. */
 163 static size_t
 164 explain_prologue(char *buf, size_t n, struct cdecl_declarator *d)
 165 {
 166         while (d) {
 167                 switch (d->type) {
 168                 case CDECL_DECL_NULL:
 169                         return snprintf(buf, n, "type");
 170                 case CDECL_DECL_IDENT:
 171                         return snprintf(buf, n, "declare %s as", d->u.ident);
 172                 }
 173
 174                 d = d->child;
 175         }
 176 }
 177
 178 static size_t
 179 explain_pointer(char *buf, size_t n, struct cdecl_pointer *p)
 180 {
 181         size_t ret = 0, rc;
 182
 183         rc = explain_qualifiers(buf, n, p->qualifiers);
 184         ret += advance(&buf, &n, rc);
 185
 186         return ret + snprintf(buf, n, "pointer to");
 187 }
 188
 189 static size_t
 190 explain_array(char *buf, size_t n, struct cdecl_array *a)
 191 {
 192         size_t ret = 0, rc = 0;
 193
 194         if (a->vla)
 195                 rc = snprintf(buf, n, "variable-length array");
 196         else
 197                 rc = snprintf(buf, n, "array");
 198         ret += advance(&buf, &n, rc);
 199
 200         if (a->vla) {
 201                 rc = snprintf(buf, n, "%s", a->vla);
 202                 ret += advance(&buf, &n, rc);
 203         } else if (a->length) {
 204                 rc = snprintf(buf, n, "%ju", a->length);
 205                 ret += advance(&buf, &n, rc);
 206         }
 207
 208         return ret + snprintf(buf, n, "of");
 209 }
 210
 211 static size_t
 212 explain_declarators(char *buf, size_t n, struct cdecl_declarator *d)
 213 {
 214         size_t ret = 0, rc;
 215
 216         if (d->type == CDECL_DECL_IDENT || d->type == CDECL_DECL_NULL)
 217                 return 0;
 218
 219         rc = explain_declarators(buf, n, d->child);
 220         ret += advance(&buf, &n, rc);
 221
 222         switch (d->type) {
 223         case CDECL_DECL_POINTER:
 224                 return ret + explain_pointer(buf, n, &d->u.pointer);
 225         case CDECL_DECL_ARRAY:
 226                 return ret + explain_array(buf, n, &d->u.array);
 227         default:
 228                 assert(0);
 229         }
 230 }
 231
 232 size_t cdecl_explain(char *buf, size_t n, struct cdecl *decl)
 233 {
 234         size_t ret = 0, rc;
 235
 236         rc = explain_prologue(buf, n, decl->declarators);
 237         ret += advance(&buf, &n, rc);
 238
 239         rc = explain_pre_specs(buf, n, decl->specifiers);
 240         ret += advance(&buf, &n, rc);
 241
 242         rc = explain_declarators(buf, n, decl->declarators);
 243         ret += advance(&buf, &n, rc);
 244
 245         return ret + explain_post_specs(buf, n, decl->specifiers);
 246 }