TiXmlComment Class Reference

#include <tinyxml.h>

Inheritance diagram for TiXmlComment:

Public Member Functions
virtual bool	Accept (TiXmlVisitor *visitor) const
virtual TiXmlNode *	Clone () const
	Returns a copy of this Comment. More...
TiXmlComment &	operator= (const TiXmlComment &base)
virtual const char *	Parse (const char *p, TiXmlParsingData *data, TiXmlEncoding encoding)
virtual void	Print (FILE *cfile, int depth) const
	TiXmlComment ()
	Constructs an empty comment. More...
	TiXmlComment (const char *_value)
	Construct a comment from text. More...
	TiXmlComment (const TiXmlComment &)
virtual const TiXmlComment *	ToComment () const
	Cast to a more defined type. Will return null not of the requested type. More...
virtual TiXmlComment *	ToComment ()
	Cast to a more defined type. Will return null not of the requested type. More...
virtual	~TiXmlComment ()
Public Member Functions inherited from TiXmlNode
void	Clear ()
	Delete all the children of this node. Does not affect 'this'. More...
const TiXmlNode *	FirstChild () const
	The first child of this node. Will be null if there are no children. More...
TiXmlNode *	FirstChild ()
const TiXmlNode *	FirstChild (const char *value) const
TiXmlNode *	FirstChild (const char *_value)
	The first child of this node with the matching 'value'. Will be null if none found. More...
const TiXmlNode *	FirstChild (const std::string &_value) const
	STL std::string form. More...
TiXmlNode *	FirstChild (const std::string &_value)
	STL std::string form. More...
const TiXmlElement *	FirstChildElement () const
	Convenience function to get through elements. More...
TiXmlElement *	FirstChildElement ()
const TiXmlElement *	FirstChildElement (const char *_value) const
	Convenience function to get through elements. More...
TiXmlElement *	FirstChildElement (const char *_value)
const TiXmlElement *	FirstChildElement (const std::string &_value) const
	STL std::string form. More...
TiXmlElement *	FirstChildElement (const std::string &_value)
	STL std::string form. More...
const TiXmlDocument *	GetDocument () const
TiXmlDocument *	GetDocument ()
TiXmlNode *	InsertAfterChild (TiXmlNode *afterThis, const TiXmlNode &addThis)
TiXmlNode *	InsertBeforeChild (TiXmlNode *beforeThis, const TiXmlNode &addThis)
TiXmlNode *	InsertEndChild (const TiXmlNode &addThis)
const TiXmlNode *	IterateChildren (const TiXmlNode *previous) const
TiXmlNode *	IterateChildren (const TiXmlNode *previous)
const TiXmlNode *	IterateChildren (const char *value, const TiXmlNode *previous) const
	This flavor of IterateChildren searches for children with a particular 'value'. More...
TiXmlNode *	IterateChildren (const char *_value, const TiXmlNode *previous)
const TiXmlNode *	IterateChildren (const std::string &_value, const TiXmlNode *previous) const
	STL std::string form. More...
TiXmlNode *	IterateChildren (const std::string &_value, const TiXmlNode *previous)
	STL std::string form. More...
const TiXmlNode *	LastChild () const
TiXmlNode *	LastChild ()
	The last child of this node. Will be null if there are no children. More...
const TiXmlNode *	LastChild (const char *value) const
TiXmlNode *	LastChild (const char *_value)
	The last child of this node matching 'value'. Will be null if there are no children. More...
const TiXmlNode *	LastChild (const std::string &_value) const
	STL std::string form. More...
TiXmlNode *	LastChild (const std::string &_value)
	STL std::string form. More...
TiXmlNode *	LinkEndChild (TiXmlNode *addThis)
const TiXmlNode *	NextSibling (const std::string &_value) const
	STL std::string form. More...
TiXmlNode *	NextSibling (const std::string &_value)
	STL std::string form. More...
const TiXmlNode *	NextSibling () const
	Navigate to a sibling node. More...
TiXmlNode *	NextSibling ()
const TiXmlNode *	NextSibling (const char *) const
	Navigate to a sibling node with the given 'value'. More...
TiXmlNode *	NextSibling (const char *_next)
const TiXmlElement *	NextSiblingElement () const
TiXmlElement *	NextSiblingElement ()
const TiXmlElement *	NextSiblingElement (const char *) const
TiXmlElement *	NextSiblingElement (const char *_next)
const TiXmlElement *	NextSiblingElement (const std::string &_value) const
	STL std::string form. More...
