Add clone() function

Author: TimWolla

Zend/zend_builtin_functions.c

@@ -69,6 +69,84 @@ zend_result zend_startup_builtin_functions(void) /* {{{ */
 }
 /* }}} */
 
+ZEND_FUNCTION(clone)
+{
+	zend_object *zobj;
+	zval *args;
+	uint32_t argc;
+	HashTable *named_params;
+
+	ZEND_PARSE_PARAMETERS_START(1, -1)
+		Z_PARAM_OBJ(zobj)
+		Z_PARAM_VARIADIC_WITH_NAMED(args, argc, named_params);
+	ZEND_PARSE_PARAMETERS_END();
+
+	zend_class_entry *scope = zend_get_executed_scope();
+
+	zend_class_entry *ce = zobj->ce;
+	zend_function *clone = ce->clone;
+
+	if (UNEXPECTED(zobj->handlers->clone_obj == NULL)) {
+		zend_throw_error(NULL, "Trying to clone an uncloneable object of class %s", ZSTR_VAL(ce->name));
+		RETURN_THROWS();
+	}
+
+	if (clone && !(clone->common.fn_flags & ZEND_ACC_PUBLIC)) {
+		if (clone->common.scope != scope) {
+			if (UNEXPECTED(clone->common.fn_flags & ZEND_ACC_PRIVATE)
+			 || UNEXPECTED(!zend_check_protected(zend_get_function_root_class(clone), scope))) {
+				zend_throw_error(NULL, "Call to %s %s::__clone() from %s%s",
+					zend_visibility_string(clone->common.fn_flags), ZSTR_VAL(clone->common.scope->name),
+					scope ? "scope " : "global scope",
+					scope ? ZSTR_VAL(scope->name) : ""
+				);
+				RETURN_THROWS();
+			}
+		}
+	}
+
+	zend_object *cloned;
+	if (zobj->handlers->clone_obj_with) {
+		HashTable *params = named_params;
+		if (UNEXPECTED(argc > 0)) {
+			HashTable params;
+			zend_hash_init(&params, argc + (named_params ? zend_hash_num_elements(named_params) : 0), NULL, ZVAL_PTR_DTOR, false);
+			for (uint32_t i = 0; i < argc; i++) {
+				zend_string *key = zend_long_to_str(i);
+				zend_hash_update(&params, key, &args[i]);
+				zend_string_release(key);
+			}
+			if (named_params != NULL) {
+				zend_string *key;
+				zval *val;
+				ZEND_HASH_FOREACH_STR_KEY_VAL(named_params, key, val) {
+					zend_hash_update(&params, key, val);
+				} ZEND_HASH_FOREACH_END();
+			}
+			cloned = zobj->handlers->clone_obj_with(zobj, scope, &params);
+			zend_hash_destroy(&params);
+		} else {
+			cloned = zobj->handlers->clone_obj_with(zobj, scope, params);
+		}
+	} else {
+		if (UNEXPECTED(named_params || argc > 0)) {
+			zend_throw_error(NULL, "Trying to clone an object with updated properties that is not compatible %s", ZSTR_VAL(ce->name));
+			RETURN_THROWS();
+		}
+		cloned = zobj->handlers->clone_obj(zobj);
+	}
+	
+	if (EG(exception)) {
+		if (cloned) {
+			OBJ_RELEASE(cloned);
+		}
+
+		RETURN_THROWS();
+	}
+
+	RETURN_OBJ(cloned);
+}
+
 ZEND_FUNCTION(exit)
 {
 	zend_string *str = NULL;

Zend/zend_builtin_functions.stub.php

@@ -7,6 +7,8 @@ class stdClass
 {
 }
 
+function _clone(object $object, mixed ...$updatedProperties): object {}
+
 function exit(string|int $status = 0): never {}
 
 /** @alias exit */

Zend/zend_builtin_functions_arginfo.h

@@ -983,6 +983,9 @@ class FunctionName implements FunctionOrMethodName {
     private /* readonly */ Name $name;
 
     public function __construct(Name $name) {
+        if ($name->name === '_clone') {
+            $name = new Name('clone', $name->getAttributes());
+        }
         $this->name = $name;
     }