xmlTiny::TiXmlNode

xmlTiny::TiXmlNode Class Reference

The parent class for everything in the Document Object Model. More...

#include <OBTtinyxml.h>

Inheritance diagram for xmlTiny::TiXmlNode:

Inheritance graph
[legend]
Collaboration diagram for xmlTiny::TiXmlNode:

Collaboration graph
[legend]

List of all members.

Public Types

enum  NodeType {
  DOCUMENT,
  ELEMENT,
  COMMENT,
  UNKNOWN,
  TEXT,
  DECLARATION,
  TYPECOUNT
}
 The types of XML nodes supported by TinyXml. More...

Public Member Functions

virtual ~TiXmlNode ()
const char * Value () const
 The meaning of 'value' changes for the specific type of TiXmlNode.
const std::string & ValueStr () const
 Return Value() as a std::string.
const TIXML_STRING & ValueTStr () const
void SetValue (const char *_value)
 Changes the value of the node.
void SetValue (const std::string &_value)
 STL std::string form.
void Clear ()
 Delete all the children of this node. Does not affect 'this'.
TiXmlNode * Parent ()
 One step up the DOM.
const TiXmlNode * Parent () const
const TiXmlNode * FirstChild () const
 The first child of this node. Will be null if there are no children.
TiXmlNode * FirstChild ()
const TiXmlNode * FirstChild (const char *value) const
 The first child of this node with the matching 'value'.
TiXmlNode * FirstChild (const char *_value)
 The first child of this node with the matching 'value'. Will be null if none found.
const TiXmlNode * LastChild () const
TiXmlNode * LastChild ()
 The last child of this node. Will be null if there are no children.
const TiXmlNode * LastChild (const char *value) const
TiXmlNode * LastChild (const char *_value)
 The last child of this node matching 'value'. Will be null if there are no children.
const TiXmlNode * FirstChild (const std::string &_value) const
 STL std::string form.
TiXmlNode * FirstChild (const std::string &_value)
 STL std::string form.
const TiXmlNode * LastChild (const std::string &_value) const
 STL std::string form.
TiXmlNode * LastChild (const std::string &_value)
 STL std::string form.
const TiXmlNode * IterateChildren (const TiXmlNode *previous) const
 An alternate way to walk the children of a node.
TiXmlNode * IterateChildren (const TiXmlNode *previous)
const TiXmlNode * IterateChildren (const char *value, const TiXmlNode *previous) const
 This flavor of IterateChildren searches for children with a particular 'value'.
TiXmlNode * IterateChildren (const char *_value, const TiXmlNode *previous)
const TiXmlNode * IterateChildren (const std::string &_value, const TiXmlNode *previous) const
 STL std::string form.
TiXmlNode * IterateChildren (const std::string &_value, const TiXmlNode *previous)
 STL std::string form.
TiXmlNode * InsertEndChild (const TiXmlNode &addThis)
 Add a new node related to this.
TiXmlNode * LinkEndChild (TiXmlNode *addThis)
 Add a new node related to this.
TiXmlNode * InsertBeforeChild (TiXmlNode *beforeThis, const TiXmlNode &addThis)
 Add a new node related to this.
TiXmlNode * InsertAfterChild (TiXmlNode *afterThis, const TiXmlNode &addThis)
 Add a new node related to this.
TiXmlNode * ReplaceChild (TiXmlNode *replaceThis, const TiXmlNode &withThis)
 Replace a child of this node.
bool RemoveChild (TiXmlNode *removeThis)
 Delete a child of this node.
const TiXmlNode * PreviousSibling () const
 Navigate to a sibling node.
TiXmlNode * PreviousSibling ()
const TiXmlNode * PreviousSibling (const char *) const
 Navigate to a sibling node.
TiXmlNode * PreviousSibling (const char *_prev)
const TiXmlNode * PreviousSibling (const std::string &_value) const
 STL std::string form.
TiXmlNode * PreviousSibling (const std::string &_value)
 STL std::string form.
const TiXmlNode * NextSibling (const std::string &_value) const
 STL std::string form.
TiXmlNode * NextSibling (const std::string &_value)
 STL std::string form.
const TiXmlNode * NextSibling () const
 Navigate to a sibling node.
TiXmlNode * NextSibling ()
const TiXmlNode * NextSibling (const char *) const
 Navigate to a sibling node with the given 'value'.
TiXmlNode * NextSibling (const char *_next)
const TiXmlElement * NextSiblingElement () const
 Convenience function to get through elements.
TiXmlElement * NextSiblingElement ()
const TiXmlElement * NextSiblingElement (const char *) const
 Convenience function to get through elements.
TiXmlElement * NextSiblingElement (const char *_next)
const TiXmlElement * NextSiblingElement (const std::string &_value) const
 STL std::string form.
TiXmlElement * NextSiblingElement (const std::string &_value)
 STL std::string form.
const TiXmlElement * FirstChildElement () const
 Convenience function to get through elements.
