An XML packet reader that reads a single text packet. More...
#include <nxmlpacketreaders.h>
Public Member Functions | |
NXMLTextReader () | |
Creates a new text packet reader. | |
virtual NPacket * | getPacket () |
Returns the newly allocated packet that has been read by this element reader. | |
virtual NXMLElementReader * | startContentSubElement (const std::string &subTagName, const regina::xml::XMLPropertyDict &subTagProps) |
Used instead of startSubElement() for XML subelements that are not child packets or packet tags. | |
virtual void | endContentSubElement (const std::string &subTagName, NXMLElementReader *subReader) |
Used instead of endSubElement() for XML subelements that are not child packets or packet tags. |
An XML packet reader that reads a single text packet.
regina::NXMLTextReader::NXMLTextReader | ( | ) | [inline] |
Creates a new text packet reader.
void regina::NXMLTextReader::endContentSubElement | ( | const std::string & | subTagName, | |
NXMLElementReader * | subReader | |||
) | [inline, virtual] |
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::NXMLPacketReader.
NPacket * regina::NXMLTextReader::getPacket | ( | ) | [inline, virtual] |
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 NXMLPacketReader::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 NXMLPacketReader::startSubElement().
The default implementation returns 0.
Reimplemented from regina::NXMLPacketReader.
NXMLElementReader * regina::NXMLTextReader::startContentSubElement | ( | const std::string & | subTagName, | |
const regina::xml::XMLPropertyDict & | subTagProps | |||
) | [inline, virtual] |
Used instead of startSubElement() for XML subelements that are not child packets or packet tags.
The default implementation returns a new NXMLElementReader 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::NXMLPacketReader.