TiXmlAttribute Class Reference

An attribute is a name-value pair. More...

#include <tinyxml.h>

Inheritance diagram for TiXmlAttribute:

Collaboration diagram for TiXmlAttribute:

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

Public Member Functions
	TiXmlAttribute ()
	Construct an empty attribute. More...
	TiXmlAttribute (const std::string &_name, const std::string &_value)
	std::string constructor. More...
	TiXmlAttribute (const char *_name, const char *_value)
	Construct an attribute with a name and value. More...
const char *	Name () const
	Return the name of this attribute. More...
const char *	Value () const
	Return the value of this attribute. More...
const std::string &	ValueStr () const
	Return the value of this attribute. More...
int	IntValue () const
	Return the value of this attribute, converted to an integer. More...
double	DoubleValue () const
	Return the value of this attribute, converted to a double. More...
const TIXML_STRING &	NameTStr () const
int	QueryIntValue (int *_value) const
	QueryIntValue examines the value string. More...
int	QueryDoubleValue (double *_value) const
	QueryDoubleValue examines the value string. See QueryIntValue(). More...
void	SetName (const char *_name)
	Set the name of this attribute. More...
void	SetValue (const char *_value)
	Set the value. More...
void	SetIntValue (int _value)
	Set the value from an integer. More...
void	SetDoubleValue (double _value)
	Set the value from a double. More...
void	SetName (const std::string &_name)
	STL std::string form. More...
void	SetValue (const std::string &_value)
	STL std::string form. More...
const TiXmlAttribute *	Next () const
	Get the next sibling attribute in the DOM. Returns null at end. More...
TiXmlAttribute *	Next ()
const TiXmlAttribute *	Previous () const
	Get the previous sibling attribute in the DOM. Returns null at beginning. More...
TiXmlAttribute *	Previous ()
bool	operator== (const TiXmlAttribute &rhs) const
bool	operator< (const TiXmlAttribute &rhs) const
bool	operator> (const TiXmlAttribute &rhs) const
virtual const char *	Parse (const char *p, TiXmlParsingData *data, TiXmlEncoding encoding)
virtual void	Print (FILE *cfile, int depth) const
	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. More...
void	Print (FILE *cfile, int depth, TIXML_STRING *str) const
void	SetDocument (TiXmlDocument *doc)
int	Row () const
	Return the position, in the original source file, of this node or attribute. More...
int	Column () const
	See Row() More...
void	SetUserData (void *user)
	Set a pointer to arbitrary user data. More...
void *	GetUserData ()
	Get a pointer to arbitrary user data. More...
const void *	GetUserData () const
	Get a pointer to arbitrary user data. More...
void	DeleteSpawnedWrappers ()
	Delete all container objects we've spawned with 'new'. More...

Static Public Attributes
static const int	utf8ByteTable [256]

Static Public Member Functions
static void	SetCondenseWhiteSpace (bool condense)
	The world does not agree on whether white space should be kept or not. More...
static bool	IsWhiteSpaceCondensed ()
	Return the current white space setting. More...
static void	EncodeString (const TIXML_STRING &str, TIXML_STRING *out)
	Expands entities in a string. More...

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 }

Protected Attributes
TiXmlCursor	location
void *	userData
	Field containing a generic user pointer. More...

Static Protected Attributes
static const char *	errorString [TIXML_ERROR_STRING_COUNT]

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)

Friends
class	TiXmlAttributeSet

Detailed Description

An attribute is a name-value pair.

Elements have an arbitrary number of attributes, each with a unique name.

Note

The attributes are not TiXmlNodes, since they are not part of the tinyXML document object model. There are other suggested ways to look at this problem.

Definition at line 915 of file tinyxml.h.

Member Enumeration Documentation

anonymous enum

anonymous enum

inherited

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
  };

Constructor & Destructor Documentation

TiXmlAttribute() [1/4]

TiXmlAttribute::TiXmlAttribute ( )

inline

Construct an empty attribute.

Definition at line 920 of file tinyxml.h.

References next, prev, and TiXmlBase::TiXmlBase().

Referenced by ticpp::Attribute::Attribute(), and TiXmlElement::Parse().

      : TiXmlBase() {
    document = 0;
    prev = next = 0;
  }

