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@does-not-exist.org> 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@mutt.org> 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 * Holger Weiss <holger@zedat.fu-berlin.de> 07/23/06 for mutt 1.5.13
42 * A C99 compliant [v]snprintf() returns the number of characters that
43 * would have been written to a sufficiently sized buffer (excluding
44 * the '\0'). Mutt now relies on this behaviour, but the original
45 * code simply returned the length of the resulting output string, so
48 **************************************************************/
54 #if !defined(HAVE_SNPRINTF) || !defined(HAVE_VSNPRINTF)
58 #include <sys/types.h>
60 /* Define this as a fall through, HAVE_STDARG_H is probably already set */
62 #define HAVE_VARARGS_H
64 /* varargs declarations: */
66 #if defined(HAVE_STDARG_H)
68 # define HAVE_STDARGS /* let's hope that works everywhere (mj) */
69 # define VA_LOCAL_DECL va_list ap
70 # define VA_START(f) va_start(ap, f)
71 # define VA_SHIFT(v,t) ; /* no-op for ANSI */
72 # define VA_END va_end(ap)
74 # if defined(HAVE_VARARGS_H)
77 # define VA_LOCAL_DECL va_list ap
78 # define VA_START(f) va_start(ap) /* f is ignored! */
79 # define VA_SHIFT(v,t) v = va_arg(ap,t)
80 # define VA_END va_end(ap)
82 /*XX ** NO VARARGS ** XX*/
86 /*int snprintf (char *str, size_t count, const char *fmt, ...);*/
87 /*int vsnprintf (char *str, size_t count, const char *fmt, va_list arg);*/
89 static int dopr (char *buffer, size_t maxlen, const char *format,
91 static void fmtstr (char *buffer, size_t *currlen, size_t maxlen,
92 char *value, int flags, int min, int max);
93 static void fmtint (char *buffer, size_t *currlen, size_t maxlen,
94 long value, int base, int min, int max, int flags);
95 static void fmtfp (char *buffer, size_t *currlen, size_t maxlen,
96 long double fvalue, int min, int max, int flags);
97 static void dopr_outch (char *buffer, size_t *currlen, size_t maxlen, char c );
100 * dopr(): poor man's version of doprintf
103 /* format read states */
104 #define DP_S_DEFAULT 0
113 /* format flags - Bits */
114 #define DP_F_MINUS (1 << 0)
115 #define DP_F_PLUS (1 << 1)
116 #define DP_F_SPACE (1 << 2)
117 #define DP_F_NUM (1 << 3)
118 #define DP_F_ZERO (1 << 4)
119 #define DP_F_UP (1 << 5)
120 #define DP_F_UNSIGNED (1 << 6)
122 /* Conversion Flags */
125 #define DP_C_LDOUBLE 3
127 #define char_to_int(p) (p - '0')
129 #define MAX(p,q) ((p >= q) ? p : q)
131 static int dopr (char *buffer, size_t maxlen, const char *format, va_list args)
144 state = DP_S_DEFAULT;
145 currlen = flags = cflags = min = 0;
149 while (state != DP_S_DONE)
160 dopr_outch (buffer, &currlen, maxlen, ch);
192 if (isdigit((unsigned char)ch))
194 min = 10*min + char_to_int (ch);
199 min = va_arg (args, int);
216 if (isdigit((unsigned char)ch))
220 max = 10*max + char_to_int (ch);
225 max = va_arg (args, int);
233 /* Currently, we don't support Long Long, bummer */
245 cflags = DP_C_LDOUBLE;
258 if (cflags == DP_C_SHORT)
259 value = va_arg (args, short int);
260 else if (cflags == DP_C_LONG)
261 value = va_arg (args, long int);
263 value = va_arg (args, int);
264 fmtint (buffer, &currlen, maxlen, value, 10, min, max, flags);
267 flags |= DP_F_UNSIGNED;
268 if (cflags == DP_C_SHORT)
269 value = va_arg (args, unsigned short int);
270 else if (cflags == DP_C_LONG)
271 value = va_arg (args, unsigned long int);
273 value = va_arg (args, unsigned int);
274 fmtint (buffer, &currlen, maxlen, value, 8, min, max, flags);
277 flags |= DP_F_UNSIGNED;
278 if (cflags == DP_C_SHORT)
279 value = va_arg (args, unsigned short int);
280 else if (cflags == DP_C_LONG)
281 value = va_arg (args, unsigned long int);
283 value = va_arg (args, unsigned int);
284 fmtint (buffer, &currlen, maxlen, value, 10, min, max, flags);
289 flags |= DP_F_UNSIGNED;
290 if (cflags == DP_C_SHORT)
291 value = va_arg (args, unsigned short int);
292 else if (cflags == DP_C_LONG)
293 value = va_arg (args, unsigned long int);
295 value = va_arg (args, unsigned int);
296 fmtint (buffer, &currlen, maxlen, value, 16, min, max, flags);
299 if (cflags == DP_C_LDOUBLE)
300 fvalue = va_arg (args, long double);
302 fvalue = va_arg (args, double);
303 /* um, floating point? */
304 fmtfp (buffer, &currlen, maxlen, fvalue, min, max, flags);
309 if (cflags == DP_C_LDOUBLE)
310 fvalue = va_arg (args, long double);
312 fvalue = va_arg (args, double);
317 if (cflags == DP_C_LDOUBLE)
318 fvalue = va_arg (args, long double);
320 fvalue = va_arg (args, double);
323 dopr_outch (buffer, &currlen, maxlen, va_arg (args, int));
326 strvalue = va_arg (args, char *);
327 fmtstr (buffer, &currlen, maxlen, strvalue, flags, min, max);
330 strvalue = va_arg (args, void *);
331 fmtint (buffer, &currlen, maxlen, (long) strvalue, 16, min, max, flags);
334 if (cflags == DP_C_SHORT)
337 num = va_arg (args, short int *);
340 else if (cflags == DP_C_LONG)
343 num = va_arg (args, long int *);
349 num = va_arg (args, int *);
354 dopr_outch (buffer, &currlen, maxlen, ch);
357 /* not supported yet, treat as next char */
365 state = DP_S_DEFAULT;
366 flags = cflags = min = 0;
373 break; /* some picky compilers need this */
376 if (currlen < maxlen - 1)
377 buffer[currlen] = '\0';
379 buffer[maxlen - 1] = '\0';
384 static void fmtstr (char *buffer, size_t *currlen, size_t maxlen,
385 char *value, int flags, int min, int max)
387 int padlen, strln; /* amount to pad */
395 for (strln = 0; value[strln]; ++strln); /* strlen */
396 padlen = min - strln;
399 if (flags & DP_F_MINUS)
400 padlen = -padlen; /* Left Justify */
402 while ((padlen > 0) && (max == -1 || cnt < max))
404 dopr_outch (buffer, currlen, maxlen, ' ');
408 while (*value && (max == -1 || cnt < max))
410 dopr_outch (buffer, currlen, maxlen, *value++);
413 while ((padlen < 0) && (max == -1 || cnt < max))
415 dopr_outch (buffer, currlen, maxlen, ' ');
421 /* Have to handle DP_F_NUM (ie 0x and 0 alternates) */
423 static void fmtint (char *buffer, size_t *currlen, size_t maxlen,
424 long value, int base, int min, int max, int flags)
427 unsigned long uvalue;
430 int spadlen = 0; /* amount to space pad */
431 int zpadlen = 0; /* amount to zero pad */
439 if(!(flags & DP_F_UNSIGNED))
446 if (flags & DP_F_PLUS) /* Do a sign (+/i) */
449 if (flags & DP_F_SPACE)
453 if (flags & DP_F_UP) caps = 1; /* Should characters be upper case? */
457 (caps? "0123456789ABCDEF":"0123456789abcdef")
458 [uvalue % (unsigned)base ];
459 uvalue = (uvalue / (unsigned)base );
460 } while(uvalue && (place < 20));
461 if (place == 20) place--;
464 zpadlen = max - place;
465 spadlen = min - MAX (max, place) - (signvalue ? 1 : 0);
466 if (zpadlen < 0) zpadlen = 0;
467 if (spadlen < 0) spadlen = 0;
468 if (flags & DP_F_ZERO)
470 zpadlen = MAX(zpadlen, spadlen);
473 if (flags & DP_F_MINUS)
474 spadlen = -spadlen; /* Left Justifty */
476 #ifdef DEBUG_SNPRINTF
477 dprint (1, (debugfile, "zpad: %d, spad: %d, min: %d, max: %d, place: %d\n",
478 zpadlen, spadlen, min, max, place));
484 dopr_outch (buffer, currlen, maxlen, ' ');
490 dopr_outch (buffer, currlen, maxlen, signvalue);
497 dopr_outch (buffer, currlen, maxlen, '0');
504 dopr_outch (buffer, currlen, maxlen, convert[--place]);
506 /* Left Justified spaces */
507 while (spadlen < 0) {
508 dopr_outch (buffer, currlen, maxlen, ' ');
513 static long double abs_val (long double value)
515 long double result = value;
523 static long double pow10 (int exp)
525 long double result = 1;
536 static long round (long double value)
541 value = value - intpart;
548 static void fmtfp (char *buffer, size_t *currlen, size_t maxlen,
549 long double fvalue, int min, int max, int flags)
557 int padlen = 0; /* amount to pad */
564 * AIX manpage says the default is 0, but Solaris says the default
565 * is 6, and sprintf on AIX defaults to 6
570 ufvalue = abs_val (fvalue);
575 if (flags & DP_F_PLUS) /* Do a sign (+/i) */
578 if (flags & DP_F_SPACE)
582 if (flags & DP_F_UP) caps = 1; /* Should characters be upper case? */
588 * Sorry, we only support 9 digits past the decimal because of our
594 /* We "cheat" by converting the fractional part to integer by
595 * multiplying by a factor of 10
597 fracpart = round ((pow10 (max)) * (ufvalue - intpart));
599 if (fracpart >= pow10 (max))
602 fracpart -= pow10 (max);
605 #ifdef DEBUG_SNPRINTF
606 dprint (1, (debugfile, "fmtfp: %f =? %d.%d\n", fvalue, intpart, fracpart));
609 /* Convert integer part */
612 (caps? "0123456789ABCDEF":"0123456789abcdef")[intpart % 10];
613 intpart = (intpart / 10);
614 } while(intpart && (iplace < 20));
615 if (iplace == 20) iplace--;
616 iconvert[iplace] = 0;
618 /* Convert fractional part */
621 (caps? "0123456789ABCDEF":"0123456789abcdef")[fracpart % 10];
622 fracpart = (fracpart / 10);
623 } while(fracpart && (fplace < 20));
624 if (fplace == 20) fplace--;
625 fconvert[fplace] = 0;
627 /* -1 for decimal point, another -1 if we are printing a sign */
628 padlen = min - iplace - max - 1 - ((signvalue) ? 1 : 0);
629 zpadlen = max - fplace;
634 if (flags & DP_F_MINUS)
635 padlen = -padlen; /* Left Justifty */
637 if ((flags & DP_F_ZERO) && (padlen > 0))
641 dopr_outch (buffer, currlen, maxlen, signvalue);
647 dopr_outch (buffer, currlen, maxlen, '0');
653 dopr_outch (buffer, currlen, maxlen, ' ');
657 dopr_outch (buffer, currlen, maxlen, signvalue);
660 dopr_outch (buffer, currlen, maxlen, iconvert[--iplace]);
663 * Decimal point. This should probably use locale to find the correct
666 dopr_outch (buffer, currlen, maxlen, '.');
669 dopr_outch (buffer, currlen, maxlen, fconvert[--fplace]);
673 dopr_outch (buffer, currlen, maxlen, '0');
679 dopr_outch (buffer, currlen, maxlen, ' ');
684 static void dopr_outch (char *buffer, size_t *currlen, size_t maxlen, char c)
686 if (*currlen < maxlen)
687 buffer[*currlen] = c;
690 #endif /* !defined(HAVE_SNPRINTF) || !defined(HAVE_VSNPRINTF) */
692 #ifndef HAVE_VSNPRINTF
693 int vsnprintf (char *str, size_t count, const char *fmt, va_list args)
696 return(dopr(str, count, fmt, args));
698 #endif /* !HAVE_VSNPRINTF */
700 #ifndef HAVE_SNPRINTF
703 int snprintf (char *str,size_t count,const char *fmt,...)
705 int snprintf (va_alist) va_dcl
717 VA_SHIFT (str, char *);
718 VA_SHIFT (count, size_t );
719 VA_SHIFT (fmt, char *);
720 len = vsnprintf(str, count, fmt, ap);
727 #define LONG_STRING 1024
731 char buf1[LONG_STRING];
732 char buf2[LONG_STRING];
747 double fp_nums[] = { -1.5, 134.21, 91340.2, 341.1234, 0203.9, 0.96, 0.996,
748 0.9996, 1.996, 4.136, 0};
761 long int_nums[] = { -1, 134, 91340, 341, 0203, 0};
766 printf ("Testing snprintf format codes against system sprintf...\n");
768 for (x = 0; fp_fmt[x] != NULL ; x++)
769 for (y = 0; fp_nums[y] != 0 ; y++)
771 snprintf (buf1, sizeof (buf1), fp_fmt[x], fp_nums[y]);
772 sprintf (buf2, fp_fmt[x], fp_nums[y]);
773 if (strcmp (buf1, buf2))
775 printf("snprintf doesn't match Format: %s\n\tsnprintf = %s\n\tsprintf = %s\n", /* __SPRINTF_CHECKED__ */
776 fp_fmt[x], buf1, buf2);
782 for (x = 0; int_fmt[x] != NULL ; x++)
783 for (y = 0; int_nums[y] != 0 ; y++)
785 snprintf (buf1, sizeof (buf1), int_fmt[x], int_nums[y]);
786 sprintf (buf2, int_fmt[x], int_nums[y]);
787 if (strcmp (buf1, buf2))
789 printf("snprintf doesn't match Format: %s\n\tsnprintf = %s\n\tsprintf = %s\n", /* __SPRINTF_CHECKED__ */
790 int_fmt[x], buf1, buf2);
795 printf ("%d tests failed out of %d.\n", fail, num);
797 #endif /* SNPRINTF_TEST */
799 #endif /* !HAVE_SNPRINTF */