Pandora
Pandora source code navigator
Loading...
Searching...
No Matches
pandora::TiXmlAttribute Class Reference

#include "tinyxml.h"

Inheritance diagram for pandora::TiXmlAttribute:
Collaboration diagram for pandora::TiXmlAttribute:

Public Types

enum  {
  TIXML_NO_ERROR = 0 , TIXML_ERROR , TIXML_ERROR_OPENING_FILE , TIXML_ERROR_PARSING_ELEMENT ,
  TIXML_ERROR_FAILED_TO_READ_ELEMENT_NAME , TIXML_ERROR_READING_ELEMENT_VALUE , TIXML_ERROR_READING_ATTRIBUTES , TIXML_ERROR_PARSING_EMPTY ,
  TIXML_ERROR_READING_END_TAG , TIXML_ERROR_PARSING_UNKNOWN , TIXML_ERROR_PARSING_COMMENT , TIXML_ERROR_PARSING_DECLARATION ,
  TIXML_ERROR_DOCUMENT_EMPTY , TIXML_ERROR_EMBEDDED_NULL , TIXML_ERROR_PARSING_CDATA , TIXML_ERROR_DOCUMENT_TOP_ONLY ,
  TIXML_ERROR_STRING_COUNT
}
 

Public Member Functions

 TiXmlAttribute ()
 Construct an empty attribute.
 
 TiXmlAttribute (const std::string &_name, const std::string &_value)
 std::string constructor.
 
 TiXmlAttribute (const char *_name, const char *_value)
 Construct an attribute with a name and value.
 
const char * Name () const
 Return the name of this attribute.
 
const char * Value () const
 Return the value of this attribute.
 
const std::string & ValueStr () const
 Return the value of this attribute.
 
int IntValue () const
 Return the value of this attribute, converted to an integer.
 
double DoubleValue () const
 Return the value of this attribute, converted to a double.
 
const TIXML_STRINGNameTStr () const
 
int QueryIntValue (int *_value) const
 
int QueryDoubleValue (double *_value) const
 QueryDoubleValue examines the value string. See QueryIntValue().
 
void SetName (const char *_name)
 Set the name of this attribute.
 
void SetValue (const char *_value)
 Set the value.
 
void SetIntValue (int _value)
 Set the value from an integer.
 
void SetDoubleValue (double _value)
 Set the value from a double.
 
void SetName (const std::string &_name)
 STL std::string form.
 
void SetValue (const std::string &_value)
 STL std::string form.

 
const TiXmlAttributeNext () const
 Get the next sibling attribute in the DOM. Returns null at end.
 
TiXmlAttributeNext ()
 
const TiXmlAttributePrevious () const
 Get the previous sibling attribute in the DOM. Returns null at beginning.
 
TiXmlAttributePrevious ()
 
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
 
void Print (FILE *cfile, int depth, TIXML_STRING *str) const
 
void SetDocument (TiXmlDocument *doc)
 
int Row () const
 
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.
 

Static Public Member Functions

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

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

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

Private Attributes

TiXmlDocumentdocument
 
TIXML_STRING name
 
TIXML_STRING value
 
TiXmlAttributeprev
 
TiXmlAttributenext
 

Static Private Attributes

static Entity entity [NUM_ENTITY]
 
static bool condenseWhiteSpace = true
 

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

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
inherited
Enumerator
TIXML_NO_ERROR 
TIXML_ERROR 
TIXML_ERROR_OPENING_FILE 
TIXML_ERROR_PARSING_ELEMENT 
TIXML_ERROR_FAILED_TO_READ_ELEMENT_NAME 
TIXML_ERROR_READING_ELEMENT_VALUE 
TIXML_ERROR_READING_ATTRIBUTES 
TIXML_ERROR_PARSING_EMPTY 
TIXML_ERROR_READING_END_TAG 
TIXML_ERROR_PARSING_UNKNOWN 
TIXML_ERROR_PARSING_COMMENT 
TIXML_ERROR_PARSING_DECLARATION 
TIXML_ERROR_DOCUMENT_EMPTY 
TIXML_ERROR_EMBEDDED_NULL 
TIXML_ERROR_PARSING_CDATA 
TIXML_ERROR_DOCUMENT_TOP_ONLY 
TIXML_ERROR_STRING_COUNT 

Definition at line 271 of file tinyxml.h.

◆ anonymous enum

anonymous enum
privateinherited
Enumerator
NUM_ENTITY 
MAX_ENTITY_LENGTH 

Definition at line 413 of file tinyxml.h.

Constructor & Destructor Documentation

◆ TiXmlAttribute() [1/4]

pandora::TiXmlAttribute::TiXmlAttribute ( )
inline

Construct an empty attribute.

Definition at line 792 of file tinyxml.h.

◆ TiXmlAttribute() [2/4]

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

std::string constructor.

Definition at line 800 of file tinyxml.h.

◆ TiXmlAttribute() [3/4]

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

