mirror of
https://github.com/LMMS/lmms.git
synced 2026-01-22 21:38:12 -05:00
a1b355828e
* Move m_key member of Effect into Plugin * Pass key to Instrument ctors and instantiaters * Add pluginKeys to all plugin selector widgets, and let them pass the keys when instantiating the instruments; or, if the keys must be passed over threads, pass the keys to the Engine using `Engine::setDndPluginKey()` * As instrument plugin libraries now also need to get their key passed, their second argument, which was always the same as the first, is now used to pass the sub plugin keys. This affects *all* instrument plugins. * Plugin.h: Add more virtuals to `SubPluginFeatures` in order to draw logos and images into instrument selector widgets * LadspaSubPluginFeatures: Implement the `displayName` virtual because the new behaviour to resolve displayNames is to first look at the SubPluginFeatures, which, without override, returns the superior plugin's name (Plugin.cpp) Additional: * PluginFactory.h: Allow setting up search paths without discovering plugins yet * Plugin.h: Add full documentation (should be checked)
109 lines
3.1 KiB
C++
109 lines
3.1 KiB
C++
/*
|
|
* PluginFactory.h
|
|
*
|
|
* Copyright (c) 2015 Lukas W <lukaswhl/at/gmail.com>
|
|
*
|
|
* This file is part of LMMS - https://lmms.io
|
|
*
|
|
* 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 (see COPYING); if not, write to the
|
|
* Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
|
|
* Boston, MA 02110-1301 USA.
|
|
*
|
|
*/
|
|
|
|
#ifndef PLUGINFACTORY_H
|
|
#define PLUGINFACTORY_H
|
|
|
|
#include <memory>
|
|
#include <string>
|
|
|
|
#include <QtCore/QFileInfo>
|
|
#include <QtCore/QHash>
|
|
#include <QtCore/QList>
|
|
#include <QtCore/QString>
|
|
#include <QtCore/QVector>
|
|
|
|
#include "lmms_export.h"
|
|
#include "Plugin.h"
|
|
|
|
class QLibrary;
|
|
|
|
class LMMS_EXPORT PluginFactory
|
|
{
|
|
public:
|
|
struct PluginInfo
|
|
{
|
|
const QString name() const;
|
|
QFileInfo file;
|
|
std::shared_ptr<QLibrary> library = nullptr;
|
|
Plugin::Descriptor* descriptor = nullptr;
|
|
|
|
bool isNull() const {return ! library;}
|
|
};
|
|
typedef QList<PluginInfo> PluginInfoList;
|
|
typedef QMultiMap<Plugin::PluginTypes, Plugin::Descriptor*> DescriptorMap;
|
|
|
|
PluginFactory();
|
|
~PluginFactory();
|
|
|
|
static void setupSearchPaths();
|
|
|
|
/// Returns the singleton instance of PluginFactory. You won't need to call
|
|
/// this directly, use pluginFactory instead.
|
|
static PluginFactory* instance();
|
|
|
|
/// Returns a list of all found plugins' descriptors.
|
|
const Plugin::DescriptorList descriptors() const;
|
|
const Plugin::DescriptorList descriptors(Plugin::PluginTypes type) const;
|
|
|
|
struct PluginInfoAndKey
|
|
{
|
|
PluginInfo info;
|
|
Plugin::Descriptor::SubPluginFeatures::Key key;
|
|
bool isNull() const { return info.isNull(); }
|
|
};
|
|
|
|
/// Returns a list of all found plugins' PluginFactory::PluginInfo objects.
|
|
const PluginInfoList& pluginInfos() const;
|
|
/// Returns a plugin that support the given file extension
|
|
const PluginInfoAndKey pluginSupportingExtension(const QString& ext);
|
|
|
|
/// Returns the PluginInfo object of the plugin with the given name.
|
|
/// If the plugin is not found, an empty PluginInfo is returned (use
|
|
/// PluginInfo::isNull() to check this).
|
|
const PluginInfo pluginInfo(const char* name) const;
|
|
|
|
/// When loading a library fails during discovery, the error string is saved.
|
|
/// It can be retrieved by calling this function.
|
|
QString errorString(QString pluginName) const;
|
|
|
|
public slots:
|
|
void discoverPlugins();
|
|
|
|
private:
|
|
DescriptorMap m_descriptors;
|
|
PluginInfoList m_pluginInfos;
|
|
|
|
QMap<QString, PluginInfoAndKey> m_pluginByExt;
|
|
QVector<std::string> m_garbage; //!< cleaned up at destruction
|
|
|
|
QHash<QString, QString> m_errors;
|
|
|
|
static std::unique_ptr<PluginFactory> s_instance;
|
|
};
|
|
|
|
#define pluginFactory PluginFactory::instance()
|
|
|
|
#endif // PLUGINFACTORY_H
|