X-Git-Url: https://git.draconx.ca/gitweb/cdecl99.git/blobdiff_plain/1518db926f5b2b3fc8de28b2f99ee870c42cc230..0c61f9637a469ac7a28b5a329551b03e6ad14d62:/src/explain.c diff --git a/src/explain.c b/src/explain.c index 8c86530..0f6b787 100644 --- a/src/explain.c +++ b/src/explain.c @@ -1,6 +1,6 @@ /* * Render C declarations as English. - * Copyright © 2011 Nick Bowler + * Copyright © 2011, 2021 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 @@ -15,6 +15,8 @@ * You should have received a copy of the GNU General Public License * along with this program. If not, see . */ + +#include #include #include #include @@ -22,160 +24,7 @@ #include #include "cdecl.h" -#include "typemap.h" - -/* declare [ident] as [storage] [function specs] [other crap] [qualifiers] [type specs] */ - -static size_t -voutput(char *buf, size_t n, size_t off, const char *fmt, va_list ap) -{ - if (off >= n) - return vsnprintf(NULL, 0, fmt, ap); - return vsnprintf(buf+off, n-off, fmt, ap); -} - -static size_t output(char *buf, size_t n, size_t off, const char *fmt, ...) -{ - va_list ap; - size_t ret; - - va_start(ap, fmt); - ret = voutput(buf, n, off, fmt, ap); - va_end(ap); - - return ret; -} - -static size_t advance_(char **buf, size_t *n, size_t amount) -{ - if (amount >= *n) { - *n = 0; - *buf = 0; - } else { - *buf += amount; - *n -= amount; - } - - return amount; -} - -static size_t advance(char **buf, size_t *n, size_t amount) -{ - size_t ret, rc; - - if (!amount) - return 0; - - ret = advance_(buf, n, amount); - rc = snprintf(*buf, *n, " "); - return ret + advance_(buf, n, rc); -} - -static size_t -explain_qualifiers(char *buf, size_t n, struct cdecl_declspec *s) -{ - unsigned long qualmap = 0; - size_t ret = 0, rc = 0; - - for (struct cdecl_declspec *c = s; c; c = c->next) { - if (cdecl_spec_kind(c) != CDECL_SPEC_QUAL) - continue; - qualmap |= 1ul << (c->type & 0xff); - } - - if (qualmap & (1ul << (CDECL_QUAL_RESTRICT & 0xff))) { - ret += advance(&buf, &n, rc); - rc = snprintf(buf, n, "restrict"); - } - if (qualmap & (1ul << (CDECL_QUAL_VOLATILE & 0xff))) { - ret += advance(&buf, &n, rc); - rc = snprintf(buf, n, "volatile"); - } - if (qualmap & (1ul << (CDECL_QUAL_CONST & 0xff))) { - ret += advance(&buf, &n, rc); - rc = snprintf(buf, n, "const"); - } - - return ret + rc; -} - -/* Renders the type qualifiers and type specifiers in canonical form. */ -static size_t -explain_post_specs(char *buf, size_t n, struct cdecl_declspec *s) -{ - const char *tag = NULL; - unsigned long typemap; - size_t ret = 0, rc; - - typemap = cdecl__build_typemap(s); - if (typemap == -1) - return 0; - - for (struct cdecl_declspec *c = s; c; c = c->next) { - if (cdecl_spec_kind(c) != CDECL_SPEC_TYPE) - continue; - - /* Valid C types have at most one identifier. */ - if (c->ident) - tag = c->ident; - } - - rc = explain_qualifiers(buf, n, s); - ret += advance(&buf, &n, rc); - - rc = snprintf(buf, n, "%s", cdecl__explain_typemap(typemap)); - if (tag) { - ret += advance(&buf, &n, rc); - rc = snprintf(buf, n, "%s", tag); - } - - return ret + rc; -} - -static const char *explain_storage(unsigned spec) -{ - switch (spec) { - case CDECL_STOR_TYPEDEF: - return "typedef"; - case CDECL_STOR_EXTERN: - return "extern"; - case CDECL_STOR_STATIC: - return "static"; - case CDECL_STOR_AUTO: - return "auto"; - case CDECL_STOR_REGISTER: - return "register"; - default: - assert(0); - } -} - -/* Renders the storage-class and function specifiers in canonical form. */ -static size_t explain_pre_specs(char *buf, size_t n, struct cdecl_declspec *s) -{ - unsigned long funcmap = 0; - const char *storage = NULL; - size_t ret = 0; - - for (struct cdecl_declspec *c = s; c; c = c->next) { - switch (cdecl_spec_kind(c)) { - case CDECL_SPEC_FUNC: - funcmap |= 1ul << (c->type & 0xff); - break; - case CDECL_SPEC_STOR: - /* Valid C declarations have at most one - * storage-class specifier. */ - storage = explain_storage(c->type); - break; - } - } - - if (storage) - ret += output(buf, n, ret, "%s", storage); - if (funcmap & (1ul << (CDECL_FUNC_INLINE & 0xff))) - ret += output(buf, n, ret, "%.*s%s", !!ret, "", "inline"); - return ret; -} +#include "cdecl-internal.h" /* * Renders the start of the thing being declared. If top is true, print @@ -195,12 +44,14 @@ explain_prologue(char *buf, size_t n, struct cdecl_declarator *d, bool top) case CDECL_DECL_IDENT: if (top) rc = snprintf(buf, n, "declare"); - ret += advance(&buf, &n, rc); + ret += cdecl__advance(&buf, &n, rc); return ret + snprintf(buf, n, "%s as", d->u.ident); } d = d->child; } + + assert(0); } static size_t @@ -208,8 +59,8 @@ explain_pointer(char *buf, size_t n, struct cdecl_pointer *p) { size_t ret = 0, rc; - rc = explain_qualifiers(buf, n, p->qualifiers); - ret += advance(&buf, &n, rc); + rc = cdecl__explain_specs(buf, n, p->qualifiers, CDECL_SPEC_QUAL); + ret += cdecl__advance(&buf, &n, rc); return ret + snprintf(buf, n, "pointer to"); } @@ -223,14 +74,14 @@ explain_array(char *buf, size_t n, struct cdecl_array *a) rc = snprintf(buf, n, "variable-length array"); else rc = snprintf(buf, n, "array"); - ret += advance(&buf, &n, rc); + ret += cdecl__advance(&buf, &n, rc); if (a->vla) { rc = snprintf(buf, n, "%s", a->vla); - ret += advance(&buf, &n, rc); + ret += cdecl__advance(&buf, &n, rc); } else if (a->length) { rc = snprintf(buf, n, "%ju", a->length); - ret += advance(&buf, &n, rc); + ret += cdecl__advance(&buf, &n, rc); } return ret + snprintf(buf, n, "of"); @@ -244,15 +95,15 @@ static size_t explain_decl(char *buf, size_t n, struct cdecl *decl, bool top) size_t ret = 0, rc; rc = explain_prologue(buf, n, decl->declarators, top); - ret += advance(&buf, &n, rc); + ret += cdecl__advance(&buf, &n, rc); - rc = explain_pre_specs(buf, n, decl->specifiers); - ret += advance(&buf, &n, rc); + rc = cdecl__explain_pre_specs(buf, n, decl->specifiers); + ret += cdecl__advance(&buf, &n, rc); rc = explain_declarators(buf, n, decl->declarators); - ret += advance(&buf, &n, rc); + ret += cdecl__advance(&buf, &n, rc); - return ret + explain_post_specs(buf, n, decl->specifiers); + return ret + cdecl__explain_post_specs(buf, n, decl->specifiers); } static size_t explain_function(char *buf, size_t n, struct cdecl_function *f) @@ -260,15 +111,15 @@ static size_t explain_function(char *buf, size_t n, struct cdecl_function *f) size_t ret = 0, rc = 0; rc = snprintf(buf, n, "function"); - ret += advance(&buf, &n, rc); + ret += cdecl__advance(&buf, &n, rc); if (f->parameters) { rc = snprintf(buf, n, "("); - ret += advance_(&buf, &n, rc); + ret += cdecl__advance_(&buf, &n, rc); for (struct cdecl *p = f->parameters; p; p = p->next) { rc = explain_decl(buf, n, p, false); - ret += advance_(&buf, &n, rc); + ret += cdecl__advance_(&buf, &n, rc); if (p->next) rc = snprintf(buf, n, ","); @@ -276,7 +127,7 @@ static size_t explain_function(char *buf, size_t n, struct cdecl_function *f) rc = snprintf(buf, n, ", ...)"); else rc = snprintf(buf, n, ")"); - ret += advance(&buf, &n, rc); + ret += cdecl__advance(&buf, &n, rc); } } @@ -292,7 +143,7 @@ explain_declarators(char *buf, size_t n, struct cdecl_declarator *d) return 0; rc = explain_declarators(buf, n, d->child); - ret += advance(&buf, &n, rc); + ret += cdecl__advance(&buf, &n, rc); switch (d->type) { case CDECL_DECL_POINTER: