TiXmlBase is a base class for every class in TinyXml. 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 }

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 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]

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)

Inheritance diagram for omega::xml::TiXmlBase:

Member Enumeration Documentation

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

Constructor & Destructor Documentation

omega::xml::TiXmlBase::TiXmlBase ( )

inline

virtual omega::xml::TiXmlBase::~TiXmlBase ( )

inlinevirtual

Member Function Documentation

int omega::xml::TiXmlBase::Column ( ) const

inline

See Row()

static void omega::xml::TiXmlBase::ConvertUTF32ToUTF8	(	unsigned long	input,
		char *	output,
		int *	length
	)

staticprotected

static void omega::xml::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!

static const char* omega::xml::TiXmlBase::GetChar	(	const char *	p,
		char *	_value,
		int *	length,
		TiXmlEncoding	encoding
	)

inlinestaticprotected

static const char* omega::xml::TiXmlBase::GetEntity	(	const char *	in,
		char *	value,
		int *	length,
		TiXmlEncoding	encoding
	)

staticprotected

void* omega::xml::TiXmlBase::GetUserData ( )

inline

Get a pointer to arbitrary user data.

const void* omega::xml::TiXmlBase::GetUserData ( ) const

inline

Get a pointer to arbitrary user data.

static int omega::xml::TiXmlBase::IsAlpha	(	unsigned char	anyByte,
		TiXmlEncoding	encoding
	)

staticprotected

static int omega::xml::TiXmlBase::IsAlphaNum	(	unsigned char	anyByte,
		TiXmlEncoding	encoding
	)

staticprotected

static bool omega::xml::TiXmlBase::IsWhiteSpace ( char c )

inlinestaticprotected

static bool omega::xml::TiXmlBase::IsWhiteSpace ( int c )

inlinestaticprotected

static bool omega::xml::TiXmlBase::IsWhiteSpaceCondensed ( )

inlinestatic

Return the current white space setting.

virtual const char* omega::xml::TiXmlBase::Parse	(	const char *	p,
		TiXmlParsingData *	data,
		TiXmlEncoding	encoding
	)

pure virtual

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

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

static const char* omega::xml::TiXmlBase::ReadName	(	const char *	p,
		TIXML_STRING *	name,
		TiXmlEncoding	encoding
	)

staticprotected

static const char* omega::xml::TiXmlBase::ReadText	(	const char *	in,
		TIXML_STRING *	text,
		bool	ignoreWhiteSpace,
		const char *	endTag,
		bool	ignoreCase,
		TiXmlEncoding	encoding
	)

staticprotected

int omega::xml::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.

See also: TiXmlDocument::SetTabSize()

static void omega::xml::TiXmlBase::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.

void omega::xml::TiXmlBase::SetUserData ( void * user )

inline

Set a pointer to arbitrary user data.

static const char* omega::xml::TiXmlBase::SkipWhiteSpace	(	const char *	,
		TiXmlEncoding	encoding
	)

staticprotected

static bool omega::xml::TiXmlBase::StringEqual	(	const char *	p,
		const char *	endTag,
		bool	ignoreCase,
		TiXmlEncoding	encoding
	)

staticprotected

static int omega::xml::TiXmlBase::ToLower	(	int	v,
		TiXmlEncoding	encoding
	)

inlinestaticprotected

Friends And Related Function Documentation

friend class TiXmlDocument

friend

friend class TiXmlElement

friend

friend class TiXmlNode

friend

Member Data Documentation

const char* omega::xml::TiXmlBase::errorString[TIXML_ERROR_STRING_COUNT]

staticprotected

TiXmlCursor omega::xml::TiXmlBase::location

protected

void* omega::xml::TiXmlBase::userData

protected

Field containing a generic user pointer.

const int omega::xml::TiXmlBase::utf8ByteTable[256]

static

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

C:/dev/omegalib/release/src/omicron/include/omicron/xml/tinyxml.h

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Static Protected Member Functions

Protected Attributes

Static Protected Attributes

Friends

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation