Improve zend_enum_get_case_by_value() API

Author: iluuu1994

Zend/zend_enum.c

@@ -207,7 +207,7 @@ static ZEND_NAMED_FUNCTION(zend_enum_cases_func)
 	} ZEND_HASH_FOREACH_END();
 }
 
-ZEND_API zend_object *zend_enum_get_case_by_value(zend_class_entry *ce, zend_long long_key, zend_string *string_key)
+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)
 {
 	zval *case_name_zv;
 	if (ce->enum_backing_type == IS_LONG) {
@@ -219,7 +219,18 @@ ZEND_API zend_object *zend_enum_get_case_by_value(zend_class_entry *ce, zend_lon
 	}
 
 	if (case_name_zv == NULL) {
-		return NULL;
+		if (try) {
+			*result = NULL;
+			return SUCCESS;
+		}
+
+		if (ce->enum_backing_type == IS_LONG) {
+			zend_value_error(ZEND_LONG_FMT " is not a valid backing value for enum \"%s\"", long_key, ZSTR_VAL(ce->name));
+		} else {
+			ZEND_ASSERT(ce->enum_backing_type == IS_STRING);
+			zend_value_error("\"%s\" is not a valid backing value for enum \"%s\"", ZSTR_VAL(string_key), ZSTR_VAL(ce->name));
+		}
+		return FAILURE;
 	}
 
 	// TODO: We might want to store pointers to constants in backed_enum_table instead of names,
@@ -230,11 +241,12 @@ ZEND_API zend_object *zend_enum_get_case_by_value(zend_class_entry *ce, zend_lon
 	zval *case_zv = &c->value;
 	if (Z_TYPE_P(case_zv) == IS_CONSTANT_AST) {
 		if (zval_update_constant_ex(case_zv, c->ce) == FAILURE) {
-			return NULL;
+			return FAILURE;
 		}
 	}
 
-	return Z_OBJ_P(case_zv);
+	*result = Z_OBJ_P(case_zv);
+    return SUCCESS;
 }
 
 static void zend_enum_from_base(INTERNAL_FUNCTION_PARAMETERS, bool try)
@@ -255,24 +267,14 @@ static void zend_enum_from_base(INTERNAL_FUNCTION_PARAMETERS, bool try)
 		ZEND_ASSERT(ce->enum_backing_type == IS_STRING);
 	}
 
-	zend_object *case_obj = zend_enum_get_case_by_value(ce, long_key, string_key);
-	// Updating of constants can fail
-	if (EG(exception)) {
+	zend_object *case_obj;
+	if (zend_enum_get_case_by_value(&case_obj, ce, long_key, string_key, try) == FAILURE) {
 		RETURN_THROWS();
 	}
 
 	if (case_obj == NULL) {
-		if (try) {
-			RETURN_NULL();
-		}
-
-		if (ce->enum_backing_type == IS_LONG) {
-			zend_value_error(ZEND_LONG_FMT " is not a valid backing value for enum \"%s\"", long_key, ZSTR_VAL(ce->name));
-		} else {
-			ZEND_ASSERT(ce->enum_backing_type == IS_STRING);
-			zend_value_error("\"%s\" is not a valid backing value for enum \"%s\"", ZSTR_VAL(string_key), ZSTR_VAL(ce->name));
-		}
-		RETURN_THROWS();
+		ZEND_ASSERT(try);
+		RETURN_NULL();
 	}
 
 	ZVAL_OBJ_COPY(return_value, case_obj);

Zend/zend_enum.h

@@ -40,7 +40,7 @@ ZEND_API void zend_enum_add_case(zend_class_entry *ce, zend_string *case_name, z
 ZEND_API void zend_enum_add_case_cstr(zend_class_entry *ce, const char *name, zval *value);
 ZEND_API zend_object *zend_enum_get_case(zend_class_entry *ce, zend_string *name);
 ZEND_API zend_object *zend_enum_get_case_cstr(zend_class_entry *ce, const char *name);
-ZEND_API zend_object *zend_enum_get_case_by_value(zend_class_entry *ce, zend_long long_key, zend_string *string_key);
+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);
 
 static zend_always_inline zval *zend_enum_fetch_case_name(zend_object *zobj)
 {