TiXmlElement *	NextSiblingElement (const std::string &_value)
	STL std::string form. More...
bool	NoChildren () const
	Returns true if this node has no children. More...
TiXmlNode *	Parent ()
	One step up the DOM. More...
const TiXmlNode *	Parent () const
const TiXmlNode *	PreviousSibling () const
	Navigate to a sibling node. More...
TiXmlNode *	PreviousSibling ()
const TiXmlNode *	PreviousSibling (const char *) const
	Navigate to a sibling node. More...
TiXmlNode *	PreviousSibling (const char *_prev)
const TiXmlNode *	PreviousSibling (const std::string &_value) const
	STL std::string form. More...
TiXmlNode *	PreviousSibling (const std::string &_value)
	STL std::string form. More...
bool	RemoveChild (TiXmlNode *removeThis)
	Delete a child of this node. More...
TiXmlNode *	ReplaceChild (TiXmlNode *replaceThis, const TiXmlNode &withThis)
void	SetValue (const char *_value)
void	SetValue (const std::string &_value)
	STL std::string form. More...
virtual const TiXmlDeclaration *	ToDeclaration () const
	Cast to a more defined type. Will return null if not of the requested type. More...
virtual TiXmlDeclaration *	ToDeclaration ()
	Cast to a more defined type. Will return null if not of the requested type. More...
virtual const TiXmlDocument *	ToDocument () const
	Cast to a more defined type. Will return null if not of the requested type. More...
virtual TiXmlDocument *	ToDocument ()
	Cast to a more defined type. Will return null if not of the requested type. More...
virtual const TiXmlElement *	ToElement () const
	Cast to a more defined type. Will return null if not of the requested type. More...
virtual TiXmlElement *	ToElement ()
	Cast to a more defined type. Will return null if not of the requested type. More...
virtual const TiXmlText *	ToText () const
	Cast to a more defined type. Will return null if not of the requested type. More...
virtual TiXmlText *	ToText ()
	Cast to a more defined type. Will return null if not of the requested type. More...
virtual const TiXmlUnknown *	ToUnknown () const
	Cast to a more defined type. Will return null if not of the requested type. More...
virtual TiXmlUnknown *	ToUnknown ()
	Cast to a more defined type. Will return null if not of the requested type. More...
int	Type () const
const char *	Value () const
const std::string &	ValueStr () const
const std::string &	ValueTStr () const
virtual	~TiXmlNode ()
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 ()

Protected Member Functions
void	CopyTo (TiXmlComment *target) const
virtual void	StreamIn (std::istream *in, std::string *tag)
Protected Member Functions inherited from TiXmlNode
void	CopyTo (TiXmlNode *target) const
TiXmlNode *	Identify (const char *start, TiXmlEncoding encoding)
	TiXmlNode (NodeType _type)

Additional Inherited Members
Public Types inherited from TiXmlNode
enum	NodeType {   DOCUMENT, ELEMENT, COMMENT, UNKNOWN,   TEXT, DECLARATION, TYPECOUNT }
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 std::string &str, std::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, std::string *name, TiXmlEncoding encoding)
static const char *	ReadText (const char *in, std::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, std::string *tag)
static bool	StreamWhiteSpace (std::istream *in, std::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 TiXmlNode
TiXmlNode *	firstChild
TiXmlNode *	lastChild
TiXmlNode *	next
TiXmlNode *	parent
TiXmlNode *	prev
NodeType	type
std::string	value
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 XML comment.

Definition at line 1157 of file tinyxml.h.

Constructor & Destructor Documentation

TiXmlComment::TiXmlComment ( )

inline

Constructs an empty comment.

Definition at line 1161 of file tinyxml.h.

Referenced by Clone().

: TiXmlNode( TiXmlNode::COMMENT ) {}

TiXmlComment::TiXmlComment ( const char *  _value )

inline

Construct a comment from text.

Definition at line 1163 of file tinyxml.h.

References TiXmlNode::SetValue().

                                       : TiXmlNode( TiXmlNode::COMMENT ) {
        SetValue( _value );
    }

TiXmlComment::TiXmlComment

(

const TiXmlComment &

copy

)

Definition at line 1303 of file tinyxml.cc.

References CopyTo().

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

virtual TiXmlComment::~TiXmlComment ( )

inlinevirtual

Definition at line 1169 of file tinyxml.h.

{}

Member Function Documentation

bool TiXmlComment::Accept ( TiXmlVisitor *  visitor ) const

virtual

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

Implements TiXmlNode.

Definition at line 1334 of file tinyxml.cc.

References TiXmlVisitor::Visit().

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

TiXmlNode * TiXmlComment::Clone ( ) const

virtual

Returns a copy of this Comment.

Implements TiXmlNode.

Definition at line 1340 of file tinyxml.cc.

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

{
    TiXmlComment* clone = new TiXmlComment();

    if ( !clone )
        return 0;

    CopyTo( clone );
    return clone;
}

void TiXmlComment::CopyTo ( TiXmlComment *  target ) const

protected

Definition at line 1328 of file tinyxml.cc.

References TiXmlNode::CopyTo().

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

{
    TiXmlNode::CopyTo( target );
}

TiXmlComment & TiXmlComment::operator=

(

const TiXmlComment &

base

)

Definition at line 1309 of file tinyxml.cc.

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

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

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

virtual

Implements TiXmlBase.

Definition at line 1345 of file tinyxmlparser.cc.

References TiXmlParsingData::Cursor(), TiXmlNode::GetDocument(), TiXmlBase::location, AlCaHLTBitMon_ParallelJobs::p, TiXmlDocument::SetError(), TiXmlBase::SkipWhiteSpace(), TiXmlParsingData::Stamp(), TiXmlBase::StringEqual(), TiXmlBase::TIXML_ERROR_PARSING_COMMENT, and TiXmlNode::value.

{
    TiXmlDocument* document = GetDocument();
    value = "";

    p = SkipWhiteSpace( p, encoding );

    if ( data )
    {
        data->Stamp( p, encoding );
        location = data->Cursor();
    }
    const char* startTag = "<!--";
    const char* endTag   = "-->";

    if ( !StringEqual( p, startTag, false, encoding ) )
    {
        document->SetError( TIXML_ERROR_PARSING_COMMENT, p, data, encoding );
        return 0;
    }
    p += strlen( startTag );

    // [ 1475201 ] TinyXML parses entities in comments
    // Oops - ReadText doesn't work, because we don't want to parse the entities.
    // p = ReadText( p, &value, false, endTag, false, encoding );
    //
    // from the XML spec:
    /*
     [Definition: Comments may appear anywhere in a document outside other markup; in addition,
                  they may appear within the document type declaration at places allowed by the grammar.
                  They are not part of the document's character data; an XML processor MAY, but need not,
                  make it possible for an application to retrieve the text of comments. For compatibility,
                  the string "--" (double-hyphen) MUST NOT occur within comments.] Parameter entity
                  references MUST NOT be recognized within comments.

                  An example of a comment:

                  <!-- declarations for <head> & <body> -->
    */

    value = "";
    // Keep all the white space.
    while ( p && *p && !StringEqual( p, endTag, false, encoding ) )
    {
        value.append( p, 1 );
        ++p;
    }
    if ( p )
        p += strlen( endTag );

    return p;
}

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

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

References i, and TiXmlNode::value.

{
    assert( cfile );
    for ( int i=0; i<depth; i++ )
    {
        fprintf( cfile,  "    " );
    }
    fprintf( cfile, "<!--%s-->", value.c_str() );
}

void TiXmlComment::StreamIn ( std::istream *  in, std::string *  tag  )

protectedvirtual

Implements TiXmlNode.

Definition at line 1318 of file tinyxmlparser.cc.

References trackerHits::c, TiXmlNode::GetDocument(), TiXmlDocument::SetError(), TIXML_ENCODING_UNKNOWN, and TiXmlBase::TIXML_ERROR_EMBEDDED_NULL.

{
    while ( in->good() )
    {
        int c = in->get();
        if ( c <= 0 )
        {
            TiXmlDocument* document = GetDocument();
            if ( document )
                document->SetError( TIXML_ERROR_EMBEDDED_NULL, 0, 0, TIXML_ENCODING_UNKNOWN );
            return;
        }

        (*tag) += (char) c;

        if ( c == '>'
             && tag->at( tag->length() - 2 ) == '-'
             && tag->at( tag->length() - 3 ) == '-' )
        {
            // All is well.
            return;
        }
    }
}

virtual const TiXmlComment* TiXmlComment::ToComment ( ) const

inlinevirtual

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

Reimplemented from TiXmlNode.

Definition at line 1181 of file tinyxml.h.

virtual TiXmlComment* TiXmlComment::ToComment ( )

inlinevirtual

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

Reimplemented from TiXmlNode.

Definition at line 1182 of file tinyxml.h.