|
Twitch SDK (Internal)
|
#include <tinyxml2.h>
Public Member Functions | |
| XMLDocument (bool processEntities=true, Whitespace=PRESERVE_WHITESPACE) | |
| constructor More... | |
| ~XMLDocument () | |
| virtual XMLDocument * | ToDocument () |
| Safely cast to a Document, or null. More... | |
| virtual const XMLDocument * | ToDocument () 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) |
| XMLElement * | RootElement () |
| const XMLElement * | RootElement () const |
| void | Print (XMLPrinter *streamer=0) const |
| virtual bool | Accept (XMLVisitor *visitor) const |
| XMLElement * | NewElement (const char *name) |
| XMLComment * | NewComment (const char *comment) |
| XMLText * | NewText (const char *text) |
| XMLDeclaration * | NewDeclaration (const char *text=0) |
| XMLUnknown * | NewUnknown (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 XMLNode * | ShallowClone (XMLDocument *) const |
| virtual bool | ShallowEqual (const XMLNode *) const |
| const XMLDocument * | GetDocument () const |
| Get the XMLDocument that owns this XMLNode. More... | |
| XMLDocument * | GetDocument () |
| Get the XMLDocument that owns this XMLNode. More... | |
| virtual XMLElement * | ToElement () |
| Safely cast to an Element, or null. More... | |
| virtual const XMLElement * | ToElement () const |
| virtual XMLText * | ToText () |
| Safely cast to Text, or null. More... | |
| virtual const XMLText * | ToText () const |
| virtual XMLComment * | ToComment () |
| Safely cast to a Comment, or null. More... | |
| virtual const XMLComment * | ToComment () const |
| virtual XMLDeclaration * | ToDeclaration () |
| Safely cast to a Declaration, or null. More... | |
| virtual const XMLDeclaration * | ToDeclaration () const |
| virtual XMLUnknown * | ToUnknown () |
| Safely cast to an Unknown, or null. More... | |
| virtual const XMLUnknown * | ToUnknown () const |
| const char * | Value () const |
| void | SetValue (const char *val, bool staticMem=false) |
| const XMLNode * | Parent () const |
| Get the parent of this node on the DOM. More... | |
| XMLNode * | Parent () |
| bool | NoChildren () const |
| Returns true if this node has no children. More... | |
| const XMLNode * | FirstChild () const |
| Get the first child node, or null if none exists. More... | |
| XMLNode * | FirstChild () |
| const XMLElement * | FirstChildElement (const char *name=0) const |
| XMLElement * | FirstChildElement (const char *name=0) |
| const XMLNode * | LastChild () const |
| Get the last child node, or null if none exists. More... | |
| XMLNode * | LastChild () |
| const XMLElement * | LastChildElement (const char *name=0) const |
| XMLElement * | LastChildElement (const char *name=0) |
| const XMLNode * | PreviousSibling () const |
| Get the previous (left) sibling node of this node. More... | |
| XMLNode * | PreviousSibling () |
| const XMLElement * | PreviousSiblingElement (const char *name=0) const |
| Get the previous (left) sibling element of this node, with an optionally supplied name. More... | |
| XMLElement * | PreviousSiblingElement (const char *name=0) |
| const XMLNode * | NextSibling () const |
| Get the next (right) sibling node of this node. More... | |
| XMLNode * | NextSibling () |
| const XMLElement * | NextSiblingElement (const char *name=0) const |
| Get the next (right) sibling element of this node, with an optionally supplied name. More... | |
| XMLElement * | NextSiblingElement (const char *name=0) |
| XMLNode * | InsertEndChild (XMLNode *addThis) |
| XMLNode * | LinkEndChild (XMLNode *addThis) |
| XMLNode * | InsertFirstChild (XMLNode *addThis) |
| XMLNode * | InsertAfterChild (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 |
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.
| ttv::xml::XMLDocument::XMLDocument | ( | bool | processEntities = true, |
| Whitespace | = PRESERVE_WHITESPACE |
||
| ) |
constructor
| ttv::xml::XMLDocument::~XMLDocument | ( | ) |
|
private |
|
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.
| void ttv::xml::XMLDocument::Clear | ( | ) |
Clear the document, resetting it to the initial state.
|
inherited |
Delete a child of this node.
|
inherited |
Delete all the children of this node.
| void ttv::xml::XMLDocument::DeleteNode | ( | XMLNode * | node | ) |
Delete a node associated with this document. It will be unlinked from the DOM.
|
inline |
Return true if there was an error parsing the document.
|
inline |
Return the errorID.
| const char* ttv::xml::XMLDocument::ErrorName | ( | ) | const |
|
inlineinherited |
Get the first child node, or null if none exists.
|
inlineinherited |
|
inherited |
Get the first child element, or optionally the first child element with the specified name.
|
inlineinherited |
|
inlineinherited |
Get the XMLDocument that owns this XMLNode.
|
inlineinherited |
Get the XMLDocument that owns this XMLNode.
|
inline |
Return a possibly helpful diagnostic location or string.
|
inline |
Return a possibly helpful secondary diagnostic location or string.
|
inlineinherited |
Get user data set into the XMLNode. TinyXML-2 in no way processes or interprets user data. It is initially 0.
|
inline |
Returns true if this document has a leading Byte Order Mark of UTF8.
| char* ttv::xml::XMLDocument::Identify | ( | char * | p, |
| XMLNode ** | node | ||
| ) |
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.
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.
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.
|
inlineinherited |
Get the last child node, or null if none exists.
|
inlineinherited |
|
inherited |
Get the last child element or optionally the last child element with the specified name.
|
inlineinherited |
| XMLError ttv::xml::XMLDocument::LoadFile | ( | const char * | filename | ) |
Load an XML file from disk. Returns XML_NO_ERROR (0) on success, or an errorID.
| 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.
| 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.
| 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"?>
| 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.
| 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.
| 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.
|
inlineinherited |
Get the next (right) sibling node of this node.
|
inlineinherited |
|
inherited |
Get the next (right) sibling element of this node, with an optionally supplied name.
|
inlineinherited |
|
inlineinherited |
Returns true if this node has no children.
|
private |
|
inlineinherited |
Get the parent of this node on the DOM.
|
inlineinherited |
| 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.
|
private |
|
protectedvirtualinherited |
Reimplemented in ttv::xml::XMLElement, ttv::xml::XMLUnknown, ttv::xml::XMLDeclaration, ttv::xml::XMLComment, and ttv::xml::XMLText.
|
inlineinherited |
Get the previous (left) sibling node of this node.
|
inlineinherited |
|
inherited |
Get the previous (left) sibling element of this node, with an optionally supplied name.
|
inlineinherited |
| 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
| void ttv::xml::XMLDocument::PrintError | ( | ) | const |
If there is an error, print it to stdout.
|
inline |
|
inline |
Return the root element of DOM. Equivalent to FirstChildElement(). To get the first node, use FirstChild().
|
inline |
| 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.
| 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.
|
inline |
Sets whether to write the BOM when writing the file.
| void ttv::xml::XMLDocument::SetError | ( | XMLError | error, |
| const char * | str1, | ||
| const char * | str2 | ||
| ) |
|
inlineinherited |
Set user data into the XMLNode. TinyXML-2 in no way processes or interprets user data. It is initially 0.
|
inherited |
Set the Value of an XML node.
|
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.
|
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.
|
inlinevirtualinherited |
Safely cast to a Comment, or null.
Reimplemented in ttv::xml::XMLComment.
|
inlinevirtualinherited |
Reimplemented in ttv::xml::XMLComment.
|
inlinevirtualinherited |
Safely cast to a Declaration, or null.
Reimplemented in ttv::xml::XMLDeclaration.
|
inlinevirtualinherited |
Reimplemented in ttv::xml::XMLDeclaration.
|
inlinevirtual |
Safely cast to a Document, or null.
Reimplemented from ttv::xml::XMLNode.
|
inlinevirtual |
Reimplemented from ttv::xml::XMLNode.
|
inlinevirtualinherited |
Safely cast to an Element, or null.
Reimplemented in ttv::xml::XMLElement.
|
inlinevirtualinherited |
Reimplemented in ttv::xml::XMLElement.
|
inlinevirtualinherited |
Safely cast to Text, or null.
Reimplemented in ttv::xml::XMLText.
|
inlinevirtualinherited |
Reimplemented in ttv::xml::XMLText.
|
inlinevirtualinherited |
Safely cast to an Unknown, or null.
Reimplemented in ttv::xml::XMLUnknown.
|
inlinevirtualinherited |
Reimplemented in ttv::xml::XMLUnknown.
|
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
|
inline |
|
friend |
|
private |
|
private |
|
private |
|
protectedinherited |
|
private |
|
private |
|
staticprivate |
|
private |
|
private |
|
protectedinherited |
|
protectedinherited |
|
protectedinherited |
|
protectedinherited |
|
protectedinherited |
|
private |
|
protectedinherited |
|
mutableprotectedinherited |
|
private |
|
private |
1.8.13