yukijoou/kwin
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

[kcmkwin] Move effects model into a shared library

Browse source 
Summary:
The main motivation for moving it into a shared library is to share the
model between Desktop Effects and Virtual Desktops KCM.

The extracted model is quite the same as the one in Desktop Effects KCM,
except some minor changes, e.g. rename loadEffect and syncConfig to more
convenient names, add comments, some whitespace changes, fix coding
style in some parts, etc.

Test Plan: effectModelTest passes, Desktop Effects KCM works.

Reviewers: #kwin, davidedmundson

Reviewed By: #kwin, davidedmundson

Subscribers: hein, kwin

Tags: #kwin

Differential Revision: https://phabricator.kde.org/D17765
This commit is contained in:
Vlad Zagorodniy 2018-12-22 12:50:28 +02:00
parent 30b257be08
commit c3fd6413b9
9 changed files with 808 additions and 542 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
kcmkwin/CMakeLists.txt
View file

@ -1,5 +1,6 @@
remove_definitions(-DQT_NO_CAST_FROM_ASCII -DQT_STRICT_ITERATORS -DQT_NO_CAST_FROM_BYTEARRAY -DQT_NO_KEYWORDS)
add_subdirectory( common )
add_subdirectory( kwincompositing )
add_subdirectory( kwinoptions )
add_subdirectory( kwindecoration )

32
kcmkwin/common/CMakeLists.txt Normal file
View file

