Class TiXmlBase

Nested Relationships

Nested Types

Inheritance Relationships

Derived Types

Class Documentation

class TiXmlBase

TiXmlBase is a base class for every class in TinyXml. It does little except to establish that TinyXml classes can be printed and provide some utility functions.

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)

Subclassed by TiXmlAttribute, TiXmlNode

Public Types

Values:

enumerator TIXML_NO_ERROR
enumerator TIXML_ERROR
enumerator TIXML_ERROR_OPENING_FILE
enumerator TIXML_ERROR_PARSING_ELEMENT
enumerator TIXML_ERROR_FAILED_TO_READ_ELEMENT_NAME
enumerator TIXML_ERROR_READING_ELEMENT_VALUE
enumerator TIXML_ERROR_READING_ATTRIBUTES
enumerator TIXML_ERROR_PARSING_EMPTY
enumerator TIXML_ERROR_READING_END_TAG
enumerator TIXML_ERROR_PARSING_UNKNOWN
enumerator TIXML_ERROR_PARSING_COMMENT
enumerator TIXML_ERROR_PARSING_DECLARATION
enumerator TIXML_ERROR_DOCUMENT_EMPTY
enumerator TIXML_ERROR_EMBEDDED_NULL
enumerator TIXML_ERROR_PARSING_CDATA
enumerator TIXML_ERROR_DOCUMENT_TOP_ONLY
enumerator TIXML_ERROR_STRING_COUNT

Public Functions

inline TiXmlBase()
inline virtual ~TiXmlBase()
virtual void Print(FILE *cfile, int depth) const = 0

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.)

inline int Row() const

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.

inline int Column() const

See Row()

inline void SetUserData(void *user)

Set a pointer to arbitrary user data.

inline void *GetUserData()

Get a pointer to arbitrary user data.

inline const void *GetUserData() const

Get a pointer to arbitrary user data.

virtual const char *Parse(const char *p, TiXmlParsingData *data, TiXmlEncoding encoding) = 0

Public Static Functions

static inline void SetCondenseWhiteSpace(bool condense)

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 inline bool IsWhiteSpaceCondensed()

Return the current white space setting.

static void EncodeString(const TIXML_STRING &str, TIXML_STRING *out)

Expands entities in a string. Note this should not contian the tag’s ‘<’, ‘>’, etc, or they will be transformed into entities!

Public Static Attributes

static const int utf8ByteTable[256]

Protected Attributes

TiXmlCursor location
void *userData

Field containing a generic user pointer.

Protected Static Functions

static const char *SkipWhiteSpace(const char*, TiXmlEncoding encoding)
static inline bool IsWhiteSpace(char c)
static inline 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 inline 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 inline int ToLower(int v, TiXmlEncoding encoding)
static void ConvertUTF32ToUTF8(unsigned long input, char *output, int *length)

Protected Static Attributes

static const char *errorString[TIXML_ERROR_STRING_COUNT]