added xml include logic

src/mvvmcore/qtmvvmcore_global.cpp

@@ -3,7 +3,7 @@
 
 namespace QtMvvm {
 
-#ifdef QT_NO_DEBUG
+#ifdef QT_NO_DEBUG //TODO always info only
 Q_LOGGING_CATEGORY(mvvmLoggingCat, "qtmvvm", QtInfoMsg)
 #else
 Q_LOGGING_CATEGORY(mvvmLoggingCat, "qtmvvm", QtDebugMsg)

src/mvvmsettingscore/settingssetuploader.cpp

@@ -1,5 +1,9 @@
 #include "settingssetuploader_p.h"
+
 #include <QtCore/QCoreApplication>
+#include <QtCore/QDir>
+
+#include <QtMvvmCore/private/qtmvvm_logging_p.h>
 using namespace QtMvvm;
 using namespace QtMvvm::SettingsElements;
 
@@ -26,7 +30,7 @@ SettingsSetup SettingsSetupLoader::loadSetup(const QString &filePath, const QStr
 {
 	SettingsSetup setup;
 	if(!_cache.contains(filePath)) {
-		QFile file(filePath);
+		QFile file(QDir::cleanPath(filePath));
 		if(!file.open(QIODevice::ReadOnly | QIODevice::Text))
 			throw SettingsXmlException(file);
 
@@ -39,10 +43,16 @@ SettingsSetup SettingsSetupLoader::loadSetup(const QString &filePath, const QStr
 		setup.allowRestore = reader.boolValue("allowRestore");
 
 		if(reader.readNextStartElement()) {
-			if(reader.name() == QStringLiteral("Category")) {
+			if(reader.name() == QStringLiteral("Category") ||
-				do
+			   reader.name() == QStringLiteral("Include")) {
+				do {
+					if(reader.name() == QStringLiteral("Include")) {
+						SettingsCategory category;
+						if(readCategoryInclude(reader, category))
+							setup.categories.append(category);
+					} else
 						setup.categories.append(readCategory(reader));
-				while(reader.readNextStartElement());
+				} while(reader.readNextStartElement());
 			} else
 				setup.categories.append(readDefaultCategory(reader));
 		}
@@ -89,14 +99,8 @@ SettingsCategory SettingsSetupLoader::readCategory(QXmlStreamReader &reader) con
 	category.frontends = reader.stringValue("frontends");
 	category.selectors = reader.stringValue("selectors");
 
-	if(reader.readNextStartElement()) {
+	if(reader.readNextStartElement())
-		if(reader.name() == QStringLiteral("Section")) {
+		readCategoryChildren(reader, category);
-			do
-				category.sections.append(readSection(reader));
-			while(reader.readNextStartElement());
-		} else
-			category.sections.append(readDefaultSection(reader));
-	}
 	testXmlValid(reader);
 
 	return category;
@@ -106,15 +110,25 @@ SettingsCategory SettingsSetupLoader::readDefaultCategory(QXmlStreamReader &read
 {
 	testXmlValid(reader);
 	auto category = createDefaultCategory();
-	if(reader.name() == QStringLiteral("Section")) {
+	readCategoryChildren(reader, category);
-		do
+	testXmlValid(reader);
+	return category;
+}
+
+void SettingsSetupLoader::readCategoryChildren(QXmlStreamReader &reader, SettingsCategory &category) const
+{
+	if(reader.name() == QStringLiteral("Section") ||
+	   reader.name() == QStringLiteral("Include")) {
+		do {
+			if(reader.name() == QStringLiteral("Include")) {
+				SettingsSection section;
+				if(readSectionInclude(reader, section))
+					category.sections.append(section);
+			} else
 				category.sections.append(readSection(reader));
-		while(reader.readNextStartElement());
+		} while(reader.readNextStartElement());
 	} else
 		category.sections.append(readDefaultSection(reader));
-	testXmlValid(reader);
-
-	return category;
 }
 
 SettingsSection SettingsSetupLoader::readSection(QXmlStreamReader &reader) const
@@ -134,14 +148,8 @@ SettingsSection SettingsSetupLoader::readSection(QXmlStreamReader &reader) const
 	section.frontends = reader.stringValue("frontends");
 	section.selectors = reader.stringValue("selectors");
 
-	if(reader.readNextStartElement()) {
+	if(reader.readNextStartElement())
-		if(reader.name() == QStringLiteral("Group")) {
+		readSectionChildren(reader, section);
-			do
-				section.groups.append(readGroup(reader));
-			while(reader.readNextStartElement());
-		} else
-			section.groups.append(readDefaultGroup(reader));
-	}
 	testXmlValid(reader);
 
 	return section;
@@ -151,16 +159,25 @@ SettingsSection SettingsSetupLoader::readDefaultSection(QXmlStreamReader &reader
 {
 	testXmlValid(reader);
 	auto section = createDefaultSection();
+	readSectionChildren(reader, section);
+	testXmlValid(reader);
+	return section;
+}
 
-	if(reader.name() == QStringLiteral("Group")) {
+void SettingsSetupLoader::readSectionChildren(QXmlStreamReader &reader, SettingsSection &section) const
-		do
+{
+	if(reader.name() == QStringLiteral("Group") ||
+	   reader.name() == QStringLiteral("Include")) {
+		do {
+			if(reader.name() == QStringLiteral("Include")) {
+				SettingsGroup group;
+				if(readGroupInclude(reader, group))
+					section.groups.append(group);
+			} else
 				section.groups.append(readGroup(reader));
-		while(reader.readNextStartElement());
+		} while(reader.readNextStartElement());
 	} else
 		section.groups.append(readDefaultGroup(reader));
-	testXmlValid(reader);
-
-	return section;
 }
 
 SettingsGroup SettingsSetupLoader::readGroup(QXmlStreamReader &reader) const
@@ -177,14 +194,8 @@ SettingsGroup SettingsSetupLoader::readGroup(QXmlStreamReader &reader) const
 	group.frontends = reader.stringValue("frontends");
 	group.selectors = reader.stringValue("selectors");
 
-	if(reader.readNextStartElement()) {
+	if(reader.readNextStartElement())
-		if(reader.name() == QStringLiteral("Entry")) {
+		readGroupChildren(reader, group);
-			do
-				group.entries.append(readEntry(reader));
-			while(reader.readNextStartElement());
-		} else
-			throwElement(reader, "Entry");
-	}
 	testXmlValid(reader);
 
 	return group;
@@ -194,21 +205,33 @@ SettingsGroup SettingsSetupLoader::readDefaultGroup(QXmlStreamReader &reader) co
 {
 	testXmlValid(reader);
 	SettingsGroup group;
+	readGroupChildren(reader, group);
+	testXmlValid(reader);
+	return group;
+}
 
-	if(reader.name() == QStringLiteral("Entry")) {
+void SettingsSetupLoader::readGroupChildren(QXmlStreamReader &reader, SettingsGroup &group) const
-		do
+{
+	if(reader.name() == QStringLiteral("Entry") ||
+	   reader.name() == QStringLiteral("Include")) {
+		do {
+			if(reader.name() == QStringLiteral("Include")) {
+				SettingsEntry entry;
+				if(readEntryInclude(reader, entry))
+					group.entries.append(entry);
+			} else
 				group.entries.append(readEntry(reader));
-		while(reader.readNextStartElement());
+		} while(reader.readNextStartElement());
 	} else
-		throwElement(reader, "Entry");
+		throwXmlError(reader, QStringLiteral("Unexpected element type <%1>").arg(reader.name()).toUtf8());
-	testXmlValid(reader);
-
-	return group;
 }
 
 SettingsEntry SettingsSetupLoader::readEntry(QXmlStreamReader &reader) const
 {
 	testXmlValid(reader);
+	if(reader.name() != QStringLiteral("Entry"))
+		throwElement(reader, "Entry");
+
 	SettingsEntry entry;
 
 	if(!reader.hasValue("key"))
@@ -226,9 +249,10 @@ SettingsEntry SettingsSetupLoader::readEntry(QXmlStreamReader &reader) const
 	entry.selectors = reader.stringValue("selectors");
 
 	while(reader.readNextStartElement()) {
-		if(reader.name() == QStringLiteral("SearchKey"))
+		if(reader.name() == QStringLiteral("SearchKey")) {
 			entry.searchKeys.append(trctx(reader.readElementText()));
-		else if(reader.name() == QStringLiteral("Property")) {
+			testXmlValid(reader);
+		} else if(reader.name() == QStringLiteral("Property")) {
 			auto prop = readProperty(reader);
 			entry.properties.insert(std::get<0>(prop), std::get<1>(prop));
 		} else
@@ -303,12 +327,80 @@ QVariant SettingsSetupLoader::readElement(QXmlStreamReader &reader) const
 		mVariant = trctx(reader.readElementText());
 	else
 		mVariant = reader.readElementText();
+	testXmlValid(reader);
 	if(!mVariant.convert(typeId))
 		throwXmlError(reader, "Failed to convert element data to type: " + type.toUtf8());
 
 	return mVariant;
 }
 
+bool SettingsSetupLoader::readCategoryInclude(QXmlStreamReader &reader, SettingsCategory &category) const
+{
+	return readInclude(reader, [this, &category](QXmlStreamReader &reader){
+		category = readCategory(reader);
+	}, QStringLiteral("Category"));
+}
+
+bool SettingsSetupLoader::readSectionInclude(QXmlStreamReader &reader, SettingsSection &section) const
+{
+	return readInclude(reader, [this, &section](QXmlStreamReader &reader){
+		section = readSection(reader);
+	}, QStringLiteral("Section"));
+}
+
+bool SettingsSetupLoader::readGroupInclude(QXmlStreamReader &reader, SettingsGroup &group) const
+{
+	return readInclude(reader, [this, &group](QXmlStreamReader &reader){
+		group = readGroup(reader);
+	}, QStringLiteral("Group"));
+}
+
+bool SettingsSetupLoader::readEntryInclude(QXmlStreamReader &reader, SettingsEntry &entry) const
+{
+	return readInclude(reader, [this, &entry](QXmlStreamReader &reader){
+		entry = readEntry(reader);
+	}, QStringLiteral("Entry"));
+}
+
+bool SettingsSetupLoader::readInclude(QXmlStreamReader &reader, const std::function<void(QXmlStreamReader &)> &readFn, const QString &typeName) const
+{
+	testXmlValid(reader);
+	if(reader.name() != QStringLiteral("Include"))
+		throwElement(reader, "Include");
+
+	auto optional = reader.boolValue("optional");
+	auto fileName = reader.readElementText();
+	testXmlValid(reader);
+	if(reader.readNextStartElement())
+		throwXmlError(reader, "The <Include> Element must not have any child elements");
+
+	try {
+		auto dir = QDir::current();
+		auto dev = qobject_cast<QFileDevice*>(reader.device());
+		if(dev)
+			dir = QFileInfo(dev->fileName()).dir();
+
+		QFile incFile(QDir::cleanPath(dir.absoluteFilePath(fileName)));
+		if(!incFile.open(QIODevice::ReadOnly | QIODevice::Text))
+			throw SettingsXmlException(incFile);
+
+		QXmlStreamReader incReader(&incFile);
+		if(!incReader.readNextStartElement() || incReader.name() != typeName)
+			throwXmlError(reader, QStringLiteral("Expected element of type <%1>").arg(typeName).toUtf8());
+		readFn(incReader);
+		testXmlValid(reader);
+		incFile.close();
+
+		return true;
+	} catch(SettingsXmlException &e) {
+		if(optional) {
+			logInfo() << "Skipped include file:" << e.what();
+			return false;
+		} else
+			throw;
+	}
+}
+
 void SettingsSetupLoader::clearSetup(SettingsSetup &setup, const QString &frontend, const QStringList &selectors) const
 {
 	for(auto it = setup.categories.begin(); it != setup.categories.end();) {
@@ -382,7 +474,11 @@ bool SettingsSetupLoader::isUsable(const T &configElement, const QString &fronte
 
 SettingsXmlException::SettingsXmlException(const QXmlStreamReader &reader) :
 	SettingsLoaderException(),
-	_what(QStringLiteral("XML Error at %1:%2. Error: %3")
+	_what(QStringLiteral("XML Error in file \"%1\", line %2, column %3. Error: %4")
+		  .arg([&](){
+			  auto dev = qobject_cast<QFileDevice*>(reader.device());
+			  return dev ? dev->fileName() : QStringLiteral("<unknown>");
+		  }())
 		  .arg(reader.lineNumber())
 		  .arg(reader.columnNumber())
 		  .arg(reader.errorString())

src/mvvmsettingscore/settingssetuploader_p.h

@@ -31,15 +31,18 @@ private:
 
 	mutable QCache<QString, SettingsElements::SettingsSetup> _cache;
 
-	//functions to read the settings XML
+	//Functions to read the settings XML
 	SettingsElements::SettingsCategory readCategory(QXmlStreamReader &reader) const;
 	SettingsElements::SettingsCategory readDefaultCategory(QXmlStreamReader &reader) const;
+	void readCategoryChildren(QXmlStreamReader &reader, SettingsElements::SettingsCategory &category) const;
 
 	SettingsElements::SettingsSection readSection(QXmlStreamReader &reader) const;
 	SettingsElements::SettingsSection readDefaultSection(QXmlStreamReader &reader) const;
+	void readSectionChildren(QXmlStreamReader &reader, SettingsElements::SettingsSection &section) const;
 
 	SettingsElements::SettingsGroup readGroup(QXmlStreamReader &reader) const;
 	SettingsElements::SettingsGroup readDefaultGroup(QXmlStreamReader &reader) const;
+	void readGroupChildren(QXmlStreamReader &reader, SettingsElements::SettingsGroup &group) const;
 
 	SettingsElements::SettingsEntry readEntry(QXmlStreamReader &reader) const;
 
@@ -49,6 +52,13 @@ private:
 	std::tuple<QString, QVariant> readProperty(QXmlStreamReader &reader) const;
 	QVariant readElement(QXmlStreamReader &reader) const;
 
+	//Functions to read included files
+	bool readCategoryInclude(QXmlStreamReader &reader, SettingsElements::SettingsCategory &category) const;
+	bool readSectionInclude(QXmlStreamReader &reader, SettingsElements::SettingsSection &section) const;
+	bool readGroupInclude(QXmlStreamReader &reader, SettingsElements::SettingsGroup &group) const;
+	bool readEntryInclude(QXmlStreamReader &reader, SettingsElements::SettingsEntry &entry) const;
+	bool readInclude(QXmlStreamReader &reader, const std::function<void(QXmlStreamReader&)> &readFn, const QString &typeName) const;
+
 	//Functions to filter the elements
 	void clearSetup(SettingsElements::SettingsSetup &setup, const QString &frontend, const QStringList &selectors) const;
 	void clearCategory(SettingsElements::SettingsCategory &category, const QString &frontend, const QStringList &selectors) const;

src/mvvmsettingscore/settingsviewmodel.cpp

@@ -48,8 +48,13 @@ ISettingsSetupLoader *SettingsViewModel::settingsSetupLoader() const
 
 SettingsElements::SettingsSetup SettingsViewModel::loadSetup(const QString &frontend) const
 {
+	try {
 		QFileSelector selector;
 		return d->setupLoader->loadSetup(d->setupFile, frontend, &selector);
+	} catch(SettingsLoaderException &e) {
+		logCritical() << "Failed to load settings setup:" << e.what();
+		return {};
+	}
 }
 
 QSettings *SettingsViewModel::settings() const