Allow defining Closures in const-expr

TimWolla · TimWolla · commit 9c29baf1c3b4 · 2024-10-16T16:07:15.000+02:00
Most notably this allows to use Closures as Attribute parameters.
diff --git a/Zend/tests/closure_const_expr/attributes.phpt b/Zend/tests/closure_const_expr/attributes.phpt
@@ -0,0 +1,59 @@
+--TEST--
+Allow defining closures in attributes
+--EXTENSIONS--
+reflection
+--FILE--
+<?php
+
+#[Attribute(Attribute::TARGET_CLASS | Attribute::IS_REPEATABLE)]
+class Attr {
+    public function __construct(public Closure $value) {
+      $value('foo');
+    }
+}
+
+#[Attr(function () {
+
+})]
+#[Attr(function (...$args) {
+  var_dump($args);
+})]
+class C {}
+
+foreach ((new ReflectionClass(C::class))->getAttributes() as $reflectionAttribute) {
+    var_dump($reflectionAttribute->newInstance());
+}
+
+?>
+--EXPECTF--
+object(Attr)#%d (1) {
+  ["value"]=>
+  object(Closure)#%d (3) {
+    ["name"]=>
+    string(%d) "{closure:%s:%d}"
+    ["file"]=>
+    string(%d) "%s"
+    ["line"]=>
+    int(%d)
+  }
+}
+array(1) {
+  [0]=>
+  string(3) "foo"
+}
+object(Attr)#%d (1) {
+  ["value"]=>
+  object(Closure)#%d (4) {
+    ["name"]=>
+    string(%d) "{closure:%s:%d}"
+    ["file"]=>
+    string(%d) "%s"
+    ["line"]=>
+    int(%d)
+    ["parameter"]=>
+    array(1) {
+      ["$args"]=>
+      string(10) "<optional>"
+    }
+  }
+}
diff --git a/Zend/tests/closure_const_expr/basic.phpt b/Zend/tests/closure_const_expr/basic.phpt
@@ -0,0 +1,23 @@
+--TEST--
+Allow defining Closures in const expressions.
+--FILE--
+<?php
+
+const Closure = function () {
+    echo "called", PHP_EOL;
+};
+
+var_dump(Closure);
+(Closure)();
+
+?>
+--EXPECTF--
+object(Closure)#%d (3) {
+  ["name"]=>
+  string(%d) "{closure:%s:%d}"
+  ["file"]=>
+  string(%d) "%s"
+  ["line"]=>
+  int(3)
+}
+called
diff --git a/Zend/tests/closure_const_expr/class_const.phpt b/Zend/tests/closure_const_expr/class_const.phpt
@@ -0,0 +1,25 @@
+--TEST--
+Allow defining Closures in class constants.
+--FILE--
+<?php
+
+class C {
+    const Closure = function () {
+        echo "called", PHP_EOL;
+    };
+}
+
+var_dump(C::Closure);
+(C::Closure)();
+
+?>
+--EXPECTF--
+object(Closure)#%d (3) {
+  ["name"]=>
+  string(%d) "{closure:%s:%d}"
+  ["file"]=>
+  string(%d) "%s"
+  ["line"]=>
+  int(4)
+}
+called
diff --git a/Zend/tests/closure_const_expr/default_args.phpt b/Zend/tests/closure_const_expr/default_args.phpt
@@ -0,0 +1,22 @@
+--TEST--
+Closures in default argument
+--FILE--
+<?php
+
+function test(
+    Closure $name = function () {
+        echo "default", PHP_EOL;
+    },
+) {
+    $name();
+}
+
+test();
+test(function () {
+    echo "explicit", PHP_EOL;
+});
+
+?>
+--EXPECT--
+default
+explicit
diff --git a/Zend/tests/closure_const_expr/disallows_using_variables.phpt b/Zend/tests/closure_const_expr/disallows_using_variables.phpt
@@ -0,0 +1,17 @@
+--TEST--
+Disallows using variables.
+--FILE--
+<?php
+
+$foo = "bar";
+
+const Closure = function () use ($foo) {
+    echo $foo, PHP_EOL;
+};
+
+var_dump(Closure);
+(Closure)();
+
+?>
+--EXPECTF--
+Fatal error: Cannot use(...) variables in constant expression in %s on line %d
diff --git a/Zend/tests/closure_const_expr/property_initializer.phpt b/Zend/tests/closure_const_expr/property_initializer.phpt
@@ -0,0 +1,27 @@
+--TEST--
+Closure in property initializer
+--FILE--
+<?php
+
+class C {
+    public Closure $d = function () {
+        echo "called", PHP_EOL;
+    };
+}
+
+$c = new C();
+var_dump($c->d);
+($c->d)();
+
+
+?>
+--EXPECTF--
+object(Closure)#%d (3) {
+  ["name"]=>
+  string(%d) "{closure:%s:%d}"
+  ["file"]=>
+  string(%d) "%s"
+  ["line"]=>
+  int(4)
+}
+called
diff --git a/Zend/tests/closure_const_expr/static_initalizer.phpt b/Zend/tests/closure_const_expr/static_initalizer.phpt
@@ -0,0 +1,27 @@
+--TEST--
+Closure in static initializer
+--FILE--
+<?php
+
+function foo() {
+    static $closure = function () {
+        echo "called", PHP_EOL;
+    };
+
+    var_dump($closure);
+    $closure();
+}
+
+foo();
+
+?>
+--EXPECTF--
+object(Closure)#%d (3) {
+  ["name"]=>
+  string(17) "{closure:foo():4}"
+  ["file"]=>
+  string(%d) "%s"
+  ["line"]=>
+  int(4)
+}
+called
diff --git a/Zend/tests/closure_const_expr/static_property_initializer.phpt b/Zend/tests/closure_const_expr/static_property_initializer.phpt
@@ -0,0 +1,26 @@
+--TEST--
+Closure in static property initializer
+--FILE--
+<?php
+
+class C {
+    public static Closure $d = function () {
+        echo "called", PHP_EOL;
+    };
+}
+
+var_dump(C::$d);
+(C::$d)();
+
+
+?>
+--EXPECTF--
+object(Closure)#%d (3) {
+  ["name"]=>
+  string(%d) "{closure:%s:%d}"
+  ["file"]=>
+  string(%d) "%s"
+  ["line"]=>
+  int(4)
+}
+called
diff --git a/Zend/zend_ast.c b/Zend/zend_ast.c
@@ -564,6 +564,8 @@ ZEND_API zend_result ZEND_FASTCALL zend_ast_evaluate_ex(
 	return r;
 }
 
