|
TinyXML-2
1.0.5
|
#include <tinyxml2.h>
Public Member Functions | |
| XMLDocument (bool processEntities=true) | |
| constructor | |
| virtual XMLDocument * | ToDocument () |
| Safely cast to a Document, or null. | |
| int | Parse (const char *xml) |
| int | LoadFile (const char *filename) |
| int | LoadFile (FILE *) |
| int | SaveFile (const char *filename) |
| int | SaveFile (FILE *) |
| bool | HasBOM () const |
| void | SetBOM (bool useBOM) |
| XMLElement * | RootElement () |
| void | Print (XMLPrinter *streamer=0) |
| 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) |
| bool | Error () const |
| Return true if there was an error parsing the document. | |
| int | ErrorID () const |
| Return the errorID. | |
| const char * | GetErrorStr1 () const |
| Return a possibly helpful diagnostic location or string. | |
| const char * | GetErrorStr2 () const |
| Return a possibly helpful secondary diagnostic location or string. | |
| void | PrintError () const |
| If there is an error, print it to stdout. | |
| virtual XMLNode * | ShallowClone (XMLDocument *) const |
| virtual bool | ShallowEqual (const XMLNode *) const |
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.
| virtual bool tinyxml2::XMLDocument::Accept | ( | XMLVisitor * | visitor | ) | const [virtual] |
Accept a hierarchical visit of 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();Implements tinyxml2::XMLNode.
| void tinyxml2::XMLDocument::DeleteNode | ( | XMLNode * | node | ) | [inline] |
Delete a node associated with this document. It will be unlinked from the DOM.
| bool tinyxml2::XMLDocument::HasBOM | ( | ) | const [inline] |
Returns true if this document has a leading Byte Order Mark of UTF8.
| int tinyxml2::XMLDocument::LoadFile | ( | const char * | filename | ) |
Load an XML file from disk. Returns XML_NO_ERROR (0) on success, or an errorID.
| int tinyxml2::XMLDocument::LoadFile | ( | FILE * | ) |
Load an XML file from disk. You are responsible for providing and closing the FILE*.
Returns XML_NO_ERROR (0) on success, or an errorID.
| XMLComment* tinyxml2::XMLDocument::NewComment | ( | const char * | comment | ) |
Create a new Comment associated with this Document. The memory for the Comment is managed by the Document.
| XMLDeclaration* tinyxml2::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* tinyxml2::XMLDocument::NewElement | ( | const char * | name | ) |
Create a new Element associated with this Document. The memory for the Element is managed by the Document.
| XMLText* tinyxml2::XMLDocument::NewText | ( | const char * | text | ) |
Create a new Text associated with this Document. The memory for the Text is managed by the Document.
| XMLUnknown* tinyxml2::XMLDocument::NewUnknown | ( | const char * | text | ) |
Create a new Unknown associated with this Document. The memory for the object is managed by the Document.
| int tinyxml2::XMLDocument::Parse | ( | const char * | xml | ) |
Parse an XML file from a character string. Returns XML_NO_ERROR (0) on success, or an errorID.
| void tinyxml2::XMLDocument::Print | ( | XMLPrinter * | streamer = 0 | ) |
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| XMLElement* tinyxml2::XMLDocument::RootElement | ( | ) | [inline] |
Return the root element of DOM. Equivalent to FirstChildElement(). To get the first node, use FirstChild().
| int tinyxml2::XMLDocument::SaveFile | ( | const char * | filename | ) |
Save the XML file to disk. Returns XML_NO_ERROR (0) on success, or an errorID.
| int tinyxml2::XMLDocument::SaveFile | ( | FILE * | ) |
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.
| void tinyxml2::XMLDocument::SetBOM | ( | bool | useBOM | ) | [inline] |
Sets whether to write the BOM when writing the file.
| virtual XMLNode* tinyxml2::XMLDocument::ShallowClone | ( | XMLDocument * | document | ) | const [inline, virtual] |
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 tinyxml2::XMLNode.
| virtual bool tinyxml2::XMLDocument::ShallowEqual | ( | const XMLNode * | compare | ) | const [inline, virtual] |
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 tinyxml2::XMLNode.
1.8.0