TiXmlElement * FirstChildElement ()
const TiXmlElement * FirstChildElement (const char *_value) const
 Convenience function to get through elements.
TiXmlElement * FirstChildElement (const char *_value)
const TiXmlElement * FirstChildElement (const std::string &_value) const
 STL std::string form.
TiXmlElement * FirstChildElement (const std::string &_value)
 STL std::string form.
int Type () const
 Query the type (as an enumerated value, above) of this node.
const TiXmlDocument * GetDocument () const
 Return a pointer to the Document this node lives in.
TiXmlDocument * GetDocument ()
bool NoChildren () const
 Returns true if this node has no children.
virtual const
TiXmlDocument * 		ToDocument () const
 Cast to a more defined type. Will return null if not of the requested type.
virtual const
TiXmlElement * 		ToElement () const
 Cast to a more defined type. Will return null if not of the requested type.
virtual const
TiXmlComment * 		ToComment () const
 Cast to a more defined type. Will return null if not of the requested type.
virtual const
TiXmlUnknown * 		ToUnknown () const
 Cast to a more defined type. Will return null if not of the requested type.
virtual const TiXmlText * ToText () const
 Cast to a more defined type. Will return null if not of the requested type.
virtual const
TiXmlDeclaration * 		ToDeclaration () const
 Cast to a more defined type. Will return null if not of the requested type.
virtual TiXmlDocument * ToDocument ()
 Cast to a more defined type. Will return null if not of the requested type.
virtual TiXmlElement * ToElement ()
 Cast to a more defined type. Will return null if not of the requested type.
virtual TiXmlComment * ToComment ()
 Cast to a more defined type. Will return null if not of the requested type.
virtual TiXmlUnknown * ToUnknown ()
 Cast to a more defined type. Will return null if not of the requested type.
virtual TiXmlText * ToText ()
 Cast to a more defined type. Will return null if not of the requested type.
virtual
TiXmlDeclaration * 		ToDeclaration ()
 Cast to a more defined type. Will return null if not of the requested type.
virtual TiXmlNode * Clone () const =0
 Create an exact duplicate of this node and return it.
virtual bool Accept (TiXmlVisitor *visitor) const =0
 Accept a hierchical visit the nodes in the TinyXML DOM.

Protected Member Functions

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

Protected Attributes

TiXmlNode * parent
NodeType type
TiXmlNode * firstChild
TiXmlNode * lastChild
TIXML_STRING value
TiXmlNode * prev
TiXmlNode * next

Private Member Functions

 TiXmlNode (const TiXmlNode &)
void operator= (const TiXmlNode &base)

Friends

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

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 430 of file tiny/tmp/OBTtinyxml.h.

Member Enumeration Documentation

enum xmlTiny::TiXmlNode::NodeType

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 469 of file tiny/tmp/OBTtinyxml.h.

00470         {
00471                 DOCUMENT,
00472                 ELEMENT,
00473                 COMMENT,
00474                 UNKNOWN,
00475                 TEXT,
00476                 DECLARATION,
00477                 TYPECOUNT
00478         };

Constructor & Destructor Documentation

xmlTiny::TiXmlNode::~TiXmlNode (  )  [virtual]

Definition at line 149 of file tiny/tmp/OBTtinyxml.cpp.

References firstChild, and next.

00150 {
00151         TiXmlNode* node = firstChild;
00152         TiXmlNode* temp = 0;
00153 
00154         while ( node )
00155         {
00156                 temp = node;
00157                 node = node->next;
00158                 delete temp;
00159         }       
00160 }

xmlTiny::TiXmlNode::TiXmlNode ( NodeType  _type  )  [protected]

Definition at line 138 of file tiny/tmp/OBTtinyxml.cpp.

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

00138                                      : TiXmlBase()
00139 {
00140         parent = 0;
00141         type = _type;
00142         firstChild = 0;
00143         lastChild = 0;
00144         prev = 0;
00145         next = 0;
00146 }

xmlTiny::TiXmlNode::TiXmlNode ( const TiXmlNode &   )  [private]

Member Function Documentation

const char* xmlTiny::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 494 of file tiny/tmp/OBTtinyxml.h.

References value.

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

00494 { return value.c_str (); }

const std::string& xmlTiny::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 501 of file tiny/tmp/OBTtinyxml.h.

References value.

00501 { return value; }

const TIXML_STRING& xmlTiny::TiXmlNode::ValueTStr (  )  const [inline]

Definition at line 504 of file tiny/tmp/OBTtinyxml.h.

References value.

Referenced by xmlTiny::TiXmlPrinter::Visit().

00504 { return value; }

void xmlTiny::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 515 of file tiny/tmp/OBTtinyxml.h.

References value.

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

00515 { value = _value;}

void xmlTiny::TiXmlNode::SetValue ( const std::string &  _value  )  [inline]

STL std::string form.

Definition at line 519 of file tiny/tmp/OBTtinyxml.h.

00519 { value = _value; }