+#include "Zend/zend_closures.h"
+
 ZEND_API zend_result ZEND_FASTCALL zend_ast_evaluate_inner(
 	zval *result,
 	zend_ast *ast,
@@ -989,6 +991,14 @@ ZEND_API zend_result ZEND_FASTCALL zend_ast_evaluate_inner(
 			}
 			return SUCCESS;
 		}
+		case ZEND_AST_CLOSURE_CONSTEXPR:
+		{
+			zend_ast *child = ast->child[0];
+			zval *z = zend_ast_get_zval(child);
+
+			zend_create_closure(result, Z_PTR_P(z), NULL, NULL, NULL);
+			return SUCCESS;	
+		}
 		case ZEND_AST_PROP:
 		case ZEND_AST_NULLSAFE_PROP:
 		{
diff --git a/Zend/zend_ast.h b/Zend/zend_ast.h
@@ -111,6 +111,8 @@ enum _zend_ast_kind {
 	ZEND_AST_CONTINUE,
 	ZEND_AST_PROPERTY_HOOK_SHORT_BODY,
 
+	ZEND_AST_CLOSURE_CONSTEXPR,
+
 	/* 2 child nodes */
 	ZEND_AST_DIM = 2 << ZEND_AST_NUM_CHILDREN_SHIFT,
 	ZEND_AST_PROP,
diff --git a/Zend/zend_compile.c b/Zend/zend_compile.c
@@ -11030,7 +11030,8 @@ static bool zend_is_allowed_in_const_expr(zend_ast_kind kind) /* {{{ */
 		|| kind == ZEND_AST_CONST_ENUM_INIT
 		|| kind == ZEND_AST_NEW || kind == ZEND_AST_ARG_LIST
 		|| kind == ZEND_AST_NAMED_ARG
-		|| kind == ZEND_AST_PROP || kind == ZEND_AST_NULLSAFE_PROP;
+		|| kind == ZEND_AST_PROP || kind == ZEND_AST_NULLSAFE_PROP
+		|| kind == ZEND_AST_CLOSURE;
 }
 /* }}} */
 
@@ -11164,6 +11165,24 @@ static void zend_compile_const_expr_new(zend_ast **ast_ptr)
 	class_ast->attr = fetch_type << ZEND_CONST_EXPR_NEW_FETCH_TYPE_SHIFT;
 }
 
