gnulib/lib/printf-args.c

/* Decomposed printf argument list.
   Copyright (C) 1999, 2002-2003, 2005-2007, 2009-2025 Free Software
   Foundation, Inc.

   This file is free software: you can redistribute it and/or modify
   it under the terms of the GNU Lesser General Public License as
   published by the Free Software Foundation; either version 2.1 of the
   License, or (at your option) any later version.

   This file is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU Lesser General Public License for more details.

   You should have received a copy of the GNU Lesser General Public License
   along with this program.  If not, see <https://www.gnu.org/licenses/>.  */

/* This file can be parametrized with the following macros:
     ENABLE_UNISTDIO    Set to 1 to enable the unistdio extensions.
     PRINTF_FETCHARGS   Name of the function to be defined.
     STATIC             Set to 'static' to declare the function static.  */

#ifndef PRINTF_FETCHARGS
# include <config.h>
#endif

/* Specification.  */
#ifndef PRINTF_FETCHARGS
# include "printf-args.h"
#endif

/* Get INT_WIDTH.  */
#include <limits.h>

/* Get abort().  */
#include <stdlib.h>

#ifdef STATIC
STATIC
#endif
int
PRINTF_FETCHARGS (va_list args, arguments *a)
{
  size_t i;
  argument *ap;

  for (i = 0, ap = &a->arg[0]; i < a->count; i++, ap++)
    switch (ap->type)
      {
      case TYPE_SCHAR:
        ap->a.a_schar = va_arg (args, /*signed char*/ int);
        break;
      case TYPE_UCHAR:
        ap->a.a_uchar = va_arg (args, /*unsigned char*/ int);
        break;
      case TYPE_SHORT:
        ap->a.a_short = va_arg (args, /*short*/ int);
        break;
      case TYPE_USHORT:
        ap->a.a_ushort = va_arg (args, /*unsigned short*/ int);
        break;
      case TYPE_INT:
        ap->a.a_int = va_arg (args, int);
        break;
      case TYPE_UINT:
        ap->a.a_uint = va_arg (args, unsigned int);
        break;
      case TYPE_LONGINT:
        ap->a.a_longint = va_arg (args, long int);
        break;
      case TYPE_ULONGINT:
        ap->a.a_ulongint = va_arg (args, unsigned long int);
        break;
      case TYPE_LONGLONGINT:
        ap->a.a_longlongint = va_arg (args, long long int);
        break;
      case TYPE_ULONGLONGINT:
        ap->a.a_ulonglongint = va_arg (args, unsigned long long int);
        break;
      case TYPE_INT8_T:
        #if INT8_WIDTH < INT_WIDTH
        ap->a.a_int8_t = va_arg (args, /* int8_t */ int);
        #else
        ap->a.a_int8_t = va_arg (args, int8_t);
        #endif
        break;
      case TYPE_UINT8_T:
        #if UINT8_WIDTH < INT_WIDTH
        ap->a.a_uint8_t = va_arg (args, /* uint8_t */ int);
        #else
        ap->a.a_uint8_t = va_arg (args, uint8_t);
        #endif
        break;
      case TYPE_INT16_T:
        #if INT16_WIDTH < INT_WIDTH
        ap->a.a_int16_t = va_arg (args, /* int16_t */ int);
        #else
        ap->a.a_int16_t = va_arg (args, int16_t);
        #endif
        break;
      case TYPE_UINT16_T:
        #if UINT16_WIDTH < INT_WIDTH
        ap->a.a_uint16_t = va_arg (args, /* uint16_t */ int);
        #else
        ap->a.a_uint16_t = va_arg (args, uint16_t);
        #endif
        break;
      case TYPE_INT32_T:
        #if INT32_WIDTH < INT_WIDTH
        ap->a.a_int32_t = va_arg (args, /* int32_t */ int);
        #else
        ap->a.a_int32_t = va_arg (args, int32_t);
        #endif
        break;
      case TYPE_UINT32_T:
        #if UINT32_WIDTH < INT_WIDTH
        ap->a.a_uint32_t = va_arg (args, /* uint32_t */ int);
        #else
        ap->a.a_uint32_t = va_arg (args, uint32_t);
        #endif
        break;
      case TYPE_INT64_T:
        ap->a.a_int64_t = va_arg (args, int64_t);
        break;
      case TYPE_UINT64_T:
        ap->a.a_uint64_t = va_arg (args, uint64_t);
        break;
      case TYPE_INT_FAST8_T:
        #if INT_FAST8_WIDTH < INT_WIDTH
        ap->a.a_int_fast8_t = va_arg (args, /* int_fast8_t */ int);
        #else
        ap->a.a_int_fast8_t = va_arg (args, int_fast8_t);
        #endif
        break;
      case TYPE_UINT_FAST8_T:
        #if UINT_FAST8_WIDTH < INT_WIDTH
        ap->a.a_uint_fast8_t = va_arg (args, /* uint_fast8_t */ int);
        #else
        ap->a.a_uint_fast8_t = va_arg (args, uint_fast8_t);
        #endif
        break;
      case TYPE_INT_FAST16_T:
        #if INT_FAST16_WIDTH < INT_WIDTH
        ap->a.a_int_fast16_t = va_arg (args, /* int_fast16_t */ int);
        #else
        ap->a.a_int_fast16_t = va_arg (args, int_fast16_t);
        #endif
        break;
      case TYPE_UINT_FAST16_T:
        #if UINT_FAST16_WIDTH < INT_WIDTH
        ap->a.a_uint_fast16_t = va_arg (args, /* uint_fast16_t */ int);
        #else
        ap->a.a_uint_fast16_t = va_arg (args, uint_fast16_t);
        #endif
        break;
      case TYPE_INT_FAST32_T:
        #if INT_FAST32_WIDTH < INT_WIDTH
        ap->a.a_int_fast32_t = va_arg (args, /* int_fast32_t */ int);
        #else
        ap->a.a_int_fast32_t = va_arg (args, int_fast32_t);
        #endif
        break;
      case TYPE_UINT_FAST32_T:
        #if UINT_FAST32_WIDTH < INT_WIDTH
        ap->a.a_uint_fast32_t = va_arg (args, /* uint_fast32_t */ int);
        #else
        ap->a.a_uint_fast32_t = va_arg (args, uint_fast32_t);
        #endif
        break;
      case TYPE_INT_FAST64_T:
        ap->a.a_int_fast64_t = va_arg (args, int_fast64_t);
        break;
      case TYPE_UINT_FAST64_T:
        ap->a.a_uint_fast64_t = va_arg (args, uint_fast64_t);
        break;
      case TYPE_DOUBLE:
        ap->a.a_double = va_arg (args, double);
        break;
      case TYPE_LONGDOUBLE:
        ap->a.a_longdouble = va_arg (args, long double);
        break;
      case TYPE_CHAR:
        ap->a.a_char = va_arg (args, int);
        break;
#if HAVE_WINT_T
      case TYPE_WIDE_CHAR:
        /* Although ISO C 99 7.24.1.(2) says that wint_t is "unchanged by
           default argument promotions", this is not the case in mingw32,
           where wint_t is 'unsigned short'.  */
        ap->a.a_wide_char =
          (sizeof (wint_t) < sizeof (int)
           ? (wint_t) va_arg (args, int)
           : va_arg (args, wint_t));
        break;
#endif
      case TYPE_STRING:
        ap->a.a_string = va_arg (args, const char *);
        /* A null pointer is an invalid argument for "%s", but in practice
           it occurs quite frequently in printf statements that produce
           debug output.  Use a fallback in this case.  */
        if (ap->a.a_string == NULL)
          ap->a.a_string = "(NULL)";
        break;
      case TYPE_WIDE_STRING:
        ap->a.a_wide_string = va_arg (args, const wchar_t *);
        /* A null pointer is an invalid argument for "%ls", but in practice
           it occurs quite frequently in printf statements that produce
           debug output.  Use a fallback in this case.  */
        if (ap->a.a_wide_string == NULL)
          {
            static const wchar_t wide_null_string[] =
              {
                (wchar_t)'(',
                (wchar_t)'N', (wchar_t)'U', (wchar_t)'L', (wchar_t)'L',
                (wchar_t)')',
                (wchar_t)0
              };
            ap->a.a_wide_string = wide_null_string;
          }
        break;
      case TYPE_POINTER:
        ap->a.a_pointer = va_arg (args, void *);
        break;
      case TYPE_COUNT_SCHAR_POINTER:
        ap->a.a_count_schar_pointer = va_arg (args, signed char *);
        break;
      case TYPE_COUNT_SHORT_POINTER:
        ap->a.a_count_short_pointer = va_arg (args, short *);
        break;
      case TYPE_COUNT_INT_POINTER:
        ap->a.a_count_int_pointer = va_arg (args, int *);
        break;
      case TYPE_COUNT_LONGINT_POINTER:
        ap->a.a_count_longint_pointer = va_arg (args, long int *);
        break;
      case TYPE_COUNT_LONGLONGINT_POINTER:
        ap->a.a_count_longlongint_pointer = va_arg (args, long long int *);
        break;
      case TYPE_COUNT_INT8_T_POINTER:
        ap->a.a_count_int8_t_pointer = va_arg (args, int8_t *);
        break;
      case TYPE_COUNT_INT16_T_POINTER:
        ap->a.a_count_int16_t_pointer = va_arg (args, int16_t *);
        break;
      case TYPE_COUNT_INT32_T_POINTER:
        ap->a.a_count_int32_t_pointer = va_arg (args, int32_t *);
        break;
      case TYPE_COUNT_INT64_T_POINTER:
        ap->a.a_count_int64_t_pointer = va_arg (args, int64_t *);
        break;
      case TYPE_COUNT_INT_FAST8_T_POINTER:
        ap->a.a_count_int_fast8_t_pointer = va_arg (args, int_fast8_t *);
        break;
      case TYPE_COUNT_INT_FAST16_T_POINTER:
        ap->a.a_count_int_fast16_t_pointer = va_arg (args, int_fast16_t *);
        break;
      case TYPE_COUNT_INT_FAST32_T_POINTER:
        ap->a.a_count_int_fast32_t_pointer = va_arg (args, int_fast32_t *);
        break;
      case TYPE_COUNT_INT_FAST64_T_POINTER:
        ap->a.a_count_int_fast64_t_pointer = va_arg (args, int_fast64_t *);
        break;
#if ENABLE_UNISTDIO
      /* The unistdio extensions.  */
      case TYPE_U8_STRING:
        ap->a.a_u8_string = va_arg (args, const uint8_t *);
        /* A null pointer is an invalid argument for "%U", but in practice
           it occurs quite frequently in printf statements that produce
           debug output.  Use a fallback in this case.  */
        if (ap->a.a_u8_string == NULL)
          {
            static const uint8_t u8_null_string[] =
              { '(', 'N', 'U', 'L', 'L', ')', 0 };
            ap->a.a_u8_string = u8_null_string;
          }
        break;
      case TYPE_U16_STRING:
        ap->a.a_u16_string = va_arg (args, const uint16_t *);
        /* A null pointer is an invalid argument for "%lU", but in practice
           it occurs quite frequently in printf statements that produce
           debug output.  Use a fallback in this case.  */
        if (ap->a.a_u16_string == NULL)
          {
            static const uint16_t u16_null_string[] =
              { '(', 'N', 'U', 'L', 'L', ')', 0 };
            ap->a.a_u16_string = u16_null_string;
          }
        break;
      case TYPE_U32_STRING:
        ap->a.a_u32_string = va_arg (args, const uint32_t *);
        /* A null pointer is an invalid argument for "%llU", but in practice
           it occurs quite frequently in printf statements that produce
           debug output.  Use a fallback in this case.  */
        if (ap->a.a_u32_string == NULL)
          {
            static const uint32_t u32_null_string[] =
              { '(', 'N', 'U', 'L', 'L', ')', 0 };
            ap->a.a_u32_string = u32_null_string;
          }
        break;
#endif
      case TYPE_NONE:
        /* Argument i is not used by any directive, but some argument with
           number > i is used by a format directive.  POSIX says that this
           is invalid:
             "When numbered argument specifications are used, specifying the
              Nth argument requires that all the leading arguments, from the
              first to the (N-1)th, are specified in the format string."
           The reason is that we cannot know how many bytes to skip in the
           va_arg sequence.  */
        return -1;
      default:
        /* Unknown type.  Should not happen.  */
        abort ();
      }
  return 0;
}