TiXmlDeclaration Class Reference

#include <tinyxml.h>

Inheritance diagram for TiXmlDeclaration:

List of all members.

Public Member Functions
virtual bool	Accept (TiXmlVisitor *visitor) const
virtual bool	Accept (TiXmlVisitor *visitor) const
virtual TiXmlNode *	Clone () const
	Creates a copy of this Declaration and returns it.
virtual TiXmlNode *	Clone () const
	Creates a copy of this Declaration and returns it.
const char *	Encoding () const
	Encoding. Will return an empty string if none was found.
const char *	Encoding () const
	Encoding. Will return an empty string if none was found.
TiXmlDeclaration &	operator= (const TiXmlDeclaration &copy)
void	operator= (const TiXmlDeclaration &copy)
virtual const char *	Parse (const char *p, TiXmlParsingData *data, TiXmlEncoding encoding)
virtual const char *	Parse (const char *p, TiXmlParsingData *data, TiXmlEncoding encoding)
virtual void	Print (FILE *cfile, int depth, TIXML_STRING *str) const
virtual void	Print (FILE *cfile, int depth) const
virtual void	Print (FILE *cfile, int depth, TIXML_STRING *str) const
virtual void	Print (FILE *cfile, int depth) const
const char *	Standalone () const
	Is this a standalone document?
const char *	Standalone () const
	Is this a standalone document?
	TiXmlDeclaration (const char *_version, const char *_encoding, const char *_standalone)
	Construct.
	TiXmlDeclaration (const TiXmlDeclaration &copy)
	TiXmlDeclaration ()
	Construct an empty declaration.
	TiXmlDeclaration ()
	Construct an empty declaration.
	TiXmlDeclaration (const char *_version, const char *_encoding, const char *_standalone)
	Construct.
	TiXmlDeclaration (const TiXmlDeclaration &copy)
	TiXmlDeclaration (const std::string &_version, const std::string &_encoding, const std::string &_standalone)
	Constructor.
	TiXmlDeclaration (const std::string &_version, const std::string &_encoding, const std::string &_standalone)
	Constructor.
virtual TiXmlDeclaration *	ToDeclaration ()
	Cast to a more defined type. Will return null not of the requested type.
virtual TiXmlDeclaration *	ToDeclaration ()
	Cast to a more defined type. Will return null not of the requested type.
virtual const TiXmlDeclaration *	ToDeclaration () const
	Cast to a more defined type. Will return null not of the requested type.
virtual const TiXmlDeclaration *	ToDeclaration () const
	Cast to a more defined type. Will return null not of the requested type.
const char *	Version () const
	Version. Will return an empty string if none was found.
const char *	Version () const
	Version. Will return an empty string if none was found.
virtual	~TiXmlDeclaration ()
virtual	~TiXmlDeclaration ()
Protected Member Functions
void	CopyTo (TiXmlDeclaration *target) const
void	CopyTo (TiXmlDeclaration *target) const
virtual void	StreamIn (std::istream *in, TIXML_STRING *tag)
virtual void	StreamIn (std::istream *in, TIXML_STRING *tag)
Private Attributes
TIXML_STRING	encoding
TIXML_STRING	standalone
TIXML_STRING	version

---

Detailed Description

In correct XML the declaration is the first entry in the file.

		<?xml version="1.0" standalone="yes"?>
	

TinyXml will happily read or write files without a declaration, however. There are 3 possible attributes to the declaration: version, encoding, and standalone.

Note: In this version of the code, the attributes are handled as special cases, not generic attributes, simply because there can only be at most 3 and they are always the same.

Definition at line 1280 of file tinyxml.h.

---

Constructor & Destructor Documentation

TiXmlDeclaration::TiXmlDeclaration

(

)

[inline]

Construct an empty declaration.

Definition at line 1284 of file tinyxml.h.

Referenced by Clone().

: TiXmlNode( TiXmlNode::DECLARATION ) {}

TiXmlDeclaration::TiXmlDeclaration	(	const std::string &	_version,
		const std::string &	_encoding,
		const std::string &	_standalone
	)

