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 * 4. 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
33 #if defined(LIBC_SCCS) && !defined(lint)
34 static char sccsid[] = "@(#)vfprintf.c 8.1 (Berkeley) 6/4/93";
35 #endif /* LIBC_SCCS and not lint */
36 #include <sys/cdefs.h>
37 __FBSDID("$FreeBSD$");
40 * Actual printf innards.
42 * This code is large and complicated...
45 #include "namespace.h"
46 #include <sys/types.h>
60 #include "un-namespace.h"
62 #include "libc_private.h"
65 #include "printflocal.h"
67 static int __sprint(FILE *, struct __suio *);
68 static int __sbprintf(FILE *, const char *, va_list) __printflike(2, 0)
70 static char *__wcsconv(wchar_t *, int);
73 #include "printfcommon.h"
75 struct grouping_state {
76 char *thousands_sep; /* locale-specific thousands separator */
77 int thousep_len; /* length of thousands_sep */
78 const char *grouping; /* locale-specific numeric grouping rules */
79 int lead; /* sig figs before decimal or group sep */
80 int nseps; /* number of group separators with ' */
81 int nrepeats; /* number of repeats of the last group */
85 * Initialize the thousands' grouping state in preparation to print a
86 * number with ndigits digits. This routine returns the total number
87 * of bytes that will be needed.
90 grouping_init(struct grouping_state *gs, int ndigits)
94 locale = localeconv();
95 gs->grouping = locale->grouping;
96 gs->thousands_sep = locale->thousands_sep;
97 gs->thousep_len = strlen(gs->thousands_sep);
99 gs->nseps = gs->nrepeats = 0;
101 while (*gs->grouping != CHAR_MAX) {
102 if (gs->lead <= *gs->grouping)
104 gs->lead -= *gs->grouping;
105 if (*(gs->grouping+1)) {
111 return ((gs->nseps + gs->nrepeats) * gs->thousep_len);
115 * Print a number with thousands' separators.
118 grouping_print(struct grouping_state *gs, struct io_state *iop,
119 const CHAR *cp, const CHAR *ep)
121 const CHAR *cp0 = cp;
123 if (io_printandpad(iop, cp, ep, gs->lead, zeroes))
126 while (gs->nseps > 0 || gs->nrepeats > 0) {
127 if (gs->nrepeats > 0)
133 if (io_print(iop, gs->thousands_sep, gs->thousep_len))
135 if (io_printandpad(iop, cp, ep, *gs->grouping, zeroes))
145 * Flush out all the vectors defined by the given uio,
146 * then reset it so that it can be reused.
149 __sprint(FILE *fp, struct __suio *uio)
153 if (uio->uio_resid == 0) {
157 err = __sfvwrite(fp, uio);
164 * Helper function for `fprintf to unbuffered unix file': creates a
165 * temporary buffer. We only work on write-only files; this avoids
166 * worries about ungetc buffers and so forth.
169 __sbprintf(FILE *fp, const char *fmt, va_list ap)
172 FILE fake = FAKE_FILE;
173 unsigned char buf[BUFSIZ];
175 /* XXX This is probably not needed. */
176 if (prepwrite(fp) != 0)
179 /* copy the important variables */
180 fake._flags = fp->_flags & ~__SNBF;
181 fake._file = fp->_file;
182 fake._cookie = fp->_cookie;
183 fake._write = fp->_write;
184 fake._orientation = fp->_orientation;
185 fake._mbstate = fp->_mbstate;
187 /* set up the buffer */
188 fake._bf._base = fake._p = buf;
189 fake._bf._size = fake._w = sizeof(buf);
190 fake._lbfsize = 0; /* not actually used, but Just In Case */
192 /* do the work, then copy any error status */
193 ret = __vfprintf(&fake, fmt, ap);
194 if (ret >= 0 && __fflush(&fake))
196 if (fake._flags & __SERR)
197 fp->_flags |= __SERR;
202 * Convert a wide character string argument for the %ls format to a multibyte
203 * string representation. If not -1, prec specifies the maximum number of
204 * bytes to output, and also means that we can't assume that the wide char.
205 * string ends is null-terminated.
208 __wcsconv(wchar_t *wcsarg, int prec)
210 static const mbstate_t initial;
212 char buf[MB_LEN_MAX];
217 /* Allocate space for the maximum number of bytes we could output. */
221 nbytes = wcsrtombs(NULL, (const wchar_t **)&p, 0, &mbs);
222 if (nbytes == (size_t)-1)
226 * Optimisation: if the output precision is small enough,
227 * just allocate enough memory for the maximum instead of
228 * scanning the string.
237 clen = wcrtomb(buf, *p++, &mbs);
238 if (clen == 0 || clen == (size_t)-1 ||
239 nbytes + clen > prec)
245 if ((convbuf = malloc(nbytes + 1)) == NULL)
248 /* Fill the output buffer. */
251 if ((nbytes = wcsrtombs(convbuf, (const wchar_t **)&p,
252 nbytes, &mbs)) == (size_t)-1) {
256 convbuf[nbytes] = '\0';
264 vfprintf(FILE * __restrict fp, const char * __restrict fmt0, va_list ap)
270 /* optimise fprintf(stderr) (and other unbuffered Unix files) */
271 if ((fp->_flags & (__SNBF|__SWR|__SRW)) == (__SNBF|__SWR) &&
273 ret = __sbprintf(fp, fmt0, ap);
275 ret = __vfprintf(fp, fmt0, ap);
281 * The size of the buffer we use as scratch space for integer
282 * conversions, among other things. We need enough space to
283 * write a uintmax_t in octal (plus one byte).
285 #if UINTMAX_MAX <= UINT64_MAX
288 #error "BUF must be large enough to format a uintmax_t"
292 * Non-MT-safe version
295 __vfprintf(FILE *fp, const char *fmt0, va_list ap)
297 char *fmt; /* format string */
298 int ch; /* character from fmt */
299 int n, n2; /* handy integer (short term usage) */
300 char *cp; /* handy char pointer (short term usage) */
301 int flags; /* flags as above */
302 int ret; /* return value accumulator */
303 int width; /* width from format (%8d), or 0 */
304 int prec; /* precision from format; <0 for N/A */
305 char sign; /* sign prefix (' ', '+', '-', or \0) */
306 struct grouping_state gs; /* thousands' grouping info */
308 #ifndef NO_FLOATING_POINT
310 * We can decompose the printed representation of floating
311 * point numbers into several parts, some of which may be empty:
313 * [+|-| ] [0x|0X] MMM . NNN [e|E|p|P] [+|-] ZZ
316 * A: 'sign' holds this value if present; '\0' otherwise
317 * B: ox[1] holds the 'x' or 'X'; '\0' if not hexadecimal
318 * C: cp points to the string MMMNNN. Leading and trailing
319 * zeros are not in the string and must be added.
320 * D: expchar holds this character; '\0' if no exponent, e.g. %f
321 * F: at least two digits for decimal, at least one digit for hex
323 char *decimal_point; /* locale specific decimal point */
324 int decpt_len; /* length of decimal_point */
325 int signflag; /* true if float is negative */
326 union { /* floating point arguments %[aAeEfFgG] */
330 int expt; /* integer value of exponent */
331 char expchar; /* exponent character: [eEpP\0] */
332 char *dtoaend; /* pointer to end of converted digits */
333 int expsize; /* character count for expstr */
334 int ndig; /* actual number of digits returned by dtoa */
335 char expstr[MAXEXPDIG+2]; /* buffer for exponent string: e+ZZZ */
336 char *dtoaresult; /* buffer allocated by dtoa */
338 u_long ulval; /* integer arguments %[diouxX] */
339 uintmax_t ujval; /* %j, %ll, %q, %t, %z integers */
340 int base; /* base for [diouxX] conversion */
341 int dprec; /* a copy of prec if [diouxX], 0 otherwise */
342 int realsz; /* field size expanded by dprec, sign, etc */
343 int size; /* size of converted field or string */
344 int prsize; /* max size of printed field */
345 const char *xdigs; /* digits for %[xX] conversion */
346 struct io_state io; /* I/O buffering state */
347 char buf[BUF]; /* buffer with space for digits of uintmax_t */
348 char ox[2]; /* space for 0x; ox[1] is either x, X, or \0 */
349 union arg *argtable; /* args, built due to positional arg */
350 union arg statargtable [STATIC_ARG_TBL_SIZE];
351 int nextarg; /* 1-based argument index */
352 va_list orgap; /* original argument pointer */
353 char *convbuf; /* wide to multibyte conversion result */
355 static const char xdigs_lower[16] = "0123456789abcdef";
356 static const char xdigs_upper[16] = "0123456789ABCDEF";
358 /* BEWARE, these `goto error' on error. */
359 #define PRINT(ptr, len) { \
360 if (io_print(&io, (ptr), (len))) \
363 #define PAD(howmany, with) { \
364 if (io_pad(&io, (howmany), (with))) \
367 #define PRINTANDPAD(p, ep, len, with) { \
368 if (io_printandpad(&io, (p), (ep), (len), (with))) \
377 * Get the argument indexed by nextarg. If the argument table is
378 * built, use it to get the argument. If its not, get the next
379 * argument (and arguments must be gotten sequentially).
381 #define GETARG(type) \
382 ((argtable != NULL) ? *((type*)(&argtable[nextarg++])) : \
383 (nextarg++, va_arg(ap, type)))
386 * To extend shorts properly, we need both signed and unsigned
387 * argument extraction methods.
390 (flags&LONGINT ? GETARG(long) : \
391 flags&SHORTINT ? (long)(short)GETARG(int) : \
392 flags&CHARINT ? (long)(signed char)GETARG(int) : \
395 (flags&LONGINT ? GETARG(u_long) : \
396 flags&SHORTINT ? (u_long)(u_short)GETARG(int) : \
397 flags&CHARINT ? (u_long)(u_char)GETARG(int) : \
398 (u_long)GETARG(u_int))
399 #define INTMAX_SIZE (INTMAXT|SIZET|PTRDIFFT|LLONGINT)
401 (flags&INTMAXT ? GETARG(intmax_t) : \
402 flags&SIZET ? (intmax_t)GETARG(ssize_t) : \
403 flags&PTRDIFFT ? (intmax_t)GETARG(ptrdiff_t) : \
404 (intmax_t)GETARG(long long))
406 (flags&INTMAXT ? GETARG(uintmax_t) : \
407 flags&SIZET ? (uintmax_t)GETARG(size_t) : \
408 flags&PTRDIFFT ? (uintmax_t)GETARG(ptrdiff_t) : \
409 (uintmax_t)GETARG(unsigned long long))
412 * Get * arguments, including the form *nn$. Preserve the nextarg
413 * that the argument can be gotten once the type is determined.
415 #define GETASTER(val) \
418 while (is_digit(*cp)) { \
419 n2 = 10 * n2 + to_digit(*cp); \
423 int hold = nextarg; \
424 if (argtable == NULL) { \
425 argtable = statargtable; \
426 if (__find_arguments (fmt0, orgap, &argtable)) { \
432 val = GETARG (int); \
436 val = GETARG (int); \
439 if (__use_xprintf == 0 && getenv("USE_XPRINTF"))
441 if (__use_xprintf > 0)
442 return (__xvprintf(fp, fmt0, ap));
444 /* sorry, fprintf(read_only_file, "") returns EOF, not 0 */
445 if (prepwrite(fp) != 0)
455 #ifndef NO_FLOATING_POINT
457 decimal_point = localeconv()->decimal_point;
458 /* The overwhelmingly common case is decpt_len == 1. */
459 decpt_len = (decimal_point[1] == '\0' ? 1 : strlen(decimal_point));
463 * Scan the format for conversions (`%' character).
466 for (cp = fmt; (ch = *fmt) != '\0' && ch != '%'; fmt++)
468 if ((n = fmt - cp) != 0) {
469 if ((unsigned)ret + n > INT_MAX) {
478 fmt++; /* skip over '%' */
489 reswitch: switch (ch) {
492 * ``If the space and + flags both appear, the space
493 * flag will be ignored.''
504 * ``A negative field width argument is taken as a
505 * - flag followed by a positive field width.''
507 * They don't exclude field widths read from args.
524 if ((ch = *fmt++) == '*') {
529 while (is_digit(ch)) {
530 prec = 10 * prec + to_digit(ch);
536 * ``Note that 0 is taken as a flag, not as the
537 * beginning of a field width.''
542 case '1': case '2': case '3': case '4':
543 case '5': case '6': case '7': case '8': case '9':
546 n = 10 * n + to_digit(ch);
548 } while (is_digit(ch));
551 if (argtable == NULL) {
552 argtable = statargtable;
553 if (__find_arguments (fmt0, orgap,
563 #ifndef NO_FLOATING_POINT
569 if (flags & SHORTINT) {
579 if (flags & LONGINT) {
586 flags |= LLONGINT; /* not necessarily */
598 if (flags & LONGINT) {
599 static const mbstate_t initial;
604 mbseqlen = wcrtomb(cp = buf,
605 (wchar_t)GETARG(wint_t), &mbs);
606 if (mbseqlen == (size_t)-1) {
607 fp->_flags |= __SERR;
610 size = (int)mbseqlen;
612 *(cp = buf) = GETARG(int);
622 if (flags & INTMAX_SIZE) {
624 if ((intmax_t)ujval < 0) {
630 if ((long)ulval < 0) {
637 #ifndef NO_FLOATING_POINT
651 if (dtoaresult != NULL)
652 freedtoa(dtoaresult);
653 if (flags & LONGDBL) {
654 fparg.ldbl = GETARG(long double);
656 __hldtoa(fparg.ldbl, xdigs, prec,
657 &expt, &signflag, &dtoaend);
659 fparg.dbl = GETARG(double);
661 __hdtoa(fparg.dbl, xdigs, prec,
662 &expt, &signflag, &dtoaend);
672 if (prec < 0) /* account for digit before decpt */
683 expchar = ch - ('g' - 'e');
689 if (dtoaresult != NULL)
690 freedtoa(dtoaresult);
691 if (flags & LONGDBL) {
692 fparg.ldbl = GETARG(long double);
694 __ldtoa(&fparg.ldbl, expchar ? 2 : 3, prec,
695 &expt, &signflag, &dtoaend);
697 fparg.dbl = GETARG(double);
699 dtoa(fparg.dbl, expchar ? 2 : 3, prec,
700 &expt, &signflag, &dtoaend);
707 if (expt == INT_MAX) { /* inf or nan */
709 cp = (ch >= 'a') ? "nan" : "NAN";
712 cp = (ch >= 'a') ? "inf" : "INF";
719 if (ch == 'g' || ch == 'G') {
720 if (expt > -4 && expt <= prec) {
721 /* Make %[gG] smell like %[fF] */
731 * Make %[gG] smell like %[eE], but
732 * trim trailing zeroes if no # flag.
739 expsize = exponent(expstr, expt - 1, expchar);
740 size = expsize + prec;
741 if (prec > 1 || flags & ALT)
744 /* space for digits before decimal point */
749 /* space for decimal pt and following digits */
750 if (prec || flags & ALT)
751 size += prec + decpt_len;
752 if ((flags & GROUPING) && expt > 0)
753 size += grouping_init(&gs, expt);
756 #endif /* !NO_FLOATING_POINT */
759 * Assignment-like behavior is specified if the
760 * value overflows or is otherwise unrepresentable.
761 * C99 says to use `signed char' for %hhn conversions.
763 if (flags & LLONGINT)
764 *GETARG(long long *) = ret;
765 else if (flags & SIZET)
766 *GETARG(ssize_t *) = (ssize_t)ret;
767 else if (flags & PTRDIFFT)
768 *GETARG(ptrdiff_t *) = ret;
769 else if (flags & INTMAXT)
770 *GETARG(intmax_t *) = ret;
771 else if (flags & LONGINT)
772 *GETARG(long *) = ret;
773 else if (flags & SHORTINT)
774 *GETARG(short *) = ret;
775 else if (flags & CHARINT)
776 *GETARG(signed char *) = ret;
778 *GETARG(int *) = ret;
779 continue; /* no output */
784 if (flags & INTMAX_SIZE)
792 * ``The argument shall be a pointer to void. The
793 * value of the pointer is converted to a sequence
794 * of printable characters, in an implementation-
798 ujval = (uintmax_t)(uintptr_t)GETARG(void *);
801 flags = flags | INTMAXT;
808 if (flags & LONGINT) {
813 if ((wcp = GETARG(wchar_t *)) == NULL)
816 convbuf = __wcsconv(wcp, prec);
817 if (convbuf == NULL) {
818 fp->_flags |= __SERR;
823 } else if ((cp = GETARG(char *)) == NULL)
825 size = (prec >= 0) ? strnlen(cp, prec) : strlen(cp);
832 if (flags & INTMAX_SIZE)
844 if (flags & INTMAX_SIZE)
849 /* leading 0x/X only if non-zero */
851 (flags & INTMAX_SIZE ? ujval != 0 : ulval != 0))
855 /* unsigned conversions */
858 * ``... diouXx conversions ... if a precision is
859 * specified, the 0 flag will be ignored.''
862 number: if ((dprec = prec) >= 0)
866 * ``The result of converting a zero value with an
867 * explicit precision of zero is no characters.''
870 * ``The C Standard is clear enough as is. The call
871 * printf("%#.0o", 0) should print 0.''
872 * -- Defect Report #151
875 if (flags & INTMAX_SIZE) {
876 if (ujval != 0 || prec != 0 ||
877 (flags & ALT && base == 8))
878 cp = __ujtoa(ujval, cp, base,
881 if (ulval != 0 || prec != 0 ||
882 (flags & ALT && base == 8))
883 cp = __ultoa(ulval, cp, base,
886 size = buf + BUF - cp;
887 if (size > BUF) /* should never happen */
889 if ((flags & GROUPING) && size != 0)
890 size += grouping_init(&gs, size);
892 default: /* "%?" prints ?, unless ? is NUL */
895 /* pretend it was %c with argument ch */
904 * All reasonable formats wind up here. At this point, `cp'
905 * points to a string which (if not flags&LADJUST) should be
906 * padded out to `width' places. If flags&ZEROPAD, it should
907 * first be prefixed by any sign or other prefix; otherwise,
908 * it should be blank padded before the prefix is emitted.
909 * After any left-hand padding and prefixing, emit zeroes
910 * required by a decimal [diouxX] precision, then print the
911 * string proper, then emit zeroes required by any leftover
912 * floating precision; finally, if LADJUST, pad with blanks.
914 * Compute actual size, so we know how much to pad.
915 * size excludes decimal prec; realsz includes it.
917 realsz = dprec > size ? dprec : size;
923 prsize = width > realsz ? width : realsz;
924 if ((unsigned)ret + prsize > INT_MAX) {
929 /* right-adjusting blank padding */
930 if ((flags & (LADJUST|ZEROPAD)) == 0)
931 PAD(width - realsz, blanks);
937 if (ox[1]) { /* ox[1] is either x, X, or \0 */
942 /* right-adjusting zero padding */
943 if ((flags & (LADJUST|ZEROPAD)) == ZEROPAD)
944 PAD(width - realsz, zeroes);
946 /* the string or number proper */
947 #ifndef NO_FLOATING_POINT
948 if ((flags & FPT) == 0) {
950 /* leading zeroes from decimal precision */
951 PAD(dprec - size, zeroes);
953 if (grouping_print(&gs, &io, cp, buf+BUF) < 0)
958 #ifndef NO_FLOATING_POINT
959 } else { /* glue together f_p fragments */
960 if (!expchar) { /* %[fF] or sufficiently short %[gG] */
963 if (prec || flags & ALT)
964 PRINT(decimal_point,decpt_len);
966 /* already handled initial 0's */
970 n = grouping_print(&gs, &io,
976 PRINTANDPAD(cp, dtoaend,
980 if (prec || flags & ALT)
981 PRINT(decimal_point,decpt_len);
983 PRINTANDPAD(cp, dtoaend, prec, zeroes);
984 } else { /* %[eE] or sufficiently long %[gG] */
985 if (prec > 1 || flags & ALT) {
987 PRINT(decimal_point, decpt_len);
989 PAD(prec - ndig, zeroes);
992 PRINT(expstr, expsize);
996 /* left-adjusting padding (always blank) */
998 PAD(width - realsz, blanks);
1000 /* finally, adjust ret */
1003 FLUSH(); /* copy out the I/O vectors */
1009 #ifndef NO_FLOATING_POINT
1010 if (dtoaresult != NULL)
1011 freedtoa(dtoaresult);
1013 if (convbuf != NULL)
1017 if ((argtable != NULL) && (argtable != statargtable))