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 * tridge@samba.org, idra@samba.org, April 2001
53 * got rid of fcvt code (twas buggy and made testing harder)
56 * date: 2002/12/19 19:56:31; author: herb; state: Exp; lines: +2 -0
57 * actually print args for %g and %e
59 * date: 2002/06/03 13:37:52; author: jmcd; state: Exp; lines: +8 -0
60 * Since includes.h isn't included here, VA_COPY has to be defined here. I don't
61 * see any include file that is guaranteed to be here, so I'm defining it
62 * locally. Fixes AIX and Solaris builds.
64 * date: 2002/06/03 03:07:24; author: tridge; state: Exp; lines: +5 -13
65 * put the ifdef for HAVE_VA_COPY in one place rather than in lots of
68 * date: 2002/05/17 14:51:22; author: jmcd; state: Exp; lines: +21 -4
69 * Fix usage of va_list passed as an arg. Use __va_copy before using it
72 * date: 2002/04/16 22:38:04; author: idra; state: Exp; lines: +20 -14
73 * Fix incorrect zpadlen handling in fmtfp.
74 * Thanks to Ollie Oldham <ollie.oldham@metro-optix.com> for spotting it.
75 * few mods to make it easier to compile the tests.
76 * addedd the "Ollie" test to the floating point ones.
78 * Martin Pool (mbp@samba.org) April 2003
79 * Remove NO_CONFIG_H so that the test case can be built within a source
80 * tree with less trouble.
81 * Remove unnecessary SAFE_FREE() definition.
83 * Martin Pool (mbp@samba.org) May 2003
84 * Put in a prototype for dummy_snprintf() to quiet compiler warnings.
86 * Move #endif to make sure VA_COPY, LDOUBLE, etc are defined even
87 * if the C library has some snprintf functions already.
88 **************************************************************/
92 #if defined(BROKEN_SNPRINTF) /* For those with broken snprintf() */
94 # undef HAVE_VSNPRINTF
99 # define VA_COPY(dest, src) va_copy(dest, src)
101 # ifdef HAVE___VA_COPY
102 # define VA_COPY(dest, src) __va_copy(dest, src)
104 # define VA_COPY(dest, src) (dest) = (src)
109 #if !defined(HAVE_SNPRINTF) || !defined(HAVE_VSNPRINTF)
111 #ifdef HAVE_LONG_DOUBLE
112 # define LDOUBLE long double
114 # define LDOUBLE double
117 #ifdef HAVE_LONG_LONG
118 # define LLONG long long
124 * dopr(): poor man's version of doprintf
127 /* format read states */
128 #define DP_S_DEFAULT 0
137 /* format flags - Bits */
138 #define DP_F_MINUS (1 << 0)
139 #define DP_F_PLUS (1 << 1)
140 #define DP_F_SPACE (1 << 2)
141 #define DP_F_NUM (1 << 3)
142 #define DP_F_ZERO (1 << 4)
143 #define DP_F_UP (1 << 5)
144 #define DP_F_UNSIGNED (1 << 6)
146 /* Conversion Flags */
149 #define DP_C_LDOUBLE 3
152 #define char_to_int(p) ((p)- '0')
154 # define MAX(p,q) (((p) >= (q)) ? (p) : (q))
157 static size_t dopr(char *buffer, size_t maxlen, const char *format,
159 static void fmtstr(char *buffer, size_t *currlen, size_t maxlen,
160 char *value, int flags, int min, int max);
161 static void fmtint(char *buffer, size_t *currlen, size_t maxlen,
162 LLONG value, int base, int min, int max, int flags);
163 static void fmtfp(char *buffer, size_t *currlen, size_t maxlen,
164 LDOUBLE fvalue, int min, int max, int flags);
165 static void dopr_outch(char *buffer, size_t *currlen, size_t maxlen, char c);
167 static size_t dopr(char *buffer, size_t maxlen, const char *format, va_list args_in)
181 VA_COPY(args, args_in);
183 state = DP_S_DEFAULT;
184 currlen = flags = cflags = min = 0;
188 while (state != DP_S_DONE) {
197 dopr_outch (buffer, &currlen, maxlen, ch);
228 if (isdigit((unsigned char)ch)) {
229 min = 10*min + char_to_int (ch);
231 } else if (ch == '*') {
232 min = va_arg (args, int);
248 if (isdigit((unsigned char)ch)) {
251 max = 10*max + char_to_int (ch);
253 } else if (ch == '*') {
254 max = va_arg (args, int);
270 if (ch == 'l') { /* It's a long long */
276 cflags = DP_C_LDOUBLE;
288 if (cflags == DP_C_SHORT)
289 value = va_arg (args, int);
290 else if (cflags == DP_C_LONG)
291 value = va_arg (args, long int);
292 else if (cflags == DP_C_LLONG)
293 value = va_arg (args, LLONG);
295 value = va_arg (args, int);
296 fmtint (buffer, &currlen, maxlen, value, 10, min, max, flags);
299 flags |= DP_F_UNSIGNED;
300 if (cflags == DP_C_SHORT)
301 value = va_arg (args, unsigned int);
302 else if (cflags == DP_C_LONG)
303 value = (long)va_arg (args, unsigned long int);
304 else if (cflags == DP_C_LLONG)
305 value = (long)va_arg (args, unsigned LLONG);
307 value = (long)va_arg (args, unsigned int);
308 fmtint (buffer, &currlen, maxlen, value, 8, min, max, flags);
311 flags |= DP_F_UNSIGNED;
312 if (cflags == DP_C_SHORT)
313 value = va_arg (args, unsigned int);
314 else if (cflags == DP_C_LONG)
315 value = (long)va_arg (args, unsigned long int);
316 else if (cflags == DP_C_LLONG)
317 value = (LLONG)va_arg (args, unsigned LLONG);
319 value = (long)va_arg (args, unsigned int);
320 fmtint (buffer, &currlen, maxlen, value, 10, min, max, flags);
325 flags |= DP_F_UNSIGNED;
326 if (cflags == DP_C_SHORT)
327 value = va_arg (args, unsigned int);
328 else if (cflags == DP_C_LONG)
329 value = (long)va_arg (args, unsigned long int);
330 else if (cflags == DP_C_LLONG)
331 value = (LLONG)va_arg (args, unsigned LLONG);
333 value = (long)va_arg (args, unsigned int);
334 fmtint (buffer, &currlen, maxlen, value, 16, min, max, flags);
337 if (cflags == DP_C_LDOUBLE)
338 fvalue = va_arg (args, LDOUBLE);
340 fvalue = va_arg (args, double);
341 /* um, floating point? */
342 fmtfp (buffer, &currlen, maxlen, fvalue, min, max, flags);
347 if (cflags == DP_C_LDOUBLE)
348 fvalue = va_arg (args, LDOUBLE);
350 fvalue = va_arg (args, double);
351 fmtfp (buffer, &currlen, maxlen, fvalue, min, max, flags);
356 if (cflags == DP_C_LDOUBLE)
357 fvalue = va_arg (args, LDOUBLE);
359 fvalue = va_arg (args, double);
360 fmtfp (buffer, &currlen, maxlen, fvalue, min, max, flags);
363 dopr_outch (buffer, &currlen, maxlen, va_arg (args, int));
366 strvalue = va_arg (args, char *);
367 if (!strvalue) strvalue = "(NULL)";
369 max = strlen(strvalue);
371 if (min > 0 && max >= 0 && min > max) max = min;
372 fmtstr (buffer, &currlen, maxlen, strvalue, flags, min, max);
375 strvalue = va_arg (args, void *);
376 fmtint (buffer, &currlen, maxlen, (long) strvalue, 16, min, max, flags);
379 if (cflags == DP_C_SHORT) {
381 num = va_arg (args, short int *);
383 } else if (cflags == DP_C_LONG) {
385 num = va_arg (args, long int *);
386 *num = (long int)currlen;
387 } else if (cflags == DP_C_LLONG) {
389 num = va_arg (args, LLONG *);
390 *num = (LLONG)currlen;
393 num = va_arg (args, int *);
398 dopr_outch (buffer, &currlen, maxlen, ch);
401 /* not supported yet, treat as next char */
409 state = DP_S_DEFAULT;
410 flags = cflags = min = 0;
417 break; /* some picky compilers need this */
421 if (currlen < maxlen - 1)
422 buffer[currlen] = '\0';
424 buffer[maxlen - 1] = '\0';
430 static void fmtstr(char *buffer, size_t *currlen, size_t maxlen,
431 char *value, int flags, int min, int max)
433 int padlen, strln; /* amount to pad */
436 #ifdef DEBUG_SNPRINTF
437 printf("fmtstr min=%d max=%d s=[%s]\n", min, max, value);
443 for (strln = 0; strln < max && value[strln]; ++strln); /* strlen */
444 padlen = min - strln;
447 if (flags & DP_F_MINUS)
448 padlen = -padlen; /* Left Justify */
450 while ((padlen > 0) && (cnt < max)) {
451 dopr_outch (buffer, currlen, maxlen, ' ');
455 while (*value && (cnt < max)) {
456 dopr_outch (buffer, currlen, maxlen, *value++);
459 while ((padlen < 0) && (cnt < max)) {
460 dopr_outch (buffer, currlen, maxlen, ' ');
466 /* Have to handle DP_F_NUM (ie 0x and 0 alternates) */
468 static void fmtint(char *buffer, size_t *currlen, size_t maxlen,
469 LLONG value, int base, int min, int max, int flags)
472 unsigned LLONG uvalue;
475 int spadlen = 0; /* amount to space pad */
476 int zpadlen = 0; /* amount to zero pad */
484 if(!(flags & DP_F_UNSIGNED)) {
489 if (flags & DP_F_PLUS) /* Do a sign (+/i) */
491 else if (flags & DP_F_SPACE)
496 if (flags & DP_F_UP) caps = 1; /* Should characters be upper case? */
500 (caps? "0123456789ABCDEF":"0123456789abcdef")
501 [uvalue % (unsigned)base ];
502 uvalue = (uvalue / (unsigned)base );
503 } while(uvalue && (place < 20));
504 if (place == 20) place--;
507 zpadlen = max - place;
508 spadlen = min - MAX (max, place) - (signvalue ? 1 : 0);
509 if (zpadlen < 0) zpadlen = 0;
510 if (spadlen < 0) spadlen = 0;
511 if (flags & DP_F_ZERO) {
512 zpadlen = MAX(zpadlen, spadlen);
515 if (flags & DP_F_MINUS)
516 spadlen = -spadlen; /* Left Justifty */
518 #ifdef DEBUG_SNPRINTF
519 printf("zpad: %d, spad: %d, min: %d, max: %d, place: %d\n",
520 zpadlen, spadlen, min, max, place);
524 while (spadlen > 0) {
525 dopr_outch (buffer, currlen, maxlen, ' ');
531 dopr_outch (buffer, currlen, maxlen, signvalue);
535 while (zpadlen > 0) {
536 dopr_outch (buffer, currlen, maxlen, '0');
543 dopr_outch (buffer, currlen, maxlen, convert[--place]);
545 /* Left Justified spaces */
546 while (spadlen < 0) {
547 dopr_outch (buffer, currlen, maxlen, ' ');
552 static LDOUBLE abs_val(LDOUBLE value)
554 LDOUBLE result = value;
562 static LDOUBLE POW10(int exp)
574 static LLONG ROUND(LDOUBLE value)
578 intpart = (LLONG)value;
579 value = value - intpart;
580 if (value >= 0.5) intpart++;
585 /* a replacement for modf that doesn't need the math library. Should
586 be portable, but slow */
587 static double my_modf(double x0, double *iptr)
594 for (i=0;i<100;i++) {
596 if (l <= (x+1) && l >= (x-1)) break;
602 /* yikes! the number is beyond what we can handle. What do we do? */
611 ret = my_modf(x0-l*f, &i2);
621 static void fmtfp (char *buffer, size_t *currlen, size_t maxlen,
622 LDOUBLE fvalue, int min, int max, int flags)
630 int padlen = 0; /* amount to pad */
639 * AIX manpage says the default is 0, but Solaris says the default
640 * is 6, and sprintf on AIX defaults to 6
645 ufvalue = abs_val (fvalue);
650 if (flags & DP_F_PLUS) { /* Do a sign (+/i) */
653 if (flags & DP_F_SPACE)
659 if (flags & DP_F_UP) caps = 1; /* Should characters be upper case? */
663 if (max == 0) ufvalue += 0.5; /* if max = 0 we must round */
667 * Sorry, we only support 16 digits past the decimal because of our
673 /* We "cheat" by converting the fractional part to integer by
674 * multiplying by a factor of 10
678 my_modf(temp, &intpart);
680 fracpart = ROUND((POW10(max)) * (ufvalue - intpart));
682 if (fracpart >= POW10(max)) {
684 fracpart -= POW10(max);
687 /* Convert integer part */
690 my_modf(temp, &intpart);
691 idx = (int) ((temp -intpart +0.05)* 10.0);
692 /* idx = (int) (((double)(temp*0.1) -intpart +0.05) *10.0); */
693 /* printf ("%llf, %f, %x\n", temp, intpart, idx); */
695 (caps? "0123456789ABCDEF":"0123456789abcdef")[idx];
696 } while (intpart && (iplace < 311));
697 if (iplace == 311) iplace--;
698 iconvert[iplace] = 0;
700 /* Convert fractional part */
705 my_modf(temp, &fracpart);
706 idx = (int) ((temp -fracpart +0.05)* 10.0);
707 /* idx = (int) ((((temp/10) -fracpart) +0.05) *10); */
708 /* printf ("%lf, %lf, %ld\n", temp, fracpart, idx ); */
710 (caps? "0123456789ABCDEF":"0123456789abcdef")[idx];
711 } while(fracpart && (fplace < 311));
712 if (fplace == 311) fplace--;
714 fconvert[fplace] = 0;
716 /* -1 for decimal point, another -1 if we are printing a sign */
717 padlen = min - iplace - max - 1 - ((signvalue) ? 1 : 0);
718 zpadlen = max - fplace;
719 if (zpadlen < 0) zpadlen = 0;
722 if (flags & DP_F_MINUS)
723 padlen = -padlen; /* Left Justifty */
725 if ((flags & DP_F_ZERO) && (padlen > 0)) {
727 dopr_outch (buffer, currlen, maxlen, signvalue);
732 dopr_outch (buffer, currlen, maxlen, '0');
737 dopr_outch (buffer, currlen, maxlen, ' ');
741 dopr_outch (buffer, currlen, maxlen, signvalue);
744 dopr_outch (buffer, currlen, maxlen, iconvert[--iplace]);
746 #ifdef DEBUG_SNPRINTF
747 printf("fmtfp: fplace=%d zpadlen=%d\n", fplace, zpadlen);
751 * Decimal point. This should probably use locale to find the correct
755 dopr_outch (buffer, currlen, maxlen, '.');
757 while (zpadlen > 0) {
758 dopr_outch (buffer, currlen, maxlen, '0');
763 dopr_outch (buffer, currlen, maxlen, fconvert[--fplace]);
767 dopr_outch (buffer, currlen, maxlen, ' ');
772 static void dopr_outch(char *buffer, size_t *currlen, size_t maxlen, char c)
774 if (*currlen < maxlen) {
775 buffer[(*currlen)] = c;
779 #endif /* !defined(HAVE_SNPRINTF) || !defined(HAVE_VSNPRINTF) */
781 #if !defined(HAVE_VSNPRINTF)
782 int vsnprintf (char *str, size_t count, const char *fmt, va_list args)
784 return dopr(str, count, fmt, args);
788 #if !defined(HAVE_SNPRINTF)
789 int snprintf(char *str, size_t count, SNPRINTF_CONST char *fmt, ...)
795 ret = vsnprintf(str, count, fmt, ap);