Breathe v2.0.0 documentation

TinyXML Test Suite

«  Doxygen Test Suite   ::   Contents   ::   Specific Examples Test Suite  »

TinyXML Test Suite

struct TiXmlBase::Entity
Public Members
const char * str
unsigned int strLength
char chr
class TiXmlAttribute
#include <tinyxml.h>

An attribute is a name-value pair.

Elements have an arbitrary number of attributes, each with a unique name.

Note
The attributes are not TiXmlNodes, since they are not part of the tinyXML document object model. There are other suggested ways to look at this problem.

Public Functions
TiXmlAttribute()

Construct an empty attribute.

TiXmlAttribute(const std::string & _name, const std::string & _value)

std::string constructor.

TiXmlAttribute(const char * _name, const char * _value)

Construct an attribute with a name and value.

const char * Name()

Return the name of this attribute.

const char * Value()

Return the value of this attribute.

const std::string & ValueStr()

Return the value of this attribute.

int IntValue()

Return the value of this attribute, converted to an integer.

double DoubleValue()

Return the value of this attribute, converted to a double.

const TIXML_STRING & NameTStr()
int QueryIntValue(int * _value)

QueryIntValue examines the value string.

It is an alternative to the IntValue() method with richer error checking. If the value is an integer, it is stored in ‘value’ and the call returns TIXML_SUCCESS. If it is not an integer, it returns TIXML_WRONG_TYPE.

A specialized but useful call. Note that for success it returns 0, which is the opposite of almost all other TinyXml calls.

int QueryDoubleValue(double * _value)

QueryDoubleValue examines the value string. See QueryIntValue().

void SetName(const char * _name)

Set the name of this attribute.

void SetValue(const char * _value)

Set the value.

void SetIntValue(int _value)

Set the value from an integer.

void SetDoubleValue(double _value)

Set the value from a double.

void SetName(const std::string & _name)

STL std::string form.

void SetValue(const std::string & _value)

STL std::string form.

const TiXmlAttribute * Next()

Get the next sibling attribute in the DOM. Returns null at end.

TiXmlAttribute * Next()
const TiXmlAttribute * Previous()

Get the previous sibling attribute in the DOM. Returns null at beginning.

TiXmlAttribute * Previous()
bool operator==(const TiXmlAttribute & rhs)
bool operator<(const TiXmlAttribute & rhs)
bool operator>(const TiXmlAttribute & rhs)
const char * Parse(const char * p, TiXmlParsingData * data, TiXmlEncoding encoding)
void Print(FILE * cfile, int depth)

All TinyXml classes can print themselves to a file stream or the string class (TiXmlString in non-STL mode, std::string in STL mode.) Either or both cfile and str can be null.

This is a formatted print, and will insert tabs and newlines.

(For an unformatted stream, use the << operator.)

void Print(FILE * cfile, int depth, TIXML_STRING * str)
void SetDocument(TiXmlDocument * doc)
Private Functions
TiXmlAttribute(const TiXmlAttribute &)
void operator=(const TiXmlAttribute & base)
Private Members
TiXmlDocument * document
TIXML_STRING name
TIXML_STRING value
TiXmlAttribute * prev
TiXmlAttribute * next
Friends
friend class TiXmlAttributeSet
class TiXmlAttributeSet
Public Functions
TiXmlAttributeSet()
~TiXmlAttributeSet()
void Add(TiXmlAttribute * attribute)
void Remove(TiXmlAttribute * attribute)
const TiXmlAttribute * First()
TiXmlAttribute * First()
const TiXmlAttribute * Last()
TiXmlAttribute * Last()
const TiXmlAttribute * Find(const char * _name)
TiXmlAttribute * Find(const char * _name)
const TiXmlAttribute * Find(const std::string & _name)
TiXmlAttribute * Find(const std::string & _name)
Private Functions
TiXmlAttributeSet(const TiXmlAttributeSet &)
void operator=(const TiXmlAttributeSet &)
Private Members
TiXmlAttribute sentinel
class TiXmlBase
#include <tinyxml.h>

TiXmlBase is a base class for every class in TinyXml.

It does little except to establish that TinyXml classes can be printed and provide some utility functions.

In XML, the document and elements can contain other elements and other types of nodes.

A Document can contain: Element (container or leaf)
                        Comment (leaf)
                        Unknown (leaf)
                        Declaration( leaf )

