1 /* This is taken from cvslock. The same code is used in several
2 * freeware and GPLd applications. I contacted the email addresses
3 * listed in the header and have been told that the code is probably
4 * public domain, but I am still seeking confirmation from Patrick
5 * Powell. The original code was posted to BugTraq by Patrick in 1995
6 * but without any notice as to the copyright or license status.
8 * October 1998, Andrew Tridgell (tridge@samba.anu.edu.au)
11 /**************************************************************
13 * Patrick Powell Tue Apr 11 09:48:21 PDT 1995
14 * A bombproof version of doprnt (dopr) included.
15 * Sigh. This sort of thing is always nasty do deal with. Note that
16 * the version here does not include floating point...
18 * snprintf() is used instead of sprintf() as it does limit checks
19 * for string length. This covers a nasty loophole.
21 * The other functions are there to prevent NULL pointers from
22 * causing nast effects.
25 * Brandon Long <blong@fiction.net> 9/15/96 for mutt 0.43
26 * This was ugly. It is still ugly. I opted out of floating point
27 * numbers, but the formatter understands just about everything
28 * from the normal C string format, at least as far as I can tell from
29 * the Solaris 2.5 printf(3S) man page.
31 * Brandon Long <blong@fiction.net> 10/22/97 for mutt 0.87.1
32 * Ok, added some minimal floating point support, which means this
33 * probably requires libm on most operating systems. Don't yet
34 * support the exponent (e,E) and sigfig (g,G). Also, fmtint()
35 * was pretty badly broken, it just wasn't being exercised in ways
36 * which showed it, so that's been fixed. Also, formated the code
37 * to mutt conventions, and removed dead code left over from the
38 * original. Also, there is now a builtin-test, just compile with:
39 * gcc -DTEST_SNPRINTF -o snprintf snprintf.c -lm
40 * and run snprintf for results.
42 * Thomas Roessler <roessler@guug.de> 01/27/98 for mutt 0.89i
43 * The PGP code was using unsigned hexadecimal formats.
44 * Unfortunately, unsigned formats simply didn't work.
46 * Michael Elkins <me@cs.hmc.edu> 03/05/98 for mutt 0.90.8
47 * The original code assumed that both snprintf() and vsnprintf() were
48 * missing. Some systems only have snprintf() but not vsnprintf(), so
49 * the code is now broken down under HAVE_SNPRINTF and HAVE_VSNPRINTF.
51 * Andrew Tridgell (tridge@samba.anu.edu.au) Oct 1998
52 * fixed handling of %.0f
53 * added test for HAVE_LONG_DOUBLE
55 **************************************************************/
61 #include <sys/types.h>
63 #if !defined(HAVE_SNPRINTF) || !defined(HAVE_VSNPRINTF)
65 /* Define this as a fall through, HAVE_STDARG_H is probably already set */
67 #define HAVE_VARARGS_H
69 /* varargs declarations: */
71 #if defined(HAVE_STDARG_H)
73 # define HAVE_STDARGS /* let's hope that works everywhere (mj) */
74 # define VA_LOCAL_DECL va_list ap
75 # define VA_START(f) va_start(ap, f)
76 # define VA_SHIFT(v,t) ; /* no-op for ANSI */
77 # define VA_END va_end(ap)
79 # if defined(HAVE_VARARGS_H)
82 # define VA_LOCAL_DECL va_list ap
83 # define VA_START(f) va_start(ap) /* f is ignored! */
84 # define VA_SHIFT(v,t) v = va_arg(ap,t)
85 # define VA_END va_end(ap)
87 /*XX ** NO VARARGS ** XX*/
91 #ifdef HAVE_LONG_DOUBLE
92 #define LDOUBLE long double
94 #define LDOUBLE double
97 /*int snprintf (char *str, size_t count, const char *fmt, ...);*/
98 /*int vsnprintf (char *str, size_t count, const char *fmt, va_list arg);*/
100 static void dopr (char *buffer, size_t maxlen, const char *format,
102 static void fmtstr (char *buffer, size_t *currlen, size_t maxlen,
103 char *value, int flags, int min, int max);
104 static void fmtint (char *buffer, size_t *currlen, size_t maxlen,
105 long value, int base, int min, int max, int flags);
106 static void fmtfp (char *buffer, size_t *currlen, size_t maxlen,
107 LDOUBLE fvalue, int min, int max, int flags);
108 static void dopr_outch (char *buffer, size_t *currlen, size_t maxlen, char c );
111 * dopr(): poor man's version of doprintf
114 /* format read states */
115 #define DP_S_DEFAULT 0
124 /* format flags - Bits */
125 #define DP_F_MINUS (1 << 0)
126 #define DP_F_PLUS (1 << 1)
127 #define DP_F_SPACE (1 << 2)
128 #define DP_F_NUM (1 << 3)
129 #define DP_F_ZERO (1 << 4)
130 #define DP_F_UP (1 << 5)
131 #define DP_F_UNSIGNED (1 << 6)
133 /* Conversion Flags */
136 #define DP_C_LDOUBLE 3
138 #define char_to_int(p) (p - '0')
139 #define MAX(p,q) ((p >= q) ? p : q)
141 static void 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)
161 if ((ch == '\0') || (currlen >= maxlen))
170 dopr_outch (buffer, &currlen, maxlen, ch);
202 if (isdigit((unsigned char)ch))
204 min = 10*min + char_to_int (ch);
209 min = va_arg (args, int);
226 if (isdigit((unsigned char)ch))
230 max = 10*max + char_to_int (ch);
235 max = va_arg (args, int);
243 /* Currently, we don't support Long Long, bummer */
255 cflags = DP_C_LDOUBLE;
268 if (cflags == DP_C_SHORT)
269 value = va_arg (args, short int);
270 else if (cflags == DP_C_LONG)
271 value = va_arg (args, long int);
273 value = va_arg (args, int);
274 fmtint (buffer, &currlen, maxlen, value, 10, 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, 8, min, max, flags);
287 flags |= DP_F_UNSIGNED;
288 if (cflags == DP_C_SHORT)
289 value = va_arg (args, unsigned short int);
290 else if (cflags == DP_C_LONG)
291 value = va_arg (args, unsigned long int);
293 value = va_arg (args, unsigned int);
294 fmtint (buffer, &currlen, maxlen, value, 10, min, max, flags);
299 flags |= DP_F_UNSIGNED;
300 if (cflags == DP_C_SHORT)
301 value = va_arg (args, unsigned short int);
302 else if (cflags == DP_C_LONG)
303 value = va_arg (args, unsigned long int);
305 value = va_arg (args, unsigned int);
306 fmtint (buffer, &currlen, maxlen, value, 16, min, max, flags);
309 if (cflags == DP_C_LDOUBLE)
310 fvalue = va_arg (args, LDOUBLE);
312 fvalue = va_arg (args, double);
313 /* um, floating point? */
314 fmtfp (buffer, &currlen, maxlen, fvalue, min, max, flags);
319 if (cflags == DP_C_LDOUBLE)
320 fvalue = va_arg (args, LDOUBLE);
322 fvalue = va_arg (args, double);
327 if (cflags == DP_C_LDOUBLE)
328 fvalue = va_arg (args, LDOUBLE);
330 fvalue = va_arg (args, double);
333 dopr_outch (buffer, &currlen, maxlen, va_arg (args, int));
336 strvalue = va_arg (args, char *);
338 max = maxlen; /* ie, no max */
339 fmtstr (buffer, &currlen, maxlen, strvalue, flags, min, max);
342 strvalue = va_arg (args, void *);
343 fmtint (buffer, &currlen, maxlen, (long) strvalue, 16, min, max, flags);
346 if (cflags == DP_C_SHORT)
349 num = va_arg (args, short int *);
352 else if (cflags == DP_C_LONG)
355 num = va_arg (args, long int *);
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 */
388 if (currlen < maxlen - 1)
389 buffer[currlen] = '\0';
391 buffer[maxlen - 1] = '\0';
394 static void fmtstr (char *buffer, size_t *currlen, size_t maxlen,
395 char *value, int flags, int min, int max)
397 int padlen, strln; /* amount to pad */
405 for (strln = 0; value[strln]; ++strln); /* strlen */
406 padlen = min - strln;
409 if (flags & DP_F_MINUS)
410 padlen = -padlen; /* Left Justify */
412 while ((padlen > 0) && (cnt < max))
414 dopr_outch (buffer, currlen, maxlen, ' ');
418 while (*value && (cnt < max))
420 dopr_outch (buffer, currlen, maxlen, *value++);
423 while ((padlen < 0) && (cnt < max))
425 dopr_outch (buffer, currlen, maxlen, ' ');
431 /* Have to handle DP_F_NUM (ie 0x and 0 alternates) */
433 static void fmtint (char *buffer, size_t *currlen, size_t maxlen,
434 long value, int base, int min, int max, int flags)
437 unsigned long uvalue;
440 int spadlen = 0; /* amount to space pad */
441 int zpadlen = 0; /* amount to zero pad */
449 if(!(flags & DP_F_UNSIGNED))
456 if (flags & DP_F_PLUS) /* Do a sign (+/i) */
459 if (flags & DP_F_SPACE)
463 if (flags & DP_F_UP) caps = 1; /* Should characters be upper case? */
467 (caps? "0123456789ABCDEF":"0123456789abcdef")
468 [uvalue % (unsigned)base ];
469 uvalue = (uvalue / (unsigned)base );
470 } while(uvalue && (place < 20));
471 if (place == 20) place--;
474 zpadlen = max - place;
475 spadlen = min - MAX (max, place) - (signvalue ? 1 : 0);
476 if (zpadlen < 0) zpadlen = 0;
477 if (spadlen < 0) spadlen = 0;
478 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);
494 dopr_outch (buffer, currlen, maxlen, ' ');
500 dopr_outch (buffer, currlen, maxlen, signvalue);
507 dopr_outch (buffer, currlen, maxlen, '0');
514 dopr_outch (buffer, currlen, maxlen, convert[--place]);
516 /* Left Justified spaces */
517 while (spadlen < 0) {
518 dopr_outch (buffer, currlen, maxlen, ' ');
523 static LDOUBLE abs_val (LDOUBLE value)
525 LDOUBLE result = value;
533 static LDOUBLE pow10 (int exp)
546 static long round (LDOUBLE value)
551 value = value - intpart;
558 static void fmtfp (char *buffer, size_t *currlen, size_t maxlen,
559 LDOUBLE fvalue, int min, int max, int flags)
567 int padlen = 0; /* amount to pad */
574 * AIX manpage says the default is 0, but Solaris says the default
575 * is 6, and sprintf on AIX defaults to 6
580 ufvalue = abs_val (fvalue);
585 if (flags & DP_F_PLUS) /* Do a sign (+/i) */
588 if (flags & DP_F_SPACE)
592 if (flags & DP_F_UP) caps = 1; /* Should characters be upper case? */
598 * Sorry, we only support 9 digits past the decimal because of our
604 /* We "cheat" by converting the fractional part to integer by
605 * multiplying by a factor of 10
607 fracpart = round ((pow10 (max)) * (ufvalue - intpart));
609 if (fracpart >= pow10 (max))
612 fracpart -= pow10 (max);
615 #ifdef DEBUG_SNPRINTF
616 printf("fmtfp: %g %d.%d min=%d max=%d\n",
617 (double)fvalue, intpart, fracpart, min, max);
620 /* Convert integer part */
623 (caps? "0123456789ABCDEF":"0123456789abcdef")[intpart % 10];
624 intpart = (intpart / 10);
625 } while(intpart && (iplace < 20));
626 if (iplace == 20) iplace--;
627 iconvert[iplace] = 0;
629 /* Convert fractional part */
632 (caps? "0123456789ABCDEF":"0123456789abcdef")[fracpart % 10];
633 fracpart = (fracpart / 10);
634 } while(fracpart && (fplace < 20));
635 if (fplace == 20) fplace--;
636 fconvert[fplace] = 0;
638 /* -1 for decimal point, another -1 if we are printing a sign */
639 padlen = min - iplace - max - 1 - ((signvalue) ? 1 : 0);
640 zpadlen = max - fplace;
645 if (flags & DP_F_MINUS)
646 padlen = -padlen; /* Left Justifty */
648 if ((flags & DP_F_ZERO) && (padlen > 0))
652 dopr_outch (buffer, currlen, maxlen, signvalue);
658 dopr_outch (buffer, currlen, maxlen, '0');
664 dopr_outch (buffer, currlen, maxlen, ' ');
668 dopr_outch (buffer, currlen, maxlen, signvalue);
671 dopr_outch (buffer, currlen, maxlen, iconvert[--iplace]);
674 #ifdef DEBUG_SNPRINTF
675 printf("fmtfp: fplace=%d zpadlen=%d\n", fplace, zpadlen);
679 * Decimal point. This should probably use locale to find the correct
683 dopr_outch (buffer, currlen, maxlen, '.');
686 dopr_outch (buffer, currlen, maxlen, fconvert[--fplace]);
691 dopr_outch (buffer, currlen, maxlen, '0');
697 dopr_outch (buffer, currlen, maxlen, ' ');
702 static void dopr_outch (char *buffer, size_t *currlen, size_t maxlen, char c)
704 if (*currlen < maxlen)
705 buffer[(*currlen)++] = c;
707 #endif /* !defined(HAVE_SNPRINTF) || !defined(HAVE_VSNPRINTF) */
709 #ifndef HAVE_VSNPRINTF
710 int vsnprintf (char *str, size_t count, const char *fmt, va_list args)
713 dopr(str, count, fmt, args);
716 #endif /* !HAVE_VSNPRINTF */
718 #ifndef HAVE_SNPRINTF
721 int snprintf (char *str,size_t count,const char *fmt,...)
723 int snprintf (va_alist) va_dcl
734 VA_SHIFT (str, char *);
735 VA_SHIFT (count, size_t );
736 VA_SHIFT (fmt, char *);
737 (void) vsnprintf(str, count, fmt, ap);
744 /* keep compilers happy about empty files */
745 void dummy_snprintf(void) {}
746 #endif /* !HAVE_SNPRINTF */
750 #define LONG_STRING 1024
754 char buf1[LONG_STRING];
755 char buf2[LONG_STRING];
772 double fp_nums[] = { -1.5, 134.21, 91340.2, 341.1234, 0203.9, 0.96, 0.996,
773 0.9996, 1.996, 4.136, 0};
786 long int_nums[] = { -1, 134, 91340, 341, 0203, 0};
791 printf ("Testing snprintf format codes against system sprintf...\n");
793 for (x = 0; fp_fmt[x] != NULL ; x++)
794 for (y = 0; fp_nums[y] != 0 ; y++)
796 snprintf (buf1, sizeof (buf1), fp_fmt[x], fp_nums[y]);
797 sprintf (buf2, fp_fmt[x], fp_nums[y]);
798 if (strcmp (buf1, buf2))
800 printf("snprintf doesn't match Format: %s\n\tsnprintf = %s\n\tsprintf = %s\n",
801 fp_fmt[x], buf1, buf2);
807 for (x = 0; int_fmt[x] != NULL ; x++)
808 for (y = 0; int_nums[y] != 0 ; y++)
810 snprintf (buf1, sizeof (buf1), int_fmt[x], int_nums[y]);
811 sprintf (buf2, int_fmt[x], int_nums[y]);
812 if (strcmp (buf1, buf2))
814 printf("snprintf doesn't match Format: %s\n\tsnprintf = %s\n\tsprintf = %s\n",
815 int_fmt[x], buf1, buf2);
820 printf ("%d tests failed out of %d.\n", fail, num);
822 #endif /* SNPRINTF_TEST */