TiXmlBase Class Reference

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

#include <tinyxml.h>

Inheritance diagram for TiXmlBase:

Collaboration diagram for TiXmlBase:

Classes
struct	Entity

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_nullptr , TIXML_ERROR_PARSING_CDATA ,   TIXML_ERROR_DOCUMENT_TOP_ONLY , TIXML_ERROR_STRING_COUNT }

Public Member Functions
	TiXmlBase ()
virtual	~TiXmlBase ()
virtual void	Print (FILE *cfile, int depth) const =0
	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.
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)
	Set a pointer to arbitrary user data.
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
void	DeleteSpawnedWrappers ()
	Delete all container objects we've spawned with 'new'.

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 void	EncodeString (const TIXML_STRING &str, TIXML_STRING *out)
	Expands entities in a string.

Public Attributes
std::vector< ticpp::Base * >	m_spawnedWrappers
	Remember all wrappers that we've created with 'new' - ( e.g.

Static Public Attributes
static const int	utf8ByteTable [256]

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

Private Attributes
TiCppRCImp *	m_tiRC
	Pointer to reference counter.

Static Private Attributes
static Entity	entity [NUM_ENTITY]
static bool	condenseWhiteSpace = true

Friends
class	TiXmlNode
class	TiXmlElement
class	TiXmlDocument

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

Member Enumeration Documentation

anonymous enum

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_nullptr
TIXML_ERROR_PARSING_CDATA
TIXML_ERROR_DOCUMENT_TOP_ONLY
TIXML_ERROR_STRING_COUNT

Definition at line 304 of file tinyxml.h.

       {
    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_nullptr,
    TIXML_ERROR_PARSING_CDATA,
    TIXML_ERROR_DOCUMENT_TOP_ONLY,
 
    TIXML_ERROR_STRING_COUNT
  };

anonymous enum

anonymous enum

private

Enumerator
NUM_ENTITY
MAX_ENTITY_LENGTH

Definition at line 439 of file tinyxml.h.

       {
    NUM_ENTITY = 5,
    MAX_ENTITY_LENGTH = 6
 
  };

Constructor & Destructor Documentation

TiXmlBase() [1/2]

TiXmlBase::TiXmlBase ( )

inline

Definition at line 221 of file tinyxml.h.

      : userData(0) {}

References userData.

Referenced by TiXmlAttribute::TiXmlAttribute(), TiXmlBase(), TiXmlNode::TiXmlNode(), and operator=().

Here is the caller graph for this function:

~TiXmlBase()

virtual TiXmlBase::~TiXmlBase ( )

inlinevirtual

Definition at line 223 of file tinyxml.h.

{}

TiXmlBase() [2/2]

TiXmlBase::TiXmlBase ( const TiXmlBase & )

private

References TiXmlBase().

Here is the call graph for this function:

Member Function Documentation

Column()

int TiXmlBase::Column ( ) const

inline

See Row().

Definition at line 276 of file tinyxml.h.

References location.

Referenced by ticpp::Base::Column().

Here is the caller graph for this function:

ConvertUTF32ToUTF8()

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

staticprotected

Definition at line 100 of file tinyxmlparser.cpp.

                                                         {
  const unsigned long BYTE_MASK = 0xBF;
  const unsigned long BYTE_MARK = 0x80;
  const unsigned long FIRST_BYTE_MARK[7] = {
    0x00, 0x00, 0xC0, 0xE0, 0xF0, 0xF8, 0xFC};
 
  if (input < 0x80)
    *length = 1;
  else if (input < 0x800)
    *length = 2;
  else if (input < 0x10000)
    *length = 3;
  else if (input < 0x200000)
    *length = 4;
  else {
    *length = 0;
    return;
  }  // This code won't covert this correctly anyway.
 
  output += *length;
 
  // Scary scary fall throughs.
  switch (*length) {
    case 4:
      --output;
      *output = (char)((input | BYTE_MARK) & BYTE_MASK);
      input >>= 6;
 
    case 3:
      --output;
      *output = (char)((input | BYTE_MARK) & BYTE_MASK);
      input >>= 6;
 
    case 2:
      --output;
      *output = (char)((input | BYTE_MARK) & BYTE_MASK);
      input >>= 6;
 
    case 1:
      --output;
      *output = (char)(input | FIRST_BYTE_MARK[*length]);
  }
}

