Skip to content
GitLab
Commit 5563290b authored by Volker Krause's avatar Volker Krause
Browse files

Port XKB rule parser to QXmlStreamReader 

This removes the last use of the deprecated SAX parser API.
parent b7f0d8ad
Pipeline #165848 passed with stage
in 8 minutes and 31 seconds
Hide whitespace changes
Inline Side-by-side
kcms/keyboard/tests/xkb_rules_test.cpp
View file @ 5563290b
......@@ -9,7 +9,6 @@
#include "../xkb_rules.h"
#include <qdom.h>
#include <qxml.h>
static const Rules::ExtrasFlag readExtras = Rules::NO_EXTRAS;
......
kcms/keyboard/xkb_rules.cpp
View file @ 5563290b
......@@ -13,7 +13,7 @@
#include <QDir>
#include <QRegularExpression>
#include <QTextDocument> // for Qt::escape
#include <QXmlAttributes>
#include <QXmlStreamReader>
#include <QtConcurrent>
......@@ -31,25 +31,6 @@
#include <X11/extensions/XKBrules.h>
#include <fixx11h.h>
class RulesHandler : public QXmlDefaultHandler
{
public:
RulesHandler(Rules *rules_, bool fromExtras_)
: rules(rules_)
, fromExtras(fromExtras_)
{
}
bool startElement(const QString &namespaceURI, const QString &localName, const QString &qName, const QXmlAttributes &attributes) override;
bool endElement(const QString &namespaceURI, const QString &localName, const QString &qName) override;
bool characters(const QString &str) override;
private:
QStringList path;
Rules *rules;
const bool fromExtras;
};
static QString translate_xml_item(const QString &itemText)
{
if (itemText.isEmpty()) { // i18n warns on empty input strings
......@@ -210,17 +191,67 @@ Rules *Rules::readRules(Rules *rules, const QString &filename, bool fromExtras)
return nullptr;
}
RulesHandler rulesHandler(rules, fromExtras);
QXmlSimpleReader reader;
reader.setContentHandler(&rulesHandler);
reader.setErrorHandler(&rulesHandler);
QStringList path;
QXmlStreamReader reader(&file);
while (!reader.atEnd()) {
const auto token = reader.readNext();
if (token == QXmlStreamReader::StartElement) {
path << reader.name().toString();
QString strPath = path.join(QLatin1String("/"));
if (strPath.endsWith(QLatin1String("layoutList/layout/configItem"))) {
rules->layoutInfos << new LayoutInfo(fromExtras);
} else if (strPath.endsWith(QLatin1String("layoutList/layout/variantList/variant"))) {
rules->layoutInfos.last()->variantInfos << new VariantInfo(fromExtras);
} else if (strPath.endsWith(QLatin1String("modelList/model"))) {
rules->modelInfos << new ModelInfo();
} else if (strPath.endsWith(QLatin1String("optionList/group"))) {
rules->optionGroupInfos << new OptionGroupInfo();
rules->optionGroupInfos.last()->exclusive = (reader.attributes().value(QStringLiteral("allowMultipleSelection")) != QLatin1String("true"));
} else if (strPath.endsWith(QLatin1String("optionList/group/option"))) {
rules->optionGroupInfos.last()->optionInfos << new OptionInfo();
} else if (strPath == ("xkbConfigRegistry") && !reader.attributes().value(QStringLiteral("version")).isEmpty()) {
rules->version = reader.attributes().value(QStringLiteral("version")).toString();
qCDebug(KCM_KEYBOARD) << "xkbConfigRegistry version" << rules->version;
}
QXmlInputSource xmlInputSource(&file);
if (strPath.endsWith(QLatin1String("layoutList/layout/configItem/name"))) {
if (rules->layoutInfos.last() != nullptr) {
rules->layoutInfos.last()->name = reader.readElementText().trimmed();
}
} else if (strPath.endsWith(QLatin1String("layoutList/layout/configItem/description"))) {
rules->layoutInfos.last()->description = reader.readElementText().trimmed();
} else if (strPath.endsWith(QLatin1String("layoutList/layout/configItem/languageList/iso639Id"))) {
rules->layoutInfos.last()->languages << reader.readElementText().trimmed();
} else if (strPath.endsWith(QLatin1String("layoutList/layout/variantList/variant/configItem/name"))) {
rules->layoutInfos.last()->variantInfos.last()->name = reader.readElementText().trimmed();
} else if (strPath.endsWith(QLatin1String("layoutList/layout/variantList/variant/configItem/description"))) {
rules->layoutInfos.last()->variantInfos.last()->description = reader.readElementText().trimmed();
} else if (strPath.endsWith(QLatin1String("layoutList/layout/variantList/variant/configItem/languageList/iso639Id"))) {
rules->layoutInfos.last()->variantInfos.last()->languages << reader.readElementText().trimmed();
} else if (strPath.endsWith(QLatin1String("modelList/model/configItem/name"))) {
rules->modelInfos.last()->name = reader.readElementText().trimmed();
} else if (strPath.endsWith(QLatin1String("modelList/model/configItem/description"))) {
rules->modelInfos.last()->description = reader.readElementText().trimmed();
} else if (strPath.endsWith(QLatin1String("modelList/model/configItem/vendor"))) {
rules->modelInfos.last()->vendor = reader.readElementText().trimmed();
} else if (strPath.endsWith(QLatin1String("optionList/group/configItem/name"))) {
rules->optionGroupInfos.last()->name = reader.readElementText().trimmed();
} else if (strPath.endsWith(QLatin1String("optionList/group/configItem/description"))) {
rules->optionGroupInfos.last()->description = reader.readElementText().trimmed();
} else if (strPath.endsWith(QLatin1String("optionList/group/option/configItem/name"))) {
rules->optionGroupInfos.last()->optionInfos.last()->name = reader.readElementText().trimmed();
} else if (strPath.endsWith(QLatin1String("optionList/group/option/configItem/description"))) {
rules->optionGroupInfos.last()->optionInfos.last()->description = reader.readElementText().trimmed();
}
} else if (token == QXmlStreamReader::EndElement) {
path.removeLast();
}
}
qCDebug(KCM_KEYBOARD) << "Parsing xkb rules from" << file.fileName();
if (!reader.parse(xmlInputSource)) {
if (reader.hasError()) {
qCCritical(KCM_KEYBOARD) << "Failed to parse the rules file" << file.fileName();
return nullptr;
}
......@@ -230,72 +261,6 @@ Rules *Rules::readRules(Rules *rules, const QString &filename, bool fromExtras)
return rules;
}
bool RulesHandler::startElement(const QString & /*namespaceURI*/, const QString & /*localName*/, const QString &qName, const QXmlAttributes &attributes)
{
path << QString(qName);
QString strPath = path.join(QLatin1String("/"));
if (strPath.endsWith(QLatin1String("layoutList/layout/configItem"))) {
rules->layoutInfos << new LayoutInfo(fromExtras);
} else if (strPath.endsWith(QLatin1String("layoutList/layout/variantList/variant"))) {
rules->layoutInfos.last()->variantInfos << new VariantInfo(fromExtras);
} else if (strPath.endsWith(QLatin1String("modelList/model"))) {
rules->modelInfos << new ModelInfo();
} else if (strPath.endsWith(QLatin1String("optionList/group"))) {
rules->optionGroupInfos << new OptionGroupInfo();
rules->optionGroupInfos.last()->exclusive = (attributes.value(QStringLiteral("allowMultipleSelection")) != QLatin1String("true"));
} else if (strPath.endsWith(QLatin1String("optionList/group/option"))) {
rules->optionGroupInfos.last()->optionInfos << new OptionInfo();
} else if (strPath == ("xkbConfigRegistry") && !attributes.value(QStringLiteral("version")).isEmpty()) {
rules->version = attributes.value(QStringLiteral("version"));
qCDebug(KCM_KEYBOARD) << "xkbConfigRegistry version" << rules->version;
}
return true;
}
bool RulesHandler::endElement(const QString & /*namespaceURI*/, const QString & /*localName*/, const QString & /*qName*/)
{
path.removeLast();
return true;
}
bool RulesHandler::characters(const QString &str)
{
if (!str.trimmed().isEmpty()) {
QString strPath = path.join(QLatin1String("/"));
if (strPath.endsWith(QLatin1String("layoutList/layout/configItem/name"))) {
if (rules->layoutInfos.last() != nullptr) {
rules->layoutInfos.last()->name = str.trimmed();
}
} else if (strPath.endsWith(QLatin1String("layoutList/layout/configItem/description"))) {
rules->layoutInfos.last()->description = str.trimmed();
} else if (strPath.endsWith(QLatin1String("layoutList/layout/configItem/languageList/iso639Id"))) {
rules->layoutInfos.last()->languages << str.trimmed();
} else if (strPath.endsWith(QLatin1String("layoutList/layout/variantList/variant/configItem/name"))) {
rules->layoutInfos.last()->variantInfos.last()->name = str.trimmed();
} else if (strPath.endsWith(QLatin1String("layoutList/layout/variantList/variant/configItem/description"))) {
rules->layoutInfos.last()->variantInfos.last()->description = str.trimmed();
} else if (strPath.endsWith(QLatin1String("layoutList/layout/variantList/variant/configItem/languageList/iso639Id"))) {
rules->layoutInfos.last()->variantInfos.last()->languages << str.trimmed();
} else if (strPath.endsWith(QLatin1String("modelList/model/configItem/name"))) {
rules->modelInfos.last()->name = str.trimmed();
} else if (strPath.endsWith(QLatin1String("modelList/model/configItem/description"))) {
rules->modelInfos.last()->description = str.trimmed();
} else if (strPath.endsWith(QLatin1String("modelList/model/configItem/vendor"))) {
rules->modelInfos.last()->vendor = str.trimmed();
} else if (strPath.endsWith(QLatin1String("optionList/group/configItem/name"))) {
rules->optionGroupInfos.last()->name = str.trimmed();
} else if (strPath.endsWith(QLatin1String("optionList/group/configItem/description"))) {
rules->optionGroupInfos.last()->description = str.trimmed();
} else if (strPath.endsWith(QLatin1String("optionList/group/option/configItem/name"))) {
rules->optionGroupInfos.last()->optionInfos.last()->name = str.trimmed();
} else if (strPath.endsWith(QLatin1String("optionList/group/option/configItem/description"))) {
rules->optionGroupInfos.last()->optionInfos.last()->description = str.trimmed();
}
}
return true;
}
bool LayoutInfo::isLanguageSupportedByLayout(const QString &lang) const
{
return languages.contains(lang) || isLanguageSupportedByVariants(lang);
......
kcms/keyboard/xkb_rules.h
View file @ 5563290b
......@@ -9,7 +9,6 @@
#include <QList>
#include <QStringList>
#include <QXmlDefaultHandler>
#include <config-keyboard.h>
......
  • Nicolas Fella @nicolasfella ·
    Developer

    This seems to break the layout list for me.

    Layouts > Add shows only 'us' and 'apl'

  • Volker Krause @vkrause ·
    Author Developer

    I should not have trusted the unit tests that much... fixed in !926 (merged).

Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment