Orocos Real-Time Toolkit  2.9.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 | List of all members
RTT::marsh::TiXmlDocument Class Reference

Always the top level node. More...

#include <rtt/marsh/tinyxml.h>

Inheritance diagram for RTT::marsh::TiXmlDocument:
RTT::marsh::TiXmlNode RTT::marsh::TiXmlBase

Public Types

enum  NodeType {
  DOCUMENT, ELEMENT, COMMENT, UNKNOWN,
  TEXT, DECLARATION, TYPECOUNT
}
 The types of XML nodes supported by TinyXml. More...
 
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_STRING_COUNT
}
 

Public Member Functions

 TiXmlDocument ()
 Create an empty document, that has no name. More...
 
 TiXmlDocument (const char *documentName)
 Create a document with a name. The name of the document is also the filename of the xml. More...
 
 TiXmlDocument (const TiXmlDocument &copy)
 
void operator= (const TiXmlDocument &copy)
 
virtual ~TiXmlDocument ()
 
bool LoadFile (TiXmlEncoding encoding=TIXML_DEFAULT_ENCODING)
 Load a file using the current document value. More...
 
bool SaveFile () const
 Save a file using the current document value. Returns true if successful. More...
 
bool LoadFile (const char *filename, TiXmlEncoding encoding=TIXML_DEFAULT_ENCODING)
 Load a file using the given filename. Returns true if successful. More...
 
bool SaveFile (const char *filename) const
 Save a file using the given filename. Returns true if successful. More...
 
bool LoadFile (FILE *, TiXmlEncoding encoding=TIXML_DEFAULT_ENCODING)
 Load a file using the given FILE*. More...
 
bool SaveFile (FILE *) const
 Save a file using the given FILE*. Returns true if successful. More...
 
virtual const char * Parse (const char *p, TiXmlParsingData *data=0, TiXmlEncoding encoding=TIXML_DEFAULT_ENCODING)
 Parse the given null terminated block of xml data. More...
 
const TiXmlElementRootElement () const
 Get the root element – the only top level element – of the document. More...
 
TiXmlElementRootElement ()
 
bool Error () const
 If an error occurs, Error will be set to true. More...
 
const char * ErrorDesc () const
 Contains a textual (english) description of the error if one occurs. More...
 
int ErrorId () const
 Generally, you probably want the error string ( ErrorDesc() ). More...
 
int ErrorRow ()
 Returns the location (if known) of the error. More...
 
int ErrorCol ()
 The column where the error occured. See ErrorRow() More...
 
void SetTabSize (int _tabsize)
 SetTabSize() allows the error reporting functions (ErrorRow() and ErrorCol()) to report the correct values for row and column. More...
 
int TabSize () const
 
void ClearError ()
 If you have handled the error, it can be reset with this call. More...
 
void Print () const
 Dump the document to standard out. More...
 
virtual void Print (FILE *cfile, int depth=0) const
 Print this Document to a FILE stream. More...
 
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. More...
 
virtual TiXmlDocumentToDocument ()
 Cast to a more defined type. Will return null not of the requested type. More...
 
const char * Value () const
 The meaning of 'value' changes for the specific type of TiXmlNode. More...
 
void SetValue (const char *_value)
 Changes the value of the node. More...
 
void Clear ()
 Delete all the children of this node. Does not affect 'this'. More...
 
TiXmlNodeParent ()
 One step up the DOM. More...
 
const TiXmlNodeParent () const
 
const TiXmlNodeFirstChild () const
 The first child of this node. Will be null if there are no children. More...
 
TiXmlNodeFirstChild ()
 
const TiXmlNodeFirstChild (const char *value) const
 The first child of this node with the matching 'value'. Will be null if none found. More...
 
TiXmlNodeFirstChild (const char *value)
 The first child of this node with the matching 'value'. Will be null if none found. More...
 
const TiXmlNodeLastChild () const
 
