Merge changes from team/group/appdocsxml

This commit introduces the first phase of an effort to manage documentation of the
interfaces in Asterisk in an XML format.  Currently, a new format is available for
applications and dialplan functions.  A good number of conversions to the new format
are also included.

For more information, see the following message to asterisk-dev:

http://lists.digium.com/pipermail/asterisk-dev/2008-October/034968.html


git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@153365 65c4cc65-6c06-0410-ace0-fbb531ad65f3

1 files changed, 195 insertions, 0 deletions

diff --git a/main/xml.c b/main/xml.c
new file mode 100644
index 000000000..9a0c66d90
--- /dev/null
+++ b/main/xml.c
@@ -0,0 +1,195 @@
+/*
+ * 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>
+/* 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);
+
+	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) */
+