Construct an attribute with a name and value.

Definition at line 810 of file tinyxml.h.

◆ TiXmlAttribute() [4/4]

pandora::TiXmlAttribute::TiXmlAttribute ( const TiXmlAttribute )
private

Member Function Documentation

◆ Column()

int pandora::TiXmlBase::Column ( ) const
inlineinherited

See Row()

Definition at line 252 of file tinyxml.h.

◆ ConvertUTF32ToUTF8()

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

Definition at line 91 of file tinyxmlparser.cc.

Here is the caller graph for this function:

◆ DoubleValue()

double pandora::TiXmlAttribute::DoubleValue ( ) const

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

Definition at line 1280 of file tinyxml.cc.

◆ EncodeString()

void pandora::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 55 of file tinyxml.cc.

Here is the caller graph for this function:

◆ GetChar()

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

Definition at line 334 of file tinyxml.h.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GetEntity()

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

Definition at line 444 of file tinyxmlparser.cc.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GetUserData() [1/2]

void * pandora::TiXmlBase::GetUserData ( )
inlineinherited

Get a pointer to arbitrary user data.

Definition at line 255 of file tinyxml.h.

◆ GetUserData() [2/2]

const void * pandora::TiXmlBase::GetUserData ( ) const
inlineinherited

Get a pointer to arbitrary user data.

Definition at line 256 of file tinyxml.h.

◆ IntValue()

int pandora::TiXmlAttribute::IntValue ( ) const

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

Definition at line 1275 of file tinyxml.cc.

◆ IsAlpha()

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

Definition at line 135 of file tinyxmlparser.cc.

Here is the caller graph for this function:

◆ IsAlphaNum()

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

Definition at line 156 of file tinyxmlparser.cc.

Here is the caller graph for this function:

◆ IsWhiteSpace() [1/2]

static bool pandora::TiXmlBase::IsWhiteSpace ( char  c)
inlinestaticprotectedinherited

Definition at line 297 of file tinyxml.h.

Here is the caller graph for this function:

◆ IsWhiteSpace() [2/2]

static bool pandora::TiXmlBase::IsWhiteSpace ( int  c)
inlinestaticprotectedinherited

Definition at line 301 of file tinyxml.h.

Here is the call graph for this function:

◆ IsWhiteSpaceCondensed()

static bool pandora::TiXmlBase::IsWhiteSpaceCondensed ( )
inlinestaticinherited

Return the current white space setting.

Definition at line 231 of file tinyxml.h.

Here is the caller graph for this function:

◆ Name()

const char * pandora::TiXmlAttribute::Name ( ) const
inline

Return the name of this attribute.

Definition at line 818 of file tinyxml.h.

Here is the caller graph for this function:

◆ NameTStr()

const TIXML_STRING & pandora::TiXmlAttribute::NameTStr ( ) const
inline

Definition at line 827 of file tinyxml.h.

Here is the caller graph for this function:

◆ Next() [1/2]

TiXmlAttribute * pandora::TiXmlAttribute::Next ( )
inline

Definition at line 857 of file tinyxml.h.

◆ Next() [2/2]

const TiXmlAttribute * pandora::TiXmlAttribute::Next ( ) const

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

Definition at line 1173 of file tinyxml.cc.

Here is the caller graph for this function:

◆ operator<()

bool pandora::TiXmlAttribute::operator< ( const TiXmlAttribute rhs) const
inline

Definition at line 868 of file tinyxml.h.

◆ operator=()

void pandora::TiXmlAttribute::operator= ( const TiXmlAttribute base)
private

◆ operator==()

bool pandora::TiXmlAttribute::operator== ( const TiXmlAttribute rhs) const
inline

Definition at line 867 of file tinyxml.h.

◆ operator>()

bool pandora::TiXmlAttribute::operator> ( const TiXmlAttribute rhs) const
inline

Definition at line 869 of file tinyxml.h.

◆ Parse()

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

Implements pandora::TiXmlBase.

Definition at line 1398 of file tinyxmlparser.cc.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ Previous() [1/2]

TiXmlAttribute * pandora::TiXmlAttribute::Previous ( )
inline

Definition at line 863 of file tinyxml.h.

◆ Previous() [2/2]

const TiXmlAttribute * pandora::TiXmlAttribute::Previous ( ) const

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

Definition at line 1193 of file tinyxml.cc.

◆ Print() [1/2]

virtual void pandora::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 pandora::TiXmlBase.

Definition at line 877 of file tinyxml.h.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ Print() [2/2]

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

Definition at line 1213 of file tinyxml.cc.

Here is the call graph for this function:

◆ QueryDoubleValue()

int pandora::TiXmlAttribute::QueryDoubleValue ( double *  _value) const

QueryDoubleValue examines the value string. See QueryIntValue().

Definition at line 1246 of file tinyxml.cc.

Here is the caller graph for this function:

◆ QueryIntValue()

int pandora::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 1239 of file tinyxml.cc.