Here is the call graph for this function:

Here is the caller graph for this function:

TiXmlAttribute() [2/4]

TiXmlAttribute::TiXmlAttribute ( const std::string &  _name, const std::string &  _value  )

inline

std::string constructor.

Definition at line 928 of file tinyxml.h.

References name, next, prev, and value.

                                                                  {
    name = _name;
    value = _value;
    document = 0;
    prev = next = 0;
  }

TiXmlAttribute() [3/4]

TiXmlAttribute::TiXmlAttribute ( const char *  _name, const char *  _value  )

inline

Construct an attribute with a name and value.

Definition at line 937 of file tinyxml.h.

References next, and prev.

Referenced by TiXmlElement::SetAttribute().

                                                        {
    name = _name;
    value = _value;
    document = 0;
    prev = next = 0;
  }

Here is the caller graph for this function:

TiXmlAttribute() [4/4]

TiXmlAttribute::TiXmlAttribute ( const TiXmlAttribute &  )

private

Member Function Documentation

Column()

int TiXmlBase::Column ( ) const

inlineinherited

See Row()

Definition at line 276 of file tinyxml.h.

References TiXmlCursor::col, and TiXmlBase::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  )

staticprotectedinherited

Definition at line 100 of file tinyxmlparser.cpp.

Referenced by TiXmlBase::GetEntity().

                                                         {
  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]);
  }
}

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();
}

DoubleValue()

double TiXmlAttribute::DoubleValue

(

)

const

Return the value of this attribute, converted to a double.

Definition at line 1146 of file tinyxml.cpp.

{ return atof(value.c_str()); }

EncodeString()

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

staticinherited

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
      sprintf(buf, "&#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;
    }
  }
}

GetChar()

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

inlinestaticprotectedinherited

Definition at line 368 of file tinyxml.h.

References TiXmlBase::GetEntity(), TIXML_ENCODING_UTF8, and TiXmlBase::utf8ByteTable.

Referenced by TiXmlBase::ReadText().

                                                                            {
    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;
    }
  }

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  )

staticprotectedinherited

Definition at line 442 of file tinyxmlparser.cpp.

References TiXmlBase::Entity::chr, TiXmlBase::ConvertUTF32ToUTF8(), TiXmlBase::entity, TiXmlBase::NUM_ENTITY, TiXmlBase::Entity::strLength, and TIXML_ENCODING_UTF8.

Referenced by TiXmlBase::GetChar().

                                                         {
  // 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;
}

Here is the call graph for this function:

Here is the caller graph for this function:

GetUserData() [1/2]

void* TiXmlBase::GetUserData ( )

inlineinherited

Get a pointer to arbitrary user data.

Definition at line 281 of file tinyxml.h.

References TiXmlBase::userData.

GetUserData() [2/2]

const void* TiXmlBase::GetUserData ( ) const

inlineinherited

Get a pointer to arbitrary user data.

Definition at line 284 of file tinyxml.h.

References TiXmlBase::userData.

IntValue()

int TiXmlAttribute::IntValue

(

)

const

Return the value of this attribute, converted to an integer.

Definition at line 1144 of file tinyxml.cpp.

{ return atoi(value.c_str()); }

IsAlpha()

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

staticprotectedinherited

Definition at line 146 of file tinyxmlparser.cpp.

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

                                                   {
  // 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 );
  //  }
}

Here is the caller graph for this function:

IsAlphaNum()

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

staticprotectedinherited

Definition at line 170 of file tinyxmlparser.cpp.

Referenced by TiXmlBase::ReadName().

                                                      {
  // 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 );
  //  }
}

Here is the caller graph for this function:

IsWhiteSpace() [1/2]

static bool TiXmlBase::IsWhiteSpace ( char  c )

inlinestaticprotectedinherited

Definition at line 328 of file tinyxml.h.

Referenced by TiXmlBase::IsWhiteSpace(), Parse(), TiXmlDeclaration::Parse(), TiXmlStylesheetReference::Parse(), TiXmlBase::ReadText(), and TiXmlBase::SkipWhiteSpace().

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

