reflection: Add ReflectionGenerator::isClosed() (#14358)

* reflection: Add `ReflectionGenerator::isClosed()`

see #14167 (comment)

* Fix test expectation

* Drop `{{{` / `}}}` comments around `ReflectionGenerator::isClosed()`

Author: TimWolla

NEWS

@@ -215,6 +215,7 @@ PHP                                                                        NEWS
     (nielsdos)
   . Make ReflectionGenerator::getFunction() legal after generator termination.
     (timwolla)
+  . Added ReflectionGenerator::isClosed(). (timwolla)
 
 - SimpleXML:
   . Fixed bug GH-12192 (SimpleXML infinite loop when getName() is called

UPGRADING

@@ -286,6 +286,7 @@ PHP 8.4 UPGRADE NOTES
     now returns the attached doc comments.
   . ReflectionConstant was introduced.
   . ReflectionClassConstant::isDeprecated() was introduced.
+  . ReflectionGenerator::isClosed() was introduced.
 
 - Standard:
   . stream_bucket_make_writeable() and stream_bucket_new() will now return a

ext/reflection/php_reflection.c

@@ -2271,7 +2271,7 @@ ZEND_METHOD(ReflectionGenerator, __construct)
 
 #define REFLECTION_CHECK_VALID_GENERATOR(ex) \
 	if (!ex) { \
-		_DO_THROW("Cannot fetch information from a terminated Generator"); \
+		_DO_THROW("Cannot fetch information from a closed Generator"); \
 		RETURN_THROWS(); \
 	}
 
@@ -2403,6 +2403,18 @@ ZEND_METHOD(ReflectionGenerator, getExecutingGenerator)
 }
 /* }}} */
 
+ZEND_METHOD(ReflectionGenerator, isClosed)
+{
+	zend_generator *generator = (zend_generator *) Z_OBJ(Z_REFLECTION_P(ZEND_THIS)->obj);
+	zend_execute_data *ex = generator->execute_data;
+
+	if (zend_parse_parameters_none() == FAILURE) {
+		RETURN_THROWS();
+	}
+
+	RETURN_BOOL(ex == NULL);
+}
+
 /* {{{ Constructor. Throws an Exception in case the given method does not exist */
 ZEND_METHOD(ReflectionParameter, __construct)
 {

ext/reflection/php_reflection.stub.php

@@ -163,6 +163,8 @@ public function getThis(): ?object {}
 
     /** @tentative-return-type */
     public function getExecutingGenerator(): Generator {}
+
+    public function isClosed(): bool {}
 }
 
 class ReflectionMethod extends ReflectionFunctionAbstract

ext/reflection/php_reflection_arginfo.h

@@ -19,4 +19,4 @@ try {
 }
 ?>
 --EXPECT--
-Cannot fetch information from a terminated Generator
+Cannot fetch information from a closed Generator

ext/reflection/tests/027.phpt

@@ -0,0 +1,46 @@
+--TEST--
+ReflectionGenerator::isClosed
+--FILE--
+<?php
+
+function empty_generator() {
+    return;
+    yield;
+}
+
+$gens = [
+    (function() {
+        yield;
+    })(),
+    empty_generator(),
+];
+
+foreach ($gens as $gen) {
+    $ref = new ReflectionGenerator($gen);
+    var_dump($ref->getExecutingLine());
+    var_dump($ref->isClosed());
+    var_dump($ref->getExecutingLine());
+    foreach ($gen as $dummy);
+    var_dump($ref->isClosed());
+    try {
+        var_dump($ref->getExecutingLine());
+    } catch (\Exception $e) {
+        echo $e->getMessage(), PHP_EOL;
+    }
+
+    echo PHP_EOL;
+}
+
+?>
+--EXPECTF--
+int(10)
+bool(false)
+int(10)
+bool(true)
+Cannot fetch information from a closed Generator
+
+int(4)
+bool(false)
+int(4)
+bool(true)
+Cannot fetch information from a closed Generator

ext/reflection/tests/ReflectionGenerator_isClosed.phpt

@@ -0,0 +1,42 @@
+--TEST--
+ReflectionGenerator::isClosed: ->valid() terminates an empty generator.
+--FILE--
+<?php
+
+function empty_generator() {
+    return;
+    yield;
+}
+
+$gens = [
+    (function() {
+        yield;
+    })(),
+    empty_generator(),
+];
+
+foreach ($gens as $gen) {
+    $ref = new ReflectionGenerator($gen);
+    var_dump($ref->isClosed());
+    var_dump($gen->valid());
+    var_dump($ref->isClosed());
+    try {
+        var_dump($ref->getExecutingLine());
+    } catch (\Exception $e) {
+        echo $e->getMessage(), PHP_EOL;
+    }
+
+    echo PHP_EOL;
+}
+
+?>
+--EXPECTF--
+bool(false)
+bool(true)
+bool(false)
+int(11)
+
+bool(false)
+bool(false)
+bool(true)
+Cannot fetch information from a closed Generator