TiXmlBase is a base class for every class in TinyXml. More...

#include </home/andreas/Development/drewke.net/tdme2/ext/tinyxml/tinyxml.h>

Inheritance diagram for TiXmlBase:

Collaboration diagram for TiXmlBase:

Classes
struct	Entity

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 }

Public Member Functions
	TiXmlBase ()

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

int	Row () const
	Return the position, in the original source file, of this node or attribute. More...

int	Column () const
	See Row() More...

void	SetUserData (void *user)
	Set a pointer to arbitrary user data. More...

void *	GetUserData ()
	Get a pointer to arbitrary user data. More...

const void *	GetUserData () const
	Get a pointer to arbitrary user data. More...

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

Static Public Member Functions
static void	SetCondenseWhiteSpace (bool condense)
	The world does not agree on whether white space should be kept or not. More...

static bool	IsWhiteSpaceCondensed ()
	Return the current white space setting. More...

static void	EncodeString (const TIXML_STRING &str, TIXML_STRING *out)
	Expands entities in a string. More...

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 bool	StreamWhiteSpace (std::istream in, TIXML_STRING tag)

static bool	StreamTo (std::istream in, int character, TIXML_STRING tag)

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

Static Protected Attributes
static const char *	errorString [TIXML_ERROR_STRING_COUNT]

Private Types
enum	{ NUM_ENTITY = 5 , MAX_ENTITY_LENGTH = 6 }

Private Member Functions
	TiXmlBase (const TiXmlBase &)

void	operator= (const TiXmlBase &base)

Static Private Attributes
static Entity	entity [NUM_ENTITY]

static bool	condenseWhiteSpace = true

Friends
class	TiXmlNode

class	TiXmlElement

class	TiXmlDocument

Detailed Description

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)

Definition at line 169 of file tinyxml.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Enumerator
TIXML_NO_ERROR
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

Definition at line 239 of file tinyxml.h.

◆ anonymous enum

anonymous enum

private

Enumerator
NUM_ENTITY
MAX_ENTITY_LENGTH

Definition at line 379 of file tinyxml.h.

Constructor & Destructor Documentation

◆ TiXmlBase() [1/2]

TiXmlBase ( )

inline

Definition at line 176 of file tinyxml.h.

◆ ~TiXmlBase()

virtual ~TiXmlBase ( )

inlinevirtual

Definition at line 177 of file tinyxml.h.

◆ TiXmlBase() [2/2]

TiXmlBase ( const TiXmlBase & )

private

Member Function Documentation

◆ Print()

virtual void 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 TiXmlDocument, TiXmlUnknown, TiXmlDeclaration, TiXmlText, TiXmlComment, TiXmlElement, and TiXmlAttribute.

◆ SetCondenseWhiteSpace()

static void SetCondenseWhiteSpace ( bool condense )

inlinestatic

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.

Definition at line 196 of file tinyxml.h.

◆ IsWhiteSpaceCondensed()

static bool IsWhiteSpaceCondensed ( )

inlinestatic

Return the current white space setting.

Definition at line 199 of file tinyxml.h.

◆ Row()

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

See also: TiXmlDocument::SetTabSize()

Definition at line 219 of file tinyxml.h.

◆ Column()

int Column ( ) const

inline

See Row()

Definition at line 220 of file tinyxml.h.

◆ SetUserData()

void SetUserData ( void * user )

inline

Set a pointer to arbitrary user data.

Definition at line 222 of file tinyxml.h.

◆ GetUserData() [1/2]

void* GetUserData ( )

inline

Get a pointer to arbitrary user data.

Definition at line 223 of file tinyxml.h.

◆ GetUserData() [2/2]

const void* GetUserData ( ) const

inline

Get a pointer to arbitrary user data.

Definition at line 224 of file tinyxml.h.

◆ Parse()

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

pure virtual

Implemented in TiXmlDocument, TiXmlUnknown, TiXmlDeclaration, TiXmlText, TiXmlComment, TiXmlElement, and TiXmlAttribute.

◆ EncodeString()

void 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!

Definition at line 44 of file tinyxml.cpp.

◆ SkipWhiteSpace()

const char * SkipWhiteSpace	(	const char *	p,
		TiXmlEncoding	encoding
	)

staticprotected

Definition at line 314 of file tinyxmlparser.cpp.

◆ IsWhiteSpace() [1/2]

static bool IsWhiteSpace ( char c )

inlinestaticprotected

Definition at line 265 of file tinyxml.h.

◆ IsWhiteSpace() [2/2]

static bool IsWhiteSpace ( int c )

inlinestaticprotected

Definition at line 269 of file tinyxml.h.

◆ StreamWhiteSpace()

bool StreamWhiteSpace	(	std::istream *	in,
		TIXML_STRING *	tag
	)

staticprotected

Definition at line 364 of file tinyxmlparser.cpp.

◆ StreamTo()

bool StreamTo	(	std::istream *	in,
		int	character,
		TIXML_STRING *	tag
	)

staticprotected

Definition at line 379 of file tinyxmlparser.cpp.

◆ ReadName()