Here is the caller graph for this function:

IsWhiteSpace() [2/2]

static bool TiXmlBase::IsWhiteSpace ( int  c )

inlinestaticprotectedinherited

Definition at line 331 of file tinyxml.h.

References TiXmlBase::IsWhiteSpace().

Referenced by TiXmlElement::StreamIn(), and TiXmlBase::StreamWhiteSpace().

                                         {
    if (c < 256) return IsWhiteSpace((char)c);

    return false;  // Again, only truly correct for English/Latin...but usually
                   // works.
  }

Here is the call graph for this function:

Here is the caller graph for this function:

IsWhiteSpaceCondensed()

static bool TiXmlBase::IsWhiteSpaceCondensed ( )

inlinestaticinherited

Return the current white space setting.

Definition at line 247 of file tinyxml.h.

References TiXmlBase::condenseWhiteSpace.

Referenced by TiXmlElement::ReadValue().

{ return condenseWhiteSpace; }

Here is the caller graph for this function:

Name()

const char* TiXmlAttribute::Name ( ) const

inline

Return the name of this attribute.

Definition at line 944 of file tinyxml.h.

Referenced by TiXmlElement::CopyTo().

Here is the caller graph for this function:

NameTStr()

const TIXML_STRING& TiXmlAttribute::NameTStr ( ) const

inline

Definition at line 961 of file tinyxml.h.

References name.

{ return name; }

Next() [1/2]

const TiXmlAttribute * TiXmlAttribute::Next

(

)

const

Get the next sibling attribute in the DOM. Returns null at end.

Definition at line 1043 of file tinyxml.cpp.

References next.

Referenced by TiXmlElement::CopyTo(), Next(), TiXmlElement::Print(), and TiXmlPrinter::VisitEnter().

                                                 {
  // We are using knowledge of the sentinel. The sentinel
  // have a value or name.
  if (next->value.empty() && next->name.empty()) return 0;

  return next;
}

Here is the caller graph for this function:

Next() [2/2]

TiXmlAttribute* TiXmlAttribute::Next ( )

inline

Definition at line 993 of file tinyxml.h.

References Next().

Referenced by ticpp::Attribute::Next().

                               {
    return const_cast< TiXmlAttribute* >(
      (const_cast< const TiXmlAttribute* >(this))->Next());
  }

Here is the call graph for this function:

Here is the caller graph for this function:

operator<()

bool TiXmlAttribute::operator< ( const TiXmlAttribute &  rhs ) const

inline

Definition at line 1006 of file tinyxml.h.

References name.

{ return name < rhs.name; }

operator=()

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

private

operator==()

bool TiXmlAttribute::operator== ( const TiXmlAttribute &  rhs ) const

inline

Definition at line 1005 of file tinyxml.h.

References name.

{ return rhs.name == name; }

operator>()

bool TiXmlAttribute::operator> ( const TiXmlAttribute &  rhs ) const

inline

Definition at line 1007 of file tinyxml.h.

References name.

{ return name > rhs.name; }

Parse()

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

virtual

Implements TiXmlBase.

Definition at line 1361 of file tinyxmlparser.cpp.

References TiXmlParsingData::Cursor(), TiXmlBase::IsWhiteSpace(), TiXmlBase::location, TiXmlBase::SkipWhiteSpace(), and TiXmlParsingData::Stamp().

