Add support for property initialization during cloning

Author: kocsismate

Zend/tests/clone_initializer/clone_initializer_error1.phpt

@@ -0,0 +1,16 @@
+--TEST--
+Test that the property initializer list is required when "with" is given
+--FILE--
+<?php
+
+class Foo
+{
+    public function withProperties()
+    {
+        return clone $this with;
+    }
+}
+
+?>
+--EXPECTF--
+Parse error: syntax error, unexpected token ";", expecting "{" in %s on line %d

Zend/tests/clone_initializer/clone_initializer_error2.phpt

@@ -0,0 +1,16 @@
+--TEST--
+Test that the property initializer list cannot contain integer keys
+--FILE--
+<?php
+
+class Foo
+{
+    public function withProperties()
+    {
+        return clone $this with {1: "value"};
+    }
+}
+
+?>
+--EXPECTF--
+Parse error: syntax error, unexpected integer "1" in %s on line %d

Zend/tests/clone_initializer/clone_initializer_error3.phpt

@@ -0,0 +1,18 @@
+--TEST--
+Test that the property initializer list can only contain literals
+--FILE--
+<?php
+
+class Foo
+{
+    public function withProperties()
+    {
+        $property = "string";
+
+        return clone $this with {$property: "value"};
+    }
+}
+
+?>
+--EXPECTF--
+Parse error: syntax error, unexpected variable "$property" in %s on line %d

Zend/tests/clone_initializer/clone_initializer_success1.phpt

@@ -0,0 +1,38 @@
+--TEST--
+Test that declared properties can be initialized during cloning
+--FILE--
+<?php
+
+class Foo
+{
+    public int $property1;
+    public string $property2;
+
+    public function withProperties()
+    {
+        return clone $this with {
+            property1: 1,
+            property2: "foo",
+        };
+    }
+}
+
+$foo = new Foo();
+var_dump($foo);
+$bar = $foo->withProperties();
+var_dump($bar);
+
+?>
+--EXPECT--
+object(Foo)#1 (0) {
+  ["property1"]=>
+  uninitialized(int)
+  ["property2"]=>
+  uninitialized(string)
+}
+object(Foo)#2 (2) {
+  ["property1"]=>
+  int(1)
+  ["property2"]=>
+  string(3) "foo"
+}

Zend/tests/clone_initializer/clone_initializer_success2.phpt

@@ -0,0 +1,31 @@
+--TEST--
+Test that dynamic properties can be initialized during cloning
+--FILE--
+<?php
+
+class Foo
+{
+    public function withProperties()
+    {
+        return clone $this with {
+            property1: 1,
+            property2: "foo",
+        };
+    }
+}
+
+$foo = new Foo();
+var_dump($foo);
+$bar = $foo->withProperties();
+var_dump($bar);
+
+?>
+--EXPECT--
+object(Foo)#1 (0) {
+}
+object(Foo)#2 (2) {
+  ["property1"]=>
+  int(1)
+  ["property2"]=>
+  string(3) "foo"
+}

Zend/tests/clone_initializer/clone_initializer_success3.phpt

@@ -0,0 +1,24 @@
+--TEST--
+Test that the property initializer list can be empty
+--FILE--
+<?php
+
+class Foo
+{
+    public function withProperties()
+    {
+        return clone $this with {};
+    }
+}
+
+$foo = new Foo();
+var_dump($foo);
+$bar = $foo->withProperties();
+var_dump($bar);
+
+?>
+--EXPECT--
+object(Foo)#1 (0) {
+}
+object(Foo)#2 (0) {
+}

Zend/zend_ast.c