+static void zend_compile_const_expr_closure(zend_ast **ast_ptr)
+{
+	zend_ast_decl *closure_ast = (zend_ast_decl *) *ast_ptr;
+	zend_ast *uses_ast = closure_ast->child[1];
+	if (uses_ast) {
+		zend_error_noreturn(E_COMPILE_ERROR,
+			"Cannot use(...) variables in constant expression");
+	}
+
+	znode node;
+	zend_op_array *op = zend_compile_func_decl(&node, *ast_ptr, 1);
+
+	zend_ast_destroy(*ast_ptr);
+	zval z;
+	ZVAL_PTR(&z, op);
+	*ast_ptr = zend_ast_create(ZEND_AST_CLOSURE_CONSTEXPR, zend_ast_create_zval(&z));
+}
+
 static void zend_compile_const_expr_args(zend_ast **ast_ptr)
 {
 	zend_ast_list *list = zend_ast_get_list(*ast_ptr);
@@ -11226,6 +11245,9 @@ static void zend_compile_const_expr(zend_ast **ast_ptr, void *context) /* {{{ */
 		case ZEND_AST_ARG_LIST:
 			zend_compile_const_expr_args(ast_ptr);
 			break;
+		case ZEND_AST_CLOSURE:
+			zend_compile_const_expr_closure(ast_ptr);
+			break;
 	}
 
 	zend_ast_apply(ast, zend_compile_const_expr, context);

Original file line number	Diff line number	Diff line change
`@@ -564,6 +564,8 @@ ZEND_API zend_result ZEND_FASTCALL zend_ast_evaluate_ex(`
`564`	`564`	`return r;`
`565`	`565`	`}`
`566`	`566`
	`567`	`+#include "Zend/zend_closures.h"`
	`568`	`+`
`567`	`569`	`ZEND_API zend_result ZEND_FASTCALL zend_ast_evaluate_inner(`
`568`	`570`	`zval *result,`
`569`	`571`	`zend_ast *ast,`
`@@ -989,6 +991,14 @@ ZEND_API zend_result ZEND_FASTCALL zend_ast_evaluate_inner(`
`989`	`991`	`}`
`990`	`992`	`return SUCCESS;`
`991`	`993`	`}`
	`994`	`+ case ZEND_AST_CLOSURE_CONSTEXPR:`
	`995`	`+ {`
	`996`	`+ zend_ast *child = ast->child[0];`
	`997`	`+ zval *z = zend_ast_get_zval(child);`
	`998`	`+`
	`999`	`+ zend_create_closure(result, Z_PTR_P(z), NULL, NULL, NULL);`
	`1000`	`+ return SUCCESS;`
	`1001`	`+ }`
`992`	`1002`	`case ZEND_AST_PROP:`
`993`	`1003`	`case ZEND_AST_NULLSAFE_PROP:`
`994`	`1004`	`{`