void xmlTiny::TiXmlNode::Clear (  ) 

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

Definition at line 170 of file tiny/tmp/OBTtinyxml.cpp.

References firstChild, lastChild, and next.

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

00171 {
00172         TiXmlNode* node = firstChild;
00173         TiXmlNode* temp = 0;
00174 
00175         while ( node )
00176         {
00177                 temp = node;
00178                 node = node->next;
00179                 delete temp;
00180         }       
00181 
00182         firstChild = 0;
00183         lastChild = 0;
00184 }

TiXmlNode* xmlTiny::TiXmlNode::Parent (  )  [inline]

One step up the DOM.

Definition at line 526 of file tiny/tmp/OBTtinyxml.h.

References parent.

00526 { return parent; }

const TiXmlNode* xmlTiny::TiXmlNode::Parent (  )  const [inline]

Definition at line 527 of file tiny/tmp/OBTtinyxml.h.

References parent.

00527 { return parent; }

const TiXmlNode* xmlTiny::TiXmlNode::FirstChild (  )  const [inline]

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

Definition at line 529 of file tiny/tmp/OBTtinyxml.h.

References firstChild.

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

TiXmlNode* xmlTiny::TiXmlNode::FirstChild (  )  [inline]

Definition at line 530 of file tiny/tmp/OBTtinyxml.h.

References firstChild.

00530 { return firstChild; }

const TiXmlNode * xmlTiny::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 343 of file tiny/tmp/OBTtinyxml.cpp.

References firstChild, next, and Value().

00344 {
00345         const TiXmlNode* node;
00346         for ( node = firstChild; node; node = node->next )
00347         {
00348                 if ( strcmp( node->Value(), _value ) == 0 )
00349                         return node;
00350         }
00351         return 0;
00352 }

TiXmlNode* xmlTiny::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 533 of file tiny/tmp/OBTtinyxml.h.

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

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

Definition at line 538 of file tiny/tmp/OBTtinyxml.h.

References lastChild.

Referenced by LastChild(), and xmlTiny::TiXmlPrinter::VisitEnter().

00538 { return lastChild; }

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

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

Definition at line 539 of file tiny/tmp/OBTtinyxml.h.

References lastChild.

00539 { return lastChild; }

const TiXmlNode * xmlTiny::TiXmlNode::LastChild ( const char *  value  )  const

Definition at line 355 of file tiny/tmp/OBTtinyxml.cpp.

References lastChild, prev, and Value().

00356 {
00357         const TiXmlNode* node;
00358         for ( node = lastChild; node; node = node->prev )
00359         {
00360                 if ( strcmp( node->Value(), _value ) == 0 )
00361                         return node;
00362         }
00363         return 0;
00364 }

TiXmlNode* xmlTiny::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 542 of file tiny/tmp/OBTtinyxml.h.

00542                                                     {
00543                 return const_cast< TiXmlNode* > ((const_cast< const TiXmlNode* >(this))->LastChild( _value ));
00544         }

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

STL std::string form.

Definition at line 547 of file tiny/tmp/OBTtinyxml.h.

References FirstChild().

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

STL std::string form.

Definition at line 548 of file tiny/tmp/OBTtinyxml.h.

References FirstChild().

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

STL std::string form.

Definition at line 549 of file tiny/tmp/OBTtinyxml.h.

References LastChild().

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

STL std::string form.

Definition at line 550 of file tiny/tmp/OBTtinyxml.h.

References LastChild().

const TiXmlNode * xmlTiny::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 367 of file tiny/tmp/OBTtinyxml.cpp.

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

Referenced by IterateChildren().

00368 {
00369         if ( !previous )
00370         {
00371                 return FirstChild();
00372         }
00373         else
00374         {
00375                 assert( previous->parent == this );
00376                 return previous->NextSibling();
00377         }
00378 }

TiXmlNode* xmlTiny::TiXmlNode::IterateChildren ( const TiXmlNode *  previous  )  [inline]

Definition at line 570 of file tiny/tmp/OBTtinyxml.h.

00570                                                                 {
00571                 return const_cast< TiXmlNode* >( (const_cast< const TiXmlNode* >(this))->IterateChildren( previous ) );
00572         }

const TiXmlNode * xmlTiny::TiXmlNode::IterateChildren ( const char *  value,
const TiXmlNode *  previous 
) const

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

Definition at line 381 of file tiny/tmp/OBTtinyxml.cpp.

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

00382 {
00383         if ( !previous )
00384         {
00385                 return FirstChild( val );
00386         }
00387         else
00388         {
00389                 assert( previous->parent == this );
00390                 return previous->NextSibling( val );
00391         }
00392 }

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

Definition at line 576 of file tiny/tmp/OBTtinyxml.h.

00576                                                                                      {
00577                 return const_cast< TiXmlNode* >( (const_cast< const TiXmlNode* >(this))->IterateChildren( _value, previous ) );
00578         }

