lib/xstrerror.h

   1 /* Return diagnostic string based on error code.
   2    Copyright (C) 2023-2024 Free Software Foundation, Inc.
   3
   4    This program is free software: you can redistribute it and/or modify
   5    it under the terms of the GNU General Public License as published by
   6    the Free Software Foundation, either version 3 of the License, or
   7    (at your option) any later version.
   8
   9    This program is distributed in the hope that it will be useful,
  10    but WITHOUT ANY WARRANTY; without even the implied warranty of
  11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12    GNU General Public License for more details.
  13
  14    You should have received a copy of the GNU General Public License
  15    along with this program.  If not, see <https://www.gnu.org/licenses/>.  */
  16
  17 #ifndef _XSTRERROR_H
  18 #define _XSTRERROR_H
  19
  20 /* This file uses _GL_ATTRIBUTE_MALLOC, _GL_ATTRIBUTE_RETURNS_NONNULL.  */
  21 #if !_GL_CONFIG_H_INCLUDED
  22  #error "Please include config.h first."
  23 #endif
  24
  25 /* Get 'free'.  */
  26 #include <stdlib.h>
  27
  28 #ifdef __cplusplus
  29 extern "C" {
  30 #endif
  31
  32 /* Return a freshly allocated diagnostic string that contains a given string
  33    MESSAGE and the (internationalized) description of the error code ERRNUM.
  34    Upon [ENOMEM] memory allocation error, call xalloc_die.
  35
  36    This function is multithread-safe.  */
  37 extern char *xstrerror (const char *message, int errnum)
  38        _GL_ATTRIBUTE_MALLOC _GL_ATTRIBUTE_DEALLOC_FREE
  39        _GL_ATTRIBUTE_RETURNS_NONNULL;
  40
  41 #ifdef __cplusplus
  42 }
  43 #endif
  44
  45 #endif /* _XSTRERROR_H */