CMS 3D CMS Logo

Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | Friends

TiXmlNode Class Reference

#include <tinyxml.h>

Inheritance diagram for TiXmlNode:
TiXmlBase TiXmlComment TiXmlDeclaration TiXmlDocument TiXmlElement TiXmlText TiXmlUnknown

List of all members.

Public Types

enum  NodeType {
  DOCUMENT, ELEMENT, COMMENT, UNKNOWN,
  TEXT, DECLARATION, TYPECOUNT
}

Public Member Functions

virtual bool Accept (TiXmlVisitor *visitor) const =0
void Clear ()
 Delete all the children of this node. Does not affect 'this'.
virtual TiXmlNodeClone () const =0
const TiXmlNodeFirstChild () const
 The first child of this node. Will be null if there are no children.
const TiXmlNodeFirstChild (const std::string &_value) const
 STL std::string form.
TiXmlNodeFirstChild (const std::string &_value)
 STL std::string form.
TiXmlNodeFirstChild ()
const TiXmlNodeFirstChild (const char *value) const
TiXmlNodeFirstChild (const char *_value)
 The first child of this node with the matching 'value'. Will be null if none found.
const TiXmlElementFirstChildElement () const
 Convenience function to get through elements.
TiXmlElementFirstChildElement ()
const TiXmlElementFirstChildElement (const char *_value) const
 Convenience function to get through elements.
TiXmlElementFirstChildElement (const char *_value)
const TiXmlElementFirstChildElement (const std::string &_value) const
 STL std::string form.
TiXmlElementFirstChildElement (const std::string &_value)
 STL std::string form.
const TiXmlDocumentGetDocument () const
TiXmlDocumentGetDocument ()
TiXmlNodeInsertAfterChild (TiXmlNode *afterThis, const TiXmlNode &addThis)
TiXmlNodeInsertBeforeChild (TiXmlNode *beforeThis, const TiXmlNode &addThis)
TiXmlNodeInsertEndChild (const TiXmlNode &addThis)
const TiXmlNodeIterateChildren (const TiXmlNode *previous) const
TiXmlNodeIterateChildren (const TiXmlNode *previous)
const TiXmlNodeIterateChildren (const char *value, const TiXmlNode *previous) const
 This flavor of IterateChildren searches for children with a particular 'value'.
TiXmlNodeIterateChildren (const char *_value, const TiXmlNode *previous)
const TiXmlNodeIterateChildren (const std::string &_value, const TiXmlNode *previous) const
 STL std::string form.
TiXmlNodeIterateChildren (const std::string &_value, const TiXmlNode *previous)
 STL std::string form.
TiXmlNodeLastChild (const char *_value)
 The last child of this node matching 'value'. Will be null if there are no children.
const TiXmlNodeLastChild (const char *value) const
const TiXmlNodeLastChild (const std::string &_value) const
 STL std::string form.
TiXmlNodeLastChild (const std::string &_value)
 STL std::string form.
const TiXmlNodeLastChild () const
TiXmlNodeLastChild ()
 The last child of this node. Will be null if there are no children.
TiXmlNodeLinkEndChild (TiXmlNode *addThis)
const TiXmlNodeNextSibling (const std::string &_value) const
 STL std::string form.
TiXmlNodeNextSibling (const std::string &_value)
 STL std::string form.
const TiXmlNodeNextSibling () const
 Navigate to a sibling node.
TiXmlNodeNextSibling ()
const TiXmlNodeNextSibling (const char *) const
 Navigate to a sibling node with the given 'value'.
TiXmlNodeNextSibling (const char *_next)
TiXmlElementNextSiblingElement ()
const TiXmlElementNextSiblingElement () const
const TiXmlElementNextSiblingElement (const char *) const
TiXmlElementNextSiblingElement (const char *_next)
const TiXmlElementNextSiblingElement (const std::string &_value) const
 STL std::string form.
TiXmlElementNextSiblingElement (const std::string &_value)
 STL std::string form.
bool NoChildren () const
 Returns true if this node has no children.
const TiXmlNodeParent () const
TiXmlNodeParent ()
 One step up the DOM.
const TiXmlNodePreviousSibling () const
 Navigate to a sibling node.
TiXmlNodePreviousSibling ()
TiXmlNodePreviousSibling (const char *_prev)
const TiXmlNodePreviousSibling (const char *) const
 Navigate to a sibling node.
const TiXmlNodePreviousSibling (const std::string &_value) const
 STL std::string form.
TiXmlNodePreviousSibling (const std::string &_value)
 STL std::string form.
bool RemoveChild (TiXmlNode *removeThis)
 Delete a child of this node.
TiXmlNodeReplaceChild (TiXmlNode *replaceThis, const TiXmlNode &withThis)
void SetValue (const std::string &_value)
 STL std::string form.
void SetValue (const char *_value)
virtual const TiXmlCommentToComment () const
 Cast to a more defined type. Will return null if not of the requested type.
virtual TiXmlCommentToComment ()
 Cast to a more defined type. Will return null if not of the requested type.
virtual TiXmlDeclarationToDeclaration ()
 Cast to a more defined type. Will return null if not of the requested type.
virtual const TiXmlDeclarationToDeclaration () const
 Cast to a more defined type. Will return null if not of the requested type.
virtual const TiXmlDocumentToDocument () const
 Cast to a more defined type. Will return null if not of the requested type.
