Add AST_PROP_GROUP in version 70.

The type information is deliberately left out of versions < 70.

`children['type']` is a Node describing the type of the property group,
or null.
`children['props']` is the AST_PROP_DECL.

The property visibility modifier flags were moved to the AST_PROP_GROUP.

Update package.xml

Author: TysonAndre

README.md

@@ -227,8 +227,8 @@ ast\flags\NAME_FQ (= 0)    // example: \Foo\Bar
 ast\flags\NAME_NOT_FQ      // example: Foo\Bar
 ast\flags\NAME_RELATIVE    // example: namespace\Foo\Bar
 
-// Used by ast\AST_METHOD, ast\AST_PROP_DECL, ast\AST_CLASS_CONST_DECL
-// and ast\AST_TRAIT_ALIAS (combinable)
+// Used by ast\AST_METHOD, ast\AST_PROP_DECL, ast\AST_CLASS_CONST_DECL,
+// ast\AST_PROP_GROUP and ast\AST_TRAIT_ALIAS (combinable)
 ast\flags\MODIFIER_PUBLIC
 ast\flags\MODIFIER_PROTECTED
 ast\flags\MODIFIER_PRIVATE
@@ -404,6 +404,7 @@ AST_PRE_INC:          var
 AST_PRINT:            expr
 AST_PROP:             expr, prop
 AST_PROP_ELEM:        name, default, docComment
+AST_PROP_GROUP:       type, props            // version 70+
 AST_REF:              var                    // only used in foreach ($a as &$v)
 AST_RETURN:           expr
 AST_SHELL_EXEC:       expr
@@ -465,6 +466,13 @@ function accepts a boolean argument that determines whether deprecated versions
 In the following the changes in the respective AST versions, as well as their current support state,
 are listed.
 
+### 70 (experimental)
+
+* `AST_PROP_GROUP` was added to support PHP 7.4's typed properties.
+  The property visibility modifiers are now part of `AST_PROP_GROUP` instead of `AST_PROP_DECL`.
+
+  Note that property group type information is only available with AST versions 70+.
+
 ### 60 (current)
 
 Supported since 0.1.7 (2018-10-06).

ast.c

@@ -253,6 +253,7 @@ static const ast_flag_info flag_info[] = {
 	{ ZEND_AST_FUNC_DECL, 1, func_flags },
 	{ ZEND_AST_CLOSURE, 1, func_flags },
 	{ ZEND_AST_PROP_DECL, 1, modifier_flags },
+	{ ZEND_AST_PROP_GROUP, 1, modifier_flags },
 	{ ZEND_AST_CLASS_CONST_DECL, 1, visibility_flags },
 	{ ZEND_AST_TRAIT_ALIAS, 1, modifier_flags },
 };
@@ -311,6 +312,9 @@ static inline zend_bool ast_kind_uses_attr(zend_ast_kind kind) {
 		|| kind == ZEND_AST_UNARY_OP || kind == ZEND_AST_BINARY_OP || kind == ZEND_AST_ASSIGN_OP
 		|| kind == ZEND_AST_CAST || kind == ZEND_AST_MAGIC_CONST || kind == ZEND_AST_ARRAY_ELEM
 		|| kind == ZEND_AST_INCLUDE_OR_EVAL || kind == ZEND_AST_USE || kind == ZEND_AST_PROP_DECL
+#if PHP_VERSION_ID >= 70400
+		|| kind == ZEND_AST_PROP_GROUP
+#endif
 		|| 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_ARRAY;
@@ -336,6 +340,9 @@ static inline zend_bool ast_is_name(zend_ast *ast, zend_ast *parent, uint32_t i)
 			|| parent->kind == ZEND_AST_CALL || parent->kind == ZEND_AST_CONST
 			|| parent->kind == ZEND_AST_NEW || parent->kind == ZEND_AST_STATIC_CALL
 			|| parent->kind == ZEND_AST_CLASS_CONST || parent->kind == ZEND_AST_STATIC_PROP
+#if PHP_VERSION_ID >= 70400
+			|| parent->kind == ZEND_AST_PROP_GROUP
+#endif
 			;
 	}
 
