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