Referenced by GetEntity().

Here is the caller graph for this function:

DeleteSpawnedWrappers()

void TiCppRC::DeleteSpawnedWrappers ( )

inherited

Delete all container objects we've spawned with 'new'.

Definition at line 929 of file ticpp.cpp.

                                    {
  std::vector< Base* >::reverse_iterator wrapper;
 
  for (wrapper = m_spawnedWrappers.rbegin(); wrapper != m_spawnedWrappers.rend();
       ++wrapper) {
    delete *wrapper;
  }
 
  m_spawnedWrappers.clear();
}

References m_spawnedWrappers.

EncodeString()

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 50 of file tinyxml.cpp.

                                                                             {
  int i = 0;
 
  while (i < (int)str.length()) {
    unsigned char c = (unsigned char)str[i];
 
    if (c == '&' && i < ((int)str.length() - 2) && str[i + 1] == '#' &&
        str[i + 2] == 'x') {
      // Hexadecimal character reference.
      // Pass through unchanged.
      // &#xA9; -- copyright symbol, for example.
      //
      // The -1 is a bug fix from Rob Laveaux. It keeps
      // an overflow from happening if there is no ';'.
      // There are actually 2 ways to exit this loop -
      // while fails (error case) and break (semicolon found).
      // However, there is no mechanism (currently) for
      // this function to return an error.
      while (i < (int)str.length() - 1) {
        outString->append(str.c_str() + i, 1);
        ++i;
 
        if (str[i] == ';') break;
      }
    } else if (c == '&') {
      outString->append(entity[0].str, entity[0].strLength);
      ++i;
    } else if (c == '<') {
      outString->append(entity[1].str, entity[1].strLength);
      ++i;
    } else if (c == '>') {
      outString->append(entity[2].str, entity[2].strLength);
      ++i;
    } else if (c == '\"') {
      outString->append(entity[3].str, entity[3].strLength);
      ++i;
    } else if (c == '\'') {
      outString->append(entity[4].str, entity[4].strLength);
      ++i;
    } else if (c < 32) {
      // Easy pass at non-alpha/numeric/symbol
      // Below 32 is symbolic.
      char buf[32];
 
#if defined(TIXML_SNPRINTF)
      TIXML_SNPRINTF(buf, sizeof(buf), "&#x%02X;", (unsigned)(c & 0xff));
#else
      snprintf(buf, 32, "&#x%02X;", (unsigned)(c & 0xff));
#endif
 
      //*ME:  warning C4267: convert 'size_t' to 'int'
      //*ME:  Int-Cast to make compiler happy ...
      outString->append(buf, (int)strlen(buf));
      ++i;
    } else {
      // char realc = (char) c;
      // outString->append( &realc, 1 );
      *outString += (char)c;  // somewhat more efficient function call.
      ++i;
    }
  }
}

References entity, and TIXML_STRING.

Referenced by TiXmlAttribute::Print(), TiXmlText::Print(), and TiXmlPrinter::Visit().

Here is the caller graph for this function:

GetChar()

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

inlinestaticprotected

