Author: mrene Date: Thu Mar 5 00:08:45 2009 New Revision: 12456 Log: OCD - going to bed Modified: freeswitch/trunk/src/include/switch_xml_config.h Modified: freeswitch/trunk/src/include/switch_xml_config.h ============================================================================== --- freeswitch/trunk/src/include/switch_xml_config.h (original) +++ freeswitch/trunk/src/include/switch_xml_config.h Thu Mar 5 00:08:45 2009 @@ -35,26 +35,26 @@ /*! \brief Type of value to parse */ typedef enum { - SWITCH_CONFIG_INT, /*< (ptr=int* default=int data=NULL) Integer */ - SWITCH_CONFIG_STRING, /*< (ptr=[char* or char ** (for alloc)] default=char* data=switch_xml_config_string_options_t*) Zero-terminated C-string */ - SWITCH_CONFIG_YESNO, /*< (ptr=switch_bool_t* default=switch_bool_t data=NULL) Yes and no */ - SWITCH_CONFIG_CUSTOM, /*< (ptr=<custom function data> default=<custom function data> data=switch_xml_config_callback_t) Custom, get value through function pointer */ - SWITCH_CONFIG_ENUM, /*< (ptr=int* default=int data=switch_xml_config_enum_item_t*) */ - SWITCH_CONFIG_FLAG, /*< (ptr=int32_t* default=switch_bool_t data=int (flag index) */ - SWITCH_CONFIG_FLAGARRAY, /*< (ptr=int8_t* default=switch_bool_t data=int (flag index) */ + SWITCH_CONFIG_INT, /*< (ptr=int* default=int data=NULL) Integer */ + SWITCH_CONFIG_STRING, /*< (ptr=[char* or char ** (for alloc)] default=char* data=switch_xml_config_string_options_t*) Zero-terminated C-string */ + SWITCH_CONFIG_YESNO, /*< (ptr=switch_bool_t* default=switch_bool_t data=NULL) Yes and no */ + SWITCH_CONFIG_CUSTOM, /*< (ptr=<custom function data> default=<custom function data> data=switch_xml_config_callback_t) Custom, get value through function pointer */ + SWITCH_CONFIG_ENUM, /*< (ptr=int* default=int data=switch_xml_config_enum_item_t*) */ + SWITCH_CONFIG_FLAG, /*< (ptr=int32_t* default=switch_bool_t data=int (flag index) */ + SWITCH_CONFIG_FLAGARRAY, /*< (ptr=int8_t* default=switch_bool_t data=int (flag index) */ /* No more past that line */ SWITCH_CONFIG_LAST } switch_xml_config_type_t; -typedef struct { - char *key; /*< The item's key or NULL if this is the last one in the list */ - int value; /*< The item's value */ +typedef struct { + char *key; /*< The item's key or NULL if this is the last one in the list */ + int value; /*< The item's value */ } switch_xml_config_enum_item_t; typedef struct { - switch_memory_pool_t *pool; /*< If set, the string will be allocated on the pool (unless the length param is > 0, then you misread this file)*/ - switch_size_t length; /*< Length of the char array, or 0 if memory has to be allocated dynamically*/ + switch_memory_pool_t *pool; /*< If set, the string will be allocated on the pool (unless the length param is > 0, then you misread this file)*/ + switch_size_t length; /*< Length of the char array, or 0 if memory has to be allocated dynamically*/ } switch_xml_config_string_options_t; struct switch_xml_config_item; @@ -66,14 +66,14 @@ * \brief A configuration instruction read by switch_xml_config_parse */ struct switch_xml_config_item { - char *key; /*< The key of the element, or NULL to indicate the end of the list */ - switch_xml_config_type_t type; /*< The type of variable */ - switch_bool_t reloadable; /*< True if the var can be changed on reload */ - void *ptr; /*< Ptr to the var to be changed */ - void *defaultvalue; /*< Default value */ - void *data; /*< Custom data (depending on the type) */ + char *key; /*< The key of the element, or NULL to indicate the end of the list */ + switch_xml_config_type_t type; /*< The type of variable */ + switch_bool_t reloadable; /*< True if the var can be changed on reload */ + void *ptr; /*< Ptr to the var to be changed */ + void *defaultvalue; /*< Default value */ + void *data; /*< Custom data (depending on the type) */ switch_xml_config_callback_t function; /*< Callback to be called after the var is parsed */ - void *functiondata; /*< Custom data passed to the callback */ + void *functiondata; /*< Custom data passed to the callback */ } ; @@ -85,7 +85,7 @@ * \brief Parses all the xml elements, following a ruleset defined by an array of switch_xml_config_item_t * \param xml The first element of the list to parse * \param reload true to skip all non-reloadable options - * \param options instrutions on how to parse the elements + * \param instructions instrutions on how to parse the elements * \see switch_xml_config_item_t */ SWITCH_DECLARE(switch_status_t) switch_xml_config_parse(switch_xml_t xml, int reload, switch_xml_config_item_t *instructions);