const TiXmlNode* xmlTiny::TiXmlNode::IterateChildren ( const std::string &  _value,
const TiXmlNode *  previous 
) const [inline]

STL std::string form.

Definition at line 581 of file tiny/tmp/OBTtinyxml.h.

References IterateChildren().

TiXmlNode* xmlTiny::TiXmlNode::IterateChildren ( const std::string &  _value,
const TiXmlNode *  previous 
) [inline]

STL std::string form.

Definition at line 582 of file tiny/tmp/OBTtinyxml.h.

References IterateChildren().

TiXmlNode * xmlTiny::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 occured.

Definition at line 214 of file tiny/tmp/OBTtinyxml.cpp.

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

00215 {
00216         if ( addThis.Type() == TiXmlNode::DOCUMENT )
00217         {
00218                 if ( GetDocument() ) GetDocument()->SetError( TIXML_ERROR_DOCUMENT_TOP_ONLY, 0, 0, TIXML_ENCODING_UNKNOWN );
00219                 return 0;
00220         }
00221         TiXmlNode* node = addThis.Clone();
00222         if ( !node )
00223                 return 0;
00224 
00225         return LinkEndChild( node );
00226 }

TiXmlNode * xmlTiny::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 187 of file tiny/tmp/OBTtinyxml.cpp.

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

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

00188 {
00189         assert( node->parent == 0 || node->parent == this );
00190         assert( node->GetDocument() == 0 || node->GetDocument() == this->GetDocument() );
00191 
00192         if ( node->Type() == TiXmlNode::DOCUMENT )
00193         {
00194                 delete node;
00195                 if ( GetDocument() ) GetDocument()->SetError( TIXML_ERROR_DOCUMENT_TOP_ONLY, 0, 0, TIXML_ENCODING_UNKNOWN );
00196                 return 0;
00197         }
00198 
00199         node->parent = this;
00200 
00201         node->prev = lastChild;
00202         node->next = 0;
00203 
00204         if ( lastChild )
00205                 lastChild->next = node;
00206         else
00207                 firstChild = node;                      // it was an empty list.
00208 
00209         lastChild = node;
00210         return node;
00211 }

TiXmlNode * xmlTiny::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 occured.

Definition at line 229 of file tiny/tmp/OBTtinyxml.cpp.

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

00230 {       
00231         if ( !beforeThis || beforeThis->parent != this ) {
00232                 return 0;
00233         }
00234         if ( addThis.Type() == TiXmlNode::DOCUMENT )
00235         {
00236                 if ( GetDocument() ) GetDocument()->SetError( TIXML_ERROR_DOCUMENT_TOP_ONLY, 0, 0, TIXML_ENCODING_UNKNOWN );
00237                 return 0;
00238         }
00239 
00240         TiXmlNode* node = addThis.Clone();
00241         if ( !node )
00242                 return 0;
00243         node->parent = this;
00244 
00245         node->next = beforeThis;
00246         node->prev = beforeThis->prev;
00247         if ( beforeThis->prev )
00248         {
00249                 beforeThis->prev->next = node;
00250         }
00251         else
00252         {
00253                 assert( firstChild == beforeThis );
00254                 firstChild = node;
00255         }
00256         beforeThis->prev = node;
00257         return node;
00258 }

TiXmlNode * xmlTiny::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 occured.

Definition at line 261 of file tiny/tmp/OBTtinyxml.cpp.

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

00262 {
00263         if ( !afterThis || afterThis->parent != this ) {
00264                 return 0;
00265         }
00266         if ( addThis.Type() == TiXmlNode::DOCUMENT )
00267         {
00268                 if ( GetDocument() ) GetDocument()->SetError( TIXML_ERROR_DOCUMENT_TOP_ONLY, 0, 0, TIXML_ENCODING_UNKNOWN );
00269                 return 0;
00270         }
00271 
00272         TiXmlNode* node = addThis.Clone();
00273         if ( !node )
00274                 return 0;
00275         node->parent = this;
00276 
00277         node->prev = afterThis;
00278         node->next = afterThis->next;
00279         if ( afterThis->next )
00280         {
00281                 afterThis->next->prev = node;
00282         }
00283         else
00284         {
00285                 assert( lastChild == afterThis );
00286                 lastChild = node;
00287         }
00288         afterThis->next = node;
00289         return node;
00290 }

TiXmlNode * xmlTiny::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 occured.

Definition at line 293 of file tiny/tmp/OBTtinyxml.cpp.

References Clone(), firstChild, lastChild, next, parent, and prev.

00294 {
00295         if ( replaceThis->parent != this )
00296                 return 0;
00297 
00298         TiXmlNode* node = withThis.Clone();
00299         if ( !node )
00300                 return 0;
00301 
00302         node->next = replaceThis->next;
00303         node->prev = replaceThis->prev;
00304 
00305         if ( replaceThis->next )
00306                 replaceThis->next->prev = node;
00307         else
00308                 lastChild = node;
00309 
00310         if ( replaceThis->prev )
00311                 replaceThis->prev->next = node;
00312         else
00313                 firstChild = node;
00314 
00315         delete replaceThis;
00316         node->parent = this;
00317         return node;
00318 }

