]> git.draconx.ca Git - cdecl99.git/blobdiff - src/output.c
libcdecl: Avoid snprintf for integer conversions.
[cdecl99.git] / src / output.c
index cb2a568100ef85e81fdea635f36395906dd28480..047fc64ed087138d0d0ceb305485a54d88b0c89d 100644 (file)
@@ -1,6 +1,6 @@
 /*
  *  Helper functions for outputting text.
- *  Copyright © 2011 Nick Bowler
+ *  Copyright © 2011, 2021, 2023 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
 #include <stdio.h>
 #include <assert.h>
 
-#include "typemap.h"
-#include "output.h"
 #include "cdecl.h"
+#include "cdecl-internal.h"
 
-size_t cdecl__advance_(char **buf, size_t *n, size_t amount)
+#include "parse.h"
+#include "specstr.h"
+
+#define MIN(a, b) ((a) < (b) ? (a) : (b))
+
+size_t cdecl__advance(struct output_state *dst, size_t amount)
 {
-       if (amount >= *n) {
-               *n   = 0;
-               *buf = 0;
-       } else {
-               *buf += amount;
-               *n   -= amount;
-       }
+       size_t x = MIN(amount, dst->dstlen);
+
+       dst->dst    += x;
+       dst->dstlen -= x;
+       dst->accum  += amount;
 
        return amount;
 }
 
-size_t cdecl__advance(char **buf, size_t *n, size_t amount)
+size_t cdecl__strlcpy(char *dst, const char *src, size_t dstlen)
 {
-       size_t ret, rc;
-
-       if (!amount)
-               return 0;
-
-       ret = cdecl__advance_(buf, n, amount);
-       rc = snprintf(*buf, *n, " ");
-       return ret + cdecl__advance_(buf, n, rc);
+       if (dst)
+               snprintf(dst, dstlen, "%s", src);
+       return strlen(src);
 }
 
-static size_t explain_storage(char *buf, size_t n, unsigned spec)
+size_t cdecl__emit(struct output_state *dst, const char *src)
 {
-       switch (spec) {
-       case CDECL_STOR_TYPEDEF:
-               return snprintf(buf, n, "typedef");
-       case CDECL_STOR_EXTERN:
-               return snprintf(buf, n, "extern");
-       case CDECL_STOR_STATIC:
-               return snprintf(buf, n, "static");
-       case CDECL_STOR_AUTO:
-               return snprintf(buf, n, "auto");
-       case CDECL_STOR_REGISTER:
-               return snprintf(buf, n, "register");
-       default:
-               assert(0);
-       }
+       size_t rc = cdecl__strlcpy(dst->dst, src, dst->dstlen);
+       return cdecl__advance(dst, rc);
 }
 
-/* Renders the storage-class and function specifiers in canonical form. */
-size_t cdecl__explain_pre_specs(char *buf, size_t n, struct cdecl_declspec *s)
+/*
+ * 31 decimal digits is enough for values up to 2^102 - 1.
+ * 63 decimal digits is enough for values up to 2^209 - 1.
+ *
+ * We can't portably write numbers this large in preprocessor conditionals,
+ * but since the maximum values of unsigned integer types are always one
+ * less than a power of two, we can use a sequence of small shifts to infer
+ * the bounds.
+ *
+ * All known implementations have 64-bit uintmax_t.  Leave some headroom
+ * to support a possible future implementatons with 128-bit uintmax_t.
+ */
+enum {
+#if (UINTMAX_MAX >> 27 >> 27 >> 26 >> 26) == 0
+       MAX_UINT_DIGITS = 31
+#elif (UINTMAX_MAX >> 27 >> 26 >> 26 >> 26 >> 26 >> 26 >> 26 >> 26) == 0
+       MAX_UINT_DIGITS = 63
+#else
+#      error UINTMAX_MAX is too large, please report a bug.
+#endif
+};
+
+size_t cdecl__emit_uint(struct output_state *dst, uintmax_t val)
 {
-       unsigned long funcmap = 0;
-       size_t ret = 0, rc = 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. */
-                       rc = explain_storage(buf, n, c->type);
-                       break;
-               }
-       }
+       char buf[MAX_UINT_DIGITS + 1], *p = &buf[sizeof buf];
 
-       if (funcmap & (1ul << (CDECL_FUNC_INLINE & 0xff))) {
-               ret += cdecl__advance(&buf, &n, rc);
-               rc = snprintf(buf, n, "inline");
+       *(--p) = 0;
+       while (val > 0) {
+               *(--p) = '0' + val % 10;
+               val /= 10;
        }
 
-       return ret + rc;
+       return cdecl__emit(dst, p);
 }
 
-size_t cdecl__explain_qualifiers(char *buf, size_t n, struct cdecl_declspec *s)
+static void explain_spec(struct output_state *dst, struct cdecl_declspec *s)
 {
-       unsigned long qualmap = 0;
-       size_t ret = 0, rc = 0;
+       size_t rc;
 
-       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 += cdecl__advance(&buf, &n, rc);
-               rc = snprintf(buf, n, "restrict");
+       rc = cdecl__emit(dst, spec_string(s->type));
+       if (s->ident) {
+               cdecl__emit(dst, " " + !rc);
+               cdecl__emit(dst, s->ident);
        }
-       if (qualmap & (1ul << (CDECL_QUAL_VOLATILE & 0xff))) {
-               ret += cdecl__advance(&buf, &n, rc);
-               rc = snprintf(buf, n, "volatile");
-       }
-       if (qualmap & (1ul << (CDECL_QUAL_CONST & 0xff))) {
-               ret += cdecl__advance(&buf, &n, rc);
-               rc = snprintf(buf, n, "const");
-       }
-
-       return ret + rc;
 }
 
-/* Renders the type qualifiers and type specifiers in canonical form. */
-size_t cdecl__explain_post_specs(char *buf, size_t n, struct cdecl_declspec *s)
+/*
+ * Render a list of declaration specifiers.  Only the declaration specifiers
+ * listed in mask, which is the bitwise OR of the desired specifier kinds, are
+ * printed.
+ */
+const char *cdecl__emit_specs(struct output_state *dst,
+                              struct cdecl_declspec *s,
+                              unsigned mask)
 {
-       const char *tag = NULL;
-       unsigned long typemap;
-       size_t ret = 0, rc;
-
-       typemap = cdecl__build_typemap(s);
-       if (typemap == -1)
-               return 0;
+       const char *sep = " ";
+       int empty = 1;
 
-       for (struct cdecl_declspec *c = s; c; c = c->next) {
-               if (cdecl_spec_kind(c) != CDECL_SPEC_TYPE)
+       for (; s; s = s->next) {
+               if (!(s->type & mask))
                        continue;
 
-               /* Valid C types have at most one identifier. */
-               if (c->ident)
-                       tag = c->ident;
-       }
-
-       rc = cdecl__explain_qualifiers(buf, n, s);
-       ret += cdecl__advance(&buf, &n, rc);
-
-       rc = snprintf(buf, n, "%s", cdecl__explain_typemap(typemap));
-       if (tag) {
-               ret += cdecl__advance(&buf, &n, rc);
-               rc = snprintf(buf, n, "%s", tag);
+               cdecl__emit(dst, sep + empty);
+               explain_spec(dst, s);
+               empty = 0;
        }
 
-       return ret + rc;
+       return sep + empty;
 }