TiXmlNodeLastChild ()
 The last child of this node. Will be null if there are no children. More...
 
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. More...
 
const TiXmlNodeIterateChildren (const TiXmlNode *previous) const
 An alternate way to walk the children of a node. More...
 
TiXmlNodeIterateChildren (TiXmlNode *previous)
 
const TiXmlNodeIterateChildren (const char *value, const TiXmlNode *previous) const
 This flavor of IterateChildren searches for children with a particular 'value'. More...
 
TiXmlNodeIterateChildren (const char *value, TiXmlNode *previous)
 
TiXmlNodeInsertEndChild (const TiXmlNode &addThis)
 Add a new node related to this. More...
 
TiXmlNodeLinkEndChild (TiXmlNode *addThis)
 Add a new node related to this. More...
 
TiXmlNodeInsertBeforeChild (TiXmlNode *beforeThis, const TiXmlNode &addThis)
 Add a new node related to this. More...
 
TiXmlNodeInsertAfterChild (TiXmlNode *afterThis, const TiXmlNode &addThis)
 Add a new node related to this. More...
 
TiXmlNodeReplaceChild (TiXmlNode *replaceThis, const TiXmlNode &withThis)
 Replace a child of this node. More...
 
bool RemoveChild (TiXmlNode *removeThis)
 Delete a child of this node. More...
 
const TiXmlNodePreviousSibling () const
 Navigate to a sibling node. More...
 
TiXmlNodePreviousSibling ()
 
const TiXmlNodePreviousSibling (const char *) const
 Navigate to a sibling node. More...
 
TiXmlNodePreviousSibling (const char *)
 
const TiXmlNodeNextSibling () const
 Navigate to a sibling node. More...
 
TiXmlNodeNextSibling ()
 
const TiXmlNodeNextSibling (const char *) const
 Navigate to a sibling node with the given 'value'. More...
 
TiXmlNodeNextSibling (const char *)
 
const TiXmlElementNextSiblingElement () const
 Convenience function to get through elements. More...
 
TiXmlElementNextSiblingElement ()
 
const TiXmlElementNextSiblingElement (const char *) const
 Convenience function to get through elements. More...
 
TiXmlElementNextSiblingElement (const char *)
 
const TiXmlElementFirstChildElement () const
 Convenience function to get through elements. More...
 
TiXmlElementFirstChildElement ()
 
const TiXmlElementFirstChildElement (const char *value) const
 Convenience function to get through elements. More...
 
TiXmlElementFirstChildElement (const char *value)
 
int Type () const
 Query the type (as an enumerated value, above) of this node. More...
 
const TiXmlDocumentGetDocument () const
 Return a pointer to the Document this node lives in. More...
 
TiXmlDocumentGetDocument ()
 
bool NoChildren () const
 Returns true if this node has no children. More...
 
virtual const TiXmlElementToElement () const
 Cast to a more defined type. Will return null if not of the requested type. More...
 
virtual TiXmlElementToElement ()
 Cast to a more defined type. Will return null if not of the requested type. More...
 
virtual const TiXmlCommentToComment () const
 Cast to a more defined type. Will return null if not of the requested type. More...
 
virtual TiXmlCommentToComment ()
 Cast to a more defined type. Will return null if not of the requested type. More...
 
virtual const TiXmlUnknownToUnknown () const
 Cast to a more defined type. Will return null if not of the requested type. More...
 
virtual TiXmlUnknownToUnknown ()
 Cast to a more defined type. Will return null if not of the requested type. More...
 
virtual const TiXmlTextToText () const
 Cast to a more defined type. Will return null if not of the requested type. More...
 
virtual TiXmlTextToText ()
 Cast to a more defined type. Will return null if not of the requested type. More...
 
virtual const TiXmlDeclarationToDeclaration () const
 Cast to a more defined type. Will return null if not of the requested type. More...
 
virtual TiXmlDeclarationToDeclaration ()
 Cast to a more defined type. Will return null if not of the requested type. More...
 
