Skip to content

Commit d62d50b

Browse files
iluuu1994iluuu1994
committed
Add C API for getting backed enum case by value
Closes GH-8518
1 parent df2414a commit d62d50b

File tree

6 files changed

+112
-30
lines changed

6 files changed

+112
-30
lines changed

‎Zend/tests/enum/internal_enums.phpt‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,22 @@ var_dump($s = serialize($foo));
3030
var_dump(unserialize($s));
3131
var_dump(unserialize($s) === $foo);
3232

33+
function test_int_enum(int|string $case) {
34+
try {
35+
var_dump(ZendTestIntEnum::from($case));
36+
} catch (\Error $e) {
37+
echo get_class($e) . ': ' . $e->getMessage() . "\n";
38+
}
39+
var_dump(ZendTestIntEnum::tryFrom($case));
40+
}
41+
42+
test_int_enum(1);
43+
test_int_enum('1');
44+
test_int_enum(2);
45+
test_int_enum('2');
46+
test_int_enum(-1);
47+
test_int_enum('-1');
48+
3349
?>
3450
--EXPECT--
3551
enum(ZendTestUnitEnum::Bar)
@@ -66,3 +82,15 @@ array(4) {
6682
string(30) "E:22:"ZendTestStringEnum:Foo";"
6783
enum(ZendTestStringEnum::Foo)
6884
bool(true)
85+
enum(ZendTestIntEnum::Foo)
86+
enum(ZendTestIntEnum::Foo)
87+
enum(ZendTestIntEnum::Foo)
88+
enum(ZendTestIntEnum::Foo)
89+
ValueError: 2 is not a valid backing value for enum "ZendTestIntEnum"
90+
NULL
91+
ValueError: 2 is not a valid backing value for enum "ZendTestIntEnum"
92+
NULL
93+
enum(ZendTestIntEnum::Baz)
94+
enum(ZendTestIntEnum::Baz)
95+
enum(ZendTestIntEnum::Baz)
96+
enum(ZendTestIntEnum::Baz)

‎Zend/zend_enum.c‎

Lines changed: 50 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -207,20 +207,59 @@ static ZEND_NAMED_FUNCTION(zend_enum_cases_func)
207207
} ZEND_HASH_FOREACH_END();
208208
}
209209

210+
ZEND_API zend_result zend_enum_get_case_by_value(zend_object **result, zend_class_entry *ce, zend_long long_key, zend_string *string_key, bool try)
211+
{
212+
zval *case_name_zv;
213+
if (ce->enum_backing_type == IS_LONG) {
214+
case_name_zv = zend_hash_index_find(ce->backed_enum_table, long_key);
215+
} else {
216+
ZEND_ASSERT(ce->enum_backing_type == IS_STRING);
217+
ZEND_ASSERT(string_key != NULL);
218+
case_name_zv = zend_hash_find(ce->backed_enum_table, string_key);
219+
}
220+
221+
if (case_name_zv == NULL) {
222+
if (try) {
223+
*result = NULL;
224+
return SUCCESS;
225+
}
226+
227+
if (ce->enum_backing_type == IS_LONG) {
228+
zend_value_error(ZEND_LONG_FMT " is not a valid backing value for enum \"%s\"", long_key, ZSTR_VAL(ce->name));
229+
} else {
230+
ZEND_ASSERT(ce->enum_backing_type == IS_STRING);
231+
zend_value_error("\"%s\" is not a valid backing value for enum \"%s\"", ZSTR_VAL(string_key), ZSTR_VAL(ce->name));
232+
}
233+
return FAILURE;
234+
}
235+
236+
// TODO: We might want to store pointers to constants in backed_enum_table instead of names,
237+
// to make this lookup more efficient.
238+
ZEND_ASSERT(Z_TYPE_P(case_name_zv) == IS_STRING);
239+
zend_class_constant *c = zend_hash_find_ptr(CE_CONSTANTS_TABLE(ce), Z_STR_P(case_name_zv));
240+
ZEND_ASSERT(c != NULL);
241+
zval *case_zv = &c->value;
242+
if (Z_TYPE_P(case_zv) == IS_CONSTANT_AST) {
243+
if (zval_update_constant_ex(case_zv, c->ce) == FAILURE) {
244+
return FAILURE;
245+
}
246+
}
247+
248+
*result = Z_OBJ_P(case_zv);
249+
return SUCCESS;
250+
}
251+
210252
static void zend_enum_from_base(INTERNAL_FUNCTION_PARAMETERS, bool try)
211253
{
212254
zend_class_entry *ce = execute_data->func->common.scope;
213255
bool release_string = false;
214-
zend_string *string_key;
215-
zend_long long_key;
256+
zend_string *string_key = NULL;
257+
zend_long long_key = 0;
216258

217-
zval *case_name_zv;
218259
if (ce->enum_backing_type == IS_LONG) {
219260
ZEND_PARSE_PARAMETERS_START(1, 1)
220261
Z_PARAM_LONG(long_key)
221262
ZEND_PARSE_PARAMETERS_END();
222-
223-
case_name_zv = zend_hash_index_find(ce->backed_enum_table, long_key);
224263
} else {
225264
ZEND_ASSERT(ce->enum_backing_type == IS_STRING);
226265

@@ -242,40 +281,22 @@ static void zend_enum_from_base(INTERNAL_FUNCTION_PARAMETERS, bool try)
242281
string_key = zend_long_to_str(long_key);
243282
}
244283
}
245-
246-
case_name_zv = zend_hash_find(ce->backed_enum_table, string_key);
247284
}
248285

