1New parameter parsing functions 2=============================== 3 4It should be easier to parse input parameters to an extension function. 5Hence, borrowing from Python's example, there are now a set of functions 6that given the string of type specifiers, can parse the input parameters 7and store the results in the user specified variables. This avoids most 8of the IS_* checks and convert_to_* conversions. The functions also 9check for the appropriate number of parameters, and try to output 10meaningful error messages. 11 12 13Prototypes 14---------- 15/* Implemented. */ 16int zend_parse_parameters(int num_args TSRMLS_DC, char *type_spec, ...); 17int zend_parse_parameters_ex(int flags, int num_args TSRMLS_DC, char *type_spec, ...); 18 19The zend_parse_parameters() function takes the number of parameters 20passed to the extension function, the type specifier string, and the 21list of pointers to variables to store the results in. The _ex() version 22also takes 'flags' argument -- current only ZEND_PARSE_PARAMS_QUIET can 23be used as 'flags' to specify that the function should operate quietly 24and not output any error messages. 25 26Both functions return SUCCESS or FAILURE depending on the result. 27 28The auto-conversions are performed as necessary. Arrays, objects, and 29resources cannot be auto-converted. 30 31 32Type specifiers 33--------------- 34 The following list shows the type specifier, its meaning and the parameter 35 types that need to be passed by address. All passed parameters are set 36 if the PHP parameter is non optional and untouched if optional and the 37 parameter is not present. The only exception is O where the zend_class_entry* 38 has to be provided on input and is used to verify the PHP parameter is an 39 instance of that class. 40 41 a - array (zval*) 42 A - array or object (zval *) 43 b - boolean (zend_bool) 44 C - class (zend_class_entry*) 45 d - double (double) 46 f - function or array containing php method call info (returned as 47 zend_fcall_info and zend_fcall_info_cache) 48 h - array (returned as HashTable*) 49 H - array or HASH_OF(object) (returned as HashTable*) 50 l - long (long) 51 L - long, limits out-of-range numbers to LONG_MAX/LONG_MIN (long) 52 o - object of any type (zval*) 53 O - object of specific type given by class entry (zval*, zend_class_entry) 54 p - valid path (string without null bytes in the middle) and its length (char*, int) 55 r - resource (zval*) 56 s - string (with possible null bytes) and its length (char*, int) 57 z - the actual zval (zval*) 58 Z - the actual zval (zval**) 59 * - variable arguments list (0 or more) 60 + - variable arguments list (1 or more) 61 62 The following characters also have a meaning in the specifier string: 63 | - indicates that the remaining parameters are optional, they 64 should be initialized to default values by the extension since they 65 will not be touched by the parsing function if they are not 66 passed to it. 67 / - use SEPARATE_ZVAL_IF_NOT_REF() on the parameter it follows 68 ! - the parameter it follows can be of specified type or NULL (applies 69 to all specifiers except for 'b', 'l', and 'd'). If NULL is passed, the 70 results pointer is set to NULL as well. 71 72 73Note on 64bit compatibility 74--------------------------- 75Please do not forget that int and long are two different things on 64bit 76OSes (int is 4 bytes and long is 8 bytes), so make sure you pass longs to "l" 77and ints to strings length (i.e. for "s" you need to pass char * and int), 78not the other way round! 79Remember: "l" is the only case when you need to pass long (and that's why 80it's "l", not "i" btw). 81 82Both mistakes cause memory corruptions and segfaults on 64bit OSes: 831) 84 char *str; 85 long str_len; /* XXX THIS IS WRONG!! Use int instead. */ 86 zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s", &str, &str_len) 87 882) 89 int num; /* XXX THIS IS WRONG!! Use long instead. */ 90 zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "l", &num) 91 92If you're in doubt, use check_parameters.php script to the parameters 93and their types (it can be found in ./scripts/dev/ directory of PHP sources): 94 95# php ./scripts/dev/check_parameters.php /path/to/your/sources/ 96 97 98Examples 99-------- 100/* Gets a long, a string and its length, and a zval */ 101long l; 102char *s; 103int s_len; 104zval *param; 105if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "lsz", 106 &l, &s, &s_len, ¶m) == FAILURE) { 107 return; 108} 109 110 111/* Gets an object of class specified by my_ce, and an optional double. */ 112zval *obj; 113double d = 0.5; 114zend_class_entry *my_ce; 115if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "O|d", 116 &obj, my_ce, &d) == FAILURE) { 117 return; 118} 119 120 121/* Gets an object or null, and an array. 122 If null is passed for object, obj will be set to NULL. */ 123zval *obj; 124zval *arr; 125if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "o!a", 126 &obj, &arr) == FAILURE) { 127 return; 128} 129 130 131/* Gets a separated array which can also be null. */ 132zval *arr; 133if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "a/!", 134 &arr) == FAILURE) { 135 return; 136} 137 138/* Get either a set of 3 longs or a string. */ 139long l1, l2, l3; 140char *s; 141/* 142 * The function expects a pointer to a integer in this case, not a long 143 * or any other type. If you specify a type which is larger 144 * than a 'int', the upper bits might not be initialized 145 * properly, leading to random crashes on platforms like 146 * Tru64 or Linux/Alpha. 147 */ 148int length; 149 150if (zend_parse_parameters_ex(ZEND_PARSE_PARAMS_QUIET, ZEND_NUM_ARGS() TSRMLS_CC, 151 "lll", &l1, &l2, &l3) == SUCCESS) { 152 /* manipulate longs */ 153} else if (zend_parse_parameters_ex(ZEND_PARSE_PARAMS_QUIET, ZEND_NUM_ARGS() TSRMLS_CC, 154 "s", &s, &length) == SUCCESS) { 155 /* manipulate string */ 156} else { 157 /* output error */ 158 159 return; 160} 161 162 163/* Function that accepts only varargs (0 or more) */ 164 165int i, num_varargs; 166zval ***varargs = NULL; 167 168 169if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "*", &varargs, &num_varargs) == FAILURE) { 170 return; 171} 172 173for (i = 0; i < num_varargs; i++) { 174 /* do something with varargs[i] */ 175} 176 177if (varargs) { 178 efree(varargs); 179} 180 181 182/* Function that accepts a string, followed by varargs (1 or more) */ 183 184char *str; 185int str_len; 186int i, num_varargs; 187zval ***varargs = NULL; 188 189if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s+", &str, &str_len, &varargs, &num_varargs) == FAILURE) { 190 return; 191} 192 193for (i = 0; i < num_varargs; i++) { 194 /* do something with varargs[i] */ 195} 196 197if (varargs) { 198 efree(varargs); 199} 200 201 202/* Function that takes an array, followed by varargs, and ending with a long */ 203long num; 204zval *array; 205int i, num_varargs; 206zval ***varargs = NULL; 207 208if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "a*l", &array, &varargs, &num_varargs, &num) == FAILURE) { 209 return; 210} 211 212for (i = 0; i < num_varargs; i++) { 213 /* do something with varargs[i] */ 214} 215 216if (varargs) { 217 efree(varargs); 218} 219 220
