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 **************************************************************/
60 #include <sys/types.h>
65 #define HAVE_STRING_H 1
66 #define HAVE_CTYPE_H 1
67 #define HAVE_STDLIB_H 1
69 #define HAVE_SNPRINTF 1
70 #define HAVE_VSNPRINTF 1
71 #define HAVE_C99_VSNPRINTF 1
73 #define HAVE_LONG_DOUBLE 1
74 #define HAVE_LONG_LONG 1
75 #define HAVE_SNPRINTF 1
76 #define HAVE_C99_VSNPRINTF 1
77 #define HAVE_ASPRINTF 1
78 #define HAVE_VASPRINTF 1
94 #include <sys/types.h>
100 #if defined(HAVE_SNPRINTF) && defined(HAVE_VSNPRINTF) && defined(HAVE_C99_VSNPRINTF)
101 /* only include stdio.h if we are not re-defining snprintf or vsnprintf */
103 /* make the compiler happy with an empty file */
104 void dummy_snprintf(void) {}
107 #ifdef HAVE_LONG_DOUBLE
108 #define LDOUBLE long double
110 #define LDOUBLE double
113 #ifdef HAVE_LONG_LONG
114 #define LLONG long long
119 static size_t dopr(char *buffer
, size_t maxlen
, const char *format
,
121 static void fmtstr(char *buffer
, size_t *currlen
, size_t maxlen
,
122 char *value
, int flags
, int min
, int max
);
123 static void fmtint(char *buffer
, size_t *currlen
, size_t maxlen
,
124 long value
, int base
, int min
, int max
, int flags
);
125 static void fmtfp(char *buffer
, size_t *currlen
, size_t maxlen
,
126 LDOUBLE fvalue
, int min
, int max
, int flags
);
127 static void dopr_outch(char *buffer
, size_t *currlen
, size_t maxlen
, char c
);
130 * dopr(): poor man's version of doprintf
133 /* format read states */
134 #define DP_S_DEFAULT 0
143 /* format flags - Bits */
144 #define DP_F_MINUS (1 << 0)
145 #define DP_F_PLUS (1 << 1)
146 #define DP_F_SPACE (1 << 2)
147 #define DP_F_NUM (1 << 3)
148 #define DP_F_ZERO (1 << 4)
149 #define DP_F_UP (1 << 5)
150 #define DP_F_UNSIGNED (1 << 6)
152 /* Conversion Flags */
155 #define DP_C_LDOUBLE 3
158 #define char_to_int(p) ((p)- '0')
160 #define MAX(p,q) (((p) >= (q)) ? (p) : (q))
163 static size_t dopr(char *buffer
, size_t maxlen
, const char *format
, va_list args
)
176 state
= DP_S_DEFAULT
;
177 currlen
= flags
= cflags
= min
= 0;
181 while (state
!= DP_S_DONE
) {
190 dopr_outch (buffer
, &currlen
, maxlen
, ch
);
221 if (isdigit((unsigned char)ch
)) {
222 min
= 10*min
+ char_to_int (ch
);
224 } else if (ch
== '*') {
225 min
= va_arg (args
, int);
241 if (isdigit((unsigned char)ch
)) {
244 max
= 10*max
+ char_to_int (ch
);
246 } else if (ch
== '*') {
247 max
= va_arg (args
, int);
263 if (ch
== 'l') { /* It's a long long */
269 cflags
= DP_C_LDOUBLE
;
281 if (cflags
== DP_C_SHORT
)
282 value
= va_arg (args
, int);
283 else if (cflags
== DP_C_LONG
)
284 value
= va_arg (args
, long int);
285 else if (cflags
== DP_C_LLONG
)
286 value
= va_arg (args
, LLONG
);
288 value
= va_arg (args
, int);
289 fmtint (buffer
, &currlen
, maxlen
, value
, 10, min
, max
, flags
);
292 flags
|= DP_F_UNSIGNED
;
293 if (cflags
== DP_C_SHORT
)
294 value
= va_arg (args
, unsigned int);
295 else if (cflags
== DP_C_LONG
)
296 value
= (long)va_arg (args
, unsigned long int);
297 else if (cflags
== DP_C_LLONG
)
298 value
= (long)va_arg (args
, unsigned LLONG
);
300 value
= (long)va_arg (args
, unsigned int);
301 fmtint (buffer
, &currlen
, maxlen
, value
, 8, min
, max
, flags
);
304 flags
|= DP_F_UNSIGNED
;
305 if (cflags
== DP_C_SHORT
)
306 value
= va_arg (args
, unsigned int);
307 else if (cflags
== DP_C_LONG
)
308 value
= (long)va_arg (args
, unsigned long int);
309 else if (cflags
== DP_C_LLONG
)
310 value
= (LLONG
)va_arg (args
, unsigned LLONG
);
312 value
= (long)va_arg (args
, unsigned int);
313 fmtint (buffer
, &currlen
, maxlen
, value
, 10, min
, max
, flags
);
318 flags
|= DP_F_UNSIGNED
;
319 if (cflags
== DP_C_SHORT
)
320 value
= va_arg (args
, unsigned int);
321 else if (cflags
== DP_C_LONG
)
322 value
= (long)va_arg (args
, unsigned long int);
323 else if (cflags
== DP_C_LLONG
)
324 value
= (LLONG
)va_arg (args
, unsigned LLONG
);
326 value
= (long)va_arg (args
, unsigned int);
327 fmtint (buffer
, &currlen
, maxlen
, value
, 16, min
, max
, flags
);
330 if (cflags
== DP_C_LDOUBLE
)
331 fvalue
= va_arg (args
, LDOUBLE
);
333 fvalue
= va_arg (args
, double);
334 /* um, floating point? */
335 fmtfp (buffer
, &currlen
, maxlen
, fvalue
, min
, max
, flags
);
340 if (cflags
== DP_C_LDOUBLE
)
341 fvalue
= va_arg (args
, LDOUBLE
);
343 fvalue
= va_arg (args
, double);
348 if (cflags
== DP_C_LDOUBLE
)
349 fvalue
= va_arg (args
, LDOUBLE
);
351 fvalue
= va_arg (args
, double);
354 dopr_outch (buffer
, &currlen
, maxlen
, va_arg (args
, int));
357 strvalue
= va_arg (args
, char *);
359 max
= strlen(strvalue
);
361 if (min
> 0 && max
>= 0 && min
> max
) max
= min
;
362 fmtstr (buffer
, &currlen
, maxlen
, strvalue
, flags
, min
, max
);
365 strvalue
= va_arg (args
, void *);
366 fmtint (buffer
, &currlen
, maxlen
, (long) strvalue
, 16, min
, max
, flags
);
369 if (cflags
== DP_C_SHORT
) {
371 num
= va_arg (args
, short int *);
373 } else if (cflags
== DP_C_LONG
) {
375 num
= va_arg (args
, long int *);
376 *num
= (long int)currlen
;
377 } else if (cflags
== DP_C_LLONG
) {
379 num
= va_arg (args
, LLONG
*);
380 *num
= (LLONG
)currlen
;
383 num
= va_arg (args
, int *);
388 dopr_outch (buffer
, &currlen
, maxlen
, ch
);
391 /* not supported yet, treat as next char */
399 state
= DP_S_DEFAULT
;
400 flags
= cflags
= min
= 0;
407 break; /* some picky compilers need this */
411 if (currlen
< maxlen
- 1)
412 buffer
[currlen
] = '\0';
414 buffer
[maxlen
- 1] = '\0';
420 static void fmtstr(char *buffer
, size_t *currlen
, size_t maxlen
,
421 char *value
, int flags
, int min
, int max
)
423 int padlen
, strln
; /* amount to pad */
426 #ifdef DEBUG_SNPRINTF
427 printf("fmtstr min=%d max=%d s=[%s]\n", min
, max
, value
);
433 for (strln
= 0; value
[strln
]; ++strln
); /* strlen */
434 padlen
= min
- strln
;
437 if (flags
& DP_F_MINUS
)
438 padlen
= -padlen
; /* Left Justify */
440 while ((padlen
> 0) && (cnt
< max
)) {
441 dopr_outch (buffer
, currlen
, maxlen
, ' ');
445 while (*value
&& (cnt
< max
)) {
446 dopr_outch (buffer
, currlen
, maxlen
, *value
++);
449 while ((padlen
< 0) && (cnt
< max
)) {
450 dopr_outch (buffer
, currlen
, maxlen
, ' ');
456 /* Have to handle DP_F_NUM (ie 0x and 0 alternates) */
458 static void fmtint(char *buffer
, size_t *currlen
, size_t maxlen
,
459 long value
, int base
, int min
, int max
, int flags
)
462 unsigned long uvalue
;
465 int spadlen
= 0; /* amount to space pad */
466 int zpadlen
= 0; /* amount to zero pad */
474 if(!(flags
& DP_F_UNSIGNED
)) {
479 if (flags
& DP_F_PLUS
) /* Do a sign (+/i) */
481 else if (flags
& DP_F_SPACE
)
486 if (flags
& DP_F_UP
) caps
= 1; /* Should characters be upper case? */
490 (caps
? "0123456789ABCDEF":"0123456789abcdef")
491 [uvalue
% (unsigned)base
];
492 uvalue
= (uvalue
/ (unsigned)base
);
493 } while(uvalue
&& (place
< 20));
494 if (place
== 20) place
--;
497 zpadlen
= max
- place
;
498 spadlen
= min
- MAX (max
, place
) - (signvalue
? 1 : 0);
499 if (zpadlen
< 0) zpadlen
= 0;
500 if (spadlen
< 0) spadlen
= 0;
501 if (flags
& DP_F_ZERO
) {
502 zpadlen
= MAX(zpadlen
, spadlen
);
505 if (flags
& DP_F_MINUS
)
506 spadlen
= -spadlen
; /* Left Justifty */
508 #ifdef DEBUG_SNPRINTF
509 printf("zpad: %d, spad: %d, min: %d, max: %d, place: %d\n",
510 zpadlen
, spadlen
, min
, max
, place
);
514 while (spadlen
> 0) {
515 dopr_outch (buffer
, currlen
, maxlen
, ' ');
521 dopr_outch (buffer
, currlen
, maxlen
, signvalue
);
525 while (zpadlen
> 0) {
526 dopr_outch (buffer
, currlen
, maxlen
, '0');
533 dopr_outch (buffer
, currlen
, maxlen
, convert
[--place
]);
535 /* Left Justified spaces */
536 while (spadlen
< 0) {
537 dopr_outch (buffer
, currlen
, maxlen
, ' ');
542 static LDOUBLE
abs_val(LDOUBLE value
)
544 LDOUBLE result
= value
;
552 static LDOUBLE
POW10(int exp
)
564 static LLONG
ROUND(LDOUBLE value
)
568 intpart
= (LLONG
)value
;
569 value
= value
- intpart
;
570 if (value
>= 0.5) intpart
++;
575 /* a replacement for modf that doesn't need the math library. Should
576 be portable, but slow */
577 static double my_modf(double x0
, double *iptr
)
584 for (i
=0;i
<100;i
++) {
586 if (l
<= (x
+1) && l
>= (x
-1)) break;
592 /* yikes! the number is beyond what we can handle. What do we do? */
601 ret
= my_modf(x0
-l
*f
, &i2
);
611 static void fmtfp (char *buffer
, size_t *currlen
, size_t maxlen
,
612 LDOUBLE fvalue
, int min
, int max
, int flags
)
620 int padlen
= 0; /* amount to pad */
629 * AIX manpage says the default is 0, but Solaris says the default
630 * is 6, and sprintf on AIX defaults to 6
635 ufvalue
= abs_val (fvalue
);
640 if (flags
& DP_F_PLUS
) { /* Do a sign (+/i) */
643 if (flags
& DP_F_SPACE
)
649 if (flags
& DP_F_UP
) caps
= 1; /* Should characters be upper case? */
653 if (max
== 0) ufvalue
+= 0.5; /* if max = 0 we must round */
657 * Sorry, we only support 16 digits past the decimal because of our
663 /* We "cheat" by converting the fractional part to integer by
664 * multiplying by a factor of 10
668 my_modf(temp
, &intpart
);
670 fracpart
= ROUND((POW10(max
)) * (ufvalue
- intpart
));
672 if (fracpart
>= POW10(max
)) {
674 fracpart
-= POW10(max
);
678 /* Convert integer part */
681 my_modf(intpart
*0.1, &intpart
);
683 index
= (int) ((temp
-intpart
+0.05)* 10.0);
684 /* index = (int) (((double)(temp*0.1) -intpart +0.05) *10.0); */
685 /* printf ("%llf, %f, %x\n", temp, intpart, index); */
687 (caps
? "0123456789ABCDEF":"0123456789abcdef")[index
];
688 } while (intpart
&& (iplace
< 311));
689 if (iplace
== 311) iplace
--;
690 iconvert
[iplace
] = 0;
692 /* Convert fractional part */
697 my_modf(fracpart
*0.1, &fracpart
);
699 index
= (int) ((temp
-fracpart
+0.05)* 10.0);
700 /* index = (int) ((((temp/10) -fracpart) +0.05) *10); */
701 /* printf ("%lf, %lf, %ld\n", temp, fracpart, index); */
703 (caps
? "0123456789ABCDEF":"0123456789abcdef")[index
];
704 } while(fracpart
&& (fplace
< 311));
705 if (fplace
== 311) fplace
--;
707 fconvert
[fplace
] = 0;
709 /* -1 for decimal point, another -1 if we are printing a sign */
710 padlen
= min
- iplace
- max
- 1 - ((signvalue
) ? 1 : 0);
711 zpadlen
= max
- fplace
;
712 if (zpadlen
< 0) zpadlen
= 0;
715 if (flags
& DP_F_MINUS
)
716 padlen
= -padlen
; /* Left Justifty */
718 if ((flags
& DP_F_ZERO
) && (padlen
> 0)) {
720 dopr_outch (buffer
, currlen
, maxlen
, signvalue
);
725 dopr_outch (buffer
, currlen
, maxlen
, '0');
730 dopr_outch (buffer
, currlen
, maxlen
, ' ');
734 dopr_outch (buffer
, currlen
, maxlen
, signvalue
);
737 dopr_outch (buffer
, currlen
, maxlen
, iconvert
[--iplace
]);
739 #ifdef DEBUG_SNPRINTF
740 printf("fmtfp: fplace=%d zpadlen=%d\n", fplace
, zpadlen
);
744 * Decimal point. This should probably use locale to find the correct
748 dopr_outch (buffer
, currlen
, maxlen
, '.');
751 dopr_outch (buffer
, currlen
, maxlen
, fconvert
[--fplace
]);
754 while (zpadlen
> 0) {
755 dopr_outch (buffer
, currlen
, maxlen
, '0');
760 dopr_outch (buffer
, currlen
, maxlen
, ' ');
765 static void dopr_outch(char *buffer
, size_t *currlen
, size_t maxlen
, char c
)
767 if (*currlen
< maxlen
) {
768 buffer
[(*currlen
)] = c
;
773 #if !defined(HAVE_VSNPRINTF) || !defined(HAVE_C99_VSNPRINTF)
774 int vsnprintf (char *str
, size_t count
, const char *fmt
, va_list args
)
776 return dopr(str
, count
, fmt
, args
);
780 #if !defined(HAVE_SNPRINTF) || !defined(HAVE_C99_VSNPRINTF)
781 int snprintf(char *str
,size_t count
,const char *fmt
,...)
787 ret
= vsnprintf(str
, count
, fmt
, ap
);
795 #ifndef HAVE_VASPRINTF
796 int vasprintf(char **ptr
, const char *format
, va_list ap
)
800 ret
= vsnprintf(NULL
, 0, format
, ap
);
801 if (ret
<= 0) return ret
;
803 (*ptr
) = (char *)io_calloc(1, ret
+1);
804 if (!*ptr
) return -1;
805 ret
= vsnprintf(*ptr
, ret
+1, format
, ap
);
812 #ifndef HAVE_ASPRINTF
813 int asprintf(char **ptr
, const char *format
, ...)
818 va_start(ap
, format
);
819 ret
= vasprintf(ptr
, format
, ap
);
828 int sprintf(char *str
,const char *fmt
,...);
852 double fp_nums
[] = { 6442452944.1234, -1.5, 134.21, 91340.2, 341.1234, 0203.9, 0.96, 0.996,
853 0.9996, 1.996, 4.136, 0};
867 long int_nums
[] = { -1, 134, 91340, 341, 0203, 0};
881 char *str_vals
[] = {"hello", "a", "", "a longer string", NULL
};
886 printf ("Testing snprintf format codes against system sprintf...\n");
888 for (x
= 0; fp_fmt
[x
] ; x
++) {
889 for (y
= 0; fp_nums
[y
] != 0 ; y
++) {
890 int l1
= snprintf(NULL
, 0, fp_fmt
[x
], fp_nums
[y
]);
891 int l2
= snprintf(buf1
, sizeof(buf1
), fp_fmt
[x
], fp_nums
[y
]);
892 sprintf (buf2
, fp_fmt
[x
], fp_nums
[y
]);
893 if (strcmp (buf1
, buf2
)) {
894 printf("snprintf doesn't match Format: %s\n\tsnprintf = [%s]\n\t sprintf = [%s]\n",
895 fp_fmt
[x
], buf1
, buf2
);
899 printf("snprintf l1 != l2 (%d %d) %s\n", l1
, l2
, fp_fmt
[x
]);
906 for (x
= 0; int_fmt
[x
] ; x
++) {
907 for (y
= 0; int_nums
[y
] != 0 ; y
++) {
908 int l1
= snprintf(NULL
, 0, int_fmt
[x
], int_nums
[y
]);
909 int l2
= snprintf(buf1
, sizeof(buf1
), int_fmt
[x
], int_nums
[y
]);
910 sprintf (buf2
, int_fmt
[x
], int_nums
[y
]);
911 if (strcmp (buf1
, buf2
)) {
912 printf("snprintf doesn't match Format: %s\n\tsnprintf = [%s]\n\t sprintf = [%s]\n",
913 int_fmt
[x
], buf1
, buf2
);
917 printf("snprintf l1 != l2 (%d %d) %s\n", l1
, l2
, int_fmt
[x
]);
924 for (x
= 0; str_fmt
[x
] ; x
++) {
925 for (y
= 0; str_vals
[y
] != 0 ; y
++) {
926 int l1
= snprintf(NULL
, 0, str_fmt
[x
], str_vals
[y
]);
927 int l2
= snprintf(buf1
, sizeof(buf1
), str_fmt
[x
], str_vals
[y
]);
928 sprintf (buf2
, str_fmt
[x
], str_vals
[y
]);
929 if (strcmp (buf1
, buf2
)) {
930 printf("snprintf doesn't match Format: %s\n\tsnprintf = [%s]\n\t sprintf = [%s]\n",
931 str_fmt
[x
], buf1
, buf2
);
935 printf("snprintf l1 != l2 (%d %d) %s\n", l1
, l2
, str_fmt
[x
]);
942 printf ("%d tests failed out of %d.\n", fail
, num
);
944 printf("seeing how many digits we support\n");
946 double v0
= 0.12345678901234567890123456789012345678901;
947 for (x
=0; x
<100; x
++) {
948 snprintf(buf1
, sizeof(buf1
), "%1.1f", v0
*pow(10, x
));
949 sprintf(buf2
, "%1.1f", v0
*pow(10, x
));
950 if (strcmp(buf1
, buf2
)) {
951 printf("we seem to support %d digits\n", x
-1);
959 #endif /* SNPRINTF_TEST */