MTK++ Latest version: 0.2.0

Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Static Protected Member Functions | Protected Attributes | Static Protected Attributes | Private Member Functions | Private Attributes
TiXmlDocument Class Reference

#include <mtkpp/src/tinyxml/tinyxml.h>

Inheritance diagram for TiXmlDocument:
Inheritance graph
[legend]
Collaboration diagram for TiXmlDocument:
Collaboration graph
[legend]

List of all members.

Public Types

enum  NodeType {
  DOCUMENT, ELEMENT, COMMENT, UNKNOWN,
  TEXT, DECLARATION, TYPECOUNT
}
enum  {
  TIXML_NO_ERROR = 0, TIXML_ERROR, TIXML_ERROR_OPENING_FILE, TIXML_ERROR_OUT_OF_MEMORY,
  TIXML_ERROR_PARSING_ELEMENT, TIXML_ERROR_FAILED_TO_READ_ELEMENT_NAME, TIXML_ERROR_READING_ELEMENT_VALUE, TIXML_ERROR_READING_ATTRIBUTES,
  TIXML_ERROR_PARSING_EMPTY, TIXML_ERROR_READING_END_TAG, TIXML_ERROR_PARSING_UNKNOWN, TIXML_ERROR_PARSING_COMMENT,
  TIXML_ERROR_PARSING_DECLARATION, TIXML_ERROR_DOCUMENT_EMPTY, TIXML_ERROR_EMBEDDED_NULL, TIXML_ERROR_PARSING_CDATA,
  TIXML_ERROR_DOCUMENT_TOP_ONLY, TIXML_ERROR_STRING_COUNT
}

Public Member Functions

 TiXmlDocument ()
 Create an empty document, that has no name.
 TiXmlDocument (const char *documentName)
 Create a document with a name. The name of the document is also the filename of the xml.
 TiXmlDocument (const TiXmlDocument &copy)
void operator= (const TiXmlDocument &copy)
virtual ~TiXmlDocument ()
bool LoadFile (TiXmlEncoding encoding=TIXML_DEFAULT_ENCODING)
bool SaveFile () const
 Save a file using the current document value. Returns true if successful.
bool LoadFile (const char *filename, TiXmlEncoding encoding=TIXML_DEFAULT_ENCODING)
 Load a file using the given filename. Returns true if successful.
bool SaveFile (const char *filename) const
 Save a file using the given filename. Returns true if successful.
bool LoadFile (FILE *, TiXmlEncoding encoding=TIXML_DEFAULT_ENCODING)
bool SaveFile (FILE *) const
 Save a file using the given FILE*. Returns true if successful.
virtual const char * Parse (const char *p, TiXmlParsingData *data=0, TiXmlEncoding encoding=TIXML_DEFAULT_ENCODING)
const TiXmlElementRootElement () const
TiXmlElementRootElement ()
bool Error () const
const char * ErrorDesc () const
 Contains a textual (english) description of the error if one occurs.
int ErrorId () const
int ErrorRow () const
int ErrorCol () const
 The column where the error occured. See ErrorRow()
void SetTabSize (int _tabsize)
int TabSize () const
void ClearError ()
void Print () const
virtual void Print (FILE *cfile, int depth=0) const
 Print this Document to a FILE stream.
void SetError (int err, const char *errorLocation, TiXmlParsingData *prevData, TiXmlEncoding encoding)
virtual const TiXmlDocumentToDocument () const
 Cast to a more defined type. Will return null not of the requested type.
virtual TiXmlDocumentToDocument ()
 Cast to a more defined type. Will return null not of the requested type.
virtual bool Accept (TiXmlVisitor *content) const
const char * Value () const
const TIXML_STRING & ValueTStr () const
void SetValue (const char *_value)
void Clear ()
 Delete all the children of this node. Does not affect 'this'.
TiXmlNodeParent ()
 One step up the DOM.
const TiXmlNodeParent () const
const TiXmlNodeFirstChild () const
 The first child of this node. Will be null if there are no children.
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 TiXmlNodeLastChild () const
TiXmlNodeLastChild ()
 The last child of this node. Will be null if there are no children.