int Row () const
 Return the position, in the original source file, of this node or attribute. More...
 
int Column () const
 See Row() More...
 
void SetUserData (void *user)
 
void * GetUserData ()
 

Static Public Member Functions

static void SetCondenseWhiteSpace (bool condense)
 The world does not agree on whether white space should be kept or not. More...
 
static bool IsWhiteSpaceCondensed ()
 Return the current white space setting. More...
 

Static Public Attributes

static const int utf8ByteTable [256]
 

Protected Member Functions

virtual void StreamOut (TIXML_OSTREAM *out) const
 
virtual TiXmlNodeClone () const
 Create an exact duplicate of this node and return it. More...
 
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 void PutString (const TIXML_STRING &str, TIXML_OSTREAM *out)
 
static void PutString (const TIXML_STRING &str, TIXML_STRING *out)
 
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. More...
 

Static Protected Attributes

static const char * errorString [TIXML_ERROR_STRING_COUNT]
 

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.

Definition at line 1259 of file tinyxml.h.

Member Enumeration Documentation

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_STRING_COUNT 

Definition at line 249 of file tinyxml.h.

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 467 of file tinyxml.h.

Constructor & Destructor Documentation

RTT::marsh::TiXmlDocument::TiXmlDocument ( )

Create an empty document, that has no name.

Definition at line 980 of file tinyxml.cpp.

References ClearError().

Referenced by Clone(), and TiXmlDocument().

RTT::marsh::TiXmlDocument::TiXmlDocument ( const char *  documentName)

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

Definition at line 987 of file tinyxml.cpp.

References ClearError(), RTT::marsh::TiXmlNode::DOCUMENT, TiXmlDocument(), RTT::marsh::TiXmlNode::TiXmlNode(), and RTT::marsh::TiXmlNode::value.

RTT::marsh::TiXmlDocument::TiXmlDocument ( const TiXmlDocument copy)

Definition at line 1007 of file tinyxml.cpp.

virtual RTT::marsh::TiXmlDocument::~TiXmlDocument ( )
inlinevirtual

Definition at line 1275 of file tinyxml.h.

References RTT::marsh::TiXmlBase::StringToBuffer::buffer.

Member Function Documentation

void RTT::marsh::TiXmlNode::Clear ( )
inherited
void RTT::marsh::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.

Definition at line 1379 of file tinyxml.h.

Referenced by TiXmlDocument().

TiXmlNode * RTT::marsh::TiXmlDocument::Clone ( ) const
protectedvirtual

Create an exact duplicate of this node and return it.

The memory must be deleted by the caller.

Implements RTT::marsh::TiXmlNode.

Definition at line 1231 of file tinyxml.cpp.

References TiXmlDocument().

int RTT::marsh::TiXmlBase::Column ( ) const
inlineinherited

See Row()

Definition at line 236 of file tinyxml.h.

void RTT::marsh::TiXmlBase::ConvertUTF32ToUTF8 ( unsigned long  input,
char *  output,
int *  length 
)
staticprotectedinherited

Definition at line 127 of file tinyxmlparser.cpp.

Referenced by RTT::marsh::TiXmlBase::GetEntity().

void RTT::marsh::TiXmlNode::CopyTo ( TiXmlNode target) const
protectedinherited
bool RTT::marsh::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)

Definition at line 1328 of file tinyxml.h.

Referenced by LoadFile().

int RTT::marsh::TiXmlDocument::ErrorCol ( )
inline

The column where the error occured. See ErrorRow()

Definition at line 1346 of file tinyxml.h.

const char* RTT::marsh::TiXmlDocument::ErrorDesc ( ) const
inline

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

Definition at line 1331 of file tinyxml.h.

int RTT::marsh::TiXmlDocument::ErrorId ( ) const
inline

Generally, you probably want the error string ( ErrorDesc() ).

