ReactOS 0.4.15-dev-8408-g466a198
tinyxml2::XMLText Class Reference

#include <tinyxml2.h>

Inheritance diagram for tinyxml2::XMLText:
Collaboration diagram for tinyxml2::XMLText:

Public Member Functions

virtual bool Accept (XMLVisitor *visitor) const
 
virtual XMLTextToText ()
 Safely cast to Text, or null.
 
virtual const XMLTextToText () const
 
void SetCData (bool isCData)
 Declare whether this should be CDATA or standard text.
 
bool CData () const
 Returns true if this is a CDATA text element.
 
virtual XMLNodeShallowClone (XMLDocument *document) const
 
virtual bool ShallowEqual (const XMLNode *compare) const
 
- Public Member Functions inherited from tinyxml2::XMLNode
const XMLDocumentGetDocument () const
 Get the XMLDocument that owns this XMLNode.
 
XMLDocumentGetDocument ()
 Get the XMLDocument that owns this XMLNode.
 
virtual XMLElementToElement ()
 Safely cast to an Element, or null.
 
virtual XMLTextToText ()
 Safely cast to Text, or null.
 
virtual XMLCommentToComment ()
 Safely cast to a Comment, or null.
 
virtual XMLDocumentToDocument ()
 Safely cast to a Document, or null.
 
virtual XMLDeclarationToDeclaration ()
 Safely cast to a Declaration, or null.
 
virtual XMLUnknownToUnknown ()
 Safely cast to an Unknown, or null.
 
virtual const XMLElementToElement () const
 
virtual const XMLTextToText () const
 
virtual const XMLCommentToComment () const
 
virtual const XMLDocumentToDocument () const
 
virtual const XMLDeclarationToDeclaration () const
 
virtual const XMLUnknownToUnknown () const
 
const charValue () const
 
void SetValue (const char *val, bool staticMem=false)
 
const XMLNodeParent () const
 Get the parent of this node on the DOM.
 
XMLNodeParent ()
 
bool NoChildren () const
 Returns true if this node has no children.
 
const XMLNodeFirstChild () const
 Get the first child node, or null if none exists.
 
XMLNodeFirstChild ()
 
const XMLElementFirstChildElement (const char *name=0) const
 
XMLElementFirstChildElement (const char *name=0)
 
const XMLNodeLastChild () const
 Get the last child node, or null if none exists.
 
XMLNodeLastChild ()
 
const XMLElementLastChildElement (const char *name=0) const
 
XMLElementLastChildElement (const char *name=0)
 
const XMLNodePreviousSibling () const
 Get the previous (left) sibling node of this node.
 
XMLNodePreviousSibling ()
 
const XMLElementPreviousSiblingElement (const char *name=0) const
 Get the previous (left) sibling element of this node, with an optionally supplied name.
 
XMLElementPreviousSiblingElement (const char *name=0)
 
const XMLNodeNextSibling () const
 Get the next (right) sibling node of this node.
 
XMLNodeNextSibling ()
 
const XMLElementNextSiblingElement (const char *name=0) const
 Get the next (right) sibling element of this node, with an optionally supplied name.
 
XMLElementNextSiblingElement (const char *name=0)
 
XMLNodeInsertEndChild (XMLNode *addThis)
 
XMLNodeLinkEndChild (XMLNode *addThis)
 
XMLNodeInsertFirstChild (XMLNode *addThis)
 
XMLNodeInsertAfterChild (XMLNode *afterThis, XMLNode *addThis)
 
void DeleteChildren ()
 
void DeleteChild (XMLNode *node)
 
virtual XMLNodeShallowClone (XMLDocument *document) const =0
 
virtual bool ShallowEqual (const XMLNode *compare) const =0
 
virtual bool Accept (XMLVisitor *visitor) const =0
 

Protected Member Functions

 XMLText (XMLDocument *doc)
 
virtual ~XMLText ()
 
charParseDeep (char *, StrPair *endTag)
 
