lib/c-xvasprintf.h

   1 /* vasprintf and asprintf, with out-of-memory checking, in C locale.
   2    Copyright (C) 2002-2004, 2006-2019 Free Software Foundation, Inc.
   3
   4    This program is free software: you can redistribute it and/or modify
   5    it under the terms of the GNU General Public License as published by
   6    the Free Software Foundation; either version 3 of the License, or
   7    (at your option) any later version.
   8
   9    This program is distributed in the hope that it will be useful,
  10    but WITHOUT ANY WARRANTY; without even the implied warranty of
  11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12    GNU General Public License for more details.
  13
  14    You should have received a copy of the GNU General Public License
  15    along with this program.  If not, see <https://www.gnu.org/licenses/>.  */
  16
  17 #ifndef _C_XVASPRINTF_H
  18 #define _C_XVASPRINTF_H
  19
  20 /* Get va_list.  */
  21 #include <stdarg.h>
  22
  23 /* The __attribute__ feature is available in gcc versions 2.5 and later.
  24    The __-protected variants of the attributes 'format' and 'printf' are
  25    accepted by gcc versions 2.6.4 (effectively 2.7) and later.
  26    We enable _GL_ATTRIBUTE_FORMAT only if these are supported too, because
  27    gnulib and libintl do '#define printf __printf__' when they override
  28    the 'printf' function.  */
  29 #if __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 7)
  30 # define _GL_ATTRIBUTE_FORMAT(spec) __attribute__ ((__format__ spec))
  31 #else
  32 # define _GL_ATTRIBUTE_FORMAT(spec) /* empty */
  33 #endif
  34
  35 #ifdef __cplusplus
  36 extern "C" {
  37 #endif
  38
  39 /* Write formatted output to a string dynamically allocated with malloc(),
  40    and return it.  Upon [ENOMEM] memory allocation error, call xalloc_die.
  41    On some other error
  42      - [EOVERFLOW] resulting string length is > INT_MAX,
  43      - [EINVAL] invalid format string,
  44      - [EILSEQ] error during conversion between wide and multibyte characters,
  45    return NULL.
  46
  47    Formatting takes place in the C locale, that is, the decimal point
  48    used in floating-point formatting directives is always '.'. */
  49 extern char *c_xasprintf (const char *format, ...)
  50        _GL_ATTRIBUTE_FORMAT ((__printf__, 1, 2));
  51 extern char *c_xvasprintf (const char *format, va_list args)
  52        _GL_ATTRIBUTE_FORMAT ((__printf__, 1, 0));
  53
  54 #ifdef __cplusplus
  55 }
  56 #endif
  57
  58 #endif /* _C_XVASPRINTF_H */