Support match expression v2 rfc (nikic#161)

TysonAndre · web-flow · commit 1b5d767dd326 · 2020-07-11T13:39:35.000-04:00
The naming is based on `switch` statements.
Note that even if statement blocks were supported after a future RFC
those would probably be considered block **expressions**,
hence the `expr` name for `AST_MATCH_ARM`.

* Regenerate ast_stub.php
* Add missing files to package.xml
diff --git a/README.md b/README.md
@@ -405,6 +405,8 @@ AST_INSTANCEOF:       expr, class
 AST_ISSET:            var
 AST_LABEL:            name
 AST_MAGIC_CONST:
+AST_MATCH:            cond, stmts            // php 8.0+ match
+AST_MATCH_ARM:        cond, expr             // php 8.0+ match
 AST_METHOD:           name, docComment, params, stmts, returnType, attributes
                       uses                   // prior to version 60
 AST_METHOD_CALL:      expr, method, args
@@ -457,6 +459,7 @@ AST_ENCAPS_LIST           // interpolated string: "foo$bar"
 AST_EXPR_LIST
 AST_IF
 AST_LIST
+AST_MATCH_ARM_LIST        // php 8.0+ match
 AST_NAME_LIST
 AST_PARAM_LIST
 AST_PROP_DECL
diff --git a/ast.c b/ast.c
@@ -287,6 +287,7 @@ static const ast_flag_info flag_info[] = {
 	{ ZEND_AST_PROP_DECL, 1, modifier_flags },
 	{ ZEND_AST_PROP_GROUP, 1, modifier_flags },
 	{ ZEND_AST_CLASS_CONST_DECL, 1, visibility_flags },
+	{ ZEND_AST_CLASS_CONST_GROUP, 1, visibility_flags },
 	{ ZEND_AST_TRAIT_ALIAS, 1, modifier_flags },
 	{ ZEND_AST_DIM, 1, dim_flags },
 	{ ZEND_AST_CONDITIONAL, 1, conditional_flags },
@@ -355,6 +356,7 @@ static inline zend_bool ast_kind_uses_attr(zend_ast_kind kind) {
 		|| kind == ZEND_AST_PROP_GROUP
 		|| kind == ZEND_AST_GROUP_USE || kind == ZEND_AST_USE_ELEM
 		|| kind == AST_NAME || kind == AST_CLOSURE_VAR || kind == ZEND_AST_CLASS_CONST_DECL
+		|| kind == ZEND_AST_CLASS_CONST_GROUP
 		|| kind == ZEND_AST_ARRAY || kind == ZEND_AST_DIM || kind == ZEND_AST_CONDITIONAL;
 }
 
@@ -829,6 +831,7 @@ static void ast_to_zval(zval *zv, zend_ast *ast, ast_state_info_t *state) {
 			// ast->child is [AST_CLASS_CONST_DECL, optional attributes_list]
 			if (state->version < 80) {
 				// Keep class constants as a list of numerically indexed values in php 8
+				ast->child[0]->attr = ast->attr;
 				ast_to_zval(zv, ast->child[0], state);
 				return;
 			}
@@ -975,9 +978,10 @@ static void ast_to_zval(zval *zv, zend_ast *ast, ast_state_info_t *state) {
 		zval attributes_zval;
 		ZVAL_COPY_VALUE(&const_decl_zval, zv);
 		ZVAL_NULL(&attributes_zval);
+		ast_update_property_long(zv, AST_STR(str_flags), 0, AST_CACHE_SLOT_FLAGS);
 		// For version 80, create an AST_CLASS_CONST_GROUP wrapping the created AST_CLASS_CONST_DECL
 		ast_create_virtual_node_ex(
-				zv, ZEND_AST_CLASS_CONST_GROUP, 0, zend_ast_get_lineno(ast), state, 2, &const_decl_zval, &attributes_zval);
+				zv, ZEND_AST_CLASS_CONST_GROUP, ast->attr, zend_ast_get_lineno(ast), state, 2, &const_decl_zval, &attributes_zval);
 	}
 #endif
 }
diff --git a/ast_data.c b/ast_data.c
@@ -20,6 +20,7 @@ const zend_ast_kind ast_kinds[] = {
 	ZEND_AST_USE,
 	ZEND_AST_TYPE_UNION,
 	ZEND_AST_ATTRIBUTE_LIST,
+	ZEND_AST_MATCH_ARM_LIST,
 	AST_NAME,
 	AST_CLOSURE_VAR,
 	AST_NULLABLE_TYPE,
@@ -91,6 +92,8 @@ const zend_ast_kind ast_kinds[] = {
 	ZEND_AST_TRAIT_ALIAS,
 	ZEND_AST_GROUP_USE,
 	ZEND_AST_ATTRIBUTE,
+	ZEND_AST_MATCH,
+	ZEND_AST_MATCH_ARM,
 	ZEND_AST_METHOD_CALL,
 	ZEND_AST_STATIC_CALL,
 	ZEND_AST_CONDITIONAL,
@@ -124,6 +127,7 @@ const char *ast_kind_to_name(zend_ast_kind kind) {
 		case ZEND_AST_USE: return "AST_USE";
 		case ZEND_AST_TYPE_UNION: return "AST_TYPE_UNION";
 		case ZEND_AST_ATTRIBUTE_LIST: return "AST_ATTRIBUTE_LIST";
+		case ZEND_AST_MATCH_ARM_LIST: return "AST_MATCH_ARM_LIST";
 		case AST_NAME: return "AST_NAME";
 		case AST_CLOSURE_VAR: return "AST_CLOSURE_VAR";
 		case AST_NULLABLE_TYPE: return "AST_NULLABLE_TYPE";
@@ -195,6 +199,8 @@ const char *ast_kind_to_name(zend_ast_kind kind) {
 		case ZEND_AST_TRAIT_ALIAS: return "AST_TRAIT_ALIAS";
 		case ZEND_AST_GROUP_USE: return "AST_GROUP_USE";
 		case ZEND_AST_ATTRIBUTE: return "AST_ATTRIBUTE";
+		case ZEND_AST_MATCH: return "AST_MATCH";
+		case ZEND_AST_MATCH_ARM: return "AST_MATCH_ARM";
 		case ZEND_AST_METHOD_CALL: return "AST_METHOD_CALL";
 		case ZEND_AST_STATIC_CALL: return "AST_STATIC_CALL";
 		case ZEND_AST_CONDITIONAL: return "AST_CONDITIONAL";
@@ -613,6 +619,18 @@ zend_string *ast_kind_child_name(zend_ast_kind kind, uint32_t child) {
 				case 1: return AST_STR(str_args);
 			}
 			return NULL;
+		case ZEND_AST_MATCH:
+			switch (child) {
+				case 0: return AST_STR(str_cond);
+				case 1: return AST_STR(str_stmts);
+			}
+			return NULL;
+		case ZEND_AST_MATCH_ARM:
+			switch (child) {
+				case 0: return AST_STR(str_cond);
+				case 1: return AST_STR(str_expr);
+			}
+			return NULL;
 		case ZEND_AST_METHOD_CALL:
 			switch (child) {
 				case 0: return AST_STR(str_expr);
@@ -698,6 +716,7 @@ void ast_register_kind_constants(INIT_FUNC_ARGS) {
 	REGISTER_NS_LONG_CONSTANT("ast", "AST_USE", ZEND_AST_USE, CONST_CS | CONST_PERSISTENT);
 	REGISTER_NS_LONG_CONSTANT("ast", "AST_TYPE_UNION", ZEND_AST_TYPE_UNION, CONST_CS | CONST_PERSISTENT);
 	REGISTER_NS_LONG_CONSTANT("ast", "AST_ATTRIBUTE_LIST", ZEND_AST_ATTRIBUTE_LIST, CONST_CS | CONST_PERSISTENT);
+	REGISTER_NS_LONG_CONSTANT("ast", "AST_MATCH_ARM_LIST", ZEND_AST_MATCH_ARM_LIST, CONST_CS | CONST_PERSISTENT);
 	REGISTER_NS_LONG_CONSTANT("ast", "AST_NAME", AST_NAME, CONST_CS | CONST_PERSISTENT);
 	REGISTER_NS_LONG_CONSTANT("ast", "AST_CLOSURE_VAR", AST_CLOSURE_VAR, CONST_CS | CONST_PERSISTENT);
 	REGISTER_NS_LONG_CONSTANT("ast", "AST_NULLABLE_TYPE", AST_NULLABLE_TYPE, CONST_CS | CONST_PERSISTENT);
@@ -769,6 +788,8 @@ void ast_register_kind_constants(INIT_FUNC_ARGS) {
 	REGISTER_NS_LONG_CONSTANT("ast", "AST_TRAIT_ALIAS", ZEND_AST_TRAIT_ALIAS, CONST_CS | CONST_PERSISTENT);
 	REGISTER_NS_LONG_CONSTANT("ast", "AST_GROUP_USE", ZEND_AST_GROUP_USE, CONST_CS | CONST_PERSISTENT);
 	REGISTER_NS_LONG_CONSTANT("ast", "AST_ATTRIBUTE", ZEND_AST_ATTRIBUTE, CONST_CS | CONST_PERSISTENT);
+	REGISTER_NS_LONG_CONSTANT("ast", "AST_MATCH", ZEND_AST_MATCH, CONST_CS | CONST_PERSISTENT);
+	REGISTER_NS_LONG_CONSTANT("ast", "AST_MATCH_ARM", ZEND_AST_MATCH_ARM, CONST_CS | CONST_PERSISTENT);
 	REGISTER_NS_LONG_CONSTANT("ast", "AST_METHOD_CALL", ZEND_AST_METHOD_CALL, CONST_CS | CONST_PERSISTENT);
 	REGISTER_NS_LONG_CONSTANT("ast", "AST_STATIC_CALL", ZEND_AST_STATIC_CALL, CONST_CS | CONST_PERSISTENT);
 	REGISTER_NS_LONG_CONSTANT("ast", "AST_CONDITIONAL", ZEND_AST_CONDITIONAL, CONST_CS | CONST_PERSISTENT);
diff --git a/ast_stub.php b/ast_stub.php
@@ -25,6 +25,8 @@
 const AST_TRAIT_ADAPTATIONS = 142;
 const AST_USE = 143;
 const AST_TYPE_UNION = 144;
+const AST_ATTRIBUTE_LIST = 145;
+const AST_MATCH_ARM_LIST = 146;
 const AST_NAME = 2048;
 const AST_CLOSURE_VAR = 2049;
 const AST_NULLABLE_TYPE = 2050;
@@ -64,6 +66,7 @@
 const AST_BREAK = 286;
 const AST_CONTINUE = 287;
 const AST_CLASS_NAME = 276;
+const AST_CLASS_CONST_GROUP = 545;
 const AST_DIM = 512;
 const AST_PROP = 513;
 const AST_STATIC_PROP = 514;
@@ -94,14 +97,17 @@
 const AST_USE_ELEM = 542;
 const AST_TRAIT_ALIAS = 543;
 const AST_GROUP_USE = 544;
+const AST_ATTRIBUTE = 546;
+const AST_MATCH = 547;
+const AST_MATCH_ARM = 548;
 const AST_METHOD_CALL = 768;
 const AST_STATIC_CALL = 769;
 const AST_CONDITIONAL = 770;
 const AST_TRY = 771;
 const AST_CATCH = 772;
-const AST_PARAM = 1280;
 const AST_FOR = 1024;
 const AST_FOREACH = 1025;
+const AST_PARAM = 1280;
 // END AST KIND CONSTANTS
 
 // AST FLAG CONSTANTS
@@ -178,14 +184,14 @@
 const USE_NORMAL = 1;
 const USE_FUNCTION = 2;
 const USE_CONST = 4;
-const MAGIC_LINE = 373;
-const MAGIC_FILE = 374;
-const MAGIC_DIR = 375;
-const MAGIC_NAMESPACE = 392;
-const MAGIC_FUNCTION = 379;
-const MAGIC_METHOD = 378;
-const MAGIC_CLASS = 376;
-const MAGIC_TRAIT = 377;
+const MAGIC_LINE = 372;
+const MAGIC_FILE = 373;
+const MAGIC_DIR = 374;
+const MAGIC_NAMESPACE = 379;
+const MAGIC_FUNCTION = 378;
+const MAGIC_METHOD = 377;
+const MAGIC_CLASS = 375;
+const MAGIC_TRAIT = 376;
 const ARRAY_SYNTAX_LIST = 1;
 const ARRAY_SYNTAX_LONG = 2;
 const ARRAY_SYNTAX_SHORT = 3;
diff --git a/package.xml b/package.xml
@@ -50,9 +50,12 @@
       <file name="array_destructuring.phpt" role="test" />
       <file name="assign_ops.phpt" role="test" />
       <file name="ast_dump_with_linenos.phpt" role="test" />
+      <file name="attributes_01.phpt" role="test" />
+      <file name="attributes_02.phpt" role="test" />
       <file name="binary_ops.phpt" role="test" />
       <file name="by_ref_destructuring.phpt" role="test" />
       <file name="class_consts.phpt" role="test" />
+      <file name="class_consts_80.phpt" role="test" />
       <file name="class_on_objects.phpt" role="test" />
       <file name="class_name_version_50.phpt" role="test" />
       <file name="class_name_version_70.phpt" role="test" />
@@ -73,7 +76,9 @@
       <file name="get_supported_versions.phpt" role="test" />
       <file name="invalid_file.php" role="test" />
       <file name="magic_constants.phpt" role="test" />
+      <file name="match_expression.phpt" role="test" />
       <file name="metadata.phpt" role="test" />
+      <file name="mixed_type.phpt" role="test" />
       <file name="multi_catch.phpt" role="test" />
       <file name="multiple_final_modifiers.phpt" role="test" />
       <file name="named_children.phpt" role="test" />
diff --git a/php_ast.h b/php_ast.h
@@ -61,9 +61,12 @@ extern ast_str_globals str_globals;
 /* NOTE: For list nodes, the first set bit is 0x80 */
 # define ZEND_AST_TYPE_UNION ((1 << (ZEND_AST_IS_LIST_SHIFT + 1)) - 2)
 # define ZEND_AST_ATTRIBUTE_LIST ((1 << (ZEND_AST_IS_LIST_SHIFT + 1)) - 3)
-// NOTE: The first hex digit is the number of child nodes a given kind has
+# define ZEND_AST_MATCH_ARM_LIST ((1 << (ZEND_AST_IS_LIST_SHIFT + 1)) - 4)
 # define ZEND_AST_CLASS_CONST_GROUP 0x2fe
 # define ZEND_AST_ATTRIBUTE 0x2fd
+# define ZEND_AST_MATCH 0x2fc
+# define ZEND_AST_MATCH_ARM 0x2fb
+// NOTE: The first hex digit is the number of child nodes a given kind has
 #endif
 
 /* Pretend it still exists */
diff --git a/scripts/generate_ast_data.php b/scripts/generate_ast_data.php
@@ -130,6 +130,8 @@
     'ZEND_AST_TRAIT_ALIAS' => ['method', 'alias'],
     'ZEND_AST_GROUP_USE' => ['prefix', 'uses'],
     'ZEND_AST_ATTRIBUTE' => ['class', 'args'],
+    'ZEND_AST_MATCH' => ['cond', 'stmts'],
+    'ZEND_AST_MATCH_ARM' => ['cond', 'expr'],
 
     /* 3 child nodes */
     'ZEND_AST_METHOD_CALL' => ['expr', 'method', 'args'],
@@ -167,6 +169,7 @@
 	'ZEND_AST_USE',
 	'ZEND_AST_TYPE_UNION',
 	'ZEND_AST_ATTRIBUTE_LIST',
+	'ZEND_AST_MATCH_ARM_LIST',
 ];
 
 $data = [];
diff --git a/tests/attributes_02.phpt b/tests/attributes_02.phpt
@@ -101,8 +101,9 @@ AST_STMT_LIST
                                     flags: NAME_NOT_FQ (%d)
                                     name: "true"
             1: AST_CLASS_CONST_GROUP
+                flags: MODIFIER_PUBLIC (%d)
                 const: AST_CLASS_CONST_DECL
-                    flags: MODIFIER_PUBLIC (%d)
+                    flags: 0
                     0: AST_CONST_ELEM
                         name: "CONST_WITH_ATTRIBUTE"
                         value: 123
diff --git a/tests/class_consts_80.phpt b/tests/class_consts_80.phpt
@@ -33,16 +33,18 @@ AST_STMT_LIST
         implements: null
         stmts: AST_STMT_LIST
             0: AST_CLASS_CONST_GROUP
+                flags: MODIFIER_PUBLIC (%d)
                 const: AST_CLASS_CONST_DECL
-                    flags: MODIFIER_PUBLIC (%d)
+                    flags: 0
                     0: AST_CONST_ELEM
                         name: "A"
                         value: 1
                         docComment: "/** Doc A */"
                 attributes: null
             1: AST_CLASS_CONST_GROUP
+                flags: MODIFIER_PROTECTED (%d)
                 const: AST_CLASS_CONST_DECL
-                    flags: MODIFIER_PROTECTED (%d)
+                    flags: 0
                     0: AST_CONST_ELEM
                         name: "E"
                         value: 5
diff --git a/tests/match_expression.phpt b/tests/match_expression.phpt
@@ -0,0 +1,59 @@
+--TEST--
+Match expression in PHP 8.0
+--SKIPIF--
+<?php if (PHP_VERSION_ID < 80000) die('skip PHP >= 8.0 only'); ?>
+--FILE--
+<?php
+
+require __DIR__ . '/../util.php';
+
+$code = <<<'PHP'
+<?php
+$x = match($y) { 2 => 3, default => 5 };
+
+match(1) {};
+match(my_const) {
+	1, \other_const => $x,
+	default, => 123,
+};
+PHP;
+
+$node = ast\parse_code($code, $version=70);
+echo ast_dump($node), "\n";
+--EXPECTF--
+AST_STMT_LIST
+    0: AST_ASSIGN
+        var: AST_VAR
+            name: "x"
+        expr: AST_MATCH
+            cond: AST_VAR
+                name: "y"
+            stmts: AST_MATCH_ARM_LIST
+                0: AST_MATCH_ARM
+                    cond: AST_EXPR_LIST
+                        0: 2
+                    expr: 3
+                1: AST_MATCH_ARM
+                    cond: null
+                    expr: 5
+    1: AST_MATCH
+        cond: 1
+        stmts: AST_MATCH_ARM_LIST
+    2: AST_MATCH
+        cond: AST_CONST
+            name: AST_NAME
+                flags: NAME_NOT_FQ (%d)
+                name: "my_const"
+        stmts: AST_MATCH_ARM_LIST
+            0: AST_MATCH_ARM
+                cond: AST_EXPR_LIST
+                    0: 1
+                    1: AST_CONST
+                        name: AST_NAME
+                            flags: NAME_FQ (%d)
+                            name: "other_const"
+                expr: AST_VAR
+                    name: "x"
+            1: AST_MATCH_ARM
+                cond: null
+                expr: 123
diff --git a/tests/metadata.phpt b/tests/metadata.phpt
@@ -45,6 +45,7 @@ AST_TRAIT_ADAPTATIONS: []
 AST_USE: [USE_NORMAL, USE_FUNCTION, USE_CONST]
 AST_TYPE_UNION: []
 AST_ATTRIBUTE_LIST: []
+AST_MATCH_ARM_LIST: []
 AST_NAME: [NAME_FQ, NAME_NOT_FQ, NAME_RELATIVE]
 AST_CLOSURE_VAR: [CLOSURE_USE_REF]
 AST_NULLABLE_TYPE: []
@@ -84,7 +85,7 @@ AST_GOTO: []
 AST_BREAK: []
 AST_CONTINUE: []
 AST_CLASS_NAME: []
-AST_CLASS_CONST_GROUP: []
+AST_CLASS_CONST_GROUP: (combinable) [MODIFIER_PUBLIC, MODIFIER_PROTECTED, MODIFIER_PRIVATE]
 AST_DIM: (combinable) [DIM_ALTERNATIVE_SYNTAX]
 AST_PROP: []
 AST_STATIC_PROP: []
@@ -116,6 +117,8 @@ AST_USE_ELEM: [USE_NORMAL, USE_FUNCTION, USE_CONST]
 AST_TRAIT_ALIAS: (combinable) [MODIFIER_PUBLIC, MODIFIER_PROTECTED, MODIFIER_PRIVATE, MODIFIER_STATIC, MODIFIER_ABSTRACT, MODIFIER_FINAL]
 AST_GROUP_USE: [USE_NORMAL, USE_FUNCTION, USE_CONST]
 AST_ATTRIBUTE: []
+AST_MATCH: []
+AST_MATCH_ARM: []
 AST_METHOD_CALL: []
 AST_STATIC_CALL: []
 AST_CONDITIONAL: (combinable) [PARENTHESIZED_CONDITIONAL]