Constructor.

TiXmlDeclaration::TiXmlDeclaration	(	const char *	_version,
		const char *	_encoding,
		const char *	_standalone
	)

Construct.

Definition at line 1399 of file tinyxml.cc.

References encoding, standalone, and version.

        : TiXmlNode( TiXmlNode::DECLARATION )
{
        version = _version;
        encoding = _encoding;
        standalone = _standalone;
}

TiXmlDeclaration::TiXmlDeclaration

(

const TiXmlDeclaration &

copy

)

Definition at line 1423 of file tinyxml.cc.

References CopyTo().

        : TiXmlNode( TiXmlNode::DECLARATION )
{
        copy.CopyTo( this );
}

virtual TiXmlDeclaration::~TiXmlDeclaration

(

)

[inline, virtual]

Definition at line 1301 of file tinyxml.h.

{}

TiXmlDeclaration::TiXmlDeclaration

(

)

[inline]

Construct an empty declaration.

Definition at line 1212 of file tinyxml.h.

: TiXmlNode( TiXmlNode::DECLARATION ) {}

TiXmlDeclaration::TiXmlDeclaration	(	const std::string &	_version,
		const std::string &	_encoding,
		const std::string &	_standalone
	)

Constructor.

TiXmlDeclaration::TiXmlDeclaration	(	const char *	_version,
		const char *	_encoding,
		const char *	_standalone
	)

Construct.

TiXmlDeclaration::TiXmlDeclaration

(

const TiXmlDeclaration &

copy

)

virtual TiXmlDeclaration::~TiXmlDeclaration

(

)

[inline, virtual]

Definition at line 1227 of file tinyxml.h.

{}

---

Member Function Documentation

bool TiXmlDeclaration::Accept

(

TiXmlVisitor *

visitor

)

const [virtual]

Walk the XML tree visiting this node and all of its children.

Implements TiXmlNode.

Definition at line 1470 of file tinyxml.cc.

References TiXmlVisitor::Visit().

{
        return visitor->Visit( *this );
}

virtual bool TiXmlDeclaration::Accept

(

TiXmlVisitor *

visitor

)

const [virtual]

Walk the XML tree visiting this node and all of its children.

Implements TiXmlNode.

TiXmlNode * TiXmlDeclaration::Clone

(

)

const [virtual]

Creates a copy of this Declaration and returns it.

Implements TiXmlNode.

Definition at line 1476 of file tinyxml.cc.

References clone(), CopyTo(), and TiXmlDeclaration().

{
        TiXmlDeclaration* clone = new TiXmlDeclaration();

        if ( !clone )
                return 0;

        CopyTo( clone );
        return clone;
}

virtual TiXmlNode* TiXmlDeclaration::Clone

(

)

const [virtual]

Creates a copy of this Declaration and returns it.

Implements TiXmlNode.

void TiXmlDeclaration::CopyTo

(

TiXmlDeclaration *

target

)

const [protected]

Definition at line 1460 of file tinyxml.cc.

References encoding, standalone, and version.

Referenced by Clone(), operator=(), and TiXmlDeclaration().

{
        TiXmlNode::CopyTo( target );

        target->version = version;
        target->encoding = encoding;
        target->standalone = standalone;
}

void TiXmlDeclaration::CopyTo

(

TiXmlDeclaration *

target

)

const [protected]

const char* TiXmlDeclaration::Encoding

(

)

const [inline]

Encoding. Will return an empty string if none was found.

Definition at line 1232 of file tinyxml.h.

References encoding.

{ return encoding.c_str (); }

const char* TiXmlDeclaration::Encoding

(

)

const [inline]

Encoding. Will return an empty string if none was found.

Definition at line 1306 of file tinyxml.h.

References encoding.

Referenced by TiXmlDocument::Parse().

{ return encoding.c_str (); }

TiXmlDeclaration & TiXmlDeclaration::operator=

(

const TiXmlDeclaration &

copy

)

Definition at line 1430 of file tinyxml.cc.

References TiXmlNode::Clear(), and CopyTo().

