Files
asterisk/main/xml.c
Eliel C. Sardanons 2f996a3ab4 Allow to include sections of other parts of the xml documentation.
Avoid duplicating xml documentation by allowing to include other parts of
the xml documentation using XInclude.
Example:
   <xi:include xpointer="xpointer(/docs/function[@name='CHANNEL']/synopsis)" />
(Insert this line to include the synopsis of the CHANNEL function xml
documentation).

It is also possible to include documentation from other files in the
'documentation/' directory using the href="" attribute inside a xinclude
element.

(closes issue #15107)
Reported by: lmadsen

(issue #14444)
Reported by: ewieling



git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@194982 65c4cc65-6c06-0410-ace0-fbb531ad65f3
2009-05-16 20:01:22 +00:00

203 lines
3.8 KiB
C

/*
* Asterisk -- An open source telephony toolkit.
*
* Copyright (C) 2008, Eliel C. Sardanons (LU1ALY) <eliels@gmail.com>
*
* See http://www.asterisk.org for more information about
* the Asterisk project. Please do not directly contact
* any of the maintainers of this project for assistance;
* the project provides a web site, mailing lists and IRC
* channels for your use.
*
* This program is free software, distributed under the terms of
* the GNU General Public License Version 2. See the LICENSE file
* at the top of the source tree.
*/
/*! \file
*
* \brief XML abstraction layer
*
* \author Eliel C. Sardanons (LU1ALY) <eliels@gmail.com>
*/
#include "asterisk.h"
#include "asterisk/xml.h"
ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
#if defined(HAVE_LIBXML2)
#include <libxml/parser.h>
#include <libxml/tree.h>
#include <libxml/xinclude.h>
/* libxml2 ast_xml implementation. */
int ast_xml_init(void)
{
LIBXML_TEST_VERSION
return 0;
}
int ast_xml_finish(void)
{
xmlCleanupParser();
return 0;
}
struct ast_xml_doc *ast_xml_open(char *filename)
{
xmlDoc *doc;
if (!filename) {
return NULL;
}
doc = xmlReadFile(filename, NULL, XML_PARSE_RECOVER);
if (doc) {
/* process xinclude elements. */
if (xmlXIncludeProcess(doc) <= 0) {
xmlFreeDoc(doc);
return NULL;
}
}
return (struct ast_xml_doc *) doc;
}
void ast_xml_close(struct ast_xml_doc *doc)
{
if (!doc) {
return;
}
xmlFreeDoc((xmlDoc *) doc);
doc = NULL;
}
struct ast_xml_node *ast_xml_get_root(struct ast_xml_doc *doc)
{
xmlNode *root_node;
if (!doc) {
return NULL;
}
root_node = xmlDocGetRootElement((xmlDoc *) doc);
return (struct ast_xml_node *) root_node;
}
void ast_xml_free_node(struct ast_xml_node *node)
{
if (!node) {
return;
}
xmlFreeNode((xmlNode *) node);
node = NULL;
}
void ast_xml_free_attr(const char *attribute)
{
if (attribute) {
xmlFree((char *) attribute);
}
}
void ast_xml_free_text(const char *text)
{
if (text) {
xmlFree((char *) text);
}
}
const char *ast_xml_get_attribute(struct ast_xml_node *node, const char *attrname)
{
xmlChar *attrvalue;
if (!node) {
return NULL;
}
if (!attrname) {
return NULL;
}
attrvalue = xmlGetProp((xmlNode *) node, (xmlChar *) attrname);
return (const char *) attrvalue;
}
struct ast_xml_node *ast_xml_find_element(struct ast_xml_node *root_node, const char *name, const char *attrname, const char *attrvalue)
{
struct ast_xml_node *cur;
const char *attr;
if (!root_node) {
return NULL;
}
for (cur = root_node; cur; cur = ast_xml_node_get_next(cur)) {
/* Check if the name matchs */
if (strcmp(ast_xml_node_get_name(cur), name)) {
continue;
}
/* We need to check for a specific attribute name? */
if (!attrname || !attrvalue) {
return cur;
}
/* Get the attribute, we need to compare it. */
if ((attr = ast_xml_get_attribute(cur, attrname))) {
/* does attribute name/value matches? */
if (!strcmp(attr, attrvalue)) {
ast_xml_free_attr(attr);
return cur;
}
ast_xml_free_attr(attr);
}
}
return NULL;
}
const char *ast_xml_get_text(struct ast_xml_node *node)
{
if (!node) {
return NULL;
}
return (const char *) xmlNodeGetContent((xmlNode *) node);
}
const char *ast_xml_node_get_name(struct ast_xml_node *node)
{
return (const char *) ((xmlNode *) node)->name;
}
struct ast_xml_node *ast_xml_node_get_children(struct ast_xml_node *node)
{
return (struct ast_xml_node *) ((xmlNode *) node)->children;
}
struct ast_xml_node *ast_xml_node_get_next(struct ast_xml_node *node)
{
return (struct ast_xml_node *) ((xmlNode *) node)->next;
}
struct ast_xml_node *ast_xml_node_get_prev(struct ast_xml_node *node)
{
return (struct ast_xml_node *) ((xmlNode *) node)->prev;
}
struct ast_xml_node *ast_xml_node_get_parent(struct ast_xml_node *node)
{
return (struct ast_xml_node *) ((xmlNode *) node)->parent;
}
#endif /* defined(HAVE_LIBXML2) */