But if you prefer the ErrorId, this function will fetch it.

Definition at line 1336 of file tinyxml.h.

int RTT::marsh::TiXmlDocument::ErrorRow ( )
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

Definition at line 1345 of file tinyxml.h.

const TiXmlNode* RTT::marsh::TiXmlNode::FirstChild ( ) const
inlineinherited
TiXmlNode* RTT::marsh::TiXmlNode::FirstChild ( )
inlineinherited

Definition at line 526 of file tinyxml.h.

const TiXmlNode * RTT::marsh::TiXmlNode::FirstChild ( const char *  value) const
inherited

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

Definition at line 365 of file tinyxml.cpp.

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

TiXmlNode * RTT::marsh::TiXmlNode::FirstChild ( const char *  value)
inherited

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

Definition at line 377 of file tinyxml.cpp.

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

const TiXmlElement * RTT::marsh::TiXmlNode::FirstChildElement ( ) const
inherited
TiXmlElement * RTT::marsh::TiXmlNode::FirstChildElement ( )
inherited
const TiXmlElement * RTT::marsh::TiXmlNode::FirstChildElement ( const char *  value) const
inherited

Convenience function to get through elements.

Definition at line 546 of file tinyxml.cpp.

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

TiXmlElement * RTT::marsh::TiXmlNode::FirstChildElement ( const char *  value)
inherited
static const char* RTT::marsh::TiXmlBase::GetChar ( const char *  p,
char *  _value,
int *  length,
TiXmlEncoding  encoding 
)
inlinestaticprotectedinherited

Definition at line 323 of file tinyxml.h.

References RTT::marsh::TIXML_ENCODING_UTF8, TIXML_OSTREAM, and TIXML_STRING.

Referenced by RTT::marsh::TiXmlBase::ReadText().

const TiXmlDocument * RTT::marsh::TiXmlNode::GetDocument ( ) const
inherited

Return a pointer to the Document this node lives in.

Returns null if not in a document.

Definition at line 631 of file tinyxml.cpp.

References RTT::marsh::TiXmlNode::parent, and RTT::marsh::TiXmlNode::ToDocument().

Referenced by RTT::marsh::TiXmlNode::LinkEndChild(), and RTT::marsh::TiXmlElement::SetAttribute().

TiXmlDocument * RTT::marsh::TiXmlNode::GetDocument ( )
inherited
const char * RTT::marsh::TiXmlBase::GetEntity ( const char *  in,
char *  value,
int *  length,
TiXmlEncoding  encoding 
)
staticprotectedinherited
void* RTT::marsh::TiXmlBase::GetUserData ( )
inlineinherited

Definition at line 239 of file tinyxml.h.

TiXmlNode * RTT::marsh::TiXmlNode::Identify ( const char *  start,
TiXmlEncoding  encoding 
)
protectedinherited
TiXmlNode * RTT::marsh::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.

Definition at line 289 of file tinyxml.cpp.

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

TiXmlNode * RTT::marsh::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.

Definition at line 263 of file tinyxml.cpp.

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

TiXmlNode * RTT::marsh::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.

Definition at line 253 of file tinyxml.cpp.

References RTT::marsh::TiXmlNode::Clone(), and RTT::marsh::TiXmlNode::LinkEndChild().

int RTT::marsh::TiXmlBase::IsAlpha ( unsigned char  anyByte,
TiXmlEncoding  encoding 
)
staticprotectedinherited
int RTT::marsh::TiXmlBase::IsAlphaNum ( unsigned char  anyByte,
TiXmlEncoding  encoding 
)
staticprotectedinherited

Definition at line 189 of file tinyxmlparser.cpp.

Referenced by RTT::marsh::TiXmlBase::ReadName().

static bool RTT::marsh::TiXmlBase::IsWhiteSpace ( char  c)
inlinestaticprotectedinherited
static bool RTT::marsh::TiXmlBase::IsWhiteSpace ( int  c)
inlinestaticprotectedinherited

