Twitch SDK (Internal)
Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | Private Attributes | Static Private Attributes | Friends | List of all members
ttv::xml::XMLDocument Class Reference

#include <tinyxml2.h>

Inheritance diagram for ttv::xml::XMLDocument:
ttv::xml::XMLNode

Public Member Functions

 XMLDocument (bool processEntities=true, Whitespace=PRESERVE_WHITESPACE)
 constructor More...
 
 ~XMLDocument ()
 
virtual XMLDocumentToDocument ()
 Safely cast to a Document, or null. More...
 
virtual const XMLDocumentToDocument () const
 
XMLError Parse (const char *xml, size_t nBytes=SIZE_MAX)
 
XMLError LoadFile (const char *filename)
 
XMLError LoadFile (FILE *)
 
XMLError SaveFile (const char *filename, bool compact=false)
 
XMLError SaveFile (FILE *fp, bool compact=false)
 
bool ProcessEntities () const
 
Whitespace WhitespaceMode () const
 
bool HasBOM () const
 
void SetBOM (bool useBOM)
 
XMLElementRootElement ()
 
const XMLElementRootElement () const
 
void Print (XMLPrinter *streamer=0) const
 
virtual bool Accept (XMLVisitor *visitor) const
 
XMLElementNewElement (const char *name)
 
XMLCommentNewComment (const char *comment)
 
XMLTextNewText (const char *text)
 
XMLDeclarationNewDeclaration (const char *text=0)
 
XMLUnknownNewUnknown (const char *text)
 
void DeleteNode (XMLNode *node)
 
void SetError (XMLError error, const char *str1, const char *str2)
 
bool Error () const
 Return true if there was an error parsing the document. More...
 
XMLError ErrorID () const
 Return the errorID. More...
 
const char * ErrorName () const
 
const char * GetErrorStr1 () const
 Return a possibly helpful diagnostic location or string. More...
 
const char * GetErrorStr2 () const
 Return a possibly helpful secondary diagnostic location or string. More...
 
void PrintError () const
 If there is an error, print it to stdout. More...
 
void Clear ()
 Clear the document, resetting it to the initial state. More...
 
char * Identify (char *p, XMLNode **node)
 
virtual XMLNodeShallowClone (XMLDocument *) const
 
virtual bool ShallowEqual (const XMLNode *) const
 
const XMLDocumentGetDocument () const
 Get the XMLDocument that owns this XMLNode. More...
 
XMLDocumentGetDocument ()
 Get the XMLDocument that owns this XMLNode. More...
 
virtual XMLElementToElement ()
 Safely cast to an Element, or null. More...
 
virtual const XMLElementToElement () const
 
virtual XMLTextToText ()
 Safely cast to Text, or null. More...
 
virtual const XMLTextToText () const
 
virtual XMLCommentToComment ()
 Safely cast to a Comment, or null. More...
 
virtual const XMLCommentToComment () const
 
virtual XMLDeclarationToDeclaration ()
 Safely cast to a Declaration, or null. More...
 
virtual const XMLDeclarationToDeclaration () const
 
virtual XMLUnknownToUnknown ()
 Safely cast to an Unknown, or null. More...
 
virtual const XMLUnknownToUnknown () const
 
const char * Value () const
 
void SetValue (const char *val, bool staticMem=false)
 
const XMLNodeParent () const
 Get the parent of this node on the DOM. More...
 
XMLNodeParent ()
 
bool NoChildren () const
 Returns true if this node has no children. More...
 
const XMLNodeFirstChild () const
 Get the first child node, or null if none exists. More...
 
XMLNodeFirstChild ()
 
const XMLElementFirstChildElement (const char *name=0) const
 
XMLElementFirstChildElement (const char *name=0)
 
const XMLNodeLastChild () const
 Get the last child node, or null if none exists. More...
 
XMLNodeLastChild ()
 
const XMLElementLastChildElement (const char *name=0) const
 
XMLElementLastChildElement (const char *name=0)
 
const XMLNodePreviousSibling () const
 Get the previous (left) sibling node of this node. More...
 
