Change one-line summary to reflect that shred does
[coreutils.git] / lib / xstrtol.h
blob0d6b98482eff00a3b2514b3ce083925b9a75b251
1 /* A more useful interface to strtol.
3 Copyright (C) 1995, 1996, 1998, 1999, 2001, 2002, 2003, 2004 Free
4 Software Foundation, Inc.
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.
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.
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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */
20 #ifndef XSTRTOL_H_
21 # define XSTRTOL_H_ 1
23 # include "exitfail.h"
25 # if HAVE_INTTYPES_H
26 # include <inttypes.h>
27 # endif
28 # if HAVE_STDINT_H
29 # include <stdint.h>
30 # endif
32 # ifndef _STRTOL_ERROR
33 enum strtol_error
35 LONGINT_OK = 0,
37 /* These two values can be ORed together, to indicate that both
38 errors occurred. */
39 LONGINT_OVERFLOW = 1,
40 LONGINT_INVALID_SUFFIX_CHAR = 2,
42 LONGINT_INVALID_SUFFIX_CHAR_WITH_OVERFLOW = (LONGINT_INVALID_SUFFIX_CHAR
43 | LONGINT_OVERFLOW),
44 LONGINT_INVALID = 4
46 typedef enum strtol_error strtol_error;
47 # endif
49 # define _DECLARE_XSTRTOL(name, type) \
50 strtol_error name (const char *, char **, int, type *, const char *);
51 _DECLARE_XSTRTOL (xstrtol, long int)
52 _DECLARE_XSTRTOL (xstrtoul, unsigned long int)
53 _DECLARE_XSTRTOL (xstrtoimax, intmax_t)
54 _DECLARE_XSTRTOL (xstrtoumax, uintmax_t)
56 # define _STRTOL_ERROR(Exit_code, Str, Argument_type_string, Err) \
57 do \
58 { \
59 switch ((Err)) \
60 { \
61 default: \
62 abort (); \
64 case LONGINT_INVALID: \
65 error ((Exit_code), 0, "invalid %s `%s'", \
66 (Argument_type_string), (Str)); \
67 break; \
69 case LONGINT_INVALID_SUFFIX_CHAR: \
70 case LONGINT_INVALID_SUFFIX_CHAR | LONGINT_OVERFLOW: \
71 error ((Exit_code), 0, "invalid character following %s in `%s'", \
72 (Argument_type_string), (Str)); \
73 break; \
75 case LONGINT_OVERFLOW: \
76 error ((Exit_code), 0, "%s `%s' too large", \
77 (Argument_type_string), (Str)); \
78 break; \
79 } \
80 } \
81 while (0)
83 # define STRTOL_FATAL_ERROR(Str, Argument_type_string, Err) \
84 _STRTOL_ERROR (exit_failure, Str, Argument_type_string, Err)
86 # define STRTOL_FAIL_WARN(Str, Argument_type_string, Err) \
87 _STRTOL_ERROR (0, Str, Argument_type_string, Err)
89 #endif /* not XSTRTOL_H_ */