Simplify array_any(), array_all(), array_find(), array_find_key() (#17978)

By returning something more semantically meaningful that SUCCESS/FAILURE
we can avoid refcounting for array_all() and array_any().
Also we can avoid resetting the input values to UNDEF.
This commit is contained in:
Niels Dossche 2025-03-06 19:33:41 +01:00 committed by GitHub
parent 918332cf9c
commit 9ddc25afe3
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -6591,7 +6591,13 @@ PHP_FUNCTION(array_filter)
/* }}} */ /* }}} */
/* {{{ Internal function to find an array element for a user closure. */ /* {{{ Internal function to find an array element for a user closure. */
static zend_result php_array_find(const HashTable *array, zend_fcall_info fci, zend_fcall_info_cache fci_cache, zval *result_key, zval *result_value, bool negate_condition) enum php_array_find_result {
PHP_ARRAY_FIND_EXCEPTION = -1,
PHP_ARRAY_FIND_NONE = 0,
PHP_ARRAY_FIND_SOME = 1,
};
static enum php_array_find_result php_array_find(const HashTable *array, zend_fcall_info fci, zend_fcall_info_cache fci_cache, zval *result_key, zval *result_value, bool negate_condition)
{ {
zend_ulong num_key; zend_ulong num_key;
zend_string *str_key; zend_string *str_key;
@ -6599,16 +6605,8 @@ static zend_result php_array_find(const HashTable *array, zend_fcall_info fci, z
zval args[2]; zval args[2];
zval *operand; zval *operand;
if (result_value != NULL) {
ZVAL_UNDEF(result_value);
}
if (result_key != NULL) {
ZVAL_UNDEF(result_key);
}
if (zend_hash_num_elements(array) == 0) { if (zend_hash_num_elements(array) == 0) {
return SUCCESS; return PHP_ARRAY_FIND_NONE;
} }
ZEND_ASSERT(ZEND_FCI_INITIALIZED(fci)); ZEND_ASSERT(ZEND_FCI_INITIALIZED(fci));
@ -6631,7 +6629,7 @@ static zend_result php_array_find(const HashTable *array, zend_fcall_info fci, z
ZEND_ASSERT(result == SUCCESS); ZEND_ASSERT(result == SUCCESS);
if (UNEXPECTED(Z_ISUNDEF(retval))) { if (UNEXPECTED(Z_ISUNDEF(retval))) {
return FAILURE; return PHP_ARRAY_FIND_EXCEPTION;
} }
bool retval_true = zend_is_true(&retval); bool retval_true = zend_is_true(&retval);
@ -6649,103 +6647,75 @@ static zend_result php_array_find(const HashTable *array, zend_fcall_info fci, z
ZVAL_COPY(result_key, &args[1]); ZVAL_COPY(result_key, &args[1]);
} }
break; return PHP_ARRAY_FIND_SOME;
} }
} ZEND_HASH_FOREACH_END(); } ZEND_HASH_FOREACH_END();
return SUCCESS; return PHP_ARRAY_FIND_NONE;
} }
/* }}} */ /* }}} */
/* {{{ Search within an array and returns the first found element value. */ /* {{{ Search within an array and returns the first found element value. */
PHP_FUNCTION(array_find) PHP_FUNCTION(array_find)
{ {
zval *array = NULL; HashTable *array;
zend_fcall_info fci; zend_fcall_info fci;
zend_fcall_info_cache fci_cache = empty_fcall_info_cache; zend_fcall_info_cache fci_cache = empty_fcall_info_cache;
ZEND_PARSE_PARAMETERS_START(2, 2) ZEND_PARSE_PARAMETERS_START(2, 2)
Z_PARAM_ARRAY(array) Z_PARAM_ARRAY_HT(array)
Z_PARAM_FUNC(fci, fci_cache) Z_PARAM_FUNC(fci, fci_cache)
ZEND_PARSE_PARAMETERS_END(); ZEND_PARSE_PARAMETERS_END();
if (php_array_find(Z_ARR_P(array), fci, fci_cache, NULL, return_value, false) != SUCCESS) { php_array_find(array, fci, fci_cache, NULL, return_value, false);
RETURN_THROWS();
}
if (Z_TYPE_P(return_value) == IS_UNDEF) {
RETURN_NULL();
}
} }
/* }}} */ /* }}} */
/* {{{ Search within an array and returns the first found element key. */ /* {{{ Search within an array and returns the first found element key. */
PHP_FUNCTION(array_find_key) PHP_FUNCTION(array_find_key)
{ {
zval *array = NULL; HashTable *array;
zend_fcall_info fci; zend_fcall_info fci;
zend_fcall_info_cache fci_cache = empty_fcall_info_cache; zend_fcall_info_cache fci_cache = empty_fcall_info_cache;
ZEND_PARSE_PARAMETERS_START(2, 2) ZEND_PARSE_PARAMETERS_START(2, 2)
Z_PARAM_ARRAY(array) Z_PARAM_ARRAY_HT(array)
Z_PARAM_FUNC(fci, fci_cache) Z_PARAM_FUNC(fci, fci_cache)
ZEND_PARSE_PARAMETERS_END(); ZEND_PARSE_PARAMETERS_END();
if (php_array_find(Z_ARR_P(array), fci, fci_cache, return_value, NULL, false) != SUCCESS) { php_array_find(array, fci, fci_cache, return_value, NULL, false);
RETURN_THROWS();
}
if (Z_TYPE_P(return_value) == IS_UNDEF) {
RETURN_NULL();
}
} }
/* }}} */ /* }}} */
/* {{{ Checks if at least one array element satisfies a callback function. */ /* {{{ Checks if at least one array element satisfies a callback function. */
PHP_FUNCTION(array_any) PHP_FUNCTION(array_any)
{ {
zval *array = NULL; HashTable *array;
zend_fcall_info fci; zend_fcall_info fci;
zend_fcall_info_cache fci_cache = empty_fcall_info_cache; zend_fcall_info_cache fci_cache = empty_fcall_info_cache;
ZEND_PARSE_PARAMETERS_START(2, 2) ZEND_PARSE_PARAMETERS_START(2, 2)
Z_PARAM_ARRAY(array) Z_PARAM_ARRAY_HT(array)
Z_PARAM_FUNC(fci, fci_cache) Z_PARAM_FUNC(fci, fci_cache)
ZEND_PARSE_PARAMETERS_END(); ZEND_PARSE_PARAMETERS_END();
if (php_array_find(Z_ARR_P(array), fci, fci_cache, return_value, NULL, false) != SUCCESS) { RETURN_BOOL(php_array_find(array, fci, fci_cache, NULL, NULL, false) == PHP_ARRAY_FIND_SOME);
RETURN_THROWS();
}
bool retval = !Z_ISUNDEF_P(return_value);
if (Z_TYPE_P(return_value) == IS_STRING) {
zval_ptr_dtor_str(return_value);
}
RETURN_BOOL(retval);
} }
/* }}} */ /* }}} */
/* {{{ Checks if all array elements satisfy a callback function. */ /* {{{ Checks if all array elements satisfy a callback function. */
PHP_FUNCTION(array_all) PHP_FUNCTION(array_all)
{ {
zval *array = NULL; HashTable *array;
zend_fcall_info fci; zend_fcall_info fci;
zend_fcall_info_cache fci_cache = empty_fcall_info_cache; zend_fcall_info_cache fci_cache = empty_fcall_info_cache;
ZEND_PARSE_PARAMETERS_START(2, 2) ZEND_PARSE_PARAMETERS_START(2, 2)
Z_PARAM_ARRAY(array) Z_PARAM_ARRAY_HT(array)
Z_PARAM_FUNC(fci, fci_cache) Z_PARAM_FUNC(fci, fci_cache)
ZEND_PARSE_PARAMETERS_END(); ZEND_PARSE_PARAMETERS_END();
if (php_array_find(Z_ARR_P(array), fci, fci_cache, return_value, NULL, true) != SUCCESS) { RETURN_BOOL(php_array_find(array, fci, fci_cache, NULL, NULL, true) == PHP_ARRAY_FIND_NONE);
RETURN_THROWS();
}
bool retval = Z_ISUNDEF_P(return_value);
if (Z_TYPE_P(return_value) == IS_STRING) {
zval_ptr_dtor_str(return_value);
}
RETURN_BOOL(retval);
} }
/* }}} */ /* }}} */