Analysis Software
Documentation for sPHENIX simulation software
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
tinyxml2::XMLDeclaration Class Reference

#include <JETSCAPE/blob/main/external_packages/tinyxml2.h>

+ Inheritance diagram for tinyxml2::XMLDeclaration:
+ Collaboration diagram for tinyxml2::XMLDeclaration:

Public Member Functions

virtual XMLDeclarationToDeclaration ()
 Safely cast to a Declaration, or null.
 
virtual const XMLDeclarationToDeclaration () const
 
virtual bool Accept (XMLVisitor *visitor) const
 
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 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 XMLUnknownToUnknown () const
 
const char * Value () 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)
 
void SetUserData (void *userData)
 
void * GetUserData () const
 

Protected Member Functions

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

Private Member Functions

 XMLDeclaration (const XMLDeclaration &)
 
XMLDeclarationoperator= (const XMLDeclaration &)
 

Friends

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
 
void * _userData
 

Detailed Description

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

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

TinyXML-2 will happily read or write files without a declaration, however.

The text of the declaration isn't interpreted. It is parsed and written as a string.

Definition at line 1009 of file tinyxml2.h.

View newest version in sPHENIX GitHub at line 1009 of file tinyxml2.h

Constructor & Destructor Documentation

tinyxml2::XMLDeclaration::XMLDeclaration ( XMLDocument doc)
protected

Definition at line 1184 of file tinyxml2.cc.

View newest version in sPHENIX GitHub at line 1184 of file tinyxml2.cc

tinyxml2::XMLDeclaration::~XMLDeclaration ( )
protectedvirtual

Definition at line 1189 of file tinyxml2.cc.

View newest version in sPHENIX GitHub at line 1189 of file tinyxml2.cc

tinyxml2::XMLDeclaration::XMLDeclaration ( const XMLDeclaration )
private

Member Function Documentation

bool tinyxml2::XMLDeclaration::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 1226 of file tinyxml2.cc.

View newest version in sPHENIX GitHub at line 1226 of file tinyxml2.cc

References TIXMLASSERT, and tinyxml2::XMLVisitor::Visit().

+ Here is the call graph for this function:

XMLDeclaration& tinyxml2::XMLDeclaration::operator= ( const XMLDeclaration )
private
char * tinyxml2::XMLDeclaration::ParseDeep ( char *  p,
StrPair endTag 
)
protectedvirtual

Reimplemented from tinyxml2::XMLNode.

Definition at line 1195 of file tinyxml2.cc.

View newest version in sPHENIX GitHub at line 1195 of file tinyxml2.cc

References tinyxml2::XMLNode::_document, tinyxml2::XMLNode::_value, tinyxml2::StrPair::NEEDS_NEWLINE_NORMALIZATION, merge_hashes::p, tinyxml2::StrPair::ParseText(), tinyxml2::XMLDocument::SetError(), start, and tinyxml2::XML_ERROR_PARSING_DECLARATION.

+ Here is the call graph for this function:

XMLNode * tinyxml2::XMLDeclaration::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 1207 of file tinyxml2.cc.

View newest version in sPHENIX GitHub at line 1207 of file tinyxml2.cc

References tinyxml2::XMLNode::_document, tinyxml2::XMLDocument::NewDeclaration(), and tinyxml2::XMLNode::Value().

+ Here is the call graph for this function:

bool tinyxml2::XMLDeclaration::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 1217 of file tinyxml2.cc.

View newest version in sPHENIX GitHub at line 1217 of file tinyxml2.cc

References tinyxml2::XMLUtil::StringEqual(), TIXMLASSERT, tinyxml2::XMLNode::ToDeclaration(), and tinyxml2::XMLNode::Value().

+ Here is the call graph for this function:

virtual XMLDeclaration* tinyxml2::XMLDeclaration::ToDeclaration ( )
inlinevirtual

Safely cast to a Declaration, or null.

Reimplemented from tinyxml2::XMLNode.

Definition at line 1013 of file tinyxml2.h.

View newest version in sPHENIX GitHub at line 1013 of file tinyxml2.h

virtual const XMLDeclaration* tinyxml2::XMLDeclaration::ToDeclaration ( ) const
inlinevirtual

Reimplemented from tinyxml2::XMLNode.

Definition at line 1016 of file tinyxml2.h.

View newest version in sPHENIX GitHub at line 1016 of file tinyxml2.h

Friends And Related Function Documentation

friend class XMLDocument
friend

Definition at line 1011 of file tinyxml2.h.

View newest version in sPHENIX GitHub at line 1011 of file tinyxml2.h


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