Definition at line 288 of file tinyxml.h.

References TIXML_OSTREAM, and TIXML_STRING.

static bool RTT::marsh::TiXmlBase::IsWhiteSpaceCondensed ( )
inlinestaticinherited

Return the current white space setting.

Definition at line 215 of file tinyxml.h.

Referenced by RTT::marsh::TiXmlElement::ReadValue().

const TiXmlNode * RTT::marsh::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.

Definition at line 411 of file tinyxml.cpp.

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

TiXmlNode * RTT::marsh::TiXmlNode::IterateChildren ( TiXmlNode previous)
inherited
const TiXmlNode * RTT::marsh::TiXmlNode::IterateChildren ( const char *  value,
const TiXmlNode previous 
) const
inherited

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

Definition at line 437 of file tinyxml.cpp.

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

TiXmlNode * RTT::marsh::TiXmlNode::IterateChildren ( const char *  value,
TiXmlNode previous 
)
inherited
const TiXmlNode* RTT::marsh::TiXmlNode::LastChild ( ) const
inlineinherited

Definition at line 530 of file tinyxml.h.

TiXmlNode* RTT::marsh::TiXmlNode::LastChild ( )
inlineinherited

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

Definition at line 531 of file tinyxml.h.

const TiXmlNode * RTT::marsh::TiXmlNode::LastChild ( const char *  value) const
inherited
TiXmlNode * RTT::marsh::TiXmlNode::LastChild ( const char *  value)
inherited

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

Definition at line 400 of file tinyxml.cpp.

References RTT::marsh::TiXmlNode::lastChild, RTT::marsh::TiXmlNode::prev, and RTT::marsh::TiXmlNode::Value().

TiXmlNode * RTT::marsh::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

Definition at line 233 of file tinyxml.cpp.

References RTT::marsh::TiXmlNode::firstChild, RTT::marsh::TiXmlNode::GetDocument(), RTT::marsh::TiXmlNode::lastChild, RTT::marsh::TiXmlNode::next, RTT::marsh::TiXmlNode::parent, and RTT::marsh::TiXmlNode::prev.

Referenced by RTT::marsh::TiXmlElement::CopyTo(), RTT::marsh::TiXmlNode::InsertEndChild(), and SaveFile().

bool RTT::marsh::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.

Definition at line 1020 of file tinyxml.cpp.

References RTT::marsh::TiXmlBase::StringToBuffer::buffer, and RTT::marsh::TiXmlNode::value.

Referenced by LoadFile().

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

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

Definition at line 1043 of file tinyxml.cpp.

References LoadFile(), SetError(), RTT::marsh::TIXML_ENCODING_UNKNOWN, RTT::marsh::TiXmlBase::TIXML_ERROR_OPENING_FILE, and RTT::marsh::TiXmlNode::value.

bool RTT::marsh::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.

Definition at line 1071 of file tinyxml.cpp.

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

const TiXmlNode* RTT::marsh::TiXmlNode::NextSibling ( ) const
inlineinherited
TiXmlNode* RTT::marsh::TiXmlNode::NextSibling ( )
inlineinherited

Definition at line 622 of file tinyxml.h.

const TiXmlNode * RTT::marsh::TiXmlNode::NextSibling ( const char *  _value) const
inherited

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

Definition at line 463 of file tinyxml.cpp.

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

TiXmlNode * RTT::marsh::TiXmlNode::NextSibling ( const char *  _value)
inherited

Definition at line 474 of file tinyxml.cpp.

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

const TiXmlElement * RTT::marsh::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.

Definition at line 574 of file tinyxml.cpp.

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

Referenced by RTT::marsh::TiXmlHandle::ChildElement().

TiXmlElement * RTT::marsh::TiXmlNode::NextSiblingElement ( )
inherited
const TiXmlElement * RTT::marsh::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.

Definition at line 602 of file tinyxml.cpp.

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