Referenced by TiXmlElement::Parse(), TiXmlDeclaration::Parse(), and TiXmlStylesheetReference::Parse().

                                                              {
  p = SkipWhiteSpace(p, encoding);

  if (!p || !*p) return 0;

  //  int tabsize = 4;
  //  if ( document )
  //    tabsize = document->TabSize();

  if (data) {
    data->Stamp(p, encoding);
    location = data->Cursor();
  }

  // Read the name, the '=' and the value.
  const char* pErr = p;
  p = ReadName(p, &name, encoding);

  if (!p || !*p) {
    if (document)
      document->SetError(TIXML_ERROR_READING_ATTRIBUTES, pErr, data, encoding);

    return 0;
  }

  p = SkipWhiteSpace(p, encoding);

  if (!p || !*p || *p != '=') {
    if (document)
      document->SetError(TIXML_ERROR_READING_ATTRIBUTES, p, data, encoding);

    return 0;
  }

  ++p;  // skip '='
  p = SkipWhiteSpace(p, encoding);

  if (!p || !*p) {
    if (document)
      document->SetError(TIXML_ERROR_READING_ATTRIBUTES, p, data, encoding);

    return 0;
  }

  const char* end;
  const char  SINGLE_QUOTE = '\'';
  const char  DOUBLE_QUOTE = '\"';

  if (*p == SINGLE_QUOTE) {
    ++p;
    end = "\'";  // single quote in string
    p = ReadText(p, &value, false, end, false, encoding);
  } else if (*p == DOUBLE_QUOTE) {
    ++p;
    end = "\"";  // double quote in string
    p = ReadText(p, &value, false, end, false, encoding);
  } else {
    // All attribute values should be in single or double quotes.
    // But this is such a common error that the parser will try
    // its best, even without them.
    value = "";

    while (p && *p  // existence
           &&
           !IsWhiteSpace(*p) && *p != '\n' && *p != '\r'  // whitespace
           &&
           *p != '/' && *p != '>') {  // tag end
      if (*p == SINGLE_QUOTE || *p == DOUBLE_QUOTE) {
        // [ 1451649 ] Attribute values with trailing quotes not handled
        // correctly
        // We did not have an opening quote but seem to have a
        // closing one. Give up and throw an error.
        if (document)
          document->SetError(TIXML_ERROR_READING_ATTRIBUTES, p, data, encoding);

        return 0;
      }

      value += *p;
      ++p;
    }
  }

  return p;
}

Here is the call graph for this function:

Here is the caller graph for this function:

Previous() [1/2]

const TiXmlAttribute * TiXmlAttribute::Previous

(

)

const

Get the previous sibling attribute in the DOM. Returns null at beginning.

Definition at line 1062 of file tinyxml.cpp.

References prev.

Referenced by Previous().

                                                     {
  // We are using knowledge of the sentinel. The sentinel
  // have a value or name.
  if (prev->value.empty() && prev->name.empty()) return 0;

  return prev;
}

Here is the caller graph for this function:

Previous() [2/2]

TiXmlAttribute* TiXmlAttribute::Previous ( )

inline

Definition at line 1000 of file tinyxml.h.

References Previous().

Referenced by ticpp::Attribute::Previous().

                                   {
    return const_cast< TiXmlAttribute* >(
      (const_cast< const TiXmlAttribute* >(this))->Previous());
  }

Here is the call graph for this function:

Here is the caller graph for this function:

Print() [1/2]

virtual void TiXmlAttribute::Print ( FILE *  cfile, int  depth  ) const

inlinevirtual

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

Implements TiXmlBase.

Definition at line 1016 of file tinyxml.h.

References Print().

Referenced by ticpp::Attribute::Print(), and TiXmlElement::Print().

{ Print(cfile, depth, 0); }

Here is the call graph for this function:

Here is the caller graph for this function:

Print() [2/2]

void TiXmlAttribute::Print	(	FILE *	cfile,
		int	depth,
		TIXML_STRING *	str
	)		const

Definition at line 1081 of file tinyxml.cpp.

Referenced by Print().

                                                                      {
  TIXML_STRING n, v;

  EncodeString(name, &n);
  EncodeString(value, &v);

  if (value.find('\"') == TIXML_STRING::npos) {
    if (cfile) {
      fprintf(cfile, "%s=\"%s\"", n.c_str(), v.c_str());
    }

    if (str) {
      (*str) += n;
      (*str) += "=\"";
      (*str) += v;
      (*str) += "\"";
    }
  } else {
    if (cfile) {
      fprintf(cfile, "%s='%s'", n.c_str(), v.c_str());
    }

    if (str) {
      (*str) += n;
      (*str) += "='";
      (*str) += v;
      (*str) += "'";
    }
  }
}

Here is the caller graph for this function:

QueryDoubleValue()

int TiXmlAttribute::QueryDoubleValue

(

double *

_value

)

const

QueryDoubleValue examines the value string. See QueryIntValue().

Definition at line 1118 of file tinyxml.cpp.