Definition at line 368 of file tinyxml.h.

                                                                            {
    assert(p);
 
    if (encoding == TIXML_ENCODING_UTF8) {
      *length = utf8ByteTable[*((const unsigned char*)p)];
      assert(*length >= 0 && *length < 5);
    } else {
      *length = 1;
    }
 
    if (*length == 1) {
      if (*p == '&') return GetEntity(p, _value, length, encoding);
 
      *_value = *p;
      return p + 1;
    } else if (*length) {
      // strncpy( _value, p, *length );  // lots of compilers don't like this
      // function (unsafe),
      // and the null terminator isn't needed
      for (int i = 0; p[i] && i < *length; ++i) {
        _value[i] = p[i];
      }
 
      return p + (*length);
    } else {
      // Not valid text.
      return 0;
    }
  }

References GetEntity(), TIXML_ENCODING_UTF8, and utf8ByteTable.

Referenced by ReadText().

Here is the call graph for this function:

Here is the caller graph for this function:

GetEntity()

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

staticprotected

Definition at line 442 of file tinyxmlparser.cpp.

                                                         {
  // Presume an entity, and pull it out.
  TIXML_STRING ent;
  int          i;
  *length = 0;
 
  if (*(p + 1) && *(p + 1) == '#' && *(p + 2)) {
    unsigned long ucs = 0;
    ptrdiff_t     delta = 0;
    unsigned      mult = 1;
 
    if (*(p + 2) == 'x') {
      // Hexadecimal.
      if (!*(p + 3)) return 0;
 
      const char* q = p + 3;
      q = strchr(q, ';');
 
      if (!q || !*q) return 0;
 
      delta = q - p;
      --q;
 
      while (*q != 'x') {
        if (*q >= '0' && *q <= '9')
          ucs += mult * (*q - '0');
        else if (*q >= 'a' && *q <= 'f')
          ucs += mult * (*q - 'a' + 10);
        else if (*q >= 'A' && *q <= 'F')
          ucs += mult * (*q - 'A' + 10);
        else
          return 0;
 
        mult *= 16;
        --q;
      }
    } else {
      // Decimal.
      if (!*(p + 2)) return 0;
 
      const char* q = p + 2;
      q = strchr(q, ';');
 
      if (!q || !*q) return 0;
 
      delta = q - p;
      --q;
 
      while (*q != '#') {
        if (*q >= '0' && *q <= '9')
          ucs += mult * (*q - '0');
        else
          return 0;
 
        mult *= 10;
        --q;
      }
    }
 
    if (encoding == TIXML_ENCODING_UTF8) {
      // convert the UCS to UTF-8
      ConvertUTF32ToUTF8(ucs, value, length);
    } else {
      *value = (char)ucs;
      *length = 1;
    }
 
    return p + delta + 1;
  }
 
  // Now try to match it.
  for (i = 0; i < NUM_ENTITY; ++i) {
    if (strncmp(entity[i].str, p, entity[i].strLength) == 0) {
      assert(strlen(entity[i].str) == entity[i].strLength);
      *value = entity[i].chr;
      *length = 1;
      return (p + entity[i].strLength);
    }
  }
 
  // So it wasn't an entity, its unrecognized, or something like that.
  *value = *p;  // Don't put back the last one, since we return it!
  //*length = 1;  // Leave unrecognized entities - this doesn't really work.
  // Just writes strange XML.
  return p + 1;
}

References ConvertUTF32ToUTF8(), entity, NUM_ENTITY, TIXML_ENCODING_UTF8, and TIXML_STRING.

Referenced by GetChar().

Here is the call graph for this function:

Here is the caller graph for this function:

GetUserData() [1/2]

void * TiXmlBase::GetUserData ( )

inline

Get a pointer to arbitrary user data.

Definition at line 281 of file tinyxml.h.

References userData.

GetUserData() [2/2]

const void * TiXmlBase::GetUserData ( ) const

inline

Get a pointer to arbitrary user data.

Definition at line 284 of file tinyxml.h.

References userData.

IsAlpha()

int TiXmlBase::IsAlpha ( unsigned char anyByte, TiXmlEncoding encoding )

staticprotected

