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/vfprintf.c 249808 2013-04-23 13:33:13Z emaste $
42 * Actual printf innards.
44 * This code is large and complicated...
47 #include "namespace.h"
48 #include <sys/types.h>
63 #include "xlocale_private.h"
64 #include "un-namespace.h"
66 #include "libc_private.h"
68 #include "printflocal.h"
70 static int __sprint(FILE *, struct __suio *, locale_t);
71 static int __sbprintf(FILE *, locale_t, const char *, va_list) __printflike(3, 0)
73 static char *__wcsconv(wchar_t *, int);
76 #include "printfcommon.h"
78 struct grouping_state {
79 char *thousands_sep; /* locale-specific thousands separator */
80 int thousep_len; /* length of thousands_sep */
81 const char *grouping; /* locale-specific numeric grouping rules */
82 int lead; /* sig figs before decimal or group sep */
83 int nseps; /* number of group separators with ' */
84 int nrepeats; /* number of repeats of the last group */
88 * Initialize the thousands' grouping state in preparation to print a
89 * number with ndigits digits. This routine returns the total number
90 * of bytes that will be needed.
93 grouping_init(struct grouping_state *gs, int ndigits, locale_t loc)
97 locale = localeconv_l(loc);
98 gs->grouping = locale->grouping;
99 gs->thousands_sep = locale->thousands_sep;
100 gs->thousep_len = strlen(gs->thousands_sep);
102 gs->nseps = gs->nrepeats = 0;
104 while (*gs->grouping != CHAR_MAX) {
105 if (gs->lead <= *gs->grouping)
107 gs->lead -= *gs->grouping;
108 if (*(gs->grouping+1)) {
114 return ((gs->nseps + gs->nrepeats) * gs->thousep_len);
118 * Print a number with thousands' separators.
121 grouping_print(struct grouping_state *gs, struct io_state *iop,
122 const CHAR *cp, const CHAR *ep, locale_t locale)
124 const CHAR *cp0 = cp;
126 if (io_printandpad(iop, cp, ep, gs->lead, zeroes, locale))
129 while (gs->nseps > 0 || gs->nrepeats > 0) {
130 if (gs->nrepeats > 0)
136 if (io_print(iop, gs->thousands_sep, gs->thousep_len, locale))
138 if (io_printandpad(iop, cp, ep, *gs->grouping, zeroes, locale))
148 * Flush out all the vectors defined by the given uio,
149 * then reset it so that it can be reused.
152 __sprint(FILE *fp, struct __suio *uio, locale_t locale)
156 if (uio->uio_resid == 0) {
160 err = __sfvwrite(fp, uio);
167 * Helper function for `fprintf to unbuffered unix file': creates a
168 * temporary buffer. We only work on write-only files; this avoids
169 * worries about ungetc buffers and so forth.
172 __sbprintf(FILE *fp, locale_t locale, const char *fmt, va_list ap)
175 FILE fake = FAKE_FILE;
176 unsigned char buf[BUFSIZ];
178 /* XXX This is probably not needed. */
179 if (prepwrite(fp) != 0)
182 /* copy the important variables */
183 fake.pub._flags = fp->pub._flags & ~__SNBF;
184 fake.pub._fileno = fp->pub._fileno;
185 fake._cookie = fp->_cookie;
186 fake._write = fp->_write;
188 /* set up the buffer */
189 fake._bf._base = fake.pub._p = buf;
190 fake._bf._size = fake.pub._w = sizeof(buf);
191 fake.pub._lbfsize = 0; /* not actually used, but Just In Case */
193 /* do the work, then copy any error status */
194 ret = __vfprintf(&fake, locale, fmt, ap);
195 if (ret >= 0 && __fflush(&fake))
197 if (fake.pub._flags & __SERR)
198 fp->pub._flags |= __SERR;
203 * Convert a wide character string argument for the %ls format to a multibyte
204 * string representation. If not -1, prec specifies the maximum number of
205 * bytes to output, and also means that we can't assume that the wide char.
206 * string ends is null-terminated.
209 __wcsconv(wchar_t *wcsarg, int prec)
211 static const mbstate_t initial;
213 char buf[MB_LEN_MAX];
218 /* Allocate space for the maximum number of bytes we could output. */
222 nbytes = wcsrtombs(NULL, (const wchar_t **)&p, 0, &mbs);
223 if (nbytes == (size_t)-1)
227 * Optimisation: if the output precision is small enough,
228 * just allocate enough memory for the maximum instead of
229 * scanning the string.
238 clen = wcrtomb(buf, *p++, &mbs);
239 if (clen == 0 || clen == (size_t)-1 ||
240 nbytes + clen > prec)
246 if ((convbuf = malloc(nbytes + 1)) == NULL)
249 /* Fill the output buffer. */
252 if ((nbytes = wcsrtombs(convbuf, (const wchar_t **)&p,
253 nbytes, &mbs)) == (size_t)-1) {
257 convbuf[nbytes] = '\0';
265 vfprintf_l(FILE * __restrict fp, locale_t locale, const char * __restrict fmt0,
272 /* optimise fprintf(stderr) (and other unbuffered Unix files) */
273 if ((fp->pub._flags & (__SNBF|__SWR|__SRW)) == (__SNBF|__SWR) &&
274 fp->pub._fileno >= 0)
275 ret = __sbprintf(fp, locale, fmt0, ap);
277 ret = __vfprintf(fp, locale, fmt0, ap);
282 vfprintf(FILE * __restrict fp, const char * __restrict fmt0, va_list ap)
284 return vfprintf_l(fp, __get_locale(), fmt0, ap);
288 * The size of the buffer we use as scratch space for integer
289 * conversions, among other things. We need enough space to
290 * write a uintmax_t in octal (plus one byte).
292 #if UINTMAX_MAX <= UINT64_MAX
295 #error "BUF must be large enough to format a uintmax_t"
299 * Non-MT-safe version
302 __vfprintf(FILE *fp, locale_t locale, const char *fmt0, va_list ap)
304 char *fmt; /* format string */
305 int ch; /* character from fmt */
306 int n, n2; /* handy integer (short term usage) */
307 char *cp; /* handy char pointer (short term usage) */
308 int flags; /* flags as above */
309 int ret; /* return value accumulator */
310 int width; /* width from format (%8d), or 0 */
311 int prec; /* precision from format; <0 for N/A */
312 char sign; /* sign prefix (' ', '+', '-', or \0) */
313 struct grouping_state gs; /* thousands' grouping info */
315 #ifndef NO_FLOATING_POINT
317 * We can decompose the printed representation of floating
318 * point numbers into several parts, some of which may be empty:
320 * [+|-| ] [0x|0X] MMM . NNN [e|E|p|P] [+|-] ZZ
323 * A: 'sign' holds this value if present; '\0' otherwise
324 * B: ox[1] holds the 'x' or 'X'; '\0' if not hexadecimal
325 * C: cp points to the string MMMNNN. Leading and trailing
326 * zeros are not in the string and must be added.
327 * D: expchar holds this character; '\0' if no exponent, e.g. %f
328 * F: at least two digits for decimal, at least one digit for hex
330 char *decimal_point; /* locale specific decimal point */
331 int decpt_len; /* length of decimal_point */
332 int signflag; /* true if float is negative */
333 union { /* floating point arguments %[aAeEfFgG] */
337 int expt; /* integer value of exponent */
338 char expchar; /* exponent character: [eEpP\0] */
339 char *dtoaend; /* pointer to end of converted digits */
340 int expsize; /* character count for expstr */
341 int ndig; /* actual number of digits returned by dtoa */
342 char expstr[MAXEXPDIG+2]; /* buffer for exponent string: e+ZZZ */
343 char *dtoaresult; /* buffer allocated by dtoa */
345 u_long ulval; /* integer arguments %[diouxX] */
346 uintmax_t ujval; /* %j, %ll, %q, %t, %z integers */
347 int base; /* base for [diouxX] conversion */
348 int dprec; /* a copy of prec if [diouxX], 0 otherwise */
349 int realsz; /* field size expanded by dprec, sign, etc */
350 int size; /* size of converted field or string */
351 int prsize; /* max size of printed field */
352 const char *xdigs; /* digits for %[xX] conversion */
353 struct io_state io; /* I/O buffering state */
354 char buf[BUF]; /* buffer with space for digits of uintmax_t */
355 char ox[2]; /* space for 0x; ox[1] is either x, X, or \0 */
356 union arg *argtable; /* args, built due to positional arg */
357 union arg statargtable [STATIC_ARG_TBL_SIZE];
358 int nextarg; /* 1-based argument index */
359 va_list orgap; /* original argument pointer */
360 char *convbuf; /* wide to multibyte conversion result */
362 static const char xdigs_lower[16] = "0123456789abcdef";
363 static const char xdigs_upper[16] = "0123456789ABCDEF";
365 /* BEWARE, these `goto error' on error. */
366 #define PRINT(ptr, len) { \
367 if (io_print(&io, (ptr), (len), locale)) \
370 #define PAD(howmany, with) { \
371 if (io_pad(&io, (howmany), (with), locale)) \
374 #define PRINTANDPAD(p, ep, len, with) { \
375 if (io_printandpad(&io, (p), (ep), (len), (with), locale)) \
379 if (io_flush(&io, locale)) \
384 * Get the argument indexed by nextarg. If the argument table is
385 * built, use it to get the argument. If its not, get the next
386 * argument (and arguments must be gotten sequentially).
388 #define GETARG(type) \
389 ((argtable != NULL) ? *((type*)(&argtable[nextarg++])) : \
390 (nextarg++, va_arg(ap, type)))
393 * To extend shorts properly, we need both signed and unsigned
394 * argument extraction methods.
397 (flags&LONGINT ? GETARG(long) : \
398 flags&SHORTINT ? (long)(short)GETARG(int) : \
399 flags&CHARINT ? (long)(signed char)GETARG(int) : \
402 (flags&LONGINT ? GETARG(u_long) : \
403 flags&SHORTINT ? (u_long)(u_short)GETARG(int) : \
404 flags&CHARINT ? (u_long)(u_char)GETARG(int) : \
405 (u_long)GETARG(u_int))
406 #define INTMAX_SIZE (INTMAXT|SIZET|PTRDIFFT|LLONGINT)
408 (flags&INTMAXT ? GETARG(intmax_t) : \
409 flags&SIZET ? (intmax_t)GETARG(ssize_t) : \
410 flags&PTRDIFFT ? (intmax_t)GETARG(ptrdiff_t) : \
411 (intmax_t)GETARG(long long))
413 (flags&INTMAXT ? GETARG(uintmax_t) : \
414 flags&SIZET ? (uintmax_t)GETARG(size_t) : \
415 flags&PTRDIFFT ? (uintmax_t)GETARG(ptrdiff_t) : \
416 (uintmax_t)GETARG(unsigned long long))
419 * Get * arguments, including the form *nn$. Preserve the nextarg
420 * that the argument can be gotten once the type is determined.
422 #define GETASTER(val) \
425 while (is_digit(*cp)) { \
426 n2 = 10 * n2 + to_digit(*cp); \
430 int hold = nextarg; \
431 if (argtable == NULL) { \
432 argtable = statargtable; \
433 if (__find_arguments (fmt0, orgap, &argtable)) { \
439 val = GETARG (int); \
443 val = GETARG (int); \
446 if (__use_xprintf == 0 && getenv("USE_XPRINTF"))
448 if (__use_xprintf > 0)
449 return (__xvprintf(fp, fmt0, ap));
451 /* sorry, fprintf(read_only_file, "") returns EOF, not 0 */
452 if (prepwrite(fp) != 0)
462 #ifndef NO_FLOATING_POINT
464 decimal_point = localeconv_l(locale)->decimal_point;
465 /* The overwhelmingly common case is decpt_len == 1. */
466 decpt_len = (decimal_point[1] == '\0' ? 1 : strlen(decimal_point));
470 * Scan the format for conversions (`%' character).
473 for (cp = fmt; (ch = *fmt) != '\0' && ch != '%'; fmt++)
475 if ((n = fmt - cp) != 0) {
476 if ((unsigned)ret + n > INT_MAX) {
486 fmt++; /* skip over '%' */
497 reswitch: switch (ch) {
500 * ``If the space and + flags both appear, the space
501 * flag will be ignored.''
512 * ``A negative field width argument is taken as a
513 * - flag followed by a positive field width.''
515 * They don't exclude field widths read from args.
532 if ((ch = *fmt++) == '*') {
537 while (is_digit(ch)) {
538 prec = 10 * prec + to_digit(ch);
544 * ``Note that 0 is taken as a flag, not as the
545 * beginning of a field width.''
550 case '1': case '2': case '3': case '4':
551 case '5': case '6': case '7': case '8': case '9':
554 n = 10 * n + to_digit(ch);
556 } while (is_digit(ch));
559 if (argtable == NULL) {
560 argtable = statargtable;
561 if (__find_arguments (fmt0, orgap,
571 #ifndef NO_FLOATING_POINT
577 if (flags & SHORTINT) {
587 if (flags & LONGINT) {
594 flags |= LLONGINT; /* not necessarily */
606 if (flags & LONGINT) {
607 static const mbstate_t initial;
612 mbseqlen = wcrtomb(cp = buf,
613 (wchar_t)GETARG(wint_t), &mbs);
614 if (mbseqlen == (size_t)-1) {
615 fp->pub._flags |= __SERR;
618 size = (int)mbseqlen;
620 *(cp = buf) = GETARG(int);
630 if (flags & INTMAX_SIZE) {
632 if ((intmax_t)ujval < 0) {
638 if ((long)ulval < 0) {
645 #ifndef NO_FLOATING_POINT
659 if (dtoaresult != NULL)
660 freedtoa(dtoaresult);
661 if (flags & LONGDBL) {
662 fparg.ldbl = GETARG(long double);
664 __hldtoa(fparg.ldbl, xdigs, prec,
665 &expt, &signflag, &dtoaend);
667 fparg.dbl = GETARG(double);
669 __hdtoa(fparg.dbl, xdigs, prec,
670 &expt, &signflag, &dtoaend);
680 if (prec < 0) /* account for digit before decpt */
691 expchar = ch - ('g' - 'e');
697 if (dtoaresult != NULL)
698 freedtoa(dtoaresult);
699 if (flags & LONGDBL) {
700 fparg.ldbl = GETARG(long double);
702 __ldtoa(&fparg.ldbl, expchar ? 2 : 3, prec,
703 &expt, &signflag, &dtoaend);
705 fparg.dbl = GETARG(double);
707 dtoa(fparg.dbl, expchar ? 2 : 3, prec,
708 &expt, &signflag, &dtoaend);
715 if (expt == INT_MAX) { /* inf or nan */
717 cp = (ch >= 'a') ? "nan" : "NAN";
720 cp = (ch >= 'a') ? "inf" : "INF";
727 if (ch == 'g' || ch == 'G') {
728 if (expt > -4 && expt <= prec) {
729 /* Make %[gG] smell like %[fF] */
739 * Make %[gG] smell like %[eE], but
740 * trim trailing zeroes if no # flag.
747 expsize = exponent(expstr, expt - 1, expchar);
748 size = expsize + prec;
749 if (prec > 1 || flags & ALT)
752 /* space for digits before decimal point */
757 /* space for decimal pt and following digits */
758 if (prec || flags & ALT)
759 size += prec + decpt_len;
760 if ((flags & GROUPING) && expt > 0)
761 size += grouping_init(&gs, expt, locale);
764 #endif /* !NO_FLOATING_POINT */
767 * Assignment-like behavior is specified if the
768 * value overflows or is otherwise unrepresentable.
769 * C99 says to use `signed char' for %hhn conversions.
771 if (flags & LLONGINT)
772 *GETARG(long long *) = ret;
773 else if (flags & SIZET)
774 *GETARG(ssize_t *) = (ssize_t)ret;
775 else if (flags & PTRDIFFT)
776 *GETARG(ptrdiff_t *) = ret;
777 else if (flags & INTMAXT)
778 *GETARG(intmax_t *) = ret;
779 else if (flags & LONGINT)
780 *GETARG(long *) = ret;
781 else if (flags & SHORTINT)
782 *GETARG(short *) = ret;
783 else if (flags & CHARINT)
784 *GETARG(signed char *) = ret;
786 *GETARG(int *) = ret;
787 continue; /* no output */
792 if (flags & INTMAX_SIZE)
800 * ``The argument shall be a pointer to void. The
801 * value of the pointer is converted to a sequence
802 * of printable characters, in an implementation-
806 ujval = (uintmax_t)(uintptr_t)GETARG(void *);
809 flags = flags | INTMAXT;
816 if (flags & LONGINT) {
821 if ((wcp = GETARG(wchar_t *)) == NULL)
824 convbuf = __wcsconv(wcp, prec);
825 if (convbuf == NULL) {
826 fp->pub._flags |= __SERR;
831 } else if ((cp = GETARG(char *)) == NULL)
833 size = (prec >= 0) ? strnlen(cp, prec) : strlen(cp);
840 if (flags & INTMAX_SIZE)
852 if (flags & INTMAX_SIZE)
857 /* leading 0x/X only if non-zero */
859 (flags & INTMAX_SIZE ? ujval != 0 : ulval != 0))
863 /* unsigned conversions */
866 * ``... diouXx conversions ... if a precision is
867 * specified, the 0 flag will be ignored.''
870 number: if ((dprec = prec) >= 0)
874 * ``The result of converting a zero value with an
875 * explicit precision of zero is no characters.''
878 * ``The C Standard is clear enough as is. The call
879 * printf("%#.0o", 0) should print 0.''
880 * -- Defect Report #151
883 if (flags & INTMAX_SIZE) {
884 if (ujval != 0 || prec != 0 ||
885 (flags & ALT && base == 8))
886 cp = __ujtoa(ujval, cp, base,
889 if (ulval != 0 || prec != 0 ||
890 (flags & ALT && base == 8))
891 cp = __ultoa(ulval, cp, base,
894 size = buf + BUF - cp;
895 if (size > BUF) /* should never happen */
897 if ((flags & GROUPING) && size != 0)
898 size += grouping_init(&gs, size, locale);
900 default: /* "%?" prints ?, unless ? is NUL */
903 /* pretend it was %c with argument ch */
912 * All reasonable formats wind up here. At this point, `cp'
913 * points to a string which (if not flags&LADJUST) should be
914 * padded out to `width' places. If flags&ZEROPAD, it should
915 * first be prefixed by any sign or other prefix; otherwise,
916 * it should be blank padded before the prefix is emitted.
917 * After any left-hand padding and prefixing, emit zeroes
918 * required by a decimal [diouxX] precision, then print the
919 * string proper, then emit zeroes required by any leftover
920 * floating precision; finally, if LADJUST, pad with blanks.
922 * Compute actual size, so we know how much to pad.
923 * size excludes decimal prec; realsz includes it.
925 realsz = dprec > size ? dprec : size;
931 prsize = width > realsz ? width : realsz;
932 if ((unsigned)ret + prsize > INT_MAX) {
938 /* right-adjusting blank padding */
939 if ((flags & (LADJUST|ZEROPAD)) == 0)
940 PAD(width - realsz, blanks);
946 if (ox[1]) { /* ox[1] is either x, X, or \0 */
951 /* right-adjusting zero padding */
952 if ((flags & (LADJUST|ZEROPAD)) == ZEROPAD)
953 PAD(width - realsz, zeroes);
955 /* the string or number proper */
956 #ifndef NO_FLOATING_POINT
957 if ((flags & FPT) == 0) {
959 /* leading zeroes from decimal precision */
960 PAD(dprec - size, zeroes);
962 if (grouping_print(&gs, &io, cp, buf+BUF, locale) < 0)
967 #ifndef NO_FLOATING_POINT
968 } else { /* glue together f_p fragments */
969 if (!expchar) { /* %[fF] or sufficiently short %[gG] */
972 if (prec || flags & ALT)
973 PRINT(decimal_point,decpt_len);
975 /* already handled initial 0's */
979 n = grouping_print(&gs, &io,
980 cp, dtoaend, locale);
985 PRINTANDPAD(cp, dtoaend,
989 if (prec || flags & ALT)
990 PRINT(decimal_point,decpt_len);
992 PRINTANDPAD(cp, dtoaend, prec, zeroes);
993 } else { /* %[eE] or sufficiently long %[gG] */
994 if (prec > 1 || flags & ALT) {
996 PRINT(decimal_point, decpt_len);
998 PAD(prec - ndig, zeroes);
1001 PRINT(expstr, expsize);
1005 /* left-adjusting padding (always blank) */
1006 if (flags & LADJUST)
1007 PAD(width - realsz, blanks);
1009 /* finally, adjust ret */
1012 FLUSH(); /* copy out the I/O vectors */
1018 #ifndef NO_FLOATING_POINT
1019 if (dtoaresult != NULL)
1020 freedtoa(dtoaresult);
1022 if (convbuf != NULL)
1026 if ((argtable != NULL) && (argtable != statargtable))