const TiXmlNodeLastChild (const char *value) const
TiXmlNodeLastChild (const char *_value)
 The last child of this node matching 'value'. Will be null if there are no children.
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)
TiXmlNodeInsertEndChild (const TiXmlNode &addThis)
TiXmlNodeLinkEndChild (TiXmlNode *addThis)
TiXmlNodeInsertBeforeChild (TiXmlNode *beforeThis, const TiXmlNode &addThis)
TiXmlNodeInsertAfterChild (TiXmlNode *afterThis, const TiXmlNode &addThis)
TiXmlNodeReplaceChild (TiXmlNode *replaceThis, const TiXmlNode &withThis)
bool RemoveChild (TiXmlNode *removeThis)
 Delete a child of this node.
const TiXmlNodePreviousSibling () const
 Navigate to a sibling node.
TiXmlNodePreviousSibling ()
const TiXmlNodePreviousSibling (const char *) const
 Navigate to a sibling node.
TiXmlNodePreviousSibling (const char *_prev)
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)
const TiXmlElementNextSiblingElement () const
TiXmlElementNextSiblingElement ()
const TiXmlElementNextSiblingElement (const char *) const
TiXmlElementNextSiblingElement (const char *_next)
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)
int Type () const
const TiXmlDocumentGetDocument () const
TiXmlDocumentGetDocument ()
bool NoChildren () const
 Returns true if this node has no children.
virtual const TiXmlElementToElement () const
 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 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 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.
virtual const TiXmlTextToText () 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 TiXmlDeclarationToDeclaration () const
 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.
int Row () const
int Column () const
 See Row()
void SetUserData (void *user)
 Set a pointer to arbitrary user data.
void * GetUserData ()
 Get a pointer to arbitrary user data.
const void * GetUserData () const
 Get a pointer to arbitrary user data.

Static Public Member Functions

static void SetCondenseWhiteSpace (bool condense)
static bool IsWhiteSpaceCondensed ()
 Return the current white space setting.
static void EncodeString (const TIXML_STRING &str, TIXML_STRING *out)

Static Public Attributes

static const int utf8ByteTable [256]

Protected Member Functions

virtual TiXmlNodeClone () const
void CopyTo (TiXmlNode *target) const
TiXmlNodeIdentify (const char *start, TiXmlEncoding encoding)

Static Protected Member Functions

static const char * SkipWhiteSpace (const char *, TiXmlEncoding encoding)
static bool IsWhiteSpace (char c)
static bool IsWhiteSpace (int c)
static const char * ReadName (const char *p, TIXML_STRING *name, TiXmlEncoding encoding)
static const char * ReadText (const char *in, TIXML_STRING *text, bool ignoreWhiteSpace, const char *endTag, bool ignoreCase, TiXmlEncoding encoding)
static const char * GetEntity (const char *in, char *value, int *length, TiXmlEncoding encoding)
static const char * GetChar (const char *p, char *_value, int *length, TiXmlEncoding encoding)
static bool StringEqual (const char *p, const char *endTag, bool ignoreCase, TiXmlEncoding encoding)
static int IsAlpha (unsigned char anyByte, TiXmlEncoding encoding)
static int IsAlphaNum (unsigned char anyByte, TiXmlEncoding encoding)
static int ToLower (int v, TiXmlEncoding encoding)
static void ConvertUTF32ToUTF8 (unsigned long input, char *output, int *length)

Protected Attributes

TiXmlNodeparent
NodeType type
TiXmlNodefirstChild
TiXmlNodelastChild
TIXML_STRING value
TiXmlNodeprev
TiXmlNodenext
TiXmlCursor location
void * userData
 Field containing a generic user pointer.

Static Protected Attributes

static const char * errorString [TIXML_ERROR_STRING_COUNT]

Private Member Functions

void CopyTo (TiXmlDocument *target) const

Private Attributes

bool error
int errorId
TIXML_STRING errorDesc
int tabsize
TiXmlCursor errorLocation
bool useMicrosoftBOM

Detailed Description

Always the top level node. A document binds together all the XML pieces. It can be saved, loaded, and printed to the screen. The 'value' of a document node is the xml file name.


Member Enumeration Documentation

