Make Deque::push(...$values) and unshift(...$values) variadic

Author: TysonAndre

ext/spl/spl_deque.c

@@ -970,38 +970,85 @@ static void spl_deque_shrink_capacity(spl_deque_entries *array, size_t new_capac
 
 PHP_METHOD(Deque, push)
 {
+	const zval *args;
+	uint32_t argc;
 	zval *value;
 
-	ZEND_PARSE_PARAMETERS_START(1, 1)
-		Z_PARAM_ZVAL(value)
+	ZEND_PARSE_PARAMETERS_START(0, -1)
+		Z_PARAM_VARIADIC('+', args, argc)
 	ZEND_PARSE_PARAMETERS_END();
 
-	spl_deque_push_back(Z_DEQUE_P(ZEND_THIS), value);
+	if (UNEXPECTED(argc == 0)) {
+		return;
+	}
+
+	spl_deque *intern = Z_DEQUE_P(ZEND_THIS);
+	size_t old_size = intern->array.size;
+	const size_t new_size = old_size + argc;
+	size_t mask = intern->array.mask;
+	const size_t old_capacity = mask ? mask + 1 : 0;
+
+	if (new_size > old_capacity) {
+		const size_t new_capacity = spl_deque_next_pow2_capacity(new_size);
+		spl_deque_raise_capacity(&intern->array, new_capacity);
+		mask = intern->array.mask;
+	}
+	zval *const circular_buffer = intern->array.circular_buffer;
+	const size_t old_offset = intern->array.offset;
+
+	while (1) {
+		zval *dest = &circular_buffer[(old_offset + old_size) & mask];
+		ZVAL_COPY(dest, args);
+		if (++old_size >= new_size) {
+			break;
+		}
+		args++;
+	}
+	intern->array.size = new_size;
 }
 
 PHP_METHOD(Deque, unshift)
 {
+	const zval *args;
+	uint32_t argc;
 	zval *value;
 
-	ZEND_PARSE_PARAMETERS_START(1, 1)
-		Z_PARAM_ZVAL(value)
+	ZEND_PARSE_PARAMETERS_START(0, -1)
+		Z_PARAM_VARIADIC('+', args, argc)
 	ZEND_PARSE_PARAMETERS_END();
 
+	if (UNEXPECTED(argc == 0)) {
+		return;
+	}
+
 	spl_deque *intern = Z_DEQUE_P(ZEND_THIS);
-	const size_t old_size = intern->array.size;
-	const size_t old_mask = intern->array.mask;
-	const size_t old_capacity = old_mask ? old_mask + 1 : 0;
+	size_t old_size = intern->array.size;
+	const size_t new_size = old_size + argc;
+	size_t mask = intern->array.mask;
+	const size_t old_capacity = mask ? mask + 1 : 0;
 
-	if (old_size >= old_capacity) {
-		ZEND_ASSERT(old_size == old_capacity);
-		const size_t new_capacity = old_capacity > 0 ? old_capacity * 2 : 4;
+	if (new_size > old_capacity) {
+		const size_t new_capacity = spl_deque_next_pow2_capacity(new_size);
 		spl_deque_raise_capacity(&intern->array, new_capacity);
+		mask = intern->array.mask;
 	}
-	intern->array.offset = (intern->array.offset - 1) & intern->array.mask;
-	intern->array.size++;
+	size_t offset = intern->array.offset;
+	zval *const circular_buffer = intern->array.circular_buffer;
+
+	do {
+		offset = (offset - 1) & mask;
+		zval *dest = &circular_buffer[offset];
+		ZVAL_COPY(dest, args);
+		if (--argc == 0) {
+			break;
+		}
+		args++;
+	} while (1);
+
+	intern->array.offset = offset;
+	intern->array.size = new_size;
+
 	DEBUG_ASSERT_CONSISTENT_DEQUE(&intern->array);
-	zval *dest = &intern->array.circular_buffer[intern->array.offset];
-	ZVAL_COPY(dest, value);
 }
 
 static zend_always_inline void spl_deque_try_shrink_capacity(spl_deque *intern, size_t old_size)

ext/spl/spl_deque.stub.php

@@ -44,10 +44,10 @@ public function __unserialize(array $data): void {}
     /** Construct the Deque from the values of the array, ignoring keys */
     public static function __set_state(array $array): Deque {}
 
-    /** Appends a value to the end of the Deque. */
-    public function push(mixed $value): void {}
-    /** Prepends a value to the start of the Deque. */
-    public function unshift(mixed $value): void {}
+    /** Appends value(s) to the end of the Deque. */
+    public function push(mixed ...$values): void {}
+    /** Prepends value(s) to the start of the Deque. */
+    public function unshift(mixed ...$values): void {}
     /**
      * Pops a value from the end of the Deque.
      * @throws UnderflowException if the Deque is empty

ext/spl/spl_deque_arginfo.h

@@ -1,5 +1,5 @@
 /* This is a generated file, edit the .stub.php file instead.
- * Stub hash: d8d7e5ffff1a572ea16142a05b4db08a9898e5b8 */
+ * Stub hash: 49a35ccd63900ec4e1bcb992357d1d3a211f999e */
 
 ZEND_BEGIN_ARG_INFO_EX(arginfo_class_Deque___construct, 0, 0, 0)
 	ZEND_ARG_TYPE_INFO_WITH_DEFAULT_VALUE(0, iterator, IS_ITERABLE, 0, "[]")
@@ -28,8 +28,8 @@ ZEND_BEGIN_ARG_WITH_RETURN_OBJ_INFO_EX(arginfo_class_Deque___set_state, 0, 1, De
 	ZEND_ARG_TYPE_INFO(0, array, IS_ARRAY, 0)
 ZEND_END_ARG_INFO()
 
-ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_class_Deque_push, 0, 1, IS_VOID, 0)
-	ZEND_ARG_TYPE_INFO(0, value, IS_MIXED, 0)
+ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_class_Deque_push, 0, 0, IS_VOID, 0)
+	ZEND_ARG_VARIADIC_TYPE_INFO(0, values, IS_MIXED, 0)
 ZEND_END_ARG_INFO()
 
 #define arginfo_class_Deque_unshift arginfo_class_Deque_push

ext/spl/tests/Deque/push_multiple.phpt

@@ -0,0 +1,18 @@
+--TEST--
+Deque constructed from array
+--FILE--
+<?php
+// discards keys
+$it = new Deque();
+// no-op to support any length of variadic arguments
+$it->push();
+printf("it=%s count=%d\n", json_encode($it), $it->count());
+$it->push(...range(0, 19));
+printf("it=%s count=%d\n", json_encode($it), $it->count());
+$it->unshift(...range(0, 19));
+printf("it=%s count=%d\n", json_encode($it), $it->count());
+?>
+--EXPECT--
+it=[] count=0
+it=[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19] count=20
+it=[19,18,17,16,15,14,13,12,11,10,9,8,7,6,5,4,3,2,1,0,0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19] count=40