XMLNodePreviousSibling ()
 
const XMLElementPreviousSiblingElement (const char *name=0) const
 Get the previous (left) sibling element of this node, with an optionally supplied name. More...
 
XMLElementPreviousSiblingElement (const char *name=0)
 
const XMLNodeNextSibling () const
 Get the next (right) sibling node of this node. More...
 
XMLNodeNextSibling ()
 
const XMLElementNextSiblingElement (const char *name=0) const
 Get the next (right) sibling element of this node, with an optionally supplied name. More...
 
XMLElementNextSiblingElement (const char *name=0)
 
XMLNodeInsertEndChild (XMLNode *addThis)
 
XMLNodeLinkEndChild (XMLNode *addThis)
 
XMLNodeInsertFirstChild (XMLNode *addThis)
 
XMLNodeInsertAfterChild (XMLNode *afterThis, XMLNode *addThis)
 
void DeleteChildren ()
 
void DeleteChild (XMLNode *node)
 
void SetUserData (void *userData)
 
void * GetUserData () const
 

Protected Member Functions

virtual char * ParseDeep (char *, StrPair *)
 

Protected Attributes

XMLDocument_document
 
XMLNode_parent
 
StrPair _value
 
XMLNode_firstChild
 
XMLNode_lastChild
 
XMLNode_prev
 
XMLNode_next
 
void * _userData
 

Private Member Functions

 XMLDocument (const XMLDocument &)
 
void operator= (const XMLDocument &)
 
void Parse ()
 

Private Attributes

bool _writeBOM
 
bool _processEntities
 
XMLError _errorID
 
Whitespace _whitespace
 
const char * _errorStr1
 
const char * _errorStr2
 
char * _charBuffer
 
MemPoolT< sizeof(XMLElement) > _elementPool
 
MemPoolT< sizeof(XMLAttribute) > _attributePool
 
MemPoolT< sizeof(XMLText) > _textPool
 
MemPoolT< sizeof(XMLComment) > _commentPool
 

Static Private Attributes

static const char * _errorNames [XML_ERROR_COUNT]
 

Friends

class XMLElement
 

Detailed Description

A Document binds together all the functionality. It can be saved, loaded, and printed to the screen. All Nodes are connected and allocated to a Document. If the Document is deleted, all its Nodes are also deleted.

Constructor & Destructor Documentation

◆ XMLDocument() [1/2]

ttv::xml::XMLDocument::XMLDocument ( bool  processEntities = true,
Whitespace  = PRESERVE_WHITESPACE 
)

constructor

◆ ~XMLDocument()

ttv::xml::XMLDocument::~XMLDocument ( )

◆ XMLDocument() [2/2]

ttv::xml::XMLDocument::XMLDocument ( const XMLDocument )
private

Member Function Documentation

◆ Accept()

virtual bool ttv::xml::XMLDocument::Accept ( XMLVisitor visitor) const
virtual

Accept a hierarchical visit of the nodes in the TinyXML-2 DOM. Every node in the XML tree will be conditionally visited and the host will be called back via the XMLVisitor interface.

