TiXmlText Class Reference

#include <tinyxml.h>

Inheritance diagram for TiXmlText:

Public Member Functions
virtual bool	Accept (TiXmlVisitor *content) const
bool	CDATA () const
	Queries whether this represents text using a CDATA section. More...
TiXmlText &	operator= (const TiXmlText &base)
virtual const char *	Parse (const char *p, TiXmlParsingData *data, TiXmlEncoding encoding)
virtual void	Print (FILE *cfile, int depth) const
void	SetCDATA (bool _cdata)
	Turns on or off a CDATA representation of text. More...
	TiXmlText (const char *initValue)
	TiXmlText (const std::string &initValue)
	Constructor. More...
	TiXmlText (const TiXmlText &copy)
virtual const TiXmlText *	ToText () const
	Cast to a more defined type. Will return null not of the requested type. More...
virtual TiXmlText *	ToText ()
	Cast to a more defined type. Will return null not of the requested type. More...
virtual	~TiXmlText ()
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 TiXmlComment *	ToComment () const
	Cast to a more defined type. Will return null if not of the requested type. More...
virtual TiXmlComment *	ToComment ()
	Cast to a more defined type. Will return null if not of the requested type. 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 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
bool	Blank () const
virtual TiXmlNode *	Clone () const
	[internal use] Creates a new Element and returns it. More...
void	CopyTo (TiXmlText *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)

Private Attributes
bool	cdata

Friends
class	TiXmlElement

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

XML text. A text node can have 2 ways to output the next. "normal" output and CDATA. It will default to the mode it was parsed from the XML file and you generally want to leave it alone, but you can change the output mode with SetCDATA() and query it with CDATA().

Definition at line 1207 of file tinyxml.h.

Constructor & Destructor Documentation

TiXmlText::TiXmlText ( const char *  initValue )

inline

Constructor for text element. By default, it is treated as normal, encoded text. If you want it be output as a CDATA text element, set the parameter _cdata to 'true'

Definition at line 1215 of file tinyxml.h.

References cdata, and TiXmlNode::SetValue().

Referenced by Clone().

                                        : TiXmlNode (TiXmlNode::TEXT)
    {
        SetValue( initValue );
        cdata = false;
    }

virtual TiXmlText::~TiXmlText ( )

inlinevirtual

Definition at line 1220 of file tinyxml.h.

{}

TiXmlText::TiXmlText ( const std::string &  initValue )

inline

Constructor.

Definition at line 1224 of file tinyxml.h.

                                            : TiXmlNode (TiXmlNode::TEXT)
    {
        SetValue( initValue );
        cdata = false;
    }

TiXmlText::TiXmlText ( const TiXmlText &  copy )

inline

Definition at line 1231 of file tinyxml.h.

References CopyTo().

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

Member Function Documentation

bool TiXmlText::Accept ( TiXmlVisitor *  content ) const

virtual

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

Implements TiXmlNode.

Definition at line 1380 of file tinyxml.cc.

References TiXmlVisitor::Visit().

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

bool TiXmlText::Blank ( ) const

protected

Definition at line 1645 of file tinyxmlparser.cc.

References i, TiXmlBase::IsWhiteSpace(), and TiXmlNode::value.

Referenced by TiXmlElement::ReadValue().

{
    for ( unsigned i=0; i<value.length(); i++ )
        if ( !IsWhiteSpace( value[i] ) )
            return false;
    return true;
}

bool TiXmlText::CDATA ( ) const

inline

Queries whether this represents text using a CDATA section.

Definition at line 1238 of file tinyxml.h.

References cdata.

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

{ return cdata; }

TiXmlNode * TiXmlText::Clone ( ) const

protectedvirtual

[internal use] Creates a new Element and returns it.

Implements TiXmlNode.

Definition at line 1386 of file tinyxml.cc.

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

{
    TiXmlText* clone = 0;
    clone = new TiXmlText( "" );

    if ( !clone )
        return 0;

    CopyTo( clone );
    return clone;
}

