CopperSpice API  1.7.4

The QXmlStreamReader class provides a fast parser for reading well-formed XML via a simple streaming API. More...

enum  Error

enum  TokenType

## Public Methods

bool atEnd () const

QXmlStreamAttributes attributes () const

qint64 characterOffset () const

void clear ()

qint64 columnNumber () const

QIODevicedevice () const

QStringView documentEncoding () const

QStringView documentVersion () const

QStringView dtdName () const

QStringView dtdPublicId () const

QStringView dtdSystemId () const

QXmlStreamEntityDeclarations entityDeclarations () const

QXmlStreamEntityResolverentityResolver () const

Error error () const

QString errorString () const

bool hasError () const

bool isCDATA () const

bool isCharacters () const

bool isComment () const

bool isDTD () const

bool isEndDocument () const

bool isEndElement () const

bool isEntityReference () const

bool isProcessingInstruction () const

bool isStandaloneDocument () const

bool isStartDocument () const

bool isStartElement () const

bool isWhitespace () const

qint64 lineNumber () const

QStringView name () const

QXmlStreamNamespaceDeclarations namespaceDeclarations () const

bool namespaceProcessing () const

QStringView namespaceUri () const

QXmlStreamNotationDeclarations notationDeclarations () const

QStringView prefix () const

QStringView processingInstructionData () const

QStringView processingInstructionTarget () const

QStringView qualifiedName () const

void raiseError (const QString &message=QString ())

void setDevice (QIODevice *device)

void setEntityResolver (QXmlStreamEntityResolver *resolver)

void setNamespaceProcessing (bool enable)

void skipCurrentElement ()

QStringView text () const

QString tokenString () const

TokenType tokenType () const

## Detailed Description

The QXmlStreamReader class provides a fast parser for reading well-formed XML via a simple streaming API. QXmlStreamReader is a faster and more convenient replacement for the CopperSpice own SAX parser. In some cases it might also be a faster and more convenient alternative for use in applications that would otherwise use a DOM tree (see QDomDocument). QXmlStreamReader reads data either from a QIODevice (see setDevice()), or from a raw QByteArray. Refer to see addData() for more information.

CopperSpice provides QXmlStreamWriter for writing XML.

A typical loop with QXmlStreamReader might look like the following example.

while (! xml.atEnd()) {
// some processing
}
if (xml.hasError()) {
// error handling
}

QXmlStreamReader is a well-formed XML 1.0 parser that does not include external parsed entities. As long as no error occurs, the application code can thus be assured that the data provided by the stream reader satisfies the W3C's criteria for well-formed XML. For example, you can be certain that all tags are indeed nested and closed properly, that references to internal entities have been replaced with the correct replacement text, and that attributes have been normalized or added according to the internal subset of the DTD.

If an error occurs while parsing, atEnd() and hasError() return true, and error() returns the error that occurred. The functions errorString(), lineNumber(), columnNumber(), and characterOffset() are for constructing an appropriate error or warning message. To simplify application code, QXmlStreamReader contains a raiseError() mechanism that lets you raise custom errors that trigger the same error handling described.

### Namespaces

QXmlStream understands and resolves XML namespaces. E.g. in case of a StartElement, namespaceUri() returns the namespace the element is in, and name() returns the element's local name. The combination of namespaceUri and name uniquely identifies an element. If a namespace prefix was not declared in the XML entities parsed by the reader, the namespaceUri is empty.

If you parse XML data that does not utilize namespaces according to the XML specification or does not use namespaces at all, you can use the element's qualifiedName() instead. A qualified name is the element's prefix() followed by colon followed by the element's local name() - exactly like the element appears in the raw XML data. Since the mapping namespaceUri to prefix is neither unique nor universal, qualifiedName() should be avoided for namespace-compliant XML data.

In order to parse standalone documents that do use undeclared namespace prefixes, you can turn off namespace processing completely with the namespaceProcessing property.

### Incremental parsing

QXmlStreamReader is an incremental parser. It can handle the case where the document can not be parsed all at once because it arrives in chunks (e.g. from multiple files, or over a network connection). When the reader runs out of data before the complete document has been parsed, it reports a PrematureEndOfDocumentError. When more data arrives, either because of a call to addData() or because more data is available through the network device(), the reader recovers from the PrematureEndOfDocumentError error and continues parsing the new data with the next call to readNext().

### Performance

QXmlStreamReader is conservative by design since it does not store the entire XML document tree in memory but instead stores the current token. This avoids small string allocations that it would normally take to map an XML document. Internally this class leverages QStringView for optimization.

## Member Enumeration Documentation

This enum specifies different error cases

ConstantValueDescription
QXmlStreamReader::NoError0No error has occurred.
QXmlStreamReader::CustomError2A custom error has been raised with raiseError()
QXmlStreamReader::NotWellFormedError3The parser internally raised an error due to the read XML not being well-formed.
QXmlStreamReader::PrematureEndOfDocumentError4The input stream ended before a well-formed XML document was parsed. Recovery from this error is possible if more XML arrives in the stream, either by calling addData() or by waiting for it to arrive on the device().
QXmlStreamReader::UnexpectedElementError1The parser encountered an element that was different to those it expected.

