TiXmlAttribute Class Reference

#include <tinyxml.h>

Inheritance diagram for TiXmlAttribute:

Collaboration diagram for TiXmlAttribute:

Public Member Functions
double	DoubleValue () const
	Return the value of this attribute, converted to a double. More...
int	IntValue () const
	Return the value of this attribute, converted to an integer. More...
const char *	Name () const
	Return the name of this attribute. More...
const TIXML_STRING &	NameTStr () const
TiXmlAttribute *	Next ()
const TiXmlAttribute *	Next () const
	Get the next sibling attribute in the DOM. Returns null at end. More...
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)
TiXmlAttribute *	Previous ()
const TiXmlAttribute *	Previous () const
	Get the previous sibling attribute in the DOM. Returns null at beginning. More...
virtual void	Print (FILE *cfile, int depth) const
void	Print (FILE *cfile, int depth, TIXML_STRING *str) const
int	QueryDoubleValue (double *_value) const
	QueryDoubleValue examines the value string. See QueryIntValue(). More...
int	QueryIntValue (int *_value) const
void	SetDocument (TiXmlDocument *doc)
void	SetDoubleValue (double _value)
	Set the value from a double. More...
void	SetIntValue (int _value)
	Set the value from an integer. More...
void	SetName (const char *_name)
	Set the name of this attribute. More...
void	SetValue (const char *_value)
	Set the value. More...
	TiXmlAttribute ()
	Construct an empty attribute. More...
	TiXmlAttribute (const char *_name, const char *_value)
	Construct an attribute with a name and value. More...
const char *	Value () const
	Return the value of this attribute. More...
Public Member Functions inherited from TiXmlBase
int	Column () const
	See Row() More...
void *	GetUserData ()
	Get a pointer to arbitrary user data. More...
const void *	GetUserData () const
	Get a pointer to arbitrary user data. More...
int	Row () const
void	SetUserData (void *user)
	Set a pointer to arbitrary user data. More...
	TiXmlBase ()
virtual	~TiXmlBase ()

Private Member Functions
void	operator= (const TiXmlAttribute &base)
	TiXmlAttribute (const TiXmlAttribute &)

Private Attributes
TiXmlDocument *	document
TIXML_STRING	name
TiXmlAttribute *	next
TiXmlAttribute *	prev
TIXML_STRING	value

Friends
class	TiXmlAttributeSet

Additional Inherited Members
Public Types inherited from TiXmlBase
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 }
Static Public Member Functions inherited from TiXmlBase
static void	EncodeString (const TIXML_STRING &str, TIXML_STRING *out)
static bool	IsWhiteSpaceCondensed ()
	Return the current white space setting. More...
static void	SetCondenseWhiteSpace (bool condense)
Static Public Attributes inherited from TiXmlBase
static const int	utf8ByteTable [256]
Static Protected Member Functions inherited from TiXmlBase
static void	ConvertUTF32ToUTF8 (unsigned long input, char *output, int *length)
static const char *	GetChar (const char *p, char *_value, int *length, TiXmlEncoding encoding)
static const char *	GetEntity (const char *in, char *value, int *length, TiXmlEncoding encoding)
static int	IsAlpha (unsigned char anyByte, TiXmlEncoding encoding)
static int	IsAlphaNum (unsigned char anyByte, TiXmlEncoding encoding)
static bool	IsWhiteSpace (char c)
static bool	IsWhiteSpace (int c)
static const char *	ReadName (const char *p, TIXML_STRING *name, TiXmlEncoding encoding)
static const char *	ReadText (const char *in, TIXML_STRING *text, bool ignoreWhiteSpace, const char *endTag, bool ignoreCase, TiXmlEncoding encoding)
static const char *	SkipWhiteSpace (const char *, TiXmlEncoding encoding)
static bool	StringEqual (const char *p, const char *endTag, bool ignoreCase, TiXmlEncoding encoding)
static int	ToLower (int v, TiXmlEncoding encoding)
Protected Attributes inherited from TiXmlBase
TiXmlCursor	location
void *	userData
	Field containing a generic user pointer. More...
Static Protected Attributes inherited from TiXmlBase
static const char *	errorString [TIXML_ERROR_STRING_COUNT]

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.

Constructor & Destructor Documentation

TiXmlAttribute() [1/3]

TiXmlAttribute::TiXmlAttribute ( )

inline

Construct an empty attribute.

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

TiXmlAttribute() [2/3]

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

inline

Construct an attribute with a name and value.

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

TiXmlAttribute() [3/3]

TiXmlAttribute::TiXmlAttribute ( const TiXmlAttribute &  )

private

Member Function Documentation

DoubleValue()

double TiXmlAttribute::DoubleValue

(

)

const

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

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

IntValue()

int TiXmlAttribute::IntValue

(

)

const

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

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

Name()

const char* TiXmlAttribute::Name ( ) const

inline

Return the name of this attribute.

NameTStr()

const TIXML_STRING& TiXmlAttribute::NameTStr ( ) const

inline

{ return name; }

Next() [1/2]

TiXmlAttribute* TiXmlAttribute::Next ( )

inline

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

Next() [2/2]

const TiXmlAttribute * TiXmlAttribute::Next

(

)

const

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

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

operator<()

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

inline

{ return name < rhs.name; }

operator=()

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

private

operator==()

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

inline

{ return rhs.name == name; }

operator>()

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

inline

{ return name > rhs.name; }

Parse()

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

virtual

Implements TiXmlBase.

{
    p = SkipWhiteSpace( p, encoding );
    if ( !p || !*p ) return 0;
 
    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 )                              // 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;
}

Previous() [1/2]

TiXmlAttribute* TiXmlAttribute::Previous ( )

inline

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

Previous() [2/2]

const TiXmlAttribute * TiXmlAttribute::Previous

(

)

const

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

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

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.

                                                       {
        Print( cfile, depth, 0 );
    }

Print() [2/2]

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

{
    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) += "'";
        }
    }
}

QueryDoubleValue()

int TiXmlAttribute::QueryDoubleValue

(

double *

_value

)

const

QueryDoubleValue examines the value string. See QueryIntValue().

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

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.

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

SetDocument()

void TiXmlAttribute::SetDocument ( TiXmlDocument *  doc )

inline

{ document = doc; }

SetDoubleValue()

void TiXmlAttribute::SetDoubleValue

(

double

_value

)

Set the value from a double.

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

SetIntValue()

void TiXmlAttribute::SetIntValue

(

int

_value

)

Set the value from an integer.

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

SetName()

void TiXmlAttribute::SetName ( const char *  _name )

inline

Set the name of this attribute.

SetValue()

void TiXmlAttribute::SetValue ( const char *  _value )

inline

Set the value.

Value()

const char* TiXmlAttribute::Value ( ) const

inline

Return the value of this attribute.

Friends And Related Function Documentation

TiXmlAttributeSet

friend class TiXmlAttributeSet

friend

Member Data Documentation

document

TiXmlDocument* TiXmlAttribute::document

private

name

TIXML_STRING TiXmlAttribute::name

private

next

TiXmlAttribute* TiXmlAttribute::next

private

prev

TiXmlAttribute* TiXmlAttribute::prev

private

value

TIXML_STRING TiXmlAttribute::value

private

---

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

• src/libScan/tinyxml.h
• src/libScan/tinyxml.cpp
• src/libScan/tinyxmlparser.cpp