References TIXML_SUCCESS, and TIXML_WRONG_TYPE.

Referenced by TiXmlElement::QueryDoubleAttribute().

                                                       {
  if (TIXML_SSCANF(value.c_str(), "%lf", dval) == 1) return TIXML_SUCCESS;

  return TIXML_WRONG_TYPE;
}

Here is the caller graph for this function:

QueryIntValue()

int TiXmlAttribute::QueryIntValue

(

int *

_value

)

const

QueryIntValue examines the value string.

It is an alternative to the IntValue() method with richer error checking. If the value is an integer, it is stored in 'value' and the call returns TIXML_SUCCESS. If it is not an integer, it returns TIXML_WRONG_TYPE.

A specialized but useful call. Note that for success it returns 0, which is the opposite of almost all other TinyXml calls.

Definition at line 1112 of file tinyxml.cpp.

References TIXML_SUCCESS, and TIXML_WRONG_TYPE.

Referenced by TiXmlElement::QueryIntAttribute().

                                                 {
  if (TIXML_SSCANF(value.c_str(), "%d", ival) == 1) return TIXML_SUCCESS;

  return TIXML_WRONG_TYPE;
}

Here is the caller graph for this function:

ReadName()

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

staticprotectedinherited

Definition at line 409 of file tinyxmlparser.cpp.

References TiXmlBase::IsAlpha(), and TiXmlBase::IsAlphaNum().

                                                                             {
  // 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;
}

Here is the call graph for this function:

ReadText()

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

staticprotectedinherited

Definition at line 566 of file tinyxmlparser.cpp.

References TiXmlBase::condenseWhiteSpace, TiXmlBase::GetChar(), TiXmlBase::IsWhiteSpace(), TiXmlBase::SkipWhiteSpace(), and TiXmlBase::StringEqual().

                                                        {
  *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;
}

Here is the call graph for this function:

Row()

int TiXmlBase::Row ( ) const

inlineinherited

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.

References TiXmlBase::location, and TiXmlCursor::row.

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

{ return location.row + 1; }

Here is the caller graph for this function:

SetCondenseWhiteSpace()

static void TiXmlBase::SetCondenseWhiteSpace ( bool  condense )

inlinestaticinherited

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.

References TiXmlBase::condenseWhiteSpace.

                                                   {
    condenseWhiteSpace = condense;
  }

SetDocument()

void TiXmlAttribute::SetDocument ( TiXmlDocument *  doc )

inline

Definition at line 1021 of file tinyxml.h.

{ document = doc; }

SetDoubleValue()

void TiXmlAttribute::SetDoubleValue

(

double

_value

)

Set the value from a double.

Definition at line 1134 of file tinyxml.cpp.

References SetValue().

                                                 {
  char buf[256];
#if defined(TIXML_SNPRINTF)
  TIXML_SNPRINTF(buf, sizeof(buf), "%g", _value);
#else
  sprintf(buf, "%lf", _value);
#endif
  SetValue(buf);
}

Here is the call graph for this function:

SetIntValue()

void TiXmlAttribute::SetIntValue

(

int

_value

)

Set the value from an integer.

Definition at line 1124 of file tinyxml.cpp.

References SetValue().

                                           {
  char buf[64];
#if defined(TIXML_SNPRINTF)
  TIXML_SNPRINTF(buf, sizeof(buf), "%d", _value);
#else
  sprintf(buf, "%d", _value);
#endif
  SetValue(buf);
}

Here is the call graph for this function:

SetName() [1/2]

void TiXmlAttribute::SetName ( const char *  _name )

inline

Set the name of this attribute.

Definition at line 976 of file tinyxml.h.

SetName() [2/2]

void TiXmlAttribute::SetName ( const std::string &  _name )

inline

STL std::string form.

Definition at line 986 of file tinyxml.h.

References name.

{ name = _name; }

SetUserData()

void TiXmlBase::SetUserData ( void *  user )

inlineinherited

Set a pointer to arbitrary user data.

Definition at line 278 of file tinyxml.h.

References TiXmlBase::userData.

SetValue() [1/2]

void TiXmlAttribute::SetValue ( const char *  _value )

