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 **************************************************************/
58 #include <sys/types.h>
60 #if !defined(HAVE_SNPRINTF) || !defined(HAVE_VSNPRINTF)
62 /* Define this as a fall through, HAVE_STDARG_H is probably already set */
64 #define HAVE_VARARGS_H
66 /* varargs declarations: */
68 #if defined(HAVE_STDARG_H)
70 # define HAVE_STDARGS /* let's hope that works everywhere (mj) */
71 # define VA_LOCAL_DECL va_list ap
72 # define VA_START(f) va_start(ap, f)
73 # define VA_SHIFT(v,t) ; /* no-op for ANSI */
74 # define VA_END va_end(ap)
76 # if defined(HAVE_VARARGS_H)
79 # define VA_LOCAL_DECL va_list ap
80 # define VA_START(f) va_start(ap) /* f is ignored! */
81 # define VA_SHIFT(v,t) v = va_arg(ap,t)
82 # define VA_END va_end(ap)
84 /*XX ** NO VARARGS ** XX*/
88 #ifdef HAVE_LONG_DOUBLE
89 #define LDOUBLE long double
91 #define LDOUBLE double
94 /*int snprintf (char *str, size_t count, const char *fmt, ...);*/
95 /*int vsnprintf (char *str, size_t count, const char *fmt, va_list arg);*/
97 static void dopr (char *buffer, size_t maxlen, const char *format,
99 static void fmtstr (char *buffer, size_t *currlen, size_t maxlen,
100 char *value, int flags, int min, int max);
101 static void fmtint (char *buffer, size_t *currlen, size_t maxlen,
102 long value, int base, int min, int max, int flags);
103 static void fmtfp (char *buffer, size_t *currlen, size_t maxlen,
104 LDOUBLE fvalue, int min, int max, int flags);
105 static void dopr_outch (char *buffer, size_t *currlen, size_t maxlen, char c );
108 * dopr(): poor man's version of doprintf
111 /* format read states */
112 #define DP_S_DEFAULT 0
121 /* format flags - Bits */
122 #define DP_F_MINUS (1 << 0)
123 #define DP_F_PLUS (1 << 1)
124 #define DP_F_SPACE (1 << 2)
125 #define DP_F_NUM (1 << 3)
126 #define DP_F_ZERO (1 << 4)
127 #define DP_F_UP (1 << 5)
128 #define DP_F_UNSIGNED (1 << 6)
130 /* Conversion Flags */
133 #define DP_C_LDOUBLE 3
135 #define char_to_int(p) (p - '0')
136 #define MAX(p,q) ((p >= q) ? p : q)
138 static void dopr (char *buffer, size_t maxlen, const char *format, va_list args)
151 state = DP_S_DEFAULT;
152 currlen = flags = cflags = min = 0;
156 while (state != DP_S_DONE)
158 if ((ch == '\0') || (currlen >= maxlen))
167 dopr_outch (buffer, &currlen, maxlen, ch);
199 if (isdigit((unsigned char)ch))
201 min = 10*min + char_to_int (ch);
206 min = va_arg (args, int);
223 if (isdigit((unsigned char)ch))
227 max = 10*max + char_to_int (ch);
232 max = va_arg (args, int);
240 /* Currently, we don't support Long Long, bummer */
252 cflags = DP_C_LDOUBLE;
265 if (cflags == DP_C_SHORT)
266 value = va_arg (args, short int);
267 else if (cflags == DP_C_LONG)
268 value = va_arg (args, long int);
270 value = va_arg (args, int);
271 fmtint (buffer, &currlen, maxlen, value, 10, min, max, flags);
274 flags |= DP_F_UNSIGNED;
275 if (cflags == DP_C_SHORT)
276 value = va_arg (args, unsigned short int);
277 else if (cflags == DP_C_LONG)
278 value = (long)va_arg (args, unsigned long int);
280 value = (long)va_arg (args, unsigned int);
281 fmtint (buffer, &currlen, maxlen, value, 8, min, max, flags);
284 flags |= DP_F_UNSIGNED;
285 if (cflags == DP_C_SHORT)
286 value = va_arg (args, unsigned short int);
287 else if (cflags == DP_C_LONG)
288 value = (long)va_arg (args, unsigned long int);
290 value = (long)va_arg (args, unsigned int);
291 fmtint (buffer, &currlen, maxlen, value, 10, min, max, flags);
296 flags |= DP_F_UNSIGNED;
297 if (cflags == DP_C_SHORT)
298 value = va_arg (args, unsigned short int);
299 else if (cflags == DP_C_LONG)
300 value = (long)va_arg (args, unsigned long int);
302 value = (long)va_arg (args, unsigned int);
303 fmtint (buffer, &currlen, maxlen, value, 16, min, max, flags);
306 if (cflags == DP_C_LDOUBLE)
307 fvalue = va_arg (args, LDOUBLE);
309 fvalue = va_arg (args, double);
310 /* 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, max);
339 strvalue = va_arg (args, void *);
340 fmtint (buffer, &currlen, maxlen, (long) strvalue, 16, min, max, flags);
343 if (cflags == DP_C_SHORT)
346 num = va_arg (args, short int *);
349 else if (cflags == DP_C_LONG)
352 num = va_arg (args, long int *);
353 *num = (long int)currlen;
358 num = va_arg (args, int *);
363 dopr_outch (buffer, &currlen, maxlen, ch);
366 /* not supported yet, treat as next char */
374 state = DP_S_DEFAULT;
375 flags = cflags = min = 0;
382 break; /* some picky compilers need this */
385 if (currlen < maxlen - 1)
386 buffer[currlen] = '\0';
388 buffer[maxlen - 1] = '\0';
391 static void fmtstr (char *buffer, size_t *currlen, size_t maxlen,
392 char *value, int flags, int min, int max)
394 int padlen, strln; /* amount to pad */
402 for (strln = 0; value[strln]; ++strln); /* strlen */
403 padlen = min - strln;
406 if (flags & DP_F_MINUS)
407 padlen = -padlen; /* Left Justify */
409 while ((padlen > 0) && (cnt < max))
411 dopr_outch (buffer, currlen, maxlen, ' ');
415 while (*value && (cnt < max))
417 dopr_outch (buffer, currlen, maxlen, *value++);
420 while ((padlen < 0) && (cnt < max))
422 dopr_outch (buffer, currlen, maxlen, ' ');
428 /* Have to handle DP_F_NUM (ie 0x and 0 alternates) */
430 static void fmtint (char *buffer, size_t *currlen, size_t maxlen,
431 long value, int base, int min, int max, int flags)
434 unsigned long uvalue;
437 int spadlen = 0; /* amount to space pad */
438 int zpadlen = 0; /* amount to zero pad */
446 if(!(flags & DP_F_UNSIGNED))
453 if (flags & DP_F_PLUS) /* Do a sign (+/i) */
456 if (flags & DP_F_SPACE)
460 if (flags & DP_F_UP) caps = 1; /* Should characters be upper case? */
464 (caps? "0123456789ABCDEF":"0123456789abcdef")
465 [uvalue % (unsigned)base ];
466 uvalue = (uvalue / (unsigned)base );
467 } while(uvalue && (place < 20));
468 if (place == 20) place--;
471 zpadlen = max - place;
472 spadlen = min - MAX (max, place) - (signvalue ? 1 : 0);
473 if (zpadlen < 0) zpadlen = 0;
474 if (spadlen < 0) spadlen = 0;
475 if (flags & DP_F_ZERO)
477 zpadlen = MAX(zpadlen, spadlen);
480 if (flags & DP_F_MINUS)
481 spadlen = -spadlen; /* Left Justifty */
483 #ifdef DEBUG_SNPRINTF
484 printf("zpad: %d, spad: %d, min: %d, max: %d, place: %d\n",
485 zpadlen, spadlen, min, max, place);
491 dopr_outch (buffer, currlen, maxlen, ' ');
497 dopr_outch (buffer, currlen, maxlen, signvalue);
504 dopr_outch (buffer, currlen, maxlen, '0');
511 dopr_outch (buffer, currlen, maxlen, convert[--place]);
513 /* Left Justified spaces */
514 while (spadlen < 0) {
515 dopr_outch (buffer, currlen, maxlen, ' ');
520 static LDOUBLE abs_val (LDOUBLE value)
522 LDOUBLE result = value;
530 static LDOUBLE pow10 (int exp)
543 static long round (LDOUBLE value)
547 intpart = (long)value;
548 value = value - intpart;
555 static void fmtfp (char *buffer, size_t *currlen, size_t maxlen,
556 LDOUBLE fvalue, int min, int max, int flags)
564 int padlen = 0; /* amount to pad */
571 * AIX manpage says the default is 0, but Solaris says the default
572 * is 6, and sprintf on AIX defaults to 6
577 ufvalue = abs_val (fvalue);
582 if (flags & DP_F_PLUS) /* Do a sign (+/i) */
585 if (flags & DP_F_SPACE)
589 if (flags & DP_F_UP) caps = 1; /* Should characters be upper case? */
592 intpart = (long)ufvalue;
595 * Sorry, we only support 9 digits past the decimal because of our
601 /* We "cheat" by converting the fractional part to integer by
602 * multiplying by a factor of 10
604 fracpart = round ((pow10 (max)) * (ufvalue - intpart));
606 if (fracpart >= pow10 (max))
609 fracpart -= pow10 (max);
612 #ifdef DEBUG_SNPRINTF
613 printf("fmtfp: %g %d.%d min=%d max=%d\n",
614 (double)fvalue, intpart, fracpart, min, max);
617 /* Convert integer part */
620 (caps? "0123456789ABCDEF":"0123456789abcdef")[intpart % 10];
621 intpart = (intpart / 10);
622 } while(intpart && (iplace < 20));
623 if (iplace == 20) iplace--;
624 iconvert[iplace] = 0;
626 /* Convert fractional part */
629 (caps? "0123456789ABCDEF":"0123456789abcdef")[fracpart % 10];
630 fracpart = (fracpart / 10);
631 } while(fracpart && (fplace < 20));
632 if (fplace == 20) fplace--;
633 fconvert[fplace] = 0;
635 /* -1 for decimal point, another -1 if we are printing a sign */
636 padlen = min - iplace - max - 1 - ((signvalue) ? 1 : 0);
637 zpadlen = max - fplace;
642 if (flags & DP_F_MINUS)
643 padlen = -padlen; /* Left Justifty */
645 if ((flags & DP_F_ZERO) && (padlen > 0))
649 dopr_outch (buffer, currlen, maxlen, signvalue);
655 dopr_outch (buffer, currlen, maxlen, '0');
661 dopr_outch (buffer, currlen, maxlen, ' ');
665 dopr_outch (buffer, currlen, maxlen, signvalue);
668 dopr_outch (buffer, currlen, maxlen, iconvert[--iplace]);
671 #ifdef DEBUG_SNPRINTF
672 printf("fmtfp: fplace=%d zpadlen=%d\n", fplace, zpadlen);
676 * Decimal point. This should probably use locale to find the correct
680 dopr_outch (buffer, currlen, maxlen, '.');
683 dopr_outch (buffer, currlen, maxlen, fconvert[--fplace]);
688 dopr_outch (buffer, currlen, maxlen, '0');
694 dopr_outch (buffer, currlen, maxlen, ' ');
699 static void dopr_outch (char *buffer, size_t *currlen, size_t maxlen, char c)
701 if (*currlen < maxlen)
702 buffer[(*currlen)++] = c;
704 #endif /* !defined(HAVE_SNPRINTF) || !defined(HAVE_VSNPRINTF) */
706 #ifndef HAVE_VSNPRINTF
707 int vsnprintf (char *str, size_t count, const char *fmt, va_list args)
710 dopr(str, count, fmt, args);
713 #endif /* !HAVE_VSNPRINTF */
715 #ifndef HAVE_SNPRINTF
718 int snprintf (char *str,size_t count,const char *fmt,...)
720 int snprintf (va_alist) va_dcl
731 VA_SHIFT (str, char *);
732 VA_SHIFT (count, size_t );
733 VA_SHIFT (fmt, char *);
734 (void) vsnprintf(str, count, fmt, ap);
741 /* keep compilers happy about empty files */
742 void dummy_snprintf(void) {}
743 #endif /* !HAVE_SNPRINTF */
747 #define LONG_STRING 1024
751 char buf1[LONG_STRING];
752 char buf2[LONG_STRING];
769 double fp_nums[] = { -1.5, 134.21, 91340.2, 341.1234, 0203.9, 0.96, 0.996,
770 0.9996, 1.996, 4.136, 0};
783 long int_nums[] = { -1, 134, 91340, 341, 0203, 0};
788 printf ("Testing snprintf format codes against system sprintf...\n");
790 for (x = 0; fp_fmt[x] != NULL ; x++)
791 for (y = 0; fp_nums[y] != 0 ; y++)
793 snprintf (buf1, sizeof (buf1), fp_fmt[x], fp_nums[y]);
794 sprintf (buf2, fp_fmt[x], fp_nums[y]);
795 if (strcmp (buf1, buf2))
797 printf("snprintf doesn't match Format: %s\n\tsnprintf = %s\n\tsprintf = %s\n",
798 fp_fmt[x], buf1, buf2);
804 for (x = 0; int_fmt[x] != NULL ; x++)
805 for (y = 0; int_nums[y] != 0 ; y++)
807 snprintf (buf1, sizeof (buf1), int_fmt[x], int_nums[y]);
808 sprintf (buf2, int_fmt[x], int_nums[y]);
809 if (strcmp (buf1, buf2))
811 printf("snprintf doesn't match Format: %s\n\tsnprintf = %s\n\tsprintf = %s\n",
812 int_fmt[x], buf1, buf2);
817 printf ("%d tests failed out of %d.\n", fail, num);
819 #endif /* SNPRINTF_TEST */