Panda3D
|
Always the top level node. More...
#include "tinyxml.h"
Public Types | |
enum | { TIXML_NO_ERROR = 0, TIXML_ERROR, TIXML_ERROR_OPENING_FILE, 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 } |
enum | NodeType { TINYXML_DOCUMENT, TINYXML_ELEMENT, TINYXML_COMMENT, TINYXML_UNKNOWN, TINYXML_TEXT, TINYXML_DECLARATION, TINYXML_TYPECOUNT } |
The types of XML nodes supported by TinyXml. More... | |
Public Member 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 TiXmlDocument ©) | |
virtual bool | Accept (TiXmlVisitor *content) const |
Walk the XML tree visiting this node and all of its children. | |
void | Clear () |
Delete all the children of this node. Does not affect 'this'. | |
void | ClearError () |
If you have handled the error, it can be reset with this call. | |
int | Column () const |
See Row() | |
bool | Error () const |
If an error occurs, Error will be set to true. | |
int | ErrorCol () const |
The column where the error occured. See ErrorRow() | |
const char * | ErrorDesc () const |
Contains a textual (english) description of the error if one occurs. | |
int | ErrorId () const |
Generally, you probably want the error string ( ErrorDesc() ). | |
int | ErrorRow () const |
Returns the location (if known) of the error. | |
const TiXmlNode * | FirstChild () const |
The first child of this node. Will be null if there are no children. | |
TiXmlNode * | FirstChild () |
const TiXmlNode * | FirstChild (const char *value) const |
The first child of this node with the matching 'value'. | |
TiXmlNode * | FirstChild (const char *_value) |
The first child of this node with the matching 'value'. Will be null if none found. | |
const TiXmlElement * | FirstChildElement () const |
Convenience function to get through elements. | |
TiXmlElement * | FirstChildElement () |
const TiXmlElement * | FirstChildElement (const char *_value) const |
Convenience function to get through elements. | |
TiXmlElement * | FirstChildElement (const char *_value) |
TiXmlDocument * | GetDocument () |
const TiXmlDocument * | GetDocument () const |
Return a pointer to the Document this node lives in. | |
void * | GetUserData () |
Get a pointer to arbitrary user data. | |
const void * | GetUserData () const |
Get a pointer to arbitrary user data. | |
TiXmlNode * | InsertAfterChild (TiXmlNode *afterThis, const TiXmlNode &addThis) |
Add a new node related to this. | |
TiXmlNode * | InsertBeforeChild (TiXmlNode *beforeThis, const TiXmlNode &addThis) |
Add a new node related to this. | |
TiXmlNode * | InsertEndChild (const TiXmlNode &addThis) |
Add a new node related to this. | |
TiXmlNode * | IterateChildren (const TiXmlNode *previous) |
const TiXmlNode * | IterateChildren (const char *value, const TiXmlNode *previous) const |
This flavor of IterateChildren searches for children with a particular 'value'. | |
const TiXmlNode * | IterateChildren (const TiXmlNode *previous) const |
An alternate way to walk the children of a node. | |
TiXmlNode * | IterateChildren (const char *_value, const TiXmlNode *previous) |
const TiXmlNode * | LastChild () const |
const TiXmlNode * | LastChild (const char *value) const |
TiXmlNode * | LastChild () |
The last child of this node. Will be null if there are no children. | |
TiXmlNode * | LastChild (const char *_value) |
The last child of this node matching 'value'. Will be null if there are no children. | |
TiXmlNode * | LinkEndChild (TiXmlNode *addThis) |
Add a new node related to this. | |
bool | LoadFile (const char *filename, TiXmlEncoding encoding=TIXML_DEFAULT_ENCODING) |
Load 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*. | |
bool | LoadFile (TiXmlEncoding encoding=TIXML_DEFAULT_ENCODING) |
Load a file using the current document value. | |
const TiXmlNode * | NextSibling () const |
Navigate to a sibling node. | |
TiXmlNode * | NextSibling () |
const TiXmlNode * | NextSibling (const char *) const |
Navigate to a sibling node with the given 'value'. | |
TiXmlNode * | NextSibling (const char *_next) |
TiXmlElement * | NextSiblingElement (const char *_next) |
const TiXmlElement * | NextSiblingElement (const char *) const |
Convenience function to get through elements. | |
const TiXmlElement * | NextSiblingElement () const |
Convenience function to get through elements. | |
TiXmlElement * | NextSiblingElement () |
bool | NoChildren () const |
Returns true if this node has no children. | |
void | operator= (const TiXmlDocument ©) |
TiXmlNode * | Parent () |
One step up the DOM. | |
const TiXmlNode * | Parent () const |
virtual const char * | Parse (const char *p, TiXmlParsingData *data=0, TiXmlEncoding encoding=TIXML_DEFAULT_ENCODING) |
Parse the given null terminated block of xml data. | |
const TiXmlNode * | PreviousSibling (const char *) const |
Navigate to a sibling node. | |
const TiXmlNode * | PreviousSibling () const |
Navigate to a sibling node. | |
TiXmlNode * | PreviousSibling () |
TiXmlNode * | PreviousSibling (const char *_prev) |
void | Print () const |
Write the document to standard out using formatted printing ("pretty print"). | |
virtual void | Print (FILE *cfile, int depth=0) const |
Print this Document to a FILE stream. | |
bool | RemoveChild (TiXmlNode *removeThis) |
Delete a child of this node. | |
TiXmlNode * | ReplaceChild (TiXmlNode *replaceThis, const TiXmlNode &withThis) |
Replace a child of this node. | |
TiXmlElement * | RootElement () |
const TiXmlElement * | RootElement () const |
Get the root element -- the only top level element -- of the document. | |
int | Row () const |
Return the position, in the original source file, of this node or attribute. | |
bool | SaveFile (const char *filename) const |
Save a file using the given filename. Returns true if successful. | |
bool | SaveFile () const |
Save a file using the current document value. Returns true if successful. | |
bool | SaveFile (FILE *) const |
Save a file using the given FILE*. Returns true if successful. | |
void | SetError (int err, const char *errorLocation, TiXmlParsingData *prevData, TiXmlEncoding encoding) |
void | SetTabSize (int _tabsize) |
SetTabSize() allows the error reporting functions (ErrorRow() and ErrorCol()) to report the correct values for row and column. | |
void | SetUserData (void *user) |
Set a pointer to arbitrary user data. | |
void | SetValue (const char *_value) |
Changes the value of the node. | |
int | TabSize () const |
virtual const TiXmlComment * | ToComment () const |
Cast to a more defined type. Will return null if not of the requested type. | |
virtual TiXmlComment * | ToComment () |
Cast to a more defined type. Will return null if not of the requested type. | |
virtual TiXmlDeclaration * | ToDeclaration () |
Cast to a more defined type. Will return null if not of the requested type. | |
virtual const TiXmlDeclaration * | ToDeclaration () const |
Cast to a more defined type. Will return null if not of the requested type. | |
virtual const TiXmlDocument * | ToDocument () const |
Cast to a more defined type. Will return null not of the requested type. | |
virtual TiXmlDocument * | ToDocument () |
Cast to a more defined type. Will return null not of the requested type. | |
virtual const TiXmlElement * | ToElement () const |
Cast to a more defined type. Will return null if not of the requested type. | |
virtual TiXmlElement * | ToElement () |
Cast to a more defined type. Will return null if not of the requested type. | |
virtual const TiXmlText * | ToText () const |
Cast to a more defined type. Will return null if not of the requested type. | |
virtual TiXmlText * | ToText () |
Cast to a more defined type. Will return null if not of the requested type. | |
virtual TiXmlUnknown * | ToUnknown () |
Cast to a more defined type. Will return null if not of the requested type. | |
virtual const TiXmlUnknown * | ToUnknown () const |
Cast to a more defined type. Will return null if not of the requested type. | |
int | Type () const |
Query the type (as an enumerated value, above) of this node. | |
const char * | Value () const |
The meaning of 'value' changes for the specific type of TiXmlNode. | |
const TiXmlString & | ValueTStr () const |
Static Public Member Functions | |
static void | EncodeString (const TiXmlString &str, TiXmlString *out) |
Expands entities in a string. | |
static bool | IsWhiteSpaceCondensed () |
Return the current white space setting. | |
static void | SetCondenseWhiteSpace (bool condense) |
The world does not agree on whether white space should be kept or not. | |
Static Public Attributes | |
static const int | utf8ByteTable [256] |
Protected Member Functions | |
virtual TiXmlNode * | Clone () const |
Create an exact duplicate of this node and return it. | |
void | CopyTo (TiXmlNode *target) const |
TiXmlNode * | Identify (const char *start, TiXmlEncoding encoding) |
Static Protected Member Functions | |
static void | ConvertUTF32ToUTF8 (unsigned long input, char *output, int *length) |
static const char * | GetChar (const char *p, char *_value, int *length, TiXmlEncoding encoding) |
static const char * | GetEntity (const char *in, char *value, int *length, TiXmlEncoding encoding) |
static int | IsAlpha (unsigned char anyByte, TiXmlEncoding encoding) |
static int | IsAlphaNum (unsigned char anyByte, TiXmlEncoding encoding) |
static bool | IsWhiteSpace (int c) |
static bool | IsWhiteSpace (char c) |
static const char * | ReadName (const char *p, TiXmlString *name, TiXmlEncoding encoding) |
static const char * | ReadText (const char *in, TiXmlString *text, bool ignoreWhiteSpace, const char *endTag, bool ignoreCase, TiXmlEncoding encoding) |
static const char * | SkipWhiteSpace (const char *, TiXmlEncoding encoding) |
static bool | StringEqual (const char *p, const char *endTag, bool ignoreCase, TiXmlEncoding encoding) |
static int | ToLower (int v, TiXmlEncoding encoding) |
Protected Attributes | |
TiXmlNode * | firstChild |
TiXmlNode * | lastChild |
TiXmlCursor | location |
TiXmlNode * | next |
TiXmlNode * | parent |
TiXmlNode * | prev |
NodeType | type |
void * | userData |
Field containing a generic user pointer. | |
TiXmlString | value |
Static Protected Attributes | |
static const char * | errorString [TIXML_ERROR_STRING_COUNT] |
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.
enum TiXmlNode::NodeType [inherited] |
TiXmlDocument::TiXmlDocument | ( | ) |
Create an empty document, that has no name.
Definition at line 869 of file tinyxml.cpp.
References ClearError().
Referenced by Clone().
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 876 of file tinyxml.cpp.
References ClearError().
bool TiXmlDocument::Accept | ( | TiXmlVisitor * | content | ) | const [virtual] |
Walk the XML tree visiting this node and all of its children.
Implements TiXmlNode.
Definition at line 1111 of file tinyxml.cpp.
References TiXmlNode::Accept(), TiXmlNode::FirstChild(), TiXmlNode::NextSibling(), TiXmlVisitor::VisitEnter(), and TiXmlVisitor::VisitExit().
void TiXmlNode::Clear | ( | ) | [inherited] |
Delete all the children of this node. Does not affect 'this'.
Definition at line 169 of file tinyxml.cpp.
Referenced by LoadFile().
void 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 1504 of file tinyxml.h.
Referenced by Parse(), and TiXmlDocument().
TiXmlNode * TiXmlDocument::Clone | ( | ) | const [protected, virtual] |
Create an exact duplicate of this node and return it.
The memory must be deleted by the caller.
Implements TiXmlNode.
Definition at line 1089 of file tinyxml.cpp.
References TiXmlDocument().
int TiXmlBase::Column | ( | ) | const [inline, inherited] |
void TiXmlBase::EncodeString | ( | const TiXmlString & | str, |
TiXmlString * | out | ||
) | [static, inherited] |
Expands entities in a string.
Note this should not contian the tag's '<', '>', etc, or they will be transformed into entities!
Definition at line 52 of file tinyxml.cpp.
Referenced by TiXmlText::Print(), and TiXmlPrinter::Visit().
bool TiXmlDocument::Error | ( | ) | const [inline] |
If an error occurs, Error will be set to true.
Also,
Definition at line 1453 of file tinyxml.h.
Referenced by LoadFile().
int TiXmlDocument::ErrorCol | ( | ) | const [inline] |
The column where the error occured. See ErrorRow()
const char* TiXmlDocument::ErrorDesc | ( | ) | const [inline] |
int TiXmlDocument::ErrorId | ( | ) | const [inline] |
Generally, you probably want the error string ( ErrorDesc() ).
But if you prefer the ErrorId, this function will fetch it.
int TiXmlDocument::ErrorRow | ( | ) | const [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.)
const TiXmlNode* TiXmlNode::FirstChild | ( | ) | const [inline, inherited] |
The first child of this node. Will be null if there are no children.
Definition at line 522 of file tinyxml.h.
Referenced by Accept(), TiXmlElement::Accept(), TiXmlNode::FirstChildElement(), TiXmlElement::GetText(), TiXmlNode::IterateChildren(), Print(), TiXmlPrinter::VisitEnter(), and TiXmlPrinter::VisitExit().
const TiXmlNode * 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 357 of file tinyxml.cpp.
References TiXmlNode::Value().
TiXmlNode* TiXmlNode::FirstChild | ( | const char * | _value | ) | [inline, inherited] |
const TiXmlElement * TiXmlNode::FirstChildElement | ( | const char * | _value | ) | const [inherited] |
Convenience function to get through elements.
Definition at line 463 of file tinyxml.cpp.
References TiXmlNode::FirstChild(), TiXmlNode::NextSibling(), and TiXmlNode::ToElement().
const TiXmlElement * TiXmlNode::FirstChildElement | ( | ) | const [inherited] |
Convenience function to get through elements.
Definition at line 448 of file tinyxml.cpp.
References TiXmlNode::FirstChild(), TiXmlNode::NextSibling(), and TiXmlNode::ToElement().
Referenced by RootElement().
const TiXmlDocument * TiXmlNode::GetDocument | ( | ) | const [inherited] |
Return a pointer to the Document this node lives in.
Returns null if not in a document.
Definition at line 508 of file tinyxml.cpp.
References TiXmlNode::ToDocument().
Referenced by TiXmlNode::InsertAfterChild(), TiXmlNode::InsertBeforeChild(), TiXmlNode::InsertEndChild(), TiXmlNode::LinkEndChild(), and TiXmlNode::ReplaceChild().
void* TiXmlBase::GetUserData | ( | ) | [inline, inherited] |
Get a pointer to arbitrary user data.
Definition at line 248 of file tinyxml.h.
References TiXmlBase::userData.
const void* TiXmlBase::GetUserData | ( | ) | const [inline, inherited] |
Get a pointer to arbitrary user data.
Definition at line 249 of file tinyxml.h.
References TiXmlBase::userData.
TiXmlNode * 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 260 of file tinyxml.cpp.
References TiXmlNode::Clone(), TiXmlNode::GetDocument(), and TiXmlNode::Type().
TiXmlNode * 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 228 of file tinyxml.cpp.
References TiXmlNode::Clone(), TiXmlNode::GetDocument(), and TiXmlNode::Type().
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 213 of file tinyxml.cpp.
References TiXmlNode::Clone(), TiXmlNode::GetDocument(), TiXmlNode::LinkEndChild(), and TiXmlNode::Type().
static bool TiXmlBase::IsWhiteSpaceCondensed | ( | ) | [inline, static, inherited] |
const TiXmlNode * TiXmlNode::IterateChildren | ( | const char * | value, |
const TiXmlNode * | previous | ||
) | const [inherited] |
This flavor of IterateChildren searches for children with a particular 'value'.
Definition at line 395 of file tinyxml.cpp.
References TiXmlNode::FirstChild(), and TiXmlNode::NextSibling().
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 381 of file tinyxml.cpp.
References TiXmlNode::FirstChild(), and TiXmlNode::NextSibling().
TiXmlNode* TiXmlNode::LastChild | ( | ) | [inline, inherited] |
TiXmlNode* TiXmlNode::LastChild | ( | const char * | _value | ) | [inline, 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.
Definition at line 186 of file tinyxml.cpp.
References TiXmlNode::GetDocument(), and TiXmlNode::Type().
Referenced by TiXmlNode::InsertEndChild(), and Parse().
bool 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 909 of file tinyxml.cpp.
References TiXmlNode::Value().
Referenced by LoadFile().
bool TiXmlDocument::LoadFile | ( | const char * | filename, |
TiXmlEncoding | encoding = TIXML_DEFAULT_ENCODING |
||
) |
Load a file using the given filename. Returns true if successful.
Definition at line 920 of file tinyxml.cpp.
References LoadFile().
bool 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 941 of file tinyxml.cpp.
References TiXmlNode::Clear(), Error(), and Parse().
const TiXmlNode* TiXmlNode::NextSibling | ( | ) | const [inline, inherited] |
Navigate to a sibling node.
Definition at line 631 of file tinyxml.h.
Referenced by Accept(), TiXmlElement::Accept(), TiXmlHandle::Child(), TiXmlNode::FirstChildElement(), TiXmlNode::IterateChildren(), TiXmlNode::NextSiblingElement(), Print(), and TiXmlElement::Print().
const TiXmlNode * TiXmlNode::NextSibling | ( | const char * | _value | ) | const [inherited] |
Navigate to a sibling node with the given 'value'.
Definition at line 409 of file tinyxml.cpp.
References TiXmlNode::Value().
const TiXmlElement * 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 478 of file tinyxml.cpp.
References TiXmlNode::NextSibling(), and TiXmlNode::ToElement().
Referenced by TiXmlHandle::ChildElement().
const TiXmlElement * 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 493 of file tinyxml.cpp.
References TiXmlNode::NextSibling(), and TiXmlNode::ToElement().
bool TiXmlNode::NoChildren | ( | ) | const [inline, inherited] |
TiXmlNode* TiXmlNode::Parent | ( | ) | [inline, inherited] |
const char * TiXmlDocument::Parse | ( | const char * | p, |
TiXmlParsingData * | data = 0 , |
||
TiXmlEncoding | encoding = TIXML_DEFAULT_ENCODING |
||
) | [virtual] |
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.
Implements TiXmlBase.
Definition at line 704 of file tinyxmlparser.cpp.
References ClearError(), TiXmlDeclaration::Encoding(), TiXmlNode::LinkEndChild(), and TiXmlNode::ToDeclaration().
Referenced by LoadFile().
const TiXmlNode * TiXmlNode::PreviousSibling | ( | const char * | _value | ) | const [inherited] |
Navigate to a sibling node.
Definition at line 421 of file tinyxml.cpp.
References TiXmlNode::Value().
const TiXmlNode* TiXmlNode::PreviousSibling | ( | ) | const [inline, inherited] |
void TiXmlDocument::Print | ( | ) | const [inline] |
Write the document to standard out using formatted printing ("pretty print").
Definition at line 1512 of file tinyxml.h.
References Print().
Referenced by Print(), and SaveFile().
void TiXmlDocument::Print | ( | FILE * | cfile, |
int | depth = 0 |
||
) | const [virtual] |
Print this Document to a FILE stream.
Implements TiXmlBase.
Definition at line 1100 of file tinyxml.cpp.
References TiXmlNode::FirstChild(), TiXmlNode::NextSibling(), and TiXmlBase::Print().
bool TiXmlNode::RemoveChild | ( | TiXmlNode * | removeThis | ) | [inherited] |
Delete a child of this node.
Definition at line 331 of file tinyxml.cpp.
TiXmlNode * 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 292 of file tinyxml.cpp.
References TiXmlNode::Clone(), TiXmlNode::GetDocument(), and TiXmlNode::ToDocument().
const TiXmlElement* 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 1445 of file tinyxml.h.
References TiXmlNode::FirstChildElement().
int TiXmlBase::Row | ( | ) | const [inline, inherited] |
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.
bool TiXmlDocument::SaveFile | ( | ) | const |
Save a file using the current document value. Returns true if successful.
Definition at line 915 of file tinyxml.cpp.
References TiXmlNode::Value().
Referenced by SaveFile().
bool TiXmlDocument::SaveFile | ( | FILE * | fp | ) | const |
Save a file using the given FILE*. Returns true if successful.
Definition at line 1053 of file tinyxml.cpp.
References Print().
bool TiXmlDocument::SaveFile | ( | const char * | filename | ) | const |
Save a file using the given filename. Returns true if successful.
Definition at line 1039 of file tinyxml.cpp.
References SaveFile().
static void TiXmlBase::SetCondenseWhiteSpace | ( | bool | condense | ) | [inline, static, inherited] |
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.
void 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" );
void TiXmlBase::SetUserData | ( | void * | user | ) | [inline, inherited] |
Set a pointer to arbitrary user data.
Definition at line 247 of file tinyxml.h.
References TiXmlBase::userData.
void TiXmlNode::SetValue | ( | const char * | _value | ) | [inline, inherited] |
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 508 of file tinyxml.h.
Referenced by TiXmlComment::TiXmlComment(), and TiXmlText::TiXmlText().
virtual const TiXmlComment* TiXmlNode::ToComment | ( | ) | const [inline, virtual, inherited] |
Cast to a more defined type. Will return null if not of the requested type.
Reimplemented in TiXmlComment.
virtual TiXmlComment* TiXmlNode::ToComment | ( | ) | [inline, virtual, inherited] |
Cast to a more defined type. Will return null if not of the requested type.
Reimplemented in TiXmlComment.
virtual TiXmlDeclaration* TiXmlNode::ToDeclaration | ( | ) | [inline, virtual, inherited] |
Cast to a more defined type. Will return null if not of the requested type.
Reimplemented in TiXmlDeclaration.
virtual const TiXmlDeclaration* TiXmlNode::ToDeclaration | ( | ) | const [inline, virtual, inherited] |
Cast to a more defined type. Will return null if not of the requested type.
Reimplemented in TiXmlDeclaration.
Definition at line 702 of file tinyxml.h.
Referenced by Parse().
virtual const TiXmlDocument* TiXmlDocument::ToDocument | ( | ) | const [inline, virtual] |
virtual TiXmlDocument* TiXmlDocument::ToDocument | ( | ) | [inline, virtual] |
virtual TiXmlElement* TiXmlNode::ToElement | ( | ) | [inline, virtual, inherited] |
Cast to a more defined type. Will return null if not of the requested type.
Reimplemented in TiXmlElement.
virtual const TiXmlElement* TiXmlNode::ToElement | ( | ) | const [inline, virtual, inherited] |
Cast to a more defined type. Will return null if not of the requested type.
Reimplemented in TiXmlElement.
Definition at line 698 of file tinyxml.h.
Referenced by TiXmlNode::FirstChildElement(), and TiXmlNode::NextSiblingElement().
virtual TiXmlText* TiXmlNode::ToText | ( | ) | [inline, virtual, inherited] |
virtual const TiXmlText* TiXmlNode::ToText | ( | ) | const [inline, virtual, inherited] |
Cast to a more defined type. Will return null if not of the requested type.
Reimplemented in TiXmlText.
Definition at line 701 of file tinyxml.h.
Referenced by TiXmlElement::GetText(), TiXmlElement::Print(), and TiXmlPrinter::VisitEnter().
virtual TiXmlUnknown* TiXmlNode::ToUnknown | ( | ) | [inline, virtual, inherited] |
Cast to a more defined type. Will return null if not of the requested type.
Reimplemented in TiXmlUnknown.
virtual const TiXmlUnknown* TiXmlNode::ToUnknown | ( | ) | const [inline, virtual, inherited] |
Cast to a more defined type. Will return null if not of the requested type.
Reimplemented in TiXmlUnknown.
int TiXmlNode::Type | ( | ) | const [inline, inherited] |
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 684 of file tinyxml.h.
Referenced by TiXmlNode::InsertAfterChild(), TiXmlNode::InsertBeforeChild(), TiXmlNode::InsertEndChild(), and TiXmlNode::LinkEndChild().
const char* TiXmlNode::Value | ( | ) | const [inline, inherited] |
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 487 of file tinyxml.h.
Referenced by TiXmlElement::Clone(), TiXmlNode::FirstChild(), TiXmlElement::GetText(), LoadFile(), TiXmlNode::NextSibling(), TiXmlNode::PreviousSibling(), SaveFile(), TiXmlPrinter::Visit(), TiXmlPrinter::VisitEnter(), and TiXmlPrinter::VisitExit().
const char * TiXmlBase::errorString [static, protected, inherited] |
{ "No error", "Error", "Failed to open file", "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.", "Error when TiXmlDocument added to document, because TiXmlDocument can only be at the root.", }
void* TiXmlBase::userData [protected, inherited] |
Field containing a generic user pointer.
Definition at line 376 of file tinyxml.h.
Referenced by TiXmlBase::GetUserData(), and TiXmlBase::SetUserData().
const int TiXmlBase::utf8ByteTable [static, inherited] |
{ 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 }