]> git.cworth.org Git - tar/blob - lib/vasnprintf.h
Imported Upstream version 1.20
[tar] / lib / vasnprintf.h
1 /* -*- buffer-read-only: t -*- vi: set ro: */
2 /* DO NOT EDIT! GENERATED AUTOMATICALLY! */
3 /* vsprintf with automatic memory allocation.
4    Copyright (C) 2002-2004, 2007-2008 Free Software Foundation, Inc.
5
6    This program is free software; you can redistribute it and/or modify
7    it under the terms of the GNU General Public License as published by
8    the Free Software Foundation; either version 3, or (at your option)
9    any later version.
10
11    This program is distributed in the hope that it will be useful,
12    but WITHOUT ANY WARRANTY; without even the implied warranty of
13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14    GNU General Public License for more details.
15
16    You should have received a copy of the GNU General Public License along
17    with this program; if not, write to the Free Software Foundation,
18    Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.  */
19
20 #ifndef _VASNPRINTF_H
21 #define _VASNPRINTF_H
22
23 /* Get va_list.  */
24 #include <stdarg.h>
25
26 /* Get size_t.  */
27 #include <stddef.h>
28
29 #ifndef __attribute__
30 /* This feature is available in gcc versions 2.5 and later.  */
31 # if __GNUC__ < 2 || (__GNUC__ == 2 && __GNUC_MINOR__ < 5)
32 #  define __attribute__(Spec) /* empty */
33 # endif
34 /* The __-protected variants of `format' and `printf' attributes
35    are accepted by gcc versions 2.6.4 (effectively 2.7) and later.  */
36 # if __GNUC__ < 2 || (__GNUC__ == 2 && __GNUC_MINOR__ < 7)
37 #  define __format__ format
38 #  define __printf__ printf
39 # endif
40 #endif
41
42 #ifdef __cplusplus
43 extern "C" {
44 #endif
45
46 /* Write formatted output to a string dynamically allocated with malloc().
47    You can pass a preallocated buffer for the result in RESULTBUF and its
48    size in *LENGTHP; otherwise you pass RESULTBUF = NULL.
49    If successful, return the address of the string (this may be = RESULTBUF
50    if no dynamic memory allocation was necessary) and set *LENGTHP to the
51    number of resulting bytes, excluding the trailing NUL.  Upon error, set
52    errno and return NULL.
53
54    When dynamic memory allocation occurs, the preallocated buffer is left
55    alone (with possibly modified contents).  This makes it possible to use
56    a statically allocated or stack-allocated buffer, like this:
57
58           char buf[100];
59           size_t len = sizeof (buf);
60           char *output = vasnprintf (buf, &len, format, args);
61           if (output == NULL)
62             ... error handling ...;
63           else
64             {
65               ... use the output string ...;
66               if (output != buf)
67                 free (output);
68             }
69   */
70 #if REPLACE_VASNPRINTF
71 # define asnprintf rpl_asnprintf
72 # define vasnprintf rpl_vasnprintf
73 #endif
74 extern char * asnprintf (char *resultbuf, size_t *lengthp, const char *format, ...)
75        __attribute__ ((__format__ (__printf__, 3, 4)));
76 extern char * vasnprintf (char *resultbuf, size_t *lengthp, const char *format, va_list args)
77        __attribute__ ((__format__ (__printf__, 3, 0)));
78
79 #ifdef __cplusplus
80 }
81 #endif
82
83 #endif /* _VASNPRINTF_H */