Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
"new ruby host method"
[simgrid.git] / src / xbt / snprintf.c
1
2 /*
3  * snprintf.c - a portable implementation of snprintf
4  *
5  * AUTHOR
6  *   Mark Martinec <mark.martinec@ijs.si>, April 1999.
7  *
8  *   Copyright 1999, Mark Martinec. All rights reserved.
9  *
10  * TERMS AND CONDITIONS
11  *   This program is free software; you can redistribute it and/or modify
12  *   it under the terms of the "Frontier Artistic License" which comes
13  *   with this Kit.
14  *
15  *   This program is distributed in the hope that it will be useful,
16  *   but WITHOUT ANY WARRANTY; without even the implied warranty
17  *   of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
18  *   See the Frontier Artistic License for more details.
19  *
20  *   You should have received a copy of the Frontier Artistic License
21  *   with this Kit in the file named LICENSE.txt .
22  *   If not, I'll be glad to provide one.
23  *
24  * FEATURES
25  * - careful adherence to specs regarding flags, field width and precision;
26  * - good performance for large string handling (large format, large
27  *   argument or large paddings). Performance is similar to system's sprintf
28  *   and in several cases significantly better (make sure you compile with
29  *   optimizations turned on, tell the compiler the code is strict ANSI
30  *   if necessary to give it more freedom for optimizations);
31  * - return value semantics per ISO/IEC 9899:1999 ("ISO C99");
32  * - written in standard ISO/ANSI C - requires an ANSI C compiler.
33  *
34  * SUPPORTED CONVERSION SPECIFIERS AND DATA TYPES
35  *
36  * This snprintf only supports the following conversion specifiers:
37  * s, c, d, u, o, x, X, p  (and synonyms: i, D, U, O - see below)
38  * with flags: '-', '+', ' ', '0' and '#'.
39  * An asterisk is supported for field width as well as precision.
40  *
41  * Length modifiers 'h' (short int), 'l' (long int),
42  * and 'll' (long long int) are supported.
43  * NOTE:
44  *   If macro SNPRINTF_LONGLONG_SUPPORT is not defined (default) the
45  *   length modifier 'll' is recognized but treated the same as 'l',
46  *   which may cause argument value truncation! Defining
47  *   SNPRINTF_LONGLONG_SUPPORT requires that your system's sprintf also
48  *   handles length modifier 'll'.  long long int is a language extension
49  *   which may not be portable.
50  *
51  * Conversion of numeric data (conversion specifiers d, u, o, x, X, p)
52  * with length modifiers (none or h, l, ll) is left to the system routine
53  * sprintf, but all handling of flags, field width and precision as well as
54  * c and s conversions is done very carefully by this portable routine.
55  * If a string precision (truncation) is specified (e.g. %.8s) it is
56  * guaranteed the string beyond the specified precision will not be referenced.
57  *
58  * Length modifiers h, l and ll are ignored for c and s conversions (data
59  * types wint_t and wchar_t are not supported).
60  *
61  * The following common synonyms for conversion characters are supported:
62  *   - i is a synonym for d
63  *   - D is a synonym for ld, explicit length modifiers are ignored
64  *   - U is a synonym for lu, explicit length modifiers are ignored
65  *   - O is a synonym for lo, explicit length modifiers are ignored
66  * The D, O and U conversion characters are nonstandard, they are supported
67  * for backward compatibility only, and should not be used for new code.
68  *
69  * The following is specifically NOT supported:
70  *   - flag ' (thousands' grouping character) is recognized but ignored
71  *   - numeric conversion specifiers: f, e, E, g, G and synonym F,
72  *     as well as the new a and A conversion specifiers
73  *   - length modifier 'L' (long double) and 'q' (quad - use 'll' instead)
74  *   - wide character/string conversions: lc, ls, and nonstandard
75  *     synonyms C and S
76  *   - writeback of converted string length: conversion character n
77  *   - the n$ specification for direct reference to n-th argument
78  *   - locales
79  *
80  * It is permitted for str_m to be zero, and it is permitted to specify NULL
81  * pointer for resulting string argument if str_m is zero (as per ISO C99).
82  *
83  * The return value is the number of characters which would be generated
84  * for the given input, excluding the trailing null. If this value
85  * is greater or equal to str_m, not all characters from the result
86  * have been stored in str, output bytes beyond the (str_m-1) -th character
87  * are discarded. If str_m is greater than zero it is guaranteed
88  * the resulting string will be null-terminated.
89  *
90  * NOTE that this matches the ISO C99, OpenBSD, and GNU C library 2.1,
91  * but is different from some older and vendor implementations,
92  * and is also different from XPG, XSH5, SUSv2 specifications.
93  * For historical discussion on changes in the semantics and standards
94  * of snprintf see printf(3) man page in the Linux programmers manual.
95  *
96  * Routines asprintf and vasprintf return a pointer (in the ptr argument)
97  * to a buffer sufficiently large to hold the resulting string. This pointer
98  * should be passed to free(3) to release the allocated storage when it is
99  * no longer needed. If sufficient space cannot be allocated, these functions
100  * will return -1 and set ptr to be a NULL pointer. These two routines are a
101  * GNU C library extensions (glibc).
102  *
103  * Routines asnprintf and vasnprintf are similar to asprintf and vasprintf,
104  * yet, like snprintf and vsnprintf counterparts, will write at most str_m-1
105  * characters into the allocated output string, the last character in the
106  * allocated buffer then gets the terminating null. If the formatted string
107  * length (the return value) is greater than or equal to the str_m argument,
108  * the resulting string was truncated and some of the formatted characters
109  * were discarded. These routines present a handy way to limit the amount
110  * of allocated memory to some sane value.
111  *
112  * AVAILABILITY
113  *   http://www.ijs.si/software/snprintf/
114  *
115  * REVISION HISTORY
116  * 1999-04      V0.9  Mark Martinec
117  *              - initial version, some modifications after comparing printf
118  *                man pages for Digital Unix 4.0, Solaris 2.6 and HPUX 10,
119  *                and checking how Perl handles sprintf (differently!);
120  * 1999-04-09   V1.0  Mark Martinec <mark.martinec@ijs.si>
121  *              - added main test program, fixed remaining inconsistencies,
122  *                added optional (long long int) support;
123  * 1999-04-12   V1.1  Mark Martinec <mark.martinec@ijs.si>
124  *              - support the 'p' conversion (pointer to void);
125  *              - if a string precision is specified
126  *                make sure the string beyond the specified precision
127  *                will not be referenced (e.g. by strlen);
128  * 1999-04-13   V1.2  Mark Martinec <mark.martinec@ijs.si>
129  *              - support synonyms %D=%ld, %U=%lu, %O=%lo;
130  *              - speed up the case of long format string with few conversions;
131  * 1999-06-30   V1.3  Mark Martinec <mark.martinec@ijs.si>
132  *              - fixed runaway loop (eventually crashing when str_l wraps
133  *                beyond 2^31) while copying format string without
134  *                conversion specifiers to a buffer that is too short
135  *                (thanks to Edwin Young <edwiny@autonomy.com> for
136  *                spotting the problem);
137  *              - added macros PORTABLE_SNPRINTF_VERSION_(MAJOR|MINOR)
138  *                to snprintf.h
139  * 2000-02-14   V2.0 (never released) Mark Martinec <mark.martinec@ijs.si>
140  *              - relaxed license terms: The Artistic License now applies.
141  *                You may still apply the GNU GENERAL PUBLIC LICENSE
142  *                as was distributed with previous versions, if you prefer;
143  *              - changed REVISION HISTORY dates to use ISO 8601 date format;
144  *              - added vsnprintf (patch also independently proposed by
145  *                Caolan McNamara 2000-05-04, and Keith M Willenson 2000-06-01)
146  * 2000-06-27   V2.1  Mark Martinec <mark.martinec@ijs.si>
147  *              - removed POSIX check for str_m<1; value 0 for str_m is
148  *                allowed by ISO C99 (and GNU C library 2.1) - (pointed out
149  *                on 2000-05-04 by Caolan McNamara, caolan@ csn dot ul dot ie).
150  *                Besides relaxed license this change in standards adherence
151  *                is the main reason to bump up the major version number;
152  *              - added nonstandard routines asnprintf, vasnprintf, asprintf,
153  *                vasprintf that dynamically allocate storage for the
154  *                resulting string; these routines are not compiled by default,
155  *                see comments where NEED_V?ASN?PRINTF macros are defined;
156  *              - autoconf contributed by Caolan McNamara
157  * 2000-10-06   V2.2  Mark Martinec <mark.martinec@ijs.si>
158  *              - BUG FIX: the %c conversion used a temporary variable
159  *                that was no longer in scope when referenced,
160  *                possibly causing incorrect resulting character;
161  *              - BUG FIX: make precision and minimal field width unsigned
162  *                to handle huge values (2^31 <= n < 2^32) correctly;
163  *                also be more careful in the use of signed/unsigned/size_t
164  *                internal variables - probably more careful than many
165  *                vendor implementations, but there may still be a case
166  *                where huge values of str_m, precision or minimal field
167  *                could cause incorrect behaviour;
168  *              - use separate variables for signed/unsigned arguments,
169  *                and for short/int, long, and long long argument lengths
170  *                to avoid possible incompatibilities on certain
171  *                computer architectures. Also use separate variable
172  *                arg_sign to hold sign of a numeric argument,
173  *                to make code more transparent;
174  *              - some fiddling with zero padding and "0x" to make it
175  *                Linux compatible;
176  *              - systematically use macros fast_memcpy and fast_memset
177  *                instead of case-by-case hand optimization; determine some
178  *                breakeven string lengths for different architectures;
179  *              - terminology change: 'format' -> 'conversion specifier',
180  *                'C9x' -> 'ISO/IEC 9899:1999 ("ISO C99")',
181  *                'alternative form' -> 'alternate form',
182  *                'data type modifier' -> 'length modifier';
183  *              - several comments rephrased and new ones added;
184  *              - make compiler not complain about 'credits' defined but
185  *                not used;
186  */
187
188
189 /* Define HAVE_SNPRINTF if your system already has snprintf and vsnprintf.
190  *
191  * If HAVE_SNPRINTF is defined this module will not produce code for
192  * snprintf and vsnprintf, unless PREFER_PORTABLE_SNPRINTF is defined as well,
193  * causing this portable version of snprintf to be called portable_snprintf
194  * (and portable_vsnprintf).
195  */
196 /* #define HAVE_SNPRINTF */
197
198 /* Define PREFER_PORTABLE_SNPRINTF if your system does have snprintf and
199  * vsnprintf but you would prefer to use the portable routine(s) instead.
200  * In this case the portable routine is declared as portable_snprintf
201  * (and portable_vsnprintf) and a macro 'snprintf' (and 'vsnprintf')
202  * is defined to expand to 'portable_v?snprintf' - see file snprintf.h .
203  * Defining this macro is only useful if HAVE_SNPRINTF is also defined,
204  * but does does no harm if defined nevertheless.
205  */
206 /* #define PREFER_PORTABLE_SNPRINTF */
207
208 /* Define SNPRINTF_LONGLONG_SUPPORT if you want to support
209  * data type (long long int) and length modifier 'll' (e.g. %lld).
210  * If undefined, 'll' is recognized but treated as a single 'l'.
211  *
212  * If the system's sprintf does not handle 'll'
213  * the SNPRINTF_LONGLONG_SUPPORT must not be defined!
214  *
215  * This is off by default as (long long int) is a language extension.
216  */
217 /* #define SNPRINTF_LONGLONG_SUPPORT */
218
219 /* Define NEED_SNPRINTF_ONLY if you only need snprintf, and not vsnprintf.
220  * If NEED_SNPRINTF_ONLY is defined, the snprintf will be defined directly,
221  * otherwise both snprintf and vsnprintf routines will be defined
222  * and snprintf will be a simple wrapper around vsnprintf, at the expense
223  * of an extra procedure call.
224  */
225 /* #define NEED_SNPRINTF_ONLY */
226
227 /* Define NEED_V?ASN?PRINTF macros if you need library extension
228  * routines asprintf, vasprintf, asnprintf, vasnprintf respectively,
229  * and your system library does not provide them. They are all small
230  * wrapper routines around portable_vsnprintf. Defining any of the four
231  * NEED_V?ASN?PRINTF macros automatically turns off NEED_SNPRINTF_ONLY
232  * and turns on PREFER_PORTABLE_SNPRINTF.
233  *
234  * Watch for name conflicts with the system library if these routines
235  * are already present there.
236  *
237  * NOTE: vasprintf and vasnprintf routines need va_copy() from stdarg.h, as
238  * specified by C99, to be able to traverse the same list of arguments twice.
239  * I don't know of any other standard and portable way of achieving the same.
240  * With some versions of gcc you may use __va_copy(). You might even get away
241  * with "ap2 = ap", in this case you must not call va_end(ap2) !
242  *   #define va_copy(ap2,ap) ap2 = ap
243  */
244 /* #define NEED_ASPRINTF   */
245 /* #define NEED_ASNPRINTF  */
246 /* #define NEED_VASPRINTF  */
247 /* #define NEED_VASNPRINTF */
248
249
250 /* Define the following macros if desired:
251  *   SOLARIS_COMPATIBLE, SOLARIS_BUG_COMPATIBLE,
252  *   HPUX_COMPATIBLE, HPUX_BUG_COMPATIBLE, LINUX_COMPATIBLE,
253  *   DIGITAL_UNIX_COMPATIBLE, DIGITAL_UNIX_BUG_COMPATIBLE,
254  *   PERL_COMPATIBLE, PERL_BUG_COMPATIBLE,
255  *
256  * - For portable applications it is best not to rely on peculiarities
257  *   of a given implementation so it may be best not to define any
258  *   of the macros that select compatibility and to avoid features
259  *   that vary among the systems.
260  *
261  * - Selecting compatibility with more than one operating system
262  *   is not strictly forbidden but is not recommended.
263  *
264  * - 'x'_BUG_COMPATIBLE implies 'x'_COMPATIBLE .
265  *
266  * - 'x'_COMPATIBLE refers to (and enables) a behaviour that is
267  *   documented in a sprintf man page on a given operating system
268  *   and actually adhered to by the system's sprintf (but not on
269  *   most other operating systems). It may also refer to and enable
270  *   a behaviour that is declared 'undefined' or 'implementation specific'
271  *   in the man page but a given implementation behaves predictably
272  *   in a certain way.
273  *
274  * - 'x'_BUG_COMPATIBLE refers to (and enables) a behaviour of system's sprintf
275  *   that contradicts the sprintf man page on the same operating system.
276  *
277  * - I do not claim that the 'x'_COMPATIBLE and 'x'_BUG_COMPATIBLE
278  *   conditionals take into account all idiosyncrasies of a particular
279  *   implementation, there may be other incompatibilities.
280  */
281
282
283 /* ============================================= */
284 /* NO USER SERVICABLE PARTS FOLLOWING THIS POINT */
285 /* ============================================= */
286
287 #define PORTABLE_SNPRINTF_VERSION_MAJOR 2
288 #define PORTABLE_SNPRINTF_VERSION_MINOR 2
289
290 #if defined(NEED_ASPRINTF) || defined(NEED_ASNPRINTF) || defined(NEED_VASPRINTF) || defined(NEED_VASNPRINTF)
291 # if defined(NEED_SNPRINTF_ONLY)
292 # undef NEED_SNPRINTF_ONLY
293 # endif
294 # if !defined(PREFER_PORTABLE_SNPRINTF)
295 # define PREFER_PORTABLE_SNPRINTF
296 # endif
297 #endif
298
299 #if defined(SOLARIS_BUG_COMPATIBLE) && !defined(SOLARIS_COMPATIBLE)
300 #define SOLARIS_COMPATIBLE
301 #endif
302
303 #if defined(HPUX_BUG_COMPATIBLE) && !defined(HPUX_COMPATIBLE)
304 #define HPUX_COMPATIBLE
305 #endif
306
307 #if defined(DIGITAL_UNIX_BUG_COMPATIBLE) && !defined(DIGITAL_UNIX_COMPATIBLE)
308 #define DIGITAL_UNIX_COMPATIBLE
309 #endif
310
311 #if defined(PERL_BUG_COMPATIBLE) && !defined(PERL_COMPATIBLE)
312 #define PERL_COMPATIBLE
313 #endif
314
315 #if defined(LINUX_BUG_COMPATIBLE) && !defined(LINUX_COMPATIBLE)
316 #define LINUX_COMPATIBLE
317 #endif
318
319 #include "portable.h"           /* to get a working stdarg.h */
320
321 #include <sys/types.h>
322 #include <string.h>
323 #include <stdlib.h>
324 #include <stdio.h>
325 #include <stdarg.h>
326
327 #include <assert.h>
328 #include <errno.h>
329 #include "xbt/str.h"
330
331 #ifdef isdigit
332 #undef isdigit
333 #endif
334 #define isdigit(c) ((c) >= '0' && (c) <= '9')
335
336 /* For copying strings longer or equal to 'breakeven_point'
337  * it is more efficient to call memcpy() than to do it inline.
338  * The value depends mostly on the processor architecture,
339  * but also on the compiler and its optimization capabilities.
340  * The value is not critical, some small value greater than zero
341  * will be just fine if you don't care to squeeze every drop
342  * of performance out of the code.
343  *
344  * Small values favor memcpy, large values favor inline code.
345  */
346 #if defined(__alpha__) || defined(__alpha)
347 #  define breakeven_point   2   /* AXP (DEC Alpha)     - gcc or cc or egcs */
348 #endif
349 #if defined(__i386__)  || defined(__i386)
350 #  define breakeven_point  12   /* Intel Pentium/Linux - gcc 2.96 */
351 #endif
352 #if defined(__hppa)
353 #  define breakeven_point  10   /* HP-PA               - gcc */
354 #endif
355 #if defined(__sparc__) || defined(__sparc)
356 #  define breakeven_point  33   /* Sun Sparc 5         - gcc 2.8.1 */
357 #endif
358
359 /* some other values of possible interest: */
360                                                                                                                                                                                                                                                                                                                                   /* #define breakeven_point  8 *//* VAX 4000          - vaxc */
361                                                                                                                                                                                                                                                                                                                                   /* #define breakeven_point 19 *//* VAX 4000          - gcc 2.7.0 */
362
363 #ifndef breakeven_point
364 #  define breakeven_point   6   /* some reasonable one-size-fits-all value */
365 #endif
366
367 #define fast_memcpy(d,s,n) \
368   { register size_t nn = (size_t)(n); \
369   if (nn >= breakeven_point) memcpy((d), (s), nn); \
370   else if (nn > 0) { /* proc call overhead is worth only for large strings*/\
371   register char *dd; register const char *ss; \
372   for (ss=(s), dd=(d); nn>0; nn--) *dd++ = *ss++; } }
373
374 #define fast_memset(d,c,n) \
375   { register size_t nn = (size_t)(n); \
376   if (nn >= breakeven_point) memset((d), (int)(c), nn); \
377   else if (nn > 0) { /* proc call overhead is worth only for large strings*/\
378   register char *dd; register const int cc=(int)(c); \
379   for (dd=(d); nn>0; nn--) *dd++ = cc; } }
380
381 /* prototypes */
382
383
384 #if defined(NEED_ASPRINTF)
385 int asprintf(char **ptr, const char *fmt, /*args */ ...);
386 #endif
387 #if defined(NEED_VASPRINTF)
388 int vasprintf(char **ptr, const char *fmt, va_list ap);
389 #endif
390
391 #if defined(NEED_ASNPRINTF)
392 int asnprintf(char **ptr, size_t str_m, const char *fmt, /*args */ ...);
393 #endif
394 #if defined(NEED_VASNPRINTF)
395 int vasnprintf(char **ptr, size_t str_m, const char *fmt, va_list ap);
396 #endif
397
398 #if defined(HAVE_SNPRINTF)
399 /* declare our portable snprintf  routine under name portable_snprintf  */
400 /* declare our portable vsnprintf routine under name portable_vsnprintf */
401 #  if defined(_MSC_VER) && (_MSC_VER >= 1400)
402 #    define portable_snprintf  _snprintf
403 #    define portable_vsnprintf  vsnprintf
404 #  else
405 #    define portable_snprintf  snprintf
406 #    define portable_vsnprintf vsnprintf
407 #  endif
408 #else
409 /* declare our portable routines under names snprintf and vsnprintf */
410 #define portable_snprintf snprintf
411 #if !defined(NEED_SNPRINTF_ONLY)
412 #define portable_vsnprintf vsnprintf
413 #endif
414 #endif
415
416 #if !defined(HAVE_SNPRINTF) || defined(PREFER_PORTABLE_SNPRINTF)
417 int portable_snprintf(char *str, size_t str_m, const char *fmt, /*args */
418                       ...);
419 #if !defined(NEED_SNPRINTF_ONLY)
420 int portable_vsnprintf(char *str, size_t str_m, const char *fmt, va_list ap);
421 #endif
422 #endif
423
424 /* declarations */
425
426 static char credits[] = "\n\
427   @(#)snprintf.c, v2.2: Mark Martinec, <mark.martinec@ijs.si>\n\
428   @(#)snprintf.c, v2.2: Copyright 1999, Mark Martinec. Frontier Artistic License applies.\n\
429   @(#)snprintf.c, v2.2: http://www.ijs.si/software/snprintf/\n";
430
431 static void __foo__(void)
432 {
433   printf("%s", credits);
434   __foo__();
435 }
436
437 #if defined(NEED_ASPRINTF)
438 int asprintf(char **ptr, const char *fmt, /*args */ ...)
439 {
440   va_list ap;
441   size_t str_m;
442   int str_l;
443
444   *ptr = NULL;
445   va_start(ap, fmt);            /* measure the required size */
446   str_l = portable_vsnprintf(NULL, (size_t) 0, fmt, ap);
447   va_end(ap);
448   assert(str_l >= 0);           /* possible integer overflow if str_m > INT_MAX */
449   *ptr = (char *) malloc(str_m = (size_t) str_l + 1);
450   if (*ptr == NULL) {
451     errno = ENOMEM;
452     str_l = -1;
453   } else {
454     int str_l2;
455     va_start(ap, fmt);
456     str_l2 = portable_vsnprintf(*ptr, str_m, fmt, ap);
457     va_end(ap);
458     assert(str_l2 == str_l);
459   }
460   return str_l;
461 }
462 #endif
463
464 #if defined(NEED_VASPRINTF)
465 int vasprintf(char **ptr, const char *fmt, va_list ap)
466 {
467   size_t str_m;
468   int str_l;
469
470   *ptr = NULL;
471   {
472     va_list ap2;
473     va_copy(ap2, ap);           /* don't consume the original ap, we'll need it again */
474     str_l = portable_vsnprintf(NULL, (size_t) 0, fmt, ap2);     /*get required size */
475     va_end(ap2);
476   }
477   assert(str_l >= 0);           /* possible integer overflow if str_m > INT_MAX */
478   *ptr = (char *) malloc(str_m = (size_t) str_l + 1);
479   if (*ptr == NULL) {
480     errno = ENOMEM;
481     str_l = -1;
482   } else {
483     int str_l2 = portable_vsnprintf(*ptr, str_m, fmt, ap);
484     assert(str_l2 == str_l);
485   }
486   return str_l;
487 }
488 #endif
489
490 #if defined(NEED_ASNPRINTF)
491 int asnprintf(char **ptr, size_t str_m, const char *fmt, /*args */ ...)
492 {
493   va_list ap;
494   int str_l;
495
496   *ptr = NULL;
497   va_start(ap, fmt);            /* measure the required size */
498   str_l = portable_vsnprintf(NULL, (size_t) 0, fmt, ap);
499   va_end(ap);
500   assert(str_l >= 0);           /* possible integer overflow if str_m > INT_MAX */
501   if ((size_t) str_l + 1 < str_m)
502     str_m = (size_t) str_l + 1; /* truncate */
503   /* if str_m is 0, no buffer is allocated, just set *ptr to NULL */
504   if (str_m == 0) {             /* not interested in resulting string, just return size */
505   } else {
506     *ptr = (char *) malloc(str_m);
507     if (*ptr == NULL) {
508       errno = ENOMEM;
509       str_l = -1;
510     } else {
511       int str_l2;
512       va_start(ap, fmt);
513       str_l2 = portable_vsnprintf(*ptr, str_m, fmt, ap);
514       va_end(ap);
515       assert(str_l2 == str_l);
516     }
517   }
518   return str_l;
519 }
520 #endif
521
522 #if defined(NEED_VASNPRINTF)
523 int vasnprintf(char **ptr, size_t str_m, const char *fmt, va_list ap)
524 {
525   int str_l;
526
527   *ptr = NULL;
528   {
529     va_list ap2;
530     va_copy(ap2, ap);           /* don't consume the original ap, we'll need it again */
531     str_l = portable_vsnprintf(NULL, (size_t) 0, fmt, ap2);     /*get required size */
532     va_end(ap2);
533   }
534   assert(str_l >= 0);           /* possible integer overflow if str_m > INT_MAX */
535   if ((size_t) str_l + 1 < str_m)
536     str_m = (size_t) str_l + 1; /* truncate */
537   /* if str_m is 0, no buffer is allocated, just set *ptr to NULL */
538   if (str_m == 0) {             /* not interested in resulting string, just return size */
539   } else {
540     *ptr = (char *) malloc(str_m);
541     if (*ptr == NULL) {
542       errno = ENOMEM;
543       str_l = -1;
544     } else {
545       int str_l2 = portable_vsnprintf(*ptr, str_m, fmt, ap);
546       assert(str_l2 == str_l);
547     }
548   }
549   return str_l;
550 }
551 #endif
552
553 /*
554  * If the system does have snprintf and the portable routine is not
555  * specifically required, this module produces no code for snprintf/vsnprintf.
556  */
557 #if !defined(HAVE_SNPRINTF) || defined(PREFER_PORTABLE_SNPRINTF)
558
559 #if !defined(NEED_SNPRINTF_ONLY)
560 int portable_snprintf(char *str, size_t str_m, const char *fmt, /*args */ ...)
561 {
562   va_list ap;
563   int str_l;
564
565   va_start(ap, fmt);
566   str_l = portable_vsnprintf(str, str_m, fmt, ap);
567   va_end(ap);
568   return str_l;
569 }
570 #endif
571
572 #if defined(NEED_SNPRINTF_ONLY)
573 int portable_snprintf(char *str, size_t str_m, const char *fmt, /*args */ ...)
574 {
575 #else
576 int portable_vsnprintf(char *str, size_t str_m, const char *fmt, va_list ap)
577 {
578 #endif
579
580 #if defined(NEED_SNPRINTF_ONLY)
581   va_list ap;
582 #endif
583   size_t str_l = 0;
584   const char *p = fmt;
585
586   /* In contrast with POSIX, the ISO C99 now says
587    * that str can be NULL and str_m can be 0.
588    * This is more useful than the old:  if (str_m < 1) return -1; */
589
590 #if defined(NEED_SNPRINTF_ONLY)
591   va_start(ap, fmt);
592 #endif
593   if (!p)
594     p = "";
595   while (*p) {
596     if (*p != '%') {
597       /* if (str_l < str_m) str[str_l++] = *p++;    -- this would be sufficient */
598       /* but the following code achieves better performance for cases
599        * where format string is long and contains few conversions */
600       const char *q = strchr(p + 1, '%');
601       size_t n = !q ? strlen(p) : (q - p);
602       if (str_l < str_m) {
603         size_t avail = str_m - str_l;
604         fast_memcpy(str + str_l, p, (n > avail ? avail : n));
605       }
606       p += n;
607       str_l += n;
608     } else {
609       const char *starting_p;
610       size_t min_field_width = 0, precision = 0;
611       int zero_padding = 0, precision_specified = 0, justify_left = 0;
612       int alternate_form = 0, force_sign = 0;
613       int space_for_positive = 1;       /* If both the ' ' and '+' flags appear,
614                                            the ' ' flag should be ignored. */
615       char length_modifier = '\0';      /* allowed values: \0, h, l, L */
616       char tmp[32];             /* temporary buffer for simple numeric->string conversion */
617
618       const char *str_arg;      /* string address in case of string argument */
619       size_t str_arg_l;         /* natural field width of arg without padding
620                                    and sign */
621       unsigned char uchar_arg;
622       /* unsigned char argument value - only defined for c conversion.
623          N.B. standard explicitly states the char argument for
624          the c conversion is unsigned */
625
626       size_t number_of_zeros_to_pad = 0;
627       /* number of zeros to be inserted for numeric conversions
628          as required by the precision or minimal field width */
629
630       size_t zero_padding_insertion_ind = 0;
631       /* index into tmp where zero padding is to be inserted */
632
633       char fmt_spec = '\0';
634       /* current conversion specifier character */
635
636       str_arg = credits;        /* just to make compiler happy (defined but not used) */
637       str_arg = NULL;
638       starting_p = p;
639       p++;                      /* skip '%' */
640       /* parse flags */
641       while (*p == '0' || *p == '-' || *p == '+' ||
642              *p == ' ' || *p == '#' || *p == '\'') {
643         switch (*p) {
644         case '0':
645           zero_padding = 1;
646           break;
647         case '-':
648           justify_left = 1;
649           break;
650         case '+':
651           force_sign = 1;
652           space_for_positive = 0;
653           break;
654         case ' ':
655           force_sign = 1;
656           /* If both the ' ' and '+' flags appear, the ' ' flag should be ignored */
657 #ifdef PERL_COMPATIBLE
658           /* ... but in Perl the last of ' ' and '+' applies */
659           space_for_positive = 1;
660 #endif
661           break;
662         case '#':
663           alternate_form = 1;
664           break;
665         case '\'':
666           break;
667         }
668         p++;
669       }
670       /* If the '0' and '-' flags both appear, the '0' flag should be ignored. */
671
672       /* parse field width */
673       if (*p == '*') {
674         int j;
675         p++;
676         j = va_arg(ap, int);
677         if (j >= 0)
678           min_field_width = j;
679         else {
680           min_field_width = -j;
681           justify_left = 1;
682         }
683       } else if (isdigit((int) (*p))) {
684         /* size_t could be wider than unsigned int;
685            make sure we treat argument like common implementations do */
686         unsigned int uj = *p++ - '0';
687         while (isdigit((int) (*p)))
688           uj = 10 * uj + (unsigned int) (*p++ - '0');
689         min_field_width = uj;
690       }
691       /* parse precision */
692       if (*p == '.') {
693         p++;
694         precision_specified = 1;
695         if (*p == '*') {
696           int j = va_arg(ap, int);
697           p++;
698           if (j >= 0)
699             precision = j;
700           else {
701             precision_specified = 0;
702             precision = 0;
703             /* NOTE:
704              *   Solaris 2.6 man page claims that in this case the precision
705              *   should be set to 0.  Digital Unix 4.0, HPUX 10 and BSD man page
706              *   claim that this case should be treated as unspecified precision,
707              *   which is what we do here.
708              */
709           }
710         } else if (isdigit((int) (*p))) {
711           /* size_t could be wider than unsigned int;
712              make sure we treat argument like common implementations do */
713           unsigned int uj = *p++ - '0';
714           while (isdigit((int) (*p)))
715             uj = 10 * uj + (unsigned int) (*p++ - '0');
716           precision = uj;
717         }
718       }
719       /* parse 'h', 'l' and 'll' length modifiers */
720       if (*p == 'h' || *p == 'l') {
721         length_modifier = *p;
722         p++;
723         if (length_modifier == 'l' && *p == 'l') {      /* double l = long long */
724 #ifdef SNPRINTF_LONGLONG_SUPPORT
725           length_modifier = '2';        /* double l encoded as '2' */
726 #else
727           length_modifier = 'l';        /* treat it as a single 'l' */
728 #endif
729           p++;
730         }
731       }
732       fmt_spec = *p;
733       /* common synonyms: */
734       switch (fmt_spec) {
735       case 'i':
736         fmt_spec = 'd';
737         break;
738       case 'D':
739         fmt_spec = 'd';
740         length_modifier = 'l';
741         break;
742       case 'U':
743         fmt_spec = 'u';
744         length_modifier = 'l';
745         break;
746       case 'O':
747         fmt_spec = 'o';
748         length_modifier = 'l';
749         break;
750       default:
751         break;
752       }
753       /* get parameter value, do initial processing */
754       switch (fmt_spec) {
755       case '%':                /* % behaves similar to 's' regarding flags and field widths */
756       case 'c':                /* c behaves similar to 's' regarding flags and field widths */
757       case 's':
758         length_modifier = '\0'; /* wint_t and wchar_t not supported */
759         /* the result of zero padding flag with non-numeric conversion specifier */
760         /* is undefined. Solaris and HPUX 10 does zero padding in this case,    */
761         /* Digital Unix and Linux does not. */
762 #if !defined(SOLARIS_COMPATIBLE) && !defined(HPUX_COMPATIBLE)
763         zero_padding = 0;       /* turn zero padding off for string conversions */
764 #endif
765         str_arg_l = 1;
766         switch (fmt_spec) {
767         case '%':
768           str_arg = p;
769           break;
770         case 'c':{
771             int j = va_arg(ap, int);
772             uchar_arg = (unsigned char) j;      /* standard demands unsigned char */
773             str_arg = (const char *) &uchar_arg;
774             break;
775           }
776         case 's':
777           str_arg = va_arg(ap, const char *);
778           if (!str_arg)
779             str_arg_l = 0;
780           /* make sure not to address string beyond the specified precision !!! */
781           else if (!precision_specified)
782             str_arg_l = strlen(str_arg);
783           /* truncate string if necessary as requested by precision */
784           else if (precision == 0)
785             str_arg_l = 0;
786           else {
787             /* memchr on HP does not like n > 2^31  !!! */
788             char *q = (char *) memchr(str_arg, '\0',
789                                       precision <=
790                                       0x7fffffff ? precision : 0x7fffffff);
791             str_arg_l = !q ? precision : (q - str_arg);
792           }
793           break;
794         default:
795           break;
796         }
797         break;
798       case 'd':
799       case 'u':
800       case 'o':
801       case 'x':
802       case 'X':
803       case 'p':{
804           /* NOTE: the u, o, x, X and p conversion specifiers imply
805              the value is unsigned;  d implies a signed value */
806
807           int arg_sign = 0;
808           /* 0 if numeric argument is zero (or if pointer is NULL for 'p'),
809              +1 if greater than zero (or nonzero for unsigned arguments),
810              -1 if negative (unsigned argument is never negative) */
811
812           int int_arg = 0;
813           unsigned int uint_arg = 0;
814           /* only defined for length modifier h, or for no length modifiers */
815
816           long int long_arg = 0;
817           unsigned long int ulong_arg = 0;
818           /* only defined for length modifier l */
819
820           void *ptr_arg = NULL;
821           /* pointer argument value -only defined for p conversion */
822
823 #ifdef SNPRINTF_LONGLONG_SUPPORT
824           long long int long_long_arg = 0;
825           unsigned long long int ulong_long_arg = 0;
826           /* only defined for length modifier ll */
827 #endif
828           if (fmt_spec == 'p') {
829             /* HPUX 10: An l, h, ll or L before any other conversion character
830              *   (other than d, i, u, o, x, or X) is ignored.
831              * Digital Unix:
832              *   not specified, but seems to behave as HPUX does.
833              * Solaris: If an h, l, or L appears before any other conversion
834              *   specifier (other than d, i, u, o, x, or X), the behavior
835              *   is undefined. (Actually %hp converts only 16-bits of address
836              *   and %llp treats address as 64-bit data which is incompatible
837              *   with (void *) argument on a 32-bit system).
838              */
839 #ifdef SOLARIS_COMPATIBLE
840 #  ifdef SOLARIS_BUG_COMPATIBLE
841             /* keep length modifiers even if it represents 'll' */
842 #  else
843             if (length_modifier == '2')
844               length_modifier = '\0';
845 #  endif
846 #else
847             length_modifier = '\0';
848 #endif
849             ptr_arg = va_arg(ap, void *);
850             if (ptr_arg != NULL)
851               arg_sign = 1;
852           } else if (fmt_spec == 'd') { /* signed */
853             switch (length_modifier) {
854             case '\0':
855             case 'h':
856               /* It is non-portable to specify a second argument of char or short
857                * to va_arg, because arguments seen by the called function
858                * are not char or short.  C converts char and short arguments
859                * to int before passing them to a function.
860                */
861               int_arg = va_arg(ap, int);
862               if (int_arg > 0)
863                 arg_sign = 1;
864               else if (int_arg < 0)
865                 arg_sign = -1;
866               break;
867             case 'l':
868               long_arg = va_arg(ap, long int);
869               if (long_arg > 0)
870                 arg_sign = 1;
871               else if (long_arg < 0)
872                 arg_sign = -1;
873               break;
874 #ifdef SNPRINTF_LONGLONG_SUPPORT
875             case '2':
876               long_long_arg = va_arg(ap, long long int);
877               if (long_long_arg > 0)
878                 arg_sign = 1;
879               else if (long_long_arg < 0)
880                 arg_sign = -1;
881               break;
882 #endif
883             }
884           } else {              /* unsigned */
885             switch (length_modifier) {
886             case '\0':
887             case 'h':
888               uint_arg = va_arg(ap, unsigned int);
889               if (uint_arg)
890                 arg_sign = 1;
891               break;
892             case 'l':
893               ulong_arg = va_arg(ap, unsigned long int);
894               if (ulong_arg)
895                 arg_sign = 1;
896               break;
897 #ifdef SNPRINTF_LONGLONG_SUPPORT
898             case '2':
899               ulong_long_arg = va_arg(ap, unsigned long long int);
900               if (ulong_long_arg)
901                 arg_sign = 1;
902               break;
903 #endif
904             }
905           }
906           str_arg = tmp;
907           str_arg_l = 0;
908           /* NOTE:
909            *   For d, i, u, o, x, and X conversions, if precision is specified,
910            *   the '0' flag should be ignored. This is so with Solaris 2.6,
911            *   Digital UNIX 4.0, HPUX 10, Linux, FreeBSD, NetBSD; but not with Perl.
912            */
913 #ifndef PERL_COMPATIBLE
914           if (precision_specified)
915             zero_padding = 0;
916 #endif
917           if (fmt_spec == 'd') {
918             if (force_sign && arg_sign >= 0)
919               tmp[str_arg_l++] = space_for_positive ? ' ' : '+';
920             /* leave negative numbers for sprintf to handle,
921                to avoid handling tricky cases like (short int)(-32768) */
922 #ifdef LINUX_COMPATIBLE
923           } else if (fmt_spec == 'p' && force_sign && arg_sign > 0) {
924             tmp[str_arg_l++] = space_for_positive ? ' ' : '+';
925 #endif
926           } else if (alternate_form) {
927             if (arg_sign != 0 && (fmt_spec == 'x' || fmt_spec == 'X')) {
928               tmp[str_arg_l++] = '0';
929               tmp[str_arg_l++] = fmt_spec;
930             }
931             /* alternate form should have no effect for p conversion, but ... */
932 #ifdef HPUX_COMPATIBLE
933             else if (fmt_spec == 'p'
934                      /* HPUX 10: for an alternate form of p conversion,
935                       *          a nonzero result is prefixed by 0x. */
936 #ifndef HPUX_BUG_COMPATIBLE
937                      /* Actually it uses 0x prefix even for a zero value. */
938                      && arg_sign != 0
939 #endif
940               ) {
941               tmp[str_arg_l++] = '0';
942               tmp[str_arg_l++] = 'x';
943             }
944 #endif
945           }
946           zero_padding_insertion_ind = str_arg_l;
947           if (!precision_specified)
948             precision = 1;      /* default precision is 1 */
949           if (precision == 0 && arg_sign == 0
950 #if defined(HPUX_BUG_COMPATIBLE) || defined(LINUX_COMPATIBLE)
951               && fmt_spec != 'p'
952               /* HPUX 10 man page claims: With conversion character p the result of
953                * converting a zero value with a precision of zero is a null string.
954                * Actually HP returns all zeroes, and Linux returns "(nil)". */
955 #endif
956             ) {
957             /* converted to null string */
958             /* When zero value is formatted with an explicit precision 0,
959                the resulting formatted string is empty (d, i, u, o, x, X, p).   */
960           } else {
961             char f[5];
962             int f_l = 0;
963             f[f_l++] = '%';     /* construct a simple format string for sprintf */
964             if (!length_modifier) {
965             } else if (length_modifier == '2') {
966               f[f_l++] = 'l';
967               f[f_l++] = 'l';
968             } else
969               f[f_l++] = length_modifier;
970             f[f_l++] = fmt_spec;
971             f[f_l++] = '\0';
972             if (fmt_spec == 'p')
973               str_arg_l += sprintf(tmp + str_arg_l, f, ptr_arg);
974             else if (fmt_spec == 'd') { /* signed */
975               switch (length_modifier) {
976               case '\0':
977               case 'h':
978                 str_arg_l += sprintf(tmp + str_arg_l, f, int_arg);
979                 break;
980               case 'l':
981                 str_arg_l += sprintf(tmp + str_arg_l, f, long_arg);
982                 break;
983 #ifdef SNPRINTF_LONGLONG_SUPPORT
984               case '2':
985                 str_arg_l += sprintf(tmp + str_arg_l, f, long_long_arg);
986                 break;
987 #endif
988               }
989             } else {            /* unsigned */
990               switch (length_modifier) {
991               case '\0':
992               case 'h':
993                 str_arg_l += sprintf(tmp + str_arg_l, f, uint_arg);
994                 break;
995               case 'l':
996                 str_arg_l += sprintf(tmp + str_arg_l, f, ulong_arg);
997                 break;
998 #ifdef SNPRINTF_LONGLONG_SUPPORT
999               case '2':
1000                 str_arg_l += sprintf(tmp + str_arg_l, f, ulong_long_arg);
1001                 break;
1002 #endif
1003               }
1004             }
1005             /* include the optional minus sign and possible "0x"
1006                in the region before the zero padding insertion point */
1007             if (zero_padding_insertion_ind < str_arg_l &&
1008                 tmp[zero_padding_insertion_ind] == '-') {
1009               zero_padding_insertion_ind++;
1010             }
1011             if (zero_padding_insertion_ind + 1 < str_arg_l &&
1012                 tmp[zero_padding_insertion_ind] == '0' &&
1013                 (tmp[zero_padding_insertion_ind + 1] == 'x' ||
1014                  tmp[zero_padding_insertion_ind + 1] == 'X')) {
1015               zero_padding_insertion_ind += 2;
1016             }
1017           }
1018           {
1019             size_t num_of_digits = str_arg_l - zero_padding_insertion_ind;
1020             if (alternate_form && fmt_spec == 'o'
1021 #ifdef HPUX_COMPATIBLE          /* ("%#.o",0) -> ""  */
1022                 && (str_arg_l > 0)
1023 #endif
1024 #ifdef DIGITAL_UNIX_BUG_COMPATIBLE      /* ("%#o",0) -> "00" */
1025 #else
1026                 /* unless zero is already the first character */
1027                 && !(zero_padding_insertion_ind < str_arg_l
1028                      && tmp[zero_padding_insertion_ind] == '0')
1029 #endif
1030               ) {               /* assure leading zero for alternate-form octal numbers */
1031               if (!precision_specified || precision < num_of_digits + 1) {
1032                 /* precision is increased to force the first character to be zero,
1033                    except if a zero value is formatted with an explicit precision
1034                    of zero */
1035                 precision = num_of_digits + 1;
1036                 precision_specified = 1;
1037               }
1038             }
1039             /* zero padding to specified precision? */
1040             if (num_of_digits < precision)
1041               number_of_zeros_to_pad = precision - num_of_digits;
1042           }
1043           /* zero padding to specified minimal field width? */
1044           if (!justify_left && zero_padding) {
1045             int n = min_field_width - (str_arg_l + number_of_zeros_to_pad);
1046             if (n > 0)
1047               number_of_zeros_to_pad += n;
1048           }
1049           break;
1050         }
1051       default:                 /* unrecognized conversion specifier, keep format string as-is */
1052         zero_padding = 0;       /* turn zero padding off for non-numeric convers. */
1053 #ifndef DIGITAL_UNIX_COMPATIBLE
1054         justify_left = 1;
1055         min_field_width = 0;    /* reset flags */
1056 #endif
1057 #if defined(PERL_COMPATIBLE) || defined(LINUX_COMPATIBLE)
1058         /* keep the entire format string unchanged */
1059         str_arg = starting_p;
1060         str_arg_l = p - starting_p;
1061         /* well, not exactly so for Linux, which does something inbetween,
1062          * and I don't feel an urge to imitate it: "%+++++hy" -> "%+y"  */
1063 #else
1064         /* discard the unrecognized conversion, just keep *
1065          * the unrecognized conversion character          */
1066         str_arg = p;
1067         str_arg_l = 0;
1068 #endif
1069         if (*p)
1070           str_arg_l++;          /* include invalid conversion specifier unchanged
1071                                    if not at end-of-string */
1072         break;
1073       }
1074       if (*p)
1075         p++;                    /* step over the just processed conversion specifier */
1076       /* insert padding to the left as requested by min_field_width;
1077          this does not include the zero padding in case of numerical conversions */
1078       if (!justify_left) {      /* left padding with blank or zero */
1079         int n = min_field_width - (str_arg_l + number_of_zeros_to_pad);
1080         if (n > 0) {
1081           if (str_l < str_m) {
1082             int avail = str_m - str_l;
1083             fast_memset(str + str_l, (zero_padding ? '0' : ' '),
1084                         (n > avail ? avail : n));
1085           }
1086           str_l += n;
1087         }
1088       }
1089       /* zero padding as requested by the precision or by the minimal field width
1090        * for numeric conversions required? */
1091       if (number_of_zeros_to_pad <= 0) {
1092         /* will not copy first part of numeric right now, *
1093          * force it to be copied later in its entirety    */
1094         zero_padding_insertion_ind = 0;
1095       } else {
1096         /* insert first part of numerics (sign or '0x') before zero padding */
1097         int n = zero_padding_insertion_ind;
1098         if (n > 0) {
1099           if (str_l < str_m) {
1100             int avail = str_m - str_l;
1101             fast_memcpy(str + str_l, str_arg, (n > avail ? avail : n));
1102           }
1103           str_l += n;
1104         }
1105         /* insert zero padding as requested by the precision or min field width */
1106         n = number_of_zeros_to_pad;
1107         if (n > 0) {
1108           if (str_l < str_m) {
1109             int avail = str_m - str_l;
1110             fast_memset(str + str_l, '0', (n > avail ? avail : n));
1111           }
1112           str_l += n;
1113         }
1114       }
1115       /* insert formatted string
1116        * (or as-is conversion specifier for unknown conversions) */
1117       {
1118         int n = str_arg_l - zero_padding_insertion_ind;
1119         if (n > 0) {
1120           if (str_l < str_m) {
1121             int avail = str_m - str_l;
1122             fast_memcpy(str + str_l, str_arg + zero_padding_insertion_ind,
1123                         (n > avail ? avail : n));
1124           }
1125           str_l += n;
1126         }
1127       }
1128       /* insert right padding */
1129       if (justify_left) {       /* right blank padding to the field width */
1130         int n = min_field_width - (str_arg_l + number_of_zeros_to_pad);
1131         if (n > 0) {
1132           if (str_l < str_m) {
1133             int avail = str_m - str_l;
1134             fast_memset(str + str_l, ' ', (n > avail ? avail : n));
1135           }
1136           str_l += n;
1137         }
1138       }
1139     }
1140   }
1141 #if defined(NEED_SNPRINTF_ONLY)
1142   va_end(ap);
1143 #endif
1144   if (str_m > 0) {              /* make sure the string is null-terminated
1145                                    even at the expense of overwriting the last character
1146                                    (shouldn't happen, but just in case) */
1147     str[str_l <= str_m - 1 ? str_l : str_m - 1] = '\0';
1148   }
1149   /* Return the number of characters formatted (excluding trailing null
1150    * character), that is, the number of characters that would have been
1151    * written to the buffer if it were large enough.
1152    *
1153    * The value of str_l should be returned, but str_l is of unsigned type
1154    * size_t, and snprintf is int, possibly leading to an undetected
1155    * integer overflow, resulting in a negative return value, which is illegal.
1156    * Both XSH5 and ISO C99 (at least the draft) are silent on this issue.
1157    * Should errno be set to EOVERFLOW and EOF returned in this case???
1158    */
1159   return (int) str_l;
1160 }
1161 #endif
1162
1163
1164   /* FIXME: better place */
1165 #include "xbt/sysdep.h"
1166
1167 char *bprintf(const char *fmt, ...)
1168 {
1169   va_list ap;
1170   char *res;
1171   int len;
1172
1173   va_start(ap, fmt);
1174
1175   len = vasprintf(&res, fmt, ap);
1176
1177   va_end(ap);
1178   return res;
1179 }