{
        Clear();
        copy.CopyTo( this );
        return *this;
}

void TiXmlDeclaration::operator=

(

const TiXmlDeclaration &

copy

)

const char * TiXmlDeclaration::Parse	(	const char *	p,
		TiXmlParsingData *	data,
		TiXmlEncoding	encoding
	)		[virtual]

Implements TiXmlBase.

Definition at line 1582 of file tinyxmlparser.cc.

References TiXmlParsingData::Cursor(), encoding, TiXmlNode::GetDocument(), TiXmlBase::IsWhiteSpace(), TiXmlBase::location, AlCaHLTBitMon_ParallelJobs::p, TiXmlAttribute::Parse(), TiXmlDocument::SetError(), TiXmlBase::SkipWhiteSpace(), TiXmlParsingData::Stamp(), standalone, TiXmlBase::StringEqual(), TiXmlBase::TIXML_ERROR_PARSING_DECLARATION, TiXmlAttribute::Value(), and version.

{
        p = SkipWhiteSpace( p, _encoding );
        // Find the beginning, find the end, and look for
        // the stuff in-between.
        TiXmlDocument* document = GetDocument();
        if ( !p || !*p || !StringEqual( p, "<?xml", true, _encoding ) )
        {
                if ( document ) document->SetError( TIXML_ERROR_PARSING_DECLARATION, 0, 0, _encoding );
                return 0;
        }
        if ( data )
        {
                data->Stamp( p, _encoding );
                location = data->Cursor();
        }
        p += 5;

        version = "";
        encoding = "";
        standalone = "";

        while ( p && *p )
        {
                if ( *p == '>' )
                {
                        ++p;
                        return p;
                }

                p = SkipWhiteSpace( p, _encoding );
                if ( StringEqual( p, "version", true, _encoding ) )
                {
                        TiXmlAttribute attrib;
                        p = attrib.Parse( p, data, _encoding );
                        version = attrib.Value();
                }
                else if ( StringEqual( p, "encoding", true, _encoding ) )
                {
                        TiXmlAttribute attrib;
                        p = attrib.Parse( p, data, _encoding );
                        encoding = attrib.Value();
                }
                else if ( StringEqual( p, "standalone", true, _encoding ) )
                {
                        TiXmlAttribute attrib;
                        p = attrib.Parse( p, data, _encoding );
                        standalone = attrib.Value();
                }
                else
                {
                        // Read over whatever it is.
                        while( p && *p && *p != '>' && !IsWhiteSpace( *p ) )
                                ++p;
                }
        }
        return 0;
}

virtual const char* TiXmlDeclaration::Parse	(	const char *	p,
		TiXmlParsingData *	data,
		TiXmlEncoding	encoding
	)		[virtual]

Implements TiXmlBase.

void TiXmlDeclaration::Print	(	FILE *	cfile,
		int	depth,
		TIXML_STRING *	str
	)		const [virtual]

Definition at line 1438 of file tinyxml.cc.

References encoding, standalone, and version.

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

{
        if ( cfile ) fprintf( cfile, "<?xml " );
        if ( str )       (*str) += "<?xml ";

        if ( !version.empty() ) {
                if ( cfile ) fprintf (cfile, "version=\"%s\" ", version.c_str ());
                if ( str ) { (*str) += "version=\""; (*str) += version; (*str) += "\" "; }
        }
        if ( !encoding.empty() ) {
                if ( cfile ) fprintf (cfile, "encoding=\"%s\" ", encoding.c_str ());
                if ( str ) { (*str) += "encoding=\""; (*str) += encoding; (*str) += "\" "; }
        }
        if ( !standalone.empty() ) {
                if ( cfile ) fprintf (cfile, "standalone=\"%s\" ", standalone.c_str ());
                if ( str ) { (*str) += "standalone=\""; (*str) += standalone; (*str) += "\" "; }
        }
        if ( cfile ) fprintf( cfile, "?>" );
        if ( str )       (*str) += "?>";
}

