1 /**************************************************************
3 * Patrick Powell Tue Apr 11 09:48:21 PDT 1995
4 * A bombproof version of doprnt (dopr) included.
5 * Sigh. This sort of thing is always nasty do deal with. Note that
6 * the version here does not include floating point...
8 * snprintf() is used instead of sprintf() as it does limit checks
9 * for string length. This covers a nasty loophole.
11 * The other functions are there to prevent NULL pointers from
12 * causing nast effects.
15 * Brandon Long <blong@fiction.net> 9/15/96 for mutt 0.43
16 * This was ugly. It is still ugly. I opted out of floating point
17 * numbers, but the formatter understands just about everything
18 * from the normal C string format, at least as far as I can tell from
19 * the Solaris 2.5 printf(3S) man page.
21 * Brandon Long <blong@fiction.net> 10/22/97 for mutt 0.87.1
22 * Ok, added some minimal floating point support, which means this
23 * probably requires libm on most operating systems. Don't yet
24 * support the exponent (e,E) and sigfig (g,G). Also, fmtint()
25 * was pretty badly broken, it just wasn't being exercised in ways
26 * which showed it, so that's been fixed. Also, formated the code
27 * to mutt conventions, and removed dead code left over from the
28 * original. Also, there is now a builtin-test, just compile with:
29 * gcc -DTEST_SNPRINTF -o snprintf snprintf.c -lm
30 * and run snprintf for results.
32 * Thomas Roessler <roessler@guug.de> 01/27/98 for mutt 0.89i
33 * The PGP code was using unsigned hexadecimal formats.
34 * Unfortunately, unsigned formats simply didn't work.
36 * Michael Elkins <me@cs.hmc.edu> 03/05/98 for mutt 0.90.8
37 * The original code assumed that both snprintf() and vsnprintf() were
38 * missing. Some systems only have snprintf() but not vsnprintf(), so
39 * the code is now broken down under HAVE_SNPRINTF and HAVE_VSNPRINTF.
41 **************************************************************/
45 #if !defined(HAVE_SNPRINTF) || !defined(HAVE_VSNPRINTF)
49 #include <sys/types.h>
51 /* varargs declarations: */
53 #if defined(HAVE_STDARG_H)
55 # define HAVE_STDARGS /* let's hope that works everywhere (mj) */
56 # define VA_LOCAL_DECL va_list ap
57 # define VA_START(f) va_start(ap, f)
58 # define VA_SHIFT(v,t) ; /* no-op for ANSI */
59 # define VA_END va_end(ap)
61 # if defined(HAVE_VARARGS_H)
64 # define VA_LOCAL_DECL va_list ap
65 # define VA_START(f) va_start(ap) /* f is ignored! */
66 # define VA_SHIFT(v,t) v = va_arg(ap,t)
67 # define VA_END va_end(ap)
69 /*XX ** NO VARARGS ** XX*/
73 /*int snprintf (char *str, size_t count, const char *fmt, ...);*/
74 /*int vsnprintf (char *str, size_t count, const char *fmt, va_list arg);*/
76 static void dopr (char *buffer, size_t maxlen, const char *format,
78 static void fmtstr (char *buffer, size_t *currlen, size_t maxlen,
79 char *value, int flags, int min, int max);
80 static void fmtint (char *buffer, size_t *currlen, size_t maxlen,
81 long value, int base, int min, int max, int flags);
82 static void fmtfp (char *buffer, size_t *currlen, size_t maxlen,
83 long double fvalue, int min, int max, int flags);
84 static void dopr_outch (char *buffer, size_t *currlen, size_t maxlen, char c );
87 * dopr(): poor man's version of doprintf
90 /* format read states */
91 #define DP_S_DEFAULT 0
100 /* format flags - Bits */
101 #define DP_F_MINUS (1 << 0)
102 #define DP_F_PLUS (1 << 1)
103 #define DP_F_SPACE (1 << 2)
104 #define DP_F_NUM (1 << 3)
105 #define DP_F_ZERO (1 << 4)
106 #define DP_F_UP (1 << 5)
107 #define DP_F_UNSIGNED (1 << 6)
109 /* Conversion Flags */
112 #define DP_C_LDOUBLE 3
114 #define char_to_int(p) (p - '0')
115 #define MAX(p,q) ((p >= q) ? p : q)
117 static void dopr (char *buffer, size_t maxlen, const char *format, va_list args)
130 state = DP_S_DEFAULT;
131 currlen = flags = cflags = min = 0;
135 while (state != DP_S_DONE)
137 if ((ch == '\0') || (currlen >= maxlen))
146 dopr_outch (buffer, &currlen, maxlen, ch);
178 if (isdigit((unsigned char)ch))
180 min = 10*min + char_to_int (ch);
185 min = va_arg (args, int);
202 if (isdigit((unsigned char)ch))
206 max = 10*max + char_to_int (ch);
211 max = va_arg (args, int);
219 /* Currently, we don't support Long Long, bummer */
231 cflags = DP_C_LDOUBLE;
244 if (cflags == DP_C_SHORT)
245 value = va_arg (args, short int);
246 else if (cflags == DP_C_LONG)
247 value = va_arg (args, long int);
249 value = va_arg (args, int);
250 fmtint (buffer, &currlen, maxlen, value, 10, min, max, flags);
253 flags |= DP_F_UNSIGNED;
254 if (cflags == DP_C_SHORT)
255 value = va_arg (args, unsigned short int);
256 else if (cflags == DP_C_LONG)
257 value = va_arg (args, unsigned long int);
259 value = va_arg (args, unsigned int);
260 fmtint (buffer, &currlen, maxlen, value, 8, min, max, flags);
263 flags |= DP_F_UNSIGNED;
264 if (cflags == DP_C_SHORT)
265 value = va_arg (args, unsigned short int);
266 else if (cflags == DP_C_LONG)
267 value = va_arg (args, unsigned long int);
269 value = va_arg (args, unsigned int);
270 fmtint (buffer, &currlen, maxlen, value, 10, min, max, flags);
275 flags |= DP_F_UNSIGNED;
276 if (cflags == DP_C_SHORT)
277 value = va_arg (args, unsigned short int);
278 else if (cflags == DP_C_LONG)
279 value = va_arg (args, unsigned long int);
281 value = va_arg (args, unsigned int);
282 fmtint (buffer, &currlen, maxlen, value, 16, min, max, flags);
285 if (cflags == DP_C_LDOUBLE)
286 fvalue = va_arg (args, long double);
288 fvalue = va_arg (args, double);
289 /* um, floating point? */
290 fmtfp (buffer, &currlen, maxlen, fvalue, min, max, flags);
295 if (cflags == DP_C_LDOUBLE)
296 fvalue = va_arg (args, long double);
298 fvalue = va_arg (args, double);
303 if (cflags == DP_C_LDOUBLE)
304 fvalue = va_arg (args, long double);
306 fvalue = va_arg (args, double);
309 dopr_outch (buffer, &currlen, maxlen, va_arg (args, int));
312 strvalue = va_arg (args, char *);
314 max = maxlen; /* ie, no max */
315 fmtstr (buffer, &currlen, maxlen, strvalue, flags, min, max);
318 strvalue = va_arg (args, void *);
319 fmtint (buffer, &currlen, maxlen, (long) strvalue, 16, min, max, flags);
322 if (cflags == DP_C_SHORT)
325 num = va_arg (args, short int *);
328 else if (cflags == DP_C_LONG)
331 num = va_arg (args, long int *);
337 num = va_arg (args, int *);
342 dopr_outch (buffer, &currlen, maxlen, ch);
345 /* not supported yet, treat as next char */
353 state = DP_S_DEFAULT;
354 flags = cflags = min = 0;
361 break; /* some picky compilers need this */
364 if (currlen < maxlen - 1)
365 buffer[currlen] = '\0';
367 buffer[maxlen - 1] = '\0';
370 static void fmtstr (char *buffer, size_t *currlen, size_t maxlen,
371 char *value, int flags, int min, int max)
373 int padlen, strln; /* amount to pad */
381 for (strln = 0; value[strln]; ++strln); /* strlen */
382 padlen = min - strln;
385 if (flags & DP_F_MINUS)
386 padlen = -padlen; /* Left Justify */
388 while ((padlen > 0) && (cnt < max))
390 dopr_outch (buffer, currlen, maxlen, ' ');
394 while (*value && (cnt < max))
396 dopr_outch (buffer, currlen, maxlen, *value++);
399 while ((padlen < 0) && (cnt < max))
401 dopr_outch (buffer, currlen, maxlen, ' ');
407 /* Have to handle DP_F_NUM (ie 0x and 0 alternates) */
409 static void fmtint (char *buffer, size_t *currlen, size_t maxlen,
410 long value, int base, int min, int max, int flags)
413 unsigned long uvalue;
416 int spadlen = 0; /* amount to space pad */
417 int zpadlen = 0; /* amount to zero pad */
425 if(!(flags & DP_F_UNSIGNED))
432 if (flags & DP_F_PLUS) /* Do a sign (+/i) */
435 if (flags & DP_F_SPACE)
439 if (flags & DP_F_UP) caps = 1; /* Should characters be upper case? */
443 (caps? "0123456789ABCDEF":"0123456789abcdef")
444 [uvalue % (unsigned)base ];
445 uvalue = (uvalue / (unsigned)base );
446 } while(uvalue && (place < 20));
447 if (place == 20) place--;
450 zpadlen = max - place;
451 spadlen = min - MAX (max, place) - (signvalue ? 1 : 0);
452 if (zpadlen < 0) zpadlen = 0;
453 if (spadlen < 0) spadlen = 0;
454 if (flags & DP_F_ZERO)
456 zpadlen = MAX(zpadlen, spadlen);
459 if (flags & DP_F_MINUS)
460 spadlen = -spadlen; /* Left Justifty */
462 #ifdef DEBUG_SNPRINTF
463 dprint (1, (debugfile, "zpad: %d, spad: %d, min: %d, max: %d, place: %d\n",
464 zpadlen, spadlen, min, max, place));
470 dopr_outch (buffer, currlen, maxlen, ' ');
476 dopr_outch (buffer, currlen, maxlen, signvalue);
483 dopr_outch (buffer, currlen, maxlen, '0');
490 dopr_outch (buffer, currlen, maxlen, convert[--place]);
492 /* Left Justified spaces */
493 while (spadlen < 0) {
494 dopr_outch (buffer, currlen, maxlen, ' ');
499 static long double abs_val (long double value)
501 long double result = value;
509 static long double pow10 (int exp)
511 long double result = 1;
522 static long round (long double value)
527 value = value - intpart;
534 static void fmtfp (char *buffer, size_t *currlen, size_t maxlen,
535 long double fvalue, int min, int max, int flags)
543 int padlen = 0; /* amount to pad */
550 * AIX manpage says the default is 0, but Solaris says the default
551 * is 6, and sprintf on AIX defaults to 6
556 ufvalue = abs_val (fvalue);
561 if (flags & DP_F_PLUS) /* Do a sign (+/i) */
564 if (flags & DP_F_SPACE)
568 if (flags & DP_F_UP) caps = 1; /* Should characters be upper case? */
574 * Sorry, we only support 9 digits past the decimal because of our
580 /* We "cheat" by converting the fractional part to integer by
581 * multiplying by a factor of 10
583 fracpart = round ((pow10 (max)) * (ufvalue - intpart));
585 if (fracpart >= pow10 (max))
588 fracpart -= pow10 (max);
591 #ifdef DEBUG_SNPRINTF
592 dprint (1, (debugfile, "fmtfp: %f =? %d.%d\n", fvalue, intpart, fracpart));
595 /* Convert integer part */
598 (caps? "0123456789ABCDEF":"0123456789abcdef")[intpart % 10];
599 intpart = (intpart / 10);
600 } while(intpart && (iplace < 20));
601 if (iplace == 20) iplace--;
602 iconvert[iplace] = 0;
604 /* Convert fractional part */
607 (caps? "0123456789ABCDEF":"0123456789abcdef")[fracpart % 10];
608 fracpart = (fracpart / 10);
609 } while(fracpart && (fplace < 20));
610 if (fplace == 20) fplace--;
611 fconvert[fplace] = 0;
613 /* -1 for decimal point, another -1 if we are printing a sign */
614 padlen = min - iplace - max - 1 - ((signvalue) ? 1 : 0);
615 zpadlen = max - fplace;
620 if (flags & DP_F_MINUS)
621 padlen = -padlen; /* Left Justifty */
623 if ((flags & DP_F_ZERO) && (padlen > 0))
627 dopr_outch (buffer, currlen, maxlen, signvalue);
633 dopr_outch (buffer, currlen, maxlen, '0');
639 dopr_outch (buffer, currlen, maxlen, ' ');
643 dopr_outch (buffer, currlen, maxlen, signvalue);
646 dopr_outch (buffer, currlen, maxlen, iconvert[--iplace]);
649 * Decimal point. This should probably use locale to find the correct
652 dopr_outch (buffer, currlen, maxlen, '.');
655 dopr_outch (buffer, currlen, maxlen, fconvert[--fplace]);
659 dopr_outch (buffer, currlen, maxlen, '0');
665 dopr_outch (buffer, currlen, maxlen, ' ');
670 static void dopr_outch (char *buffer, size_t *currlen, size_t maxlen, char c)
672 if (*currlen < maxlen)
673 buffer[(*currlen)++] = c;
675 #endif /* !defined(HAVE_SNPRINTF) || !defined(HAVE_VSNPRINTF) */
677 #ifndef HAVE_VSNPRINTF
678 int vsnprintf (char *str, size_t count, const char *fmt, va_list args)
681 dopr(str, count, fmt, args);
684 #endif /* !HAVE_VSNPRINTF */
686 #ifndef HAVE_SNPRINTF
689 int snprintf (char *str,size_t count,const char *fmt,...)
691 int snprintf (va_alist) va_dcl
702 VA_SHIFT (str, char *);
703 VA_SHIFT (count, size_t );
704 VA_SHIFT (fmt, char *);
705 (void) vsnprintf(str, count, fmt, ap);
712 #define LONG_STRING 1024
716 char buf1[LONG_STRING];
717 char buf2[LONG_STRING];
732 double fp_nums[] = { -1.5, 134.21, 91340.2, 341.1234, 0203.9, 0.96, 0.996,
733 0.9996, 1.996, 4.136, 0};
746 long int_nums[] = { -1, 134, 91340, 341, 0203, 0};
751 printf ("Testing snprintf format codes against system sprintf...\n");
753 for (x = 0; fp_fmt[x] != NULL ; x++)
754 for (y = 0; fp_nums[y] != 0 ; y++)
756 snprintf (buf1, sizeof (buf1), fp_fmt[x], fp_nums[y]);
757 sprintf (buf2, fp_fmt[x], fp_nums[y]);
758 if (strcmp (buf1, buf2))
760 printf("snprintf doesn't match Format: %s\n\tsnprintf = %s\n\tsprintf = %s\n",
761 fp_fmt[x], buf1, buf2);
767 for (x = 0; int_fmt[x] != NULL ; x++)
768 for (y = 0; int_nums[y] != 0 ; y++)
770 snprintf (buf1, sizeof (buf1), int_fmt[x], int_nums[y]);
771 sprintf (buf2, int_fmt[x], int_nums[y]);
772 if (strcmp (buf1, buf2))
774 printf("snprintf doesn't match Format: %s\n\tsnprintf = %s\n\tsprintf = %s\n",
775 int_fmt[x], buf1, buf2);
780 printf ("%d tests failed out of %d.\n", fail, num);
782 #endif /* SNPRINTF_TEST */
784 #endif /* !HAVE_SNPRINTF */