#include <tinyxml.h>

Public Member Functions
	TiXmlHandle (TiXmlNode *_node)
	Create a handle from any node (at any depth of the tree.) This can be a null pointer. More...

	TiXmlHandle (const TiXmlHandle &ref)
	Copy constructor. More...

TiXmlHandle	operator= (const TiXmlHandle &ref)

TiXmlHandle	FirstChild () const
	Return a handle to the first child node. More...

TiXmlHandle	FirstChild (const char *value) const
	Return a handle to the first child node with the given name. More...

TiXmlHandle	FirstChildElement () const
	Return a handle to the first child element. More...

TiXmlHandle	FirstChildElement (const char *value) const
	Return a handle to the first child element with the given name. More...

TiXmlHandle	Child (const char *value, int index) const

TiXmlHandle	Child (int index) const

TiXmlHandle	ChildElement (const char *value, int index) const

TiXmlHandle	ChildElement (int index) const

TiXmlHandle	FirstChild (const std::string &_value) const

TiXmlHandle	FirstChildElement (const std::string &_value) const

TiXmlHandle	Child (const std::string &_value, int index) const

TiXmlHandle	ChildElement (const std::string &_value, int index) const

TiXmlNode *	ToNode () const

TiXmlElement *	ToElement () const

TiXmlText *	ToText () const

TiXmlUnknown *	ToUnknown () const

TiXmlNode *	Node () const

TiXmlElement *	Element () const

TiXmlText *	Text () const

TiXmlUnknown *	Unknown () const

Detailed Description

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
}

Definition at line 1555 of file tinyxml.h.

Constructor & Destructor Documentation

◆ TiXmlHandle() [1/2]

TiXmlHandle::TiXmlHandle ( TiXmlNode * _node )

inline

Create a handle from any node (at any depth of the tree.) This can be a null pointer.

Definition at line 1559 of file tinyxml.h.

Here is the caller graph for this function:

◆ TiXmlHandle() [2/2]

TiXmlHandle::TiXmlHandle ( const TiXmlHandle & ref )

inline

Copy constructor.

Definition at line 1561 of file tinyxml.h.

Member Function Documentation

◆ Child() [1/3]

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 1502 of file tinyxml.cpp.

Here is the call graph for this function:

◆ Child() [2/3]

TiXmlHandle TiXmlHandle::Child	(	const std::string &	_value,
		int	index
	)		const

inline

Definition at line 1596 of file tinyxml.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Child() [3/3]

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 1483 of file tinyxml.cpp.

Here is the call graph for this function:

◆ ChildElement() [1/3]

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 1540 of file tinyxml.cpp.

Here is the call graph for this function:

◆ ChildElement() [2/3]

TiXmlHandle TiXmlHandle::ChildElement	(	const std::string &	_value,
		int	index
	)		const

inline

Definition at line 1597 of file tinyxml.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ChildElement() [3/3]

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 1521 of file tinyxml.cpp.

Here is the call graph for this function:

◆ Element()

TiXmlElement* TiXmlHandle::Element ( ) const

inline

Deprecated:: use ToElement. Return the handle as a TiXmlElement. This may return null.

Definition at line 1620 of file tinyxml.h.

Here is the call graph for this function:

◆ FirstChild() [1/3]

TiXmlHandle TiXmlHandle::FirstChild ( ) const

Return a handle to the first child node.

Definition at line 1435 of file tinyxml.cpp.

Here is the call graph for this function:

◆ FirstChild() [2/3]

TiXmlHandle TiXmlHandle::FirstChild ( const char * value ) const

Return a handle to the first child node with the given name.

Definition at line 1447 of file tinyxml.cpp.

Here is the call graph for this function:

◆ FirstChild() [3/3]

TiXmlHandle TiXmlHandle::FirstChild ( const std::string & _value ) const

inline

Definition at line 1593 of file tinyxml.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ FirstChildElement() [1/3]

TiXmlHandle TiXmlHandle::FirstChildElement ( ) const

Return a handle to the first child element.

Definition at line 1459 of file tinyxml.cpp.

Here is the call graph for this function:

◆ FirstChildElement() [2/3]

TiXmlHandle TiXmlHandle::FirstChildElement ( const char * value ) const

Return a handle to the first child element with the given name.

Definition at line 1471 of file tinyxml.cpp.

Here is the call graph for this function:

◆ FirstChildElement() [3/3]

TiXmlHandle TiXmlHandle::FirstChildElement ( const std::string & _value ) const

inline

Definition at line 1594 of file tinyxml.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Node()

TiXmlNode* TiXmlHandle::Node ( ) const

inline

Deprecated:: use ToNode. Return the handle as a TiXmlNode. This may return null.

Definition at line 1616 of file tinyxml.h.

Here is the call graph for this function:

◆ operator=()

TiXmlHandle TiXmlHandle::operator= ( const TiXmlHandle & ref )

inline

Definition at line 1562 of file tinyxml.h.

◆ Text()

TiXmlText* TiXmlHandle::Text ( ) const

inline

Deprecated:: use ToText() Return the handle as a TiXmlText. This may return null.

Definition at line 1624 of file tinyxml.h.

Here is the call graph for this function:

◆ ToElement()

TiXmlElement* TiXmlHandle::ToElement ( ) const

inline

Return the handle as a TiXmlElement. This may return null.

Definition at line 1605 of file tinyxml.h.

Here is the caller graph for this function:

◆ ToNode()

TiXmlNode* TiXmlHandle::ToNode ( ) const

inline

Return the handle as a TiXmlNode. This may return null.

Definition at line 1602 of file tinyxml.h.

Here is the caller graph for this function:

◆ ToText()

TiXmlText* TiXmlHandle::ToText ( ) const

inline

Return the handle as a TiXmlText. This may return null.

Definition at line 1608 of file tinyxml.h.

Here is the caller graph for this function:

◆ ToUnknown()

TiXmlUnknown* TiXmlHandle::ToUnknown ( ) const

inline

Return the handle as a TiXmlUnknown. This may return null.

Definition at line 1611 of file tinyxml.h.

Here is the caller graph for this function:

◆ Unknown()

TiXmlUnknown* TiXmlHandle::Unknown ( ) const

inline

Deprecated:: use ToUnknown() Return the handle as a TiXmlUnknown. This may return null.

Definition at line 1628 of file tinyxml.h.

Here is the call graph for this function:

The documentation for this class was generated from the following files:

src/framework/xml/tinyxml.h
src/framework/xml/tinyxml.cpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ TiXmlHandle() [1/2]

◆ TiXmlHandle() [2/2]

Member Function Documentation

◆ Child() [1/3]

◆ Child() [2/3]

◆ Child() [3/3]

◆ ChildElement() [1/3]

◆ ChildElement() [2/3]

◆ ChildElement() [3/3]

◆ Element()

◆ FirstChild() [1/3]

◆ FirstChild() [2/3]

◆ FirstChild() [3/3]

◆ FirstChildElement() [1/3]

◆ FirstChildElement() [2/3]

◆ FirstChildElement() [3/3]

◆ Node()

◆ operator=()

◆ Text()

◆ ToElement()

◆ ToNode()

◆ ToText()

◆ ToUnknown()

◆ Unknown()