lib/xstrtol.h

   1 /* A more useful interface to strtol.
   2
   3    Copyright (C) 1995, 1996, 1998, 1999, 2001, 2002, 2003, 2004, 2006, 2007
   4    Free Software 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 2, or (at your option)
   9    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, write to the Free Software Foundation,
  18    Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.  */
  19
  20 #ifndef XSTRTOL_H_
  21 # define XSTRTOL_H_ 1
  22
  23 # include "exitfail.h"
  24
  25 # include <inttypes.h>
  26
  27 # ifndef _STRTOL_ERROR
  28 enum strtol_error
  29   {
  30     LONGINT_OK = 0,
  31
  32     /* These two values can be ORed together, to indicate that both
  33        errors occurred.  */
  34     LONGINT_OVERFLOW = 1,
  35     LONGINT_INVALID_SUFFIX_CHAR = 2,
  36
  37     LONGINT_INVALID_SUFFIX_CHAR_WITH_OVERFLOW = (LONGINT_INVALID_SUFFIX_CHAR
  38                                                  | LONGINT_OVERFLOW),
  39     LONGINT_INVALID = 4
  40   };
  41 typedef enum strtol_error strtol_error;
  42 # endif
  43
  44 # define _DECLARE_XSTRTOL(name, type) \
  45   strtol_error name (const char *, char **, int, type *, const char *);
  46 _DECLARE_XSTRTOL (xstrtol, long int)
  47 _DECLARE_XSTRTOL (xstrtoul, unsigned long int)
  48 _DECLARE_XSTRTOL (xstrtoimax, intmax_t)
  49 _DECLARE_XSTRTOL (xstrtoumax, uintmax_t)
  50
  51 /* Report an error for an out-of-range integer argument.
  52    EXIT_CODE is the exit code (0 for a non-fatal error).
  53    OPTION is the option that takes the argument
  54     (usually starting with one or two minus signs).
  55    ARG is the option's argument.
  56    ERR is the error code returned by one of the xstrto* functions.  */
  57 void xstrtol_error (int exit_code, char const *option, char const *arg,
  58                     strtol_error err);
  59
  60 # define STRTOL_FATAL_ERROR(Option, Arg, Err)                           \
  61   xstrtol_error (exit_failure, Option, Arg, Err)
  62
  63 #endif /* not XSTRTOL_H_ */