- Protected Member Functions inherited from tinyxml2::XMLNode
 XMLNode (XMLDocument *)
 
virtual ~XMLNode ()
 
virtual charParseDeep (char *, StrPair *)
 

Private Member Functions

 XMLText (const XMLText &)
 
XMLTextoperator= (const XMLText &)
 

Private Attributes

bool _isCData
 

Friends

class XMLBase
 
class XMLDocument
 

Additional Inherited Members

- Protected Attributes inherited from tinyxml2::XMLNode
XMLDocument_document
 
XMLNode_parent
 
StrPair _value
 
XMLNode_firstChild
 
XMLNode_lastChild
 
XMLNode_prev
 
XMLNode_next
 

Detailed Description

XML text.

Note that a text node can have child element nodes, for example:

<root>This is <b>bold</b></root>

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 894 of file tinyxml2.h.

Constructor & Destructor Documentation

◆ XMLText() [1/2]

tinyxml2::XMLText::XMLText ( XMLDocument doc)
inlineprotected

Definition at line 921 of file tinyxml2.h.

921: XMLNode( doc ), _isCData( false ) {}
XMLNode(XMLDocument *)
Definition: tinyxml2.cpp:701

◆ ~XMLText()

virtual tinyxml2::XMLText::~XMLText ( )
inlineprotectedvirtual

Definition at line 922 of file tinyxml2.h.

922{}

◆ XMLText() [2/2]

tinyxml2::XMLText::XMLText ( const XMLText )
private

Member Function Documentation

◆ Accept()

bool tinyxml2::XMLText::Accept ( XMLVisitor visitor) const
virtual

Accept a hierarchical visit of the nodes in the TinyXML-2 DOM. Every node in the XML tree will be conditionally visited and the host will be called back via the XMLVisitor interface.

This is essentially a SAX interface for TinyXML-2. (Note however it doesn't re-parse the XML for the callbacks, so the performance of TinyXML-2 is unchanged by using this interface versus any other.)

The interface has been based on ideas from:

Which are both good references for "visiting".

An example of using Accept():

XMLPrinter printer;
tinyxmlDoc.Accept( &printer );
const char* xmlcstr = printer.CStr();

Implements tinyxml2::XMLNode.

Definition at line 1085 of file tinyxml2.cpp.

1086{
1087 TIXMLASSERT( visitor );
1088 return visitor->Visit( *this );
1089}
#define TIXMLASSERT(x)
Definition: tinyxml2.h:88

◆ CData()

bool tinyxml2::XMLText::CData ( ) const
inline

Returns true if this is a CDATA text element.

Definition at line 913 of file tinyxml2.h.

913 {
914 return _isCData;
915 }

Referenced by ParseDeep(), and ShallowClone().

◆ operator=()

XMLText & tinyxml2::XMLText::operator= ( const XMLText )
private

◆ ParseDeep()

char * tinyxml2::XMLText::ParseDeep ( char p,
StrPair endTag 
)
protectedvirtual

Reimplemented from tinyxml2::XMLNode.

Definition at line 1039 of file tinyxml2.cpp.

1040{
1041 const char* start = p;
1042 if ( this->CData() ) {
1044 if ( !p ) {
1046 }
1047 return p;
1048 }
1049 else {
1053 }
1054
1055 p = _value.ParseText( p, "<", flags );
1056 if ( p && *p ) {
1057 return p-1;
1058 }
1059 if ( !p ) {
1061 }
1062 }
1063 return 0;
1064}
@ NEEDS_WHITESPACE_COLLAPSING
Definition: tinyxml2.h:122
@ NEEDS_NEWLINE_NORMALIZATION
Definition: tinyxml2.h:121
@ TEXT_ELEMENT_LEAVE_ENTITIES
Definition: tinyxml2.h:125
char * ParseText(char *in, const char *endTag, int strFlags)
Definition: tinyxml2.cpp:191
bool ProcessEntities() const
Definition: tinyxml2.h:1585
Whitespace WhitespaceMode() const
Definition: tinyxml2.h:1588
void SetError(XMLError error, const char *str1, const char *str2)
Definition: tinyxml2.cpp:2053
StrPair _value
Definition: tinyxml2.h:863
XMLDocument * _document
Definition: tinyxml2.h:861
bool CData() const
Returns true if this is a CDATA text element.
Definition: tinyxml2.h:913
GLuint start
Definition: gl.h:1545
GLbitfield flags
Definition: glext.h:7161
GLfloat GLfloat p
Definition: glext.h:8902
@ XML_ERROR_PARSING_TEXT
Definition: tinyxml2.h:498
@ XML_ERROR_PARSING_CDATA
Definition: tinyxml2.h:499
@ COLLAPSE_WHITESPACE
Definition: tinyxml2.h:1511

