Blame gnulib/lib/vasnprintf.h

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