#include <tinyxml.h>

Inheritance diagram for TiXmlBase:

[legend]

Collaboration diagram for TiXmlBase:

[legend]

List of all members.

Classes

struct Entity
class StringToBuffer

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)
void * GetUserData ()
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 Public Attributes

static const int utf8ByteTable [256]

Protected 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_STRING_COUNT
}

Protected Member Functions

virtual void StreamOut (TiXmlOutStream *) const =0

Static Protected Member Functions

static const char * SkipWhiteSpace (const char *, TiXmlEncoding encoding)
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 * GetEntity (const char *in, char *value, int *length, TiXmlEncoding encoding)
static const char * GetChar (const char *p, char *_value, int *length, TiXmlEncoding encoding)
static void PutString (const TiXmlString &str, TiXmlOutStream *out)
static void PutString (const TiXmlString &str, TiXmlString *out)
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]

Private Types

enum { TINYXML_NUM_ENTITY = 5, MAX_ENTITY_LENGTH = 6 }

Private Member Functions

TiXmlBase (const TiXmlBase &)
void operator= (const TiXmlBase &base)

Static Private Attributes

static Entity entity [TINYXML_NUM_ENTITY]
static bool condenseWhiteSpace = true

Friends

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)

Member Enumeration Documentation

anonymous enum [protected]

Enumerator:

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

anonymous enum [private]

Enumerator:

TINYXML_NUM_ENTITY
MAX_ENTITY_LENGTH

Constructor & Destructor Documentation

TiXmlBase::TiXmlBase ( ) [inline]

virtual TiXmlBase::~TiXmlBase ( ) [inline, virtual]

TiXmlBase::TiXmlBase ( const TiXmlBase & ) [private]

Member Function Documentation

virtual void TiXmlBase::Print	(	FILE *	cfile,
		int	depth
	)			const `[pure virtual]`

All TinyXml classes can print themselves to a filestream. 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.

Referenced by TiXmlDocument::Print(), and TiXmlElement::Print().

Here is the caller graph for this function:

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 values is not thread safe.

References condenseWhiteSpace.

Referenced by CConcIndexatorInvoker::BuildIndex(), and CRusCorpXmlFile::CRusCorpXmlFile().

Here is the caller graph for this function:

static bool TiXmlBase::IsWhiteSpaceCondensed ( ) [inline, static]

Return the current white space setting.

References condenseWhiteSpace.

Referenced by TiXmlElement::ReadValue().

Here is the caller graph for this function:

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.

See also:: TiXmlDocument::SetTabSize()

References location, and TiXmlCursor::row.

int TiXmlBase::Column ( ) const [inline]

See Row().

References TiXmlCursor::col, and location.

void TiXmlBase::SetUserData ( void * user ) [inline]

References userData.

void* TiXmlBase::GetUserData ( ) [inline]

References userData.

virtual const char* TiXmlBase::Parse	(	const char *	p,
		TiXmlParsingData *	data,
		TiXmlEncoding	encoding
	)			`[pure virtual]`

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

Referenced by TiXmlDocument::Parse(), and TiXmlElement::ReadValue().

Here is the caller graph for this function:

const char * TiXmlBase::SkipWhiteSpace	(	const char *	p,
		TiXmlEncoding	encoding
	)			`[static, protected]`

References IsWhiteSpace(), and TIXML_ENCODING_UTF8.

Referenced by TiXmlNode::Identify(), TiXmlDeclaration::Parse(), TiXmlAttribute::Parse(), TiXmlComment::Parse(), TiXmlUnknown::Parse(), TiXmlElement::Parse(), TiXmlDocument::Parse(), ReadText(), and TiXmlElement::ReadValue().

Here is the call graph for this function:

Here is the caller graph for this function:

static bool TiXmlBase::IsWhiteSpace ( char c ) [inline, static, protected]

Referenced by TiXmlText::Blank(), TiXmlDeclaration::Parse(), TiXmlAttribute::Parse(), TiXmlElement::Parse(), ReadText(), and SkipWhiteSpace().

Here is the caller graph for this function:

virtual void TiXmlBase::StreamOut ( TiXmlOutStream * ) const [protected, pure virtual]

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

Referenced by operator<<(), TiXmlDocument::StreamOut(), and TiXmlElement::StreamOut().

Here is the caller graph for this function:

const char * TiXmlBase::ReadName	(	const char *	p,
		TiXmlString *	name,
		TiXmlEncoding	encoding
	)			`[static, protected]`

References IsAlpha(), and IsAlphaNum().

Referenced by TiXmlAttribute::Parse(), and TiXmlElement::Parse().

Here is the call graph for this function:

Here is the caller graph for this function:

const char * TiXmlBase::ReadText	(	const char *	in,
		TiXmlString *	text,
		bool	ignoreWhiteSpace,
		const char *	endTag,
		bool	ignoreCase,
		TiXmlEncoding	encoding
	)			`[static, protected]`

References condenseWhiteSpace, GetChar(), IsWhiteSpace(), SkipWhiteSpace(), and StringEqual().

Referenced by TiXmlText::Parse(), TiXmlAttribute::Parse(), and TiXmlComment::Parse().

Here is the call graph for this function:

Here is the caller graph for this function:

const char * TiXmlBase::GetEntity	(	const char *	in,
		char *	value,
		int *	length,
		TiXmlEncoding	encoding
	)			`[static, protected]`

References TiXmlBase::Entity::chr, ConvertUTF32ToUTF8(), entity, TiXmlBase::Entity::strLength, TIXML_ENCODING_UTF8, and TIXML_STRING.

Referenced by GetChar().

Here is the call graph for this function:

Here is the caller graph for this function:

static const char* TiXmlBase::GetChar	(	const char *	p,
		char *	_value,
		int *	length,
		TiXmlEncoding	encoding
	)			`[inline, static, protected]`

References GetEntity(), TIXML_ENCODING_UTF8, and utf8ByteTable.

Referenced by ReadText().

Here is the call graph for this function:

Here is the caller graph for this function:

void TiXmlBase::PutString	(	const TiXmlString &	str,
		TiXmlOutStream *	out
	)			`[static, protected]`

References TIXML_STRING.

Referenced by TiXmlText::Print(), TiXmlAttribute::Print(), TiXmlDeclaration::StreamOut(), TiXmlText::StreamOut(), and TiXmlAttribute::StreamOut().

Here is the caller graph for this function:

void TiXmlBase::PutString	(	const TiXmlString &	str,
		TiXmlString *	out
	)			`[static, protected]`

References entity.

bool TiXmlBase::StringEqual	(	const char *	p,
		const char *	endTag,
		bool	ignoreCase,
		TiXmlEncoding	encoding
	)			`[static, protected]`

References ToLower().

Referenced by TiXmlNode::Identify(), TiXmlDeclaration::Parse(), TiXmlComment::Parse(), TiXmlElement::Parse(), TiXmlDocument::Parse(), ReadText(), and TiXmlElement::ReadValue().

Here is the call graph for this function:

Here is the caller graph for this function:

int TiXmlBase::IsAlpha	(	unsigned char	anyByte,
		TiXmlEncoding	encoding
	)			`[static, protected]`

References TIXML_ENCODING_UTF8.

Referenced by TiXmlNode::Identify(), and ReadName().

Here is the caller graph for this function:

int TiXmlBase::IsAlphaNum	(	unsigned char	anyByte,
		TiXmlEncoding	encoding
	)			`[static, protected]`

References TIXML_ENCODING_UTF8.

Referenced by ReadName().

Here is the caller graph for this function:

static int TiXmlBase::ToLower	(	int	v,
		TiXmlEncoding	encoding
	)			`[inline, static, protected]`

References TIXML_ENCODING_UTF8.

Referenced by StringEqual().

Here is the caller graph for this function:

void TiXmlBase::ConvertUTF32ToUTF8	(	unsigned long	input,
		char *	output,
		int *	length
	)			`[static, protected]`

Referenced by GetEntity().

Here is the caller graph for this function:

void TiXmlBase::operator= ( const TiXmlBase & base ) [private]

Friends And Related Function Documentation

friend class TiXmlNode [friend]

friend class TiXmlElement [friend]

Reimplemented in TiXmlNode, and TiXmlText.

friend class TiXmlDocument [friend]

Reimplemented in TiXmlNode.

Member Data Documentation

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       
}

Referenced by GetChar(), and TiXmlParsingData::Stamp().

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

Referenced by TiXmlDocument::SetError().

TiXmlCursor TiXmlBase::location [protected]

Referenced by Column(), TiXmlDocument::LoadFile(), TiXmlDeclaration::Parse(), TiXmlText::Parse(), TiXmlAttribute::Parse(), TiXmlComment::Parse(), TiXmlUnknown::Parse(), TiXmlElement::Parse(), TiXmlDocument::Parse(), and Row().

void* TiXmlBase::userData [protected]

Field containing a generic user pointer.

Referenced by TiXmlNode::CopyTo(), GetUserData(), and SetUserData().

TiXmlBase::Entity TiXmlBase::entity [static, private]

Initial value:

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

Referenced by GetEntity(), and PutString().

bool TiXmlBase::condenseWhiteSpace = true [static, private]

Referenced by IsWhiteSpaceCondensed(), ReadText(), and SetCondenseWhiteSpace().

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

TiXmlBase Class Reference

Classes

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Types

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Types

Private Member Functions

Static Private Attributes

Friends

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation