TiXmlBase Class Reference

#include <tinyxml.h>

Inheritance diagram for TiXmlBase:

Collaboration diagram for TiXmlBase:

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

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

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

Member Enumeration Documentation

anonymous enum

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

anonymous enum

private

Enumerator
TINYXML_NUM_ENTITY
MAX_ENTITY_LENGTH

Constructor & Destructor Documentation

TiXmlBase() [1/2]

TiXmlBase::TiXmlBase ( )

inline

~TiXmlBase()

virtual TiXmlBase::~TiXmlBase ( )

inlinevirtual

References TiXmlDocument::Print().

Here is the call graph for this function:

TiXmlBase() [2/2]

TiXmlBase::TiXmlBase ( const TiXmlBase &  )

private

Member Function Documentation

Print()

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

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

Here is the caller graph for this function:

SetCondenseWhiteSpace()

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

References condenseWhiteSpace.

Referenced by ConcIndexatorInvoker::BuildIndexStart().

Here is the caller graph for this function:

IsWhiteSpaceCondensed()

static bool TiXmlBase::IsWhiteSpaceCondensed ( )

inlinestatic

Return the current white space setting.

References condenseWhiteSpace.

Referenced by TiXmlElement::ReadValue().

Here is the caller graph for this function:

Row()

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.

Column()

int TiXmlBase::Column ( ) const

inline

See Row()

References TiXmlCursor::col, and location.

SetUserData()

void TiXmlBase::SetUserData ( void *  user )

inline

References userData.

GetUserData()

void* TiXmlBase::GetUserData ( )

inline

References userData.

Parse()

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

pure virtual

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

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

Here is the caller graph for this function:

SkipWhiteSpace()

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

staticprotected

References IsWhiteSpace(), TIXML_ENCODING_UTF8, and TIXML_STRING.

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

Here is the call graph for this function:

Here is the caller graph for this function:

IsWhiteSpace()

static bool TiXmlBase::IsWhiteSpace ( char  c )

inlinestaticprotected

References TIXML_OSTREAM, and TIXML_STRING.

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

Here is the caller graph for this function:

StreamOut()

virtual void TiXmlBase::StreamOut ( TiXmlOutStream *  ) const

protectedpure virtual

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

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

Here is the caller graph for this function:

ReadName()

const char * TiXmlBase::ReadName ( const char *  p, TiXmlString *  name, TiXmlEncoding  encoding  )

staticprotected

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:

ReadText()

const char * TiXmlBase::ReadText ( const char *  in, TiXmlString *  text, bool  ignoreWhiteSpace, const char *  endTag, bool  ignoreCase, TiXmlEncoding  encoding  )

staticprotected

References condenseWhiteSpace, GetChar(), TiXmlNode::Identify(), IsWhiteSpace(), TiXmlDocument::SetError(), SkipWhiteSpace(), StringEqual(), TIXML_DEFAULT_ENCODING, TIXML_ENCODING_UNKNOWN, TIXML_ERROR, TIXML_ERROR_EMBEDDED_NULL, TIXML_ERROR_PARSING_EMPTY, TIXML_STRING, and TiXmlNode::ToElement().

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

Here is the call graph for this function:

Here is the caller graph for this function:

GetEntity()

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

staticprotected

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

Here is the call graph for this function:

GetChar()

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

inlinestaticprotected

References TIXML_ENCODING_UTF8, TIXML_OSTREAM, and TIXML_STRING.

Referenced by ReadText().

Here is the caller graph for this function:

PutString() [1/2]

void TiXmlBase::PutString ( const TiXmlString &  str, TiXmlOutStream *  out  )

staticprotected

References TIXML_STRING.

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

Here is the caller graph for this function:

PutString() [2/2]

void TiXmlBase::PutString ( const TiXmlString &  str, TiXmlString *  out  )

staticprotected

References entity.

StringEqual()

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

staticprotected

References ToLower().

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

Here is the call graph for this function:

Here is the caller graph for this function:

IsAlpha()

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

staticprotected

References TIXML_ENCODING_UTF8.

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

Here is the caller graph for this function:

IsAlphaNum()

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

staticprotected

References TIXML_ENCODING_UTF8.

Referenced by ReadName().

Here is the caller graph for this function:

ToLower()

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

inlinestaticprotected

References TIXML_ENCODING_UTF8.

Referenced by StringEqual().

Here is the caller graph for this function:

ConvertUTF32ToUTF8()

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

staticprotected

Referenced by GetEntity().

Here is the caller graph for this function:

operator=()

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

private

Friends And Related Function Documentation

TiXmlNode

friend class TiXmlNode

friend

TiXmlElement

friend class TiXmlElement

friend

Referenced by TiXmlNode::Identify().

TiXmlDocument

friend class TiXmlDocument

friend

Member Data Documentation

utf8ByteTable

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 TiXmlParsingData::Stamp().

errorString

const char * TiXmlBase::errorString

staticprotected

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

location

TiXmlCursor TiXmlBase::location

protected

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

userData

void* TiXmlBase::userData

protected

Field containing a generic user pointer.

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

entity

TiXmlBase::Entity TiXmlBase::entity

staticprivate

Initial value:

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

Referenced by GetEntity(), and PutString().

condenseWhiteSpace

bool TiXmlBase::condenseWhiteSpace = true

staticprivate

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

---

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

• tinyxml.h
• tinyxml.cpp
• tinyxmlerror.cpp
• tinyxmlparser.cpp