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
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.
12 * "That only makes eleven (plus one mislaid) and not fourteen,
13 * unless wizards count differently to other people." --Beorn
15 * [p.115 of _The Hobbit_: "Queer Lodgings"]
19 =head1 Numeric functions
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
29 #define PERL_IN_NUMERIC_C
36 return f < I32_MIN ? (U32) I32_MIN : (U32)(I32) f;
39 if (f < U32_MAX_P1_HALF)
42 return ((U32) f) | (1 + U32_MAX >> 1);
47 return f > 0 ? U32_MAX : 0 /* NaN */;
54 return f < I32_MIN ? I32_MIN : (I32) f;
57 if (f < U32_MAX_P1_HALF)
60 return (I32)(((U32) f) | (1 + U32_MAX >> 1));
65 return f > 0 ? (I32)U32_MAX : 0 /* NaN */;
72 return f < IV_MIN ? IV_MIN : (IV) f;
75 /* For future flexibility allowing for sizeof(UV) >= sizeof(IV) */
76 if (f < UV_MAX_P1_HALF)
79 return (IV)(((UV) f) | (1 + UV_MAX >> 1));
84 return f > 0 ? (IV)UV_MAX : 0 /* NaN */;
91 return f < IV_MIN ? (UV) IV_MIN : (UV)(IV) f;
94 if (f < UV_MAX_P1_HALF)
97 return ((UV) f) | (1 + UV_MAX >> 1);
102 return f > 0 ? UV_MAX : 0 /* NaN */;
108 converts a string representing a binary number to numeric form.
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.
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>
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.
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
137 Perl_grok_bin(pTHX_ const char *start, STRLEN *len_p, I32 *flags, NV *result)
139 const char *s = start;
144 const UV max_div_2 = UV_MAX / 2;
145 const bool allow_underscores = cBOOL(*flags & PERL_SCAN_ALLOW_UNDERSCORES);
146 bool overflowed = FALSE;
149 PERL_ARGS_ASSERT_GROK_BIN;
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
156 if (isALPHA_FOLD_EQ(s[0], 'b')) {
160 else if (len >= 2 && s[0] == '0' && (isALPHA_FOLD_EQ(s[1], 'b'))) {
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. */
174 if (value <= max_div_2) {
175 value = (value << 1) | (bit - '0');
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");
183 value_nv = (NV) value;
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
192 value_nv += (NV)(bit - '0');
195 if (bit == '_' && len && allow_underscores && (bit = s[1])
196 && (bit == '0' || bit == '1'))
202 if (!(*flags & PERL_SCAN_SILENT_ILLDIGIT))
203 Perl_ck_warner(aTHX_ packWARN(WARN_DIGIT),
204 "Illegal binary digit '%c' ignored", *s);
208 if ( ( overflowed && value_nv > 4294967295.0)
210 || (!overflowed && value > 0xffffffff
211 && ! (*flags & PERL_SCAN_SILENT_NON_PORTABLE))
214 Perl_ck_warner(aTHX_ packWARN(WARN_PORTABLE),
215 "Binary number > 0b11111111111111111111111111111111 non-portable");
222 *flags = PERL_SCAN_GREATER_THAN_UV_MAX;
231 converts a string representing a hex number to numeric form.
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.
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>
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.
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
260 Perl_grok_hex(pTHX_ const char *start, STRLEN *len_p, I32 *flags, NV *result)
262 const char *s = start;
266 const UV max_div_16 = UV_MAX / 16;
267 const bool allow_underscores = cBOOL(*flags & PERL_SCAN_ALLOW_UNDERSCORES);
268 bool overflowed = FALSE;
270 PERL_ARGS_ASSERT_GROK_HEX;
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.
277 if (isALPHA_FOLD_EQ(s[0], 'x')) {
281 else if (len >= 2 && s[0] == '0' && (isALPHA_FOLD_EQ(s[1], 'x'))) {
288 for (; len-- && *s; 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. */
295 if (value <= max_div_16) {
296 value = (value << 4) | XDIGIT_VALUE(*s);
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");
304 value_nv = (NV) value;
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);
316 if (*s == '_' && len && allow_underscores && s[1]
323 if (!(*flags & PERL_SCAN_SILENT_ILLDIGIT))
324 Perl_ck_warner(aTHX_ packWARN(WARN_DIGIT),
325 "Illegal hexadecimal digit '%c' ignored", *s);
329 if ( ( overflowed && value_nv > 4294967295.0)
331 || (!overflowed && value > 0xffffffff
332 && ! (*flags & PERL_SCAN_SILENT_NON_PORTABLE))
335 Perl_ck_warner(aTHX_ packWARN(WARN_PORTABLE),
336 "Hexadecimal number > 0xffffffff non-portable");
343 *flags = PERL_SCAN_GREATER_THAN_UV_MAX;
352 converts a string representing an octal number to numeric form.
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.
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>
368 If C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the octal
369 number may use '_' characters to separate digits.
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
379 Perl_grok_oct(pTHX_ const char *start, STRLEN *len_p, I32 *flags, NV *result)
381 const char *s = start;
385 const UV max_div_8 = UV_MAX / 8;
386 const bool allow_underscores = cBOOL(*flags & PERL_SCAN_ALLOW_UNDERSCORES);
387 bool overflowed = FALSE;
389 PERL_ARGS_ASSERT_GROK_OCT;
391 for (; len-- && *s; 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.
398 if (value <= max_div_8) {
399 value = (value << 3) | OCTAL_VALUE(*s);
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");
407 value_nv = (NV) value;
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);
419 if (*s == '_' && len && allow_underscores && isOCTAL(s[1])) {
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). */
429 if (!(*flags & PERL_SCAN_SILENT_ILLDIGIT))
430 Perl_ck_warner(aTHX_ packWARN(WARN_DIGIT),
431 "Illegal octal digit '%c' ignored", *s);
436 if ( ( overflowed && value_nv > 4294967295.0)
438 || (!overflowed && value > 0xffffffff
439 && ! (*flags & PERL_SCAN_SILENT_NON_PORTABLE))
442 Perl_ck_warner(aTHX_ packWARN(WARN_PORTABLE),
443 "Octal number > 037777777777 non-portable");
450 *flags = PERL_SCAN_GREATER_THAN_UV_MAX;
459 For backwards compatibility. Use C<grok_bin> instead.
463 For backwards compatibility. Use C<grok_hex> instead.
467 For backwards compatibility. Use C<grok_oct> instead.
473 Perl_scan_bin(pTHX_ const char *start, STRLEN len, STRLEN *retlen)
476 I32 flags = *retlen ? PERL_SCAN_ALLOW_UNDERSCORES : 0;
477 const UV ruv = grok_bin (start, &len, &flags, &rnv);
479 PERL_ARGS_ASSERT_SCAN_BIN;
482 return (flags & PERL_SCAN_GREATER_THAN_UV_MAX) ? rnv : (NV)ruv;
486 Perl_scan_oct(pTHX_ const char *start, STRLEN len, STRLEN *retlen)
489 I32 flags = *retlen ? PERL_SCAN_ALLOW_UNDERSCORES : 0;
490 const UV ruv = grok_oct (start, &len, &flags, &rnv);
492 PERL_ARGS_ASSERT_SCAN_OCT;
495 return (flags & PERL_SCAN_GREATER_THAN_UV_MAX) ? rnv : (NV)ruv;
499 Perl_scan_hex(pTHX_ const char *start, STRLEN len, STRLEN *retlen)
502 I32 flags = *retlen ? PERL_SCAN_ALLOW_UNDERSCORES : 0;
503 const UV ruv = grok_hex (start, &len, &flags, &rnv);
505 PERL_ARGS_ASSERT_SCAN_HEX;
508 return (flags & PERL_SCAN_GREATER_THAN_UV_MAX) ? rnv : (NV)ruv;
512 =for apidoc grok_numeric_radix
514 Scan and skip for a numeric decimal separator (radix).
519 Perl_grok_numeric_radix(pTHX_ const char **sp, const char *send)
521 #ifdef USE_LOCALE_NUMERIC
522 PERL_ARGS_ASSERT_GROK_NUMERIC_RADIX;
524 if (IN_LC(LC_NUMERIC)) {
525 DECLARE_STORE_LC_NUMERIC_SET_TO_NEEDED();
526 if (PL_numeric_radix_sv) {
528 const char * const radix = SvPV(PL_numeric_radix_sv, len);
529 if (*sp + len <= send && memEQ(*sp, radix, len)) {
531 RESTORE_LC_NUMERIC();
535 RESTORE_LC_NUMERIC();
537 /* always try "." if numeric radix didn't match because
538 * we may have data from different locales mixed */
541 PERL_ARGS_ASSERT_GROK_NUMERIC_RADIX;
543 if (*sp < send && **sp == '.') {
551 =for apidoc grok_number_flags
553 Recognise (or not) a number. The type of the number is returned
554 (0 if unrecognised), otherwise it is a bit-ORed combination of
555 IS_NUMBER_IN_UV, IS_NUMBER_GREATER_THAN_UV_MAX, IS_NUMBER_NOT_INT,
556 IS_NUMBER_NEG, IS_NUMBER_INFINITY, IS_NUMBER_NAN (defined in perl.h).
558 If the value of the number can fit in a UV, it is returned in the *valuep
559 IS_NUMBER_IN_UV will be set to indicate that *valuep is valid, IS_NUMBER_IN_UV
560 will never be set unless *valuep is valid, but *valuep may have been assigned
561 to during processing even though IS_NUMBER_IN_UV is not set on return.
562 If valuep is NULL, IS_NUMBER_IN_UV will be set for the same cases as when
563 valuep is non-NULL, but no actual assignment (or SEGV) will occur.
565 IS_NUMBER_NOT_INT will be set with IS_NUMBER_IN_UV if trailing decimals were
566 seen (in which case *valuep gives the true value truncated to an integer), and
567 IS_NUMBER_NEG if the number is negative (in which case *valuep holds the
568 absolute value). IS_NUMBER_IN_UV is not set if e notation was used or the
569 number is larger than a UV.
571 C<flags> allows only C<PERL_SCAN_TRAILING>, which allows for trailing
572 non-numeric text on an otherwise successful I<grok>, setting
573 C<IS_NUMBER_TRAILING> on the result.
575 =for apidoc grok_number
577 Identical to grok_number_flags() with flags set to zero.
582 Perl_grok_number(pTHX_ const char *pv, STRLEN len, UV *valuep)
584 PERL_ARGS_ASSERT_GROK_NUMBER;
586 return grok_number_flags(pv, len, valuep, 0);
590 =for apidoc grok_infnan
592 Helper for grok_number(), accepts various ways of spelling "infinity"
593 or "not a number", and returns one of the following flag combinations:
597 IS_NUMBER_INFINITE | IS_NUMBER_NEG
598 IS_NUMBER_NAN | IS_NUMBER_NEG
601 If an infinity or not-a-number is recognized, the *sp will point to
602 one past the end of the recognized string. If the recognition fails,
603 zero is returned, and the *sp will not move.
609 Perl_grok_infnan(const char** sp, const char* send)
613 bool odh = FALSE; /* one dot hash: 1.#INF */
615 PERL_ARGS_ASSERT_GROK_INFNAN;
618 s++; if (s == send) return 0;
620 else if (*s == '-') {
621 flags |= IS_NUMBER_NEG; /* Yes, -NaN happens. Incorrect but happens. */
622 s++; if (s == send) return 0;
626 /* Visual C: 1.#SNAN, -1.#QNAN, 1#INF, 1#.IND (maybe also 1.#NAN) */
627 s++; if (s == send) return 0;
629 s++; if (s == send) return 0;
632 s++; if (s == send) return 0;
638 if (isALPHA_FOLD_EQ(*s, 'I')) {
639 /* INF or IND (1.#IND is indeterminate, a certain type of NAN) */
640 s++; if (s == send || isALPHA_FOLD_NE(*s, 'N')) return 0;
641 s++; if (s == send) return 0;
642 if (isALPHA_FOLD_EQ(*s, 'F')) {
644 if (s < send && (isALPHA_FOLD_EQ(*s, 'I'))) {
645 s++; if (s == send || isALPHA_FOLD_NE(*s, 'N')) return 0;
646 s++; if (s == send || isALPHA_FOLD_NE(*s, 'I')) return 0;
647 s++; if (s == send || isALPHA_FOLD_NE(*s, 'T')) return 0;
648 s++; if (s == send ||
649 /* allow either Infinity or Infinite */
650 !(isALPHA_FOLD_EQ(*s, 'Y') ||
651 isALPHA_FOLD_EQ(*s, 'E'))) return 0;
652 s++; if (s < send) return 0;
655 flags |= IS_NUMBER_INFINITY | IS_NUMBER_NOT_INT;
657 else if (isALPHA_FOLD_EQ(*s, 'D') && odh) { /* 1.#IND */
659 flags |= IS_NUMBER_NAN | IS_NUMBER_NOT_INT;
665 if (isALPHA_FOLD_EQ(*s, 'S') || isALPHA_FOLD_EQ(*s, 'Q')) {
667 /* XXX do something with the snan/qnan difference */
668 s++; if (s == send) return 0;
671 if (isALPHA_FOLD_EQ(*s, 'N')) {
672 s++; if (s == send || isALPHA_FOLD_NE(*s, 'A')) return 0;
673 s++; if (s == send || isALPHA_FOLD_NE(*s, 'N')) return 0;
676 flags |= IS_NUMBER_NAN | IS_NUMBER_NOT_INT;
678 /* NaN can be followed by various stuff (NaNQ, NaNS), but
679 * there are also multiple different NaN values, and some
680 * implementations output the "payload" values,
681 * e.g. NaN123, NAN(abc), while some implementations just
682 * have weird stuff like NaN%. */
693 static const UV uv_max_div_10 = UV_MAX / 10;
694 static const U8 uv_max_mod_10 = UV_MAX % 10;
697 Perl_grok_number_flags(pTHX_ const char *pv, STRLEN len, UV *valuep, U32 flags)
700 const char * const send = pv + len;
704 PERL_ARGS_ASSERT_GROK_NUMBER_FLAGS;
706 while (s < send && isSPACE(*s))
710 } else if (*s == '-') {
712 numtype = IS_NUMBER_NEG;
720 /* The first digit (after optional sign): note that might
721 * also point to "infinity" or "nan", or "1.#INF". */
724 /* next must be digit or the radix separator or beginning of infinity/nan */
726 /* UVs are at least 32 bits, so the first 9 decimal digits cannot
729 /* This construction seems to be more optimiser friendly.
730 (without it gcc does the isDIGIT test and the *s - '0' separately)
731 With it gcc on arm is managing 6 instructions (6 cycles) per digit.
732 In theory the optimiser could deduce how far to unroll the loop
733 before checking for overflow. */
735 int digit = *s - '0';
736 if (digit >= 0 && digit <= 9) {
737 value = value * 10 + digit;
740 if (digit >= 0 && digit <= 9) {
741 value = value * 10 + digit;
744 if (digit >= 0 && digit <= 9) {
745 value = value * 10 + digit;
748 if (digit >= 0 && digit <= 9) {
749 value = value * 10 + digit;
752 if (digit >= 0 && digit <= 9) {
753 value = value * 10 + digit;
756 if (digit >= 0 && digit <= 9) {
757 value = value * 10 + digit;
760 if (digit >= 0 && digit <= 9) {
761 value = value * 10 + digit;
764 if (digit >= 0 && digit <= 9) {
765 value = value * 10 + digit;
767 /* Now got 9 digits, so need to check
768 each time for overflow. */
770 while (digit >= 0 && digit <= 9
771 && (value < uv_max_div_10
772 || (value == uv_max_div_10
773 && digit <= uv_max_mod_10))) {
774 value = value * 10 + digit;
780 if (digit >= 0 && digit <= 9
783 skip the remaining digits, don't
784 worry about setting *valuep. */
787 } while (s < send && isDIGIT(*s));
789 IS_NUMBER_GREATER_THAN_UV_MAX;
809 numtype |= IS_NUMBER_IN_UV;
814 if (GROK_NUMERIC_RADIX(&s, send)) {
815 numtype |= IS_NUMBER_NOT_INT;
816 while (s < send && isDIGIT(*s)) /* optional digits after the radix */
820 else if (GROK_NUMERIC_RADIX(&s, send)) {
821 numtype |= IS_NUMBER_NOT_INT | IS_NUMBER_IN_UV; /* valuep assigned below */
822 /* no digits before the radix means we need digits after it */
823 if (s < send && isDIGIT(*s)) {
826 } while (s < send && isDIGIT(*s));
828 /* integer approximation is valid - it's 0. */
836 if (s > d && s < send) {
837 /* we can have an optional exponent part */
838 if (isALPHA_FOLD_EQ(*s, 'e')) {
840 if (s < send && (*s == '-' || *s == '+'))
842 if (s < send && isDIGIT(*s)) {
845 } while (s < send && isDIGIT(*s));
847 else if (flags & PERL_SCAN_TRAILING)
848 return numtype | IS_NUMBER_TRAILING;
852 /* The only flag we keep is sign. Blow away any "it's UV" */
853 numtype &= IS_NUMBER_NEG;
854 numtype |= IS_NUMBER_NOT_INT;
857 while (s < send && isSPACE(*s))
861 if (len == 10 && memEQ(pv, "0 but true", 10)) {
864 return IS_NUMBER_IN_UV;
866 /* We could be e.g. at "Inf" or "NaN", or at the "#" of "1.#INF". */
867 if ((s + 2 < send) && strchr("inqs#", toFOLD(*s))) {
868 /* Really detect inf/nan. Start at d, not s, since the above
869 * code might have already consumed the "1." or "1". */
870 int infnan = Perl_grok_infnan(&d, send);
871 if ((infnan & IS_NUMBER_INFINITY)) {
872 return (numtype | infnan); /* Keep sign for infinity. */
874 else if ((infnan & IS_NUMBER_NAN)) {
875 return (numtype | infnan) & ~IS_NUMBER_NEG; /* Clear sign for nan. */
878 else if (flags & PERL_SCAN_TRAILING) {
879 return numtype | IS_NUMBER_TRAILING;
886 =for apidoc grok_atou
888 grok_atou is a safer replacement for atoi and strtol.
890 grok_atou parses a C-style zero-byte terminated string, looking for
891 a decimal unsigned integer.
893 Returns the unsigned integer, if a valid value can be parsed
894 from the beginning of the string.
896 Accepts only the decimal digits '0'..'9'.
898 As opposed to atoi or strtol, grok_atou does NOT allow optional
899 leading whitespace, or negative inputs. If such features are
900 required, the calling code needs to explicitly implement those.
902 If a valid value cannot be parsed, returns either zero (if non-digits
903 are met before any digits) or UV_MAX (if the value overflows).
905 Note that extraneous leading zeros also count as an overflow
906 (meaning that only "0" is the zero).
908 On failure, the *endptr is also set to NULL, unless endptr is NULL.
910 Trailing non-digit bytes are allowed if the endptr is non-NULL.
911 On return the *endptr will contain the pointer to the first non-digit byte.
913 If the endptr is NULL, the first non-digit byte MUST be
914 the zero byte terminating the pv, or zero will be returned.
916 Background: atoi has severe problems with illegal inputs, it cannot be
917 used for incremental parsing, and therefore should be avoided
918 atoi and strtol are also affected by locale settings, which can also be
919 seen as a bug (global state controlled by user environment).
925 Perl_grok_atou(const char *pv, const char** endptr)
929 const char* end2; /* Used in case endptr is NULL. */
930 UV val = 0; /* The return value. */
932 PERL_ARGS_ASSERT_GROK_ATOU;
934 eptr = endptr ? endptr : &end2;
936 /* Single-digit inputs are quite common. */
939 /* Extra leading zeros cause overflow. */
944 while (isDIGIT(*s)) {
945 /* This could be unrolled like in grok_number(), but
946 * the expected uses of this are not speed-needy, and
947 * unlikely to need full 64-bitness. */
948 U8 digit = *s++ - '0';
949 if (val < uv_max_div_10 ||
950 (val == uv_max_div_10 && digit <= uv_max_mod_10)) {
951 val = val * 10 + digit;
960 *eptr = NULL; /* If no progress, failed to parse anything. */
963 if (endptr == NULL && *s) {
964 return 0; /* If endptr is NULL, no trailing non-digits allowed. */
972 S_mulexp10(NV value, I32 exponent)
984 /* On OpenVMS VAX we by default use the D_FLOAT double format,
985 * and that format does not have *easy* capabilities [1] for
986 * overflowing doubles 'silently' as IEEE fp does. We also need
987 * to support G_FLOAT on both VAX and Alpha, and though the exponent
988 * range is much larger than D_FLOAT it still doesn't do silent
989 * overflow. Therefore we need to detect early whether we would
990 * overflow (this is the behaviour of the native string-to-float
991 * conversion routines, and therefore of native applications, too).
993 * [1] Trying to establish a condition handler to trap floating point
994 * exceptions is not a good idea. */
996 /* In UNICOS and in certain Cray models (such as T90) there is no
997 * IEEE fp, and no way at all from C to catch fp overflows gracefully.
998 * There is something you can do if you are willing to use some
999 * inline assembler: the instruction is called DFI-- but that will
1000 * disable *all* floating point interrupts, a little bit too large
1001 * a hammer. Therefore we need to catch potential overflows before
1004 #if ((defined(VMS) && !defined(_IEEE_FP)) || defined(_UNICOS)) && defined(NV_MAX_10_EXP)
1006 const NV exp_v = log10(value);
1007 if (exponent >= NV_MAX_10_EXP || exponent + exp_v >= NV_MAX_10_EXP)
1010 if (-(exponent + exp_v) >= NV_MAX_10_EXP)
1012 while (-exponent >= NV_MAX_10_EXP) {
1013 /* combination does not overflow, but 10^(-exponent) does */
1023 exponent = -exponent;
1024 #ifdef NV_MAX_10_EXP
1025 /* for something like 1234 x 10^-309, the action of calculating
1026 * the intermediate value 10^309 then returning 1234 / (10^309)
1027 * will fail, since 10^309 becomes infinity. In this case try to
1028 * refactor it as 123 / (10^308) etc.
1030 while (value && exponent > NV_MAX_10_EXP) {
1038 #if defined(__osf__)
1039 /* Even with cc -ieee + ieee_set_fp_control(IEEE_TRAP_ENABLE_INV)
1040 * Tru64 fp behavior on inf/nan is somewhat broken. Another way
1041 * to do this would be ieee_set_fp_control(IEEE_TRAP_ENABLE_OVF)
1042 * but that breaks another set of infnan.t tests. */
1043 # define FP_OVERFLOWS_TO_ZERO
1045 for (bit = 1; exponent; bit <<= 1) {
1046 if (exponent & bit) {
1049 #ifdef FP_OVERFLOWS_TO_ZERO
1051 return value < 0 ? -NV_INF : NV_INF;
1053 /* Floating point exceptions are supposed to be turned off,
1054 * but if we're obviously done, don't risk another iteration.
1056 if (exponent == 0) break;
1060 return negative ? value / result : value * result;
1062 #endif /* #ifndef USE_QUADMATH */
1065 Perl_my_atof(pTHX_ const char* s)
1069 Perl_my_atof2(aTHX_ s, &x);
1072 # ifdef USE_LOCALE_NUMERIC
1073 PERL_ARGS_ASSERT_MY_ATOF;
1076 DECLARE_STORE_LC_NUMERIC_SET_TO_NEEDED();
1077 if (PL_numeric_radix_sv && IN_LC(LC_NUMERIC)) {
1078 const char *standard = NULL, *local = NULL;
1079 bool use_standard_radix;
1081 /* Look through the string for the first thing that looks like a
1082 * decimal point: either the value in the current locale or the
1083 * standard fallback of '.'. The one which appears earliest in the
1084 * input string is the one that we should have atof look for. Note
1085 * that we have to determine this beforehand because on some
1086 * systems, Perl_atof2 is just a wrapper around the system's atof.
1088 standard = strchr(s, '.');
1089 local = strstr(s, SvPV_nolen(PL_numeric_radix_sv));
1091 use_standard_radix = standard && (!local || standard < local);
1093 if (use_standard_radix)
1094 SET_NUMERIC_STANDARD();
1098 if (use_standard_radix)
1099 SET_NUMERIC_LOCAL();
1103 RESTORE_LC_NUMERIC();
1113 S_my_atof_infnan(const char* s, bool negative, const char* send, NV* value)
1115 const char *p0 = negative ? s - 1 : s;
1117 int infnan = grok_infnan(&p, send);
1118 if (infnan && p != p0) {
1119 /* If we can generate inf/nan directly, let's do so. */
1121 if ((infnan & IS_NUMBER_INFINITY)) {
1122 *value = (infnan & IS_NUMBER_NEG) ? -NV_INF: NV_INF;
1127 if ((infnan & IS_NUMBER_NAN)) {
1133 /* If still here, we didn't have either NV_INF or NV_NAN,
1134 * and can try falling back to native strtod/strtold.
1136 * (Though, are our NV_INF or NV_NAN ever not defined?)
1138 * The native interface might not recognize all the possible
1139 * inf/nan strings Perl recognizes. What we can try
1140 * is to try faking the input. We will try inf/-inf/nan
1141 * as the most promising/portable input. */
1143 const char* fake = NULL;
1146 if ((infnan & IS_NUMBER_INFINITY)) {
1147 fake = ((infnan & IS_NUMBER_NEG)) ? "-inf" : "inf";
1149 else if ((infnan & IS_NUMBER_NAN)) {
1153 nv = Perl_strtod(fake, &endp);
1155 if ((infnan & IS_NUMBER_INFINITY)) {
1160 /* last resort, may generate SIGFPE */
1161 *value = Perl_exp((NV)1e9);
1162 if ((infnan & IS_NUMBER_NEG))
1165 return (char*)p; /* p, not endp */
1167 else if ((infnan & IS_NUMBER_NAN)) {
1172 /* last resort, may generate SIGFPE */
1173 *value = Perl_log((NV)-1.0);
1175 return (char*)p; /* p, not endp */
1179 #endif /* #ifdef Perl_strtod */
1185 Perl_my_atof2(pTHX_ const char* orig, NV* value)
1187 const char* s = orig;
1188 NV result[3] = {0.0, 0.0, 0.0};
1189 #if defined(USE_PERL_ATOF) || defined(USE_QUADMATH)
1190 const char* send = s + strlen(orig); /* one past the last */
1193 #if defined(USE_PERL_ATOF) && !defined(USE_QUADMATH)
1194 UV accumulator[2] = {0,0}; /* before/after dp */
1195 bool seen_digit = 0;
1196 I32 exp_adjust[2] = {0,0};
1197 I32 exp_acc[2] = {-1, -1};
1198 /* the current exponent adjust for the accumulators */
1203 I32 sig_digits = 0; /* noof significant digits seen so far */
1206 #if defined(USE_PERL_ATOF) || defined(USE_QUADMATH)
1207 PERL_ARGS_ASSERT_MY_ATOF2;
1209 /* leading whitespace */
1226 if ((endp = S_my_atof_infnan(s, negative, send, value)))
1228 result[2] = strtoflt128(s, &endp);
1230 *value = negative ? -result[2] : result[2];
1235 #elif defined(USE_PERL_ATOF)
1237 /* There is no point in processing more significant digits
1238 * than the NV can hold. Note that NV_DIG is a lower-bound value,
1239 * while we need an upper-bound value. We add 2 to account for this;
1240 * since it will have been conservative on both the first and last digit.
1241 * For example a 32-bit mantissa with an exponent of 4 would have
1242 * exact values in the set
1250 * where for the purposes of calculating NV_DIG we would have to discount
1251 * both the first and last digit, since neither can hold all values from
1252 * 0..9; but for calculating the value we must examine those two digits.
1254 #ifdef MAX_SIG_DIG_PLUS
1255 /* It is not necessarily the case that adding 2 to NV_DIG gets all the
1256 possible digits in a NV, especially if NVs are not IEEE compliant
1257 (e.g., long doubles on IRIX) - Allen <allens@cpan.org> */
1258 # define MAX_SIG_DIGITS (NV_DIG+MAX_SIG_DIG_PLUS)
1260 # define MAX_SIG_DIGITS (NV_DIG+2)
1263 /* the max number we can accumulate in a UV, and still safely do 10*N+9 */
1264 #define MAX_ACCUMULATE ( (UV) ((UV_MAX - 9)/10))
1268 if ((endp = S_my_atof_infnan(s, negative, send, value)))
1272 /* we accumulate digits into an integer; when this becomes too
1273 * large, we add the total to NV and start again */
1283 /* don't start counting until we see the first significant
1284 * digit, eg the 5 in 0.00005... */
1285 if (!sig_digits && digit == 0)
1288 if (++sig_digits > MAX_SIG_DIGITS) {
1289 /* limits of precision reached */
1291 ++accumulator[seen_dp];
1292 } else if (digit == 5) {
1293 if (old_digit % 2) { /* round to even - Allen */
1294 ++accumulator[seen_dp];
1302 /* skip remaining digits */
1303 while (isDIGIT(*s)) {
1309 /* warn of loss of precision? */
1312 if (accumulator[seen_dp] > MAX_ACCUMULATE) {
1313 /* add accumulator to result and start again */
1314 result[seen_dp] = S_mulexp10(result[seen_dp],
1316 + (NV)accumulator[seen_dp];
1317 accumulator[seen_dp] = 0;
1318 exp_acc[seen_dp] = 0;
1320 accumulator[seen_dp] = accumulator[seen_dp] * 10 + digit;
1324 else if (!seen_dp && GROK_NUMERIC_RADIX(&s, send)) {
1326 if (sig_digits > MAX_SIG_DIGITS) {
1329 } while (isDIGIT(*s));
1338 result[0] = S_mulexp10(result[0], exp_acc[0]) + (NV)accumulator[0];
1340 result[1] = S_mulexp10(result[1], exp_acc[1]) + (NV)accumulator[1];
1343 if (seen_digit && (isALPHA_FOLD_EQ(*s, 'e'))) {
1344 bool expnegative = 0;
1355 exponent = exponent * 10 + (*s++ - '0');
1357 exponent = -exponent;
1362 /* now apply the exponent */
1365 result[2] = S_mulexp10(result[0],exponent+exp_adjust[0])
1366 + S_mulexp10(result[1],exponent-exp_adjust[1]);
1368 result[2] = S_mulexp10(result[0],exponent+exp_adjust[0]);
1371 /* now apply the sign */
1373 result[2] = -result[2];
1374 #endif /* USE_PERL_ATOF */
1380 =for apidoc isinfnan
1382 Perl_isinfnan() is utility function that returns true if the NV
1383 argument is either an infinity or a NaN, false otherwise. To test
1384 in more detail, use Perl_isinf() and Perl_isnan().
1386 This is also the logical inverse of Perl_isfinite().
1391 Perl_isinfnan(NV nv)
1407 Checks whether the argument would be either an infinity or NaN when used
1408 as a number, but is careful not to trigger non-numeric or uninitialized
1409 warnings. it assumes the caller has done SvGETMAGIC(sv) already.
1415 Perl_isinfnansv(pTHX_ SV *sv)
1417 PERL_ARGS_ASSERT_ISINFNANSV;
1421 return Perl_isinfnan(SvNVX(sv));
1426 const char *s = SvPV_nomg_const(sv, len);
1427 return cBOOL(grok_infnan(&s, s+len));
1432 /* C99 has truncl, pre-C99 Solaris had aintl. We can use either with
1433 * copysignl to emulate modfl, which is in some platforms missing or
1435 # if defined(HAS_TRUNCL) && defined(HAS_COPYSIGNL)
1437 Perl_my_modfl(long double x, long double *ip)
1440 return (x == *ip ? copysignl(0.0L, x) : x - *ip);
1442 # elif defined(HAS_AINTL) && defined(HAS_COPYSIGNL)
1444 Perl_my_modfl(long double x, long double *ip)
1447 return (x == *ip ? copysignl(0.0L, x) : x - *ip);
1452 /* Similarly, with ilogbl and scalbnl we can emulate frexpl. */
1453 #if ! defined(HAS_FREXPL) && defined(HAS_ILOGBL) && defined(HAS_SCALBNL)
1455 Perl_my_frexpl(long double x, int *e) {
1456 *e = x == 0.0L ? 0 : ilogbl(x) + 1;
1457 return (scalbnl(x, -*e));
1462 =for apidoc Perl_signbit
1464 Return a non-zero integer if the sign bit on an NV is set, and 0 if
1467 If Configure detects this system has a signbit() that will work with
1468 our NVs, then we just use it via the #define in perl.h. Otherwise,
1469 fall back on this implementation. The main use of this function
1472 Configure notes: This function is called 'Perl_signbit' instead of a
1473 plain 'signbit' because it is easy to imagine a system having a signbit()
1474 function or macro that doesn't happen to work with our particular choice
1475 of NVs. We shouldn't just re-#define signbit as Perl_signbit and expect
1476 the standard system headers to be happy. Also, this is a no-context
1477 function (no pTHX_) because Perl_signbit() is usually re-#defined in
1478 perl.h as a simple macro call to the system's signbit().
1479 Users should just always call Perl_signbit().
1483 #if !defined(HAS_SIGNBIT)
1485 Perl_signbit(NV x) {
1486 # ifdef Perl_fp_class_nzero
1488 return Perl_fp_class_nzero(x);
1490 return (x < 0.0) ? 1 : 0;
1496 * c-indentation-style: bsd
1498 * indent-tabs-mode: nil
1501 * ex: set ts=8 sts=4 sw=4 et: