Class XmlRecoveryHelper

src/util/xml_stream_util.h:84–108

* This class provides recovery from invalid characters in an XML stream. * * Some characters are not allowed in well-formed XML 1.0 (cf. * https://www.w3.org/TR/2008/REC-xml-20081126/#NT-Char). While QXmlStreamWriter * will not complain when writing such characters, QXmlStreamReader will raise * a NotWellFormedError. This class will remove offending characters from the * input and reset the

 *     }
 */
class XmlRecoveryHelper
{
public:
	/**
	 * Constructs a new recovery helper for the given xml stream.
	 * 
	 * Captures the current position in the XML stream (QXmlStreamReader::characterOffset()).
	 */
	XmlRecoveryHelper(QXmlStreamReader& xml) : xml (xml), recovery_start {xml.characterOffset()} {}
	
	/**
	 * Checks the stream for an error which this utility can handle,
	 * applies corrections, and resets the stream.
	 * 
	 * If this operator returns false if either there was a different type of
	 * error, or if recovery failed. If it returns true, the stream was modified
	 * in order to fix the errors which are handled by this utility, and a new
	 * attempt can be made to parse the remainder of the stream.
	 */
	bool operator() ();
	
private:
	QXmlStreamReader& xml;
	const qint64 recovery_start;
};