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 */
72 #include <sys/types.h>
78 #if defined(HAVE_SNPRINTF) && defined(HAVE_VSNPRINTF) && defined(HAVE_C99_VSNPRINTF)
79 /* only include stdio.h if we are not re-defining snprintf or vsnprintf */
81 /* make the compiler happy with an empty file */
82 void dummy_snprintf(void) {}
85 #ifdef HAVE_LONG_DOUBLE
86 #define LDOUBLE long double
88 #define LDOUBLE double
92 #define LLONG long long
97 static size_t dopr(char *buffer, size_t maxlen, const char *format,
99 static void fmtstr(char *buffer, size_t *currlen, size_t maxlen,
100 char *value, int flags, int min, int max);
101 static void fmtint(char *buffer, size_t *currlen, size_t maxlen,
102 long value, int base, int min, int max, int flags);
103 static void fmtfp(char *buffer, size_t *currlen, size_t maxlen,
104 LDOUBLE fvalue, int min, int max, int flags);
105 static void dopr_outch(char *buffer, size_t *currlen, size_t maxlen, char c);
108 * dopr(): poor man's version of doprintf
111 /* format read states */
112 #define DP_S_DEFAULT 0
121 /* format flags - Bits */
122 #define DP_F_MINUS (1 << 0)
123 #define DP_F_PLUS (1 << 1)
124 #define DP_F_SPACE (1 << 2)
125 #define DP_F_NUM (1 << 3)
126 #define DP_F_ZERO (1 << 4)
127 #define DP_F_UP (1 << 5)
128 #define DP_F_UNSIGNED (1 << 6)
130 /* Conversion Flags */
133 #define DP_C_LDOUBLE 3
136 #define char_to_int(p) ((p)- '0')
138 #define MAX(p,q) (((p) >= (q)) ? (p) : (q))
141 static size_t dopr(char *buffer, size_t maxlen, const char *format, va_list args)
154 state = DP_S_DEFAULT;
155 currlen = flags = cflags = min = 0;
159 while (state != DP_S_DONE) {
168 dopr_outch (buffer, &currlen, maxlen, ch);
199 if (isdigit((unsigned char)ch)) {
200 min = 10*min + char_to_int (ch);
202 } else if (ch == '*') {
203 min = va_arg (args, int);
219 if (isdigit((unsigned char)ch)) {
222 max = 10*max + char_to_int (ch);
224 } else if (ch == '*') {
225 max = va_arg (args, int);
241 if (ch == 'l') { /* It's a long long */
247 cflags = DP_C_LDOUBLE;
259 if (cflags == DP_C_SHORT)
260 value = va_arg (args, int);
261 else if (cflags == DP_C_LONG)
262 value = va_arg (args, long int);
263 else if (cflags == DP_C_LLONG)
264 value = va_arg (args, LLONG);
266 value = va_arg (args, int);
267 fmtint (buffer, &currlen, maxlen, value, 10, min, max, flags);
270 flags |= DP_F_UNSIGNED;
271 if (cflags == DP_C_SHORT)
272 value = va_arg (args, unsigned int);
273 else if (cflags == DP_C_LONG)
274 value = (long)va_arg (args, unsigned long int);
275 else if (cflags == DP_C_LLONG)
276 value = (long)va_arg (args, unsigned LLONG);
278 value = (long)va_arg (args, unsigned int);
279 fmtint (buffer, &currlen, maxlen, value, 8, min, max, flags);
282 flags |= DP_F_UNSIGNED;
283 if (cflags == DP_C_SHORT)
284 value = va_arg (args, unsigned int);
285 else if (cflags == DP_C_LONG)
286 value = (long)va_arg (args, unsigned long int);
287 else if (cflags == DP_C_LLONG)
288 value = (LLONG)va_arg (args, unsigned LLONG);
290 value = (long)va_arg (args, unsigned int);
291 fmtint (buffer, &currlen, maxlen, value, 10, min, max, flags);
296 flags |= DP_F_UNSIGNED;
297 if (cflags == DP_C_SHORT)
298 value = va_arg (args, unsigned int);
299 else if (cflags == DP_C_LONG)
300 value = (long)va_arg (args, unsigned long int);
301 else if (cflags == DP_C_LLONG)
302 value = (LLONG)va_arg (args, unsigned LLONG);
304 value = (long)va_arg (args, unsigned int);
305 fmtint (buffer, &currlen, maxlen, value, 16, min, max, flags);
308 if (cflags == DP_C_LDOUBLE)
309 fvalue = va_arg (args, LDOUBLE);
311 fvalue = va_arg (args, double);
312 /* um, floating point? */
313 fmtfp (buffer, &currlen, maxlen, fvalue, min, max, flags);
318 if (cflags == DP_C_LDOUBLE)
319 fvalue = va_arg (args, LDOUBLE);
321 fvalue = va_arg (args, double);
326 if (cflags == DP_C_LDOUBLE)
327 fvalue = va_arg (args, LDOUBLE);
329 fvalue = va_arg (args, double);
332 dopr_outch (buffer, &currlen, maxlen, va_arg (args, int));
335 strvalue = va_arg (args, char *);
337 max = strlen(strvalue);
339 if (min > 0 && max >= 0 && min > max) max = min;
340 fmtstr (buffer, &currlen, maxlen, strvalue, flags, min, max);
343 strvalue = va_arg (args, void *);
344 fmtint (buffer, &currlen, maxlen, (long) strvalue, 16, min, max, flags);
347 if (cflags == DP_C_SHORT) {
349 num = va_arg (args, short int *);
351 } else if (cflags == DP_C_LONG) {
353 num = va_arg (args, long int *);
354 *num = (long int)currlen;
355 } else if (cflags == DP_C_LLONG) {
357 num = va_arg (args, LLONG *);
358 *num = (LLONG)currlen;
361 num = va_arg (args, int *);
366 dopr_outch (buffer, &currlen, maxlen, ch);
369 /* not supported yet, treat as next char */
377 state = DP_S_DEFAULT;
378 flags = cflags = min = 0;
385 break; /* some picky compilers need this */
389 if (currlen < maxlen - 1)
390 buffer[currlen] = '\0';
392 buffer[maxlen - 1] = '\0';
398 static void fmtstr(char *buffer, size_t *currlen, size_t maxlen,
399 char *value, int flags, int min, int max)
401 int padlen, strln; /* amount to pad */
404 #ifdef DEBUG_SNPRINTF
405 printf("fmtstr min=%d max=%d s=[%s]\n", min, max, value);
411 for (strln = 0; value[strln]; ++strln); /* strlen */
412 padlen = min - strln;
415 if (flags & DP_F_MINUS)
416 padlen = -padlen; /* Left Justify */
418 while ((padlen > 0) && (cnt < max)) {
419 dopr_outch (buffer, currlen, maxlen, ' ');
423 while (*value && (cnt < max)) {
424 dopr_outch (buffer, currlen, maxlen, *value++);
427 while ((padlen < 0) && (cnt < max)) {
428 dopr_outch (buffer, currlen, maxlen, ' ');
434 /* Have to handle DP_F_NUM (ie 0x and 0 alternates) */
436 static void fmtint(char *buffer, size_t *currlen, size_t maxlen,
437 long value, int base, int min, int max, int flags)
440 unsigned long uvalue;
443 int spadlen = 0; /* amount to space pad */
444 int zpadlen = 0; /* amount to zero pad */
452 if(!(flags & DP_F_UNSIGNED)) {
457 if (flags & DP_F_PLUS) /* Do a sign (+/i) */
459 else if (flags & DP_F_SPACE)
464 if (flags & DP_F_UP) caps = 1; /* Should characters be upper case? */
468 (caps? "0123456789ABCDEF":"0123456789abcdef")
469 [uvalue % (unsigned)base ];
470 uvalue = (uvalue / (unsigned)base );
471 } while(uvalue && (place < 20));
472 if (place == 20) place--;
475 zpadlen = max - place;
476 spadlen = min - MAX (max, place) - (signvalue ? 1 : 0);
477 if (zpadlen < 0) zpadlen = 0;
478 if (spadlen < 0) spadlen = 0;
479 if (flags & DP_F_ZERO) {
480 zpadlen = MAX(zpadlen, spadlen);
483 if (flags & DP_F_MINUS)
484 spadlen = -spadlen; /* Left Justifty */
486 #ifdef DEBUG_SNPRINTF
487 printf("zpad: %d, spad: %d, min: %d, max: %d, place: %d\n",
488 zpadlen, spadlen, min, max, place);
492 while (spadlen > 0) {
493 dopr_outch (buffer, currlen, maxlen, ' ');
499 dopr_outch (buffer, currlen, maxlen, signvalue);
503 while (zpadlen > 0) {
504 dopr_outch (buffer, currlen, maxlen, '0');
511 dopr_outch (buffer, currlen, maxlen, convert[--place]);
513 /* Left Justified spaces */
514 while (spadlen < 0) {
515 dopr_outch (buffer, currlen, maxlen, ' ');
520 static LDOUBLE abs_val(LDOUBLE value)
522 LDOUBLE result = value;
530 static LDOUBLE POW10(int exp)
542 static LLONG ROUND(LDOUBLE value)
546 intpart = (LLONG)value;
547 value = value - intpart;
548 if (value >= 0.5) intpart++;
553 /* a replacement for modf that doesn't need the math library. Should
554 be portable, but slow */
555 static double my_modf(double x0, double *iptr)
562 for (i=0;i<100;i++) {
564 if (l <= (x+1) && l >= (x-1)) break;
570 /* yikes! the number is beyond what we can handle. What do we do? */
579 ret = my_modf(x0-l*f, &i2);
589 static void fmtfp (char *buffer, size_t *currlen, size_t maxlen,
590 LDOUBLE fvalue, int min, int max, int flags)
598 int padlen = 0; /* amount to pad */
607 * AIX manpage says the default is 0, but Solaris says the default
608 * is 6, and sprintf on AIX defaults to 6
613 ufvalue = abs_val (fvalue);
618 if (flags & DP_F_PLUS) { /* Do a sign (+/i) */
621 if (flags & DP_F_SPACE)
627 if (flags & DP_F_UP) caps = 1; /* Should characters be upper case? */
631 if (max == 0) ufvalue += 0.5; /* if max = 0 we must round */
635 * Sorry, we only support 16 digits past the decimal because of our
641 /* We "cheat" by converting the fractional part to integer by
642 * multiplying by a factor of 10
646 my_modf(temp, &intpart);
648 fracpart = ROUND((POW10(max)) * (ufvalue - intpart));
650 if (fracpart >= POW10(max)) {
652 fracpart -= POW10(max);
656 /* Convert integer part */
659 my_modf(intpart*0.1, &intpart);
661 index = (int) ((temp -intpart +0.05)* 10.0);
662 /* index = (int) (((double)(temp*0.1) -intpart +0.05) *10.0); */
663 /* printf ("%llf, %f, %x\n", temp, intpart, index); */
665 (caps? "0123456789ABCDEF":"0123456789abcdef")[index];
666 } while (intpart && (iplace < 311));
667 if (iplace == 311) iplace--;
668 iconvert[iplace] = 0;
670 /* Convert fractional part */
675 my_modf(fracpart*0.1, &fracpart);
677 index = (int) ((temp -fracpart +0.05)* 10.0);
678 /* index = (int) ((((temp/10) -fracpart) +0.05) *10); */
679 /* printf ("%lf, %lf, %ld\n", temp, fracpart, index); */
681 (caps? "0123456789ABCDEF":"0123456789abcdef")[index];
682 } while(fracpart && (fplace < 311));
683 if (fplace == 311) fplace--;
685 fconvert[fplace] = 0;
687 /* -1 for decimal point, another -1 if we are printing a sign */
688 padlen = min - iplace - max - 1 - ((signvalue) ? 1 : 0);
689 zpadlen = max - fplace;
690 if (zpadlen < 0) zpadlen = 0;
693 if (flags & DP_F_MINUS)
694 padlen = -padlen; /* Left Justifty */
696 if ((flags & DP_F_ZERO) && (padlen > 0)) {
698 dopr_outch (buffer, currlen, maxlen, signvalue);
703 dopr_outch (buffer, currlen, maxlen, '0');
708 dopr_outch (buffer, currlen, maxlen, ' ');
712 dopr_outch (buffer, currlen, maxlen, signvalue);
715 dopr_outch (buffer, currlen, maxlen, iconvert[--iplace]);
717 #ifdef DEBUG_SNPRINTF
718 printf("fmtfp: fplace=%d zpadlen=%d\n", fplace, zpadlen);
722 * Decimal point. This should probably use locale to find the correct
726 dopr_outch (buffer, currlen, maxlen, '.');
729 dopr_outch (buffer, currlen, maxlen, fconvert[--fplace]);
732 while (zpadlen > 0) {
733 dopr_outch (buffer, currlen, maxlen, '0');
738 dopr_outch (buffer, currlen, maxlen, ' ');
743 static void dopr_outch(char *buffer, size_t *currlen, size_t maxlen, char c)
745 if (*currlen < maxlen) {
746 buffer[(*currlen)] = c;
751 #if !defined(HAVE_VSNPRINTF) || !defined(HAVE_C99_VSNPRINTF)
752 int vsnprintf (char *str, size_t count, const char *fmt, va_list args)
754 return dopr(str, count, fmt, args);
758 #if !defined(HAVE_SNPRINTF) || !defined(HAVE_C99_VSNPRINTF)
759 int snprintf(char *str,size_t count,const char *fmt,...)
765 ret = vsnprintf(str, count, fmt, ap);
773 #ifndef HAVE_VASPRINTF
774 int vasprintf(char **ptr, const char *format, va_list ap)
778 ret = vsnprintf(NULL, 0, format, ap);
779 if (ret <= 0) return ret;
781 (*ptr) = (char *)malloc(ret+1);
782 if (!*ptr) return -1;
783 ret = vsnprintf(*ptr, ret+1, format, ap);
790 #ifndef HAVE_ASPRINTF
791 int asprintf(char **ptr, const char *format, ...)
796 va_start(ap, format);
797 ret = vasprintf(ptr, format, ap);
806 int sprintf(char *str,const char *fmt,...);
830 double fp_nums[] = { 6442452944.1234, -1.5, 134.21, 91340.2, 341.1234, 0203.9, 0.96, 0.996,
831 0.9996, 1.996, 4.136, 0};
845 long int_nums[] = { -1, 134, 91340, 341, 0203, 0};
859 char *str_vals[] = {"hello", "a", "", "a longer string", NULL};
864 printf ("Testing snprintf format codes against system sprintf...\n");
866 for (x = 0; fp_fmt[x] ; x++) {
867 for (y = 0; fp_nums[y] != 0 ; y++) {
868 int l1 = snprintf(NULL, 0, fp_fmt[x], fp_nums[y]);
869 int l2 = snprintf(buf1, sizeof(buf1), fp_fmt[x], fp_nums[y]);
870 sprintf (buf2, fp_fmt[x], fp_nums[y]);
871 if (strcmp (buf1, buf2)) {
872 printf("snprintf doesn't match Format: %s\n\tsnprintf = [%s]\n\t sprintf = [%s]\n",
873 fp_fmt[x], buf1, buf2);
877 printf("snprintf l1 != l2 (%d %d) %s\n", l1, l2, fp_fmt[x]);
884 for (x = 0; int_fmt[x] ; x++) {
885 for (y = 0; int_nums[y] != 0 ; y++) {
886 int l1 = snprintf(NULL, 0, int_fmt[x], int_nums[y]);
887 int l2 = snprintf(buf1, sizeof(buf1), int_fmt[x], int_nums[y]);
888 sprintf (buf2, int_fmt[x], int_nums[y]);
889 if (strcmp (buf1, buf2)) {
890 printf("snprintf doesn't match Format: %s\n\tsnprintf = [%s]\n\t sprintf = [%s]\n",
891 int_fmt[x], buf1, buf2);
895 printf("snprintf l1 != l2 (%d %d) %s\n", l1, l2, int_fmt[x]);
902 for (x = 0; str_fmt[x] ; x++) {
903 for (y = 0; str_vals[y] != 0 ; y++) {
904 int l1 = snprintf(NULL, 0, str_fmt[x], str_vals[y]);
905 int l2 = snprintf(buf1, sizeof(buf1), str_fmt[x], str_vals[y]);
906 sprintf (buf2, str_fmt[x], str_vals[y]);
907 if (strcmp (buf1, buf2)) {
908 printf("snprintf doesn't match Format: %s\n\tsnprintf = [%s]\n\t sprintf = [%s]\n",
909 str_fmt[x], buf1, buf2);
913 printf("snprintf l1 != l2 (%d %d) %s\n", l1, l2, str_fmt[x]);
920 printf ("%d tests failed out of %d.\n", fail, num);
922 printf("seeing how many digits we support\n");
924 double v0 = 0.12345678901234567890123456789012345678901;
925 for (x=0; x<100; x++) {
926 snprintf(buf1, sizeof(buf1), "%1.1f", v0*pow(10, x));
927 sprintf(buf2, "%1.1f", v0*pow(10, x));
928 if (strcmp(buf1, buf2)) {
929 printf("we seem to support %d digits\n", x-1);
937 #endif /* SNPRINTF_TEST */