This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
apidoc fixes, comment tweaks.
[perl5.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     const char *s = start;
263     STRLEN len = *len_p;
264     UV value = 0;
265     NV value_nv = 0;
266     const UV max_div_16 = UV_MAX / 16;
267     const bool allow_underscores = cBOOL(*flags & PERL_SCAN_ALLOW_UNDERSCORES);
268     bool overflowed = FALSE;
269
270     PERL_ARGS_ASSERT_GROK_HEX;
271
272     if (!(*flags & PERL_SCAN_DISALLOW_PREFIX)) {
273         /* strip off leading x or 0x.
274            for compatibility silently suffer "x" and "0x" as valid hex numbers.
275         */
276         if (len >= 1) {
277             if (s[0] == 'x' || s[0] == 'X') {
278                 s++;
279                 len--;
280             }
281             else if (len >= 2 && s[0] == '0' && (s[1] == 'x' || s[1] == 'X')) {
282                 s+=2;
283                 len-=2;
284             }
285         }
286     }
287
288     for (; len-- && *s; s++) {
289         if (isXDIGIT(*s)) {
290             /* Write it in this wonky order with a goto to attempt to get the
291                compiler to make the common case integer-only loop pretty tight.
292                With gcc seems to be much straighter code than old scan_hex.  */
293           redo:
294             if (!overflowed) {
295                 if (value <= max_div_16) {
296                     value = (value << 4) | XDIGIT_VALUE(*s);
297                     continue;
298                 }
299                 /* Bah. We're just overflowed.  */
300                 /* diag_listed_as: Integer overflow in %s number */
301                 Perl_ck_warner_d(aTHX_ packWARN(WARN_OVERFLOW),
302                                  "Integer overflow in hexadecimal number");
303                 overflowed = TRUE;
304                 value_nv = (NV) value;
305             }
306             value_nv *= 16.0;
307             /* If an NV has not enough bits in its mantissa to
308              * represent a UV this summing of small low-order numbers
309              * is a waste of time (because the NV cannot preserve
310              * the low-order bits anyway): we could just remember when
311              * did we overflow and in the end just multiply value_nv by the
312              * right amount of 16-tuples. */
313             value_nv += (NV) XDIGIT_VALUE(*s);
314             continue;
315         }
316         if (*s == '_' && len && allow_underscores && s[1]
317                 && isXDIGIT(s[1]))
318             {
319                 --len;
320                 ++s;
321                 goto redo;
322             }
323         if (!(*flags & PERL_SCAN_SILENT_ILLDIGIT))
324             Perl_ck_warner(aTHX_ packWARN(WARN_DIGIT),
325                         "Illegal hexadecimal digit '%c' ignored", *s);
326         break;
327     }
328     
329     if (   ( overflowed && value_nv > 4294967295.0)
330 #if UVSIZE > 4
331         || (!overflowed && value > 0xffffffff
332             && ! (*flags & PERL_SCAN_SILENT_NON_PORTABLE))
333 #endif
334         ) {
335         Perl_ck_warner(aTHX_ packWARN(WARN_PORTABLE),
336                        "Hexadecimal number > 0xffffffff non-portable");
337     }
338     *len_p = s - start;
339     if (!overflowed) {
340         *flags = 0;
341         return value;
342     }
343     *flags = PERL_SCAN_GREATER_THAN_UV_MAX;
344     if (result)
345         *result = value_nv;
346     return UV_MAX;
347 }
348
349 /*
350 =for apidoc grok_oct
351
352 converts a string representing an octal number to numeric form.
353
354 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
355 conversion flags, and I<result> should be NULL or a pointer to an NV.
356 The scan stops at the end of the string, or the first invalid character.
357 Unless C<PERL_SCAN_SILENT_ILLDIGIT> is set in I<*flags>, encountering an
358 8 or 9 will also trigger a warning.
359 On return I<*len> is set to the length of the scanned string,
360 and I<*flags> gives output flags.
361
362 If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
363 and nothing is written to I<*result>.  If the value is > UV_MAX C<grok_oct>
364 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
365 and writes the value to I<*result> (or the value is discarded if I<result>
366 is NULL).
367
368 If C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the octal
369 number may use '_' characters to separate digits.
370
371 =cut
372
373 Not documented yet because experimental is C<PERL_SCAN_SILENT_NON_PORTABLE>
374 which suppresses any message for non-portable numbers, but which are valid
375 on this platform.
376  */
377
378 UV
379 Perl_grok_oct(pTHX_ const char *start, STRLEN *len_p, I32 *flags, NV *result)
380 {
381     const char *s = start;
382     STRLEN len = *len_p;
383     UV value = 0;
384     NV value_nv = 0;
385     const UV max_div_8 = UV_MAX / 8;
386     const bool allow_underscores = cBOOL(*flags & PERL_SCAN_ALLOW_UNDERSCORES);
387     bool overflowed = FALSE;
388
389     PERL_ARGS_ASSERT_GROK_OCT;
390
391     for (; len-- && *s; s++) {
392         if (isOCTAL(*s)) {
393             /* Write it in this wonky order with a goto to attempt to get the
394                compiler to make the common case integer-only loop pretty tight.
395             */
396           redo:
397             if (!overflowed) {
398                 if (value <= max_div_8) {
399                     value = (value << 3) | OCTAL_VALUE(*s);
400                     continue;
401                 }
402                 /* Bah. We're just overflowed.  */
403                 /* diag_listed_as: Integer overflow in %s number */
404                 Perl_ck_warner_d(aTHX_ packWARN(WARN_OVERFLOW),
405                                "Integer overflow in octal number");
406                 overflowed = TRUE;
407                 value_nv = (NV) value;
408             }
409             value_nv *= 8.0;
410             /* If an NV has not enough bits in its mantissa to
411              * represent a UV this summing of small low-order numbers
412              * is a waste of time (because the NV cannot preserve
413              * the low-order bits anyway): we could just remember when
414              * did we overflow and in the end just multiply value_nv by the
415              * right amount of 8-tuples. */
416             value_nv += (NV) OCTAL_VALUE(*s);
417             continue;
418         }
419         if (*s == '_' && len && allow_underscores && isOCTAL(s[1])) {
420             --len;
421             ++s;
422             goto redo;
423         }
424         /* Allow \octal to work the DWIM way (that is, stop scanning
425          * as soon as non-octal characters are seen, complain only if
426          * someone seems to want to use the digits eight and nine.  Since we
427          * know it is not octal, then if isDIGIT, must be an 8 or 9). */
428         if (isDIGIT(*s)) {
429             if (!(*flags & PERL_SCAN_SILENT_ILLDIGIT))
430                 Perl_ck_warner(aTHX_ packWARN(WARN_DIGIT),
431                                "Illegal octal digit '%c' ignored", *s);
432         }
433         break;
434     }
435     
436     if (   ( overflowed && value_nv > 4294967295.0)
437 #if UVSIZE > 4
438         || (!overflowed && value > 0xffffffff
439             && ! (*flags & PERL_SCAN_SILENT_NON_PORTABLE))
440 #endif
441         ) {
442         Perl_ck_warner(aTHX_ packWARN(WARN_PORTABLE),
443                        "Octal number > 037777777777 non-portable");
444     }
445     *len_p = s - start;
446     if (!overflowed) {
447         *flags = 0;
448         return value;
449     }
450     *flags = PERL_SCAN_GREATER_THAN_UV_MAX;
451     if (result)
452         *result = value_nv;
453     return UV_MAX;
454 }
455
456 /*
457 =for apidoc scan_bin
458
459 For backwards compatibility.  Use C<grok_bin> instead.
460
461 =for apidoc scan_hex
462
463 For backwards compatibility.  Use C<grok_hex> instead.
464
465 =for apidoc scan_oct
466
467 For backwards compatibility.  Use C<grok_oct> instead.
468
469 =cut
470  */
471
472 NV
473 Perl_scan_bin(pTHX_ const char *start, STRLEN len, STRLEN *retlen)
474 {
475     NV rnv;
476     I32 flags = *retlen ? PERL_SCAN_ALLOW_UNDERSCORES : 0;
477     const UV ruv = grok_bin (start, &len, &flags, &rnv);
478
479     PERL_ARGS_ASSERT_SCAN_BIN;
480
481     *retlen = len;
482     return (flags & PERL_SCAN_GREATER_THAN_UV_MAX) ? rnv : (NV)ruv;
483 }
484
485 NV
486 Perl_scan_oct(pTHX_ const char *start, STRLEN len, STRLEN *retlen)
487 {
488     NV rnv;
489     I32 flags = *retlen ? PERL_SCAN_ALLOW_UNDERSCORES : 0;
490     const UV ruv = grok_oct (start, &len, &flags, &rnv);
491
492     PERL_ARGS_ASSERT_SCAN_OCT;
493
494     *retlen = len;
495     return (flags & PERL_SCAN_GREATER_THAN_UV_MAX) ? rnv : (NV)ruv;
496 }
497
498 NV
499 Perl_scan_hex(pTHX_ const char *start, STRLEN len, STRLEN *retlen)
500 {
501     NV rnv;
502     I32 flags = *retlen ? PERL_SCAN_ALLOW_UNDERSCORES : 0;
503     const UV ruv = grok_hex (start, &len, &flags, &rnv);
504
505     PERL_ARGS_ASSERT_SCAN_HEX;
506
507     *retlen = len;
508     return (flags & PERL_SCAN_GREATER_THAN_UV_MAX) ? rnv : (NV)ruv;
509 }
510
511 /*
512 =for apidoc grok_numeric_radix
513
514 Scan and skip for a numeric decimal separator (radix).
515
516 =cut
517  */
518 bool
519 Perl_grok_numeric_radix(pTHX_ const char **sp, const char *send)
520 {
521 #ifdef USE_LOCALE_NUMERIC
522     PERL_ARGS_ASSERT_GROK_NUMERIC_RADIX;
523
524     if (IN_LC(LC_NUMERIC)) {
525         DECLARE_STORE_LC_NUMERIC_SET_TO_NEEDED();
526         if (PL_numeric_radix_sv) {
527             STRLEN len;
528             const char * const radix = SvPV(PL_numeric_radix_sv, len);
529             if (*sp + len <= send && memEQ(*sp, radix, len)) {
530                 *sp += len;
531                 RESTORE_LC_NUMERIC();
532                 return TRUE;
533             }
534         }
535         RESTORE_LC_NUMERIC();
536     }
537     /* always try "." if numeric radix didn't match because
538      * we may have data from different locales mixed */
539 #endif
540
541     PERL_ARGS_ASSERT_GROK_NUMERIC_RADIX;
542
543     if (*sp < send && **sp == '.') {
544         ++*sp;
545         return TRUE;
546     }
547     return FALSE;
548 }
549
550 /*
551 =for apidoc grok_number_flags
552
553 Recognise (or not) a number.  The type of the number is returned
554 (0 if unrecognised), otherwise it is a bit-ORed combination of
555 IS_NUMBER_IN_UV, IS_NUMBER_GREATER_THAN_UV_MAX, IS_NUMBER_NOT_INT,
556 IS_NUMBER_NEG, IS_NUMBER_INFINITY, IS_NUMBER_NAN (defined in perl.h).
557
558 If the value of the number can fit in a UV, it is returned in the *valuep
559 IS_NUMBER_IN_UV will be set to indicate that *valuep is valid, IS_NUMBER_IN_UV
560 will never be set unless *valuep is valid, but *valuep may have been assigned
561 to during processing even though IS_NUMBER_IN_UV is not set on return.
562 If valuep is NULL, IS_NUMBER_IN_UV will be set for the same cases as when
563 valuep is non-NULL, but no actual assignment (or SEGV) will occur.
564
565 IS_NUMBER_NOT_INT will be set with IS_NUMBER_IN_UV if trailing decimals were
566 seen (in which case *valuep gives the true value truncated to an integer), and
567 IS_NUMBER_NEG if the number is negative (in which case *valuep holds the
568 absolute value).  IS_NUMBER_IN_UV is not set if e notation was used or the
569 number is larger than a UV.
570
571 C<flags> allows only C<PERL_SCAN_TRAILING>, which allows for trailing
572 non-numeric text on an otherwise successful I<grok>, setting
573 C<IS_NUMBER_TRAILING> on the result.
574
575 =for apidoc grok_number
576
577 Identical to grok_number_flags() with flags set to zero.
578
579 =cut
580  */
581 int
582 Perl_grok_number(pTHX_ const char *pv, STRLEN len, UV *valuep)
583 {
584     PERL_ARGS_ASSERT_GROK_NUMBER;
585
586     return grok_number_flags(pv, len, valuep, 0);
587 }
588
589 int
590 Perl_grok_number_flags(pTHX_ const char *pv, STRLEN len, UV *valuep, U32 flags)
591 {
592   const char *s = pv;
593   const char * const send = pv + len;
594   const UV max_div_10 = UV_MAX / 10;
595   const char max_mod_10 = UV_MAX % 10;
596   int numtype = 0;
597   int sawinf = 0;
598   int sawnan = 0;
599
600   PERL_ARGS_ASSERT_GROK_NUMBER_FLAGS;
601
602   while (s < send && isSPACE(*s))
603     s++;
604   if (s == send) {
605     return 0;
606   } else if (*s == '-') {
607     s++;
608     numtype = IS_NUMBER_NEG;
609   }
610   else if (*s == '+')
611     s++;
612
613   if (s == send)
614     return 0;
615
616   /* next must be digit or the radix separator or beginning of infinity */
617   if (isDIGIT(*s)) {
618     /* UVs are at least 32 bits, so the first 9 decimal digits cannot
619        overflow.  */
620     UV value = *s - '0';
621     /* This construction seems to be more optimiser friendly.
622        (without it gcc does the isDIGIT test and the *s - '0' separately)
623        With it gcc on arm is managing 6 instructions (6 cycles) per digit.
624        In theory the optimiser could deduce how far to unroll the loop
625        before checking for overflow.  */
626     if (++s < send) {
627       int digit = *s - '0';
628       if (digit >= 0 && digit <= 9) {
629         value = value * 10 + digit;
630         if (++s < send) {
631           digit = *s - '0';
632           if (digit >= 0 && digit <= 9) {
633             value = value * 10 + digit;
634             if (++s < send) {
635               digit = *s - '0';
636               if (digit >= 0 && digit <= 9) {
637                 value = value * 10 + digit;
638                 if (++s < send) {
639                   digit = *s - '0';
640                   if (digit >= 0 && digit <= 9) {
641                     value = value * 10 + digit;
642                     if (++s < send) {
643                       digit = *s - '0';
644                       if (digit >= 0 && digit <= 9) {
645                         value = value * 10 + digit;
646                         if (++s < send) {
647                           digit = *s - '0';
648                           if (digit >= 0 && digit <= 9) {
649                             value = value * 10 + digit;
650                             if (++s < send) {
651                               digit = *s - '0';
652                               if (digit >= 0 && digit <= 9) {
653                                 value = value * 10 + digit;
654                                 if (++s < send) {
655                                   digit = *s - '0';
656                                   if (digit >= 0 && digit <= 9) {
657                                     value = value * 10 + digit;
658                                     if (++s < send) {
659                                       /* Now got 9 digits, so need to check
660                                          each time for overflow.  */
661                                       digit = *s - '0';
662                                       while (digit >= 0 && digit <= 9
663                                              && (value < max_div_10
664                                                  || (value == max_div_10
665                                                      && digit <= max_mod_10))) {
666                                         value = value * 10 + digit;
667                                         if (++s < send)
668                                           digit = *s - '0';
669                                         else
670                                           break;
671                                       }
672                                       if (digit >= 0 && digit <= 9
673                                           && (s < send)) {
674                                         /* value overflowed.
675                                            skip the remaining digits, don't
676                                            worry about setting *valuep.  */
677                                         do {
678                                           s++;
679                                         } while (s < send && isDIGIT(*s));
680                                         numtype |=
681                                           IS_NUMBER_GREATER_THAN_UV_MAX;
682                                         goto skip_value;
683                                       }
684                                     }
685                                   }
686                                 }
687                               }
688                             }
689                           }
690                         }
691                       }
692                     }
693                   }
694                 }
695               }
696             }
697           }
698         }
699       }
700     }
701     numtype |= IS_NUMBER_IN_UV;
702     if (valuep)
703       *valuep = value;
704
705   skip_value:
706     if (GROK_NUMERIC_RADIX(&s, send)) {
707       numtype |= IS_NUMBER_NOT_INT;
708       while (s < send && isDIGIT(*s))  /* optional digits after the radix */
709         s++;
710     }
711   }
712   else if (GROK_NUMERIC_RADIX(&s, send)) {
713     numtype |= IS_NUMBER_NOT_INT | IS_NUMBER_IN_UV; /* valuep assigned below */
714     /* no digits before the radix means we need digits after it */
715     if (s < send && isDIGIT(*s)) {
716       do {
717         s++;
718       } while (s < send && isDIGIT(*s));
719       if (valuep) {
720         /* integer approximation is valid - it's 0.  */
721         *valuep = 0;
722       }
723     }
724     else
725       return 0;
726   } else if (*s == 'I' || *s == 'i') {
727     s++; if (s == send || (*s != 'N' && *s != 'n')) return 0;
728     s++; if (s == send || (*s != 'F' && *s != 'f')) return 0;
729     s++; if (s < send && (*s == 'I' || *s == 'i')) {
730       s++; if (s == send || (*s != 'N' && *s != 'n')) return 0;
731       s++; if (s == send || (*s != 'I' && *s != 'i')) return 0;
732       s++; if (s == send || (*s != 'T' && *s != 't')) return 0;
733       s++; if (s == send || (*s != 'Y' && *s != 'y')) return 0;
734       s++;
735     }
736     sawinf = 1;
737   } else if (*s == 'N' || *s == 'n') {
738     /* XXX TODO: There are signaling NaNs and quiet NaNs. */
739     s++; if (s == send || (*s != 'A' && *s != 'a')) return 0;
740     s++; if (s == send || (*s != 'N' && *s != 'n')) return 0;
741     s++;
742     sawnan = 1;
743   } else
744     return 0;
745
746   if (sawinf) {
747     numtype &= IS_NUMBER_NEG; /* Keep track of sign  */
748     numtype |= IS_NUMBER_INFINITY | IS_NUMBER_NOT_INT;
749   } else if (sawnan) {
750     numtype &= IS_NUMBER_NEG; /* Keep track of sign  */
751     numtype |= IS_NUMBER_NAN | IS_NUMBER_NOT_INT;
752   } else if (s < send) {
753     /* we can have an optional exponent part */
754     if (*s == 'e' || *s == 'E') {
755       s++;
756       if (s < send && (*s == '-' || *s == '+'))
757         s++;
758       if (s < send && isDIGIT(*s)) {
759         do {
760           s++;
761         } while (s < send && isDIGIT(*s));
762       }
763       else if (flags & PERL_SCAN_TRAILING)
764         return numtype | IS_NUMBER_TRAILING;
765       else
766         return 0;
767
768       /* The only flag we keep is sign.  Blow away any "it's UV"  */
769       numtype &= IS_NUMBER_NEG;
770       numtype |= IS_NUMBER_NOT_INT;
771     }
772   }
773   while (s < send && isSPACE(*s))
774     s++;
775   if (s >= send)
776     return numtype;
777   if (len == 10 && memEQ(pv, "0 but true", 10)) {
778     if (valuep)
779       *valuep = 0;
780     return IS_NUMBER_IN_UV;
781   }
782   else if (flags & PERL_SCAN_TRAILING) {
783     return numtype | IS_NUMBER_TRAILING;
784   }
785
786   return 0;
787 }
788
789 /*
790 =for apidoc grok_atou
791
792 grok_atou is a safer replacement for atoi and strtol.
793
794 grok_atou parses a C-style zero-byte terminated string, looking for
795 a decimal unsigned integer.
796
797 Returns the unsigned integer, if a valid value can be parsed
798 from the beginning of the string.
799
800 Accepts only the decimal digits '0'..'9'.
801
802 As opposed to atoi or strtol, grok_atou does NOT allow optional
803 leading whitespace, or negative inputs.  If such features are
804 required, the calling code needs to explicitly implement those.
805
806 If a valid value cannot be parsed, returns either zero (if non-digits
807 are met before any digits) or Size_t_MAX (if the value overflows).
808
809 Note that extraneous leading zeros also count as an overflow
810 (meaning that only "0" is the zero).
811
812 On failure, the *endptr is also set to NULL, unless endptr is NULL.
813
814 Trailing non-digit bytes are allowed if the endptr is non-NULL.
815 On return the *endptr will contain the pointer to the first non-digit byte.
816
817 If the endptr is NULL, the first non-digit byte MUST be
818 the zero byte terminating the pv, or zero will be returned.
819
820 Background: atoi has severe problems with illegal inputs, it cannot be
821 used for incremental parsing, and therefore should be avoided
822 atoi and strtol are also affected by locale settings, which can also be
823 seen as a bug (global state controlled by user environment).
824
825 =cut
826 */
827
828 Size_t
829 Perl_grok_atou(const char *pv, const char** endptr)
830 {
831     const char* s = pv;
832     const char** eptr;
833     const char* end2; /* Used in case endptr is NULL. */
834     /* With Size_t_size of 8 or 4 this works out to be the start plus
835      * either 20 or 10.  When 128 or 256-bit systems became reality,
836      * this overshoots (should get 39, 78, but gets 40, 80). */
837     const char* maxend = s + 10 * (Size_t_size / 4);
838     Size_t val = 0; /* The return value. */
839
840     PERL_ARGS_ASSERT_GROK_ATOU;
841
842     eptr = endptr ? endptr : &end2;
843     if (isDIGIT(*s) && !isDIGIT(*(s + 1))) {
844         /* Single-digit inputs are quite common cases, and in addition
845          * the case of zero ("0") here simplifies the decoding loop:
846          * not having to think whether "000" or "000123" are valid
847          * (now they are invalid). */
848         val = *s++ - '0';
849     } else {
850         Size_t tmp = 0; /* Temporary accumulator. */
851
852         while (s < maxend && *s) {
853             /* This could be unrolled like in grok_number(), but
854              * the expected uses of this are not speed-needy, and
855              * unlikely to need full 64-bitness. */
856             if (isDIGIT(*s)) {
857                 int digit = *s++ - '0';
858                 tmp = tmp * 10 + digit;
859                 if (tmp > val) { /* This implictly rejects leading zeros. */
860                     val = tmp;
861                 } else { /* Overflow. */
862                     *eptr = NULL;
863                     return Size_t_MAX;
864                 }
865             } else {
866                 break;
867             }
868         }
869         if (s == pv) {
870             *eptr = NULL; /* If no progress, failed to parse anything. */
871             return 0;
872         }
873     }
874     if (endptr == NULL && *s) {
875         return 0; /* If endptr is NULL, no trailing non-digits allowed. */
876     }
877     *eptr = s;
878     return val;
879 }
880
881 STATIC NV
882 S_mulexp10(NV value, I32 exponent)
883 {
884     NV result = 1.0;
885     NV power = 10.0;
886     bool negative = 0;
887     I32 bit;
888
889     if (exponent == 0)
890         return value;
891     if (value == 0)
892         return (NV)0;
893
894     /* On OpenVMS VAX we by default use the D_FLOAT double format,
895      * and that format does not have *easy* capabilities [1] for
896      * overflowing doubles 'silently' as IEEE fp does.  We also need 
897      * to support G_FLOAT on both VAX and Alpha, and though the exponent 
898      * range is much larger than D_FLOAT it still doesn't do silent 
899      * overflow.  Therefore we need to detect early whether we would 
900      * overflow (this is the behaviour of the native string-to-float 
901      * conversion routines, and therefore of native applications, too).
902      *
903      * [1] Trying to establish a condition handler to trap floating point
904      *     exceptions is not a good idea. */
905
906     /* In UNICOS and in certain Cray models (such as T90) there is no
907      * IEEE fp, and no way at all from C to catch fp overflows gracefully.
908      * There is something you can do if you are willing to use some
909      * inline assembler: the instruction is called DFI-- but that will
910      * disable *all* floating point interrupts, a little bit too large
911      * a hammer.  Therefore we need to catch potential overflows before
912      * it's too late. */
913
914 #if ((defined(VMS) && !defined(_IEEE_FP)) || defined(_UNICOS)) && defined(NV_MAX_10_EXP)
915     STMT_START {
916         const NV exp_v = log10(value);
917         if (exponent >= NV_MAX_10_EXP || exponent + exp_v >= NV_MAX_10_EXP)
918             return NV_MAX;
919         if (exponent < 0) {
920             if (-(exponent + exp_v) >= NV_MAX_10_EXP)
921                 return 0.0;
922             while (-exponent >= NV_MAX_10_EXP) {
923                 /* combination does not overflow, but 10^(-exponent) does */
924                 value /= 10;
925                 ++exponent;
926             }
927         }
928     } STMT_END;
929 #endif
930
931     if (exponent < 0) {
932         negative = 1;
933         exponent = -exponent;
934 #ifdef NV_MAX_10_EXP
935         /* for something like 1234 x 10^-309, the action of calculating
936          * the intermediate value 10^309 then returning 1234 / (10^309)
937          * will fail, since 10^309 becomes infinity. In this case try to
938          * refactor it as 123 / (10^308) etc.
939          */
940         while (value && exponent > NV_MAX_10_EXP) {
941             exponent--;
942             value /= 10;
943         }
944 #endif
945     }
946     for (bit = 1; exponent; bit <<= 1) {
947         if (exponent & bit) {
948             exponent ^= bit;
949             result *= power;
950             /* Floating point exceptions are supposed to be turned off,
951              *  but if we're obviously done, don't risk another iteration.  
952              */
953              if (exponent == 0) break;
954         }
955         power *= power;
956     }
957     return negative ? value / result : value * result;
958 }
959
960 NV
961 Perl_my_atof(pTHX_ const char* s)
962 {
963     NV x = 0.0;
964 #ifdef USE_LOCALE_NUMERIC
965     PERL_ARGS_ASSERT_MY_ATOF;
966
967     {
968         DECLARE_STORE_LC_NUMERIC_SET_TO_NEEDED();
969         if (PL_numeric_radix_sv && IN_LC(LC_NUMERIC)) {
970             const char *standard = NULL, *local = NULL;
971             bool use_standard_radix;
972
973             /* Look through the string for the first thing that looks like a
974              * decimal point: either the value in the current locale or the
975              * standard fallback of '.'. The one which appears earliest in the
976              * input string is the one that we should have atof look for. Note
977              * that we have to determine this beforehand because on some
978              * systems, Perl_atof2 is just a wrapper around the system's atof.
979              * */
980             standard = strchr(s, '.');
981             local = strstr(s, SvPV_nolen(PL_numeric_radix_sv));
982
983             use_standard_radix = standard && (!local || standard < local);
984
985             if (use_standard_radix)
986                 SET_NUMERIC_STANDARD();
987
988             Perl_atof2(s, x);
989
990             if (use_standard_radix)
991                 SET_NUMERIC_LOCAL();
992         }
993         else
994             Perl_atof2(s, x);
995         RESTORE_LC_NUMERIC();
996     }
997 #else
998     Perl_atof2(s, x);
999 #endif
1000     return x;
1001 }
1002
1003 char*
1004 Perl_my_atof2(pTHX_ const char* orig, NV* value)
1005 {
1006     NV result[3] = {0.0, 0.0, 0.0};
1007     const char* s = orig;
1008 #ifdef USE_PERL_ATOF
1009     UV accumulator[2] = {0,0};  /* before/after dp */
1010     bool negative = 0;
1011     const char* send = s + strlen(orig) - 1;
1012     bool seen_digit = 0;
1013     I32 exp_adjust[2] = {0,0};
1014     I32 exp_acc[2] = {-1, -1};
1015     /* the current exponent adjust for the accumulators */
1016     I32 exponent = 0;
1017     I32 seen_dp  = 0;
1018     I32 digit = 0;
1019     I32 old_digit = 0;
1020     I32 sig_digits = 0; /* noof significant digits seen so far */
1021
1022     PERL_ARGS_ASSERT_MY_ATOF2;
1023
1024 /* There is no point in processing more significant digits
1025  * than the NV can hold. Note that NV_DIG is a lower-bound value,
1026  * while we need an upper-bound value. We add 2 to account for this;
1027  * since it will have been conservative on both the first and last digit.
1028  * For example a 32-bit mantissa with an exponent of 4 would have
1029  * exact values in the set
1030  *               4
1031  *               8
1032  *              ..
1033  *     17179869172
1034  *     17179869176
1035  *     17179869180
1036  *
1037  * where for the purposes of calculating NV_DIG we would have to discount
1038  * both the first and last digit, since neither can hold all values from
1039  * 0..9; but for calculating the value we must examine those two digits.
1040  */
1041 #ifdef MAX_SIG_DIG_PLUS
1042     /* It is not necessarily the case that adding 2 to NV_DIG gets all the
1043        possible digits in a NV, especially if NVs are not IEEE compliant
1044        (e.g., long doubles on IRIX) - Allen <allens@cpan.org> */
1045 # define MAX_SIG_DIGITS (NV_DIG+MAX_SIG_DIG_PLUS)
1046 #else
1047 # define MAX_SIG_DIGITS (NV_DIG+2)
1048 #endif
1049
1050 /* the max number we can accumulate in a UV, and still safely do 10*N+9 */
1051 #define MAX_ACCUMULATE ( (UV) ((UV_MAX - 9)/10))
1052
1053     /* leading whitespace */
1054     while (isSPACE(*s))
1055         ++s;
1056
1057     /* sign */
1058     switch (*s) {
1059         case '-':
1060             negative = 1;
1061             /* FALLTHROUGH */
1062         case '+':
1063             ++s;
1064     }
1065
1066     /* punt to strtod for NaN/Inf; if no support for it there, tough luck */
1067
1068 #ifdef HAS_STRTOD
1069     if (*s == 'n' || *s == 'N' || *s == 'i' || *s == 'I') {
1070         const char *p = negative ? s - 1 : s;
1071         char *endp;
1072         NV rslt;
1073         rslt = strtod(p, &endp);
1074         if (endp != p) {
1075             *value = rslt;
1076             return (char *)endp;
1077         }
1078     }
1079 #endif
1080
1081     /* we accumulate digits into an integer; when this becomes too
1082      * large, we add the total to NV and start again */
1083
1084     while (1) {
1085         if (isDIGIT(*s)) {
1086             seen_digit = 1;
1087             old_digit = digit;
1088             digit = *s++ - '0';
1089             if (seen_dp)
1090                 exp_adjust[1]++;
1091
1092             /* don't start counting until we see the first significant
1093              * digit, eg the 5 in 0.00005... */
1094             if (!sig_digits && digit == 0)
1095                 continue;
1096
1097             if (++sig_digits > MAX_SIG_DIGITS) {
1098                 /* limits of precision reached */
1099                 if (digit > 5) {
1100                     ++accumulator[seen_dp];
1101                 } else if (digit == 5) {
1102                     if (old_digit % 2) { /* round to even - Allen */
1103                         ++accumulator[seen_dp];
1104                     }
1105                 }
1106                 if (seen_dp) {
1107                     exp_adjust[1]--;
1108                 } else {
1109                     exp_adjust[0]++;
1110                 }
1111                 /* skip remaining digits */
1112                 while (isDIGIT(*s)) {
1113                     ++s;
1114                     if (! seen_dp) {
1115                         exp_adjust[0]++;
1116                     }
1117                 }
1118                 /* warn of loss of precision? */
1119             }
1120             else {
1121                 if (accumulator[seen_dp] > MAX_ACCUMULATE) {
1122                     /* add accumulator to result and start again */
1123                     result[seen_dp] = S_mulexp10(result[seen_dp],
1124                                                  exp_acc[seen_dp])
1125                         + (NV)accumulator[seen_dp];
1126                     accumulator[seen_dp] = 0;
1127                     exp_acc[seen_dp] = 0;
1128                 }
1129                 accumulator[seen_dp] = accumulator[seen_dp] * 10 + digit;
1130                 ++exp_acc[seen_dp];
1131             }
1132         }
1133         else if (!seen_dp && GROK_NUMERIC_RADIX(&s, send)) {
1134             seen_dp = 1;
1135             if (sig_digits > MAX_SIG_DIGITS) {
1136                 do {
1137                     ++s;
1138                 } while (isDIGIT(*s));
1139                 break;
1140             }
1141         }
1142         else {
1143             break;
1144         }
1145     }
1146
1147     result[0] = S_mulexp10(result[0], exp_acc[0]) + (NV)accumulator[0];
1148     if (seen_dp) {
1149         result[1] = S_mulexp10(result[1], exp_acc[1]) + (NV)accumulator[1];
1150     }
1151
1152     if (seen_digit && (*s == 'e' || *s == 'E')) {
1153         bool expnegative = 0;
1154
1155         ++s;
1156         switch (*s) {
1157             case '-':
1158                 expnegative = 1;
1159                 /* FALLTHROUGH */
1160             case '+':
1161                 ++s;
1162         }
1163         while (isDIGIT(*s))
1164             exponent = exponent * 10 + (*s++ - '0');
1165         if (expnegative)
1166             exponent = -exponent;
1167     }
1168
1169
1170
1171     /* now apply the exponent */
1172
1173     if (seen_dp) {
1174         result[2] = S_mulexp10(result[0],exponent+exp_adjust[0])
1175                 + S_mulexp10(result[1],exponent-exp_adjust[1]);
1176     } else {
1177         result[2] = S_mulexp10(result[0],exponent+exp_adjust[0]);
1178     }
1179
1180     /* now apply the sign */
1181     if (negative)
1182         result[2] = -result[2];
1183 #endif /* USE_PERL_ATOF */
1184     *value = result[2];
1185     return (char *)s;
1186 }
1187
1188 #if ! defined(HAS_MODFL) && defined(HAS_AINTL) && defined(HAS_COPYSIGNL)
1189 long double
1190 Perl_my_modfl(long double x, long double *ip)
1191 {
1192         *ip = aintl(x);
1193         return (x == *ip ? copysignl(0.0L, x) : x - *ip);
1194 }
1195 #endif
1196
1197 #if ! defined(HAS_FREXPL) && defined(HAS_ILOGBL) && defined(HAS_SCALBNL)
1198 long double
1199 Perl_my_frexpl(long double x, int *e) {
1200         *e = x == 0.0L ? 0 : ilogbl(x) + 1;
1201         return (scalbnl(x, -*e));
1202 }
1203 #endif
1204
1205 /*
1206 =for apidoc Perl_signbit
1207
1208 Return a non-zero integer if the sign bit on an NV is set, and 0 if
1209 it is not.  
1210
1211 If Configure detects this system has a signbit() that will work with
1212 our NVs, then we just use it via the #define in perl.h.  Otherwise,
1213 fall back on this implementation.  As a first pass, this gets everything
1214 right except -0.0.  Alas, catching -0.0 is the main use for this function,
1215 so this is not too helpful yet.  Still, at least we have the scaffolding
1216 in place to support other systems, should that prove useful.
1217
1218
1219 Configure notes:  This function is called 'Perl_signbit' instead of a
1220 plain 'signbit' because it is easy to imagine a system having a signbit()
1221 function or macro that doesn't happen to work with our particular choice
1222 of NVs.  We shouldn't just re-#define signbit as Perl_signbit and expect
1223 the standard system headers to be happy.  Also, this is a no-context
1224 function (no pTHX_) because Perl_signbit() is usually re-#defined in
1225 perl.h as a simple macro call to the system's signbit().
1226 Users should just always call Perl_signbit().
1227
1228 =cut
1229 */
1230 #if !defined(HAS_SIGNBIT)
1231 int
1232 Perl_signbit(NV x) {
1233     return (x < 0.0) ? 1 : 0;
1234 }
1235 #endif
1236
1237 /*
1238  * Local variables:
1239  * c-indentation-style: bsd
1240  * c-basic-offset: 4
1241  * indent-tabs-mode: nil
1242  * End:
1243  *
1244  * ex: set ts=8 sts=4 sw=4 et:
1245  */