Definition at line 146 of file tinyxmlparser.cpp.

                                                   {
  // This will only work for low-ascii, everything else is assumed to be a valid
  // letter. I'm not sure this is the best approach, but it is quite tricky
  // trying
  // to figure out alhabetical vs. not across encoding. So take a very
  // conservative approach.
 
  //  if ( encoding == TIXML_ENCODING_UTF8 )
  //  {
  if (anyByte < 127)
    return isalpha(anyByte);
  else
    return 1;  // What else to do? The unicode set is huge...get the english
               // ones
               // right.
 
  //  }
  //  else
  //  {
  //    return isalpha( anyByte );
  //  }
}

Referenced by TiXmlNode::Identify(), and ReadName().

Here is the caller graph for this function:

IsAlphaNum()

int TiXmlBase::IsAlphaNum ( unsigned char anyByte, TiXmlEncoding encoding )

staticprotected

Definition at line 170 of file tinyxmlparser.cpp.

                                                      {
  // This will only work for low-ascii, everything else is assumed to be a valid
  // letter. I'm not sure this is the best approach, but it is quite tricky
  // trying
  // to figure out alhabetical vs. not across encoding. So take a very
  // conservative approach.
 
  //  if ( encoding == TIXML_ENCODING_UTF8 )
  //  {
  if (anyByte < 127)
    return isalnum(anyByte);
  else
    return 1;  // What else to do? The unicode set is huge...get the english
               // ones
               // right.
 
  //  }
  //  else
  //  {
  //    return isalnum( anyByte );
  //  }
}

Referenced by ReadName().

Here is the caller graph for this function:

IsWhiteSpace() [1/2]

bool TiXmlBase::IsWhiteSpace ( char c )

inlinestaticprotected

Definition at line 328 of file tinyxml.h.

                                          {
    return (std::isspace((unsigned char)c) || c == '\n' || c == '\r');
  }

Referenced by TiXmlText::Blank(), IsWhiteSpace(), TiXmlAttribute::Parse(), TiXmlDeclaration::Parse(), TiXmlStylesheetReference::Parse(), ReadText(), SkipWhiteSpace(), TiXmlElement::StreamIn(), and StreamWhiteSpace().

Here is the caller graph for this function:

IsWhiteSpace() [2/2]

bool TiXmlBase::IsWhiteSpace ( int c )

inlinestaticprotected

Definition at line 331 of file tinyxml.h.

                                         {
    if (c < 256) return IsWhiteSpace((char)c);
 
    return false;  // Again, only truly correct for English/Latin...but usually
                   // works.
  }

References IsWhiteSpace().

Here is the call graph for this function:

IsWhiteSpaceCondensed()

bool TiXmlBase::IsWhiteSpaceCondensed ( )

inlinestatic

Return the current white space setting.

Definition at line 247 of file tinyxml.h.

{ return condenseWhiteSpace; }

References condenseWhiteSpace.

Referenced by TiXmlElement::ReadValue().

Here is the caller graph for this function:

operator=()

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

private

References TiXmlBase().

Here is the call graph for this function:

Parse()

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

pure virtual

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

References TIXML_STRING.

Referenced by TiXmlNode::operator>>, TiXmlDocument::Parse(), and TiXmlElement::ReadValue().

Here is the caller graph for this function:

Print()

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 TiXmlAttribute, TiXmlComment, TiXmlDeclaration, TiXmlDocument, TiXmlElement, TiXmlStylesheetReference, TiXmlText, and TiXmlUnknown.

Referenced by TiXmlElement::Print().

Here is the caller graph for this function:

ReadName()

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

staticprotected

