zenilib
0.5.3.0
|
#include <tinyxml.h>
A TiXmlHandle is a class that wraps a node pointer with null checks; this is an incredibly useful thing. Note that TiXmlHandle is not part of the TinyXml DOM structure. It is a separate utility class.
Take an example:
<Document> <Element attributeA = "valueA"> <Child attributeB = "value1" /> <Child attributeB = "value2" /> </Element> <Document>
Assuming you want the value of "attributeB" in the 2nd "Child" element, it's very easy to write a lot of code that looks like:
TiXmlElement* root = document.FirstChildElement( "Document" ); if ( root ) { TiXmlElement* element = root->FirstChildElement( "Element" ); if ( element ) { TiXmlElement* child = element->FirstChildElement( "Child" ); if ( child ) { TiXmlElement* child2 = child->NextSiblingElement( "Child" ); if ( child2 ) { // Finally do something useful.
And that doesn't even cover "else" cases. TiXmlHandle addresses the verbosity of such code. A TiXmlHandle checks for null pointers so it is perfectly safe and correct to use:
TiXmlHandle docHandle( &document ); TiXmlElement* child2 = docHandle.FirstChild( "Document" ).FirstChild( "Element" ).Child( "Child", 1 ).ToElement(); if ( child2 ) { // do something useful
Which is MUCH more concise and useful.
It is also safe to copy handles - internally they are nothing more than node pointers.
TiXmlHandle handleCopy = handle;
What they should not be used for is iteration:
int i=0; while ( true ) { TiXmlElement* child = docHandle.FirstChild( "Document" ).FirstChild( "Element" ).Child( "Child", i ).ToElement(); if ( !child ) break; // do something ++i; }
It seems reasonable, but it is in fact two embedded while loops. The Child method is a linear walk to find the element, so this code would iterate much more than it needs to. Instead, prefer:
TiXmlElement* child = docHandle.FirstChild( "Document" ).FirstChild( "Element" ).FirstChild( "Child" ).ToElement(); for( child; child; child=child->NextSiblingElement() ) { // do something }
|
inline |
Create a handle from any node (at any depth of the tree.) This can be a null pointer.
Definition at line 1635 of file tinyxml.h.
Referenced by Child(), ChildElement(), FirstChild(), and FirstChildElement().
|
inline |
TiXmlHandle TiXmlHandle::Child | ( | const char * | value, |
int | index | ||
) | const |
Return a handle to the "index" child with the given name. The first child is 0, the second 1, etc.
Definition at line 1652 of file tinyxml.cpp.
References TiXmlNode::FirstChild(), i, TiXmlNode::NextSibling(), and TiXmlHandle().
TiXmlHandle TiXmlHandle::Child | ( | int | index | ) | const |
Return a handle to the "index" child. The first child is 0, the second 1, etc.
Definition at line 1633 of file tinyxml.cpp.
References TiXmlNode::FirstChild(), i, TiXmlNode::NextSibling(), and TiXmlHandle().
TiXmlHandle TiXmlHandle::ChildElement | ( | const char * | value, |
int | index | ||
) | const |
Return a handle to the "index" child element with the given name. The first child element is 0, the second 1, etc. Note that only TiXmlElements are indexed: other types are not counted.
Definition at line 1690 of file tinyxml.cpp.
References TiXmlNode::FirstChildElement(), i, TiXmlNode::NextSiblingElement(), and TiXmlHandle().
TiXmlHandle TiXmlHandle::ChildElement | ( | int | index | ) | const |
Return a handle to the "index" child element. The first child element is 0, the second 1, etc. Note that only TiXmlElements are indexed: other types are not counted.
Definition at line 1671 of file tinyxml.cpp.
References TiXmlNode::FirstChildElement(), i, TiXmlNode::NextSiblingElement(), and TiXmlHandle().
|
inline |
TiXmlHandle TiXmlHandle::FirstChild | ( | ) | const |
Return a handle to the first child node.
Definition at line 1585 of file tinyxml.cpp.
References TiXmlNode::FirstChild(), and TiXmlHandle().
TiXmlHandle TiXmlHandle::FirstChild | ( | const char * | value | ) | const |
Return a handle to the first child node with the given name.
Definition at line 1597 of file tinyxml.cpp.
References TiXmlNode::FirstChild(), and TiXmlHandle().
TiXmlHandle TiXmlHandle::FirstChildElement | ( | ) | const |
Return a handle to the first child element.
Definition at line 1609 of file tinyxml.cpp.
References TiXmlNode::FirstChildElement(), and TiXmlHandle().
TiXmlHandle TiXmlHandle::FirstChildElement | ( | const char * | value | ) | const |
Return a handle to the first child element with the given name.
Definition at line 1621 of file tinyxml.cpp.
References TiXmlNode::FirstChildElement(), and TiXmlHandle().
|
inline |
|
inline |
Return the handle as a TiXmlElement. This may return null.
Definition at line 1681 of file tinyxml.h.
Referenced by Zeni::XML_Element_c::good(), Zeni::XML_Element_c::to_string(), and Zeni::XML_Element_c::value().
|
inline |
Return the handle as a TiXmlNode. This may return null.
Definition at line 1678 of file tinyxml.h.
Referenced by Zeni::XML_Element_c::child(), Zeni::XML_Element_c::child_element(), Zeni::XML_Element::create_child(), Zeni::XML_Element_c::first(), Zeni::XML_Element::first(), Zeni::XML_Element_c::first_child(), Zeni::XML_Element_c::first_child_element(), Zeni::XML_Element_c::next(), Zeni::XML_Element::next(), Zeni::XML_Element_c::operator[](), Zeni::XML_Element::operator[](), Zeni::XML_Element::remove_child(), and Zeni::XML_Element::set_string().
|
inline |
|
inline |
Return the handle as a TiXmlUnknown. This may return null.
|
inline |