From: Bruno Haible Date: Sat, 22 Jun 2024 10:21:11 +0000 (+0200) Subject: c-vzsnprintf: New module. X-Git-Url: https://gitweb.git.savannah.gnu.org/gitweb/?a=commitdiff_plain;h=9c456389c96b0532596ea62bcc320f549540d10c;p=gnulib.git c-vzsnprintf: New module. * lib/c-vsnprintf.h: Change license to LGPLv2+. (c_vzsnprintf): New declaration. * lib/c-vzsnprintf.c: New file, based on lib/vzsnprintf.c. * modules/c-vzsnprintf: New file. --- diff --git a/ChangeLog b/ChangeLog index ef21dcc222..0f37171285 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,11 @@ +2024-06-22 Bruno Haible + + c-vzsnprintf: New module. + * lib/c-vsnprintf.h: Change license to LGPLv2+. + (c_vzsnprintf): New declaration. + * lib/c-vzsnprintf.c: New file, based on lib/vzsnprintf.c. + * modules/c-vzsnprintf: New file. + 2024-06-22 Bruno Haible xvasprintf: Guarantee a non-NULL result. diff --git a/lib/c-vsnprintf.h b/lib/c-vsnprintf.h index 57d689e297..e00ade93f8 100644 --- a/lib/c-vsnprintf.h +++ b/lib/c-vsnprintf.h @@ -1,18 +1,18 @@ /* vsnprintf in C locale. Copyright (C) 2012-2024 Free Software Foundation, Inc. - This program is free software; you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation, either version 3, or (at your option) - any later version. + 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 program is distributed in the hope that it will be useful, + 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 General Public License for more details. + GNU Lesser General Public License for more details. - You should have received a copy of the GNU General Public License along - with this program; if not, see . */ + You should have received a copy of the GNU Lesser General Public License + along with this program. If not, see . */ #ifndef _C_VSNPRINTF_H #define _C_VSNPRINTF_H @@ -22,7 +22,7 @@ #error "Please include config.h first." #endif -/* Get size_t. */ +/* Get size_t, ptrdiff_t. */ #include /* Get va_list. */ @@ -35,6 +35,22 @@ extern "C" { #endif +/* Prints formatted output to string STR. Similar to vsprintf, but the + additional parameter SIZE limits how much is written into STR. + STR may be NULL, in which case nothing will be written. + Returns the string length of the formatted string (which may be larger + than SIZE). Upon failure, returns -1 with errno set. + + Failure code 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 code is ENOMEM. + + Formatting takes place in the C locale, that is, the decimal point + used in floating-point formatting directives is always '.'. */ +extern ptrdiff_t c_vzsnprintf (char *restrict str, size_t size, + const char *format, va_list args) + _GL_ATTRIBUTE_FORMAT ((_GL_ATTRIBUTE_SPEC_PRINTF_STANDARD, 3, 0)); + extern int c_vsnprintf (char *restrict str, size_t size, const char *format, va_list args) _GL_ATTRIBUTE_FORMAT ((_GL_ATTRIBUTE_SPEC_PRINTF_STANDARD, 3, 0)); diff --git a/lib/c-vzsnprintf.c b/lib/c-vzsnprintf.c new file mode 100644 index 0000000000..948266dd99 --- /dev/null +++ b/lib/c-vzsnprintf.c @@ -0,0 +1,66 @@ +/* Formatted output to strings in C locale. + Copyright (C) 2004, 2006-2024 Free Software Foundation, Inc. + Written by Simon Josefsson and Yoann Vandoorselaere . + Modified for C locale by Ben Pfaff. + + 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 . */ + +#ifdef HAVE_CONFIG_H +# include +#endif + +/* Specification. */ +#include "c-vsnprintf.h" + +#include +#include +#include +#include +#include + +#include "c-vasnprintf.h" + +ptrdiff_t +c_vzsnprintf (char *str, size_t size, const char *format, va_list args) +{ + char *output; + size_t len; + size_t lenbuf = size; + + output = c_vasnprintf (str, &lenbuf, format, args); + len = lenbuf; + + if (!output) + return -1; + + if (output != str) + { + if (size) + { + size_t pruned_len = (len < size ? len : size - 1); + memcpy (str, output, pruned_len); + str[pruned_len] = '\0'; + } + + free (output); + } + + if (len > PTRDIFF_MAX) + { + errno = ENOMEM; + return -1; + } + + return len; +} diff --git a/modules/c-vzsnprintf b/modules/c-vzsnprintf new file mode 100644 index 0000000000..4049974f4a --- /dev/null +++ b/modules/c-vzsnprintf @@ -0,0 +1,27 @@ +Description: +c_vzsnprintf(): print formatted output from an stdarg argument list to a +fixed length string (without INT_MAX limitation) in C locale + +Files: +lib/c-vsnprintf.h +lib/c-vzsnprintf.c + +Depends-on: +stdint +stdio +c-vasnprintf + +configure.ac: +AC_REQUIRE([AC_C_RESTRICT]) + +Makefile.am: +lib_SOURCES += c-vzsnprintf.c + +Include: +"c-vsnprintf.h" + +License: +LGPLv2+ + +Maintainer: +all