Skip to content

Commit 5c230ba

Browse files
nikicnikic
committed
Implement Generator::getReturn()
Conflicts: Zend/zend_vm_execute.h
1 parent f1a6c06 commit 5c230ba

11 files changed

+523
-75
lines changed

‎Zend/tests/generators/errors/generator_cannot_return_before_yield_error.phpt‎

Lines changed: 0 additions & 13 deletions
This file was deleted.

‎Zend/tests/generators/errors/generator_cannot_return_error.phpt‎

Lines changed: 0 additions & 13 deletions
This file was deleted.

‎Zend/tests/generators/get_return.phpt‎

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
--TEST--
2+
Generator::getReturn() success cases
3+
--FILE--
4+
<?php
5+
6+
function gen1() {
7+
return 42;
8+
yield 24;
9+
}
10+
11+
$gen = gen1();
12+
// Calling getReturn() directly here is okay due to auto-priming
13+
var_dump($gen->getReturn());
14+
15+
function gen2() {
16+
yield 24;
17+
return 42;
18+
}
19+
20+
$gen = gen2();
21+
var_dump($gen->current());
22+
$gen->next();
23+
var_dump($gen->getReturn());
24+
25+
// & for generators specifies by-reference yield, not return
26+
// so it's okay to return a literal
27+
function &gen3() {
28+
$var = 24;
29+
yield $var;
30+
return 42;
31+
}
32+
33+
$gen = gen3();
34+
var_dump($gen->current());
35+
$gen->next();
36+
var_dump($gen->getReturn());
37+
38+
// Return types for generators specify the return of the function,
39+
// not of the generator return value, so this code is okay
40+
function gen4() : Generator {
41+
yield 24;
42+
return 42;
43+
}
44+
45+
$gen = gen4();
46+
var_dump($gen->current());
47+
$gen->next();
48+
var_dump($gen->getReturn());
49+
50+
// Has no explicit return, but implicitly return NULL at the end
51+
function gen5() {
52+
yield 24;
53+
}
54+
55+
$gen = gen5();
56+
var_dump($gen->current());
57+
$gen->next();
58+
var_dump($gen->getReturn());
59+
60+
// Explicit value-less return also results in a NULL generator
61+
// return value and there is no interference with type hints
62+
function gen6() : Generator {
63+
return;
64+
yield 24;
65+
}
66+
67+
$gen = gen6();
68+
var_dump($gen->getReturn());
69+
70+
?>
71+
--EXPECTF--
72+
int(42)
73+
int(24)
74+
int(42)
75+
int(24)
76+
int(42)
77+
int(24)
78+
int(42)
79+
int(24)
80+
NULL
81+
NULL

‎Zend/tests/generators/get_return_and_finally.phpt‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
--TEST--
2+
Test interaction of Generator::getReturn() and finally
3+
--FILE--
4+
<?php
5+
6+
function gen1() {
7+
try {
8+
throw new Exception("gen1() throw");
9+
} finally {
10+
return 42;
11+
}
12+
yield;
13+
}
14+
15+
// The exception was discarded, so this works
16+
$gen = gen1();
17+
var_dump($gen->getReturn());
18+
19+
function gen2() {
20+
try {
21+
return 42;
22+
} finally {
23+
throw new Exception("gen2() throw");
24+
}
25+
yield;
26+
}
27+
28+
$gen = gen2();
29+
try {
30+
// This will throw an exception (from the finally)
31+
// during auto-priming, so fails
32+
var_dump($gen->getReturn());
33+
} catch (Exception $e) {
34+
echo $e->getMessage(), "\n";
35+
}
36+
try {
37+
// This fails, because the return value was discarded
38+
var_dump($gen->getReturn());
39+
} catch (Exception $e) {
40+
echo $e->getMessage(), "\n";
41+
}
42+
43+
?>
44+
--EXPECT--
45+
int(42)
46+
gen2() throw
47+
Cannot get return value of a generator that hasn't returned

‎Zend/tests/generators/get_return_errors.phpt‎

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
--TEST--
2+
Generator::getReturn() error cases
3+
--FILE--
4+
<?php
5+
6+
function gen1() {
7+
yield 1;
8+
yield 2;
9+
return 3;
10+
}
11+
12+
$gen = gen1();
13+
try {
14+
// Generator hasn't reached the "return" yet
15+
$gen->getReturn();
16+
} catch (Exception $e) {
17+
echo $e->getMessage(), "\n";
18+
}
19+
20+
function gen2() {
21+
throw new Exception("gen2() throw");
22+
yield 1;
23+
return 2;
24+
}
25+
26+
$gen = gen2();
27+
try {
28+
$gen->next();
29+
} catch (Exception $e) {
30+
echo $e->getMessage(), "\n";
31+
}
32+
try {
33+
// Generator has been aborted as a result of an exception
34+
$gen->getReturn();
35+
} catch (Exception $e) {
36+
echo $e->getMessage(), "\n";
37+
}
38+
39+
function gen3() {
40+
throw new Exception("gen3() throw");
41+
return 1;
42+
yield 2;
43+
}
44+
45+
$gen = gen3();
46+
try {
47+
// Generator throws during auto-priming of getReturn() call
48+
$gen->getReturn();
49+
} catch (Exception $e) {
50+
echo $e->getMessage(), "\n";
51+
}
52+
53+
function gen4() {
54+
yield;
55+
return 1;
56+
}
57+
58+
$gen = gen4();
59+
try {
60+
$gen->throw(new Exception("gen4() throw"));
61+
} catch (Exception $e) {
62+
echo $e->getMessage(), "\n";
63+
}
64+
try {
65+
// Generator has been aborted as a result of an exception
66+
// that was injected using throw()
67+
$gen->getReturn();
68+
} catch (Exception $e) {
69+
echo $e->getMessage(), "\n";
70+
}
71+
72+
?>
73+
--EXPECT--
74+
Cannot get return value of a generator that hasn't returned
75+
gen2() throw
76+
Cannot get return value of a generator that hasn't returned
77+
gen3() throw
78+
gen4() throw
79+
Cannot get return value of a generator that hasn't returned

