Digital Spaces Portal
Wiki
Forum
Bug Tracker

TiXmlBase Class Reference
[XML objects]

#include <TinyXML.h>

Inherited by TiXmlAttribute, and TiXmlNode.

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)

Public Member Functions

 TiXmlBase ()
virtual ~TiXmlBase ()
virtual void Print (FILE *cfile, int depth) const =0
 All TinyXml classes can print themselves to a filestream.
int Row () const
 Return the position, in the original source file, of this node or attribute.
int Column () const
 See Row().
void SetUserData (void *user)
void * GetUserData ()

Static Public Member Functions

static void SetCondenseWhiteSpace (bool condense)
 The world does not agree on whether white space should be kept or not.
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_STRING_COUNT
}

Protected Member Functions

virtual void StreamOut (TiXmlOutStream *) const =0
virtual const char * Parse (const char *p, TiXmlParsingData *data)=0

Static Protected Member Functions

static const char * SkipWhiteSpace (const char *)
static bool IsWhiteSpace (char c)
static const char * ReadName (const char *p, TiXmlString *name)
static const char * ReadText (const char *in, TiXmlString *text, bool ignoreWhiteSpace, const char *endTag, bool ignoreCase)
static const char * GetEntity (const char *in, char *value, int *length)
static const char * GetCharUTF8 (const char *p, char *_value, int *length)
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)
static int IsAlphaUTF8 (unsigned char anyByte)
static int IsAlphaNumUTF8 (unsigned char anyByte)
static int ToLowerUTF8 (int v)
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  { 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

Friends

class TiXmlNode
class TiXmlElement
class TiXmlDocument

Data Structures

struct  Entity
class  StringToBuffer

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_STRING_COUNT 

anonymous enum [private]

Enumerator:
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.

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.

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

Return the current white space setting.

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

int TiXmlBase::Column (  )  const [inline]

See Row().

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

void* TiXmlBase::GetUserData (  )  [inline]

static const char* TiXmlBase::SkipWhiteSpace ( const char *   )  [static, protected]

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

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

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

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

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

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

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

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

Referenced by GetCharUTF8().

static const char* TiXmlBase::GetCharUTF8 ( const char *  p,
char *  _value,
int *  length 
) [inline, static, protected]

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

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

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

static int TiXmlBase::IsAlphaUTF8 ( unsigned char  anyByte  )  [static, protected]

static int TiXmlBase::IsAlphaNumUTF8 ( unsigned char  anyByte  )  [static, protected]

static int TiXmlBase::ToLowerUTF8 ( int  v  )  [inline, static, protected]

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

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.

Field Documentation

const int TiXmlBase::utf8ByteTable[256] [static]

Referenced by GetCharUTF8().

const char* TiXmlBase::errorString[TIXML_ERROR_STRING_COUNT] [static, protected]

TiXmlCursor TiXmlBase::location [protected]

Referenced by Column(), and Row().

void* TiXmlBase::userData [protected]

Field containing a generic user pointer.

Referenced by TiXmlNode::CopyToClone(), GetUserData(), SetUserData(), and TiXmlBase().

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

bool TiXmlBase::condenseWhiteSpace [static, private]

Referenced by IsWhiteSpaceCondensed(), and SetCondenseWhiteSpace().

The documentation for this class was generated from the following file:
Generated on Sun Aug 31 17:46:28 2008 for Digital Spaces by  doxygen 1.5.6