This enum specifies the different behaviors of readElementText().

ConstantValueDescription
QXmlStreamReader::ErrorOnUnexpectedElement0Raise an UnexpectedElementError and return what was read so far when a child element is encountered.
QXmlStreamReader::IncludeChildElements1Recursively include the text from child elements.
QXmlStreamReader::SkipChildElements2Skip child elements.

ConstantValueDescription
QXmlStreamReader::NoToken0The reader has not yet read anything.
QXmlStreamReader::Invalid1An error has occurred, reported in error() and errorString().
QXmlStreamReader::StartDocument2The reader reports the XML version number in documentVersion(), and the encoding as specified in the XML document in documentEncoding(). If the document is declared standalone, isStandaloneDocument() returns true, otherwise it returns false.
QXmlStreamReader::EndDocument3The reader reports the end of the document.
QXmlStreamReader::StartElement4The reader reports the start of an element with namespaceUri() and name(). Empty elements are also reported as StartElement, followed directly by EndElement. The convenience function readElementText() can be called to concatenate all content until the corresponding EndElement. Attributes are reported in attributes(), namespace declarations in namespaceDeclarations().
QXmlStreamReader::EndElement5The reader reports the end of an element with namespaceUri() and name().
QXmlStreamReader::Characters6The reader reports characters in text(). If the characters are all white-space, isWhitespace() returns true. If the characters stem from a CDATA section, isCDATA() returns true.
QXmlStreamReader::Comment7The reader reports a comment in text().
QXmlStreamReader::DTD8The reader reports a DTD in text(), notation declarations in notationDeclarations(), and entity declarations in entityDeclarations(). Details of the DTD declaration are reported in in dtdName(), dtdPublicId(), and dtdSystemId().
QXmlStreamReader::EntityReference9The reader reports an entity reference that could not be resolved. The name of the reference is reported in name(), the replacement text in text().
QXmlStreamReader::ProcessingInstruction10The reader reports a processing instruction in processingInstructionTarget() and processingInstructionData().

## Constructor & Destructor Documentation

setDevice(), clear()

## Method Documentation

Adds a declaration. The declaration will be valid for children of the current element, If this method is called before any elements are read then the declaration is applied to the entire XML document.

Adds a vector of declarations specified by declarations.

Returns true if the reader has read until the end of the XML document, or if an error() has occurred and reading has been aborted. Otherwise, it returns false.

When atEnd() and hasError() return true and error() returns PrematureEndOfDocumentError, it means the XML has been well-formed so far, but a complete XML document has not been parsed. The next chunk of XML can be added with addData(), if the XML is being read from a QByteArray, or by waiting for more data to arrive if the XML is being read from a QIODevice. Either way, atEnd() will return false once more data is available.

hasError(), error(), device(), QIODevice::atEnd()

Returns the attributes of a StartElement.

Returns the current character offset, starting with 0.

lineNumber(), columnNumber()

Removes any device() or data from the reader and resets its internal state to the initial state.

Returns the current column number, starting with 0.

lineNumber(), characterOffset()
 QIODevice * QXmlStreamReader::device ( ) const

Returns the current device associated with the QXmlStreamReader, or 0 if no device has been assigned.

setDevice()

If the state() is StartDocument, this function returns the encoding string as specified in the XML declaration. Otherwise an empty string is returned.

If the state() is StartDocument, this function returns the version string as specified in the XML declaration. Otherwise an empty string is returned.

If the state() is DTD, this function returns the DTD's name. Otherwise an empty string is returned.

If the state() is DTD, this function returns the DTD's public identifier. Otherwise an empty string is returned.

If the state() is DTD, this function returns the DTD's system identifier. Otherwise an empty string is returned.

If the state() is DTD, this function returns the DTD's unparsed (external) entity declarations. Otherwise an empty vector is returned.

The QXmlStreamEntityDeclarations class is defined to be a QVector of QXmlStreamEntityDeclaration.

 QXmlStreamEntityResolver * QXmlStreamReader::entityResolver ( ) const

Returns the entity resolver, or 0 if there is no entity resolver.

setEntityResolver()

Returns the type of the current error, or NoError if no error occurred.

errorString(), raiseError()

Returns the error message that was set with raiseError().

error(), lineNumber(), columnNumber(), characterOffset()
inline

Returns true if an error has occurred, otherwise false.

errorString(), error()

Returns true if the reader reports characters that stem from a CDATA section, otherwise returns false.

isCharacters(), text()
inline

Returns true if tokenType() equals Characters, otherwise returns false.

isWhitespace(), isCDATA()
inline

Returns true if tokenType() equals Comment, otherwise returns false.

inline

