Skip to content

Commit 5905857

Browse files
TimWollaSakiTakamachinielsdos
authored
RFC: Add the RoundingMode enum (php#14833)
see https://wiki.php.net/rfc/correctly_name_the_rounding_mode_and_make_it_an_enum Co-authored-by: Saki Takamachi <[email protected]> Co-authored-by: Niels Dossche <[email protected]>
1 parent 81da53f commit 5905857

29 files changed

+401
-152
lines changed

‎NEWS‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,10 @@ PHP NEWS
55
- Core:
66
. Fix GH-14978 (The xmlreader extension phpize build). (Peter Kokot)
77

8+
- BCMath:
9+
. Adjust bcround()'s $mode parameter to only accept the RoundingMode
10+
enum. (timwolla, saki)
11+
812
- DOM:
913
. Fix trampoline leak in xpath callables. (nielsdos)
1014

@@ -18,6 +22,7 @@ PHP NEWS
1822

1923
- Standard:
2024
. Fix references in request_parse_body() options array. (nielsdos)
25+
. Add RoundingMode enum. (timwolla, saki)
2126

2227
- XSL:
2328
. Fix trampoline leak in xpath callables. (nielsdos)

‎UPGRADING‎

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -344,6 +344,9 @@ PHP 8.4 UPGRADE NOTES
344344
. stream_bucket_make_writeable() and stream_bucket_new() will now return a
345345
StreamBucket instance instead of an stdClass instance.
346346
RFC: https://wiki.php.net/rfc/dedicated_stream_bucket
347+
. Added a new RoundingMode enum with clearer naming and improved discoverability
348+
compared to the PHP_ROUND_* constants.
349+
RFC: https://wiki.php.net/rfc/correctly_name_the_rounding_mode_and_make_it_an_enum
347350

348351
- SOAP:
349352
. Added support for clark notation for namespaces in class map.
@@ -549,23 +552,27 @@ PHP 8.4 UPGRADE NOTES
549552
would have resulted in 1.0 instead of the correct result 0.0. Additional
550553
inputs might also be affected and result in different outputs compared to
551554
earlier PHP versions.
552-
. The default value of the 'cost' option for PASSWORD_BCRYPT for password_hash()
553-
has been increased from '10' to '12'.
555+
. The $mode parameter of the round() function has been widened to RoundingMode|int,
556+
accepting instances of a new RoundingMode enum.
554557

555-
RFC: https://wiki.php.net/rfc/bcrypt_cost_2023
556-
. Four new modes have been added to the round() function: PHP_ROUND_CEILING,
557-
PHP_ROUND_FLOOR, PHP_ROUND_TOWARD_ZERO, PHP_ROUND_AWAY_FROM_ZERO.
558+
RFC: https://wiki.php.net/rfc/correctly_name_the_rounding_mode_and_make_it_an_enum
559+
. Four new modes have been added to the round() function: RoundingMode::PositiveInfinity,
560+
RoundingMode::NegativeInfinity, RoundingMode::TowardsZero, RoundingMode::AwayFromZero.
558561

559562
RFC: https://wiki.php.net/rfc/new_rounding_modes_to_round_function
560-
. debug_zval_dump() now indicates whether an array is packed.
561563
. Fixed a bug caused by "pre-rounding" of the round() function. Previously, using
562564
"pre-rounding" to treat a value like 0.285 (actually 0.28499999999999998) as a
563565
decimal number and round it to 0.29. However, "pre-rounding" incorrectly rounds
564566
certain numbers, so this fix removes "pre-rounding" and changes the way numbers
565567
are compared, so that the values are correctly rounded as decimal numbers.
566-
. long2ip() now returns string instead of string|false.
567568
. The maximum precision that can be handled by round() has been extended by
568569
one digit.
570+
. The default value of the 'cost' option for PASSWORD_BCRYPT for password_hash()
571+
has been increased from '10' to '12'.
572+
573+
RFC: https://wiki.php.net/rfc/bcrypt_cost_2023
574+
. debug_zval_dump() now indicates whether an array is packed.
575+
. long2ip() now returns string instead of string|false.
569576
. output_add_rewrite_var() now uses url_rewriter.hosts instead of
570577
session.trans_sid_hosts for selecting hosts that will be rewritten.
571578
. highlight_string() now has a return type of string|true instead of string|bool.
@@ -809,12 +816,6 @@ PHP 8.4 UPGRADE NOTES
809816
. P_SID (NetBSD/FreeBSD only).
810817
. P_JAILID (FreeBSD only).
811818

812-
- Standard:
813-
. PHP_ROUND_CEILING.
814-
. PHP_ROUND_FLOOR.
815-
. PHP_ROUND_TOWARD_ZERO.
816-
. PHP_ROUND_AWAY_FROM_ZERO.
817-
818819
- Sockets:
819820
. SO_EXCLUSIVEADDRUSE (Windows only).
820821
. SOCK_CONN_DGRAM (NetBSD only).

‎ext/bcmath/bcmath.c‎

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -696,15 +696,20 @@ PHP_FUNCTION(bcround)
696696
zend_string *numstr;
697697
zend_long precision = 0;
698698
zend_long mode = PHP_ROUND_HALF_UP;
699+
zend_object *mode_object = NULL;
699700
bc_num num = NULL, result;
700701

701702
ZEND_PARSE_PARAMETERS_START(1, 3)
702703
Z_PARAM_STR(numstr)
703704
Z_PARAM_OPTIONAL
704705
Z_PARAM_LONG(precision)
705-
Z_PARAM_LONG(mode)
706+
Z_PARAM_OBJ_OF_CLASS(mode_object, rounding_mode_ce)
706707
ZEND_PARSE_PARAMETERS_END();
707708

709+
if (mode_object != NULL) {
710+
mode = php_math_round_mode_from_enum(mode_object);
711+
}
712+
708713
switch (mode) {
709714
case PHP_ROUND_HALF_UP:
710715
case PHP_ROUND_HALF_DOWN:
@@ -716,7 +721,8 @@ PHP_FUNCTION(bcround)
716721
case PHP_ROUND_AWAY_FROM_ZERO:
717722
break;
718723
default:
719-
zend_argument_value_error(3, "must be a valid rounding mode (PHP_ROUND_*)");
724+
/* This is currently unreachable, but might become reachable when new modes are added. */
725+
zend_argument_value_error(3, "is an unsupported rounding mode");
720726
return;
721727
}
722728

‎ext/bcmath/bcmath.stub.php‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,4 +37,4 @@ function bcfloor(string $num): string {}
3737
function bcceil(string $num): string {}
3838

3939
/** @refcount 1 */
40-
function bcround(string $num, int $precision = 0, int $mode = PHP_ROUND_HALF_UP): string {}
40+
function bcround(string $num, int $precision = 0, RoundingMode $mode = RoundingMode::HalfAwayFromZero): string {}

‎ext/bcmath/bcmath_arginfo.h‎

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎ext/bcmath/tests/bcround_all.phpt‎

Lines changed: 104 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,104 @@
1+
--TEST--
2+
bcround() function all modes
3+
--EXTENSIONS--
4+
bcmath
5+
--FILE--
6+
<?php
7+
foreach (RoundingMode::cases() as $mode) {
8+
foreach ([
9+
'1.0',
10+
'-1.0',
11+
'1.2',
12+
'-1.2',
13+
'1.7',
14+
'-1.7',
15+
'1.5',
16+
'-1.5',
17+
'2.5',
18+
'-2.5',
19+
] as $number) {
20+
printf("%-20s: %s -> %s\n", $mode->name, $number, bcround($number, 0, $mode));
21+
}
22+
}
23+
?>
24+
--EXPECT--
25+
HalfAwayFromZero : 1.0 -> 1
26+
HalfAwayFromZero : -1.0 -> -1
27+
HalfAwayFromZero : 1.2 -> 1
28+
HalfAwayFromZero : -1.2 -> -1
29+
HalfAwayFromZero : 1.7 -> 2
30+
HalfAwayFromZero : -1.7 -> -2
31+
HalfAwayFromZero : 1.5 -> 2
32+
HalfAwayFromZero : -1.5 -> -2
33+
HalfAwayFromZero : 2.5 -> 3
34+
HalfAwayFromZero : -2.5 -> -3
35+
HalfTowardsZero : 1.0 -> 1
36+
HalfTowardsZero : -1.0 -> -1
37+
HalfTowardsZero : 1.2 -> 1
38+
HalfTowardsZero : -1.2 -> -1
39+
HalfTowardsZero : 1.7 -> 2
40+
HalfTowardsZero : -1.7 -> -2
41+
HalfTowardsZero : 1.5 -> 1
42+
HalfTowardsZero : -1.5 -> -1
43+
HalfTowardsZero : 2.5 -> 2
44+
HalfTowardsZero : -2.5 -> -2
45+
HalfEven : 1.0 -> 1
46+
HalfEven : -1.0 -> -1
47+
HalfEven : 1.2 -> 1
48+
HalfEven : -1.2 -> -1
49+
HalfEven : 1.7 -> 2
50+
HalfEven : -1.7 -> -2
51+
HalfEven : 1.5 -> 2
52+
HalfEven : -1.5 -> -2
53+
HalfEven : 2.5 -> 2
54+
HalfEven : -2.5 -> -2
55+
HalfOdd : 1.0 -> 1
56+
HalfOdd : -1.0 -> -1
57+
HalfOdd : 1.2 -> 1
58+
HalfOdd : -1.2 -> -1
59+
HalfOdd : 1.7 -> 2
60+
HalfOdd : -1.7 -> -2
61+
HalfOdd : 1.5 -> 1
62+
HalfOdd : -1.5 -> -1
63+
HalfOdd : 2.5 -> 3
64+
HalfOdd : -2.5 -> -3
65+
TowardsZero : 1.0 -> 1
66+
TowardsZero : -1.0 -> -1
67+
TowardsZero : 1.2 -> 1
68+
TowardsZero : -1.2 -> -1
69+
TowardsZero : 1.7 -> 1
70+
TowardsZero : -1.7 -> -1
71+
TowardsZero : 1.5 -> 1
72+
TowardsZero : -1.5 -> -1
73+
TowardsZero : 2.5 -> 2
74+
TowardsZero : -2.5 -> -2
75+
AwayFromZero : 1.0 -> 1
76+
AwayFromZero : -1.0 -> -1
77+
AwayFromZero : 1.2 -> 2
78+
AwayFromZero : -1.2 -> -2
79+
AwayFromZero : 1.7 -> 2
80+
AwayFromZero : -1.7 -> -2
81+
AwayFromZero : 1.5 -> 2
82+
AwayFromZero : -1.5 -> -2
83+
AwayFromZero : 2.5 -> 3
84+
AwayFromZero : -2.5 -> -3
85+
NegativeInfinity : 1.0 -> 1
86+
NegativeInfinity : -1.0 -> -1
87+
NegativeInfinity : 1.2 -> 1
88+
NegativeInfinity : -1.2 -> -2
89+
NegativeInfinity : 1.7 -> 1
90+
NegativeInfinity : -1.7 -> -2
91+
NegativeInfinity : 1.5 -> 1
92+
NegativeInfinity : -1.5 -> -2
93+
NegativeInfinity : 2.5 -> 2
94+
NegativeInfinity : -2.5 -> -3
95+
PositiveInfinity : 1.0 -> 1
96+
PositiveInfinity : -1.0 -> -1
97+
PositiveInfinity : 1.2 -> 2
98+
PositiveInfinity : -1.2 -> -1
99+
PositiveInfinity : 1.7 -> 2
100+
PositiveInfinity : -1.7 -> -1
101+
PositiveInfinity : 1.5 -> 2
102+
PositiveInfinity : -1.5 -> -1
103+
PositiveInfinity : 2.5 -> 3
104+
PositiveInfinity : -2.5 -> -2

‎ext/bcmath/tests/bcround_away_from_zero.phpt‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
--TEST--
2-
bcround() function PHP_ROUND_AWAY_FROM_ZERO
2+
bcround() function AwayFromZero
33
--EXTENSIONS--
44
bcmath
55
--FILE--
66
<?php
77
require_once __DIR__ . '/bcround_test_helper.inc';
8-
run_round_test(PHP_ROUND_AWAY_FROM_ZERO);
8+
run_round_test(RoundingMode::AwayFromZero);
99
?>
1010
--EXPECT--
1111
========== non-boundary value ==========

‎ext/bcmath/tests/bcround_ceiling.phpt‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
--TEST--
2-
bcround() function PHP_ROUND_CEILING
2+
bcround() function PositiveInfinity
33
--EXTENSIONS--
44
bcmath
55
--FILE--
66
<?php
77
require_once __DIR__ . '/bcround_test_helper.inc';
8-
run_round_test(PHP_ROUND_CEILING);
8+
run_round_test(RoundingMode::PositiveInfinity);
99
?>
1010
--EXPECT--
1111
========== non-boundary value ==========

‎ext/bcmath/tests/bcround_early_return.phpt‎

Lines changed: 18 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,6 @@ bcround() function with early return
44
bcmath
55
--FILE--
66
<?php
7-
$otherModes = [
8-
'PHP_ROUND_HALF_DOWN',
9-
'PHP_ROUND_HALF_EVEN',
10-
'PHP_ROUND_HALF_ODD',
11-
'PHP_ROUND_FLOOR',
12-
'PHP_ROUND_CEILING',
13-
'PHP_ROUND_AWAY_FROM_ZERO',
14-
'PHP_ROUND_TOWARD_ZERO',
15-
];
167

178
$early_return_cases = [
189
['123', -4],
@@ -38,33 +29,27 @@ $early_return_cases = [
3829
];
3930

4031
$results = [
41-
'PHP_ROUND_HALF_UP' => [],
42-
'PHP_ROUND_HALF_DOWN' => [],
43-
'PHP_ROUND_HALF_EVEN' => [],
44-
'PHP_ROUND_HALF_ODD' => [],
45-
'PHP_ROUND_FLOOR' => [],
46-
'PHP_ROUND_CEIL' => [],
47-
'PHP_ROUND_AWAY_FROM_ZERO' => [],
48-
'PHP_ROUND_TOWARD_ZERO' => [],
32+
RoundingMode::HalfAwayFromZero->name => [],
4933
];
5034
foreach ($early_return_cases as [$num, $precision]) {
51-
$result = str_pad("[{$num}, {$precision}]", 33, ' ', STR_PAD_LEFT) . ' => ' . bcround($num, $precision, PHP_ROUND_HALF_UP) . "\n";
35+
$result = str_pad("[{$num}, {$precision}]", 33, ' ', STR_PAD_LEFT) . ' => ' . bcround($num, $precision, RoundingMode::HalfAwayFromZero) . "\n";
5236
echo $result;
53-
$results['PHP_ROUND_HALF_UP'][] = $result;
37+
$results[RoundingMode::HalfAwayFromZero->name][] = $result;
5438
}
5539

5640
echo "\n";
5741

58-
foreach ($otherModes as $mode) {
42+
foreach (RoundingMode::cases() as $mode) {
43+
$results[$mode->name] = [];
5944
foreach ($early_return_cases as [$num, $precision]) {
60-
$result = str_pad("[{$num}, {$precision}]", 33, ' ', STR_PAD_LEFT) . ' => ' . bcround($num, $precision, constant($mode)) . "\n";
61-
$results[$mode][] = $result;
45+
$result = str_pad("[{$num}, {$precision}]", 33, ' ', STR_PAD_LEFT) . ' => ' . bcround($num, $precision, $mode) . "\n";
46+
$results[$mode->name][] = $result;
6247
}
6348

64-
if ($results['PHP_ROUND_HALF_UP'] === $results[$mode]) {
65-
echo str_pad($mode, 24, ' ', STR_PAD_LEFT) . ": result is same to PHP_ROUND_HALF_UP\n";
49+
if ($results[RoundingMode::HalfAwayFromZero->name] === $results[$mode->name]) {
50+
echo str_pad($mode->name, 24, ' ', STR_PAD_LEFT) . ": result is same to HalfAwayFromZero\n";
6651
} else {
67-
echo str_pad($mode, 24, ' ', STR_PAD_LEFT) . ": result is not same to PHP_ROUND_HALF_UP, failed\n";
52+
echo str_pad($mode->name, 24, ' ', STR_PAD_LEFT) . ": result is not same to HalfAwayFromZero, failed\n";
6853
}
6954
}
7055
?>
@@ -90,10 +75,11 @@ foreach ($otherModes as $mode) {
9075
[-0.0, 0] => 0
9176
[-0.0000, 0] => 0
9277

93-
PHP_ROUND_HALF_DOWN: result is same to PHP_ROUND_HALF_UP
94-
PHP_ROUND_HALF_EVEN: result is same to PHP_ROUND_HALF_UP
95-
PHP_ROUND_HALF_ODD: result is same to PHP_ROUND_HALF_UP
96-
PHP_ROUND_FLOOR: result is same to PHP_ROUND_HALF_UP
97-
PHP_ROUND_CEILING: result is same to PHP_ROUND_HALF_UP
98-
PHP_ROUND_AWAY_FROM_ZERO: result is same to PHP_ROUND_HALF_UP
99-
PHP_ROUND_TOWARD_ZERO: result is same to PHP_ROUND_HALF_UP
78+
HalfAwayFromZero: result is same to HalfAwayFromZero
79+
HalfTowardsZero: result is same to HalfAwayFromZero
80+
HalfEven: result is same to HalfAwayFromZero
81+
HalfOdd: result is same to HalfAwayFromZero
82+
TowardsZero: result is same to HalfAwayFromZero
83+
AwayFromZero: result is same to HalfAwayFromZero
84+
NegativeInfinity: result is same to HalfAwayFromZero
85+
PositiveInfinity: result is same to HalfAwayFromZero

‎ext/bcmath/tests/bcround_error.phpt‎

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -15,14 +15,7 @@ try {
1515
} catch (Throwable $e) {
1616
echo $e->getMessage()."\n";
1717
}
18-
19-
try {
20-
bcround('0.001', 0, 1000);
21-
} catch (Throwable $e) {
22-
echo $e->getMessage()."\n";
23-
}
2418
?>
2519
--EXPECT--
2620
bcround(): Argument #1 ($num) is not well-formed
2721
bcround(): Argument #1 ($num) is not well-formed
28-
bcround(): Argument #3 ($mode) must be a valid rounding mode (PHP_ROUND_*)

0 commit comments

Comments
 (0)