Add mutating keyword

Author: iluuu1994

Zend/tests/data_classes/mutating_call_verification.phpt

@@ -0,0 +1,38 @@
+--TEST--
+Mutating method calls on data classes
+--FILE--
+<?php
+
+data class D {
+    public function nonMutating() {
+        echo __FUNCTION__, "\n";
+    }
+
+    public mutating function mutating() {
+        echo __FUNCTION__, "\n";
+    }
+}
+
+$d = new D();
+
+$d->nonMutating();
+$d->mutating!();
+
+try {
+    $d->nonMutating!();
+} catch (Error $e) {
+    echo $e->getMessage(), "\n";
+}
+
+try {
+    $d->mutating();
+} catch (Error $e) {
+    echo $e->getMessage(), "\n";
+}
+
+?>
+--EXPECT--
+nonMutating
+mutating
+Non-mutating method must not be called with $object->func!() syntax
+Mutating method must be called with $object->func!() syntax

Zend/tests/data_classes/mutating_methods.phpt

@@ -9,7 +9,7 @@ data class Point {
         public int $y,
     ) {}
 
-    public /* mutating */ function zero() {
+    public mutating function zero() {
         $this->x = 0;
         $this->y = 0;
     }

Zend/tests/data_classes/nested_references.phpt

@@ -9,7 +9,7 @@ data class Point {
         public int $y,
     ) {}
 
-    public /* mutating */ function zero() {
+    public mutating function zero() {
         $this->x = 0;
         $this->y = 0;
     }

Zend/tests/data_classes/references.phpt

@@ -9,7 +9,7 @@ data class Point {
         public int $y,
     ) {}
 
-    public /* mutating */ function zero() {
+    public mutating function zero() {
         $this->x = 0;
         $this->y = 0;
     }

Zend/zend_compile.c

@@ -844,6 +844,8 @@ static char *zend_modifier_token_to_string(uint32_t token)
 			return "readonly";
 		case T_ABSTRACT:
 			return "abstract";
+		case T_MUTATING:
+			return "mutating";
 		EMPTY_SWITCH_DEFAULT_CASE()
 	}
 }
@@ -877,6 +879,11 @@ uint32_t zend_modifier_token_to_flag(zend_modifier_target target, uint32_t token
 				return ZEND_ACC_STATIC;
 			}
 			break;
+		case T_MUTATING:
+			if (target == ZEND_MODIFIER_TARGET_METHOD) {
+				return ZEND_ACC_MUTATING;
+			}
+			break;
 	}
 
 	char *member;

Zend/zend_compile.h

@@ -318,7 +318,7 @@ typedef struct _zend_oparray_context {
 /* Data classes are value types                           |     |     |     */
 #define ZEND_ACC_DATA_CLASS              (1 << 30) /*  X  |     |     |     */
 /*                                                        |     |     |     */
-/* Function Flags (unused: 29-30)                         |     |     |     */
+/* Function Flags (unused: 30)                            |     |     |     */
 /* ==============                                         |     |     |     */
 /*                                                        |     |     |     */
 /* deprecation flag                                       |     |     |     */
@@ -380,6 +380,9 @@ typedef struct _zend_oparray_context {
 /* has #[\Override] attribute                             |     |     |     */
 #define ZEND_ACC_OVERRIDE                (1 << 28) /*     |  X  |     |     */
 /*                                                        |     |     |     */
+/* Mutating function of a data class                      |     |     |     */
+#define ZEND_ACC_MUTATING                (1 << 29) /*     |  X  |     |     */
+/*                                                        |     |     |     */
 /* op_array uses strict mode types                        |     |     |     */
 #define ZEND_ACC_STRICT_TYPES            (1U << 31) /*    |  X  |     |     */
 

Zend/zend_language_parser.y

@@ -151,6 +151,7 @@ static YYSIZE_T zend_yytnamerr(char*, const char*);
 %token <ident> T_STATIC        "'static'"
 %token <ident> T_ABSTRACT      "'abstract'"
 %token <ident> T_FINAL         "'final'"
+%token <ident> T_MUTATING      "'mutating'"
 %token <ident> T_PRIVATE       "'private'"
 %token <ident> T_PROTECTED     "'protected'"
 %token <ident> T_PUBLIC        "'public'"
@@ -308,7 +309,7 @@ reserved_non_modifiers:
 
 semi_reserved:
 	  reserved_non_modifiers
-	| T_STATIC | T_ABSTRACT | T_FINAL | T_PRIVATE | T_PROTECTED | T_PUBLIC | T_READONLY
+	| T_STATIC | T_ABSTRACT | T_FINAL | T_PRIVATE | T_PROTECTED | T_PUBLIC | T_READONLY | T_MUTATING
 ;
 
 ampersand:
@@ -1067,6 +1068,7 @@ member_modifier:
 	|	T_ABSTRACT				{ $$ = T_ABSTRACT; }
 	|	T_FINAL					{ $$ = T_FINAL; }
 	|	T_READONLY				{ $$ = T_READONLY; }
+	|	T_MUTATING				{ $$ = T_MUTATING; }
 ;
 
 property_list:

Zend/zend_language_scanner.l

@@ -1729,6 +1729,10 @@ OPTIONAL_WHITESPACE_OR_COMMENTS ({WHITESPACE}|{MULTI_LINE_COMMENT}|{SINGLE_LINE_
 	RETURN_TOKEN_WITH_IDENT(T_FINAL);
 }
 
+<ST_IN_SCRIPTING>"mutating" {
+	RETURN_TOKEN_WITH_IDENT(T_MUTATING);
+}
+
 <ST_IN_SCRIPTING>"private" {
 	RETURN_TOKEN_WITH_IDENT(T_PRIVATE);
 }

Zend/zend_vm_def.h

@@ -3607,6 +3607,21 @@ ZEND_VM_HOT_OBJ_HANDLER(112, ZEND_INIT_METHOD_CALL, CONST|TMPVAR|UNUSED|THIS|CV,
 			}
 			HANDLE_EXCEPTION();
 		}
+		if (UNEXPECTED(
+			((fbc->common.fn_flags & ZEND_ACC_MUTATING) != 0)
+			!= ((opline->extended_value & ZEND_INIT_METHOD_CALL_MUTATING) != 0)
+		)) {
+			if (fbc->common.fn_flags & ZEND_ACC_MUTATING) {
+				zend_throw_error(NULL, "Mutating method must be called with $object->func!() syntax");
+			} else {
+				zend_throw_error(NULL, "Non-mutating method must not be called with $object->func!() syntax");
+			}
+			FREE_OP2();
+			if ((OP1_TYPE & (IS_VAR|IS_TMP_VAR)) && !needs_addref && GC_DELREF(orig_obj) == 0) {
+				zend_objects_store_del(orig_obj);
+			}
+			HANDLE_EXCEPTION();
+		}
 		if (OP2_TYPE == IS_CONST &&
 		    EXPECTED(!(fbc->common.fn_flags & (ZEND_ACC_CALL_VIA_TRAMPOLINE|ZEND_ACC_NEVER_CACHE))) &&
 		    EXPECTED(obj == orig_obj)) {