An Element can contain: Element (container or leaf)
                        Text    (leaf)
                        Attributes (not on tree)
                        Comment (leaf)
                        Unknown (leaf)

A Decleration contains: Attributes (not on tree)

Public Type
Anonymous enum

Values:

  • 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 Functions
TiXmlBase()
~TiXmlBase()
void Print(FILE * cfile, int depth)

All TinyXml classes can print themselves to a file stream or the string class (TiXmlString in non-STL mode, std::string in STL mode.) Either or both cfile and str can be null.

This is a formatted print, and will insert tabs and newlines.

(For an unformatted stream, use the << operator.)

int Row()

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
TiXmlDocument::SetTabSize()

int Column()

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

Get a pointer to arbitrary user data.

const char * Parse(const char * p, TiXmlParsingData * data, TiXmlEncoding encoding)
Public Static Functions
void SetCondenseWhiteSpace(bool condense)

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.

bool IsWhiteSpaceCondensed()

Return the current white space setting.

Public Static Attributes
const int utf8ByteTable[256]
Protected Attributes
TiXmlCursor location
void * userData

Field containing a generic user pointer.

Protected Static Functions
const char * SkipWhiteSpace(const char *, TiXmlEncoding encoding)
bool IsWhiteSpace(char c)
bool IsWhiteSpace(int c)
bool StreamWhiteSpace(std::istream * in, TIXML_STRING * tag)
bool StreamTo(std::istream * in, int character, TIXML_STRING * tag)
const char * ReadName(const char * p, TIXML_STRING * name, TiXmlEncoding encoding)
const char * ReadText(const char * in, TIXML_STRING * text, bool ignoreWhiteSpace, const char * endTag, bool ignoreCase, TiXmlEncoding encoding)
const char * GetEntity(const char * in, char * value, int * length, TiXmlEncoding encoding)
const char * GetChar(const char * p, char * _value, int * length, TiXmlEncoding encoding)
void PutString(const TIXML_STRING & str, TIXML_STRING * out)
bool StringEqual(const char * p, const char * endTag, bool ignoreCase, TiXmlEncoding encoding)
int IsAlpha(unsigned char anyByte, TiXmlEncoding encoding)
int IsAlphaNum(unsigned char anyByte, TiXmlEncoding encoding)
int ToLower(int v, TiXmlEncoding encoding)
void ConvertUTF32ToUTF8(unsigned long input, char * output, int * length)
Protected Static Attributes
const char * errorString[TIXML_ERROR_STRING_COUNT]
Private Types
Anonymous enum

Values:

  • NUM_ENTITY = = 5 -
  • MAX_ENTITY_LENGTH = = 6 -
Private Functions
TiXmlBase(const TiXmlBase &)
void operator=(const TiXmlBase & base)
Private Static Attributes
Entity entity[NUM_ENTITY]
bool condenseWhiteSpace
Friends
friend class TiXmlNode
friend class TiXmlElement
friend class TiXmlDocument
class TiXmlComment
#include <tinyxml.h>

An XML comment.

Public Functions
TiXmlComment()

Constructs an empty comment.

TiXmlComment(const char * _value)

Construct a comment from text.

TiXmlComment(const TiXmlComment &)
void operator=(const TiXmlComment & base)
~TiXmlComment()
TiXmlNode * Clone()

Returns a copy of this Comment.

void Print(FILE * cfile, int depth)

All TinyXml classes can print themselves to a file stream or the string class (TiXmlString in non-STL mode, std::string in STL mode.) Either or both cfile and str can be null.

This is a formatted print, and will insert tabs and newlines.

(For an unformatted stream, use the << operator.)

const char * Parse(const char * p, TiXmlParsingData * data, TiXmlEncoding encoding)
const TiXmlComment * ToComment()

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

TiXmlComment * ToComment()

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

bool Accept(TiXmlVisitor * visitor)

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

Protected Functions
void CopyTo(TiXmlComment * target)
void StreamIn(std::istream * in, TIXML_STRING * tag)
struct TiXmlCursor
Public Functions
TiXmlCursor()
void Clear()
Public Members
int row
int col
class TiXmlDeclaration
#include <tinyxml.h>

In correct XML the declaration is the first entry in the file. 

    <?xml version="1.0" standalone="yes"?>

