10 Package Traversal APIs for C

DocumentTraversal Interface

Table 10-1 summarizes the methods available through the DocumentTraversal interface.

XmlDomCreateNodeIter()

One of two methods of DocumentTraversal interface, used to create a NodeIterator object. This method is identical to XmlDomCreateTreeWalker() except for the type of object returned.

The whatToShow argument is a mask of flag bits, one for each node type. The value XMLDOM_SHOW_ALL passes all node types through, otherwise only the types whose bits are set will be passed.

Entity reference expansion is controlled by the entrefExpansion flag. If TRUE, entity references are replaced with their final content; if FALSE, entity references are left as nodes.

CAXML6089Syntax

xmliter* XmlDomCreateNodeIter(
   xmlctx *xctx,
   xmliter *iter,
   xmlnode *root,
   xmlshowbits whatToShow, 
   XMLDOM_ACCEPT_NODE_F(
      (*nodeFilter), 
      xctx, 
      node),
   boolean entrefExpand);

xctx

IN

iter

IN

xerr

IN

whatToShow

IN

nodeFilter

IN

xerr

IN

CAXML6090Returns

(xmliter *) original or new NodeIterator object

XmlDomCreateTreeWalker()

One of two methods of DocumentTraversal interface, used to create a TreeWalker object. This method is identical to XmlDomCreateNodeIter() except for the type of object returned.

The whatToShow argument is a mask of flag bits, one for each node type. The value XMLDOM_SHOW_ALL passes all node types through, otherwise only the types whose bits are set will be passed.

Entity reference expansion is controlled by the entrefExpansion flag. If TRUE, entity references are replaced with their final content; if FALSE, entity references are left as nodes.

CAXML6092Syntax

xmlwalk* XmlDomCreateTreeWalker(
   xmlctx *xctx, 
   xmlwalk* walker, 
   xmlnode *root,
   xmlshowbits whatToShow,
   XMLDOM_ACCEPT_NODE_F(
      (*nodeFilter),
      xctx,
      node),
   boolean entrefExpansion);

xctx

IN

walker

IN

xerr

IN

whatToShow

IN

nodeFilter

IN

xerr

IN

CAXML6093Returns

(xmlwalk *) new TreeWalker object

NodeFilter Interface

Table 10-2 summarizes the methods available through the NodeFilter interface.

XMLDOM_ACCEPT_NODE_F()

Sole method of NodeFilter interface. Given a node and a filter, determines the filtering action to perform.

This function pointer is passed to the node iterator/tree walker methods, as needed.

Values for xmlerr are:

• XMLERR_OK Accept the node. Navigation methods defined for NodeIterator or TreeWalker will return this node.

• XMLERR_FILTER_REJECT Reject the node. Navigation methods defined for NodeIterator or TreeWalker will not return this node. For TreeWalker, the children of this node will also be rejected. NodeIterators treat this as a synonym for XMLDOM_FILTER_SKIP

• XMLERR_FILTER_SKIP Skip this single node. Navigation methods defined for NodeIterator or TreeWalker will not return this node. For both NodeIterator and TreeWalker, the children of this node will still be considered.

CAXML6097Syntax

#define XMLDOM_ACCEPT_NODE_F(func, xctx, node)
xmlerr func(
   xmlctx *xctx,
   xmlnode *node);

xctx

IN

node

IN

CAXML6098Returns

(xmlerr) filtering result

NodeIterator Interface

Table 10-3 summarizes the methods available through the NodeIterator interface.

XmlDomIterDetach()

Detaches the NodeIterator from the set which it iterated over, releasing any resources and placing the iterator in the INVALID state. After detach has been invoked, calls to XmlDomIterNextNode or XmlDomIterPrevNode will raise the exception XMLERR_ITER_DETACHED.

CAXML6102Syntax

xmlerr XmlDomIterDetach(
   xmlctx *xctx, 
   xmliter *iter);

xctx

IN

iter

IN

XmlDomIterNextNode()

Returns the next node in the set and advances the position of the iterator in the set. After a node iterator is created, the first call to XmlDomIterNextNode returns the first node in the set. It assumed that the reference node (current iterator position) is never deleted. Otherwise, changes in the underlying DOM tree do not invalidate the iterator.

CAXML6104Syntax

xmlnode* XmlDomIterNextNode(
   xmlctx *xctx, 
   xmliter *iter, 
   xmlerr *xerr);

xctx

IN

iter

IN

xerr

OUT

CAXML6105Returns

(xmlnode *) next node in set being iterated over [or NULL]

XmlDomIterPrevNode()

Returns the previous node in the set and moves the position of the iterator backward in the set.

CAXML6107Syntax

xmlnode* XmlDomIterPrevNode(
   xmlctx *xctx, 
   xmliter *iter, 
   xmlerr *xerr);

xctx

IN

iter

IN

xerr

OUT

CAXML6108Returns

(xmlnode *) previous node in set being iterated over [or NULL]

TreeWalker Interface

Table 10-4 summarizes the methods available through the TreeWalker interface.

XmlDomWalkerFirstChild()

Moves the TreeWalker to the first visible child of the current node, and returns the new node. If the current node has no visible children, returns NULL, and retains the current node.

CAXML6112Syntax

xmlnode* XmlDomWalkerFirstChild(
   xmlctx *xctx,
   xmlwalk *walker,
   xmlerr *xerr);

xctx

IN

walker

IN

xerr

OUT

CAXML6113Returns

(xmlnode *) first visible child [or NULL]

