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