TiXmlElement * RTT::marsh::TiXmlNode::NextSiblingElement ( const char *  _value)
inherited
bool RTT::marsh::TiXmlNode::NoChildren ( ) const
inlineinherited

Returns true if this node has no children.

Definition at line 673 of file tinyxml.h.

void RTT::marsh::TiXmlDocument::operator= ( const TiXmlDocument copy)

Definition at line 1013 of file tinyxml.cpp.

References RTT::marsh::TiXmlNode::Clear().

TiXmlNode* RTT::marsh::TiXmlNode::Parent ( )
inlineinherited

One step up the DOM.

Definition at line 522 of file tinyxml.h.

const TiXmlNode* RTT::marsh::TiXmlNode::Parent ( ) const
inlineinherited

Definition at line 523 of file tinyxml.h.

const char * RTT::marsh::TiXmlDocument::Parse ( const char *  p,
TiXmlParsingData data = 0,
TiXmlEncoding  encoding = TIXML_DEFAULT_ENCODING 
)
virtual
const TiXmlNode* RTT::marsh::TiXmlNode::PreviousSibling ( ) const
inlineinherited

Navigate to a sibling node.

Definition at line 606 of file tinyxml.h.

TiXmlNode* RTT::marsh::TiXmlNode::PreviousSibling ( )
inlineinherited

Definition at line 607 of file tinyxml.h.

const TiXmlNode * RTT::marsh::TiXmlNode::PreviousSibling ( const char *  _value) const
inherited

Navigate to a sibling node.

Definition at line 485 of file tinyxml.cpp.

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

TiXmlNode * RTT::marsh::TiXmlNode::PreviousSibling ( const char *  _value)
inherited

Definition at line 496 of file tinyxml.cpp.

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

void RTT::marsh::TiXmlDocument::Print ( ) const
inline

Dump the document to standard out.

Definition at line 1387 of file tinyxml.h.

References Print().

Referenced by Print(), and SaveFile().

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

Print this Document to a FILE stream.

Implements RTT::marsh::TiXmlBase.

Definition at line 1242 of file tinyxml.cpp.

References RTT::marsh::TiXmlNode::FirstChild(), RTT::marsh::TiXmlNode::NextSibling(), and RTT::marsh::TiXmlBase::Print().

void RTT::marsh::TiXmlBase::PutString ( const TIXML_STRING str,
TIXML_OSTREAM out 
)
staticprotectedinherited
void RTT::marsh::TiXmlBase::PutString ( const TIXML_STRING str,
TIXML_STRING out 
)
staticprotectedinherited

Definition at line 82 of file tinyxml.cpp.

const char * RTT::marsh::TiXmlBase::ReadName ( const char *  p,
TIXML_STRING name,
TiXmlEncoding  encoding 
)
staticprotectedinherited
const char * RTT::marsh::TiXmlBase::ReadText ( const char *  in,
TIXML_STRING text,
bool  ignoreWhiteSpace,
const char *  endTag,
bool  ignoreCase,
TiXmlEncoding  encoding 
)
staticprotectedinherited
bool RTT::marsh::TiXmlNode::RemoveChild ( TiXmlNode removeThis)
inherited
TiXmlNode * RTT::marsh::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.

Definition at line 315 of file tinyxml.cpp.

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

const TiXmlElement* RTT::marsh::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.

Definition at line 1320 of file tinyxml.h.

TiXmlElement* RTT::marsh::TiXmlDocument::RootElement ( )
inline

Definition at line 1321 of file tinyxml.h.

int RTT::marsh::TiXmlBase::Row ( ) const
inlineinherited

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()

Definition at line 235 of file tinyxml.h.

Referenced by RTT::marsh::Tiny2CPFHandler::populateBag().

bool RTT::marsh::TiXmlDocument::SaveFile ( ) const

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

Definition at line 1032 of file tinyxml.cpp.

