Allow step to be negative for decreasing ranges

Author: Girgias

ext/standard/array.c

@@ -2726,6 +2726,7 @@ PHP_FUNCTION(range)
 {
 	zval *user_start, *user_end, *user_step = NULL, tmp;
 	bool is_step_double = false;
+	bool is_step_negative = false;
 	double step_double = 1.0;
 	zend_long step = 1;
 
@@ -2751,10 +2752,7 @@ PHP_FUNCTION(range)
 
 			/* We only want positive step values. */
 			if (step_double < 0.0) {
-				php_error_docref(NULL, E_WARNING, "Argument #3 ($step) must be greater than 0, $step multiplied by -1");
-				if (UNEXPECTED(EG(exception))) {
-					RETURN_THROWS();
-				}
+				is_step_negative = true;
 				step_double *= -1;
 			}
 			step = zend_dval_to_lval(step_double);
@@ -2765,10 +2763,7 @@ PHP_FUNCTION(range)
 			step = Z_LVAL_P(user_step);
 			/* We only want positive step values. */
 			if (step < 0) {
-				php_error_docref(NULL, E_WARNING, "Argument #3 ($step) must be greater than 0, $step multiplied by -1");
-				if (UNEXPECTED(EG(exception))) {
-					RETURN_THROWS();
-				}
+				is_step_negative = true;
 				step *= -1;
 			}
 			step_double = (double) step;
@@ -2828,7 +2823,8 @@ PHP_FUNCTION(range)
 		unsigned char low = (unsigned char)Z_STRVAL_P(user_start)[0];
 		unsigned char high = (unsigned char)Z_STRVAL_P(user_end)[0];
 
-		if (low > high) {		/* Negative Steps */
+		/* Decreasing char range */
+		if (low > high) {
 			if (low - high < step) {
 				goto boundary_error;
 			}
@@ -2844,7 +2840,10 @@ PHP_FUNCTION(range)
 					}
 				}
 			} ZEND_HASH_FILL_END();
-		} else if (high > low) {	/* Positive Steps */
+		} else if (high > low) { /* Increasing char range */
+			if (is_step_negative) {
+				goto negative_step_error;
+			}
 			if (high - low < step) {
 				goto boundary_error;
 			}
@@ -2872,7 +2871,8 @@ PHP_FUNCTION(range)
 		double element;
 		uint32_t i, size;
 
-		if (start_double > end_double) { 		/* Negative steps */
+		/* Decreasing float range */
+		if (start_double > end_double) {
 			if (start_double - end_double < step_double) {
 				goto boundary_error;
 			}
@@ -2885,7 +2885,10 @@ PHP_FUNCTION(range)
 					ZEND_HASH_FILL_NEXT();
 				}
 			} ZEND_HASH_FILL_END();
-		} else if (end_double > start_double) { 	/* Positive steps */
+		} else if (end_double > start_double) { /* Increasing float range */
+			if (is_step_negative) {
+				goto negative_step_error;
+			}
 			if (end_double - start_double < step_double) {
 				goto boundary_error;
 			}
@@ -2909,7 +2912,8 @@ PHP_FUNCTION(range)
 		zend_ulong unsigned_step= (zend_ulong)step;
 		uint32_t i, size;
 
-		if (start_long > end_long) { 		/* Negative steps */
+		/* Decreasing int range */
+		if (start_long > end_long) {
 			if ((zend_ulong)start_long - end_long < unsigned_step) {
 				goto boundary_error;
 			}
@@ -2922,7 +2926,10 @@ PHP_FUNCTION(range)
 					ZEND_HASH_FILL_NEXT();
 				}
 			} ZEND_HASH_FILL_END();
-		} else if (end_long > start_long) { 	/* Positive steps */
+		} else if (end_long > start_long) { /* Increasing int range */
+			if (is_step_negative) {
+				goto negative_step_error;
+			}
 			if ((zend_ulong)end_long - start_long < unsigned_step) {
 				goto boundary_error;
 			}
@@ -2943,6 +2950,10 @@ PHP_FUNCTION(range)
 	}
 	return;
 
+negative_step_error:
+	zend_argument_value_error(3, "must be greater than 0 for increasing ranges");
+	RETURN_THROWS();
+
 boundary_error:
 	zend_argument_value_error(3, "must be less than the range spanned by argument #1 ($start) and argument #2 ($end)");
 	RETURN_THROWS();

ext/standard/tests/array/range/range_negative_step_decreasing_ranges.phpt

@@ -0,0 +1,33 @@
+--TEST--
+range() allows $step parameter to be negative for decreasing ranges
+--INI--
+precision=14
+--FILE--
+<?php
+var_dump(range('c', 'a', -1));
+var_dump(range(3, 1, -1));
+var_dump(range(3.5, 1.5, -1.5));
+?>
+--EXPECT--
+array(3) {
+  [0]=>
+  string(1) "c"
+  [1]=>
+  string(1) "b"
+  [2]=>
+  string(1) "a"
+}
+array(3) {
+  [0]=>
+  int(3)
+  [1]=>
+  int(2)
+  [2]=>
+  int(1)
+}
+array(2) {
+  [0]=>
+  float(3.5)
+  [1]=>
+  float(2)
+}

ext/standard/tests/array/range/range_step_errors.phpt

@@ -87,7 +87,7 @@ try {
     echo $e->getMessage(), "\n";
 }
 
-echo "Step must not be negative\n";
+echo "Step must not be negative for increasing ranges\n";
 try {
     var_dump(range('a', 'c', -1));
 } catch (\ValueError $e) {
@@ -98,11 +98,6 @@ try {
 } catch (\ValueError $e) {
     echo $e->getMessage(), "\n";
 }
-try {
-    var_dump(range('a', 'c', -1));
-} catch (\ValueError $e) {
-    echo $e->getMessage(), "\n";
-}
 try {
     var_dump(range(1.5, 3.5, -1.5));
 } catch (\ValueError $e) {
@@ -133,42 +128,7 @@ range(): Argument #3 ($step) must be less than the range spanned by argument #1
 range(): Argument #3 ($step) must be less than the range spanned by argument #1 ($start) and argument #2 ($end)
 -- Testing ( (low > high) && (low-high < step) ) for characters --
 range(): Argument #3 ($step) must be less than the range spanned by argument #1 ($start) and argument #2 ($end)
-Step must not be negative
-
-Warning: range(): Argument #3 ($step) must be greater than 0, $step multiplied by -1 in %s on line %d
-array(3) {
-  [0]=>
-  string(1) "a"
-  [1]=>
-  string(1) "b"
-  [2]=>
-  string(1) "c"
-}
-
-Warning: range(): Argument #3 ($step) must be greater than 0, $step multiplied by -1 in %s on line %d
-array(3) {
-  [0]=>
-  int(1)
-  [1]=>
-  int(2)
-  [2]=>
-  int(3)
-}
-
-Warning: range(): Argument #3 ($step) must be greater than 0, $step multiplied by -1 in %s on line %d
-array(3) {
-  [0]=>
-  string(1) "a"
-  [1]=>
-  string(1) "b"
-  [2]=>
-  string(1) "c"
-}
-
-Warning: range(): Argument #3 ($step) must be greater than 0, $step multiplied by -1 in %s on line %d
-array(2) {
-  [0]=>
-  float(1.5)
-  [1]=>
-  float(3)
-}
+Step must not be negative for increasing ranges
+range(): Argument #3 ($step) must be greater than 0 for increasing ranges
+range(): Argument #3 ($step) must be greater than 0 for increasing ranges
+range(): Argument #3 ($step) must be greater than 0 for increasing ranges