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 RCSID("$Id: bsd-snprintf.c,v 1.11 2005/12/17 11:32:04 dtucker Exp $");
94 #if defined(BROKEN_SNPRINTF) /* For those with broken snprintf() */
96 # undef HAVE_VSNPRINTF
101 # define VA_COPY(dest, src) va_copy(dest, src)
103 # ifdef HAVE___VA_COPY
104 # define VA_COPY(dest, src) __va_copy(dest, src)
106 # define VA_COPY(dest, src) (dest) = (src)
111 #if !defined(HAVE_SNPRINTF) || !defined(HAVE_VSNPRINTF)
113 #ifdef HAVE_LONG_DOUBLE
114 # define LDOUBLE long double
116 # define LDOUBLE double
119 #ifdef HAVE_LONG_LONG
120 # define LLONG long long
126 * dopr(): poor man's version of doprintf
129 /* format read states */
130 #define DP_S_DEFAULT 0
139 /* format flags - Bits */
140 #define DP_F_MINUS (1 << 0)
141 #define DP_F_PLUS (1 << 1)
142 #define DP_F_SPACE (1 << 2)
143 #define DP_F_NUM (1 << 3)
144 #define DP_F_ZERO (1 << 4)
145 #define DP_F_UP (1 << 5)
146 #define DP_F_UNSIGNED (1 << 6)
148 /* Conversion Flags */
151 #define DP_C_LDOUBLE 3
154 #define char_to_int(p) ((p)- '0')
156 # define MAX(p,q) (((p) >= (q)) ? (p) : (q))
159 static size_t dopr(char *buffer, size_t maxlen, const char *format,
161 static void fmtstr(char *buffer, size_t *currlen, size_t maxlen,
162 char *value, int flags, int min, int max);
163 static void fmtint(char *buffer, size_t *currlen, size_t maxlen,
164 long value, int base, int min, int max, int flags);
165 static void fmtfp(char *buffer, size_t *currlen, size_t maxlen,
166 LDOUBLE fvalue, int min, int max, int flags);
167 static void dopr_outch(char *buffer, size_t *currlen, size_t maxlen, char c);
169 static size_t dopr(char *buffer, size_t maxlen, const char *format, va_list args_in)
183 VA_COPY(args, args_in);
185 state = DP_S_DEFAULT;
186 currlen = flags = cflags = min = 0;
190 while (state != DP_S_DONE) {
199 dopr_outch (buffer, &currlen, maxlen, ch);
230 if (isdigit((unsigned char)ch)) {
231 min = 10*min + char_to_int (ch);
233 } else if (ch == '*') {
234 min = va_arg (args, int);
250 if (isdigit((unsigned char)ch)) {
253 max = 10*max + char_to_int (ch);
255 } else if (ch == '*') {
256 max = va_arg (args, int);
272 if (ch == 'l') { /* It's a long long */
278 cflags = DP_C_LDOUBLE;
290 if (cflags == DP_C_SHORT)
291 value = va_arg (args, int);
292 else if (cflags == DP_C_LONG)
293 value = va_arg (args, long int);
294 else if (cflags == DP_C_LLONG)
295 value = va_arg (args, LLONG);
297 value = va_arg (args, int);
298 fmtint (buffer, &currlen, maxlen, value, 10, min, max, flags);
301 flags |= DP_F_UNSIGNED;
302 if (cflags == DP_C_SHORT)
303 value = va_arg (args, unsigned int);
304 else if (cflags == DP_C_LONG)
305 value = (long)va_arg (args, unsigned long int);
306 else if (cflags == DP_C_LLONG)
307 value = (long)va_arg (args, unsigned LLONG);
309 value = (long)va_arg (args, unsigned int);
310 fmtint (buffer, &currlen, maxlen, value, 8, min, max, flags);
313 flags |= DP_F_UNSIGNED;
314 if (cflags == DP_C_SHORT)
315 value = va_arg (args, unsigned int);
316 else if (cflags == DP_C_LONG)
317 value = (long)va_arg (args, unsigned long int);
318 else if (cflags == DP_C_LLONG)
319 value = (LLONG)va_arg (args, unsigned LLONG);
321 value = (long)va_arg (args, unsigned int);
322 fmtint (buffer, &currlen, maxlen, value, 10, min, max, flags);
327 flags |= DP_F_UNSIGNED;
328 if (cflags == DP_C_SHORT)
329 value = va_arg (args, unsigned int);
330 else if (cflags == DP_C_LONG)
331 value = (long)va_arg (args, unsigned long int);
332 else if (cflags == DP_C_LLONG)
333 value = (LLONG)va_arg (args, unsigned LLONG);
335 value = (long)va_arg (args, unsigned int);
336 fmtint (buffer, &currlen, maxlen, value, 16, min, max, flags);
339 if (cflags == DP_C_LDOUBLE)
340 fvalue = va_arg (args, LDOUBLE);
342 fvalue = va_arg (args, double);
343 /* um, floating point? */
344 fmtfp (buffer, &currlen, maxlen, fvalue, min, max, flags);
349 if (cflags == DP_C_LDOUBLE)
350 fvalue = va_arg (args, LDOUBLE);
352 fvalue = va_arg (args, double);
353 fmtfp (buffer, &currlen, maxlen, fvalue, min, max, flags);
358 if (cflags == DP_C_LDOUBLE)
359 fvalue = va_arg (args, LDOUBLE);
361 fvalue = va_arg (args, double);
362 fmtfp (buffer, &currlen, maxlen, fvalue, min, max, flags);
365 dopr_outch (buffer, &currlen, maxlen, va_arg (args, int));
368 strvalue = va_arg (args, char *);
369 if (!strvalue) strvalue = "(NULL)";
371 max = strlen(strvalue);
373 if (min > 0 && max >= 0 && min > max) max = min;
374 fmtstr (buffer, &currlen, maxlen, strvalue, flags, min, max);
377 strvalue = va_arg (args, void *);
378 fmtint (buffer, &currlen, maxlen, (long) strvalue, 16, min, max, flags);
381 if (cflags == DP_C_SHORT) {
383 num = va_arg (args, short int *);
385 } else if (cflags == DP_C_LONG) {
387 num = va_arg (args, long int *);
388 *num = (long int)currlen;
389 } else if (cflags == DP_C_LLONG) {
391 num = va_arg (args, LLONG *);
392 *num = (LLONG)currlen;
395 num = va_arg (args, int *);
400 dopr_outch (buffer, &currlen, maxlen, ch);
403 /* not supported yet, treat as next char */
411 state = DP_S_DEFAULT;
412 flags = cflags = min = 0;
419 break; /* some picky compilers need this */
423 if (currlen < maxlen - 1)
424 buffer[currlen] = '\0';
426 buffer[maxlen - 1] = '\0';
432 static void fmtstr(char *buffer, size_t *currlen, size_t maxlen,
433 char *value, int flags, int min, int max)
435 int padlen, strln; /* amount to pad */
438 #ifdef DEBUG_SNPRINTF
439 printf("fmtstr min=%d max=%d s=[%s]\n", min, max, value);
445 for (strln = 0; strln < max && value[strln]; ++strln); /* strlen */
446 padlen = min - strln;
449 if (flags & DP_F_MINUS)
450 padlen = -padlen; /* Left Justify */
452 while ((padlen > 0) && (cnt < max)) {
453 dopr_outch (buffer, currlen, maxlen, ' ');
457 while (*value && (cnt < max)) {
458 dopr_outch (buffer, currlen, maxlen, *value++);
461 while ((padlen < 0) && (cnt < max)) {
462 dopr_outch (buffer, currlen, maxlen, ' ');
468 /* Have to handle DP_F_NUM (ie 0x and 0 alternates) */
470 static void fmtint(char *buffer, size_t *currlen, size_t maxlen,
471 long value, int base, int min, int max, int flags)
474 unsigned long uvalue;
477 int spadlen = 0; /* amount to space pad */
478 int zpadlen = 0; /* amount to zero pad */
486 if(!(flags & DP_F_UNSIGNED)) {
491 if (flags & DP_F_PLUS) /* Do a sign (+/i) */
493 else if (flags & DP_F_SPACE)
498 if (flags & DP_F_UP) caps = 1; /* Should characters be upper case? */
502 (caps? "0123456789ABCDEF":"0123456789abcdef")
503 [uvalue % (unsigned)base ];
504 uvalue = (uvalue / (unsigned)base );
505 } while(uvalue && (place < 20));
506 if (place == 20) place--;
509 zpadlen = max - place;
510 spadlen = min - MAX (max, place) - (signvalue ? 1 : 0);
511 if (zpadlen < 0) zpadlen = 0;
512 if (spadlen < 0) spadlen = 0;
513 if (flags & DP_F_ZERO) {
514 zpadlen = MAX(zpadlen, spadlen);
517 if (flags & DP_F_MINUS)
518 spadlen = -spadlen; /* Left Justifty */
520 #ifdef DEBUG_SNPRINTF
521 printf("zpad: %d, spad: %d, min: %d, max: %d, place: %d\n",
522 zpadlen, spadlen, min, max, place);
526 while (spadlen > 0) {
527 dopr_outch (buffer, currlen, maxlen, ' ');
533 dopr_outch (buffer, currlen, maxlen, signvalue);
537 while (zpadlen > 0) {
538 dopr_outch (buffer, currlen, maxlen, '0');
545 dopr_outch (buffer, currlen, maxlen, convert[--place]);
547 /* Left Justified spaces */
548 while (spadlen < 0) {
549 dopr_outch (buffer, currlen, maxlen, ' ');
554 static LDOUBLE abs_val(LDOUBLE value)
556 LDOUBLE result = value;
564 static LDOUBLE POW10(int exp)
576 static LLONG ROUND(LDOUBLE value)
580 intpart = (LLONG)value;
581 value = value - intpart;
582 if (value >= 0.5) intpart++;
587 /* a replacement for modf that doesn't need the math library. Should
588 be portable, but slow */
589 static double my_modf(double x0, double *iptr)
596 for (i=0;i<100;i++) {
598 if (l <= (x+1) && l >= (x-1)) break;
604 /* yikes! the number is beyond what we can handle. What do we do? */
613 ret = my_modf(x0-l*f, &i2);
623 static void fmtfp (char *buffer, size_t *currlen, size_t maxlen,
624 LDOUBLE fvalue, int min, int max, int flags)
632 int padlen = 0; /* amount to pad */
641 * AIX manpage says the default is 0, but Solaris says the default
642 * is 6, and sprintf on AIX defaults to 6
647 ufvalue = abs_val (fvalue);
652 if (flags & DP_F_PLUS) { /* Do a sign (+/i) */
655 if (flags & DP_F_SPACE)
661 if (flags & DP_F_UP) caps = 1; /* Should characters be upper case? */
665 if (max == 0) ufvalue += 0.5; /* if max = 0 we must round */
669 * Sorry, we only support 16 digits past the decimal because of our
675 /* We "cheat" by converting the fractional part to integer by
676 * multiplying by a factor of 10
680 my_modf(temp, &intpart);
682 fracpart = ROUND((POW10(max)) * (ufvalue - intpart));
684 if (fracpart >= POW10(max)) {
686 fracpart -= POW10(max);
689 /* Convert integer part */
692 my_modf(temp, &intpart);
693 idx = (int) ((temp -intpart +0.05)* 10.0);
694 /* idx = (int) (((double)(temp*0.1) -intpart +0.05) *10.0); */
695 /* printf ("%llf, %f, %x\n", temp, intpart, idx); */
697 (caps? "0123456789ABCDEF":"0123456789abcdef")[idx];
698 } while (intpart && (iplace < 311));
699 if (iplace == 311) iplace--;
700 iconvert[iplace] = 0;
702 /* Convert fractional part */
707 my_modf(temp, &fracpart);
708 idx = (int) ((temp -fracpart +0.05)* 10.0);
709 /* idx = (int) ((((temp/10) -fracpart) +0.05) *10); */
710 /* printf ("%lf, %lf, %ld\n", temp, fracpart, idx ); */
712 (caps? "0123456789ABCDEF":"0123456789abcdef")[idx];
713 } while(fracpart && (fplace < 311));
714 if (fplace == 311) fplace--;
716 fconvert[fplace] = 0;
718 /* -1 for decimal point, another -1 if we are printing a sign */
719 padlen = min - iplace - max - 1 - ((signvalue) ? 1 : 0);
720 zpadlen = max - fplace;
721 if (zpadlen < 0) zpadlen = 0;
724 if (flags & DP_F_MINUS)
725 padlen = -padlen; /* Left Justifty */
727 if ((flags & DP_F_ZERO) && (padlen > 0)) {
729 dopr_outch (buffer, currlen, maxlen, signvalue);
734 dopr_outch (buffer, currlen, maxlen, '0');
739 dopr_outch (buffer, currlen, maxlen, ' ');
743 dopr_outch (buffer, currlen, maxlen, signvalue);
746 dopr_outch (buffer, currlen, maxlen, iconvert[--iplace]);
748 #ifdef DEBUG_SNPRINTF
749 printf("fmtfp: fplace=%d zpadlen=%d\n", fplace, zpadlen);
753 * Decimal point. This should probably use locale to find the correct
757 dopr_outch (buffer, currlen, maxlen, '.');
759 while (zpadlen > 0) {
760 dopr_outch (buffer, currlen, maxlen, '0');
765 dopr_outch (buffer, currlen, maxlen, fconvert[--fplace]);
769 dopr_outch (buffer, currlen, maxlen, ' ');
774 static void dopr_outch(char *buffer, size_t *currlen, size_t maxlen, char c)
776 if (*currlen < maxlen) {
777 buffer[(*currlen)] = c;
781 #endif /* !defined(HAVE_SNPRINTF) || !defined(HAVE_VSNPRINTF) */
783 #if !defined(HAVE_VSNPRINTF)
784 int vsnprintf (char *str, size_t count, const char *fmt, va_list args)
786 return dopr(str, count, fmt, args);
790 #if !defined(HAVE_SNPRINTF)
791 int snprintf(char *str, size_t count, SNPRINTF_CONST char *fmt, ...)
797 ret = vsnprintf(str, count, fmt, ap);