@@ -354,7 +361,11 @@ static inline zend_bool ast_is_name(zend_ast *ast, zend_ast *parent, uint32_t i)
 /* Assumes that ast_is_name is already true */
 static inline zend_bool ast_is_type(zend_ast *ast, zend_ast *parent, uint32_t i) {
 	if (i == 0) {
-		return parent->kind == ZEND_AST_PARAM;
+		return parent->kind == ZEND_AST_PARAM
+#if PHP_VERSION_ID >= 70400
+			|| parent->kind == ZEND_AST_PROP_GROUP
+#endif
+			;
 	}
 	if (i == 3) {
 		return parent->kind == ZEND_AST_CLOSURE || parent->kind == ZEND_AST_FUNC_DECL
@@ -512,6 +523,46 @@ static void ast_create_virtual_node(
 		zv, kind, attr, zend_ast_get_lineno(child), state, 1, &child_zv);
 }
 
+static inline void ast_name_to_zval(zend_ast *child, zend_ast *ast, zval *child_zv, int i, ast_state_info_t *state) {
+	zend_uchar type;
+	zend_bool is_nullable = 0;
+	if (child->attr & ZEND_TYPE_NULLABLE) {
+		is_nullable = 1;
+		child->attr &= ~ZEND_TYPE_NULLABLE;
+	}
+
+	if (child->attr == ZEND_NAME_FQ) {
+		/* Ensure there is no leading \ for fully-qualified names. This can happen if
+		 * something like ('\bar')() is used. */
+		zval *name = zend_ast_get_zval(child);
+		if (Z_STRVAL_P(name)[0] == '\\') {
+			zend_string *new_name = zend_string_init(
+				Z_STRVAL_P(name) + 1, Z_STRLEN_P(name) - 1, 0);
+			zend_string_release(Z_STR_P(name));
+			Z_STR_P(name) = new_name;
+		}
+	}
+
+	if (child->attr == ZEND_NAME_NOT_FQ
+			&& ast_is_type(child, ast, i)
+			&& (type = lookup_builtin_type(zend_ast_get_str(child)))
+	) {
+		/* Convert "int" etc typehints to TYPE nodes */
+		ast_create_virtual_node_ex(
+			child_zv, ZEND_AST_TYPE, type, zend_ast_get_lineno(child), state, 0);
+	} else {
+		ast_create_virtual_node(child_zv, AST_NAME, child->attr, child, state);
+	}
+
+	if (is_nullable) {
+		/* Create explicit AST_NULLABLE_TYPE node */
+		zval tmp;
+		ZVAL_COPY_VALUE(&tmp, child_zv);
+		ast_create_virtual_node_ex(
+			child_zv, AST_NULLABLE_TYPE, 0, zend_ast_get_lineno(child), state, 1, &tmp);
+	}
+}
+
 static void ast_fill_children_ht(HashTable *ht, zend_ast *ast, ast_state_info_t *state) {
 	uint32_t i, count;
 	zend_bool is_list = zend_ast_is_list(ast);
@@ -542,43 +593,7 @@ static void ast_fill_children_ht(HashTable *ht, zend_ast *ast, ast_state_info_t
 		} else
 #endif
 		if (ast_is_name(child, ast, i)) {
-			zend_uchar type;
-			zend_bool is_nullable = 0;
-			if (child->attr & ZEND_TYPE_NULLABLE) {
-				is_nullable = 1;
-				child->attr &= ~ZEND_TYPE_NULLABLE;
-			}
-
-			if (child->attr == ZEND_NAME_FQ) {
-				/* Ensure there is no leading \ for fully-qualified names. This can happen if
-				 * something like ('\bar')() is used. */
-				zval *name = zend_ast_get_zval(child);
-				if (Z_STRVAL_P(name)[0] == '\\') {
-					zend_string *new_name = zend_string_init(
-						Z_STRVAL_P(name) + 1, Z_STRLEN_P(name) - 1, 0);
-					zend_string_release(Z_STR_P(name));
-					Z_STR_P(name) = new_name;
-				}
-			}
-
-			if (child->attr == ZEND_NAME_NOT_FQ
-					&& ast_is_type(child, ast, i)
-					&& (type = lookup_builtin_type(zend_ast_get_str(child)))
-			) {
-				/* Convert "int" etc typehints to TYPE nodes */
-				ast_create_virtual_node_ex(
-					&child_zv, ZEND_AST_TYPE, type, zend_ast_get_lineno(child), state, 0);
-			} else {
-				ast_create_virtual_node(&child_zv, AST_NAME, child->attr, child, state);
-			}
-
-			if (is_nullable) {
-				/* Create explicit AST_NULLABLE_TYPE node */
-				zval tmp;
-				ZVAL_COPY_VALUE(&tmp, &child_zv);
-				ast_create_virtual_node_ex(
-					&child_zv, AST_NULLABLE_TYPE, 0, zend_ast_get_lineno(child), state, 1, &tmp);
-			}
+			ast_name_to_zval(child, ast, &child_zv, i, state);
 		} else if (child && child->kind == ZEND_AST_TYPE && (child->attr & ZEND_TYPE_NULLABLE)) {
 			child->attr &= ~ZEND_TYPE_NULLABLE;
 			ast_create_virtual_node(&child_zv, AST_NULLABLE_TYPE, 0, child, state);
@@ -693,6 +708,19 @@ static void ast_to_zval(zval *zv, zend_ast *ast, ast_state_info_t *state) {
 			ast->kind = ZEND_AST_UNARY_OP;
 			ast->attr = AST_MINUS;
 			break;
+#if PHP_VERSION_ID >= 70400
+		case ZEND_AST_PROP_GROUP:
+			if (state->version < 70) {
+				// In versions less than 70, just omit property type information entirely.
+				// ast->child is [type_ast, prop_ast]
+				ast_to_zval(zv, ast->child[1], state);
+				// The property visibility is on the AST_PROP_GROUP node.
+				// Add it to the AST_PROP_DECL node for old
+				ast_update_property_long(zv, AST_STR(str_flags), ast->attr, AST_CACHE_SLOT_FLAGS);
+				return;
+			}
+			break;
+#endif
 	}
 
 #if PHP_VERSION_ID < 70100
@@ -747,9 +775,20 @@ static void ast_to_zval(zval *zv, zend_ast *ast, ast_state_info_t *state) {
 	}
 
 	ast_fill_children_ht(Z_ARRVAL(children_zv), ast, state);
+#if PHP_VERSION_ID < 70400
+	if (ast->kind == ZEND_AST_PROP_DECL && state->version >= 70) {
+		zval type_zval;
+		zval prop_group_zval = *zv;
+		ZVAL_NULL(&type_zval);
+		// For version 70, create an AST_PROP_GROUP wrapping the created AST_PROP_DECL.
+		ast_create_virtual_node_ex(
+				zv, ZEND_AST_PROP_GROUP, ast->attr, zend_ast_get_lineno(ast), state, 2, &type_zval, &prop_group_zval);
+		ast_update_property_long(&prop_group_zval, AST_STR(str_flags), 0, AST_CACHE_SLOT_FLAGS);
+	}
+#endif
 }
 
-static const zend_long versions[] = {50, 60};
+static const zend_long versions[] = {50, 60, 70};
 static const size_t versions_count = sizeof(versions)/sizeof(versions[0]);
 
 static inline zend_bool ast_version_deprecated(zend_long version) {

ast_data.c

@@ -1,7 +1,5 @@
 #include "php_ast.h"
 
-const size_t ast_kinds_count = 91;
-
 const zend_ast_kind ast_kinds[] = {
 	ZEND_AST_ARG_LIST,
 	ZEND_AST_LIST,
@@ -78,6 +76,7 @@ const zend_ast_kind ast_kinds[] = {
 	ZEND_AST_SWITCH_CASE,
 	ZEND_AST_DECLARE,
 	ZEND_AST_PROP_ELEM,
+	ZEND_AST_PROP_GROUP,
 	ZEND_AST_CONST_ELEM,
 	ZEND_AST_USE_TRAIT,
 	ZEND_AST_TRAIT_PRECEDENCE,
@@ -96,6 +95,8 @@ const zend_ast_kind ast_kinds[] = {
 	ZEND_AST_FOREACH,
 };
 
+const size_t ast_kinds_count = sizeof(ast_kinds) / sizeof(ast_kinds[0]);
+
 const char *ast_kind_to_name(zend_ast_kind kind) {
 	switch (kind) {
 		case ZEND_AST_ARG_LIST: return "AST_ARG_LIST";
@@ -173,6 +174,7 @@ const char *ast_kind_to_name(zend_ast_kind kind) {
 		case ZEND_AST_SWITCH_CASE: return "AST_SWITCH_CASE";
 		case ZEND_AST_DECLARE: return "AST_DECLARE";
 		case ZEND_AST_PROP_ELEM: return "AST_PROP_ELEM";
+		case ZEND_AST_PROP_GROUP: return "AST_PROP_GROUP";
 		case ZEND_AST_CONST_ELEM: return "AST_CONST_ELEM";
 		case ZEND_AST_USE_TRAIT: return "AST_USE_TRAIT";
 		case ZEND_AST_TRAIT_PRECEDENCE: return "AST_TRAIT_PRECEDENCE";
@@ -513,6 +515,12 @@ zend_string *ast_kind_child_name(zend_ast_kind kind, uint32_t child) {
 				case 2: return AST_STR(str_docComment);
 			}
 			return NULL;
+		case ZEND_AST_PROP_GROUP:
+			switch (child) {
+				case 0: return AST_STR(str_type);
+				case 1: return AST_STR(str_props);
+			}
+			return NULL;
 		case ZEND_AST_CONST_ELEM:
 			switch (child) {
 				case 0: return AST_STR(str_name);
@@ -701,6 +709,7 @@ void ast_register_kind_constants(INIT_FUNC_ARGS) {
 	REGISTER_NS_LONG_CONSTANT("ast", "AST_SWITCH_CASE", ZEND_AST_SWITCH_CASE, CONST_CS | CONST_PERSISTENT);
 	REGISTER_NS_LONG_CONSTANT("ast", "AST_DECLARE", ZEND_AST_DECLARE, CONST_CS | CONST_PERSISTENT);
 	REGISTER_NS_LONG_CONSTANT("ast", "AST_PROP_ELEM", ZEND_AST_PROP_ELEM, CONST_CS | CONST_PERSISTENT);
+	REGISTER_NS_LONG_CONSTANT("ast", "AST_PROP_GROUP", ZEND_AST_PROP_GROUP, CONST_CS | CONST_PERSISTENT);
 	REGISTER_NS_LONG_CONSTANT("ast", "AST_CONST_ELEM", ZEND_AST_CONST_ELEM, CONST_CS | CONST_PERSISTENT);
 	REGISTER_NS_LONG_CONSTANT("ast", "AST_USE_TRAIT", ZEND_AST_USE_TRAIT, CONST_CS | CONST_PERSISTENT);
 	REGISTER_NS_LONG_CONSTANT("ast", "AST_TRAIT_PRECEDENCE", ZEND_AST_TRAIT_PRECEDENCE, CONST_CS | CONST_PERSISTENT);

ast_str_defs.h

@@ -35,6 +35,7 @@
 	X(default) \
 	X(cond) \
 	X(declares) \
+	X(props) \
 	X(traits) \
 	X(adaptations) \
 	X(method) \

ast_stub.php

@@ -19,6 +19,7 @@
 const AST_PARAM_LIST = 136;
 const AST_CLOSURE_USES = 137;
 const AST_PROP_DECL = 138;
+const AST_PROP_GROUP = 767;
 const AST_CONST_DECL = 139;
 const AST_CLASS_CONST_DECL = 140;
 const AST_NAME_LIST = 141;

package.xml

@@ -23,7 +23,8 @@
  </stability>
  <license uri="https://github.com/nikic/php-ast/blob/master/LICENSE">BSD-3-Clause</license>
  <notes>
-- TBD
+- Fix a segfault in PHP 7.4-dev after typed properties support was added.
+- Add AST version 70 (experimental): This adds AST_PROP_GROUP with type information for property groups.
  </notes>
  <contents>
   <dir name="/">
@@ -77,6 +78,8 @@
       <file name="parse_file_not_existing.phpt" role="test" />
       <file name="parse_file_parse_error.phpt" role="test" />
       <file name="parse_file.phpt" role="test" />
+      <file name="php74_ordinary_class.phpt" role="test" />
+      <file name="php74_type_hints.phpt" role="test" />
       <file name="prop_doc_comments.phpt" role="test" />
       <file name="stmt_list.phpt" role="test" />
       <file name="try_catch_finally.phpt" role="test" />

php_ast.h

@@ -21,6 +21,8 @@ extern zend_module_entry ast_module_entry;
 #include "TSRM.h"
 #endif
 
+// PHP 7.4 added a 3rd cache slot for property_info
+// and expects cache_slot[2] to be null.
 #define AST_NUM_CACHE_SLOTS (3 * 4)
 
 ZEND_BEGIN_MODULE_GLOBALS(ast)
@@ -47,6 +49,11 @@ extern ast_str_globals str_globals;
 #define AST_CLOSURE_VAR   2049
 #define AST_NULLABLE_TYPE 2050
 
+// 544 is already taken by ZEND_AST_GROUP_USE
+#if PHP_VERSION_ID < 70400
+# define ZEND_AST_PROP_GROUP 0x2ff
+#endif
+
 /* Pretend it still exists */
 #if PHP_VERSION_ID >= 70100
 # define ZEND_AST_LIST ((1 << (ZEND_AST_IS_LIST_SHIFT + 1)) - 1)

scripts/generate_ast_data.php

@@ -6,12 +6,12 @@
 $code = <<<EOC
 #include "php_ast.h"
 
-const size_t ast_kinds_count = {COUNT};
-
 const zend_ast_kind ast_kinds[] = {
 {KINDS}
 };
 
+const size_t ast_kinds_count = sizeof(ast_kinds) / sizeof(ast_kinds[0]);
+
 const char *ast_kind_to_name(zend_ast_kind kind) {
 \tswitch (kind) {
 {STRS}
@@ -117,6 +117,7 @@
     'ZEND_AST_SWITCH_CASE' => ['cond', 'stmts'],
     'ZEND_AST_DECLARE' => ['declares', 'stmts'],
     'ZEND_AST_PROP_ELEM' => ['name', 'default', 'docComment'],
+    'ZEND_AST_PROP_GROUP' => ['type', 'props'],
     'ZEND_AST_CONST_ELEM' => ['name', 'value', 'docComment'],
     'ZEND_AST_USE_TRAIT' => ['traits', 'adaptations'],
     'ZEND_AST_TRAIT_PRECEDENCE' => ['method', 'insteadof'],
@@ -210,7 +211,6 @@
         . " CONST_CS | CONST_PERSISTENT);";
 }
 
-$code = str_replace('{COUNT}', count($data), $code);
 $code = str_replace('{KINDS}', implode("\n", $kinds), $code);
 $code = str_replace('{STRS}', implode("\n", $strs), $code);
 $code = str_replace('{CONSTS}', implode("\n", $consts), $code);

scripts/generate_ast_stub.php

@@ -1,6 +1,10 @@
 <?php
 
 $stubFile = __DIR__ . '/../ast_stub.php';
+if (!extension_loaded('ast')) {
+    fwrite(STDERR, __FILE__ . " requires that php-ast be enabled\n");
+    exit(1);
+}
 
 $stub = file_get_contents($stubFile);
 $stub = preg_replace_callback(

tests/get_supported_versions.phpt

@@ -8,15 +8,19 @@ var_dump(ast\get_supported_versions(true));
 
 ?>
 --EXPECT--
-array(2) {
+array(3) {
   [0]=>
   int(50)
   [1]=>
   int(60)
+  [2]=>
+  int(70)
 }
-array(2) {
+array(3) {
   [0]=>
   int(50)
   [1]=>
   int(60)
+  [2]=>
+  int(70)
 }