This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
infnan: grok_number* setting the infnan NV directly
[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 (isALPHA_FOLD_EQ(s[0], 'b')) {
157                 s++;
158                 len--;
159             }
160             else if (len >= 2 && s[0] == '0' && (isALPHA_FOLD_EQ(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, but which are 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 (isALPHA_FOLD_EQ(s[0], 'x')) {
278                 s++;
279                 len--;
280             }
281             else if (len >= 2 && s[0] == '0' && (isALPHA_FOLD_EQ(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 nan_hibyte
552
553 Given an NV, returns pointer to the byte containing the most
554 significant bit of the NaN, this bit is most commonly the
555 quiet/signaling bit of the NaN.  The mask will contain a mask
556 appropriate for manipulating the most significant bit.
557 Note that this bit may not be the highest bit of the byte.
558
559 If the NV is not a NaN, returns NULL.
560
561 Most platforms have "high bit is one" -> quiet nan.
562 The known opposite exceptions are older MIPS and HPPA platforms.
563
564 Some platforms do not differentiate between quiet and signaling NaNs.
565
566 =cut
567 */
568 U8*
569 Perl_nan_hibyte(NV *nvp, U8* mask)
570 {
571     STRLEN i = (NV_MANT_REAL_DIG - 1) / 8;
572     STRLEN j = (NV_MANT_REAL_DIG - 1) % 8;
573
574     PERL_ARGS_ASSERT_NAN_HIBYTE;
575
576     *mask = 1 << j;
577 #ifdef NV_BIG_ENDIAN
578     return (U8*) nvp + NVSIZE - 1 - i;
579 #endif
580 #ifdef NV_LITTLE_ENDIAN
581     return (U8*) nvp + i;
582 #endif
583 }
584
585 /*
586 =for apidoc nan_signaling_set
587
588 Set or unset the NaN signaling-ness.
589
590 Of those platforms that differentiate between quiet and signaling
591 platforms the majority has the semantics of the most significant bit
592 being on meaning quiet NaN, so for signaling we need to clear the bit.
593
594 Some platforms (older MIPS, and HPPA) have the opposite
595 semantics, and we set the bit for a signaling NaN.
596
597 =cut
598 */
599 void
600 Perl_nan_signaling_set(NV *nvp, bool signaling)
601 {
602     U8 mask;
603     U8* hibyte;
604
605     PERL_ARGS_ASSERT_NAN_SIGNALING_SET;
606
607     hibyte = nan_hibyte(nvp, &mask);
608     if (hibyte) {
609         const NV nan = NV_NAN;
610         /* Decent optimizers should make the irrelevant branch to disappear. */
611         if ((((U8*)&nan)[hibyte - (U8*)nvp] & mask)) {
612             /* x86 style: the most significant bit of the NaN is off
613              * for a signaling NaN, and on for a quiet NaN. */
614             if (signaling) {
615                 *hibyte &= ~mask;
616             } else {
617                 *hibyte |=  mask;
618             }
619         } else {
620             /* MIPS/HPPA style: the most significant bit of the NaN is on
621              * for a signaling NaN, and off for a quiet NaN. */
622             if (signaling) {
623                 *hibyte |=  mask;
624             } else {
625                 *hibyte &= ~mask;
626             }
627         }
628     }
629 }
630
631 /*
632 =for apidoc nan_is_signaling
633
634 Returns true if the nv is a NaN is a signaling NaN.
635
636 =cut
637 */
638 int
639 Perl_nan_is_signaling(NV nv)
640 {
641     /* Quiet NaN bit pattern (64-bit doubles, ignore endianness):
642      * x86    00 00 00 00 00 00 f8 7f
643      * sparc  7f ff ff ff ff ff ff ff
644      * mips   7f f7 ff ff ff ff ff ff
645      * hppa   7f f4 00 00 00 00 00 00
646      * The "7ff" is the exponent.  The most significant bit of the NaN
647      * (note: here, not the most significant bit of the byte) is of
648      * interest: in the x86 style (also in sparc) the bit on means
649      * 'quiet', in the mips style the bit off means 'quiet'. */
650 #ifdef Perl_fp_classify_snan
651     return Perl_fp_classify_snan(nv);
652 #else
653     if (Perl_isnan(nv)) {
654         U8 mask;
655         U8 *hibyte = Perl_nan_hibyte(&nv, &mask);
656         /* Hoping NV_NAN is a quiet nan - this might be a false hope.
657          * XXX Configure test */
658         const NV nan = NV_NAN;
659         return (*hibyte & mask) != (((U8*)&nan)[hibyte - (U8*)&nv] & mask);
660     } else {
661         return 0;
662     }
663 #endif
664 }
665
666 /* The largest known floating point numbers are the IEEE quadruple
667  * precision of 128 bits. */
668 #define MAX_NV_BYTES (128/8)
669
670 static const char nan_payload_error[] = "NaN payload error";
671
672 /*
673
674 =for apidoc nan_payload_set
675
676 Set the NaN payload of the nv.
677
678 The first byte is the highest order byte of the payload (big-endian).
679
680 The signaling flag, if true, turns the generated NaN into a signaling one.
681 In most platforms this means turning _off_ the most significant bit of the
682 NaN.  Note the _most_ - some platforms have the opposite semantics.
683 Do not assume any portability of the NaN semantics.
684
685 =cut
686 */
687 void
688 Perl_nan_payload_set(NV *nvp, const void *bytes, STRLEN byten, bool signaling)
689 {
690     /* How many bits we can set in the payload.
691      *
692      * Note that whether the most signicant bit is a quiet or
693      * signaling NaN is actually unstandardized.  Most platforms use
694      * it as the 'quiet' bit.  The known exceptions to this are older
695      * MIPS, and HPPA.
696      *
697      * Yet another unstandardized area is what does the difference
698      * actually mean - if it exists: some platforms do not even have
699      * signaling NaNs.
700      *
701      * C99 nan() is supposed to generate quiet NaNs. */
702     int bits = NV_MANT_REAL_DIG - 1;
703
704     STRLEN i, nvi;
705     bool error = FALSE;
706
707     /* XXX None of this works for doubledouble platforms, or for mixendians. */
708
709     PERL_ARGS_ASSERT_NAN_PAYLOAD_SET;
710
711     *nvp = NV_NAN;
712
713 #ifdef NV_BIG_ENDIAN
714     nvi = NVSIZE - 1;
715 #endif
716 #ifdef NV_LITTLE_ENDIAN
717     nvi = 0;
718 #endif
719
720     if (byten > MAX_NV_BYTES) {
721         byten = MAX_NV_BYTES;
722         error = TRUE;
723     }
724     for (i = 0; bits > 0; i++) {
725         U8 b = i < byten ? ((U8*) bytes)[i] : 0;
726         if (bits > 0 && bits < 8) {
727             U8 m = (1 << bits) - 1;
728             ((U8*)nvp)[nvi] &= ~m;
729             ((U8*)nvp)[nvi] |= b & m;
730             bits = 0;
731         } else {
732             ((U8*)nvp)[nvi] = b;
733             bits -= 8;
734         }
735 #ifdef NV_BIG_ENDIAN
736         nvi--;
737 #endif
738 #ifdef NV_LITTLE_ENDIAN
739         nvi++;
740 #endif
741     }
742     if (error) {
743         Perl_ck_warner_d(aTHX_ packWARN(WARN_OVERFLOW),
744                          nan_payload_error);
745     }
746     nan_signaling_set(nvp, signaling);
747 }
748
749 /*
750 =for apidoc grok_nan_payload
751
752 Helper for grok_nan().
753
754 Parses the "..." in C99-style "nan(...)" strings, and sets the nvp accordingly.
755
756 If you want the parse the "nan" part you need to use grok_nan().
757
758 =cut
759 */
760 const char *
761 Perl_grok_nan_payload(pTHX_ const char* s, const char* send, bool signaling, int *flags, NV* nvp)
762 {
763     U8 bytes[MAX_NV_BYTES];
764     STRLEN byten = 0;
765     const char *t = send - 1; /* minus one for ')' */
766     bool error = FALSE;
767
768     PERL_ARGS_ASSERT_GROK_NAN_PAYLOAD;
769
770     /* XXX: legacy nan payload formats like "nan123",
771      * "nan0xabc", or "nan(s123)" ("s" for signaling). */
772
773     while (t > s && isSPACE(*t)) t--;
774     if (*t != ')') {
775         return send;
776     }
777
778     if (++s == send) {
779         *flags |= IS_NUMBER_TRAILING;
780         return s;
781     }
782
783     while (s < t && byten < MAX_NV_BYTES) {
784         UV uv;
785         int nantype = 0;
786
787         if (s[0] == '0' && s + 2 < t &&
788             isALPHA_FOLD_EQ(s[1], 'x') &&
789             isXDIGIT(s[2])) {
790             const char *u = s + 3;
791             STRLEN len;
792             I32 uvflags;
793
794             while (isXDIGIT(*u)) u++;
795             len = u - s;
796             uvflags = PERL_SCAN_ALLOW_UNDERSCORES;
797             uv = grok_hex(s, &len, &uvflags, NULL);
798             if ((uvflags & PERL_SCAN_GREATER_THAN_UV_MAX)) {
799                 nantype = 0;
800             } else {
801                 nantype = IS_NUMBER_IN_UV;
802             }
803             s += len;
804         } else if (s[0] == '0' && s + 2 < t &&
805                    isALPHA_FOLD_EQ(s[1], 'b') &&
806                    (s[2] == '0' || s[2] == '1')) {
807             const char *u = s + 3;
808             STRLEN len;
809             I32 uvflags;
810
811             while (*u == '0' || *u == '1') u++;
812             len = u - s;
813             uvflags = PERL_SCAN_ALLOW_UNDERSCORES;
814             uv = grok_bin(s, &len, &uvflags, NULL);
815             if ((uvflags & PERL_SCAN_GREATER_THAN_UV_MAX)) {
816                 nantype = 0;
817             } else {
818                 nantype = IS_NUMBER_IN_UV;
819             }
820             s += len;
821         } else if ((s[0] == '\'' || s[0] == '"') &&
822                    s + 2 < t && t[-1] == s[0]) {
823             /* Perl extension: if the input looks like a string
824              * constant ('' or ""), read its bytes as-they-come. */
825             STRLEN n = t - s - 2;
826             STRLEN i;
827             if ((n > MAX_NV_BYTES - byten) ||
828                 (n * 8 > NV_MANT_REAL_DIG)) {
829                 error = TRUE;
830                 break;
831             }
832             /* Copy the bytes in reverse so that \x41\x42 ('AB')
833              * is equivalent to 0x4142.  In other words, the bytes
834              * are in big-endian order. */
835             for (i = 0; i < n; i++) {
836                 bytes[n - i - 1] = s[i + 1];
837             }
838             byten += n;
839             break;
840         } else if (s < t && isDIGIT(*s)) {
841             const char *u;
842             nantype =
843                 grok_number_flags(s, (STRLEN)(t - s), &uv,
844                                   PERL_SCAN_TRAILING |
845                                   PERL_SCAN_ALLOW_UNDERSCORES);
846             /* Unfortunately grok_number_flags() doesn't
847              * tell how far we got and the ')' will always
848              * be "trailing", so we need to double-check
849              * whether we had something dubious. */
850             for (u = s; u < send - 1; u++) {
851                 if (!isDIGIT(*u)) {
852                     *flags |= IS_NUMBER_TRAILING;
853                     break;
854                 }
855             }
856             s = u;
857         } else {
858             error = TRUE;
859             break;
860         }
861         /* XXX Doesn't do octal: nan("0123").
862          * Probably not a big loss. */
863
864         if (!(nantype & IS_NUMBER_IN_UV)) {
865             error = TRUE;
866             break;
867         }
868
869         if (uv) {
870             while (uv && byten < MAX_NV_BYTES) {
871                 bytes[byten++] = (U8) (uv & 0xFF);
872                 uv >>= 8;
873             }
874         }
875     }
876
877     if (byten == 0) {
878         bytes[byten++] = 0;
879     }
880
881     if (error) {
882         Perl_ck_warner_d(aTHX_ packWARN(WARN_OVERFLOW),
883                          nan_payload_error);
884     }
885
886     if (s == send) {
887         *flags |= IS_NUMBER_TRAILING;
888         return s;
889     }
890
891     if (nvp) {
892         nan_payload_set(nvp, bytes, byten, signaling);
893     }
894
895     return s;
896 }
897
898 /*
899 =for apidoc grok_nan
900
901 Helper for grok_infnan().
902
903 Parses the C99-style "nan(...)" strings, and sets the nvp accordingly.
904
905 *sp points to the beginning of "nan", which can be also "qnan", "nanq",
906 or "snan", "nans", and case is ignored.
907
908 The "..." is parsed with grok_nan_payload().
909
910 =cut
911 */
912 const char *
913 Perl_grok_nan(pTHX_ const char* s, const char* send, int *flags, NV* nvp)
914 {
915     bool signaling = FALSE;
916
917     PERL_ARGS_ASSERT_GROK_NAN;
918
919     if (isALPHA_FOLD_EQ(*s, 'S')) {
920         signaling = TRUE;
921         s++; if (s == send) return s;
922     } else if (isALPHA_FOLD_EQ(*s, 'Q')) {
923         s++; if (s == send) return s;
924     }
925
926     if (isALPHA_FOLD_EQ(*s, 'N')) {
927         s++; if (s == send || isALPHA_FOLD_NE(*s, 'A')) return s;
928         s++; if (s == send || isALPHA_FOLD_NE(*s, 'N')) return s;
929         s++;
930
931         *flags |= IS_NUMBER_NAN | IS_NUMBER_NOT_INT;
932
933         /* NaN can be followed by various stuff (NaNQ, NaNS), while
934          * some legacy implementations have weird stuff like "NaN%"
935          * (no idea what that means). */
936         if (isALPHA_FOLD_EQ(*s, 's')) {
937             signaling = TRUE;
938             s++;
939         } else if (isALPHA_FOLD_EQ(*s, 'q')) {
940             s++;
941         }
942
943         if (*s == '(') {
944             const char *n = grok_nan_payload(s, send, signaling, flags, nvp);
945             if (n == send) return NULL;
946             s = n;
947             if (*s != ')') {
948                 *flags |= IS_NUMBER_TRAILING;
949                 return s;
950             }
951         } else {
952             if (nvp) {
953                 U8 bytes[1] = { 0 };
954                 nan_payload_set(nvp, bytes, 1, signaling);
955             }
956
957             while (s < send && isSPACE(*s)) s++;
958
959             if (s < send && *s) {
960                 /* Note that we here implicitly accept (parse as
961                  * "nan", but with warnings) also any other weird
962                  * trailing stuff for "nan".  In the above we just
963                  * check that if we got the C99-style "nan(...)",
964                  * the "..."  looks sane.  If in future we accept
965                  * more ways of specifying the nan payload (like
966                  * "nan123" or "nan0xabc"), the accepting would
967                  * happen around here. */
968                 *flags |= IS_NUMBER_TRAILING;
969             }
970         }
971
972         s = send;
973     }
974     else
975         return NULL;
976
977     return s;
978 }
979
980 /*
981 =for apidoc grok_infnan
982
983 Helper for grok_number(), accepts various ways of spelling "infinity"
984 or "not a number", and returns one of the following flag combinations:
985
986   IS_NUMBER_INFINITE
987   IS_NUMBER_NAN
988   IS_NUMBER_INFINITE | IS_NUMBER_NEG
989   IS_NUMBER_NAN | IS_NUMBER_NEG
990   0
991
992 possibly |-ed with IS_NUMBER_TRAILING.
993
994 If an infinity or a not-a-number is recognized, the *sp will point to
995 one byte past the end of the recognized string.  If the recognition fails,
996 zero is returned, and the *sp will not move.
997
998 =cut
999 */
1000
1001 int
1002 Perl_grok_infnan(pTHX_ const char** sp, const char* send, NV* nvp)
1003 {
1004     const char* s = *sp;
1005     int flags = 0;
1006     bool odh = FALSE; /* one-dot-hash: 1.#INF */
1007
1008     PERL_ARGS_ASSERT_GROK_INFNAN;
1009
1010     /* XXX there are further legacy formats like HP-UX "++" for Inf
1011      * and "--" for -Inf.  While we might be able to grok those in
1012      * string numification, having those in source code might open
1013      * up too much golfing: ++++;
1014      */
1015
1016     if (*s == '+') {
1017         s++; if (s == send) return 0;
1018     }
1019     else if (*s == '-') {
1020         flags |= IS_NUMBER_NEG; /* Yes, -NaN happens. Incorrect but happens. */
1021         s++; if (s == send) return 0;
1022     }
1023
1024     if (*s == '1') {
1025         /* Visual C: 1.#SNAN, -1.#QNAN, 1#INF, 1.#IND (maybe also 1.#NAN)
1026          * Let's keep the dot optional. */
1027         s++; if (s == send) return 0;
1028         if (*s == '.') {
1029             s++; if (s == send) return 0;
1030         }
1031         if (*s == '#') {
1032             s++; if (s == send) return 0;
1033         } else
1034             return 0;
1035         odh = TRUE;
1036     }
1037
1038     if (isALPHA_FOLD_EQ(*s, 'I')) {
1039         /* INF or IND (1.#IND is "indeterminate", a certain type of NAN) */
1040
1041         s++; if (s == send || isALPHA_FOLD_NE(*s, 'N')) return 0;
1042         s++; if (s == send) return 0;
1043         if (isALPHA_FOLD_EQ(*s, 'F')) {
1044             s++;
1045             if (s < send && (isALPHA_FOLD_EQ(*s, 'I'))) {
1046                 int fail =
1047                     flags | IS_NUMBER_INFINITY | IS_NUMBER_NOT_INT | IS_NUMBER_TRAILING;
1048                 s++; if (s == send || isALPHA_FOLD_NE(*s, 'N')) return fail;
1049                 s++; if (s == send || isALPHA_FOLD_NE(*s, 'I')) return fail;
1050                 s++; if (s == send || isALPHA_FOLD_NE(*s, 'T')) return fail;
1051                 s++; if (s == send || isALPHA_FOLD_NE(*s, 'Y')) return fail;
1052                 s++;
1053             } else if (odh) {
1054                 while (*s == '0') { /* 1.#INF00 */
1055                     s++;
1056                 }
1057             }
1058             while (s < send && isSPACE(*s))
1059                 s++;
1060             if (s < send && *s) {
1061                 flags |= IS_NUMBER_TRAILING;
1062             }
1063             flags |= IS_NUMBER_INFINITY | IS_NUMBER_NOT_INT;
1064             if (nvp) {
1065                 *nvp = (flags & IS_NUMBER_NEG) ? -NV_INF: NV_INF;
1066             }
1067         }
1068         else if (isALPHA_FOLD_EQ(*s, 'D') && odh) { /* 1.#IND */
1069             s++;
1070             flags |= IS_NUMBER_NAN | IS_NUMBER_NOT_INT;
1071             if (nvp) {
1072                 *nvp = NV_NAN;
1073             }
1074             while (*s == '0') { /* 1.#IND00 */
1075                 s++;
1076             }
1077             if (*s) {
1078                 flags |= IS_NUMBER_TRAILING;
1079             }
1080         } else
1081             return 0;
1082     }
1083     else {
1084         /* Maybe NAN of some sort */
1085         const char *n = grok_nan(s, send, &flags, nvp);
1086         if (n == NULL) return 0;
1087         s = n;
1088     }
1089
1090     while (s < send && isSPACE(*s))
1091         s++;
1092
1093     *sp = s;
1094     return flags;
1095 }
1096
1097 /*
1098 =for apidoc grok_number2_flags
1099
1100 Recognise (or not) a number.  The type of the number is returned
1101 (0 if unrecognised), otherwise it is a bit-ORed combination of
1102 IS_NUMBER_IN_UV, IS_NUMBER_GREATER_THAN_UV_MAX, IS_NUMBER_NOT_INT,
1103 IS_NUMBER_NEG, IS_NUMBER_INFINITY, IS_NUMBER_NAN (defined in perl.h).
1104
1105 If the value of the number can fit in a UV, it is returned in the *valuep
1106 IS_NUMBER_IN_UV will be set to indicate that *valuep is valid, IS_NUMBER_IN_UV
1107 will never be set unless *valuep is valid, but *valuep may have been assigned
1108 to during processing even though IS_NUMBER_IN_UV is not set on return.
1109 If valuep is NULL, IS_NUMBER_IN_UV will be set for the same cases as when
1110 valuep is non-NULL, but no actual assignment (or SEGV) will occur.
1111
1112 The nvp is used to directly set the value for infinities (Inf) and
1113 not-a-numbers (NaN).
1114
1115 IS_NUMBER_NOT_INT will be set with IS_NUMBER_IN_UV if trailing decimals were
1116 seen (in which case *valuep gives the true value truncated to an integer), and
1117 IS_NUMBER_NEG if the number is negative (in which case *valuep holds the
1118 absolute value).  IS_NUMBER_IN_UV is not set if e notation was used or the
1119 number is larger than a UV.
1120
1121 C<flags> allows only C<PERL_SCAN_TRAILING>, which allows for trailing
1122 non-numeric text on an otherwise successful I<grok>, setting
1123 C<IS_NUMBER_TRAILING> on the result.
1124
1125 =for apidoc grok_number_flags
1126
1127 Identical to grok_number2_flags() with nvp and flags set to zero.
1128
1129 =for apidoc grok_number
1130
1131 Identical to grok_number_flags() with flags set to zero.
1132
1133 =cut
1134  */
1135 int
1136 Perl_grok_number(pTHX_ const char *pv, STRLEN len, UV *valuep)
1137 {
1138     PERL_ARGS_ASSERT_GROK_NUMBER;
1139
1140     return grok_number_flags(pv, len, valuep, 0);
1141 }
1142
1143 int
1144 Perl_grok_number_flags(pTHX_ const char *pv, STRLEN len, UV *valuep, U32 flags)
1145 {
1146     PERL_ARGS_ASSERT_GROK_NUMBER_FLAGS;
1147
1148     return grok_number2_flags(pv, len, valuep, NULL, flags);
1149 }
1150
1151 static const UV uv_max_div_10 = UV_MAX / 10;
1152 static const U8 uv_max_mod_10 = UV_MAX % 10;
1153
1154 int
1155 Perl_grok_number2_flags(pTHX_ const char *pv, STRLEN len, UV *valuep, NV *nvp, U32 flags)
1156 {
1157   const char *s = pv;
1158   const char * const send = pv + len;
1159   const char *d;
1160   int numtype = 0;
1161
1162   PERL_ARGS_ASSERT_GROK_NUMBER2_FLAGS;
1163
1164   while (s < send && isSPACE(*s))
1165     s++;
1166   if (s == send) {
1167     return 0;
1168   } else if (*s == '-') {
1169     s++;
1170     numtype = IS_NUMBER_NEG;
1171   }
1172   else if (*s == '+')
1173     s++;
1174
1175   if (s == send)
1176     return 0;
1177
1178   /* The first digit (after optional sign): note that might
1179    * also point to "infinity" or "nan", or "1.#INF". */
1180   d = s;
1181
1182   /* next must be digit or the radix separator or beginning of infinity/nan */
1183   if (isDIGIT(*s)) {
1184     /* UVs are at least 32 bits, so the first 9 decimal digits cannot
1185        overflow.  */
1186     UV value = *s - '0';
1187     /* This construction seems to be more optimiser friendly.
1188        (without it gcc does the isDIGIT test and the *s - '0' separately)
1189        With it gcc on arm is managing 6 instructions (6 cycles) per digit.
1190        In theory the optimiser could deduce how far to unroll the loop
1191        before checking for overflow.  */
1192     if (++s < send) {
1193       int digit = *s - '0';
1194       if (digit >= 0 && digit <= 9) {
1195         value = value * 10 + digit;
1196         if (++s < send) {
1197           digit = *s - '0';
1198           if (digit >= 0 && digit <= 9) {
1199             value = value * 10 + digit;
1200             if (++s < send) {
1201               digit = *s - '0';
1202               if (digit >= 0 && digit <= 9) {
1203                 value = value * 10 + digit;
1204                 if (++s < send) {
1205                   digit = *s - '0';
1206                   if (digit >= 0 && digit <= 9) {
1207                     value = value * 10 + digit;
1208                     if (++s < send) {
1209                       digit = *s - '0';
1210                       if (digit >= 0 && digit <= 9) {
1211                         value = value * 10 + digit;
1212                         if (++s < send) {
1213                           digit = *s - '0';
1214                           if (digit >= 0 && digit <= 9) {
1215                             value = value * 10 + digit;
1216                             if (++s < send) {
1217                               digit = *s - '0';
1218                               if (digit >= 0 && digit <= 9) {
1219                                 value = value * 10 + digit;
1220                                 if (++s < send) {
1221                                   digit = *s - '0';
1222                                   if (digit >= 0 && digit <= 9) {
1223                                     value = value * 10 + digit;
1224                                     if (++s < send) {
1225                                       /* Now got 9 digits, so need to check
1226                                          each time for overflow.  */
1227                                       digit = *s - '0';
1228                                       while (digit >= 0 && digit <= 9
1229                                              && (value < uv_max_div_10
1230                                                  || (value == uv_max_div_10
1231                                                      && digit <= uv_max_mod_10))) {
1232                                         value = value * 10 + digit;
1233                                         if (++s < send)
1234                                           digit = *s - '0';
1235                                         else
1236                                           break;
1237                                       }
1238                                       if (digit >= 0 && digit <= 9
1239                                           && (s < send)) {
1240                                         /* value overflowed.
1241                                            skip the remaining digits, don't
1242                                            worry about setting *valuep.  */
1243                                         do {
1244                                           s++;
1245                                         } while (s < send && isDIGIT(*s));
1246                                         numtype |=
1247                                           IS_NUMBER_GREATER_THAN_UV_MAX;
1248                                         goto skip_value;
1249                                       }
1250                                     }
1251                                   }
1252                                 }
1253                               }
1254                             }
1255                           }
1256                         }
1257                       }
1258                     }
1259                   }
1260                 }
1261               }
1262             }
1263           }
1264         }
1265       }
1266     }
1267     numtype |= IS_NUMBER_IN_UV;
1268     if (valuep)
1269       *valuep = value;
1270
1271   skip_value:
1272     if (GROK_NUMERIC_RADIX(&s, send)) {
1273       numtype |= IS_NUMBER_NOT_INT;
1274       while (s < send && isDIGIT(*s))  /* optional digits after the radix */
1275         s++;
1276     }
1277   }
1278   else if (GROK_NUMERIC_RADIX(&s, send)) {
1279     numtype |= IS_NUMBER_NOT_INT | IS_NUMBER_IN_UV; /* valuep assigned below */
1280     /* no digits before the radix means we need digits after it */
1281     if (s < send && isDIGIT(*s)) {
1282       do {
1283         s++;
1284       } while (s < send && isDIGIT(*s));
1285       if (valuep) {
1286         /* integer approximation is valid - it's 0.  */
1287         *valuep = 0;
1288       }
1289     }
1290     else
1291         return 0;
1292   }
1293
1294   if (s > d && s < send) {
1295     /* we can have an optional exponent part */
1296     if (isALPHA_FOLD_EQ(*s, 'e')) {
1297       s++;
1298       if (s < send && (*s == '-' || *s == '+'))
1299         s++;
1300       if (s < send && isDIGIT(*s)) {
1301         do {
1302           s++;
1303         } while (s < send && isDIGIT(*s));
1304       }
1305       else if (flags & PERL_SCAN_TRAILING)
1306         return numtype | IS_NUMBER_TRAILING;
1307       else
1308         return 0;
1309
1310       /* The only flag we keep is sign.  Blow away any "it's UV"  */
1311       numtype &= IS_NUMBER_NEG;
1312       numtype |= IS_NUMBER_NOT_INT;
1313     }
1314   }
1315   while (s < send && isSPACE(*s))
1316     s++;
1317   if (s >= send)
1318     return numtype;
1319   if (len == 10 && memEQ(pv, "0 but true", 10)) {
1320     if (valuep)
1321       *valuep = 0;
1322     return IS_NUMBER_IN_UV;
1323   }
1324   /* We could be e.g. at "Inf" or "NaN", or at the "#" of "1.#INF". */
1325   if ((s + 2 < send) && strchr("inqs#", toFOLD(*s))) {
1326       /* Really detect inf/nan. Start at d, not s, since the above
1327        * code might have already consumed the "1." or "1". */
1328       NV nanv;
1329       int infnan = Perl_grok_infnan(aTHX_ &d, send, &nanv);
1330       if ((infnan & IS_NUMBER_INFINITY)) {
1331           if (nvp) {
1332               *nvp = (numtype & IS_NUMBER_NEG) ? -NV_INF : NV_INF;
1333           }
1334           return (numtype | infnan); /* Keep sign for infinity. */
1335       }
1336       else if ((infnan & IS_NUMBER_NAN)) {
1337           if (nvp) {
1338               *nvp = nanv;
1339           }
1340           return (numtype | infnan) & ~IS_NUMBER_NEG; /* Clear sign for nan. */
1341       }
1342   }
1343   else if (flags & PERL_SCAN_TRAILING) {
1344     return numtype | IS_NUMBER_TRAILING;
1345   }
1346
1347   return 0;
1348 }
1349
1350 /*
1351 =for apidoc grok_atou
1352
1353 grok_atou is a safer replacement for atoi and strtol.
1354
1355 grok_atou parses a C-style zero-byte terminated string, looking for
1356 a decimal unsigned integer.
1357
1358 Returns the unsigned integer, if a valid value can be parsed
1359 from the beginning of the string.
1360
1361 Accepts only the decimal digits '0'..'9'.
1362
1363 As opposed to atoi or strtol, grok_atou does NOT allow optional
1364 leading whitespace, or negative inputs.  If such features are
1365 required, the calling code needs to explicitly implement those.
1366
1367 If a valid value cannot be parsed, returns either zero (if non-digits
1368 are met before any digits) or UV_MAX (if the value overflows).
1369
1370 Note that extraneous leading zeros also count as an overflow
1371 (meaning that only "0" is the zero).
1372
1373 On failure, the *endptr is also set to NULL, unless endptr is NULL.
1374
1375 Trailing non-digit bytes are allowed if the endptr is non-NULL.
1376 On return the *endptr will contain the pointer to the first non-digit byte.
1377
1378 If the endptr is NULL, the first non-digit byte MUST be
1379 the zero byte terminating the pv, or zero will be returned.
1380
1381 Background: atoi has severe problems with illegal inputs, it cannot be
1382 used for incremental parsing, and therefore should be avoided
1383 atoi and strtol are also affected by locale settings, which can also be
1384 seen as a bug (global state controlled by user environment).
1385
1386 =cut
1387 */
1388
1389 UV
1390 Perl_grok_atou(const char *pv, const char** endptr)
1391 {
1392     const char* s = pv;
1393     const char** eptr;
1394     const char* end2; /* Used in case endptr is NULL. */
1395     UV val = 0; /* The return value. */
1396
1397     PERL_ARGS_ASSERT_GROK_ATOU;
1398
1399     eptr = endptr ? endptr : &end2;
1400     if (isDIGIT(*s)) {
1401         /* Single-digit inputs are quite common. */
1402         val = *s++ - '0';
1403         if (isDIGIT(*s)) {
1404             /* Extra leading zeros cause overflow. */
1405             if (val == 0) {
1406                 *eptr = NULL;
1407                 return UV_MAX;
1408             }
1409             while (isDIGIT(*s)) {
1410                 /* This could be unrolled like in grok_number(), but
1411                  * the expected uses of this are not speed-needy, and
1412                  * unlikely to need full 64-bitness. */
1413                 U8 digit = *s++ - '0';
1414                 if (val < uv_max_div_10 ||
1415                     (val == uv_max_div_10 && digit <= uv_max_mod_10)) {
1416                     val = val * 10 + digit;
1417                 } else {
1418                     *eptr = NULL;
1419                     return UV_MAX;
1420                 }
1421             }
1422         }
1423     }
1424     if (s == pv) {
1425         *eptr = NULL; /* If no progress, failed to parse anything. */
1426         return 0;
1427     }
1428     if (endptr == NULL && *s) {
1429         return 0; /* If endptr is NULL, no trailing non-digits allowed. */
1430     }
1431     *eptr = s;
1432     return val;
1433 }
1434
1435 #ifndef USE_QUADMATH
1436 STATIC NV
1437 S_mulexp10(NV value, I32 exponent)
1438 {
1439     NV result = 1.0;
1440     NV power = 10.0;
1441     bool negative = 0;
1442     I32 bit;
1443
1444     if (exponent == 0)
1445         return value;
1446     if (value == 0)
1447         return (NV)0;
1448
1449     /* On OpenVMS VAX we by default use the D_FLOAT double format,
1450      * and that format does not have *easy* capabilities [1] for
1451      * overflowing doubles 'silently' as IEEE fp does.  We also need 
1452      * to support G_FLOAT on both VAX and Alpha, and though the exponent 
1453      * range is much larger than D_FLOAT it still doesn't do silent 
1454      * overflow.  Therefore we need to detect early whether we would 
1455      * overflow (this is the behaviour of the native string-to-float 
1456      * conversion routines, and therefore of native applications, too).
1457      *
1458      * [1] Trying to establish a condition handler to trap floating point
1459      *     exceptions is not a good idea. */
1460
1461     /* In UNICOS and in certain Cray models (such as T90) there is no
1462      * IEEE fp, and no way at all from C to catch fp overflows gracefully.
1463      * There is something you can do if you are willing to use some
1464      * inline assembler: the instruction is called DFI-- but that will
1465      * disable *all* floating point interrupts, a little bit too large
1466      * a hammer.  Therefore we need to catch potential overflows before
1467      * it's too late. */
1468
1469 #if ((defined(VMS) && !defined(_IEEE_FP)) || defined(_UNICOS)) && defined(NV_MAX_10_EXP)
1470     STMT_START {
1471         const NV exp_v = log10(value);
1472         if (exponent >= NV_MAX_10_EXP || exponent + exp_v >= NV_MAX_10_EXP)
1473             return NV_MAX;
1474         if (exponent < 0) {
1475             if (-(exponent + exp_v) >= NV_MAX_10_EXP)
1476                 return 0.0;
1477             while (-exponent >= NV_MAX_10_EXP) {
1478                 /* combination does not overflow, but 10^(-exponent) does */
1479                 value /= 10;
1480                 ++exponent;
1481             }
1482         }
1483     } STMT_END;
1484 #endif
1485
1486     if (exponent < 0) {
1487         negative = 1;
1488         exponent = -exponent;
1489 #ifdef NV_MAX_10_EXP
1490         /* for something like 1234 x 10^-309, the action of calculating
1491          * the intermediate value 10^309 then returning 1234 / (10^309)
1492          * will fail, since 10^309 becomes infinity. In this case try to
1493          * refactor it as 123 / (10^308) etc.
1494          */
1495         while (value && exponent > NV_MAX_10_EXP) {
1496             exponent--;
1497             value /= 10;
1498         }
1499         if (value == 0.0)
1500             return value;
1501 #endif
1502     }
1503 #if defined(__osf__)
1504     /* Even with cc -ieee + ieee_set_fp_control(IEEE_TRAP_ENABLE_INV)
1505      * Tru64 fp behavior on inf/nan is somewhat broken. Another way
1506      * to do this would be ieee_set_fp_control(IEEE_TRAP_ENABLE_OVF)
1507      * but that breaks another set of infnan.t tests. */
1508 #  define FP_OVERFLOWS_TO_ZERO
1509 #endif
1510     for (bit = 1; exponent; bit <<= 1) {
1511         if (exponent & bit) {
1512             exponent ^= bit;
1513             result *= power;
1514 #ifdef FP_OVERFLOWS_TO_ZERO
1515             if (result == 0)
1516                 return value < 0 ? -NV_INF : NV_INF;
1517 #endif
1518             /* Floating point exceptions are supposed to be turned off,
1519              *  but if we're obviously done, don't risk another iteration.  
1520              */
1521              if (exponent == 0) break;
1522         }
1523         power *= power;
1524     }
1525     return negative ? value / result : value * result;
1526 }
1527 #endif /* #ifndef USE_QUADMATH */
1528
1529 NV
1530 Perl_my_atof(pTHX_ const char* s)
1531 {
1532     NV x = 0.0;
1533 #ifdef USE_QUADMATH
1534     Perl_my_atof2(aTHX_ s, &x);
1535     return x;
1536 #else
1537 #  ifdef USE_LOCALE_NUMERIC
1538     PERL_ARGS_ASSERT_MY_ATOF;
1539
1540     {
1541         DECLARE_STORE_LC_NUMERIC_SET_TO_NEEDED();
1542         if (PL_numeric_radix_sv && IN_LC(LC_NUMERIC)) {
1543             const char *standard = NULL, *local = NULL;
1544             bool use_standard_radix;
1545
1546             /* Look through the string for the first thing that looks like a
1547              * decimal point: either the value in the current locale or the
1548              * standard fallback of '.'. The one which appears earliest in the
1549              * input string is the one that we should have atof look for. Note
1550              * that we have to determine this beforehand because on some
1551              * systems, Perl_atof2 is just a wrapper around the system's atof.
1552              * */
1553             standard = strchr(s, '.');
1554             local = strstr(s, SvPV_nolen(PL_numeric_radix_sv));
1555
1556             use_standard_radix = standard && (!local || standard < local);
1557
1558             if (use_standard_radix)
1559                 SET_NUMERIC_STANDARD();
1560
1561             Perl_atof2(s, x);
1562
1563             if (use_standard_radix)
1564                 SET_NUMERIC_LOCAL();
1565         }
1566         else
1567             Perl_atof2(s, x);
1568         RESTORE_LC_NUMERIC();
1569     }
1570 #  else
1571     Perl_atof2(s, x);
1572 #  endif
1573 #endif
1574     return x;
1575 }
1576
1577
1578 #ifdef USING_MSVC6
1579 #  pragma warning(push)
1580 #  pragma warning(disable:4756;disable:4056)
1581 #endif
1582 static char*
1583 S_my_atof_infnan(pTHX_ const char* s, bool negative, const char* send, NV* value)
1584 {
1585     const char *p0 = negative ? s - 1 : s;
1586     const char *p = p0;
1587     int infnan = grok_infnan(&p, send, value);
1588     if (infnan && p != p0) {
1589         /* If we can generate inf/nan directly, let's do so. */
1590 #ifdef NV_INF
1591         if ((infnan & IS_NUMBER_INFINITY)) {
1592             /* grok_infnan() already set the value. */
1593             return (char*)p;
1594         }
1595 #endif
1596 #ifdef NV_NAN
1597         if ((infnan & IS_NUMBER_NAN)) {
1598             /* grok_infnan() already set the value. */
1599             return (char*)p;
1600         }
1601 #endif
1602 #ifdef Perl_strtod
1603         /* If still here, we didn't have either NV_INF or NV_NAN,
1604          * and can try falling back to native strtod/strtold.
1605          *
1606          * (Though, are our NV_INF or NV_NAN ever not defined?)
1607          *
1608          * The native interface might not recognize all the possible
1609          * inf/nan strings Perl recognizes.  What we can try
1610          * is to try faking the input.  We will try inf/-inf/nan
1611          * as the most promising/portable input. */
1612         {
1613             const char* fake = NULL;
1614             char* endp;
1615             NV nv;
1616             if ((infnan & IS_NUMBER_INFINITY)) {
1617                 fake = ((infnan & IS_NUMBER_NEG)) ? "-inf" : "inf";
1618             }
1619             else if ((infnan & IS_NUMBER_NAN)) {
1620                 fake = "nan";
1621             }
1622             assert(fake);
1623             nv = Perl_strtod(fake, &endp);
1624             if (fake != endp) {
1625                 if ((infnan & IS_NUMBER_INFINITY)) {
1626 #ifdef Perl_isinf
1627                     if (Perl_isinf(nv))
1628                         *value = nv;
1629 #else
1630                     /* last resort, may generate SIGFPE */
1631                     *value = Perl_exp((NV)1e9);
1632                     if ((infnan & IS_NUMBER_NEG))
1633                         *value = -*value;
1634 #endif
1635                     return (char*)p; /* p, not endp */
1636                 }
1637                 else if ((infnan & IS_NUMBER_NAN)) {
1638 #ifdef Perl_isnan
1639                     if (Perl_isnan(nv))
1640                         *value = nv;
1641 #else
1642                     /* last resort, may generate SIGFPE */
1643                     *value = Perl_log((NV)-1.0);
1644 #endif
1645                     return (char*)p; /* p, not endp */
1646                 }
1647             }
1648         }
1649 #endif /* #ifdef Perl_strtod */
1650     }
1651     return NULL;
1652 }
1653 #ifdef USING_MSVC6
1654 #  pragma warning(pop)
1655 #endif
1656
1657 char*
1658 Perl_my_atof2(pTHX_ const char* orig, NV* value)
1659 {
1660     const char* s = orig;
1661     NV result[3] = {0.0, 0.0, 0.0};
1662 #if defined(USE_PERL_ATOF) || defined(USE_QUADMATH)
1663     const char* send = s + strlen(orig); /* one past the last */
1664     bool negative = 0;
1665 #endif
1666 #if defined(USE_PERL_ATOF) && !defined(USE_QUADMATH)
1667     UV accumulator[2] = {0,0};  /* before/after dp */
1668     bool seen_digit = 0;
1669     I32 exp_adjust[2] = {0,0};
1670     I32 exp_acc[2] = {-1, -1};
1671     /* the current exponent adjust for the accumulators */
1672     I32 exponent = 0;
1673     I32 seen_dp  = 0;
1674     I32 digit = 0;
1675     I32 old_digit = 0;
1676     I32 sig_digits = 0; /* noof significant digits seen so far */
1677 #endif
1678
1679 #if defined(USE_PERL_ATOF) || defined(USE_QUADMATH)
1680     PERL_ARGS_ASSERT_MY_ATOF2;
1681
1682     /* leading whitespace */
1683     while (isSPACE(*s))
1684         ++s;
1685
1686     /* sign */
1687     switch (*s) {
1688         case '-':
1689             negative = 1;
1690             /* FALLTHROUGH */
1691         case '+':
1692             ++s;
1693     }
1694 #endif
1695
1696 #ifdef USE_QUADMATH
1697     {
1698         char* endp;
1699         if ((endp = S_my_atof_infnan(s, negative, send, value)))
1700             return endp;
1701         result[2] = strtoflt128(s, &endp);
1702         if (s != endp) {
1703             *value = negative ? -result[2] : result[2];
1704             return endp;
1705         }
1706         return NULL;
1707     }
1708 #elif defined(USE_PERL_ATOF)
1709
1710 /* There is no point in processing more significant digits
1711  * than the NV can hold. Note that NV_DIG is a lower-bound value,
1712  * while we need an upper-bound value. We add 2 to account for this;
1713  * since it will have been conservative on both the first and last digit.
1714  * For example a 32-bit mantissa with an exponent of 4 would have
1715  * exact values in the set
1716  *               4
1717  *               8
1718  *              ..
1719  *     17179869172
1720  *     17179869176
1721  *     17179869180
1722  *
1723  * where for the purposes of calculating NV_DIG we would have to discount
1724  * both the first and last digit, since neither can hold all values from
1725  * 0..9; but for calculating the value we must examine those two digits.
1726  */
1727 #ifdef MAX_SIG_DIG_PLUS
1728     /* It is not necessarily the case that adding 2 to NV_DIG gets all the
1729        possible digits in a NV, especially if NVs are not IEEE compliant
1730        (e.g., long doubles on IRIX) - Allen <allens@cpan.org> */
1731 # define MAX_SIG_DIGITS (NV_DIG+MAX_SIG_DIG_PLUS)
1732 #else
1733 # define MAX_SIG_DIGITS (NV_DIG+2)
1734 #endif
1735
1736 /* the max number we can accumulate in a UV, and still safely do 10*N+9 */
1737 #define MAX_ACCUMULATE ( (UV) ((UV_MAX - 9)/10))
1738
1739     {
1740         const char* endp;
1741         if ((endp = S_my_atof_infnan(aTHX_ s, negative, send, value)))
1742             return (char*)endp;
1743     }
1744
1745     /* we accumulate digits into an integer; when this becomes too
1746      * large, we add the total to NV and start again */
1747
1748     while (1) {
1749         if (isDIGIT(*s)) {
1750             seen_digit = 1;
1751             old_digit = digit;
1752             digit = *s++ - '0';
1753             if (seen_dp)
1754                 exp_adjust[1]++;
1755
1756             /* don't start counting until we see the first significant
1757              * digit, eg the 5 in 0.00005... */
1758             if (!sig_digits && digit == 0)
1759                 continue;
1760
1761             if (++sig_digits > MAX_SIG_DIGITS) {
1762                 /* limits of precision reached */
1763                 if (digit > 5) {
1764                     ++accumulator[seen_dp];
1765                 } else if (digit == 5) {
1766                     if (old_digit % 2) { /* round to even - Allen */
1767                         ++accumulator[seen_dp];
1768                     }
1769                 }
1770                 if (seen_dp) {
1771                     exp_adjust[1]--;
1772                 } else {
1773                     exp_adjust[0]++;
1774                 }
1775                 /* skip remaining digits */
1776                 while (isDIGIT(*s)) {
1777                     ++s;
1778                     if (! seen_dp) {
1779                         exp_adjust[0]++;
1780                     }
1781                 }
1782                 /* warn of loss of precision? */
1783             }
1784             else {
1785                 if (accumulator[seen_dp] > MAX_ACCUMULATE) {
1786                     /* add accumulator to result and start again */
1787                     result[seen_dp] = S_mulexp10(result[seen_dp],
1788                                                  exp_acc[seen_dp])
1789                         + (NV)accumulator[seen_dp];
1790                     accumulator[seen_dp] = 0;
1791                     exp_acc[seen_dp] = 0;
1792                 }
1793                 accumulator[seen_dp] = accumulator[seen_dp] * 10 + digit;
1794                 ++exp_acc[seen_dp];
1795             }
1796         }
1797         else if (!seen_dp && GROK_NUMERIC_RADIX(&s, send)) {
1798             seen_dp = 1;
1799             if (sig_digits > MAX_SIG_DIGITS) {
1800                 do {
1801                     ++s;
1802                 } while (isDIGIT(*s));
1803                 break;
1804             }
1805         }
1806         else {
1807             break;
1808         }
1809     }
1810
1811     result[0] = S_mulexp10(result[0], exp_acc[0]) + (NV)accumulator[0];
1812     if (seen_dp) {
1813         result[1] = S_mulexp10(result[1], exp_acc[1]) + (NV)accumulator[1];
1814     }
1815
1816     if (seen_digit && (isALPHA_FOLD_EQ(*s, 'e'))) {
1817         bool expnegative = 0;
1818
1819         ++s;
1820         switch (*s) {
1821             case '-':
1822                 expnegative = 1;
1823                 /* FALLTHROUGH */
1824             case '+':
1825                 ++s;
1826         }
1827         while (isDIGIT(*s))
1828             exponent = exponent * 10 + (*s++ - '0');
1829         if (expnegative)
1830             exponent = -exponent;
1831     }
1832
1833
1834
1835     /* now apply the exponent */
1836
1837     if (seen_dp) {
1838         result[2] = S_mulexp10(result[0],exponent+exp_adjust[0])
1839                 + S_mulexp10(result[1],exponent-exp_adjust[1]);
1840     } else {
1841         result[2] = S_mulexp10(result[0],exponent+exp_adjust[0]);
1842     }
1843
1844     /* now apply the sign */
1845     if (negative)
1846         result[2] = -result[2];
1847 #endif /* USE_PERL_ATOF */
1848     *value = result[2];
1849     return (char *)s;
1850 }
1851
1852 /*
1853 =for apidoc isinfnan
1854
1855 Perl_isinfnan() is utility function that returns true if the NV
1856 argument is either an infinity or a NaN, false otherwise.  To test
1857 in more detail, use Perl_isinf() and Perl_isnan().
1858
1859 This is also the logical inverse of Perl_isfinite().
1860
1861 =cut
1862 */
1863 bool
1864 Perl_isinfnan(NV nv)
1865 {
1866 #ifdef Perl_isinf
1867     if (Perl_isinf(nv))
1868         return TRUE;
1869 #endif
1870 #ifdef Perl_isnan
1871     if (Perl_isnan(nv))
1872         return TRUE;
1873 #endif
1874     return FALSE;
1875 }
1876
1877 /*
1878 =for apidoc
1879
1880 Checks whether the argument would be either an infinity or NaN when used
1881 as a number, but is careful not to trigger non-numeric or uninitialized
1882 warnings.  it assumes the caller has done SvGETMAGIC(sv) already.
1883
1884 =cut
1885 */
1886
1887 bool
1888 Perl_isinfnansv(pTHX_ SV *sv)
1889 {
1890     PERL_ARGS_ASSERT_ISINFNANSV;
1891     if (!SvOK(sv))
1892         return FALSE;
1893     if (SvNOKp(sv))
1894         return Perl_isinfnan(SvNVX(sv));
1895     if (SvIOKp(sv))
1896         return FALSE;
1897     {
1898         STRLEN len;
1899         const char *s = SvPV_nomg_const(sv, len);
1900         return cBOOL(grok_infnan(&s, s+len, NULL));
1901     }
1902 }
1903
1904 #ifndef HAS_MODFL
1905 /* C99 has truncl, pre-C99 Solaris had aintl.  We can use either with
1906  * copysignl to emulate modfl, which is in some platforms missing or
1907  * broken. */
1908 #  if defined(HAS_TRUNCL) && defined(HAS_COPYSIGNL)
1909 long double
1910 Perl_my_modfl(long double x, long double *ip)
1911 {
1912     *ip = truncl(x);
1913     return (x == *ip ? copysignl(0.0L, x) : x - *ip);
1914 }
1915 #  elif defined(HAS_AINTL) && defined(HAS_COPYSIGNL)
1916 long double
1917 Perl_my_modfl(long double x, long double *ip)
1918 {
1919     *ip = aintl(x);
1920     return (x == *ip ? copysignl(0.0L, x) : x - *ip);
1921 }
1922 #  endif
1923 #endif
1924
1925 /* Similarly, with ilogbl and scalbnl we can emulate frexpl. */
1926 #if ! defined(HAS_FREXPL) && defined(HAS_ILOGBL) && defined(HAS_SCALBNL)
1927 long double
1928 Perl_my_frexpl(long double x, int *e) {
1929     *e = x == 0.0L ? 0 : ilogbl(x) + 1;
1930     return (scalbnl(x, -*e));
1931 }
1932 #endif
1933
1934 /*
1935 =for apidoc Perl_signbit
1936
1937 Return a non-zero integer if the sign bit on an NV is set, and 0 if
1938 it is not.  
1939
1940 If Configure detects this system has a signbit() that will work with
1941 our NVs, then we just use it via the #define in perl.h.  Otherwise,
1942 fall back on this implementation.  The main use of this function
1943 is catching -0.0.
1944
1945 Configure notes:  This function is called 'Perl_signbit' instead of a
1946 plain 'signbit' because it is easy to imagine a system having a signbit()
1947 function or macro that doesn't happen to work with our particular choice
1948 of NVs.  We shouldn't just re-#define signbit as Perl_signbit and expect
1949 the standard system headers to be happy.  Also, this is a no-context
1950 function (no pTHX_) because Perl_signbit() is usually re-#defined in
1951 perl.h as a simple macro call to the system's signbit().
1952 Users should just always call Perl_signbit().
1953
1954 =cut
1955 */
1956 #if !defined(HAS_SIGNBIT)
1957 int
1958 Perl_signbit(NV x) {
1959 #  ifdef Perl_fp_class_nzero
1960     if (x == 0)
1961         return Perl_fp_class_nzero(x);
1962 #  endif
1963     return (x < 0.0) ? 1 : 0;
1964 }
1965 #endif
1966
1967 /*
1968  * Local variables:
1969  * c-indentation-style: bsd
1970  * c-basic-offset: 4
1971  * indent-tabs-mode: nil
1972  * End:
1973  *
1974  * ex: set ts=8 sts=4 sw=4 et:
1975  */