git.gag.com Git - debian/tar/blob - gnu/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-2014 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, see <http://www.gnu.org/licenses/>.  */
  18
  19 #ifndef _VASNPRINTF_H
  20 #define _VASNPRINTF_H
  21
  22 /* Get va_list.  */
  23 #include <stdarg.h>
  24
  25 /* Get size_t.  */
  26 #include <stddef.h>
  27
  28 /* The __attribute__ feature is available in gcc versions 2.5 and later.
  29    The __-protected variants of the attributes 'format' and 'printf' are
  30    accepted by gcc versions 2.6.4 (effectively 2.7) and later.
  31    We enable _GL_ATTRIBUTE_FORMAT only if these are supported too, because
  32    gnulib and libintl do '#define printf __printf__' when they override
  33    the 'printf' function.  */
  34 #if __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 7)
  35 # define _GL_ATTRIBUTE_FORMAT(spec) __attribute__ ((__format__ spec))
  36 #else
  37 # define _GL_ATTRIBUTE_FORMAT(spec) /* empty */
  38 #endif
  39
  40 #ifdef __cplusplus
  41 extern "C" {
  42 #endif
  43
  44 /* Write formatted output to a string dynamically allocated with malloc().
  45    You can pass a preallocated buffer for the result in RESULTBUF and its
  46    size in *LENGTHP; otherwise you pass RESULTBUF = NULL.
  47    If successful, return the address of the string (this may be = RESULTBUF
  48    if no dynamic memory allocation was necessary) and set *LENGTHP to the
  49    number of resulting bytes, excluding the trailing NUL.  Upon error, set
  50    errno and return NULL.
  51
  52    When dynamic memory allocation occurs, the preallocated buffer is left
  53    alone (with possibly modified contents).  This makes it possible to use
  54    a statically allocated or stack-allocated buffer, like this:
  55
  56           char buf[100];
  57           size_t len = sizeof (buf);
  58           char *output = vasnprintf (buf, &len, format, args);
  59           if (output == NULL)
  60             ... error handling ...;
  61           else
  62             {
  63               ... use the output string ...;
  64               if (output != buf)
  65                 free (output);
  66             }
  67   */
  68 #if REPLACE_VASNPRINTF
  69 # define asnprintf rpl_asnprintf
  70 # define vasnprintf rpl_vasnprintf
  71 #endif
  72 extern char * asnprintf (char *resultbuf, size_t *lengthp, const char *format, ...)
  73        _GL_ATTRIBUTE_FORMAT ((__printf__, 3, 4));
  74 extern char * vasnprintf (char *resultbuf, size_t *lengthp, const char *format, va_list args)
  75        _GL_ATTRIBUTE_FORMAT ((__printf__, 3, 0));
  76
  77 #ifdef __cplusplus
  78 }
  79 #endif
  80
  81 #endif /* _VASNPRINTF_H */