TinyXml will happily read or write files without a declaration, however. There are 3 possible attributes to the declaration: version, encoding, and standalone.

Note: In this version of the code, the attributes are handled as special cases, not generic attributes, simply because there can only be at most 3 and they are always the same.

Public Functions
TiXmlDeclaration()

Construct an empty declaration.

TiXmlDeclaration(const std::string & _version, const std::string & _encoding, const std::string & _standalone)

Constructor.

TiXmlDeclaration(const char * _version, const char * _encoding, const char * _standalone)

Construct.

TiXmlDeclaration(const TiXmlDeclaration & copy)
void operator=(const TiXmlDeclaration & copy)
~TiXmlDeclaration()
const char * Version()

Version. Will return an empty string if none was found.

const char * Encoding()

Encoding. Will return an empty string if none was found.

const char * Standalone()

Is this a standalone document?

TiXmlNode * Clone()

Creates a copy of this Declaration and returns it.

void Print(FILE * cfile, int depth, TIXML_STRING * str)
void Print(FILE * cfile, int depth)

All TinyXml classes can print themselves to a file stream or the string class (TiXmlString in non-STL mode, std::string in STL mode.) Either or both cfile and str can be null.

This is a formatted print, and will insert tabs and newlines.

(For an unformatted stream, use the << operator.)

const char * Parse(const char * p, TiXmlParsingData * data, TiXmlEncoding encoding)
const TiXmlDeclaration * ToDeclaration()

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

TiXmlDeclaration * ToDeclaration()

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

bool Accept(TiXmlVisitor * visitor)

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

Protected Functions
void CopyTo(TiXmlDeclaration * target)
void StreamIn(std::istream * in, TIXML_STRING * tag)
Private Members
TIXML_STRING version
TIXML_STRING encoding
TIXML_STRING standalone
class TiXmlDocument
#include <tinyxml.h>

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.

Public 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 std::string & documentName)

Constructor.

TiXmlDocument(const TiXmlDocument & copy)
void operator=(const TiXmlDocument & copy)
~TiXmlDocument()
bool 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.

bool SaveFile()

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)

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

