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

#include <tinyxml.h>

Inheritance diagram for RTT::marsh::TiXmlBase:
Inheritance graph
[legend]

List of all members.

Classes

struct  Entity
class  StringToBuffer

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

Public Member Functions

int Column () const
 See Row()
void * GetUserData ()
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)
 TiXmlBase ()
virtual ~TiXmlBase ()

Static Public Member Functions

static bool IsWhiteSpaceCondensed ()
 Return the current white space setting.
static void SetCondenseWhiteSpace (bool condense)

Static Public Attributes

static const int utf8ByteTable [256]

Protected Member Functions

virtual void StreamOut (TIXML_OSTREAM *) const =0

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 void PutString (const TIXML_STRING &str, TIXML_OSTREAM *out)
static void PutString (const TIXML_STRING &str, TIXML_STRING *out)
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 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 189 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_PARSING_CDATA 
TIXML_ERROR_STRING_COUNT 

Definition at line 249 of file tinyxml.h.

anonymous enum [private]
Enumerator:
NUM_ENTITY 
MAX_ENTITY_LENGTH 

Definition at line 408 of file tinyxml.h.


Constructor & Destructor Documentation

Definition at line 196 of file tinyxml.h.

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

Definition at line 197 of file tinyxml.h.


Member Function Documentation

int RTT::marsh::TiXmlBase::Column ( ) const [inline]

See Row()

Definition at line 236 of file tinyxml.h.

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

Definition at line 127 of file tinyxmlparser.cpp.

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

Definition at line 323 of file tinyxml.h.

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

Definition at line 467 of file tinyxmlparser.cpp.

Definition at line 239 of file tinyxml.h.

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

Definition at line 168 of file tinyxmlparser.cpp.

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

Definition at line 189 of file tinyxmlparser.cpp.

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

Definition at line 284 of file tinyxml.h.

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

Definition at line 288 of file tinyxml.h.

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

Return the current white space setting.

Definition at line 215 of file tinyxml.h.

void RTT::marsh::TiXmlBase::operator= ( const TiXmlBase base) [private]
virtual const char* RTT::marsh::TiXmlBase::Parse ( const char *  p,
TiXmlParsingData data,
TiXmlEncoding  encoding 
) [pure virtual]
virtual void RTT::marsh::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 RTT::marsh::TiXmlDocument, RTT::marsh::TiXmlUnknown, RTT::marsh::TiXmlDeclaration, RTT::marsh::TiXmlText, RTT::marsh::TiXmlComment, RTT::marsh::TiXmlElement, and RTT::marsh::TiXmlAttribute.

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

Definition at line 75 of file tinyxml.cpp.

void RTT::marsh::TiXmlBase::PutString ( const TIXML_STRING str,
TIXML_STRING out 
) [static, protected]

Definition at line 82 of file tinyxml.cpp.

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

Definition at line 437 of file tinyxmlparser.cpp.

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

Definition at line 601 of file tinyxmlparser.cpp.

int RTT::marsh::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 235 of file tinyxml.h.

static void RTT::marsh::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 212 of file tinyxml.h.

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

Definition at line 238 of file tinyxml.h.

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

Definition at line 353 of file tinyxmlparser.cpp.

virtual void RTT::marsh::TiXmlBase::StreamOut ( TIXML_OSTREAM ) const [protected, pure virtual]
bool RTT::marsh::TiXmlBase::StringEqual ( const char *  p,
const char *  endTag,
bool  ignoreCase,
TiXmlEncoding  encoding 
) [static, protected]

Definition at line 561 of file tinyxmlparser.cpp.

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

Definition at line 384 of file tinyxml.h.


Friends And Related Function Documentation

friend class TiXmlDocument [friend]

Reimplemented in RTT::marsh::TiXmlNode.

Definition at line 193 of file tinyxml.h.

friend class TiXmlElement [friend]

Reimplemented in RTT::marsh::TiXmlText, and RTT::marsh::TiXmlNode.

Definition at line 192 of file tinyxml.h.

friend class TiXmlNode [friend]

Definition at line 191 of file tinyxml.h.


Member Data Documentation

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

Definition at line 415 of file tinyxml.h.

Initial value:
{
        { "&amp;",  5, '&' },
        { "&lt;",   4, '<' },
        { "&gt;",   4, '>' },
        { "&quot;", 6, '\"' },
        { "&apos;", 6, '\'' }
}

Definition at line 414 of file tinyxml.h.

const char * RTT::marsh::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.",
        "Error parsing CDATA.",
}

Definition at line 373 of file tinyxml.h.

Definition at line 375 of file tinyxml.h.

Field containing a generic user pointer.

Definition at line 378 of file tinyxml.h.

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


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


rtt
Author(s): RTT Developers
autogenerated on Thu Jan 2 2014 11:35:44