From 6d20768e5a08a393aee4099419794e0cca495967 Mon Sep 17 00:00:00 2001 From: Bruno Haible Date: Thu, 5 Oct 2023 18:01:05 +0200 Subject: [PATCH] xstrerror: New module. * lib/xstrerror.h: New file. * lib/xstrerror.c: New file. * modules/xstrerror: New file. * modules/strerror_r-posix (configure.ac): Update comment. --- ChangeLog | 8 ++++++ lib/xstrerror.c | 59 ++++++++++++++++++++++++++++++++++++++++ lib/xstrerror.h | 45 ++++++++++++++++++++++++++++++ modules/strerror_r-posix | 2 +- modules/xstrerror | 26 ++++++++++++++++++ 5 files changed, 139 insertions(+), 1 deletion(-) create mode 100644 lib/xstrerror.c create mode 100644 lib/xstrerror.h create mode 100644 modules/xstrerror diff --git a/ChangeLog b/ChangeLog index f09de5233e..b8aefaf222 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,11 @@ +2023-10-05 Bruno Haible + + xstrerror: New module. + * lib/xstrerror.h: New file. + * lib/xstrerror.c: New file. + * modules/xstrerror: New file. + * modules/strerror_r-posix (configure.ac): Update comment. + 2023-10-05 Paul Eggert isnan: slightly simplify configuration diff --git a/lib/xstrerror.c b/lib/xstrerror.c new file mode 100644 index 0000000000..d00b996627 --- /dev/null +++ b/lib/xstrerror.c @@ -0,0 +1,59 @@ +/* Return diagnostic string based on error code. + Copyright (C) 2023 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 of the License, or + (at your option) any later version. + + This program 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. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . */ + +#include + +/* Specification. */ +#include "xstrerror.h" + +#include + +#include "xvasprintf.h" +#include "xalloc.h" +#include "gettext.h" + +#define _(msgid) gettext (msgid) + +char * +xstrerror (const char *message, int errnum) +{ + /* Get the internationalized description of errnum, + in a stack-allocated buffer. */ + const char *errdesc; + char errbuf[1024]; +#if !GNULIB_STRERROR_R_POSIX && STRERROR_R_CHAR_P + errdesc = strerror_r (errnum, errbuf, sizeof errbuf); +#else + if (strerror_r (errnum, errbuf, sizeof errbuf) == 0) + errdesc = errbuf; + else + errdesc = NULL; +#endif + if (errdesc == NULL) + errdesc = _("Unknown system error"); + + if (message != NULL) + { + /* Allow e.g. French translators to insert a space before the colon. */ + char *result = xasprintf (_("%s: %s"), message, errdesc); + if (result == NULL) + /* Probably a buggy translation. Use a safe fallback. */ + result = xasprintf ("%s%s%s", message, ": ", errdesc); + return result; + } + else + return xstrdup (errdesc); +} diff --git a/lib/xstrerror.h b/lib/xstrerror.h new file mode 100644 index 0000000000..95beb1d64a --- /dev/null +++ b/lib/xstrerror.h @@ -0,0 +1,45 @@ +/* Return diagnostic string based on error code. + Copyright (C) 2023 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 of the License, or + (at your option) any later version. + + This program 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. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . */ + +#ifndef _XSTRERROR_H +#define _XSTRERROR_H + +/* This file uses _GL_ATTRIBUTE_MALLOC, _GL_ATTRIBUTE_RETURNS_NONNULL. */ +#if !_GL_CONFIG_H_INCLUDED + #error "Please include config.h first." +#endif + +/* Get 'free'. */ +#include + +#ifdef __cplusplus +extern "C" { +#endif + +/* Return a freshly allocated diagnostic string that contains a given string + MESSAGE and the (internationalized) description of the error code ERRNUM. + Upon [ENOMEM] memory allocation error, call xalloc_die. + + This function is multithread-safe. */ +extern char *xstrerror (const char *message, int errnum) + _GL_ATTRIBUTE_MALLOC _GL_ATTRIBUTE_DEALLOC_FREE + _GL_ATTRIBUTE_RETURNS_NONNULL; + +#ifdef __cplusplus +} +#endif + +#endif /* _XSTRERROR_H */ diff --git a/modules/strerror_r-posix b/modules/strerror_r-posix index 25f049365a..779a821e9e 100644 --- a/modules/strerror_r-posix +++ b/modules/strerror_r-posix @@ -19,7 +19,7 @@ AS_IF([test $HAVE_DECL_STRERROR_R = 0 || test $REPLACE_STRERROR_R = 1], [ gl_PREREQ_STRERROR_R ]) gl_STRING_MODULE_INDICATOR([strerror_r]) -dnl For the modules argp, error. +dnl For the modules argp, error, xstrerror. gl_MODULE_INDICATOR([strerror_r-posix]) Makefile.am: diff --git a/modules/xstrerror b/modules/xstrerror new file mode 100644 index 0000000000..927d4c74a7 --- /dev/null +++ b/modules/xstrerror @@ -0,0 +1,26 @@ +Description: +xstrerror() function: return diagnostic string based on error code. +Multithread-safe. With out-of-memory checking. + +Files: +lib/xstrerror.h +lib/xstrerror.c + +Depends-on: +strerror_r-posix +xalloc +xvasprintf + +configure.ac: + +Makefile.am: +lib_SOURCES += xstrerror.c + +Include: +"xstrerror.h" + +License: +GPL + +Maintainer: +all -- 2.39.5