Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
update the double extern declaration bis
[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 \f
284 /* ============================================= */
285 /* NO USER SERVICABLE PARTS FOLLOWING THIS POINT */
286 /* ============================================= */
287
288 #define PORTABLE_SNPRINTF_VERSION_MAJOR 2
289 #define PORTABLE_SNPRINTF_VERSION_MINOR 2
290
291 #if defined(NEED_ASPRINTF) || defined(NEED_ASNPRINTF) || defined(NEED_VASPRINTF) || defined(NEED_VASNPRINTF)
292 # if defined(NEED_SNPRINTF_ONLY)
293 # undef NEED_SNPRINTF_ONLY
294 # endif
295 # if !defined(PREFER_PORTABLE_SNPRINTF)
296 # define PREFER_PORTABLE_SNPRINTF
297 # endif
298 #endif
299
300 #if defined(SOLARIS_BUG_COMPATIBLE) && !defined(SOLARIS_COMPATIBLE)
301 #define SOLARIS_COMPATIBLE
302 #endif
303
304 #if defined(HPUX_BUG_COMPATIBLE) && !defined(HPUX_COMPATIBLE)
305 #define HPUX_COMPATIBLE
306 #endif
307
308 #if defined(DIGITAL_UNIX_BUG_COMPATIBLE) && !defined(DIGITAL_UNIX_COMPATIBLE)
309 #define DIGITAL_UNIX_COMPATIBLE
310 #endif
311
312 #if defined(PERL_BUG_COMPATIBLE) && !defined(PERL_COMPATIBLE)
313 #define PERL_COMPATIBLE
314 #endif
315
316 #if defined(LINUX_BUG_COMPATIBLE) && !defined(LINUX_COMPATIBLE)
317 #define LINUX_COMPATIBLE
318 #endif
319
320 #include <sys/types.h>
321 #include <string.h>
322 #include <stdlib.h>
323 #include <stdio.h>
324 #include <stdarg.h>
325
326 #include "portable.h" /* to get a working stdarg.h */
327
328 #include <assert.h>
329 #include <errno.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 #if defined(NEED_ASPRINTF)
384 int asprintf   (char **ptr, const char *fmt, /*args*/ ...);
385 #endif
386 #if defined(NEED_VASPRINTF)
387 int vasprintf  (char **ptr, const char *fmt, va_list ap);
388 #endif
389 #if defined(NEED_ASNPRINTF)
390 int asnprintf  (char **ptr, size_t str_m, const char *fmt, /*args*/ ...);
391 #endif
392 #if defined(NEED_VASNPRINTF)
393 int vasnprintf (char **ptr, size_t str_m, const char *fmt, va_list ap);
394 #endif
395
396 #if defined(HAVE_SNPRINTF)
397 /* declare our portable snprintf  routine under name portable_snprintf  */
398 /* declare our portable vsnprintf routine under name portable_vsnprintf */
399 #else
400 /* declare our portable routines under names snprintf and vsnprintf */
401 #define portable_snprintf snprintf
402 #if !defined(NEED_SNPRINTF_ONLY)
403 #define portable_vsnprintf vsnprintf
404 #endif
405 #endif
406
407 #if !defined(HAVE_SNPRINTF) || defined(PREFER_PORTABLE_SNPRINTF)
408 int portable_snprintf(char *str, size_t str_m, const char *fmt, /*args*/ ...);
409 #if !defined(NEED_SNPRINTF_ONLY)
410 int portable_vsnprintf(char *str, size_t str_m, const char *fmt, va_list ap);
411 #endif
412 #endif
413
414 /* declarations */
415
416 static char credits[] = "\n\
417 @(#)snprintf.c, v2.2: Mark Martinec, <mark.martinec@ijs.si>\n\
418 @(#)snprintf.c, v2.2: Copyright 1999, Mark Martinec. Frontier Artistic License applies.\n\
419 @(#)snprintf.c, v2.2: http://www.ijs.si/software/snprintf/\n";
420
421 static void __foo__(void) 
422 {
423    printf("%s",credits);
424    __foo__();
425 }
426
427 #if defined(NEED_ASPRINTF)
428 int asprintf(char **ptr, const char *fmt, /*args*/ ...) {
429   va_list ap;
430   size_t str_m;
431   int str_l;
432
433   *ptr = NULL;
434   va_start(ap, fmt);                            /* measure the required size */
435   str_l = portable_vsnprintf(NULL, (size_t)0, fmt, ap);
436   va_end(ap);
437   assert(str_l >= 0);        /* possible integer overflow if str_m > INT_MAX */
438   *ptr = (char *) malloc(str_m = (size_t)str_l + 1);
439   if (*ptr == NULL) { errno = ENOMEM; str_l = -1; }
440   else {
441     int str_l2;
442     va_start(ap, fmt);
443     str_l2 = portable_vsnprintf(*ptr, str_m, fmt, ap);
444     va_end(ap);
445     assert(str_l2 == str_l);
446   }
447   return str_l;
448 }
449 #endif
450
451 #if defined(NEED_VASPRINTF)
452 int vasprintf(char **ptr, const char *fmt, va_list ap) {
453   size_t str_m;
454   int str_l;
455
456   *ptr = NULL;
457   { va_list ap2;
458     va_copy(ap2, ap);  /* don't consume the original ap, we'll need it again */
459     str_l = portable_vsnprintf(NULL, (size_t)0, fmt, ap2);/*get required size*/
460     va_end(ap2);
461   }
462   assert(str_l >= 0);        /* possible integer overflow if str_m > INT_MAX */
463   *ptr = (char *) malloc(str_m = (size_t)str_l + 1);
464   if (*ptr == NULL) { errno = ENOMEM; str_l = -1; }
465   else {
466     int str_l2 = portable_vsnprintf(*ptr, str_m, fmt, ap);
467     assert(str_l2 == str_l);
468   }
469   return str_l;
470 }
471 #endif
472
473 #if defined(NEED_ASNPRINTF)
474 int asnprintf (char **ptr, size_t str_m, const char *fmt, /*args*/ ...) {
475   va_list ap;
476   int str_l;
477
478   *ptr = NULL;
479   va_start(ap, fmt);                            /* measure the required size */
480   str_l = portable_vsnprintf(NULL, (size_t)0, fmt, ap);
481   va_end(ap);
482   assert(str_l >= 0);        /* possible integer overflow if str_m > INT_MAX */
483   if ((size_t)str_l + 1 < str_m) str_m = (size_t)str_l + 1;      /* truncate */
484   /* if str_m is 0, no buffer is allocated, just set *ptr to NULL */
485   if (str_m == 0) {  /* not interested in resulting string, just return size */
486   } else {
487     *ptr = (char *) malloc(str_m);
488     if (*ptr == NULL) { errno = ENOMEM; str_l = -1; }
489     else {
490       int str_l2;
491       va_start(ap, fmt);
492       str_l2 = portable_vsnprintf(*ptr, str_m, fmt, ap);
493       va_end(ap);
494       assert(str_l2 == str_l);
495     }
496   }
497   return str_l;
498 }
499 #endif
500
501 #if defined(NEED_VASNPRINTF)
502 int vasnprintf (char **ptr, size_t str_m, const char *fmt, va_list ap) {
503   int str_l;
504
505   *ptr = NULL;
506   { va_list ap2;
507     va_copy(ap2, ap);  /* don't consume the original ap, we'll need it again */
508     str_l = portable_vsnprintf(NULL, (size_t)0, fmt, ap2);/*get required size*/
509     va_end(ap2);
510   }
511   assert(str_l >= 0);        /* possible integer overflow if str_m > INT_MAX */
512   if ((size_t)str_l + 1 < str_m) str_m = (size_t)str_l + 1;      /* truncate */
513   /* if str_m is 0, no buffer is allocated, just set *ptr to NULL */
514   if (str_m == 0) {  /* not interested in resulting string, just return size */
515   } else {
516     *ptr = (char *) malloc(str_m);
517     if (*ptr == NULL) { errno = ENOMEM; str_l = -1; }
518     else {
519       int str_l2 = portable_vsnprintf(*ptr, str_m, fmt, ap);
520       assert(str_l2 == str_l);
521     }
522   }
523   return str_l;
524 }
525 #endif
526
527 /*
528  * If the system does have snprintf and the portable routine is not
529  * specifically required, this module produces no code for snprintf/vsnprintf.
530  */
531 #if !defined(HAVE_SNPRINTF) || defined(PREFER_PORTABLE_SNPRINTF)
532
533 #if !defined(NEED_SNPRINTF_ONLY)
534 int portable_snprintf(char *str, size_t str_m, const char *fmt, /*args*/ ...) {
535   va_list ap;
536   int str_l;
537
538   va_start(ap, fmt);
539   str_l = portable_vsnprintf(str, str_m, fmt, ap);
540   va_end(ap);
541   return str_l;
542 }
543 #endif
544
545 #if defined(NEED_SNPRINTF_ONLY)
546 int portable_snprintf(char *str, size_t str_m, const char *fmt, /*args*/ ...) {
547 #else
548 int portable_vsnprintf(char *str, size_t str_m, const char *fmt, va_list ap) {
549 #endif
550
551 #if defined(NEED_SNPRINTF_ONLY)
552   va_list ap;
553 #endif
554   size_t str_l = 0;
555   const char *p = fmt;
556
557 /* In contrast with POSIX, the ISO C99 now says
558  * that str can be NULL and str_m can be 0.
559  * This is more useful than the old:  if (str_m < 1) return -1; */
560
561 #if defined(NEED_SNPRINTF_ONLY)
562   va_start(ap, fmt);
563 #endif
564   if (!p) p = "";
565   while (*p) {
566     if (*p != '%') {
567    /* if (str_l < str_m) str[str_l++] = *p++;    -- this would be sufficient */
568    /* but the following code achieves better performance for cases
569     * where format string is long and contains few conversions */
570       const char *q = strchr(p+1,'%');
571       size_t n = !q ? strlen(p) : (q-p);
572       if (str_l < str_m) {
573         size_t avail = str_m-str_l;
574         fast_memcpy(str+str_l, p, (n>avail?avail:n));
575       }
576       p += n; str_l += n;
577     } else {
578       const char *starting_p;
579       size_t min_field_width = 0, precision = 0;
580       int zero_padding = 0, precision_specified = 0, justify_left = 0;
581       int alternate_form = 0, force_sign = 0;
582       int space_for_positive = 1; /* If both the ' ' and '+' flags appear,
583                                      the ' ' flag should be ignored. */
584       char length_modifier = '\0';            /* allowed values: \0, h, l, L */
585       char tmp[32];/* temporary buffer for simple numeric->string conversion */
586
587       const char *str_arg;      /* string address in case of string argument */
588       size_t str_arg_l;         /* natural field width of arg without padding
589                                    and sign */
590       unsigned char uchar_arg;
591         /* unsigned char argument value - only defined for c conversion.
592            N.B. standard explicitly states the char argument for
593            the c conversion is unsigned */
594
595       size_t number_of_zeros_to_pad = 0;
596         /* number of zeros to be inserted for numeric conversions
597            as required by the precision or minimal field width */
598
599       size_t zero_padding_insertion_ind = 0;
600         /* index into tmp where zero padding is to be inserted */
601
602       char fmt_spec = '\0';
603         /* current conversion specifier character */
604
605       str_arg = credits;/* just to make compiler happy (defined but not used)*/
606       str_arg = NULL;
607       starting_p = p; p++;  /* skip '%' */
608    /* parse flags */
609       while (*p == '0' || *p == '-' || *p == '+' ||
610              *p == ' ' || *p == '#' || *p == '\'') {
611         switch (*p) {
612         case '0': zero_padding = 1; break;
613         case '-': justify_left = 1; break;
614         case '+': force_sign = 1; space_for_positive = 0; break;
615         case ' ': force_sign = 1;
616      /* If both the ' ' and '+' flags appear, the ' ' flag should be ignored */
617 #ifdef PERL_COMPATIBLE
618      /* ... but in Perl the last of ' ' and '+' applies */
619                   space_for_positive = 1;
620 #endif
621                   break;
622         case '#': alternate_form = 1; break;
623         case '\'': break;
624         }
625         p++;
626       }
627    /* If the '0' and '-' flags both appear, the '0' flag should be ignored. */
628
629    /* parse field width */
630       if (*p == '*') {
631         int j;
632         p++; j = va_arg(ap, int);
633         if (j >= 0) min_field_width = j;
634         else { min_field_width = -j; justify_left = 1; }
635       } else if (isdigit((int)(*p))) {
636         /* size_t could be wider than unsigned int;
637            make sure we treat argument like common implementations do */
638         unsigned int uj = *p++ - '0';
639         while (isdigit((int)(*p))) uj = 10*uj + (unsigned int)(*p++ - '0');
640         min_field_width = uj;
641       }
642    /* parse precision */
643       if (*p == '.') {
644         p++; precision_specified = 1;
645         if (*p == '*') {
646           int j = va_arg(ap, int);
647           p++;
648           if (j >= 0) precision = j;
649           else {
650             precision_specified = 0; precision = 0;
651          /* NOTE:
652           *   Solaris 2.6 man page claims that in this case the precision
653           *   should be set to 0.  Digital Unix 4.0, HPUX 10 and BSD man page
654           *   claim that this case should be treated as unspecified precision,
655           *   which is what we do here.
656           */
657           }
658         } else if (isdigit((int)(*p))) {
659           /* size_t could be wider than unsigned int;
660              make sure we treat argument like common implementations do */
661           unsigned int uj = *p++ - '0';
662           while (isdigit((int)(*p))) uj = 10*uj + (unsigned int)(*p++ - '0');
663           precision = uj;
664         }
665       }
666    /* parse 'h', 'l' and 'll' length modifiers */
667       if (*p == 'h' || *p == 'l') {
668         length_modifier = *p; p++;
669         if (length_modifier == 'l' && *p == 'l') {   /* double l = long long */
670 #ifdef SNPRINTF_LONGLONG_SUPPORT
671           length_modifier = '2';                  /* double l encoded as '2' */
672 #else
673           length_modifier = 'l';                 /* treat it as a single 'l' */
674 #endif
675           p++;
676         }
677       }
678       fmt_spec = *p;
679    /* common synonyms: */
680       switch (fmt_spec) {
681       case 'i': fmt_spec = 'd'; break;
682       case 'D': fmt_spec = 'd'; length_modifier = 'l'; break;
683       case 'U': fmt_spec = 'u'; length_modifier = 'l'; break;
684       case 'O': fmt_spec = 'o'; length_modifier = 'l'; break;
685       default: break;
686       }
687    /* get parameter value, do initial processing */
688       switch (fmt_spec) {
689       case '%': /* % behaves similar to 's' regarding flags and field widths */
690       case 'c': /* c behaves similar to 's' regarding flags and field widths */
691       case 's':
692         length_modifier = '\0';          /* wint_t and wchar_t not supported */
693      /* the result of zero padding flag with non-numeric conversion specifier*/
694      /* is undefined. Solaris and HPUX 10 does zero padding in this case,    */
695      /* Digital Unix and Linux does not. */
696 #if !defined(SOLARIS_COMPATIBLE) && !defined(HPUX_COMPATIBLE)
697         zero_padding = 0;    /* turn zero padding off for string conversions */
698 #endif
699         str_arg_l = 1;
700         switch (fmt_spec) {
701         case '%':
702           str_arg = p; break;
703         case 'c': {
704           int j = va_arg(ap, int);
705           uchar_arg = (unsigned char) j;   /* standard demands unsigned char */
706           str_arg = (const char *) &uchar_arg;
707           break;
708         }
709         case 's':
710           str_arg = va_arg(ap, const char *);
711           if (!str_arg) str_arg_l = 0;
712        /* make sure not to address string beyond the specified precision !!! */
713           else if (!precision_specified) str_arg_l = strlen(str_arg);
714        /* truncate string if necessary as requested by precision */
715           else if (precision == 0) str_arg_l = 0;
716           else {
717        /* memchr on HP does not like n > 2^31  !!! */
718             char *q = (char *) memchr(str_arg, '\0',
719                              precision <= 0x7fffffff ? precision : 0x7fffffff);
720             str_arg_l = !q ? precision : (q-str_arg);
721           }
722           break;
723         default: break;
724         }
725         break;
726       case 'd': case 'u': case 'o': case 'x': case 'X': case 'p': {
727         /* NOTE: the u, o, x, X and p conversion specifiers imply
728                  the value is unsigned;  d implies a signed value */
729
730         int arg_sign = 0;
731           /* 0 if numeric argument is zero (or if pointer is NULL for 'p'),
732             +1 if greater than zero (or nonzero for unsigned arguments),
733             -1 if negative (unsigned argument is never negative) */
734
735         int int_arg = 0;  unsigned int uint_arg = 0;
736           /* only defined for length modifier h, or for no length modifiers */
737
738         long int long_arg = 0;  unsigned long int ulong_arg = 0;
739           /* only defined for length modifier l */
740
741         void *ptr_arg = NULL;
742           /* pointer argument value -only defined for p conversion */
743
744 #ifdef SNPRINTF_LONGLONG_SUPPORT
745         long long int long_long_arg = 0;
746         unsigned long long int ulong_long_arg = 0;
747           /* only defined for length modifier ll */
748 #endif
749         if (fmt_spec == 'p') {
750         /* HPUX 10: An l, h, ll or L before any other conversion character
751          *   (other than d, i, u, o, x, or X) is ignored.
752          * Digital Unix:
753          *   not specified, but seems to behave as HPUX does.
754          * Solaris: If an h, l, or L appears before any other conversion
755          *   specifier (other than d, i, u, o, x, or X), the behavior
756          *   is undefined. (Actually %hp converts only 16-bits of address
757          *   and %llp treats address as 64-bit data which is incompatible
758          *   with (void *) argument on a 32-bit system).
759          */
760 #ifdef SOLARIS_COMPATIBLE
761 #  ifdef SOLARIS_BUG_COMPATIBLE
762           /* keep length modifiers even if it represents 'll' */
763 #  else
764           if (length_modifier == '2') length_modifier = '\0';
765 #  endif
766 #else
767           length_modifier = '\0';
768 #endif
769           ptr_arg = va_arg(ap, void *);
770           if (ptr_arg != NULL) arg_sign = 1;
771         } else if (fmt_spec == 'd') {  /* signed */
772           switch (length_modifier) {
773           case '\0':
774           case 'h':
775          /* It is non-portable to specify a second argument of char or short
776           * to va_arg, because arguments seen by the called function
777           * are not char or short.  C converts char and short arguments
778           * to int before passing them to a function.
779           */
780             int_arg = va_arg(ap, int);
781             if      (int_arg > 0) arg_sign =  1;
782             else if (int_arg < 0) arg_sign = -1;
783             break;
784           case 'l':
785             long_arg = va_arg(ap, long int);
786             if      (long_arg > 0) arg_sign =  1;
787             else if (long_arg < 0) arg_sign = -1;
788             break;
789 #ifdef SNPRINTF_LONGLONG_SUPPORT
790           case '2':
791             long_long_arg = va_arg(ap, long long int);
792             if      (long_long_arg > 0) arg_sign =  1;
793             else if (long_long_arg < 0) arg_sign = -1;
794             break;
795 #endif
796           }
797         } else {  /* unsigned */
798           switch (length_modifier) {
799           case '\0':
800           case 'h':
801             uint_arg = va_arg(ap, unsigned int);
802             if (uint_arg) arg_sign = 1;
803             break;
804           case 'l':
805             ulong_arg = va_arg(ap, unsigned long int);
806             if (ulong_arg) arg_sign = 1;
807             break;
808 #ifdef SNPRINTF_LONGLONG_SUPPORT
809           case '2':
810             ulong_long_arg = va_arg(ap, unsigned long long int);
811             if (ulong_long_arg) arg_sign = 1;
812             break;
813 #endif
814           }
815         }
816         str_arg = tmp; str_arg_l = 0;
817      /* NOTE:
818       *   For d, i, u, o, x, and X conversions, if precision is specified,
819       *   the '0' flag should be ignored. This is so with Solaris 2.6,
820       *   Digital UNIX 4.0, HPUX 10, Linux, FreeBSD, NetBSD; but not with Perl.
821       */
822 #ifndef PERL_COMPATIBLE
823         if (precision_specified) zero_padding = 0;
824 #endif
825         if (fmt_spec == 'd') {
826           if (force_sign && arg_sign >= 0)
827             tmp[str_arg_l++] = space_for_positive ? ' ' : '+';
828          /* leave negative numbers for sprintf to handle,
829             to avoid handling tricky cases like (short int)(-32768) */
830 #ifdef LINUX_COMPATIBLE
831         } else if (fmt_spec == 'p' && force_sign && arg_sign > 0) {
832           tmp[str_arg_l++] = space_for_positive ? ' ' : '+';
833 #endif
834         } else if (alternate_form) {
835           if (arg_sign != 0 && (fmt_spec == 'x' || fmt_spec == 'X') )
836             { tmp[str_arg_l++] = '0'; tmp[str_arg_l++] = fmt_spec; }
837          /* alternate form should have no effect for p conversion, but ... */
838 #ifdef HPUX_COMPATIBLE
839           else if (fmt_spec == 'p'
840          /* HPUX 10: for an alternate form of p conversion,
841           *          a nonzero result is prefixed by 0x. */
842 #ifndef HPUX_BUG_COMPATIBLE
843          /* Actually it uses 0x prefix even for a zero value. */
844                    && arg_sign != 0
845 #endif
846                   ) { tmp[str_arg_l++] = '0'; tmp[str_arg_l++] = 'x'; }
847 #endif
848         }
849         zero_padding_insertion_ind = str_arg_l;
850         if (!precision_specified) precision = 1;   /* default precision is 1 */
851         if (precision == 0 && arg_sign == 0
852 #if defined(HPUX_BUG_COMPATIBLE) || defined(LINUX_COMPATIBLE)
853             && fmt_spec != 'p'
854          /* HPUX 10 man page claims: With conversion character p the result of
855           * converting a zero value with a precision of zero is a null string.
856           * Actually HP returns all zeroes, and Linux returns "(nil)". */
857 #endif
858         ) {
859          /* converted to null string */
860          /* When zero value is formatted with an explicit precision 0,
861             the resulting formatted string is empty (d, i, u, o, x, X, p).   */
862         } else {
863           char f[5]; int f_l = 0;
864           f[f_l++] = '%';    /* construct a simple format string for sprintf */
865           if (!length_modifier) { }
866           else if (length_modifier=='2') { f[f_l++] = 'l'; f[f_l++] = 'l'; }
867           else f[f_l++] = length_modifier;
868           f[f_l++] = fmt_spec; f[f_l++] = '\0';
869           if (fmt_spec == 'p') str_arg_l += sprintf(tmp+str_arg_l, f, ptr_arg);
870           else if (fmt_spec == 'd') {  /* signed */
871             switch (length_modifier) {
872             case '\0':
873             case 'h': str_arg_l+=sprintf(tmp+str_arg_l, f, int_arg);  break;
874             case 'l': str_arg_l+=sprintf(tmp+str_arg_l, f, long_arg); break;
875 #ifdef SNPRINTF_LONGLONG_SUPPORT
876             case '2': str_arg_l+=sprintf(tmp+str_arg_l,f,long_long_arg); break;
877 #endif
878             }
879           } else {  /* unsigned */
880             switch (length_modifier) {
881             case '\0':
882             case 'h': str_arg_l+=sprintf(tmp+str_arg_l, f, uint_arg);  break;
883             case 'l': str_arg_l+=sprintf(tmp+str_arg_l, f, ulong_arg); break;
884 #ifdef SNPRINTF_LONGLONG_SUPPORT
885             case '2': str_arg_l+=sprintf(tmp+str_arg_l,f,ulong_long_arg);break;
886 #endif
887             }
888           }
889          /* include the optional minus sign and possible "0x"
890             in the region before the zero padding insertion point */
891           if (zero_padding_insertion_ind < str_arg_l &&
892               tmp[zero_padding_insertion_ind] == '-') {
893             zero_padding_insertion_ind++;
894           }
895           if (zero_padding_insertion_ind+1 < str_arg_l &&
896               tmp[zero_padding_insertion_ind]   == '0' &&
897              (tmp[zero_padding_insertion_ind+1] == 'x' ||
898               tmp[zero_padding_insertion_ind+1] == 'X') ) {
899             zero_padding_insertion_ind += 2;
900           }
901         }
902         { size_t num_of_digits = str_arg_l - zero_padding_insertion_ind;
903           if (alternate_form && fmt_spec == 'o'
904 #ifdef HPUX_COMPATIBLE                                  /* ("%#.o",0) -> ""  */
905               && (str_arg_l > 0)
906 #endif
907 #ifdef DIGITAL_UNIX_BUG_COMPATIBLE                      /* ("%#o",0) -> "00" */
908 #else
909               /* unless zero is already the first character */
910               && !(zero_padding_insertion_ind < str_arg_l
911                    && tmp[zero_padding_insertion_ind] == '0')
912 #endif
913           ) {        /* assure leading zero for alternate-form octal numbers */
914             if (!precision_specified || precision < num_of_digits+1) {
915              /* precision is increased to force the first character to be zero,
916                 except if a zero value is formatted with an explicit precision
917                 of zero */
918               precision = num_of_digits+1; precision_specified = 1;
919             }
920           }
921        /* zero padding to specified precision? */
922           if (num_of_digits < precision) 
923             number_of_zeros_to_pad = precision - num_of_digits;
924         }
925      /* zero padding to specified minimal field width? */
926         if (!justify_left && zero_padding) {
927           int n = min_field_width - (str_arg_l+number_of_zeros_to_pad);
928           if (n > 0) number_of_zeros_to_pad += n;
929         }
930         break;
931       }
932       default: /* unrecognized conversion specifier, keep format string as-is*/
933         zero_padding = 0;  /* turn zero padding off for non-numeric convers. */
934 #ifndef DIGITAL_UNIX_COMPATIBLE
935         justify_left = 1; min_field_width = 0;                /* reset flags */
936 #endif
937 #if defined(PERL_COMPATIBLE) || defined(LINUX_COMPATIBLE)
938      /* keep the entire format string unchanged */
939         str_arg = starting_p; str_arg_l = p - starting_p;
940      /* well, not exactly so for Linux, which does something inbetween,
941       * and I don't feel an urge to imitate it: "%+++++hy" -> "%+y"  */
942 #else
943      /* discard the unrecognized conversion, just keep *
944       * the unrecognized conversion character          */
945         str_arg = p; str_arg_l = 0;
946 #endif
947         if (*p) str_arg_l++;  /* include invalid conversion specifier unchanged
948                                  if not at end-of-string */
949         break;
950       }
951       if (*p) p++;      /* step over the just processed conversion specifier */
952    /* insert padding to the left as requested by min_field_width;
953       this does not include the zero padding in case of numerical conversions*/
954       if (!justify_left) {                /* left padding with blank or zero */
955         int n = min_field_width - (str_arg_l+number_of_zeros_to_pad);
956         if (n > 0) {
957           if (str_l < str_m) {
958             int avail = str_m-str_l;
959             fast_memset(str+str_l, (zero_padding?'0':' '), (n>avail?avail:n));
960           }
961           str_l += n;
962         }
963       }
964    /* zero padding as requested by the precision or by the minimal field width
965     * for numeric conversions required? */
966       if (number_of_zeros_to_pad <= 0) {
967      /* will not copy first part of numeric right now, *
968       * force it to be copied later in its entirety    */
969         zero_padding_insertion_ind = 0;
970       } else {
971      /* insert first part of numerics (sign or '0x') before zero padding */
972         int n = zero_padding_insertion_ind;
973         if (n > 0) {
974           if (str_l < str_m) {
975             int avail = str_m-str_l;
976             fast_memcpy(str+str_l, str_arg, (n>avail?avail:n));
977           }
978           str_l += n;
979         }
980      /* insert zero padding as requested by the precision or min field width */
981         n = number_of_zeros_to_pad;
982         if (n > 0) {
983           if (str_l < str_m) {
984             int avail = str_m-str_l;
985             fast_memset(str+str_l, '0', (n>avail?avail:n));
986           }
987           str_l += n;
988         }
989       }
990    /* insert formatted string
991     * (or as-is conversion specifier for unknown conversions) */
992       { int n = str_arg_l - zero_padding_insertion_ind;
993         if (n > 0) {
994           if (str_l < str_m) {
995             int avail = str_m-str_l;
996             fast_memcpy(str+str_l, str_arg+zero_padding_insertion_ind,
997                         (n>avail?avail:n));
998           }
999           str_l += n;
1000         }
1001       }
1002    /* insert right padding */
1003       if (justify_left) {          /* right blank padding to the field width */
1004         int n = min_field_width - (str_arg_l+number_of_zeros_to_pad);
1005         if (n > 0) {
1006           if (str_l < str_m) {
1007             int avail = str_m-str_l;
1008             fast_memset(str+str_l, ' ', (n>avail?avail:n));
1009           }
1010           str_l += n;
1011         }
1012       }
1013     }
1014   }
1015 #if defined(NEED_SNPRINTF_ONLY)
1016   va_end(ap);
1017 #endif
1018   if (str_m > 0) { /* make sure the string is null-terminated
1019                       even at the expense of overwriting the last character
1020                       (shouldn't happen, but just in case) */
1021     str[str_l <= str_m-1 ? str_l : str_m-1] = '\0';
1022   }
1023   /* Return the number of characters formatted (excluding trailing null
1024    * character), that is, the number of characters that would have been
1025    * written to the buffer if it were large enough.
1026    *
1027    * The value of str_l should be returned, but str_l is of unsigned type
1028    * size_t, and snprintf is int, possibly leading to an undetected
1029    * integer overflow, resulting in a negative return value, which is illegal.
1030    * Both XSH5 and ISO C99 (at least the draft) are silent on this issue.
1031    * Should errno be set to EOVERFLOW and EOF returned in this case???
1032    */
1033   return (int) str_l;
1034 }
1035 #endif
1036
1037
1038 /* FIXME: better place */
1039 #include "xbt/sysdep.h"
1040
1041 char *bprintf(const char*fmt, ...) {
1042   va_list ap;
1043   char *res;
1044   
1045   va_start(ap, fmt);
1046   vasprintf(&res,fmt,ap);
1047   va_end(ap);
1048   return res;
1049 }