enum TiXmlNode::NodeType [inherited]

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 
anonymous enum [inherited]
Enumerator:
TIXML_NO_ERROR 
TIXML_ERROR 
TIXML_ERROR_OPENING_FILE 
TIXML_ERROR_OUT_OF_MEMORY 
TIXML_ERROR_PARSING_ELEMENT 
TIXML_ERROR_FAILED_TO_READ_ELEMENT_NAME 
TIXML_ERROR_READING_ELEMENT_VALUE 
TIXML_ERROR_READING_ATTRIBUTES 
TIXML_ERROR_PARSING_EMPTY 
TIXML_ERROR_READING_END_TAG 
TIXML_ERROR_PARSING_UNKNOWN 
TIXML_ERROR_PARSING_COMMENT 
TIXML_ERROR_PARSING_DECLARATION 
TIXML_ERROR_DOCUMENT_EMPTY 
TIXML_ERROR_EMBEDDED_NULL 
TIXML_ERROR_PARSING_CDATA 
TIXML_ERROR_DOCUMENT_TOP_ONLY 
TIXML_ERROR_STRING_COUNT 

Constructor & Destructor Documentation

TiXmlDocument::TiXmlDocument ( )

Create an empty document, that has no name.

References ClearError(), tabsize, and useMicrosoftBOM.

Referenced by Clone().

TiXmlDocument::TiXmlDocument ( const char *  documentName)

Create a document with a name. The name of the document is also the filename of the xml.

References ClearError(), tabsize, useMicrosoftBOM, and TiXmlNode::value.

TiXmlDocument::TiXmlDocument ( const TiXmlDocument copy)

References CopyTo().

virtual TiXmlDocument::~TiXmlDocument ( ) [inline, virtual]

Member Function Documentation

void TiXmlDocument::operator= ( const TiXmlDocument copy)

References TiXmlNode::Clear(), and CopyTo().

bool TiXmlDocument::LoadFile ( TiXmlEncoding  encoding = TIXML_DEFAULT_ENCODING)

Load a file using the current document value. Returns true if successful. Will delete any existing document data before loading.

References TiXmlNode::Value().

Referenced by LoadFile().

bool TiXmlDocument::SaveFile ( ) const

Save a file using the current document value. Returns true if successful.

References TiXmlNode::Value().

Referenced by SaveFile().

bool TiXmlDocument::LoadFile ( const char *  filename,
TiXmlEncoding  encoding = TIXML_DEFAULT_ENCODING 
)

Load a file using the given filename. Returns true if successful.

References LoadFile(), SetError(), TIXML_ENCODING_UNKNOWN, TiXmlBase::TIXML_ERROR_OPENING_FILE, TIXML_STRING, TiXmlFOpen(), and TiXmlNode::value.

bool TiXmlDocument::SaveFile ( const char *  filename) const

Save a file using the given filename. Returns true if successful.

References SaveFile(), and TiXmlFOpen().

bool TiXmlDocument::LoadFile ( FILE *  file,
TiXmlEncoding  encoding = TIXML_DEFAULT_ENCODING 
)

Load a file using the given FILE*. Returns true if successful. Note that this method doesn't stream - the entire object pointed at by the FILE* will be interpreted as an XML file. TinyXML doesn't stream in XML from the current file location. Streaming may be added in the future.

References TiXmlCursor::Clear(), TiXmlNode::Clear(), Error(), TiXmlBase::location, Parse(), SetError(), TIXML_ENCODING_UNKNOWN, TiXmlBase::TIXML_ERROR_DOCUMENT_EMPTY, TiXmlBase::TIXML_ERROR_OPENING_FILE, and TIXML_STRING.

bool TiXmlDocument::SaveFile ( FILE *  fp) const

Save a file using the given FILE*. Returns true if successful.

References Print(), TIXML_UTF_LEAD_0, TIXML_UTF_LEAD_1, TIXML_UTF_LEAD_2, and useMicrosoftBOM.

const char * TiXmlDocument::Parse ( const char *  p,
TiXmlParsingData data = 0,
TiXmlEncoding  encoding = TIXML_DEFAULT_ENCODING 
) [virtual]
const TiXmlElement* TiXmlDocument::RootElement ( ) const [inline]

