1 /* vsprintf with automatic memory allocation.
2 Copyright (C) 1999, 2002-2003 Free Software Foundation, Inc.
4 This program is free software; you can redistribute it and/or modify it
5 under the terms of the GNU Library General Public License as published
6 by the Free Software Foundation; either version 2, or (at your option)
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 Library General Public License for more details.
14 You should have received a copy of the GNU Library General Public
15 License along with this program; if not, write to the Free Software
16 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
19 /* Tell glibc's <stdio.h> to provide a prototype for snprintf().
20 This must come before <config.h> because <config.h> may include
21 <features.h>, and once <features.h> has been included, it's too late. */
23 # define _GNU_SOURCE 1
35 # include "vasnwprintf.h"
37 # include "vasnprintf.h"
40 #include <stdio.h> /* snprintf(), sprintf() */
41 #include <stdlib.h> /* abort(), malloc(), realloc(), free() */
42 #include <string.h> /* memcpy(), strlen() */
43 #include <errno.h> /* errno */
44 #include <limits.h> /* CHAR_BIT */
45 #include <float.h> /* DBL_MAX_EXP, LDBL_MAX_EXP */
47 # include "wprintf-parse.h"
49 # include "printf-parse.h"
52 /* Checked size_t computations. */
57 # define local_wcslen wcslen
59 /* Solaris 2.5.1 has wcslen() in a separate library libw.so. To avoid
60 a dependency towards this library, here is a local substitute.
61 Define this substitute only once, even if this file is included
62 twice in the same compilation unit. */
63 # ifndef local_wcslen_defined
64 # define local_wcslen_defined 1
66 local_wcslen (const wchar_t *s
)
70 for (ptr
= s
; *ptr
!= (wchar_t) 0; ptr
++)
79 # define VASNPRINTF vasnwprintf
80 # define CHAR_T wchar_t
81 # define DIRECTIVE wchar_t_directive
82 # define DIRECTIVES wchar_t_directives
83 # define PRINTF_PARSE wprintf_parse
84 # define USE_SNPRINTF 1
85 # if HAVE_DECL__SNWPRINTF
86 /* On Windows, the function swprintf() has a different signature than
87 on Unix; we use the _snwprintf() function instead. */
88 # define SNPRINTF _snwprintf
91 # define SNPRINTF swprintf
94 # define VASNPRINTF vasnprintf
96 # define DIRECTIVE char_directive
97 # define DIRECTIVES char_directives
98 # define PRINTF_PARSE printf_parse
99 # define USE_SNPRINTF (HAVE_DECL__SNPRINTF || HAVE_SNPRINTF)
100 # if HAVE_DECL__SNPRINTF
102 # define SNPRINTF _snprintf
105 # define SNPRINTF snprintf
110 VASNPRINTF (CHAR_T
*resultbuf
, size_t *lengthp
, const CHAR_T
*format
, va_list args
)
115 if (PRINTF_PARSE (format
, &d
, &a
) < 0)
126 if (printf_fetchargs (args
, &a
) < 0)
134 size_t buf_neededlength
;
136 CHAR_T
*buf_malloced
;
140 /* Output string accumulator. */
145 /* Allocate a small buffer that will hold a directive passed to
146 sprintf or snprintf. */
148 xsum4 (7, d
.max_width_length
, d
.max_precision_length
, 6);
150 if (buf_neededlength
< 4000 / sizeof (CHAR_T
))
152 buf
= (CHAR_T
*) alloca (buf_neededlength
* sizeof (CHAR_T
));
158 size_t buf_memsize
= xtimes (buf_neededlength
, sizeof (CHAR_T
));
159 if (size_overflow_p (buf_memsize
))
160 goto out_of_memory_1
;
161 buf
= (CHAR_T
*) malloc (buf_memsize
);
163 goto out_of_memory_1
;
167 if (resultbuf
!= NULL
)
170 allocated
= *lengthp
;
179 result is either == resultbuf or == NULL or malloc-allocated.
180 If length > 0, then result != NULL. */
182 /* Ensures that allocated >= needed. Aborts through a jump to
183 out_of_memory if needed is SIZE_MAX or otherwise too big. */
184 #define ENSURE_ALLOCATION(needed) \
185 if ((needed) > allocated) \
187 size_t memory_size; \
190 allocated = (allocated > 0 ? xtimes (allocated, 2) : 12); \
191 if ((needed) > allocated) \
192 allocated = (needed); \
193 memory_size = xtimes (allocated, sizeof (CHAR_T)); \
194 if (size_overflow_p (memory_size)) \
195 goto out_of_memory; \
196 if (result == resultbuf || result == NULL) \
197 memory = (CHAR_T *) malloc (memory_size); \
199 memory = (CHAR_T *) realloc (result, memory_size); \
200 if (memory == NULL) \
201 goto out_of_memory; \
202 if (result == resultbuf && length > 0) \
203 memcpy (memory, result, length * sizeof (CHAR_T)); \
207 for (cp
= format
, i
= 0, dp
= &d
.dir
[0]; ; cp
= dp
->dir_end
, i
++, dp
++)
209 if (cp
!= dp
->dir_start
)
211 size_t n
= dp
->dir_start
- cp
;
212 size_t augmented_length
= xsum (length
, n
);
214 ENSURE_ALLOCATION (augmented_length
);
215 memcpy (result
+ length
, cp
, n
* sizeof (CHAR_T
));
216 length
= augmented_length
;
221 /* Execute a single directive. */
222 if (dp
->conversion
== '%')
224 size_t augmented_length
;
226 if (!(dp
->arg_index
== ARG_NONE
))
228 augmented_length
= xsum (length
, 1);
229 ENSURE_ALLOCATION (augmented_length
);
230 result
[length
] = '%';
231 length
= augmented_length
;
235 if (!(dp
->arg_index
!= ARG_NONE
))
238 if (dp
->conversion
== 'n')
240 switch (a
.arg
[dp
->arg_index
].type
)
242 case TYPE_COUNT_SCHAR_POINTER
:
243 *a
.arg
[dp
->arg_index
].a
.a_count_schar_pointer
= length
;
245 case TYPE_COUNT_SHORT_POINTER
:
246 *a
.arg
[dp
->arg_index
].a
.a_count_short_pointer
= length
;
248 case TYPE_COUNT_INT_POINTER
:
249 *a
.arg
[dp
->arg_index
].a
.a_count_int_pointer
= length
;
251 case TYPE_COUNT_LONGINT_POINTER
:
252 *a
.arg
[dp
->arg_index
].a
.a_count_longint_pointer
= length
;
254 #ifdef HAVE_LONG_LONG
255 case TYPE_COUNT_LONGLONGINT_POINTER
:
256 *a
.arg
[dp
->arg_index
].a
.a_count_longlongint_pointer
= length
;
265 arg_type type
= a
.arg
[dp
->arg_index
].type
;
267 unsigned int prefix_count
;
274 /* Allocate a temporary buffer of sufficient size for calling
281 if (dp
->width_start
!= dp
->width_end
)
283 if (dp
->width_arg_index
!= ARG_NONE
)
287 if (!(a
.arg
[dp
->width_arg_index
].type
== TYPE_INT
))
289 arg
= a
.arg
[dp
->width_arg_index
].a
.a_int
;
290 width
= (arg
< 0 ? (unsigned int) (-arg
) : arg
);
294 const CHAR_T
*digitp
= dp
->width_start
;
297 width
= xsum (xtimes (width
, 10), *digitp
++ - '0');
298 while (digitp
!= dp
->width_end
);
303 if (dp
->precision_start
!= dp
->precision_end
)
305 if (dp
->precision_arg_index
!= ARG_NONE
)
309 if (!(a
.arg
[dp
->precision_arg_index
].type
== TYPE_INT
))
311 arg
= a
.arg
[dp
->precision_arg_index
].a
.a_int
;
312 precision
= (arg
< 0 ? 0 : arg
);
316 const CHAR_T
*digitp
= dp
->precision_start
+ 1;
320 precision
= xsum (xtimes (precision
, 10), *digitp
++ - '0');
321 while (digitp
!= dp
->precision_end
);
325 switch (dp
->conversion
)
328 case 'd': case 'i': case 'u':
329 # ifdef HAVE_LONG_LONG
330 if (type
== TYPE_LONGLONGINT
|| type
== TYPE_ULONGLONGINT
)
332 (unsigned int) (sizeof (unsigned long long) * CHAR_BIT
333 * 0.30103 /* binary -> decimal */
334 * 2 /* estimate for FLAG_GROUP */
336 + 1 /* turn floor into ceil */
337 + 1; /* account for leading sign */
340 if (type
== TYPE_LONGINT
|| type
== TYPE_ULONGINT
)
342 (unsigned int) (sizeof (unsigned long) * CHAR_BIT
343 * 0.30103 /* binary -> decimal */
344 * 2 /* estimate for FLAG_GROUP */
346 + 1 /* turn floor into ceil */
347 + 1; /* account for leading sign */
350 (unsigned int) (sizeof (unsigned int) * CHAR_BIT
351 * 0.30103 /* binary -> decimal */
352 * 2 /* estimate for FLAG_GROUP */
354 + 1 /* turn floor into ceil */
355 + 1; /* account for leading sign */
359 # ifdef HAVE_LONG_LONG
360 if (type
== TYPE_LONGLONGINT
|| type
== TYPE_ULONGLONGINT
)
362 (unsigned int) (sizeof (unsigned long long) * CHAR_BIT
363 * 0.333334 /* binary -> octal */
365 + 1 /* turn floor into ceil */
366 + 1; /* account for leading sign */
369 if (type
== TYPE_LONGINT
|| type
== TYPE_ULONGINT
)
371 (unsigned int) (sizeof (unsigned long) * CHAR_BIT
372 * 0.333334 /* binary -> octal */
374 + 1 /* turn floor into ceil */
375 + 1; /* account for leading sign */
378 (unsigned int) (sizeof (unsigned int) * CHAR_BIT
379 * 0.333334 /* binary -> octal */
381 + 1 /* turn floor into ceil */
382 + 1; /* account for leading sign */
386 # ifdef HAVE_LONG_LONG
387 if (type
== TYPE_LONGLONGINT
|| type
== TYPE_ULONGLONGINT
)
389 (unsigned int) (sizeof (unsigned long long) * CHAR_BIT
390 * 0.25 /* binary -> hexadecimal */
392 + 1 /* turn floor into ceil */
393 + 2; /* account for leading sign or alternate form */
396 if (type
== TYPE_LONGINT
|| type
== TYPE_ULONGINT
)
398 (unsigned int) (sizeof (unsigned long) * CHAR_BIT
399 * 0.25 /* binary -> hexadecimal */
401 + 1 /* turn floor into ceil */
402 + 2; /* account for leading sign or alternate form */
405 (unsigned int) (sizeof (unsigned int) * CHAR_BIT
406 * 0.25 /* binary -> hexadecimal */
408 + 1 /* turn floor into ceil */
409 + 2; /* account for leading sign or alternate form */
413 # ifdef HAVE_LONG_DOUBLE
414 if (type
== TYPE_LONGDOUBLE
)
416 (unsigned int) (LDBL_MAX_EXP
417 * 0.30103 /* binary -> decimal */
418 * 2 /* estimate for FLAG_GROUP */
420 + 1 /* turn floor into ceil */
421 + 10; /* sign, decimal point etc. */
425 (unsigned int) (DBL_MAX_EXP
426 * 0.30103 /* binary -> decimal */
427 * 2 /* estimate for FLAG_GROUP */
429 + 1 /* turn floor into ceil */
430 + 10; /* sign, decimal point etc. */
431 tmp_length
= xsum (tmp_length
, precision
);
434 case 'e': case 'E': case 'g': case 'G':
437 12; /* sign, decimal point, exponent etc. */
438 tmp_length
= xsum (tmp_length
, precision
);
442 # if defined HAVE_WINT_T && !WIDE_CHAR_VERSION
443 if (type
== TYPE_WIDE_CHAR
)
444 tmp_length
= MB_CUR_MAX
;
452 if (type
== TYPE_WIDE_STRING
)
455 local_wcslen (a
.arg
[dp
->arg_index
].a
.a_wide_string
);
457 # if !WIDE_CHAR_VERSION
458 tmp_length
= xtimes (tmp_length
, MB_CUR_MAX
);
463 tmp_length
= strlen (a
.arg
[dp
->arg_index
].a
.a_string
);
468 (unsigned int) (sizeof (void *) * CHAR_BIT
469 * 0.25 /* binary -> hexadecimal */
471 + 1 /* turn floor into ceil */
472 + 2; /* account for leading 0x */
479 if (tmp_length
< width
)
482 tmp_length
= xsum (tmp_length
, 1); /* account for trailing NUL */
485 if (tmp_length
<= sizeof (tmpbuf
) / sizeof (CHAR_T
))
489 size_t tmp_memsize
= xtimes (tmp_length
, sizeof (CHAR_T
));
491 if (size_overflow_p (tmp_memsize
))
492 /* Overflow, would lead to out of memory. */
494 tmp
= (CHAR_T
*) malloc (tmp_memsize
);
501 /* Construct the format string for calling snprintf or
505 if (dp
->flags
& FLAG_GROUP
)
507 if (dp
->flags
& FLAG_LEFT
)
509 if (dp
->flags
& FLAG_SHOWSIGN
)
511 if (dp
->flags
& FLAG_SPACE
)
513 if (dp
->flags
& FLAG_ALT
)
515 if (dp
->flags
& FLAG_ZERO
)
517 if (dp
->width_start
!= dp
->width_end
)
519 size_t n
= dp
->width_end
- dp
->width_start
;
520 memcpy (p
, dp
->width_start
, n
* sizeof (CHAR_T
));
523 if (dp
->precision_start
!= dp
->precision_end
)
525 size_t n
= dp
->precision_end
- dp
->precision_start
;
526 memcpy (p
, dp
->precision_start
, n
* sizeof (CHAR_T
));
532 #ifdef HAVE_LONG_LONG
533 case TYPE_LONGLONGINT
:
534 case TYPE_ULONGLONGINT
:
544 case TYPE_WIDE_STRING
:
548 #ifdef HAVE_LONG_DOUBLE
549 case TYPE_LONGDOUBLE
:
565 /* Construct the arguments for calling snprintf or sprintf. */
567 if (dp
->width_arg_index
!= ARG_NONE
)
569 if (!(a
.arg
[dp
->width_arg_index
].type
== TYPE_INT
))
571 prefixes
[prefix_count
++] = a
.arg
[dp
->width_arg_index
].a
.a_int
;
573 if (dp
->precision_arg_index
!= ARG_NONE
)
575 if (!(a
.arg
[dp
->precision_arg_index
].type
== TYPE_INT
))
577 prefixes
[prefix_count
++] = a
.arg
[dp
->precision_arg_index
].a
.a_int
;
581 /* Prepare checking whether snprintf returns the count
583 ENSURE_ALLOCATION (xsum (length
, 1));
584 result
[length
] = '\0';
593 maxlen
= allocated
- length
;
598 # define SNPRINTF_BUF(arg) \
599 switch (prefix_count) \
602 retcount = SNPRINTF (result + length, maxlen, buf, \
606 retcount = SNPRINTF (result + length, maxlen, buf, \
607 prefixes[0], arg, &count); \
610 retcount = SNPRINTF (result + length, maxlen, buf, \
611 prefixes[0], prefixes[1], arg, \
618 # define SNPRINTF_BUF(arg) \
619 switch (prefix_count) \
622 count = sprintf (tmp, buf, arg); \
625 count = sprintf (tmp, buf, prefixes[0], arg); \
628 count = sprintf (tmp, buf, prefixes[0], prefixes[1],\
640 int arg
= a
.arg
[dp
->arg_index
].a
.a_schar
;
646 unsigned int arg
= a
.arg
[dp
->arg_index
].a
.a_uchar
;
652 int arg
= a
.arg
[dp
->arg_index
].a
.a_short
;
658 unsigned int arg
= a
.arg
[dp
->arg_index
].a
.a_ushort
;
664 int arg
= a
.arg
[dp
->arg_index
].a
.a_int
;
670 unsigned int arg
= a
.arg
[dp
->arg_index
].a
.a_uint
;
676 long int arg
= a
.arg
[dp
->arg_index
].a
.a_longint
;
682 unsigned long int arg
= a
.arg
[dp
->arg_index
].a
.a_ulongint
;
686 #ifdef HAVE_LONG_LONG
687 case TYPE_LONGLONGINT
:
689 long long int arg
= a
.arg
[dp
->arg_index
].a
.a_longlongint
;
693 case TYPE_ULONGLONGINT
:
695 unsigned long long int arg
= a
.arg
[dp
->arg_index
].a
.a_ulonglongint
;
702 double arg
= a
.arg
[dp
->arg_index
].a
.a_double
;
706 #ifdef HAVE_LONG_DOUBLE
707 case TYPE_LONGDOUBLE
:
709 long double arg
= a
.arg
[dp
->arg_index
].a
.a_longdouble
;
716 int arg
= a
.arg
[dp
->arg_index
].a
.a_char
;
723 wint_t arg
= a
.arg
[dp
->arg_index
].a
.a_wide_char
;
730 const char *arg
= a
.arg
[dp
->arg_index
].a
.a_string
;
735 case TYPE_WIDE_STRING
:
737 const wchar_t *arg
= a
.arg
[dp
->arg_index
].a
.a_wide_string
;
744 void *arg
= a
.arg
[dp
->arg_index
].a
.a_pointer
;
753 /* Portability: Not all implementations of snprintf()
754 are ISO C 99 compliant. Determine the number of
755 bytes that snprintf() has produced or would have
759 /* Verify that snprintf() has NUL-terminated its
761 if (count
< maxlen
&& result
[length
+ count
] != '\0')
763 /* Portability hack. */
764 if (retcount
> count
)
769 /* snprintf() doesn't understand the '%n'
773 /* Don't use the '%n' directive; instead, look
774 at the snprintf() return value. */
780 /* Look at the snprintf() return value. */
783 /* HP-UX 10.20 snprintf() is doubly deficient:
784 It doesn't understand the '%n' directive,
785 *and* it returns -1 (rather than the length
786 that would have been required) when the
787 buffer is too small. */
789 xsum (xtimes (allocated
, 2), 12);
790 ENSURE_ALLOCATION (bigger_need
);
799 /* Attempt to handle failure. */
802 if (!(result
== resultbuf
|| result
== NULL
))
811 if (count
>= tmp_length
)
812 /* tmp_length was incorrectly calculated - fix the
817 /* Make room for the result. */
820 /* Need at least count bytes. But allocate
821 proportionally, to avoid looping eternally if
822 snprintf() reports a too small count. */
824 xmax (xsum (length
, count
), xtimes (allocated
, 2));
826 ENSURE_ALLOCATION (n
);
833 /* The snprintf() result did fit. */
835 /* Append the sprintf() result. */
836 memcpy (result
+ length
, tmp
, count
* sizeof (CHAR_T
));
848 /* Add the final NUL. */
849 ENSURE_ALLOCATION (xsum (length
, 1));
850 result
[length
] = '\0';
852 if (result
!= resultbuf
&& length
+ 1 < allocated
)
854 /* Shrink the allocated memory if possible. */
857 memory
= (CHAR_T
*) realloc (result
, (length
+ 1) * sizeof (CHAR_T
));
868 if (!(result
== resultbuf
|| result
== NULL
))