#include <PluginScan.h>

Collaboration diagram for PluginScan:

Classes
struct	Candidate

class	Logger

Public Types
enum	PluginType { VampPlugin, LADSPAPlugin, DSSIPlugin }

Public Member Functions
void	scan ()
	Carry out startup scan of available plugins. More...

bool	scanSucceeded () const
	Return true if scan() completed successfully. More...

QList< Candidate >	getCandidateLibrariesFor (PluginType) const
	Return the candidate plugin libraries of the given type that were found by helpers during the startup scan. More...

QString	getStartupFailureReport () const

Static Public Member Functions
static PluginScan *	getInstance ()

Private Member Functions
	PluginScan ()

	~PluginScan ()

void	clear ()

Private Attributes
QMutex	m_mutex

std::map< QString, KnownPluginCandidates * >	m_kp

bool	m_succeeded

Logger *	m_logger

Detailed Description

Definition at line 29 of file PluginScan.h.

Member Enumeration Documentation

enum PluginScan::PluginType

Enumerator
VampPlugin
LADSPAPlugin
DSSIPlugin

Definition at line 51 of file PluginScan.h.

Constructor & Destructor Documentation

PluginScan::PluginScan ( )

private

Definition at line 53 of file PluginScan.cpp.

Referenced by getInstance().

PluginScan::~PluginScan ( )

private

Definition at line 56 of file PluginScan.cpp.

References clear(), m_logger, m_mutex, and SVDEBUG.

Member Function Documentation

PluginScan * PluginScan::getInstance ( )

static

Definition at line 43 of file PluginScan.cpp.

References mutex, and PluginScan().

Referenced by LADSPAPluginFactory::discoverPlugins(), and getCandidateLibraries().

void PluginScan::scan ( )

Carry out startup scan of available plugins.

Do not call getCandidateLibrariesFor() unless this has been called and scanSucceeded() is returning true.

Definition at line 64 of file PluginScan.cpp.

References HelperExecPath::AllInstalled, clear(), HelperExecPath::getHelperCandidatePaths(), HelperExecPath::getHelperExecutables(), Preferences::getInstance(), Preferences::getRunPluginsInProcess(), m_kp, m_logger, m_mutex, m_succeeded, HelperExecPath::NativeArchitectureOnly, and SVDEBUG.

bool PluginScan::scanSucceeded ( ) const

Return true if scan() completed successfully.

If the scan failed, consider using the normal plugin path to load any available plugins (as if they had all been found to be loadable) rather than rejecting all of them – i.e. consider falling back on the behaviour of code from before the scan logic was added.

Definition at line 115 of file PluginScan.cpp.

References m_mutex, and m_succeeded.

QList< PluginScan::Candidate > PluginScan::getCandidateLibrariesFor ( PluginType ) const

Return the candidate plugin libraries of the given type that were found by helpers during the startup scan.

This could return an empty list for two reasons: the scan succeeded but no libraries were found; or the scan failed. Call scanSucceeded() to distinguish between them.

Definition at line 132 of file PluginScan.cpp.

References DSSIPlugin, LADSPAPlugin, m_kp, m_mutex, SVDEBUG, and VampPlugin.

Referenced by LADSPAPluginFactory::discoverPlugins(), and getCandidateLibraries().

QString PluginScan::getStartupFailureReport ( ) const

Definition at line 280 of file PluginScan.cpp.

References m_kp, m_mutex, and m_succeeded.

void PluginScan::clear ( )

private

Definition at line 122 of file PluginScan.cpp.

References m_kp, and m_succeeded.

Referenced by scan(), and ~PluginScan().