Потоковая обработка XML

С версии 4.3 Qt предоставляет два новых класса для чтения и записи XML: QXmlStreamReader и QXmlStreamWriter.

Классы QXmlStreamReader и QXmlStreamWriter являются новыми классами, предоставленными в Qt 4.3 и более поздних версиях. Потоковый читатель отображает XML-документ как поток токенов. Это отличается от SAX, так как приложения SAX предоставляют обработчики для получения событий XML от анализатора, тогда как QXmlStreamReader управляет циклом, извлекая токены из читателя по мере необходимости. Этот подход «извлечения» позволяет создавать парсеры рекурсивного спуска, позволяя разделить код парсинга XML на различные методы или классы.

QXmlStreamReader — это валидирующий XML-парсер 1.0, который исключает внешние анализируемые сущности. Следовательно, данные, предоставляемые потоковым читателем, соответствуют критериям W3C для хорошо сформированного XML, если не возникнет ошибок. В противном случае можно использовать функции, такие как atEnd(), error() и hasError(), для проверки и просмотра ошибок.

Пример реализации QXmlStreamReader — это XbelReader в Примере закладок потока XML, который оборачивает QXmlStreamReader. Конструктор принимает treeWidget в качестве параметра, и у класса есть специфичные для Xbel функции:

    XbelReader(QTreeWidget *treeWidget);
    ...
    void readXBEL();
    void readTitle(QTreeWidgetItem *item);
    void readSeparator(QTreeWidgetItem *item);
    void readFolder(QTreeWidgetItem *item);
    void readBookmark(QTreeWidgetItem *item);

    QTreeWidgetItem *createChildItem(QTreeWidgetItem *item);

    QXmlStreamReader xml;
    QTreeWidget *treeWidget;
    ...

Функция read() принимает QIODevice и устанавливает его с помощью setDevice(). Функция raiseError() используется для отображения пользовательского сообщения об ошибке, указывающего, что версия файла неверна.

bool XbelReader::read(QIODevice *device)
{
    xml.setDevice(device);

    if (xml.readNextStartElement()) {
        if (xml.name() == QLatin1String("xbel")
            && xml.attributes().value(versionAttribute()) == QLatin1String("1.0")) {
            readXBEL();
        } else {
            xml.raiseError(QObject::tr("The file is not an XBEL version 1.0 file."));
        }
    }

    return !xml.error();
}

Дополнительный класс к QXmlStreamReader — QXmlStreamWriter, который предоставляет XML-записыватель с простым потоковым API. QXmlStreamWriter работает с QIODevice и имеет специализированные функции для всех XML-токенов или событий, которые вы хотите записать, таких как writeDTD(), writeCharacters(), writeComment() и так далее.

Для записи XML-документа с помощью QXmlStreamWriter вы начинаете документ с помощью функции writeStartDocument() и заканчиваете её writeEndDocument(), которая неявно закрывает все оставшиеся открытые теги. Теги элементов открываются с помощью writeStartDocument() и следуют за writeAttribute() или writeAttributes(), содержимым элемента и затем writeEndDocument(). Также можно использовать writeEmptyElement() для записи пустых элементов.

Содержимое элемента включает символы, ссылки на сущности или вложенные элементы. Содержимое можно записать с помощью writeCharacters(), функции, которая также обрабатывает экранирование всех запрещённых символов и последовательностей символов, writeEntityReference() или последующие вызовы writeStartElement().

Класс XbelWriter из Примера закладок потока XML оборачивает QXmlStreamWriter. Его функция writeFile() демонстрирует основные функции QXmlStreamWriter, упомянутые выше:

bool XbelWriter::writeFile(QIODevice *device)
{
    xml.setDevice(device);

    xml.writeStartDocument();
    xml.writeDTD(QStringLiteral("<!DOCTYPE xbel>"));
    xml.writeStartElement(QStringLiteral("xbel"));
    xml.writeAttribute(XbelReader::versionAttribute(), QStringLiteral("1.0"));
    for (int i = 0; i < treeWidget->topLevelItemCount(); ++i)
        writeItem(treeWidget->topLevelItem(i));

    xml.writeEndDocument();
    return true;
}