lib/xvasprintf.h

   1 /* vasprintf and asprintf with out-of-memory checking.
   2    Copyright (C) 2002-2004, 2006-2024 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 _XVASPRINTF_H
  18 #define _XVASPRINTF_H
  19
  20 /* This file uses _GL_ATTRIBUTE_FORMAT, _GL_ATTRIBUTE_MALLOC.  */
  21 #if !_GL_CONFIG_H_INCLUDED
  22  #error "Please include config.h first."
  23 #endif
  24
  25 /* Get va_list.  */
  26 #include <stdarg.h>
  27
  28 /* Get _GL_ATTRIBUTE_SPEC_PRINTF_STANDARD.  */
  29 #include <stdio.h>
  30
  31 /* Get 'free'.  */
  32 #include <stdlib.h>
  33
  34 #ifdef __cplusplus
  35 extern "C" {
  36 #endif
  37
  38 /* Write formatted output to a string dynamically allocated with malloc(),
  39    and return it.  Upon [ENOMEM] memory allocation error, call xalloc_die.
  40    On some other error
  41      - [EOVERFLOW] resulting string length is > INT_MAX,
  42      - [EINVAL] invalid format string,
  43      - [EILSEQ] error during conversion between wide and multibyte characters,
  44    return NULL.  */
  45 extern char *xasprintf (const char *format, ...)
  46        _GL_ATTRIBUTE_MALLOC _GL_ATTRIBUTE_DEALLOC_FREE
  47        _GL_ATTRIBUTE_FORMAT ((_GL_ATTRIBUTE_SPEC_PRINTF_STANDARD, 1, 2));
  48 extern char *xvasprintf (const char *format, va_list args)
  49        _GL_ATTRIBUTE_MALLOC _GL_ATTRIBUTE_DEALLOC_FREE
  50        _GL_ATTRIBUTE_FORMAT ((_GL_ATTRIBUTE_SPEC_PRINTF_STANDARD, 1, 0));
  51
  52 #ifdef __cplusplus
  53 }
  54 #endif
  55
  56 #endif /* _XVASPRINTF_H */