Changeset 2727 for pjproject/trunk/pjlib-util/include/pjlib-util/xml.h

Timestamp:

Jun 1, 2009 9:28:28 AM (15 years ago)

Author:

bennylp

Message:

Ticket #868: Added functions to search XML child nodes recursively

File:

• pjproject/trunk/pjlib-util/include/pjlib-util/xml.h (modified) (6 diffs)

pjproject/trunk/pjlib-util/include/pjlib-util/xml.h

@@ -150 +150 @@
 
 /**
- * Find first node with the specified name.
+ * Find first direct child node with the specified name.
  *
  * @param parent    Parent node.
@@ -157 +157 @@
  * @return          XML node found or NULL.
  */
-PJ_DECL(pj_xml_node*) pj_xml_find_node(pj_xml_node *parent, const pj_str_t *name);
-
-/**
- * Find first node with the specified name.
+PJ_DECL(pj_xml_node*) pj_xml_find_node(const pj_xml_node *parent, 
+                                       const pj_str_t *name);
+
+/**
+ * Find next direct child node with the specified name.
  *
  * @param parent    Parent node.
@@ -168 +169 @@
  * @return          XML node found or NULL.
  */
-PJ_DECL(pj_xml_node*) pj_xml_find_next_node(pj_xml_node *parent, pj_xml_node *node,
+PJ_DECL(pj_xml_node*) pj_xml_find_next_node(const pj_xml_node *parent, 
+                                            const pj_xml_node *node,
                                             const pj_str_t *name);
 
 /**
- * Find first attribute within a node with the specified name and optional value.
+ * Recursively find the first node with the specified name in the child nodes
+ * and their children.
+ *
+ * @param parent    Parent node.
+ * @param name      Node name to find.
+ *
+ * @return          XML node found or NULL.
+ */
+PJ_DECL(pj_xml_node*) pj_xml_find_node_rec(const pj_xml_node *parent, 
+                                           const pj_str_t *name);
+
+
+/**
+ * Find first attribute within a node with the specified name and optional 
+ * value.
  *
  * @param node      XML Node.
@@ -180 +196 @@
  * @return          XML attribute found, or NULL.
  */
-PJ_DECL(pj_xml_attr*) pj_xml_find_attr(pj_xml_node *node, const pj_str_t *name,
+PJ_DECL(pj_xml_attr*) pj_xml_find_attr(const pj_xml_node *node, 
+                                       const pj_str_t *name,
                                        const pj_str_t *value);
 
@@ -188 +205 @@
  *
  * @param parent    Parent node.
- * @param name      Optional name.
+ * @param name      Optional name. If this is NULL, the name will not be
+ *                  matched.
  * @param data      Data to be passed to matching function.
  * @param match     Optional matching function.
@@ -194 +212 @@
  * @return          The first matched node, or NULL.
  */
-PJ_DECL(pj_xml_node*) pj_xml_find( pj_xml_node *parent, const pj_str_t *name,
+PJ_DECL(pj_xml_node*) pj_xml_find( const pj_xml_node *parent, 
+                                   const pj_str_t *name,
                                    const void *data, 
-                                   pj_bool_t (*match)(pj_xml_node *, const void*));
+                                   pj_bool_t (*match)(const pj_xml_node *, 
+                                                      const void*));
+
+
+/**
+ * Recursively find a child node with the specified name and match the 
+ * function.
+ *
+ * @param parent    Parent node.
+ * @param name      Optional name. If this is NULL, the name will not be
+ *                  matched.
+ * @param data      Data to be passed to matching function.
+ * @param match     Optional matching function.
+ *
+ * @return          The first matched node, or NULL.
+ */
+PJ_DECL(pj_xml_node*) pj_xml_find_rec(const pj_xml_node *parent, 
+                                      const pj_str_t *name,
+                                      const void *data, 
+                                      pj_bool_t (*match)(const pj_xml_node*, 
+                                                         const void*));