ext/spl: Remove spl_engine.h header

Girgias · Girgias · commit e643ee820e89 · 2024-06-01T19:37:29.000+01:00
This doesn't really make the calling code clearer and it is barely used on top of that.
diff --git a/UPGRADING.INTERNALS b/UPGRADING.INTERNALS
@@ -261,6 +261,17 @@ PHP 8.4 INTERNALS UPGRADE NOTES
    - The ext/session/php_session.h doesn't transitively include the
      ext/hash/php_hash.h header anymore.
 
+ i. ext/spl
+   - The spl_engine.h header has been removed, this includes the following 3
+     functions it was defining:
+     - spl_instantiate_arg_ex1
+     - spl_instantiate_arg_ex2
+     - spl_instantiate_arg_n
+     Instead manually instantiate the object with object_init_ex() and call
+     the constructor via one of the zend_call_known_instance_method*()
+     API. E.g. zend_call_known_instance_method_with_1_params(
+        ce->constructor, Z_OBJ_P(return_value), NULL, &arg1);
+
 ========================
 4. OpCode changes
 ========================
diff --git a/ext/phar/phar_internal.h b/ext/phar/phar_internal.h
@@ -52,7 +52,6 @@
 #include "Zend/zend_virtual_cwd.h"
 #include "ext/spl/spl_array.h"
 #include "ext/spl/spl_directory.h"
-#include "ext/spl/spl_engine.h"
 #include "ext/spl/spl_exceptions.h"
 #include "ext/spl/spl_iterators.h"
 #include "php_phar.h"
diff --git a/ext/phar/phar_object.c b/ext/phar/phar_object.c
@@ -3576,7 +3576,10 @@ PHP_METHOD(Phar, offsetGet)
 
 		sfname = strpprintf(0, "phar://%s/%s", phar_obj->archive->fname, fname);
 		ZVAL_NEW_STR(&zfname, sfname);
-		spl_instantiate_arg_ex1(phar_obj->spl.info_class, return_value, &zfname);
+
+		/* Instantiate object and call constructor */
+		object_init_ex(return_value, phar_obj->spl.info_class);
+		zend_call_known_instance_method_with_1_params(phar_obj->spl.info_class->constructor, Z_OBJ_P(return_value), NULL, &zfname);
 		zval_ptr_dtor(&zfname);
 	}
 }
diff --git a/ext/spl/config.m4 b/ext/spl/config.m4
@@ -1,5 +1,5 @@
 PHP_NEW_EXTENSION(spl, php_spl.c spl_functions.c spl_iterators.c spl_array.c spl_directory.c spl_exceptions.c spl_observer.c spl_dllist.c spl_heap.c spl_fixedarray.c, no,, -DZEND_ENABLE_STATIC_TSRMLS_CACHE=1)
-PHP_INSTALL_HEADERS([ext/spl], [php_spl.h spl_array.h spl_directory.h spl_engine.h spl_exceptions.h spl_functions.h spl_iterators.h spl_observer.h spl_dllist.h spl_heap.h spl_fixedarray.h])
+PHP_INSTALL_HEADERS([ext/spl], [php_spl.h spl_array.h spl_directory.h spl_exceptions.h spl_functions.h spl_iterators.h spl_observer.h spl_dllist.h spl_heap.h spl_fixedarray.h])
 PHP_ADD_EXTENSION_DEP(spl, pcre, true)
 PHP_ADD_EXTENSION_DEP(spl, standard, true)
 PHP_ADD_EXTENSION_DEP(spl, json)
diff --git a/ext/spl/config.w32 b/ext/spl/config.w32
@@ -2,4 +2,4 @@
 
 EXTENSION("spl", "php_spl.c spl_functions.c spl_iterators.c spl_array.c spl_directory.c spl_exceptions.c spl_observer.c spl_dllist.c spl_heap.c spl_fixedarray.c", false /*never shared */, "/DZEND_ENABLE_STATIC_TSRMLS_CACHE=1");
 PHP_SPL="yes";
-PHP_INSTALL_HEADERS("ext/spl", "php_spl.h spl_array.h spl_directory.h spl_engine.h spl_exceptions.h spl_functions.h spl_iterators.h spl_observer.h spl_dllist.h spl_heap.h spl_fixedarray.h");
+PHP_INSTALL_HEADERS("ext/spl", "php_spl.h spl_array.h spl_directory.h spl_exceptions.h spl_functions.h spl_iterators.h spl_observer.h spl_dllist.h spl_heap.h spl_fixedarray.h");
diff --git a/ext/spl/php_spl.c b/ext/spl/php_spl.c
@@ -25,7 +25,6 @@
 #include "php_spl.h"
 #include "php_spl_arginfo.h"
 #include "spl_functions.h"
-#include "spl_engine.h"
 #include "spl_array.h"
 #include "spl_directory.h"
 #include "spl_iterators.h"