‎Zend/tests/generators/get_return_types.phpt‎

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
--TEST--
2+
Test different types of generator return values (VM operands)
3+
--FILE--
4+
<?php
5+
6+
function gen1() {
7+
return; // CONST
8+
yield;
9+
}
10+
11+
$gen = gen1();
12+
var_dump($gen->getReturn());
13+
14+
function gen2() {
15+
return "str"; // CONST
16+
yield;
17+
}
18+
19+
$gen = gen2();
20+
var_dump($gen->getReturn());
21+
22+
function gen3($var) {
23+
return $var; // CV
24+
yield;
25+
}
26+
27+
$gen = gen3([1, 2, 3]);
28+
var_dump($gen->getReturn());
29+
30+
function gen4($obj) {
31+
return $obj->prop; // VAR
32+
yield;
33+
}
34+
35+
$gen = gen4((object) ['prop' => 321]);
36+
var_dump($gen->getReturn());
37+
38+
function gen5($val) {
39+
return (int) $val; // TMP
40+
yield;
41+
}
42+
43+
$gen = gen5("42");
44+
var_dump($gen->getReturn());
45+
46+
?>
47+
--EXPECT--
48+
NULL
49+
string(3) "str"
50+
array(3) {
51+
[0]=>
52+
int(1)
53+
[1]=>
54+
int(2)
55+
[2]=>
56+
int(3)
57+
}
58+
int(321)
59+
int(42)

‎Zend/zend_generators.c‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -186,6 +186,7 @@ static void zend_generator_free_storage(zend_object *object) /* {{{ */
186186

187187
zend_generator_close(generator, 0);
188188

189+
zval_ptr_dtor(&generator->retval);
189190
zend_object_std_dtor(&generator->std);
190191

191192
if (generator->iterator) {
@@ -204,6 +205,8 @@ static zend_object *zend_generator_create(zend_class_entry *class_type) /* {{{ *
204205
/* The key will be incremented on first use, so it'll start at 0 */
205206
generator->largest_used_integer_key = -1;
206207

208+
ZVAL_UNDEF(&generator->retval);
209+
207210
zend_object_std_init(&generator->std, class_type);
208211
generator->std.handlers = &zend_generator_handlers;
209212

@@ -537,6 +540,34 @@ ZEND_METHOD(Generator, throw)
537540
}
538541
/* }}} */
539542

543+
/* {{{ proto mixed Generator::getReturn()
544+
* Retrieves the return value of the generator */
545+
ZEND_METHOD(Generator, getReturn)
546+
{
547+
zend_generator *generator;
548+
549+
if (zend_parse_parameters_none() == FAILURE) {
550+
return;
551+
}
552+
553+
generator = (zend_generator *) Z_OBJ_P(getThis());
554+
555+
zend_generator_ensure_initialized(generator);
556+
if (EG(exception)) {
557+
return;
558+
}
559+
560+
if (Z_ISUNDEF(generator->retval)) {
561+
/* Generator hasn't returned yet -> error! */
562+
zend_throw_exception(NULL,
563+
"Cannot get return value of a generator that hasn't returned", 0);
564+
return;
565+
}
566+
567+
ZVAL_COPY(return_value, &generator->retval);
568+
}
569+
/* }}} */
570+
540571
/* {{{ proto void Generator::__wakeup()
541572
* Throws an Exception as generators can't be serialized */
542573
ZEND_METHOD(Generator, __wakeup)
@@ -670,6 +701,7 @@ static const zend_function_entry generator_functions[] = {
670701
ZEND_ME(Generator, next, arginfo_generator_void, ZEND_ACC_PUBLIC)
671702
ZEND_ME(Generator, send, arginfo_generator_send, ZEND_ACC_PUBLIC)
672703
ZEND_ME(Generator, throw, arginfo_generator_throw, ZEND_ACC_PUBLIC)
704+
ZEND_ME(Generator, getReturn,arginfo_generator_void, ZEND_ACC_PUBLIC)
673705
ZEND_ME(Generator, __wakeup, arginfo_generator_void, ZEND_ACC_PUBLIC)
674706
ZEND_FE_END
675707
};

‎Zend/zend_generators.h‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,8 @@ typedef struct _zend_generator {
4040
zval value;
4141
/* Current key */
4242
zval key;
43+
/* Return value */
44+
zval retval;
4345
/* Variable to put sent value into */
4446
zval *send_target;
4547
/* Largest used integer key for auto-incrementing keys */

‎Zend/zend_opcode.c‎

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -798,11 +798,6 @@ ZEND_API int pass_two(zend_op_array *op_array)
798798
case ZEND_RETURN:
799799
case ZEND_RETURN_BY_REF:
800800
if (op_array->fn_flags & ZEND_ACC_GENERATOR) {
801-
if (opline->op1_type != IS_CONST || Z_TYPE_P(RT_CONSTANT(op_array, opline->op1)) != IS_NULL) {
802-
CG(zend_lineno) = opline->lineno;
803-
zend_error_noreturn(E_COMPILE_ERROR, "Generators cannot return values using \"return\"");
804-
}
805-
806801
opline->opcode = ZEND_GENERATOR_RETURN;
807802
}
808803
break;

0 commit comments

Comments
 (0)