Here is the caller graph for this function:

◆ ReadName()

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

Definition at line 407 of file tinyxmlparser.cc.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ ReadText()

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

Definition at line 580 of file tinyxmlparser.cc.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ Row()

int pandora::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 251 of file tinyxml.h.

◆ SetCondenseWhiteSpace()

static void pandora::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 228 of file tinyxml.h.

◆ SetDocument()

void pandora::TiXmlAttribute::SetDocument ( TiXmlDocument doc)
inline

Definition at line 884 of file tinyxml.h.

Here is the caller graph for this function:

◆ SetDoubleValue()

void pandora::TiXmlAttribute::SetDoubleValue ( double  _value)

Set the value from a double.

Definition at line 1264 of file tinyxml.cc.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ SetIntValue()

void pandora::TiXmlAttribute::SetIntValue ( int  _value)

Set the value from an integer.

Definition at line 1253 of file tinyxml.cc.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ SetName() [1/2]

void pandora::TiXmlAttribute::SetName ( const char *  _name)
inline

Set the name of this attribute.

Definition at line 842 of file tinyxml.h.

Here is the caller graph for this function:

◆ SetName() [2/2]

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

STL std::string form.

Definition at line 850 of file tinyxml.h.

◆ SetUserData()

void pandora::TiXmlBase::SetUserData ( void *  user)
inlineinherited

Set a pointer to arbitrary user data.

Definition at line 254 of file tinyxml.h.

◆ SetValue() [1/2]

void pandora::TiXmlAttribute::SetValue ( const char *  _value)
inline

Set the value.

Definition at line 843 of file tinyxml.h.

Here is the caller graph for this function:

◆ SetValue() [2/2]

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

STL std::string form.

Definition at line 852 of file tinyxml.h.

◆ SkipWhiteSpace()

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

Definition at line 320 of file tinyxmlparser.cc.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ StreamTo()

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

◆ StreamWhiteSpace()

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

◆ StringEqual()

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

Definition at line 540 of file tinyxmlparser.cc.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ ToLower()

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

Definition at line 389 of file tinyxml.h.

Here is the caller graph for this function:

◆ Value()

const char * pandora::TiXmlAttribute::Value ( ) const
inline

Return the value of this attribute.

Definition at line 819 of file tinyxml.h.

Here is the caller graph for this function:

◆ ValueStr()

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

Return the value of this attribute.

Definition at line 821 of file tinyxml.h.

Here is the caller graph for this function:

Friends And Related Symbol Documentation

◆ TiXmlAttributeSet

friend class TiXmlAttributeSet
friend

Definition at line 788 of file tinyxml.h.

Member Data Documentation

◆ condenseWhiteSpace

bool pandora::TiXmlBase::condenseWhiteSpace = true
staticprivateinherited

Definition at line 420 of file tinyxml.h.

◆ document

TiXmlDocument* pandora::TiXmlAttribute::document
private

Definition at line 890 of file tinyxml.h.

◆ entity

TiXmlBase::Entity pandora::TiXmlBase::entity
staticprivateinherited
Initial value:
=
{
{ "&amp;", 5, '&' },
{ "&lt;", 4, '<' },
{ "&gt;", 4, '>' },
{ "&quot;", 6, '\"' },
{ "&apos;", 6, '\'' }
}

Definition at line 419 of file tinyxml.h.

◆ errorString

const char * pandora::TiXmlBase::errorString
staticprotectedinherited
Initial value:
=
{
"No error",
"Error",
"Failed to open file",
"Error parsing Element.",
"Failed to read Element name",
"Error reading Element value.",
"Error reading Attributes.",
"Error: empty tag.",
"Error reading end tag.",
"Error parsing Unknown.",
"Error parsing Comment.",
"Error parsing Declaration.",
"Error document empty.",
"Error null (0) or unexpected EOF found in input stream.",
"Error parsing CDATA.",
"Error when TiXmlDocument added to document, because TiXmlDocument can only be at the root.",
}

Definition at line 378 of file tinyxml.h.

◆ location

TiXmlCursor pandora::TiXmlBase::location
protectedinherited

Definition at line 380 of file tinyxml.h.

◆ name

TIXML_STRING pandora::TiXmlAttribute::name
private

Definition at line 891 of file tinyxml.h.

◆ next

TiXmlAttribute* pandora::TiXmlAttribute::next
private

Definition at line 894 of file tinyxml.h.

◆ prev

TiXmlAttribute* pandora::TiXmlAttribute::prev
private

Definition at line 893 of file tinyxml.h.

◆ userData

void* pandora::TiXmlBase::userData
protectedinherited

Field containing a generic user pointer.

Definition at line 383 of file tinyxml.h.

◆ utf8ByteTable

const int pandora::TiXmlBase::utf8ByteTable
staticinherited
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 260 of file tinyxml.h.

◆ value

TIXML_STRING pandora::TiXmlAttribute::value
private

Definition at line 892 of file tinyxml.h.


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