Get the root element -- the only top level element -- of the document. In well formed XML, there should only be one. TinyXml is tolerant of multiple elements at the document level.

References TiXmlNode::FirstChildElement().

TiXmlElement* TiXmlDocument::RootElement ( ) [inline]
bool TiXmlDocument::Error ( ) const [inline]

If an error occurs, Error will be set to true. Also,

  • The ErrorId() will contain the integer identifier of the error (not generally useful)
  • The ErrorDesc() method will return the name of the error. (very useful)
  • The ErrorRow() and ErrorCol() will return the location of the error (if known)

References error.

Referenced by LoadFile().

const char* TiXmlDocument::ErrorDesc ( ) const [inline]

Contains a textual (english) description of the error if one occurs.

References errorDesc.

int TiXmlDocument::ErrorId ( ) const [inline]

Generally, you probably want the error string ( ErrorDesc() ). But if you prefer the ErrorId, this function will fetch it.

References errorId.

int TiXmlDocument::ErrorRow ( ) const [inline]

Returns the location (if known) of the error. The first column is column 1, and the first row is row 1. A value of 0 means the row and column wasn't applicable (memory errors, for example, have no row/column) or the parser lost the error. (An error in the error reporting, in that case.)

See also:
SetTabSize, Row, Column

References errorLocation, and TiXmlCursor::row.

int TiXmlDocument::ErrorCol ( ) const [inline]

The column where the error occured. See ErrorRow()

References TiXmlCursor::col, and errorLocation.

void TiXmlDocument::SetTabSize ( int  _tabsize) [inline]

SetTabSize() allows the error reporting functions (ErrorRow() and ErrorCol()) to report the correct values for row and column. It does not change the output or input in any way.

By calling this method, with a tab size greater than 0, the row and column of each node and attribute is stored when the file is loaded. Very useful for tracking the DOM back in to the source file.

The tab size is required for calculating the location of nodes. If not set, the default of 4 is used. The tabsize is set per document. Setting the tabsize to 0 disables row/column tracking.

Note that row and column tracking is not supported when using operator>>.

The tab size needs to be enabled before the parse or load. Correct usage:

		TiXmlDocument doc;
		doc.SetTabSize( 8 );
		doc.Load( "myfile.xml" );
		
See also:
Row, Column

References tabsize.

int TiXmlDocument::TabSize ( ) const [inline]

References tabsize.

Referenced by Parse().

void TiXmlDocument::ClearError ( ) [inline]

If you have handled the error, it can be reset with this call. The error state is automatically cleared if you Parse a new XML block.

References TiXmlCursor::col, error, errorDesc, errorId, errorLocation, and TiXmlCursor::row.

Referenced by Parse(), and TiXmlDocument().

void TiXmlDocument::Print ( ) const [inline]

Write the document to standard out using formatted printing ("pretty print").

References Print().

Referenced by Print(), and SaveFile().

void TiXmlDocument::Print ( FILE *  cfile,
int  depth = 0 
) const [virtual]

Print this Document to a FILE stream.

Implements TiXmlBase.

References TiXmlNode::FirstChild(), and TiXmlAttribute::Print().

void TiXmlDocument::SetError ( int  err,
const char *  errorLocation,
TiXmlParsingData prevData,
TiXmlEncoding  encoding 
)
virtual const TiXmlDocument* TiXmlDocument::ToDocument ( ) const [inline, virtual]

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

Reimplemented from TiXmlNode.

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

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

Reimplemented from TiXmlNode.

bool TiXmlDocument::Accept ( TiXmlVisitor content) const [virtual]

Walk the XML tree visiting this node and all of its children.

Implements TiXmlNode.

References TiXmlNode::FirstChild(), TiXmlVisitor::VisitEnter(), and TiXmlVisitor::VisitExit().

TiXmlNode * TiXmlDocument::Clone ( ) const [protected, virtual]

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

Implements TiXmlNode.

References CopyTo(), and TiXmlDocument().

void TiXmlDocument::CopyTo ( TiXmlDocument target) const [private]
const char* TiXmlNode::Value ( ) const [inline, inherited]

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.

References TiXmlNode::value.

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