virtual TiXmlDocumentToDocument ()
 Cast to a more defined type. Will return null if not of the requested type.
virtual TiXmlElementToElement ()
 Cast to a more defined type. Will return null if not of the requested type.
virtual const TiXmlElementToElement () const
 Cast to a more defined type. Will return null if not of the requested type.
virtual TiXmlTextToText ()
 Cast to a more defined type. Will return null if not of the requested type.
virtual const TiXmlTextToText () const
 Cast to a more defined type. Will return null if not of the requested type.
virtual const TiXmlUnknownToUnknown () const
 Cast to a more defined type. Will return null if not of the requested type.
virtual TiXmlUnknownToUnknown ()
 Cast to a more defined type. Will return null if not of the requested type.
int Type () const
const char * Value () const
const std::string & ValueStr () const
const TIXML_STRING & ValueTStr () const
virtual ~TiXmlNode ()

Protected Member Functions

void CopyTo (TiXmlNode *target) const
TiXmlNodeIdentify (const char *start, TiXmlEncoding encoding)
virtual void StreamIn (std::istream *in, TIXML_STRING *tag)=0
 TiXmlNode (NodeType _type)

Protected Attributes

TiXmlNodefirstChild
TiXmlNodelastChild
TiXmlNodenext
TiXmlNodeparent
TiXmlNodeprev
NodeType type
TIXML_STRING value

Private Member Functions

TiXmlNodeoperator= (const TiXmlNode &base)
 TiXmlNode (const TiXmlNode &)

Friends

std::ostream & operator<< (std::ostream &out, const TiXmlNode &base)
std::string & operator<< (std::string &out, const TiXmlNode &base)
 Appends the XML node or attribute to a std::string.
std::istream & operator>> (std::istream &in, TiXmlNode &base)
class TiXmlDocument
class TiXmlElement

Detailed Description

The parent class for everything in the Document Object Model. (Except for attributes). Nodes have siblings, a parent, and children. A node can be in a document, or stand on its own. The type of a TiXmlNode can be queried, and it can be cast to its more defined type.

Definition at line 427 of file tinyxml.h.


Member Enumeration Documentation

The types of XML nodes supported by TinyXml. (All the unsupported types are picked up by UNKNOWN.)

Enumerator:
DOCUMENT 
ELEMENT 
COMMENT 
UNKNOWN 
TEXT 
DECLARATION 
TYPECOUNT 

Definition at line 466 of file tinyxml.h.


Constructor & Destructor Documentation

TiXmlNode::~TiXmlNode ( ) [virtual]

Definition at line 154 of file tinyxml.cc.

References firstChild, next, python::Node::node, and groupFilesInBlocks::temp.

{
        TiXmlNode* node = firstChild;
        TiXmlNode* temp = 0;

        while ( node )
        {
                temp = node;
                node = node->next;
                delete temp;
        }
}
TiXmlNode::TiXmlNode ( NodeType  _type) [protected]

Definition at line 143 of file tinyxml.cc.

References firstChild, lastChild, next, parent, and prev.

                                     : TiXmlBase()
{
        parent = 0;
        type = _type;
        firstChild = 0;
        lastChild = 0;
        prev = 0;
        next = 0;
}
TiXmlNode::TiXmlNode ( const TiXmlNode ) [private]

Member Function Documentation

virtual bool TiXmlNode::Accept ( TiXmlVisitor visitor) const [pure virtual]

Accept a hierchical visit the nodes in the TinyXML DOM. Every node in the XML tree will be conditionally visited and the host will be called back via the TiXmlVisitor interface.

