xmlTiny::TiXmlComment Class Reference

An XML comment. More...

#include <OBTtinyxml.h>

Inheritance diagram for xmlTiny::TiXmlComment:

[legend]

Collaboration diagram for xmlTiny::TiXmlComment:

[legend]

List of all members.

Public Member Functions
	TiXmlComment ()
	Constructs an empty comment.
	TiXmlComment (const char *_value)
	Construct a comment from text.
	TiXmlComment (const TiXmlComment &)
void	operator= (const TiXmlComment &base)
virtual	~TiXmlComment ()
virtual TiXmlNode *	Clone () const
	Returns a copy of this Comment.
virtual void	Print (FILE *cfile, int depth) const
	All TinyXml classes can print themselves to a filestream or the string class (TiXmlString in non-STL mode, std::string in STL mode.
virtual const char *	Parse (const char *p, TiXmlParsingData *data, TiXmlEncoding encoding)
virtual const TiXmlComment *	ToComment () const
	Cast to a more defined type. Will return null not of the requested type.
virtual TiXmlComment *	ToComment ()
	Cast to a more defined type. Will return null not of the requested type.
virtual bool	Accept (TiXmlVisitor *visitor) const
	Walk the XML tree visiting this node and all of its children.
Protected Member Functions
void	CopyTo (TiXmlComment *target) const
virtual void	StreamIn (std::istream *in, TIXML_STRING *tag)

---

Detailed Description

An XML comment.

Definition at line 1159 of file tiny/tmp/OBTtinyxml.h.

---

Constructor & Destructor Documentation

xmlTiny::TiXmlComment::TiXmlComment

(

)

[inline]

Constructs an empty comment.

Definition at line 1163 of file tiny/tmp/OBTtinyxml.h.

Referenced by Clone().

: TiXmlNode( TiXmlNode::COMMENT ) {}

xmlTiny::TiXmlComment::TiXmlComment

(

const char *

_value

)

[inline]

Construct a comment from text.

Definition at line 1165 of file tiny/tmp/OBTtinyxml.h.

References xmlTiny::TiXmlNode::SetValue().

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

xmlTiny::TiXmlComment::TiXmlComment

(

const TiXmlComment &

copy

)

Definition at line 1290 of file tiny/tmp/OBTtinyxml.cpp.

References CopyTo().

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

virtual xmlTiny::TiXmlComment::~TiXmlComment

(

)

[inline, virtual]

Definition at line 1171 of file tiny/tmp/OBTtinyxml.h.

{}

---

Member Function Documentation

void xmlTiny::TiXmlComment::operator=

(

const TiXmlComment &

base

)

Definition at line 1296 of file tiny/tmp/OBTtinyxml.cpp.

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

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

TiXmlNode * xmlTiny::TiXmlComment::Clone

(

)

const [virtual]

Returns a copy of this Comment.

Implements xmlTiny::TiXmlNode.

Definition at line 1326 of file tiny/tmp/OBTtinyxml.cpp.

References CopyTo(), and TiXmlComment().

{
        TiXmlComment* clone = new TiXmlComment();

        if ( !clone )
                return 0;

        CopyTo( clone );
        return clone;
}

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

Definition at line 1303 of file tiny/tmp/OBTtinyxml.cpp.

References xmlTiny::TiXmlNode::value.

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

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

Implements xmlTiny::TiXmlBase.

Definition at line 1337 of file tiny/tmp/OBTtinyxmlparser.cpp.

References xmlTiny::TiXmlParsingData::Cursor(), xmlTiny::TiXmlNode::GetDocument(), xmlTiny::TiXmlBase::location, xmlTiny::TiXmlDocument::SetError(), xmlTiny::TiXmlBase::SkipWhiteSpace(), xmlTiny::TiXmlParsingData::Stamp(), xmlTiny::TiXmlBase::StringEqual(), xmlTiny::TiXmlBase::TIXML_ERROR_PARSING_COMMENT, and xmlTiny::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;
}

virtual const TiXmlComment* xmlTiny::TiXmlComment::ToComment

(

)

const [inline, virtual]

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

Reimplemented from xmlTiny::TiXmlNode.

Definition at line 1183 of file tiny/tmp/OBTtinyxml.h.

virtual TiXmlComment* xmlTiny::TiXmlComment::ToComment

(

)

[inline, virtual]

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

Reimplemented from xmlTiny::TiXmlNode.

Definition at line 1184 of file tiny/tmp/OBTtinyxml.h.

bool xmlTiny::TiXmlComment::Accept

(

TiXmlVisitor *

visitor

)

const [virtual]

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

Implements xmlTiny::TiXmlNode.

Definition at line 1320 of file tiny/tmp/OBTtinyxml.cpp.

References xmlTiny::TiXmlVisitor::Visit().

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

void xmlTiny::TiXmlComment::CopyTo

(

TiXmlComment *

target

)

const [protected]

Definition at line 1314 of file tiny/tmp/OBTtinyxml.cpp.

References xmlTiny::TiXmlNode::CopyTo().

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

{
        TiXmlNode::CopyTo( target );
}

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

Implements xmlTiny::TiXmlNode.

---