TiXmlAttribute Class Reference

#include <tinyxml.h>

Inheritance 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
const TiXmlAttribute *	Next () const
	Get the next sibling attribute in the DOM. Returns null at end. More...
TiXmlAttribute *	Next ()
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)
const TiXmlAttribute *	Previous () const
	Get the previous sibling attribute in the DOM. Returns null at beginning. More...
TiXmlAttribute *	Previous ()
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	SetName (const std::string &_name)
	STL std::string form. More...
void	SetValue (const char *_value)
	Set the value. More...
void	SetValue (const std::string &_value)
	STL std::string form. More...
	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 *	Value () const
	Return the value of this attribute. More...
const std::string &	ValueStr () 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
TiXmlAttribute &	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_OUT_OF_MEMORY,   TIXML_ERROR_PARSING_ELEMENT, TIXML_ERROR_FAILED_TO_READ_ELEMENT_NAME, TIXML_ERROR_READING_ELEMENT_VALUE, TIXML_ERROR_READING_ATTRIBUTES,   TIXML_ERROR_PARSING_EMPTY, TIXML_ERROR_READING_END_TAG, TIXML_ERROR_PARSING_UNKNOWN, TIXML_ERROR_PARSING_COMMENT,   TIXML_ERROR_PARSING_DECLARATION, TIXML_ERROR_DOCUMENT_EMPTY, TIXML_ERROR_EMBEDDED_NULL, TIXML_ERROR_PARSING_CDATA,   TIXML_ERROR_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	StreamTo (std::istream *in, int character, TIXML_STRING *tag)
static bool	StreamWhiteSpace (std::istream *in, TIXML_STRING *tag)
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.

Definition at line 783 of file tinyxml.h.

Constructor & Destructor Documentation

TiXmlAttribute::TiXmlAttribute ( )

inline

Construct an empty attribute.

Definition at line 789 of file tinyxml.h.

References document, next, and prev.

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

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

inline

std::string constructor.

Definition at line 797 of file tinyxml.h.

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

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

inline

Construct an attribute with a name and value.

Definition at line 807 of file tinyxml.h.

References document, name, next, prev, and value.

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

TiXmlAttribute::TiXmlAttribute ( const TiXmlAttribute &  )

private

Member Function Documentation

double TiXmlAttribute::DoubleValue

(

)

const

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

Definition at line 1297 of file tinyxml.cc.

References value.

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

int TiXmlAttribute::IntValue

(

)

const

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

Definition at line 1292 of file tinyxml.cc.

References value.

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

const char* TiXmlAttribute::Name ( ) const

inline

Return the name of this attribute.

Definition at line 815 of file tinyxml.h.

References name.

Referenced by TiXmlAttributeSet::Add(), TiXmlElement::CopyTo(), and TiXmlElement::Parse().

const TIXML_STRING& TiXmlAttribute::NameTStr ( ) const

inline

Definition at line 824 of file tinyxml.h.

References name.

Referenced by TiXmlElement::Parse().

{ return name; }

const TiXmlAttribute * TiXmlAttribute::Next

(

)

const

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

Definition at line 1184 of file tinyxml.cc.

References name, next, and value.

Referenced by TiXmlElement::CopyTo(), 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;
}

TiXmlAttribute* TiXmlAttribute::Next ( )

inline

Definition at line 854 of file tinyxml.h.

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

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

inline

Definition at line 865 of file tinyxml.h.

References name.

{ return name < rhs.name; }

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

private

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

inline

Definition at line 864 of file tinyxml.h.

References name.

{ return rhs.name == name; }

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

inline

Definition at line 866 of file tinyxml.h.

References name.

{ return name > rhs.name; }

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

virtual

Implements TiXmlBase.

Definition at line 1403 of file tinyxmlparser.cc.

References TiXmlParsingData::Cursor(), document, end, TiXmlBase::IsWhiteSpace(), TiXmlBase::location, name, AlCaHLTBitMon_ParallelJobs::p, TiXmlBase::ReadName(), TiXmlBase::ReadText(), TiXmlDocument::SetError(), TiXmlBase::SkipWhiteSpace(), TiXmlParsingData::Stamp(), TiXmlBase::TIXML_ERROR_READING_ATTRIBUTES, and value.

Referenced by TiXmlElement::Parse(), and TiXmlDeclaration::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;
}

const TiXmlAttribute * TiXmlAttribute::Previous

(

)

const

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

Definition at line 1204 of file tinyxml.cc.

References name, prev, and value.

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

TiXmlAttribute* TiXmlAttribute::Previous ( )

inline

Definition at line 860 of file tinyxml.h.

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

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

                                                       {
        Print( cfile, depth, 0 );
    }

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

Definition at line 1224 of file tinyxml.cc.

References TiXmlBase::EncodeString(), n, name, TIXML_STRING, findQualityFiles::v, and value.

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

int TiXmlAttribute::QueryDoubleValue

(

double *

_value

)

const

QueryDoubleValue examines the value string. See QueryIntValue().

Definition at line 1260 of file tinyxml.cc.

References TIXML_SUCCESS, TIXML_WRONG_TYPE, and value.

Referenced by TiXmlElement::QueryDoubleAttribute().

{
        try {
          *dval = boost::lexical_cast<double>(value);
        } catch(boost::bad_lexical_cast const&) {
      return TIXML_WRONG_TYPE;
        }
    return TIXML_SUCCESS;
}

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 1250 of file tinyxml.cc.

References TIXML_SUCCESS, TIXML_WRONG_TYPE, and value.