XmlDomWalkerGetCurrentNode()

Return (get) current node, or NULL on error.

CAXML6115Syntax

xmlnode* XmlDomWalkerGetCurrentNode(
   xmlctx *xctx, 
   xmlwalk *walker, 
   xmlerr *xerr);

xctx

IN

walker

IN

xerr

OUT

CAXML6116Returns

(xmlnode *) current node

XmlDomWalkerGetRoot()

Return (get) root node, or NULL on error. Since the current node can be removed from under the root node together with a subtree where it belongs to, the current root node in a walker might have no relation to the current node any more. The TreeWalker iterations are based on the current node. However, the root node defines the space of an iteration. This function checks if the root node is still in the root node (ancestor) relation to the current node. If so, it returns this root node. Otherwise, it finds the root of the tree where the current node belongs to, and sets and returns this root as the root node of the walker. It returns NULL if the walker is a NULL pointer.

CAXML6118Syntax

xmlnode* XmlDomWalkerGetRoot(
   xmlctx *xctx, 
   xmlwalk *walker, 
   xmlerr *xerr);

xctx

IN

walker

IN

xerr

OUT

CAXML6119Returns

(xmlnode *) root node

XmlDomWalkerLastChild()

Moves the TreeWalker to the last visible child of the current node, and returns the new node. If the current node has no visible children, returns NULL, and retains the current node.

CAXML6121Syntax

xmlnode* XmlDomWalkerLastChild(
   xmlctx *xctx, 
   xmlwalk *walker,
    xmlerr *xerr);

xctx

IN

walker

IN

xerr

OUT

CAXML6122Returns

(xmlnode *) last visible children [or NULL]

XmlDomWalkerNextNode()

Moves the TreeWalker to the next visible node in document order relative to the current node, and returns the new node. If the current node has no next node, or if the search for the next node attempts to step upward from the TreeWalker's root node, returns NULL, and retains the current node.

CAXML6124Syntax

xmlnode* XmlDomWalkerNextNode(
   xmlctx *xctx, 
   xmlwalk *walker, 
   xmlerr *xerr);

xctx

IN

walker

IN

xerr

OUT

CAXML6125Returns

(xmlnode *) next node [or NULL]

XmlDomWalkerNextSibling()

Moves the TreeWalker to the next sibling of the current node, and returns the new node. If the current node has no visible next sibling, returns NULL, and retains the current node.

CAXML6127Syntax

xmlnode* XmlDomWalkerNextSibling(
   xmlctx *xctx, 
   xmlwalk *walker, 
   xmlerr *xerr);

xctx

IN

walker

IN

xerr

OUT

CAXML6128Returns

(xmlnode *) next sibling [or NULL]

XmlDomWalkerParentNode()

Moves to and returns the closest visible ancestor node of the current node. If the search for the parent node attempts to step upward from the TreeWalker's root node, or if it fails to find a visible ancestor node, this method retains the current position and returns null.

CAXML6130Syntax

xmlnode* XmlDomWalkerParentNode(
   xmlctx *xctx, 
   xmlwalk *walker, 
   xmlerr *xerr);

xctx

IN

walker

IN

xerr

OUT

CAXML6131Returns

(xmlnode *) parent node [or NULL]

XmlDomWalkerPrevNode()

Moves the TreeWalker to the previous visible node in document order relative to the current node, and returns the new node. If the current node has no previous node, or if the search for the previous node attempts to step upward from the TreeWalker's root node, returns NULL, and retains the current node.

CAXML6133Syntax

xmlnode* XmlDomWalkerPrevNode(
   xmlctx *xctx, 
   xmlwalk *walker, 
   xmlerr *xerr);

xctx

IN

walker

IN

xerr

OUT

CAXML6134Returns

(xmlnode *) previous node [or NULL]

XmlDomWalkerPrevSibling()

Moves the TreeWalker to the previous sibling of the current node, and returns the new node. If the current node has no visible previous sibling, returns NULL, and retains the current node.

CAXML6136Syntax

xmlnode* XmlDomWalkerPrevSibling(
   xmlctx *xctx, 
   xmlwalk *walker, 
   xmlerr *xerr);

xctx

IN

walker

IN

xerr

OUT

CAXML6137Returns

(xmlnode *) previous sibling [or NULL]

XmlDomWalkerSetCurrentNode()

Sets and returns new current node. It also checks if the root node is an ancestor of the new current node. If not it does not set the current node, returns NULL, and sets retval to XMLDOM_WALKER_BAD_NEW_CUR. Returns NULL if an error.

CAXML6139Syntax

xmlnode* XmlDomWalkerSetCurrentNode(
   xmlctx *xctx, 
   xmlwalk *walker, 
   xmlnode *node, 
   xmlerr *xerr);

xctx

IN

walker

IN

node

IN

xerr

OUT

CAXML6140Returns

(xmlnode *) new current node

XmlDomWalkerSetRoot()

Set the root node. Returns new root node if it is an ancestor of the current node. If not it signals an error and checks if the current root node is an ancestor of the current node. If yes it returns it. Otherwise it sets the root node to and returns the root of the tree where the current node belongs to. It returns NULL if the walker or the root node parameter is a NULL pointer.

CAXML6142Syntax

xmlnode* XmlDomWalkerSetRoot(
   xmlctx *xctx, 
   xmlwalk *walker, 
   xmlnode *node, 
   xmlerr *xerr);

xctx

IN

walker

IN

node

IN

xerr

OUT

CAXML6143Returns

(xmlnode *) new root node