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 **************************************************************/
58 #ifndef NO_CONFIG_H /* for some tests */
64 #ifdef TEST_SNPRINTF /* need math library headers for testing */
78 #include <sys/types.h>
84 #if defined(HAVE_SNPRINTF) && defined(HAVE_VSNPRINTF) && defined(HAVE_C99_VSNPRINTF)
85 /* only include stdio.h if we are not re-defining snprintf or vsnprintf */
87 /* make the compiler happy with an empty file */
88 void dummy_snprintf(void) {}
91 #ifdef HAVE_LONG_DOUBLE
92 #define LDOUBLE long double
94 #define LDOUBLE double
98 #define LLONG long long
103 /* free memory if the pointer is valid and zero the pointer */
105 #define SAFE_FREE(x) do { if ((x) != NULL) {free((x)); (x)=NULL;} } while(0)
110 #define VA_COPY(dest, src) __va_copy(dest, src)
112 #define VA_COPY(dest, src) (dest) = (src)
116 static size_t dopr(char *buffer, size_t maxlen, const char *format,
118 static void fmtstr(char *buffer, size_t *currlen, size_t maxlen,
119 char *value, int flags, int min, int max);
120 static void fmtint(char *buffer, size_t *currlen, size_t maxlen,
121 long value, int base, int min, int max, int flags);
122 static void fmtfp(char *buffer, size_t *currlen, size_t maxlen,
123 LDOUBLE fvalue, int min, int max, int flags);
124 static void dopr_outch(char *buffer, size_t *currlen, size_t maxlen, char c);
127 * dopr(): poor man's version of doprintf
130 /* format read states */
131 #define DP_S_DEFAULT 0
140 /* format flags - Bits */
141 #define DP_F_MINUS (1 << 0)
142 #define DP_F_PLUS (1 << 1)
143 #define DP_F_SPACE (1 << 2)
144 #define DP_F_NUM (1 << 3)
145 #define DP_F_ZERO (1 << 4)
146 #define DP_F_UP (1 << 5)
147 #define DP_F_UNSIGNED (1 << 6)
149 /* Conversion Flags */
152 #define DP_C_LDOUBLE 3
155 #define char_to_int(p) ((p)- '0')
157 #define MAX(p,q) (((p) >= (q)) ? (p) : (q))
160 static size_t dopr(char *buffer, size_t maxlen, const char *format, va_list args_in)
174 VA_COPY(args, args_in);
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);
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);
356 dopr_outch (buffer, &currlen, maxlen, va_arg (args, int));
359 strvalue = va_arg (args, char *);
360 if (!strvalue) strvalue = "(NULL)";
362 max = strlen(strvalue);
364 if (min > 0 && max >= 0 && min > max) max = min;
365 fmtstr (buffer, &currlen, maxlen, strvalue, flags, min, max);
368 strvalue = va_arg (args, void *);
369 fmtint (buffer, &currlen, maxlen, (long) strvalue, 16, min, max, flags);
372 if (cflags == DP_C_SHORT) {
374 num = va_arg (args, short int *);
376 } else if (cflags == DP_C_LONG) {
378 num = va_arg (args, long int *);
379 *num = (long int)currlen;
380 } else if (cflags == DP_C_LLONG) {
382 num = va_arg (args, LLONG *);
383 *num = (LLONG)currlen;
386 num = va_arg (args, int *);
391 dopr_outch (buffer, &currlen, maxlen, ch);
394 /* not supported yet, treat as next char */
402 state = DP_S_DEFAULT;
403 flags = cflags = min = 0;
410 break; /* some picky compilers need this */
414 if (currlen < maxlen - 1)
415 buffer[currlen] = '\0';
417 buffer[maxlen - 1] = '\0';
423 static void fmtstr(char *buffer, size_t *currlen, size_t maxlen,
424 char *value, int flags, int min, int max)
426 int padlen, strln; /* amount to pad */
429 #ifdef DEBUG_SNPRINTF
430 printf("fmtstr min=%d max=%d s=[%s]\n", min, max, value);
436 for (strln = 0; value[strln]; ++strln); /* strlen */
437 padlen = min - strln;
440 if (flags & DP_F_MINUS)
441 padlen = -padlen; /* Left Justify */
443 while ((padlen > 0) && (cnt < max)) {
444 dopr_outch (buffer, currlen, maxlen, ' ');
448 while (*value && (cnt < max)) {
449 dopr_outch (buffer, currlen, maxlen, *value++);
452 while ((padlen < 0) && (cnt < max)) {
453 dopr_outch (buffer, currlen, maxlen, ' ');
459 /* Have to handle DP_F_NUM (ie 0x and 0 alternates) */
461 static void fmtint(char *buffer, size_t *currlen, size_t maxlen,
462 long value, int base, int min, int max, int flags)
465 unsigned long uvalue;
468 int spadlen = 0; /* amount to space pad */
469 int zpadlen = 0; /* amount to zero pad */
477 if(!(flags & DP_F_UNSIGNED)) {
482 if (flags & DP_F_PLUS) /* Do a sign (+/i) */
484 else if (flags & DP_F_SPACE)
489 if (flags & DP_F_UP) caps = 1; /* Should characters be upper case? */
493 (caps? "0123456789ABCDEF":"0123456789abcdef")
494 [uvalue % (unsigned)base ];
495 uvalue = (uvalue / (unsigned)base );
496 } while(uvalue && (place < 20));
497 if (place == 20) place--;
500 zpadlen = max - place;
501 spadlen = min - MAX (max, place) - (signvalue ? 1 : 0);
502 if (zpadlen < 0) zpadlen = 0;
503 if (spadlen < 0) spadlen = 0;
504 if (flags & DP_F_ZERO) {
505 zpadlen = MAX(zpadlen, spadlen);
508 if (flags & DP_F_MINUS)
509 spadlen = -spadlen; /* Left Justifty */
511 #ifdef DEBUG_SNPRINTF
512 printf("zpad: %d, spad: %d, min: %d, max: %d, place: %d\n",
513 zpadlen, spadlen, min, max, place);
517 while (spadlen > 0) {
518 dopr_outch (buffer, currlen, maxlen, ' ');
524 dopr_outch (buffer, currlen, maxlen, signvalue);
528 while (zpadlen > 0) {
529 dopr_outch (buffer, currlen, maxlen, '0');
536 dopr_outch (buffer, currlen, maxlen, convert[--place]);
538 /* Left Justified spaces */
539 while (spadlen < 0) {
540 dopr_outch (buffer, currlen, maxlen, ' ');
545 static LDOUBLE abs_val(LDOUBLE value)
547 LDOUBLE result = value;
555 static LDOUBLE POW10(int exp)
567 static LLONG ROUND(LDOUBLE value)
571 intpart = (LLONG)value;
572 value = value - intpart;
573 if (value >= 0.5) intpart++;
578 /* a replacement for modf that doesn't need the math library. Should
579 be portable, but slow */
580 static double my_modf(double x0, double *iptr)
587 for (i=0;i<100;i++) {
589 if (l <= (x+1) && l >= (x-1)) break;
595 /* yikes! the number is beyond what we can handle. What do we do? */
604 ret = my_modf(x0-l*f, &i2);
614 static void fmtfp (char *buffer, size_t *currlen, size_t maxlen,
615 LDOUBLE fvalue, int min, int max, int flags)
623 int padlen = 0; /* amount to pad */
632 * AIX manpage says the default is 0, but Solaris says the default
633 * is 6, and sprintf on AIX defaults to 6
638 ufvalue = abs_val (fvalue);
643 if (flags & DP_F_PLUS) { /* Do a sign (+/i) */
646 if (flags & DP_F_SPACE)
652 if (flags & DP_F_UP) caps = 1; /* Should characters be upper case? */
656 if (max == 0) ufvalue += 0.5; /* if max = 0 we must round */
660 * Sorry, we only support 16 digits past the decimal because of our
666 /* We "cheat" by converting the fractional part to integer by
667 * multiplying by a factor of 10
671 my_modf(temp, &intpart);
673 fracpart = ROUND((POW10(max)) * (ufvalue - intpart));
675 if (fracpart >= POW10(max)) {
677 fracpart -= POW10(max);
681 /* Convert integer part */
684 my_modf(temp, &intpart);
685 index = (int) ((temp -intpart +0.05)* 10.0);
686 /* index = (int) (((double)(temp*0.1) -intpart +0.05) *10.0); */
687 /* printf ("%llf, %f, %x\n", temp, intpart, index); */
689 (caps? "0123456789ABCDEF":"0123456789abcdef")[index];
690 } while (intpart && (iplace < 311));
691 if (iplace == 311) iplace--;
692 iconvert[iplace] = 0;
694 /* Convert fractional part */
699 my_modf(temp, &fracpart);
700 index = (int) ((temp -fracpart +0.05)* 10.0);
701 /* index = (int) ((((temp/10) -fracpart) +0.05) *10); */
702 /* printf ("%lf, %lf, %ld\n", temp, fracpart, index); */
704 (caps? "0123456789ABCDEF":"0123456789abcdef")[index];
705 } while(fracpart && (fplace < 311));
706 if (fplace == 311) fplace--;
708 fconvert[fplace] = 0;
710 /* -1 for decimal point, another -1 if we are printing a sign */
711 padlen = min - iplace - max - 1 - ((signvalue) ? 1 : 0);
712 zpadlen = max - fplace;
713 if (zpadlen < 0) zpadlen = 0;
716 if (flags & DP_F_MINUS)
717 padlen = -padlen; /* Left Justifty */
719 if ((flags & DP_F_ZERO) && (padlen > 0)) {
721 dopr_outch (buffer, currlen, maxlen, signvalue);
726 dopr_outch (buffer, currlen, maxlen, '0');
731 dopr_outch (buffer, currlen, maxlen, ' ');
735 dopr_outch (buffer, currlen, maxlen, signvalue);
738 dopr_outch (buffer, currlen, maxlen, iconvert[--iplace]);
740 #ifdef DEBUG_SNPRINTF
741 printf("fmtfp: fplace=%d zpadlen=%d\n", fplace, zpadlen);
745 * Decimal point. This should probably use locale to find the correct
749 dopr_outch (buffer, currlen, maxlen, '.');
751 while (zpadlen > 0) {
752 dopr_outch (buffer, currlen, maxlen, '0');
757 dopr_outch (buffer, currlen, maxlen, fconvert[--fplace]);
761 dopr_outch (buffer, currlen, maxlen, ' ');
766 static void dopr_outch(char *buffer, size_t *currlen, size_t maxlen, char c)
768 if (*currlen < maxlen) {
769 buffer[(*currlen)] = c;
774 /* yes this really must be a ||. Don't muck with this (tridge) */
775 #if !defined(HAVE_VSNPRINTF) || !defined(HAVE_C99_VSNPRINTF)
776 int vsnprintf (char *str, size_t count, const char *fmt, va_list args)
778 return dopr(str, count, fmt, args);
782 /* yes this really must be a ||. Don't muck wiith this (tridge)
784 * The logic for these two is that we need our own definition if the
785 * OS *either* has no definition of *sprintf, or if it does have one
786 * that doesn't work properly according to the autoconf test. Perhaps
787 * these should really be smb_snprintf to avoid conflicts with buggy
790 #if !defined(HAVE_SNPRINTF) || !defined(HAVE_C99_SNPRINTF)
791 int snprintf(char *str,size_t count,const char *fmt,...)
797 ret = vsnprintf(str, count, fmt, ap);
805 #ifndef HAVE_VASPRINTF
806 int vasprintf(char **ptr, const char *format, va_list ap)
813 ret = vsnprintf(NULL, 0, format, ap2);
814 if (ret <= 0) return ret;
816 (*ptr) = (char *)malloc(ret+1);
817 if (!*ptr) return -1;
821 ret = vsnprintf(*ptr, ret+1, format, ap2);
828 #ifndef HAVE_ASPRINTF
829 int asprintf(char **ptr, const char *format, ...)
835 va_start(ap, format);
836 ret = vasprintf(ptr, format, ap);
845 int sprintf(char *str,const char *fmt,...);
869 double fp_nums[] = { 6442452944.1234, -1.5, 134.21, 91340.2, 341.1234, 0203.9, 0.96, 0.996,
870 0.9996, 1.996, 4.136, 5.030201, 0};
884 long int_nums[] = { -1, 134, 91340, 341, 0203, 0};
898 char *str_vals[] = {"hello", "a", "", "a longer string", NULL};
903 printf ("Testing snprintf format codes against system sprintf...\n");
905 for (x = 0; fp_fmt[x] ; x++) {
906 for (y = 0; fp_nums[y] != 0 ; y++) {
907 int l1 = snprintf(NULL, 0, fp_fmt[x], fp_nums[y]);
908 int l2 = snprintf(buf1, sizeof(buf1), fp_fmt[x], fp_nums[y]);
909 sprintf (buf2, fp_fmt[x], fp_nums[y]);
910 if (strcmp (buf1, buf2)) {
911 printf("snprintf doesn't match Format: %s\n\tsnprintf = [%s]\n\t sprintf = [%s]\n",
912 fp_fmt[x], buf1, buf2);
916 printf("snprintf l1 != l2 (%d %d) %s\n", l1, l2, fp_fmt[x]);
923 for (x = 0; int_fmt[x] ; x++) {
924 for (y = 0; int_nums[y] != 0 ; y++) {
925 int l1 = snprintf(NULL, 0, int_fmt[x], int_nums[y]);
926 int l2 = snprintf(buf1, sizeof(buf1), int_fmt[x], int_nums[y]);
927 sprintf (buf2, int_fmt[x], int_nums[y]);
928 if (strcmp (buf1, buf2)) {
929 printf("snprintf doesn't match Format: %s\n\tsnprintf = [%s]\n\t sprintf = [%s]\n",
930 int_fmt[x], buf1, buf2);
934 printf("snprintf l1 != l2 (%d %d) %s\n", l1, l2, int_fmt[x]);
941 for (x = 0; str_fmt[x] ; x++) {
942 for (y = 0; str_vals[y] != 0 ; y++) {
943 int l1 = snprintf(NULL, 0, str_fmt[x], str_vals[y]);
944 int l2 = snprintf(buf1, sizeof(buf1), str_fmt[x], str_vals[y]);
945 sprintf (buf2, str_fmt[x], str_vals[y]);
946 if (strcmp (buf1, buf2)) {
947 printf("snprintf doesn't match Format: %s\n\tsnprintf = [%s]\n\t sprintf = [%s]\n",
948 str_fmt[x], buf1, buf2);
952 printf("snprintf l1 != l2 (%d %d) %s\n", l1, l2, str_fmt[x]);
959 printf ("%d tests failed out of %d.\n", fail, num);
961 printf("seeing how many digits we support\n");
963 double v0 = 0.12345678901234567890123456789012345678901;
964 for (x=0; x<100; x++) {
965 double p = pow(10, x);
967 snprintf(buf1, sizeof(buf1), "%1.1f", r);
968 sprintf(buf2, "%1.1f", r);
969 if (strcmp(buf1, buf2)) {
970 printf("we seem to support %d digits\n", x-1);
978 #endif /* SNPRINTF_TEST */