lib/xstrtol-error.h

   1 /* Error reporting interface for xstrto* functions.
   2
   3    Copyright (C) 1995-1996, 1998-1999, 2001-2004, 2006-2024 Free Software
   4    Foundation, Inc.
   5
   6    This program is free software: you can redistribute it and/or modify
   7    it under the terms of the GNU General Public License as published by
   8    the Free Software Foundation, either version 3 of the License, or
   9    (at your option) any later version.
  10
  11    This program is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14    GNU General Public License for more details.
  15
  16    You should have received a copy of the GNU General Public License
  17    along with this program.  If not, see <https://www.gnu.org/licenses/>.  */
  18
  19 #ifndef XSTRTOL_ERROR_H_
  20 # define XSTRTOL_ERROR_H_ 1
  21
  22 /* This file uses _Noreturn.  */
  23 # if !_GL_CONFIG_H_INCLUDED
  24 #  error "Please include config.h first."
  25 # endif
  26
  27 # include "xstrtol.h"
  28
  29 # include <getopt.h>
  30
  31 /* Report an error for an invalid integer in an option argument.
  32
  33    ERR is the error code returned by one of the xstrto* functions.
  34
  35    Use OPT_IDX to decide whether to print the short option string "C"
  36    or "-C" or a long option string derived from LONG_OPTIONS.  OPT_IDX
  37    is -2 if the short option "C" was used, without any leading "-"; it
  38    is -1 if the short option "-C" was used; otherwise it is an index
  39    into LONG_OPTIONS, which should have a name preceded by two '-'
  40    characters.
  41
  42    ARG is the option-argument containing the integer.
  43
  44    After reporting an error, exit with a failure status.  */
  45
  46 _Noreturn void xstrtol_fatal (enum strtol_error /* err */,
  47                               int /* opt_idx */, char /* c */,
  48                               struct option const * /* long_options */,
  49                               char const * /* arg */);
  50
  51 #endif /* not XSTRTOL_ERROR_H_ */