Definition at line 409 of file tinyxmlparser.cpp.

                                                                             {
  // Oddly, not supported on some comilers,
  // name->clear();
  // So use this:
  *name = "";
  assert(p);
 
  // Names start with letters or underscores.
  // Of course, in unicode, tinyxml has no idea what a letter *is*. The
  // algorithm is generous.
  //
  // After that, they can be letters, underscores, numbers,
  // hyphens, or colons. (Colons are valid ony for namespaces,
  // but tinyxml can't tell namespaces from names.)
  if (p && *p && (IsAlpha((unsigned char)*p, encoding) || *p == '_')) {
    const char* start = p;
 
    while (p && *p && (IsAlphaNum((unsigned char)*p, encoding) || *p == '_' ||
                       *p == '-' || *p == '.' || *p == ':')) {
      //(*name) += *p; // expensive
      ++p;
    }
 
    if (p - start > 0) {
      name->assign(start, p - start);
    }
 
    return p;
  }
 
  return 0;
}

References IsAlpha(), IsAlphaNum(), and TIXML_STRING.

Referenced by TiXmlAttribute::Parse(), and TiXmlElement::Parse().

Here is the call graph for this function:

Here is the caller graph for this function:

ReadText()

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

staticprotected

Definition at line 566 of file tinyxmlparser.cpp.

                                                        {
  *text = "";
 
  if (!trimWhiteSpace  // certain tags always keep whitespace
      ||
      !condenseWhiteSpace) {  // if true, whitespace is always kept
    // Keep all the white space.
    while (p && *p && !StringEqual(p, endTag, caseInsensitive, encoding)) {
      int  len;
      char cArr[4] = {0, 0, 0, 0};
      p = GetChar(p, cArr, &len, encoding);
      text->append(cArr, len);
    }
  } else {
    bool whitespace = false;
 
    // Remove leading white space:
    p = SkipWhiteSpace(p, encoding);
 
    while (p && *p && !StringEqual(p, endTag, caseInsensitive, encoding)) {
      if (*p == '\r' || *p == '\n') {
        whitespace = true;
        ++p;
      } else if (IsWhiteSpace(*p)) {
        whitespace = true;
        ++p;
      } else {
        // If we've found whitespace, add it before the
        // new character. Any whitespace just becomes a space.
        if (whitespace) {
          (*text) += ' ';
          whitespace = false;
        }
 
        int  len;
        char cArr[4] = {0, 0, 0, 0};
        p = GetChar(p, cArr, &len, encoding);
 
        if (len == 1)
          (*text) += cArr[0];  // more efficient
        else
          text->append(cArr, len);
      }
    }
  }
 
  if (p) p += strlen(endTag);
 
  return p;
}

References condenseWhiteSpace, GetChar(), IsWhiteSpace(), SkipWhiteSpace(), StringEqual(), and TIXML_STRING.

Referenced by TiXmlAttribute::Parse(), and TiXmlText::Parse().

Here is the call graph for this function:

Here is the caller graph for this function:

Row()

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

{ return location.row + 1; }

References location.

Referenced by ticpp::Base::Row().

Here is the caller graph for this function:

SetCondenseWhiteSpace()

void TiXmlBase::SetCondenseWhiteSpace ( bool condense )

inlinestatic

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

                                                   {
    condenseWhiteSpace = condense;
  }

References condenseWhiteSpace.

SetUserData()

void TiXmlBase::SetUserData ( void * user )

inline

Set a pointer to arbitrary user data.

Definition at line 278 of file tinyxml.h.

References userData.

SkipWhiteSpace()

const char * TiXmlBase::SkipWhiteSpace ( const char * p, TiXmlEncoding encoding )

staticprotected

