lib/c-xvasprintf.h

   1 /* vasprintf and asprintf, with out-of-memory checking, in C locale.
   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 _C_XVASPRINTF_H
  18 #define _C_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 #include <stdlib.h>
  33
  34 #ifdef __cplusplus
  35 extern "C" {
  36 #endif
  37
  38 /* Prints formatted output to a string dynamically allocated with malloc(),
  39    and returns it.  Upon [ENOMEM] memory allocation error, it calls xalloc_die.
  40
  41    It is the responsibility of the programmer to ensure that
  42      - the format string is valid,
  43      - the format string does not use %ls or %lc directives, and
  44      - all widths in the format string and passed as arguments are >= -INT_MAX
  45        and <= INT_MAX,
  46    so that other errors
  47      - [EINVAL] invalid format string,
  48      - [EILSEQ] error during conversion between wide and multibyte characters,
  49      - [EOVERFLOW] some specified width is > INT_MAX,
  50    cannot occur.
  51
  52    Formatting takes place in the C locale, that is, the decimal point
  53    used in floating-point formatting directives is always '.'. */
  54 extern char *c_xasprintf (const char *format, ...)
  55   _GL_ATTRIBUTE_FORMAT ((_GL_ATTRIBUTE_SPEC_PRINTF_STANDARD, 1, 2))
  56   _GL_ATTRIBUTE_MALLOC _GL_ATTRIBUTE_DEALLOC_FREE
  57   _GL_ATTRIBUTE_RETURNS_NONNULL;
  58 extern char *c_xvasprintf (const char *format, va_list args)
  59   _GL_ATTRIBUTE_FORMAT ((_GL_ATTRIBUTE_SPEC_PRINTF_STANDARD, 1, 0))
  60   _GL_ATTRIBUTE_MALLOC _GL_ATTRIBUTE_DEALLOC_FREE
  61   _GL_ATTRIBUTE_RETURNS_NONNULL;
  62
  63 #ifdef __cplusplus
  64 }
  65 #endif
  66
  67 #endif /* _C_XVASPRINTF_H */