bool xmlTiny::TiXmlNode::RemoveChild ( TiXmlNode *  removeThis  ) 

Delete a child of this node.

Definition at line 321 of file tiny/tmp/OBTtinyxml.cpp.

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

00322 {
00323         if ( removeThis->parent != this )
00324         {       
00325                 assert( 0 );
00326                 return false;
00327         }
00328 
00329         if ( removeThis->next )
00330                 removeThis->next->prev = removeThis->prev;
00331         else
00332                 lastChild = removeThis->prev;
00333 
00334         if ( removeThis->prev )
00335                 removeThis->prev->next = removeThis->next;
00336         else
00337                 firstChild = removeThis->next;
00338 
00339         delete removeThis;
00340         return true;
00341 }

const TiXmlNode* xmlTiny::TiXmlNode::PreviousSibling (  )  const [inline]

Navigate to a sibling node.

Definition at line 621 of file tiny/tmp/OBTtinyxml.h.

References prev.

Referenced by PreviousSibling().

00621 { return prev; }

TiXmlNode* xmlTiny::TiXmlNode::PreviousSibling (  )  [inline]

Definition at line 622 of file tiny/tmp/OBTtinyxml.h.

References prev.

00622 { return prev; }

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

Navigate to a sibling node.

Definition at line 407 of file tiny/tmp/OBTtinyxml.cpp.

References prev, and Value().

00408 {
00409         const TiXmlNode* node;
00410         for ( node = prev; node; node = node->prev )
00411         {
00412                 if ( strcmp( node->Value(), _value ) == 0 )
00413                         return node;
00414         }
00415         return 0;
00416 }

TiXmlNode* xmlTiny::TiXmlNode::PreviousSibling ( const char *  _prev  )  [inline]

Definition at line 626 of file tiny/tmp/OBTtinyxml.h.

00626                                                         {
00627                 return const_cast< TiXmlNode* >( (const_cast< const TiXmlNode* >(this))->PreviousSibling( _prev ) );
00628         }

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

STL std::string form.

Definition at line 631 of file tiny/tmp/OBTtinyxml.h.

References PreviousSibling().

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

STL std::string form.

Definition at line 632 of file tiny/tmp/OBTtinyxml.h.

References PreviousSibling().

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

STL std::string form.

Definition at line 633 of file tiny/tmp/OBTtinyxml.h.

References NextSibling().

Referenced by xmlTiny::TiXmlHandle::Child(), xmlTiny::TiXmlDocument::CopyTo(), xmlTiny::TiXmlElement::CopyTo(), FirstChildElement(), IterateChildren(), NextSiblingElement(), and xmlTiny::TiXmlElement::Print().

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

STL std::string form.

Definition at line 634 of file tiny/tmp/OBTtinyxml.h.

References NextSibling().

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

Navigate to a sibling node.

Definition at line 638 of file tiny/tmp/OBTtinyxml.h.

References next.

Referenced by NextSibling(), and NextSiblingElement().

00638 { return next; }

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

Definition at line 639 of file tiny/tmp/OBTtinyxml.h.

References next.

00639 { return next; }

const TiXmlNode * xmlTiny::TiXmlNode::NextSibling ( const char *  _value  )  const

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

Definition at line 395 of file tiny/tmp/OBTtinyxml.cpp.

References next, and Value().

00396 {
00397         const TiXmlNode* node;
00398         for ( node = next; node; node = node->next )
00399         {
00400                 if ( strcmp( node->Value(), _value ) == 0 )
00401                         return node;
00402         }
00403         return 0;
00404 }

TiXmlNode* xmlTiny::TiXmlNode::NextSibling ( const char *  _next  )  [inline]

Definition at line 643 of file tiny/tmp/OBTtinyxml.h.

00643                                                     {
00644                 return const_cast< TiXmlNode* >( (const_cast< const TiXmlNode* >(this))->NextSibling( _next ) );
00645         }

const TiXmlElement * xmlTiny::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 464 of file tiny/tmp/OBTtinyxml.cpp.

References NextSibling(), and ToElement().

Referenced by xmlTiny::TiXmlHandle::ChildElement(), and NextSiblingElement().

00465 {
00466         const TiXmlNode* node;
00467 
00468         for (   node = NextSibling();
00469                         node;
00470                         node = node->NextSibling() )
00471         {
00472                 if ( node->ToElement() )
00473                         return node->ToElement();
00474         }
00475         return 0;
00476 }

TiXmlElement* xmlTiny::TiXmlNode::NextSiblingElement (  )  [inline]

Definition at line 652 of file tiny/tmp/OBTtinyxml.h.

00652                                            {
00653                 return const_cast< TiXmlElement* >( (const_cast< const TiXmlNode* >(this))->NextSiblingElement() );
00654         }