bool LoadFile(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.

bool SaveFile(FILE *)

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

bool LoadFile(const std::string & filename, TiXmlEncoding encoding = TIXML_DEFAULT_ENCODING)

Parameters
  • encoding -

    STL std::string version.

bool SaveFile(const std::string & filename)

< STL std::string version.

const char * Parse(const char * p, TiXmlParsingData * data = 0, TiXmlEncoding encoding = TIXML_DEFAULT_ENCODING)

Parse the given null terminated block of xml data.

Passing in an encoding to this method (either TIXML_ENCODING_LEGACY or TIXML_ENCODING_UTF8 will force TinyXml to use that encoding, regardless of what TinyXml might otherwise try to detect.

const TiXmlElement * RootElement()

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.

TiXmlElement * RootElement()
bool Error()

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)

const char * ErrorDesc()

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

int ErrorId()

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

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

int ErrorRow()

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
SetTabSize, Row, Column

int ErrorCol()

The column where the error occurred. See ErrorRow()

void SetTabSize(int _tabsize)

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
Row, Column

int TabSize()
void ClearError()

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.

void Print()

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

void Print(FILE * cfile, int depth = 0)

Print this Document to a FILE stream.

void SetError(int err, const char * errorLocation, TiXmlParsingData * prevData, TiXmlEncoding encoding)
const TiXmlDocument * ToDocument()

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

TiXmlDocument * ToDocument()

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

bool Accept(TiXmlVisitor * content)

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

Protected Functions
TiXmlNode * Clone()

Create an exact duplicate of this node and return it.

The memory must be deleted by the caller.

void StreamIn(std::istream * in, TIXML_STRING * tag)
Private Functions
void CopyTo(TiXmlDocument * target)
Private Members
bool error
int errorId
TIXML_STRING errorDesc
int tabsize
TiXmlCursor errorLocation
bool useMicrosoftBOM
class TiXmlElement
#include <tinyxml.h>

The element is a container class.

It has a value, the element name, and can contain other elements, text, comments, and unknowns. Elements also contain an arbitrary number of attributes.

Public Functions
TiXmlElement(const char * in_value)

Construct an element.

TiXmlElement(const std::string & _value)

std::string constructor.

TiXmlElement(const TiXmlElement &)
void operator=(const TiXmlElement & base)
~TiXmlElement()
const char * Attribute(const char * name)

Given an attribute name, Attribute() returns the value for the attribute of that name, or null if none exists.

const char * Attribute(const char * name, int * i)

Given an attribute name, Attribute() returns the value for the attribute of that name, or null if none exists.

If the attribute exists and can be converted to an integer, the integer value will be put in the return ‘i’, if ‘i’ is non-null.

const char * Attribute(const char * name, double * d)

Given an attribute name, Attribute() returns the value for the attribute of that name, or null if none exists.

If the attribute exists and can be converted to an double, the double value will be put in the return ‘d’, if ‘d’ is non-null.

int QueryIntAttribute(const char * name, int * _value)

QueryIntAttribute examines the attribute - it is an alternative to the Attribute() method with richer error checking.

If the attribute is an integer, it is stored in ‘value’ and the call returns TIXML_SUCCESS. If it is not an integer, it returns TIXML_WRONG_TYPE. If the attribute does not exist, then TIXML_NO_ATTRIBUTE is returned.

int QueryDoubleAttribute(const char * name, double * _value)

QueryDoubleAttribute examines the attribute - see QueryIntAttribute().

int QueryFloatAttribute(const char * name, float * _value)

QueryFloatAttribute examines the attribute - see QueryIntAttribute().

template <typename T>
int QueryValueAttribute(const std::string & name, T * outValue)

Template form of the attribute query which will try to read the attribute into the specified type.

Very easy, very powerful, but be careful to make sure to call this with the correct type.

Return
TIXML_SUCCESS, TIXML_WRONG_TYPE, or TIXML_NO_ATTRIBUTE

void SetAttribute(const char * name, const char * _value)

Sets an attribute of name to a given value.

The attribute will be created if it does not exist, or changed if it does.

const std::string * Attribute(const std::string & name)
const std::string * Attribute(const std::string & name, int * i)
const std::string * Attribute(const std::string & name, double * d)
int QueryIntAttribute(const std::string & name, int * _value)
int QueryDoubleAttribute(const std::string & name, double * _value)
void SetAttribute(const std::string & name, const std::string & _value)

STL std::string form.

STL std::string form.

void SetAttribute(const std::string & name, int _value)
void SetAttribute(const char * name, int value)

Sets an attribute of name to a given value.

The attribute will be created if it does not exist, or changed if it does.

void SetDoubleAttribute(const char * name, double value)

Sets an attribute of name to a given value.

The attribute will be created if it does not exist, or changed if it does.

void RemoveAttribute(const char * name)

Deletes an attribute with the given name.

void RemoveAttribute(const std::string & name)

STL std::string form.

const TiXmlAttribute * FirstAttribute()

Access the first attribute in this element.

TiXmlAttribute * FirstAttribute()
const TiXmlAttribute * LastAttribute()

Access the last attribute in this element.

TiXmlAttribute * LastAttribute()
const char * GetText()

Convenience function for easy access to the text inside an element.

Although easy and concise, GetText() is limited compared to getting the TiXmlText child and accessing it directly.

If the first child of ‘this’ is a TiXmlText, the GetText() returns the character string of the Text node, else null is returned.

This is a convenient method for getting the text of simple contained text: 

<foo>This is text</foo>
const char* str = fooElement->GetText();

‘str’ will be a pointer to “This is text”.

Note that this function can be misleading. If the element foo was created from this XML: 

<foo><b>This is text</b></foo>

then the value of str would be null. The first child node isn’t a text node, it is another element. From this XML: 

<foo>This is <b>text</b></foo>
GetText() will return “This is ”.

WARNING: GetText() accesses a child node - don’t become confused with the similarly named TiXmlHandle::Text() and TiXmlNode::ToText() which are safe type casts on the referenced node.

TiXmlNode * Clone()

Creates a new Element and returns it - the returned element is a copy.

void Print(FILE * cfile, int depth)

All TinyXml classes can print themselves to a file stream or the string class (TiXmlString in non-STL mode, std::string in STL mode.) Either or both cfile and str can be null.

This is a formatted print, and will insert tabs and newlines.

(For an unformatted stream, use the << operator.)

const char * Parse(const char * p, TiXmlParsingData * data, TiXmlEncoding encoding)
const TiXmlElement * ToElement()

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

TiXmlElement * ToElement()

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

bool Accept(TiXmlVisitor * visitor)

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

Protected Functions
void CopyTo(TiXmlElement * target)
void ClearThis()
void StreamIn(std::istream * in, TIXML_STRING * tag)
const char * ReadValue(const char * in, TiXmlParsingData * prevData, TiXmlEncoding encoding)
Private Members
TiXmlAttributeSet attributeSet
class TiXmlHandle
#include <tinyxml.h>

A TiXmlHandle is a class that wraps a node pointer with null checks; this is an incredibly useful thing.

Note that TiXmlHandle is not part of the TinyXml DOM structure. It is a separate utility class.

Take an example: 

<Document>
    <Element attributeA = "valueA">
        <Child attributeB = "value1" />
        <Child attributeB = "value2" />
    </Element>
<Document>

Assuming you want the value of “attributeB” in the second “Child” element, it’s very easy to write a lot of code that looks like:

TiXmlElement* root = document.FirstChildElement( "Document" );
if ( root )
{
    TiXmlElement* element = root->FirstChildElement( "Element" );
    if ( element )
    {
        TiXmlElement* child = element->FirstChildElement( "Child" );
        if ( child )
        {
            TiXmlElement* child2 = child->NextSiblingElement( "Child" );
            if ( child2 )
            {
                // Finally do something useful.

And that doesn’t even cover “else” cases. TiXmlHandle addresses the verbosity of such code. A TiXmlHandle checks for null pointers so it is perfectly safe and correct to use:

TiXmlHandle docHandle( &document );
TiXmlElement* child2 = docHandle.FirstChild( "Document" ).FirstChild( "Element" ).Child( "Child", 1 ).ToElement();
if ( child2 )
{
    // do something useful

Which is MUCH more concise and useful.

It is also safe to copy handles - internally they are nothing more than node pointers. 

TiXmlHandle handleCopy = handle;

What they should not be used for is iteration:

int i=0; 
while ( true )
{
    TiXmlElement* child = docHandle.FirstChild( "Document" ).FirstChild( "Element" ).Child( "Child", i ).ToElement();
    if ( !child )
        break;
    // do something
    ++i;
}

It seems reasonable, but it is in fact two embedded while loops. The Child method is a linear walk to find the element, so this code would iterate much more than it needs to. Instead, prefer:

TiXmlElement* child = docHandle.FirstChild( "Document" ).FirstChild( "Element" ).FirstChild( "Child" ).ToElement();

for( child; child; child=child->NextSiblingElement() )
{
    // do something
}

Public Functions
TiXmlHandle(TiXmlNode * _node)

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

TiXmlHandle(const TiXmlHandle & ref)

Copy constructor.

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

Return a handle to the first child node.

TiXmlHandle FirstChild(const char * value)

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

TiXmlHandle FirstChildElement()

Return a handle to the first child element.

TiXmlHandle FirstChildElement(const char * value)

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

TiXmlHandle Child(const char * value, int index)

Return a handle to the “index” child with the given name.

The first child is 0, the second 1, etc.

TiXmlHandle Child(int index)

Return a handle to the “index” child.

The first child is 0, the second 1, etc.

TiXmlHandle ChildElement(const char * value, int index)

Return a handle to the “index” child element with the given name.

The first child element is 0, the second 1, etc. Note that only TiXmlElements are indexed: other types are not counted.

TiXmlHandle ChildElement(int index)

Return a handle to the “index” child element.

The first child element is 0, the second 1, etc. Note that only TiXmlElements are indexed: other types are not counted.

TiXmlHandle FirstChild(const std::string & _value)
TiXmlHandle FirstChildElement(const std::string & _value)
TiXmlHandle Child(const std::string & _value, int index)
TiXmlHandle ChildElement(const std::string & _value, int index)
TiXmlNode * ToNode()

Return the handle as a TiXmlNode.

This may return null.

TiXmlElement * ToElement()

Return the handle as a TiXmlElement.

This may return null.

TiXmlText * ToText()

Return the handle as a TiXmlText.

This may return null.

TiXmlUnknown * ToUnknown()

Return the handle as a TiXmlUnknown.

This may return null.

TiXmlNode * Node()

TiXmlElement * Element()

TiXmlText * Text()

TiXmlUnknown * Unknown()

Private Members
TiXmlNode * node
class TiXmlNode
#include <tinyxml.h>

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.

Public Type
NodeType enum

The types of XML nodes supported by TinyXml.

(All the unsupported types are picked up by UNKNOWN.)

Values:

  • DOCUMENT -
  • ELEMENT -
  • COMMENT -
  • UNKNOWN -
  • TEXT -
  • DECLARATION -
  • TYPECOUNT -
Public Functions
~TiXmlNode()
const char * Value()

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.

const std::string & ValueStr()

Return Value() as a std::string.

If you only use STL, this is more efficient than calling Value(). Only available in STL mode.

void SetValue(const char * _value)

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

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 TiXmlNode * FirstChild()

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

TiXmlNode * FirstChild()
const TiXmlNode * FirstChild(const char * value)

The first child of this node with the matching ‘value’.

Will be null if none found.

TiXmlNode * FirstChild(const char * _value)

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

const TiXmlNode * LastChild()
TiXmlNode * LastChild()

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

const TiXmlNode * LastChild(const char * value)
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)

STL std::string form.

TiXmlNode * FirstChild(const std::string & _value)

STL std::string form.

const TiXmlNode * LastChild(const std::string & _value)

STL std::string form.

TiXmlNode * LastChild(const std::string & _value)

STL std::string form.

const TiXmlNode * IterateChildren(const TiXmlNode * previous)

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.

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

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)

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.

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

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
InsertEndChild

TiXmlNode * InsertBeforeChild(TiXmlNode * beforeThis, const TiXmlNode & addThis)

Add a new node related to this.

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

TiXmlNode * InsertAfterChild(TiXmlNode * afterThis, const TiXmlNode & addThis)

Add a new node related to this.

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

TiXmlNode * ReplaceChild(TiXmlNode * replaceThis, const TiXmlNode & withThis)

Replace a child of this node.

Returns a pointer to the new object or NULL if an error occurred.

bool RemoveChild(TiXmlNode * removeThis)

Delete a child of this node.

const TiXmlNode * PreviousSibling()

Navigate to a sibling node.

TiXmlNode * PreviousSibling()
const TiXmlNode * PreviousSibling(const char *)

Navigate to a sibling node.

TiXmlNode * PreviousSibling(const char * _prev)
const TiXmlNode * PreviousSibling(const std::string & _value)

STL std::string form.

TiXmlNode * PreviousSibling(const std::string & _value)

STL std::string form.

const TiXmlNode * NextSibling(const std::string & _value)

STL std::string form.

TiXmlNode * NextSibling(const std::string & _value)

STL std::string form.

const TiXmlNode * NextSibling()

Navigate to a sibling node.

TiXmlNode * NextSibling()
const TiXmlNode * NextSibling(const char *)

Navigate to a sibling node with the given ‘value’.

TiXmlNode * NextSibling(const char * _next)
const TiXmlElement * NextSiblingElement()

Convenience function to get through elements.

Calls NextSibling and ToElement. Will skip all non-Element nodes. Returns 0 if there is not another element.

TiXmlElement * NextSiblingElement()
const TiXmlElement * NextSiblingElement(const char *)

Convenience function to get through elements.

Calls NextSibling and ToElement. Will skip all non-Element nodes. Returns 0 if there is not another element.

TiXmlElement * NextSiblingElement(const char * _next)
const TiXmlElement * NextSiblingElement(const std::string & _value)

STL std::string form.

TiXmlElement * NextSiblingElement(const std::string & _value)

STL std::string form.

const TiXmlElement * FirstChildElement()

Convenience function to get through elements.

TiXmlElement * FirstChildElement()
const TiXmlElement * FirstChildElement(const char * _value)

Convenience function to get through elements.

TiXmlElement * FirstChildElement(const char * _value)
const TiXmlElement * FirstChildElement(const std::string & _value)

STL std::string form.

TiXmlElement * FirstChildElement(const std::string & _value)

STL std::string form.

int Type()

Query the type (as an enumerated value, above) of this node.

The possible types are: DOCUMENT, ELEMENT, COMMENT, UNKNOWN, TEXT, and DECLARATION.

const TiXmlDocument * GetDocument()

Return a pointer to the Document this node lives in.

Returns null if not in a document.

TiXmlDocument * GetDocument()
bool NoChildren()

Returns true if this node has no children.

const TiXmlDocument * ToDocument()

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

const TiXmlElement * ToElement()

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

const TiXmlComment * ToComment()

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

const TiXmlUnknown * ToUnknown()

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

const TiXmlText * ToText()

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

const TiXmlDeclaration * ToDeclaration()

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

TiXmlDocument * ToDocument()

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

TiXmlElement * ToElement()

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

TiXmlComment * ToComment()

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

TiXmlUnknown * ToUnknown()

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

TiXmlText * ToText()

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

TiXmlDeclaration * ToDeclaration()

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

TiXmlNode * Clone()

Create an exact duplicate of this node and return it.

The memory must be deleted by the caller.

bool Accept(TiXmlVisitor * visitor)

Accept a hierarchical 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();

Protected Functions
TiXmlNode(NodeType _type)
void CopyTo(TiXmlNode * target)
void StreamIn(std::istream * in, TIXML_STRING * tag)
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 Functions
TiXmlNode(const TiXmlNode &)
void operator=(const TiXmlNode & base)
Friends
friend class TiXmlDocument
friend class TiXmlElement
friend std::istream & operator>>

An input stream operator, for every class.

Tolerant of newlines and formatting, but doesn’t expect them.

friend std::ostream & operator<<

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.

friend std::string & operator<<

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

class TiXmlPrinter
#include <tinyxml.h>

Print to memory functionality.

The TiXmlPrinter is useful when you need to:

  1. Print to memory (especially in non-STL mode)
  2. Control formatting (line endings, etc.)

When constructed, the TiXmlPrinter is in its default “pretty printing” mode. Before calling Accept() you can call methods to control the printing of the XML document. After TiXmlNode::Accept() is called, the printed document can be accessed via the CStr(), Str(), and Size() methods.

TiXmlPrinter uses the Visitor API. 

TiXmlPrinter printer;
printer.SetIndent( "\t" );

doc.Accept( &printer );
fprintf( stdout, "%s", printer.CStr() );

Public Functions
TiXmlPrinter()
bool VisitEnter(const TiXmlDocument &)

Visit a document.

bool VisitExit(const TiXmlDocument &)

Visit a document.

bool VisitEnter(const TiXmlElement &, const TiXmlAttribute *)

Visit an element.

bool VisitExit(const TiXmlElement &)

Visit an element.

bool Visit(const TiXmlDeclaration &)

Visit a declaration.

bool Visit(const TiXmlText &)

Visit a text node.

bool Visit(const TiXmlComment &)

Visit a comment node.

bool Visit(const TiXmlUnknown &)

Visit an unknown node.

void SetIndent(const char * _indent)

Set the indent characters for printing.

By default 4 spaces but tab () is also useful, or null/empty string for no indentation.

const char * Indent()

Query the indention string.

void SetLineBreak(const char * _lineBreak)

Set the line breaking string.

By default set to newline ( ). Some operating systems prefer other characters, or can be set to the null/empty string for no indentation.

const char * LineBreak()

Query the current line breaking string.

void SetStreamPrinting()

Switch over to “stream printing” which is the most dense formatting without line breaks.

Common when the XML is needed for network transmission.

const char * CStr()

Return the result.

size_t Size()

Return the length of the result string.

const std::string & Str()

Return the result.

Private Functions
void DoIndent()
void DoLineBreak()
Private Members
int depth
bool simpleTextPrint
TIXML_STRING buffer
TIXML_STRING indent
TIXML_STRING lineBreak
class TiXmlText
#include <tinyxml.h>

XML text.

A text node can have 2 ways to output the next. “normal” output and CDATA. It will default to the mode it was parsed from the XML file and you generally want to leave it alone, but you can change the output mode with SetCDATA() and query it with CDATA().

Public Functions
TiXmlText(const char * initValue)

Constructor for text element.

By default, it is treated as normal, encoded text. If you want it be output as a CDATA text element, set the parameter _cdata to ‘true’

~TiXmlText()
TiXmlText(const std::string & initValue)

Constructor.

TiXmlText(const TiXmlText & copy)
void operator=(const TiXmlText & base)
void Print(FILE * cfile, int depth)

All TinyXml classes can print themselves to a file stream or the string class (TiXmlString in non-STL mode, std::string in STL mode.) Either or both cfile and str can be null.

This is a formatted print, and will insert tabs and newlines.

(For an unformatted stream, use the << operator.)

bool CDATA()

Queries whether this represents text using a CDATA section.

void SetCDATA(bool _cdata)

Turns on or off a CDATA representation of text.

const char * Parse(const char * p, TiXmlParsingData * data, TiXmlEncoding encoding)
const TiXmlText * ToText()

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

TiXmlText * ToText()

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

bool Accept(TiXmlVisitor * content)

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

Protected Functions
TiXmlNode * Clone()

[internal use] Creates a new Element and returns it.

void CopyTo(TiXmlText * target)
bool Blank()
void StreamIn(std::istream * in, TIXML_STRING * tag)
Private Members
bool cdata
Friends
friend class TiXmlElement
class TiXmlUnknown
#include <tinyxml.h>

Any tag that tinyXml doesn’t recognize is saved as an unknown.

It is a tag of text, but should not be modified. It will be written back to the XML, unchanged, when the file is saved.

DTD tags get thrown into TiXmlUnknowns.

Public Functions
TiXmlUnknown()
~TiXmlUnknown()
TiXmlUnknown(const TiXmlUnknown & copy)
void operator=(const TiXmlUnknown & copy)
TiXmlNode * Clone()

Creates a copy of this Unknown and returns it.

void Print(FILE * cfile, int depth)

All TinyXml classes can print themselves to a file stream or the string class (TiXmlString in non-STL mode, std::string in STL mode.) Either or both cfile and str can be null.

This is a formatted print, and will insert tabs and newlines.

(For an unformatted stream, use the << operator.)

const char * Parse(const char * p, TiXmlParsingData * data, TiXmlEncoding encoding)
const TiXmlUnknown * ToUnknown()

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

TiXmlUnknown * ToUnknown()

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

bool Accept(TiXmlVisitor * content)

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

Protected Functions
void CopyTo(TiXmlUnknown * target)
void StreamIn(std::istream * in, TIXML_STRING * tag)
class TiXmlVisitor
#include <tinyxml.h>

If you call the Accept() method, it requires being passed a TiXmlVisitor class to handle callbacks.

For nodes that contain other nodes (Document, Element) you will get called with a VisitEnter/VisitExit pair. Nodes that are always leaves are simple called with Visit().

If you return ‘true’ from a Visit method, recursive parsing will continue. If you return false, no children of this node or its sibilings will be Visited.

All flavors of Visit methods have a default implementation that returns ‘true’ (continue visiting). You need to only override methods that are interesting to you.

Generally Accept() is called on the TiXmlDocument, although all nodes support Visiting.

You should never change the document from a callback.

See
TiXmlNode::Accept()

Public Functions
~TiXmlVisitor()
bool VisitEnter(const TiXmlDocument &)

Visit a document.

bool VisitExit(const TiXmlDocument &)

Visit a document.

bool VisitEnter(const TiXmlElement &, const TiXmlAttribute *)

Visit an element.

bool VisitExit(const TiXmlElement &)

Visit an element.

bool Visit(const TiXmlDeclaration &)

Visit a declaration.

bool Visit(const TiXmlText &)

Visit a text node.

bool Visit(const TiXmlComment &)

Visit a comment node.

bool Visit(const TiXmlUnknown &)

Visit an unknown node.

file tinyxml.h
#include <ctype.h>#include <stdio.h>#include <stdlib.h>#include <string.h>#include <assert.h>#include <string>#include <iostream>#include <sstream>
Defines
TIXML_USE_STL
TIXML_STRING
TIXML_SAFE
Enums
Anonymous enum

Values:

  • TIXML_SUCCESS -
  • TIXML_NO_ATTRIBUTE -
  • TIXML_WRONG_TYPE -
TiXmlEncoding enum

Values:

  • TIXML_ENCODING_UNKNOWN -
  • TIXML_ENCODING_UTF8 -
  • TIXML_ENCODING_LEGACY -
Variables
const int TIXML_MAJOR_VERSION
const int TIXML_MINOR_VERSION
const int TIXML_PATCH_VERSION
const TiXmlEncoding TIXML_DEFAULT_ENCODING
page deprecated

«  Doxygen Test Suite   ::   Contents   ::   Specific Examples Test Suite  »

© Copyright 2009-2014, Michael Jones. Created using Sphinx 1.2.2.