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 * Ben Lindstrom <mouring@pconline.com> 09/27/00 for OpenSSH
42 * Welcome to the world of %lld and %qd support. With other
43 * long long support. This is needed for sftp-server to work
45 **************************************************************/
49 #if !defined(HAVE_SNPRINTF) || !defined(HAVE_VSNPRINTF)
53 #include <sys/types.h>
55 /* Define this as a fall through, HAVE_STDARG_H is probably already set */
57 #define HAVE_VARARGS_H
59 /* varargs declarations: */
61 #if defined(HAVE_STDARG_H)
63 # define HAVE_STDARGS /* let's hope that works everywhere (mj) */
64 # define VA_LOCAL_DECL va_list ap
65 # define VA_START(f) va_start(ap, f)
66 # define VA_SHIFT(v,t) ; /* no-op for ANSI */
67 # define VA_END va_end(ap)
69 # if defined(HAVE_VARARGS_H)
72 # define VA_LOCAL_DECL va_list ap
73 # define VA_START(f) va_start(ap) /* f is ignored! */
74 # define VA_SHIFT(v,t) v = va_arg(ap,t)
75 # define VA_END va_end(ap)
77 /*XX ** NO VARARGS ** XX*/
81 /*int snprintf (char *str, size_t count, const char *fmt, ...);*/
82 /*int vsnprintf (char *str, size_t count, const char *fmt, va_list arg);*/
84 static void dopr (char *buffer, size_t maxlen, const char *format,
86 static void fmtstr (char *buffer, size_t *currlen, size_t maxlen,
87 char *value, int flags, int min, int max);
88 static void fmtint (char *buffer, size_t *currlen, size_t maxlen,
89 long value, int base, int min, int max, int flags);
90 static void fmtfp (char *buffer, size_t *currlen, size_t maxlen,
91 long double fvalue, int min, int max, int flags);
92 static void dopr_outch (char *buffer, size_t *currlen, size_t maxlen, char c );
95 * dopr(): poor man's version of doprintf
98 /* format read states */
99 #define DP_S_DEFAULT 0
108 /* format flags - Bits */
109 #define DP_F_MINUS (1 << 0)
110 #define DP_F_PLUS (1 << 1)
111 #define DP_F_SPACE (1 << 2)
112 #define DP_F_NUM (1 << 3)
113 #define DP_F_ZERO (1 << 4)
114 #define DP_F_UP (1 << 5)
115 #define DP_F_UNSIGNED (1 << 6)
117 /* Conversion Flags */
120 #define DP_C_LDOUBLE 3
121 #define DP_C_LONG_LONG 4
123 #define char_to_int(p) (p - '0')
125 # define MAX(p,q) ((p >= q) ? p : q)
128 static void dopr (char *buffer, size_t maxlen, const char *format, va_list args)
141 state = DP_S_DEFAULT;
142 currlen = flags = cflags = min = 0;
146 while (state != DP_S_DONE)
148 if ((ch == '\0') || (currlen >= maxlen))
157 dopr_outch (buffer, &currlen, maxlen, ch);
189 if (isdigit((unsigned char)ch))
191 min = 10*min + char_to_int (ch);
196 min = va_arg (args, int);
213 if (isdigit((unsigned char)ch))
217 max = 10*max + char_to_int (ch);
222 max = va_arg (args, int);
240 cflags = DP_C_LONG_LONG;
245 cflags = DP_C_LONG_LONG;
249 cflags = DP_C_LDOUBLE;
262 if (cflags == DP_C_SHORT)
263 value = va_arg (args, int);
264 else if (cflags == DP_C_LONG)
265 value = va_arg (args, long int);
266 else if (cflags == DP_C_LONG_LONG)
267 value = va_arg (args, long long);
269 value = va_arg (args, int);
270 fmtint (buffer, &currlen, maxlen, value, 10, min, max, flags);
273 flags |= DP_F_UNSIGNED;
274 if (cflags == DP_C_SHORT)
275 value = va_arg (args, unsigned int);
276 else if (cflags == DP_C_LONG)
277 value = va_arg (args, unsigned long int);
278 else if (cflags == DP_C_LONG_LONG)
279 value = va_arg (args, unsigned long long);
281 value = va_arg (args, unsigned int);
282 fmtint (buffer, &currlen, maxlen, value, 8, min, max, flags);
285 flags |= DP_F_UNSIGNED;
286 if (cflags == DP_C_SHORT)
287 value = va_arg (args, unsigned int);
288 else if (cflags == DP_C_LONG)
289 value = va_arg (args, unsigned long int);
290 else if (cflags == DP_C_LONG_LONG)
291 value = va_arg (args, unsigned long long);
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 int);
302 else if (cflags == DP_C_LONG)
303 value = va_arg (args, unsigned long int);
304 else if (cflags == DP_C_LONG_LONG)
305 value = va_arg (args, unsigned long long);
307 value = va_arg (args, unsigned int);
308 fmtint (buffer, &currlen, maxlen, value, 16, min, max, flags);
311 if (cflags == DP_C_LDOUBLE)
312 fvalue = va_arg (args, long double);
314 fvalue = va_arg (args, double);
315 /* um, floating point? */
316 fmtfp (buffer, &currlen, maxlen, fvalue, min, max, flags);
321 if (cflags == DP_C_LDOUBLE)
322 fvalue = va_arg (args, long double);
324 fvalue = va_arg (args, double);
329 if (cflags == DP_C_LDOUBLE)
330 fvalue = va_arg (args, long double);
332 fvalue = va_arg (args, double);
335 dopr_outch (buffer, &currlen, maxlen, va_arg (args, int));
338 strvalue = va_arg (args, char *);
340 max = maxlen; /* ie, no max */
341 fmtstr (buffer, &currlen, maxlen, strvalue, flags, min, max);
344 strvalue = va_arg (args, void *);
345 fmtint (buffer, &currlen, maxlen, (long) strvalue, 16, min, max, flags);
348 if (cflags == DP_C_SHORT)
351 num = va_arg (args, short int *);
354 else if (cflags == DP_C_LONG)
357 num = va_arg (args, long int *);
360 else if (cflags == DP_C_LONG_LONG)
363 num = va_arg (args, long long *);
369 num = va_arg (args, int *);
374 dopr_outch (buffer, &currlen, maxlen, ch);
377 /* not supported yet, treat as next char */
385 state = DP_S_DEFAULT;
386 flags = cflags = min = 0;
393 break; /* some picky compilers need this */
396 if (currlen < maxlen - 1)
397 buffer[currlen] = '\0';
399 buffer[maxlen - 1] = '\0';
402 static void fmtstr (char *buffer, size_t *currlen, size_t maxlen,
403 char *value, int flags, int min, int max)
405 int padlen, strln; /* amount to pad */
413 for (strln = 0; value[strln]; ++strln); /* strlen */
414 padlen = min - strln;
417 if (flags & DP_F_MINUS)
418 padlen = -padlen; /* Left Justify */
420 while ((padlen > 0) && (cnt < max))
422 dopr_outch (buffer, currlen, maxlen, ' ');
426 while (*value && (cnt < max))
428 dopr_outch (buffer, currlen, maxlen, *value++);
431 while ((padlen < 0) && (cnt < max))
433 dopr_outch (buffer, currlen, maxlen, ' ');
439 /* Have to handle DP_F_NUM (ie 0x and 0 alternates) */
441 static void fmtint (char *buffer, size_t *currlen, size_t maxlen,
442 long value, int base, int min, int max, int flags)
445 unsigned long uvalue;
448 int spadlen = 0; /* amount to space pad */
449 int zpadlen = 0; /* amount to zero pad */
457 if(!(flags & DP_F_UNSIGNED))
464 if (flags & DP_F_PLUS) /* Do a sign (+/i) */
467 if (flags & DP_F_SPACE)
471 if (flags & DP_F_UP) caps = 1; /* Should characters be upper case? */
475 (caps? "0123456789ABCDEF":"0123456789abcdef")
476 [uvalue % (unsigned)base ];
477 uvalue = (uvalue / (unsigned)base );
478 } while(uvalue && (place < 20));
479 if (place == 20) place--;
482 zpadlen = max - place;
483 spadlen = min - MAX (max, place) - (signvalue ? 1 : 0);
484 if (zpadlen < 0) zpadlen = 0;
485 if (spadlen < 0) spadlen = 0;
486 if (flags & DP_F_ZERO)
488 zpadlen = MAX(zpadlen, spadlen);
491 if (flags & DP_F_MINUS)
492 spadlen = -spadlen; /* Left Justifty */
494 #ifdef DEBUG_SNPRINTF
495 dprint (1, (debugfile, "zpad: %d, spad: %d, min: %d, max: %d, place: %d\n",
496 zpadlen, spadlen, min, max, place));
502 dopr_outch (buffer, currlen, maxlen, ' ');
508 dopr_outch (buffer, currlen, maxlen, signvalue);
515 dopr_outch (buffer, currlen, maxlen, '0');
522 dopr_outch (buffer, currlen, maxlen, convert[--place]);
524 /* Left Justified spaces */
525 while (spadlen < 0) {
526 dopr_outch (buffer, currlen, maxlen, ' ');
531 static long double abs_val (long double value)
533 long double result = value;
541 static long double pow10 (int exp)
543 long double result = 1;
554 static long round (long double value)
559 value = value - intpart;
566 static void fmtfp (char *buffer, size_t *currlen, size_t maxlen,
567 long double fvalue, int min, int max, int flags)
575 int padlen = 0; /* amount to pad */
582 * AIX manpage says the default is 0, but Solaris says the default
583 * is 6, and sprintf on AIX defaults to 6
588 ufvalue = abs_val (fvalue);
593 if (flags & DP_F_PLUS) /* Do a sign (+/i) */
596 if (flags & DP_F_SPACE)
600 if (flags & DP_F_UP) caps = 1; /* Should characters be upper case? */
606 * Sorry, we only support 9 digits past the decimal because of our
612 /* We "cheat" by converting the fractional part to integer by
613 * multiplying by a factor of 10
615 fracpart = round ((pow10 (max)) * (ufvalue - intpart));
617 if (fracpart >= pow10 (max))
620 fracpart -= pow10 (max);
623 #ifdef DEBUG_SNPRINTF
624 dprint (1, (debugfile, "fmtfp: %f =? %d.%d\n", fvalue, intpart, fracpart));
627 /* Convert integer part */
630 (caps? "0123456789ABCDEF":"0123456789abcdef")[intpart % 10];
631 intpart = (intpart / 10);
632 } while(intpart && (iplace < 20));
633 if (iplace == 20) iplace--;
634 iconvert[iplace] = 0;
636 /* Convert fractional part */
639 (caps? "0123456789ABCDEF":"0123456789abcdef")[fracpart % 10];
640 fracpart = (fracpart / 10);
641 } while(fracpart && (fplace < 20));
642 if (fplace == 20) fplace--;
643 fconvert[fplace] = 0;
645 /* -1 for decimal point, another -1 if we are printing a sign */
646 padlen = min - iplace - max - 1 - ((signvalue) ? 1 : 0);
647 zpadlen = max - fplace;
652 if (flags & DP_F_MINUS)
653 padlen = -padlen; /* Left Justifty */
655 if ((flags & DP_F_ZERO) && (padlen > 0))
659 dopr_outch (buffer, currlen, maxlen, signvalue);
665 dopr_outch (buffer, currlen, maxlen, '0');
671 dopr_outch (buffer, currlen, maxlen, ' ');
675 dopr_outch (buffer, currlen, maxlen, signvalue);
678 dopr_outch (buffer, currlen, maxlen, iconvert[--iplace]);
681 * Decimal point. This should probably use locale to find the correct
684 dopr_outch (buffer, currlen, maxlen, '.');
687 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 #define LONG_STRING 1024
748 char buf1[LONG_STRING];
749 char buf2[LONG_STRING];
764 double fp_nums[] = { -1.5, 134.21, 91340.2, 341.1234, 0203.9, 0.96, 0.996,
765 0.9996, 1.996, 4.136, 0};
780 long long int_nums[] = { -1, 134, 91340, 341, 0203, 0, 9999999 };
785 printf ("Testing snprintf format codes against system sprintf...\n");
787 for (x = 0; fp_fmt[x] != NULL ; x++)
788 for (y = 0; fp_nums[y] != 0 ; y++)
790 snprintf (buf1, sizeof (buf1), fp_fmt[x], fp_nums[y]);
791 sprintf (buf2, fp_fmt[x], fp_nums[y]);
792 if (strcmp (buf1, buf2))
794 printf("snprintf doesn't match Format: %s\n\tsnprintf = %s\n\tsprintf = %s\n",
795 fp_fmt[x], buf1, buf2);
801 for (x = 0; int_fmt[x] != NULL ; x++)
802 for (y = 0; int_nums[y] != 0 ; y++)
804 snprintf (buf1, sizeof (buf1), int_fmt[x], int_nums[y]);
805 sprintf (buf2, int_fmt[x], int_nums[y]);
806 if (strcmp (buf1, buf2))
808 printf("snprintf doesn't match Format: %s\n\tsnprintf = %s\n\tsprintf = %s\n",
809 int_fmt[x], buf1, buf2);
814 printf ("%d tests failed out of %d.\n", fail, num);
816 #endif /* SNPRINTF_TEST */
818 #endif /* !HAVE_SNPRINTF */