Logo AND Algorithmique Numérique Distribuée

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