@@ -1602,6 +1602,11 @@ static ZEND_COLD void zend_ast_export_ex(smart_str *str, zend_ast *ast, int prio
 		case ZEND_AST_MATCH_ARM_LIST:
 			zend_ast_export_list(str, (zend_ast_list*)ast, 0, 0, indent);
 			break;
+		case ZEND_AST_PROPERTY_INITIALIZER_LIST:
+			smart_str_appends(str, " {");
+			zend_ast_export_list(str, (zend_ast_list*)ast, 0, 0, indent);
+			smart_str_appends(str, " }");
+			break;
 		case ZEND_AST_CLOSURE_USES:
 			smart_str_appends(str, " use(");
 			zend_ast_export_var_list(str, (zend_ast_list*)ast, indent);
@@ -2079,6 +2084,12 @@ static ZEND_COLD void zend_ast_export_ex(smart_str *str, zend_ast *ast, int prio
 			ast = ast->child[1];
 			goto tail_call;
 
+		case ZEND_AST_INITIALIZER_EXPR:
+			smart_str_append(str, zend_ast_get_str(ast->child[0]));
+			smart_str_appends(str, "= ");
+			ast = ast->child[1];
+			goto tail_call;
+
 		/* 3 child nodes */
 		case ZEND_AST_METHOD_CALL:
 		case ZEND_AST_NULLSAFE_METHOD_CALL:

Zend/zend_ast.h

@@ -65,6 +65,7 @@ enum _zend_ast_kind {
 	ZEND_AST_ATTRIBUTE_LIST,
 	ZEND_AST_ATTRIBUTE_GROUP,
 	ZEND_AST_MATCH_ARM_LIST,
+	ZEND_AST_PROPERTY_INITIALIZER_LIST,
 
 	/* 0 child nodes */
 	ZEND_AST_MAGIC_CONST = 0 << ZEND_AST_NUM_CHILDREN_SHIFT,
@@ -82,7 +83,6 @@ enum _zend_ast_kind {
 	ZEND_AST_ISSET,
 	ZEND_AST_SILENCE,
 	ZEND_AST_SHELL_EXEC,
-	ZEND_AST_CLONE,
 	ZEND_AST_EXIT,
 	ZEND_AST_PRINT,
 	ZEND_AST_INCLUDE_OR_EVAL,
@@ -113,6 +113,7 @@ enum _zend_ast_kind {
 	ZEND_AST_STATIC_PROP,
 	ZEND_AST_CALL,
 	ZEND_AST_CLASS_CONST,
+	ZEND_AST_CLONE,
 	ZEND_AST_ASSIGN,
 	ZEND_AST_ASSIGN_REF,
 	ZEND_AST_ASSIGN_OP,
@@ -147,6 +148,7 @@ enum _zend_ast_kind {
 	ZEND_AST_MATCH,
 	ZEND_AST_MATCH_ARM,
 	ZEND_AST_NAMED_ARG,
+	ZEND_AST_INITIALIZER_EXPR,
 
 	/* 3 child nodes */
 	ZEND_AST_METHOD_CALL = 3 << ZEND_AST_NUM_CHILDREN_SHIFT,

Zend/zend_compile.c

@@ -734,6 +734,7 @@ void zend_do_free(znode *op1) /* {{{ */
 				case ZEND_ASSIGN_DIM_OP:
 				case ZEND_ASSIGN_OBJ_OP:
 				case ZEND_ASSIGN_STATIC_PROP_OP:
+				case ZEND_INIT_OBJ:
 				case ZEND_PRE_INC_STATIC_PROP:
 				case ZEND_PRE_DEC_STATIC_PROP:
 				case ZEND_PRE_INC_OBJ:
@@ -4538,11 +4539,40 @@ void zend_compile_new(znode *result, zend_ast *ast) /* {{{ */
 void zend_compile_clone(znode *result, zend_ast *ast) /* {{{ */
 {
 	zend_ast *obj_ast = ast->child[0];
+	zend_ast *initializer_ast = ast->child[1];
 
 	znode obj_node;
 	zend_compile_expr(&obj_node, obj_ast);
+	zend_op *opline = zend_emit_op(result, ZEND_CLONE, &obj_node, NULL);
 
-	zend_emit_op_tmp(result, ZEND_CLONE, &obj_node, NULL);
+	if (initializer_ast) {
+		zend_ast_list *list = zend_ast_get_list(initializer_ast);
+		uint32_t i;
+
+		for (i = 0; i < list->children; i++) {
+			zend_ast *property_init_expr_ast = list->child[i];
+			ZEND_ASSERT(property_init_expr_ast->kind == ZEND_AST_INITIALIZER_EXPR);
+			zend_string *property_name = zval_make_interned_string(zend_ast_get_zval(property_init_expr_ast->child[0]));
+
+			zend_ast *property_value_ast = property_init_expr_ast->child[1];
+			znode property_value_node;
+			zend_compile_expr(&property_value_node, property_value_ast);
+
+			znode property_object_node;
+			property_object_node.op_type = IS_VAR;
+			GET_NODE(&property_object_node, opline->result);
+
+			znode property_name_node;
+			property_name_node.op_type = IS_CONST;
+			ZVAL_STR_COPY(&property_name_node.u.constant, property_name);
+			opline = zend_emit_op(result, ZEND_INIT_OBJ, &property_object_node, &property_name_node);
+			opline->result.var  = get_temporary_variable();
+			opline->extended_value = zend_alloc_cache_slots(3);
+
+			zend_emit_op_data(&property_value_node);
+			GET_NODE(result, opline->result);
+		}
+	}
 }
 /* }}} */
 

Zend/zend_language_parser.y

@@ -80,6 +80,7 @@ static YYSIZE_T zend_yytnamerr(char*, const char*);
 %precedence '~' T_INT_CAST T_DOUBLE_CAST T_STRING_CAST T_ARRAY_CAST T_OBJECT_CAST T_BOOL_CAST T_UNSET_CAST '@'
 %right T_POW
 %precedence T_CLONE
+%precedence T_WITH
 
 /* Resolve danging else conflict */
 %precedence T_NOELSE
@@ -113,6 +114,7 @@ static YYSIZE_T zend_yytnamerr(char*, const char*);
 %token <ident> T_INSTANCEOF    "'instanceof'"
 %token <ident> T_NEW           "'new'"
 %token <ident> T_CLONE         "'clone'"
+%token <ident> T_WITH          "'with'"
 %token <ident> T_EXIT          "'exit'"
 %token <ident> T_IF            "'if'"
 %token <ident> T_ELSEIF        "'elseif'"
@@ -268,6 +270,7 @@ static YYSIZE_T zend_yytnamerr(char*, const char*);
 %type <ast> attributed_statement attributed_class_statement attributed_parameter
 %type <ast> attribute_decl attribute attributes attribute_group namespace_declaration_name
 %type <ast> match match_arm_list non_empty_match_arm_list match_arm match_arm_cond_list
+%type <ast> clone property_initializer_list non_empty_property_initializer_list property_initializer_expr
 
 %type <num> returns_ref function fn is_reference is_variadic variable_modifiers
 %type <num> method_modifiers non_empty_member_modifiers member_modifier optional_visibility_modifier
@@ -286,7 +289,7 @@ start:
 
 reserved_non_modifiers:
 	  T_INCLUDE | T_INCLUDE_ONCE | T_EVAL | T_REQUIRE | T_REQUIRE_ONCE | T_LOGICAL_OR | T_LOGICAL_XOR | T_LOGICAL_AND
-	| T_INSTANCEOF | T_NEW | T_CLONE | T_EXIT | T_IF | T_ELSEIF | T_ELSE | T_ENDIF | T_ECHO | T_DO | T_WHILE | T_ENDWHILE
+	| T_INSTANCEOF | T_NEW | T_CLONE | T_WITH | T_EXIT | T_IF | T_ELSEIF | T_ELSE | T_ENDIF | T_ECHO | T_DO | T_WHILE | T_ENDWHILE
 	| T_FOR | T_ENDFOR | T_FOREACH | T_ENDFOREACH | T_DECLARE | T_ENDDECLARE | T_AS | T_TRY | T_CATCH | T_FINALLY
 	| T_THROW | T_USE | T_INSTEADOF | T_GLOBAL | T_VAR | T_UNSET | T_ISSET | T_EMPTY | T_CONTINUE | T_GOTO
 	| T_FUNCTION | T_CONST | T_RETURN | T_PRINT | T_YIELD | T_LIST | T_SWITCH | T_ENDSWITCH | T_CASE | T_DEFAULT | T_BREAK
@@ -1024,7 +1027,7 @@ expr:
 			{ $$ = zend_ast_create(ZEND_AST_ASSIGN, $1, $3); }
 	|	variable '=' '&' variable
 			{ $$ = zend_ast_create(ZEND_AST_ASSIGN_REF, $1, $4); }
-	|	T_CLONE expr { $$ = zend_ast_create(ZEND_AST_CLONE, $2); }
+	|	clone { $$ = $1; }
 	|	variable T_PLUS_EQUAL expr
 			{ $$ = zend_ast_create_assign_op(ZEND_ADD, $1, $3); }
 	|	variable T_MINUS_EQUAL expr
@@ -1471,6 +1474,24 @@ isset_variable:
 		expr { $$ = zend_ast_create(ZEND_AST_ISSET, $1); }
 ;
 
+clone:
+		T_CLONE expr { $$ = zend_ast_create(ZEND_AST_CLONE, $2, NULL); }
+	|	T_CLONE expr T_WITH property_initializer_list { $$ = zend_ast_create(ZEND_AST_CLONE, $2, $4); }
+
+property_initializer_list:
+		'{' '}'	{ $$ = zend_ast_create_list(0, ZEND_AST_PROPERTY_INITIALIZER_LIST); }
+	|	'{' non_empty_property_initializer_list possible_comma '}' { $$ = $2; }
+;
+
+non_empty_property_initializer_list:
+		property_initializer_expr { $$ = zend_ast_create_list(1, ZEND_AST_PROPERTY_INITIALIZER_LIST, $1); }
+	|	non_empty_property_initializer_list ',' property_initializer_expr { $$ = zend_ast_list_add($1, $3); }
+;
+
+property_initializer_expr:
+		identifier ':' expr { $$ = zend_ast_create(ZEND_AST_INITIALIZER_EXPR, $1, $3); }
+;
+
 %%
 
 /* Over-ride Bison formatting routine to give better token descriptions.

Zend/zend_language_scanner.l

@@ -1604,6 +1604,10 @@ NEWLINE ("\r"|"\n"|"\r\n")
 	RETURN_TOKEN_WITH_IDENT(T_CLONE);
 }
 
+<ST_IN_SCRIPTING>"with" {
+	RETURN_TOKEN_WITH_IDENT(T_WITH);
+}
+
 <ST_IN_SCRIPTING>"var" {
 	RETURN_TOKEN_WITH_IDENT(T_VAR);
 }