Expose zend_parse_arg() as zend_parse_parameter()

Sometimes, one wants to accept several types for a given parameter. zpp
has special functionality for detecting the NULL type, since the NULL
type is frequently used to skip parameters.

However, supporting several types is otherwise very tedious. There are
many cases where this situation arises -- for instance one may want
to accept an arbitrary number of integer and expect them in an array,
but allow a bare integer too; one may want to accept something that
will be used as an array key (which can be either and int or a string);
one may want to accept integer and double numbers. A search for IS_LONG
reveals many situations where this need arises.

The usual solution is to fetch the argument with 'z'/'Z', check its
type, and then convert the argument, e.g. with convert_to_long_ex().
As explain in the last commit, this has different behavior and
generates inconsistency.

Another -- even more flawed strategy --, is to try zpp with a specific
format, forcing it quiet, and if it fails retrying with another form.
But because zpp changes the arguments directly in the stack (for
instance, using "l" converts the zval in the stack to IS_LONG), the
arguments may look different after the first zpp, leaving subtle bugs.

This commit also allows more complex scenarios, for instance where the
expected type of one parameter depends on other parameters.

diff --git a/Zend/zend_API.c b/Zend/zend_API.c
index d7170eb2cc72048c379b58151cd5d7793814e542..22acb701255826a82ced0d63d4988ac031aad827 100644 (file)
--- a/Zend/zend_API.c
+++ b/Zend/zend_API.c
@@ -713,6 +713,19 @@ static int zend_parse_arg(int arg_num, zval **arg, va_list *va, const char **spe
 }
 /* }}} */
 
+int zend_parse_parameter(int flags, int arg_num TSRMLS_DC, zval **arg, const char *spec, ...)
+{
+       va_list va;
+       int ret;
+       int quiet = flags & ZEND_PARSE_PARAMS_QUIET;
+
+       va_start(va, spec);
+       ret = zend_parse_arg(arg_num, arg, &va, &spec, quiet TSRMLS_CC);
+       va_end(va);
+
+       return ret;
+}
+
 static int zend_parse_va_args(int num_args, const char *type_spec, va_list *va, int flags TSRMLS_DC) /* {{{ */
 {
        const  char *spec_walk;

diff --git a/Zend/zend_API.h b/Zend/zend_API.h
index f54db7f2e87cc6d2de27f1dfa990d1baeef6ba18..f65fb172c5be515c407f049b1adde82eb20c8c72 100644 (file)
--- a/Zend/zend_API.h
+++ b/Zend/zend_API.h
@@ -253,6 +253,8 @@ ZEND_API char *zend_zval_type_name(const zval *arg);
 ZEND_API int zend_parse_method_parameters(int num_args TSRMLS_DC, zval *this_ptr, const char *type_spec, ...);
 ZEND_API int zend_parse_method_parameters_ex(int flags, int num_args TSRMLS_DC, zval *this_ptr, const char *type_spec, ...);
 
+int zend_parse_parameter(int flags, int arg_num TSRMLS_DC, zval **arg, const char *spec, ...);
+
 /* End of parameter parsing API -- andrei */
 
 ZEND_API int zend_register_functions(zend_class_entry *scope, const zend_function_entry *functions, HashTable *function_table, int type TSRMLS_DC);