![]() |
![]() |
DD4hep - The AIDA detector description toolkit for high energy physics experiments
DD4hep
Rev:Unversioneddirectory
|
TinyXML class. See http://www.grinninglizard.com/tinyxml. More...
#include <tinyxml.h>
Public Member Functions | |
TiXmlDocument () | |
Create an empty document, that has no name. More... | |
TiXmlDocument (const char *documentName) | |
Create a document with a name. The name of the document is also the filename of the xml. More... | |
TiXmlDocument (const std::string &documentName) | |
Constructor. More... | |
TiXmlDocument (const TiXmlDocument ©) | |
void | operator= (const TiXmlDocument ©) |
virtual | ~TiXmlDocument () |
bool | LoadFile (TiXmlEncoding encoding=TIXML_DEFAULT_ENCODING) |
bool | SaveFile () const |
Save a file using the current document value. Returns true if successful. More... | |
bool | LoadFile (const char *filename, TiXmlEncoding encoding=TIXML_DEFAULT_ENCODING) |
Load a file using the given filename. Returns true if successful. More... | |
bool | SaveFile (const char *filename) const |
Save a file using the given filename. Returns true if successful. More... | |
bool | LoadFile (FILE *, TiXmlEncoding encoding=TIXML_DEFAULT_ENCODING) |
bool | SaveFile (FILE *) const |
Save a file using the given FILE*. Returns true if successful. More... | |
bool | LoadFile (const std::string &filename, TiXmlEncoding encoding=TIXML_DEFAULT_ENCODING) |
bool | SaveFile (const std::string &filename) const |
< STL std::string version. More... | |
virtual const char * | Parse (const char *p, TiXmlParsingData *data=0, TiXmlEncoding encoding=TIXML_DEFAULT_ENCODING) |
const TiXmlElement * | RootElement () const |
TiXmlElement * | RootElement () |
bool | Error () const |
const char * | ErrorDesc () const |
Contains a textual (english) description of the error if one occurs. More... | |
int | ErrorId () const |
int | ErrorRow () const |
int | ErrorCol () const |
The column where the error occured. See ErrorRow() More... | |
void | SetTabSize (int _tabsize) |
int | TabSize () const |
void | ClearError () |
void | Print () const |
virtual void | Print (FILE *cfile, int depth=0) const |
Print this Document to a FILE stream. More... | |
void | SetError (int err, const char *errorLocation, TiXmlParsingData *prevData, TiXmlEncoding encoding) |
virtual const TiXmlDocument * | ToDocument () const |
Cast to a more defined type. Will return null not of the requested type. More... | |
virtual TiXmlDocument * | ToDocument () |
Cast to a more defined type. Will return null not of the requested type. More... | |
virtual bool | Accept (TiXmlVisitor *content) const |
![]() | |
virtual | ~TiXmlNode () |
const char * | Value () const |
const std::string & | ValueStr () const |
void | SetValue (const char *_value) |
void | SetValue (const std::string &_value) |
STL std::string form. More... | |
void | Clear () |
Delete all the children of this node. Does not affect 'this'. More... | |
TiXmlNode * | Parent () |
One step up the DOM. More... | |
const TiXmlNode * | Parent () const |
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 * | 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 * | FirstChild (const std::string &_value) const |
STL std::string form. More... | |
TiXmlNode * | FirstChild (const std::string &_value) |
STL std::string form. 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... | |
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... | |
TiXmlNode * | InsertEndChild (const TiXmlNode &addThis) |
TiXmlNode * | LinkEndChild (TiXmlNode *addThis) |
TiXmlNode * | InsertBeforeChild (TiXmlNode *beforeThis, const TiXmlNode &addThis) |
TiXmlNode * | InsertAfterChild (TiXmlNode *afterThis, const TiXmlNode &addThis) |
TiXmlNode * | ReplaceChild (TiXmlNode *replaceThis, const TiXmlNode &withThis) |
bool | RemoveChild (TiXmlNode *removeThis) |
Delete a child of this node. More... | |
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... | |
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 * | PreviousSiblingElement () const |
TiXmlElement * | PreviousSiblingElement () |
const TiXmlElement * | PreviousSiblingElement (const char *) const |
TiXmlElement * | PreviousSiblingElement (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... | |
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... | |
int | Type () const |
const TiXmlDocument * | GetDocument () const |
TiXmlDocument * | GetDocument () |
bool | NoChildren () const |
Returns true if this node has no children. More... | |
virtual const TiXmlElement * | ToElement () const |
Cast to a more defined type. Will return null if not of the requested type. More... | |
virtual const TiXmlComment * | ToComment () const |
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 const TiXmlText * | ToText () const |
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 TiXmlElement * | ToElement () |
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 TiXmlUnknown * | ToUnknown () |
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 TiXmlDeclaration * | ToDeclaration () |
Cast to a more defined type. Will return null if not of the requested type. More... | |
![]() | |
TiXmlBase () | |
virtual | ~TiXmlBase () |
int | Row () const |
int | Column () const |
See Row() More... | |
void | SetUserData (void *user) |
Set a pointer to arbitrary user data. More... | |
void * | GetUserData () |
Get a pointer to arbitrary user data. More... | |
const void * | GetUserData () const |
Get a pointer to arbitrary user data. More... | |
Protected Member Functions | |
virtual TiXmlNode * | Clone () const |
virtual void | StreamIn (std::istream *in, TIXML_STRING *tag) |
![]() | |
TiXmlNode (NodeType _type) | |
void | CopyTo (TiXmlNode *target) const |
TiXmlNode * | Identify (const char *start, TiXmlEncoding encoding) |
Private Member Functions | |
void | CopyTo (TiXmlDocument *target) const |
Private Attributes | |
bool | error |
int | errorId |
TIXML_STRING | errorDesc |
int | tabsize |
TiXmlCursor | errorLocation |
bool | useMicrosoftBOM |
Additional Inherited Members | |
![]() | |
enum | NodeType { DOCUMENT, ELEMENT, COMMENT, UNKNOWN, TEXT, DECLARATION, TYPECOUNT } |
![]() | |
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 void | SetCondenseWhiteSpace (bool condense) |
static bool | IsWhiteSpaceCondensed () |
Return the current white space setting. More... | |
![]() | |
static const int | utf8ByteTable [256] |
![]() | |
static const char * | SkipWhiteSpace (const char *, TiXmlEncoding encoding) |
static bool | IsWhiteSpace (char c) |
static bool | IsWhiteSpace (int c) |
static bool | StreamWhiteSpace (std::istream *in, TIXML_STRING *tag) |
static bool | StreamTo (std::istream *in, int character, TIXML_STRING *tag) |
static const char * | ReadName (const char *p, TIXML_STRING *name, TiXmlEncoding encoding) |
static const char * | ReadText (const char *in, TIXML_STRING *text, bool ignoreWhiteSpace, const char *endTag, bool ignoreCase, TiXmlEncoding encoding) |
static const char * | GetEntity (const char *in, char *value, int *length, TiXmlEncoding encoding) |
static const char * | GetChar (const char *p, char *_value, int *length, TiXmlEncoding encoding) |
static void | PutString (const TIXML_STRING &str, TIXML_STRING *out) |
static bool | StringEqual (const char *p, const char *endTag, bool ignoreCase, TiXmlEncoding encoding) |
static int | IsAlpha (unsigned char anyByte, TiXmlEncoding encoding) |
static int | IsAlphaNum (unsigned char anyByte, TiXmlEncoding encoding) |
static int | ToLower (int v, TiXmlEncoding encoding) |
static void | ConvertUTF32ToUTF8 (unsigned long input, char *output, int *length) |
![]() | |
TiXmlNode * | parent |
NodeType | type |
TiXmlNode * | firstChild |
TiXmlNode * | lastChild |
TIXML_STRING | value |
TiXmlNode * | prev |
TiXmlNode * | next |
![]() | |
TiXmlCursor | location |
void * | userData |
Field containing a generic user pointer. More... | |
![]() | |
static const char * | errorString [TIXML_ERROR_STRING_COUNT] |
TinyXML class. See http://www.grinninglizard.com/tinyxml.
Always the top level node. A document binds together all the XML pieces. It can be saved, loaded, and printed to the screen. The 'value' of a document node is the xml file name.
See
TiXmlDocument::TiXmlDocument | ( | ) |
Create an empty document, that has no name.
Definition at line 910 of file tinyxml_inl.h.
References ClearError(), tabsize, and useMicrosoftBOM.
Referenced by Clone().
TiXmlDocument::TiXmlDocument | ( | const char * | documentName | ) |
Create a document with a name. The name of the document is also the filename of the xml.
Definition at line 917 of file tinyxml_inl.h.
References ClearError(), tabsize, useMicrosoftBOM, and TiXmlNode::value.
TiXmlDocument::TiXmlDocument | ( | const std::string & | documentName | ) |
Constructor.
TiXmlDocument::TiXmlDocument | ( | const TiXmlDocument & | copy | ) |
Definition at line 937 of file tinyxml_inl.h.
References CopyTo().
|
virtual |
Walk the XML tree visiting this node and all of its children.
Implements TiXmlNode.
Definition at line 1182 of file tinyxml_inl.h.
References TiXmlNode::FirstChild(), TiXmlVisitor::VisitEnter(), and TiXmlVisitor::VisitExit().
|
inline |
If you have handled the error, it can be reset with this call. The error state is automatically cleared if you Parse a new XML block.
Definition at line 1684 of file tinyxml.h.
References TiXmlCursor::col, error, errorDesc, errorId, errorLocation, and TiXmlCursor::row.
Referenced by Parse(), and TiXmlDocument().
|
protectedvirtual |
Create an exact duplicate of this node and return it. The memory must be deleted by the caller.
Implements TiXmlNode.
Definition at line 1160 of file tinyxml_inl.h.
References CopyTo(), and TiXmlDocument().
|
private |
Definition at line 1145 of file tinyxml_inl.h.
References TiXmlNode::Clone(), TiXmlNode::CopyTo(), error, errorDesc, TiXmlNode::firstChild, TiXmlNode::LinkEndChild(), and TiXmlNode::NextSibling().
Referenced by Clone(), operator=(), and TiXmlDocument().
|
inline |
If an error occurs, Error will be set to true. Also,
Definition at line 1619 of file tinyxml.h.
References error.
Referenced by LoadFile().
|
inline |
The column where the error occured. See ErrorRow()
Definition at line 1645 of file tinyxml.h.
References TiXmlCursor::col, and errorLocation.
|
inline |
|
inline |
Generally, you probably want the error string ( ErrorDesc() ). But if you prefer the ErrorId, this function will fetch it.
Definition at line 1631 of file tinyxml.h.
References errorId.
|
inline |
Returns the location (if known) of the error. The first column is column 1, and the first row is row 1. A value of 0 means the row and column wasn't applicable (memory errors, for example, have no row/column) or the parser lost the error. (An error in the error reporting, in that case.)
Definition at line 1642 of file tinyxml.h.
References errorLocation, and TiXmlCursor::row.
bool TiXmlDocument::LoadFile | ( | TiXmlEncoding | encoding = TIXML_DEFAULT_ENCODING | ) |
Load a file using the current document value. Returns true if successful. Will delete any existing document data before loading.
Definition at line 950 of file tinyxml_inl.h.
References TiXmlNode::Value().
Referenced by LoadFile().
bool TiXmlDocument::LoadFile | ( | const char * | filename, |
TiXmlEncoding | encoding = TIXML_DEFAULT_ENCODING |
||
) |
Load a file using the given filename. Returns true if successful.
Definition at line 971 of file tinyxml_inl.h.
References LoadFile(), SetError(), TIXML_ENCODING_UNKNOWN, TiXmlBase::TIXML_ERROR_OPENING_FILE, TIXML_STRING, and TiXmlNode::value.
bool TiXmlDocument::LoadFile | ( | FILE * | file, |
TiXmlEncoding | encoding = TIXML_DEFAULT_ENCODING |
||
) |
Load a file using the given FILE*. Returns true if successful. Note that this method doesn't stream - the entire object pointed at by the FILE* will be interpreted as an XML file. TinyXML doesn't stream in XML from the current file location. Streaming may be added in the future.
Definition at line 999 of file tinyxml_inl.h.
References TiXmlCursor::Clear(), TiXmlNode::Clear(), Error(), TiXmlBase::location, Parse(), SetError(), TIXML_ENCODING_UNKNOWN, TiXmlBase::TIXML_ERROR_DOCUMENT_EMPTY, TiXmlBase::TIXML_ERROR_OPENING_FILE, and TIXML_STRING.
|
inline |
encoding | STL std::string version. |
Definition at line 1583 of file tinyxml.h.
References LoadFile().
void TiXmlDocument::operator= | ( | const TiXmlDocument & | copy | ) |
Definition at line 943 of file tinyxml_inl.h.
References TiXmlNode::Clear(), and CopyTo().
|
virtual |
Parse the given null terminated block of xml data. Passing in an encoding to this method (either TIXML_ENCODING_LEGACY or TIXML_ENCODING_UTF8 will force TinyXml to use that encoding, regardless of what TinyXml might otherwise try to detect.
Implements TiXmlBase.
Definition at line 712 of file tinyxmlparser_inl.h.
References TiXmlCursor::Clear(), ClearError(), TiXmlCursor::col, TiXmlParsingData::Cursor(), TiXmlParsingData::cursor, TiXmlDeclaration::Encoding(), TiXmlNode::firstChild, TiXmlNode::Identify(), TiXmlNode::LinkEndChild(), TiXmlBase::location, TiXmlBase::Parse(), TiXmlCursor::row, SetError(), TiXmlBase::SkipWhiteSpace(), TiXmlBase::StringEqual(), TabSize(), TIXML_ENCODING_LEGACY, TIXML_ENCODING_UNKNOWN, TIXML_ENCODING_UTF8, TiXmlBase::TIXML_ERROR_DOCUMENT_EMPTY, TIXML_UTF_LEAD_0, TIXML_UTF_LEAD_1, TIXML_UTF_LEAD_2, TiXmlNode::ToDeclaration(), and useMicrosoftBOM.
Referenced by LoadFile().
|
inline |
Write the document to standard out using formatted printing ("pretty print").
Definition at line 1693 of file tinyxml.h.
Referenced by SaveFile().
|
virtual |
Print this Document to a FILE stream.
Implements TiXmlBase.
Definition at line 1171 of file tinyxml_inl.h.
References TiXmlNode::FirstChild(), and TiXmlAttribute::Print().
|
inline |
Get the root element – the only top level element – of the document. In well formed XML, there should only be one. TinyXml is tolerant of multiple elements at the document level.
Definition at line 1607 of file tinyxml.h.
References TiXmlNode::FirstChildElement().
|
inline |
Definition at line 1610 of file tinyxml.h.
References TiXmlNode::FirstChildElement().
bool TiXmlDocument::SaveFile | ( | ) | const |
Save a file using the current document value. Returns true if successful.
Definition at line 959 of file tinyxml_inl.h.
References TiXmlNode::Value().
Referenced by SaveFile().
bool TiXmlDocument::SaveFile | ( | const char * | filename | ) | const |
Save a file using the given filename. Returns true if successful.
Definition at line 1114 of file tinyxml_inl.h.
References SaveFile().
bool TiXmlDocument::SaveFile | ( | FILE * | fp | ) | const |
Save a file using the given FILE*. Returns true if successful.
Definition at line 1128 of file tinyxml_inl.h.
References Print(), TIXML_UTF_LEAD_0, TIXML_UTF_LEAD_1, TIXML_UTF_LEAD_2, and useMicrosoftBOM.
|
inline |
void TiXmlDocument::SetError | ( | int | err, |
const char * | errorLocation, | ||
TiXmlParsingData * | prevData, | ||
TiXmlEncoding | encoding | ||
) |
Definition at line 806 of file tinyxmlparser_inl.h.
References TiXmlCursor::Clear(), TiXmlParsingData::Cursor(), error, errorDesc, errorId, errorLocation, TiXmlBase::errorString, TiXmlParsingData::Stamp(), and TiXmlBase::TIXML_ERROR_STRING_COUNT.
Referenced by TiXmlNode::Identify(), TiXmlNode::InsertAfterChild(), TiXmlNode::InsertBeforeChild(), TiXmlNode::InsertEndChild(), TiXmlNode::LinkEndChild(), LoadFile(), TiXmlAttribute::Parse(), TiXmlElement::Parse(), TiXmlComment::Parse(), TiXmlText::Parse(), TiXmlDeclaration::Parse(), TiXmlUnknown::Parse(), Parse(), TiXmlElement::ReadValue(), and TiXmlElement::SetAttribute().
|
inline |
SetTabSize() allows the error reporting functions (ErrorRow() and ErrorCol()) to report the correct values for row and column. It does not change the output or input in any way.
By calling this method, with a tab size greater than 0, the row and column of each node and attribute is stored when the file is loaded. Very useful for tracking the DOM back in to the source file.
The tab size is required for calculating the location of nodes. If not set, the default of 4 is used. The tabsize is set per document. Setting the tabsize to 0 disables row/column tracking.
Note that row and column tracking is not supported when using operator>>.
The tab size needs to be enabled before the parse or load. Correct usage:
TiXmlDocument doc; doc.SetTabSize( 8 ); doc.Load( "myfile.xml" );
Definition at line 1673 of file tinyxml.h.
References tabsize.
|
protectedvirtual |
Implements TiXmlNode.
|
inline |
|
inlinevirtual |
|
inlinevirtual |
|
private |
Definition at line 1728 of file tinyxml.h.
Referenced by ClearError(), CopyTo(), Error(), and SetError().
|
private |
Definition at line 1729 of file tinyxml.h.
Referenced by ClearError(), CopyTo(), ErrorDesc(), and SetError().
|
private |
Definition at line 1729 of file tinyxml.h.
Referenced by ClearError(), ErrorId(), and SetError().
|
private |
Definition at line 1731 of file tinyxml.h.
Referenced by ClearError(), ErrorCol(), ErrorRow(), and SetError().
|
private |
Definition at line 1730 of file tinyxml.h.
Referenced by SetTabSize(), TabSize(), and TiXmlDocument().
|
private |
Definition at line 1732 of file tinyxml.h.
Referenced by Parse(), SaveFile(), and TiXmlDocument().