void TiXmlText::CopyTo ( TiXmlText *  target ) const

protected

Definition at line 1373 of file tinyxml.cc.

References cdata, and TiXmlNode::CopyTo().

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

{
    TiXmlNode::CopyTo( target );
    target->cdata = cdata;
}

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

inline

Definition at line 1232 of file tinyxml.h.

References CopyTo().

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

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

virtual

Implements TiXmlBase.

Definition at line 1512 of file tinyxmlparser.cc.

References cdata, TiXmlParsingData::Cursor(), end, TiXmlNode::GetDocument(), TiXmlBase::location, AlCaHLTBitMon_ParallelJobs::p, TiXmlBase::ReadText(), TiXmlDocument::SetError(), TiXmlParsingData::Stamp(), TiXmlBase::StringEqual(), TiXmlBase::TIXML_ERROR_PARSING_CDATA, TIXML_STRING, and TiXmlNode::value.

Referenced by TiXmlElement::ReadValue().

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

    if ( data )
    {
        data->Stamp( p, encoding );
        location = data->Cursor();
    }

    const char* const startTag = "<![CDATA[";
    const char* const endTag   = "]]>";

    if ( cdata || StringEqual( p, startTag, false, encoding ) )
    {
        cdata = true;

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

        // Keep all the white space, ignore the encoding, etc.
        while (    p && *p
                && !StringEqual( p, endTag, false, encoding )
              )
        {
            value += *p;
            ++p;
        }

        TIXML_STRING dummy;
        p = ReadText( p, &dummy, false, endTag, false, encoding );
        return p;
    }
    else
    {
        bool ignoreWhite = true;

        const char* end = "<";
        p = ReadText( p, &value, ignoreWhite, end, false, encoding );
        if ( p )
            return p-1; // don't truncate the '<'
        return 0;
    }
}

void TiXmlText::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 1352 of file tinyxml.cc.

References cdata, TiXmlBase::EncodeString(), i, TIXML_STRING, and TiXmlNode::value.

{
    assert( cfile );
    if ( cdata )
    {
        int i;
        fprintf( cfile, "\n" );
        for ( i=0; i<depth; i++ ) {
            fprintf( cfile, "    " );
        }
        fprintf( cfile, "<![CDATA[%s]]>\n", value.c_str() );    // unformatted output
    }
    else
    {
        TIXML_STRING buffer;
        EncodeString( value, &buffer );
        fprintf( cfile, "%s", buffer.c_str() );
    }
}

void TiXmlText::SetCDATA ( bool  _cdata )

inline

Turns on or off a CDATA representation of text.

Definition at line 1240 of file tinyxml.h.

References cdata.

Referenced by TiXmlNode::Identify().

{ cdata = _cdata; }

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

protectedvirtual

Implements TiXmlNode.

Definition at line 1481 of file tinyxmlparser.cc.

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

Referenced by TiXmlElement::StreamIn().

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

        (*tag) += (char) c;
        in->get();  // "commits" the peek made above

        if ( cdata && c == '>' && tag->size() >= 3 ) {
            size_t len = tag->size();
            if ( (*tag)[len-2] == ']' && (*tag)[len-3] == ']' ) {
                // terminator of cdata.
                return;
            }
        }
    }
}

virtual const TiXmlText* TiXmlText::ToText ( ) const

inlinevirtual

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

Reimplemented from TiXmlNode.

Definition at line 1244 of file tinyxml.h.

virtual TiXmlText* TiXmlText::ToText ( )

inlinevirtual

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

Reimplemented from TiXmlNode.

Definition at line 1245 of file tinyxml.h.

Friends And Related Function Documentation

friend class TiXmlElement

friend

Definition at line 1209 of file tinyxml.h.

Member Data Documentation

bool TiXmlText::cdata

private

Definition at line 1263 of file tinyxml.h.

Referenced by CDATA(), CopyTo(), Parse(), Print(), SetCDATA(), StreamIn(), and TiXmlText().