Import upstream version 1.28
[debian/tar] / gnu / xstrtol.c
1 /* -*- buffer-read-only: t -*- vi: set ro: */
2 /* DO NOT EDIT! GENERATED AUTOMATICALLY! */
3 /* A more useful interface to strtol.
4
5    Copyright (C) 1995-1996, 1998-2001, 2003-2007, 2009-2014 Free Software
6    Foundation, Inc.
7
8    This program is free software: you can redistribute it and/or modify
9    it under the terms of the GNU General Public License as published by
10    the Free Software Foundation; either version 3 of the License, or
11    (at your option) any later version.
12
13    This program is distributed in the hope that it will be useful,
14    but WITHOUT ANY WARRANTY; without even the implied warranty of
15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16    GNU General Public License for more details.
17
18    You should have received a copy of the GNU General Public License
19    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
20
21 /* Written by Jim Meyering. */
22
23 #ifndef __strtol
24 # define __strtol strtol
25 # define __strtol_t long int
26 # define __xstrtol xstrtol
27 # define STRTOL_T_MINIMUM LONG_MIN
28 # define STRTOL_T_MAXIMUM LONG_MAX
29 #endif
30
31 #include <config.h>
32
33 #include "xstrtol.h"
34
35 /* Some pre-ANSI implementations (e.g. SunOS 4)
36    need stderr defined if assertion checking is enabled.  */
37 #include <stdio.h>
38
39 #include <assert.h>
40 #include <ctype.h>
41 #include <errno.h>
42 #include <limits.h>
43 #include <stdlib.h>
44 #include <string.h>
45
46 #include "intprops.h"
47
48 /* xstrtoll.c and xstrtoull.c, which include this file, require that
49    ULLONG_MAX, LLONG_MAX, LLONG_MIN are defined, but <limits.h> does not
50    define them on all platforms.  */
51 #ifndef ULLONG_MAX
52 # define ULLONG_MAX TYPE_MAXIMUM (unsigned long long)
53 #endif
54 #ifndef LLONG_MAX
55 # define LLONG_MAX TYPE_MAXIMUM (long long int)
56 #endif
57 #ifndef LLONG_MIN
58 # define LLONG_MIN TYPE_MINIMUM (long long int)
59 #endif
60
61 static strtol_error
62 bkm_scale (__strtol_t *x, int scale_factor)
63 {
64   if (TYPE_SIGNED (__strtol_t) && *x < STRTOL_T_MINIMUM / scale_factor)
65     {
66       *x = STRTOL_T_MINIMUM;
67       return LONGINT_OVERFLOW;
68     }
69   if (STRTOL_T_MAXIMUM / scale_factor < *x)
70     {
71       *x = STRTOL_T_MAXIMUM;
72       return LONGINT_OVERFLOW;
73     }
74   *x *= scale_factor;
75   return LONGINT_OK;
76 }
77
78 static strtol_error
79 bkm_scale_by_power (__strtol_t *x, int base, int power)
80 {
81   strtol_error err = LONGINT_OK;
82   while (power--)
83     err |= bkm_scale (x, base);
84   return err;
85 }
86
87 /* FIXME: comment.  */
88
89 strtol_error
90 __xstrtol (const char *s, char **ptr, int strtol_base,
91            __strtol_t *val, const char *valid_suffixes)
92 {
93   char *t_ptr;
94   char **p;
95   __strtol_t tmp;
96   strtol_error err = LONGINT_OK;
97
98   assert (0 <= strtol_base && strtol_base <= 36);
99
100   p = (ptr ? ptr : &t_ptr);
101
102   if (! TYPE_SIGNED (__strtol_t))
103     {
104       const char *q = s;
105       unsigned char ch = *q;
106       while (isspace (ch))
107         ch = *++q;
108       if (ch == '-')
109         return LONGINT_INVALID;
110     }
111
112   errno = 0;
113   tmp = __strtol (s, p, strtol_base);
114
115   if (*p == s)
116     {
117       /* If there is no number but there is a valid suffix, assume the
118          number is 1.  The string is invalid otherwise.  */
119       if (valid_suffixes && **p && strchr (valid_suffixes, **p))
120         tmp = 1;
121       else
122         return LONGINT_INVALID;
123     }
124   else if (errno != 0)
125     {
126       if (errno != ERANGE)
127         return LONGINT_INVALID;
128       err = LONGINT_OVERFLOW;
129     }
130
131   /* Let valid_suffixes == NULL mean "allow any suffix".  */
132   /* FIXME: update all callers except the ones that allow suffixes
133      after the number, changing last parameter NULL to "".  */
134   if (!valid_suffixes)
135     {
136       *val = tmp;
137       return err;
138     }
139
140   if (**p != '\0')
141     {
142       int base = 1024;
143       int suffixes = 1;
144       strtol_error overflow;
145
146       if (!strchr (valid_suffixes, **p))
147         {
148           *val = tmp;
149           return err | LONGINT_INVALID_SUFFIX_CHAR;
150         }
151
152       if (strchr (valid_suffixes, '0'))
153         {
154           /* The "valid suffix" '0' is a special flag meaning that
155              an optional second suffix is allowed, which can change
156              the base.  A suffix "B" (e.g. "100MB") stands for a power
157              of 1000, whereas a suffix "iB" (e.g. "100MiB") stands for
158              a power of 1024.  If no suffix (e.g. "100M"), assume
159              power-of-1024.  */
160
161           switch (p[0][1])
162             {
163             case 'i':
164               if (p[0][2] == 'B')
165                 suffixes += 2;
166               break;
167
168             case 'B':
169             case 'D': /* 'D' is obsolescent */
170               base = 1000;
171               suffixes++;
172               break;
173             }
174         }
175
176       switch (**p)
177         {
178         case 'b':
179           overflow = bkm_scale (&tmp, 512);
180           break;
181
182         case 'B':
183           overflow = bkm_scale (&tmp, 1024);
184           break;
185
186         case 'c':
187           overflow = 0;
188           break;
189
190         case 'E': /* exa or exbi */
191           overflow = bkm_scale_by_power (&tmp, base, 6);
192           break;
193
194         case 'G': /* giga or gibi */
195         case 'g': /* 'g' is undocumented; for compatibility only */
196           overflow = bkm_scale_by_power (&tmp, base, 3);
197           break;
198
199         case 'k': /* kilo */
200         case 'K': /* kibi */
201           overflow = bkm_scale_by_power (&tmp, base, 1);
202           break;
203
204         case 'M': /* mega or mebi */
205         case 'm': /* 'm' is undocumented; for compatibility only */
206           overflow = bkm_scale_by_power (&tmp, base, 2);
207           break;
208
209         case 'P': /* peta or pebi */
210           overflow = bkm_scale_by_power (&tmp, base, 5);
211           break;
212
213         case 'T': /* tera or tebi */
214         case 't': /* 't' is undocumented; for compatibility only */
215           overflow = bkm_scale_by_power (&tmp, base, 4);
216           break;
217
218         case 'w':
219           overflow = bkm_scale (&tmp, 2);
220           break;
221
222         case 'Y': /* yotta or 2**80 */
223           overflow = bkm_scale_by_power (&tmp, base, 8);
224           break;
225
226         case 'Z': /* zetta or 2**70 */
227           overflow = bkm_scale_by_power (&tmp, base, 7);
228           break;
229
230         default:
231           *val = tmp;
232           return err | LONGINT_INVALID_SUFFIX_CHAR;
233         }
234
235       err |= overflow;
236       *p += suffixes;
237       if (**p)
238         err |= LONGINT_INVALID_SUFFIX_CHAR;
239     }
240
241   *val = tmp;
242   return err;
243 }