Class Poco::XML::XMLStreamParser

Library: XML
Package: XML
Header: Poco/XML/XMLStreamParser.h

Description

The streaming XML pull parser and streaming XML serializer. The parser is a conforming, non-validating XML 1.0 implementation (see Implementation Notes for details). The application character encoding (that is, the encoding used in the application's memory) for both parser and serializer is UTF-8. The output encoding of the serializer is UTF-8 as well. The parser supports UTF-8, UTF-16, ISO-8859-1, and US-ASCII input encodings.

Attribute map:

Attribute map lookup. If attribute is not found, then the version without the default value throws an appropriate parsing exception while the version with the default value returns that value.

Note also that there is no attribute(ns, name) version since it would conflict with attribute(name, dv) (qualified attributes are not very common).

Attribute map is valid throughout at the "element level" until end_element and not just during EV_START_ELEMENT. As a special case, the map is still valid after peek() that returned end_element until this end_element event is retrieved with next().

Using parser:

XMLStreamParser p(ifs, argv[1]);
for (XMLStreamParser::EventType e: p)
{
    switch (e)
    {
    case XMLStreamParser::EV_START_ELEMENT:
        cerr << p.line () << ':' << p.column () << ": start " << p.name () << endl;
        break;
    case XMLStreamParser::EV_END_ELEMENT:
        cerr << p.line () << ':' << p.column () << ": end " << p.name () << endl;
        break;
    case XMLStreamParser::EV_START_ATTRIBUTE:
        ...
    case XMLStreamParser::EV_END_ATTRIBUTE:
        ...
    case XMLStreamParser::EV_CHARACTERS:
        ...
    }
}

Member Summary

Member Functions: attribute, attributeMap, attributePresent, begin, column, content, element, end, event, getQName, inputName, line, localName, namespaceURI, next, nextExpect, peek, prefix, value

Nested Classes

struct AttributeValueType

struct Iterator

Types Aliases

AttributeMapType

using AttributeMapType = std::map < QName, AttributeValueType >;

FeatureType

using FeatureType = unsigned short;

If both receive_attributes_event and RECEIVE_ATTRIBUTE_MAP are specified, then RECEIVE_ATTRIBUTES_EVENT is assumed.

Enumerations

EventType

Parsing events.

EV_START_NAMESPACE_DECL

EV_END_NAMESPACE_DECL

EV_EOF

Constructors

XMLStreamParser

XMLStreamParser(
    std::istream & param559,
    const std::string & inputName,
    FeatureType = RECEIVE_DEFAULT
);

The parser constructor takes three arguments: the stream to parse, input name that is used in diagnostics to identify the document being parsed, and the list of events we want the parser to report.

Parse std::istream. Input name is used in diagnostics to identify the document being parsed.

If stream exceptions are enabled then std::ios_base::failure exception is used to report io errors (badbit and failbit). Otherwise, those are reported as the parsing exception.