const TIXML_STRING& TiXmlNode::ValueTStr ( ) const [inline, inherited]

References TiXmlNode::value.

Referenced by TiXmlPrinter::Visit().

void TiXmlNode::SetValue ( const char *  _value) [inline, inherited]

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
		

References TiXmlNode::value.

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

void TiXmlNode::Clear ( ) [inherited]

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

References TiXmlNode::firstChild, TiXmlNode::lastChild, and TiXmlNode::next.

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

TiXmlNode* TiXmlNode::Parent ( ) [inline, inherited]

One step up the DOM.

References TiXmlNode::parent.

const TiXmlNode* TiXmlNode::Parent ( ) const [inline, inherited]

References TiXmlNode::parent.

const TiXmlNode* TiXmlNode::FirstChild ( ) const [inline, inherited]
TiXmlNode* TiXmlNode::FirstChild ( ) [inline, inherited]

References TiXmlNode::firstChild.

const TiXmlNode * TiXmlNode::FirstChild ( const char *  value) const [inherited]

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

References TiXmlNode::firstChild, TiXmlNode::next, and TiXmlNode::Value().

TiXmlNode* TiXmlNode::FirstChild ( const char *  _value) [inline, inherited]

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

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

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

References TiXmlNode::lastChild.

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

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

const TiXmlNode * TiXmlNode::IterateChildren ( const TiXmlNode previous) const [inherited]

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.

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

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

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

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

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

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.

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

TiXmlNode * TiXmlNode::LinkEndChild ( TiXmlNode addThis) [inherited]

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

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

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

TiXmlNode * TiXmlNode::InsertBeforeChild ( TiXmlNode beforeThis,
const TiXmlNode addThis 
) [inherited]

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.

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

TiXmlNode * TiXmlNode::InsertAfterChild ( TiXmlNode afterThis,
const TiXmlNode addThis 
) [inherited]

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.

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

TiXmlNode * TiXmlNode::ReplaceChild ( TiXmlNode replaceThis,
const TiXmlNode withThis 
) [inherited]

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

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

bool TiXmlNode::RemoveChild ( TiXmlNode removeThis) [inherited]
const TiXmlNode* TiXmlNode::PreviousSibling ( ) const [inline, inherited]

Navigate to a sibling node.

References TiXmlNode::prev.

TiXmlNode* TiXmlNode::PreviousSibling ( ) [inline, inherited]

References TiXmlNode::prev.

const TiXmlNode * TiXmlNode::PreviousSibling ( const char *  _value) const [inherited]

Navigate to a sibling node.

References TiXmlNode::prev, and TiXmlNode::Value().

TiXmlNode* TiXmlNode::PreviousSibling ( const char *  _prev) [inline, inherited]
const TiXmlNode* TiXmlNode::NextSibling ( ) const [inline, inherited]
TiXmlNode* TiXmlNode::NextSibling ( ) [inline, inherited]

References TiXmlNode::next.

const TiXmlNode * TiXmlNode::NextSibling ( const char *  _value) const [inherited]

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

References TiXmlNode::next, and TiXmlNode::Value().

TiXmlNode* TiXmlNode::NextSibling ( const char *  _next) [inline, inherited]
const TiXmlElement * TiXmlNode::NextSiblingElement ( ) const [inherited]

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

References TiXmlNode::NextSibling(), and TiXmlNode::ToElement().

Referenced by TiXmlHandle::ChildElement().

TiXmlElement* TiXmlNode::NextSiblingElement ( ) [inline, inherited]
const TiXmlElement * TiXmlNode::NextSiblingElement ( const char *  _value) const [inherited]

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

References TiXmlNode::NextSibling(), and TiXmlNode::ToElement().

TiXmlElement* TiXmlNode::NextSiblingElement ( const char *  _next) [inline, inherited]
const TiXmlElement * TiXmlNode::FirstChildElement ( ) const [inherited]

Convenience function to get through elements.

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

Referenced by RootElement().

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

Convenience function to get through elements.

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

TiXmlElement* TiXmlNode::FirstChildElement ( const char *  _value) [inline, inherited]
int TiXmlNode::Type ( ) const [inline, inherited]

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

