Blame gnulib/lib/vasnprintf.h

Packit Service 51e54d
/* vsprintf with automatic memory allocation.
Packit Service 51e54d
   Copyright (C) 2002-2004, 2007-2014 Free Software Foundation, Inc.
Packit Service 51e54d
Packit Service 51e54d
   This program is free software; you can redistribute it and/or modify
Packit Service 51e54d
   it under the terms of the GNU General Public License as published by
Packit Service 51e54d
   the Free Software Foundation; either version 3, or (at your option)
Packit Service 51e54d
   any later version.
Packit Service 51e54d
Packit Service 51e54d
   This program is distributed in the hope that it will be useful,
Packit Service 51e54d
   but WITHOUT ANY WARRANTY; without even the implied warranty of
Packit Service 51e54d
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
Packit Service 51e54d
   GNU General Public License for more details.
Packit Service 51e54d
Packit Service 51e54d
   You should have received a copy of the GNU General Public License along
Packit Service 51e54d
   with this program; if not, see <http://www.gnu.org/licenses/>.  */
Packit Service 51e54d
Packit Service 51e54d
#ifndef _VASNPRINTF_H
Packit Service 51e54d
#define _VASNPRINTF_H
Packit Service 51e54d
Packit Service 51e54d
/* Get va_list.  */
Packit Service 51e54d
#include <stdarg.h>
Packit Service 51e54d
Packit Service 51e54d
/* Get size_t.  */
Packit Service 51e54d
#include <stddef.h>
Packit Service 51e54d
Packit Service 51e54d
/* The __attribute__ feature is available in gcc versions 2.5 and later.
Packit Service 51e54d
   The __-protected variants of the attributes 'format' and 'printf' are
Packit Service 51e54d
   accepted by gcc versions 2.6.4 (effectively 2.7) and later.
Packit Service 51e54d
   We enable _GL_ATTRIBUTE_FORMAT only if these are supported too, because
Packit Service 51e54d
   gnulib and libintl do '#define printf __printf__' when they override
Packit Service 51e54d
   the 'printf' function.  */
Packit Service 51e54d
#if __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 7)
Packit Service 51e54d
# define _GL_ATTRIBUTE_FORMAT(spec) __attribute__ ((__format__ spec))
Packit Service 51e54d
#else
Packit Service 51e54d
# define _GL_ATTRIBUTE_FORMAT(spec) /* empty */
Packit Service 51e54d
#endif
Packit Service 51e54d
Packit Service 51e54d
#ifdef __cplusplus
Packit Service 51e54d
extern "C" {
Packit Service 51e54d
#endif
Packit Service 51e54d
Packit Service 51e54d
/* Write formatted output to a string dynamically allocated with malloc().
Packit Service 51e54d
   You can pass a preallocated buffer for the result in RESULTBUF and its
Packit Service 51e54d
   size in *LENGTHP; otherwise you pass RESULTBUF = NULL.
Packit Service 51e54d
   If successful, return the address of the string (this may be = RESULTBUF
Packit Service 51e54d
   if no dynamic memory allocation was necessary) and set *LENGTHP to the
Packit Service 51e54d
   number of resulting bytes, excluding the trailing NUL.  Upon error, set
Packit Service 51e54d
   errno and return NULL.
Packit Service 51e54d
Packit Service 51e54d
   When dynamic memory allocation occurs, the preallocated buffer is left
Packit Service 51e54d
   alone (with possibly modified contents).  This makes it possible to use
Packit Service 51e54d
   a statically allocated or stack-allocated buffer, like this:
Packit Service 51e54d
Packit Service 51e54d
          char buf[100];
Packit Service 51e54d
          size_t len = sizeof (buf);
Packit Service 51e54d
          char *output = vasnprintf (buf, &len, format, args);
Packit Service 51e54d
          if (output == NULL)
Packit Service 51e54d
            ... error handling ...;
Packit Service 51e54d
          else
Packit Service 51e54d
            {
Packit Service 51e54d
              ... use the output string ...;
Packit Service 51e54d
              if (output != buf)
Packit Service 51e54d
                free (output);
Packit Service 51e54d
            }
Packit Service 51e54d
  */
Packit Service 51e54d
#if REPLACE_VASNPRINTF
Packit Service 51e54d
# define asnprintf rpl_asnprintf
Packit Service 51e54d
# define vasnprintf rpl_vasnprintf
Packit Service 51e54d
#endif
Packit Service 51e54d
extern char * asnprintf (char *resultbuf, size_t *lengthp, const char *format, ...)
Packit Service 51e54d
       _GL_ATTRIBUTE_FORMAT ((__printf__, 3, 4));
Packit Service 51e54d
extern char * vasnprintf (char *resultbuf, size_t *lengthp, const char *format, va_list args)
Packit Service 51e54d
       _GL_ATTRIBUTE_FORMAT ((__printf__, 3, 0));
Packit Service 51e54d
Packit Service 51e54d
#ifdef __cplusplus
Packit Service 51e54d
}
Packit Service 51e54d
#endif
Packit Service 51e54d
Packit Service 51e54d
#endif /* _VASNPRINTF_H */