kwin/src/pluginmanager.cpp
Laurent Montel b823747c3b Add explicit moc includes to sources for moc-covered headers
* speeds up incremental builds as changes to a header will not always
  need the full mocs_compilation.cpp for all the target's headers rebuild,
  while having a moc file sourced into a source file only adds minor
  extra costs, due to small own code and the used headers usually
  already covered by the source file, being for the same class/struct
* seems to not slow down clean builds, due to empty mocs_compilation.cpp
  resulting in those quickly processed, while the minor extra cost of the
  sourced moc files does not outweigh that in summary.
  Measured times actually improved by some percent points.
  (ideally CMake would just skip empty mocs_compilation.cpp & its object
  file one day)
* enables compiler to see all methods of a class in same compilation unit
  to do some sanity checks
* potentially more inlining in general, due to more in the compilation unit
* allows to keep using more forward declarations in the header, as with the
  moc code being sourced into the cpp file there definitions can be ensured
  and often are already for the needs of the normal class methods
2023-07-15 08:40:49 +00:00

134 lines
3.7 KiB
C++

/*
SPDX-FileCopyrightText: 2020 Vlad Zahorodnii <vlad.zahorodnii@kde.org>
SPDX-License-Identifier: GPL-2.0-or-later
*/
#include "pluginmanager.h"
#include "dbusinterface.h"
#include "main.h"
#include "plugin.h"
#include "utils/common.h"
#include <KConfigGroup>
#include <KPluginFactory>
#include <KPluginMetaData>
namespace KWin
{
static const QString s_pluginDirectory = QStringLiteral("kwin/plugins");
static QJsonValue readPluginInfo(const QJsonObject &metadata, const QString &key)
{
return metadata.value(QLatin1String("KPlugin")).toObject().value(key);
}
PluginManager::PluginManager()
{
const KConfigGroup config(kwinApp()->config(), QStringLiteral("Plugins"));
auto checkEnabled = [&config](const QString &pluginId, const QJsonObject &metadata) {
const QString configKey = pluginId + QLatin1String("Enabled");
if (config.hasKey(configKey)) {
return config.readEntry(configKey, false);
}
return readPluginInfo(metadata, QStringLiteral("EnabledByDefault")).toBool(false);
};
const QVector<KPluginMetaData> plugins = KPluginMetaData::findPlugins(s_pluginDirectory);
for (const KPluginMetaData &metadata : plugins) {
if (m_plugins.find(metadata.pluginId()) != m_plugins.end()) {
qCWarning(KWIN_CORE) << "Conflicting plugin id" << metadata.pluginId();
continue;
}
if (checkEnabled(metadata.pluginId(), metadata.rawData())) {
loadPlugin(metadata);
}
}
new PluginManagerDBusInterface(this);
}
PluginManager::~PluginManager() = default;
QStringList PluginManager::loadedPlugins() const
{
QStringList ret;
ret.reserve(m_plugins.size());
for (const auto &[key, _] : m_plugins) {
ret.push_back(key);
}
return ret;
}
QStringList PluginManager::availablePlugins() const
{
const QVector<KPluginMetaData> plugins = KPluginMetaData::findPlugins(s_pluginDirectory);
QStringList ret;
ret.reserve(plugins.size());
for (const KPluginMetaData &metadata : plugins) {
ret.append(metadata.pluginId());
}
return ret;
}
bool PluginManager::loadPlugin(const QString &pluginId)
{
if (m_plugins.find(pluginId) != m_plugins.end()) {
qCDebug(KWIN_CORE) << "Plugin with id" << pluginId << "is already loaded";
return false;
}
const KPluginMetaData metadata = KPluginMetaData::findPluginById(s_pluginDirectory, pluginId);
if (metadata.isValid()) {
if (loadPlugin(metadata)) {
return true;
}
}
return false;
}
bool PluginManager::loadPlugin(const KPluginMetaData &metadata)
{
if (!metadata.isValid()) {
qCDebug(KWIN_CORE) << "PluginManager::loadPlugin needs a valid plugin metadata";
return false;
}
const QString pluginId = metadata.pluginId();
QPluginLoader pluginLoader(metadata.fileName());
if (pluginLoader.metaData().value("IID").toString() != PluginFactory_iid) {
qCWarning(KWIN_CORE) << pluginId << "has mismatching plugin version";
return false;
}
std::unique_ptr<PluginFactory> factory(qobject_cast<PluginFactory *>(pluginLoader.instance()));
if (!factory) {
qCWarning(KWIN_CORE) << "Failed to get plugin factory for" << pluginId;
return false;
}
if (std::unique_ptr<Plugin> plugin = factory->create()) {
m_plugins[pluginId] = std::move(plugin);
return true;
} else {
return false;
}
}
void PluginManager::unloadPlugin(const QString &pluginId)
{
auto it = m_plugins.find(pluginId);
if (it != m_plugins.end()) {
m_plugins.erase(it);
} else {
qCWarning(KWIN_CORE) << "No plugin with the specified id:" << pluginId;
}
}
} // namespace KWin
#include "moc_pluginmanager.cpp"