xmlParseUtil.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2005 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/
/*******************************************************************************
** $RCSfile: xmlParseUtil.h,v $ $Revision: 1.2 $ $State: Exp $
*******************************************************************************/

#ifndef xmlParseUtil_H_
#define xmlParseUtil_H_
#include <vrvUtil/signalslib.h>

//
// \file xmlParseUtil.h
// \brief Collections of utility functions to aid in parsing XML files.
//

#include <vlutil/vlString.h>
#include <libxml/xmlreader.h>
      
// Finds the first node whose tag matches the one given by \p nodeName.   
// \param node Starting node for the search inside the xml document
// \param nodeName Name of the node to be searched (e.g. "GridStructure")
// \return 0 if no matches are found.
xmlNodePtr DtXmlFindNode(xmlNodePtr node, const char* nodeName);

// Finds the node named as nodeName and that also has an attribute named 
// attrName with a value of attrValue. For example, 
// <tt>findNode(nodeptr, "GridStructure", "name", "abc")</tt> searches for a 
// node that looks like <br> <br> <tt>
// <GridStructure name="abc"> <br>
// ... <br>
// </GridStructure>
// </tt>
// \return 0 if no matches are found.
xmlNodePtr DtXmlFindNode(xmlNodePtr node, const char* nodeName, 
   const char* attrName, const char *attrValue);

// Returns the value of the attribute attrname inside the node. Attributes
// are specified inside the node like this <br><br> <tt>
// <node \e attrname=\e value ...> <br>
// ... <br>
// </node>
// </tt>
// \param node Node to access
// \param attrname Name of the attribute to be searched (e.g. "name")
// \return The attribute's value if present or an empty DtSring otherwise.
DtString DtXmlGetAttrValue(xmlNodePtr node, const char* attrname);

// Returns the value of an "atomic" node. Atomic nodes are the ones that 
// have the following structure <tt><tag>value</tag></tt>. 
// \param node Node to start the search of the atomic node
// \param nodeName Name of the atomic node to be searched
// \return It returns an empty DtString if the node has the form or <tag></tag>   
DtString DtXmlGetAtomicNodeValue(xmlNodePtr node, const char* nodeName);

// \return the next node which is not a blank text node
void DtXmlNextNode(xmlNodePtr& node);

// Returns the value of an "atomic" node. Atomic nodes are the ones that 
// have the following structure <tag>value</tag>. It returns the empty
// string if the node has the form or <tag></tag>
DtString DtXmlGetAtomicNodeValue(xmlNodePtr node);

// Returns a pointer to the first child of the node or NULL if not defined
// The reason for this method is because libXml also includes blank text
// nodes sometimes, so they need to be filtered out. This function 
// guarantees you get an actual child node as the first node
xmlNodePtr DtXmlGetChildren(xmlNodePtr node);

#endif