Returns true if tokenType() equals DTD, otherwise returns false.

inline

Returns true if tokenType() equals EndDocument, otherwise returns false.

inline

Returns true if tokenType() equals EndElement, otherwise returns false.

inline

Returns true if tokenType() equals EntityReference, otherwise returns false.

inline

Returns true if tokenType() equals ProcessingInstruction, otherwise returns false.

Returns true if this document has been declared standalone in the XML declaration, otherwise returns false.

If no XML declaration has been parsed, this function returns false.

inline

Returns true if tokenType() equals StartDocument, otherwise returns false.

inline

Returns true if tokenType() equals StartElement, otherwise returns false.

Returns true if the reader reports characters that only consist of white-space, otherwise returns false.

isCharacters(), text()

Returns the current line number, starting with 1.

columnNumber(), characterOffset()

Returns the local name of a StartElement, EndElement, or an EntityReference.

namespaceUri(), qualifiedName()

If the state() is StartElement, this function returns the element's namespace declarations. Otherwise an empty vector is returned.

The QXmlStreamNamespaceDeclaration class is defined to be a QVector of QXmlStreamNamespaceDeclaration.

The namespace-processing flag of the stream reader. This property controls whether or not the stream reader processes namespaces. If enabled, the reader processes namespaces, otherwise it does not.

By default, namespace-processing is enabled.

Returns the namespaceUri of a StartElement or EndElement.

name(), qualifiedName()

If the state() is DTD, this function returns the DTD's notation declarations. Otherwise an empty vector is returned.

The QXmlStreamNotationDeclarations class is defined to be a QVector of QXmlStreamNotationDeclaration.

Returns the prefix of a StartElement or EndElement.

name(), qualifiedName()

Returns the data of a ProcessingInstruction.

Returns the target of a ProcessingInstruction.

Returns the qualified name of a StartElement or EndElement;

A qualified name is the raw name of an element in the XML data. It consists of the namespace prefix, followed by colon, followed by the element's local name. Since the namespace prefix is not unique (the same prefix can point to different namespaces and different prefixes can point to the same namespace), you should not use qualifiedName(), but the resolved namespaceUri() and the attribute's local name().

name(), prefix(), namespaceUri()
 void QXmlStreamReader::raiseError ( const QString & message = QString() )

Raises a custom error with an optional error message.

error(), errorString()

Calling this function is equivalent to calling readElementText(ErrorOnUnexpectedElement).

Convenience function to be called in case a StartElement was read. Reads until the corresponding EndElement and returns all text in-between. In case of no error, the current token (see tokenType()) after having called this function is EndElement.

The function concatenates text() when it reads either Characters or EntityReference tokens, but skips ProcessingInstruction and Comment. If the current token is not StartElement, an empty string is returned.

The behavior defines what happens in case anything else is read before reaching EndElement. The function can include the text from child elements (useful for example for HTML), ignore child elements, or raise an UnexpectedElementError and return what was read so far.

Reads the next token and returns its type.

With one exception, once an error() is reported by readNext(), further reading of the XML stream is not possible. Then atEnd() returns true, hasError() returns true, and this function returns QXmlStreamReader::Invalid.

The exception is when error() returns PrematureEndOfDocumentError. This error is reported when the end of an otherwise well-formed chunk of XML is reached, but the chunk does not represent a complete XML document. In that case, parsing can be resumed by calling addData() to add the next chunk of XML, when the stream is being read from a QByteArray, or by waiting for more data to arrive when the stream is being read from a device().

tokenType(), tokenString()

Reads until the next start element within the current element. Returns true when a start element was reached. When the end element was reached, or when an error occurred, false is returned.

The current element is the element matching the most recently parsed start element of which a matching end element has not yet been reached. When the parser has reached the end element, the current element becomes the parent element.

You can traverse a document by repeatedly calling this function while ensuring that the stream reader is not at the end of the document:

while (! xs.atEnd()) {
std::cout << csPrintable(xs.name().toString()) << std::endl;
}
}

This is a convenience function for when you are only concerned with parsing XML elements.

 void QXmlStreamReader::setDevice ( QIODevice * device )

Sets the current device to device. Setting the device resets the stream to its initial state.

device(), clear()
 void QXmlStreamReader::setEntityResolver ( QXmlStreamEntityResolver * resolver )

Makes resolver the new entityResolver().

The stream reader does not take ownership of the resolver. It's the callers responsibility to ensure that the resolver is valid during the entire life-time of the stream reader object, or until another resolver or 0 is set.

entityResolver()
 void QXmlStreamReader::setNamespaceProcessing ( bool enable )

Sets the value of the property to enable.

Reads until the end of the current element, skipping any child nodes. This function is useful for skipping unknown elements.

The current element is the element matching the most recently parsed start element of which a matching end element has not yet been reached. When the parser has reached the end element, the current element becomes the parent element.

Returns the text of Characters, Comment, DTD, or EntityReference.