Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages

TiXmlBase Class Reference

#include <tinyxml.h>

Inheritance diagram for TiXmlBase:

Inheritance graph
[legend]
Collaboration diagram for TiXmlBase:

Collaboration graph
[legend]
List of all members.

Public 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
}

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 Member Functions

virtual void StreamOut (TIXML_OSTREAM *) 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, 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 void PutString (const TIXML_STRING &str, TIXML_OSTREAM *out)
static void PutString (const TIXML_STRING &str, TIXML_STRING *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]

Friends

class TiXmlNode
class TiXmlElement
class TiXmlDocument

Classes

struct  Entity
class  StringToBuffer

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 133 of file tinyxml.h.


Member Enumeration Documentation

anonymous enum
 

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 

Definition at line 193 of file tinyxml.h.


Constructor & Destructor Documentation

TiXmlBase::TiXmlBase  )  [inline]
 

Definition at line 140 of file tinyxml.h.

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

Definition at line 141 of file tinyxml.h.


Member Function Documentation

int TiXmlBase::Column  )  const [inline]
 

See Row().

Definition at line 180 of file tinyxml.h.

References TiXmlCursor::col, and location.

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

Definition at line 78 of file tinyxmlparser.cpp.

Referenced by GetEntity().

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

Definition at line 260 of file tinyxml.h.

References GetEntity(), TIXML_ENCODING_UTF8, and utf8ByteTable.

Referenced by ReadText().

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

Definition at line 413 of file tinyxmlparser.cpp.

References ConvertUTF32ToUTF8(), TIXML_ENCODING_UTF8, and TIXML_STRING.

Referenced by GetChar().

void* TiXmlBase::GetUserData  )  [inline]
 

Definition at line 183 of file tinyxml.h.

References userData.

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

Definition at line 119 of file tinyxmlparser.cpp.

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

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

Definition at line 140 of file tinyxmlparser.cpp.

Referenced by ReadName().

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

Definition at line 227 of file tinyxml.h.

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

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

Return the current white space setting.

Definition at line 159 of file tinyxml.h.

Referenced by TiXmlElement::ReadValue().

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

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

void TiXmlBase::PutString const TIXML_STRING &  str,
TIXML_STRING *  out
[static, protected]
 

Definition at line 42 of file tinyxml.cpp.

void TiXmlBase::PutString const TIXML_STRING &  str,
TIXML_OSTREAM *  out
[static, protected]
 

Definition at line 35 of file tinyxml.cpp.

References TIXML_STRING.

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

const char * TiXmlBase::ReadName const char *  p,
TIXML_STRING *  name,
TiXmlEncoding  encoding
[static, protected]
 

Definition at line 383 of file tinyxmlparser.cpp.

References IsAlpha(), and IsAlphaNum().

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

const char * TiXmlBase::ReadText const char *  in,
TIXML_STRING *  text,
bool  ignoreWhiteSpace,
const char *  endTag,
bool  ignoreCase,
TiXmlEncoding  encoding
[static, protected]
 

Definition at line 549 of file tinyxmlparser.cpp.

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

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

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

Definition at line 179 of file tinyxml.h.

References location, and TiXmlCursor::row.

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.

Definition at line 156 of file tinyxml.h.

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

Definition at line 182 of file tinyxml.h.

References userData.

const char * TiXmlBase::SkipWhiteSpace const char *  ,
TiXmlEncoding  encoding
[static, protected]
 

Definition at line 301 of file tinyxmlparser.cpp.

References IsWhiteSpace(), TIXML_ENCODING_UTF8, TIXML_UTF_LEAD_0, TIXML_UTF_LEAD_1, and TIXML_UTF_LEAD_2.

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

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

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

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

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

Definition at line 509 of file tinyxmlparser.cpp.

References ToLower().

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

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

Definition at line 317 of file tinyxml.h.

References TIXML_ENCODING_UTF8.

Referenced by StringEqual().


Friends And Related Function Documentation

friend class TiXmlDocument [friend]
 

Reimplemented in TiXmlNode.

Definition at line 137 of file tinyxml.h.

friend class TiXmlElement [friend]
 

Reimplemented in TiXmlNode, and TiXmlText.

Definition at line 136 of file tinyxml.h.

friend class TiXmlNode [friend]
 

Definition at line 135 of file tinyxml.h.


Member Data Documentation

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

Definition at line 34 of file tinyxmlerror.cpp.

Referenced by TiXmlDocument::SetError().

TiXmlCursor TiXmlBase::location [protected]
 

Definition at line 308 of file tinyxml.h.

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.

Definition at line 311 of file tinyxml.h.

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

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       
}

Definition at line 56 of file tinyxmlparser.cpp.

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


The documentation for this class was generated from the following files:
Generated on Wed Sep 7 10:05:20 2005 for Crazy Eddies GUI System by  doxygen 1.4.3