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 **************************************************************/
47 #if !defined(HAVE_SNPRINTF) || !defined(HAVE_VSNPRINTF)
51 #include <sys/types.h>
53 /* Define this as a fall through, HAVE_STDARG_H is probably already set */
55 #define HAVE_VARARGS_H
57 /* varargs declarations: */
59 #if defined(HAVE_STDARG_H)
61 # define HAVE_STDARGS /* let's hope that works everywhere (mj) */
62 # define VA_LOCAL_DECL va_list ap
63 # define VA_START(f) va_start(ap, f)
64 # define VA_SHIFT(v,t) ; /* no-op for ANSI */
65 # define VA_END va_end(ap)
67 # if defined(HAVE_VARARGS_H)
70 # define VA_LOCAL_DECL va_list ap
71 # define VA_START(f) va_start(ap) /* f is ignored! */
72 # define VA_SHIFT(v,t) v = va_arg(ap,t)
73 # define VA_END va_end(ap)
75 /*XX ** NO VARARGS ** XX*/
79 /*int snprintf (char *str, size_t count, const char *fmt, ...);*/
80 /*int vsnprintf (char *str, size_t count, const char *fmt, va_list arg);*/
82 static void dopr (char *buffer, size_t maxlen, const char *format,
84 static void fmtstr (char *buffer, size_t *currlen, size_t maxlen,
85 char *value, int flags, int min, int max);
86 static void fmtint (char *buffer, size_t *currlen, size_t maxlen,
87 long value, int base, int min, int max, int flags);
88 static void fmtfp (char *buffer, size_t *currlen, size_t maxlen,
89 long double fvalue, int min, int max, int flags);
90 static void dopr_outch (char *buffer, size_t *currlen, size_t maxlen, char c );
93 * dopr(): poor man's version of doprintf
96 /* format read states */
97 #define DP_S_DEFAULT 0
106 /* format flags - Bits */
107 #define DP_F_MINUS (1 << 0)
108 #define DP_F_PLUS (1 << 1)
109 #define DP_F_SPACE (1 << 2)
110 #define DP_F_NUM (1 << 3)
111 #define DP_F_ZERO (1 << 4)
112 #define DP_F_UP (1 << 5)
113 #define DP_F_UNSIGNED (1 << 6)
115 /* Conversion Flags */
118 #define DP_C_LDOUBLE 3
120 #define char_to_int(p) (p - '0')
122 #define MAX(p,q) ((p >= q) ? p : q)
124 static void dopr (char *buffer, size_t maxlen, const char *format, va_list args)
137 state = DP_S_DEFAULT;
138 currlen = flags = cflags = min = 0;
142 while (state != DP_S_DONE)
144 if ((ch == '\0') || (currlen >= maxlen))
153 dopr_outch (buffer, &currlen, maxlen, ch);
185 if (isdigit((unsigned char)ch))
187 min = 10*min + char_to_int (ch);
192 min = va_arg (args, int);
209 if (isdigit((unsigned char)ch))
213 max = 10*max + char_to_int (ch);
218 max = va_arg (args, int);
226 /* Currently, we don't support Long Long, bummer */
238 cflags = DP_C_LDOUBLE;
251 if (cflags == DP_C_SHORT)
252 value = va_arg (args, short int);
253 else if (cflags == DP_C_LONG)
254 value = va_arg (args, long int);
256 value = va_arg (args, int);
257 fmtint (buffer, &currlen, maxlen, value, 10, min, max, flags);
260 flags |= DP_F_UNSIGNED;
261 if (cflags == DP_C_SHORT)
262 value = va_arg (args, unsigned short int);
263 else if (cflags == DP_C_LONG)
264 value = va_arg (args, unsigned long int);
266 value = va_arg (args, unsigned int);
267 fmtint (buffer, &currlen, maxlen, value, 8, min, max, flags);
270 flags |= DP_F_UNSIGNED;
271 if (cflags == DP_C_SHORT)
272 value = va_arg (args, unsigned short int);
273 else if (cflags == DP_C_LONG)
274 value = va_arg (args, unsigned long int);
276 value = va_arg (args, unsigned int);
277 fmtint (buffer, &currlen, maxlen, value, 10, min, max, flags);
282 flags |= DP_F_UNSIGNED;
283 if (cflags == DP_C_SHORT)
284 value = va_arg (args, unsigned short int);
285 else if (cflags == DP_C_LONG)
286 value = va_arg (args, unsigned long int);
288 value = va_arg (args, unsigned int);
289 fmtint (buffer, &currlen, maxlen, value, 16, min, max, flags);
292 if (cflags == DP_C_LDOUBLE)
293 fvalue = va_arg (args, long double);
295 fvalue = va_arg (args, double);
296 /* um, floating point? */
297 fmtfp (buffer, &currlen, maxlen, fvalue, min, max, flags);
302 if (cflags == DP_C_LDOUBLE)
303 fvalue = va_arg (args, long double);
305 fvalue = va_arg (args, double);
310 if (cflags == DP_C_LDOUBLE)
311 fvalue = va_arg (args, long double);
313 fvalue = va_arg (args, double);
316 dopr_outch (buffer, &currlen, maxlen, va_arg (args, int));
319 strvalue = va_arg (args, char *);
321 max = maxlen; /* ie, no max */
322 fmtstr (buffer, &currlen, maxlen, strvalue, flags, min, max);
325 strvalue = va_arg (args, void *);
326 fmtint (buffer, &currlen, maxlen, (long) strvalue, 16, min, max, flags);
329 if (cflags == DP_C_SHORT)
332 num = va_arg (args, short int *);
335 else if (cflags == DP_C_LONG)
338 num = va_arg (args, long int *);
344 num = va_arg (args, int *);
349 dopr_outch (buffer, &currlen, maxlen, ch);
352 /* not supported yet, treat as next char */
360 state = DP_S_DEFAULT;
361 flags = cflags = min = 0;
368 break; /* some picky compilers need this */
371 if (currlen < maxlen - 1)
372 buffer[currlen] = '\0';
374 buffer[maxlen - 1] = '\0';
377 static void fmtstr (char *buffer, size_t *currlen, size_t maxlen,
378 char *value, int flags, int min, int max)
380 int padlen, strln; /* amount to pad */
388 for (strln = 0; value[strln]; ++strln); /* strlen */
389 padlen = min - strln;
392 if (flags & DP_F_MINUS)
393 padlen = -padlen; /* Left Justify */
395 while ((padlen > 0) && (cnt < max))
397 dopr_outch (buffer, currlen, maxlen, ' ');
401 while (*value && (cnt < max))
403 dopr_outch (buffer, currlen, maxlen, *value++);
406 while ((padlen < 0) && (cnt < max))
408 dopr_outch (buffer, currlen, maxlen, ' ');
414 /* Have to handle DP_F_NUM (ie 0x and 0 alternates) */
416 static void fmtint (char *buffer, size_t *currlen, size_t maxlen,
417 long value, int base, int min, int max, int flags)
420 unsigned long uvalue;
423 int spadlen = 0; /* amount to space pad */
424 int zpadlen = 0; /* amount to zero pad */
432 if(!(flags & DP_F_UNSIGNED))
439 if (flags & DP_F_PLUS) /* Do a sign (+/i) */
442 if (flags & DP_F_SPACE)
446 if (flags & DP_F_UP) caps = 1; /* Should characters be upper case? */
450 (caps? "0123456789ABCDEF":"0123456789abcdef")
451 [uvalue % (unsigned)base ];
452 uvalue = (uvalue / (unsigned)base );
453 } while(uvalue && (place < 20));
454 if (place == 20) place--;
457 zpadlen = max - place;
458 spadlen = min - MAX (max, place) - (signvalue ? 1 : 0);
459 if (zpadlen < 0) zpadlen = 0;
460 if (spadlen < 0) spadlen = 0;
461 if (flags & DP_F_ZERO)
463 zpadlen = MAX(zpadlen, spadlen);
466 if (flags & DP_F_MINUS)
467 spadlen = -spadlen; /* Left Justifty */
469 #ifdef DEBUG_SNPRINTF
470 dprint (1, (debugfile, "zpad: %d, spad: %d, min: %d, max: %d, place: %d\n",
471 zpadlen, spadlen, min, max, place));
477 dopr_outch (buffer, currlen, maxlen, ' ');
483 dopr_outch (buffer, currlen, maxlen, signvalue);
490 dopr_outch (buffer, currlen, maxlen, '0');
497 dopr_outch (buffer, currlen, maxlen, convert[--place]);
499 /* Left Justified spaces */
500 while (spadlen < 0) {
501 dopr_outch (buffer, currlen, maxlen, ' ');
506 static long double abs_val (long double value)
508 long double result = value;
516 static long double pow10 (int exp)
518 long double result = 1;
529 static long round (long double value)
534 value = value - intpart;
541 static void fmtfp (char *buffer, size_t *currlen, size_t maxlen,
542 long double fvalue, int min, int max, int flags)
550 int padlen = 0; /* amount to pad */
557 * AIX manpage says the default is 0, but Solaris says the default
558 * is 6, and sprintf on AIX defaults to 6
563 ufvalue = abs_val (fvalue);
568 if (flags & DP_F_PLUS) /* Do a sign (+/i) */
571 if (flags & DP_F_SPACE)
575 if (flags & DP_F_UP) caps = 1; /* Should characters be upper case? */
581 * Sorry, we only support 9 digits past the decimal because of our
587 /* We "cheat" by converting the fractional part to integer by
588 * multiplying by a factor of 10
590 fracpart = round ((pow10 (max)) * (ufvalue - intpart));
592 if (fracpart >= pow10 (max))
595 fracpart -= pow10 (max);
598 #ifdef DEBUG_SNPRINTF
599 dprint (1, (debugfile, "fmtfp: %f =? %d.%d\n", fvalue, intpart, fracpart));
602 /* Convert integer part */
605 (caps? "0123456789ABCDEF":"0123456789abcdef")[intpart % 10];
606 intpart = (intpart / 10);
607 } while(intpart && (iplace < 20));
608 if (iplace == 20) iplace--;
609 iconvert[iplace] = 0;
611 /* Convert fractional part */
614 (caps? "0123456789ABCDEF":"0123456789abcdef")[fracpart % 10];
615 fracpart = (fracpart / 10);
616 } while(fracpart && (fplace < 20));
617 if (fplace == 20) fplace--;
618 fconvert[fplace] = 0;
620 /* -1 for decimal point, another -1 if we are printing a sign */
621 padlen = min - iplace - max - 1 - ((signvalue) ? 1 : 0);
622 zpadlen = max - fplace;
627 if (flags & DP_F_MINUS)
628 padlen = -padlen; /* Left Justifty */
630 if ((flags & DP_F_ZERO) && (padlen > 0))
634 dopr_outch (buffer, currlen, maxlen, signvalue);
640 dopr_outch (buffer, currlen, maxlen, '0');
646 dopr_outch (buffer, currlen, maxlen, ' ');
650 dopr_outch (buffer, currlen, maxlen, signvalue);
653 dopr_outch (buffer, currlen, maxlen, iconvert[--iplace]);
656 * Decimal point. This should probably use locale to find the correct
659 dopr_outch (buffer, currlen, maxlen, '.');
662 dopr_outch (buffer, currlen, maxlen, fconvert[--fplace]);
666 dopr_outch (buffer, currlen, maxlen, '0');
672 dopr_outch (buffer, currlen, maxlen, ' ');
677 static void dopr_outch (char *buffer, size_t *currlen, size_t maxlen, char c)
679 if (*currlen < maxlen)
680 buffer[(*currlen)++] = c;
682 #endif /* !defined(HAVE_SNPRINTF) || !defined(HAVE_VSNPRINTF) */
684 #ifndef HAVE_VSNPRINTF
685 int vsnprintf (char *str, size_t count, const char *fmt, va_list args)
688 dopr(str, count, fmt, args);
691 #endif /* !HAVE_VSNPRINTF */
693 #ifndef HAVE_SNPRINTF
696 int snprintf (char *str,size_t count,const char *fmt,...)
698 int snprintf (va_alist) va_dcl
709 VA_SHIFT (str, char *);
710 VA_SHIFT (count, size_t );
711 VA_SHIFT (fmt, char *);
712 (void) vsnprintf(str, count, fmt, ap);
719 #define LONG_STRING 1024
723 char buf1[LONG_STRING];
724 char buf2[LONG_STRING];
739 double fp_nums[] = { -1.5, 134.21, 91340.2, 341.1234, 0203.9, 0.96, 0.996,
740 0.9996, 1.996, 4.136, 0};
753 long int_nums[] = { -1, 134, 91340, 341, 0203, 0};
758 printf ("Testing snprintf format codes against system sprintf...\n");
760 for (x = 0; fp_fmt[x] != NULL ; x++)
761 for (y = 0; fp_nums[y] != 0 ; y++)
763 snprintf (buf1, sizeof (buf1), fp_fmt[x], fp_nums[y]);
764 sprintf (buf2, fp_fmt[x], fp_nums[y]);
765 if (strcmp (buf1, buf2))
767 printf("snprintf doesn't match Format: %s\n\tsnprintf = %s\n\tsprintf = %s\n", /* __SPRINTF_CHECKED__ */
768 fp_fmt[x], buf1, buf2);
774 for (x = 0; int_fmt[x] != NULL ; x++)
775 for (y = 0; int_nums[y] != 0 ; y++)
777 snprintf (buf1, sizeof (buf1), int_fmt[x], int_nums[y]);
778 sprintf (buf2, int_fmt[x], int_nums[y]);
779 if (strcmp (buf1, buf2))
781 printf("snprintf doesn't match Format: %s\n\tsnprintf = %s\n\tsprintf = %s\n", /* __SPRINTF_CHECKED__ */
782 int_fmt[x], buf1, buf2);
787 printf ("%d tests failed out of %d.\n", fail, num);
789 #endif /* SNPRINTF_TEST */
791 #endif /* !HAVE_SNPRINTF */