]> Savannah Git Hosting - gnulib.git/commitdiff
c-zsnprintf: New module.
authorBruno Haible <bruno@clisp.org>
Sat, 22 Jun 2024 10:21:29 +0000 (12:21 +0200)
committerBruno Haible <bruno@clisp.org>
Sat, 22 Jun 2024 10:21:29 +0000 (12:21 +0200)
* lib/c-snprintf.h: Change license to LGPLv2+.
(c_zsnprintf): New declaration.
* lib/c-zsnprintf.c: New file, based on lib/zsnprintf.c.
* modules/c-zsnprintf: New file.

ChangeLog
lib/c-snprintf.h
lib/c-zsnprintf.c [new file with mode: 0644]
modules/c-zsnprintf [new file with mode: 0644]

index 9326d490e7a7a278158027b37d9776bbe99aa149..83445e3e8c750c74a8a920b3132acc4ddcc2d4ec 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,11 @@
+2024-06-22  Bruno Haible  <bruno@clisp.org>
+
+       c-zsnprintf: New module.
+       * lib/c-snprintf.h: Change license to LGPLv2+.
+       (c_zsnprintf): New declaration.
+       * lib/c-zsnprintf.c: New file, based on lib/zsnprintf.c.
+       * modules/c-zsnprintf: New file.
+
 2024-06-22  Bruno Haible  <bruno@clisp.org>
 
        c-vsnprintf: Use c-vzsnprintf.
index 8e2ab729d799d0f9fff65e9ea83a972c1c6da423..8e4a6cbe5951930c50c2ad257eaedc57c0afc4d8 100644 (file)
@@ -1,18 +1,18 @@
 /* snprintf 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 <https://www.gnu.org/licenses/>.  */
+   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/>.  */
 
 #ifndef _C_SNPRINTF_H
 #define _C_SNPRINTF_H
@@ -22,7 +22,7 @@
  #error "Please include config.h first."
 #endif
 
-/* Get size_t.  */
+/* Get size_t, ptrdiff_t.  */
 #include <stddef.h>
 
 /* Get _GL_ATTRIBUTE_SPEC_PRINTF_STANDARD.  */
 extern "C" {
 #endif
 
+/* Prints formatted output to string STR.  Similar to sprintf, 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_zsnprintf (char *restrict str, size_t size,
+                              const char *format, ...)
+       _GL_ATTRIBUTE_FORMAT ((_GL_ATTRIBUTE_SPEC_PRINTF_STANDARD, 3, 4));
+
 extern int c_snprintf (char *restrict str, size_t size,
                        const char *format, ...)
        _GL_ATTRIBUTE_FORMAT ((_GL_ATTRIBUTE_SPEC_PRINTF_STANDARD, 3, 4));
diff --git a/lib/c-zsnprintf.c b/lib/c-zsnprintf.c
new file mode 100644 (file)
index 0000000..85ed3f9
--- /dev/null
@@ -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 Paul Eggert.
+
+   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/>.  */
+
+#include <config.h>
+
+/* Specification.  */
+#include "c-snprintf.h"
+
+#include <errno.h>
+#include <stdarg.h>
+#include <stdint.h>
+#include <stdlib.h>
+#include <string.h>
+
+#include "c-vasnprintf.h"
+
+ptrdiff_t
+c_zsnprintf (char *str, size_t size, const char *format, ...)
+{
+  char *output;
+  size_t len;
+  size_t lenbuf = size;
+  va_list args;
+
+  va_start (args, format);
+  output = c_vasnprintf (str, &lenbuf, format, args);
+  len = lenbuf;
+  va_end (args);
+
+  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-zsnprintf b/modules/c-zsnprintf
new file mode 100644 (file)
index 0000000..5410db0
--- /dev/null
@@ -0,0 +1,27 @@
+Description:
+c_zsnprintf(): print formatted output to a fixed length string (without
+INT_MAX limitation) in C locale
+
+Files:
+lib/c-snprintf.h
+lib/c-zsnprintf.c
+
+Depends-on:
+stdint
+stdio
+c-vasnprintf
+
+configure.ac:
+AC_REQUIRE([AC_C_RESTRICT])
+
+Makefile.am:
+lib_SOURCES += c-zsnprintf.c
+
+Include:
+"c-snprintf.h"
+
+License:
+LGPLv2+
+
+Maintainer:
+all