class TiXmlBase

TiXmlBase is a base class for every class in TinyXml. More...

Contains pure virtuals
Full nameTelEngine::TiXmlBase
Definition#include <libs/yxml/tinyxml.h>
Inherited byTiXmlAttribute, TiXmlComment, TiXmlDeclaration, TiXmlDocument, TiXmlElement, TiXmlNode, TiXmlText, TiXmlUnknown, XMLParser
List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

Public Types

Public Methods

Public Static Methods

Public Members

Protected Types

Protected Static Methods

Protected 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.

@verbatim 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) @endverbatim

 TiXmlBase ()

TiXmlBase

 ~TiXmlBase ()

~TiXmlBase

[virtual]

void  Print ( FILE* cfile, int depth )

Print

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

void  SetCondenseWhiteSpace ( bool condense )

SetCondenseWhiteSpace

[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.

bool  IsWhiteSpaceCondensed ()

IsWhiteSpaceCondensed

[static]

int  Row ()

Row

[const]

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.

@sa TiXmlDocument::SetTabSize()

int  Column ()

Column

[const]

void  SetUserData ( void* user )

SetUserData

void*  GetUserData ()

GetUserData

static const int utf8ByteTable[256]

utf8ByteTable[256]

const char*  Parse (const char* p, TiXmlParsingData* data, TiXmlEncoding encoding )

Parse

[pure virtual]

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_INCOMPLETE, TIXML_ERROR_BUFFEROVERRUN, TIXML_ERROR_STRING_COUNT }

StringToBuffer (class)

StringToBuffer

[protected]

const char*  SkipWhiteSpace ( const char*, TiXmlEncoding encoding )

SkipWhiteSpace

[protected static]

inline bool  IsWhiteSpace ( char c )

IsWhiteSpace

[protected static]

inline bool  IsWhiteSpace ( int c )

IsWhiteSpace

[protected static]

void  StreamOut (TIXML_OSTREAM *, bool = false)

StreamOut

[const pure virtual]

bool  StreamWhiteSpace ( TIXML_ISTREAM * in, TIXML_STRING * tag )

StreamWhiteSpace

[protected static]

bool  StreamTo ( TIXML_ISTREAM * in, int character, TIXML_STRING * tag )

StreamTo

[protected static]

const char*  ReadName ( const char* p, TIXML_STRING* name, TiXmlEncoding encoding )

ReadName

[protected static]

const char*  ReadText (const char* in, TIXML_STRING* text, bool ignoreWhiteSpace, const char* endTag, bool ignoreCase, TiXmlEncoding encoding, bool* eof = 0)

ReadText

[protected static]

const char*  GetEntity ( const char* in, char* value, int* length, TiXmlEncoding encoding )

GetEntity

[protected static]

inline const char*  GetChar ( const char* p, char* _value, int* length, TiXmlEncoding encoding )

GetChar

[protected static]

void  PutString ( const TIXML_STRING& str, TIXML_OSTREAM* out )

PutString

[protected static]

void  PutString ( const TIXML_STRING& str, TIXML_STRING* out )

PutString

[protected static]

bool  StringEqual (const char* p, const char* endTag, bool ignoreCase, TiXmlEncoding encoding, bool* eof = 0)

StringEqual

[protected static]

static const char* errorString[ TIXML_ERROR_STRING_COUNT ]

errorString[ TIXML_ERROR_STRING_COUNT ]

[protected]

TiXmlCursor location

location

[protected]

void* userData

userData

[protected]

int  IsAlpha ( unsigned char anyByte, TiXmlEncoding encoding )

IsAlpha

[protected static]

int  IsAlphaNum ( unsigned char anyByte, TiXmlEncoding encoding )

IsAlphaNum

[protected static]

inline int  ToLower ( int v, TiXmlEncoding encoding )

ToLower

[protected static]

void  ConvertUTF32ToUTF8 ( unsigned long input, char* output, int* length )

ConvertUTF32ToUTF8

[protected static]


Generated by: paulc on bussard on Mon Mar 8 12:18:15 2010, using kdoc 2.0a54.