From: Bruno Haible Date: Sun, 30 Jun 2024 16:31:56 +0000 (+0200) Subject: vfzprintf: New module. X-Git-Url: https://gitweb.git.savannah.gnu.org/gitweb/?a=commitdiff_plain;h=133fc37f5cbb6d7310844ea2b411dd845e70bb83;p=gnulib.git vfzprintf: New module. * lib/stdio.in.h (vfzprintf): New declaration. * lib/vfzprintf.c: New file, based on lib/vfprintf.c and lib/vdzprintf.c. * m4/stdio_h.m4 (gl_STDIO_H_REQUIRE_DEFAULTS): Initialize GNULIB_VFZPRINTF. * modules/stdio (Makefile.am): Substitute GNULIB_VFZPRINTF. * modules/vfzprintf: New file. --- diff --git a/ChangeLog b/ChangeLog index a1c3732254..bb0e4aa50d 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,14 @@ +2024-06-30 Bruno Haible + + vfzprintf: New module. + * lib/stdio.in.h (vfzprintf): New declaration. + * lib/vfzprintf.c: New file, based on lib/vfprintf.c and + lib/vdzprintf.c. + * m4/stdio_h.m4 (gl_STDIO_H_REQUIRE_DEFAULTS): Initialize + GNULIB_VFZPRINTF. + * modules/stdio (Makefile.am): Substitute GNULIB_VFZPRINTF. + * modules/vfzprintf: New file. + 2024-06-30 Bruno Haible dzprintf-gnu: Add tests. diff --git a/lib/stdio.in.h b/lib/stdio.in.h index acbe14cc41..e4a0997919 100644 --- a/lib/stdio.in.h +++ b/lib/stdio.in.h @@ -1775,6 +1775,24 @@ _GL_WARN_ON_USE (vdprintf, "vdprintf is unportable - " # endif #endif +#if @GNULIB_VFZPRINTF@ +/* Prints formatted output to stream FP. + Returns the number of bytes written to the stream. Upon failure, + returns -1 with the stream's error indicator set. + Failure cause EOVERFLOW can only occur when a width > INT_MAX is used. + Therefore, if the format string is valid and does not use %ls/%lc + directives nor widths, the only possible failure causes are ENOMEM + and the possible failure causes from fwrite(). */ +_GL_FUNCDECL_SYS (vfzprintf, off64_t, + (FILE *restrict fp, + const char *restrict format, va_list args) + _GL_ATTRIBUTE_FORMAT_PRINTF_STANDARD (2, 0) + _GL_ARG_NONNULL ((1, 2))); +_GL_CXXALIAS_SYS (vfzprintf, off64_t, + (FILE *restrict fp, + const char *restrict format, va_list args)); +#endif + #if @GNULIB_VFPRINTF_POSIX@ || @GNULIB_VFPRINTF@ # if (@GNULIB_VFPRINTF_POSIX@ && @REPLACE_VFPRINTF@) \ || (@GNULIB_VFPRINTF@ && @REPLACE_STDIO_WRITE_FUNCS@ && (@GNULIB_STDIO_H_NONBLOCKING@ || @GNULIB_STDIO_H_SIGPIPE@)) diff --git a/lib/vfzprintf.c b/lib/vfzprintf.c new file mode 100644 index 0000000000..94e71a2568 --- /dev/null +++ b/lib/vfzprintf.c @@ -0,0 +1,72 @@ +/* Formatted output to a stream. + Copyright (C) 2004, 2006-2024 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 3 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 . */ + +#ifdef HAVE_CONFIG_H +# include +#endif + +/* Specification. */ +#include + +#include +#include +#include + +#include "fseterr.h" +#include "intprops.h" +#include "vasnprintf.h" + +off64_t +vfzprintf (FILE *fp, const char *format, va_list args) +{ + char buf[2000]; + char *output; + size_t len; + size_t lenbuf = sizeof (buf); + + output = vasnprintf (buf, &lenbuf, format, args); + len = lenbuf; + + if (!output) + { + fseterr (fp); + return -1; + } + + if (len > TYPE_MAXIMUM (off64_t)) + { + /* We could write the (huge) output, but then could not return len, as it + would be negative. Treat this case as if vasnprintf had already + encountered an out-of-memory situation. */ + if (output != buf) + free (output); + fseterr (fp); + errno = ENOMEM; + return -1; + } + + if (fwrite (output, 1, len, fp) < len) + { + if (output != buf) + free (output); + return -1; + } + + if (output != buf) + free (output); + + return len; +} diff --git a/m4/stdio_h.m4 b/m4/stdio_h.m4 index 126e395fae..090d5cd110 100644 --- a/m4/stdio_h.m4 +++ b/m4/stdio_h.m4 @@ -1,5 +1,5 @@ # stdio_h.m4 -# serial 71 +# serial 72 dnl Copyright (C) 2007-2024 Free Software Foundation, Inc. dnl This file is free software; the Free Software Foundation dnl gives unlimited permission to copy and/or distribute it, @@ -188,6 +188,7 @@ AC_DEFUN([gl_STDIO_H_REQUIRE_DEFAULTS], gl_MODULE_INDICATOR_INIT_VARIABLE([GNULIB_VDZPRINTF]) gl_MODULE_INDICATOR_INIT_VARIABLE([GNULIB_VFPRINTF]) gl_MODULE_INDICATOR_INIT_VARIABLE([GNULIB_VFPRINTF_POSIX]) + gl_MODULE_INDICATOR_INIT_VARIABLE([GNULIB_VFZPRINTF]) gl_MODULE_INDICATOR_INIT_VARIABLE([GNULIB_VPRINTF]) gl_MODULE_INDICATOR_INIT_VARIABLE([GNULIB_VPRINTF_POSIX]) gl_MODULE_INDICATOR_INIT_VARIABLE([GNULIB_VSNPRINTF]) diff --git a/modules/stdio b/modules/stdio index 22008a2b90..ec8cf240d6 100644 --- a/modules/stdio +++ b/modules/stdio @@ -121,6 +121,7 @@ stdio.h: stdio.in.h $(top_builddir)/config.status $(CXXDEFS_H) $(ARG_NONNULL_H) -e 's/@''GNULIB_VDZPRINTF''@/$(GNULIB_VDZPRINTF)/g' \ -e 's/@''GNULIB_VFPRINTF''@/$(GNULIB_VFPRINTF)/g' \ -e 's/@''GNULIB_VFPRINTF_POSIX''@/$(GNULIB_VFPRINTF_POSIX)/g' \ + -e 's/@''GNULIB_VFZPRINTF''@/$(GNULIB_VFZPRINTF)/g' \ -e 's/@''GNULIB_VFSCANF''@/$(GNULIB_VFSCANF)/g' \ -e 's/@''GNULIB_VSCANF''@/$(GNULIB_VSCANF)/g' \ -e 's/@''GNULIB_VPRINTF''@/$(GNULIB_VPRINTF)/g' \ diff --git a/modules/vfzprintf b/modules/vfzprintf new file mode 100644 index 0000000000..45bafdb365 --- /dev/null +++ b/modules/vfzprintf @@ -0,0 +1,29 @@ +Description: +vfzprintf() function: print formatted output (without INT_MAX limitation) +to a stream + +Files: +lib/vfzprintf.c + +Depends-on: +stdio +vasnprintf +intprops +free-posix +fseterr +errno + +configure.ac: +gl_STDIO_MODULE_INDICATOR([vfzprintf]) + +Makefile.am: +lib_SOURCES += vfzprintf.c + +Include: + + +License: +LGPL + +Maintainer: +all