lib/c-vasnprintf.h

   1 /* vsprintf with automatic memory allocation in C locale.
   2    Copyright (C) 2002-2004, 2007-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, or (at your option)
   7    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 along
  15    with this program; if not, see <https://www.gnu.org/licenses/>.  */
  16
  17 #ifndef _C_VASNPRINTF_H
  18 #define _C_VASNPRINTF_H
  19
  20 /* This file uses _GL_ATTRIBUTE_FORMAT.  */
  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 size_t.  */
  29 #include <stddef.h>
  30
  31 /* Get _GL_ATTRIBUTE_SPEC_PRINTF_STANDARD.  */
  32 #include <stdio.h>
  33
  34 #ifdef __cplusplus
  35 extern "C" {
  36 #endif
  37
  38 /* Write formatted output to a string dynamically allocated with malloc().
  39    You can pass a preallocated buffer for the result in RESULTBUF and its
  40    size in *LENGTHP; otherwise you pass RESULTBUF = NULL.
  41    If successful, return the address of the string (this may be = RESULTBUF
  42    if no dynamic memory allocation was necessary) and set *LENGTHP to the
  43    number of resulting bytes, excluding the trailing NUL.  Upon error, set
  44    errno and return NULL.
  45
  46    When dynamic memory allocation occurs, the preallocated buffer is left
  47    alone (with possibly modified contents).  This makes it possible to use
  48    a statically allocated or stack-allocated buffer, like this:
  49
  50           char buf[100];
  51           size_t len = sizeof (buf);
  52           char *output = vasnprintf (buf, &len, format, args);
  53           if (output == NULL)
  54             ... error handling ...;
  55           else
  56             {
  57               ... use the output string ...;
  58               if (output != buf)
  59                 free (output);
  60             }
  61
  62    Formatting takes place in the C locale, that is, the decimal point used in
  63    floating-point formatting directives is always '.'.
  64   */
  65 extern char *c_vasnprintf (char *restrict resultbuf, size_t *lengthp,
  66                            const char *format, va_list args)
  67        _GL_ATTRIBUTE_FORMAT ((_GL_ATTRIBUTE_SPEC_PRINTF_STANDARD, 3, 0));
  68
  69 #ifdef __cplusplus
  70 }
  71 #endif
  72
  73 #endif /* _C_VASNPRINTF_H */