@ -0,0 +1,32 @@
# KI18N Translation Domain for this library
add_definitions(-DTRANSLATION_DOMAIN=\"kcmkwincommon\")
include_directories(${KWIN_SOURCE_DIR}/effects)
set(kcmkwincommon_SRC
effectmodel.cpp
)
qt5_add_dbus_interface(kcmkwincommon_SRC
${KWIN_SOURCE_DIR}/org.kde.kwin.Effects.xml kwin_effects_interface
)
add_library(kcmkwincommon SHARED ${kcmkwincommon_SRC})
target_link_libraries(kcmkwincommon
Qt5::Core
Qt5::DBus
KF5::CoreAddons
KF5::ConfigCore
KF5::I18n
KF5::Package
KF5::KCMUtils
kwin4_effect_builtins
)
set_target_properties(kcmkwincommon PROPERTIES
VERSION ${PROJECT_VERSION}
SOVERSION ${PROJECT_VERSION_MAJOR}
)
install(TARGETS kcmkwincommon ${INSTALL_TARGETS_DEFAULT_ARGS} LIBRARY NAMELINK_SKIP)

2
kcmkwin/common/Messages.sh Normal file
View file

@ -0,0 +1,2 @@
#! /usr/bin/env bash
$XGETTEXT `find . -name \*.cpp` -o $podir/kcmkwincommon.pot

528
kcmkwin/common/effectmodel.cpp Normal file
View file

@ -0,0 +1,528 @@
/********************************************************************
KWin - the KDE window manager
This file is part of the KDE project.
Copyright (C) 2013 Antonis Tsiapaliokas <kok3rs@gmail.com>
Copyright (C) 2018 Vlad Zagorodniy <vladzzag@gmail.com>
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*********************************************************************/
#include "effectmodel.h"
#include <config-kwin.h>
#include <effect_builtins.h>
#include <kwin_effects_interface.h>
#include <KAboutData>
#include <KLocalizedString>
#include <KPackage/PackageLoader>
#include <KPluginLoader>
#include <KPluginMetaData>
#include <KPluginTrader>
#include <QDBusConnection>
#include <QDBusInterface>
#include <QDBusMessage>
#include <QDBusPendingCall>
namespace KWin
{
static QString translatedCategory(const QString &category)
{
static const QVector<QString> knownCategories = {
QStringLiteral("Accessibility"),
QStringLiteral("Appearance"),
QStringLiteral("Candy"),
QStringLiteral("Focus"),
QStringLiteral("Show Desktop Animation"),
QStringLiteral("Tools"),
QStringLiteral("Virtual Desktop Switching Animation"),
QStringLiteral("Window Management"),
QStringLiteral("Window Open/Close Animation")
};
static const QVector<QString> translatedCategories = {
i18nc("Category of Desktop Effects, used as section header", "Accessibility"),
i18nc("Category of Desktop Effects, used as section header", "Appearance"),
i18nc("Category of Desktop Effects, used as section header", "Candy"),
i18nc("Category of Desktop Effects, used as section header", "Focus"),
i18nc("Category of Desktop Effects, used as section header", "Show Desktop Animation"),
i18nc("Category of Desktop Effects, used as section header", "Tools"),
i18nc("Category of Desktop Effects, used as section header", "Virtual Desktop Switching Animation"),
i18nc("Category of Desktop Effects, used as section header", "Window Management"),
i18nc("Category of Desktop Effects, used as section header", "Window Open/Close Animation")
};
const int index = knownCategories.indexOf(category);
if (index == -1) {
qDebug() << "Unknown category '" << category << "' and thus not translated";
return category;
}
return translatedCategories[index];
}
static EffectModel::Status effectStatus(bool enabled)
{
return enabled ? EffectModel::Status::Enabled : EffectModel::Status::Disabled;
}
EffectModel::EffectModel(QObject *parent)
: QAbstractItemModel(parent)
{
}
QHash<int, QByteArray> EffectModel::roleNames() const
{
QHash<int, QByteArray> roleNames;
roleNames[NameRole] = "NameRole";
roleNames[DescriptionRole] = "DescriptionRole";
roleNames[AuthorNameRole] = "AuthorNameRole";
roleNames[AuthorEmailRole] = "AuthorEmailRole";
roleNames[LicenseRole] = "LicenseRole";
roleNames[VersionRole] = "VersionRole";
roleNames[CategoryRole] = "CategoryRole";
roleNames[ServiceNameRole] = "ServiceNameRole";
roleNames[IconNameRole] = "IconNameRole";
roleNames[EffectStatusRole] = "EffectStatusRole";
roleNames[VideoRole] = "VideoRole";
roleNames[WebsiteRole] = "WebsiteRole";
roleNames[SupportedRole] = "SupportedRole";
roleNames[ExclusiveRole] = "ExclusiveRole";
roleNames[ConfigurableRole] = "ConfigurableRole";
roleNames[ScriptedRole] = QByteArrayLiteral("ScriptedRole");
roleNames[EnabledByDefaultRole] = "EnabledByDefaultRole";
return roleNames;
}
QModelIndex EffectModel::index(int row, int column, const QModelIndex &parent) const
{
if (parent.isValid() || column > 0 || column < 0 || row < 0 || row >= m_effectsList.count()) {
return {};
}
return createIndex(row, column);
}
QModelIndex EffectModel::parent(const QModelIndex &child) const
{
Q_UNUSED(child)
return {};
}
int EffectModel::columnCount(const QModelIndex &parent) const
{
Q_UNUSED(parent)
return 1;
}
int EffectModel::rowCount(const QModelIndex &parent) const
{
if (parent.isValid()) {
return 0;
}
return m_effectsList.count();
}
QVariant EffectModel::data(const QModelIndex &index, int role) const
{
if (!index.isValid()) {
return {};
}
const EffectData effect = m_effectsList.at(index.row());
switch (role) {
case Qt::DisplayRole:
case NameRole:
return effect.name;
case DescriptionRole:
return effect.description;
case AuthorNameRole:
return effect.authorName;
case AuthorEmailRole:
return effect.authorEmail;
case LicenseRole:
return effect.license;
case VersionRole:
return effect.version;
case CategoryRole:
return effect.category;
case ServiceNameRole:
return effect.serviceName;
case IconNameRole:
return effect.iconName;
case EffectStatusRole:
return static_cast<int>(effect.effectStatus);
case VideoRole:
return effect.video;
case WebsiteRole:
return effect.website;
case SupportedRole:
return effect.supported;
case ExclusiveRole:
return effect.exclusiveGroup;
case InternalRole:
return effect.internal;
case ConfigurableRole:
return effect.configurable;
case ScriptedRole:
return effect.kind == Kind::Scripted;
case EnabledByDefaultRole:
return effect.enabledByDefault;
default:
return {};
}
}
bool EffectModel::setData(const QModelIndex &index, const QVariant &value, int role)
{
if (!index.isValid()) {
return QAbstractItemModel::setData(index, value, role);
}
if (role == EffectModel::EffectStatusRole) {
// note: whenever the StatusRole is modified (even to the same value) the entry
// gets marked as changed and will get saved to the config file. This means the
// config file could get polluted
EffectData &data = m_effectsList[index.row()];
data.effectStatus = Status(value.toInt());
data.changed = true;
emit dataChanged(index, index);
if (data.effectStatus == Status::Enabled && !data.exclusiveGroup.isEmpty()) {
// need to disable all other exclusive effects in the same category
for (int i = 0; i < m_effectsList.size(); ++i) {
if (i == index.row()) {
continue;
}
EffectData &otherData = m_effectsList[i];
if (otherData.exclusiveGroup == data.exclusiveGroup) {
otherData.effectStatus = Status::Disabled;
otherData.changed = true;
emit dataChanged(this->index(i, 0), this->index(i, 0));
}
}
}
return true;
}
return QAbstractItemModel::setData(index, value, role);
}
void EffectModel::loadBuiltInEffects(const KConfigGroup &kwinConfig, const KPluginInfo::List &configs)
{
const auto builtins = BuiltInEffects::availableEffects();
for (auto builtin : builtins) {
const BuiltInEffects::EffectData &data = BuiltInEffects::effectData(builtin);
EffectData effect;
effect.name = data.displayName;
effect.description = data.comment;
effect.authorName = i18n("KWin development team");
effect.authorEmail = QString(); // not used at all
effect.license = QStringLiteral("GPL");
effect.version = QStringLiteral(KWIN_VERSION_STRING);
effect.untranslatedCategory = data.category;
effect.category = translatedCategory(data.category);
effect.serviceName = data.name;
effect.iconName = QStringLiteral("preferences-system-windows");
effect.enabledByDefault = data.enabled;
effect.enabledByDefaultFunction = (data.enabledFunction != nullptr);
const QString enabledKey = QStringLiteral("%1Enabled").arg(effect.serviceName);
if (kwinConfig.hasKey(enabledKey)) {
effect.effectStatus = effectStatus(kwinConfig.readEntry(effect.serviceName + "Enabled", effect.enabledByDefault));
} else if (data.enabledFunction != nullptr) {
effect.effectStatus = Status::EnabledUndeterminded;
} else {
effect.effectStatus = effectStatus(effect.enabledByDefault);
}
effect.video = data.video;
effect.website = QUrl();
effect.supported = true;
effect.exclusiveGroup = data.exclusiveCategory;
effect.internal = data.internal;
effect.kind = Kind::BuiltIn;
effect.configurable = std::any_of(configs.constBegin(), configs.constEnd(),
[data](const KPluginInfo &info) {
return info.property(QStringLiteral("X-KDE-ParentComponents")).toString() == data.name;
}
);
if (shouldStore(effect)) {
m_effectsList << effect;
}
}
}
void EffectModel::loadJavascriptEffects(const KConfigGroup &kwinConfig)
{
const auto plugins = KPackage::PackageLoader::self()->listPackages(
QStringLiteral("KWin/Effect"),
QStringLiteral("kwin/effects")
);
for (const KPluginMetaData &metaData : plugins) {
KPluginInfo plugin(metaData);
EffectData effect;
effect.name = plugin.name();
effect.description = plugin.comment();
effect.authorName = plugin.author();
effect.authorEmail = plugin.email();
effect.license = plugin.license();
effect.version = plugin.version();
effect.untranslatedCategory = plugin.category();
effect.category = translatedCategory(plugin.category());
effect.serviceName = plugin.pluginName();
effect.iconName = plugin.icon();
effect.effectStatus = effectStatus(kwinConfig.readEntry(effect.serviceName + "Enabled", plugin.isPluginEnabledByDefault()));
effect.enabledByDefault = plugin.isPluginEnabledByDefault();
effect.enabledByDefaultFunction = false;
effect.video = plugin.property(QStringLiteral("X-KWin-Video-Url")).toUrl();
effect.website = plugin.website();
effect.supported = true;
effect.exclusiveGroup = plugin.property(QStringLiteral("X-KWin-Exclusive-Category")).toString();
effect.internal = plugin.property(QStringLiteral("X-KWin-Internal")).toBool();
effect.kind = Kind::Scripted;
const QString pluginKeyword = plugin.property(QStringLiteral("X-KDE-PluginKeyword")).toString();
if (!pluginKeyword.isEmpty()) {
// scripted effects have their pluginName() as the keyword
effect.configurable = plugin.property(QStringLiteral("X-KDE-ParentComponents")).toString() == pluginKeyword;
} else {
effect.configurable = false;
}
if (shouldStore(effect)) {
m_effectsList << effect;
}
}
}
void EffectModel::loadPluginEffects(const KConfigGroup &kwinConfig, const KPluginInfo::List &configs)
{
const auto pluginEffects = KPluginLoader::findPlugins(
QStringLiteral("kwin/effects/plugins/"),
[](const KPluginMetaData &data) {
return data.serviceTypes().contains(QStringLiteral("KWin/Effect"));
}
);
for (const KPluginMetaData &pluginEffect : pluginEffects) {
if (!pluginEffect.isValid()) {
continue;
}
EffectData effect;
effect.name = pluginEffect.name();
effect.description = pluginEffect.description();
effect.license = pluginEffect.license();
effect.version = pluginEffect.version();
effect.untranslatedCategory = pluginEffect.category();
effect.category = translatedCategory(pluginEffect.category());
effect.serviceName = pluginEffect.pluginId();
effect.iconName = pluginEffect.iconName();
effect.enabledByDefault = pluginEffect.isEnabledByDefault();
effect.supported = true;
effect.enabledByDefaultFunction = false;
effect.internal = false;
effect.kind = Kind::Binary;
for (int i = 0; i < pluginEffect.authors().count(); ++i) {
effect.authorName.append(pluginEffect.authors().at(i).name());
effect.authorEmail.append(pluginEffect.authors().at(i).emailAddress());
if (i+1 < pluginEffect.authors().count()) {
effect.authorName.append(", ");
effect.authorEmail.append(", ");
}
}
if (pluginEffect.rawData().contains("org.kde.kwin.effect")) {
const QJsonObject d(pluginEffect.rawData().value("org.kde.kwin.effect").toObject());
effect.exclusiveGroup = d.value("exclusiveGroup").toString();
effect.video = QUrl::fromUserInput(d.value("video").toString());
effect.enabledByDefaultFunction = d.value("enabledByDefaultMethod").toBool();
}
effect.website = pluginEffect.website();
const QString enabledKey = QStringLiteral("%1Enabled").arg(effect.serviceName);
if (kwinConfig.hasKey(enabledKey)) {
effect.effectStatus = effectStatus(kwinConfig.readEntry(effect.serviceName + "Enabled", effect.enabledByDefault));
} else if (effect.enabledByDefaultFunction) {
effect.effectStatus = Status::EnabledUndeterminded;
} else {
effect.effectStatus = effectStatus(effect.enabledByDefault);
}
effect.configurable = std::any_of(configs.constBegin(), configs.constEnd(),
[pluginEffect](const KPluginInfo &info) {
return info.property(QStringLiteral("X-KDE-ParentComponents")).toString() == pluginEffect.pluginId();
}
);
if (shouldStore(effect)) {
m_effectsList << effect;
}
}
}
void EffectModel::load()
{
KConfigGroup kwinConfig(KSharedConfig::openConfig("kwinrc"), "Plugins");
beginResetModel();
m_effectsChanged.clear();
m_effectsList.clear();
const KPluginInfo::List configs = KPluginTrader::self()->query(QStringLiteral("kwin/effects/configs/"));
loadBuiltInEffects(kwinConfig, configs);
loadJavascriptEffects(kwinConfig);
loadPluginEffects(kwinConfig, configs);
qSort(m_effectsList.begin(), m_effectsList.end(), [](const EffectData &a, const EffectData &b) {
if (a.category == b.category) {
if (a.exclusiveGroup == b.exclusiveGroup) {
return a.name < b.name;
}
return a.exclusiveGroup < b.exclusiveGroup;
}
return a.category < b.category;
});
OrgKdeKwinEffectsInterface interface(QStringLiteral("org.kde.KWin"),
QStringLiteral("/Effects"),
QDBusConnection::sessionBus());
if (interface.isValid()) {
QStringList effectNames;
effectNames.reserve(m_effectsList.count());
for (const EffectData &data : m_effectsList) {
effectNames.append(data.serviceName);
}
QDBusPendingCallWatcher *watcher = new QDBusPendingCallWatcher(interface.areEffectsSupported(effectNames), this);
watcher->setProperty("effectNames", effectNames);
connect(watcher, &QDBusPendingCallWatcher::finished, [this](QDBusPendingCallWatcher *self) {
const QStringList effectNames = self->property("effectNames").toStringList();
const QDBusPendingReply<QList<bool > > reply = *self;
QList<bool> supportValues;
if (reply.isValid()) {
supportValues.append(reply.value());
}
if (effectNames.size() == supportValues.size()) {
for (int i = 0; i < effectNames.size(); ++i) {
const bool supportedValue = supportValues.at(i);
const QString &effectName = effectNames.at(i);
auto it = std::find_if(m_effectsList.begin(), m_effectsList.end(), [effectName](const EffectData &data) {
return data.serviceName == effectName;
});
if (it != m_effectsList.end()) {
if ((*it).supported != supportedValue) {
(*it).supported = supportedValue;
QModelIndex i = index(findRowByServiceName(effectName), 0);
if (i.isValid()) {
emit dataChanged(i, i, QVector<int>() << SupportedRole);
}
}
}
}
}
self->deleteLater();
});
}
m_effectsChanged = m_effectsList;
endResetModel();
}
int EffectModel::findRowByServiceName(const QString &serviceName)
{
for (int it = 0; it < m_effectsList.size(); it++) {
if (m_effectsList.at(it).serviceName == serviceName) {
return it;
}
}
return -1;
}
void EffectModel::syncEffectsToKWin()
{
OrgKdeKwinEffectsInterface interface(QStringLiteral("org.kde.KWin"),
QStringLiteral("/Effects"),
QDBusConnection::sessionBus());
for (int it = 0; it < m_effectsList.size(); it++) {
if (m_effectsList.at(it).effectStatus == m_effectsChanged.at(it).effectStatus) {
continue;
}
if (m_effectsList.at(it).effectStatus != Status::Disabled) {
interface.loadEffect(m_effectsList.at(it).serviceName);
} else {
interface.unloadEffect(m_effectsList.at(it).serviceName);
}
}
m_effectsChanged = m_effectsList;
}
void EffectModel::updateEffectStatus(const QModelIndex &rowIndex, Status effectState)
{
setData(rowIndex, static_cast<int>(effectState), EffectModel::EffectStatusRole);
}
void EffectModel::save()
{
KConfigGroup kwinConfig(KSharedConfig::openConfig("kwinrc"), "Plugins");
for (auto it = m_effectsList.begin(); it != m_effectsList.end(); it++) {
EffectData &effect = *(it);
if (!effect.changed) {
continue;
}
effect.changed = false;
const QString key = effect.serviceName + QStringLiteral("Enabled");
const bool shouldEnable = (effect.effectStatus != Status::Disabled);
const bool restoreToDefault = effect.enabledByDefaultFunction
? effect.effectStatus == Status::EnabledUndeterminded
: shouldEnable == effect.enabledByDefault;
if (restoreToDefault) {
kwinConfig.deleteEntry(key);
} else {
kwinConfig.writeEntry(key, shouldEnable);
}
}
kwinConfig.sync();
syncEffectsToKWin();
}
void EffectModel::defaults()
{
for (int i = 0; i < m_effectsList.count(); ++i) {
const auto &effect = m_effectsList.at(i);
if (effect.enabledByDefaultFunction && effect.effectStatus != Status::EnabledUndeterminded) {
updateEffectStatus(index(i, 0), Status::EnabledUndeterminded);
} else if ((bool)effect.effectStatus != effect.enabledByDefault) {
updateEffectStatus(index(i, 0), effect.enabledByDefault ? Status::Enabled : Status::Disabled);
}
}
}
bool EffectModel::shouldStore(const EffectData &data) const
{
Q_UNUSED(data)
return true;
}
}

232
kcmkwin/common/effectmodel.h Normal file
View file

@ -0,0 +1,232 @@
/********************************************************************
KWin - the KDE window manager
This file is part of the KDE project.
Copyright (C) 2013 Antonis Tsiapaliokas <kok3rs@gmail.com>
Copyright (C) 2018 Vlad Zagorodniy <vladzzag@gmail.com>
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*********************************************************************/
#pragma once
#include <kwin_export.h>
#include <KPluginInfo>
#include <KSharedConfig>
#include <QAbstractItemModel>
#include <QString>
#include <QUrl>
namespace KWin
{
class KWIN_EXPORT EffectModel : public QAbstractItemModel
{
Q_OBJECT
public:
/**
* This enum type is used to specify data roles.
**/
enum AdditionalRoles {
/**
* The user-friendly name of the effect.
**/
NameRole = Qt::UserRole + 1,
/**
* The description of the effect.
**/
DescriptionRole,
/**
* The name of the effect's author. If there are several authors, they
* will be comma separated.
**/
AuthorNameRole,
/**
* The email of the effect's author. If there are several authors, the
* emails will be comma separated.
**/
AuthorEmailRole,
/**
* The license of the effect.
**/
LicenseRole,
/**
* The version of the effect.
**/
VersionRole,
/**
* The category of the effect.
**/
CategoryRole,
/**
* The service name(plugin name) of the effect.
**/
ServiceNameRole,
/**
* The icon name of the effect.
**/
IconNameRole,
/**
* Whether the effect is enabled or disabled.
**/
EffectStatusRole,
/**
* Link to a video demonstration of the effect.
**/
VideoRole,
/**
* Link to the home page of the effect.
**/
WebsiteRole,
/**
* Whether the effect is supported.
**/
SupportedRole,
/**
* The exclusive group of the effect.
**/
ExclusiveRole,
/**
* Whether the effect is internal.
**/
InternalRole,
/**
* Whether the effect has a KCM.
**/
ConfigurableRole,
/**
* Whether this is a scripted effect.
**/
ScriptedRole,
/**
* Whether the effect is enabled by default.
**/
EnabledByDefaultRole
};
/**
* This enum type is used to specify the status of a given effect.
**/
enum class Status {
/**
* The effect is disabled.
**/
Disabled = Qt::Unchecked,
/**
* An enable function is used to determine whether the effect is enabled.
* For example, such function can be useful to disable the blur effect
* when running in a virtual machine.
**/
EnabledUndeterminded = Qt::PartiallyChecked,
/**
* The effect is enabled.
**/
Enabled = Qt::Checked
};
explicit EffectModel(QObject *parent = nullptr);
// Reimplemented from QAbstractItemModel.
QHash<int, QByteArray> roleNames() const override;
QModelIndex index(int row, int column, const QModelIndex &parent = {}) const override;
QModelIndex parent(const QModelIndex &child) const override;
int rowCount(const QModelIndex &parent = {}) const override;
int columnCount(const QModelIndex &parent = {}) const override;
QVariant data(const QModelIndex &index, int role = Qt::DisplayRole) const override;
bool setData(const QModelIndex &index, const QVariant &value, int role = Qt::EditRole) override;
/**
* Changes the status of a given effect.
*
* @param rowIndex An effect represented by the given index.
* @param effectState The new state.
* @note In order to actually apply the change, you have to call save().
**/
void updateEffectStatus(const QModelIndex &rowIndex, Status effectState);
/**
* Loads effects.
*
* You have to call this method in order to populate the model.
**/
void load();
/**
* Saves status of each modified effect.
**/
void save();
/**
* Resets the status of each effect to the default state.
*
* @note In order to actually apply the change, you have to call save().
**/
void defaults();
protected:
enum class Kind {
BuiltIn,
Binary,
Scripted
};
struct EffectData {
QString name;
QString description;
QString authorName;
QString authorEmail;
QString license;
QString version;
QString untranslatedCategory;
QString category;
QString serviceName;
QString iconName;
Status effectStatus;
bool enabledByDefault;
bool enabledByDefaultFunction;
QUrl video;
QUrl website;
bool supported;
QString exclusiveGroup;
bool internal;
bool configurable;
Kind kind;
bool changed = false;
};
/**
* Returns whether the given effect should be stored in the model.
*
* @param data The effect.
* @returns @c true if the effect should be stored, otherwise @c false.
**/
virtual bool shouldStore(const EffectData &data) const;
private:
void loadBuiltInEffects(const KConfigGroup &kwinConfig, const KPluginInfo::List &configs);
void loadJavascriptEffects(const KConfigGroup &kwinConfig);
void loadPluginEffects(const KConfigGroup &kwinConfig, const KPluginInfo::List &configs);
int findRowByServiceName(const QString &serviceName);
void syncEffectsToKWin();
QVector<EffectData> m_effectsList;
QVector<EffectData> m_effectsChanged;
Q_DISABLE_COPY(EffectModel)
};
}

6
kcmkwin/kwincompositing/CMakeLists.txt
View file

@ -38,10 +38,9 @@ target_link_libraries(kwincompositing
KF5::ConfigCore
KF5::Declarative
KF5::I18n
KF5::Package
KF5::KCMUtils
KF5::NewStuff
kwin4_effect_builtins
kcmkwincommon
)
if (BUILD_TESTING)
@ -72,11 +71,10 @@ if (BUILD_TESTING)
KF5::ConfigCore
KF5::Declarative
KF5::I18n
KF5::Package
KF5::KCMUtils
KF5::NewStuff
kwineffects
kwin4_effect_builtins
kcmkwincommon
)
endif()