This is essentially a SAX interface for TinyXML-2. (Note however it doesn't re-parse the XML for the callbacks, so the performance of TinyXML-2 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():

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

Implements ttv::xml::XMLNode.

◆ Clear()

void ttv::xml::XMLDocument::Clear ( )

Clear the document, resetting it to the initial state.

◆ DeleteChild()

void ttv::xml::XMLNode::DeleteChild ( XMLNode node)
inherited

Delete a child of this node.

◆ DeleteChildren()

void ttv::xml::XMLNode::DeleteChildren ( )
inherited

Delete all the children of this node.

◆ DeleteNode()

void ttv::xml::XMLDocument::DeleteNode ( XMLNode node)

Delete a node associated with this document. It will be unlinked from the DOM.

◆ Error()

bool ttv::xml::XMLDocument::Error ( ) const
inline

Return true if there was an error parsing the document.

◆ ErrorID()

XMLError ttv::xml::XMLDocument::ErrorID ( ) const
inline

Return the errorID.

◆ ErrorName()

const char* ttv::xml::XMLDocument::ErrorName ( ) const

◆ FirstChild() [1/2]

const XMLNode* ttv::xml::XMLNode::FirstChild ( ) const
inlineinherited

Get the first child node, or null if none exists.

◆ FirstChild() [2/2]

XMLNode* ttv::xml::XMLNode::FirstChild ( )
inlineinherited

◆ FirstChildElement() [1/2]

const XMLElement* ttv::xml::XMLNode::FirstChildElement ( const char *  name = 0) const
inherited

Get the first child element, or optionally the first child element with the specified name.

◆ FirstChildElement() [2/2]

XMLElement* ttv::xml::XMLNode::FirstChildElement ( const char *  name = 0)
inlineinherited

◆ GetDocument() [1/2]

const XMLDocument* ttv::xml::XMLNode::GetDocument ( ) const
inlineinherited

Get the XMLDocument that owns this XMLNode.

◆ GetDocument() [2/2]

XMLDocument* ttv::xml::XMLNode::GetDocument ( )
inlineinherited

Get the XMLDocument that owns this XMLNode.

◆ GetErrorStr1()

const char* ttv::xml::XMLDocument::GetErrorStr1 ( ) const
inline

Return a possibly helpful diagnostic location or string.

◆ GetErrorStr2()

const char* ttv::xml::XMLDocument::GetErrorStr2 ( ) const
inline

Return a possibly helpful secondary diagnostic location or string.

◆ GetUserData()

void* ttv::xml::XMLNode::GetUserData ( ) const
inlineinherited

Get user data set into the XMLNode. TinyXML-2 in no way processes or interprets user data. It is initially 0.

◆ HasBOM()

bool ttv::xml::XMLDocument::HasBOM ( ) const
inline

Returns true if this document has a leading Byte Order Mark of UTF8.

◆ Identify()

char* ttv::xml::XMLDocument::Identify ( char *  p,
XMLNode **  node 
)

◆ InsertAfterChild()

XMLNode* ttv::xml::XMLNode::InsertAfterChild ( XMLNode afterThis,
XMLNode addThis 
)
inherited

Add a node after the specified child node. If the child node is already part of the document, it is moved from its old location to the new location. Returns the addThis argument or 0 if the afterThis node is not a child of this node, or if the node does not belong to the same document.

◆ InsertEndChild()

XMLNode* ttv::xml::XMLNode::InsertEndChild ( XMLNode addThis)
inherited

Add a child node as the last (right) child. If the child node is already part of the document, it is moved from its old location to the new location. Returns the addThis argument or 0 if the node does not belong to the same document.

◆ InsertFirstChild()

XMLNode* ttv::xml::XMLNode::InsertFirstChild ( XMLNode addThis)
inherited

Add a child node as the first (left) child. If the child node is already part of the document, it is moved from its old location to the new location. Returns the addThis argument or 0 if the node does not belong to the same document.

◆ LastChild() [1/2]

const XMLNode* ttv::xml::XMLNode::LastChild ( ) const
inlineinherited

Get the last child node, or null if none exists.

◆ LastChild() [2/2]

XMLNode* ttv::xml::XMLNode::LastChild ( )
inlineinherited

◆ LastChildElement() [1/2]

const XMLElement* ttv::xml::XMLNode::LastChildElement ( const char *  name = 0) const
inherited

Get the last child element or optionally the last child element with the specified name.

◆ LastChildElement() [2/2]

XMLElement* ttv::xml::XMLNode::LastChildElement ( const char *  name = 0)
inlineinherited

◆ LinkEndChild()

XMLNode* ttv::xml::XMLNode::LinkEndChild ( XMLNode addThis)
inlineinherited

◆ LoadFile() [1/2]

XMLError ttv::xml::XMLDocument::LoadFile ( const char *  filename)

Load an XML file from disk. Returns XML_NO_ERROR (0) on success, or an errorID.

◆ LoadFile() [2/2]

XMLError ttv::xml::XMLDocument::LoadFile ( FILE *  )

Load an XML file from disk. You are responsible for providing and closing the FILE*.

NOTE: The file should be opened as binary ("rb") not text in order for TinyXML-2 to correctly do newline normalization.

Returns XML_NO_ERROR (0) on success, or an errorID.

◆ NewComment()

XMLComment* ttv::xml::XMLDocument::NewComment ( const char *  comment)

Create a new Comment associated with this Document. The memory for the Comment is managed by the Document.

◆ NewDeclaration()

XMLDeclaration* ttv::xml::XMLDocument::NewDeclaration ( const char *  text = 0)

Create a new Declaration associated with this Document. The memory for the object is managed by the Document.

If the 'text' param is null, the standard declaration is used.:

    <?xml version="1.0" encoding="UTF-8"?>

◆ NewElement()

XMLElement* ttv::xml::XMLDocument::NewElement ( const char *  name)

Create a new Element associated with this Document. The memory for the Element is managed by the Document.

◆ NewText()

XMLText* ttv::xml::XMLDocument::NewText ( const char *  text)

Create a new Text associated with this Document. The memory for the Text is managed by the Document.

◆ NewUnknown()

XMLUnknown* ttv::xml::XMLDocument::NewUnknown ( const char *  text)

Create a new Unknown associated with this Document. The memory for the object is managed by the Document.

◆ NextSibling() [1/2]

const XMLNode* ttv::xml::XMLNode::NextSibling ( ) const
inlineinherited

Get the next (right) sibling node of this node.

◆ NextSibling() [2/2]

XMLNode* ttv::xml::XMLNode::NextSibling ( )
inlineinherited

◆ NextSiblingElement() [1/2]

const XMLElement* ttv::xml::XMLNode::NextSiblingElement ( const char *  name = 0) const
inherited

Get the next (right) sibling element of this node, with an optionally supplied name.

◆ NextSiblingElement() [2/2]

XMLElement* ttv::xml::XMLNode::NextSiblingElement ( const char *  name = 0)
inlineinherited

◆ NoChildren()

bool ttv::xml::XMLNode::NoChildren ( ) const
inlineinherited

Returns true if this node has no children.

◆ operator=()

void ttv::xml::XMLDocument::operator= ( const XMLDocument )
private

◆ Parent() [1/2]

const XMLNode* ttv::xml::XMLNode::Parent ( ) const
inlineinherited

Get the parent of this node on the DOM.

◆ Parent() [2/2]

XMLNode* ttv::xml::XMLNode::Parent ( )
inlineinherited

◆ Parse() [1/2]

XMLError ttv::xml::XMLDocument::Parse ( const char *  xml,
size_t  nBytes = SIZE_MAX 
)

Parse an XML file from a character string. Returns XML_NO_ERROR (0) on success, or an errorID.

You may optionally pass in the 'nBytes', which is the number of bytes which will be parsed. If not specified, TinyXML-2 will assume 'xml' points to a null terminated string.

◆ Parse() [2/2]

void ttv::xml::XMLDocument::Parse ( )
private

◆ ParseDeep()

virtual char* ttv::xml::XMLNode::ParseDeep ( char *  ,
StrPair  
)
protectedvirtualinherited

◆ PreviousSibling() [1/2]

const XMLNode* ttv::xml::XMLNode::PreviousSibling ( ) const
inlineinherited

Get the previous (left) sibling node of this node.

◆ PreviousSibling() [2/2]

XMLNode* ttv::xml::XMLNode::PreviousSibling ( )
inlineinherited

◆ PreviousSiblingElement() [1/2]

const XMLElement* ttv::xml::XMLNode::PreviousSiblingElement ( const char *  name = 0) const
inherited

Get the previous (left) sibling element of this node, with an optionally supplied name.

◆ PreviousSiblingElement() [2/2]

XMLElement* ttv::xml::XMLNode::PreviousSiblingElement ( const char *  name = 0)
inlineinherited

◆ Print()

void ttv::xml::XMLDocument::Print ( XMLPrinter streamer = 0) const

Print the Document. If the Printer is not provided, it will print to stdout. If you provide Printer, this can print to a file:

XMLPrinter printer( fp );
doc.Print( &printer );

Or you can use a printer to print to memory:

XMLPrinter printer;
doc.Print( &printer );
// printer.CStr() has a const char* to the XML

◆ PrintError()

void ttv::xml::XMLDocument::PrintError ( ) const

If there is an error, print it to stdout.

◆ ProcessEntities()

bool ttv::xml::XMLDocument::ProcessEntities ( ) const
inline

◆ RootElement() [1/2]

XMLElement* ttv::xml::XMLDocument::RootElement ( )
inline

Return the root element of DOM. Equivalent to FirstChildElement(). To get the first node, use FirstChild().

◆ RootElement() [2/2]

const XMLElement* ttv::xml::XMLDocument::RootElement ( ) const
inline

◆ SaveFile() [1/2]

XMLError ttv::xml::XMLDocument::SaveFile ( const char *  filename,
bool  compact = false 
)

Save the XML file to disk. Returns XML_NO_ERROR (0) on success, or an errorID.

◆ SaveFile() [2/2]

XMLError ttv::xml::XMLDocument::SaveFile ( FILE *  fp,
bool  compact = false 
)

Save the XML file to disk. You are responsible for providing and closing the FILE*.

Returns XML_NO_ERROR (0) on success, or an errorID.

◆ SetBOM()

void ttv::xml::XMLDocument::SetBOM ( bool  useBOM)
inline

Sets whether to write the BOM when writing the file.

◆ SetError()

void ttv::xml::XMLDocument::SetError ( XMLError  error,
const char *  str1,
const char *  str2 
)

◆ SetUserData()

void ttv::xml::XMLNode::SetUserData ( void *  userData)
inlineinherited

Set user data into the XMLNode. TinyXML-2 in no way processes or interprets user data. It is initially 0.

◆ SetValue()

void ttv::xml::XMLNode::SetValue ( const char *  val,
bool  staticMem = false 
)
inherited

Set the Value of an XML node.

See also
Value()

◆ ShallowClone()

virtual XMLNode* ttv::xml::XMLDocument::ShallowClone ( XMLDocument document) const
inlinevirtual

Make a copy of this node, but not its children. You may pass in a Document pointer that will be the owner of the new Node. If the 'document' is null, then the node returned will be allocated from the current Document. (this->GetDocument())

Note: if called on a XMLDocument, this will return null.

Implements ttv::xml::XMLNode.

◆ ShallowEqual()

virtual bool ttv::xml::XMLDocument::ShallowEqual ( const XMLNode compare) const
inlinevirtual

Test if 2 nodes are the same, but don't test children. The 2 nodes do not need to be in the same Document.

Note: if called on a XMLDocument, this will return false.

Implements ttv::xml::XMLNode.

◆ ToComment() [1/2]

virtual XMLComment* ttv::xml::XMLNode::ToComment ( )
inlinevirtualinherited

Safely cast to a Comment, or null.

Reimplemented in ttv::xml::XMLComment.

◆ ToComment() [2/2]

virtual const XMLComment* ttv::xml::XMLNode::ToComment ( ) const
inlinevirtualinherited

Reimplemented in ttv::xml::XMLComment.

◆ ToDeclaration() [1/2]

virtual XMLDeclaration* ttv::xml::XMLNode::ToDeclaration ( )
inlinevirtualinherited

Safely cast to a Declaration, or null.

Reimplemented in ttv::xml::XMLDeclaration.

◆ ToDeclaration() [2/2]

virtual const XMLDeclaration* ttv::xml::XMLNode::ToDeclaration ( ) const
inlinevirtualinherited

Reimplemented in ttv::xml::XMLDeclaration.

◆ ToDocument() [1/2]

virtual XMLDocument* ttv::xml::XMLDocument::ToDocument ( )
inlinevirtual

Safely cast to a Document, or null.

Reimplemented from ttv::xml::XMLNode.

◆ ToDocument() [2/2]

virtual const XMLDocument* ttv::xml::XMLDocument::ToDocument ( ) const
inlinevirtual

Reimplemented from ttv::xml::XMLNode.

◆ ToElement() [1/2]

virtual XMLElement* ttv::xml::XMLNode::ToElement ( )
inlinevirtualinherited

Safely cast to an Element, or null.

Reimplemented in ttv::xml::XMLElement.

◆ ToElement() [2/2]

virtual const XMLElement* ttv::xml::XMLNode::ToElement ( ) const
inlinevirtualinherited

Reimplemented in ttv::xml::XMLElement.

◆ ToText() [1/2]

virtual XMLText* ttv::xml::XMLNode::ToText ( )
inlinevirtualinherited

Safely cast to Text, or null.

Reimplemented in ttv::xml::XMLText.

◆ ToText() [2/2]

virtual const XMLText* ttv::xml::XMLNode::ToText ( ) const
inlinevirtualinherited

Reimplemented in ttv::xml::XMLText.

◆ ToUnknown() [1/2]

virtual XMLUnknown* ttv::xml::XMLNode::ToUnknown ( )
inlinevirtualinherited

Safely cast to an Unknown, or null.

Reimplemented in ttv::xml::XMLUnknown.

◆ ToUnknown() [2/2]

virtual const XMLUnknown* ttv::xml::XMLNode::ToUnknown ( ) const
inlinevirtualinherited

Reimplemented in ttv::xml::XMLUnknown.

◆ Value()

const char* ttv::xml::XMLNode::Value ( ) const
inherited

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

Document:   empty (NULL is returned, not an empty string)
Element:    name of the element
Comment:    the comment text
Unknown:    the tag contents
Text:       the text string

◆ WhitespaceMode()

Whitespace ttv::xml::XMLDocument::WhitespaceMode ( ) const
inline

Friends And Related Function Documentation

◆ XMLElement

friend class XMLElement
friend

Member Data Documentation

◆ _attributePool

MemPoolT< sizeof(XMLAttribute) > ttv::xml::XMLDocument::_attributePool
private

◆ _charBuffer

char* ttv::xml::XMLDocument::_charBuffer
private

◆ _commentPool

MemPoolT< sizeof(XMLComment) > ttv::xml::XMLDocument::_commentPool
private

◆ _document

XMLDocument* ttv::xml::XMLNode::_document
protectedinherited

◆ _elementPool

MemPoolT< sizeof(XMLElement) > ttv::xml::XMLDocument::_elementPool
private

◆ _errorID

XMLError ttv::xml::XMLDocument::_errorID
private

◆ _errorNames

const char* ttv::xml::XMLDocument::_errorNames[XML_ERROR_COUNT]
staticprivate

◆ _errorStr1

const char* ttv::xml::XMLDocument::_errorStr1
private

◆ _errorStr2

const char* ttv::xml::XMLDocument::_errorStr2
private

◆ _firstChild

XMLNode* ttv::xml::XMLNode::_firstChild
protectedinherited

◆ _lastChild

XMLNode* ttv::xml::XMLNode::_lastChild
protectedinherited

◆ _next

XMLNode* ttv::xml::XMLNode::_next
protectedinherited

◆ _parent

XMLNode* ttv::xml::XMLNode::_parent
protectedinherited

◆ _prev

XMLNode* ttv::xml::XMLNode::_prev
protectedinherited

◆ _processEntities

bool ttv::xml::XMLDocument::_processEntities
private

◆ _textPool

MemPoolT< sizeof(XMLText) > ttv::xml::XMLDocument::_textPool
private

◆ _userData

void* ttv::xml::XMLNode::_userData
protectedinherited

◆ _value

StrPair ttv::xml::XMLNode::_value
mutableprotectedinherited

◆ _whitespace

Whitespace ttv::xml::XMLDocument::_whitespace
private

◆ _writeBOM

bool ttv::xml::XMLDocument::_writeBOM
private

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