Regina Calculation Engine
Public Member Functions | List of all members
regina::NXMLCharsReader Class Reference

A reader for an XML element that contains only characters. More...

#include <utilities/nxmlelementreader.h>

Inheritance diagram for regina::NXMLCharsReader:
regina::NXMLElementReader

Public Member Functions

 NXMLCharsReader ()
 Creates a new XML element reader. More...
 
const std::string & getChars ()
 Returns the characters stored in the XML element that has been read. More...
 
virtual void initialChars (const std::string &chars)
 Signifies that the initial text belonging to this XML element has been read. More...
 
virtual void startElement (const std::string &tagName, const regina::xml::XMLPropertyDict &tagProps, NXMLElementReader *parentReader)
 Signifies that parsing of this XML element is beginning. More...
 
virtual NXMLElementReaderstartSubElement (const std::string &subTagName, const regina::xml::XMLPropertyDict &subTagProps)
 Signifies that a subelement of this XML element is about to be parsed. More...
 
virtual void endSubElement (const std::string &subTagName, NXMLElementReader *subReader)
 Signifies that parsing has finished for a subelement of this XML element. More...
 
virtual void endElement ()
 Signifies that parsing of this XML element is finished. More...
 
virtual void usingParser (regina::xml::XMLParser *parser)
 Called for the top-level element in an XML file when parsing begins. More...
 
virtual void abort (NXMLElementReader *subReader)
 Signifies that XML parsing has been aborted. More...
 

Detailed Description

A reader for an XML element that contains only characters.

Any XML subelements will be ignored (as will any characters occurring after any subelements).

Python:
Not present.

Constructor & Destructor Documentation

regina::NXMLCharsReader::NXMLCharsReader ( )
inline

Creates a new XML element reader.

Member Function Documentation

void regina::NXMLElementReader::abort ( NXMLElementReader subReader)
inlinevirtualinherited

Signifies that XML parsing has been aborted.

This element reader will be destroyed shortly after this routine is called.

The default implementation does nothing.

Parameters
subReaderthe corresponding child reader if a subelement is currently being parsed, or 0 otherwise. If this parameter is non-zero, it is guaranteed that abort() has already been called upon the child reader and that the child reader has not yet been destroyed.

Reimplemented in regina::NXMLPacketReader.

void regina::NXMLElementReader::endElement ( )
inlinevirtualinherited

Signifies that parsing of this XML element is finished.

It is guaranteed that endSubElement() has not yet been called upon the parent reader (if one exists).

The default implementation does nothing.

void regina::NXMLElementReader::endSubElement ( const std::string &  subTagName,
NXMLElementReader subReader 
)
inlinevirtualinherited

Signifies that parsing has finished for a subelement of this XML element.

The default implementation does nothing.

Parameters
subTagNamethe name of the subelement closing tag.
subReaderthe child reader that was used to parse the subelement (this is the reader that was returned by the corresponding startSubElement() call). It is guaranteed that endElement() has already been called upon this child reader and that the child reader has not yet been destroyed.

Reimplemented in regina::NXMLPacketReader, and regina::NXMLGroupPresentationReader.

const std::string & regina::NXMLCharsReader::getChars ( )
inline

Returns the characters stored in the XML element that has been read.

Returns
the characters stored in the XML element.
void regina::NXMLCharsReader::initialChars ( const std::string &  chars)
inlinevirtual

Signifies that the initial text belonging to this XML element has been read.

The initial text is everything between the opening tag and the first subelement or closing tag.

The default implementation does nothing.

Parameters
charsthe initial text for this element.

Reimplemented from regina::NXMLElementReader.

void regina::NXMLElementReader::startElement ( const std::string &  tagName,
const regina::xml::XMLPropertyDict tagProps,
NXMLElementReader parentReader 
)
inlinevirtualinherited

Signifies that parsing of this XML element is beginning.

The default implementation does nothing.

Parameters
tagNamethe name of the opening tag for this element.
tagPropsthe properties associated with the opening tag.
parentReaderthe reader currently parsing the parent XML element, or 0 if this is the top-level element. If this paraneter is non-zero, it is guaranteed that startSubElement() has already been called upon the parent reader.

Reimplemented in regina::NXMLGroupPresentationReader, regina::NXMLNormalSurfaceReader, regina::NXMLAngleStructureReader, and regina::NXMLAbelianGroupReader.

NXMLElementReader * regina::NXMLElementReader::startSubElement ( const std::string &  subTagName,
const regina::xml::XMLPropertyDict subTagProps 
)
inlinevirtualinherited

Signifies that a subelement of this XML element is about to be parsed.

The default implementation returns a new NXMLElementReader which can be used to ignore the subelement completely.

Parameters
subTagNamethe name of the subelement opening tag.
subTagPropsthe properties associated with the subelement opening tag.
Returns
a newly created element reader that will be used to parse the subelement. This class should not take care of the new reader's destruction; that will be done by the parser.

Reimplemented in regina::NXMLPacketReader, regina::NXMLGroupPresentationReader, regina::NXMLNormalSurfaceReader, and regina::NXMLAngleStructureReader.

void regina::NXMLElementReader::usingParser ( regina::xml::XMLParser parser)
inlinevirtualinherited

Called for the top-level element in an XML file when parsing begins.

This allows direct access to the parser if needed (for instance, to change the character encoding).

The default implementation does nothing.

Parameters
parserthe current XML parser.

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

Copyright © 1999-2014, The Regina development team
This software is released under the GNU General Public License, with some additional permissions; see the source code for details.
For further information, or to submit a bug or other problem, please contact Ben Burton (bab@debian.org).