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.
89 * Damien Miller (djm@mindrot.org) Jan 2007
90 * Fix integer overflows in return value.
91 * Make formatting quite a bit faster by inlining dopr_outch()
93 **************************************************************/
97 #if defined(BROKEN_SNPRINTF) /* For those with broken snprintf() */
99 # undef HAVE_VSNPRINTF
104 # define VA_COPY(dest, src) va_copy(dest, src)
106 # ifdef HAVE___VA_COPY
107 # define VA_COPY(dest, src) __va_copy(dest, src)
109 # define VA_COPY(dest, src) (dest) = (src)
114 #if !defined(HAVE_SNPRINTF) || !defined(HAVE_VSNPRINTF)
123 #ifdef HAVE_LONG_DOUBLE
124 # define LDOUBLE long double
126 # define LDOUBLE double
129 #ifdef HAVE_LONG_LONG
130 # define LLONG long long
136 * dopr(): poor man's version of doprintf
139 /* format read states */
140 #define DP_S_DEFAULT 0
149 /* format flags - Bits */
150 #define DP_F_MINUS (1 << 0)
151 #define DP_F_PLUS (1 << 1)
152 #define DP_F_SPACE (1 << 2)
153 #define DP_F_NUM (1 << 3)
154 #define DP_F_ZERO (1 << 4)
155 #define DP_F_UP (1 << 5)
156 #define DP_F_UNSIGNED (1 << 6)
158 /* Conversion Flags */
161 #define DP_C_LDOUBLE 3
164 #define char_to_int(p) ((p)- '0')
166 # define MAX(p,q) (((p) >= (q)) ? (p) : (q))
169 #define DOPR_OUTCH(buf, pos, buflen, thechar) \
171 if (pos + 1 >= INT_MAX) { \
176 buf[pos] = thechar; \
180 static int dopr(char *buffer
, size_t maxlen
, const char *format
,
182 static int fmtstr(char *buffer
, size_t *currlen
, size_t maxlen
,
183 char *value
, int flags
, int min
, int max
);
184 static int fmtint(char *buffer
, size_t *currlen
, size_t maxlen
,
185 LLONG value
, int base
, int min
, int max
, int flags
);
186 static int fmtfp(char *buffer
, size_t *currlen
, size_t maxlen
,
187 LDOUBLE fvalue
, int min
, int max
, int flags
);
190 dopr(char *buffer
, size_t maxlen
, const char *format
, va_list args_in
)
204 VA_COPY(args
, args_in
);
206 state
= DP_S_DEFAULT
;
207 currlen
= flags
= cflags
= min
= 0;
211 while (state
!= DP_S_DONE
) {
220 DOPR_OUTCH(buffer
, currlen
, maxlen
, ch
);
251 if (isdigit((unsigned char)ch
)) {
252 min
= 10*min
+ char_to_int (ch
);
254 } else if (ch
== '*') {
255 min
= va_arg (args
, int);
271 if (isdigit((unsigned char)ch
)) {
274 max
= 10*max
+ char_to_int (ch
);
276 } else if (ch
== '*') {
277 max
= va_arg (args
, int);
293 if (ch
== 'l') { /* It's a long long */
299 cflags
= DP_C_LDOUBLE
;
311 if (cflags
== DP_C_SHORT
)
312 value
= va_arg (args
, int);
313 else if (cflags
== DP_C_LONG
)
314 value
= va_arg (args
, long int);
315 else if (cflags
== DP_C_LLONG
)
316 value
= va_arg (args
, LLONG
);
318 value
= va_arg (args
, int);
319 if (fmtint(buffer
, &currlen
, maxlen
,
320 value
, 10, min
, max
, flags
) == -1)
324 flags
|= DP_F_UNSIGNED
;
325 if (cflags
== DP_C_SHORT
)
326 value
= va_arg (args
, unsigned int);
327 else if (cflags
== DP_C_LONG
)
328 value
= (long)va_arg (args
, unsigned long int);
329 else if (cflags
== DP_C_LLONG
)
330 value
= (long)va_arg (args
, unsigned LLONG
);
332 value
= (long)va_arg (args
, unsigned int);
333 if (fmtint(buffer
, &currlen
, maxlen
, value
,
334 8, min
, max
, flags
) == -1)
338 flags
|= DP_F_UNSIGNED
;
339 if (cflags
== DP_C_SHORT
)
340 value
= va_arg (args
, unsigned int);
341 else if (cflags
== DP_C_LONG
)
342 value
= (long)va_arg (args
, unsigned long int);
343 else if (cflags
== DP_C_LLONG
)
344 value
= (LLONG
)va_arg (args
, unsigned LLONG
);
346 value
= (long)va_arg (args
, unsigned int);
347 if (fmtint(buffer
, &currlen
, maxlen
, value
,
348 10, min
, max
, flags
) == -1)
354 flags
|= DP_F_UNSIGNED
;
355 if (cflags
== DP_C_SHORT
)
356 value
= va_arg (args
, unsigned int);
357 else if (cflags
== DP_C_LONG
)
358 value
= (long)va_arg (args
, unsigned long int);
359 else if (cflags
== DP_C_LLONG
)
360 value
= (LLONG
)va_arg (args
, unsigned LLONG
);
362 value
= (long)va_arg (args
, unsigned int);
363 if (fmtint(buffer
, &currlen
, maxlen
, value
,
364 16, min
, max
, flags
) == -1)
368 if (cflags
== DP_C_LDOUBLE
)
369 fvalue
= va_arg (args
, LDOUBLE
);
371 fvalue
= va_arg (args
, double);
372 if (fmtfp(buffer
, &currlen
, maxlen
, fvalue
,
373 min
, max
, flags
) == -1)
379 if (cflags
== DP_C_LDOUBLE
)
380 fvalue
= va_arg (args
, LDOUBLE
);
382 fvalue
= va_arg (args
, double);
383 if (fmtfp(buffer
, &currlen
, maxlen
, fvalue
,
384 min
, max
, flags
) == -1)
390 if (cflags
== DP_C_LDOUBLE
)
391 fvalue
= va_arg (args
, LDOUBLE
);
393 fvalue
= va_arg (args
, double);
394 if (fmtfp(buffer
, &currlen
, maxlen
, fvalue
,
395 min
, max
, flags
) == -1)
399 DOPR_OUTCH(buffer
, currlen
, maxlen
,
403 strvalue
= va_arg (args
, char *);
404 if (!strvalue
) strvalue
= "(NULL)";
406 max
= strlen(strvalue
);
408 if (min
> 0 && max
>= 0 && min
> max
) max
= min
;
409 if (fmtstr(buffer
, &currlen
, maxlen
,
410 strvalue
, flags
, min
, max
) == -1)
414 strvalue
= va_arg (args
, void *);
415 if (fmtint(buffer
, &currlen
, maxlen
,
416 (long) strvalue
, 16, min
, max
, flags
) == -1)
420 if (cflags
== DP_C_SHORT
) {
422 num
= va_arg (args
, short int *);
424 } else if (cflags
== DP_C_LONG
) {
426 num
= va_arg (args
, long int *);
427 *num
= (long int)currlen
;
428 } else if (cflags
== DP_C_LLONG
) {
430 num
= va_arg (args
, LLONG
*);
431 *num
= (LLONG
)currlen
;
434 num
= va_arg (args
, int *);
439 DOPR_OUTCH(buffer
, currlen
, maxlen
, ch
);
442 /* not supported yet, treat as next char */
450 state
= DP_S_DEFAULT
;
451 flags
= cflags
= min
= 0;
458 break; /* some picky compilers need this */
462 if (currlen
< maxlen
- 1)
463 buffer
[currlen
] = '\0';
465 buffer
[maxlen
- 1] = '\0';
468 return currlen
< INT_MAX
? (int)currlen
: -1;
472 fmtstr(char *buffer
, size_t *currlen
, size_t maxlen
,
473 char *value
, int flags
, int min
, int max
)
475 int padlen
, strln
; /* amount to pad */
478 #ifdef DEBUG_SNPRINTF
479 printf("fmtstr min=%d max=%d s=[%s]\n", min
, max
, value
);
485 for (strln
= 0; strln
< max
&& value
[strln
]; ++strln
); /* strlen */
486 padlen
= min
- strln
;
489 if (flags
& DP_F_MINUS
)
490 padlen
= -padlen
; /* Left Justify */
492 while ((padlen
> 0) && (cnt
< max
)) {
493 DOPR_OUTCH(buffer
, *currlen
, maxlen
, ' ');
497 while (*value
&& (cnt
< max
)) {
498 DOPR_OUTCH(buffer
, *currlen
, maxlen
, *value
);
502 while ((padlen
< 0) && (cnt
< max
)) {
503 DOPR_OUTCH(buffer
, *currlen
, maxlen
, ' ');
510 /* Have to handle DP_F_NUM (ie 0x and 0 alternates) */
513 fmtint(char *buffer
, size_t *currlen
, size_t maxlen
,
514 LLONG value
, int base
, int min
, int max
, int flags
)
517 unsigned LLONG uvalue
;
520 int spadlen
= 0; /* amount to space pad */
521 int zpadlen
= 0; /* amount to zero pad */
529 if(!(flags
& DP_F_UNSIGNED
)) {
534 if (flags
& DP_F_PLUS
) /* Do a sign (+/i) */
536 else if (flags
& DP_F_SPACE
)
541 if (flags
& DP_F_UP
) caps
= 1; /* Should characters be upper case? */
545 (caps
? "0123456789ABCDEF":"0123456789abcdef")
546 [uvalue
% (unsigned)base
];
547 uvalue
= (uvalue
/ (unsigned)base
);
548 } while(uvalue
&& (place
< 20));
549 if (place
== 20) place
--;
552 zpadlen
= max
- place
;
553 spadlen
= min
- MAX (max
, place
) - (signvalue
? 1 : 0);
554 if (zpadlen
< 0) zpadlen
= 0;
555 if (spadlen
< 0) spadlen
= 0;
556 if (flags
& DP_F_ZERO
) {
557 zpadlen
= MAX(zpadlen
, spadlen
);
560 if (flags
& DP_F_MINUS
)
561 spadlen
= -spadlen
; /* Left Justifty */
563 #ifdef DEBUG_SNPRINTF
564 printf("zpad: %d, spad: %d, min: %d, max: %d, place: %d\n",
565 zpadlen
, spadlen
, min
, max
, place
);
569 while (spadlen
> 0) {
570 DOPR_OUTCH(buffer
, *currlen
, maxlen
, ' ');
576 DOPR_OUTCH(buffer
, *currlen
, maxlen
, signvalue
);
580 while (zpadlen
> 0) {
581 DOPR_OUTCH(buffer
, *currlen
, maxlen
, '0');
589 DOPR_OUTCH(buffer
, *currlen
, maxlen
, convert
[place
]);
592 /* Left Justified spaces */
593 while (spadlen
< 0) {
594 DOPR_OUTCH(buffer
, *currlen
, maxlen
, ' ');
600 static LDOUBLE
abs_val(LDOUBLE value
)
602 LDOUBLE result
= value
;
610 static LDOUBLE
POW10(int val
)
622 static LLONG
ROUND(LDOUBLE value
)
626 intpart
= (LLONG
)value
;
627 value
= value
- intpart
;
628 if (value
>= 0.5) intpart
++;
633 /* a replacement for modf that doesn't need the math library. Should
634 be portable, but slow */
635 static double my_modf(double x0
, double *iptr
)
642 for (i
=0;i
<100;i
++) {
644 if (l
<= (x
+1) && l
>= (x
-1)) break;
651 * yikes! the number is beyond what we can handle.
662 ret
= my_modf(x0
-l
*f
, &i2
);
673 fmtfp (char *buffer
, size_t *currlen
, size_t maxlen
,
674 LDOUBLE fvalue
, int min
, int max
, int flags
)
682 int padlen
= 0; /* amount to pad */
691 * AIX manpage says the default is 0, but Solaris says the default
692 * is 6, and sprintf on AIX defaults to 6
697 ufvalue
= abs_val (fvalue
);
702 if (flags
& DP_F_PLUS
) { /* Do a sign (+/i) */
705 if (flags
& DP_F_SPACE
)
711 if (flags
& DP_F_UP
) caps
= 1; /* Should characters be upper case? */
715 if (max
== 0) ufvalue
+= 0.5; /* if max = 0 we must round */
719 * Sorry, we only support 16 digits past the decimal because of our
725 /* We "cheat" by converting the fractional part to integer by
726 * multiplying by a factor of 10
730 my_modf(temp
, &intpart
);
732 fracpart
= ROUND((POW10(max
)) * (ufvalue
- intpart
));
734 if (fracpart
>= POW10(max
)) {
736 fracpart
-= POW10(max
);
739 /* Convert integer part */
742 my_modf(temp
, &intpart
);
743 idx
= (int) ((temp
-intpart
+0.05)* 10.0);
744 /* idx = (int) (((double)(temp*0.1) -intpart +0.05) *10.0); */
745 /* printf ("%llf, %f, %x\n", temp, intpart, idx); */
747 (caps
? "0123456789ABCDEF":"0123456789abcdef")[idx
];
748 } while (intpart
&& (iplace
< 311));
749 if (iplace
== 311) iplace
--;
750 iconvert
[iplace
] = 0;
752 /* Convert fractional part */
757 my_modf(temp
, &fracpart
);
758 idx
= (int) ((temp
-fracpart
+0.05)* 10.0);
759 /* idx = (int) ((((temp/10) -fracpart) +0.05) *10); */
760 /* printf ("%lf, %lf, %ld\n", temp, fracpart, idx ); */
762 (caps
? "0123456789ABCDEF":"0123456789abcdef")[idx
];
763 } while(fracpart
&& (fplace
< 311));
764 if (fplace
== 311) fplace
--;
766 fconvert
[fplace
] = 0;
768 /* -1 for decimal point, another -1 if we are printing a sign */
769 padlen
= min
- iplace
- max
- 1 - ((signvalue
) ? 1 : 0);
770 zpadlen
= max
- fplace
;
771 if (zpadlen
< 0) zpadlen
= 0;
774 if (flags
& DP_F_MINUS
)
775 padlen
= -padlen
; /* Left Justifty */
777 if ((flags
& DP_F_ZERO
) && (padlen
> 0)) {
779 DOPR_OUTCH(buffer
, *currlen
, maxlen
, signvalue
);
784 DOPR_OUTCH(buffer
, *currlen
, maxlen
, '0');
789 DOPR_OUTCH(buffer
, *currlen
, maxlen
, ' ');
793 DOPR_OUTCH(buffer
, *currlen
, maxlen
, signvalue
);
797 DOPR_OUTCH(buffer
, *currlen
, maxlen
, iconvert
[iplace
]);
800 #ifdef DEBUG_SNPRINTF
801 printf("fmtfp: fplace=%d zpadlen=%d\n", fplace
, zpadlen
);
805 * Decimal point. This should probably use locale to find the correct
809 DOPR_OUTCH(buffer
, *currlen
, maxlen
, '.');
811 while (zpadlen
> 0) {
812 DOPR_OUTCH(buffer
, *currlen
, maxlen
, '0');
818 DOPR_OUTCH(buffer
, *currlen
, maxlen
, fconvert
[fplace
]);
823 DOPR_OUTCH(buffer
, *currlen
, maxlen
, ' ');
828 #endif /* !defined(HAVE_SNPRINTF) || !defined(HAVE_VSNPRINTF) */
830 #if !defined(HAVE_VSNPRINTF)
832 vsnprintf (char *str
, size_t count
, const char *fmt
, va_list args
)
834 return dopr(str
, count
, fmt
, args
);
838 #if !defined(HAVE_SNPRINTF)
840 snprintf(char *str
, size_t count
, SNPRINTF_CONST
char *fmt
, ...)
846 ret
= vsnprintf(str
, count
, fmt
, ap
);