Add and change modules to make it easier for coreutils to use
[gnulib.git] / lib / xstrtol.h
1 /* A more useful interface to strtol.
2
3    Copyright (C) 1995, 1996, 1998, 1999, 2001, 2002, 2003, 2004, 2006
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 # define _STRTOL_ERROR(Exit_code, Str, Argument_type_string, Err)       \
52   do                                                                    \
53     {                                                                   \
54       switch ((Err))                                                    \
55         {                                                               \
56         default:                                                        \
57           abort ();                                                     \
58                                                                         \
59         case LONGINT_INVALID:                                           \
60           error ((Exit_code), 0, "invalid %s `%s'",                     \
61                  (Argument_type_string), (Str));                        \
62           break;                                                        \
63                                                                         \
64         case LONGINT_INVALID_SUFFIX_CHAR:                               \
65         case LONGINT_INVALID_SUFFIX_CHAR | LONGINT_OVERFLOW:            \
66           error ((Exit_code), 0, "invalid character following %s in `%s'", \
67                  (Argument_type_string), (Str));                        \
68           break;                                                        \
69                                                                         \
70         case LONGINT_OVERFLOW:                                          \
71           error ((Exit_code), 0, "%s `%s' too large",                   \
72                  (Argument_type_string), (Str));                        \
73           break;                                                        \
74         }                                                               \
75     }                                                                   \
76   while (0)
77
78 # define STRTOL_FATAL_ERROR(Str, Argument_type_string, Err)             \
79   _STRTOL_ERROR (exit_failure, Str, Argument_type_string, Err)
80
81 # define STRTOL_FAIL_WARN(Str, Argument_type_string, Err)               \
82   _STRTOL_ERROR (0, Str, Argument_type_string, Err)
83
84 #endif /* not XSTRTOL_H_ */