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 <getopt.h>
  24 # include <inttypes.h>
  25
  26 # ifndef _STRTOL_ERROR
  27 enum strtol_error
  28   {
  29     LONGINT_OK = 0,
  30
  31     /* These two values can be ORed together, to indicate that both
  32        errors occurred.  */
  33     LONGINT_OVERFLOW = 1,
  34     LONGINT_INVALID_SUFFIX_CHAR = 2,
  35
  36     LONGINT_INVALID_SUFFIX_CHAR_WITH_OVERFLOW = (LONGINT_INVALID_SUFFIX_CHAR
  37                                                  | LONGINT_OVERFLOW),
  38     LONGINT_INVALID = 4
  39   };
  40 typedef enum strtol_error strtol_error;
  41 # endif
  42
  43 # define _DECLARE_XSTRTOL(name, type) \
  44   strtol_error name (const char *, char **, int, type *, const char *);
  45 _DECLARE_XSTRTOL (xstrtol, long int)
  46 _DECLARE_XSTRTOL (xstrtoul, unsigned long int)
  47 _DECLARE_XSTRTOL (xstrtoimax, intmax_t)
  48 _DECLARE_XSTRTOL (xstrtoumax, uintmax_t)
  49
  50 #ifndef __attribute__
  51 # if __GNUC__ < 2 || (__GNUC__ == 2 && __GNUC_MINOR__ < 8) || __STRICT_ANSI__
  52 #  define __attribute__(x)
  53 # endif
  54 #endif
  55
  56 #ifndef ATTRIBUTE_NORETURN
  57 # define ATTRIBUTE_NORETURN __attribute__ ((__noreturn__))
  58 #endif
  59
  60 /* Report an error for an invalid integer in an option argument.
  61
  62    ERR is the error code returned by one of the xstrto* functions.
  63
  64    Use OPT_IDX to decide whether to print the short option string "C"
  65    or "-C" or a long option string derived from LONG_OPTION.  OPT_IDX
  66    is -2 if the short option "C" was used, without any leading "-"; it
  67    is -1 if the short option "-C" was used; otherwise it is an index
  68    into LONG_OPTIONS, which should have a name preceded by two '-'
  69    characters.
  70
  71    ARG is the option-argument containing the integer.
  72
  73    After reporting an error, exit with a failure status.  */
  74
  75 void xstrtol_fatal (enum strtol_error,
  76                     int, char, struct option const *,
  77                     char const *) ATTRIBUTE_NORETURN;
  78
  79 #endif /* not XSTRTOL_H_ */