◆ SetCData()

void tinyxml2::XMLText::SetCData ( bool  isCData)
inline

Declare whether this should be CDATA or standard text.

Definition at line 909 of file tinyxml2.h.

909 {
910 _isCData = isCData;
911 }

◆ ShallowClone()

XMLNode * tinyxml2::XMLText::ShallowClone ( XMLDocument document) const
virtual

Make a copy of this node, but not its children. You may pass in a Document pointer that will be the owner of the new Node. If the 'document' is null, then the node returned will be allocated from the current Document. (this->GetDocument())

Note: if called on a XMLDocument, this will return null.

Implements tinyxml2::XMLNode.

Definition at line 1067 of file tinyxml2.cpp.

1068{
1069 if ( !doc ) {
1070 doc = _document;
1071 }
1072 XMLText* text = doc->NewText( Value() ); // fixme: this will always allocate memory. Intern?
1073 text->SetCData( this->CData() );
1074 return text;
1075}
const char * Value() const
Definition: tinyxml2.cpp:719
XMLText(XMLDocument *doc)
Definition: tinyxml2.h:921
const WCHAR * text
Definition: package.c:1799

◆ ShallowEqual()

bool tinyxml2::XMLText::ShallowEqual ( const XMLNode compare) const
virtual

Test if 2 nodes are the same, but don't test children. The 2 nodes do not need to be in the same Document.

Note: if called on a XMLDocument, this will return false.

Implements tinyxml2::XMLNode.

Definition at line 1078 of file tinyxml2.cpp.

1079{
1080 const XMLText* text = compare->ToText();
1081 return ( text && XMLUtil::StringEqual( text->Value(), Value() ) );
1082}
static bool StringEqual(const char *p, const char *q, int nChar=INT_MAX)
Definition: tinyxml2.h:555
Definition: bug.cpp:8
_Must_inspect_result_ _In_ WDFKEY _In_ PCUNICODE_STRING _Out_opt_ PUSHORT _Inout_opt_ PUNICODE_STRING Value
Definition: wdfregistry.h:413

◆ ToText() [1/2]

virtual XMLText * tinyxml2::XMLText::ToText ( )
inlinevirtual

Safely cast to Text, or null.

Reimplemented from tinyxml2::XMLNode.

Definition at line 901 of file tinyxml2.h.

901 {
902 return this;
903 }

◆ ToText() [2/2]

virtual const XMLText * tinyxml2::XMLText::ToText ( ) const
inlinevirtual

Reimplemented from tinyxml2::XMLNode.

Definition at line 904 of file tinyxml2.h.

904 {
905 return this;
906 }

Friends And Related Function Documentation

◆ XMLBase

friend class XMLBase
friend

Definition at line 896 of file tinyxml2.h.

◆ XMLDocument

friend class XMLDocument
friend

Definition at line 897 of file tinyxml2.h.

Member Data Documentation

◆ _isCData

bool tinyxml2::XMLText::_isCData
private

Definition at line 927 of file tinyxml2.h.


The documentation for this class was generated from the following files: