Add encaps var flags for AST_DIM/AST_VAR for php 8.2 (#227)

For https://wiki.php.net/rfc/deprecate_dollar_brace_string_interpolation

Closes #224

In util.php: Don't print a 0 flag value for combinable flags

For php-ast self-testing, minimize the number of changes in the future
when similar combinable flags get added to existing ast var types.

Author: TysonAndre

README.md

@@ -357,6 +357,11 @@ ast\flags\ARRAY_ELEM_REF
 
 // Used by ast\AST_DIM (combinable), since PHP 7.4
 ast\flags\DIM_ALTERNATIVE_SYNTAX
+ast\flags\ENCAPS_VAR_DOLLAR_CURLY  // php 8.2 deprecation, only available in php 8.2+
+
+// Used by ast\AST_VAR (combinable), since PHP 8.2
+ast\flags\ENCAPS_VAR_DOLLAR_CURLY
+ast\flags\ENCAPS_VAR_DOLLAR_CURLY_VAR_VAR
 
 // Used by ast\AST_CONDITIONAL (combinable), since PHP 7.4
 ast\flags\PARENTHESIZED_CONDITIONAL

ast.c

@@ -112,6 +112,11 @@
 # define IS_NEVER 22
 #endif
 
+#if PHP_VERSION_ID < 80200
+# define ZEND_ENCAPS_VAR_DOLLAR_CURLY (1<<0)
+# define ZEND_ENCAPS_VAR_DOLLAR_CURLY_VAR_VAR (1<<1)
+#endif
+
 /* This contains state of the ast Node creator. */
 typedef struct ast_state_info {
 	zend_long version;
@@ -299,9 +304,9 @@ static const char *func_flags[] = {
 	NULL
 };
 
-// Flags of AST_DIM are marked as combinable in case any other flags get added in the future.
 static const char *dim_flags[] = {
 	AST_FLAG(DIM_ALTERNATIVE_SYNTAX),
+	AST_FLAG(ENCAPS_VAR_DOLLAR_CURLY),
 	NULL
 };
 
@@ -311,6 +316,12 @@ static const char *conditional_flags[] = {
 	NULL
 };
 
+static const char *var_flags[] = {
+	AST_FLAG(ENCAPS_VAR_DOLLAR_CURLY_VAR_VAR),
+	AST_FLAG(ENCAPS_VAR_DOLLAR_CURLY),
+	NULL
+};
+
 static const ast_flag_info flag_info[] = {
 	{ AST_NAME, 0, name_flags },
 	{ ZEND_AST_CLASS, 1, class_flags },
@@ -339,6 +350,7 @@ static const ast_flag_info flag_info[] = {
 	{ ZEND_AST_TRAIT_ALIAS, 1, modifier_flags },
 	{ ZEND_AST_DIM, 1, dim_flags },
 	{ ZEND_AST_CONDITIONAL, 1, conditional_flags },
+	{ ZEND_AST_VAR, 1, var_flags },
 };
 
 static inline void ast_update_property(zval *object, zend_string *name, zval *value) {
@@ -414,7 +426,8 @@ static inline zend_bool ast_kind_uses_attr(zend_ast_kind kind) {
 		|| 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;
+		|| kind == ZEND_AST_ARRAY || kind == ZEND_AST_DIM || kind == ZEND_AST_CONDITIONAL
+		|| kind == ZEND_AST_VAR;
 }
 
 static inline zend_bool ast_kind_is_decl(zend_ast_kind kind) {
@@ -1486,6 +1499,9 @@ PHP_MINIT_FUNCTION(ast) {
 
 	ast_register_flag_constant("PARENTHESIZED_CONDITIONAL", ZEND_PARENTHESIZED_CONDITIONAL);
 
+	ast_register_flag_constant("ENCAPS_VAR_DOLLAR_CURLY", ZEND_ENCAPS_VAR_DOLLAR_CURLY);
+	ast_register_flag_constant("ENCAPS_VAR_DOLLAR_CURLY_VAR_VAR", ZEND_ENCAPS_VAR_DOLLAR_CURLY_VAR_VAR);
+
 	INIT_CLASS_ENTRY(tmp_ce, "ast\\Node", class_ast_Node_methods);
 	ast_node_ce = zend_register_internal_class(&tmp_ce);
 	ast_declare_property(ast_node_ce, AST_STR(str_kind), &zv_null);

ast_stub.php

@@ -212,6 +212,8 @@
 const ARRAY_SYNTAX_SHORT = 3;
 const DIM_ALTERNATIVE_SYNTAX = 2;
 const PARENTHESIZED_CONDITIONAL = 1;
+const ENCAPS_VAR_DOLLAR_CURLY = 1;
+const ENCAPS_VAR_DOLLAR_CURLY_VAR_VAR = 2;
 // END AST FLAG CONSTANTS
 
 namespace ast;

package.xml

@@ -32,8 +32,10 @@
 - Change documentation files to properly namespace attributes as `#[\AllowDynamicProperties]`. The reflection attributes are already correct.
 - Deprecated AST versions 50 and 60.
 - Drop support for php <= 7.1
+- Fix test failures seen in php 8.2.0beta2 due to change to var_export's output format.
 - Add support for php 8.2 readonly classes. Add `ast\flags\CLASS_READONLY` constant.
 - Add support for php 8.2 `true` type. Add `ast\flags\TYPE_TRUE` constant.
+- Fix bug in php 8.2 where ZEND_AST_ARROW_FUNC output did not include the stub `AST_RETURN` node that was included in php 8.1 and below.
  </notes>
  <contents>
   <dir name="/">
@@ -119,7 +121,9 @@
       <file name="php81_final_class_const.phpt" role="test" />
       <file name="php81_intersection_types.phpt" role="test" />
       <file name="php81_readonly.phpt" role="test" />
-      <file name="php82_metadata.phpt" role="test" />
+      <file name="php82_dynamic_property_attribute.phpt" role="test" />
+      <file name="php82_encaps_list.phpt" role="test" />
+      <file name="php82_readonly_class.phpt" role="test" />
       <file name="prop_doc_comments.phpt" role="test" />
       <file name="short_arrow_function.phpt" role="test" />
       <file name="short_arrow_function_return.phpt" role="test" />

tests/001.phpt

@@ -24,12 +24,10 @@ echo ast_dump(ast\parse_code($code, $version=70));
 --EXPECT--
 AST_STMT_LIST
     0: AST_FUNC_DECL
-        flags: 0
         name: "test"
         docComment: "/** Test function */"
         params: AST_PARAM_LIST
             0: AST_PARAM
-                flags: 0
                 type: AST_NAME
                     flags: NAME_NOT_FQ (1)
                     name: "Type"
@@ -69,4 +67,4 @@ AST_STMT_LIST
         returnType: AST_NAME
             flags: NAME_NOT_FQ (1)
             name: "Ret"
-        __declId: 0
+        __declId: 0

tests/array_destructuring.phpt

@@ -78,4 +78,4 @@ AST_STMT_LIST
                         key: null
                 key: null
         expr: AST_VAR
-            name: "x"
+            name: "x"

tests/array_destructuring_old.phpt

@@ -18,7 +18,7 @@ echo ast_dump(ast\parse_code($code, $version=70));
 AST_STMT_LIST
     0: AST_ASSIGN
         var: AST_ARRAY
-            flags: ARRAY_SYNTAX_LIST (1)
+            flags: ARRAY_SYNTAX_LIST (%d)
             0: AST_ARRAY_ELEM
                 flags: 0
                 value: AST_VAR
@@ -33,12 +33,12 @@ AST_STMT_LIST
             name: "x"
     1: AST_ASSIGN
         var: AST_ARRAY
-            flags: ARRAY_SYNTAX_LIST (1)
+            flags: ARRAY_SYNTAX_LIST (%d)
             0: null
             1: AST_ARRAY_ELEM
                 flags: 0
                 value: AST_VAR
                     name: "b"
                 key: null
         expr: AST_VAR
-            name: "x"
+            name: "x"

tests/assign_ops.phpt

@@ -27,55 +27,55 @@ echo ast_dump(ast\parse_code($code, $version=70)), "\n";
 --EXPECTF--
 AST_STMT_LIST
     0: AST_ASSIGN_OP
-        flags: BINARY_BITWISE_OR (9)
+        flags: BINARY_BITWISE_OR (%d)
         var: AST_VAR
             name: "a"
         expr: AST_VAR
             name: "b"
     1: AST_ASSIGN_OP
-        flags: BINARY_BITWISE_AND (10)
+        flags: BINARY_BITWISE_AND (%d)
         var: AST_VAR
             name: "a"
         expr: AST_VAR
             name: "b"
     2: AST_ASSIGN_OP
-        flags: BINARY_BITWISE_XOR (11)
+        flags: BINARY_BITWISE_XOR (%d)
         var: AST_VAR
             name: "a"
         expr: AST_VAR
             name: "b"
     3: AST_ASSIGN_OP
-        flags: BINARY_CONCAT (8)
+        flags: BINARY_CONCAT (%d)
         var: AST_VAR
             name: "a"
         expr: AST_VAR
             name: "b"
     4: AST_ASSIGN_OP
-        flags: BINARY_ADD (1)
+        flags: BINARY_ADD (%d)
         var: AST_VAR
             name: "a"
         expr: AST_VAR
             name: "b"
     5: AST_ASSIGN_OP
-        flags: BINARY_SUB (2)
+        flags: BINARY_SUB (%d)
         var: AST_VAR
             name: "a"
         expr: AST_VAR
             name: "b"
     6: AST_ASSIGN_OP
-        flags: BINARY_MUL (3)
+        flags: BINARY_MUL (%d)
         var: AST_VAR
             name: "a"
         expr: AST_VAR
             name: "b"
     7: AST_ASSIGN_OP
-        flags: BINARY_DIV (4)
+        flags: BINARY_DIV (%d)
         var: AST_VAR
             name: "a"
         expr: AST_VAR
             name: "b"
     8: AST_ASSIGN_OP
-        flags: BINARY_MOD (5)
+        flags: BINARY_MOD (%d)
         var: AST_VAR
             name: "a"
         expr: AST_VAR
@@ -87,14 +87,14 @@ AST_STMT_LIST
         expr: AST_VAR
             name: "b"
     10: AST_ASSIGN_OP
-        flags: BINARY_SHIFT_LEFT (6)
+        flags: BINARY_SHIFT_LEFT (%d)
         var: AST_VAR
             name: "a"
         expr: AST_VAR
             name: "b"
     11: AST_ASSIGN_OP
-        flags: BINARY_SHIFT_RIGHT (7)
+        flags: BINARY_SHIFT_RIGHT (%d)
         var: AST_VAR
             name: "a"
         expr: AST_VAR
-            name: "b"
+            name: "b"

tests/ast_dump_with_exclude_doc.phpt

@@ -23,11 +23,9 @@ echo ast_dump($ast, AST_DUMP_EXCLUDE_DOC_COMMENT);
 --EXPECT--
 AST_STMT_LIST
     0: AST_FUNC_DECL
-        flags: 0
         name: "test"
         params: AST_PARAM_LIST
             0: AST_PARAM
-                flags: 0
                 type: null
                 name: "foo"
                 default: null

tests/ast_dump_with_linenos.phpt

@@ -25,20 +25,19 @@ $ast = ast\parse_code($code, $version=70);
 echo ast_dump($ast, AST_DUMP_LINENOS);
 
 ?>
---EXPECT--
+--EXPECTF--
 AST_STMT_LIST @ 1
     0: AST_FUNC_DECL @ 2-9
-        flags: 0
         name: "test"
         docComment: null
         params: AST_PARAM_LIST @ 4
         stmts: AST_STMT_LIST @ 5
             0: AST_CALL @ 6
                 expr: AST_NAME @ 6
-                    flags: NAME_NOT_FQ (1)
+                    flags: NAME_NOT_FQ (%d)
                     name: "var_dump"
                 args: AST_ARG_LIST @ 7
                     0: AST_VAR @ 7
                         name: "foo"
         returnType: null
-        __declId: 0
+        __declId: 0