interreality.org [VOS]
[Home] [About]
[Screenshots]
 [Download]
[News]
 [Community]
[Documentation] [Manual]
[Bugs & Requests] [Wiki]

TiXmlBase Class Reference

#include <tinyxml.hh>

Inheritance diagram for TiXmlBase:

TiXmlAttribute TiXmlNode TiXmlComment TiXmlDeclaration TiXmlDocument TiXmlElement TiXmlText TiXmlUnknown List of all members.

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 157 of file tinyxml.hh.

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Static Protected Attributes

Friends

Classes

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_PARSING_CDATA 
TIXML_ERROR_STRING_COUNT 

Definition at line 217 of file tinyxml.hh.

Constructor & Destructor Documentation

TiXmlBase::TiXmlBase (  )  [inline]

Definition at line 164 of file tinyxml.hh.

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

Definition at line 165 of file tinyxml.hh.

Member Function Documentation

int TiXmlBase::Column (  )  const [inline]

See Row().

Definition at line 204 of file tinyxml.hh.

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

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

Definition at line 285 of file tinyxml.hh.

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

void* TiXmlBase::GetUserData (  )  [inline]

Definition at line 207 of file tinyxml.hh.

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

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

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

Definition at line 252 of file tinyxml.hh.

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

Return the current white space setting.

Definition at line 183 of file tinyxml.hh.

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

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

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

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

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

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

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

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 203 of file tinyxml.hh.

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 180 of file tinyxml.hh.

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

Definition at line 206 of file tinyxml.hh.

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

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

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

static bool TiXmlBase::StreamTo ( TIXML_ISTREAM *  in,
int  character,
TIXML_STRING *  tag 
) [static, protected]

static bool TiXmlBase::StreamWhiteSpace ( TIXML_ISTREAM *  in,
TIXML_STRING *  tag 
) [static, protected]

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

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

Definition at line 346 of file tinyxml.hh.

Friends And Related Function Documentation

friend class TiXmlDocument [friend]

Reimplemented in TiXmlNode.

Definition at line 161 of file tinyxml.hh.

friend class TiXmlElement [friend]

Reimplemented in TiXmlNode, and TiXmlText.

Definition at line 160 of file tinyxml.hh.

friend class TiXmlNode [friend]

Definition at line 159 of file tinyxml.hh.

Member Data Documentation

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

Definition at line 335 of file tinyxml.hh.

TiXmlCursor TiXmlBase::location [protected]

Definition at line 337 of file tinyxml.hh.

Referenced by Column(), and Row().

void* TiXmlBase::userData [protected]

Field containing a generic user pointer.

Definition at line 340 of file tinyxml.hh.

Referenced by GetUserData(), and SetUserData().

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

Definition at line 211 of file tinyxml.hh.

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