const TiXmlElement * xmlTiny::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 479 of file tiny/tmp/OBTtinyxml.cpp.

References NextSibling(), and ToElement().

00480 {
00481         const TiXmlNode* node;
00482 
00483         for (   node = NextSibling( _value );
00484                         node;
00485                         node = node->NextSibling( _value ) )
00486         {
00487                 if ( node->ToElement() )
00488                         return node->ToElement();
00489         }
00490         return 0;
00491 }

TiXmlElement* xmlTiny::TiXmlNode::NextSiblingElement ( const char *  _next  )  [inline]

Definition at line 661 of file tiny/tmp/OBTtinyxml.h.

00661                                                               {
00662                 return const_cast< TiXmlElement* >( (const_cast< const TiXmlNode* >(this))->NextSiblingElement( _next ) );
00663         }

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

STL std::string form.

Definition at line 666 of file tiny/tmp/OBTtinyxml.h.

References NextSiblingElement().

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

STL std::string form.

Definition at line 667 of file tiny/tmp/OBTtinyxml.h.

References NextSiblingElement().

const TiXmlElement * xmlTiny::TiXmlNode::FirstChildElement (  )  const

Convenience function to get through elements.

Definition at line 434 of file tiny/tmp/OBTtinyxml.cpp.

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

Referenced by FirstChildElement(), and xmlTiny::TiXmlDocument::RootElement().

00435 {
00436         const TiXmlNode* node;
00437 
00438         for (   node = FirstChild();
00439                         node;
00440                         node = node->NextSibling() )
00441         {
00442                 if ( node->ToElement() )
00443                         return node->ToElement();
00444         }
00445         return 0;
00446 }

TiXmlElement* xmlTiny::TiXmlNode::FirstChildElement (  )  [inline]

Definition at line 672 of file tiny/tmp/OBTtinyxml.h.

00672                                           {
00673                 return const_cast< TiXmlElement* >( (const_cast< const TiXmlNode* >(this))->FirstChildElement() );
00674         }

const TiXmlElement * xmlTiny::TiXmlNode::FirstChildElement ( const char *  _value  )  const

Convenience function to get through elements.

Definition at line 449 of file tiny/tmp/OBTtinyxml.cpp.

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

00450 {
00451         const TiXmlNode* node;
00452 
00453         for (   node = FirstChild( _value );
00454                         node;
00455                         node = node->NextSibling( _value ) )
00456         {
00457                 if ( node->ToElement() )
00458                         return node->ToElement();
00459         }
00460         return 0;
00461 }

TiXmlElement* xmlTiny::TiXmlNode::FirstChildElement ( const char *  _value  )  [inline]

Definition at line 678 of file tiny/tmp/OBTtinyxml.h.

00678                                                                {
00679                 return const_cast< TiXmlElement* >( (const_cast< const TiXmlNode* >(this))->FirstChildElement( _value ) );
00680         }

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

STL std::string form.

Definition at line 683 of file tiny/tmp/OBTtinyxml.h.

References FirstChildElement().

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

STL std::string form.

Definition at line 684 of file tiny/tmp/OBTtinyxml.h.

References FirstChildElement().

int xmlTiny::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 691 of file tiny/tmp/OBTtinyxml.h.

References type.

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

00691 { return type; }

const TiXmlDocument * xmlTiny::TiXmlNode::GetDocument (  )  const

Return a pointer to the Document this node lives in.

Returns null if not in a document.

Definition at line 494 of file tiny/tmp/OBTtinyxml.cpp.

References parent, and ToDocument().

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

00495 {
00496         const TiXmlNode* node;
00497 
00498         for( node = this; node; node = node->parent )
00499         {
00500                 if ( node->ToDocument() )
00501                         return node->ToDocument();
00502         }
00503         return 0;
00504 }

TiXmlDocument* xmlTiny::TiXmlNode::GetDocument (  )  [inline]

Definition at line 697 of file tiny/tmp/OBTtinyxml.h.

00697                                      {
00698                 return const_cast< TiXmlDocument* >( (const_cast< const TiXmlNode* >(this))->GetDocument() );
00699         }

bool xmlTiny::TiXmlNode::NoChildren (  )  const [inline]

Returns true if this node has no children.

Definition at line 702 of file tiny/tmp/OBTtinyxml.h.

References firstChild.

00702 { return !firstChild; }

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

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

Reimplemented in xmlTiny::TiXmlDocument.

Definition at line 704 of file tiny/tmp/OBTtinyxml.h.

Referenced by GetDocument().

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

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

Reimplemented in xmlTiny::TiXmlElement.

Definition at line 705 of file tiny/tmp/OBTtinyxml.h.

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

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

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

Reimplemented in xmlTiny::TiXmlComment.

Definition at line 706 of file tiny/tmp/OBTtinyxml.h.

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

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

Reimplemented in xmlTiny::TiXmlUnknown.

Definition at line 707 of file tiny/tmp/OBTtinyxml.h.

