From 61c2055da70385064c554723ad234599e63f4d7a Mon Sep 17 00:00:00 2001 From: Ismael Asensio Date: Sat, 20 Mar 2021 01:43:47 +0700 Subject: [PATCH] rulebooksettings: Add accesors to the rules settings list Previously, the only way to access the rules list was via the `rules()` and `setRules()` methods, so the actual settings objects were not accesible. This commit adds methods to retrieve, insert, remove or reorder the rules within the list. Since every individual rule is stored as a KConfig group, and they are not designed to be dynamically renamed, using consecutive numbered groups and store only the total count is problematic. So we also add a new stringlist setting to store the rules group names and their order. Now any group name is valid. To avoid collisions use random QUuids as group names for newly created rules. --- src/rulebooksettings.cpp | 130 ++++++++++++++++++++++++++++------ src/rulebooksettings.h | 15 ++++ src/rulebooksettingsbase.kcfg | 8 ++- 3 files changed, 128 insertions(+), 25 deletions(-) diff --git a/src/rulebooksettings.cpp b/src/rulebooksettings.cpp index a68addf88b..a9b2fc385b 100644 --- a/src/rulebooksettings.cpp +++ b/src/rulebooksettings.cpp @@ -3,6 +3,7 @@ This file is part of the KDE project. SPDX-FileCopyrightText: 2020 Henri Chain + SPDX-FileCopyrightText: 2021 Ismael Asensio SPDX-License-Identifier: GPL-2.0-or-later */ @@ -10,14 +11,13 @@ #include "rulebooksettings.h" #include "rulesettings.h" +#include + namespace KWin { RuleBookSettings::RuleBookSettings(KSharedConfig::Ptr config, QObject *parent) : RuleBookSettingsBase(config, parent) { - for (int i = 1; i <= count(); i++) { - m_list.append(new RuleSettings(config, QString::number(i), this)); - } } RuleBookSettings::RuleBookSettings(const QString &configname, KConfig::OpenFlags flags, QObject *parent) @@ -35,34 +35,49 @@ RuleBookSettings::RuleBookSettings(QObject *parent) { } +RuleBookSettings::~RuleBookSettings() +{ + qDeleteAll(m_list); +} + void RuleBookSettings::setRules(const QVector &rules) { - int i = 1; + mCount = rules.count(); + mRuleGroupList.clear(); + mRuleGroupList.reserve(rules.count()); + + int i = 0; const int list_length = m_list.length(); for (const auto &rule : rules) { RuleSettings *settings; - if (i <= list_length) { - settings = m_list[i - 1]; + if (i < list_length) { + // Optimization. Reuse RuleSettings already created + settings = m_list.at(i); settings->setDefaults(); } else { // If there are more rules than in cache - settings = new RuleSettings(this->sharedConfig(), QString::number(i), this); + settings = new RuleSettings(this->sharedConfig(), QString::number(i + 1), this); m_list.append(settings); } + rule->write(settings); + mRuleGroupList.append(settings->currentGroup()); + i++; } - setCount(rules.length()); + for (int j = m_list.count() - 1; j >= rules.count(); j--) { + delete m_list[j]; + m_list.removeAt(j); + } } QVector RuleBookSettings::rules() { QVector result; - result.reserve(mCount); - // mCount is always <= m_list.length() - for (int i = 0; i < mCount; i++) { - result.append(new Rules(m_list[i])); + result.reserve(m_list.count()); + for (const auto &settings : qAsConst(m_list)) { + result.append(new Rules(settings)); } return result; } @@ -73,25 +88,94 @@ bool RuleBookSettings::usrSave() for (const auto &settings : qAsConst(m_list)) { result &= settings->save(); } - int nRuleGroups = sharedConfig()->groupList().length() - 1; - // Remove any extra groups currently in config - for (int i = mCount + 1; i <= nRuleGroups; i++) { - sharedConfig()->deleteGroup(QString::number(i)); + + // Remove deleted groups from config + for (const QString &groupName : qAsConst(m_storedGroups)) { + if (sharedConfig()->hasGroup(groupName) && !mRuleGroupList.contains(groupName)) { + sharedConfig()->deleteGroup(groupName); + } } + m_storedGroups = mRuleGroupList; + return result; } void RuleBookSettings::usrRead() { - const int list_length = m_list.length(); - for (int i = 1; i <= mCount; i++) { - if (i <= list_length) { - m_list[i - 1]->load(); - } else { - // If there are more groups than in cache - m_list.append(new RuleSettings(sharedConfig(), QString::number(i), this)); + qDeleteAll(m_list); + m_list.clear(); + + // Legacy path for backwards compatibility with older config files without a rules list + if (mRuleGroupList.isEmpty() && mCount > 0) { + mRuleGroupList.reserve(mCount); + for (int i = 1; i <= count(); i++) { + mRuleGroupList.append(QString::number(i)); } + save(); // Save the generated ruleGroupList property + } + + mCount = mRuleGroupList.count(); + m_storedGroups = mRuleGroupList; + + m_list.reserve(mRuleGroupList.count()); + for (const QString &groupName : qAsConst(mRuleGroupList)) { + m_list.append(new RuleSettings(sharedConfig(), groupName, this)); } } +bool RuleBookSettings::usrIsSaveNeeded() const +{ + return isSaveNeeded() || std::any_of(m_list.cbegin(), m_list.cend(), [](const auto &settings) { + return settings->isSaveNeeded(); + }); +} + +int RuleBookSettings::ruleCount() const +{ + return m_list.count(); +} + +RuleSettings *RuleBookSettings::ruleSettingsAt(int row) const +{ + Q_ASSERT(row >= 0 && row < m_list.count()); + return m_list.at(row); +} + +RuleSettings *RuleBookSettings::insertRuleSettingsAt(int row) +{ + Q_ASSERT(row >= 0 && row < m_list.count() + 1); + + const QString groupName = generateGroupName(); + RuleSettings *settings = new RuleSettings(sharedConfig(), groupName, this); + settings->setDefaults(); + + m_list.insert(row, settings); + mRuleGroupList.insert(row, groupName); + mCount++; + + return settings; +} + +void RuleBookSettings::removeRuleSettingsAt(int row) +{ + Q_ASSERT(row >= 0 && row < m_list.count()); + + delete m_list.at(row); + m_list.removeAt(row); + mRuleGroupList.removeAt(row); + mCount--; +} + +void RuleBookSettings::moveRuleSettings(int srcRow, int destRow) +{ + Q_ASSERT(srcRow >= 0 && srcRow < m_list.count() && destRow >= 0 && destRow < m_list.count()); + + m_list.insert(destRow, m_list.takeAt(srcRow)); + mRuleGroupList.insert(destRow, mRuleGroupList.takeAt(srcRow)); +} + +QString RuleBookSettings::generateGroupName() +{ + return QUuid::createUuid().toString(QUuid::WithoutBraces); +} } diff --git a/src/rulebooksettings.h b/src/rulebooksettings.h index 1ba98827f9..39def9c052 100644 --- a/src/rulebooksettings.h +++ b/src/rulebooksettings.h @@ -3,6 +3,7 @@ This file is part of the KDE project. SPDX-FileCopyrightText: 2020 Henri Chain + SPDX-FileCopyrightText: 2021 Ismael Asensio SPDX-License-Identifier: GPL-2.0-or-later */ @@ -25,13 +26,27 @@ public: RuleBookSettings(const QString &configname, KConfig::OpenFlags, QObject *parent = nullptr); RuleBookSettings(KConfig::OpenFlags, QObject *parent = nullptr); RuleBookSettings(QObject *parent = nullptr); + ~RuleBookSettings(); + void setRules(const QVector &); QVector rules(); + bool usrSave() override; void usrRead() override; + bool usrIsSaveNeeded() const; + + int ruleCount() const; + RuleSettings *ruleSettingsAt(int row) const; + RuleSettings *insertRuleSettingsAt(int row); + void removeRuleSettingsAt(int row); + void moveRuleSettings(int srcRow, int destRow); + +private: + static QString generateGroupName(); private: QVector m_list; + QStringList m_storedGroups; }; } diff --git a/src/rulebooksettingsbase.kcfg b/src/rulebooksettingsbase.kcfg index 4a64810f35..5f8f210492 100644 --- a/src/rulebooksettingsbase.kcfg +++ b/src/rulebooksettingsbase.kcfg @@ -1,13 +1,17 @@ - - + 0 + + + QStringList() +