References TiXmlNode::type.

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

const TiXmlDocument * TiXmlNode::GetDocument ( ) const [inherited]
TiXmlDocument* TiXmlNode::GetDocument ( ) [inline, inherited]
bool TiXmlNode::NoChildren ( ) const [inline, inherited]

Returns true if this node has no children.

References TiXmlNode::firstChild.

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

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

Reimplemented in TiXmlElement.

Referenced by TiXmlNode::FirstChildElement(), and TiXmlNode::NextSiblingElement().

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

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

Reimplemented in TiXmlElement.

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

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

Reimplemented in TiXmlComment.

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

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

Reimplemented in TiXmlComment.

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

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

Reimplemented in TiXmlUnknown.

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

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

Reimplemented in TiXmlUnknown.

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

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

Reimplemented in TiXmlText.

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

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

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

Reimplemented in TiXmlText.

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

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

Reimplemented in TiXmlDeclaration.

Referenced by Parse().

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

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

Reimplemented in TiXmlDeclaration.

void TiXmlNode::CopyTo ( TiXmlNode target) const [protected, inherited]
TiXmlNode * TiXmlNode::Identify ( const char *  start,
TiXmlEncoding  encoding 
) [protected, inherited]
static void TiXmlBase::SetCondenseWhiteSpace ( bool  condense) [inline, static, inherited]

The world does not agree on whether white space should be kept or not. In order to make everyone happy, these global, static functions are provided to set whether or not TinyXml will condense all white space into a single space or not. The default is to condense. Note changing this value is not thread safe.

References TiXmlBase::condenseWhiteSpace.

static bool TiXmlBase::IsWhiteSpaceCondensed ( ) [inline, static, inherited]

Return the current white space setting.

References TiXmlBase::condenseWhiteSpace.

Referenced by TiXmlElement::ReadValue().

int TiXmlBase::Row ( ) const [inline, inherited]

Return the position, in the original source file, of this node or attribute. The row and column are 1-based. (That is the first row and first column is 1,1). If the returns values are 0 or less, then the parser does not have a row and column value.

Generally, the row and column value will be set when the TiXmlDocument::Load(), TiXmlDocument::LoadFile(), or any TiXmlNode::Parse() is called. It will NOT be set when the DOM was created from operator>>.

The values reflect the initial load. Once the DOM is modified programmatically (by adding or changing nodes and attributes) the new values will NOT update to reflect changes in the document.

There is a minor performance cost to computing the row and column. Computation can be disabled if TiXmlDocument::SetTabSize() is called with 0 as the value.

See also:
TiXmlDocument::SetTabSize()

References TiXmlBase::location, and TiXmlCursor::row.

int TiXmlBase::Column ( ) const [inline, inherited]
void TiXmlBase::SetUserData ( void *  user) [inline, inherited]

Set a pointer to arbitrary user data.

References TiXmlBase::userData.

void* TiXmlBase::GetUserData ( ) [inline, inherited]

Get a pointer to arbitrary user data.

References TiXmlBase::userData.

const void* TiXmlBase::GetUserData ( ) const [inline, inherited]

Get a pointer to arbitrary user data.

References TiXmlBase::userData.

void TiXmlBase::EncodeString ( const TIXML_STRING &  str,
TIXML_STRING *  out 
) [static, inherited]

Expands entities in a string. Note this should not contian the tag's '<', '>', etc, or they will be transformed into entities!

References TiXmlBase::entity.

Referenced by TiXmlAttribute::Print(), TiXmlText::Print(), and TiXmlPrinter::Visit().