diff --git a/ext/spl/spl_directory.c b/ext/spl/spl_directory.c
@@ -30,7 +30,6 @@
 
 #include "php_spl.h"
 #include "spl_functions.h"
-#include "spl_engine.h"
 #include "spl_iterators.h"
 #include "spl_directory.h"
 #include "spl_directory_arginfo.h"
@@ -1532,7 +1531,9 @@ PHP_METHOD(RecursiveDirectoryIterator, getChildren)
 
 	ZVAL_LONG(&zflags, intern->flags);
 	ZVAL_STR_COPY(&zpath, intern->file_name);
-	spl_instantiate_arg_ex2(Z_OBJCE_P(ZEND_THIS), return_value, &zpath, &zflags);
+	/* Instantiate object and call constructor */
+	object_init_ex(return_value, Z_OBJCE_P(ZEND_THIS));
+	zend_call_known_instance_method_with_2_params(Z_OBJCE_P(ZEND_THIS)->constructor, Z_OBJ_P(return_value), NULL, &zpath, &zflags);
 	zval_ptr_dtor(&zpath);
 
 	subdir = spl_filesystem_from_obj(Z_OBJ_P(return_value));
diff --git a/ext/spl/spl_dllist.c b/ext/spl/spl_dllist.c
@@ -19,6 +19,7 @@
 #endif
 
 #include "php.h"
+#include "zend_interfaces.h"
 #include "zend_exceptions.h"
 #include "zend_hash.h"
 
@@ -27,7 +28,6 @@
 #include "ext/standard/php_var.h"
 #include "zend_smart_str.h"
 #include "spl_functions.h"
-#include "spl_engine.h"
 #include "spl_iterators.h"
 #include "spl_dllist.h"
 #include "spl_dllist_arginfo.h"
diff --git a/ext/spl/spl_engine.h b/ext/spl/spl_engine.h
diff --git a/ext/spl/spl_exceptions.c b/ext/spl/spl_exceptions.c
@@ -27,7 +27,6 @@
 
 #include "php_spl.h"
 #include "spl_functions.h"
-#include "spl_engine.h"
 #include "spl_exceptions.h"
 
 PHPAPI zend_class_entry *spl_ce_LogicException;
diff --git a/ext/spl/spl_fixedarray.c b/ext/spl/spl_fixedarray.c
@@ -22,12 +22,12 @@
 #include "php.h"
 #include "php_ini.h"
 #include "ext/standard/info.h"
+#include "zend_interfaces.h"
 #include "zend_exceptions.h"
 
 #include "php_spl.h"
 #include "spl_fixedarray_arginfo.h"
 #include "spl_functions.h"
-#include "spl_engine.h"
 #include "spl_fixedarray.h"
 #include "spl_exceptions.h"
 #include "spl_iterators.h"
diff --git a/ext/spl/spl_heap.c b/ext/spl/spl_heap.c
@@ -19,11 +19,11 @@
 #endif
 
 #include "php.h"
+#include "zend_interfaces.h"
 #include "zend_exceptions.h"
 
 #include "php_spl.h"
 #include "spl_functions.h"
-#include "spl_engine.h"
 #include "spl_iterators.h"
 #include "spl_heap.h"
 #include "spl_heap_arginfo.h"
diff --git a/ext/spl/spl_iterators.c b/ext/spl/spl_iterators.c
@@ -27,7 +27,6 @@
 
 #include "php_spl.h"
 #include "spl_functions.h"
-#include "spl_engine.h"
 #include "spl_iterators.h"
 #include "spl_iterators_arginfo.h"
 #include "spl_directory.h"
@@ -561,7 +560,11 @@ static void spl_recursive_it_it_construct(INTERNAL_FUNCTION_PARAMETERS, zend_cla
 			}
 
 			ZVAL_LONG(&caching_it_flags, user_caching_it_flags);
-			spl_instantiate_arg_ex2(spl_ce_RecursiveCachingIterator, &caching_it, iterator, &caching_it_flags);
+
+			/* Instantiate object and call constructor */
+			object_init_ex(&caching_it, spl_ce_RecursiveCachingIterator);
+			zend_call_known_instance_method_with_2_params(spl_ce_RecursiveCachingIterator->constructor, Z_OBJ(caching_it), NULL, iterator, &caching_it_flags);
+
 			zval_ptr_dtor(&caching_it_flags);
 			zval_ptr_dtor(iterator);
 			iterator = &caching_it;
