Asterisk XML abstraction layer. More...
Go to the source code of this file.
Defines | |
#define | AST_XML_DOCS |
Functions | |
struct ast_xml_node * | ast_xml_add_child (struct ast_xml_node *parent, struct ast_xml_node *child) |
Add a child node, to a specified parent node. | |
void | ast_xml_close (struct ast_xml_doc *doc) |
Close an already open document and free the used structure. | |
int | ast_xml_doc_dump_file (FILE *output, struct ast_xml_doc *doc) |
Dump the specified document to a file. | |
struct ast_xml_node * | ast_xml_find_element (struct ast_xml_node *root_node, const char *name, const char *attrname, const char *attrvalue) |
Find a node element by name. | |
struct ast_xml_ns * | ast_xml_find_namespace (struct ast_xml_doc *doc, struct ast_xml_node *node, const char *ns_name) |
int | ast_xml_finish (void) |
Cleanup library allocated global data. | |
void | ast_xml_free_attr (const char *attribute) |
Free an attribute returned by ast_xml_get_attribute(). | |
void | ast_xml_free_node (struct ast_xml_node *node) |
Free node. | |
void | ast_xml_free_text (const char *text) |
Free a content element that was returned by ast_xml_get_text(). | |
const char * | ast_xml_get_attribute (struct ast_xml_node *node, const char *attrname) |
Get a node attribute by name. | |
struct ast_xml_doc * | ast_xml_get_doc (struct ast_xml_node *node) |
Get the document based on a node. | |
const char * | ast_xml_get_ns_href (struct ast_xml_ns *ns) |
struct ast_xml_node * | ast_xml_get_root (struct ast_xml_doc *doc) |
Get the document root node. | |
const char * | ast_xml_get_text (struct ast_xml_node *node) |
Get an element content string. | |
int | ast_xml_init (void) |
Initialize the XML library implementation. This function is used to setup everything needed to start working with the xml implementation. | |
struct ast_xml_doc * | ast_xml_new (void) |
Create a XML document. | |
struct ast_xml_node * | ast_xml_new_child (struct ast_xml_node *parent, const char *child_name) |
Add a child node inside a passed parent node. | |
struct ast_xml_node * | ast_xml_new_node (const char *name) |
Create a XML node. | |
struct ast_xml_node * | ast_xml_node_get_children (struct ast_xml_node *node) |
Get the node's children. | |
const char * | ast_xml_node_get_name (struct ast_xml_node *node) |
Get the name of a node. | |
struct ast_xml_node * | ast_xml_node_get_next (struct ast_xml_node *node) |
Get the next node in the same level. | |
struct ast_xml_node * | ast_xml_node_get_parent (struct ast_xml_node *node) |
Get the parent of a specified node. | |
struct ast_xml_node * | ast_xml_node_get_prev (struct ast_xml_node *node) |
Get the previous node in the same leve. | |
struct ast_xml_doc * | ast_xml_open (char *filename) |
Open an XML document. | |
struct ast_xml_doc * | ast_xml_read_memory (char *buffer, size_t size) |
Open an XML document that resides in memory. | |
int | ast_xml_set_attribute (struct ast_xml_node *node, const char *name, const char *value) |
Set an attribute to a node. | |
void | ast_xml_set_root (struct ast_xml_doc *doc, struct ast_xml_node *node) |
Specify the root node of a XML document. | |
void | ast_xml_set_text (struct ast_xml_node *node, const char *content) |
Set an element content string. |
Asterisk XML abstraction layer.
Definition in file xml.h.
struct ast_xml_node* ast_xml_add_child | ( | struct ast_xml_node * | parent, | |
struct ast_xml_node * | child | |||
) | [read] |
Add a child node, to a specified parent node.
parent | Where to add the child node. | |
child | The child node to add. |
NULL | on error. | |
non-NULL | The add child node on success. |
Definition at line 107 of file xml.c.
Referenced by data_get_xml_add_child().
void ast_xml_close | ( | struct ast_xml_doc * | doc | ) |
Close an already open document and free the used structure.
doc | The document reference. |
Definition at line 134 of file xml.c.
Referenced by ast_data_get_xml().
int ast_xml_doc_dump_file | ( | FILE * | output, | |
struct ast_xml_doc * | doc | |||
) |
struct ast_xml_node* ast_xml_find_element | ( | struct ast_xml_node * | root_node, | |
const char * | name, | |||
const char * | attrname, | |||
const char * | attrvalue | |||
) | [read] |
Find a node element by name.
root_node | This is the node starting point. | |
name | Node name to find. | |
attrname | attribute name to match (if NULL it won't be matched). | |
attrvalue | attribute value to match (if NULL it won't be matched). |
NULL | if not found. | |
The | node on success. |
Definition at line 220 of file xml.c.
References ast_xml_free_attr(), ast_xml_get_attribute(), ast_xml_node_get_name(), and ast_xml_node_get_next().
Referenced by xmldoc_build_field(), and xmldoc_get_node().
00221 { 00222 struct ast_xml_node *cur; 00223 const char *attr; 00224 00225 if (!root_node) { 00226 return NULL; 00227 } 00228 00229 for (cur = root_node; cur; cur = ast_xml_node_get_next(cur)) { 00230 /* Check if the name matchs */ 00231 if (strcmp(ast_xml_node_get_name(cur), name)) { 00232 continue; 00233 } 00234 /* We need to check for a specific attribute name? */ 00235 if (!attrname || !attrvalue) { 00236 return cur; 00237 } 00238 /* Get the attribute, we need to compare it. */ 00239 if ((attr = ast_xml_get_attribute(cur, attrname))) { 00240 /* does attribute name/value matches? */ 00241 if (!strcmp(attr, attrvalue)) { 00242 ast_xml_free_attr(attr); 00243 return cur; 00244 } 00245 ast_xml_free_attr(attr); 00246 } 00247 } 00248 00249 return NULL; 00250 }
struct ast_xml_ns* ast_xml_find_namespace | ( | struct ast_xml_doc * | doc, | |
struct ast_xml_node * | node, | |||
const char * | ns_name | |||
) | [read] |
int ast_xml_finish | ( | void | ) |
void ast_xml_free_attr | ( | const char * | attribute | ) |
Free an attribute returned by ast_xml_get_attribute().
attribute | pointer to be freed. |
Definition at line 176 of file xml.c.
Referenced by ast_xml_find_element(), ast_xmldoc_build_seealso(), xmldoc_attribute_match(), xmldoc_get_syntax_cmd(), xmldoc_get_syntax_fun(), xmldoc_get_syntax_manager(), xmldoc_parse_argument(), xmldoc_parse_enumlist(), xmldoc_parse_optionlist(), xmldoc_parse_parameter(), xmldoc_parse_variable(), and xmldoc_parse_variablelist().
void ast_xml_free_node | ( | struct ast_xml_node * | node | ) |
void ast_xml_free_text | ( | const char * | text | ) |
Free a content element that was returned by ast_xml_get_text().
text | text to be freed. |
Definition at line 183 of file xml.c.
Referenced by ast_xmldoc_build_seealso(), xmldoc_get_formatted(), xmldoc_parse_para(), and xmldoc_parse_variable().
const char* ast_xml_get_attribute | ( | struct ast_xml_node * | node, | |
const char * | attrname | |||
) |
Get a node attribute by name.
node | Node where to search the attribute. | |
attrname | Attribute name. |
NULL | on error | |
The | attribute value on success. |
Definition at line 190 of file xml.c.
Referenced by ast_xml_find_element(), ast_xmldoc_build_seealso(), xmldoc_attribute_match(), xmldoc_get_syntax_cmd(), xmldoc_get_syntax_fun(), xmldoc_get_syntax_manager(), xmldoc_parse_argument(), xmldoc_parse_enumlist(), xmldoc_parse_optionlist(), xmldoc_parse_parameter(), xmldoc_parse_variable(), and xmldoc_parse_variablelist().
struct ast_xml_doc* ast_xml_get_doc | ( | struct ast_xml_node * | node | ) | [read] |
const char* ast_xml_get_ns_href | ( | struct ast_xml_ns * | ns | ) |
struct ast_xml_node* ast_xml_get_root | ( | struct ast_xml_doc * | doc | ) | [read] |
Get the document root node.
doc | Document reference |
NULL | on error | |
The | root node on success. |
Definition at line 153 of file xml.c.
Referenced by xmldoc_get_node().
const char* ast_xml_get_text | ( | struct ast_xml_node * | node | ) |
Get an element content string.
node | Node from where to get the string. |
NULL | on error. | |
The | text content of node. |
Definition at line 271 of file xml.c.
Referenced by ast_xmldoc_build_seealso(), xmldoc_get_formatted(), xmldoc_parse_para(), and xmldoc_parse_variable().
int ast_xml_init | ( | void | ) |
struct ast_xml_doc* ast_xml_new | ( | void | ) | [read] |
Create a XML document.
NULL | on error. | |
non-NULL | The allocated document structure. |
Definition at line 75 of file xml.c.
Referenced by ast_data_get_xml().
struct ast_xml_node* ast_xml_new_child | ( | struct ast_xml_node * | parent, | |
const char * | child_name | |||
) | [read] |
Add a child node inside a passed parent node.
parent | The pointer of the parent node. | |
child_name | The name of the child node to add. |
NULL | on error. | |
non-NULL | The created child node pointer. |
struct ast_xml_node* ast_xml_new_node | ( | const char * | name | ) | [read] |
Create a XML node.
name | The name of the node to be created. |
NULL | on error. | |
non-NULL | The allocated node structe. |
Definition at line 83 of file xml.c.
Referenced by ast_data_get_xml(), and data_get_xml_add_child().
struct ast_xml_node* ast_xml_node_get_children | ( | struct ast_xml_node * | node | ) | [read] |
Get the node's children.
Definition at line 299 of file xml.c.
Referenced by ast_xmldoc_build_arguments(), ast_xmldoc_build_seealso(), ast_xmldoc_build_syntax(), xmldoc_build_field(), xmldoc_get_formatted(), xmldoc_get_node(), xmldoc_get_syntax_cmd(), xmldoc_get_syntax_fun(), xmldoc_get_syntax_manager(), xmldoc_has_inside(), xmldoc_has_nodes(), xmldoc_has_specialtags(), xmldoc_parse_argument(), xmldoc_parse_cmd_enumlist(), xmldoc_parse_enum(), xmldoc_parse_enumlist(), xmldoc_parse_option(), xmldoc_parse_optionlist(), xmldoc_parse_para(), xmldoc_parse_parameter(), xmldoc_parse_specialtags(), xmldoc_parse_variable(), and xmldoc_parse_variablelist().
const char* ast_xml_node_get_name | ( | struct ast_xml_node * | node | ) |
Get the name of a node.
Definition at line 294 of file xml.c.
Referenced by ast_xml_find_element(), ast_xmldoc_build_arguments(), ast_xmldoc_build_seealso(), ast_xmldoc_build_syntax(), xmldoc_get_syntax_cmd(), xmldoc_get_syntax_fun(), xmldoc_get_syntax_manager(), xmldoc_has_inside(), xmldoc_has_nodes(), xmldoc_has_specialtags(), xmldoc_parse_cmd_enumlist(), xmldoc_parse_enumlist(), xmldoc_parse_option(), xmldoc_parse_optionlist(), xmldoc_parse_para(), xmldoc_parse_parameter(), xmldoc_parse_specialtags(), xmldoc_parse_variable(), and xmldoc_parse_variablelist().
struct ast_xml_node* ast_xml_node_get_next | ( | struct ast_xml_node * | node | ) | [read] |
Get the next node in the same level.
Definition at line 304 of file xml.c.
Referenced by ast_xml_find_element(), ast_xmldoc_build_arguments(), ast_xmldoc_build_seealso(), ast_xmldoc_build_syntax(), xmldoc_get_formatted(), xmldoc_get_node(), xmldoc_get_syntax_cmd(), xmldoc_get_syntax_fun(), xmldoc_get_syntax_manager(), xmldoc_has_inside(), xmldoc_has_nodes(), xmldoc_has_specialtags(), xmldoc_parse_argument(), xmldoc_parse_cmd_enumlist(), xmldoc_parse_enum(), xmldoc_parse_enumlist(), xmldoc_parse_option(), xmldoc_parse_optionlist(), xmldoc_parse_para(), xmldoc_parse_parameter(), xmldoc_parse_specialtags(), xmldoc_parse_variable(), and xmldoc_parse_variablelist().
struct ast_xml_node* ast_xml_node_get_parent | ( | struct ast_xml_node * | node | ) | [read] |
struct ast_xml_node* ast_xml_node_get_prev | ( | struct ast_xml_node * | node | ) | [read] |
struct ast_xml_doc* ast_xml_open | ( | char * | filename | ) | [read] |
Open an XML document.
filename | Document path. |
NULL | on error. | |
The | ast_xml_doc reference to the open document. |
Definition at line 55 of file xml.c.
00056 { 00057 xmlDoc *doc; 00058 00059 if (!filename) { 00060 return NULL; 00061 } 00062 00063 doc = xmlReadFile(filename, NULL, XML_PARSE_RECOVER); 00064 if (doc) { 00065 /* process xinclude elements. */ 00066 if (xmlXIncludeProcess(doc) < 0) { 00067 xmlFreeDoc(doc); 00068 return NULL; 00069 } 00070 } 00071 00072 return (struct ast_xml_doc *) doc; 00073 }
struct ast_xml_doc* ast_xml_read_memory | ( | char * | buffer, | |
size_t | size | |||
) | [read] |
Open an XML document that resides in memory.
buffer | The address where the document is stored | |
size | The number of bytes in the document |
NULL | on error. | |
The | ast_xml_doc reference to the open document. |
Definition at line 115 of file xml.c.
00116 { 00117 xmlDoc *doc; 00118 00119 if (!buffer) { 00120 return NULL; 00121 } 00122 00123 if (!(doc = xmlParseMemory(buffer, (int) size))) { 00124 /* process xinclude elements. */ 00125 if (xmlXIncludeProcess(doc) < 0) { 00126 xmlFreeDoc(doc); 00127 return NULL; 00128 } 00129 } 00130 00131 return (struct ast_xml_doc *) doc; 00132 }
int ast_xml_set_attribute | ( | struct ast_xml_node * | node, | |
const char * | name, | |||
const char * | value | |||
) |
Set an attribute to a node.
node | In which node we want to insert the attribute. | |
name | The attribute name. | |
value | The attribute value. |
0 | on success. | |
-1 | on error. |
void ast_xml_set_root | ( | struct ast_xml_doc * | doc, | |
struct ast_xml_node * | node | |||
) |
Specify the root node of a XML document.
doc | The document pointer. | |
node | A pointer to the node we want to set as root node. |
Definition at line 144 of file xml.c.
Referenced by ast_data_get_xml().
void ast_xml_set_text | ( | struct ast_xml_node * | node, | |
const char * | content | |||
) |
Set an element content string.
node | Node from where to set the content string. | |
content | The text to insert in the node. |
Definition at line 280 of file xml.c.
Referenced by data_get_xml_add_child().