2 * SPDX-License-Identifier: BSD-3-Clause
4 * Copyright (c) 1990, 1993
5 * The Regents of the University of California. All rights reserved.
7 * This code is derived from software contributed to Berkeley by
10 * Copyright (c) 2011 The FreeBSD Foundation
11 * All rights reserved.
12 * Portions of this software were developed by David Chisnall
13 * under sponsorship from the FreeBSD Foundation.
15 * Redistribution and use in source and binary forms, with or without
16 * modification, are permitted provided that the following conditions
18 * 1. Redistributions of source code must retain the above copyright
19 * notice, this list of conditions and the following disclaimer.
20 * 2. Redistributions in binary form must reproduce the above copyright
21 * notice, this list of conditions and the following disclaimer in the
22 * documentation and/or other materials provided with the distribution.
23 * 3. Neither the name of the University nor the names of its contributors
24 * may be used to endorse or promote products derived from this software
25 * without specific prior written permission.
27 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
28 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
29 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
30 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
31 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
32 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
33 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
34 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
35 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
36 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
41 #if defined(LIBC_SCCS) && !defined(lint)
42 static char sccsid[] = "@(#)vfprintf.c 8.1 (Berkeley) 6/4/93";
43 #endif /* LIBC_SCCS and not lint */
45 #include <sys/cdefs.h>
46 __FBSDID("$FreeBSD$");
49 * Actual wprintf innards.
51 * Avoid making gratuitous changes to this source file; it should be kept
52 * as close as possible to vfprintf.c for ease of maintenance.
55 #include "namespace.h"
56 #include <sys/types.h>
70 #include "un-namespace.h"
72 #include "libc_private.h"
75 #include "printflocal.h"
76 #include "xlocale_private.h"
78 static int __sprint(FILE *, struct __suio *, locale_t);
79 static int __sbprintf(FILE *, locale_t, const wchar_t *, va_list) __noinline;
80 static wint_t __xfputwc(wchar_t, FILE *, locale_t);
81 static wchar_t *__mbsconv(char *, int);
84 #include "printfcommon.h"
86 struct grouping_state {
87 wchar_t thousands_sep; /* locale-specific thousands separator */
88 const char *grouping; /* locale-specific numeric grouping rules */
89 int lead; /* sig figs before decimal or group sep */
90 int nseps; /* number of group separators with ' */
91 int nrepeats; /* number of repeats of the last group */
94 static const mbstate_t initial_mbs;
97 get_decpt(locale_t locale)
104 nconv = mbrtowc(&decpt, localeconv_l(locale)->decimal_point, MB_CUR_MAX, &mbs);
105 if (nconv == (size_t)-1 || nconv == (size_t)-2)
106 decpt = '.'; /* failsafe */
110 static inline wchar_t
111 get_thousep(locale_t locale)
118 nconv = mbrtowc(&thousep, localeconv_l(locale)->thousands_sep,
120 if (nconv == (size_t)-1 || nconv == (size_t)-2)
121 thousep = '\0'; /* failsafe */
126 * Initialize the thousands' grouping state in preparation to print a
127 * number with ndigits digits. This routine returns the total number
128 * of wide characters that will be printed.
131 grouping_init(struct grouping_state *gs, int ndigits, locale_t locale)
134 gs->grouping = localeconv_l(locale)->grouping;
135 gs->thousands_sep = get_thousep(locale);
137 gs->nseps = gs->nrepeats = 0;
139 while (*gs->grouping != CHAR_MAX) {
140 if (gs->lead <= *gs->grouping)
142 gs->lead -= *gs->grouping;
143 if (*(gs->grouping+1)) {
149 return (gs->nseps + gs->nrepeats);
153 * Print a number with thousands' separators.
156 grouping_print(struct grouping_state *gs, struct io_state *iop,
157 const CHAR *cp, const CHAR *ep, locale_t locale)
159 const CHAR *cp0 = cp;
161 if (io_printandpad(iop, cp, ep, gs->lead, zeroes, locale))
164 while (gs->nseps > 0 || gs->nrepeats > 0) {
165 if (gs->nrepeats > 0)
171 if (io_print(iop, &gs->thousands_sep, 1, locale))
173 if (io_printandpad(iop, cp, ep, *gs->grouping, zeroes, locale))
184 * Flush out all the vectors defined by the given uio,
185 * then reset it so that it can be reused.
187 * XXX The fact that we do this a character at a time and convert to a
188 * multibyte character sequence even if the destination is a wide
189 * string eclipses the benefits of buffering.
192 __sprint(FILE *fp, struct __suio *uio, locale_t locale)
199 for (; uio->uio_resid != 0; uio->uio_resid -= len, iov++) {
200 p = (wchar_t *)iov->iov_base;
202 for (i = 0; i < len; i++) {
203 if (__xfputwc(p[i], fp, locale) == WEOF)
212 * Helper function for `fprintf to unbuffered unix file': creates a
213 * temporary buffer. We only work on write-only files; this avoids
214 * worries about ungetc buffers and so forth.
217 __sbprintf(FILE *fp, locale_t locale, const wchar_t *fmt, va_list ap)
221 unsigned char buf[BUFSIZ];
223 /* XXX This is probably not needed. */
224 if (prepwrite(fp) != 0)
227 /* copy the important variables */
228 fake._flags = fp->_flags & ~__SNBF;
229 fake._file = fp->_file;
230 fake._cookie = fp->_cookie;
231 fake._write = fp->_write;
232 fake._orientation = fp->_orientation;
233 fake._mbstate = fp->_mbstate;
235 /* set up the buffer */
236 fake._bf._base = fake._p = buf;
237 fake._bf._size = fake._w = sizeof(buf);
238 fake._lbfsize = 0; /* not actually used, but Just In Case */
240 /* do the work, then copy any error status */
241 ret = __vfwprintf(&fake, locale, fmt, ap);
242 if (ret >= 0 && __fflush(&fake))
244 if (fake._flags & __SERR)
245 fp->_flags |= __SERR;
250 * Like __fputwc, but handles fake string (__SSTR) files properly.
251 * File must already be locked.
254 __xfputwc(wchar_t wc, FILE *fp, locale_t locale)
257 char buf[MB_LEN_MAX];
262 if ((fp->_flags & __SSTR) == 0)
263 return (__fputwc(wc, fp, locale));
266 if ((len = wcrtomb(buf, wc, &mbs)) == (size_t)-1) {
267 fp->_flags |= __SERR;
275 return (__sfvwrite(fp, &uio) != EOF ? (wint_t)wc : WEOF);
279 * Convert a multibyte character string argument for the %s format to a wide
280 * string representation. ``prec'' specifies the maximum number of bytes
281 * to output. If ``prec'' is greater than or equal to zero, we can't assume
282 * that the multibyte char. string ends in a null character.
285 __mbsconv(char *mbsarg, int prec)
288 wchar_t *convbuf, *wcp;
290 size_t insize, nchars, nconv;
296 * Supplied argument is a multibyte string; convert it to wide
301 * String is not guaranteed to be NUL-terminated. Find the
302 * number of characters to print.
305 insize = nchars = nconv = 0;
307 while (nchars != (size_t)prec) {
308 nconv = mbrlen(p, MB_CUR_MAX, &mbs);
309 if (nconv == 0 || nconv == (size_t)-1 ||
316 if (nconv == (size_t)-1 || nconv == (size_t)-2)
319 insize = strlen(mbsarg);
324 * Allocate buffer for the result and perform the conversion,
325 * converting at most `size' bytes of the input multibyte string to
326 * wide characters for printing.
328 convbuf = malloc((insize + 1) * sizeof(*convbuf));
334 while (insize != 0) {
335 nconv = mbrtowc(wcp, p, insize, &mbs);
336 if (nconv == 0 || nconv == (size_t)-1 || nconv == (size_t)-2)
342 if (nconv == (size_t)-1 || nconv == (size_t)-2) {
355 vfwprintf_l(FILE * __restrict fp, locale_t locale,
356 const wchar_t * __restrict fmt0, va_list ap)
361 FLOCKFILE_CANCELSAFE(fp);
362 /* optimise fprintf(stderr) (and other unbuffered Unix files) */
363 if ((fp->_flags & (__SNBF|__SWR|__SRW)) == (__SNBF|__SWR) &&
365 ret = __sbprintf(fp, locale, fmt0, ap);
367 ret = __vfwprintf(fp, locale, fmt0, ap);
368 FUNLOCKFILE_CANCELSAFE();
372 vfwprintf(FILE * __restrict fp, const wchar_t * __restrict fmt0, va_list ap)
374 return vfwprintf_l(fp, __get_locale(), fmt0, ap);
378 * The size of the buffer we use as scratch space for integer
379 * conversions, among other things. We need enough space to
380 * write a uintmax_t in octal (plus one byte).
382 #if UINTMAX_MAX <= UINT64_MAX
385 #error "BUF must be large enough to format a uintmax_t"
389 * Non-MT-safe version
392 __vfwprintf(FILE *fp, locale_t locale, const wchar_t *fmt0, va_list ap)
394 wchar_t *fmt; /* format string */
395 wchar_t ch; /* character from fmt */
396 int n, n2; /* handy integer (short term usage) */
397 wchar_t *cp; /* handy char pointer (short term usage) */
398 int flags; /* flags as above */
399 int ret; /* return value accumulator */
400 int width; /* width from format (%8d), or 0 */
401 int prec; /* precision from format; <0 for N/A */
402 wchar_t sign; /* sign prefix (' ', '+', '-', or \0) */
403 struct grouping_state gs; /* thousands' grouping info */
404 #ifndef NO_FLOATING_POINT
406 * We can decompose the printed representation of floating
407 * point numbers into several parts, some of which may be empty:
409 * [+|-| ] [0x|0X] MMM . NNN [e|E|p|P] [+|-] ZZ
412 * A: 'sign' holds this value if present; '\0' otherwise
413 * B: ox[1] holds the 'x' or 'X'; '\0' if not hexadecimal
414 * C: cp points to the string MMMNNN. Leading and trailing
415 * zeros are not in the string and must be added.
416 * D: expchar holds this character; '\0' if no exponent, e.g. %f
417 * F: at least two digits for decimal, at least one digit for hex
419 wchar_t decimal_point; /* locale specific decimal point */
420 int signflag; /* true if float is negative */
421 union { /* floating point arguments %[aAeEfFgG] */
425 int expt; /* integer value of exponent */
426 char expchar; /* exponent character: [eEpP\0] */
427 char *dtoaend; /* pointer to end of converted digits */
428 int expsize; /* character count for expstr */
429 int ndig; /* actual number of digits returned by dtoa */
430 wchar_t expstr[MAXEXPDIG+2]; /* buffer for exponent string: e+ZZZ */
431 char *dtoaresult; /* buffer allocated by dtoa */
433 u_long ulval; /* integer arguments %[diouxX] */
434 uintmax_t ujval; /* %j, %ll, %q, %t, %z integers */
435 int base; /* base for [diouxX] conversion */
436 int dprec; /* a copy of prec if [diouxX], 0 otherwise */
437 int realsz; /* field size expanded by dprec, sign, etc */
438 int size; /* size of converted field or string */
439 int prsize; /* max size of printed field */
440 const char *xdigs; /* digits for [xX] conversion */
441 struct io_state io; /* I/O buffering state */
442 wchar_t buf[BUF]; /* buffer with space for digits of uintmax_t */
443 wchar_t ox[2]; /* space for 0x hex-prefix */
444 union arg *argtable; /* args, built due to positional arg */
445 union arg statargtable [STATIC_ARG_TBL_SIZE];
446 int nextarg; /* 1-based argument index */
447 va_list orgap; /* original argument pointer */
448 wchar_t *convbuf; /* multibyte to wide conversion result */
451 static const char xdigs_lower[16] = "0123456789abcdef";
452 static const char xdigs_upper[16] = "0123456789ABCDEF";
454 /* BEWARE, these `goto error' on error. */
455 #define PRINT(ptr, len) do { \
456 if (io_print(&io, (ptr), (len), locale)) \
459 #define PAD(howmany, with) { \
460 if (io_pad(&io, (howmany), (with), locale)) \
463 #define PRINTANDPAD(p, ep, len, with) { \
464 if (io_printandpad(&io, (p), (ep), (len), (with), locale)) \
468 if (io_flush(&io, locale)) \
473 * Get the argument indexed by nextarg. If the argument table is
474 * built, use it to get the argument. If its not, get the next
475 * argument (and arguments must be gotten sequentially).
477 #define GETARG(type) \
478 ((argtable != NULL) ? *((type*)(&argtable[nextarg++])) : \
479 (nextarg++, va_arg(ap, type)))
482 * To extend shorts properly, we need both signed and unsigned
483 * argument extraction methods.
486 (flags&LONGINT ? GETARG(long) : \
487 flags&SHORTINT ? (long)(short)GETARG(int) : \
488 flags&CHARINT ? (long)(signed char)GETARG(int) : \
491 (flags&LONGINT ? GETARG(u_long) : \
492 flags&SHORTINT ? (u_long)(u_short)GETARG(int) : \
493 flags&CHARINT ? (u_long)(u_char)GETARG(int) : \
494 (u_long)GETARG(u_int))
495 #define INTMAX_SIZE (INTMAXT|SIZET|PTRDIFFT|LLONGINT)
497 (flags&INTMAXT ? GETARG(intmax_t) : \
498 flags&SIZET ? (intmax_t)GETARG(ssize_t) : \
499 flags&PTRDIFFT ? (intmax_t)GETARG(ptrdiff_t) : \
500 (intmax_t)GETARG(long long))
502 (flags&INTMAXT ? GETARG(uintmax_t) : \
503 flags&SIZET ? (uintmax_t)GETARG(size_t) : \
504 flags&PTRDIFFT ? (uintmax_t)GETARG(ptrdiff_t) : \
505 (uintmax_t)GETARG(unsigned long long))
508 * Get * arguments, including the form *nn$. Preserve the nextarg
509 * that the argument can be gotten once the type is determined.
511 #define GETASTER(val) \
514 while (is_digit(*cp)) { \
515 n2 = 10 * n2 + to_digit(*cp); \
519 int hold = nextarg; \
520 if (argtable == NULL) { \
521 argtable = statargtable; \
522 if (__find_warguments (fmt0, orgap, &argtable)) { \
528 val = GETARG (int); \
532 val = GETARG (int); \
536 /* sorry, fwprintf(read_only_file, L"") returns WEOF, not 0 */
537 if (prepwrite(fp) != 0) {
542 savserr = fp->_flags & __SERR;
543 fp->_flags &= ~__SERR;
546 fmt = (wchar_t *)fmt0;
552 #ifndef NO_FLOATING_POINT
553 decimal_point = get_decpt(locale);
557 * Scan the format for conversions (`%' character).
560 for (cp = fmt; (ch = *fmt) != '\0' && ch != '%'; fmt++)
562 if ((n = fmt - cp) != 0) {
563 if ((unsigned)ret + n > INT_MAX) {
573 fmt++; /* skip over '%' */
584 reswitch: switch (ch) {
587 * ``If the space and + flags both appear, the space
588 * flag will be ignored.''
599 * ``A negative field width argument is taken as a
600 * - flag followed by a positive field width.''
602 * They don't exclude field widths read from args.
619 if ((ch = *fmt++) == '*') {
624 while (is_digit(ch)) {
625 prec = 10 * prec + to_digit(ch);
631 * ``Note that 0 is taken as a flag, not as the
632 * beginning of a field width.''
637 case '1': case '2': case '3': case '4':
638 case '5': case '6': case '7': case '8': case '9':
641 n = 10 * n + to_digit(ch);
643 } while (is_digit(ch));
646 if (argtable == NULL) {
647 argtable = statargtable;
648 if (__find_warguments (fmt0, orgap,
658 #ifndef NO_FLOATING_POINT
664 if (flags & SHORTINT) {
674 if (flags & LONGINT) {
681 flags |= LLONGINT; /* not necessarily */
694 *(cp = buf) = (wchar_t)GETARG(wint_t);
696 *(cp = buf) = (wchar_t)btowc(GETARG(int));
705 if (flags & INTMAX_SIZE) {
707 if ((intmax_t)ujval < 0) {
713 if ((long)ulval < 0) {
720 #ifndef NO_FLOATING_POINT
734 if (flags & LONGDBL) {
735 fparg.ldbl = GETARG(long double);
737 __hldtoa(fparg.ldbl, xdigs, prec,
738 &expt, &signflag, &dtoaend);
740 fparg.dbl = GETARG(double);
742 __hdtoa(fparg.dbl, xdigs, prec,
743 &expt, &signflag, &dtoaend);
746 prec = dtoaend - dtoaresult;
751 ndig = dtoaend - dtoaresult;
752 cp = convbuf = __mbsconv(dtoaresult, -1);
753 freedtoa(dtoaresult);
758 if (prec < 0) /* account for digit before decpt */
769 expchar = ch - ('g' - 'e');
777 if (flags & LONGDBL) {
778 fparg.ldbl = GETARG(long double);
780 __ldtoa(&fparg.ldbl, expchar ? 2 : 3, prec,
781 &expt, &signflag, &dtoaend);
783 fparg.dbl = GETARG(double);
785 dtoa(fparg.dbl, expchar ? 2 : 3, prec,
786 &expt, &signflag, &dtoaend);
790 ndig = dtoaend - dtoaresult;
791 cp = convbuf = __mbsconv(dtoaresult, -1);
792 freedtoa(dtoaresult);
796 if (expt == INT_MAX) { /* inf or nan */
798 cp = (ch >= 'a') ? L"nan" : L"NAN";
801 cp = (ch >= 'a') ? L"inf" : L"INF";
807 if (ch == 'g' || ch == 'G') {
808 if (expt > -4 && expt <= prec) {
809 /* Make %[gG] smell like %[fF] */
819 * Make %[gG] smell like %[eE], but
820 * trim trailing zeroes if no # flag.
827 expsize = exponent(expstr, expt - 1, expchar);
828 size = expsize + prec;
829 if (prec > 1 || flags & ALT)
832 /* space for digits before decimal point */
837 /* space for decimal pt and following digits */
838 if (prec || flags & ALT)
840 if ((flags & GROUPING) && expt > 0)
841 size += grouping_init(&gs, expt, locale);
844 #endif /* !NO_FLOATING_POINT */
847 * Assignment-like behavior is specified if the
848 * value overflows or is otherwise unrepresentable.
849 * C99 says to use `signed char' for %hhn conversions.
851 if (flags & LLONGINT)
852 *GETARG(long long *) = ret;
853 else if (flags & SIZET)
854 *GETARG(ssize_t *) = (ssize_t)ret;
855 else if (flags & PTRDIFFT)
856 *GETARG(ptrdiff_t *) = ret;
857 else if (flags & INTMAXT)
858 *GETARG(intmax_t *) = ret;
859 else if (flags & LONGINT)
860 *GETARG(long *) = ret;
861 else if (flags & SHORTINT)
862 *GETARG(short *) = ret;
863 else if (flags & CHARINT)
864 *GETARG(signed char *) = ret;
866 *GETARG(int *) = ret;
867 continue; /* no output */
872 if (flags & INTMAX_SIZE)
880 * ``The argument shall be a pointer to void. The
881 * value of the pointer is converted to a sequence
882 * of printable characters, in an implementation-
886 ujval = (uintmax_t)(uintptr_t)GETARG(void *);
889 flags = flags | INTMAXT;
896 if (flags & LONGINT) {
897 if ((cp = GETARG(wchar_t *)) == NULL)
904 if ((mbp = GETARG(char *)) == NULL)
907 convbuf = __mbsconv(mbp, prec);
908 if (convbuf == NULL) {
909 fp->_flags |= __SERR;
915 size = (prec >= 0) ? wcsnlen(cp, prec) : wcslen(cp);
922 if (flags & INTMAX_SIZE)
934 if (flags & INTMAX_SIZE)
939 /* leading 0x/X only if non-zero */
941 (flags & INTMAX_SIZE ? ujval != 0 : ulval != 0))
945 /* unsigned conversions */
948 * ``... diouXx conversions ... if a precision is
949 * specified, the 0 flag will be ignored.''
952 number: if ((dprec = prec) >= 0)
956 * ``The result of converting a zero value with an
957 * explicit precision of zero is no characters.''
960 * ``The C Standard is clear enough as is. The call
961 * printf("%#.0o", 0) should print 0.''
962 * -- Defect Report #151
965 if (flags & INTMAX_SIZE) {
966 if (ujval != 0 || prec != 0 ||
967 (flags & ALT && base == 8))
968 cp = __ujtoa(ujval, cp, base,
971 if (ulval != 0 || prec != 0 ||
972 (flags & ALT && base == 8))
973 cp = __ultoa(ulval, cp, base,
976 size = buf + BUF - cp;
977 if (size > BUF) /* should never happen */
979 if ((flags & GROUPING) && size != 0)
980 size += grouping_init(&gs, size, locale);
982 default: /* "%?" prints ?, unless ? is NUL */
985 /* pretend it was %c with argument ch */
994 * All reasonable formats wind up here. At this point, `cp'
995 * points to a string which (if not flags&LADJUST) should be
996 * padded out to `width' places. If flags&ZEROPAD, it should
997 * first be prefixed by any sign or other prefix; otherwise,
998 * it should be blank padded before the prefix is emitted.
999 * After any left-hand padding and prefixing, emit zeroes
1000 * required by a decimal [diouxX] precision, then print the
1001 * string proper, then emit zeroes required by any leftover
1002 * floating precision; finally, if LADJUST, pad with blanks.
1004 * Compute actual size, so we know how much to pad.
1005 * size excludes decimal prec; realsz includes it.
1007 realsz = dprec > size ? dprec : size;
1013 prsize = width > realsz ? width : realsz;
1014 if ((unsigned)ret + prsize > INT_MAX) {
1020 /* right-adjusting blank padding */
1021 if ((flags & (LADJUST|ZEROPAD)) == 0)
1022 PAD(width - realsz, blanks);
1028 if (ox[1]) { /* ox[1] is either x, X, or \0 */
1033 /* right-adjusting zero padding */
1034 if ((flags & (LADJUST|ZEROPAD)) == ZEROPAD)
1035 PAD(width - realsz, zeroes);
1037 /* the string or number proper */
1038 #ifndef NO_FLOATING_POINT
1039 if ((flags & FPT) == 0) {
1041 /* leading zeroes from decimal precision */
1042 PAD(dprec - size, zeroes);
1044 if (grouping_print(&gs, &io, cp, buf+BUF, locale) < 0)
1049 #ifndef NO_FLOATING_POINT
1050 } else { /* glue together f_p fragments */
1051 if (!expchar) { /* %[fF] or sufficiently short %[gG] */
1054 if (prec || flags & ALT)
1055 PRINT(&decimal_point, 1);
1057 /* already handled initial 0's */
1061 n = grouping_print(&gs, &io,
1062 cp, convbuf + ndig, locale);
1067 PRINTANDPAD(cp, convbuf + ndig,
1071 if (prec || flags & ALT)
1072 PRINT(&decimal_point, 1);
1074 PRINTANDPAD(cp, convbuf + ndig, prec, zeroes);
1075 } else { /* %[eE] or sufficiently long %[gG] */
1076 if (prec > 1 || flags & ALT) {
1078 buf[1] = decimal_point;
1081 PAD(prec - ndig, zeroes);
1084 PRINT(expstr, expsize);
1088 /* left-adjusting padding (always blank) */
1089 if (flags & LADJUST)
1090 PAD(width - realsz, blanks);
1092 /* finally, adjust ret */
1095 FLUSH(); /* copy out the I/O vectors */
1101 if (convbuf != NULL)
1106 fp->_flags |= savserr;
1107 if ((argtable != NULL) && (argtable != statargtable))