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
39 #if defined(LIBC_SCCS) && !defined(lint)
40 static char sccsid[] = "@(#)vfprintf.c 8.1 (Berkeley) 6/4/93";
41 #endif /* LIBC_SCCS and not lint */
43 #include <sys/cdefs.h>
44 __FBSDID("$FreeBSD$");
47 * Actual wprintf innards.
49 * Avoid making gratuitous changes to this source file; it should be kept
50 * as close as possible to vfprintf.c for ease of maintenance.
53 #include "namespace.h"
54 #include <sys/types.h>
68 #include "un-namespace.h"
70 #include "libc_private.h"
73 #include "printflocal.h"
74 #include "xlocale_private.h"
76 static int __sprint(FILE *, struct __suio *, locale_t);
77 static int __sbprintf(FILE *, locale_t, const wchar_t *, va_list) __noinline;
78 static wint_t __xfputwc(wchar_t, FILE *, locale_t);
79 static wchar_t *__mbsconv(char *, int);
82 #include "printfcommon.h"
84 struct grouping_state {
85 wchar_t thousands_sep; /* locale-specific thousands separator */
86 const char *grouping; /* locale-specific numeric grouping rules */
87 int lead; /* sig figs before decimal or group sep */
88 int nseps; /* number of group separators with ' */
89 int nrepeats; /* number of repeats of the last group */
92 static const mbstate_t initial_mbs;
95 get_decpt(locale_t locale)
102 nconv = mbrtowc(&decpt, localeconv_l(locale)->decimal_point, MB_CUR_MAX, &mbs);
103 if (nconv == (size_t)-1 || nconv == (size_t)-2)
104 decpt = '.'; /* failsafe */
108 static inline wchar_t
109 get_thousep(locale_t locale)
116 nconv = mbrtowc(&thousep, localeconv_l(locale)->thousands_sep,
118 if (nconv == (size_t)-1 || nconv == (size_t)-2)
119 thousep = '\0'; /* failsafe */
124 * Initialize the thousands' grouping state in preparation to print a
125 * number with ndigits digits. This routine returns the total number
126 * of wide characters that will be printed.
129 grouping_init(struct grouping_state *gs, int ndigits, locale_t locale)
132 gs->grouping = localeconv_l(locale)->grouping;
133 gs->thousands_sep = get_thousep(locale);
135 gs->nseps = gs->nrepeats = 0;
137 while (*gs->grouping != CHAR_MAX) {
138 if (gs->lead <= *gs->grouping)
140 gs->lead -= *gs->grouping;
141 if (*(gs->grouping+1)) {
147 return (gs->nseps + gs->nrepeats);
151 * Print a number with thousands' separators.
154 grouping_print(struct grouping_state *gs, struct io_state *iop,
155 const CHAR *cp, const CHAR *ep, locale_t locale)
157 const CHAR *cp0 = cp;
159 if (io_printandpad(iop, cp, ep, gs->lead, zeroes, locale))
162 while (gs->nseps > 0 || gs->nrepeats > 0) {
163 if (gs->nrepeats > 0)
169 if (io_print(iop, &gs->thousands_sep, 1, locale))
171 if (io_printandpad(iop, cp, ep, *gs->grouping, zeroes, locale))
182 * Flush out all the vectors defined by the given uio,
183 * then reset it so that it can be reused.
185 * XXX The fact that we do this a character at a time and convert to a
186 * multibyte character sequence even if the destination is a wide
187 * string eclipses the benefits of buffering.
190 __sprint(FILE *fp, struct __suio *uio, locale_t locale)
197 for (; uio->uio_resid != 0; uio->uio_resid -= len, iov++) {
198 p = (wchar_t *)iov->iov_base;
200 for (i = 0; i < len; i++) {
201 if (__xfputwc(p[i], fp, locale) == WEOF)
210 * Helper function for `fprintf to unbuffered unix file': creates a
211 * temporary buffer. We only work on write-only files; this avoids
212 * worries about ungetc buffers and so forth.
215 __sbprintf(FILE *fp, locale_t locale, const wchar_t *fmt, va_list ap)
219 unsigned char buf[BUFSIZ];
221 /* XXX This is probably not needed. */
222 if (prepwrite(fp) != 0)
225 /* copy the important variables */
226 fake._flags = fp->_flags & ~__SNBF;
227 fake._file = fp->_file;
228 fake._cookie = fp->_cookie;
229 fake._write = fp->_write;
230 fake._orientation = fp->_orientation;
231 fake._mbstate = fp->_mbstate;
233 /* set up the buffer */
234 fake._bf._base = fake._p = buf;
235 fake._bf._size = fake._w = sizeof(buf);
236 fake._lbfsize = 0; /* not actually used, but Just In Case */
238 /* do the work, then copy any error status */
239 ret = __vfwprintf(&fake, locale, fmt, ap);
240 if (ret >= 0 && __fflush(&fake))
242 if (fake._flags & __SERR)
243 fp->_flags |= __SERR;
248 * Like __fputwc, but handles fake string (__SSTR) files properly.
249 * File must already be locked.
252 __xfputwc(wchar_t wc, FILE *fp, locale_t locale)
255 char buf[MB_LEN_MAX];
260 if ((fp->_flags & __SSTR) == 0)
261 return (__fputwc(wc, fp, locale));
264 if ((len = wcrtomb(buf, wc, &mbs)) == (size_t)-1) {
265 fp->_flags |= __SERR;
273 return (__sfvwrite(fp, &uio) != EOF ? (wint_t)wc : WEOF);
277 * Convert a multibyte character string argument for the %s format to a wide
278 * string representation. ``prec'' specifies the maximum number of bytes
279 * to output. If ``prec'' is greater than or equal to zero, we can't assume
280 * that the multibyte char. string ends in a null character.
283 __mbsconv(char *mbsarg, int prec)
286 wchar_t *convbuf, *wcp;
288 size_t insize, nchars, nconv;
294 * Supplied argument is a multibyte string; convert it to wide
299 * String is not guaranteed to be NUL-terminated. Find the
300 * number of characters to print.
303 insize = nchars = nconv = 0;
305 while (nchars != (size_t)prec) {
306 nconv = mbrlen(p, MB_CUR_MAX, &mbs);
307 if (nconv == 0 || nconv == (size_t)-1 ||
314 if (nconv == (size_t)-1 || nconv == (size_t)-2)
317 insize = strlen(mbsarg);
322 * Allocate buffer for the result and perform the conversion,
323 * converting at most `size' bytes of the input multibyte string to
324 * wide characters for printing.
326 convbuf = malloc((insize + 1) * sizeof(*convbuf));
332 while (insize != 0) {
333 nconv = mbrtowc(wcp, p, insize, &mbs);
334 if (nconv == 0 || nconv == (size_t)-1 || nconv == (size_t)-2)
340 if (nconv == (size_t)-1 || nconv == (size_t)-2) {
353 vfwprintf_l(FILE * __restrict fp, locale_t locale,
354 const wchar_t * __restrict fmt0, va_list ap)
360 /* optimise fprintf(stderr) (and other unbuffered Unix files) */
361 if ((fp->_flags & (__SNBF|__SWR|__SRW)) == (__SNBF|__SWR) &&
363 ret = __sbprintf(fp, locale, fmt0, ap);
365 ret = __vfwprintf(fp, locale, fmt0, ap);
370 vfwprintf(FILE * __restrict fp, const wchar_t * __restrict fmt0, va_list ap)
372 return vfwprintf_l(fp, __get_locale(), fmt0, ap);
376 * The size of the buffer we use as scratch space for integer
377 * conversions, among other things. We need enough space to
378 * write a uintmax_t in octal (plus one byte).
380 #if UINTMAX_MAX <= UINT64_MAX
383 #error "BUF must be large enough to format a uintmax_t"
387 * Non-MT-safe version
390 __vfwprintf(FILE *fp, locale_t locale, const wchar_t *fmt0, va_list ap)
392 wchar_t *fmt; /* format string */
393 wchar_t ch; /* character from fmt */
394 int n, n2; /* handy integer (short term usage) */
395 wchar_t *cp; /* handy char pointer (short term usage) */
396 int flags; /* flags as above */
397 int ret; /* return value accumulator */
398 int width; /* width from format (%8d), or 0 */
399 int prec; /* precision from format; <0 for N/A */
400 wchar_t sign; /* sign prefix (' ', '+', '-', or \0) */
401 struct grouping_state gs; /* thousands' grouping info */
402 #ifndef NO_FLOATING_POINT
404 * We can decompose the printed representation of floating
405 * point numbers into several parts, some of which may be empty:
407 * [+|-| ] [0x|0X] MMM . NNN [e|E|p|P] [+|-] ZZ
410 * A: 'sign' holds this value if present; '\0' otherwise
411 * B: ox[1] holds the 'x' or 'X'; '\0' if not hexadecimal
412 * C: cp points to the string MMMNNN. Leading and trailing
413 * zeros are not in the string and must be added.
414 * D: expchar holds this character; '\0' if no exponent, e.g. %f
415 * F: at least two digits for decimal, at least one digit for hex
417 wchar_t decimal_point; /* locale specific decimal point */
418 int signflag; /* true if float is negative */
419 union { /* floating point arguments %[aAeEfFgG] */
423 int expt; /* integer value of exponent */
424 char expchar; /* exponent character: [eEpP\0] */
425 char *dtoaend; /* pointer to end of converted digits */
426 int expsize; /* character count for expstr */
427 int ndig; /* actual number of digits returned by dtoa */
428 wchar_t expstr[MAXEXPDIG+2]; /* buffer for exponent string: e+ZZZ */
429 char *dtoaresult; /* buffer allocated by dtoa */
431 u_long ulval; /* integer arguments %[diouxX] */
432 uintmax_t ujval; /* %j, %ll, %q, %t, %z integers */
433 int base; /* base for [diouxX] conversion */
434 int dprec; /* a copy of prec if [diouxX], 0 otherwise */
435 int realsz; /* field size expanded by dprec, sign, etc */
436 int size; /* size of converted field or string */
437 int prsize; /* max size of printed field */
438 const char *xdigs; /* digits for [xX] conversion */
439 struct io_state io; /* I/O buffering state */
440 wchar_t buf[BUF]; /* buffer with space for digits of uintmax_t */
441 wchar_t ox[2]; /* space for 0x hex-prefix */
442 union arg *argtable; /* args, built due to positional arg */
443 union arg statargtable [STATIC_ARG_TBL_SIZE];
444 int nextarg; /* 1-based argument index */
445 va_list orgap; /* original argument pointer */
446 wchar_t *convbuf; /* multibyte to wide conversion result */
448 static const char xdigs_lower[16] = "0123456789abcdef";
449 static const char xdigs_upper[16] = "0123456789ABCDEF";
451 /* BEWARE, these `goto error' on error. */
452 #define PRINT(ptr, len) do { \
453 if (io_print(&io, (ptr), (len), locale)) \
456 #define PAD(howmany, with) { \
457 if (io_pad(&io, (howmany), (with), locale)) \
460 #define PRINTANDPAD(p, ep, len, with) { \
461 if (io_printandpad(&io, (p), (ep), (len), (with), locale)) \
465 if (io_flush(&io, locale)) \
470 * Get the argument indexed by nextarg. If the argument table is
471 * built, use it to get the argument. If its not, get the next
472 * argument (and arguments must be gotten sequentially).
474 #define GETARG(type) \
475 ((argtable != NULL) ? *((type*)(&argtable[nextarg++])) : \
476 (nextarg++, va_arg(ap, type)))
479 * To extend shorts properly, we need both signed and unsigned
480 * argument extraction methods.
483 (flags&LONGINT ? GETARG(long) : \
484 flags&SHORTINT ? (long)(short)GETARG(int) : \
485 flags&CHARINT ? (long)(signed char)GETARG(int) : \
488 (flags&LONGINT ? GETARG(u_long) : \
489 flags&SHORTINT ? (u_long)(u_short)GETARG(int) : \
490 flags&CHARINT ? (u_long)(u_char)GETARG(int) : \
491 (u_long)GETARG(u_int))
492 #define INTMAX_SIZE (INTMAXT|SIZET|PTRDIFFT|LLONGINT)
494 (flags&INTMAXT ? GETARG(intmax_t) : \
495 flags&SIZET ? (intmax_t)GETARG(ssize_t) : \
496 flags&PTRDIFFT ? (intmax_t)GETARG(ptrdiff_t) : \
497 (intmax_t)GETARG(long long))
499 (flags&INTMAXT ? GETARG(uintmax_t) : \
500 flags&SIZET ? (uintmax_t)GETARG(size_t) : \
501 flags&PTRDIFFT ? (uintmax_t)GETARG(ptrdiff_t) : \
502 (uintmax_t)GETARG(unsigned long long))
505 * Get * arguments, including the form *nn$. Preserve the nextarg
506 * that the argument can be gotten once the type is determined.
508 #define GETASTER(val) \
511 while (is_digit(*cp)) { \
512 n2 = 10 * n2 + to_digit(*cp); \
516 int hold = nextarg; \
517 if (argtable == NULL) { \
518 argtable = statargtable; \
519 if (__find_warguments (fmt0, orgap, &argtable)) { \
525 val = GETARG (int); \
529 val = GETARG (int); \
533 /* sorry, fwprintf(read_only_file, L"") returns WEOF, not 0 */
534 if (prepwrite(fp) != 0) {
540 fmt = (wchar_t *)fmt0;
546 #ifndef NO_FLOATING_POINT
547 decimal_point = get_decpt(locale);
551 * Scan the format for conversions (`%' character).
554 for (cp = fmt; (ch = *fmt) != '\0' && ch != '%'; fmt++)
556 if ((n = fmt - cp) != 0) {
557 if ((unsigned)ret + n > INT_MAX) {
567 fmt++; /* skip over '%' */
578 reswitch: switch (ch) {
581 * ``If the space and + flags both appear, the space
582 * flag will be ignored.''
593 * ``A negative field width argument is taken as a
594 * - flag followed by a positive field width.''
596 * They don't exclude field widths read from args.
613 if ((ch = *fmt++) == '*') {
618 while (is_digit(ch)) {
619 prec = 10 * prec + to_digit(ch);
625 * ``Note that 0 is taken as a flag, not as the
626 * beginning of a field width.''
631 case '1': case '2': case '3': case '4':
632 case '5': case '6': case '7': case '8': case '9':
635 n = 10 * n + to_digit(ch);
637 } while (is_digit(ch));
640 if (argtable == NULL) {
641 argtable = statargtable;
642 if (__find_warguments (fmt0, orgap,
652 #ifndef NO_FLOATING_POINT
658 if (flags & SHORTINT) {
668 if (flags & LONGINT) {
675 flags |= LLONGINT; /* not necessarily */
688 *(cp = buf) = (wchar_t)GETARG(wint_t);
690 *(cp = buf) = (wchar_t)btowc(GETARG(int));
699 if (flags & INTMAX_SIZE) {
701 if ((intmax_t)ujval < 0) {
707 if ((long)ulval < 0) {
714 #ifndef NO_FLOATING_POINT
728 if (flags & LONGDBL) {
729 fparg.ldbl = GETARG(long double);
731 __hldtoa(fparg.ldbl, xdigs, prec,
732 &expt, &signflag, &dtoaend);
734 fparg.dbl = GETARG(double);
736 __hdtoa(fparg.dbl, xdigs, prec,
737 &expt, &signflag, &dtoaend);
740 prec = dtoaend - dtoaresult;
745 ndig = dtoaend - dtoaresult;
746 cp = convbuf = __mbsconv(dtoaresult, -1);
747 freedtoa(dtoaresult);
752 if (prec < 0) /* account for digit before decpt */
763 expchar = ch - ('g' - 'e');
771 if (flags & LONGDBL) {
772 fparg.ldbl = GETARG(long double);
774 __ldtoa(&fparg.ldbl, expchar ? 2 : 3, prec,
775 &expt, &signflag, &dtoaend);
777 fparg.dbl = GETARG(double);
779 dtoa(fparg.dbl, expchar ? 2 : 3, prec,
780 &expt, &signflag, &dtoaend);
784 ndig = dtoaend - dtoaresult;
785 cp = convbuf = __mbsconv(dtoaresult, -1);
786 freedtoa(dtoaresult);
790 if (expt == INT_MAX) { /* inf or nan */
792 cp = (ch >= 'a') ? L"nan" : L"NAN";
795 cp = (ch >= 'a') ? L"inf" : L"INF";
801 if (ch == 'g' || ch == 'G') {
802 if (expt > -4 && expt <= prec) {
803 /* Make %[gG] smell like %[fF] */
813 * Make %[gG] smell like %[eE], but
814 * trim trailing zeroes if no # flag.
821 expsize = exponent(expstr, expt - 1, expchar);
822 size = expsize + prec;
823 if (prec > 1 || flags & ALT)
826 /* space for digits before decimal point */
831 /* space for decimal pt and following digits */
832 if (prec || flags & ALT)
834 if ((flags & GROUPING) && expt > 0)
835 size += grouping_init(&gs, expt, locale);
838 #endif /* !NO_FLOATING_POINT */
841 * Assignment-like behavior is specified if the
842 * value overflows or is otherwise unrepresentable.
843 * C99 says to use `signed char' for %hhn conversions.
845 if (flags & LLONGINT)
846 *GETARG(long long *) = ret;
847 else if (flags & SIZET)
848 *GETARG(ssize_t *) = (ssize_t)ret;
849 else if (flags & PTRDIFFT)
850 *GETARG(ptrdiff_t *) = ret;
851 else if (flags & INTMAXT)
852 *GETARG(intmax_t *) = ret;
853 else if (flags & LONGINT)
854 *GETARG(long *) = ret;
855 else if (flags & SHORTINT)
856 *GETARG(short *) = ret;
857 else if (flags & CHARINT)
858 *GETARG(signed char *) = ret;
860 *GETARG(int *) = ret;
861 continue; /* no output */
866 if (flags & INTMAX_SIZE)
874 * ``The argument shall be a pointer to void. The
875 * value of the pointer is converted to a sequence
876 * of printable characters, in an implementation-
880 ujval = (uintmax_t)(uintptr_t)GETARG(void *);
883 flags = flags | INTMAXT;
890 if (flags & LONGINT) {
891 if ((cp = GETARG(wchar_t *)) == NULL)
898 if ((mbp = GETARG(char *)) == NULL)
901 convbuf = __mbsconv(mbp, prec);
902 if (convbuf == NULL) {
903 fp->_flags |= __SERR;
909 size = (prec >= 0) ? wcsnlen(cp, prec) : wcslen(cp);
916 if (flags & INTMAX_SIZE)
928 if (flags & INTMAX_SIZE)
933 /* leading 0x/X only if non-zero */
935 (flags & INTMAX_SIZE ? ujval != 0 : ulval != 0))
939 /* unsigned conversions */
942 * ``... diouXx conversions ... if a precision is
943 * specified, the 0 flag will be ignored.''
946 number: if ((dprec = prec) >= 0)
950 * ``The result of converting a zero value with an
951 * explicit precision of zero is no characters.''
954 * ``The C Standard is clear enough as is. The call
955 * printf("%#.0o", 0) should print 0.''
956 * -- Defect Report #151
959 if (flags & INTMAX_SIZE) {
960 if (ujval != 0 || prec != 0 ||
961 (flags & ALT && base == 8))
962 cp = __ujtoa(ujval, cp, base,
965 if (ulval != 0 || prec != 0 ||
966 (flags & ALT && base == 8))
967 cp = __ultoa(ulval, cp, base,
970 size = buf + BUF - cp;
971 if (size > BUF) /* should never happen */
973 if ((flags & GROUPING) && size != 0)
974 size += grouping_init(&gs, size, locale);
976 default: /* "%?" prints ?, unless ? is NUL */
979 /* pretend it was %c with argument ch */
988 * All reasonable formats wind up here. At this point, `cp'
989 * points to a string which (if not flags&LADJUST) should be
990 * padded out to `width' places. If flags&ZEROPAD, it should
991 * first be prefixed by any sign or other prefix; otherwise,
992 * it should be blank padded before the prefix is emitted.
993 * After any left-hand padding and prefixing, emit zeroes
994 * required by a decimal [diouxX] precision, then print the
995 * string proper, then emit zeroes required by any leftover
996 * floating precision; finally, if LADJUST, pad with blanks.
998 * Compute actual size, so we know how much to pad.
999 * size excludes decimal prec; realsz includes it.
1001 realsz = dprec > size ? dprec : size;
1007 prsize = width > realsz ? width : realsz;
1008 if ((unsigned)ret + prsize > INT_MAX) {
1014 /* right-adjusting blank padding */
1015 if ((flags & (LADJUST|ZEROPAD)) == 0)
1016 PAD(width - realsz, blanks);
1022 if (ox[1]) { /* ox[1] is either x, X, or \0 */
1027 /* right-adjusting zero padding */
1028 if ((flags & (LADJUST|ZEROPAD)) == ZEROPAD)
1029 PAD(width - realsz, zeroes);
1031 /* the string or number proper */
1032 #ifndef NO_FLOATING_POINT
1033 if ((flags & FPT) == 0) {
1035 /* leading zeroes from decimal precision */
1036 PAD(dprec - size, zeroes);
1038 if (grouping_print(&gs, &io, cp, buf+BUF, locale) < 0)
1043 #ifndef NO_FLOATING_POINT
1044 } else { /* glue together f_p fragments */
1045 if (!expchar) { /* %[fF] or sufficiently short %[gG] */
1048 if (prec || flags & ALT)
1049 PRINT(&decimal_point, 1);
1051 /* already handled initial 0's */
1055 n = grouping_print(&gs, &io,
1056 cp, convbuf + ndig, locale);
1061 PRINTANDPAD(cp, convbuf + ndig,
1065 if (prec || flags & ALT)
1066 PRINT(&decimal_point, 1);
1068 PRINTANDPAD(cp, convbuf + ndig, prec, zeroes);
1069 } else { /* %[eE] or sufficiently long %[gG] */
1070 if (prec > 1 || flags & ALT) {
1072 buf[1] = decimal_point;
1075 PAD(prec - ndig, zeroes);
1078 PRINT(expstr, expsize);
1082 /* left-adjusting padding (always blank) */
1083 if (flags & LADJUST)
1084 PAD(width - realsz, blanks);
1086 /* finally, adjust ret */
1089 FLUSH(); /* copy out the I/O vectors */
1095 if (convbuf != NULL)
1099 if ((argtable != NULL) && (argtable != statargtable))