PERL_UNUSED_CONTEXT -> remove interp context where possible
[perl.git] / numeric.c
1 /*    numeric.c
2  *
3  *    Copyright (C) 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001,
4  *    2002, 2003, 2004, 2005, 2006, 2007, 2008 by Larry Wall and others
5  *
6  *    You may distribute under the terms of either the GNU General Public
7  *    License or the Artistic License, as specified in the README file.
8  *
9  */
10
11 /*
12  * "That only makes eleven (plus one mislaid) and not fourteen,
13  *  unless wizards count differently to other people."  --Beorn
14  *
15  *     [p.115 of _The Hobbit_: "Queer Lodgings"]
16  */
17
18 /*
19 =head1 Numeric functions
20
21 =cut
22
23 This file contains all the stuff needed by perl for manipulating numeric
24 values, including such things as replacements for the OS's atof() function
25
26 */
27
28 #include "EXTERN.h"
29 #define PERL_IN_NUMERIC_C
30 #include "perl.h"
31
32 U32
33 Perl_cast_ulong(NV f)
34 {
35   if (f < 0.0)
36     return f < I32_MIN ? (U32) I32_MIN : (U32)(I32) f;
37   if (f < U32_MAX_P1) {
38 #if CASTFLAGS & 2
39     if (f < U32_MAX_P1_HALF)
40       return (U32) f;
41     f -= U32_MAX_P1_HALF;
42     return ((U32) f) | (1 + U32_MAX >> 1);
43 #else
44     return (U32) f;
45 #endif
46   }
47   return f > 0 ? U32_MAX : 0 /* NaN */;
48 }
49
50 I32
51 Perl_cast_i32(NV f)
52 {
53   if (f < I32_MAX_P1)
54     return f < I32_MIN ? I32_MIN : (I32) f;
55   if (f < U32_MAX_P1) {
56 #if CASTFLAGS & 2
57     if (f < U32_MAX_P1_HALF)
58       return (I32)(U32) f;
59     f -= U32_MAX_P1_HALF;
60     return (I32)(((U32) f) | (1 + U32_MAX >> 1));
61 #else
62     return (I32)(U32) f;
63 #endif
64   }
65   return f > 0 ? (I32)U32_MAX : 0 /* NaN */;
66 }
67
68 IV
69 Perl_cast_iv(NV f)
70 {
71   if (f < IV_MAX_P1)
72     return f < IV_MIN ? IV_MIN : (IV) f;
73   if (f < UV_MAX_P1) {
74 #if CASTFLAGS & 2
75     /* For future flexibility allowing for sizeof(UV) >= sizeof(IV)  */
76     if (f < UV_MAX_P1_HALF)
77       return (IV)(UV) f;
78     f -= UV_MAX_P1_HALF;
79     return (IV)(((UV) f) | (1 + UV_MAX >> 1));
80 #else
81     return (IV)(UV) f;
82 #endif
83   }
84   return f > 0 ? (IV)UV_MAX : 0 /* NaN */;
85 }
86
87 UV
88 Perl_cast_uv(NV f)
89 {
90   if (f < 0.0)
91     return f < IV_MIN ? (UV) IV_MIN : (UV)(IV) f;
92   if (f < UV_MAX_P1) {
93 #if CASTFLAGS & 2
94     if (f < UV_MAX_P1_HALF)
95       return (UV) f;
96     f -= UV_MAX_P1_HALF;
97     return ((UV) f) | (1 + UV_MAX >> 1);
98 #else
99     return (UV) f;
100 #endif
101   }
102   return f > 0 ? UV_MAX : 0 /* NaN */;
103 }
104
105 /*
106 =for apidoc grok_bin
107
108 converts a string representing a binary number to numeric form.
109
110 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
111 conversion flags, and I<result> should be NULL or a pointer to an NV.
112 The scan stops at the end of the string, or the first invalid character.
113 Unless C<PERL_SCAN_SILENT_ILLDIGIT> is set in I<*flags>, encountering an
114 invalid character will also trigger a warning.
115 On return I<*len> is set to the length of the scanned string,
116 and I<*flags> gives output flags.
117
118 If the value is <= C<UV_MAX> it is returned as a UV, the output flags are clear,
119 and nothing is written to I<*result>.  If the value is > UV_MAX C<grok_bin>
120 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
121 and writes the value to I<*result> (or the value is discarded if I<result>
122 is NULL).
123
124 The binary number may optionally be prefixed with "0b" or "b" unless
125 C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry.  If
126 C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the binary
127 number may use '_' characters to separate digits.
128
129 =cut
130
131 Not documented yet because experimental is C<PERL_SCAN_SILENT_NON_PORTABLE
132 which suppresses any message for non-portable numbers that are still valid
133 on this platform.
134  */
135
136 UV
137 Perl_grok_bin(pTHX_ const char *start, STRLEN *len_p, I32 *flags, NV *result)
138 {
139     const char *s = start;
140     STRLEN len = *len_p;
141     UV value = 0;
142     NV value_nv = 0;
143
144     const UV max_div_2 = UV_MAX / 2;
145     const bool allow_underscores = cBOOL(*flags & PERL_SCAN_ALLOW_UNDERSCORES);
146     bool overflowed = FALSE;
147     char bit;
148
149     PERL_ARGS_ASSERT_GROK_BIN;
150
151     if (!(*flags & PERL_SCAN_DISALLOW_PREFIX)) {
152         /* strip off leading b or 0b.
153            for compatibility silently suffer "b" and "0b" as valid binary
154            numbers. */
155         if (len >= 1) {
156             if (s[0] == 'b' || s[0] == 'B') {
157                 s++;
158                 len--;
159             }
160             else if (len >= 2 && s[0] == '0' && (s[1] == 'b' || s[1] == 'B')) {
161                 s+=2;
162                 len-=2;
163             }
164         }
165     }
166
167     for (; len-- && (bit = *s); s++) {
168         if (bit == '0' || bit == '1') {
169             /* Write it in this wonky order with a goto to attempt to get the
170                compiler to make the common case integer-only loop pretty tight.
171                With gcc seems to be much straighter code than old scan_bin.  */
172           redo:
173             if (!overflowed) {
174                 if (value <= max_div_2) {
175                     value = (value << 1) | (bit - '0');
176                     continue;
177                 }
178                 /* Bah. We're just overflowed.  */
179                 /* diag_listed_as: Integer overflow in %s number */
180                 Perl_ck_warner_d(aTHX_ packWARN(WARN_OVERFLOW),
181                                  "Integer overflow in binary number");
182                 overflowed = TRUE;
183                 value_nv = (NV) value;
184             }
185             value_nv *= 2.0;
186             /* If an NV has not enough bits in its mantissa to
187              * represent a UV this summing of small low-order numbers
188              * is a waste of time (because the NV cannot preserve
189              * the low-order bits anyway): we could just remember when
190              * did we overflow and in the end just multiply value_nv by the
191              * right amount. */
192             value_nv += (NV)(bit - '0');
193             continue;
194         }
195         if (bit == '_' && len && allow_underscores && (bit = s[1])
196             && (bit == '0' || bit == '1'))
197             {
198                 --len;
199                 ++s;
200                 goto redo;
201             }
202         if (!(*flags & PERL_SCAN_SILENT_ILLDIGIT))
203             Perl_ck_warner(aTHX_ packWARN(WARN_DIGIT),
204                            "Illegal binary digit '%c' ignored", *s);
205         break;
206     }
207     
208     if (   ( overflowed && value_nv > 4294967295.0)
209 #if UVSIZE > 4
210         || (!overflowed && value > 0xffffffff
211             && ! (*flags & PERL_SCAN_SILENT_NON_PORTABLE))
212 #endif
213         ) {
214         Perl_ck_warner(aTHX_ packWARN(WARN_PORTABLE),
215                        "Binary number > 0b11111111111111111111111111111111 non-portable");
216     }
217     *len_p = s - start;
218     if (!overflowed) {
219         *flags = 0;
220         return value;
221     }
222     *flags = PERL_SCAN_GREATER_THAN_UV_MAX;
223     if (result)
224         *result = value_nv;
225     return UV_MAX;
226 }
227
228 /*
229 =for apidoc grok_hex
230
231 converts a string representing a hex number to numeric form.
232
233 On entry I<start> and I<*len_p> give the string to scan, I<*flags> gives
234 conversion flags, and I<result> should be NULL or a pointer to an NV.
235 The scan stops at the end of the string, or the first invalid character.
236 Unless C<PERL_SCAN_SILENT_ILLDIGIT> is set in I<*flags>, encountering an
237 invalid character will also trigger a warning.
238 On return I<*len> is set to the length of the scanned string,
239 and I<*flags> gives output flags.
240
241 If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
242 and nothing is written to I<*result>.  If the value is > UV_MAX C<grok_hex>
243 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
244 and writes the value to I<*result> (or the value is discarded if I<result>
245 is NULL).
246
247 The hex number may optionally be prefixed with "0x" or "x" unless
248 C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry.  If
249 C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the hex
250 number may use '_' characters to separate digits.
251
252 =cut
253
254 Not documented yet because experimental is C<PERL_SCAN_SILENT_NON_PORTABLE
255 which suppresses any message for non-portable numbers that are still valid
256 on this platform.
257  */
258
259 UV
260 Perl_grok_hex(pTHX_ const char *start, STRLEN *len_p, I32 *flags, NV *result)
261 {
262     dVAR;
263     const char *s = start;
264     STRLEN len = *len_p;
265     UV value = 0;
266     NV value_nv = 0;
267     const UV max_div_16 = UV_MAX / 16;
268     const bool allow_underscores = cBOOL(*flags & PERL_SCAN_ALLOW_UNDERSCORES);
269     bool overflowed = FALSE;
270
271     PERL_ARGS_ASSERT_GROK_HEX;
272
273     if (!(*flags & PERL_SCAN_DISALLOW_PREFIX)) {
274         /* strip off leading x or 0x.
275            for compatibility silently suffer "x" and "0x" as valid hex numbers.
276         */
277         if (len >= 1) {
278             if (s[0] == 'x' || s[0] == 'X') {
279                 s++;
280                 len--;
281             }
282             else if (len >= 2 && s[0] == '0' && (s[1] == 'x' || s[1] == 'X')) {
283                 s+=2;
284                 len-=2;
285             }
286         }
287     }
288
289     for (; len-- && *s; s++) {
290         if (isXDIGIT(*s)) {
291             /* Write it in this wonky order with a goto to attempt to get the
292                compiler to make the common case integer-only loop pretty tight.
293                With gcc seems to be much straighter code than old scan_hex.  */
294           redo:
295             if (!overflowed) {
296                 if (value <= max_div_16) {
297                     value = (value << 4) | XDIGIT_VALUE(*s);
298                     continue;
299                 }
300                 /* Bah. We're just overflowed.  */
301                 /* diag_listed_as: Integer overflow in %s number */
302                 Perl_ck_warner_d(aTHX_ packWARN(WARN_OVERFLOW),
303                                  "Integer overflow in hexadecimal number");
304                 overflowed = TRUE;
305                 value_nv = (NV) value;
306             }
307             value_nv *= 16.0;
308             /* If an NV has not enough bits in its mantissa to
309              * represent a UV this summing of small low-order numbers
310              * is a waste of time (because the NV cannot preserve
311              * the low-order bits anyway): we could just remember when
312              * did we overflow and in the end just multiply value_nv by the
313              * right amount of 16-tuples. */
314             value_nv += (NV) XDIGIT_VALUE(*s);
315             continue;
316         }
317         if (*s == '_' && len && allow_underscores && s[1]
318                 && isXDIGIT(s[1]))
319             {
320                 --len;
321                 ++s;
322                 goto redo;
323             }
324         if (!(*flags & PERL_SCAN_SILENT_ILLDIGIT))
325             Perl_ck_warner(aTHX_ packWARN(WARN_DIGIT),
326                         "Illegal hexadecimal digit '%c' ignored", *s);
327         break;
328     }
329     
330     if (   ( overflowed && value_nv > 4294967295.0)
331 #if UVSIZE > 4
332         || (!overflowed && value > 0xffffffff
333             && ! (*flags & PERL_SCAN_SILENT_NON_PORTABLE))
334 #endif
335         ) {
336         Perl_ck_warner(aTHX_ packWARN(WARN_PORTABLE),
337                        "Hexadecimal number > 0xffffffff non-portable");
338     }
339     *len_p = s - start;
340     if (!overflowed) {
341         *flags = 0;
342         return value;
343     }
344     *flags = PERL_SCAN_GREATER_THAN_UV_MAX;
345     if (result)
346         *result = value_nv;
347     return UV_MAX;
348 }
349
350 /*
351 =for apidoc grok_oct
352
353 converts a string representing an octal number to numeric form.
354
355 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
356 conversion flags, and I<result> should be NULL or a pointer to an NV.
357 The scan stops at the end of the string, or the first invalid character.
358 Unless C<PERL_SCAN_SILENT_ILLDIGIT> is set in I<*flags>, encountering an
359 8 or 9 will also trigger a warning.
360 On return I<*len> is set to the length of the scanned string,
361 and I<*flags> gives output flags.
362
363 If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
364 and nothing is written to I<*result>.  If the value is > UV_MAX C<grok_oct>
365 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
366 and writes the value to I<*result> (or the value is discarded if I<result>
367 is NULL).
368
369 If C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the octal
370 number may use '_' characters to separate digits.
371
372 =cut
373
374 Not documented yet because experimental is C<PERL_SCAN_SILENT_NON_PORTABLE>
375 which suppresses any message for non-portable numbers, but which are valid
376 on this platform.
377  */
378
379 UV
380 Perl_grok_oct(pTHX_ const char *start, STRLEN *len_p, I32 *flags, NV *result)
381 {
382     const char *s = start;
383     STRLEN len = *len_p;
384     UV value = 0;
385     NV value_nv = 0;
386     const UV max_div_8 = UV_MAX / 8;
387     const bool allow_underscores = cBOOL(*flags & PERL_SCAN_ALLOW_UNDERSCORES);
388     bool overflowed = FALSE;
389
390     PERL_ARGS_ASSERT_GROK_OCT;
391
392     for (; len-- && *s; s++) {
393         if (isOCTAL(*s)) {
394             /* Write it in this wonky order with a goto to attempt to get the
395                compiler to make the common case integer-only loop pretty tight.
396             */
397           redo:
398             if (!overflowed) {
399                 if (value <= max_div_8) {
400                     value = (value << 3) | OCTAL_VALUE(*s);
401                     continue;
402                 }
403                 /* Bah. We're just overflowed.  */
404                 /* diag_listed_as: Integer overflow in %s number */
405                 Perl_ck_warner_d(aTHX_ packWARN(WARN_OVERFLOW),
406                                "Integer overflow in octal number");
407                 overflowed = TRUE;
408                 value_nv = (NV) value;
409             }
410             value_nv *= 8.0;
411             /* If an NV has not enough bits in its mantissa to
412              * represent a UV this summing of small low-order numbers
413              * is a waste of time (because the NV cannot preserve
414              * the low-order bits anyway): we could just remember when
415              * did we overflow and in the end just multiply value_nv by the
416              * right amount of 8-tuples. */
417             value_nv += (NV) OCTAL_VALUE(*s);
418             continue;
419         }
420         if (*s == '_' && len && allow_underscores && isOCTAL(s[1])) {
421             --len;
422             ++s;
423             goto redo;
424         }
425         /* Allow \octal to work the DWIM way (that is, stop scanning
426          * as soon as non-octal characters are seen, complain only if
427          * someone seems to want to use the digits eight and nine.  Since we
428          * know it is not octal, then if isDIGIT, must be an 8 or 9). */
429         if (isDIGIT(*s)) {
430             if (!(*flags & PERL_SCAN_SILENT_ILLDIGIT))
431                 Perl_ck_warner(aTHX_ packWARN(WARN_DIGIT),
432                                "Illegal octal digit '%c' ignored", *s);
433         }
434         break;
435     }
436     
437     if (   ( overflowed && value_nv > 4294967295.0)
438 #if UVSIZE > 4
439         || (!overflowed && value > 0xffffffff
440             && ! (*flags & PERL_SCAN_SILENT_NON_PORTABLE))
441 #endif
442         ) {
443         Perl_ck_warner(aTHX_ packWARN(WARN_PORTABLE),
444                        "Octal number > 037777777777 non-portable");
445     }
446     *len_p = s - start;
447     if (!overflowed) {
448         *flags = 0;
449         return value;
450     }
451     *flags = PERL_SCAN_GREATER_THAN_UV_MAX;
452     if (result)
453         *result = value_nv;
454     return UV_MAX;
455 }
456
457 /*
458 =for apidoc scan_bin
459
460 For backwards compatibility.  Use C<grok_bin> instead.
461
462 =for apidoc scan_hex
463
464 For backwards compatibility.  Use C<grok_hex> instead.
465
466 =for apidoc scan_oct
467
468 For backwards compatibility.  Use C<grok_oct> instead.
469
470 =cut
471  */
472
473 NV
474 Perl_scan_bin(pTHX_ const char *start, STRLEN len, STRLEN *retlen)
475 {
476     NV rnv;
477     I32 flags = *retlen ? PERL_SCAN_ALLOW_UNDERSCORES : 0;
478     const UV ruv = grok_bin (start, &len, &flags, &rnv);
479
480     PERL_ARGS_ASSERT_SCAN_BIN;
481
482     *retlen = len;
483     return (flags & PERL_SCAN_GREATER_THAN_UV_MAX) ? rnv : (NV)ruv;
484 }
485
486 NV
487 Perl_scan_oct(pTHX_ const char *start, STRLEN len, STRLEN *retlen)
488 {
489     NV rnv;
490     I32 flags = *retlen ? PERL_SCAN_ALLOW_UNDERSCORES : 0;
491     const UV ruv = grok_oct (start, &len, &flags, &rnv);
492
493     PERL_ARGS_ASSERT_SCAN_OCT;
494
495     *retlen = len;
496     return (flags & PERL_SCAN_GREATER_THAN_UV_MAX) ? rnv : (NV)ruv;
497 }
498
499 NV
500 Perl_scan_hex(pTHX_ const char *start, STRLEN len, STRLEN *retlen)
501 {
502     NV rnv;
503     I32 flags = *retlen ? PERL_SCAN_ALLOW_UNDERSCORES : 0;
504     const UV ruv = grok_hex (start, &len, &flags, &rnv);
505
506     PERL_ARGS_ASSERT_SCAN_HEX;
507
508     *retlen = len;
509     return (flags & PERL_SCAN_GREATER_THAN_UV_MAX) ? rnv : (NV)ruv;
510 }
511
512 /*
513 =for apidoc grok_numeric_radix
514
515 Scan and skip for a numeric decimal separator (radix).
516
517 =cut
518  */
519 bool
520 Perl_grok_numeric_radix(pTHX_ const char **sp, const char *send)
521 {
522 #ifdef USE_LOCALE_NUMERIC
523     dVAR;
524
525     PERL_ARGS_ASSERT_GROK_NUMERIC_RADIX;
526
527     if (IN_LC(LC_NUMERIC)) {
528         DECLARE_STORE_LC_NUMERIC_SET_TO_NEEDED();
529         if (PL_numeric_radix_sv) {
530             STRLEN len;
531             const char * const radix = SvPV(PL_numeric_radix_sv, len);
532             if (*sp + len <= send && memEQ(*sp, radix, len)) {
533                 *sp += len;
534                 RESTORE_LC_NUMERIC();
535                 return TRUE;
536             }
537         }
538         RESTORE_LC_NUMERIC();
539     }
540     /* always try "." if numeric radix didn't match because
541      * we may have data from different locales mixed */
542 #endif
543
544     PERL_ARGS_ASSERT_GROK_NUMERIC_RADIX;
545
546     if (*sp < send && **sp == '.') {
547         ++*sp;
548         return TRUE;
549     }
550     return FALSE;
551 }
552
553 /*
554 =for apidoc grok_number
555
556 Recognise (or not) a number.  The type of the number is returned
557 (0 if unrecognised), otherwise it is a bit-ORed combination of
558 IS_NUMBER_IN_UV, IS_NUMBER_GREATER_THAN_UV_MAX, IS_NUMBER_NOT_INT,
559 IS_NUMBER_NEG, IS_NUMBER_INFINITY, IS_NUMBER_NAN (defined in perl.h).
560
561 If the value of the number can fit in a UV, it is returned in the *valuep
562 IS_NUMBER_IN_UV will be set to indicate that *valuep is valid, IS_NUMBER_IN_UV
563 will never be set unless *valuep is valid, but *valuep may have been assigned
564 to during processing even though IS_NUMBER_IN_UV is not set on return.
565 If valuep is NULL, IS_NUMBER_IN_UV will be set for the same cases as when
566 valuep is non-NULL, but no actual assignment (or SEGV) will occur.
567
568 IS_NUMBER_NOT_INT will be set with IS_NUMBER_IN_UV if trailing decimals were
569 seen (in which case *valuep gives the true value truncated to an integer), and
570 IS_NUMBER_NEG if the number is negative (in which case *valuep holds the
571 absolute value).  IS_NUMBER_IN_UV is not set if e notation was used or the
572 number is larger than a UV.
573
574 =cut
575  */
576 int
577 Perl_grok_number(pTHX_ const char *pv, STRLEN len, UV *valuep)
578 {
579   const char *s = pv;
580   const char * const send = pv + len;
581   const UV max_div_10 = UV_MAX / 10;
582   const char max_mod_10 = UV_MAX % 10;
583   int numtype = 0;
584   int sawinf = 0;
585   int sawnan = 0;
586
587   PERL_ARGS_ASSERT_GROK_NUMBER;
588
589   while (s < send && isSPACE(*s))
590     s++;
591   if (s == send) {
592     return 0;
593   } else if (*s == '-') {
594     s++;
595     numtype = IS_NUMBER_NEG;
596   }
597   else if (*s == '+')
598     s++;
599
600   if (s == send)
601     return 0;
602
603   /* next must be digit or the radix separator or beginning of infinity */
604   if (isDIGIT(*s)) {
605     /* UVs are at least 32 bits, so the first 9 decimal digits cannot
606        overflow.  */
607     UV value = *s - '0';
608     /* This construction seems to be more optimiser friendly.
609        (without it gcc does the isDIGIT test and the *s - '0' separately)
610        With it gcc on arm is managing 6 instructions (6 cycles) per digit.
611        In theory the optimiser could deduce how far to unroll the loop
612        before checking for overflow.  */
613     if (++s < send) {
614       int digit = *s - '0';
615       if (digit >= 0 && digit <= 9) {
616         value = value * 10 + digit;
617         if (++s < send) {
618           digit = *s - '0';
619           if (digit >= 0 && digit <= 9) {
620             value = value * 10 + digit;
621             if (++s < send) {
622               digit = *s - '0';
623               if (digit >= 0 && digit <= 9) {
624                 value = value * 10 + digit;
625                 if (++s < send) {
626                   digit = *s - '0';
627                   if (digit >= 0 && digit <= 9) {
628                     value = value * 10 + digit;
629                     if (++s < send) {
630                       digit = *s - '0';
631                       if (digit >= 0 && digit <= 9) {
632                         value = value * 10 + digit;
633                         if (++s < send) {
634                           digit = *s - '0';
635                           if (digit >= 0 && digit <= 9) {
636                             value = value * 10 + digit;
637                             if (++s < send) {
638                               digit = *s - '0';
639                               if (digit >= 0 && digit <= 9) {
640                                 value = value * 10 + digit;
641                                 if (++s < send) {
642                                   digit = *s - '0';
643                                   if (digit >= 0 && digit <= 9) {
644                                     value = value * 10 + digit;
645                                     if (++s < send) {
646                                       /* Now got 9 digits, so need to check
647                                          each time for overflow.  */
648                                       digit = *s - '0';
649                                       while (digit >= 0 && digit <= 9
650                                              && (value < max_div_10
651                                                  || (value == max_div_10
652                                                      && digit <= max_mod_10))) {
653                                         value = value * 10 + digit;
654                                         if (++s < send)
655                                           digit = *s - '0';
656                                         else
657                                           break;
658                                       }
659                                       if (digit >= 0 && digit <= 9
660                                           && (s < send)) {
661                                         /* value overflowed.
662                                            skip the remaining digits, don't
663                                            worry about setting *valuep.  */
664                                         do {
665                                           s++;
666                                         } while (s < send && isDIGIT(*s));
667                                         numtype |=
668                                           IS_NUMBER_GREATER_THAN_UV_MAX;
669                                         goto skip_value;
670                                       }
671                                     }
672                                   }
673                                 }
674                               }
675                             }
676                           }
677                         }
678                       }
679                     }
680                   }
681                 }
682               }
683             }
684           }
685         }
686       }
687     }
688     numtype |= IS_NUMBER_IN_UV;
689     if (valuep)
690       *valuep = value;
691
692   skip_value:
693     if (GROK_NUMERIC_RADIX(&s, send)) {
694       numtype |= IS_NUMBER_NOT_INT;
695       while (s < send && isDIGIT(*s))  /* optional digits after the radix */
696         s++;
697     }
698   }
699   else if (GROK_NUMERIC_RADIX(&s, send)) {
700     numtype |= IS_NUMBER_NOT_INT | IS_NUMBER_IN_UV; /* valuep assigned below */
701     /* no digits before the radix means we need digits after it */
702     if (s < send && isDIGIT(*s)) {
703       do {
704         s++;
705       } while (s < send && isDIGIT(*s));
706       if (valuep) {
707         /* integer approximation is valid - it's 0.  */
708         *valuep = 0;
709       }
710     }
711     else
712       return 0;
713   } else if (*s == 'I' || *s == 'i') {
714     s++; if (s == send || (*s != 'N' && *s != 'n')) return 0;
715     s++; if (s == send || (*s != 'F' && *s != 'f')) return 0;
716     s++; if (s < send && (*s == 'I' || *s == 'i')) {
717       s++; if (s == send || (*s != 'N' && *s != 'n')) return 0;
718       s++; if (s == send || (*s != 'I' && *s != 'i')) return 0;
719       s++; if (s == send || (*s != 'T' && *s != 't')) return 0;
720       s++; if (s == send || (*s != 'Y' && *s != 'y')) return 0;
721       s++;
722     }
723     sawinf = 1;
724   } else if (*s == 'N' || *s == 'n') {
725     /* XXX TODO: There are signaling NaNs and quiet NaNs. */
726     s++; if (s == send || (*s != 'A' && *s != 'a')) return 0;
727     s++; if (s == send || (*s != 'N' && *s != 'n')) return 0;
728     s++;
729     sawnan = 1;
730   } else
731     return 0;
732
733   if (sawinf) {
734     numtype &= IS_NUMBER_NEG; /* Keep track of sign  */
735     numtype |= IS_NUMBER_INFINITY | IS_NUMBER_NOT_INT;
736   } else if (sawnan) {
737     numtype &= IS_NUMBER_NEG; /* Keep track of sign  */
738     numtype |= IS_NUMBER_NAN | IS_NUMBER_NOT_INT;
739   } else if (s < send) {
740     /* we can have an optional exponent part */
741     if (*s == 'e' || *s == 'E') {
742       /* The only flag we keep is sign.  Blow away any "it's UV"  */
743       numtype &= IS_NUMBER_NEG;
744       numtype |= IS_NUMBER_NOT_INT;
745       s++;
746       if (s < send && (*s == '-' || *s == '+'))
747         s++;
748       if (s < send && isDIGIT(*s)) {
749         do {
750           s++;
751         } while (s < send && isDIGIT(*s));
752       }
753       else
754       return 0;
755     }
756   }
757   while (s < send && isSPACE(*s))
758     s++;
759   if (s >= send)
760     return numtype;
761   if (len == 10 && memEQ(pv, "0 but true", 10)) {
762     if (valuep)
763       *valuep = 0;
764     return IS_NUMBER_IN_UV;
765   }
766   return 0;
767 }
768
769 STATIC NV
770 S_mulexp10(NV value, I32 exponent)
771 {
772     NV result = 1.0;
773     NV power = 10.0;
774     bool negative = 0;
775     I32 bit;
776
777     if (exponent == 0)
778         return value;
779     if (value == 0)
780         return (NV)0;
781
782     /* On OpenVMS VAX we by default use the D_FLOAT double format,
783      * and that format does not have *easy* capabilities [1] for
784      * overflowing doubles 'silently' as IEEE fp does.  We also need 
785      * to support G_FLOAT on both VAX and Alpha, and though the exponent 
786      * range is much larger than D_FLOAT it still doesn't do silent 
787      * overflow.  Therefore we need to detect early whether we would 
788      * overflow (this is the behaviour of the native string-to-float 
789      * conversion routines, and therefore of native applications, too).
790      *
791      * [1] Trying to establish a condition handler to trap floating point
792      *     exceptions is not a good idea. */
793
794     /* In UNICOS and in certain Cray models (such as T90) there is no
795      * IEEE fp, and no way at all from C to catch fp overflows gracefully.
796      * There is something you can do if you are willing to use some
797      * inline assembler: the instruction is called DFI-- but that will
798      * disable *all* floating point interrupts, a little bit too large
799      * a hammer.  Therefore we need to catch potential overflows before
800      * it's too late. */
801
802 #if ((defined(VMS) && !defined(_IEEE_FP)) || defined(_UNICOS)) && defined(NV_MAX_10_EXP)
803     STMT_START {
804         const NV exp_v = log10(value);
805         if (exponent >= NV_MAX_10_EXP || exponent + exp_v >= NV_MAX_10_EXP)
806             return NV_MAX;
807         if (exponent < 0) {
808             if (-(exponent + exp_v) >= NV_MAX_10_EXP)
809                 return 0.0;
810             while (-exponent >= NV_MAX_10_EXP) {
811                 /* combination does not overflow, but 10^(-exponent) does */
812                 value /= 10;
813                 ++exponent;
814             }
815         }
816     } STMT_END;
817 #endif
818
819     if (exponent < 0) {
820         negative = 1;
821         exponent = -exponent;
822 #ifdef NV_MAX_10_EXP
823         /* for something like 1234 x 10^-309, the action of calculating
824          * the intermediate value 10^309 then returning 1234 / (10^309)
825          * will fail, since 10^309 becomes infinity. In this case try to
826          * refactor it as 123 / (10^308) etc.
827          */
828         while (value && exponent > NV_MAX_10_EXP) {
829             exponent--;
830             value /= 10;
831         }
832 #endif
833     }
834     for (bit = 1; exponent; bit <<= 1) {
835         if (exponent & bit) {
836             exponent ^= bit;
837             result *= power;
838             /* Floating point exceptions are supposed to be turned off,
839              *  but if we're obviously done, don't risk another iteration.  
840              */
841              if (exponent == 0) break;
842         }
843         power *= power;
844     }
845     return negative ? value / result : value * result;
846 }
847
848 NV
849 Perl_my_atof(pTHX_ const char* s)
850 {
851     NV x = 0.0;
852 #ifdef USE_LOCALE_NUMERIC
853     dVAR;
854
855     PERL_ARGS_ASSERT_MY_ATOF;
856
857     {
858         DECLARE_STORE_LC_NUMERIC_SET_TO_NEEDED();
859         if (PL_numeric_radix_sv && IN_LC(LC_NUMERIC)) {
860             const char *standard = NULL, *local = NULL;
861             bool use_standard_radix;
862
863             /* Look through the string for the first thing that looks like a
864              * decimal point: either the value in the current locale or the
865              * standard fallback of '.'. The one which appears earliest in the
866              * input string is the one that we should have atof look for. Note
867              * that we have to determine this beforehand because on some
868              * systems, Perl_atof2 is just a wrapper around the system's atof.
869              * */
870             standard = strchr(s, '.');
871             local = strstr(s, SvPV_nolen(PL_numeric_radix_sv));
872
873             use_standard_radix = standard && (!local || standard < local);
874
875             if (use_standard_radix)
876                 SET_NUMERIC_STANDARD();
877
878             Perl_atof2(s, x);
879
880             if (use_standard_radix)
881                 SET_NUMERIC_LOCAL();
882         }
883         else
884             Perl_atof2(s, x);
885         RESTORE_LC_NUMERIC();
886     }
887 #else
888     Perl_atof2(s, x);
889 #endif
890     return x;
891 }
892
893 char*
894 Perl_my_atof2(pTHX_ const char* orig, NV* value)
895 {
896     NV result[3] = {0.0, 0.0, 0.0};
897     const char* s = orig;
898 #ifdef USE_PERL_ATOF
899     UV accumulator[2] = {0,0};  /* before/after dp */
900     bool negative = 0;
901     const char* send = s + strlen(orig) - 1;
902     bool seen_digit = 0;
903     I32 exp_adjust[2] = {0,0};
904     I32 exp_acc[2] = {-1, -1};
905     /* the current exponent adjust for the accumulators */
906     I32 exponent = 0;
907     I32 seen_dp  = 0;
908     I32 digit = 0;
909     I32 old_digit = 0;
910     I32 sig_digits = 0; /* noof significant digits seen so far */
911
912     PERL_ARGS_ASSERT_MY_ATOF2;
913
914 /* There is no point in processing more significant digits
915  * than the NV can hold. Note that NV_DIG is a lower-bound value,
916  * while we need an upper-bound value. We add 2 to account for this;
917  * since it will have been conservative on both the first and last digit.
918  * For example a 32-bit mantissa with an exponent of 4 would have
919  * exact values in the set
920  *               4
921  *               8
922  *              ..
923  *     17179869172
924  *     17179869176
925  *     17179869180
926  *
927  * where for the purposes of calculating NV_DIG we would have to discount
928  * both the first and last digit, since neither can hold all values from
929  * 0..9; but for calculating the value we must examine those two digits.
930  */
931 #ifdef MAX_SIG_DIG_PLUS
932     /* It is not necessarily the case that adding 2 to NV_DIG gets all the
933        possible digits in a NV, especially if NVs are not IEEE compliant
934        (e.g., long doubles on IRIX) - Allen <allens@cpan.org> */
935 # define MAX_SIG_DIGITS (NV_DIG+MAX_SIG_DIG_PLUS)
936 #else
937 # define MAX_SIG_DIGITS (NV_DIG+2)
938 #endif
939
940 /* the max number we can accumulate in a UV, and still safely do 10*N+9 */
941 #define MAX_ACCUMULATE ( (UV) ((UV_MAX - 9)/10))
942
943     /* leading whitespace */
944     while (isSPACE(*s))
945         ++s;
946
947     /* sign */
948     switch (*s) {
949         case '-':
950             negative = 1;
951             /* FALLTHROUGH */
952         case '+':
953             ++s;
954     }
955
956     /* punt to strtod for NaN/Inf; if no support for it there, tough luck */
957
958 #ifdef HAS_STRTOD
959     if (*s == 'n' || *s == 'N' || *s == 'i' || *s == 'I') {
960         const char *p = negative ? s - 1 : s;
961         char *endp;
962         NV rslt;
963         rslt = strtod(p, &endp);
964         if (endp != p) {
965             *value = rslt;
966             return (char *)endp;
967         }
968     }
969 #endif
970
971     /* we accumulate digits into an integer; when this becomes too
972      * large, we add the total to NV and start again */
973
974     while (1) {
975         if (isDIGIT(*s)) {
976             seen_digit = 1;
977             old_digit = digit;
978             digit = *s++ - '0';
979             if (seen_dp)
980                 exp_adjust[1]++;
981
982             /* don't start counting until we see the first significant
983              * digit, eg the 5 in 0.00005... */
984             if (!sig_digits && digit == 0)
985                 continue;
986
987             if (++sig_digits > MAX_SIG_DIGITS) {
988                 /* limits of precision reached */
989                 if (digit > 5) {
990                     ++accumulator[seen_dp];
991                 } else if (digit == 5) {
992                     if (old_digit % 2) { /* round to even - Allen */
993                         ++accumulator[seen_dp];
994                     }
995                 }
996                 if (seen_dp) {
997                     exp_adjust[1]--;
998                 } else {
999                     exp_adjust[0]++;
1000                 }
1001                 /* skip remaining digits */
1002                 while (isDIGIT(*s)) {
1003                     ++s;
1004                     if (! seen_dp) {
1005                         exp_adjust[0]++;
1006                     }
1007                 }
1008                 /* warn of loss of precision? */
1009             }
1010             else {
1011                 if (accumulator[seen_dp] > MAX_ACCUMULATE) {
1012                     /* add accumulator to result and start again */
1013                     result[seen_dp] = S_mulexp10(result[seen_dp],
1014                                                  exp_acc[seen_dp])
1015                         + (NV)accumulator[seen_dp];
1016                     accumulator[seen_dp] = 0;
1017                     exp_acc[seen_dp] = 0;
1018                 }
1019                 accumulator[seen_dp] = accumulator[seen_dp] * 10 + digit;
1020                 ++exp_acc[seen_dp];
1021             }
1022         }
1023         else if (!seen_dp && GROK_NUMERIC_RADIX(&s, send)) {
1024             seen_dp = 1;
1025             if (sig_digits > MAX_SIG_DIGITS) {
1026                 do {
1027                     ++s;
1028                 } while (isDIGIT(*s));
1029                 break;
1030             }
1031         }
1032         else {
1033             break;
1034         }
1035     }
1036
1037     result[0] = S_mulexp10(result[0], exp_acc[0]) + (NV)accumulator[0];
1038     if (seen_dp) {
1039         result[1] = S_mulexp10(result[1], exp_acc[1]) + (NV)accumulator[1];
1040     }
1041
1042     if (seen_digit && (*s == 'e' || *s == 'E')) {
1043         bool expnegative = 0;
1044
1045         ++s;
1046         switch (*s) {
1047             case '-':
1048                 expnegative = 1;
1049                 /* FALLTHROUGH */
1050             case '+':
1051                 ++s;
1052         }
1053         while (isDIGIT(*s))
1054             exponent = exponent * 10 + (*s++ - '0');
1055         if (expnegative)
1056             exponent = -exponent;
1057     }
1058
1059
1060
1061     /* now apply the exponent */
1062
1063     if (seen_dp) {
1064         result[2] = S_mulexp10(result[0],exponent+exp_adjust[0])
1065                 + S_mulexp10(result[1],exponent-exp_adjust[1]);
1066     } else {
1067         result[2] = S_mulexp10(result[0],exponent+exp_adjust[0]);
1068     }
1069
1070     /* now apply the sign */
1071     if (negative)
1072         result[2] = -result[2];
1073 #endif /* USE_PERL_ATOF */
1074     *value = result[2];
1075     return (char *)s;
1076 }
1077
1078 #if ! defined(HAS_MODFL) && defined(HAS_AINTL) && defined(HAS_COPYSIGNL)
1079 long double
1080 Perl_my_modfl(long double x, long double *ip)
1081 {
1082         *ip = aintl(x);
1083         return (x == *ip ? copysignl(0.0L, x) : x - *ip);
1084 }
1085 #endif
1086
1087 #if ! defined(HAS_FREXPL) && defined(HAS_ILOGBL) && defined(HAS_SCALBNL)
1088 long double
1089 Perl_my_frexpl(long double x, int *e) {
1090         *e = x == 0.0L ? 0 : ilogbl(x) + 1;
1091         return (scalbnl(x, -*e));
1092 }
1093 #endif
1094
1095 /*
1096 =for apidoc Perl_signbit
1097
1098 Return a non-zero integer if the sign bit on an NV is set, and 0 if
1099 it is not.  
1100
1101 If Configure detects this system has a signbit() that will work with
1102 our NVs, then we just use it via the #define in perl.h.  Otherwise,
1103 fall back on this implementation.  As a first pass, this gets everything
1104 right except -0.0.  Alas, catching -0.0 is the main use for this function,
1105 so this is not too helpful yet.  Still, at least we have the scaffolding
1106 in place to support other systems, should that prove useful.
1107
1108
1109 Configure notes:  This function is called 'Perl_signbit' instead of a
1110 plain 'signbit' because it is easy to imagine a system having a signbit()
1111 function or macro that doesn't happen to work with our particular choice
1112 of NVs.  We shouldn't just re-#define signbit as Perl_signbit and expect
1113 the standard system headers to be happy.  Also, this is a no-context
1114 function (no pTHX_) because Perl_signbit() is usually re-#defined in
1115 perl.h as a simple macro call to the system's signbit().
1116 Users should just always call Perl_signbit().
1117
1118 =cut
1119 */
1120 #if !defined(HAS_SIGNBIT)
1121 int
1122 Perl_signbit(NV x) {
1123     return (x < 0.0) ? 1 : 0;
1124 }
1125 #endif
1126
1127 /*
1128  * Local variables:
1129  * c-indentation-style: bsd
1130  * c-basic-offset: 4
1131  * indent-tabs-mode: nil
1132  * End:
1133  *
1134  * ex: set ts=8 sts=4 sw=4 et:
1135  */