Regina Calculation Engine
|
An XML packet reader that reads a single dim-dimensional triangulation. More...
#include <triangulation/xmltrireader.h>
Public Member Functions | |
XMLTriangulationReader (XMLTreeResolver &resolver) | |
Creates a new triangulation reader. More... | |
XMLElementReader * | startPropertySubElement (const std::string &subTagName, const regina::xml::XMLPropertyDict &subTagProps) |
Returns an XML element reader for the given optional property of a dim-dimensional triangulation. More... | |
virtual Packet * | packet () override |
Returns the newly allocated packet that has been read by this element reader. More... | |
virtual XMLElementReader * | startContentSubElement (const std::string &subTagName, const regina::xml::XMLPropertyDict &subTagProps) override |
Used instead of startSubElement() for XML subelements that are not child packets or packet tags. More... | |
virtual void | endContentSubElement (const std::string &subTagName, XMLElementReader *subReader) override |
Used instead of endSubElement() for XML subelements that are not child packets or packet tags. More... | |
virtual XMLElementReader * | startSubElement (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, XMLElementReader *subReader) |
Signifies that parsing has finished for a subelement of this XML element. More... | |
virtual void | abort (XMLElementReader *subReader) |
Signifies that XML parsing has been aborted. More... | |
virtual void | startElement (const std::string &tagName, const regina::xml::XMLPropertyDict &tagProps, XMLElementReader *parentReader) |
Signifies that parsing of this XML element is beginning. More... | |
virtual void | initialChars (const std::string &chars) |
Signifies that the initial text belonging to this XML element has been read. 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... | |
Protected Member Functions | |
XMLElementReader * | propertyReader (const std::string &subTagName, const regina::xml::XMLPropertyDict &subTagProps) |
Returns a reader for the generic triangulation property with the given subtag name. More... | |
Protected Attributes | |
Triangulation< dim > * | tri_ |
The triangulation currently being read. More... | |
XMLTreeResolver & | resolver_ |
The master resolver that will be used to fix dangling packet references after the entire XML file has been read. More... | |
An XML packet reader that reads a single dim-dimensional triangulation.
In some dimensions this template is specialised so that it can read in additional properties of the triangulation. In order to use these specialised classes, you will need to include the corresponding headers (e.g., triangulation/xmltrireader3.h for dim = 3).
dim | The dimension of the triangulation being read. This must be between 2 and 15 inclusive. |
|
inline |
Creates a new triangulation reader.
resolver | the master resolver that will be used to fix dangling packet references after the entire XML file has been read. |
|
virtualinherited |
Signifies that XML parsing has been aborted.
This element reader will be destroyed shortly after this routine is called.
The default implementation does nothing.
subReader | the 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 from regina::XMLElementReader.
|
inlineoverridevirtualinherited |
Used instead of endSubElement() for XML subelements that are not child packets or packet tags.
The default implementation does nothing.
subTagName | the name of the subelement closing tag. |
subReader | the child reader that was used to parse the subelement (this is the reader that was returned by the corresponding startContentSubElement() 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 from regina::XMLPacketReader.
|
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.
|
virtualinherited |
Signifies that parsing has finished for a subelement of this XML element.
The default implementation does nothing.
subTagName | the name of the subelement closing tag. |
subReader | the 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 from regina::XMLElementReader.
|
inlinevirtualinherited |
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.
chars | the initial text for this element. |
Reimplemented in regina::XMLCharsReader, regina::detail::XMLSimplexReader< dim >, regina::XMLNormalHypersurfaceReader, regina::XMLNormalSurfaceReader, regina::XMLAngleStructureReader, and regina::XMLAbelianGroupReader.
|
inlineoverridevirtualinherited |
Returns the newly allocated packet that has been read by this element reader.
Deallocation of this new packet is not the responsibility of this class. Once this routine gives a non-zero return value, it should continue to give the same non-zero return value from this point onwards.
If this routine is ever to give a non-zero return value, it must be giving that non-zero return value by the time the first child packet or packet tag is encountered; otherwise child packets will not be inserted into the packet tree and/or packet tags will not be added.
The newly allocated packet should not be given a packet label. This will be done by XMLPacketReader::endSubElement().
The newly allocated packet may or may not be inserted in the packet tree structure; this does not matter (although if it is inserted it must be inserted in the correct place).
The newly allocated packet should not be given any associated packet tags. This will be done by XMLPacketReader::startSubElement().
The default implementation returns 0.
Reimplemented from regina::XMLPacketReader.
|
inlineprotectedinherited |
Returns a reader for the generic triangulation property with the given subtag name.
If subTagName refers to a property that is managed by the generic base class TriangulationBase<dim>, then this routine returns an appropriate element reader. Otherwise this routine returns null
.
subTagName | the name of the XML subelement opening tag. |
subTagProps | the properties associated with the subelement opening tag. |
null
otherwise.
|
overridevirtualinherited |
Used instead of startSubElement() for XML subelements that are not child packets or packet tags.
The default implementation returns a new XMLElementReader which can be used to ignore the subelement completely.
subTagName | the name of the subelement opening tag. |
subTagProps | the properties associated with the subelement opening tag. |
Reimplemented from regina::XMLPacketReader.
|
inlinevirtualinherited |
Signifies that parsing of this XML element is beginning.
The default implementation does nothing.
tagName | the name of the opening tag for this element. |
tagProps | the properties associated with the opening tag. |
parentReader | the 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::detail::XMLSimplicesReader< dim >, regina::detail::XMLSimplexReader< dim >, regina::XMLGroupPresentationReader, regina::XMLNormalHypersurfaceReader, regina::XMLNormalSurfaceReader, regina::XMLAngleStructureReader, and regina::XMLAbelianGroupReader.
|
inline |
Returns an XML element reader for the given optional property of a dim-dimensional triangulation.
If subTagName names an XML element that describes an optional property of a triangulation (such as H1
or fundgroup
for 3-manifold triangulations), then this function should return a corresponding element reader.
Otherwise this function should return a new XMLElementReader, which will cause the XML element to be ignored.
subTagName | the name of the XML subelement opening tag. |
subTagProps | the properties associated with the subelement opening tag. |
|
virtualinherited |
Signifies that a subelement of this XML element is about to be parsed.
The default implementation returns a new XMLElementReader which can be used to ignore the subelement completely.
subTagName | the name of the subelement opening tag. |
subTagProps | the properties associated with the subelement opening tag. |
Reimplemented from regina::XMLElementReader.
|
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.
parser | the current XML parser. |
|
protectedinherited |
The master resolver that will be used to fix dangling packet references after the entire XML file has been read.
|
protectedinherited |
The triangulation currently being read.