#include <tinyxml.h>
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 Types | |
| enum | { 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 Member Functions | |
| TiXmlBase () | |
| virtual | ~TiXmlBase () |
| virtual void | Print (FILE *cfile, int depth) const =0 |
| int | Row () const |
| int | Column () const |
| 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 () const |
| Get a pointer to arbitrary user data. | |
| virtual const char * | Parse (const char *p, TiXmlParsingData *data, TiXmlEncoding encoding)=0 |
Static Public Member Functions | |
| static void | SetCondenseWhiteSpace (bool condense) |
| static bool | IsWhiteSpaceCondensed () |
| Return the current white space setting. | |
| static void | EncodeString (const TIXML_STRING &str, TIXML_STRING *out) |
Static Public Attributes | |
| static const int | utf8ByteTable [256] |
Static Protected Member Functions | |
| static const char * | SkipWhiteSpace (const char *, TiXmlEncoding encoding) |
| static bool | IsWhiteSpace (char c) |
| static bool | IsWhiteSpace (int c) |
| static const char * | ReadName (const char *p, TIXML_STRING *name, TiXmlEncoding encoding) |
| static const char * | ReadText (const char *in, TIXML_STRING *text, bool ignoreWhiteSpace, const char *endTag, bool ignoreCase, TiXmlEncoding encoding) |
| static const char * | GetEntity (const char *in, char *value, int *length, TiXmlEncoding encoding) |
| static const char * | GetChar (const char *p, char *_value, int *length, TiXmlEncoding encoding) |
| static bool | StringEqual (const char *p, const char *endTag, bool ignoreCase, TiXmlEncoding encoding) |
| static int | IsAlpha (unsigned char anyByte, TiXmlEncoding encoding) |
| static int | IsAlphaNum (unsigned char anyByte, TiXmlEncoding encoding) |
| static int | ToLower (int v, TiXmlEncoding encoding) |
| static void | ConvertUTF32ToUTF8 (unsigned long input, char *output, int *length) |
Protected Attributes | |
| TiXmlCursor | location |
| void * | userData |
| Field containing a generic user pointer. | |
Static Protected Attributes | |
| static const char * | errorString [TIXML_ERROR_STRING_COUNT] |
Friends | |
| class | TiXmlNode |
| class | TiXmlElement |
| class | TiXmlDocument |
Classes | |
| struct | Entity |
| anonymous enum |
| TiXmlBase::TiXmlBase | ( | ) | [inline] |
| virtual TiXmlBase::~TiXmlBase | ( | ) | [inline, virtual] |
| virtual void TiXmlBase::Print | ( | FILE * | cfile, | |
| int | depth | |||
| ) | const [pure virtual] |
All TinyXml classes can print themselves to a filestream 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.)
Implemented in TiXmlAttribute, TiXmlElement, TiXmlComment, TiXmlText, TiXmlDeclaration, TiXmlUnknown, and TiXmlDocument.
| static void TiXmlBase::SetCondenseWhiteSpace | ( | bool | condense | ) | [inline, static] |
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.
| static bool TiXmlBase::IsWhiteSpaceCondensed | ( | ) | [inline, static] |
Return the current white space setting.
| int TiXmlBase::Row | ( | ) | const [inline] |
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.
| int TiXmlBase::Column | ( | ) | const [inline] |
See Row().
| void TiXmlBase::SetUserData | ( | void * | user | ) | [inline] |
Set a pointer to arbitrary user data.
| void* TiXmlBase::GetUserData | ( | ) | [inline] |
Get a pointer to arbitrary user data.
| const void* TiXmlBase::GetUserData | ( | ) | const [inline] |
Get a pointer to arbitrary user data.
| virtual const char* TiXmlBase::Parse | ( | const char * | p, | |
| TiXmlParsingData * | data, | |||
| TiXmlEncoding | encoding | |||
| ) | [pure virtual] |
Implemented in TiXmlAttribute, TiXmlElement, TiXmlComment, TiXmlText, TiXmlDeclaration, TiXmlUnknown, and TiXmlDocument.
| void TiXmlBase::EncodeString | ( | const TIXML_STRING & | str, | |
| TIXML_STRING * | out | |||
| ) | [static] |
Expands entities in a string. Note this should not contian the tag's '<', '>', etc, or they will be transformed into entities!
| const char * TiXmlBase::SkipWhiteSpace | ( | const char * | p, | |
| TiXmlEncoding | encoding | |||
| ) | [static, protected] |
| static bool TiXmlBase::IsWhiteSpace | ( | char | c | ) | [inline, static, protected] |
| static bool TiXmlBase::IsWhiteSpace | ( | int | c | ) | [inline, static, protected] |
| const char * TiXmlBase::ReadName | ( | const char * | p, | |
| TIXML_STRING * | name, | |||
| TiXmlEncoding | encoding | |||
| ) | [static, protected] |
| const char * TiXmlBase::ReadText | ( | const char * | in, | |
| TIXML_STRING * | text, | |||
| bool | ignoreWhiteSpace, | |||
| const char * | endTag, | |||
| bool | ignoreCase, | |||
| TiXmlEncoding | encoding | |||
| ) | [static, protected] |
| const char * TiXmlBase::GetEntity | ( | const char * | in, | |
| char * | value, | |||
| int * | length, | |||
| TiXmlEncoding | encoding | |||
| ) | [static, protected] |
| static const char* TiXmlBase::GetChar | ( | const char * | p, | |
| char * | _value, | |||
| int * | length, | |||
| TiXmlEncoding | encoding | |||
| ) | [inline, static, protected] |
| bool TiXmlBase::StringEqual | ( | const char * | p, | |
| const char * | endTag, | |||
| bool | ignoreCase, | |||
| TiXmlEncoding | encoding | |||
| ) | [static, protected] |
| int TiXmlBase::IsAlpha | ( | unsigned char | anyByte, | |
| TiXmlEncoding | encoding | |||
| ) | [static, protected] |
| int TiXmlBase::IsAlphaNum | ( | unsigned char | anyByte, | |
| TiXmlEncoding | encoding | |||
| ) | [static, protected] |
| static int TiXmlBase::ToLower | ( | int | v, | |
| TiXmlEncoding | encoding | |||
| ) | [inline, static, protected] |
| void TiXmlBase::ConvertUTF32ToUTF8 | ( | unsigned long | input, | |
| char * | output, | |||
| int * | length | |||
| ) | [static, protected] |
friend class TiXmlNode [friend] |
friend class TiXmlElement [friend] |
friend class TiXmlDocument [friend] |
Reimplemented in TiXmlNode.
const int TiXmlBase::utf8ByteTable [static] |
Initial value:
{
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
}
const char * TiXmlBase::errorString [static, protected] |
Initial value:
{
"No error",
"Error",
"Failed to open file",
"Memory allocation failed.",
"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.",
}
TiXmlCursor TiXmlBase::location [protected] |
void* TiXmlBase::userData [protected] |
Field containing a generic user pointer.
1.5.4