@@ -1740,19 +1743,21 @@ PHP_METHOD(RecursiveFilterIterator, hasChildren)
 PHP_METHOD(RecursiveFilterIterator, getChildren)
 {
 	spl_dual_it_object   *intern;
-	zval                  retval;
 
 	if (zend_parse_parameters_none() == FAILURE) {
 		RETURN_THROWS();
 	}
 
 	SPL_FETCH_AND_CHECK_DUAL_IT(intern, ZEND_THIS);
 
-	zend_call_method_with_0_params(Z_OBJ(intern->inner.zobject), intern->inner.ce, NULL, "getchildren", &retval);
-	if (!EG(exception) && Z_TYPE(retval) != IS_UNDEF) {
-		spl_instantiate_arg_ex1(Z_OBJCE_P(ZEND_THIS), return_value, &retval);
+	zval childrens;
+	zend_call_method_with_0_params(Z_OBJ(intern->inner.zobject), intern->inner.ce, NULL, "getchildren", &childrens);
+	if (!EG(exception) && Z_TYPE(childrens) != IS_UNDEF) {
+		/* Instantiate object and call constructor */
+		object_init_ex(return_value, Z_OBJCE_P(ZEND_THIS));
+		zend_call_known_instance_method_with_1_params(Z_OBJCE_P(ZEND_THIS)->constructor, Z_OBJ_P(return_value), NULL, &childrens);
 	}
-	zval_ptr_dtor(&retval);
+	zval_ptr_dtor(&childrens);
 } /* }}} */
 
 /* {{{ Return the inner iterator's children contained in a RecursiveCallbackFilterIterator */
@@ -1771,7 +1776,11 @@ PHP_METHOD(RecursiveCallbackFilterIterator, getChildren)
 	if (!EG(exception) && Z_TYPE(retval) != IS_UNDEF) {
 		zval callable;
 		zend_get_callable_zval_from_fcc(&intern->u.callback_filter, &callable);
-		spl_instantiate_arg_ex2(Z_OBJCE_P(ZEND_THIS), return_value, &retval, &callable);
+
+		/* Instantiate object and call constructor */
+		object_init_ex(return_value, Z_OBJCE_P(ZEND_THIS));
+		zend_call_known_instance_method_with_2_params(Z_OBJCE_P(ZEND_THIS)->constructor, Z_OBJ_P(return_value), NULL, &retval, &callable);
+
 		zval_ptr_dtor(&callable);
 	}
 	zval_ptr_dtor(&retval);
@@ -2054,7 +2063,15 @@ PHP_METHOD(RecursiveRegexIterator, getChildren)
 		ZVAL_LONG(&args[3], intern->u.regex.flags);
 		ZVAL_LONG(&args[4], intern->u.regex.preg_flags);
 
-		spl_instantiate_arg_n(Z_OBJCE_P(ZEND_THIS), return_value, 5, args);
+		/* Instantiate object and call constructor */
+		object_init_ex(return_value, Z_OBJCE_P(ZEND_THIS));
+		zend_call_known_instance_method(
+			Z_OBJCE_P(ZEND_THIS)->constructor,
+			Z_OBJ_P(return_value),
+			NULL,
+			5,
+			args
+		);
 
 		zval_ptr_dtor(&args[0]);
 		zval_ptr_dtor(&args[1]);
@@ -2362,7 +2379,15 @@ static inline void spl_caching_it_next(spl_dual_it_object *intern)
 						}
 					} else {
 						ZVAL_LONG(&zflags, intern->u.caching.flags & CIT_PUBLIC);
-						spl_instantiate_arg_ex2(spl_ce_RecursiveCachingIterator, &intern->u.caching.zchildren, &zchildren, &zflags);
+						/* Instantiate object and call constructor */
+						object_init_ex(&intern->u.caching.zchildren, spl_ce_RecursiveCachingIterator);
+						zend_call_known_instance_method_with_2_params(
+							spl_ce_RecursiveCachingIterator->constructor,
+							Z_OBJ(intern->u.caching.zchildren),
+							NULL,
+							&zchildren,
+							&zflags
+						);
 						zval_ptr_dtor(&zchildren);
 					}
 				}
diff --git a/ext/spl/spl_observer.c b/ext/spl/spl_observer.c
@@ -30,7 +30,6 @@
 
 #include "php_spl.h"
 #include "spl_functions.h"
-#include "spl_engine.h"
 #include "spl_observer.h"
 #include "spl_observer_arginfo.h"
 #include "spl_iterators.h"

Original file line number	Diff line number	Diff line change
`@@ -3576,7 +3576,10 @@ PHP_METHOD(Phar, offsetGet)`
`3576`	`3576`
`3577`	`3577`	`sfname = strpprintf(0, "phar://%s/%s", phar_obj->archive->fname, fname);`
`3578`	`3578`	`ZVAL_NEW_STR(&zfname, sfname);`
`3579`		`- spl_instantiate_arg_ex1(phar_obj->spl.info_class, return_value, &zfname);`
	`3579`	`+`
	`3580`	`+ /* Instantiate object and call constructor */`
	`3581`	`+ object_init_ex(return_value, phar_obj->spl.info_class);`
	`3582`	`+ zend_call_known_instance_method_with_1_params(phar_obj->spl.info_class->constructor, Z_OBJ_P(return_value), NULL, &zfname);`
`3580`	`3583`	`zval_ptr_dtor(&zfname);`
`3581`	`3584`	`}`
`3582`	`3585`	`}`