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
37 * @(#)vfprintf.c 8.1 (Berkeley) 6/4/93
38 * $FreeBSD: head/lib/libc/stdio/vfwprintf.c 249808 2013-04-23 13:33:13Z emaste $
42 * Actual wprintf innards.
44 * Avoid making gratuitous changes to this source file; it should be kept
45 * as close as possible to vfprintf.c for ease of maintenance.
48 #include "namespace.h"
49 #include <sys/types.h>
63 #include "un-namespace.h"
65 #include "libc_private.h"
67 #include "printflocal.h"
68 #include "xlocale_private.h"
70 static int __sprint(FILE *, struct __suio *, locale_t);
71 static int __sbprintf(FILE *, locale_t, const wchar_t *, va_list) __noinline;
72 static wint_t __xfputwc(wchar_t, FILE *, locale_t);
73 static wchar_t *__mbsconv(char *, int);
76 #include "printfcommon.h"
78 struct grouping_state {
79 wchar_t thousands_sep; /* locale-specific thousands separator */
80 const char *grouping; /* locale-specific numeric grouping rules */
81 int lead; /* sig figs before decimal or group sep */
82 int nseps; /* number of group separators with ' */
83 int nrepeats; /* number of repeats of the last group */
86 static const mbstate_t initial_mbs;
89 get_decpt(locale_t locale)
96 nconv = mbrtowc(&decpt, localeconv_l(locale)->decimal_point, MB_CUR_MAX, &mbs);
97 if (nconv == (size_t)-1 || nconv == (size_t)-2)
98 decpt = '.'; /* failsafe */
102 static inline wchar_t
103 get_thousep(locale_t locale)
110 nconv = mbrtowc(&thousep, localeconv_l(locale)->thousands_sep,
112 if (nconv == (size_t)-1 || nconv == (size_t)-2)
113 thousep = '\0'; /* failsafe */
118 * Initialize the thousands' grouping state in preparation to print a
119 * number with ndigits digits. This routine returns the total number
120 * of wide characters that will be printed.
123 grouping_init(struct grouping_state *gs, int ndigits, locale_t locale)
126 gs->grouping = localeconv_l(locale)->grouping;
127 gs->thousands_sep = get_thousep(locale);
129 gs->nseps = gs->nrepeats = 0;
131 while (*gs->grouping != CHAR_MAX) {
132 if (gs->lead <= *gs->grouping)
134 gs->lead -= *gs->grouping;
135 if (*(gs->grouping+1)) {
141 return (gs->nseps + gs->nrepeats);
145 * Print a number with thousands' separators.
148 grouping_print(struct grouping_state *gs, struct io_state *iop,
149 const CHAR *cp, const CHAR *ep, locale_t locale)
151 const CHAR *cp0 = cp;
153 if (io_printandpad(iop, cp, ep, gs->lead, zeroes, locale))
156 while (gs->nseps > 0 || gs->nrepeats > 0) {
157 if (gs->nrepeats > 0)
163 if (io_print(iop, &gs->thousands_sep, 1, locale))
165 if (io_printandpad(iop, cp, ep, *gs->grouping, zeroes, locale))
176 * Flush out all the vectors defined by the given uio,
177 * then reset it so that it can be reused.
179 * XXX The fact that we do this a character at a time and convert to a
180 * multibyte character sequence even if the destination is a wide
181 * string eclipses the benefits of buffering.
184 __sprint(FILE *fp, struct __suio *uio, locale_t locale)
191 for (; uio->uio_resid != 0; uio->uio_resid -= len, iov++) {
192 p = (wchar_t *)iov->iov_base;
194 for (i = 0; i < len; i++) {
195 if (__xfputwc(p[i], fp, locale) == WEOF)
204 * Helper function for `fprintf to unbuffered unix file': creates a
205 * temporary buffer. We only work on write-only files; this avoids
206 * worries about ungetc buffers and so forth.
209 __sbprintf(FILE *fp, locale_t locale, const wchar_t *fmt, va_list ap)
213 unsigned char buf[BUFSIZ];
215 /* XXX This is probably not needed. */
216 if (prepwrite(fp) != 0)
219 /* copy the important variables */
220 fake.pub._flags = fp->pub._flags & ~__SNBF;
221 fake.pub._fileno = fp->pub._fileno;
222 fake._cookie = fp->_cookie;
223 fake._write = fp->_write;
225 /* set up the buffer */
226 fake._bf._base = fake.pub._p = buf;
227 fake._bf._size = fake.pub._w = sizeof(buf);
228 fake.pub._lbfsize = 0; /* not actually used, but Just In Case */
230 /* do the work, then copy any error status */
231 ret = __vfwprintf(&fake, locale, fmt, ap);
232 if (ret >= 0 && __fflush(&fake))
234 if (fake.pub._flags & __SERR)
235 fp->pub._flags |= __SERR;
240 * Like __fputwc, but handles fake string (__SSTR) files properly.
241 * File must already be locked.
244 __xfputwc(wchar_t wc, FILE *fp, locale_t locale)
247 char buf[MB_LEN_MAX];
252 if ((fp->pub._flags & __SSTR) == 0)
253 return (__fputwc(wc, fp, locale));
256 if ((len = wcrtomb(buf, wc, &mbs)) == (size_t)-1) {
257 fp->pub._flags |= __SERR;
265 return (__sfvwrite(fp, &uio) != EOF ? (wint_t)wc : WEOF);
269 * Convert a multibyte character string argument for the %s format to a wide
270 * string representation. ``prec'' specifies the maximum number of bytes
271 * to output. If ``prec'' is greater than or equal to zero, we can't assume
272 * that the multibyte char. string ends in a null character.
275 __mbsconv(char *mbsarg, int prec)
278 wchar_t *convbuf, *wcp;
280 size_t insize, nchars, nconv;
286 * Supplied argument is a multibyte string; convert it to wide
291 * String is not guaranteed to be NUL-terminated. Find the
292 * number of characters to print.
295 insize = nchars = nconv = 0;
297 while (nchars != (size_t)prec) {
298 nconv = mbrlen(p, MB_CUR_MAX, &mbs);
299 if (nconv == 0 || nconv == (size_t)-1 ||
306 if (nconv == (size_t)-1 || nconv == (size_t)-2)
309 insize = strlen(mbsarg);
314 * Allocate buffer for the result and perform the conversion,
315 * converting at most `size' bytes of the input multibyte string to
316 * wide characters for printing.
318 convbuf = malloc((insize + 1) * sizeof(*convbuf));
324 while (insize != 0) {
325 nconv = mbrtowc(wcp, p, insize, &mbs);
326 if (nconv == 0 || nconv == (size_t)-1 || nconv == (size_t)-2)
332 if (nconv == (size_t)-1 || nconv == (size_t)-2) {
345 vfwprintf_l(FILE * __restrict fp, locale_t locale,
346 const wchar_t * __restrict fmt0, va_list ap)
352 /* optimise fprintf(stderr) (and other unbuffered Unix files) */
353 if ((fp->pub._flags & (__SNBF|__SWR|__SRW)) == (__SNBF|__SWR) &&
354 fp->pub._fileno >= 0)
355 ret = __sbprintf(fp, locale, fmt0, ap);
357 ret = __vfwprintf(fp, locale, fmt0, ap);
362 vfwprintf(FILE * __restrict fp, const wchar_t * __restrict fmt0, va_list ap)
364 return vfwprintf_l(fp, __get_locale(), fmt0, ap);
368 * The size of the buffer we use as scratch space for integer
369 * conversions, among other things. We need enough space to
370 * write a uintmax_t in octal (plus one byte).
372 #if UINTMAX_MAX <= UINT64_MAX
375 #error "BUF must be large enough to format a uintmax_t"
379 * Non-MT-safe version
382 __vfwprintf(FILE *fp, locale_t locale, const wchar_t *fmt0, va_list ap)
384 wchar_t *fmt; /* format string */
385 wchar_t ch; /* character from fmt */
386 int n, n2; /* handy integer (short term usage) */
387 wchar_t *cp; /* handy char pointer (short term usage) */
388 int flags; /* flags as above */
389 int ret; /* return value accumulator */
390 int width; /* width from format (%8d), or 0 */
391 int prec; /* precision from format; <0 for N/A */
392 wchar_t sign; /* sign prefix (' ', '+', '-', or \0) */
393 struct grouping_state gs; /* thousands' grouping info */
394 #ifndef NO_FLOATING_POINT
396 * We can decompose the printed representation of floating
397 * point numbers into several parts, some of which may be empty:
399 * [+|-| ] [0x|0X] MMM . NNN [e|E|p|P] [+|-] ZZ
402 * A: 'sign' holds this value if present; '\0' otherwise
403 * B: ox[1] holds the 'x' or 'X'; '\0' if not hexadecimal
404 * C: cp points to the string MMMNNN. Leading and trailing
405 * zeros are not in the string and must be added.
406 * D: expchar holds this character; '\0' if no exponent, e.g. %f
407 * F: at least two digits for decimal, at least one digit for hex
409 wchar_t decimal_point; /* locale specific decimal point */
410 int signflag; /* true if float is negative */
411 union { /* floating point arguments %[aAeEfFgG] */
415 int expt; /* integer value of exponent */
416 char expchar; /* exponent character: [eEpP\0] */
417 char *dtoaend; /* pointer to end of converted digits */
418 int expsize; /* character count for expstr */
419 int ndig; /* actual number of digits returned by dtoa */
420 wchar_t expstr[MAXEXPDIG+2]; /* buffer for exponent string: e+ZZZ */
421 char *dtoaresult; /* buffer allocated by dtoa */
423 u_long ulval; /* integer arguments %[diouxX] */
424 uintmax_t ujval; /* %j, %ll, %q, %t, %z integers */
425 int base; /* base for [diouxX] conversion */
426 int dprec; /* a copy of prec if [diouxX], 0 otherwise */
427 int realsz; /* field size expanded by dprec, sign, etc */
428 int size; /* size of converted field or string */
429 int prsize; /* max size of printed field */
430 const char *xdigs; /* digits for [xX] conversion */
431 struct io_state io; /* I/O buffering state */
432 wchar_t buf[BUF]; /* buffer with space for digits of uintmax_t */
433 wchar_t ox[2]; /* space for 0x hex-prefix */
434 union arg *argtable; /* args, built due to positional arg */
435 union arg statargtable [STATIC_ARG_TBL_SIZE];
436 int nextarg; /* 1-based argument index */
437 va_list orgap; /* original argument pointer */
438 wchar_t *convbuf; /* multibyte to wide conversion result */
440 static const char xdigs_lower[16] = "0123456789abcdef";
441 static const char xdigs_upper[16] = "0123456789ABCDEF";
443 /* BEWARE, these `goto error' on error. */
444 #define PRINT(ptr, len) do { \
445 if (io_print(&io, (ptr), (len), locale)) \
448 #define PAD(howmany, with) { \
449 if (io_pad(&io, (howmany), (with), locale)) \
452 #define PRINTANDPAD(p, ep, len, with) { \
453 if (io_printandpad(&io, (p), (ep), (len), (with), locale)) \
457 if (io_flush(&io, locale)) \
462 * Get the argument indexed by nextarg. If the argument table is
463 * built, use it to get the argument. If its not, get the next
464 * argument (and arguments must be gotten sequentially).
466 #define GETARG(type) \
467 ((argtable != NULL) ? *((type*)(&argtable[nextarg++])) : \
468 (nextarg++, va_arg(ap, type)))
471 * To extend shorts properly, we need both signed and unsigned
472 * argument extraction methods.
475 (flags&LONGINT ? GETARG(long) : \
476 flags&SHORTINT ? (long)(short)GETARG(int) : \
477 flags&CHARINT ? (long)(signed char)GETARG(int) : \
480 (flags&LONGINT ? GETARG(u_long) : \
481 flags&SHORTINT ? (u_long)(u_short)GETARG(int) : \
482 flags&CHARINT ? (u_long)(u_char)GETARG(int) : \
483 (u_long)GETARG(u_int))
484 #define INTMAX_SIZE (INTMAXT|SIZET|PTRDIFFT|LLONGINT)
486 (flags&INTMAXT ? GETARG(intmax_t) : \
487 flags&SIZET ? (intmax_t)GETARG(ssize_t) : \
488 flags&PTRDIFFT ? (intmax_t)GETARG(ptrdiff_t) : \
489 (intmax_t)GETARG(long long))
491 (flags&INTMAXT ? GETARG(uintmax_t) : \
492 flags&SIZET ? (uintmax_t)GETARG(size_t) : \
493 flags&PTRDIFFT ? (uintmax_t)GETARG(ptrdiff_t) : \
494 (uintmax_t)GETARG(unsigned long long))
497 * Get * arguments, including the form *nn$. Preserve the nextarg
498 * that the argument can be gotten once the type is determined.
500 #define GETASTER(val) \
503 while (is_digit(*cp)) { \
504 n2 = 10 * n2 + to_digit(*cp); \
508 int hold = nextarg; \
509 if (argtable == NULL) { \
510 argtable = statargtable; \
511 if (__find_warguments (fmt0, orgap, &argtable)) { \
517 val = GETARG (int); \
521 val = GETARG (int); \
525 /* sorry, fwprintf(read_only_file, L"") returns WEOF, not 0 */
526 if (prepwrite(fp) != 0)
530 fmt = (wchar_t *)fmt0;
536 #ifndef NO_FLOATING_POINT
537 decimal_point = get_decpt(locale);
541 * Scan the format for conversions (`%' character).
544 for (cp = fmt; (ch = *fmt) != '\0' && ch != '%'; fmt++)
546 if ((n = fmt - cp) != 0) {
547 if ((unsigned)ret + n > INT_MAX) {
557 fmt++; /* skip over '%' */
568 reswitch: switch (ch) {
571 * ``If the space and + flags both appear, the space
572 * flag will be ignored.''
583 * ``A negative field width argument is taken as a
584 * - flag followed by a positive field width.''
586 * They don't exclude field widths read from args.
603 if ((ch = *fmt++) == '*') {
608 while (is_digit(ch)) {
609 prec = 10 * prec + to_digit(ch);
615 * ``Note that 0 is taken as a flag, not as the
616 * beginning of a field width.''
621 case '1': case '2': case '3': case '4':
622 case '5': case '6': case '7': case '8': case '9':
625 n = 10 * n + to_digit(ch);
627 } while (is_digit(ch));
630 if (argtable == NULL) {
631 argtable = statargtable;
632 if (__find_warguments (fmt0, orgap,
642 #ifndef NO_FLOATING_POINT
648 if (flags & SHORTINT) {
658 if (flags & LONGINT) {
665 flags |= LLONGINT; /* not necessarily */
678 *(cp = buf) = (wchar_t)GETARG(wint_t);
680 *(cp = buf) = (wchar_t)btowc(GETARG(int));
689 if (flags & INTMAX_SIZE) {
691 if ((intmax_t)ujval < 0) {
697 if ((long)ulval < 0) {
704 #ifndef NO_FLOATING_POINT
718 if (flags & LONGDBL) {
719 fparg.ldbl = GETARG(long double);
721 __hldtoa(fparg.ldbl, xdigs, prec,
722 &expt, &signflag, &dtoaend);
724 fparg.dbl = GETARG(double);
726 __hdtoa(fparg.dbl, xdigs, prec,
727 &expt, &signflag, &dtoaend);
730 prec = dtoaend - dtoaresult;
735 ndig = dtoaend - dtoaresult;
736 cp = convbuf = __mbsconv(dtoaresult, -1);
737 freedtoa(dtoaresult);
742 if (prec < 0) /* account for digit before decpt */
753 expchar = ch - ('g' - 'e');
761 if (flags & LONGDBL) {
762 fparg.ldbl = GETARG(long double);
764 __ldtoa(&fparg.ldbl, expchar ? 2 : 3, prec,
765 &expt, &signflag, &dtoaend);
767 fparg.dbl = GETARG(double);
769 dtoa(fparg.dbl, expchar ? 2 : 3, prec,
770 &expt, &signflag, &dtoaend);
774 ndig = dtoaend - dtoaresult;
775 cp = convbuf = __mbsconv(dtoaresult, -1);
776 freedtoa(dtoaresult);
780 if (expt == INT_MAX) { /* inf or nan */
782 cp = (ch >= 'a') ? L"nan" : L"NAN";
785 cp = (ch >= 'a') ? L"inf" : L"INF";
791 if (ch == 'g' || ch == 'G') {
792 if (expt > -4 && expt <= prec) {
793 /* Make %[gG] smell like %[fF] */
803 * Make %[gG] smell like %[eE], but
804 * trim trailing zeroes if no # flag.
811 expsize = exponent(expstr, expt - 1, expchar);
812 size = expsize + prec;
813 if (prec > 1 || flags & ALT)
816 /* space for digits before decimal point */
821 /* space for decimal pt and following digits */
822 if (prec || flags & ALT)
824 if ((flags & GROUPING) && expt > 0)
825 size += grouping_init(&gs, expt, locale);
828 #endif /* !NO_FLOATING_POINT */
831 * Assignment-like behavior is specified if the
832 * value overflows or is otherwise unrepresentable.
833 * C99 says to use `signed char' for %hhn conversions.
835 if (flags & LLONGINT)
836 *GETARG(long long *) = ret;
837 else if (flags & SIZET)
838 *GETARG(ssize_t *) = (ssize_t)ret;
839 else if (flags & PTRDIFFT)
840 *GETARG(ptrdiff_t *) = ret;
841 else if (flags & INTMAXT)
842 *GETARG(intmax_t *) = ret;
843 else if (flags & LONGINT)
844 *GETARG(long *) = ret;
845 else if (flags & SHORTINT)
846 *GETARG(short *) = ret;
847 else if (flags & CHARINT)
848 *GETARG(signed char *) = ret;
850 *GETARG(int *) = ret;
851 continue; /* no output */
856 if (flags & INTMAX_SIZE)
864 * ``The argument shall be a pointer to void. The
865 * value of the pointer is converted to a sequence
866 * of printable characters, in an implementation-
870 ujval = (uintmax_t)(uintptr_t)GETARG(void *);
873 flags = flags | INTMAXT;
880 if (flags & LONGINT) {
881 if ((cp = GETARG(wchar_t *)) == NULL)
888 if ((mbp = GETARG(char *)) == NULL)
891 convbuf = __mbsconv(mbp, prec);
892 if (convbuf == NULL) {
893 fp->pub._flags |= __SERR;
899 size = (prec >= 0) ? wcsnlen(cp, prec) : wcslen(cp);
906 if (flags & INTMAX_SIZE)
918 if (flags & INTMAX_SIZE)
923 /* leading 0x/X only if non-zero */
925 (flags & INTMAX_SIZE ? ujval != 0 : ulval != 0))
929 /* unsigned conversions */
932 * ``... diouXx conversions ... if a precision is
933 * specified, the 0 flag will be ignored.''
936 number: if ((dprec = prec) >= 0)
940 * ``The result of converting a zero value with an
941 * explicit precision of zero is no characters.''
944 * ``The C Standard is clear enough as is. The call
945 * printf("%#.0o", 0) should print 0.''
946 * -- Defect Report #151
949 if (flags & INTMAX_SIZE) {
950 if (ujval != 0 || prec != 0 ||
951 (flags & ALT && base == 8))
952 cp = __ujtoa(ujval, cp, base,
955 if (ulval != 0 || prec != 0 ||
956 (flags & ALT && base == 8))
957 cp = __ultoa(ulval, cp, base,
960 size = buf + BUF - cp;
961 if (size > BUF) /* should never happen */
963 if ((flags & GROUPING) && size != 0)
964 size += grouping_init(&gs, size, locale);
966 default: /* "%?" prints ?, unless ? is NUL */
969 /* pretend it was %c with argument ch */
978 * All reasonable formats wind up here. At this point, `cp'
979 * points to a string which (if not flags&LADJUST) should be
980 * padded out to `width' places. If flags&ZEROPAD, it should
981 * first be prefixed by any sign or other prefix; otherwise,
982 * it should be blank padded before the prefix is emitted.
983 * After any left-hand padding and prefixing, emit zeroes
984 * required by a decimal [diouxX] precision, then print the
985 * string proper, then emit zeroes required by any leftover
986 * floating precision; finally, if LADJUST, pad with blanks.
988 * Compute actual size, so we know how much to pad.
989 * size excludes decimal prec; realsz includes it.
991 realsz = dprec > size ? dprec : size;
997 prsize = width > realsz ? width : realsz;
998 if ((unsigned)ret + prsize > INT_MAX) {
1004 /* right-adjusting blank padding */
1005 if ((flags & (LADJUST|ZEROPAD)) == 0)
1006 PAD(width - realsz, blanks);
1012 if (ox[1]) { /* ox[1] is either x, X, or \0 */
1017 /* right-adjusting zero padding */
1018 if ((flags & (LADJUST|ZEROPAD)) == ZEROPAD)
1019 PAD(width - realsz, zeroes);
1021 /* the string or number proper */
1022 #ifndef NO_FLOATING_POINT
1023 if ((flags & FPT) == 0) {
1025 /* leading zeroes from decimal precision */
1026 PAD(dprec - size, zeroes);
1028 if (grouping_print(&gs, &io, cp, buf+BUF, locale) < 0)
1033 #ifndef NO_FLOATING_POINT
1034 } else { /* glue together f_p fragments */
1035 if (!expchar) { /* %[fF] or sufficiently short %[gG] */
1038 if (prec || flags & ALT)
1039 PRINT(&decimal_point, 1);
1041 /* already handled initial 0's */
1045 n = grouping_print(&gs, &io,
1046 cp, convbuf + ndig, locale);
1051 PRINTANDPAD(cp, convbuf + ndig,
1055 if (prec || flags & ALT)
1056 PRINT(&decimal_point, 1);
1058 PRINTANDPAD(cp, convbuf + ndig, prec, zeroes);
1059 } else { /* %[eE] or sufficiently long %[gG] */
1060 if (prec > 1 || flags & ALT) {
1062 buf[1] = decimal_point;
1065 PAD(prec - ndig, zeroes);
1068 PRINT(expstr, expsize);
1072 /* left-adjusting padding (always blank) */
1073 if (flags & LADJUST)
1074 PAD(width - realsz, blanks);
1076 /* finally, adjust ret */
1079 FLUSH(); /* copy out the I/O vectors */
1085 if (convbuf != NULL)
1089 if ((argtable != NULL) && (argtable != statargtable))