Referenced by xmlTiny::TiXmlHandle::ToUnknown().

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

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

Reimplemented in xmlTiny::TiXmlText.

Definition at line 708 of file tiny/tmp/OBTtinyxml.h.

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

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

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

Reimplemented in xmlTiny::TiXmlDeclaration.

Definition at line 709 of file tiny/tmp/OBTtinyxml.h.

Referenced by xmlTiny::TiXmlDocument::Parse().

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

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

Reimplemented in xmlTiny::TiXmlDocument.

Definition at line 711 of file tiny/tmp/OBTtinyxml.h.

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

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

Reimplemented in xmlTiny::TiXmlElement.

Definition at line 712 of file tiny/tmp/OBTtinyxml.h.

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

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

Reimplemented in xmlTiny::TiXmlComment.

Definition at line 713 of file tiny/tmp/OBTtinyxml.h.

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

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

Reimplemented in xmlTiny::TiXmlUnknown.

Definition at line 714 of file tiny/tmp/OBTtinyxml.h.

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

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

Reimplemented in xmlTiny::TiXmlText.

Definition at line 715 of file tiny/tmp/OBTtinyxml.h.

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

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

Reimplemented in xmlTiny::TiXmlDeclaration.

Definition at line 716 of file tiny/tmp/OBTtinyxml.h.

virtual TiXmlNode* xmlTiny::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 xmlTiny::TiXmlElement, xmlTiny::TiXmlComment, xmlTiny::TiXmlText, xmlTiny::TiXmlDeclaration, xmlTiny::TiXmlUnknown, and xmlTiny::TiXmlDocument.

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

virtual bool xmlTiny::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 xmlTiny::TiXmlElement, xmlTiny::TiXmlComment, xmlTiny::TiXmlText, xmlTiny::TiXmlDeclaration, xmlTiny::TiXmlUnknown, and xmlTiny::TiXmlDocument.

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

Definition at line 163 of file tiny/tmp/OBTtinyxml.cpp.

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

Referenced by xmlTiny::TiXmlUnknown::CopyTo(), xmlTiny::TiXmlDeclaration::CopyTo(), xmlTiny::TiXmlText::CopyTo(), xmlTiny::TiXmlComment::CopyTo(), xmlTiny::TiXmlDocument::CopyTo(), and xmlTiny::TiXmlElement::CopyTo().

00164 {
00165         target->SetValue (value.c_str() );
00166         target->userData = userData; 
00167 }

virtual void xmlTiny::TiXmlNode::StreamIn ( std::istream *  in,
TIXML_STRING *  tag 
) [protected, pure virtual]

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

TiXmlNode * xmlTiny::TiXmlNode::Identify ( const char *  start,
TiXmlEncoding  encoding 
) [protected]

Definition at line 820 of file tiny/tmp/OBTtinyxmlparser.cpp.

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

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

00821 {
00822         TiXmlNode* returnNode = 0;
00823 
00824         p = SkipWhiteSpace( p, encoding );
00825         if( !p || !*p || *p != '<' )
00826         {
00827                 return 0;
00828         }
00829 
00830         TiXmlDocument* doc = GetDocument();
00831         p = SkipWhiteSpace( p, encoding );
00832 
00833         if ( !p || !*p )
00834         {
00835                 return 0;
00836         }
00837 
00838         // What is this thing? 
00839         // - Elements start with a letter or underscore, but xml is reserved.
00840         // - Comments: <!--
00841         // - Decleration: <?xml
00842         // - Everthing else is unknown to tinyxml.
00843         //
00844 
00845         const char* xmlHeader = { "<?xml" };
00846         const char* commentHeader = { "<!--" };
00847         const char* dtdHeader = { "<!" };
00848         const char* cdataHeader = { "<![CDATA[" };
00849 
00850         if ( StringEqual( p, xmlHeader, true, encoding ) )
00851         {
00852                 #ifdef DEBUG_PARSER
00853                         TIXML_LOG( "XML parsing Declaration\n" );
00854                 #endif
00855                 returnNode = new TiXmlDeclaration();
00856         }
00857         else if ( StringEqual( p, commentHeader, false, encoding ) )
00858         {
00859                 #ifdef DEBUG_PARSER
00860                         TIXML_LOG( "XML parsing Comment\n" );
00861                 #endif
00862                 returnNode = new TiXmlComment();
00863         }
00864         else if ( StringEqual( p, cdataHeader, false, encoding ) )
00865         {
00866                 #ifdef DEBUG_PARSER
00867                         TIXML_LOG( "XML parsing CDATA\n" );
00868                 #endif
00869                 TiXmlText* text = new TiXmlText( "" );
00870                 text->SetCDATA( true );
00871                 returnNode = text;
00872         }
00873         else if ( StringEqual( p, dtdHeader, false, encoding ) )
00874         {
00875                 #ifdef DEBUG_PARSER
00876                         TIXML_LOG( "XML parsing Unknown(1)\n" );
00877                 #endif
00878                 returnNode = new TiXmlUnknown();
00879         }
00880         else if (    IsAlpha( *(p+1), encoding )
00881                           || *(p+1) == '_' )
00882         {
00883                 #ifdef DEBUG_PARSER
00884                         TIXML_LOG( "XML parsing Element\n" );
00885                 #endif
00886                 returnNode = new TiXmlElement( "" );
00887         }
00888         else
00889         {
00890                 #ifdef DEBUG_PARSER
00891                         TIXML_LOG( "XML parsing Unknown(2)\n" );
00892                 #endif
00893                 returnNode = new TiXmlUnknown();
00894         }
00895 
00896         if ( returnNode )
00897         {
00898                 // Set the parent, so it can report errors
00899                 returnNode->parent = this;
00900         }
00901         else
00902         {
00903                 if ( doc )
00904                         doc->SetError( TIXML_ERROR_OUT_OF_MEMORY, 0, 0, TIXML_ENCODING_UNKNOWN );
00905         }
00906         return returnNode;
00907 }

