#include <nxmlcallback.h>
Public Member Functions | |
NXMLCallback (NXMLElementReader &newTopReader, std::ostream &newErrStream) | |
Creates a new callback object. | |
virtual | ~NXMLCallback () |
Destroys this callback object. | |
int | getState () const |
Returns the state that this callback object is currently in. | |
void | abort () |
Aborts processing of the XML file completely. | |
virtual void | end_document () |
Called when the document is finalised. | |
virtual void | start_element (const std::string &n, const regina::xml::XMLPropertyDict &p) |
Called when an element's opening tag is encountered. | |
virtual void | end_element (const std::string &n) |
Called when an element's closing tag is encountered. | |
virtual void | characters (const std::string &s) |
Called when characters are encountered. | |
virtual void | warning (const std::string &s) |
Called when a parser warning occurs. | |
virtual void | error (const std::string &s) |
Called when a parser error occurs. | |
virtual void | fatal_error (const std::string &s) |
Called when a parser fatal error occurs. | |
Static Public Attributes | |
static const int | WAITING |
Signifies that the top-level XML element has not yet been seen. | |
static const int | WORKING |
Signifies that XML elements are currently being processed. | |
static const int | DONE |
Signifies that processing of all XML elements has finished. | |
static const int | ABORTED |
Signifies that XML processing was aborted. |
See the NXMLElementReader class notes for details of precisely how processing will take place.
regina::NXMLCallback::NXMLCallback | ( | NXMLElementReader & | newTopReader, | |
std::ostream & | newErrStream | |||
) | [inline] |
Creates a new callback object.
newTopReader | the element reader to use for the top-level XML element. This is the only element reader that will not be destroyed once parsing has finished. | |
newErrStream | the output stream to which any warning or error messages should be sent. |
virtual regina::NXMLCallback::~NXMLCallback | ( | ) | [virtual] |
Destroys this callback object.
Any element reader (aside from the top-level reader) that has not yet been destroyed will have abort() called upon it and will be destroyed at this point.
int regina::NXMLCallback::getState | ( | ) | const [inline] |
Returns the state that this callback object is currently in.
The returned value will be one of the state constants defined in this class.
void regina::NXMLCallback::abort | ( | ) |
Aborts processing of the XML file completely.
The XMLParser may continue sending information but it will be completely ignored by this NXMLCallback object from this point onwards.
All currently active readers will have NXMLElementReader::abort() called upon them and all except for the top-level reader will be destroyed.
virtual void regina::NXMLCallback::end_document | ( | ) | [virtual] |
virtual void regina::NXMLCallback::start_element | ( | const std::string & | n, | |
const regina::xml::XMLPropertyDict & | p | |||
) | [virtual] |
Called when an element's opening tag is encountered.
n | the name of the tag. | |
p | a hashed dictionary of all the properties of the tag. |
Reimplemented from regina::xml::XMLParserCallback.
virtual void regina::NXMLCallback::end_element | ( | const std::string & | n | ) | [virtual] |
Called when an element's closing tag is encountered.
This is called immediately after start_element() if the opening tag is in <tag/>
format.
n | the name of the tag. |
Reimplemented from regina::xml::XMLParserCallback.
virtual void regina::NXMLCallback::characters | ( | const std::string & | s | ) | [virtual] |
Called when characters are encountered.
s | the characters encountered. |
Reimplemented from regina::xml::XMLParserCallback.
virtual void regina::NXMLCallback::warning | ( | const std::string & | s | ) | [virtual] |
Called when a parser warning occurs.
s | the warning message. |
Reimplemented from regina::xml::XMLParserCallback.
virtual void regina::NXMLCallback::error | ( | const std::string & | s | ) | [virtual] |
Called when a parser error occurs.
s | the error message. |
Reimplemented from regina::xml::XMLParserCallback.
virtual void regina::NXMLCallback::fatal_error | ( | const std::string & | s | ) | [virtual] |
Called when a parser fatal error occurs.
s | the error message. |
Reimplemented from regina::xml::XMLParserCallback.
const int regina::NXMLCallback::WAITING [static] |
Signifies that the top-level XML element has not yet been seen.
const int regina::NXMLCallback::WORKING [static] |
Signifies that XML elements are currently being processed.
const int regina::NXMLCallback::DONE [static] |
Signifies that processing of all XML elements has finished.
const int regina::NXMLCallback::ABORTED [static] |
Signifies that XML processing was aborted.