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 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
16 * 3. Neither the name of the University nor the names of its contributors
17 * may be used to endorse or promote products derived from this software
18 * without specific prior written permission.
20 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 * @(#)vfprintf.c 8.1 (Berkeley) 6/4/93
33 * $FreeBSD: src/lib/libc/stdio/vfwprintf.c,v 1.41 2009/02/28 06:06:57 das Exp $
34 * $DragonFly: src/lib/libc/stdio/vfwprintf.c,v 1.3 2006/03/02 18:05:30 joerg Exp $
38 * Actual wprintf innards.
40 * Avoid making gratuitous changes to this source file; it should be kept
41 * as close as possible to vfprintf.c for ease of maintenance.
44 #include "namespace.h"
45 #include <sys/types.h>
58 #include "un-namespace.h"
60 #include "libc_private.h"
62 #include "priv_stdio.h"
63 #include "printflocal.h"
65 static int __sprint(FILE *, struct __suio *);
66 static int __sbprintf(FILE *, const wchar_t *, va_list) __noinline;
67 static wint_t __xfputwc(wchar_t, FILE *);
68 static wchar_t *__mbsconv(char *, int);
71 #include "printfcommon.h"
73 struct grouping_state {
74 wchar_t thousands_sep; /* locale-specific thousands separator */
75 const char *grouping; /* locale-specific numeric grouping rules */
76 int lead; /* sig figs before decimal or group sep */
77 int nseps; /* number of group separators with ' */
78 int nrepeats; /* number of repeats of the last group */
81 static const mbstate_t initial_mbs;
91 nconv = mbrtowc(&decpt, localeconv()->decimal_point, MB_CUR_MAX, &mbs);
92 if (nconv == (size_t)-1 || nconv == (size_t)-2)
93 decpt = '.'; /* failsafe */
105 nconv = mbrtowc(&thousep, localeconv()->thousands_sep,
107 if (nconv == (size_t)-1 || nconv == (size_t)-2)
108 thousep = '\0'; /* failsafe */
113 * Initialize the thousands' grouping state in preparation to print a
114 * number with ndigits digits. This routine returns the total number
115 * of wide characters that will be printed.
118 grouping_init(struct grouping_state *gs, int ndigits)
121 gs->grouping = localeconv()->grouping;
122 gs->thousands_sep = get_thousep();
124 gs->nseps = gs->nrepeats = 0;
126 while (*gs->grouping != CHAR_MAX) {
127 if (gs->lead <= *gs->grouping)
129 gs->lead -= *gs->grouping;
130 if (*(gs->grouping+1)) {
136 return (gs->nseps + gs->nrepeats);
140 * Print a number with thousands' separators.
143 grouping_print(struct grouping_state *gs, struct io_state *iop,
144 const CHAR *cp, const CHAR *ep)
146 const CHAR *cp0 = cp;
148 if (io_printandpad(iop, cp, ep, gs->lead, zeroes))
151 while (gs->nseps > 0 || gs->nrepeats > 0) {
152 if (gs->nrepeats > 0)
158 if (io_print(iop, &gs->thousands_sep, 1))
160 if (io_printandpad(iop, cp, ep, *gs->grouping, zeroes))
171 * Flush out all the vectors defined by the given uio,
172 * then reset it so that it can be reused.
174 * XXX The fact that we do this a character at a time and convert to a
175 * multibyte character sequence even if the destination is a wide
176 * string eclipses the benefits of buffering.
179 __sprint(FILE *fp, struct __suio *uio)
186 for (; uio->uio_resid != 0; uio->uio_resid -= len, iov++) {
187 p = (wchar_t *)iov->iov_base;
189 for (i = 0; i < len; i++) {
190 if (__xfputwc(p[i], fp) == WEOF)
199 * Helper function for `fprintf to unbuffered unix file': creates a
200 * temporary buffer. We only work on write-only files; this avoids
201 * worries about ungetc buffers and so forth.
204 __sbprintf(FILE *fp, const wchar_t *fmt, va_list ap)
208 unsigned char buf[BUFSIZ];
210 /* XXX This is probably not needed. */
211 if (prepwrite(fp) != 0)
214 /* copy the important variables */
215 fake.pub._flags = fp->pub._flags & ~__SNBF;
216 fake.pub._fileno = fp->pub._fileno;
217 fake._cookie = fp->_cookie;
218 fake._write = fp->_write;
219 memcpy(WCIO_GET(&fake), WCIO_GET(fp), sizeof(struct wchar_io_data));
221 /* set up the buffer */
222 fake._bf._base = fake.pub._p = buf;
223 fake._bf._size = fake.pub._w = sizeof(buf);
224 fake.pub._lbfsize = 0; /* not actually used, but Just In Case */
226 /* do the work, then copy any error status */
227 ret = __vfwprintf(&fake, fmt, ap);
228 if (ret >= 0 && __fflush(&fake))
230 if (fake.pub._flags & __SERR)
231 fp->pub._flags |= __SERR;
236 * Like __fputwc, but handles fake string (__SSTR) files properly.
237 * File must already be locked.
240 __xfputwc(wchar_t wc, FILE *fp)
243 char buf[MB_LEN_MAX];
248 if ((fp->pub._flags & __SSTR) == 0)
249 return (__fputwc_unlock(wc, fp));
252 if ((len = wcrtomb(buf, wc, &mbs)) == (size_t)-1) {
253 fp->pub._flags |= __SERR;
261 return (__sfvwrite(fp, &uio) != EOF ? (wint_t)wc : WEOF);
265 * Convert a multibyte character string argument for the %s format to a wide
266 * string representation. ``prec'' specifies the maximum number of bytes
267 * to output. If ``prec'' is greater than or equal to zero, we can't assume
268 * that the multibyte char. string ends in a null character.
271 __mbsconv(char *mbsarg, int prec)
274 wchar_t *convbuf, *wcp;
276 size_t insize, nchars, nconv;
282 * Supplied argument is a multibyte string; convert it to wide
287 * String is not guaranteed to be NUL-terminated. Find the
288 * number of characters to print.
293 while (nchars != (size_t)prec) {
294 nconv = mbrlen(p, MB_CUR_MAX, &mbs);
295 if (nconv == 0 || nconv == (size_t)-1 ||
302 if (nconv == (size_t)-1 || nconv == (size_t)-2)
305 insize = strlen(mbsarg);
310 * Allocate buffer for the result and perform the conversion,
311 * converting at most `size' bytes of the input multibyte string to
312 * wide characters for printing.
314 convbuf = malloc((insize + 1) * sizeof(*convbuf));
320 while (insize != 0) {
321 nconv = mbrtowc(wcp, p, insize, &mbs);
322 if (nconv == 0 || nconv == (size_t)-1 || nconv == (size_t)-2)
328 if (nconv == (size_t)-1 || nconv == (size_t)-2) {
341 vfwprintf(FILE * __restrict fp, const wchar_t * __restrict fmt0, va_list ap)
346 /* optimise fprintf(stderr) (and other unbuffered Unix files) */
347 if ((fp->pub._flags & (__SNBF|__SWR|__SRW)) == (__SNBF|__SWR) &&
348 fp->pub._fileno >= 0)
349 ret = __sbprintf(fp, fmt0, ap);
351 ret = __vfwprintf(fp, fmt0, ap);
357 * The size of the buffer we use as scratch space for integer
358 * conversions, among other things. We need enough space to
359 * write a uintmax_t in octal (plus one byte).
361 #if UINTMAX_MAX <= UINT64_MAX
364 #error "BUF must be large enough to format a uintmax_t"
368 * Non-MT-safe version
371 __vfwprintf(FILE *fp, const wchar_t *fmt0, va_list ap)
373 wchar_t *fmt; /* format string */
374 wchar_t ch; /* character from fmt */
375 int n, n2; /* handy integer (short term usage) */
376 wchar_t *cp; /* handy char pointer (short term usage) */
377 int flags; /* flags as above */
378 int ret; /* return value accumulator */
379 int width; /* width from format (%8d), or 0 */
380 int prec; /* precision from format; <0 for N/A */
381 wchar_t sign; /* sign prefix (' ', '+', '-', or \0) */
382 struct grouping_state gs; /* thousands' grouping info */
383 #ifndef NO_FLOATING_POINT
385 * We can decompose the printed representation of floating
386 * point numbers into several parts, some of which may be empty:
388 * [+|-| ] [0x|0X] MMM . NNN [e|E|p|P] [+|-] ZZ
391 * A: 'sign' holds this value if present; '\0' otherwise
392 * B: ox[1] holds the 'x' or 'X'; '\0' if not hexadecimal
393 * C: cp points to the string MMMNNN. Leading and trailing
394 * zeros are not in the string and must be added.
395 * D: expchar holds this character; '\0' if no exponent, e.g. %f
396 * F: at least two digits for decimal, at least one digit for hex
398 wchar_t decimal_point; /* locale specific decimal point */
399 int signflag; /* true if float is negative */
400 union { /* floating point arguments %[aAeEfFgG] */
404 int expt; /* integer value of exponent */
405 char expchar; /* exponent character: [eEpP\0] */
406 char *dtoaend; /* pointer to end of converted digits */
407 int expsize; /* character count for expstr */
408 int ndig; /* actual number of digits returned by dtoa */
409 wchar_t expstr[MAXEXPDIG+2]; /* buffer for exponent string: e+ZZZ */
410 char *dtoaresult; /* buffer allocated by dtoa */
412 u_long ulval; /* integer arguments %[diouxX] */
413 uintmax_t ujval; /* %j, %ll, %q, %t, %z integers */
414 int base; /* base for [diouxX] conversion */
415 int dprec; /* a copy of prec if [diouxX], 0 otherwise */
416 int realsz; /* field size expanded by dprec, sign, etc */
417 int size; /* size of converted field or string */
418 int prsize; /* max size of printed field */
419 const char *xdigs; /* digits for [xX] conversion */
420 struct io_state io; /* I/O buffering state */
421 wchar_t buf[BUF]; /* buffer with space for digits of uintmax_t */
422 wchar_t ox[2]; /* space for 0x hex-prefix */
423 union arg *argtable; /* args, built due to positional arg */
424 union arg statargtable [STATIC_ARG_TBL_SIZE];
425 int nextarg; /* 1-based argument index */
426 va_list orgap; /* original argument pointer */
427 wchar_t *convbuf; /* multibyte to wide conversion result */
429 static const char xdigs_lower[16] = "0123456789abcdef";
430 static const char xdigs_upper[16] = "0123456789ABCDEF";
432 /* BEWARE, these `goto error' on error. */
433 #define PRINT(ptr, len) do { \
434 if (io_print(&io, (ptr), (len))) \
437 #define PAD(howmany, with) { \
438 if (io_pad(&io, (howmany), (with))) \
441 #define PRINTANDPAD(p, ep, len, with) { \
442 if (io_printandpad(&io, (p), (ep), (len), (with))) \
451 * Get the argument indexed by nextarg. If the argument table is
452 * built, use it to get the argument. If its not, get the next
453 * argument (and arguments must be gotten sequentially).
455 #define GETARG(type) \
456 ((argtable != NULL) ? *((type*)(&argtable[nextarg++])) : \
457 (nextarg++, va_arg(ap, type)))
460 * To extend shorts properly, we need both signed and unsigned
461 * argument extraction methods.
464 (flags&LONGINT ? GETARG(long) : \
465 flags&SHORTINT ? (long)(short)GETARG(int) : \
466 flags&CHARINT ? (long)(signed char)GETARG(int) : \
469 (flags&LONGINT ? GETARG(u_long) : \
470 flags&SHORTINT ? (u_long)(u_short)GETARG(int) : \
471 flags&CHARINT ? (u_long)(u_char)GETARG(int) : \
472 (u_long)GETARG(u_int))
473 #define INTMAX_SIZE (INTMAXT|SIZET|PTRDIFFT|LLONGINT)
475 (flags&INTMAXT ? GETARG(intmax_t) : \
476 flags&SIZET ? (intmax_t)GETARG(ssize_t) : \
477 flags&PTRDIFFT ? (intmax_t)GETARG(ptrdiff_t) : \
478 (intmax_t)GETARG(long long))
480 (flags&INTMAXT ? GETARG(uintmax_t) : \
481 flags&SIZET ? (uintmax_t)GETARG(size_t) : \
482 flags&PTRDIFFT ? (uintmax_t)GETARG(ptrdiff_t) : \
483 (uintmax_t)GETARG(unsigned long long))
486 * Get * arguments, including the form *nn$. Preserve the nextarg
487 * that the argument can be gotten once the type is determined.
489 #define GETASTER(val) \
492 while (is_digit(*cp)) { \
493 n2 = 10 * n2 + to_digit(*cp); \
497 int hold = nextarg; \
498 if (argtable == NULL) { \
499 argtable = statargtable; \
500 if (__find_warguments(fmt0, orgap, &argtable)) { \
506 val = GETARG (int); \
510 val = GETARG (int); \
514 /* sorry, fwprintf(read_only_file, L"") returns WEOF, not 0 */
515 if (prepwrite(fp) != 0)
519 fmt = __DECONST(wchar_t *, fmt0);
525 #ifndef NO_FLOATING_POINT
526 decimal_point = get_decpt();
530 * Scan the format for conversions (`%' character).
533 for (cp = fmt; (ch = *fmt) != '\0' && ch != '%'; fmt++)
535 if ((n = fmt - cp) != 0) {
536 if ((unsigned)ret + n > INT_MAX) {
545 fmt++; /* skip over '%' */
556 reswitch: switch (ch) {
559 * ``If the space and + flags both appear, the space
560 * flag will be ignored.''
571 * ``A negative field width argument is taken as a
572 * - flag followed by a positive field width.''
574 * They don't exclude field widths read from args.
591 if ((ch = *fmt++) == '*') {
596 while (is_digit(ch)) {
597 prec = 10 * prec + to_digit(ch);
603 * ``Note that 0 is taken as a flag, not as the
604 * beginning of a field width.''
609 case '1': case '2': case '3': case '4':
610 case '5': case '6': case '7': case '8': case '9':
613 n = 10 * n + to_digit(ch);
615 } while (is_digit(ch));
618 if (argtable == NULL) {
619 argtable = statargtable;
620 if (__find_warguments(fmt0, orgap,
630 #ifndef NO_FLOATING_POINT
636 if (flags & SHORTINT) {
647 if (flags & LONGINT) {
655 flags |= LLONGINT; /* not necessarily */
668 *(cp = buf) = (wchar_t)GETARG(wint_t);
670 *(cp = buf) = (wchar_t)btowc(GETARG(int));
679 if (flags & INTMAX_SIZE) {
681 if ((intmax_t)ujval < 0) {
687 if ((long)ulval < 0) {
694 #ifndef NO_FLOATING_POINT
708 if (flags & LONGDBL) {
709 fparg.ldbl = GETARG(long double);
711 __hldtoa(fparg.ldbl, xdigs, prec,
712 &expt, &signflag, &dtoaend);
714 fparg.dbl = GETARG(double);
716 __hdtoa(fparg.dbl, xdigs, prec,
717 &expt, &signflag, &dtoaend);
720 prec = dtoaend - dtoaresult;
725 ndig = dtoaend - dtoaresult;
726 cp = convbuf = __mbsconv(dtoaresult, -1);
727 freedtoa(dtoaresult);
732 if (prec < 0) /* account for digit before decpt */
743 expchar = ch - ('g' - 'e');
751 if (flags & LONGDBL) {
752 fparg.ldbl = GETARG(long double);
754 __ldtoa(&fparg.ldbl, expchar ? 2 : 3, prec,
755 &expt, &signflag, &dtoaend);
757 fparg.dbl = GETARG(double);
759 dtoa(fparg.dbl, expchar ? 2 : 3, prec,
760 &expt, &signflag, &dtoaend);
764 ndig = dtoaend - dtoaresult;
765 cp = convbuf = __mbsconv(dtoaresult, -1);
766 freedtoa(dtoaresult);
770 if (expt == INT_MAX) { /* inf or nan */
772 cp = (ch >= 'a') ? L"nan" : L"NAN";
775 cp = (ch >= 'a') ? L"inf" : L"INF";
781 if (ch == 'g' || ch == 'G') {
782 if (expt > -4 && expt <= prec) {
783 /* Make %[gG] smell like %[fF] */
793 * Make %[gG] smell like %[eE], but
794 * trim trailing zeroes if no # flag.
801 expsize = exponent(expstr, expt - 1, expchar);
802 size = expsize + prec;
803 if (prec > 1 || flags & ALT)
806 /* space for digits before decimal point */
811 /* space for decimal pt and following digits */
812 if (prec || flags & ALT)
814 if ((flags & GROUPING) && expt > 0)
815 size += grouping_init(&gs, expt);
818 #endif /* !NO_FLOATING_POINT */
821 * Assignment-like behavior is specified if the
822 * value overflows or is otherwise unrepresentable.
823 * C99 says to use `signed char' for %hhn conversions.
825 if (flags & LLONGINT)
826 *GETARG(long long *) = ret;
827 else if (flags & SIZET)
828 *GETARG(ssize_t *) = (ssize_t)ret;
829 else if (flags & PTRDIFFT)
830 *GETARG(ptrdiff_t *) = ret;
831 else if (flags & INTMAXT)
832 *GETARG(intmax_t *) = ret;
833 else if (flags & LONGINT)
834 *GETARG(long *) = ret;
835 else if (flags & SHORTINT)
836 *GETARG(short *) = ret;
837 else if (flags & CHARINT)
838 *GETARG(signed char *) = ret;
840 *GETARG(int *) = ret;
841 continue; /* no output */
846 if (flags & INTMAX_SIZE)
854 * ``The argument shall be a pointer to void. The
855 * value of the pointer is converted to a sequence
856 * of printable characters, in an implementation-
860 ujval = (uintmax_t)(uintptr_t)GETARG(void *);
863 flags = flags | INTMAXT;
870 if (flags & LONGINT) {
871 if ((cp = GETARG(wchar_t *)) == NULL)
878 if ((mbp = GETARG(char *)) == NULL)
881 convbuf = __mbsconv(mbp, prec);
882 if (convbuf == NULL) {
883 fp->pub._flags |= __SERR;
889 size = (prec >= 0) ? wcsnlen(cp, prec) : wcslen(cp);
896 if (flags & INTMAX_SIZE)
908 if (flags & INTMAX_SIZE)
913 /* leading 0x/X only if non-zero */
915 (flags & INTMAX_SIZE ? ujval != 0 : ulval != 0))
919 /* unsigned conversions */
922 * ``... diouXx conversions ... if a precision is
923 * specified, the 0 flag will be ignored.''
926 number: if ((dprec = prec) >= 0)
930 * ``The result of converting a zero value with an
931 * explicit precision of zero is no characters.''
934 * ``The C Standard is clear enough as is. The call
935 * printf("%#.0o", 0) should print 0.''
936 * -- Defect Report #151
939 if (flags & INTMAX_SIZE) {
940 if (ujval != 0 || prec != 0 ||
941 (flags & ALT && base == 8))
942 cp = __ujtoa(ujval, cp, base,
945 if (ulval != 0 || prec != 0 ||
946 (flags & ALT && base == 8))
947 cp = __ultoa(ulval, cp, base,
950 size = buf + BUF - cp;
951 if (size > BUF) /* should never happen */
953 if ((flags & GROUPING) && size != 0)
954 size += grouping_init(&gs, size);
956 default: /* "%?" prints ?, unless ? is NUL */
959 /* pretend it was %c with argument ch */
968 * All reasonable formats wind up here. At this point, `cp'
969 * points to a string which (if not flags&LADJUST) should be
970 * padded out to `width' places. If flags&ZEROPAD, it should
971 * first be prefixed by any sign or other prefix; otherwise,
972 * it should be blank padded before the prefix is emitted.
973 * After any left-hand padding and prefixing, emit zeroes
974 * required by a decimal [diouxX] precision, then print the
975 * string proper, then emit zeroes required by any leftover
976 * floating precision; finally, if LADJUST, pad with blanks.
978 * Compute actual size, so we know how much to pad.
979 * size excludes decimal prec; realsz includes it.
981 realsz = dprec > size ? dprec : size;
987 prsize = width > realsz ? width : realsz;
988 if ((unsigned)ret + prsize > INT_MAX) {
993 /* right-adjusting blank padding */
994 if ((flags & (LADJUST|ZEROPAD)) == 0)
995 PAD(width - realsz, blanks);
1001 if (ox[1]) { /* ox[1] is either x, X, or \0 */
1006 /* right-adjusting zero padding */
1007 if ((flags & (LADJUST|ZEROPAD)) == ZEROPAD)
1008 PAD(width - realsz, zeroes);
1010 /* the string or number proper */
1011 #ifndef NO_FLOATING_POINT
1012 if ((flags & FPT) == 0) {
1014 /* leading zeroes from decimal precision */
1015 PAD(dprec - size, zeroes);
1017 if (grouping_print(&gs, &io, cp, buf+BUF) < 0)
1022 #ifndef NO_FLOATING_POINT
1023 } else { /* glue together f_p fragments */
1024 if (!expchar) { /* %[fF] or sufficiently short %[gG] */
1027 if (prec || flags & ALT)
1028 PRINT(&decimal_point, 1);
1030 /* already handled initial 0's */
1034 n = grouping_print(&gs, &io,
1035 cp, convbuf + ndig);
1040 PRINTANDPAD(cp, convbuf + ndig,
1044 if (prec || flags & ALT)
1045 PRINT(&decimal_point, 1);
1047 PRINTANDPAD(cp, convbuf + ndig, prec, zeroes);
1048 } else { /* %[eE] or sufficiently long %[gG] */
1049 if (prec > 1 || flags & ALT) {
1051 buf[1] = decimal_point;
1054 PAD(prec - ndig, zeroes);
1057 PRINT(expstr, expsize);
1061 /* left-adjusting padding (always blank) */
1062 if (flags & LADJUST)
1063 PAD(width - realsz, blanks);
1065 /* finally, adjust ret */
1068 FLUSH(); /* copy out the I/O vectors */
1074 if (convbuf != NULL)
1078 if ((argtable != NULL) && (argtable != statargtable))