2 * Copyright Patrick Powell 1995
3 * This code is based on code written by Patrick Powell (papowell@astart.com)
4 * It may be used for any purpose as long as this notice remains intact
5 * on all source code distributions
8 /**************************************************************
10 * Patrick Powell Tue Apr 11 09:48:21 PDT 1995
11 * A bombproof version of doprnt (dopr) included.
12 * Sigh. This sort of thing is always nasty do deal with. Note that
13 * the version here does not include floating point...
15 * snprintf() is used instead of sprintf() as it does limit checks
16 * for string length. This covers a nasty loophole.
18 * The other functions are there to prevent NULL pointers from
19 * causing nast effects.
22 * Brandon Long <blong@fiction.net> 9/15/96 for mutt 0.43
23 * This was ugly. It is still ugly. I opted out of floating point
24 * numbers, but the formatter understands just about everything
25 * from the normal C string format, at least as far as I can tell from
26 * the Solaris 2.5 printf(3S) man page.
28 * Brandon Long <blong@fiction.net> 10/22/97 for mutt 0.87.1
29 * Ok, added some minimal floating point support, which means this
30 * probably requires libm on most operating systems. Don't yet
31 * support the exponent (e,E) and sigfig (g,G). Also, fmtint()
32 * was pretty badly broken, it just wasn't being exercised in ways
33 * which showed it, so that's been fixed. Also, formated the code
34 * to mutt conventions, and removed dead code left over from the
35 * original. Also, there is now a builtin-test, just compile with:
36 * gcc -DTEST_SNPRINTF -o snprintf snprintf.c -lm
37 * and run snprintf for results.
39 * Thomas Roessler <roessler@guug.de> 01/27/98 for mutt 0.89i
40 * The PGP code was using unsigned hexadecimal formats.
41 * Unfortunately, unsigned formats simply didn't work.
43 * Michael Elkins <me@cs.hmc.edu> 03/05/98 for mutt 0.90.8
44 * The original code assumed that both snprintf() and vsnprintf() were
45 * missing. Some systems only have snprintf() but not vsnprintf(), so
46 * the code is now broken down under HAVE_SNPRINTF and HAVE_VSNPRINTF.
48 * Andrew Tridgell (tridge@samba.org) Oct 1998
49 * fixed handling of %.0f
50 * added test for HAVE_LONG_DOUBLE
52 **************************************************************/
54 #include <net-snmp/net-snmp-config.h>
56 #if !defined(HAVE_SNPRINTF) || !defined(HAVE_VSNPRINTF)
64 #include <sys/types.h>
68 # define HAVE_STDARGS /* let's hope that works everywhere (mj) */
69 # define VA_LOCAL_DECL va_list ap
70 # define VA_START(f) va_start(ap, f)
71 # define VA_SHIFT(v,t) ; /* no-op for ANSI */
72 # define VA_END va_end(ap)
76 # define VA_LOCAL_DECL va_list ap
77 # define VA_START(f) va_start(ap) /* f is ignored! */
78 # define VA_SHIFT(v,t) v = va_arg(ap,t)
79 # define VA_END va_end(ap)
82 * XX ** NO VARARGS ** XX
86 #ifdef HAVE_LONG_DOUBLE
87 #define LDOUBLE long double
89 #define LDOUBLE double
92 int snprintf(char *str, size_t count, const char *fmt, ...);
93 int vsnprintf(char *str, size_t count, const char *fmt,
96 static void dopr(char *buffer, size_t maxlen, const char *format,
98 static void fmtstr(char *buffer, size_t * currlen, size_t maxlen,
99 char *value, int flags, int min, int max);
100 static void fmtint(char *buffer, size_t * currlen, size_t maxlen,
101 long value, int base, int min, int max, int flags);
102 static void fmtfp(char *buffer, size_t * currlen, size_t maxlen,
103 LDOUBLE fvalue, int min, int max, int flags);
104 static void dopr_outch(char *buffer, size_t * currlen, size_t maxlen,
108 * dopr(): poor man's version of doprintf
114 #define DP_S_DEFAULT 0
124 * format flags - Bits
126 #define DP_F_MINUS (1 << 0)
127 #define DP_F_PLUS (1 << 1)
128 #define DP_F_SPACE (1 << 2)
129 #define DP_F_NUM (1 << 3)
130 #define DP_F_ZERO (1 << 4)
131 #define DP_F_UP (1 << 5)
132 #define DP_F_UNSIGNED (1 << 6)
139 #define DP_C_LDOUBLE 3
141 #define char_to_int(p) (p - '0')
142 #define MAX(p,q) ((p >= q) ? p : q)
145 dopr(char *buffer, size_t maxlen, const char *format, va_list args)
158 state = DP_S_DEFAULT;
159 currlen = flags = cflags = min = 0;
163 while (state != DP_S_DONE) {
164 if ((ch == '\0') || (currlen >= maxlen))
172 dopr_outch(buffer, &currlen, maxlen, ch);
204 min = 10 * min + char_to_int(ch);
206 } else if (ch == '*') {
207 min = va_arg(args, int);
224 max = 10 * max + char_to_int(ch);
226 } else if (ch == '*') {
227 max = va_arg(args, int);
235 * Currently, we don't support Long Long, bummer
247 cflags = DP_C_LDOUBLE;
259 if (cflags == DP_C_SHORT)
260 value = va_arg(args, short int);
261 else if (cflags == DP_C_LONG)
262 value = va_arg(args, long int);
264 value = va_arg(args, int);
265 fmtint(buffer, &currlen, maxlen, value, 10, min, max,
269 flags |= DP_F_UNSIGNED;
270 if (cflags == DP_C_SHORT)
271 value = va_arg(args, unsigned short int);
272 else if (cflags == DP_C_LONG)
273 value = va_arg(args, unsigned long int);
275 value = va_arg(args, unsigned int);
276 fmtint(buffer, &currlen, maxlen, value, 8, min, max,
280 flags |= DP_F_UNSIGNED;
281 if (cflags == DP_C_SHORT)
282 value = va_arg(args, unsigned short int);
283 else if (cflags == DP_C_LONG)
284 value = va_arg(args, unsigned long int);
286 value = va_arg(args, unsigned int);
287 fmtint(buffer, &currlen, maxlen, value, 10, min, max,
293 flags |= DP_F_UNSIGNED;
294 if (cflags == DP_C_SHORT)
295 value = va_arg(args, unsigned short int);
296 else if (cflags == DP_C_LONG)
297 value = va_arg(args, unsigned long int);
299 value = va_arg(args, unsigned int);
300 fmtint(buffer, &currlen, maxlen, value, 16, min, max,
304 if (cflags == DP_C_LDOUBLE)
305 fvalue = va_arg(args, LDOUBLE);
307 fvalue = va_arg(args, double);
309 * um, floating point?
311 fmtfp(buffer, &currlen, maxlen, fvalue, min, max, flags);
316 if (cflags == DP_C_LDOUBLE)
317 fvalue = va_arg(args, LDOUBLE);
319 fvalue = va_arg(args, double);
324 if (cflags == DP_C_LDOUBLE)
325 fvalue = va_arg(args, LDOUBLE);
327 fvalue = va_arg(args, double);
330 dopr_outch(buffer, &currlen, maxlen, va_arg(args, int));
333 strvalue = va_arg(args, char *);
335 max = maxlen; /* ie, no max */
336 fmtstr(buffer, &currlen, maxlen, strvalue, flags, min,
340 strvalue = (char *) va_arg(args, void *);
341 fmtint(buffer, &currlen, maxlen, (long) strvalue, 16, min,
345 if (cflags == DP_C_SHORT) {
347 num = va_arg(args, short int *);
349 } else if (cflags == DP_C_LONG) {
351 num = va_arg(args, long int *);
355 num = va_arg(args, int *);
360 dopr_outch(buffer, &currlen, maxlen, ch);
364 * not supported yet, treat as next char
375 state = DP_S_DEFAULT;
376 flags = cflags = min = 0;
385 break; /* some picky compilers need this */
388 if (currlen < maxlen - 1)
389 buffer[currlen] = '\0';
391 buffer[maxlen - 1] = '\0';
395 fmtstr(char *buffer, size_t * currlen, size_t maxlen,
396 char *value, int flags, int min, int max)
398 int padlen, strln; /* amount to pad */
405 for (strln = 0; value[strln]; ++strln); /* strlen */
406 padlen = min - strln;
409 if (flags & DP_F_MINUS)
410 padlen = -padlen; /* Left Justify */
412 while ((padlen > 0) && (cnt < max)) {
413 dopr_outch(buffer, currlen, maxlen, ' ');
417 while (*value && (cnt < max)) {
418 dopr_outch(buffer, currlen, maxlen, *value++);
421 while ((padlen < 0) && (cnt < max)) {
422 dopr_outch(buffer, currlen, maxlen, ' ');
429 * Have to handle DP_F_NUM (ie 0x and 0 alternates)
433 fmtint(char *buffer, size_t * currlen, size_t maxlen,
434 long value, int base, int min, int max, int flags)
437 unsigned long uvalue;
440 int spadlen = 0; /* amount to space pad */
441 int zpadlen = 0; /* amount to zero pad */
449 if (!(flags & DP_F_UNSIGNED)) {
453 } else if (flags & DP_F_PLUS) /* Do a sign (+/i) */
455 else if (flags & DP_F_SPACE)
460 caps = 1; /* Should characters be upper case? */
463 convert[place++] = (caps ? "0123456789ABCDEF" : "0123456789abcdef")
464 [uvalue % (unsigned) base];
465 uvalue = (uvalue / (unsigned) base);
466 } while (uvalue && (place < 20));
471 zpadlen = max - place;
472 spadlen = min - MAX(max, place) - (signvalue ? 1 : 0);
477 if (flags & DP_F_ZERO) {
478 zpadlen = MAX(zpadlen, spadlen);
481 if (flags & DP_F_MINUS)
482 spadlen = -spadlen; /* Left Justifty */
484 #ifdef DEBUG_SNPRINTF
486 (debugfile, "zpad: %d, spad: %d, min: %d, max: %d, place: %d\n",
487 zpadlen, spadlen, min, max, place));
493 while (spadlen > 0) {
494 dopr_outch(buffer, currlen, maxlen, ' ');
502 dopr_outch(buffer, currlen, maxlen, signvalue);
508 while (zpadlen > 0) {
509 dopr_outch(buffer, currlen, maxlen, '0');
518 dopr_outch(buffer, currlen, maxlen, convert[--place]);
521 * Left Justified spaces
523 while (spadlen < 0) {
524 dopr_outch(buffer, currlen, maxlen, ' ');
530 abs_val(LDOUBLE value)
532 LDOUBLE result = value;
559 value = value - intpart;
567 fmtfp(char *buffer, size_t * currlen, size_t maxlen,
568 LDOUBLE fvalue, int min, int max, int flags)
576 int padlen = 0; /* amount to pad */
583 * AIX manpage says the default is 0, but Solaris says the default
584 * is 6, and sprintf on AIX defaults to 6
589 ufvalue = abs_val(fvalue);
593 else if (flags & DP_F_PLUS) /* Do a sign (+/i) */
595 else if (flags & DP_F_SPACE)
600 caps = 1; /* Should characters be upper case? */
606 * Sorry, we only support 9 digits past the decimal because of our
613 * We "cheat" by converting the fractional part to integer by
614 * * multiplying by a factor of 10
616 fracpart = round((pow10(max)) * (ufvalue - intpart));
618 if (fracpart >= pow10(max)) {
620 fracpart -= pow10(max);
622 #ifdef DEBUG_SNPRINTF
624 (debugfile, "fmtfp: %f =? %d.%d\n", fvalue, intpart, fracpart));
628 * Convert integer part
632 (caps ? "0123456789ABCDEF" : "0123456789abcdef")[intpart % 10];
633 intpart = (intpart / 10);
634 } while (intpart && (iplace < 20));
637 iconvert[iplace] = 0;
640 * Convert fractional part
644 (caps ? "0123456789ABCDEF" : "0123456789abcdef")[fracpart %
646 fracpart = (fracpart / 10);
647 } while (fracpart && (fplace < 20));
650 fconvert[fplace] = 0;
653 * -1 for decimal point, another -1 if we are printing a sign
655 padlen = min - iplace - max - 1 - ((signvalue) ? 1 : 0);
656 zpadlen = max - fplace;
661 if (flags & DP_F_MINUS)
662 padlen = -padlen; /* Left Justifty */
664 if ((flags & DP_F_ZERO) && (padlen > 0)) {
666 dopr_outch(buffer, currlen, maxlen, signvalue);
671 dopr_outch(buffer, currlen, maxlen, '0');
676 dopr_outch(buffer, currlen, maxlen, ' ');
680 dopr_outch(buffer, currlen, maxlen, signvalue);
683 dopr_outch(buffer, currlen, maxlen, iconvert[--iplace]);
686 * Decimal point. This should probably use locale to find the correct
690 dopr_outch(buffer, currlen, maxlen, '.');
693 dopr_outch(buffer, currlen, maxlen, fconvert[--fplace]);
696 while (zpadlen > 0) {
697 dopr_outch(buffer, currlen, maxlen, '0');
702 dopr_outch(buffer, currlen, maxlen, ' ');
708 dopr_outch(char *buffer, size_t * currlen, size_t maxlen, char c)
710 if (*currlen < maxlen)
711 buffer[(*currlen)++] = c;
714 #ifndef HAVE_VSNPRINTF
716 vsnprintf(char *str, size_t count, const char *fmt, va_list args)
719 dopr(str, count, fmt, args);
720 return (strlen(str));
722 #endif /* !HAVE_VSNPRINTF */
724 #ifndef HAVE_SNPRINTF
730 snprintf(char *str, size_t count, const char *fmt, ...)
745 VA_SHIFT(str, char *);
746 VA_SHIFT(count, size_t);
747 VA_SHIFT(fmt, char *);
748 (void) vsnprintf(str, count, fmt, ap);
750 return (strlen(str));
752 #endif /* !HAVE_SNPRINTF */
756 #define LONG_STRING 1024
761 char buf1[LONG_STRING];
762 char buf2[LONG_STRING];
780 { -1.5, 134.21, 91340.2, 341.1234, 0203.9, 0.96, 0.996,
781 0.9996, 1.996, 4.136, 0
795 long int_nums[] = { -1, 134, 91340, 341, 0203, 0 };
800 printf("Testing snprintf format codes against system sprintf...\n");
802 for (x = 0; fp_fmt[x] != NULL; x++)
803 for (y = 0; fp_nums[y] != 0; y++) {
804 snprintf(buf1, sizeof(buf1), fp_fmt[x], fp_nums[y]);
805 sprintf(buf2, fp_fmt[x], fp_nums[y]);
806 if (strcmp(buf1, buf2)) {
808 ("snprintf doesn't match Format: %s\n\tsnprintf = %s\n\tsprintf = %s\n",
809 fp_fmt[x], buf1, buf2);
815 for (x = 0; int_fmt[x] != NULL; x++)
816 for (y = 0; int_nums[y] != 0; y++) {
817 snprintf(buf1, sizeof(buf1), int_fmt[x], int_nums[y]);
818 sprintf(buf2, int_fmt[x], int_nums[y]);
819 if (strcmp(buf1, buf2)) {
821 ("snprintf doesn't match Format: %s\n\tsnprintf = %s\n\tsprintf = %s\n",
822 int_fmt[x], buf1, buf2);
827 printf("%d tests failed out of %d.\n", fail, num);
829 #endif /* SNPRINTF_TEST */
831 #endif /* !HAVE_SNPRINTF */