Document various strtod bugs, with some fixes.
[gnulib.git] / lib / strtod.c
1 /* Copyright (C) 1991, 1992, 1997, 1999, 2003, 2006, 2008 Free
2    Software Foundation, Inc.
3
4    This program is free software: you can redistribute it and/or modify
5    it under the terms of the GNU General Public License as published by
6    the Free Software Foundation; either version 3 of the License, or
7    (at your option) any later version.
8
9    This program is distributed in the hope that it will be useful,
10    but WITHOUT ANY WARRANTY; without even the implied warranty of
11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12    GNU General Public License for more details.
13
14    You should have received a copy of the GNU General Public License
15    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
16
17 #include <config.h>
18
19 #include <stdlib.h>
20
21 #include <ctype.h>
22 #include <errno.h>
23 #include <float.h>
24 #include <math.h>
25 #include <stdbool.h>
26 #include <string.h>
27
28 /* Convert NPTR to a double.  If ENDPTR is not NULL, a pointer to the
29    character after the last one used in the number is put in *ENDPTR.  */
30 double
31 strtod (const char *nptr, char **endptr)
32 {
33   const char *s;
34   bool negative = false;
35
36   /* The number so far.  */
37   double num;
38
39   bool got_dot;                 /* Found a decimal point.  */
40   bool got_digit;               /* Seen any digits.  */
41
42   /* The exponent of the number.  */
43   long int exponent;
44
45   if (nptr == NULL)
46     {
47       errno = EINVAL;
48       goto noconv;
49     }
50
51   s = nptr;
52
53   /* Eat whitespace.  */
54   while (isspace ((unsigned char) *s))
55     ++s;
56
57   /* Get the sign.  */
58   negative = *s == '-';
59   if (*s == '-' || *s == '+')
60     ++s;
61
62   num = 0.0;
63   got_dot = false;
64   got_digit = false;
65   exponent = 0;
66   for (;; ++s)
67     {
68       if ('0' <= *s && *s <= '9')
69         {
70           got_digit = true;
71
72           /* Make sure that multiplication by 10 will not overflow.  */
73           if (num > DBL_MAX * 0.1)
74             /* The value of the digit doesn't matter, since we have already
75                gotten as many digits as can be represented in a `double'.
76                This doesn't necessarily mean the result will overflow.
77                The exponent may reduce it to within range.
78
79                We just need to record that there was another
80                digit so that we can multiply by 10 later.  */
81             ++exponent;
82           else
83             num = (num * 10.0) + (*s - '0');
84
85           /* Keep track of the number of digits after the decimal point.
86              If we just divided by 10 here, we would lose precision.  */
87           if (got_dot)
88             --exponent;
89         }
90       else if (!got_dot && *s == '.')
91         /* Record that we have found the decimal point.  */
92         got_dot = true;
93       else
94         /* Any other character terminates the number.  */
95         break;
96     }
97
98   if (!got_digit)
99     {
100       /* Check for infinities and NaNs.  */
101       if (tolower ((unsigned char) *s) == 'i'
102           && tolower ((unsigned char) s[1]) == 'n'
103           && tolower ((unsigned char) s[2]) == 'f')
104         {
105           s += 3;
106           num = HUGE_VAL;
107           if (tolower ((unsigned char) *s) == 'i'
108               && tolower ((unsigned char) s[1]) == 'n'
109               && tolower ((unsigned char) s[2]) == 'i'
110               && tolower ((unsigned char) s[3]) == 't'
111               && tolower ((unsigned char) s[4]) == 'y')
112             s += 5;
113           goto valid;
114         }
115 #ifdef NAN
116       else if (tolower ((unsigned char) *s) == 'n'
117                && tolower ((unsigned char) s[1]) == 'a'
118                && tolower ((unsigned char) s[2]) == 'n')
119         {
120           s += 3;
121           num = NAN;
122           /* Since nan(<n-char-sequence>) is implementation-defined,
123              we define it by ignoring <n-char-sequence>.  A nicer
124              implementation would populate the bits of the NaN
125              according to interpreting n-char-sequence as a
126              hexadecimal number, but the result is still a NaN.  */
127           if (*s == '(')
128             {
129               const char *p = s + 1;
130               while (isalnum ((unsigned char) *p))
131                 p++;
132               if (*p == ')')
133                 s = p + 1;
134             }
135           goto valid;
136         }
137 #endif
138       goto noconv;
139     }
140
141   if (tolower ((unsigned char) *s) == 'e')
142     {
143       /* Get the exponent specified after the `e' or `E'.  */
144       int save = errno;
145       char *end;
146       long int exp;
147
148       errno = 0;
149       ++s;
150       exp = strtol (s, &end, 10);
151       if (errno == ERANGE && num)
152         {
153           /* The exponent overflowed a `long int'.  It is probably a safe
154              assumption that an exponent that cannot be represented by
155              a `long int' exceeds the limits of a `double'.  */
156           if (endptr != NULL)
157             *endptr = end;
158           if (exp < 0)
159             goto underflow;
160           else
161             goto overflow;
162         }
163       else if (end == s)
164         /* There was no exponent.  Reset END to point to
165            the 'e' or 'E', so *ENDPTR will be set there.  */
166         end = (char *) s - 1;
167       errno = save;
168       s = end;
169       exponent += exp;
170     }
171
172   if (num == 0.0)
173     goto valid;
174
175   /* Multiply NUM by 10 to the EXPONENT power,
176      checking for overflow and underflow.  */
177
178   if (exponent < 0)
179     {
180       if (num < DBL_MIN * pow (10.0, (double) -exponent))
181         goto underflow;
182     }
183   else if (exponent > 0)
184     {
185       if (num > DBL_MAX * pow (10.0, (double) -exponent))
186         goto overflow;
187     }
188
189   num *= pow (10.0, (double) exponent);
190
191  valid:
192   if (endptr != NULL)
193     *endptr = (char *) s;
194   return negative ? -num : num;
195
196  overflow:
197   /* Return an overflow error.  */
198   if (endptr != NULL)
199     *endptr = (char *) s;
200   errno = ERANGE;
201   return negative ? -HUGE_VAL : HUGE_VAL;
202
203  underflow:
204   /* Return an underflow error.  */
205   if (endptr != NULL)
206     *endptr = (char *) s;
207   errno = ERANGE;
208   return negative ? -0.0 : 0.0;
209
210  noconv:
211   /* There was no number.  */
212   if (endptr != NULL)
213     *endptr = (char *) nptr;
214   errno = EINVAL;
215   return 0.0;
216 }