Support parsing php 8.1 enum doc comments

Requires php/php-src#6984
(php 8.1 has no public alphas yet)

Author: TysonAndre

ast_data.c

@@ -97,7 +97,6 @@ const zend_ast_kind ast_kinds[] = {
 	ZEND_AST_MATCH,
 	ZEND_AST_MATCH_ARM,
 	ZEND_AST_NAMED_ARG,
-	ZEND_AST_ENUM_CASE,
 	ZEND_AST_METHOD_CALL,
 	ZEND_AST_NULLSAFE_METHOD_CALL,
 	ZEND_AST_STATIC_CALL,
@@ -106,6 +105,7 @@ const zend_ast_kind ast_kinds[] = {
 	ZEND_AST_CATCH,
 	ZEND_AST_FOR,
 	ZEND_AST_FOREACH,
+	ZEND_AST_ENUM_CASE,
 	ZEND_AST_PARAM,
 };
 
@@ -209,7 +209,6 @@ const char *ast_kind_to_name(zend_ast_kind kind) {
 		case ZEND_AST_MATCH: return "AST_MATCH";
 		case ZEND_AST_MATCH_ARM: return "AST_MATCH_ARM";
 		case ZEND_AST_NAMED_ARG: return "AST_NAMED_ARG";
-		case ZEND_AST_ENUM_CASE: return "AST_ENUM_CASE";
 		case ZEND_AST_METHOD_CALL: return "AST_METHOD_CALL";
 		case ZEND_AST_NULLSAFE_METHOD_CALL: return "AST_NULLSAFE_METHOD_CALL";
 		case ZEND_AST_STATIC_CALL: return "AST_STATIC_CALL";
@@ -218,6 +217,7 @@ const char *ast_kind_to_name(zend_ast_kind kind) {
 		case ZEND_AST_CATCH: return "AST_CATCH";
 		case ZEND_AST_FOR: return "AST_FOR";
 		case ZEND_AST_FOREACH: return "AST_FOREACH";
+		case ZEND_AST_ENUM_CASE: return "AST_ENUM_CASE";
 		case ZEND_AST_PARAM: return "AST_PARAM";
 	}
 
@@ -654,13 +654,6 @@ zend_string *ast_kind_child_name(zend_ast_kind kind, uint32_t child) {
 				case 1: return AST_STR(str_expr);
 			}
 			return NULL;
-		case ZEND_AST_ENUM_CASE:
-			switch (child) {
-				case 0: return AST_STR(str_name);
-				case 1: return AST_STR(str_expr);
-				case 2: return AST_STR(str_attributes);
-			}
-			return NULL;
 		case ZEND_AST_METHOD_CALL:
 			switch (child) {
 				case 0: return AST_STR(str_expr);
@@ -719,6 +712,14 @@ 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_ENUM_CASE:
+			switch (child) {
+				case 0: return AST_STR(str_name);
+				case 1: return AST_STR(str_expr);
+				case 2: return AST_STR(str_docComment);
+				case 3: return AST_STR(str_attributes);
+			}
+			return NULL;
 		case ZEND_AST_PARAM:
 			switch (child) {
 				case 0: return AST_STR(str_type);
@@ -830,7 +831,6 @@ void ast_register_kind_constants(INIT_FUNC_ARGS) {
 	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_NAMED_ARG", ZEND_AST_NAMED_ARG, CONST_CS | CONST_PERSISTENT);
-	REGISTER_NS_LONG_CONSTANT("ast", "AST_ENUM_CASE", ZEND_AST_ENUM_CASE, 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_NULLSAFE_METHOD_CALL", ZEND_AST_NULLSAFE_METHOD_CALL, CONST_CS | CONST_PERSISTENT);
 	REGISTER_NS_LONG_CONSTANT("ast", "AST_STATIC_CALL", ZEND_AST_STATIC_CALL, CONST_CS | CONST_PERSISTENT);
@@ -839,5 +839,6 @@ void ast_register_kind_constants(INIT_FUNC_ARGS) {
 	REGISTER_NS_LONG_CONSTANT("ast", "AST_CATCH", ZEND_AST_CATCH, 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_ENUM_CASE", ZEND_AST_ENUM_CASE, CONST_CS | CONST_PERSISTENT);
 	REGISTER_NS_LONG_CONSTANT("ast", "AST_PARAM", ZEND_AST_PARAM, CONST_CS | CONST_PERSISTENT);
 }

ast_stub.php

@@ -103,7 +103,6 @@
 const AST_MATCH = 548;
 const AST_MATCH_ARM = 549;
 const AST_NAMED_ARG = 550;
-const AST_ENUM_CASE = 777;
 const AST_METHOD_CALL = 768;
 const AST_NULLSAFE_METHOD_CALL = 769;
 const AST_STATIC_CALL = 770;
@@ -112,6 +111,7 @@
 const AST_CATCH = 773;
 const AST_FOR = 1024;
 const AST_FOREACH = 1025;
+const AST_ENUM_CASE = 1026;
 const AST_PARAM = 1280;
 // END AST KIND CONSTANTS
 

scripts/generate_ast_data.php

@@ -134,7 +134,6 @@
     'ZEND_AST_MATCH' => ['cond', 'stmts'],
     'ZEND_AST_MATCH_ARM' => ['cond', 'expr'],
     'ZEND_AST_NAMED_ARG' => ['name', 'expr'],
-    'ZEND_AST_ENUM_CASE' => ['name', 'expr', 'attributes'],
 
     /* 3 child nodes */
     'ZEND_AST_METHOD_CALL' => ['expr', 'method', 'args'],
@@ -148,6 +147,7 @@
     /* 4 child nodes */
     'ZEND_AST_FOR' => ['init', 'cond', 'loop', 'stmts'],
     'ZEND_AST_FOREACH' => ['expr', 'value', 'key', 'stmts'],
+    'ZEND_AST_ENUM_CASE' => ['name', 'expr', 'docComment', 'attributes'],
 
     /* 5 child nodes */
     'ZEND_AST_PARAM' => ['type', 'name', 'default', 'attributes', 'docComment'],

tests/php81_enums.phpt

@@ -16,6 +16,7 @@ enum HasValue: int {
 
 #[MyAttribute(1)]
 enum NoValue {
+    /** Case doc comment */
     #[OtherAttribute()]
     case FOO;
 }
@@ -39,6 +40,7 @@ AST_STMT_LIST
             0: AST_ENUM_CASE
                 name: "FOO"
                 expr: 42
+                docComment: null
                 attributes: null
             1: AST_CLASS_CONST_DECL
                 flags: MODIFIER_PUBLIC (%d)
@@ -61,6 +63,7 @@ AST_STMT_LIST
             0: AST_ENUM_CASE
                 name: "FOO"
                 expr: null
+                docComment: "/** Case doc comment */"
                 attributes: AST_ATTRIBUTE_LIST
                     0: AST_ATTRIBUTE_GROUP
                         0: AST_ATTRIBUTE
@@ -80,6 +83,7 @@ AST_STMT_LIST
             0: AST_ENUM_CASE
                 name: "FOO"
                 expr: 42
+                docComment: null
                 attributes: null
             1: AST_CLASS_CONST_GROUP
                 flags: MODIFIER_PUBLIC (%d)
@@ -106,6 +110,7 @@ AST_STMT_LIST
             0: AST_ENUM_CASE
                 name: "FOO"
                 expr: null
+                docComment: "/** Case doc comment */"
                 attributes: AST_ATTRIBUTE_LIST
                     0: AST_ATTRIBUTE_GROUP
                         0: AST_ATTRIBUTE
@@ -133,6 +138,7 @@ AST_STMT_LIST
             0: AST_ENUM_CASE
                 name: "FOO"
                 expr: 42
+                docComment: null
                 attributes: null
             1: AST_CLASS_CONST_GROUP
                 flags: MODIFIER_PUBLIC (%d)
@@ -161,6 +167,7 @@ AST_STMT_LIST
             0: AST_ENUM_CASE
                 name: "FOO"
                 expr: null
+                docComment: "/** Case doc comment */"
                 attributes: AST_ATTRIBUTE_LIST
                     0: AST_ATTRIBUTE_GROUP
                         0: AST_ATTRIBUTE