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 * 4. 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>
65 #include "xlocale_private.h"
66 #include "un-namespace.h"
68 #include "libc_private.h"
71 #include "printflocal.h"
73 static int __sprint(FILE *, struct __suio *, locale_t);
74 static int __sbprintf(FILE *, locale_t, const char *, va_list) __printflike(3, 0)
76 static char *__wcsconv(wchar_t *, int);
79 #include "printfcommon.h"
81 struct grouping_state {
82 char *thousands_sep; /* locale-specific thousands separator */
83 int thousep_len; /* length of thousands_sep */
84 const char *grouping; /* locale-specific numeric grouping rules */
85 int lead; /* sig figs before decimal or group sep */
86 int nseps; /* number of group separators with ' */
87 int nrepeats; /* number of repeats of the last group */
91 * Initialize the thousands' grouping state in preparation to print a
92 * number with ndigits digits. This routine returns the total number
93 * of bytes that will be needed.
96 grouping_init(struct grouping_state *gs, int ndigits, locale_t loc)
100 locale = localeconv_l(loc);
101 gs->grouping = locale->grouping;
102 gs->thousands_sep = locale->thousands_sep;
103 gs->thousep_len = strlen(gs->thousands_sep);
105 gs->nseps = gs->nrepeats = 0;
107 while (*gs->grouping != CHAR_MAX) {
108 if (gs->lead <= *gs->grouping)
110 gs->lead -= *gs->grouping;
111 if (*(gs->grouping+1)) {
117 return ((gs->nseps + gs->nrepeats) * gs->thousep_len);
121 * Print a number with thousands' separators.
124 grouping_print(struct grouping_state *gs, struct io_state *iop,
125 const CHAR *cp, const CHAR *ep, locale_t locale)
127 const CHAR *cp0 = cp;
129 if (io_printandpad(iop, cp, ep, gs->lead, zeroes, locale))
132 while (gs->nseps > 0 || gs->nrepeats > 0) {
133 if (gs->nrepeats > 0)
139 if (io_print(iop, gs->thousands_sep, gs->thousep_len, locale))
141 if (io_printandpad(iop, cp, ep, *gs->grouping, zeroes, locale))
151 * Flush out all the vectors defined by the given uio,
152 * then reset it so that it can be reused.
155 __sprint(FILE *fp, struct __suio *uio, locale_t locale)
159 if (uio->uio_resid == 0) {
163 err = __sfvwrite(fp, uio);
170 * Helper function for `fprintf to unbuffered unix file': creates a
171 * temporary buffer. We only work on write-only files; this avoids
172 * worries about ungetc buffers and so forth.
175 __sbprintf(FILE *fp, locale_t locale, const char *fmt, va_list ap)
178 FILE fake = FAKE_FILE;
179 unsigned char buf[BUFSIZ];
181 /* XXX This is probably not needed. */
182 if (prepwrite(fp) != 0)
185 /* copy the important variables */
186 fake._flags = fp->_flags & ~__SNBF;
187 fake._file = fp->_file;
188 fake._cookie = fp->_cookie;
189 fake._write = fp->_write;
190 fake._orientation = fp->_orientation;
191 fake._mbstate = fp->_mbstate;
193 /* set up the buffer */
194 fake._bf._base = fake._p = buf;
195 fake._bf._size = fake._w = sizeof(buf);
196 fake._lbfsize = 0; /* not actually used, but Just In Case */
198 /* do the work, then copy any error status */
199 ret = __vfprintf(&fake, locale, fmt, ap);
200 if (ret >= 0 && __fflush(&fake))
202 if (fake._flags & __SERR)
203 fp->_flags |= __SERR;
208 * Convert a wide character string argument for the %ls format to a multibyte
209 * string representation. If not -1, prec specifies the maximum number of
210 * bytes to output, and also means that we can't assume that the wide char.
211 * string ends is null-terminated.
214 __wcsconv(wchar_t *wcsarg, int prec)
216 static const mbstate_t initial;
218 char buf[MB_LEN_MAX];
223 /* Allocate space for the maximum number of bytes we could output. */
227 nbytes = wcsrtombs(NULL, (const wchar_t **)&p, 0, &mbs);
228 if (nbytes == (size_t)-1)
232 * Optimisation: if the output precision is small enough,
233 * just allocate enough memory for the maximum instead of
234 * scanning the string.
243 clen = wcrtomb(buf, *p++, &mbs);
244 if (clen == 0 || clen == (size_t)-1 ||
245 nbytes + clen > prec)
251 if ((convbuf = malloc(nbytes + 1)) == NULL)
254 /* Fill the output buffer. */
257 if ((nbytes = wcsrtombs(convbuf, (const wchar_t **)&p,
258 nbytes, &mbs)) == (size_t)-1) {
262 convbuf[nbytes] = '\0';
270 vfprintf_l(FILE * __restrict fp, locale_t locale, const char * __restrict fmt0,
277 /* optimise fprintf(stderr) (and other unbuffered Unix files) */
278 if ((fp->_flags & (__SNBF|__SWR|__SRW)) == (__SNBF|__SWR) &&
280 ret = __sbprintf(fp, locale, fmt0, ap);
282 ret = __vfprintf(fp, locale, fmt0, ap);
287 vfprintf(FILE * __restrict fp, const char * __restrict fmt0, va_list ap)
289 return vfprintf_l(fp, __get_locale(), fmt0, ap);
293 * The size of the buffer we use as scratch space for integer
294 * conversions, among other things. We need enough space to
295 * write a uintmax_t in octal (plus one byte).
297 #if UINTMAX_MAX <= UINT64_MAX
300 #error "BUF must be large enough to format a uintmax_t"
304 * Non-MT-safe version
307 __vfprintf(FILE *fp, locale_t locale, const char *fmt0, va_list ap)
309 char *fmt; /* format string */
310 int ch; /* character from fmt */
311 int n, n2; /* handy integer (short term usage) */
312 char *cp; /* handy char pointer (short term usage) */
313 int flags; /* flags as above */
314 int ret; /* return value accumulator */
315 int width; /* width from format (%8d), or 0 */
316 int prec; /* precision from format; <0 for N/A */
317 char sign; /* sign prefix (' ', '+', '-', or \0) */
318 struct grouping_state gs; /* thousands' grouping info */
320 #ifndef NO_FLOATING_POINT
322 * We can decompose the printed representation of floating
323 * point numbers into several parts, some of which may be empty:
325 * [+|-| ] [0x|0X] MMM . NNN [e|E|p|P] [+|-] ZZ
328 * A: 'sign' holds this value if present; '\0' otherwise
329 * B: ox[1] holds the 'x' or 'X'; '\0' if not hexadecimal
330 * C: cp points to the string MMMNNN. Leading and trailing
331 * zeros are not in the string and must be added.
332 * D: expchar holds this character; '\0' if no exponent, e.g. %f
333 * F: at least two digits for decimal, at least one digit for hex
335 char *decimal_point; /* locale specific decimal point */
336 int decpt_len; /* length of decimal_point */
337 int signflag; /* true if float is negative */
338 union { /* floating point arguments %[aAeEfFgG] */
342 int expt; /* integer value of exponent */
343 char expchar; /* exponent character: [eEpP\0] */
344 char *dtoaend; /* pointer to end of converted digits */
345 int expsize; /* character count for expstr */
346 int ndig; /* actual number of digits returned by dtoa */
347 char expstr[MAXEXPDIG+2]; /* buffer for exponent string: e+ZZZ */
348 char *dtoaresult; /* buffer allocated by dtoa */
350 u_long ulval; /* integer arguments %[diouxX] */
351 uintmax_t ujval; /* %j, %ll, %q, %t, %z integers */
352 int base; /* base for [diouxX] conversion */
353 int dprec; /* a copy of prec if [diouxX], 0 otherwise */
354 int realsz; /* field size expanded by dprec, sign, etc */
355 int size; /* size of converted field or string */
356 int prsize; /* max size of printed field */
357 const char *xdigs; /* digits for %[xX] conversion */
358 struct io_state io; /* I/O buffering state */
359 char buf[BUF]; /* buffer with space for digits of uintmax_t */
360 char ox[2]; /* space for 0x; ox[1] is either x, X, or \0 */
361 union arg *argtable; /* args, built due to positional arg */
362 union arg statargtable [STATIC_ARG_TBL_SIZE];
363 int nextarg; /* 1-based argument index */
364 va_list orgap; /* original argument pointer */
365 char *convbuf; /* wide to multibyte conversion result */
367 static const char xdigs_lower[16] = "0123456789abcdef";
368 static const char xdigs_upper[16] = "0123456789ABCDEF";
370 /* BEWARE, these `goto error' on error. */
371 #define PRINT(ptr, len) { \
372 if (io_print(&io, (ptr), (len), locale)) \
375 #define PAD(howmany, with) { \
376 if (io_pad(&io, (howmany), (with), locale)) \
379 #define PRINTANDPAD(p, ep, len, with) { \
380 if (io_printandpad(&io, (p), (ep), (len), (with), locale)) \
384 if (io_flush(&io, locale)) \
389 * Get the argument indexed by nextarg. If the argument table is
390 * built, use it to get the argument. If its not, get the next
391 * argument (and arguments must be gotten sequentially).
393 #define GETARG(type) \
394 ((argtable != NULL) ? *((type*)(&argtable[nextarg++])) : \
395 (nextarg++, va_arg(ap, type)))
398 * To extend shorts properly, we need both signed and unsigned
399 * argument extraction methods.
402 (flags&LONGINT ? GETARG(long) : \
403 flags&SHORTINT ? (long)(short)GETARG(int) : \
404 flags&CHARINT ? (long)(signed char)GETARG(int) : \
407 (flags&LONGINT ? GETARG(u_long) : \
408 flags&SHORTINT ? (u_long)(u_short)GETARG(int) : \
409 flags&CHARINT ? (u_long)(u_char)GETARG(int) : \
410 (u_long)GETARG(u_int))
411 #define INTMAX_SIZE (INTMAXT|SIZET|PTRDIFFT|LLONGINT)
413 (flags&INTMAXT ? GETARG(intmax_t) : \
414 flags&SIZET ? (intmax_t)GETARG(ssize_t) : \
415 flags&PTRDIFFT ? (intmax_t)GETARG(ptrdiff_t) : \
416 (intmax_t)GETARG(long long))
418 (flags&INTMAXT ? GETARG(uintmax_t) : \
419 flags&SIZET ? (uintmax_t)GETARG(size_t) : \
420 flags&PTRDIFFT ? (uintmax_t)GETARG(ptrdiff_t) : \
421 (uintmax_t)GETARG(unsigned long long))
424 * Get * arguments, including the form *nn$. Preserve the nextarg
425 * that the argument can be gotten once the type is determined.
427 #define GETASTER(val) \
430 while (is_digit(*cp)) { \
431 n2 = 10 * n2 + to_digit(*cp); \
435 int hold = nextarg; \
436 if (argtable == NULL) { \
437 argtable = statargtable; \
438 if (__find_arguments (fmt0, orgap, &argtable)) { \
444 val = GETARG (int); \
448 val = GETARG (int); \
451 if (__use_xprintf == 0 && getenv("USE_XPRINTF"))
453 if (__use_xprintf > 0)
454 return (__xvprintf(fp, fmt0, ap));
456 /* sorry, fprintf(read_only_file, "") returns EOF, not 0 */
457 if (prepwrite(fp) != 0)
467 #ifndef NO_FLOATING_POINT
469 decimal_point = localeconv_l(locale)->decimal_point;
470 /* The overwhelmingly common case is decpt_len == 1. */
471 decpt_len = (decimal_point[1] == '\0' ? 1 : strlen(decimal_point));
475 * Scan the format for conversions (`%' character).
478 for (cp = fmt; (ch = *fmt) != '\0' && ch != '%'; fmt++)
480 if ((n = fmt - cp) != 0) {
481 if ((unsigned)ret + n > INT_MAX) {
490 fmt++; /* skip over '%' */
501 reswitch: switch (ch) {
504 * ``If the space and + flags both appear, the space
505 * flag will be ignored.''
516 * ``A negative field width argument is taken as a
517 * - flag followed by a positive field width.''
519 * They don't exclude field widths read from args.
536 if ((ch = *fmt++) == '*') {
541 while (is_digit(ch)) {
542 prec = 10 * prec + to_digit(ch);
548 * ``Note that 0 is taken as a flag, not as the
549 * beginning of a field width.''
554 case '1': case '2': case '3': case '4':
555 case '5': case '6': case '7': case '8': case '9':
558 n = 10 * n + to_digit(ch);
560 } while (is_digit(ch));
563 if (argtable == NULL) {
564 argtable = statargtable;
565 if (__find_arguments (fmt0, orgap,
575 #ifndef NO_FLOATING_POINT
581 if (flags & SHORTINT) {
591 if (flags & LONGINT) {
598 flags |= LLONGINT; /* not necessarily */
610 if (flags & LONGINT) {
611 static const mbstate_t initial;
616 mbseqlen = wcrtomb(cp = buf,
617 (wchar_t)GETARG(wint_t), &mbs);
618 if (mbseqlen == (size_t)-1) {
619 fp->_flags |= __SERR;
622 size = (int)mbseqlen;
624 *(cp = buf) = GETARG(int);
634 if (flags & INTMAX_SIZE) {
636 if ((intmax_t)ujval < 0) {
642 if ((long)ulval < 0) {
649 #ifndef NO_FLOATING_POINT
663 if (dtoaresult != NULL)
664 freedtoa(dtoaresult);
665 if (flags & LONGDBL) {
666 fparg.ldbl = GETARG(long double);
668 __hldtoa(fparg.ldbl, xdigs, prec,
669 &expt, &signflag, &dtoaend);
671 fparg.dbl = GETARG(double);
673 __hdtoa(fparg.dbl, xdigs, prec,
674 &expt, &signflag, &dtoaend);
684 if (prec < 0) /* account for digit before decpt */
695 expchar = ch - ('g' - 'e');
701 if (dtoaresult != NULL)
702 freedtoa(dtoaresult);
703 if (flags & LONGDBL) {
704 fparg.ldbl = GETARG(long double);
706 __ldtoa(&fparg.ldbl, expchar ? 2 : 3, prec,
707 &expt, &signflag, &dtoaend);
709 fparg.dbl = GETARG(double);
711 dtoa(fparg.dbl, expchar ? 2 : 3, prec,
712 &expt, &signflag, &dtoaend);
719 if (expt == INT_MAX) { /* inf or nan */
721 cp = (ch >= 'a') ? "nan" : "NAN";
724 cp = (ch >= 'a') ? "inf" : "INF";
731 if (ch == 'g' || ch == 'G') {
732 if (expt > -4 && expt <= prec) {
733 /* Make %[gG] smell like %[fF] */
743 * Make %[gG] smell like %[eE], but
744 * trim trailing zeroes if no # flag.
751 expsize = exponent(expstr, expt - 1, expchar);
752 size = expsize + prec;
753 if (prec > 1 || flags & ALT)
756 /* space for digits before decimal point */
761 /* space for decimal pt and following digits */
762 if (prec || flags & ALT)
763 size += prec + decpt_len;
764 if ((flags & GROUPING) && expt > 0)
765 size += grouping_init(&gs, expt, locale);
768 #endif /* !NO_FLOATING_POINT */
771 * Assignment-like behavior is specified if the
772 * value overflows or is otherwise unrepresentable.
773 * C99 says to use `signed char' for %hhn conversions.
775 if (flags & LLONGINT)
776 *GETARG(long long *) = ret;
777 else if (flags & SIZET)
778 *GETARG(ssize_t *) = (ssize_t)ret;
779 else if (flags & PTRDIFFT)
780 *GETARG(ptrdiff_t *) = ret;
781 else if (flags & INTMAXT)
782 *GETARG(intmax_t *) = ret;
783 else if (flags & LONGINT)
784 *GETARG(long *) = ret;
785 else if (flags & SHORTINT)
786 *GETARG(short *) = ret;
787 else if (flags & CHARINT)
788 *GETARG(signed char *) = ret;
790 *GETARG(int *) = ret;
791 continue; /* no output */
796 if (flags & INTMAX_SIZE)
804 * ``The argument shall be a pointer to void. The
805 * value of the pointer is converted to a sequence
806 * of printable characters, in an implementation-
810 ujval = (uintmax_t)(uintptr_t)GETARG(void *);
813 flags = flags | INTMAXT;
820 if (flags & LONGINT) {
825 if ((wcp = GETARG(wchar_t *)) == NULL)
828 convbuf = __wcsconv(wcp, prec);
829 if (convbuf == NULL) {
830 fp->_flags |= __SERR;
835 } else if ((cp = GETARG(char *)) == NULL)
837 size = (prec >= 0) ? strnlen(cp, prec) : strlen(cp);
844 if (flags & INTMAX_SIZE)
856 if (flags & INTMAX_SIZE)
861 /* leading 0x/X only if non-zero */
863 (flags & INTMAX_SIZE ? ujval != 0 : ulval != 0))
867 /* unsigned conversions */
870 * ``... diouXx conversions ... if a precision is
871 * specified, the 0 flag will be ignored.''
874 number: if ((dprec = prec) >= 0)
878 * ``The result of converting a zero value with an
879 * explicit precision of zero is no characters.''
882 * ``The C Standard is clear enough as is. The call
883 * printf("%#.0o", 0) should print 0.''
884 * -- Defect Report #151
887 if (flags & INTMAX_SIZE) {
888 if (ujval != 0 || prec != 0 ||
889 (flags & ALT && base == 8))
890 cp = __ujtoa(ujval, cp, base,
893 if (ulval != 0 || prec != 0 ||
894 (flags & ALT && base == 8))
895 cp = __ultoa(ulval, cp, base,
898 size = buf + BUF - cp;
899 if (size > BUF) /* should never happen */
901 if ((flags & GROUPING) && size != 0)
902 size += grouping_init(&gs, size, locale);
904 default: /* "%?" prints ?, unless ? is NUL */
907 /* pretend it was %c with argument ch */
916 * All reasonable formats wind up here. At this point, `cp'
917 * points to a string which (if not flags&LADJUST) should be
918 * padded out to `width' places. If flags&ZEROPAD, it should
919 * first be prefixed by any sign or other prefix; otherwise,
920 * it should be blank padded before the prefix is emitted.
921 * After any left-hand padding and prefixing, emit zeroes
922 * required by a decimal [diouxX] precision, then print the
923 * string proper, then emit zeroes required by any leftover
924 * floating precision; finally, if LADJUST, pad with blanks.
926 * Compute actual size, so we know how much to pad.
927 * size excludes decimal prec; realsz includes it.
929 realsz = dprec > size ? dprec : size;
935 prsize = width > realsz ? width : realsz;
936 if ((unsigned)ret + prsize > INT_MAX) {
941 /* right-adjusting blank padding */
942 if ((flags & (LADJUST|ZEROPAD)) == 0)
943 PAD(width - realsz, blanks);
949 if (ox[1]) { /* ox[1] is either x, X, or \0 */
954 /* right-adjusting zero padding */
955 if ((flags & (LADJUST|ZEROPAD)) == ZEROPAD)
956 PAD(width - realsz, zeroes);
958 /* the string or number proper */
959 #ifndef NO_FLOATING_POINT
960 if ((flags & FPT) == 0) {
962 /* leading zeroes from decimal precision */
963 PAD(dprec - size, zeroes);
965 if (grouping_print(&gs, &io, cp, buf+BUF, locale) < 0)
970 #ifndef NO_FLOATING_POINT
971 } else { /* glue together f_p fragments */
972 if (!expchar) { /* %[fF] or sufficiently short %[gG] */
975 if (prec || flags & ALT)
976 PRINT(decimal_point,decpt_len);
978 /* already handled initial 0's */
982 n = grouping_print(&gs, &io,
983 cp, dtoaend, locale);
988 PRINTANDPAD(cp, dtoaend,
992 if (prec || flags & ALT)
993 PRINT(decimal_point,decpt_len);
995 PRINTANDPAD(cp, dtoaend, prec, zeroes);
996 } else { /* %[eE] or sufficiently long %[gG] */
997 if (prec > 1 || flags & ALT) {
999 PRINT(decimal_point, decpt_len);
1001 PAD(prec - ndig, zeroes);
1004 PRINT(expstr, expsize);
1008 /* left-adjusting padding (always blank) */
1009 if (flags & LADJUST)
1010 PAD(width - realsz, blanks);
1012 /* finally, adjust ret */
1015 FLUSH(); /* copy out the I/O vectors */
1021 #ifndef NO_FLOATING_POINT
1022 if (dtoaresult != NULL)
1023 freedtoa(dtoaresult);
1025 if (convbuf != NULL)
1029 if ((argtable != NULL) && (argtable != statargtable))