References RTT::marsh::TiXmlBase::StringToBuffer::buffer, and RTT::marsh::TiXmlNode::value.

Referenced by SaveFile().

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

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

Definition at line 1185 of file tinyxml.cpp.

References SaveFile().

bool RTT::marsh::TiXmlDocument::SaveFile ( FILE *  fp) const
static void RTT::marsh::TiXmlBase::SetCondenseWhiteSpace ( bool  condense)
inlinestaticinherited

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 values is not thread safe.

Definition at line 212 of file tinyxml.h.

void RTT::marsh::TiXmlDocument::SetError ( int  err,
const char *  errorLocation,
TiXmlParsingData prevData,
TiXmlEncoding  encoding 
)
void RTT::marsh::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

Definition at line 1372 of file tinyxml.h.

void RTT::marsh::TiXmlBase::SetUserData ( void *  user)
inlineinherited

Definition at line 238 of file tinyxml.h.

void RTT::marsh::TiXmlNode::SetValue ( const char *  _value)
inlineinherited

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 511 of file tinyxml.h.

References RTT::marsh::TiXmlCursor::Clear().

Referenced by RTT::marsh::TiXmlNode::CopyTo(), RTT::marsh::TiXmlAttribute::SetDoubleValue(), and RTT::marsh::TiXmlAttribute::SetIntValue().

const char * RTT::marsh::TiXmlBase::SkipWhiteSpace ( const char *  p,
TiXmlEncoding  encoding 
)
staticprotectedinherited
void RTT::marsh::TiXmlDocument::StreamOut ( TIXML_OSTREAM out) const
protectedvirtual
bool RTT::marsh::TiXmlBase::StringEqual ( const char *  p,
const char *  endTag,
bool  ignoreCase,
TiXmlEncoding  encoding 
)
staticprotectedinherited
int RTT::marsh::TiXmlDocument::TabSize ( ) const
inline

Definition at line 1374 of file tinyxml.h.

virtual const TiXmlComment* RTT::marsh::TiXmlNode::ToComment ( ) const
inlinevirtualinherited

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

Reimplemented in RTT::marsh::TiXmlComment.

Definition at line 677 of file tinyxml.h.

virtual TiXmlComment* RTT::marsh::TiXmlNode::ToComment ( )
inlinevirtualinherited

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

Reimplemented in RTT::marsh::TiXmlComment.

Definition at line 684 of file tinyxml.h.

virtual const TiXmlDeclaration* RTT::marsh::TiXmlNode::ToDeclaration ( ) const
inlinevirtualinherited

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

Reimplemented in RTT::marsh::TiXmlDeclaration.

Definition at line 680 of file tinyxml.h.

Referenced by Parse().

virtual TiXmlDeclaration* RTT::marsh::TiXmlNode::ToDeclaration ( )
inlinevirtualinherited

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

Reimplemented in RTT::marsh::TiXmlDeclaration.

Definition at line 687 of file tinyxml.h.

References TIXML_STRING.

virtual const TiXmlDocument* RTT::marsh::TiXmlDocument::ToDocument ( ) const
inlinevirtual

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

Reimplemented from RTT::marsh::TiXmlNode.

Definition at line 1394 of file tinyxml.h.

virtual TiXmlDocument* RTT::marsh::TiXmlDocument::ToDocument ( )
inlinevirtual

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

Reimplemented from RTT::marsh::TiXmlNode.

Definition at line 1395 of file tinyxml.h.

References TIXML_OSTREAM, and TIXML_STRING.

virtual const TiXmlElement* RTT::marsh::TiXmlNode::ToElement ( ) const
inlinevirtualinherited

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

Reimplemented in RTT::marsh::TiXmlElement.

Definition at line 676 of file tinyxml.h.

Referenced by RTT::marsh::TiXmlNode::FirstChildElement(), RTT::marsh::TiXmlNode::NextSiblingElement(), RTT::marsh::Tiny2CPFHandler::populateBag(), RTT::marsh::TiXmlBase::ReadText(), and StreamOut().