249-
if (case_name_zv == NULL) {
250-
if (try) {
251-
goto return_null;
252-
}
253-
254-
if (ce->enum_backing_type == IS_LONG) {
255-
zend_value_error(ZEND_LONG_FMT " is not a valid backing value for enum \"%s\"", long_key, ZSTR_VAL(ce->name));
256-
} else {
257-
ZEND_ASSERT(ce->enum_backing_type == IS_STRING);
258-
zend_value_error("\"%s\" is not a valid backing value for enum \"%s\"", ZSTR_VAL(string_key), ZSTR_VAL(ce->name));
259-
}
286+
zend_object *case_obj;
287+
if (zend_enum_get_case_by_value(&case_obj, ce, long_key, string_key, try) == FAILURE) {
260288
goto throw;
261289
}
262290

263-
// TODO: We might want to store pointers to constants in backed_enum_table instead of names,
264-
// to make this lookup more efficient.
265-
ZEND_ASSERT(Z_TYPE_P(case_name_zv) == IS_STRING);
266-
zend_class_constant *c = zend_hash_find_ptr(CE_CONSTANTS_TABLE(ce), Z_STR_P(case_name_zv));
267-
ZEND_ASSERT(c != NULL);
268-
zval *case_zv = &c->value;
269-
if (Z_TYPE_P(case_zv) == IS_CONSTANT_AST) {
270-
if (zval_update_constant_ex(case_zv, c->ce) == FAILURE) {
271-
goto throw;
272-
}
291+
if (case_obj == NULL) {
292+
ZEND_ASSERT(try);
293+
goto return_null;
273294
}
274295

275296
if (release_string) {
276297
zend_string_release(string_key);
277298
}
278-
RETURN_COPY(case_zv);
299+
RETURN_OBJ_COPY(case_obj);
279300

280301
throw:
281302
if (release_string) {

‎Zend/zend_enum.h‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@ ZEND_API void zend_enum_add_case(zend_class_entry *ce, zend_string *case_name, z
4040
ZEND_API void zend_enum_add_case_cstr(zend_class_entry *ce, const char *name, zval *value);
4141
ZEND_API zend_object *zend_enum_get_case(zend_class_entry *ce, zend_string *name);
4242
ZEND_API zend_object *zend_enum_get_case_cstr(zend_class_entry *ce, const char *name);
43+
ZEND_API zend_result zend_enum_get_case_by_value(zend_object **result, zend_class_entry *ce, zend_long long_key, zend_string *string_key, bool try);
4344

4445
static zend_always_inline zval *zend_enum_fetch_case_name(zend_object *zobj)
4546
{

‎ext/zend_test/test.c‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,7 @@ static zend_class_entry *zend_test_ns2_foo_class;
4545
static zend_class_entry *zend_test_ns2_ns_foo_class;
4646
static zend_class_entry *zend_test_unit_enum;
4747
static zend_class_entry *zend_test_string_enum;
48+
static zend_class_entry *zend_test_int_enum;
4849
static zend_object_handlers zend_test_class_handlers;
4950

5051
static ZEND_FUNCTION(zend_test_func)
@@ -589,6 +590,7 @@ PHP_MINIT_FUNCTION(zend_test)
589590

590591
zend_test_unit_enum = register_class_ZendTestUnitEnum();
591592
zend_test_string_enum = register_class_ZendTestStringEnum();
593+
zend_test_int_enum = register_class_ZendTestIntEnum();
592594

593595
// Loading via dl() not supported with the observer API
594596
if (type != MODULE_TEMPORARY) {

‎ext/zend_test/test.stub.php‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,12 @@ enum ZendTestStringEnum: string {
7272
case FortyTwo = "42";
7373
}
7474

75+
enum ZendTestIntEnum: int {
76+
case Foo = 1;
77+
case Bar = 3;
78+
case Baz = -1;
79+
}
80+
7581
function zend_test_array_return(): array {}
7682

7783
function zend_test_nullable_array_return(): ?array {}

‎ext/zend_test/test_arginfo.h‎

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/* This is a generated file, edit the .stub.php file instead.
2-
* Stub hash: 7a0436c43deff3960c15c278644021a039c4946f */
2+
* Stub hash: e498f52a68debccd85bf1c086d05563174130e62 */
33

44
ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_zend_test_array_return, 0, 0, IS_ARRAY, 0)
55
ZEND_END_ARG_INFO()
@@ -236,6 +236,11 @@ static const zend_function_entry class_ZendTestStringEnum_methods[] = {
236236
};
237237

238238

239+
static const zend_function_entry class_ZendTestIntEnum_methods[] = {
240+
ZEND_FE_END
241+
};
242+
243+
239244
static const zend_function_entry class_ZendTestNS_Foo_methods[] = {
240245
ZEND_ME(ZendTestNS_Foo, method, arginfo_class_ZendTestNS_Foo_method, ZEND_ACC_PUBLIC)
241246
ZEND_FE_END
@@ -432,6 +437,25 @@ static zend_class_entry *register_class_ZendTestStringEnum(void)
432437
return class_entry;
433438
}
434439

440+
static zend_class_entry *register_class_ZendTestIntEnum(void)
441+
{
442+
zend_class_entry *class_entry = zend_register_internal_enum("ZendTestIntEnum", IS_LONG, class_ZendTestIntEnum_methods);
443+
444+
zval enum_case_Foo_value;
445+
ZVAL_LONG(&enum_case_Foo_value, 1);
446+
zend_enum_add_case_cstr(class_entry, "Foo", &enum_case_Foo_value);
447+
448+
zval enum_case_Bar_value;
449+
ZVAL_LONG(&enum_case_Bar_value, 3);
450+
zend_enum_add_case_cstr(class_entry, "Bar", &enum_case_Bar_value);
451+
452+
zval enum_case_Baz_value;
453+
ZVAL_LONG(&enum_case_Baz_value, -1);
454+
zend_enum_add_case_cstr(class_entry, "Baz", &enum_case_Baz_value);
455+
456+
return class_entry;
457+
}
458+
435459
static zend_class_entry *register_class_ZendTestNS_Foo(void)
436460
{
437461
zend_class_entry ce, *class_entry;

0 commit comments

Comments
 (0)