Preserve doc comment on promoted property

nikic · nikic · commit abc2cdfdcb59 · 2020-06-05T11:12:46.000+02:00
diff --git a/Zend/zend_ast.h b/Zend/zend_ast.h
@@ -156,7 +156,9 @@ enum _zend_ast_kind {
 	/* 4 child nodes */
 	ZEND_AST_FOR = 4 << ZEND_AST_NUM_CHILDREN_SHIFT,
 	ZEND_AST_FOREACH,
-	ZEND_AST_PARAM,
+
+	/* 5 child nodes */
+	ZEND_AST_PARAM = 5 << ZEND_AST_NUM_CHILDREN_SHIFT,
 };
 
 typedef uint16_t zend_ast_kind;
diff --git a/Zend/zend_compile.c b/Zend/zend_compile.c
@@ -5787,6 +5787,7 @@ void zend_compile_params(zend_ast *ast, zend_ast *return_type_ast, uint32_t fall
 		zend_ast *var_ast = param_ast->child[1];
 		zend_ast *default_ast = param_ast->child[2];
 		zend_ast *attributes_ast = param_ast->child[3];
+		zend_ast *doc_comment_ast = param_ast->child[4];
 		zend_string *name = zval_make_interned_string(zend_ast_get_zval(var_ast));
 		zend_bool is_ref = (param_ast->attr & ZEND_PARAM_REF) != 0;
 		zend_bool is_variadic = (param_ast->attr & ZEND_PARAM_VARIADIC) != 0;
@@ -5938,8 +5939,10 @@ void zend_compile_params(zend_ast *ast, zend_ast *return_type_ast, uint32_t fall
 				type = zend_compile_typename(type_ast, /* force_allow_null */ 0, /* use_arena */ 1);
 			}
 
+			zend_string *doc_comment =
+				doc_comment_ast ? zend_string_copy(zend_ast_get_str(doc_comment_ast)) : NULL;
 			zend_declare_typed_property(
-				scope, name, &default_value, visibility, /* doc_comment */ NULL, type);
+				scope, name, &default_value, visibility, doc_comment, type);
 		}
 	}
 
diff --git a/Zend/zend_language_parser.y b/Zend/zend_language_parser.y
@@ -693,11 +693,13 @@ optional_visibility_modifier:
 
 parameter:
 		optional_visibility_modifier optional_type_without_static
-		is_reference is_variadic T_VARIABLE
-			{ $$ = zend_ast_create_ex(ZEND_AST_PARAM, $1 | $3 | $4, $2, $5, NULL); }
+		is_reference is_variadic T_VARIABLE backup_doc_comment
+			{ $$ = zend_ast_create_ex(ZEND_AST_PARAM, $1 | $3 | $4, $2, $5, NULL,
+					NULL, $6 ? zend_ast_create_zval_from_str($6) : NULL); }
 	|	optional_visibility_modifier optional_type_without_static
-		is_reference is_variadic T_VARIABLE '=' expr
-			{ $$ = zend_ast_create_ex(ZEND_AST_PARAM, $1 | $3 | $4, $2, $5, $7); }
+		is_reference is_variadic T_VARIABLE backup_doc_comment '=' expr
+			{ $$ = zend_ast_create_ex(ZEND_AST_PARAM, $1 | $3 | $4, $2, $5, $8,
+					NULL, $6 ? zend_ast_create_zval_from_str($6) : NULL); }
 ;
 
 
diff --git a/ext/reflection/tests/constructor_promotion.phpt b/ext/reflection/tests/constructor_promotion.phpt
@@ -48,4 +48,4 @@ Class [ <user> class Test ] {
   }
 }
 
-bool(false)
+string(24) "/** @SomeAnnotation() */"

Original file line number	Diff line number	Diff line change
`@@ -5787,6 +5787,7 @@ void zend_compile_params(zend_ast ast, zend_ast return_type_ast, uint32_t fall`
`5787`	`5787`	`zend_ast *var_ast = param_ast->child[1];`
`5788`	`5788`	`zend_ast *default_ast = param_ast->child[2];`
`5789`	`5789`	`zend_ast *attributes_ast = param_ast->child[3];`
	`5790`	`+ zend_ast *doc_comment_ast = param_ast->child[4];`
`5790`	`5791`	`zend_string *name = zval_make_interned_string(zend_ast_get_zval(var_ast));`
`5791`	`5792`	`zend_bool is_ref = (param_ast->attr & ZEND_PARAM_REF) != 0;`
`5792`	`5793`	`zend_bool is_variadic = (param_ast->attr & ZEND_PARAM_VARIADIC) != 0;`
`@@ -5938,8 +5939,10 @@ void zend_compile_params(zend_ast ast, zend_ast return_type_ast, uint32_t fall`
`5938`	`5939`	`type = zend_compile_typename(type_ast, /* force_allow_null / 0, / use_arena */ 1);`
`5939`	`5940`	`}`
`5940`	`5941`
	`5942`	`+ zend_string *doc_comment =`
	`5943`	`+ doc_comment_ast ? zend_string_copy(zend_ast_get_str(doc_comment_ast)) : NULL;`
`5941`	`5944`	`zend_declare_typed_property(`
`5942`		`- scope, name, &default_value, visibility, /* doc_comment */ NULL, type);`
	`5945`	`+ scope, name, &default_value, visibility, doc_comment, type);`
`5943`	`5946`	`}`
`5944`	`5947`	`}`
`5945`	`5948`
Original file line number	Diff line number	Diff line change
`@@ -48,4 +48,4 @@ Class [ <user> class Test ] {`
`48`	`48`	`}`
`49`	`49`	`}`
`50`	`50`
`51`		`-bool(false)`
	`51`	`+string(24) "/** @SomeAnnotation() */"`