Definition at line 333 of file tinyxmlparser.cpp.

                                                                           {
  if (!p || !*p) {
    return 0;
  }
 
  if (encoding == TIXML_ENCODING_UTF8) {
    while (*p) {
      const unsigned char* pU = (const unsigned char*)p;
 
      // Skip the stupid Microsoft UTF-8 Byte order marks
      if (*(pU + 0) == TIXML_UTF_LEAD_0 && *(pU + 1) == TIXML_UTF_LEAD_1 &&
          *(pU + 2) == TIXML_UTF_LEAD_2) {
        p += 3;
        continue;
      } else if (*(pU + 0) == TIXML_UTF_LEAD_0 && *(pU + 1) == 0xbfU &&
                 *(pU + 2) == 0xbeU) {
        p += 3;
        continue;
      } else if (*(pU + 0) == TIXML_UTF_LEAD_0 && *(pU + 1) == 0xbfU &&
                 *(pU + 2) == 0xbfU) {
        p += 3;
        continue;
      }
 
      if (IsWhiteSpace(*p) || *p == '\n' ||
          *p == '\r')  // Still using old rules for white space.
        ++p;
      else
        break;
    }
  } else {
    while ((*p && IsWhiteSpace(*p)) || *p == '\n' || *p == '\r')
      ++p;
  }
 
  return p;
}

References IsWhiteSpace(), TIXML_ENCODING_UTF8, TIXML_UTF_LEAD_0, TIXML_UTF_LEAD_1, and TIXML_UTF_LEAD_2.

Referenced by TiXmlNode::Identify(), TiXmlAttribute::Parse(), TiXmlComment::Parse(), TiXmlDeclaration::Parse(), TiXmlDocument::Parse(), TiXmlElement::Parse(), TiXmlStylesheetReference::Parse(), TiXmlUnknown::Parse(), ReadText(), and TiXmlElement::ReadValue().

Here is the call graph for this function:

Here is the caller graph for this function:

StreamTo()

bool TiXmlBase::StreamTo ( std::istream * in, int character, TIXML_STRING * tag )

staticprotected

Definition at line 386 of file tinyxmlparser.cpp.

                                                                    {
  // assert( character > 0 && character < 128 ); // else it won't work in utf-8
  while (in->good()) {
    int c = in->peek();
 
    if (c == character) return true;
 
    if (c <= 0)  // Silent failure: can't get document at this scope
      return false;
 
    in->get();
    *tag += (char)c;
  }
 
  return false;
}

References TIXML_STRING.

Referenced by TiXmlDocument::StreamIn().

Here is the caller graph for this function:

StreamWhiteSpace()

bool TiXmlBase::StreamWhiteSpace ( std::istream * in, TIXML_STRING * tag )

staticprotected

Definition at line 372 of file tinyxmlparser.cpp.

                                                                    {
  for (;;) {
    if (!in->good()) return false;
 
    int c = in->peek();
 
    // At this scope, we can't get to a document. So fail silently.
    if (!IsWhiteSpace(c) || c <= 0) return true;
 
    *tag += (char)in->get();
  }
}

References IsWhiteSpace(), and TIXML_STRING.

Referenced by TiXmlElement::StreamIn().

Here is the call graph for this function:

Here is the caller graph for this function:

StringEqual()

bool TiXmlBase::StringEqual ( const char * p, const char * endTag, bool ignoreCase, TiXmlEncoding encoding )

staticprotected

Definition at line 532 of file tinyxmlparser.cpp.

                                                    {
  assert(p);
  assert(tag);
 
  if (!p || !*p) {
    assert(0);
    return false;
  }
 
  const char* q = p;
 
  if (ignoreCase) {
    while (*q && *tag && ToLower(*q, encoding) == ToLower(*tag, encoding)) {
      ++q;
      ++tag;
    }
 
    if (*tag == 0) return true;
  } else {
    while (*q && *tag && *q == *tag) {
      ++q;
      ++tag;
    }
 
    if (*tag == 0)  // Have we found the end of the tag, and everything equal?
      return true;
  }
 
  return false;
}

References ToLower().

Referenced by TiXmlNode::Identify(), TiXmlComment::Parse(), TiXmlDeclaration::Parse(), TiXmlDocument::Parse(), TiXmlElement::Parse(), TiXmlStylesheetReference::Parse(), TiXmlText::Parse(), ReadText(), and TiXmlElement::ReadValue().

Here is the call graph for this function:

Here is the caller graph for this function:

ToLower()

