Support php 8.0 "Constructor Promotion" and attributes

Because AST_CLASS_CONST_DECL is a list of nodes, don't add the key
"attributes" to the hash table in older AST versions.

Add visibility modifiers to AST_PARAM, but only in php 8.0+.
MODIFIER_PUBLIC and PARAM_REF are the same value in php 7.4.

Author: TysonAndre

.travis.yml

@@ -9,6 +9,10 @@ php:
   - 7.4
   - nightly
 
+matrix:
+  allow_failures:
+    - php: master
+
 before_script:
   - phpize
   - ./configure

README.md

@@ -253,9 +253,12 @@ ast\flags\CLASS_TRAIT
 ast\flags\CLASS_INTERFACE
 ast\flags\CLASS_ANONYMOUS
 
-// Used by ast\AST_PARAM (cominable)
+// Used by ast\AST_PARAM (combinable)
 ast\flags\PARAM_REF
 ast\flags\PARAM_VARIADIC
+ast\flags\MODIFIER_PUBLIC
+ast\flags\MODIFIER_PROTECTED
+ast\flags\MODIFIER_PRIVATE
 
 // Used by ast\AST_TYPE (exclusive)
 ast\flags\TYPE_ARRAY
@@ -361,20 +364,22 @@ This section lists the AST node kinds that are supported and the names of their
 
 ```
 AST_ARRAY_ELEM:       value, key
-AST_ARROW_FUNC:       name, docComment, params, stmts, returnType
+AST_ARROW_FUNC:       name, docComment, params, stmts, returnType, attributes
 AST_ASSIGN:           var, expr
 AST_ASSIGN_OP:        var, expr
 AST_ASSIGN_REF:       var, expr
+AST_ATTRIBUTE:        class, args            // php 8.0+ attributes
 AST_BINARY_OP:        left, right
 AST_BREAK:            depth
 AST_CALL:             expr, args
 AST_CAST:             expr
 AST_CATCH:            class, var, stmts
 AST_CLASS:            name, docComment, extends, implements, stmts
 AST_CLASS_CONST:      class, const
+AST_CLASS_CONST_GROUP class, attributes      // version 80+
 AST_CLASS_NAME:       class                  // version 70+
 AST_CLONE:            expr
-AST_CLOSURE:          name, docComment, params, uses, stmts, returnType
+AST_CLOSURE:          name, docComment, params, uses, stmts, returnType, attributes
 AST_CLOSURE_VAR:      name
 AST_CONDITIONAL:      cond, true, false
 AST_CONST:            name
@@ -388,7 +393,7 @@ AST_EMPTY:            expr
 AST_EXIT:             expr
 AST_FOR:              init, cond, loop, stmts
 AST_FOREACH:          expr, value, key, stmts
-AST_FUNC_DECL:        name, docComment, params, stmts, returnType
+AST_FUNC_DECL:        name, docComment, params, stmts, returnType, attributes
                       uses                   // prior to version 60
 AST_GLOBAL:           var
 AST_GOTO:             label
@@ -400,23 +405,23 @@ AST_INSTANCEOF:       expr, class
 AST_ISSET:            var
 AST_LABEL:            name
 AST_MAGIC_CONST:
-AST_METHOD:           name, docComment, params, stmts, returnType
+AST_METHOD:           name, docComment, params, stmts, returnType, attributes
                       uses                   // prior to version 60
 AST_METHOD_CALL:      expr, method, args
 AST_METHOD_REFERENCE: class, method
 AST_NAME:             name
 AST_NAMESPACE:        name, stmts
 AST_NEW:              class, args
 AST_NULLABLE_TYPE:    type                   // Used only since PHP 7.1
-AST_PARAM:            type, name, default
+AST_PARAM:            type, name, default, attributes, docComment
 AST_POST_DEC:         var
 AST_POST_INC:         var
 AST_PRE_DEC:          var
 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_PROP_GROUP:       type, props, attributes // version 70+
 AST_REF:              var                    // only used in foreach ($a as &$v)
 AST_RETURN:           expr
 AST_SHELL_EXEC:       expr
@@ -443,6 +448,7 @@ AST_YIELD_FROM:       expr
 // List nodes (numerically indexed children):
 AST_ARG_LIST
 AST_ARRAY
+AST_ATTRIBUTE_LIST        // php 8.0+ attributes
 AST_CATCH_LIST
 AST_CLASS_CONST_DECL
 AST_CLOSURE_USES
@@ -483,6 +489,7 @@ are listed.
 Available since 1.0.7 (XXX).
 
 * `mixed` type hints are now reported as an `AST_TYPE` with type `TYPE_MIXED` instead of an `AST_NAME`.
+* `AST_CLASS_CONST_GROUP` nodes are emitted for php 8.0 class constant declarations with a `const` and an optional `attributes` node.
 
 ### 70 (current)
 

ast.c

@@ -107,6 +107,11 @@ static const char *class_flags[] = {
 static const char *param_flags[] = {
 	AST_FLAG(PARAM_REF),
 	AST_FLAG(PARAM_VARIADIC),
+#if PHP_VERSION_ID >= 80000
+	AST_FLAG(MODIFIER_PUBLIC),
+	AST_FLAG(MODIFIER_PROTECTED),
+	AST_FLAG(MODIFIER_PRIVATE),
+#endif
 	NULL
 };
 
@@ -287,6 +292,8 @@ static const ast_flag_info flag_info[] = {
 	{ ZEND_AST_CONDITIONAL, 1, conditional_flags },
 };
 
+// NOTE(tandre) in php 8, to get a writeable pointer to a property, Z_OBJ_HT_P(zv)->get_property_ptr_ptr(Z_OBJ_P(zv), AST_STR(str_propname), BP_VAR_RW, AST_CACHE_SLOT_PROPNAME); can be used.
+
 static inline void ast_update_property(zval *object, zend_string *name, zval *value, void **cache_slot) {
 #if PHP_VERSION_ID < 80000
 	zval name_zv;
@@ -368,7 +375,7 @@ static inline zend_bool ast_is_name(zend_ast *ast, zend_ast *parent, uint32_t i)
 		return 1;
 	}
 #if PHP_VERSION_ID >= 80000
-	if (parent->kind == ZEND_AST_TYPE_UNION) {
+	if (parent->kind == ZEND_AST_TYPE_UNION || parent->kind == ZEND_AST_ATTRIBUTE) {
 		return 1;
 	}
 #endif
@@ -507,7 +514,11 @@ static inline zend_ast_attr ast_assign_op_to_binary_op(zend_ast_attr attr) {
 static inline zend_ast **ast_get_children(zend_ast *ast, uint32_t *count) {
 	if (ast_kind_is_decl(ast->kind)) {
 		zend_ast_decl *decl = (zend_ast_decl *) ast;
+#if PHP_VERSION_ID >= 80000
+		*count = decl->kind == ZEND_AST_CLASS ? 4 : 5;
+#else
 		*count = decl->kind == ZEND_AST_CLASS ? 3 : 4;
+#endif
 		return decl->child;
 	} else if (zend_ast_is_list(ast)) {
 		zend_ast_list *list = zend_ast_get_list(ast);
@@ -622,6 +633,23 @@ static void ast_fill_children_ht(HashTable *ht, zend_ast *ast, ast_state_info_t
 			}
 		}
 
+#if PHP_VERSION_ID >= 80000
+		if (child == NULL) {
+			if (i == 4) {
+				if (ast_kind == ZEND_AST_PARAM || ast_kind == ZEND_AST_METHOD || ast_kind == ZEND_AST_FUNC_DECL || ast_kind == ZEND_AST_CLOSURE || ast_kind == ZEND_AST_ARROW_FUNC) {
+					continue;
+				}
+			} else if (i == 3) {
+				if (ast_kind == ZEND_AST_PARAM || ast_kind == ZEND_AST_CLASS) {
+					continue;
+				}
+			} else if (i == 2) {
+				if (ast_kind == ZEND_AST_PROP_GROUP) {
+					continue;
+				}
+			}
+		}
+#endif
 		/* This AST_CATCH check should occur before ast_is_name() */
 #if PHP_VERSION_ID < 70100
 		if (ast_kind == ZEND_AST_CATCH && i == 0) {
@@ -755,6 +783,15 @@ 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 >= 80000
+		case ZEND_AST_CLASS_CONST_GROUP:
+			// 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_to_zval(zv, ast->child[0], state);
+				return;
+			}
+#endif
 #if PHP_VERSION_ID >= 70400
 		case ZEND_AST_PROP_GROUP:
 			if (state->version < 70) {
@@ -884,6 +921,16 @@ static void ast_to_zval(zval *zv, zend_ast *ast, ast_state_info_t *state) {
 		ast_update_property_long(&prop_group_zval, AST_STR(str_flags), 0, AST_CACHE_SLOT_FLAGS);
 	}
 #endif
+#if PHP_VERSION_ID < 80000
+	if (ast->kind == ZEND_AST_CLASS_CONST_DECL && state->version >= 80) {
+		zval const_decl_zval = *zv;
+		zval attributes_zval = *zv;
+		ZVAL_NULL(&attributes_zval);
+		// 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);
+	}
+#endif
 }
 
 static const zend_long versions[] = {50, 60, 70, 80};

ast_data.c

@@ -19,6 +19,7 @@ const zend_ast_kind ast_kinds[] = {
 	ZEND_AST_TRAIT_ADAPTATIONS,
 	ZEND_AST_USE,
 	ZEND_AST_TYPE_UNION,
+	ZEND_AST_ATTRIBUTE_LIST,
 	AST_NAME,
 	AST_CLOSURE_VAR,
 	AST_NULLABLE_TYPE,
@@ -58,6 +59,7 @@ const zend_ast_kind ast_kinds[] = {
 	ZEND_AST_BREAK,
 	ZEND_AST_CONTINUE,
 	ZEND_AST_CLASS_NAME,
+	ZEND_AST_CLASS_CONST_GROUP,
 	ZEND_AST_DIM,
 	ZEND_AST_PROP,
 	ZEND_AST_STATIC_PROP,
@@ -88,14 +90,15 @@ const zend_ast_kind ast_kinds[] = {
 	ZEND_AST_USE_ELEM,
 	ZEND_AST_TRAIT_ALIAS,
 	ZEND_AST_GROUP_USE,
+	ZEND_AST_ATTRIBUTE,
 	ZEND_AST_METHOD_CALL,
 	ZEND_AST_STATIC_CALL,
 	ZEND_AST_CONDITIONAL,
 	ZEND_AST_TRY,
 	ZEND_AST_CATCH,
-	ZEND_AST_PARAM,
 	ZEND_AST_FOR,
 	ZEND_AST_FOREACH,
+	ZEND_AST_PARAM,
 };
 
 const size_t ast_kinds_count = sizeof(ast_kinds) / sizeof(ast_kinds[0]);
@@ -120,6 +123,7 @@ const char *ast_kind_to_name(zend_ast_kind kind) {
 		case ZEND_AST_TRAIT_ADAPTATIONS: return "AST_TRAIT_ADAPTATIONS";
 		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 AST_NAME: return "AST_NAME";
 		case AST_CLOSURE_VAR: return "AST_CLOSURE_VAR";
 		case AST_NULLABLE_TYPE: return "AST_NULLABLE_TYPE";
@@ -159,6 +163,7 @@ const char *ast_kind_to_name(zend_ast_kind kind) {
 		case ZEND_AST_BREAK: return "AST_BREAK";
 		case ZEND_AST_CONTINUE: return "AST_CONTINUE";
 		case ZEND_AST_CLASS_NAME: return "AST_CLASS_NAME";
+		case ZEND_AST_CLASS_CONST_GROUP: return "AST_CLASS_CONST_GROUP";
 		case ZEND_AST_DIM: return "AST_DIM";
 		case ZEND_AST_PROP: return "AST_PROP";
 		case ZEND_AST_STATIC_PROP: return "AST_STATIC_PROP";
@@ -189,14 +194,15 @@ const char *ast_kind_to_name(zend_ast_kind kind) {
 		case ZEND_AST_USE_ELEM: return "AST_USE_ELEM";
 		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_METHOD_CALL: return "AST_METHOD_CALL";
 		case ZEND_AST_STATIC_CALL: return "AST_STATIC_CALL";
 		case ZEND_AST_CONDITIONAL: return "AST_CONDITIONAL";
 		case ZEND_AST_TRY: return "AST_TRY";
 		case ZEND_AST_CATCH: return "AST_CATCH";
-		case ZEND_AST_PARAM: return "AST_PARAM";
 		case ZEND_AST_FOR: return "AST_FOR";
 		case ZEND_AST_FOREACH: return "AST_FOREACH";
+		case ZEND_AST_PARAM: return "AST_PARAM";
 	}
 
 	return NULL;
@@ -225,6 +231,7 @@ zend_string *ast_kind_child_name(zend_ast_kind kind, uint32_t child) {
 				case 1: return AST_STR(str_uses);
 				case 2: return AST_STR(str_stmts);
 				case 3: return AST_STR(str_returnType);
+				case 4: return AST_STR(str_attributes);
 			}
 			return NULL;
 		case ZEND_AST_CLOSURE:
@@ -233,6 +240,7 @@ zend_string *ast_kind_child_name(zend_ast_kind kind, uint32_t child) {
 				case 1: return AST_STR(str_uses);
 				case 2: return AST_STR(str_stmts);
 				case 3: return AST_STR(str_returnType);
+				case 4: return AST_STR(str_attributes);
 			}
 			return NULL;
 		case ZEND_AST_METHOD:
@@ -241,6 +249,7 @@ zend_string *ast_kind_child_name(zend_ast_kind kind, uint32_t child) {
 				case 1: return AST_STR(str_uses);
 				case 2: return AST_STR(str_stmts);
 				case 3: return AST_STR(str_returnType);
+				case 4: return AST_STR(str_attributes);
 			}
 			return NULL;
 		case ZEND_AST_ARROW_FUNC:
@@ -249,6 +258,7 @@ zend_string *ast_kind_child_name(zend_ast_kind kind, uint32_t child) {
 				case 1: return AST_STR(str_uses);
 				case 2: return AST_STR(str_stmts);
 				case 3: return AST_STR(str_returnType);
+				case 4: return AST_STR(str_attributes);
 			}
 			return NULL;
 		case ZEND_AST_CLASS:
@@ -407,6 +417,12 @@ zend_string *ast_kind_child_name(zend_ast_kind kind, uint32_t child) {
 				case 0: return AST_STR(str_class);
 			}
 			return NULL;
+		case ZEND_AST_CLASS_CONST_GROUP:
+			switch (child) {
+				case 0: return AST_STR(str_const);
+				case 1: return AST_STR(str_attributes);
+			}
+			return NULL;
 		case ZEND_AST_DIM:
 			switch (child) {
 				case 0: return AST_STR(str_expr);
@@ -589,6 +605,12 @@ zend_string *ast_kind_child_name(zend_ast_kind kind, uint32_t child) {
 				case 1: return AST_STR(str_uses);
 			}
 			return NULL;
+		case ZEND_AST_ATTRIBUTE:
+			switch (child) {
+				case 0: return AST_STR(str_class);
+				case 1: return AST_STR(str_args);
+			}
+			return NULL;
 		case ZEND_AST_METHOD_CALL:
 			switch (child) {
 				case 0: return AST_STR(str_expr);
@@ -624,13 +646,6 @@ zend_string *ast_kind_child_name(zend_ast_kind kind, uint32_t child) {
 				case 2: return AST_STR(str_stmts);
 			}
 			return NULL;
-		case ZEND_AST_PARAM:
-			switch (child) {
-				case 0: return AST_STR(str_type);
-				case 1: return AST_STR(str_name);
-				case 2: return AST_STR(str_default);
-			}
-			return NULL;
 		case ZEND_AST_FOR:
 			switch (child) {
 				case 0: return AST_STR(str_init);
@@ -647,6 +662,15 @@ zend_string *ast_kind_child_name(zend_ast_kind kind, uint32_t child) {
 				case 3: return AST_STR(str_stmts);
 			}
 			return NULL;
+		case ZEND_AST_PARAM:
+			switch (child) {
+				case 0: return AST_STR(str_type);
+				case 1: return AST_STR(str_name);
+				case 2: return AST_STR(str_default);
+				case 3: return AST_STR(str_attributes);
+				case 4: return AST_STR(str_docComment);
+			}
+			return NULL;
 	}
 
 	return NULL;
@@ -671,6 +695,7 @@ void ast_register_kind_constants(INIT_FUNC_ARGS) {
 	REGISTER_NS_LONG_CONSTANT("ast", "AST_TRAIT_ADAPTATIONS", ZEND_AST_TRAIT_ADAPTATIONS, CONST_CS | CONST_PERSISTENT);
 	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_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);
@@ -710,6 +735,7 @@ void ast_register_kind_constants(INIT_FUNC_ARGS) {
 	REGISTER_NS_LONG_CONSTANT("ast", "AST_BREAK", ZEND_AST_BREAK, CONST_CS | CONST_PERSISTENT);
 	REGISTER_NS_LONG_CONSTANT("ast", "AST_CONTINUE", ZEND_AST_CONTINUE, CONST_CS | CONST_PERSISTENT);
 	REGISTER_NS_LONG_CONSTANT("ast", "AST_CLASS_NAME", ZEND_AST_CLASS_NAME, CONST_CS | CONST_PERSISTENT);
+	REGISTER_NS_LONG_CONSTANT("ast", "AST_CLASS_CONST_GROUP", ZEND_AST_CLASS_CONST_GROUP, CONST_CS | CONST_PERSISTENT);
 	REGISTER_NS_LONG_CONSTANT("ast", "AST_DIM", ZEND_AST_DIM, CONST_CS | CONST_PERSISTENT);
 	REGISTER_NS_LONG_CONSTANT("ast", "AST_PROP", ZEND_AST_PROP, CONST_CS | CONST_PERSISTENT);
 	REGISTER_NS_LONG_CONSTANT("ast", "AST_STATIC_PROP", ZEND_AST_STATIC_PROP, CONST_CS | CONST_PERSISTENT);
@@ -740,12 +766,13 @@ void ast_register_kind_constants(INIT_FUNC_ARGS) {
 	REGISTER_NS_LONG_CONSTANT("ast", "AST_USE_ELEM", ZEND_AST_USE_ELEM, CONST_CS | CONST_PERSISTENT);
 	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_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);
 	REGISTER_NS_LONG_CONSTANT("ast", "AST_TRY", ZEND_AST_TRY, CONST_CS | CONST_PERSISTENT);
 	REGISTER_NS_LONG_CONSTANT("ast", "AST_CATCH", ZEND_AST_CATCH, CONST_CS | CONST_PERSISTENT);
-	REGISTER_NS_LONG_CONSTANT("ast", "AST_PARAM", ZEND_AST_PARAM, CONST_CS | CONST_PERSISTENT);
 	REGISTER_NS_LONG_CONSTANT("ast", "AST_FOR", ZEND_AST_FOR, CONST_CS | CONST_PERSISTENT);
 	REGISTER_NS_LONG_CONSTANT("ast", "AST_FOREACH", ZEND_AST_FOREACH, CONST_CS | CONST_PERSISTENT);
+	REGISTER_NS_LONG_CONSTANT("ast", "AST_PARAM", ZEND_AST_PARAM, CONST_CS | CONST_PERSISTENT);
 }