This is essentially a SAX interface for TinyXML. (Note however it doesn't re-parse the XML for the callbacks, so the performance of TinyXML is unchanged by using this interface versus any other.)

The interface has been based on ideas from:

Which are both good references for "visiting".

An example of using Accept():

		TiXmlPrinter printer;
		tinyxmlDoc.Accept( &printer );
		const char* xmlcstr = printer.CStr();
		

Implemented in TiXmlElement, TiXmlComment, TiXmlText, TiXmlDeclaration, TiXmlUnknown, and TiXmlDocument.

void TiXmlNode::Clear ( )

Delete all the children of this node. Does not affect 'this'.

Definition at line 175 of file tinyxml.cc.

References firstChild, lastChild, next, python::Node::node, and groupFilesInBlocks::temp.

Referenced by TiXmlElement::ClearThis(), TiXmlDocument::LoadFile(), TiXmlComment::operator=(), TiXmlDocument::operator=(), and TiXmlDeclaration::operator=().

{
        TiXmlNode* node = firstChild;
        TiXmlNode* temp = 0;

        while ( node )
        {
                temp = node;
                node = node->next;
                delete temp;
        }

        firstChild = 0;
        lastChild = 0;
}
virtual TiXmlNode* TiXmlNode::Clone ( ) const [pure virtual]

Create an exact duplicate of this node and return it. The memory must be deleted by the caller.

Implemented in TiXmlElement, TiXmlComment, TiXmlText, TiXmlDeclaration, TiXmlUnknown, and TiXmlDocument.

Referenced by TiXmlElement::CopyTo(), TiXmlDocument::CopyTo(), InsertAfterChild(), InsertBeforeChild(), InsertEndChild(), and ReplaceChild().

void TiXmlNode::CopyTo ( TiXmlNode target) const [protected]

Definition at line 168 of file tinyxml.cc.

References SetValue(), TiXmlBase::userData, and value.

{
        target->SetValue (value.c_str() );
        target->userData = userData;
}
const TiXmlNode* TiXmlNode::FirstChild ( ) const [inline]

The first child of this node. Will be null if there are no children.

Definition at line 526 of file tinyxml.h.

References firstChild.

Referenced by TiXmlDocument::Accept(), TiXmlElement::Accept(), FirstChildElement(), TiXmlElement::GetText(), IterateChildren(), TiXmlDocument::Print(), TiXmlPrinter::VisitEnter(), and TiXmlPrinter::VisitExit().

const TiXmlNode* TiXmlNode::FirstChild ( const std::string &  _value) const [inline]

STL std::string form.

Definition at line 544 of file tinyxml.h.

References FirstChild().

Referenced by FirstChild().

TiXmlNode* TiXmlNode::FirstChild ( const std::string &  _value) [inline]

STL std::string form.

Definition at line 545 of file tinyxml.h.

References FirstChild().

Referenced by FirstChild().

TiXmlNode* TiXmlNode::FirstChild ( ) [inline]

Definition at line 527 of file tinyxml.h.

References firstChild.

{ return firstChild; }
const TiXmlNode * TiXmlNode::FirstChild ( const char *  value) const

The first child of this node with the matching 'value'. Will be null if none found.

Definition at line 348 of file tinyxml.cc.

References firstChild, next, python::Node::node, and Value().

{
        const TiXmlNode* node;
        for ( node = firstChild; node; node = node->next )
        {
                if ( strcmp( node->Value(), _value ) == 0 )
                        return node;
        }
        return 0;
}
TiXmlNode* TiXmlNode::FirstChild ( const char *  _value) [inline]

The first child of this node with the matching 'value'. Will be null if none found.

Definition at line 530 of file tinyxml.h.

                                                     {
                // Call through to the const version - safe since nothing is changed. Exiting syntax: cast this to a const (always safe)
                // call the method, cast the return back to non-const.
                return const_cast< TiXmlNode* > ((const_cast< const TiXmlNode* >(this))->FirstChild( _value ));
        }
const TiXmlElement * TiXmlNode::FirstChildElement ( ) const

Convenience function to get through elements.

Definition at line 439 of file tinyxml.cc.

References FirstChild(), NextSibling(), python::Node::node, and ToElement().

Referenced by TiXmlDocument::RootElement().

{
        const TiXmlNode* node;

        for (   node = FirstChild();
                        node;
                        node = node->NextSibling() )
        {
                if ( node->ToElement() )
                        return node->ToElement();
        }
        return 0;
}
TiXmlElement* TiXmlNode::FirstChildElement ( ) [inline]

Definition at line 669 of file tinyxml.h.

                                          {
                return const_cast< TiXmlElement* >( (const_cast< const TiXmlNode* >(this))->FirstChildElement() );
        }
const TiXmlElement * TiXmlNode::FirstChildElement ( const char *  _value) const

Convenience function to get through elements.

Definition at line 454 of file tinyxml.cc.

References FirstChild(), NextSibling(), python::Node::node, and ToElement().

{
        const TiXmlNode* node;

        for (   node = FirstChild( _value );
                        node;
                        node = node->NextSibling( _value ) )
        {
                if ( node->ToElement() )
                        return node->ToElement();
        }
        return 0;
}
TiXmlElement* TiXmlNode::FirstChildElement ( const char *  _value) [inline]

Definition at line 675 of file tinyxml.h.

                                                               {
                return const_cast< TiXmlElement* >( (const_cast< const TiXmlNode* >(this))->FirstChildElement( _value ) );
        }
const TiXmlElement* TiXmlNode::FirstChildElement ( const std::string &  _value) const [inline]

STL std::string form.

Definition at line 680 of file tinyxml.h.

References FirstChildElement().

Referenced by FirstChildElement().

TiXmlElement* TiXmlNode::FirstChildElement ( const std::string &  _value) [inline]

STL std::string form.

Definition at line 681 of file tinyxml.h.

References FirstChildElement().

Referenced by FirstChildElement().

const TiXmlDocument * TiXmlNode::GetDocument ( ) const

Return a pointer to the Document this node lives in. Returns null if not in a document.

Definition at line 499 of file tinyxml.cc.

References python::Node::node, parent, and ToDocument().

Referenced by Identify(), InsertAfterChild(), InsertBeforeChild(), InsertEndChild(), LinkEndChild(), TiXmlElement::Parse(), TiXmlComment::Parse(), TiXmlDeclaration::Parse(), TiXmlUnknown::Parse(), TiXmlText::Parse(), TiXmlElement::ReadValue(), and TiXmlElement::SetAttribute().

{
        const TiXmlNode* node;

        for( node = this; node; node = node->parent )
        {
                if ( node->ToDocument() )
                        return node->ToDocument();
        }
        return 0;
}
TiXmlDocument* TiXmlNode::GetDocument ( ) [inline]

Definition at line 694 of file tinyxml.h.

                                     {
                return const_cast< TiXmlDocument* >( (const_cast< const TiXmlNode* >(this))->GetDocument() );
        }
TiXmlNode * TiXmlNode::Identify ( const char *  start,
TiXmlEncoding  encoding 
) [protected]

Definition at line 828 of file tinyxmlparser.cc.

References asciidump::doc, GetDocument(), TiXmlBase::IsAlpha(), parent, TiXmlText::SetCDATA(), TiXmlDocument::SetError(), TiXmlBase::SkipWhiteSpace(), TiXmlBase::StringEqual(), runonSM::text, TIXML_ENCODING_UNKNOWN, TiXmlBase::TIXML_ERROR_OUT_OF_MEMORY, and TiXmlElement.

Referenced by TiXmlDocument::Parse(), and TiXmlElement::ReadValue().

{
        TiXmlNode* returnNode = 0;

        p = SkipWhiteSpace( p, encoding );
        if( !p || !*p || *p != '<' )
        {
                return 0;
        }

        TiXmlDocument* doc = GetDocument();
        p = SkipWhiteSpace( p, encoding );

        if ( !p || !*p )
        {
                return 0;
        }

        // What is this thing?
        // - Elements start with a letter or underscore, but xml is reserved.
        // - Comments: <!--
        // - Decleration: <?xml
        // - Everthing else is unknown to tinyxml.
        //

        const char* xmlHeader = { "<?xml" };
        const char* commentHeader = { "<!--" };
        const char* dtdHeader = { "<!" };
        const char* cdataHeader = { "<![CDATA[" };

        if ( StringEqual( p, xmlHeader, true, encoding ) )
        {
                #ifdef DEBUG_PARSER
                        TIXML_LOG( "XML parsing Declaration\n" );
                #endif
                returnNode = new TiXmlDeclaration();
        }
        else if ( StringEqual( p, commentHeader, false, encoding ) )
        {
                #ifdef DEBUG_PARSER
                        TIXML_LOG( "XML parsing Comment\n" );
                #endif
                returnNode = new TiXmlComment();
        }
        else if ( StringEqual( p, cdataHeader, false, encoding ) )
        {
                #ifdef DEBUG_PARSER
                        TIXML_LOG( "XML parsing CDATA\n" );
                #endif
                TiXmlText* text = new TiXmlText( "" );
                text->SetCDATA( true );
                returnNode = text;
        }
        else if ( StringEqual( p, dtdHeader, false, encoding ) )
        {
                #ifdef DEBUG_PARSER
                        TIXML_LOG( "XML parsing Unknown(1)\n" );
                #endif
                returnNode = new TiXmlUnknown();
        }
        else if (    IsAlpha( *(p+1), encoding )
                          || *(p+1) == '_' )
        {
                #ifdef DEBUG_PARSER
                        TIXML_LOG( "XML parsing Element\n" );
                #endif
                returnNode = new TiXmlElement( "" );
        }
        else
        {
                #ifdef DEBUG_PARSER
                        TIXML_LOG( "XML parsing Unknown(2)\n" );
                #endif
                returnNode = new TiXmlUnknown();
        }

        if ( returnNode )
        {
                // Set the parent, so it can report errors
                returnNode->parent = this;
        }
        else
        {
                if ( doc )
                        doc->SetError( TIXML_ERROR_OUT_OF_MEMORY, 0, 0, TIXML_ENCODING_UNKNOWN );
        }
        return returnNode;
}
TiXmlNode * TiXmlNode::InsertAfterChild ( TiXmlNode afterThis,
const TiXmlNode addThis 
)

Add a new node related to this. Adds a child after the specified child. Returns a pointer to the new object or NULL if an error occurred.

Definition at line 266 of file tinyxml.cc.

References Clone(), DOCUMENT, GetDocument(), lastChild, next, python::Node::node, parent, prev, TiXmlDocument::SetError(), TIXML_ENCODING_UNKNOWN, TiXmlBase::TIXML_ERROR_DOCUMENT_TOP_ONLY, and Type().

{
        if ( !afterThis || afterThis->parent != this ) {
                return 0;
        }
        if ( addThis.Type() == TiXmlNode::DOCUMENT )
        {
                if ( GetDocument() ) GetDocument()->SetError( TIXML_ERROR_DOCUMENT_TOP_ONLY, 0, 0, TIXML_ENCODING_UNKNOWN );
                return 0;
        }

        TiXmlNode* node = addThis.Clone();
        if ( !node )
                return 0;
        node->parent = this;

        node->prev = afterThis;
        node->next = afterThis->next;
        if ( afterThis->next )
        {
                afterThis->next->prev = node;
        }
        else
        {
                assert( lastChild == afterThis );
                lastChild = node;
        }
        afterThis->next = node;
        return node;
}
TiXmlNode * TiXmlNode::InsertBeforeChild ( TiXmlNode beforeThis,
const TiXmlNode addThis 
)

Add a new node related to this. Adds a child before the specified child. Returns a pointer to the new object or NULL if an error occurred.

Definition at line 234 of file tinyxml.cc.

References Clone(), DOCUMENT, firstChild, GetDocument(), next, python::Node::node, parent, prev, TiXmlDocument::SetError(), TIXML_ENCODING_UNKNOWN, TiXmlBase::TIXML_ERROR_DOCUMENT_TOP_ONLY, and Type().

{
        if ( !beforeThis || beforeThis->parent != this ) {
                return 0;
        }
        if ( addThis.Type() == TiXmlNode::DOCUMENT )
        {
                if ( GetDocument() ) GetDocument()->SetError( TIXML_ERROR_DOCUMENT_TOP_ONLY, 0, 0, TIXML_ENCODING_UNKNOWN );
                return 0;
        }

        TiXmlNode* node = addThis.Clone();
        if ( !node )
                return 0;
        node->parent = this;

        node->next = beforeThis;
        node->prev = beforeThis->prev;
        if ( beforeThis->prev )
        {
                beforeThis->prev->next = node;
        }
        else
        {
                assert( firstChild == beforeThis );
                firstChild = node;
        }
        beforeThis->prev = node;
        return node;
}
TiXmlNode * TiXmlNode::InsertEndChild ( const TiXmlNode addThis)

Add a new node related to this. Adds a child past the LastChild. Returns a pointer to the new object or NULL if an error occurred.

Definition at line 219 of file tinyxml.cc.

References Clone(), DOCUMENT, GetDocument(), LinkEndChild(), python::Node::node, TiXmlDocument::SetError(), TIXML_ENCODING_UNKNOWN, TiXmlBase::TIXML_ERROR_DOCUMENT_TOP_ONLY, and Type().

{
        if ( addThis.Type() == TiXmlNode::DOCUMENT )
        {
                if ( GetDocument() ) GetDocument()->SetError( TIXML_ERROR_DOCUMENT_TOP_ONLY, 0, 0, TIXML_ENCODING_UNKNOWN );
                return 0;
        }
        TiXmlNode* node = addThis.Clone();
        if ( !node )
                return 0;

        return LinkEndChild( node );
}
const TiXmlNode * TiXmlNode::IterateChildren ( const TiXmlNode previous) const

An alternate way to walk the children of a node. One way to iterate over nodes is:

			for( child = parent->FirstChild(); child; child = child->NextSibling() )
		

IterateChildren does the same thing with the syntax:

			child = 0;
			while( child = parent->IterateChildren( child ) )
		

IterateChildren takes the previous child as input and finds the next one. If the previous child is null, it returns the first. IterateChildren will return null when done.

Definition at line 372 of file tinyxml.cc.

References FirstChild(), NextSibling(), and parent.

{
        if ( !previous )
        {
                return FirstChild();
        }
        else
        {
                assert( previous->parent == this );
                return previous->NextSibling();
        }
}
TiXmlNode* TiXmlNode::IterateChildren ( const TiXmlNode previous) [inline]

Definition at line 567 of file tinyxml.h.

                                                                {
                return const_cast< TiXmlNode* >( (const_cast< const TiXmlNode* >(this))->IterateChildren( previous ) );
        }
const TiXmlNode * TiXmlNode::IterateChildren ( const char *  value,
const TiXmlNode previous 
) const

This flavor of IterateChildren searches for children with a particular 'value'.

Definition at line 386 of file tinyxml.cc.

References FirstChild(), NextSibling(), and parent.

{
        if ( !previous )
        {
                return FirstChild( val );
        }
        else
        {
                assert( previous->parent == this );
                return previous->NextSibling( val );
        }
}
const TiXmlNode* TiXmlNode::IterateChildren ( const std::string &  _value,
const TiXmlNode previous 
) const [inline]

STL std::string form.

Definition at line 578 of file tinyxml.h.

References IterateChildren().

Referenced by IterateChildren().

TiXmlNode* TiXmlNode::IterateChildren ( const char *  _value,
const TiXmlNode previous 
) [inline]

Definition at line 573 of file tinyxml.h.

                                                                                     {
                return const_cast< TiXmlNode* >( (const_cast< const TiXmlNode* >(this))->IterateChildren( _value, previous ) );
        }
TiXmlNode* TiXmlNode::IterateChildren ( const std::string &  _value,
const TiXmlNode previous 
) [inline]

STL std::string form.

Definition at line 579 of file tinyxml.h.

References IterateChildren().

Referenced by IterateChildren().

TiXmlNode* TiXmlNode::LastChild ( const char *  _value) [inline]

The last child of this node matching 'value'. Will be null if there are no children.

Definition at line 539 of file tinyxml.h.

                                                    {
                return const_cast< TiXmlNode* > ((const_cast< const TiXmlNode* >(this))->LastChild( _value ));
        }
const TiXmlNode* TiXmlNode::LastChild ( const std::string &  _value) const [inline]

STL std::string form.

Definition at line 546 of file tinyxml.h.

References LastChild().

Referenced by LastChild().

TiXmlNode* TiXmlNode::LastChild ( const std::string &  _value) [inline]

STL std::string form.

Definition at line 547 of file tinyxml.h.

References LastChild().

Referenced by LastChild().

const TiXmlNode* TiXmlNode::LastChild ( ) const [inline]

Definition at line 535 of file tinyxml.h.

References lastChild.

Referenced by TiXmlPrinter::VisitEnter().

{ return lastChild; }           
TiXmlNode* TiXmlNode::LastChild ( ) [inline]

The last child of this node. Will be null if there are no children.

Definition at line 536 of file tinyxml.h.

References lastChild.

{ return lastChild; }
const TiXmlNode * TiXmlNode::LastChild ( const char *  value) const

Definition at line 360 of file tinyxml.cc.

References lastChild, python::Node::node, prev, and Value().

{
        const TiXmlNode* node;
        for ( node = lastChild; node; node = node->prev )
        {
                if ( strcmp( node->Value(), _value ) == 0 )
                        return node;
        }
        return 0;
}
TiXmlNode * TiXmlNode::LinkEndChild ( TiXmlNode addThis)

Add a new node related to this. Adds a child past the LastChild.

NOTE: the node to be added is passed by pointer, and will be henceforth owned (and deleted) by tinyXml. This method is efficient and avoids an extra copy, but should be used with care as it uses a different memory model than the other insert functions.

See also:
InsertEndChild

Definition at line 192 of file tinyxml.cc.

References DOCUMENT, firstChild, GetDocument(), lastChild, next, python::Node::node, parent, prev, TiXmlDocument::SetError(), TIXML_ENCODING_UNKNOWN, TiXmlBase::TIXML_ERROR_DOCUMENT_TOP_ONLY, and Type().

Referenced by TiXmlElement::CopyTo(), TiXmlDocument::CopyTo(), InsertEndChild(), TiXmlDocument::Parse(), and TiXmlElement::ReadValue().

{
        assert( node->parent == 0 || node->parent == this );
        assert( node->GetDocument() == 0 || node->GetDocument() == this->GetDocument() );

        if ( node->Type() == TiXmlNode::DOCUMENT )
        {
                delete node;
                if ( GetDocument() ) GetDocument()->SetError( TIXML_ERROR_DOCUMENT_TOP_ONLY, 0, 0, TIXML_ENCODING_UNKNOWN );
                return 0;
        }

        node->parent = this;

        node->prev = lastChild;
        node->next = 0;

        if ( lastChild )
                lastChild->next = node;
        else
                firstChild = node;                      // it was an empty list.

        lastChild = node;
        return node;
}
const TiXmlNode* TiXmlNode::NextSibling ( const std::string &  _value) const [inline]
TiXmlNode* TiXmlNode::NextSibling ( const std::string &  _value) [inline]

STL std::string form.

Definition at line 631 of file tinyxml.h.

References NextSibling().

Referenced by NextSibling().

const TiXmlNode* TiXmlNode::NextSibling ( ) const [inline]

Navigate to a sibling node.

Definition at line 635 of file tinyxml.h.

References next.

Referenced by NextSiblingElement().

{ return next; }
TiXmlNode* TiXmlNode::NextSibling ( ) [inline]

Definition at line 636 of file tinyxml.h.

References next.

{ return next; }
const TiXmlNode * TiXmlNode::NextSibling ( const char *  _value) const

Navigate to a sibling node with the given 'value'.

Definition at line 400 of file tinyxml.cc.

References next, python::Node::node, and Value().

{
        const TiXmlNode* node;
        for ( node = next; node; node = node->next )
        {
                if ( strcmp( node->Value(), _value ) == 0 )
                        return node;
        }
        return 0;
}
TiXmlNode* TiXmlNode::NextSibling ( const char *  _next) [inline]

Definition at line 640 of file tinyxml.h.

                                                    {
                return const_cast< TiXmlNode* >( (const_cast< const TiXmlNode* >(this))->NextSibling( _next ) );
        }
const TiXmlElement * TiXmlNode::NextSiblingElement ( ) const

Convenience function to get through elements. Calls NextSibling and ToElement. Will skip all non-Element nodes. Returns 0 if there is not another element.

Definition at line 469 of file tinyxml.cc.

References NextSibling(), python::Node::node, and ToElement().

Referenced by TiXmlHandle::ChildElement().

{
        const TiXmlNode* node;

        for (   node = NextSibling();
                        node;
                        node = node->NextSibling() )
        {
                if ( node->ToElement() )
                        return node->ToElement();
        }
        return 0;
}
TiXmlElement* TiXmlNode::NextSiblingElement ( ) [inline]

Definition at line 649 of file tinyxml.h.

                                           {
                return const_cast< TiXmlElement* >( (const_cast< const TiXmlNode* >(this))->NextSiblingElement() );
        }
TiXmlElement* TiXmlNode::NextSiblingElement ( const char *  _next) [inline]

Definition at line 658 of file tinyxml.h.

                                                              {
                return const_cast< TiXmlElement* >( (const_cast< const TiXmlNode* >(this))->NextSiblingElement( _next ) );
        }
const TiXmlElement* TiXmlNode::NextSiblingElement ( const std::string &  _value) const [inline]

STL std::string form.

Definition at line 663 of file tinyxml.h.

References NextSiblingElement().

Referenced by NextSiblingElement().

TiXmlElement* TiXmlNode::NextSiblingElement ( const std::string &  _value) [inline]

STL std::string form.

Definition at line 664 of file tinyxml.h.

References NextSiblingElement().

Referenced by NextSiblingElement().

const TiXmlElement * TiXmlNode::NextSiblingElement ( const char *  _value) const

Convenience function to get through elements. Calls NextSibling and ToElement. Will skip all non-Element nodes. Returns 0 if there is not another element.

Definition at line 484 of file tinyxml.cc.

References NextSibling(), python::Node::node, and ToElement().

{
        const TiXmlNode* node;

        for (   node = NextSibling( _value );
                        node;
                        node = node->NextSibling( _value ) )
        {
                if ( node->ToElement() )
                        return node->ToElement();
        }
        return 0;
}
bool TiXmlNode::NoChildren ( ) const [inline]

Returns true if this node has no children.

Definition at line 699 of file tinyxml.h.

References firstChild.

{ return !firstChild; }
TiXmlNode& TiXmlNode::operator= ( const TiXmlNode base) [private]
const TiXmlNode* TiXmlNode::Parent ( ) const [inline]

Definition at line 524 of file tinyxml.h.

References parent.

{ return parent; }
TiXmlNode* TiXmlNode::Parent ( ) [inline]

One step up the DOM.

Definition at line 523 of file tinyxml.h.

References parent.

{ return parent; }
const TiXmlNode* TiXmlNode::PreviousSibling ( ) const [inline]

Navigate to a sibling node.

Definition at line 618 of file tinyxml.h.

References prev.

{ return prev; }
TiXmlNode* TiXmlNode::PreviousSibling ( ) [inline]

Definition at line 619 of file tinyxml.h.

References prev.

{ return prev; }
TiXmlNode* TiXmlNode::PreviousSibling ( const char *  _prev) [inline]

Definition at line 623 of file tinyxml.h.

                                                        {
                return const_cast< TiXmlNode* >( (const_cast< const TiXmlNode* >(this))->PreviousSibling( _prev ) );
        }
const TiXmlNode* TiXmlNode::PreviousSibling ( const std::string &  _value) const [inline]

STL std::string form.

Definition at line 628 of file tinyxml.h.

References PreviousSibling().

Referenced by PreviousSibling().

TiXmlNode* TiXmlNode::PreviousSibling ( const std::string &  _value) [inline]

STL std::string form.

Definition at line 629 of file tinyxml.h.

References PreviousSibling().

Referenced by PreviousSibling().

const TiXmlNode * TiXmlNode::PreviousSibling ( const char *  _value) const

Navigate to a sibling node.

Definition at line 412 of file tinyxml.cc.

References python::Node::node, prev, and Value().

{
        const TiXmlNode* node;
        for ( node = prev; node; node = node->prev )
        {
                if ( strcmp( node->Value(), _value ) == 0 )
                        return node;
        }
        return 0;
}
bool TiXmlNode::RemoveChild ( TiXmlNode removeThis)

Delete a child of this node.

Definition at line 326 of file tinyxml.cc.

References firstChild, lastChild, next, parent, and prev.

{
        if ( removeThis->parent != this )
        {
                assert( 0 );
                return false;
        }

        if ( removeThis->next )
                removeThis->next->prev = removeThis->prev;
        else
                lastChild = removeThis->prev;

        if ( removeThis->prev )
                removeThis->prev->next = removeThis->next;
        else
                firstChild = removeThis->next;

        delete removeThis;
        return true;
}
TiXmlNode * TiXmlNode::ReplaceChild ( TiXmlNode replaceThis,
const TiXmlNode withThis 
)

Replace a child of this node. Returns a pointer to the new object or NULL if an error occurred.

Definition at line 298 of file tinyxml.cc.

References Clone(), firstChild, lastChild, next, python::Node::node, parent, and prev.

{
        if ( replaceThis->parent != this )
                return 0;

        TiXmlNode* node = withThis.Clone();
        if ( !node )
                return 0;

        node->next = replaceThis->next;
        node->prev = replaceThis->prev;

        if ( replaceThis->next )
                replaceThis->next->prev = node;
        else
                lastChild = node;

        if ( replaceThis->prev )
                replaceThis->prev->next = node;
        else
                firstChild = node;

        delete replaceThis;
        node->parent = this;
        return node;
}
void TiXmlNode::SetValue ( const std::string &  _value) [inline]

STL std::string form.

Definition at line 516 of file tinyxml.h.

References value.

{ value = _value; }
void TiXmlNode::SetValue ( const char *  _value) [inline]

Changes the value of the node. Defined as:

		Document:	filename of the xml file
		Element:	name of the element
		Comment:	the comment text
		Unknown:	the tag contents
		Text:		the text string
		

Definition at line 512 of file tinyxml.h.

References value.

Referenced by CopyTo(), TiXmlComment::TiXmlComment(), and TiXmlText::TiXmlText().

{ value = _value;}
virtual void TiXmlNode::StreamIn ( std::istream *  in,
TIXML_STRING *  tag 
) [protected, pure virtual]
virtual const TiXmlComment* TiXmlNode::ToComment ( ) const [inline, virtual]

Cast to a more defined type. Will return null if not of the requested type.

Reimplemented in TiXmlComment.

Definition at line 703 of file tinyxml.h.

virtual TiXmlComment* TiXmlNode::ToComment ( ) [inline, virtual]

Cast to a more defined type. Will return null if not of the requested type.

Reimplemented in TiXmlComment.

Definition at line 710 of file tinyxml.h.

virtual const TiXmlDeclaration* TiXmlNode::ToDeclaration ( ) const [inline, virtual]

Cast to a more defined type. Will return null if not of the requested type.

Reimplemented in TiXmlDeclaration.

Definition at line 706 of file tinyxml.h.

Referenced by TiXmlDocument::Parse().

virtual TiXmlDeclaration* TiXmlNode::ToDeclaration ( ) [inline, virtual]

Cast to a more defined type. Will return null if not of the requested type.

Reimplemented in TiXmlDeclaration.

Definition at line 713 of file tinyxml.h.

virtual const TiXmlDocument* TiXmlNode::ToDocument ( ) const [inline, virtual]

Cast to a more defined type. Will return null if not of the requested type.

Reimplemented in TiXmlDocument.

Definition at line 701 of file tinyxml.h.

Referenced by GetDocument().

virtual TiXmlDocument* TiXmlNode::ToDocument ( ) [inline, virtual]

Cast to a more defined type. Will return null if not of the requested type.

Reimplemented in TiXmlDocument.

Definition at line 708 of file tinyxml.h.

virtual TiXmlElement* TiXmlNode::ToElement ( ) [inline, virtual]

Cast to a more defined type. Will return null if not of the requested type.

Reimplemented in TiXmlElement.

Definition at line 709 of file tinyxml.h.

virtual const TiXmlElement* TiXmlNode::ToElement ( ) const [inline, virtual]

Cast to a more defined type. Will return null if not of the requested type.

Reimplemented in TiXmlElement.

Definition at line 702 of file tinyxml.h.

Referenced by FirstChildElement(), NextSiblingElement(), and TiXmlHandle::ToElement().

virtual const TiXmlText* TiXmlNode::ToText ( ) const [inline, virtual]

Cast to a more defined type. Will return null if not of the requested type.

Reimplemented in TiXmlText.

Definition at line 705 of file tinyxml.h.

Referenced by TiXmlElement::GetText(), TiXmlElement::Print(), TiXmlHandle::ToText(), and TiXmlPrinter::VisitEnter().

virtual TiXmlText* TiXmlNode::ToText ( ) [inline, virtual]

Cast to a more defined type. Will return null if not of the requested type.

Reimplemented in TiXmlText.

Definition at line 712 of file tinyxml.h.

virtual TiXmlUnknown* TiXmlNode::ToUnknown ( ) [inline, virtual]

Cast to a more defined type. Will return null if not of the requested type.

Reimplemented in TiXmlUnknown.

Definition at line 711 of file tinyxml.h.

virtual const TiXmlUnknown* TiXmlNode::ToUnknown ( ) const [inline, virtual]

Cast to a more defined type. Will return null if not of the requested type.

Reimplemented in TiXmlUnknown.

Definition at line 704 of file tinyxml.h.

Referenced by TiXmlHandle::ToUnknown().

int TiXmlNode::Type ( ) const [inline]

Query the type (as an enumerated value, above) of this node. The possible types are: DOCUMENT, ELEMENT, COMMENT, UNKNOWN, TEXT, and DECLARATION.

Definition at line 688 of file tinyxml.h.

References type.

Referenced by InsertAfterChild(), InsertBeforeChild(), InsertEndChild(), and LinkEndChild().

{ return type; }
const char* TiXmlNode::Value ( ) const [inline]

The meaning of 'value' changes for the specific type of TiXmlNode.

		Document:	filename of the xml file
		Element:	name of the element
		Comment:	the comment text
		Unknown:	the tag contents
		Text:		the text string
		

The subclasses will wrap this function.

Definition at line 491 of file tinyxml.h.

References value.

Referenced by TiXmlElement::Clone(), FirstChild(), TiXmlElement::GetText(), LastChild(), TiXmlDocument::LoadFile(), NextSibling(), PreviousSibling(), TiXmlDocument::SaveFile(), TiXmlPrinter::Visit(), TiXmlPrinter::VisitEnter(), and TiXmlPrinter::VisitExit().

{ return value.c_str (); }
const std::string& TiXmlNode::ValueStr ( ) const [inline]

Return Value() as a std::string. If you only use STL, this is more efficient than calling Value(). Only available in STL mode.

Definition at line 498 of file tinyxml.h.

References value.

{ return value; }
const TIXML_STRING& TiXmlNode::ValueTStr ( ) const [inline]

Definition at line 501 of file tinyxml.h.

References value.

Referenced by TiXmlPrinter::Visit().

{ return value; }

Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  out,
const TiXmlNode base 
) [friend]