inline

Set the value.

Definition at line 979 of file tinyxml.h.

Referenced by TiXmlElement::Parse(), SetDoubleValue(), and SetIntValue().

Here is the caller graph for this function:

SetValue() [2/2]

void TiXmlAttribute::SetValue ( const std::string &  _value )

inline

STL std::string form.

Definition at line 988 of file tinyxml.h.

References value.

{ value = _value; }

SkipWhiteSpace()

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

staticprotectedinherited

Definition at line 333 of file tinyxmlparser.cpp.

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

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

                                                                           {
  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;
}

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  )

staticprotectedinherited

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;
}

StreamWhiteSpace()

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

staticprotectedinherited

Definition at line 372 of file tinyxmlparser.cpp.

References TiXmlBase::IsWhiteSpace().

                                                                    {
  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();
  }
}

Here is the call graph for this function:

StringEqual()

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

staticprotectedinherited

Definition at line 532 of file tinyxmlparser.cpp.

References TiXmlBase::ToLower().

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

                                                    {
  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;
}

Here is the call graph for this function:

Here is the caller graph for this function:

ToLower()

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

inlinestaticprotectedinherited

Definition at line 419 of file tinyxml.h.

References TIXML_ENCODING_UTF8.

Referenced by TiXmlBase::StringEqual().

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

      return v;
    } else {
      return std::tolower(v);
    }
  }

Here is the caller graph for this function:

Value()

const char* TiXmlAttribute::Value ( ) const

inline

Return the value of this attribute.

Definition at line 947 of file tinyxml.h.

Referenced by TiXmlElement::Attribute(), TiXmlElement::CopyTo(), and TiXmlElement::Parse().

Here is the caller graph for this function:

ValueStr()

const std::string& TiXmlAttribute::ValueStr ( ) const

inline

Return the value of this attribute.

Definition at line 951 of file tinyxml.h.

References value.

Referenced by TiXmlElement::QueryValueAttribute(), and ticpp::Attribute::Value().

Here is the caller graph for this function:

Friends And Related Function Documentation

TiXmlAttributeSet

friend class TiXmlAttributeSet

friend

Definition at line 916 of file tinyxml.h.

Member Data Documentation

document

TiXmlDocument* TiXmlAttribute::document

private

Definition at line 1027 of file tinyxml.h.

errorString

const char * TiXmlBase::errorString

staticprotectedinherited

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

location

TiXmlCursor TiXmlBase::location

protectedinherited

Definition at line 410 of file tinyxml.h.

Referenced by TiXmlBase::Column(), TiXmlDocument::LoadFile(), Parse(), TiXmlElement::Parse(), TiXmlComment::Parse(), TiXmlText::Parse(), TiXmlDeclaration::Parse(), TiXmlStylesheetReference::Parse(), TiXmlUnknown::Parse(), TiXmlDocument::Parse(), and TiXmlBase::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.

name

TIXML_STRING TiXmlAttribute::name

private

Definition at line 1028 of file tinyxml.h.

Referenced by NameTStr(), operator<(), operator==(), operator>(), SetName(), and TiXmlAttribute().

next

TiXmlAttribute* TiXmlAttribute::next

private

Definition at line 1031 of file tinyxml.h.

Referenced by Next(), and TiXmlAttribute().

prev

TiXmlAttribute* TiXmlAttribute::prev

private

Definition at line 1030 of file tinyxml.h.

Referenced by Previous(), and TiXmlAttribute().

userData

void* TiXmlBase::userData

protectedinherited

Field containing a generic user pointer.

Definition at line 413 of file tinyxml.h.

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

utf8ByteTable

const int TiXmlBase::utf8ByteTable

staticinherited

Definition at line 290 of file tinyxml.h.

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

value

TIXML_STRING TiXmlAttribute::value

private

Definition at line 1029 of file tinyxml.h.

Referenced by SetValue(), TiXmlAttribute(), and ValueStr().

---

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

• agrum/tools/external/tinyxml/ticpp/tinyxml.h
• agrum/tools/external/tinyxml/ticpp/tinyxml.cpp
• agrum/tools/external/tinyxml/ticpp/tinyxmlparser.cpp