8 /* Define this as a fall through, HAVE_STDARG_H is probably already set */
10 #define HAVE_VARARGS_H
12 /**************************************************************
14 * Patrick Powell Tue Apr 11 09:48:21 PDT 1995
15 * A bombproof version of doprnt (dopr) included.
16 * Sigh. This sort of thing is always nasty do deal with. Note that
17 * the version here does not include floating point...
19 * snprintf() is used instead of sprintf() as it does limit checks
20 * for string length. This covers a nasty loophole.
22 * The other functions are there to prevent NULL pointers from
23 * causing nast effects.
26 * Brandon Long (blong@fiction.net) 9/15/96 for mutt 0.43
27 * This was ugly. It is still ugly. I opted out of floating point
28 * numbers, but the formatter understands just about everything
29 * from the normal C string format, at least as far as I can tell from
30 * the Solaris 2.5 printf(3S) man page.
32 * Brandon Long (blong@fiction.net) 10/22/97 for mutt 0.87.1
33 * Ok, added some minimal floating point support, which means this
34 * probably requires libm on most operating systems. Don't yet
35 * support the exponent (e,E) and sigfig (g,G). Also, fmtint()
36 * was pretty badly broken, it just wasn't being exercised in ways
37 * which showed it, so that's been fixed. Also, formated the code
38 * to mutt conventions, and removed dead code left over from the
39 * original. Also, there is now a builtin-test, just compile with:
40 * gcc -DTEST_SNPRINTF -o snprintf snprintf.c -lm
41 * and run snprintf for results.
43 * Wouter Wijngaards(wouter@nlnetlabs.nl) 2/09/2010 for unbound.
44 * Limited support for %g. Does not do the exponents for the before-dot.
46 **************************************************************/
49 /* varargs declarations: */
51 #if defined(HAVE_STDARG_H)
53 # define HAVE_STDARGS /* let's hope that works everywhere (mj) */
54 # define VA_LOCAL_DECL va_list ap
55 # define VA_START(f) va_start(ap, f)
56 # define VA_SHIFT(v,t) ; /* no-op for ANSI */
57 # define VA_END va_end(ap)
59 # if defined(HAVE_VARARGS_H)
62 # define VA_LOCAL_DECL va_list ap
63 # define VA_START(f) va_start(ap) /* f is ignored! */
64 # define VA_SHIFT(v,t) v = va_arg(ap,t)
65 # define VA_END va_end(ap)
67 /*XX ** NO VARARGS ** XX*/
71 int snprintf (char *str, size_t count, const char *fmt, ...);
72 int vsnprintf (char *str, size_t count, const char *fmt, va_list arg);
74 static void dopr (char *buffer, size_t maxlen, const char *format,
76 static void fmtstr (char *buffer, size_t *currlen, size_t maxlen,
77 char *value, int flags, int min, int max);
78 static void fmtint (char *buffer, size_t *currlen, size_t maxlen,
79 long value, int base, int min, int max, int flags);
80 static void fmtfp (char *buffer, size_t *currlen, size_t maxlen,
81 long double fvalue, int min, int max, int flags, int conv);
82 static void dopr_outch (char *buffer, size_t *currlen, size_t maxlen, char c );
84 int vsnprintf (char *str, size_t count, const char *fmt, va_list args)
87 dopr(str, count, fmt, args);
93 int snprintf (char *str,size_t count,const char *fmt,...)
95 int snprintf (va_alist) va_dcl
106 VA_SHIFT (str, char *);
107 VA_SHIFT (count, size_t );
108 VA_SHIFT (fmt, char *);
109 (void) vsnprintf(str, count, fmt, ap);
115 * dopr(): poor man's version of doprintf
118 /* format read states */
119 #define DP_S_DEFAULT 0
128 /* format flags - Bits */
136 /* Conversion Flags */
139 #define DP_C_LDOUBLE 3
141 #define char_to_int(p) (p - '0')
143 #define MAX(p,q) ((p >= q) ? p : q)
146 static void dopr (char *buffer, size_t maxlen, const char *format, va_list args)
159 state = DP_S_DEFAULT;
160 currlen = flags = cflags = min = 0;
164 while (state != DP_S_DONE)
166 if ((ch == '\0') || (currlen >= maxlen))
175 dopr_outch (buffer, &currlen, maxlen, ch);
209 min = 10*min + char_to_int (ch);
214 min = va_arg (args, int);
235 max = 10*max + char_to_int (ch);
240 max = va_arg (args, int);
248 /* Currently, we don't support Long Long, bummer */
260 cflags = DP_C_LDOUBLE;
273 if (cflags == DP_C_SHORT)
274 value = va_arg (args, int);
275 else if (cflags == DP_C_LONG)
276 value = va_arg (args, long int);
278 value = va_arg (args, int);
279 fmtint (buffer, &currlen, maxlen, value, 10, min, max, flags);
283 if (cflags == DP_C_SHORT)
284 value = va_arg (args, unsigned 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, 8, min, max, flags);
293 if (cflags == DP_C_SHORT)
294 value = va_arg (args, unsigned int);
295 else if (cflags == DP_C_LONG)
296 value = va_arg (args, unsigned long int);
298 value = va_arg (args, unsigned int);
299 fmtint (buffer, &currlen, maxlen, value, 10, min, max, flags);
305 if (cflags == DP_C_SHORT)
306 value = va_arg (args, unsigned int);
307 else if (cflags == DP_C_LONG)
308 value = va_arg (args, unsigned long int);
310 value = va_arg (args, unsigned int);
311 fmtint (buffer, &currlen, maxlen, value, 16, min, max, flags);
314 if (cflags == DP_C_LDOUBLE)
315 fvalue = va_arg (args, long double);
317 fvalue = va_arg (args, double);
318 /* um, floating point? */
319 fmtfp (buffer, &currlen, maxlen, fvalue, min, max, flags, 'f');
324 if (cflags == DP_C_LDOUBLE)
325 fvalue = va_arg (args, long double);
327 fvalue = va_arg (args, double);
332 if (cflags == DP_C_LDOUBLE)
333 fvalue = va_arg (args, long double);
335 fvalue = va_arg (args, double);
336 fmtfp (buffer, &currlen, maxlen, fvalue, min, max, flags, 'g');
339 dopr_outch (buffer, &currlen, maxlen, va_arg (args, int));
342 strvalue = va_arg (args, char *);
344 max = maxlen; /* ie, no max */
345 fmtstr (buffer, &currlen, maxlen, strvalue, flags, min, max);
348 strvalue = va_arg (args, void *);
349 fmtint (buffer, &currlen, maxlen, (long) strvalue, 16, min, max, flags);
352 if (cflags == DP_C_SHORT)
355 num = va_arg (args, short int *);
358 else if (cflags == DP_C_LONG)
361 num = va_arg (args, long int *);
367 num = va_arg (args, int *);
372 dopr_outch (buffer, &currlen, maxlen, ch);
375 /* not supported yet, treat as next char */
383 state = DP_S_DEFAULT;
384 flags = cflags = min = 0;
391 break; /* some picky compilers need this */
394 if (currlen < maxlen - 1)
395 buffer[currlen] = '\0';
397 buffer[maxlen - 1] = '\0';
400 static void fmtstr (char *buffer, size_t *currlen, size_t maxlen,
401 char *value, int flags, int min, int max)
403 int padlen, strln; /* amount to pad */
411 for (strln = 0; value[strln]; ++strln); /* strlen */
412 padlen = min - strln;
415 if (flags & DP_F_MINUS)
416 padlen = -padlen; /* Left Justify */
418 while ((padlen > 0) && (cnt < max))
420 dopr_outch (buffer, currlen, maxlen, ' ');
424 while (*value && (cnt < max))
426 dopr_outch (buffer, currlen, maxlen, *value++);
429 while ((padlen < 0) && (cnt < max))
431 dopr_outch (buffer, currlen, maxlen, ' ');
437 /* Have to handle DP_F_NUM (ie 0x and 0 alternates) */
439 static void fmtint (char *buffer, size_t *currlen, size_t maxlen,
440 long value, int base, int min, int max, int flags)
443 unsigned long uvalue;
446 int spadlen = 0; /* amount to space pad */
447 int zpadlen = 0; /* amount to zero pad */
459 if (flags & DP_F_PLUS) /* Do a sign (+/i) */
462 if (flags & DP_F_SPACE)
465 if (flags & DP_F_UP) caps = 1; /* Should characters be upper case? */
469 (caps? "0123456789ABCDEF":"0123456789abcdef")
470 [uvalue % (unsigned)base ];
471 uvalue = (uvalue / (unsigned)base );
472 } while(uvalue && (place < 20));
473 if (place == 20) place--;
476 zpadlen = max - place;
477 spadlen = min - MAX (max, place) - (signvalue ? 1 : 0);
478 if (zpadlen < 0) zpadlen = 0;
479 if (spadlen < 0) spadlen = 0;
480 if (flags & DP_F_ZERO)
482 zpadlen = MAX(zpadlen, spadlen);
485 if (flags & DP_F_MINUS)
486 spadlen = -spadlen; /* Left Justifty */
488 #ifdef DEBUG_SNPRINTF
489 dprint (1, (debugfile, "zpad: %d, spad: %d, min: %d, max: %d, place: %d\n",
490 zpadlen, spadlen, min, max, place));
496 dopr_outch (buffer, currlen, maxlen, ' ');
502 dopr_outch (buffer, currlen, maxlen, signvalue);
509 dopr_outch (buffer, currlen, maxlen, '0');
516 dopr_outch (buffer, currlen, maxlen, convert[--place]);
518 /* Left Justified spaces */
519 while (spadlen < 0) {
520 dopr_outch (buffer, currlen, maxlen, ' ');
525 static long double abs_val (long double value)
527 long double result = value;
535 static long double compat_pow10 (int exp)
537 long double result = 1;
548 static long compat_round (long double value)
553 value = value - intpart;
560 static void fmtfp (char *buffer, size_t *currlen, size_t maxlen,
561 long double fvalue, int min, int max, int flags, int conv)
569 int padlen = 0; /* amount to pad */
576 * AIX manpage says the default is 0, but Solaris says the default
577 * is 6, and sprintf on AIX defaults to 6
582 ufvalue = abs_val (fvalue);
587 if (flags & DP_F_PLUS) /* Do a sign (+/i) */
590 if (flags & DP_F_SPACE)
594 if (flags & DP_F_UP) caps = 1; /* Should characters be upper case? */
600 * Sorry, we only support 9 digits past the decimal because of our
606 /* We "cheat" by converting the fractional part to integer by
607 * multiplying by a factor of 10
609 fracpart = compat_round ((compat_pow10 (max)) * (ufvalue - intpart));
611 if (fracpart >= compat_pow10 (max))
614 fracpart -= compat_pow10 (max);
617 #ifdef DEBUG_SNPRINTF
618 dprint (1, (debugfile, "fmtfp: %f =? %d.%d\n", fvalue, intpart, fracpart));
621 /* Convert integer part */
624 (caps? "0123456789ABCDEF":"0123456789abcdef")[intpart % 10];
625 intpart = (intpart / 10);
626 } while(intpart && (iplace < 20));
627 if (iplace == 20) iplace--;
628 iconvert[iplace] = 0;
630 /* Convert fractional part */
633 (caps? "0123456789ABCDEF":"0123456789abcdef")[fracpart % 10];
634 fracpart = (fracpart / 10);
635 if(conv == 'g' && fplace == 1 && fconvert[0] == '0') {
636 fplace = 0; /* skip trailing zeroes for %g */
639 } while(fracpart && (fplace < 20));
640 if (fplace == 20) fplace--;
641 fconvert[fplace] = 0;
644 /* -1 for decimal point, another -1 if we are printing a sign */
645 padlen = min - iplace - max - 1 - ((signvalue) ? 1 : 0);
646 zpadlen = max - fplace;
647 } else if(conv == 'g') {
648 /* zpadlen contains number of trailing zeroes removed */
649 padlen = min - iplace - (max-zpadlen) - 1 - ((signvalue) ? 1 : 0);
651 padlen += 1; /* add the decimal dot suppressed */
653 } else zpadlen = (max-zpadlen) - fplace;
659 if (flags & DP_F_MINUS)
660 padlen = -padlen; /* Left Justifty */
662 if ((flags & DP_F_ZERO) && (padlen > 0))
666 dopr_outch (buffer, currlen, maxlen, signvalue);
672 dopr_outch (buffer, currlen, maxlen, '0');
678 dopr_outch (buffer, currlen, maxlen, ' ');
682 dopr_outch (buffer, currlen, maxlen, signvalue);
685 dopr_outch (buffer, currlen, maxlen, iconvert[--iplace]);
687 /* for %g do not output decimal point if no fraction is present */
688 if(conv == 'f' || (conv == 'g' && fplace > 0)) {
690 * Decimal point. This should probably use locale to find the correct
693 dopr_outch (buffer, currlen, maxlen, '.');
698 dopr_outch (buffer, currlen, maxlen, '0');
703 dopr_outch (buffer, currlen, maxlen, fconvert[--fplace]);
707 dopr_outch (buffer, currlen, maxlen, ' ');
712 static void dopr_outch (char *buffer, size_t *currlen, size_t maxlen, char c)
714 if (*currlen < maxlen)
715 buffer[(*currlen)++] = c;
720 #define LONG_STRING 1024
724 char buf1[LONG_STRING];
725 char buf2[LONG_STRING];
740 double fp_nums[] = { -1.5, 134.21, 91340.2, 341.1234, 0203.9, 0.96, 0.996,
741 0.9996, 1.996, 4.136, 0};
754 long int_nums[] = { -1, 134, 91340, 341, 0203, 0};
759 printf ("Testing snprintf format codes against system sprintf...\n");
761 for (x = 0; fp_fmt[x] != NULL ; x++)
762 for (y = 0; fp_nums[y] != 0 ; y++)
764 snprintf (buf1, sizeof (buf1), fp_fmt[x], fp_nums[y]);
765 sprintf (buf2, fp_fmt[x], fp_nums[y]);
766 if (strcmp (buf1, buf2))
768 printf("snprintf doesn't match Format: %s\n\tsnprintf = %s\n\tsprintf = %s\n",
769 fp_fmt[x], buf1, buf2);
775 for (x = 0; int_fmt[x] != NULL ; x++)
776 for (y = 0; int_nums[y] != 0 ; y++)
778 snprintf (buf1, sizeof (buf1), int_fmt[x], int_nums[y]);
779 sprintf (buf2, int_fmt[x], int_nums[y]);
780 if (strcmp (buf1, buf2))
782 printf("snprintf doesn't match Format: %s\n\tsnprintf = %s\n\tsprintf = %s\n",
783 int_fmt[x], buf1, buf2);
788 printf ("%d tests failed out of %d.\n", fail, num);
790 #endif /* SNPRINTF_TEST */
792 #endif /* !HAVE_SNPRINTF */