const char * TiXmlBase::SkipWhiteSpace ( const char *  p,
TiXmlEncoding  encoding 
) [static, protected, inherited]
static bool TiXmlBase::IsWhiteSpace ( char  c) [inline, static, protected, inherited]
static bool TiXmlBase::IsWhiteSpace ( int  c) [inline, static, protected, inherited]
const char * TiXmlBase::ReadName ( const char *  p,
TIXML_STRING *  name,
TiXmlEncoding  encoding 
) [static, protected, inherited]
const char * TiXmlBase::ReadText ( const char *  in,
TIXML_STRING *  text,
bool  ignoreWhiteSpace,
const char *  endTag,
bool  ignoreCase,
TiXmlEncoding  encoding 
) [static, protected, inherited]
const char * TiXmlBase::GetEntity ( const char *  in,
char *  value,
int *  length,
TiXmlEncoding  encoding 
) [static, protected, inherited]
static const char* TiXmlBase::GetChar ( const char *  p,
char *  _value,
int *  length,
TiXmlEncoding  encoding 
) [inline, static, protected, inherited]
bool TiXmlBase::StringEqual ( const char *  p,
const char *  endTag,
bool  ignoreCase,
TiXmlEncoding  encoding 
) [static, protected, inherited]
int TiXmlBase::IsAlpha ( unsigned char  anyByte,
TiXmlEncoding  encoding 
) [static, protected, inherited]
int TiXmlBase::IsAlphaNum ( unsigned char  anyByte,
TiXmlEncoding  encoding 
) [static, protected, inherited]

Referenced by TiXmlBase::ReadName().

static int TiXmlBase::ToLower ( int  v,
TiXmlEncoding  encoding 
) [inline, static, protected, inherited]

References TIXML_ENCODING_UTF8.

Referenced by TiXmlBase::StringEqual().

void TiXmlBase::ConvertUTF32ToUTF8 ( unsigned long  input,
char *  output,
int *  length 
) [static, protected, inherited]

Referenced by TiXmlBase::GetEntity().


Member Data Documentation

bool TiXmlDocument::error [private]

Referenced by ClearError(), CopyTo(), Error(), and SetError().

int TiXmlDocument::errorId [private]

Referenced by ClearError(), CopyTo(), ErrorId(), and SetError().

TIXML_STRING TiXmlDocument::errorDesc [private]
int TiXmlDocument::tabsize [private]

Referenced by CopyTo(), Parse(), SaveFile(), and TiXmlDocument().

TiXmlNode* TiXmlNode::parent [protected, inherited]
NodeType TiXmlNode::type [protected, inherited]
TiXmlNode* TiXmlNode::firstChild [protected, inherited]
TiXmlNode* TiXmlNode::lastChild [protected, inherited]
TIXML_STRING TiXmlNode::value [protected, inherited]
TiXmlNode* TiXmlNode::prev [protected, inherited]
TiXmlNode* TiXmlNode::next [protected, inherited]
const int TiXmlBase::utf8ByteTable [static, inherited]
Initial value:
 
{
        
                1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      
                1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      
                1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      
                1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      
                1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      
                1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      
                1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      
                1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      
                1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      
                1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      
                1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      
                1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      
                1,      1,      2,      2,      2,      2,      2,      2,      2,      2,      2,      2,      2,      2,      2,      2,      
                2,      2,      2,      2,      2,      2,      2,      2,      2,      2,      2,      2,      2,      2,      2,      2,      
                3,      3,      3,      3,      3,      3,      3,      3,      3,      3,      3,      3,      3,      3,      3,      3,      
                4,      4,      4,      4,      4,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1       
}

Referenced by TiXmlBase::GetChar(), and TiXmlParsingData::Stamp().

const char * TiXmlBase::errorString [static, protected, inherited]
Initial value:
{
        "No error",
        "Error",
        "Failed to open file",
        "Memory allocation failed.",
        "Error parsing Element.",
        "Failed to read Element name",
        "Error reading Element value.",
        "Error reading Attributes.",
        "Error: empty tag.",
        "Error reading end tag.",
        "Error parsing Unknown.",
        "Error parsing Comment.",
        "Error parsing Declaration.",
        "Error document empty.",
        "Error null (0) or unexpected EOF found in input stream.",
        "Error parsing CDATA.",
        "Error when TiXmlDocument added to document, because TiXmlDocument can only be at the root.",
}

Referenced by SetError().

TiXmlCursor TiXmlBase::location [protected, inherited]
void* TiXmlBase::userData [protected, inherited]

Field containing a generic user pointer.

Referenced by TiXmlNode::CopyTo(), TiXmlBase::GetUserData(), and TiXmlBase::SetUserData().


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

Generated on Fri Dec 23 2011 09:28:55 for MTK++ by Doxygen 1.7.5.1