void xmlTiny::TiXmlNode::operator= ( const TiXmlNode &  base  )  [private]

Friends And Related Function Documentation

friend class TiXmlDocument [friend]

Reimplemented from xmlTiny::TiXmlBase.

Definition at line 432 of file tiny/tmp/OBTtinyxml.h.

friend class TiXmlElement [friend]

Reimplemented from xmlTiny::TiXmlBase.

Reimplemented in xmlTiny::TiXmlText.

Definition at line 433 of file tiny/tmp/OBTtinyxml.h.

Referenced by Identify().

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.

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.

Member Data Documentation

TiXmlNode* xmlTiny::TiXmlNode::parent [protected]

Definition at line 762 of file tiny/tmp/OBTtinyxml.h.

Referenced by GetDocument(), Identify(), InsertAfterChild(), InsertBeforeChild(), IterateChildren(), LinkEndChild(), Parent(), RemoveChild(), ReplaceChild(), and TiXmlNode().

NodeType xmlTiny::TiXmlNode::type [protected]

Definition at line 763 of file tiny/tmp/OBTtinyxml.h.

Referenced by TiXmlNode(), and Type().

TiXmlNode* xmlTiny::TiXmlNode::firstChild [protected]

Definition at line 765 of file tiny/tmp/OBTtinyxml.h.

Referenced by Clear(), xmlTiny::TiXmlDocument::CopyTo(), xmlTiny::TiXmlElement::CopyTo(), FirstChild(), InsertBeforeChild(), LinkEndChild(), NoChildren(), xmlTiny::TiXmlDocument::Parse(), xmlTiny::TiXmlElement::Print(), RemoveChild(), ReplaceChild(), xmlTiny::TiXmlElement::TiXmlElement(), TiXmlNode(), and ~TiXmlNode().

TiXmlNode* xmlTiny::TiXmlNode::lastChild [protected]

Definition at line 766 of file tiny/tmp/OBTtinyxml.h.

Referenced by Clear(), InsertAfterChild(), LastChild(), LinkEndChild(), xmlTiny::TiXmlElement::Print(), RemoveChild(), ReplaceChild(), xmlTiny::TiXmlElement::TiXmlElement(), and TiXmlNode().

TIXML_STRING xmlTiny::TiXmlNode::value [protected]

Definition at line 768 of file tiny/tmp/OBTtinyxml.h.

Referenced by xmlTiny::TiXmlText::Blank(), CopyTo(), xmlTiny::TiXmlDocument::LoadFile(), xmlTiny::TiXmlText::Parse(), xmlTiny::TiXmlComment::Parse(), xmlTiny::TiXmlUnknown::Parse(), xmlTiny::TiXmlElement::Parse(), xmlTiny::TiXmlUnknown::Print(), xmlTiny::TiXmlText::Print(), xmlTiny::TiXmlComment::Print(), xmlTiny::TiXmlElement::Print(), SetValue(), xmlTiny::TiXmlDocument::TiXmlDocument(), xmlTiny::TiXmlElement::TiXmlElement(), Value(), ValueStr(), and ValueTStr().

TiXmlNode* xmlTiny::TiXmlNode::prev [protected]

Definition at line 770 of file tiny/tmp/OBTtinyxml.h.

Referenced by InsertAfterChild(), InsertBeforeChild(), LastChild(), LinkEndChild(), PreviousSibling(), RemoveChild(), ReplaceChild(), and TiXmlNode().

TiXmlNode* xmlTiny::TiXmlNode::next [protected]

Definition at line 771 of file tiny/tmp/OBTtinyxml.h.

Referenced by Clear(), FirstChild(), InsertAfterChild(), InsertBeforeChild(), LinkEndChild(), NextSibling(), RemoveChild(), ReplaceChild(), TiXmlNode(), and ~TiXmlNode().

Generated on Wed Oct 1 11:34:24 2008 for OBT by  doxygen 1.5.3