2 * Copyright (c) 1990, 1993
3 * The Regents of the University of California. All rights reserved.
5 * This code is derived from software contributed to Berkeley by
8 * Copyright (c) 2011 The FreeBSD Foundation
10 * Portions of this software were developed by David Chisnall
11 * under sponsorship from the FreeBSD Foundation.
13 * Redistribution and use in source and binary forms, with or without
14 * modification, are permitted provided that the following conditions
16 * 1. Redistributions of source code must retain the above copyright
17 * notice, this list of conditions and the following disclaimer.
18 * 2. Redistributions in binary form must reproduce the above copyright
19 * notice, this list of conditions and the following disclaimer in the
20 * documentation and/or other materials provided with the distribution.
21 * 3. Neither the name of the University nor the names of its contributors
22 * may be used to endorse or promote products derived from this software
23 * without specific prior written permission.
25 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
26 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
28 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
29 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
30 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
31 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
32 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
33 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
34 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
38 #if defined(LIBC_SCCS) && !defined(lint)
39 static char sccsid[] = "@(#)vfprintf.c 8.1 (Berkeley) 6/4/93";
40 #endif /* LIBC_SCCS and not lint */
41 #include <sys/cdefs.h>
42 __FBSDID("$FreeBSD$");
45 * Actual printf innards.
47 * This code is large and complicated...
50 #include "namespace.h"
51 #include <sys/types.h>
66 #include "xlocale_private.h"
67 #include "un-namespace.h"
69 #include "libc_private.h"
72 #include "printflocal.h"
74 static int __sprint(FILE *, struct __suio *, locale_t);
75 static int __sbprintf(FILE *, locale_t, const char *, va_list) __printflike(3, 0)
77 static char *__wcsconv(wchar_t *, int);
80 #include "printfcommon.h"
82 struct grouping_state {
83 char *thousands_sep; /* locale-specific thousands separator */
84 int thousep_len; /* length of thousands_sep */
85 const char *grouping; /* locale-specific numeric grouping rules */
86 int lead; /* sig figs before decimal or group sep */
87 int nseps; /* number of group separators with ' */
88 int nrepeats; /* number of repeats of the last group */
92 * Initialize the thousands' grouping state in preparation to print a
93 * number with ndigits digits. This routine returns the total number
94 * of bytes that will be needed.
97 grouping_init(struct grouping_state *gs, int ndigits, locale_t loc)
101 locale = localeconv_l(loc);
102 gs->grouping = locale->grouping;
103 gs->thousands_sep = locale->thousands_sep;
104 gs->thousep_len = strlen(gs->thousands_sep);
106 gs->nseps = gs->nrepeats = 0;
108 while (*gs->grouping != CHAR_MAX) {
109 if (gs->lead <= *gs->grouping)
111 gs->lead -= *gs->grouping;
112 if (*(gs->grouping+1)) {
118 return ((gs->nseps + gs->nrepeats) * gs->thousep_len);
122 * Print a number with thousands' separators.
125 grouping_print(struct grouping_state *gs, struct io_state *iop,
126 const CHAR *cp, const CHAR *ep, locale_t locale)
128 const CHAR *cp0 = cp;
130 if (io_printandpad(iop, cp, ep, gs->lead, zeroes, locale))
133 while (gs->nseps > 0 || gs->nrepeats > 0) {
134 if (gs->nrepeats > 0)
140 if (io_print(iop, gs->thousands_sep, gs->thousep_len, locale))
142 if (io_printandpad(iop, cp, ep, *gs->grouping, zeroes, locale))
152 * Flush out all the vectors defined by the given uio,
153 * then reset it so that it can be reused.
156 __sprint(FILE *fp, struct __suio *uio, locale_t locale)
160 if (uio->uio_resid == 0) {
164 err = __sfvwrite(fp, uio);
171 * Helper function for `fprintf to unbuffered unix file': creates a
172 * temporary buffer. We only work on write-only files; this avoids
173 * worries about ungetc buffers and so forth.
176 __sbprintf(FILE *fp, locale_t locale, const char *fmt, va_list ap)
179 FILE fake = FAKE_FILE;
180 unsigned char buf[BUFSIZ];
182 /* XXX This is probably not needed. */
183 if (prepwrite(fp) != 0)
186 /* copy the important variables */
187 fake._flags = fp->_flags & ~__SNBF;
188 fake._file = fp->_file;
189 fake._cookie = fp->_cookie;
190 fake._write = fp->_write;
191 fake._orientation = fp->_orientation;
192 fake._mbstate = fp->_mbstate;
194 /* set up the buffer */
195 fake._bf._base = fake._p = buf;
196 fake._bf._size = fake._w = sizeof(buf);
197 fake._lbfsize = 0; /* not actually used, but Just In Case */
199 /* do the work, then copy any error status */
200 ret = __vfprintf(&fake, locale, fmt, ap);
201 if (ret >= 0 && __fflush(&fake))
203 if (fake._flags & __SERR)
204 fp->_flags |= __SERR;
209 * Convert a wide character string argument for the %ls format to a multibyte
210 * string representation. If not -1, prec specifies the maximum number of
211 * bytes to output, and also means that we can't assume that the wide char.
212 * string ends is null-terminated.
215 __wcsconv(wchar_t *wcsarg, int prec)
217 static const mbstate_t initial;
219 char buf[MB_LEN_MAX];
224 /* Allocate space for the maximum number of bytes we could output. */
228 nbytes = wcsrtombs(NULL, (const wchar_t **)&p, 0, &mbs);
229 if (nbytes == (size_t)-1)
233 * Optimisation: if the output precision is small enough,
234 * just allocate enough memory for the maximum instead of
235 * scanning the string.
244 clen = wcrtomb(buf, *p++, &mbs);
245 if (clen == 0 || clen == (size_t)-1 ||
246 nbytes + clen > prec)
252 if ((convbuf = malloc(nbytes + 1)) == NULL)
255 /* Fill the output buffer. */
258 if ((nbytes = wcsrtombs(convbuf, (const wchar_t **)&p,
259 nbytes, &mbs)) == (size_t)-1) {
263 convbuf[nbytes] = '\0';
271 vfprintf_l(FILE * __restrict fp, locale_t locale, const char * __restrict fmt0,
278 /* optimise fprintf(stderr) (and other unbuffered Unix files) */
279 if ((fp->_flags & (__SNBF|__SWR|__SRW)) == (__SNBF|__SWR) &&
281 ret = __sbprintf(fp, locale, fmt0, ap);
283 ret = __vfprintf(fp, locale, fmt0, ap);
288 vfprintf(FILE * __restrict fp, const char * __restrict fmt0, va_list ap)
290 return vfprintf_l(fp, __get_locale(), fmt0, ap);
294 * The size of the buffer we use as scratch space for integer
295 * conversions, among other things. We need enough space to
296 * write a uintmax_t in octal (plus one byte).
298 #if UINTMAX_MAX <= UINT64_MAX
301 #error "BUF must be large enough to format a uintmax_t"
305 * Non-MT-safe version
308 __vfprintf(FILE *fp, locale_t locale, const char *fmt0, va_list ap)
310 char *fmt; /* format string */
311 int ch; /* character from fmt */
312 int n, n2; /* handy integer (short term usage) */
313 char *cp; /* handy char pointer (short term usage) */
314 int flags; /* flags as above */
315 int ret; /* return value accumulator */
316 int width; /* width from format (%8d), or 0 */
317 int prec; /* precision from format; <0 for N/A */
318 char sign; /* sign prefix (' ', '+', '-', or \0) */
319 struct grouping_state gs; /* thousands' grouping info */
321 #ifndef NO_FLOATING_POINT
323 * We can decompose the printed representation of floating
324 * point numbers into several parts, some of which may be empty:
326 * [+|-| ] [0x|0X] MMM . NNN [e|E|p|P] [+|-] ZZ
329 * A: 'sign' holds this value if present; '\0' otherwise
330 * B: ox[1] holds the 'x' or 'X'; '\0' if not hexadecimal
331 * C: cp points to the string MMMNNN. Leading and trailing
332 * zeros are not in the string and must be added.
333 * D: expchar holds this character; '\0' if no exponent, e.g. %f
334 * F: at least two digits for decimal, at least one digit for hex
336 char *decimal_point; /* locale specific decimal point */
337 int decpt_len; /* length of decimal_point */
338 int signflag; /* true if float is negative */
339 union { /* floating point arguments %[aAeEfFgG] */
343 int expt; /* integer value of exponent */
344 char expchar; /* exponent character: [eEpP\0] */
345 char *dtoaend; /* pointer to end of converted digits */
346 int expsize; /* character count for expstr */
347 int ndig; /* actual number of digits returned by dtoa */
348 char expstr[MAXEXPDIG+2]; /* buffer for exponent string: e+ZZZ */
349 char *dtoaresult; /* buffer allocated by dtoa */
351 u_long ulval; /* integer arguments %[diouxX] */
352 uintmax_t ujval; /* %j, %ll, %q, %t, %z integers */
353 int base; /* base for [diouxX] conversion */
354 int dprec; /* a copy of prec if [diouxX], 0 otherwise */
355 int realsz; /* field size expanded by dprec, sign, etc */
356 int size; /* size of converted field or string */
357 int prsize; /* max size of printed field */
358 const char *xdigs; /* digits for %[xX] conversion */
359 struct io_state io; /* I/O buffering state */
360 char buf[BUF]; /* buffer with space for digits of uintmax_t */
361 char ox[2]; /* space for 0x; ox[1] is either x, X, or \0 */
362 union arg *argtable; /* args, built due to positional arg */
363 union arg statargtable [STATIC_ARG_TBL_SIZE];
364 int nextarg; /* 1-based argument index */
365 va_list orgap; /* original argument pointer */
366 char *convbuf; /* wide to multibyte conversion result */
368 static const char xdigs_lower[16] = "0123456789abcdef";
369 static const char xdigs_upper[16] = "0123456789ABCDEF";
371 /* BEWARE, these `goto error' on error. */
372 #define PRINT(ptr, len) { \
373 if (io_print(&io, (ptr), (len), locale)) \
376 #define PAD(howmany, with) { \
377 if (io_pad(&io, (howmany), (with), locale)) \
380 #define PRINTANDPAD(p, ep, len, with) { \
381 if (io_printandpad(&io, (p), (ep), (len), (with), locale)) \
385 if (io_flush(&io, locale)) \
390 * Get the argument indexed by nextarg. If the argument table is
391 * built, use it to get the argument. If its not, get the next
392 * argument (and arguments must be gotten sequentially).
394 #define GETARG(type) \
395 ((argtable != NULL) ? *((type*)(&argtable[nextarg++])) : \
396 (nextarg++, va_arg(ap, type)))
399 * To extend shorts properly, we need both signed and unsigned
400 * argument extraction methods.
403 (flags&LONGINT ? GETARG(long) : \
404 flags&SHORTINT ? (long)(short)GETARG(int) : \
405 flags&CHARINT ? (long)(signed char)GETARG(int) : \
408 (flags&LONGINT ? GETARG(u_long) : \
409 flags&SHORTINT ? (u_long)(u_short)GETARG(int) : \
410 flags&CHARINT ? (u_long)(u_char)GETARG(int) : \
411 (u_long)GETARG(u_int))
412 #define INTMAX_SIZE (INTMAXT|SIZET|PTRDIFFT|LLONGINT)
414 (flags&INTMAXT ? GETARG(intmax_t) : \
415 flags&SIZET ? (intmax_t)GETARG(ssize_t) : \
416 flags&PTRDIFFT ? (intmax_t)GETARG(ptrdiff_t) : \
417 (intmax_t)GETARG(long long))
419 (flags&INTMAXT ? GETARG(uintmax_t) : \
420 flags&SIZET ? (uintmax_t)GETARG(size_t) : \
421 flags&PTRDIFFT ? (uintmax_t)GETARG(ptrdiff_t) : \
422 (uintmax_t)GETARG(unsigned long long))
425 * Get * arguments, including the form *nn$. Preserve the nextarg
426 * that the argument can be gotten once the type is determined.
428 #define GETASTER(val) \
431 while (is_digit(*cp)) { \
432 n2 = 10 * n2 + to_digit(*cp); \
436 int hold = nextarg; \
437 if (argtable == NULL) { \
438 argtable = statargtable; \
439 if (__find_arguments (fmt0, orgap, &argtable)) { \
445 val = GETARG (int); \
449 val = GETARG (int); \
452 if (__use_xprintf == 0 && getenv("USE_XPRINTF"))
454 if (__use_xprintf > 0)
455 return (__xvprintf(fp, fmt0, ap));
457 /* sorry, fprintf(read_only_file, "") returns EOF, not 0 */
458 if (prepwrite(fp) != 0) {
470 #ifndef NO_FLOATING_POINT
472 decimal_point = localeconv_l(locale)->decimal_point;
473 /* The overwhelmingly common case is decpt_len == 1. */
474 decpt_len = (decimal_point[1] == '\0' ? 1 : strlen(decimal_point));
478 * Scan the format for conversions (`%' character).
481 for (cp = fmt; (ch = *fmt) != '\0' && ch != '%'; fmt++)
483 if ((n = fmt - cp) != 0) {
484 if ((unsigned)ret + n > INT_MAX) {
494 fmt++; /* skip over '%' */
505 reswitch: switch (ch) {
508 * ``If the space and + flags both appear, the space
509 * flag will be ignored.''
520 * ``A negative field width argument is taken as a
521 * - flag followed by a positive field width.''
523 * They don't exclude field widths read from args.
540 if ((ch = *fmt++) == '*') {
545 while (is_digit(ch)) {
546 prec = 10 * prec + to_digit(ch);
552 * ``Note that 0 is taken as a flag, not as the
553 * beginning of a field width.''
558 case '1': case '2': case '3': case '4':
559 case '5': case '6': case '7': case '8': case '9':
562 n = 10 * n + to_digit(ch);
564 } while (is_digit(ch));
567 if (argtable == NULL) {
568 argtable = statargtable;
569 if (__find_arguments (fmt0, orgap,
579 #ifndef NO_FLOATING_POINT
585 if (flags & SHORTINT) {
595 if (flags & LONGINT) {
602 flags |= LLONGINT; /* not necessarily */
614 if (flags & LONGINT) {
615 static const mbstate_t initial;
620 mbseqlen = wcrtomb(cp = buf,
621 (wchar_t)GETARG(wint_t), &mbs);
622 if (mbseqlen == (size_t)-1) {
623 fp->_flags |= __SERR;
626 size = (int)mbseqlen;
628 *(cp = buf) = GETARG(int);
638 if (flags & INTMAX_SIZE) {
640 if ((intmax_t)ujval < 0) {
646 if ((long)ulval < 0) {
653 #ifndef NO_FLOATING_POINT
667 if (dtoaresult != NULL)
668 freedtoa(dtoaresult);
669 if (flags & LONGDBL) {
670 fparg.ldbl = GETARG(long double);
672 __hldtoa(fparg.ldbl, xdigs, prec,
673 &expt, &signflag, &dtoaend);
675 fparg.dbl = GETARG(double);
677 __hdtoa(fparg.dbl, xdigs, prec,
678 &expt, &signflag, &dtoaend);
688 if (prec < 0) /* account for digit before decpt */
699 expchar = ch - ('g' - 'e');
705 if (dtoaresult != NULL)
706 freedtoa(dtoaresult);
707 if (flags & LONGDBL) {
708 fparg.ldbl = GETARG(long double);
710 __ldtoa(&fparg.ldbl, expchar ? 2 : 3, prec,
711 &expt, &signflag, &dtoaend);
713 fparg.dbl = GETARG(double);
715 dtoa(fparg.dbl, expchar ? 2 : 3, prec,
716 &expt, &signflag, &dtoaend);
723 if (expt == INT_MAX) { /* inf or nan */
725 cp = (ch >= 'a') ? "nan" : "NAN";
728 cp = (ch >= 'a') ? "inf" : "INF";
735 if (ch == 'g' || ch == 'G') {
736 if (expt > -4 && expt <= prec) {
737 /* Make %[gG] smell like %[fF] */
747 * Make %[gG] smell like %[eE], but
748 * trim trailing zeroes if no # flag.
755 expsize = exponent(expstr, expt - 1, expchar);
756 size = expsize + prec;
757 if (prec > 1 || flags & ALT)
760 /* space for digits before decimal point */
765 /* space for decimal pt and following digits */
766 if (prec || flags & ALT)
767 size += prec + decpt_len;
768 if ((flags & GROUPING) && expt > 0)
769 size += grouping_init(&gs, expt, locale);
772 #endif /* !NO_FLOATING_POINT */
775 * Assignment-like behavior is specified if the
776 * value overflows or is otherwise unrepresentable.
777 * C99 says to use `signed char' for %hhn conversions.
779 if (flags & LLONGINT)
780 *GETARG(long long *) = ret;
781 else if (flags & SIZET)
782 *GETARG(ssize_t *) = (ssize_t)ret;
783 else if (flags & PTRDIFFT)
784 *GETARG(ptrdiff_t *) = ret;
785 else if (flags & INTMAXT)
786 *GETARG(intmax_t *) = ret;
787 else if (flags & LONGINT)
788 *GETARG(long *) = ret;
789 else if (flags & SHORTINT)
790 *GETARG(short *) = ret;
791 else if (flags & CHARINT)
792 *GETARG(signed char *) = ret;
794 *GETARG(int *) = ret;
795 continue; /* no output */
800 if (flags & INTMAX_SIZE)
808 * ``The argument shall be a pointer to void. The
809 * value of the pointer is converted to a sequence
810 * of printable characters, in an implementation-
814 ujval = (uintmax_t)(uintptr_t)GETARG(void *);
817 flags = flags | INTMAXT;
824 if (flags & LONGINT) {
829 if ((wcp = GETARG(wchar_t *)) == NULL)
832 convbuf = __wcsconv(wcp, prec);
833 if (convbuf == NULL) {
834 fp->_flags |= __SERR;
839 } else if ((cp = GETARG(char *)) == NULL)
841 size = (prec >= 0) ? strnlen(cp, prec) : strlen(cp);
848 if (flags & INTMAX_SIZE)
860 if (flags & INTMAX_SIZE)
865 /* leading 0x/X only if non-zero */
867 (flags & INTMAX_SIZE ? ujval != 0 : ulval != 0))
871 /* unsigned conversions */
874 * ``... diouXx conversions ... if a precision is
875 * specified, the 0 flag will be ignored.''
878 number: if ((dprec = prec) >= 0)
882 * ``The result of converting a zero value with an
883 * explicit precision of zero is no characters.''
886 * ``The C Standard is clear enough as is. The call
887 * printf("%#.0o", 0) should print 0.''
888 * -- Defect Report #151
891 if (flags & INTMAX_SIZE) {
892 if (ujval != 0 || prec != 0 ||
893 (flags & ALT && base == 8))
894 cp = __ujtoa(ujval, cp, base,
897 if (ulval != 0 || prec != 0 ||
898 (flags & ALT && base == 8))
899 cp = __ultoa(ulval, cp, base,
902 size = buf + BUF - cp;
903 if (size > BUF) /* should never happen */
905 if ((flags & GROUPING) && size != 0)
906 size += grouping_init(&gs, size, locale);
908 default: /* "%?" prints ?, unless ? is NUL */
911 /* pretend it was %c with argument ch */
920 * All reasonable formats wind up here. At this point, `cp'
921 * points to a string which (if not flags&LADJUST) should be
922 * padded out to `width' places. If flags&ZEROPAD, it should
923 * first be prefixed by any sign or other prefix; otherwise,
924 * it should be blank padded before the prefix is emitted.
925 * After any left-hand padding and prefixing, emit zeroes
926 * required by a decimal [diouxX] precision, then print the
927 * string proper, then emit zeroes required by any leftover
928 * floating precision; finally, if LADJUST, pad with blanks.
930 * Compute actual size, so we know how much to pad.
931 * size excludes decimal prec; realsz includes it.
933 realsz = dprec > size ? dprec : size;
939 prsize = width > realsz ? width : realsz;
940 if ((unsigned)ret + prsize > INT_MAX) {
946 /* right-adjusting blank padding */
947 if ((flags & (LADJUST|ZEROPAD)) == 0)
948 PAD(width - realsz, blanks);
954 if (ox[1]) { /* ox[1] is either x, X, or \0 */
959 /* right-adjusting zero padding */
960 if ((flags & (LADJUST|ZEROPAD)) == ZEROPAD)
961 PAD(width - realsz, zeroes);
963 /* the string or number proper */
964 #ifndef NO_FLOATING_POINT
965 if ((flags & FPT) == 0) {
967 /* leading zeroes from decimal precision */
968 PAD(dprec - size, zeroes);
970 if (grouping_print(&gs, &io, cp, buf+BUF, locale) < 0)
975 #ifndef NO_FLOATING_POINT
976 } else { /* glue together f_p fragments */
977 if (!expchar) { /* %[fF] or sufficiently short %[gG] */
980 if (prec || flags & ALT)
981 PRINT(decimal_point,decpt_len);
983 /* already handled initial 0's */
987 n = grouping_print(&gs, &io,
988 cp, dtoaend, locale);
993 PRINTANDPAD(cp, dtoaend,
997 if (prec || flags & ALT)
998 PRINT(decimal_point,decpt_len);
1000 PRINTANDPAD(cp, dtoaend, prec, zeroes);
1001 } else { /* %[eE] or sufficiently long %[gG] */
1002 if (prec > 1 || flags & ALT) {
1004 PRINT(decimal_point, decpt_len);
1006 PAD(prec - ndig, zeroes);
1009 PRINT(expstr, expsize);
1013 /* left-adjusting padding (always blank) */
1014 if (flags & LADJUST)
1015 PAD(width - realsz, blanks);
1017 /* finally, adjust ret */
1020 FLUSH(); /* copy out the I/O vectors */
1026 #ifndef NO_FLOATING_POINT
1027 if (dtoaresult != NULL)
1028 freedtoa(dtoaresult);
1030 if (convbuf != NULL)
1034 if ((argtable != NULL) && (argtable != statargtable))