virtual void TiXmlDeclaration::Print	(	FILE *	cfile,
		int	depth,
		TIXML_STRING *	str
	)		const [virtual]

virtual void TiXmlDeclaration::Print	(	FILE *	cfile,
		int	depth
	)		const [inline, virtual]

All TinyXml classes can print themselves to a filestream or the string class (TiXmlString in non-STL mode, std::string in STL mode.) Either or both cfile and str can be null.

This is a formatted print, and will insert tabs and newlines.

(For an unformatted stream, use the << operator.)

Implements TiXmlBase.

Definition at line 1240 of file tinyxml.h.

References Print().

                                                           {
                Print( cfile, depth, 0 );
        }

virtual void TiXmlDeclaration::Print	(	FILE *	cfile,
		int	depth
	)		const [inline, virtual]

All TinyXml classes can print themselves to a filestream or the string class (TiXmlString in non-STL mode, std::string in STL mode.) Either or both cfile and str can be null.

This is a formatted print, and will insert tabs and newlines.

(For an unformatted stream, use the << operator.)

Implements TiXmlBase.

Definition at line 1314 of file tinyxml.h.

References Print().

                                                           {
                Print( cfile, depth, 0 );
        }

const char* TiXmlDeclaration::Standalone

(

)

const [inline]

Is this a standalone document?

Definition at line 1234 of file tinyxml.h.

References standalone.

{ return standalone.c_str (); }

const char* TiXmlDeclaration::Standalone

(

)

const [inline]

Is this a standalone document?

Definition at line 1308 of file tinyxml.h.

References standalone.

{ return standalone.c_str (); }

virtual void TiXmlDeclaration::StreamIn	(	std::istream *	in,
		TIXML_STRING *	tag
	)		[protected, virtual]

Implements TiXmlNode.

virtual void TiXmlDeclaration::StreamIn	(	std::istream *	in,
		TIXML_STRING *	tag
	)		[protected, virtual]

Implements TiXmlNode.

virtual TiXmlDeclaration* TiXmlDeclaration::ToDeclaration

(

)

[inline, virtual]

Cast to a more defined type. Will return null not of the requested type.

Reimplemented from TiXmlNode.

Definition at line 1321 of file tinyxml.h.

virtual const TiXmlDeclaration* TiXmlDeclaration::ToDeclaration

(

)

const [inline, virtual]

Cast to a more defined type. Will return null not of the requested type.

Reimplemented from TiXmlNode.

Definition at line 1246 of file tinyxml.h.

virtual const TiXmlDeclaration* TiXmlDeclaration::ToDeclaration

(

)

const [inline, virtual]

Cast to a more defined type. Will return null not of the requested type.

Reimplemented from TiXmlNode.

Definition at line 1320 of file tinyxml.h.

virtual TiXmlDeclaration* TiXmlDeclaration::ToDeclaration

(

)

[inline, virtual]

Cast to a more defined type. Will return null not of the requested type.

Reimplemented from TiXmlNode.

Definition at line 1247 of file tinyxml.h.

const char* TiXmlDeclaration::Version

(

)

const [inline]

Version. Will return an empty string if none was found.

Definition at line 1304 of file tinyxml.h.

References version.

{ return version.c_str (); }

const char* TiXmlDeclaration::Version

(

)

const [inline]

Version. Will return an empty string if none was found.

Definition at line 1230 of file tinyxml.h.

References version.

{ return version.c_str (); }

---

Member Data Documentation

TIXML_STRING TiXmlDeclaration::encoding [private]

Definition at line 1337 of file tinyxml.h.

Referenced by CopyTo(), Encoding(), Parse(), Print(), and TiXmlDeclaration().

TIXML_STRING TiXmlDeclaration::standalone [private]

Definition at line 1338 of file tinyxml.h.

Referenced by CopyTo(), Parse(), Print(), Standalone(), and TiXmlDeclaration().

TIXML_STRING TiXmlDeclaration::version [private]

Definition at line 1336 of file tinyxml.h.

Referenced by CopyTo(), Parse(), Print(), TiXmlDeclaration(), and Version().