Classes | Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Static Protected Member Functions | Protected Attributes | Static Protected Attributes | Private Types | Private Member Functions | Static Private Attributes | Friends
TiXmlBase Class Reference

#include <tinyxml.h>

Inheritance diagram for TiXmlBase:
Inheritance graph
[legend]

List of all members.

Classes

struct  Entity

Public Types

enum  {
  TIXML_NO_ERROR = 0, TIXML_ERROR, TIXML_ERROR_OPENING_FILE, 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_DOCUMENT_TOP_ONLY,
  TIXML_ERROR_STRING_COUNT
}

Public Member Functions

int Column () const
 See Row()
void * GetUserData ()
 Get a pointer to arbitrary user data.
const void * GetUserData () const
 Get a pointer to arbitrary user data.
virtual const char * Parse (const char *p, TiXmlParsingData *data, TiXmlEncoding encoding)=0
virtual void Print (FILE *cfile, int depth) const =0
int Row () const
void SetUserData (void *user)
 Set a pointer to arbitrary user data.
 TiXmlBase ()
virtual ~TiXmlBase ()

Static Public Member Functions

static void EncodeString (const TIXML_STRING &str, TIXML_STRING *out)
static bool IsWhiteSpaceCondensed ()
 Return the current white space setting.
static void SetCondenseWhiteSpace (bool condense)

Static Public Attributes

static const int utf8ByteTable [256]

Static Protected Member Functions

static void ConvertUTF32ToUTF8 (unsigned long input, char *output, int *length)
static const char * GetChar (const char *p, char *_value, int *length, TiXmlEncoding encoding)
static const char * GetEntity (const char *in, char *value, int *length, TiXmlEncoding encoding)
static int IsAlpha (unsigned char anyByte, TiXmlEncoding encoding)
static int IsAlphaNum (unsigned char anyByte, TiXmlEncoding encoding)
static bool IsWhiteSpace (char c)
static bool IsWhiteSpace (int 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 * SkipWhiteSpace (const char *, TiXmlEncoding encoding)
static bool StreamTo (std::istream *in, int character, TIXML_STRING *tag)
static bool StreamWhiteSpace (std::istream *in, TIXML_STRING *tag)
static bool StringEqual (const char *p, const char *endTag, bool ignoreCase, TiXmlEncoding encoding)
static int ToLower (int v, TiXmlEncoding encoding)

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

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

Static Private Attributes

static bool condenseWhiteSpace = true
static Entity entity [NUM_ENTITY]

Friends

class TiXmlDocument
class TiXmlElement
class 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)

Definition at line 199 of file tinyxml.h.

Member Enumeration Documentation

anonymous enum
Enumerator:
TIXML_NO_ERROR 
TIXML_ERROR 
TIXML_ERROR_OPENING_FILE 
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_DOCUMENT_TOP_ONLY 
TIXML_ERROR_STRING_COUNT 

Definition at line 269 of file tinyxml.h.

anonymous enum [private]
Enumerator:
NUM_ENTITY 
MAX_ENTITY_LENGTH 

Definition at line 411 of file tinyxml.h.

Constructor & Destructor Documentation

TiXmlBase::TiXmlBase ( ) [inline]

Definition at line 206 of file tinyxml.h.

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

Definition at line 207 of file tinyxml.h.

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

Member Function Documentation

int TiXmlBase::Column ( ) const [inline]

See Row()

Definition at line 250 of file tinyxml.h.

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

Definition at line 88 of file tinyxmlparser.cpp.

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

Expands entities in a string. Note this should not contian the tag's '<', '>', etc, or they will be transformed into entities!

Definition at line 52 of file tinyxml.cpp.

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

Definition at line 332 of file tinyxml.h.

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

Definition at line 438 of file tinyxmlparser.cpp.

void* TiXmlBase::GetUserData ( ) [inline]

Get a pointer to arbitrary user data.

Definition at line 253 of file tinyxml.h.

const void* TiXmlBase::GetUserData ( ) const [inline]

Get a pointer to arbitrary user data.

Definition at line 254 of file tinyxml.h.

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

Definition at line 129 of file tinyxmlparser.cpp.

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

Definition at line 150 of file tinyxmlparser.cpp.

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

Definition at line 295 of file tinyxml.h.

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

Definition at line 299 of file tinyxml.h.

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

Return the current white space setting.

Definition at line 229 of file tinyxml.h.

void TiXmlBase::operator= ( const TiXmlBase &  base) [private]
virtual const char* TiXmlBase::Parse ( const char *  p,
TiXmlParsingData *  data,
TiXmlEncoding  encoding 
) [pure virtual]

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

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

All TinyXml classes can print themselves to a filestream or the string class (TiXmlString in non-STL mode, std::string in STL mode.) Either or both cfile and str can be null.

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.

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

Definition at line 401 of file tinyxmlparser.cpp.

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

Definition at line 574 of file tinyxmlparser.cpp.

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

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

Definition at line 226 of file tinyxml.h.

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

Set a pointer to arbitrary user data.

Definition at line 252 of file tinyxml.h.

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

Definition at line 314 of file tinyxmlparser.cpp.

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

Definition at line 380 of file tinyxmlparser.cpp.

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

Definition at line 365 of file tinyxmlparser.cpp.

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

Definition at line 534 of file tinyxmlparser.cpp.

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

Definition at line 387 of file tinyxml.h.

Friends And Related Function Documentation

friend class TiXmlDocument [friend]

Reimplemented in TiXmlNode.

Definition at line 203 of file tinyxml.h.

friend class TiXmlElement [friend]

Reimplemented in TiXmlText, and TiXmlNode.

Definition at line 202 of file tinyxml.h.

friend class TiXmlNode [friend]

Definition at line 201 of file tinyxml.h.

Member Data Documentation

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

Definition at line 418 of file tinyxml.h.

TiXmlBase::Entity TiXmlBase::entity [static, private]
Initial value:
 
{
        { "&amp;",  5, '&' },
        { "&lt;",   4, '<' },
        { "&gt;",   4, '>' },
        { "&quot;", 6, '\"' },
        { "&apos;", 6, '\'' }
}

Definition at line 417 of file tinyxml.h.

const char * TiXmlBase::errorString [static, protected]
Initial value:
{
        "No error",
        "Error",
        "Failed to open file",
        "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.",
        "Error parsing CDATA.",
        "Error when TiXmlDocument added to document, because TiXmlDocument can only be at the root.",
}

Definition at line 376 of file tinyxml.h.

TiXmlCursor TiXmlBase::location [protected]

Definition at line 378 of file tinyxml.h.

void* TiXmlBase::userData [protected]

Field containing a generic user pointer.

Definition at line 381 of file tinyxml.h.

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

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

win_tinyxml
Author(s): Daniel Stonier
autogenerated on Mon Oct 6 2014 12:28:38