An output stream operator, for every class. Note that this outputs without any newlines or formatting, as opposed to Print(), which includes tabs and new lines.

The operator<< and operator>> are not completely symmetric. Writing a node to a stream is very well defined. You'll get a nice stream of output, without any extra whitespace or newlines.

But reading is not as well defined. (As it always is.) If you create a TiXmlElement (for example) and read that from an input stream, the text needs to define an element or junk will result. This is true of all input streams, but it's worth keeping in mind.

A TiXmlDocument will read nodes until it reads a root element, and all the children of that root element.

std::string& operator<< ( std::string &  out,
const TiXmlNode base 
) [friend]

Appends the XML node or attribute to a std::string.

std::istream& operator>> ( std::istream &  in,
TiXmlNode base 
) [friend]

An input stream operator, for every class. Tolerant of newlines and formatting, but doesn't expect them.

friend class TiXmlDocument [friend]

Reimplemented from TiXmlBase.

Definition at line 429 of file tinyxml.h.

friend class TiXmlElement [friend]

Reimplemented from TiXmlBase.

Reimplemented in TiXmlText.

Definition at line 430 of file tinyxml.h.

Referenced by Identify().


Member Data Documentation

TiXmlNode* TiXmlNode::next [protected]
TiXmlNode* TiXmlNode::prev [protected]

Definition at line 760 of file tinyxml.h.

Referenced by Type().

TIXML_STRING TiXmlNode::value [protected]