const char * ReadName	(	const char *	p,
		TIXML_STRING *	name,
		TiXmlEncoding	encoding
	)

staticprotected

Definition at line 399 of file tinyxmlparser.cpp.

◆ ReadText()

const char * ReadText	(	const char *	in,
		TIXML_STRING *	text,
		bool	ignoreWhiteSpace,
		const char *	endTag,
		bool	ignoreCase,
		TiXmlEncoding	encoding
	)

staticprotected

Definition at line 572 of file tinyxmlparser.cpp.

◆ GetEntity()

const char * GetEntity	(	const char *	in,
		char *	value,
		int *	length,
		TiXmlEncoding	encoding
	)

staticprotected

Definition at line 436 of file tinyxmlparser.cpp.

◆ GetChar()

static const char* GetChar	(	const char *	p,
		char *	_value,
		int *	length,
		TiXmlEncoding	encoding
	)

inlinestaticprotected

Definition at line 300 of file tinyxml.h.

◆ StringEqual()

bool StringEqual	(	const char *	p,
		const char *	endTag,
		bool	ignoreCase,
		TiXmlEncoding	encoding
	)

staticprotected

Definition at line 532 of file tinyxmlparser.cpp.

◆ IsAlpha()

int IsAlpha	(	unsigned char	anyByte,
		TiXmlEncoding	encoding
	)

staticprotected

Definition at line 126 of file tinyxmlparser.cpp.

◆ IsAlphaNum()

int IsAlphaNum	(	unsigned char	anyByte,
		TiXmlEncoding	encoding
	)

staticprotected

Definition at line 147 of file tinyxmlparser.cpp.

◆ ToLower()

static int ToLower	(	int	v,
		TiXmlEncoding	encoding
	)

inlinestaticprotected

Definition at line 355 of file tinyxml.h.

◆ ConvertUTF32ToUTF8()

void ConvertUTF32ToUTF8	(	unsigned long	input,
		char *	output,
		int *	length
	)

staticprotected

Definition at line 85 of file tinyxmlparser.cpp.

◆ operator=()

void operator= ( const TiXmlBase & base )

private

Friends And Related Function Documentation

◆ TiXmlNode

friend class TiXmlNode

friend

Definition at line 171 of file tinyxml.h.

◆ TiXmlElement

friend class TiXmlElement

friend

Definition at line 172 of file tinyxml.h.

◆ TiXmlDocument

friend class TiXmlDocument

friend

Definition at line 173 of file tinyxml.h.

Member Data Documentation

◆ utf8ByteTable

const int 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   
}

Definition at line 228 of file tinyxml.h.

◆ errorString

const char * errorString

staticprotected

Initial value:

=
{
    "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.",
}

Definition at line 344 of file tinyxml.h.

◆ location

TiXmlCursor location

protected

Definition at line 346 of file tinyxml.h.

◆ userData

void* userData

protected

Field containing a generic user pointer.

Definition at line 349 of file tinyxml.h.

◆ entity

TiXmlBase::Entity entity

staticprivate

Initial value:

=
{
    { "&amp;",  5, '&' },
    { "&lt;",   4, '<' },
    { "&gt;",   4, '>' },
    { "&quot;", 6, '\"' },
    { "&apos;", 6, '\'' }
}

Definition at line 385 of file tinyxml.h.

◆ condenseWhiteSpace

bool condenseWhiteSpace = true

staticprivate

Definition at line 386 of file tinyxml.h.

The documentation for this class was generated from the following files:

/home/andreas/Development/drewke.net/tdme2/ext/tinyxml/tinyxml.h
/home/andreas/Development/drewke.net/tdme2/ext/tinyxml/tinyxml.cpp
/home/andreas/Development/drewke.net/tdme2/ext/tinyxml/tinyxmlerror.cpp
/home/andreas/Development/drewke.net/tdme2/ext/tinyxml/tinyxmlparser.cpp

Classes

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Static Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Types

Private Member Functions

Static Private Attributes

Friends

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

◆ anonymous enum

Constructor & Destructor Documentation

◆ TiXmlBase() [1/2]

◆ ~TiXmlBase()

◆ TiXmlBase() [2/2]

Member Function Documentation

◆ Print()

◆ SetCondenseWhiteSpace()

◆ IsWhiteSpaceCondensed()

◆ Row()

◆ Column()

◆ SetUserData()

◆ GetUserData() [1/2]

◆ GetUserData() [2/2]

◆ Parse()

◆ EncodeString()

◆ SkipWhiteSpace()

◆ IsWhiteSpace() [1/2]

◆ IsWhiteSpace() [2/2]

◆ StreamWhiteSpace()

◆ StreamTo()

◆ ReadName()

◆ ReadText()

◆ GetEntity()

◆ GetChar()

◆ StringEqual()

◆ IsAlpha()

◆ IsAlphaNum()

◆ ToLower()

◆ ConvertUTF32ToUTF8()

◆ operator=()

Friends And Related Function Documentation

◆ TiXmlNode

◆ TiXmlElement

◆ TiXmlDocument

Member Data Documentation

◆ utf8ByteTable

◆ errorString

◆ location

◆ userData

◆ entity

◆ condenseWhiteSpace