/* Formatted output functions (printf functions family).

Copyright 2007-2025 Free Software Foundation, Inc.
Contributed by the Pascaline and Caramba projects, INRIA.

This file is part of the GNU MPFR Library.

The GNU MPFR Library 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 3 of the License, or (at your
option) any later version.

The GNU MPFR Library 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 the GNU MPFR Library; see the file COPYING.LESSER.
If not, see <https://www.gnu.org/licenses/>. */

#ifdef HAVE_CONFIG_H
# include "config.h"
#endif

/* The mpfr_printf-like functions are defined only if <stdarg.h> exists.
   Since they use mpf_t, they cannot be defined with mini-gmp. */
#if defined(HAVE_STDARG) && !defined(MPFR_USE_MINI_GMP)

#include <stdarg.h>

#include "mpfr-impl.h"

/* Each printf-like function calls mpfr_vasnprintf_aux (directly or
   via mpfr_vasprintf), which
   - returns the number of characters to be written excluding the
     terminating null character (disregarding the size argument);
   - returns -1 and sets the erange flag if this number exceeds INT_MAX
     (in that case, also sets errno to EOVERFLOW on POSIX systems).

   Moreover, since the output may contain non-terminating null characters
   (if %c is used with the value 0), the mpfr_free_str function must not be
   used to free the allocated memory, because the size may matter with some
   custom allocation functions. Anyway, mpfr_free_func is more efficient
   here, as the size does not need to be recomputed. */

#ifdef _MPFR_H_HAVE_FILE

#define GET_STR_VA(sz, str, fmt, ap)            \
  do                                            \
    {                                           \
      sz = mpfr_vasprintf (&(str), fmt, ap);    \
      if (sz < 0)                               \
        return -1;                              \
    } while (0)

#define GET_STR(sz, str, fmt)                   \
  do                                            \
    {                                           \
      va_list ap;                               \
      va_start(ap, fmt);                        \
      sz = mpfr_vasprintf (&(str), fmt, ap);    \
      va_end (ap);                              \
      if (sz < 0)                               \
        return -1;                              \
    } while (0)

#define MPFR_FPRINTF_END(ret, str, fp)          \
  do                                            \
    {                                           \
      int status;                               \
      status = fwrite ((str), (ret), 1, (fp));  \
      mpfr_free_func ((str), (ret) + 1);        \
      return status == 1 ? (ret) : -1;          \
    } while (0)

int
mpfr_printf (const char *fmt, ...)
{
  char *str;
  int ret;

  GET_STR (ret, str, fmt);
  MPFR_FPRINTF_END (ret, str, stdout);
}

int
mpfr_vprintf (const char *fmt, va_list ap)
{
  char *str;
  int ret;

  GET_STR_VA (ret, str, fmt, ap);
  MPFR_FPRINTF_END (ret, str, stdout);
}


int
mpfr_fprintf (FILE *fp, const char *fmt, ...)
{
  char *str;
  int ret;

  GET_STR (ret, str, fmt);
  MPFR_FPRINTF_END (ret, str, fp);
}

int
mpfr_vfprintf (FILE *fp, const char *fmt, va_list ap)
{
  char *str;
  int ret;

  GET_STR_VA (ret, str, fmt, ap);
  MPFR_FPRINTF_END (ret, str, fp);
}

#endif /* _MPFR_H_HAVE_FILE */

#define MPFR_SPRINTF_END(ret, buf, str)         \
  do                                            \
    {                                           \
      memcpy ((buf), (str), (ret) + 1);         \
      mpfr_free_func ((str), (ret) + 1);        \
      return (ret);                             \
    } while (0)

int
mpfr_sprintf (char *buf, const char *fmt, ...)
{
  char *str;
  int ret;

  GET_STR (ret, str, fmt);
  MPFR_SPRINTF_END (ret, buf, str);
}

int
mpfr_vsprintf (char *buf, const char *fmt, va_list ap)
{
  char *str;
  int ret;

  GET_STR_VA (ret, str, fmt, ap);
  MPFR_SPRINTF_END (ret, buf, str);
}

int
mpfr_snprintf (char *buf, size_t size, const char *fmt, ...)
{
  int ret;
  va_list ap;

  va_start(ap, fmt);
  ret = mpfr_vasnprintf_aux (NULL, buf, size, fmt, ap);
  va_end (ap);

  return ret;
}

int
mpfr_vsnprintf (char *buf, size_t size, const char *fmt, va_list ap)
{
  return mpfr_vasnprintf_aux (NULL, buf, size, fmt, ap);
}

int
mpfr_asprintf (char **pp, const char *fmt, ...)
{
  int ret;

  GET_STR (ret, *pp, fmt);

  return ret;
}

int
mpfr_vasprintf (char **ptr, const char *fmt, va_list ap)
{
  return mpfr_vasnprintf_aux (ptr, NULL, 0, fmt, ap);
}

#else /* HAVE_STDARG */

/* Avoid an empty translation unit (see ISO C99, 6.9) */
typedef int foo;

#endif /* HAVE_STDARG */