lib/xvasprintf.h

   1 /* vasprintf and asprintf with out-of-memory checking.
   2    Copyright (C) 2002-2004, 2006-2025 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    _GL_ATTRIBUTE_RETURNS_NONNULL.  */
  22 #if !_GL_CONFIG_H_INCLUDED
  23  #error "Please include config.h first."
  24 #endif
  25
  26 /* Get va_list.  */
  27 #include <stdarg.h>
  28
  29 /* Get _GL_ATTRIBUTE_SPEC_PRINTF_STANDARD.  */
  30 #include <stdio.h>
  31
  32 /* Get 'free'.  */
  33 #include <stdlib.h>
  34
  35 #ifdef __cplusplus
  36 extern "C" {
  37 #endif
  38
  39 /* Prints formatted output to a string dynamically allocated with malloc(),
  40    and returns it.  Upon [ENOMEM] memory allocation error, it calls xalloc_die.
  41
  42    It is the responsibility of the programmer to ensure that
  43      - the format string is valid,
  44      - the format string does not use %ls or %lc directives, and
  45      - all widths in the format string and passed as arguments are >= -INT_MAX
  46        and <= INT_MAX,
  47    so that other errors
  48      - [EINVAL] invalid format string,
  49      - [EILSEQ] error during conversion between wide and multibyte characters,
  50      - [EOVERFLOW] some specified width is > INT_MAX,
  51    cannot occur.  */
  52 extern char *xasprintf (const char *format, ...)
  53        _GL_ATTRIBUTE_MALLOC _GL_ATTRIBUTE_DEALLOC_FREE
  54        _GL_ATTRIBUTE_FORMAT ((_GL_ATTRIBUTE_SPEC_PRINTF_STANDARD, 1, 2))
  55        _GL_ATTRIBUTE_RETURNS_NONNULL;
  56 extern char *xvasprintf (const char *format, va_list args)
  57        _GL_ATTRIBUTE_MALLOC _GL_ATTRIBUTE_DEALLOC_FREE
  58        _GL_ATTRIBUTE_FORMAT ((_GL_ATTRIBUTE_SPEC_PRINTF_STANDARD, 1, 0))
  59        _GL_ATTRIBUTE_RETURNS_NONNULL;
  60
  61 #ifdef __cplusplus
  62 }
  63 #endif
  64
  65 #endif /* _XVASPRINTF_H */