lmms::PluginFactory Class Reference

#include <PluginFactory.h>

Classes
struct	PluginInfo
struct	PluginInfoAndKey

Public Types
using	PluginInfoList = QList<PluginInfo>
using	DescriptorMap = QMultiMap<Plugin::Type, Plugin::Descriptor*>

Public Slots
void	discoverPlugins ()

Public Member Functions
	PluginFactory ()
	~PluginFactory ()=default
Plugin::DescriptorList	descriptors () const
	Returns a list of all found plugins' descriptors.
Plugin::DescriptorList	descriptors (Plugin::Type type) const
const PluginInfoList &	pluginInfos () const
	Returns a list of all found plugins' PluginFactory::PluginInfo objects.
PluginInfoAndKey	pluginSupportingExtension (const QString &ext)
	Returns a plugin that support the given file extension.
PluginInfo	pluginInfo (const char *name) const
QString	errorString (QString pluginName) const

Static Public Member Functions
static void	setupSearchPaths ()
static QList< QRegularExpression >	getExcludePatterns (const char *envVar)
static PluginFactory *	instance ()

Static Private Member Functions
static void	filterPlugins (QSet< QFileInfo > &files)

Private Attributes
DescriptorMap	m_descriptors
PluginInfoList	m_pluginInfos
QMap< QString, PluginInfoAndKey >	m_pluginByExt
std::vector< std::string >	m_garbage
	cleaned up at destruction
QHash< QString, QString >	m_errors

Static Private Attributes
static std::unique_ptr< PluginFactory >	s_instance

Member Typedef Documentation

DescriptorMap

using lmms::PluginFactory::DescriptorMap = QMultiMap<Plugin::Type, Plugin::Descriptor*>

PluginInfoList

using lmms::PluginFactory::PluginInfoList = QList<PluginInfo>

Constructor & Destructor Documentation

PluginFactory()

lmms::PluginFactory::PluginFactory

(

)

~PluginFactory()

lmms::PluginFactory::~PluginFactory ( )

default

Member Function Documentation

descriptors() [1/2]

Plugin::DescriptorList lmms::PluginFactory::descriptors

(

)

const

Returns a list of all found plugins' descriptors.

descriptors() [2/2]

Plugin::DescriptorList lmms::PluginFactory::descriptors

(

Plugin::Type

type

)

const

discoverPlugins

void lmms::PluginFactory::discoverPlugins ( )

slot

errorString()

QString lmms::PluginFactory::errorString

(

QString

pluginName

)

const

When loading a library fails during discovery, the error string is saved. It can be retrieved by calling this function.

filterPlugins()

void lmms::PluginFactory::filterPlugins ( QSet< QFileInfo > & files )

staticprivate

getExcludePatterns()

QList< QRegularExpression > lmms::PluginFactory::getExcludePatterns ( const char * envVar )

static

instance()

PluginFactory * lmms::PluginFactory::instance ( )

static

Returns the singleton instance of PluginFactory. You won't need to call this directly, use pluginFactory instead.

pluginInfo()

PluginFactory::PluginInfo lmms::PluginFactory::pluginInfo

(

const char *

name

)

const

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).

pluginInfos()

const PluginFactory::PluginInfoList & lmms::PluginFactory::pluginInfos

(

)

const

Returns a list of all found plugins' PluginFactory::PluginInfo objects.

pluginSupportingExtension()

PluginFactory::PluginInfoAndKey lmms::PluginFactory::pluginSupportingExtension

(

const QString &

ext

)

Returns a plugin that support the given file extension.

setupSearchPaths()

void lmms::PluginFactory::setupSearchPaths ( )

static

Member Data Documentation

m_descriptors

DescriptorMap lmms::PluginFactory::m_descriptors

private

m_errors

QHash<QString, QString> lmms::PluginFactory::m_errors

private

m_garbage

std::vector<std::string> lmms::PluginFactory::m_garbage

private

cleaned up at destruction

m_pluginByExt

QMap<QString, PluginInfoAndKey> lmms::PluginFactory::m_pluginByExt

private

m_pluginInfos

PluginInfoList lmms::PluginFactory::m_pluginInfos

private

s_instance

std::unique_ptr< PluginFactory > lmms::PluginFactory::s_instance

staticprivate

---

The documentation for this class was generated from the following files:

• /home/runner/work/lmms-fork/lmms-fork/include/PluginFactory.h
• /home/runner/work/lmms-fork/lmms-fork/src/core/PluginFactory.cpp