int TiXmlBase::ToLower ( int v, TiXmlEncoding encoding )

inlinestaticprotected

Definition at line 419 of file tinyxml.h.

                                                           {
    if (encoding == TIXML_ENCODING_UTF8) {
      if (v < 128) return std::tolower(v);
 
      return v;
    } else {
      return std::tolower(v);
    }
  }

References TIXML_ENCODING_UTF8.

Referenced by StringEqual().

Here is the caller graph for this function:

Friends And Related Symbol Documentation

TiXmlDocument

friend class TiXmlDocument

friend

Definition at line 218 of file tinyxml.h.

References TiXmlDocument.

Referenced by TiXmlAttribute::SetDocument(), and TiXmlDocument.

TiXmlElement

friend class TiXmlElement

friend

Definition at line 217 of file tinyxml.h.

References TiXmlElement.

Referenced by TiXmlElement.

TiXmlNode

friend class TiXmlNode

friend

Definition at line 216 of file tinyxml.h.

References TiXmlNode.

Referenced by TiXmlNode.

Member Data Documentation

condenseWhiteSpace

bool TiXmlBase::condenseWhiteSpace = true

staticprivate

Definition at line 445 of file tinyxml.h.

Referenced by IsWhiteSpaceCondensed(), ReadText(), and SetCondenseWhiteSpace().

entity

TiXmlBase::Entity TiXmlBase::entity

staticprivate

Initial value:

= {{"&", 5, '&'},
               {"&lt;", 4, '<'},
               {"&gt;", 4, '>'},
               {"&quot;", 6, '\"'},
               {"&apos;", 6, '\''}}

Definition at line 44 of file tinyxml.h.

Referenced by EncodeString(), and GetEntity().

errorString

const char * TiXmlBase::errorString

staticprotected

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.",
  "Error when TiXmlDocument added to document, because "
  "TiXmlDocument can only be at the root.",
}

Definition at line 35 of file tinyxml.h.

Referenced by TiXmlDocument::SetError().

location

TiXmlCursor TiXmlBase::location

protected

Definition at line 410 of file tinyxml.h.

Referenced by Column(), TiXmlDocument::LoadFile(), TiXmlAttribute::Parse(), TiXmlComment::Parse(), TiXmlDeclaration::Parse(), TiXmlDocument::Parse(), TiXmlElement::Parse(), TiXmlStylesheetReference::Parse(), TiXmlText::Parse(), TiXmlUnknown::Parse(), and Row().

m_spawnedWrappers

std::vector< ticpp::Base* > TiCppRC::m_spawnedWrappers

inherited

Remember all wrappers that we've created with 'new' - ( e.g.

NodeFactory, FirstChildElement, etc. )

Definition at line 63 of file ticpprc.h.

Referenced by DeleteSpawnedWrappers(), ticpp::Element::LastAttribute(), ticpp::Attribute::Next(), ticpp::Node::NodeFactory(), ticpp::Attribute::Previous(), ticpp::Node::ToComment(), ticpp::Node::ToDocument(), and ticpp::Node::ToElement().

m_tiRC

TiCppRCImp* TiCppRC::m_tiRC

privateinherited

Pointer to reference counter.

Definition at line 46 of file ticpprc.h.

Referenced by ticpp::Base::SetImpRC().

userData

void* TiXmlBase::userData

protected

Field containing a generic user pointer.

Definition at line 413 of file tinyxml.h.

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

utf8ByteTable

const int TiXmlBase::utf8ByteTable

static

Definition at line 64 of file tinyxml.h.

Referenced by GetChar(), and TiXmlParsingData::Stamp().

---

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

• agrum/base/external/tinyxml/ticpp/tinyxml.h
• agrum/base/external/tinyxml/ticpp/tinyxml.cpp
• agrum/base/external/tinyxml/ticpp/tinyxmlerror.cpp
• agrum/base/external/tinyxml/ticpp/tinyxmlparser.cpp