Referenced by TiXmlElement::QueryIntAttribute().

{
        try {
          *ival = boost::lexical_cast<int>(value);
        } catch(boost::bad_lexical_cast const&) {
      return TIXML_WRONG_TYPE;
        }
    return TIXML_SUCCESS;
}

void TiXmlAttribute::SetDocument ( TiXmlDocument *  doc )

inline

Definition at line 881 of file tinyxml.h.

References asciidump::doc, and document.

Referenced by TiXmlElement::Parse().

{ document = doc; }

void TiXmlAttribute::SetDoubleValue

(

double

_value

)

Set the value from a double.

Definition at line 1281 of file tinyxml.cc.

References SetValue().

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

void TiXmlAttribute::SetIntValue

(

int

_value

)

Set the value from an integer.

Definition at line 1270 of file tinyxml.cc.

References SetValue().

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

void TiXmlAttribute::SetName ( const char *  _name )

inline

Set the name of this attribute.

Definition at line 839 of file tinyxml.h.

References name.

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

inline

STL std::string form.

Definition at line 847 of file tinyxml.h.

{ name = _name; }

void TiXmlAttribute::SetValue ( const char *  _value )

inline

Set the value.

Definition at line 840 of file tinyxml.h.

References value.

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

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

inline

STL std::string form.

Definition at line 849 of file tinyxml.h.

References value.

{ value = _value; }

const char* TiXmlAttribute::Value ( ) const

inline

Return the value of this attribute.

Definition at line 816 of file tinyxml.h.

References value.

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

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

inline

Return the value of this attribute.

Definition at line 818 of file tinyxml.h.

References value.

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

Friends And Related Function Documentation

friend class TiXmlAttributeSet

friend

Definition at line 785 of file tinyxml.h.

Member Data Documentation

TiXmlDocument* TiXmlAttribute::document

private

Definition at line 887 of file tinyxml.h.

Referenced by Parse(), SetDocument(), and TiXmlAttribute().

TIXML_STRING TiXmlAttribute::name

private

Definition at line 888 of file tinyxml.h.

Referenced by dirstructure.Directory::__create_pie_image(), dqm_interfaces.DirID::__eq__(), dirstructure.Directory::__get_full_path(), dirstructure.Comparison::__get_img_name(), dataset.Dataset::__getFileInfoList(), cuy.divideElement::__init__(), cuy.plotElement::__init__(), cuy.additionElement::__init__(), cuy.superimposeElement::__init__(), cuy.graphElement::__init__(), dirstructure.Comparison::__make_image(), dirstructure.Directory::__repr__(), dqm_interfaces.DirID::__repr__(), dirstructure.Comparison::__repr__(), dirstructure.Directory::calcStats(), python.rootplot.utilities.Hist::divide(), python.rootplot.utilities.Hist::divide_wilson(), utils.StatisticalTest::get_status(), Name(), NameTStr(), Next(), operator<(), operator==(), operator>(), Parse(), Previous(), Print(), dirstructure.Directory::print_report(), SetName(), python.rootplot.utilities.Hist::TGraph(), python.rootplot.utilities.Hist::TH1F(), TiXmlAttribute(), and Vispa.Views.PropertyView.Property::valueChanged().

TiXmlAttribute* TiXmlAttribute::next

private

Definition at line 891 of file tinyxml.h.

Referenced by BeautifulSoup.PageElement::_invert(), TiXmlAttributeSet::Add(), TiXmlAttributeSet::Find(), TiXmlAttributeSet::First(), Next(), TiXmlAttributeSet::Remove(), TiXmlAttribute(), TiXmlAttributeSet::TiXmlAttributeSet(), and TiXmlAttributeSet::~TiXmlAttributeSet().

TiXmlAttribute* TiXmlAttribute::prev

private

Definition at line 890 of file tinyxml.h.

Referenced by TiXmlAttributeSet::Add(), TiXmlAttributeSet::Last(), Previous(), TiXmlAttributeSet::Remove(), TiXmlAttribute(), TiXmlAttributeSet::TiXmlAttributeSet(), and TiXmlAttributeSet::~TiXmlAttributeSet().

TIXML_STRING TiXmlAttribute::value

private

Definition at line 889 of file tinyxml.h.

Referenced by Types.int32::__nonzero__(), Types.uint32::__nonzero__(), Types.int64::__nonzero__(), Types.uint64::__nonzero__(), Types.double::__nonzero__(), Types.bool::__nonzero__(), Types.string::__nonzero__(), Vispa.Views.PropertyView.FileProperty::buttonClicked(), Types.string::configValue(), Types.FileInPath::configValue(), DoubleValue(), Mixins.UsingBlock::dumpPython(), Types.int32::insertInto(), Types.uint32::insertInto(), Types.int64::insertInto(), Types.uint64::insertInto(), Mixins.UsingBlock::insertInto(), Types.double::insertInto(), Types.bool::insertInto(), Types.string::insertInto(), Types.FileInPath::insertInto(), Types.vint32::insertInto(), Types.vuint32::insertInto(), Types.vint64::insertInto(), Types.vuint64::insertInto(), Types.vdouble::insertInto(), Types.vbool::insertInto(), Types.vstring::insertInto(), IntValue(), Vispa.Views.PropertyView.FileProperty::labelDoubleClicked(), Next(), Parse(), Previous(), Print(), QueryDoubleValue(), QueryIntValue(), SetValue(), TiXmlAttribute(), Value(), and ValueStr().