GIT_REPOSITORIES/LPP/Users/mperrinel/SciQLop-fork Commit - r72:538f97c38e97

core/include/Plugin/PluginManager.h created 644 +34 0

			@@ -0,0 +1,34
		1	#ifndef SCIQLOP_PLUGINMANAGER_H
		2	#define SCIQLOP_PLUGINMANAGER_H
		3
		4	#include <Common/spimpl.h>
		5
		6	#include <QLoggingCategory>
		7
		8	class QDir;
		9
		10	Q_DECLARE_LOGGING_CATEGORY(LOG_PluginManager)
		11
		12	/**
		13	* @brief The PluginManager class aims to handle the plugins loaded dynamically into SciQLop.
		14	*/
		15	class PluginManager {
		16	public:
		17	explicit PluginManager();
		18
		19	/**
		20	* Loads plugins into SciQlop. The loaded plugins are those located in the directory passed in
		21	* parameter
		22	* @param pluginDir the directory containing the plugins
		23	*/
		24	void loadPlugins(const QDir &pluginDir);
		25
		26	/// @returns the number of plugins loaded
		27	int nbPluginsLoaded() const noexcept;
		28
		29	private:
		30	class PluginManagerPrivate;
		31	spimpl::unique_impl_ptr<PluginManagerPrivate> impl;
		32	};
		33
		34	#endif // SCIQLOP_PLUGINMANAGER_H

core/src/Plugin/PluginManager.cpp created 644 +118 0

			@@ -0,0 +1,118
		1	#include <Plugin/PluginManager.h>
		2
		3	#include <Plugin/IPlugin.h>
		4
		5	#include <QDir>
		6	#include <QLibrary>
		7	#include <QPluginLoader>
		8
		9	Q_LOGGING_CATEGORY(LOG_PluginManager, "PluginManager")
		10
		11	namespace {
		12
		13	/// Key for retrieving metadata of the plugin
		14	const auto PLUGIN_METADATA_KEY = QStringLiteral("MetaData");
		15
		16	/// Key for retrieving the name of the plugin in its metadata
		17	const auto PLUGIN_NAME_KEY = QStringLiteral("name");
		18
		19	/// Helper to state the plugin loading operation
		20	struct LoadPluginState {
		21	explicit LoadPluginState(const QString &pluginPath)
		22	: m_PluginPath{pluginPath}, m_Valid{true}, m_ErrorMessage{}
		23	{
		24	}
		25
		26	void log() const
		27	{
		28	if (m_Valid) {
		29	qCDebug(LOG_PluginManager())
		30	<< QObject::tr("File '%1' has been loaded as a plugin").arg(m_PluginPath);
		31	}
		32	else {
		33	qCWarning(LOG_PluginManager())
		34	<< QObject::tr("File '%1' can't be loaded as a plugin: %2")
		35	.arg(m_PluginPath)
		36	.arg(m_ErrorMessage);
		37	}
		38	}
		39
		40	void setError(const QString &errorMessage)
		41	{
		42	m_Valid = false;
		43	m_ErrorMessage = errorMessage;
		44	}
		45
		46	QString m_PluginPath;
		47	bool m_Valid;
		48	QString m_ErrorMessage;
		49	};
		50
		51	} // namespace
		52
		53	struct PluginManager::PluginManagerPrivate {
		54	/**
		55	* Loads a single plugin into SciQlop. The method has no effect if the plugin is malformed (e.g.
		56	* wrong library type, missing metadata, etc.)
		57	* @param pluginPath the path to the plugin library.
		58	*/
		59	void loadPlugin(const QString &pluginPath)
		60	{
		61	qCDebug(LOG_PluginManager())
		62	<< QObject::tr("Attempting to load file '%1' as a plugin").arg(pluginPath);
		63
		64	LoadPluginState loadState{pluginPath};
		65
		66	if (QLibrary::isLibrary(pluginPath)) {
		67	QPluginLoader pluginLoader{pluginPath};
		68
		69	// Retrieving the plugin name to check if it can be loaded (i.e. no plugin with the same
		70	// name has been registered yet)
		71	auto metadata = pluginLoader.metaData().value(PLUGIN_METADATA_KEY).toObject();
		72	auto pluginName = metadata.value(PLUGIN_NAME_KEY).toString();
		73
		74	if (pluginName.isEmpty()) {
		75	loadState.setError(QObject::tr("empty file name"));
		76	}
		77	else if (m_RegisteredPlugins.contains(pluginName)) {
		78	loadState.setError(QObject::tr("name '%1' already registered").arg(pluginName));
		79	}
		80	else {
		81	if (auto pluginInstance = qobject_cast<IPlugin *>(pluginLoader.instance())) {
		82	pluginInstance->initialize();
		83	m_RegisteredPlugins.insert(pluginName, pluginPath);
		84	}
		85	else {
		86	loadState.setError(QObject::tr("the file is not a Sciqlop plugin"));
		87	}
		88	}
		89	}
		90	else {
		91	loadState.setError(QObject::tr("the file is not a library"));
		92	}
		93
		94	// Log loading result
		95	loadState.log();
		96	}
		97
		98	/// Registered plugins (key: plugin name, value: plugin path)
		99	QHash<QString, QString> m_RegisteredPlugins;
		100	};
		101
		102	PluginManager::PluginManager() : impl{spimpl::make_unique_impl<PluginManagerPrivate>()}
		103	{
		104	}
		105
		106	void PluginManager::loadPlugins(const QDir &pluginDir)
		107	{
		108	// Load plugins
		109	auto pluginInfoList = pluginDir.entryInfoList(QDir::Files, QDir::Name);
		110	for (auto pluginInfo : qAsConst(pluginInfoList)) {
		111	impl->loadPlugin(pluginInfo.absoluteFilePath());
		112	}
		113	}
		114
		115	int PluginManager::nbPluginsLoaded() const noexcept
		116	{
		117	return impl->m_RegisteredPlugins.size();
		118	}

core/tests-resources/Plugin/TestPluginManager/Test_DuplicatedPlugins/DuplicatedPlugin.dll created 644 binary 0 0