ext/spl: Remove spl_engine.h header

This doesn't really make the calling code clearer and it is barely used on top of that.

Author: Girgias

UPGRADING.INTERNALS

@@ -263,6 +263,18 @@ 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);
+     or use the new object_init_with_constructor() API
+
 ========================
 4. OpCode changes
 ========================

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"

ext/phar/phar_object.c

@@ -3540,9 +3540,7 @@ PHP_METHOD(Phar, offsetGet)
 {
 	char *fname, *error;
 	size_t fname_len;
-	zval zfname;
 	phar_entry_info *entry;
-	zend_string *sfname;
 
 	if (zend_parse_parameters(ZEND_NUM_ARGS(), "p", &fname, &fname_len) == FAILURE) {
 		RETURN_THROWS();
@@ -3574,10 +3572,16 @@ PHP_METHOD(Phar, offsetGet)
 			efree(entry);
 		}
 
-		sfname = strpprintf(0, "phar://%s/%s", phar_obj->archive->fname, fname);
+		zend_string *sfname = strpprintf(0, "phar://%s/%s", phar_obj->archive->fname, fname);
+		zval zfname;
 		ZVAL_NEW_STR(&zfname, sfname);
-		spl_instantiate_arg_ex1(phar_obj->spl.info_class, return_value, &zfname);
+
+		/* Instantiate object and call constructor */
+		zend_result is_initialized = object_init_with_constructor(return_value, phar_obj->spl.info_class, 1, &zfname, NULL);
 		zval_ptr_dtor(&zfname);
+		if (is_initialized == FAILURE) {
+			RETURN_THROWS();
+		}
 	}
 }
 /* }}} */

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)

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");

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"

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"
@@ -1517,7 +1516,6 @@ PHP_METHOD(RecursiveDirectoryIterator, hasChildren)
 /* {{{ Returns an iterator for the current entry if it is a directory */
 PHP_METHOD(RecursiveDirectoryIterator, getChildren)
 {
-	zval zpath, zflags;
 	spl_filesystem_object *intern = spl_filesystem_from_obj(Z_OBJ_P(ZEND_THIS));
 	spl_filesystem_object *subdir;
 	char slash = SPL_HAS_FLAG(intern->flags, SPL_FILE_DIR_UNIXPATHS) ? '/' : DEFAULT_SLASH;
@@ -1530,10 +1528,16 @@ PHP_METHOD(RecursiveDirectoryIterator, getChildren)
 		RETURN_THROWS();
 	}
 
-	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);
-	zval_ptr_dtor(&zpath);
+	zval params[2];
+	ZVAL_STR_COPY(&params[0], intern->file_name);
+	ZVAL_LONG(&params[1], intern->flags);
+	/* Instantiate object and call constructor */
+	zend_result is_initialized = object_init_with_constructor(return_value, Z_OBJCE_P(ZEND_THIS), 2, params, NULL);
+	zval_ptr_dtor(&params[0]);
+	zval_ptr_dtor(&params[1]);
+	if (is_initialized == FAILURE) {
+		RETURN_THROWS();
+	}
 
 	subdir = spl_filesystem_from_obj(Z_OBJ_P(return_value));
 	if (subdir) {

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"

ext/spl/spl_engine.h

@@ -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;