458
kcmkwin/kwincompositing/model.cpp
View file

@ -20,29 +20,17 @@
#include "model.h"
#include "effectconfig.h"
#include "effectmodel.h"
#include "compositing.h"
#include <config-kwin.h>
#include <kwin_effects_interface.h>
#include <effect_builtins.h>
#include <KLocalizedString>
#include <KSharedConfig>
#include <KCModuleProxy>
#include <KPackage/PackageLoader>
#include <KPluginTrader>
#include <kdeclarative/kdeclarative.h>
#include <KPluginLoader>
#include <KPluginMetaData>
#include <KAboutData>
#include <QAbstractItemModel>
#include <QDBusConnection>
#include <QDBusInterface>
#include <QDBusPendingCall>
#include <QDBusMessage>
#include <QHash>
#include <QVariant>
#include <QList>
#include <QString>
#include <QQmlEngine>
#include <QtQml>
@ -52,444 +40,6 @@
namespace KWin {
namespace Compositing {
static QString translatedCategory(const QString &category)
{
static const QVector<QString> knownCategories = {
QStringLiteral("Accessibility"),
QStringLiteral("Appearance"),
QStringLiteral("Candy"),
QStringLiteral("Focus"),
QStringLiteral("Show Desktop Animation"),
QStringLiteral("Tools"),
QStringLiteral("Virtual Desktop Switching Animation"),
QStringLiteral("Window Management"),
QStringLiteral("Window Open/Close Animation")
};
static const QVector<QString> translatedCategories = {
i18nc("Category of Desktop Effects, used as section header", "Accessibility"),
i18nc("Category of Desktop Effects, used as section header", "Appearance"),
i18nc("Category of Desktop Effects, used as section header", "Candy"),
i18nc("Category of Desktop Effects, used as section header", "Focus"),
i18nc("Category of Desktop Effects, used as section header", "Show Desktop Animation"),
i18nc("Category of Desktop Effects, used as section header", "Tools"),
i18nc("Category of Desktop Effects, used as section header", "Virtual Desktop Switching Animation"),
i18nc("Category of Desktop Effects, used as section header", "Window Management"),
i18nc("Category of Desktop Effects, used as section header", "Window Open/Close Animation")
};
const int index = knownCategories.indexOf(category);
if (index == -1) {
qDebug() << "Unknown category '" << category << "' and thus not translated";
return category;
}
return translatedCategories[index];
}
static EffectStatus effectStatus(bool enabled)
{
return enabled ? EffectStatus::Enabled : EffectStatus::Disabled;
}
EffectModel::EffectModel(QObject *parent)
: QAbstractItemModel(parent) {
}
QHash< int, QByteArray > EffectModel::roleNames() const
{
QHash<int, QByteArray> roleNames;
roleNames[NameRole] = "NameRole";
roleNames[DescriptionRole] = "DescriptionRole";
roleNames[AuthorNameRole] = "AuthorNameRole";
roleNames[AuthorEmailRole] = "AuthorEmailRole";
roleNames[LicenseRole] = "LicenseRole";
roleNames[VersionRole] = "VersionRole";
roleNames[CategoryRole] = "CategoryRole";
roleNames[ServiceNameRole] = "ServiceNameRole";
roleNames[EffectStatusRole] = "EffectStatusRole";
roleNames[VideoRole] = "VideoRole";
roleNames[SupportedRole] = "SupportedRole";
roleNames[ExclusiveRole] = "ExclusiveRole";
roleNames[ConfigurableRole] = "ConfigurableRole";
roleNames[ScriptedRole] = QByteArrayLiteral("ScriptedRole");
return roleNames;
}
QModelIndex EffectModel::index(int row, int column, const QModelIndex &parent) const
{
if (parent.isValid() || column > 0 || column < 0 || row < 0 || row >= m_effectsList.count()) {
return QModelIndex();
}
return createIndex(row, column);
}
QModelIndex EffectModel::parent(const QModelIndex &child) const
{
Q_UNUSED(child)
return QModelIndex();
}
int EffectModel::columnCount(const QModelIndex &parent) const
{
Q_UNUSED(parent)
return 1;
}
int EffectModel::rowCount(const QModelIndex &parent) const
{
if (parent.isValid()) {
return 0;
}
return m_effectsList.count();
}
QVariant EffectModel::data(const QModelIndex &index, int role) const
{
if (!index.isValid()) {
return QVariant();
}
EffectData currentEffect = m_effectsList.at(index.row());
switch (role) {
case Qt::DisplayRole:
case NameRole:
return m_effectsList.at(index.row()).name;
case DescriptionRole:
return m_effectsList.at(index.row()).description;
case AuthorNameRole:
return m_effectsList.at(index.row()).authorName;
case AuthorEmailRole:
return m_effectsList.at(index.row()).authorEmail;
case LicenseRole:
return m_effectsList.at(index.row()).license;
case VersionRole:
return m_effectsList.at(index.row()).version;
case CategoryRole:
return m_effectsList.at(index.row()).category;
case ServiceNameRole:
return m_effectsList.at(index.row()).serviceName;
case EffectStatusRole:
return (int)m_effectsList.at(index.row()).effectStatus;
case VideoRole:
return m_effectsList.at(index.row()).video;
case SupportedRole:
return m_effectsList.at(index.row()).supported;
case ExclusiveRole:
return m_effectsList.at(index.row()).exclusiveGroup;
case InternalRole:
return m_effectsList.at(index.row()).internal;
case ConfigurableRole:
return m_effectsList.at(index.row()).configurable;
case ScriptedRole:
return m_effectsList.at(index.row()).scripted;
default:
return QVariant();
}
}
bool EffectModel::setData(const QModelIndex& index, const QVariant& value, int role)
{
if (!index.isValid())
return QAbstractItemModel::setData(index, value, role);
if (role == EffectModel::EffectStatusRole) {
// note: whenever the StatusRole is modified (even to the same value) the entry
// gets marked as changed and will get saved to the config file. This means the
// config file could get polluted
EffectData &data = m_effectsList[index.row()];
data.effectStatus = EffectStatus(value.toInt());
data.changed = true;
emit dataChanged(index, index);
if (data.effectStatus == EffectStatus::Enabled && !data.exclusiveGroup.isEmpty()) {
// need to disable all other exclusive effects in the same category
for (int i = 0; i < m_effectsList.size(); ++i) {
if (i == index.row()) {
continue;
}
EffectData &otherData = m_effectsList[i];
if (otherData.exclusiveGroup == data.exclusiveGroup) {
otherData.effectStatus = EffectStatus::Disabled;
otherData.changed = true;
emit dataChanged(this->index(i, 0), this->index(i, 0));
}
}
}
return true;
}
return QAbstractItemModel::setData(index, value, role);
}
void EffectModel::loadBuiltInEffects(const KConfigGroup &kwinConfig, const KPluginInfo::List &configs)
{
const auto builtins = BuiltInEffects::availableEffects();
for (auto builtin : builtins) {
const BuiltInEffects::EffectData &data = BuiltInEffects::effectData(builtin);
EffectData effect;
effect.name = data.displayName;
effect.description = data.comment;
effect.authorName = i18n("KWin development team");
effect.authorEmail = QString(); // not used at all
effect.license = QStringLiteral("GPL");
effect.version = QStringLiteral(KWIN_VERSION_STRING);
effect.category = translatedCategory(data.category);
effect.serviceName = data.name;
effect.enabledByDefault = data.enabled;
effect.enabledByDefaultFunction = (data.enabledFunction != nullptr);
const QString enabledKey = QStringLiteral("%1Enabled").arg(effect.serviceName);
if (kwinConfig.hasKey(enabledKey)) {
effect.effectStatus = effectStatus(kwinConfig.readEntry(effect.serviceName + "Enabled", effect.enabledByDefault));
} else if (data.enabledFunction != nullptr) {
effect.effectStatus = EffectStatus::EnabledUndeterminded;
} else {
effect.effectStatus = effectStatus(effect.enabledByDefault);
}
effect.video = data.video;
effect.supported = true;
effect.exclusiveGroup = data.exclusiveCategory;
effect.internal = data.internal;
effect.scripted = false;
auto it = std::find_if(configs.begin(), configs.end(), [data](const KPluginInfo &info) {
return info.property(QStringLiteral("X-KDE-ParentComponents")).toString() == data.name;
});
effect.configurable = it != configs.end();
m_effectsList << effect;
}
}
void EffectModel::loadJavascriptEffects(const KConfigGroup &kwinConfig)
{
const auto plugins = KPackage::PackageLoader::self()->listPackages(QStringLiteral("KWin/Effect"), QStringLiteral("kwin/effects"));
for (const KPluginMetaData &metaData : plugins) {
KPluginInfo plugin(metaData);
EffectData effect;
effect.name = plugin.name();
effect.description = plugin.comment();
effect.authorName = plugin.author();
effect.authorEmail = plugin.email();
effect.license = plugin.license();
effect.version = plugin.version();
effect.category = translatedCategory(plugin.category());
effect.serviceName = plugin.pluginName();
effect.effectStatus = effectStatus(kwinConfig.readEntry(effect.serviceName + "Enabled", plugin.isPluginEnabledByDefault()));
effect.enabledByDefault = plugin.isPluginEnabledByDefault();
effect.enabledByDefaultFunction = false;
effect.video = plugin.property(QStringLiteral("X-KWin-Video-Url")).toUrl();
effect.supported = true;
effect.exclusiveGroup = plugin.property(QStringLiteral("X-KWin-Exclusive-Category")).toString();
effect.internal = plugin.property(QStringLiteral("X-KWin-Internal")).toBool();
effect.scripted = true;
const QString pluginKeyword = plugin.property(QStringLiteral("X-KDE-PluginKeyword")).toString();
if (!pluginKeyword.isEmpty()) {
// scripted effects have their pluginName() as the keyword
effect.configurable = plugin.property(QStringLiteral("X-KDE-ParentComponents")).toString() == pluginKeyword;
} else {
effect.configurable = false;
}
m_effectsList << effect;
}
}
void EffectModel::loadPluginEffects(const KConfigGroup &kwinConfig, const KPluginInfo::List &configs)
{
static const QString subDir(QStringLiteral("kwin/effects/plugins/"));
static const QString serviceType(QStringLiteral("KWin/Effect"));
const QVector<KPluginMetaData> pluginEffects = KPluginLoader::findPlugins(subDir, [] (const KPluginMetaData &data) { return data.serviceTypes().contains(serviceType); });
for (KPluginMetaData pluginEffect : pluginEffects) {
if (!pluginEffect.isValid())
continue;
EffectData effect;
effect.name = pluginEffect.name();
effect.description = pluginEffect.description();
effect.license = pluginEffect.license();
effect.version = pluginEffect.version();
effect.category = pluginEffect.category();
effect.serviceName = pluginEffect.pluginId();
effect.enabledByDefault = pluginEffect.isEnabledByDefault();
effect.supported = true;
effect.enabledByDefaultFunction = false;
effect.internal = false;
effect.scripted = false;
for (int i = 0; i < pluginEffect.authors().count(); ++i) {
effect.authorName.append(pluginEffect.authors().at(i).name());
effect.authorEmail.append(pluginEffect.authors().at(i).emailAddress());
if (i+1 < pluginEffect.authors().count()) {
effect.authorName.append(", ");
effect.authorEmail.append(", ");
}
}
if (pluginEffect.rawData().contains("org.kde.kwin.effect")) {
const QJsonObject d(pluginEffect.rawData().value("org.kde.kwin.effect").toObject());
effect.exclusiveGroup = d.value("exclusiveGroup").toString();
effect.video = QUrl::fromUserInput(d.value("video").toString());
effect.enabledByDefaultFunction = d.value("enabledByDefaultMethod").toBool();
}
const QString enabledKey = QStringLiteral("%1Enabled").arg(effect.serviceName);
if (kwinConfig.hasKey(enabledKey)) {
effect.effectStatus = effectStatus(kwinConfig.readEntry(effect.serviceName + "Enabled", effect.enabledByDefault));
} else if (effect.enabledByDefaultFunction) {
effect.effectStatus = EffectStatus::EnabledUndeterminded;
} else {
effect.effectStatus = effectStatus(effect.enabledByDefault);
}
auto it = std::find_if(configs.begin(), configs.end(), [pluginEffect](const KPluginInfo &info) {
return info.property(QStringLiteral("X-KDE-ParentComponents")).toString() == pluginEffect.pluginId();
});
effect.configurable = it != configs.end();
m_effectsList << effect;
}
}
void EffectModel::loadEffects()
{
KConfigGroup kwinConfig(KSharedConfig::openConfig("kwinrc"), "Plugins");
beginResetModel();
m_effectsChanged.clear();
m_effectsList.clear();
const KPluginInfo::List configs = KPluginTrader::self()->query(QStringLiteral("kwin/effects/configs/"));
loadBuiltInEffects(kwinConfig, configs);
loadJavascriptEffects(kwinConfig);
loadPluginEffects(kwinConfig, configs);
qSort(m_effectsList.begin(), m_effectsList.end(), [](const EffectData &a, const EffectData &b) {
if (a.category == b.category) {
if (a.exclusiveGroup == b.exclusiveGroup) {
return a.name < b.name;
}
return a.exclusiveGroup < b.exclusiveGroup;
}
return a.category < b.category;
});
OrgKdeKwinEffectsInterface interface(QStringLiteral("org.kde.KWin"),
QStringLiteral("/Effects"),
QDBusConnection::sessionBus());
if (interface.isValid()) {
QStringList effectNames;
std::for_each(m_effectsList.constBegin(), m_effectsList.constEnd(), [&effectNames](const EffectData &data) {
effectNames << data.serviceName;
});
QDBusPendingCallWatcher *watcher = new QDBusPendingCallWatcher(interface.areEffectsSupported(effectNames), this);
watcher->setProperty("effectNames", effectNames);
connect(watcher, &QDBusPendingCallWatcher::finished, [this](QDBusPendingCallWatcher *self) {
const QStringList effectNames = self->property("effectNames").toStringList();
const QDBusPendingReply< QList< bool > > reply = *self;
QList< bool> supportValues;
if (reply.isValid()) {
supportValues.append(reply.value());
}
if (effectNames.size() == supportValues.size()) {
for (int i = 0; i < effectNames.size(); ++i) {
const bool supportedValue = supportValues.at(i);
const QString &effectName = effectNames.at(i);
auto it = std::find_if(m_effectsList.begin(), m_effectsList.end(), [effectName](const EffectData &data) {
return data.serviceName == effectName;
});
if (it != m_effectsList.end()) {
if ((*it).supported != supportedValue) {
(*it).supported = supportedValue;
QModelIndex i = index(findRowByServiceName(effectName), 0);
if (i.isValid()) {
emit dataChanged(i, i, QVector<int>() << SupportedRole);
}
}
}
}
}
self->deleteLater();
});
}
m_effectsChanged = m_effectsList;
endResetModel();
}
int EffectModel::findRowByServiceName(const QString &serviceName)
{
for (int it = 0; it < m_effectsList.size(); it++) {
if (m_effectsList.at(it).serviceName == serviceName) {
return it;
}
}
return -1;
}
void EffectModel::syncEffectsToKWin()
{
OrgKdeKwinEffectsInterface interface(QStringLiteral("org.kde.KWin"),
QStringLiteral("/Effects"),
QDBusConnection::sessionBus());
for (int it = 0; it < m_effectsList.size(); it++) {
if (m_effectsList.at(it).effectStatus != m_effectsChanged.at(it).effectStatus) {
if (m_effectsList.at(it).effectStatus != EffectStatus::Disabled) {
interface.loadEffect(m_effectsList.at(it).serviceName);
} else {
interface.unloadEffect(m_effectsList.at(it).serviceName);
}
}
}
m_effectsChanged = m_effectsList;
}
void EffectModel::updateEffectStatus(const QModelIndex &rowIndex, EffectStatus effectState)
{
setData(rowIndex, (int)effectState, EffectModel::EffectStatusRole);
}
void EffectModel::syncConfig()
{
KConfigGroup kwinConfig(KSharedConfig::openConfig("kwinrc"), "Plugins");
for (auto it = m_effectsList.begin(); it != m_effectsList.end(); it++) {
EffectData &effect = *(it);
if (!effect.changed) {
continue;
}
effect.changed = false;
const QString key = effect.serviceName + QStringLiteral("Enabled");
const bool shouldEnable = (effect.effectStatus != EffectStatus::Disabled);
const bool restoreToDefault = effect.enabledByDefaultFunction
? effect.effectStatus == EffectStatus::EnabledUndeterminded
: shouldEnable == effect.enabledByDefault;
if (restoreToDefault) {
kwinConfig.deleteEntry(key);
} else {
kwinConfig.writeEntry(key, shouldEnable);
}
}
kwinConfig.sync();
syncEffectsToKWin();
}
void EffectModel::defaults()
{
for (int i = 0; i < m_effectsList.count(); ++i) {
const auto &effect = m_effectsList.at(i);
if (effect.enabledByDefaultFunction && effect.effectStatus != EffectStatus::EnabledUndeterminded) {
updateEffectStatus(index(i, 0), EffectStatus::EnabledUndeterminded);
} else if ((bool)effect.effectStatus != effect.enabledByDefault) {
updateEffectStatus(index(i, 0), effect.enabledByDefault ? EffectStatus::Enabled : EffectStatus::Disabled);
}
}
}
EffectFilterModel::EffectFilterModel(QObject *parent)
: QSortFilterProxyModel(parent)
, m_effectModel(new EffectModel(this))
@ -566,17 +116,17 @@ void EffectFilterModel::updateEffectStatus(int rowIndex, int effectState)
{
const QModelIndex sourceIndex = mapToSource(index(rowIndex, 0));
m_effectModel->updateEffectStatus(sourceIndex, EffectStatus(effectState));
m_effectModel->updateEffectStatus(sourceIndex, EffectModel::Status(effectState));
}
void EffectFilterModel::syncConfig()
{
m_effectModel->syncConfig();
m_effectModel->save();
}
void EffectFilterModel::load()
{
m_effectModel->loadEffects();
m_effectModel->load();
}
void EffectFilterModel::defaults()

86
kcmkwin/kwincompositing/model.h
View file

@ -24,96 +24,16 @@
#include <KColorScheme>
#include <KSharedConfig>
#include <QAbstractItemModel>
#include <QHash>
#include <QList>
#include <QQuickWidget>
#include <QSortFilterProxyModel>
#include <QString>
#include <KPluginInfo>
namespace KWin {
class EffectModel;
namespace Compositing {
enum class EffectStatus {
Disabled = Qt::Unchecked,
EnabledUndeterminded = Qt::PartiallyChecked,
Enabled = Qt::Checked
};
struct EffectData {
QString name;
QString description;
QString authorName;
QString authorEmail;
QString license;
QString version;
QString category;
QString serviceName;
EffectStatus effectStatus;
bool enabledByDefault;
bool enabledByDefaultFunction;
QUrl video;
bool supported;
QString exclusiveGroup;
bool internal;
bool configurable;
bool scripted;
bool changed = false;
};
class EffectModel : public QAbstractItemModel
{
Q_OBJECT
public:
enum EffectRoles {
NameRole = Qt::UserRole + 1,
DescriptionRole,
AuthorNameRole,
AuthorEmailRole,
LicenseRole,
VersionRole,
CategoryRole,
ServiceNameRole,
EffectStatusRole,
VideoRole,
SupportedRole,
ExclusiveRole,
InternalRole,
ConfigurableRole,
ScriptedRole
};
explicit EffectModel(QObject *parent = 0);
QModelIndex index(int row, int column, const QModelIndex &parent = QModelIndex()) const override;
QModelIndex parent(const QModelIndex &child) const override;
int rowCount(const QModelIndex &parent = QModelIndex()) const override;
int columnCount(const QModelIndex &parent = QModelIndex()) const override;
QVariant data(const QModelIndex &index, int role = Qt::DisplayRole) const override;
bool setData(const QModelIndex& index, const QVariant& value, int role = Qt::EditRole) override;
QString serviceName(const QString &effectName);
virtual QHash< int, QByteArray > roleNames() const override;
void updateEffectStatus(const QModelIndex &rowIndex, EffectStatus effectState);
void syncEffectsToKWin();
void syncConfig();
void loadEffects();
void defaults();
private:
void loadBuiltInEffects(const KConfigGroup &kwinConfig, const KPluginInfo::List &configs);
void loadJavascriptEffects(const KConfigGroup &kwinConfig);
void loadPluginEffects(const KConfigGroup &kwinConfig, const KPluginInfo::List &configs);
int findRowByServiceName(const QString &serviceName);
QList<EffectData> m_effectsList;
QList<EffectData> m_effectsChanged;
};
class EffectView : public QQuickWidget
{

5
kcmkwin/kwincompositing/test/effectmodeltest.cpp
View file

@ -21,6 +21,9 @@
#include "modeltest.h"
#include "../model.h"
#include "effectmodeltest.h"
#include "effectmodel.h"
#include <QtTest>
EffectModelTest::EffectModelTest(QObject *parent)
@ -29,7 +32,7 @@ EffectModelTest::EffectModelTest(QObject *parent)
}
void EffectModelTest::testEffectModel() {
KWin::Compositing::EffectModel *effectModel = new KWin::Compositing::EffectModel();
auto effectModel = new KWin::EffectModel();
new ModelTest(effectModel, this);
}