1 /* $Id: snprintf.c,v 1.9 2008/01/20 14:02:00 holger Exp $ */
4 * Copyright (c) 1995 Patrick Powell.
6 * This code is based on code written by Patrick Powell <papowell@astart.com>.
7 * It may be used for any purpose as long as this notice remains intact on all
8 * source code distributions.
12 * Copyright (c) 2008 Holger Weiss.
14 * This version of the code is maintained by Holger Weiss <holger@jhweiss.de>.
15 * My changes to the code may freely be used, modified and/or redistributed for
16 * any purpose. It would be nice if additions and fixes to this file (including
17 * trivial code cleanups) would be sent back in order to let me include them in
18 * the version available at <http://www.jhweiss.de/software/snprintf.html>.
19 * However, this is not a requirement for using or redistributing (possibly
20 * modified) versions of this file, nor is leaving this notice intact mandatory.
26 * 2008-01-20 Holger Weiss <holger@jhweiss.de> for C99-snprintf 1.1:
28 * Fixed the detection of infinite floating point values on IRIX (and
29 * possibly other systems) and applied another few minor cleanups.
31 * 2008-01-06 Holger Weiss <holger@jhweiss.de> for C99-snprintf 1.0:
33 * Added a lot of new features, fixed many bugs, and incorporated various
34 * improvements done by Andrew Tridgell <tridge@samba.org>, Russ Allbery
35 * <rra@stanford.edu>, Hrvoje Niksic <hniksic@xemacs.org>, Damien Miller
36 * <djm@mindrot.org>, and others for the Samba, INN, Wget, and OpenSSH
37 * projects. The additions include: support the "e", "E", "g", "G", and
38 * "F" conversion specifiers (and use conversion style "f" or "F" for the
39 * still unsupported "a" and "A" specifiers); support the "hh", "ll", "j",
40 * "t", and "z" length modifiers; support the "#" flag and the (non-C99)
41 * "'" flag; use localeconv(3) (if available) to get both the current
42 * locale's decimal point character and the separator between groups of
43 * digits; fix the handling of various corner cases of field width and
44 * precision specifications; fix various floating point conversion bugs;
45 * handle infinite and NaN floating point values; don't attempt to write to
46 * the output buffer (which may be NULL) if a size of zero was specified;
47 * check for integer overflow of the field width, precision, and return
48 * values and during the floating point conversion; use the OUTCHAR() macro
49 * instead of a function for better performance; provide asprintf(3) and
50 * vasprintf(3) functions; add new test cases. The replacement functions
51 * have been renamed to use an "rpl_" prefix, the function calls in the
52 * main project (and in this file) must be redefined accordingly for each
53 * replacement function which is needed (by using Autoconf or other means).
54 * Various other minor improvements have been applied and the coding style
55 * was cleaned up for consistency.
57 * 2007-07-23 Holger Weiss <holger@jhweiss.de> for Mutt 1.5.13:
59 * C99 compliant snprintf(3) and vsnprintf(3) functions return the number
60 * of characters that would have been written to a sufficiently sized
61 * buffer (excluding the '\0'). The original code simply returned the
62 * length of the resulting output string, so that's been fixed.
64 * 1998-03-05 Michael Elkins <me@mutt.org> for Mutt 0.90.8:
66 * The original code assumed that both snprintf(3) and vsnprintf(3) were
67 * missing. Some systems only have snprintf(3) but not vsnprintf(3), so
68 * the code is now broken down under HAVE_SNPRINTF and HAVE_VSNPRINTF.
70 * 1998-01-27 Thomas Roessler <roessler@does-not-exist.org> for Mutt 0.89i:
72 * The PGP code was using unsigned hexadecimal formats. Unfortunately,
73 * unsigned formats simply didn't work.
75 * 1997-10-22 Brandon Long <blong@fiction.net> for Mutt 0.87.1:
77 * Ok, added some minimal floating point support, which means this probably
78 * requires libm on most operating systems. Don't yet support the exponent
79 * (e,E) and sigfig (g,G). Also, fmtint() was pretty badly broken, it just
80 * wasn't being exercised in ways which showed it, so that's been fixed.
81 * Also, formatted the code to Mutt conventions, and removed dead code left
82 * over from the original. Also, there is now a builtin-test, run with:
83 * gcc -DTEST_SNPRINTF -o snprintf snprintf.c -lm && ./snprintf
85 * 2996-09-15 Brandon Long <blong@fiction.net> for Mutt 0.43:
87 * This was ugly. It is still ugly. I opted out of floating point
88 * numbers, but the formatter understands just about everything from the
89 * normal C string format, at least as far as I can tell from the Solaris
90 * 2.5 printf(3S) man page.
96 * - Add wide character support.
97 * - Add support for "%a" and "%A" conversions.
98 * - Create test routines which predefine the expected results. Our test cases
99 * usually expose bugs in system implementations rather than in ours :-)
105 * 1) The following preprocessor macros should be defined to 1 if the feature or
106 * file in question is available on the target system (by using Autoconf or
107 * other means), though basic functionality should be available as long as
108 * HAVE_STDARG_H and HAVE_STDLIB_H are defined correctly:
121 * HAVE_LCONV_DECIMAL_POINT
122 * HAVE_LCONV_THOUSANDS_SEP
125 * HAVE_UNSIGNED_LONG_LONG_INT
133 * 2) The calls to the functions which should be replaced must be redefined
134 * throughout the project files (by using Autoconf or other means):
136 * #define vsnprintf rpl_vsnprintf
137 * #define snprintf rpl_snprintf
138 * #define vasprintf rpl_vasprintf
139 * #define asprintf rpl_asprintf
141 * 3) The required replacement functions should be declared in some header file
142 * included throughout the project files:
145 * #include <config.h>
148 * #include <stdarg.h>
149 * #if !HAVE_VSNPRINTF
150 * int rpl_vsnprintf(char *, size_t, const char *, va_list);
153 * int rpl_snprintf(char *, size_t, const char *, ...);
155 * #if !HAVE_VASPRINTF
156 * int rpl_vasprintf(char **, const char *, va_list);
159 * int rpl_asprintf(char **, const char *, ...);
163 * Autoconf macros for handling step 1 and step 2 are available at
164 * <http://www.jhweiss.de/software/snprintf.html>.
169 #endif /* HAVE_CONFIG_H */
172 #include <math.h> /* For pow(3), NAN, and INFINITY. */
173 #include <string.h> /* For strcmp(3). */
174 #if defined(__NetBSD__) || \
175 defined(__FreeBSD__) || \
176 defined(__OpenBSD__) || \
177 defined(__NeXT__) || \
180 #elif defined(sgi) || defined(__sgi)
182 #define __c99 /* Force C99 mode to get <stdint.h> included on IRIX 6.5.30. */
183 #endif /* !defined(__c99) */
186 #elif defined(__svr4__)
188 #elif defined(__linux__)
190 #endif /* defined(__NetBSD__) || defined(__FreeBSD__) || [...] */
191 #if HAVE_CONFIG_H /* Undefine definitions possibly done in config.h. */
194 #endif /* defined(HAVE_SNPRINTF) */
195 #ifdef HAVE_VSNPRINTF
196 #undef HAVE_VSNPRINTF
197 #endif /* defined(HAVE_VSNPRINTF) */
200 #endif /* defined(HAVE_ASPRINTF) */
201 #ifdef HAVE_VASPRINTF
202 #undef HAVE_VASPRINTF
203 #endif /* defined(HAVE_VASPRINTF) */
206 #endif /* defined(snprintf) */
209 #endif /* defined(vsnprintf) */
212 #endif /* defined(asprintf) */
215 #endif /* defined(vasprintf) */
216 #else /* By default, we assume a modern system for testing. */
217 #ifndef HAVE_STDARG_H
218 #define HAVE_STDARG_H 1
219 #endif /* HAVE_STDARG_H */
220 #ifndef HAVE_STDDEF_H
221 #define HAVE_STDDEF_H 1
222 #endif /* HAVE_STDDEF_H */
223 #ifndef HAVE_STDINT_H
224 #define HAVE_STDINT_H 1
225 #endif /* HAVE_STDINT_H */
226 #ifndef HAVE_STDLIB_H
227 #define HAVE_STDLIB_H 1
228 #endif /* HAVE_STDLIB_H */
229 #ifndef HAVE_INTTYPES_H
230 #define HAVE_INTTYPES_H 1
231 #endif /* HAVE_INTTYPES_H */
232 #ifndef HAVE_LOCALE_H
233 #define HAVE_LOCALE_H 1
234 #endif /* HAVE_LOCALE_H */
235 #ifndef HAVE_LOCALECONV
236 #define HAVE_LOCALECONV 1
237 #endif /* !defined(HAVE_LOCALECONV) */
238 #ifndef HAVE_LCONV_DECIMAL_POINT
239 #define HAVE_LCONV_DECIMAL_POINT 1
240 #endif /* HAVE_LCONV_DECIMAL_POINT */
241 #ifndef HAVE_LCONV_THOUSANDS_SEP
242 #define HAVE_LCONV_THOUSANDS_SEP 1
243 #endif /* HAVE_LCONV_THOUSANDS_SEP */
244 #ifndef HAVE_LONG_DOUBLE
245 #define HAVE_LONG_DOUBLE 1
246 #endif /* !defined(HAVE_LONG_DOUBLE) */
247 #ifndef HAVE_LONG_LONG_INT
248 #define HAVE_LONG_LONG_INT 1
249 #endif /* !defined(HAVE_LONG_LONG_INT) */
250 #ifndef HAVE_UNSIGNED_LONG_LONG_INT
251 #define HAVE_UNSIGNED_LONG_LONG_INT 1
252 #endif /* !defined(HAVE_UNSIGNED_LONG_LONG_INT) */
253 #ifndef HAVE_INTMAX_T
254 #define HAVE_INTMAX_T 1
255 #endif /* !defined(HAVE_INTMAX_T) */
256 #ifndef HAVE_UINTMAX_T
257 #define HAVE_UINTMAX_T 1
258 #endif /* !defined(HAVE_UINTMAX_T) */
259 #ifndef HAVE_UINTPTR_T
260 #define HAVE_UINTPTR_T 1
261 #endif /* !defined(HAVE_UINTPTR_T) */
262 #ifndef HAVE_PTRDIFF_T
263 #define HAVE_PTRDIFF_T 1
264 #endif /* !defined(HAVE_PTRDIFF_T) */
266 #define HAVE_VA_COPY 1
267 #endif /* !defined(HAVE_VA_COPY) */
268 #ifndef HAVE___VA_COPY
269 #define HAVE___VA_COPY 1
270 #endif /* !defined(HAVE___VA_COPY) */
271 #endif /* HAVE_CONFIG_H */
272 #define snprintf rpl_snprintf
273 #define vsnprintf rpl_vsnprintf
274 #define asprintf rpl_asprintf
275 #define vasprintf rpl_vasprintf
276 #endif /* TEST_SNPRINTF */
278 #if !HAVE_SNPRINTF || !HAVE_VSNPRINTF || !HAVE_ASPRINTF || !HAVE_VASPRINTF
279 #include <stdio.h> /* For NULL, size_t, vsnprintf(3), and vasprintf(3). */
282 #endif /* defined(VA_START) */
285 #endif /* defined(VA_SHIFT) */
288 #define VA_START(ap, last) va_start(ap, last)
289 #define VA_SHIFT(ap, value, type) /* No-op for ANSI C. */
290 #else /* Assume <varargs.h> is available. */
292 #define VA_START(ap, last) va_start(ap) /* "last" is ignored. */
293 #define VA_SHIFT(ap, value, type) value = va_arg(ap, type)
294 #endif /* HAVE_STDARG_H */
297 int rpl_vsnprintf(char *, size_t, const char *, va_list);
298 #define vsnprintf rpl_vsnprintf
301 int rpl_snprintf(char *, size_t, const char *, ...);
302 #define snprintf rpl_snprintf
305 int rpl_vasprintf(char **, const char *, va_list);
306 #define vasprintf rpl_vasprintf
309 int rpl_asprintf(char **, const char *, ...);
310 #define asprintf rpl_asprintf
315 #include <stdlib.h> /* For malloc(3). */
316 #endif /* HAVE_STDLIB_H */
319 #endif /* defined(VA_COPY) */
322 #endif /* defined(VA_END_COPY) */
324 #define VA_COPY(dest, src) va_copy(dest, src)
325 #define VA_END_COPY(ap) va_end(ap)
327 #define VA_COPY(dest, src) __va_copy(dest, src)
328 #define VA_END_COPY(ap) va_end(ap)
330 #define VA_COPY(dest, src) (void)mymemcpy(&dest, &src, sizeof(va_list))
331 #define VA_END_COPY(ap) /* No-op. */
332 #define NEED_MYMEMCPY 1
333 static void *mymemcpy(void *, void *, size_t);
334 #endif /* HAVE_VA_COPY */
335 #endif /* !HAVE_VASPRINTF */
338 #include <errno.h> /* For ERANGE and errno. */
339 #include <limits.h> /* For *_MAX. */
341 #include <inttypes.h> /* For intmax_t (if not defined in <stdint.h>). */
342 #endif /* HAVE_INTTYPES_H */
344 #include <locale.h> /* For localeconv(3). */
345 #endif /* HAVE_LOCALE_H */
347 #include <stddef.h> /* For ptrdiff_t. */
348 #endif /* HAVE_STDDEF_H */
350 #include <stdint.h> /* For intmax_t. */
351 #endif /* HAVE_STDINT_H */
353 /* Support for unsigned long long int. We may also need ULLONG_MAX. */
354 #ifndef ULONG_MAX /* We may need ULONG_MAX as a fallback. */
356 #define ULONG_MAX UINT_MAX
358 #define ULONG_MAX INT_MAX
359 #endif /* defined(UINT_MAX) */
360 #endif /* !defined(ULONG_MAX) */
363 #endif /* defined(ULLONG) */
364 #if HAVE_UNSIGNED_LONG_LONG_INT
365 #define ULLONG unsigned long long int
367 #define ULLONG_MAX ULONG_MAX
368 #endif /* !defined(ULLONG_MAX) */
370 #define ULLONG unsigned long int
373 #endif /* defined(ULLONG_MAX) */
374 #define ULLONG_MAX ULONG_MAX
375 #endif /* HAVE_LONG_LONG_INT */
377 /* Support for uintmax_t. We also need UINTMAX_MAX. */
380 #endif /* defined(UINTMAX_T) */
381 #if HAVE_UINTMAX_T || defined(uintmax_t)
382 #define UINTMAX_T uintmax_t
384 #define UINTMAX_MAX ULLONG_MAX
385 #endif /* !defined(UINTMAX_MAX) */
387 #define UINTMAX_T ULLONG
390 #endif /* defined(UINTMAX_MAX) */
391 #define UINTMAX_MAX ULLONG_MAX
392 #endif /* HAVE_UINTMAX_T || defined(uintmax_t) */
394 /* Support for long double. */
397 #define LDOUBLE long double
399 #define LDOUBLE double
400 #endif /* HAVE_LONG_DOUBLE */
401 #endif /* !defined(LDOUBLE) */
403 /* Support for long long int. */
405 #if HAVE_LONG_LONG_INT
406 #define LLONG long long int
408 #define LLONG long int
409 #endif /* HAVE_LONG_LONG_INT */
410 #endif /* !defined(LLONG) */
412 /* Support for intmax_t. */
414 #if HAVE_INTMAX_T || defined(intmax_t)
415 #define INTMAX_T intmax_t
417 #define INTMAX_T LLONG
418 #endif /* HAVE_INTMAX_T || defined(intmax_t) */
419 #endif /* !defined(INTMAX_T) */
421 /* Support for uintptr_t. */
423 #if HAVE_UINTPTR_T || defined(uintptr_t)
424 #define UINTPTR_T uintptr_t
426 #define UINTPTR_T unsigned long int
427 #endif /* HAVE_UINTPTR_T || defined(uintptr_t) */
428 #endif /* !defined(UINTPTR_T) */
430 /* Support for ptrdiff_t. */
432 #if HAVE_PTRDIFF_T || defined(ptrdiff_t)
433 #define PTRDIFF_T ptrdiff_t
435 #define PTRDIFF_T long int
436 #endif /* HAVE_PTRDIFF_T || defined(ptrdiff_t) */
437 #endif /* !defined(PTRDIFF_T) */
440 * We need an unsigned integer type corresponding to ptrdiff_t (cf. C99:
441 * 7.19.6.1, 7). However, we'll simply use PTRDIFF_T and convert it to an
442 * unsigned type if necessary. This should work just fine in practice.
445 #define UPTRDIFF_T PTRDIFF_T
446 #endif /* !defined(UPTRDIFF_T) */
449 * We need a signed integer type corresponding to size_t (cf. C99: 7.19.6.1, 7).
450 * However, we'll simply use size_t and convert it to a signed type if
451 * necessary. This should work just fine in practice.
454 #define SSIZE_T size_t
455 #endif /* !defined(SSIZE_T) */
457 /* Either ERANGE or E2BIG should be available everywhere. */
460 #endif /* !defined(ERANGE) */
462 #define EOVERFLOW ERANGE
463 #endif /* !defined(EOVERFLOW) */
466 * Buffer size to hold the octal string representation of UINT128_MAX without
467 * nul-termination ("3777777777777777777777777777777777777777777").
469 #ifdef MAX_CONVERT_LENGTH
470 #undef MAX_CONVERT_LENGTH
471 #endif /* defined(MAX_CONVERT_LENGTH) */
472 #define MAX_CONVERT_LENGTH 43
474 /* Format read states. */
475 #define PRINT_S_DEFAULT 0
476 #define PRINT_S_FLAGS 1
477 #define PRINT_S_WIDTH 2
478 #define PRINT_S_DOT 3
479 #define PRINT_S_PRECISION 4
480 #define PRINT_S_MOD 5
481 #define PRINT_S_CONV 6
484 #define PRINT_F_MINUS (1 << 0)
485 #define PRINT_F_PLUS (1 << 1)
486 #define PRINT_F_SPACE (1 << 2)
487 #define PRINT_F_NUM (1 << 3)
488 #define PRINT_F_ZERO (1 << 4)
489 #define PRINT_F_QUOTE (1 << 5)
490 #define PRINT_F_UP (1 << 6)
491 #define PRINT_F_UNSIGNED (1 << 7)
492 #define PRINT_F_TYPE_G (1 << 8)
493 #define PRINT_F_TYPE_E (1 << 9)
495 /* Conversion flags. */
496 #define PRINT_C_CHAR 1
497 #define PRINT_C_SHORT 2
498 #define PRINT_C_LONG 3
499 #define PRINT_C_LLONG 4
500 #define PRINT_C_LDOUBLE 5
501 #define PRINT_C_SIZE 6
502 #define PRINT_C_PTRDIFF 7
503 #define PRINT_C_INTMAX 8
506 #define MAX(x, y) ((x >= y) ? x : y)
507 #endif /* !defined(MAX) */
509 #define CHARTOINT(ch) (ch - '0')
510 #endif /* !defined(CHARTOINT) */
512 #define ISDIGIT(ch) ('0' <= (unsigned char)ch && (unsigned char)ch <= '9')
513 #endif /* !defined(ISDIGIT) */
515 #define ISNAN(x) (x != x)
516 #endif /* !defined(ISNAN) */
518 #define ISINF(x) (x != 0.0 && x + x == x)
519 #endif /* !defined(ISINF) */
523 #endif /* defined(OUTCHAR) */
524 #define OUTCHAR(str, len, size, ch) \
526 if (len + 1 < size) \
529 } while (/* CONSTCOND */ 0)
531 static void fmtstr(char *, size_t *, size_t, const char *, int, int, int);
532 static void fmtint(char *, size_t *, size_t, INTMAX_T, int, int, int, int);
533 static void fmtflt(char *, size_t *, size_t, LDOUBLE, int, int, int, int *);
534 static void printsep(char *, size_t *, size_t);
535 static int getnumsep(int);
536 static int getexponent(LDOUBLE);
537 static int convert(UINTMAX_T, char *, size_t, int, int);
538 static UINTMAX_T cast(LDOUBLE);
539 static UINTMAX_T myround(LDOUBLE);
540 static LDOUBLE mypow10(int);
547 rpl_vsnprintf(char *str, size_t size, const char *format, va_list args)
551 unsigned char cvalue;
552 const char *strvalue;
554 PTRDIFF_T *ptrdiffptr;
560 signed char *charptr;
568 int state = PRINT_S_DEFAULT;
572 * C99 says: "If `n' is zero, nothing is written, and `s' may be a null
573 * pointer." (7.19.6.5, 2) We're forgiving and allow a NULL pointer
574 * even if a size larger than zero was specified. At least NetBSD's
575 * snprintf(3) does the same, as well as other versions of this file.
576 * (Though some of these versions will write to a non-NULL buffer even
577 * if a size of zero was specified, which violates the standard.)
579 if (str == NULL && size != 0)
584 case PRINT_S_DEFAULT:
586 state = PRINT_S_FLAGS;
588 OUTCHAR(str, len, size, ch);
594 flags |= PRINT_F_MINUS;
598 flags |= PRINT_F_PLUS;
602 flags |= PRINT_F_SPACE;
606 flags |= PRINT_F_NUM;
610 flags |= PRINT_F_ZERO;
613 case '\'': /* SUSv2 flag (not in C99). */
614 flags |= PRINT_F_QUOTE;
618 state = PRINT_S_WIDTH;
625 if (width > (INT_MAX - ch) / 10) {
629 width = 10 * width + ch;
631 } else if (ch == '*') {
633 * C99 says: "A negative field width argument is
634 * taken as a `-' flag followed by a positive
635 * field width." (7.19.6.1, 5)
637 if ((width = va_arg(args, int)) < 0) {
638 flags |= PRINT_F_MINUS;
648 state = PRINT_S_PRECISION;
653 case PRINT_S_PRECISION:
658 if (precision > (INT_MAX - ch) / 10) {
662 precision = 10 * precision + ch;
664 } else if (ch == '*') {
666 * C99 says: "A negative precision argument is
667 * taken as if the precision were omitted."
670 if ((precision = va_arg(args, int)) < 0)
681 if (ch == 'h') { /* It's a char. */
683 cflags = PRINT_C_CHAR;
685 cflags = PRINT_C_SHORT;
689 if (ch == 'l') { /* It's a long long. */
691 cflags = PRINT_C_LLONG;
693 cflags = PRINT_C_LONG;
696 cflags = PRINT_C_LDOUBLE;
700 cflags = PRINT_C_INTMAX;
704 cflags = PRINT_C_PTRDIFF;
708 cflags = PRINT_C_SIZE;
712 state = PRINT_S_CONV;
721 value = (signed char)va_arg(args, int);
724 value = (short int)va_arg(args, int);
727 value = va_arg(args, long int);
730 value = va_arg(args, LLONG);
733 value = va_arg(args, SSIZE_T);
736 value = va_arg(args, INTMAX_T);
738 case PRINT_C_PTRDIFF:
739 value = va_arg(args, PTRDIFF_T);
742 value = va_arg(args, int);
745 fmtint(str, &len, size, value, 10, width,
761 flags |= PRINT_F_UNSIGNED;
764 value = (unsigned char)va_arg(args,
768 value = (unsigned short int)va_arg(args,
772 value = va_arg(args, unsigned long int);
775 value = va_arg(args, ULLONG);
778 value = va_arg(args, size_t);
781 value = va_arg(args, UINTMAX_T);
783 case PRINT_C_PTRDIFF:
784 value = va_arg(args, UPTRDIFF_T);
787 value = va_arg(args, unsigned int);
790 fmtint(str, &len, size, value, base, width,
794 /* Not yet supported, we'll use "%F". */
799 /* Not yet supported, we'll use "%f". */
802 if (cflags == PRINT_C_LDOUBLE)
803 fvalue = va_arg(args, LDOUBLE);
805 fvalue = va_arg(args, double);
806 fmtflt(str, &len, size, fvalue, width,
807 precision, flags, &overflow);
815 flags |= PRINT_F_TYPE_E;
816 if (cflags == PRINT_C_LDOUBLE)
817 fvalue = va_arg(args, LDOUBLE);
819 fvalue = va_arg(args, double);
820 fmtflt(str, &len, size, fvalue, width,
821 precision, flags, &overflow);
829 flags |= PRINT_F_TYPE_G;
830 if (cflags == PRINT_C_LDOUBLE)
831 fvalue = va_arg(args, LDOUBLE);
833 fvalue = va_arg(args, double);
835 * If the precision is zero, it is treated as
836 * one (cf. C99: 7.19.6.1, 8).
840 fmtflt(str, &len, size, fvalue, width,
841 precision, flags, &overflow);
846 cvalue = va_arg(args, int);
847 OUTCHAR(str, len, size, cvalue);
850 strvalue = va_arg(args, char *);
851 fmtstr(str, &len, size, strvalue, width,
856 * C99 says: "The value of the pointer is
857 * converted to a sequence of printing
858 * characters, in an implementation-defined
859 * manner." (C99: 7.19.6.1, 8)
861 if ((strvalue = va_arg(args, void *)) == NULL)
863 * We use the glibc format. BSD prints
866 fmtstr(str, &len, size, "(nil)", width,
870 * We use the BSD/glibc format. SysV
871 * omits the "0x" prefix (which we emit
872 * using the PRINT_F_NUM flag).
874 flags |= PRINT_F_NUM;
875 flags |= PRINT_F_UNSIGNED;
876 fmtint(str, &len, size,
877 (UINTPTR_T)strvalue, 16, width,
884 charptr = va_arg(args, signed char *);
888 shortptr = va_arg(args, short int *);
892 longptr = va_arg(args, long int *);
896 llongptr = va_arg(args, LLONG *);
901 * C99 says that with the "z" length
902 * modifier, "a following `n' conversion
903 * specifier applies to a pointer to a
904 * signed integer type corresponding to
905 * size_t argument." (7.19.6.1, 7)
907 sizeptr = va_arg(args, SSIZE_T *);
911 intmaxptr = va_arg(args, INTMAX_T *);
914 case PRINT_C_PTRDIFF:
915 ptrdiffptr = va_arg(args, PTRDIFF_T *);
919 intptr = va_arg(args, int *);
924 case '%': /* Print a "%" character verbatim. */
925 OUTCHAR(str, len, size, ch);
927 default: /* Skip other characters. */
931 state = PRINT_S_DEFAULT;
932 base = cflags = flags = width = 0;
940 str[size - 1] = '\0';
942 if (overflow || len >= INT_MAX) {
943 errno = overflow ? EOVERFLOW : ERANGE;
950 fmtstr(char *str, size_t *len, size_t size, const char *value, int width,
951 int precision, int flags)
953 int padlen, strln; /* Amount to pad. */
954 int noprecision = (precision == -1);
956 if (value == NULL) /* We're forgiving. */
959 /* If a precision was specified, don't read the string past it. */
960 for (strln = 0; value[strln] != '\0' &&
961 (noprecision || strln < precision); strln++)
964 if ((padlen = width - strln) < 0)
966 if (flags & PRINT_F_MINUS) /* Left justify. */
969 while (padlen > 0) { /* Leading spaces. */
970 OUTCHAR(str, *len, size, ' ');
973 while (*value != '\0' && (noprecision || precision-- > 0)) {
974 OUTCHAR(str, *len, size, *value);
977 while (padlen < 0) { /* Trailing spaces. */
978 OUTCHAR(str, *len, size, ' ');
984 fmtint(char *str, size_t *len, size_t size, INTMAX_T value, int base, int width,
985 int precision, int flags)
988 char iconvert[MAX_CONVERT_LENGTH];
991 int spadlen = 0; /* Amount to space pad. */
992 int zpadlen = 0; /* Amount to zero pad. */
994 int separators = (flags & PRINT_F_QUOTE);
995 int noprecision = (precision == -1);
997 if (flags & PRINT_F_UNSIGNED)
1000 uvalue = (value >= 0) ? value : -value;
1003 else if (flags & PRINT_F_PLUS) /* Do a sign. */
1005 else if (flags & PRINT_F_SPACE)
1009 pos = convert(uvalue, iconvert, sizeof(iconvert), base,
1010 flags & PRINT_F_UP);
1012 if (flags & PRINT_F_NUM && uvalue != 0) {
1014 * C99 says: "The result is converted to an `alternative form'.
1015 * For `o' conversion, it increases the precision, if and only
1016 * if necessary, to force the first digit of the result to be a
1017 * zero (if the value and precision are both 0, a single 0 is
1018 * printed). For `x' (or `X') conversion, a nonzero result has
1019 * `0x' (or `0X') prefixed to it." (7.19.6.1, 6)
1023 if (precision <= pos)
1024 precision = pos + 1;
1027 hexprefix = (flags & PRINT_F_UP) ? 'X' : 'x';
1032 if (separators) /* Get the number of group separators we'll print. */
1033 separators = getnumsep(pos);
1035 zpadlen = precision - pos - separators;
1036 spadlen = width /* Minimum field width. */
1037 - separators /* Number of separators. */
1038 - MAX(precision, pos) /* Number of integer digits. */
1039 - ((sign != 0) ? 1 : 0) /* Will we print a sign? */
1040 - ((hexprefix != 0) ? 2 : 0); /* Will we print a prefix? */
1048 * C99 says: "If the `0' and `-' flags both appear, the `0' flag is
1049 * ignored. For `d', `i', `o', `u', `x', and `X' conversions, if a
1050 * precision is specified, the `0' flag is ignored." (7.19.6.1, 6)
1052 if (flags & PRINT_F_MINUS) /* Left justify. */
1054 else if (flags & PRINT_F_ZERO && noprecision) {
1058 while (spadlen > 0) { /* Leading spaces. */
1059 OUTCHAR(str, *len, size, ' ');
1062 if (sign != 0) /* Sign. */
1063 OUTCHAR(str, *len, size, sign);
1064 if (hexprefix != 0) { /* A "0x" or "0X" prefix. */
1065 OUTCHAR(str, *len, size, '0');
1066 OUTCHAR(str, *len, size, hexprefix);
1068 while (zpadlen > 0) { /* Leading zeros. */
1069 OUTCHAR(str, *len, size, '0');
1072 while (pos > 0) { /* The actual digits. */
1074 OUTCHAR(str, *len, size, iconvert[pos]);
1075 if (separators > 0 && pos > 0 && pos % 3 == 0)
1076 printsep(str, len, size);
1078 while (spadlen < 0) { /* Trailing spaces. */
1079 OUTCHAR(str, *len, size, ' ');
1085 fmtflt(char *str, size_t *len, size_t size, LDOUBLE fvalue, int width,
1086 int precision, int flags, int *overflow)
1092 const char *infnan = NULL;
1093 char iconvert[MAX_CONVERT_LENGTH];
1094 char fconvert[MAX_CONVERT_LENGTH];
1095 char econvert[4]; /* "e-12" (without nul-termination). */
1098 int leadfraczeros = 0;
1107 int separators = (flags & PRINT_F_QUOTE);
1108 int estyle = (flags & PRINT_F_TYPE_E);
1109 #if HAVE_LOCALECONV && HAVE_LCONV_DECIMAL_POINT
1110 struct lconv *lc = localeconv();
1111 #endif /* HAVE_LOCALECONV && HAVE_LCONV_DECIMAL_POINT */
1114 * AIX' man page says the default is 0, but C99 and at least Solaris'
1115 * and NetBSD's man pages say the default is 6, and sprintf(3) on AIX
1118 if (precision == -1)
1123 else if (flags & PRINT_F_PLUS) /* Do a sign. */
1125 else if (flags & PRINT_F_SPACE)
1129 infnan = (flags & PRINT_F_UP) ? "NAN" : "nan";
1130 else if (ISINF(fvalue))
1131 infnan = (flags & PRINT_F_UP) ? "INF" : "inf";
1133 if (infnan != NULL) {
1135 iconvert[ipos++] = sign;
1136 while (*infnan != '\0')
1137 iconvert[ipos++] = *infnan++;
1138 fmtstr(str, len, size, iconvert, width, ipos, flags);
1142 /* "%e" (or "%E") or "%g" (or "%G") conversion. */
1143 if (flags & PRINT_F_TYPE_E || flags & PRINT_F_TYPE_G) {
1144 if (flags & PRINT_F_TYPE_G) {
1146 * For "%g" (and "%G") conversions, the precision
1147 * specifies the number of significant digits, which
1148 * includes the digits in the integer part. The
1149 * conversion will or will not be using "e-style" (like
1150 * "%e" or "%E" conversions) depending on the precision
1151 * and on the exponent. However, the exponent can be
1152 * affected by rounding the converted value, so we'll
1153 * leave this decision for later. Until then, we'll
1154 * assume that we're going to do an "e-style" conversion
1155 * (in order to get the exponent calculated). For
1156 * "e-style", the precision must be decremented by one.
1160 * For "%g" (and "%G") conversions, trailing zeros are
1161 * removed from the fractional portion of the result
1162 * unless the "#" flag was specified.
1164 if (!(flags & PRINT_F_NUM))
1167 exponent = getexponent(fvalue);
1173 * Sorry, we only support 9, 19, or 38 digits (that is, the number of
1174 * digits of the 32-bit, the 64-bit, or the 128-bit UINTMAX_MAX value
1175 * minus one) past the decimal point due to our conversion method.
1177 switch (sizeof(UINTMAX_T)) {
1192 ufvalue = (fvalue >= 0.0) ? fvalue : -fvalue;
1193 if (estyle) /* We want exactly one integer digit. */
1194 ufvalue /= mypow10(exponent);
1196 if ((intpart = cast(ufvalue)) == UINTMAX_MAX) {
1202 * Factor of ten with the number of digits needed for the fractional
1203 * part. For example, if the precision is 3, the mask will be 1000.
1205 mask = mypow10(precision);
1207 * We "cheat" by converting the fractional part to integer by
1208 * multiplying by a factor of ten.
1210 if ((fracpart = myround(mask * (ufvalue - intpart))) >= mask) {
1212 * For example, ufvalue = 2.99962, intpart = 2, and mask = 1000
1213 * (because precision = 3). Now, myround(1000 * 0.99962) will
1214 * return 1000. So, the integer part must be incremented by one
1215 * and the fractional part must be set to zero.
1219 if (estyle && intpart == 10) {
1221 * The value was rounded up to ten, but we only want one
1222 * integer digit if using "e-style". So, the integer
1223 * part must be set to one and the exponent must be
1224 * incremented by one.
1232 * Now that we know the real exponent, we can check whether or not to
1233 * use "e-style" for "%g" (and "%G") conversions. If we don't need
1234 * "e-style", the precision must be adjusted and the integer and
1235 * fractional parts must be recalculated from the original value.
1237 * C99 says: "Let P equal the precision if nonzero, 6 if the precision
1238 * is omitted, or 1 if the precision is zero. Then, if a conversion
1239 * with style `E' would have an exponent of X:
1241 * - if P > X >= -4, the conversion is with style `f' (or `F') and
1242 * precision P - (X + 1).
1244 * - otherwise, the conversion is with style `e' (or `E') and precision
1245 * P - 1." (7.19.6.1, 8)
1247 * Note that we had decremented the precision by one.
1249 if (flags & PRINT_F_TYPE_G && estyle &&
1250 precision + 1 > exponent && exponent >= -4) {
1251 precision -= exponent;
1258 exponent = -exponent;
1264 * Convert the exponent. The sizeof(econvert) is 4. So, the
1265 * econvert buffer can hold e.g. "e+99" and "e-99". We don't
1266 * support an exponent which contains more than two digits.
1267 * Therefore, the following stores are safe.
1269 epos = convert(exponent, econvert, 2, 10, 0);
1271 * C99 says: "The exponent always contains at least two digits,
1272 * and only as many more digits as necessary to represent the
1273 * exponent." (7.19.6.1, 8)
1276 econvert[epos++] = '0';
1277 econvert[epos++] = esign;
1278 econvert[epos++] = (flags & PRINT_F_UP) ? 'E' : 'e';
1281 /* Convert the integer part and the fractional part. */
1282 ipos = convert(intpart, iconvert, sizeof(iconvert), 10, 0);
1283 if (fracpart != 0) /* convert() would return 1 if fracpart == 0. */
1284 fpos = convert(fracpart, fconvert, sizeof(fconvert), 10, 0);
1286 leadfraczeros = precision - fpos;
1289 if (fpos > 0) /* Omit trailing fractional part zeros. */
1290 while (omitcount < fpos && fconvert[omitcount] == '0')
1292 else { /* The fractional part is zero, omit it completely. */
1293 omitcount = precision;
1296 precision -= omitcount;
1300 * Print a decimal point if either the fractional part is non-zero
1301 * and/or the "#" flag was specified.
1303 if (precision > 0 || flags & PRINT_F_NUM)
1305 if (separators) /* Get the number of group separators we'll print. */
1306 separators = getnumsep(ipos);
1308 padlen = width /* Minimum field width. */
1309 - ipos /* Number of integer digits. */
1310 - epos /* Number of exponent characters. */
1311 - precision /* Number of fractional digits. */
1312 - separators /* Number of group separators. */
1313 - (emitpoint ? 1 : 0) /* Will we print a decimal point? */
1314 - ((sign != 0) ? 1 : 0); /* Will we print a sign character? */
1320 * C99 says: "If the `0' and `-' flags both appear, the `0' flag is
1321 * ignored." (7.19.6.1, 6)
1323 if (flags & PRINT_F_MINUS) /* Left justifty. */
1325 else if (flags & PRINT_F_ZERO && padlen > 0) {
1326 if (sign != 0) { /* Sign. */
1327 OUTCHAR(str, *len, size, sign);
1330 while (padlen > 0) { /* Leading zeros. */
1331 OUTCHAR(str, *len, size, '0');
1335 while (padlen > 0) { /* Leading spaces. */
1336 OUTCHAR(str, *len, size, ' ');
1339 if (sign != 0) /* Sign. */
1340 OUTCHAR(str, *len, size, sign);
1341 while (ipos > 0) { /* Integer part. */
1343 OUTCHAR(str, *len, size, iconvert[ipos]);
1344 if (separators > 0 && ipos > 0 && ipos % 3 == 0)
1345 printsep(str, len, size);
1347 if (emitpoint) { /* Decimal point. */
1348 #if HAVE_LOCALECONV && HAVE_LCONV_DECIMAL_POINT
1349 if (lc->decimal_point != NULL && *lc->decimal_point != '\0')
1350 OUTCHAR(str, *len, size, *lc->decimal_point);
1351 else /* We'll always print some decimal point character. */
1352 #endif /* HAVE_LOCALECONV && HAVE_LCONV_DECIMAL_POINT */
1353 OUTCHAR(str, *len, size, '.');
1355 while (leadfraczeros > 0) { /* Leading fractional part zeros. */
1356 OUTCHAR(str, *len, size, '0');
1359 while (fpos > omitcount) { /* The remaining fractional part. */
1361 OUTCHAR(str, *len, size, fconvert[fpos]);
1363 while (epos > 0) { /* Exponent. */
1365 OUTCHAR(str, *len, size, econvert[epos]);
1367 while (padlen < 0) { /* Trailing spaces. */
1368 OUTCHAR(str, *len, size, ' ');
1374 printsep(char *str, size_t *len, size_t size)
1376 #if HAVE_LOCALECONV && HAVE_LCONV_THOUSANDS_SEP
1377 struct lconv *lc = localeconv();
1380 if (lc->thousands_sep != NULL)
1381 for (i = 0; lc->thousands_sep[i] != '\0'; i++)
1382 OUTCHAR(str, *len, size, lc->thousands_sep[i]);
1384 #endif /* HAVE_LOCALECONV && HAVE_LCONV_THOUSANDS_SEP */
1385 OUTCHAR(str, *len, size, ',');
1389 getnumsep(int digits)
1391 int separators = (digits - ((digits % 3 == 0) ? 1 : 0)) / 3;
1392 #if HAVE_LOCALECONV && HAVE_LCONV_THOUSANDS_SEP
1394 struct lconv *lc = localeconv();
1396 /* We support an arbitrary separator length (including zero). */
1397 if (lc->thousands_sep != NULL) {
1398 for (strln = 0; lc->thousands_sep[strln] != '\0'; strln++)
1400 separators *= strln;
1402 #endif /* HAVE_LOCALECONV && HAVE_LCONV_THOUSANDS_SEP */
1407 getexponent(LDOUBLE value)
1409 LDOUBLE tmp = (value >= 0.0) ? value : -value;
1413 * We check for 99 > exponent > -99 in order to work around possible
1414 * endless loops which could happen (at least) in the second loop (at
1415 * least) if we're called with an infinite value. However, we checked
1416 * for infinity before calling this function using our ISINF() macro, so
1417 * this might be somewhat paranoid.
1419 while (tmp < 1.0 && tmp > 0.0 && --exponent > -99)
1421 while (tmp >= 10.0 && ++exponent < 99)
1428 convert(UINTMAX_T value, char *buf, size_t size, int base, int caps)
1430 const char *digits = caps ? "0123456789ABCDEF" : "0123456789abcdef";
1433 /* We return an unterminated buffer with the digits in reverse order. */
1435 buf[pos++] = digits[value % base];
1437 } while (value != 0 && pos < size);
1448 * We check for ">=" and not for ">" because if UINTMAX_MAX cannot be
1449 * represented exactly as an LDOUBLE value (but is less than LDBL_MAX),
1450 * it may be increased to the nearest higher representable value for the
1451 * comparison (cf. C99: 6.3.1.4, 2). It might then equal the LDOUBLE
1452 * value although converting the latter to UINTMAX_T would overflow.
1454 if (value >= UINTMAX_MAX)
1459 * At least on NetBSD/sparc64 3.0.2 and 4.99.30, casting long double to
1460 * an integer type converts e.g. 1.9 to 2 instead of 1 (which violates
1461 * the standard). Sigh.
1463 return (result <= value) ? result : result - 1;
1467 myround(LDOUBLE value)
1469 UINTMAX_T intpart = cast(value);
1471 return ((value -= intpart) < 0.5) ? intpart : intpart + 1;
1475 mypow10(int exponent)
1479 while (exponent > 0) {
1483 while (exponent < 0) {
1489 #endif /* !HAVE_VSNPRINTF */
1494 mymemcpy(void *dst, void *src, size_t len)
1496 const char *from = src;
1499 /* No need for optimization, we use this only to replace va_copy(3). */
1504 #endif /* NEED_MYMEMCPY */
1507 rpl_vasprintf(char **ret, const char *format, va_list ap)
1514 len = vsnprintf(NULL, 0, format, aq);
1516 if (len < 0 || (*ret = malloc(size = len + 1)) == NULL)
1518 return vsnprintf(*ret, size, format, ap);
1520 #endif /* !HAVE_VASPRINTF */
1525 rpl_snprintf(char *str, size_t size, const char *format, ...)
1528 rpl_snprintf(va_alist) va_dcl
1529 #endif /* HAVE_STDARG_H */
1535 #endif /* HAVE_STDARG_H */
1539 VA_START(ap, format);
1540 VA_SHIFT(ap, str, char *);
1541 VA_SHIFT(ap, size, size_t);
1542 VA_SHIFT(ap, format, const char *);
1543 len = vsnprintf(str, size, format, ap);
1547 #endif /* !HAVE_SNPRINTF */
1552 rpl_asprintf(char **ret, const char *format, ...)
1555 rpl_asprintf(va_alist) va_dcl
1556 #endif /* HAVE_STDARG_H */
1561 #endif /* HAVE_STDARG_H */
1565 VA_START(ap, format);
1566 VA_SHIFT(ap, ret, char **);
1567 VA_SHIFT(ap, format, const char *);
1568 len = vasprintf(ret, format, ap);
1572 #endif /* !HAVE_ASPRINTF */
1573 #else /* Dummy declaration to avoid empty translation unit warnings. */
1575 #endif /* !HAVE_SNPRINTF || !HAVE_VSNPRINTF || !HAVE_ASPRINTF || [...] */
1581 const char *float_fmt[] = {
1582 /* "%E" and "%e" formats. */
1583 #if HAVE_LONG_LONG_INT && !OS_BSD && !OS_IRIX
1589 #endif /* HAVE_LONG_LONG_INT && !OS_BSD && !OS_IRIX */
1590 "foo|%#+0123.9E|bar",
1602 #if !OS_LINUX /* glibc sometimes gets these wrong. */
1629 #endif /* !OS_LINUX */
1630 /* "%F" and "%f" formats. */
1631 #if !OS_BSD && !OS_IRIX
1636 #if HAVE_LONG_LONG_INT
1642 #endif /* HAVE_LONG_LONG_INT */
1643 #endif /* !OS_BSD && !OS_IRIX */
1644 "foo|%#+0123.9F|bar",
1682 /* "%G" and "%g" formats. */
1683 #if !OS_BSD && !OS_IRIX && !OS_LINUX
1688 #if HAVE_LONG_LONG_INT
1694 #endif /* HAVE_LONG_LONG_INT */
1695 #endif /* !OS_BSD && !OS_IRIX && !OS_LINUX */
1696 "foo|%#+0123.9G|bar",
1708 #if !OS_LINUX /* glibc sometimes gets these wrong. */
1735 #endif /* !OS_LINUX */
1738 double float_val[] = {
1794 #if !OS_BSD /* BSD sometimes gets these wrong. */
1798 #endif /* defined(INFINITY) */
1801 #endif /* defined(NAN) */
1802 #endif /* !OS_BSD */
1805 const char *long_fmt[] = {
1812 #endif /* !OS_IRiX */
1853 long int long_val[] = {
1856 #endif /* LONG_MAX */
1859 #endif /* LONG_MIN */
1869 const char *ulong_fmt[] = {
1877 #endif /* !OS_IRiX */
1925 /* "%X" and "%x" formats. */
1961 unsigned long int ulong_val[] = {
1964 #endif /* ULONG_MAX */
1972 const char *llong_fmt[] = {
1991 LLONG llong_val[] = {
1994 #endif /* LLONG_MAX */
1997 #endif /* LLONG_MIN */
2007 const char *string_fmt[] = {
2027 const char *string_val[] = {
2030 "Sound check: One, two, three.",
2031 "This string is a little longer than the other strings.",
2036 #if !OS_SYSV /* SysV uses a different format than we do. */
2037 const char *pointer_fmt[] = {
2043 const char *pointer_val[] = {
2049 #endif /* !OS_SYSV */
2050 char buf1[1024], buf2[1024];
2051 double value, digits = 9.123456789012345678901234567890123456789;
2052 int i, j, r1, r2, failed = 0, num = 0;
2055 * Use -DTEST_NILS in order to also test the conversion of nil values. Might
2056 * segfault on systems which don't support converting a NULL pointer with "%s"
2057 * and lets some test cases fail against BSD and glibc due to bugs in their
2065 #endif /* !defined(TEST_NILS) */
2068 #endif /* defined(TEST) */
2069 #define TEST(fmt, val) \
2071 for (i = 0; fmt[i] != NULL; i++) \
2072 for (j = 0; j == 0 || val[j - TEST_NILS] != 0; j++) { \
2073 r1 = sprintf(buf1, fmt[i], val[j]); \
2074 r2 = snprintf(buf2, sizeof(buf2), fmt[i], val[j]); \
2075 if (strcmp(buf1, buf2) != 0 || r1 != r2) { \
2076 (void)printf("Results don't match, " \
2077 "format string: %s\n" \
2078 "\t sprintf(3): [%s] (%d)\n" \
2079 "\tsnprintf(3): [%s] (%d)\n", \
2080 fmt[i], buf1, r1, buf2, r2); \
2085 } while (/* CONSTCOND */ 0)
2088 (void)setlocale(LC_ALL, "");
2089 #endif /* HAVE_LOCALE_H */
2091 (void)puts("Testing our snprintf(3) against your system's sprintf(3).");
2092 TEST(float_fmt, float_val);
2093 TEST(long_fmt, long_val);
2094 TEST(ulong_fmt, ulong_val);
2095 TEST(llong_fmt, llong_val);
2096 TEST(string_fmt, string_val);
2097 #if !OS_SYSV /* SysV uses a different format than we do. */
2098 TEST(pointer_fmt, pointer_val);
2099 #endif /* !OS_SYSV */
2100 (void)printf("Result: %d out of %d tests failed.\n", failed, num);
2102 (void)fputs("Checking how many digits we support: ", stdout);
2103 for (i = 0; i < 100; i++) {
2104 value = pow(10, i) * digits;
2105 (void)sprintf(buf1, "%.1f", value);
2106 (void)snprintf(buf2, sizeof(buf2), "%.1f", value);
2107 if (strcmp(buf1, buf2) != 0) {
2108 (void)printf("apparently %d.\n", i);
2112 return (failed == 0) ? 0 : 1;
2114 #endif /* TEST_SNPRINTF */
2116 /* vim: set joinspaces textwidth=80: */