virtual TiXmlElement* RTT::marsh::TiXmlNode::ToElement ( )
inlinevirtualinherited

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

Reimplemented in RTT::marsh::TiXmlElement.

Definition at line 683 of file tinyxml.h.

static int RTT::marsh::TiXmlBase::ToLower ( int  v,
TiXmlEncoding  encoding 
)
inlinestaticprotectedinherited

Definition at line 384 of file tinyxml.h.

References RTT::marsh::TIXML_ENCODING_UTF8.

Referenced by RTT::marsh::TiXmlBase::StringEqual().

virtual const TiXmlText* RTT::marsh::TiXmlNode::ToText ( ) const
inlinevirtualinherited

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

Reimplemented in RTT::marsh::TiXmlText.

Definition at line 679 of file tinyxml.h.

Referenced by RTT::marsh::TiXmlElement::GetText(), RTT::marsh::Tiny2CPFHandler::populateBag(), and RTT::marsh::TiXmlElement::Print().

virtual TiXmlText* RTT::marsh::TiXmlNode::ToText ( )
inlinevirtualinherited

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

Reimplemented in RTT::marsh::TiXmlText.

Definition at line 686 of file tinyxml.h.

virtual const TiXmlUnknown* RTT::marsh::TiXmlNode::ToUnknown ( ) const
inlinevirtualinherited

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

Reimplemented in RTT::marsh::TiXmlUnknown.

Definition at line 678 of file tinyxml.h.

virtual TiXmlUnknown* RTT::marsh::TiXmlNode::ToUnknown ( )
inlinevirtualinherited

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

Reimplemented in RTT::marsh::TiXmlUnknown.

Definition at line 685 of file tinyxml.h.

int RTT::marsh::TiXmlNode::Type ( ) const
inlineinherited

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 664 of file tinyxml.h.

Referenced by RTT::marsh::Tiny2CPFHandler::populateBag().

const char* RTT::marsh::TiXmlNode::Value ( ) const
inlineinherited

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 492 of file tinyxml.h.

Referenced by RTT::marsh::TiXmlElement::Clone(), RTT::marsh::TiXmlNode::FirstChild(), RTT::marsh::TiXmlElement::GetText(), RTT::marsh::TiXmlNode::LastChild(), RTT::marsh::TiXmlNode::NextSibling(), RTT::marsh::Tiny2CPFHandler::populateBag(), and RTT::marsh::TiXmlNode::PreviousSibling().

Member Data Documentation

const char * RTT::marsh::TiXmlBase::errorString
staticprotectedinherited
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.",
}

Definition at line 373 of file tinyxml.h.

Referenced by SetError().

TiXmlNode* RTT::marsh::TiXmlNode::firstChild
protectedinherited
TiXmlNode* RTT::marsh::TiXmlNode::lastChild
protectedinherited
TiXmlCursor RTT::marsh::TiXmlBase::location
protectedinherited
TiXmlNode* RTT::marsh::TiXmlNode::next
protectedinherited
TiXmlNode* RTT::marsh::TiXmlNode::parent
protectedinherited
TiXmlNode* RTT::marsh::TiXmlNode::prev
protectedinherited
NodeType RTT::marsh::TiXmlNode::type
protectedinherited

Definition at line 710 of file tinyxml.h.

Referenced by RTT::marsh::TiXmlNode::TiXmlNode().

void* RTT::marsh::TiXmlBase::userData
protectedinherited

Field containing a generic user pointer.

Definition at line 378 of file tinyxml.h.

Referenced by RTT::marsh::TiXmlNode::CopyTo().

const int RTT::marsh::TiXmlBase::utf8ByteTable
staticinherited
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
}

Definition at line 243 of file tinyxml.h.

TIXML_STRING RTT::marsh::TiXmlNode::value
protectedinherited

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