Audacity  3.0.3
Public Member Functions | Static Public Member Functions | List of all members
PluginManagerInterface Class Referenceabstract

#include <PluginInterface.h>

Inheritance diagram for PluginManagerInterface:
[legend]

Public Member Functions

virtual ~PluginManagerInterface ()
 
virtual bool IsPluginRegistered (const PluginPath &path, const TranslatableString *pName=nullptr)=0
 Was the plugin registry already populated for a path (maybe from loading the config file)? More...
 
virtual const PluginIDRegisterPlugin (ModuleInterface *module)=0
 
virtual const PluginIDRegisterPlugin (ModuleInterface *provider, EffectDefinitionInterface *effect, int type)=0
 
virtual void FindFilesInPathList (const wxString &pattern, const FilePaths &pathList, FilePaths &files, bool directories=false)=0
 
virtual bool GetSharedConfigSubgroups (const PluginID &ID, const RegistryPath &group, RegistryPaths &subgroups)=0
 
virtual bool GetSharedConfig (const PluginID &ID, const RegistryPath &group, const RegistryPath &key, wxString &value, const wxString &defval=wxString())=0
 
virtual bool GetSharedConfig (const PluginID &ID, const RegistryPath &group, const RegistryPath &key, int &value, int defval=0)=0
 
virtual bool GetSharedConfig (const PluginID &ID, const RegistryPath &group, const RegistryPath &key, bool &value, bool defval=false)=0
 
virtual bool GetSharedConfig (const PluginID &ID, const RegistryPath &group, const RegistryPath &key, float &value, float defval=0.0)=0
 
virtual bool GetSharedConfig (const PluginID &ID, const RegistryPath &group, const RegistryPath &key, double &value, double defval=0.0)=0
 
virtual bool SetSharedConfig (const PluginID &ID, const RegistryPath &group, const RegistryPath &key, const wxString &value)=0
 
virtual bool SetSharedConfig (const PluginID &ID, const RegistryPath &group, const RegistryPath &key, const int &value)=0
 
virtual bool SetSharedConfig (const PluginID &ID, const RegistryPath &group, const RegistryPath &key, const bool &value)=0
 
virtual bool SetSharedConfig (const PluginID &ID, const RegistryPath &group, const RegistryPath &key, const float &value)=0
 
virtual bool SetSharedConfig (const PluginID &ID, const RegistryPath &group, const RegistryPath &key, const double &value)=0
 
virtual bool RemoveSharedConfigSubgroup (const PluginID &ID, const RegistryPath &group)=0
 
virtual bool RemoveSharedConfig (const PluginID &ID, const RegistryPath &group, const RegistryPath &key)=0
 
virtual bool GetPrivateConfigSubgroups (const PluginID &ID, const RegistryPath &group, RegistryPaths &subgroups)=0
 
virtual bool GetPrivateConfig (const PluginID &ID, const RegistryPath &group, const RegistryPath &key, wxString &value, const wxString &defval=wxString())=0
 
virtual bool GetPrivateConfig (const PluginID &ID, const RegistryPath &group, const RegistryPath &key, int &value, int defval=0)=0
 
virtual bool GetPrivateConfig (const PluginID &ID, const RegistryPath &group, const RegistryPath &key, bool &value, bool defval=false)=0
 
virtual bool GetPrivateConfig (const PluginID &ID, const RegistryPath &group, const RegistryPath &key, float &value, float defval=0.0)=0
 
virtual bool GetPrivateConfig (const PluginID &ID, const RegistryPath &group, const RegistryPath &key, double &value, double defval=0.0)=0
 
virtual bool SetPrivateConfig (const PluginID &ID, const RegistryPath &group, const RegistryPath &key, const wxString &value)=0
 
virtual bool SetPrivateConfig (const PluginID &ID, const RegistryPath &group, const RegistryPath &key, const int &value)=0
 
virtual bool SetPrivateConfig (const PluginID &ID, const RegistryPath &group, const RegistryPath &key, const bool &value)=0
 
virtual bool SetPrivateConfig (const PluginID &ID, const RegistryPath &group, const RegistryPath &key, const float &value)=0
 
virtual bool SetPrivateConfig (const PluginID &ID, const RegistryPath &group, const RegistryPath &key, const double &value)=0
 
virtual bool RemovePrivateConfigSubgroup (const PluginID &ID, const RegistryPath &group)=0
 
virtual bool RemovePrivateConfig (const PluginID &ID, const RegistryPath &group, const RegistryPath &key)=0
 

Static Public Member Functions

static const PluginIDDefaultRegistrationCallback (ModuleInterface *provider, ComponentInterface *ident)
 
static const PluginIDAudacityCommandRegistrationCallback (ModuleInterface *provider, ComponentInterface *ident)
 

Detailed Description

Definition at line 54 of file PluginInterface.h.

Constructor & Destructor Documentation

◆ ~PluginManagerInterface()

PluginManagerInterface::~PluginManagerInterface ( )
virtualdefault

Member Function Documentation

◆ AudacityCommandRegistrationCallback()

const PluginID & PluginManagerInterface::AudacityCommandRegistrationCallback ( ModuleInterface provider,
ComponentInterface ident 
)
static

Definition at line 342 of file PluginManager.cpp.

344 {
345  ComponentInterface * pCInterface = dynamic_cast<ComponentInterface*>(pInterface);
346  if( pCInterface )
347  return PluginManager::Get().RegisterPlugin(provider, pCInterface);
348  static wxString empty;
349  return empty;
350 }

References PluginManager::Get(), and PluginManager::RegisterPlugin().

Referenced by BuiltinCommandsModule::AutoRegisterPlugins().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ DefaultRegistrationCallback()

const PluginID & PluginManagerInterface::DefaultRegistrationCallback ( ModuleInterface provider,
ComponentInterface ident 
)
static

Definition at line 329 of file PluginManager.cpp.

331 {
332  EffectDefinitionInterface * pEInterface = dynamic_cast<EffectDefinitionInterface*>(pInterface);
333  if( pEInterface )
334  return PluginManager::Get().RegisterPlugin(provider, pEInterface, PluginTypeEffect);
335  ComponentInterface * pCInterface = dynamic_cast<ComponentInterface*>(pInterface);
336  if( pCInterface )
337  return PluginManager::Get().RegisterPlugin(provider, pCInterface);
338  static wxString empty;
339  return empty;
340 }

References PluginManager::Get(), PluginTypeEffect, and PluginManager::RegisterPlugin().

Referenced by LadspaEffectsModule::AutoRegisterPlugins(), BuiltinEffectsModule::AutoRegisterPlugins(), NyquistEffectsModule::AutoRegisterPlugins(), PluginManager::DropFile(), and ModuleManager::RegisterEffectPlugin().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ FindFilesInPathList()

virtual void PluginManagerInterface::FindFilesInPathList ( const wxString &  pattern,
const FilePaths pathList,
FilePaths files,
bool  directories = false 
)
pure virtual

Implemented in PluginManager.

Referenced by LadspaEffectsModule::AutoRegisterPlugins(), NyquistEffectsModule::AutoRegisterPlugins(), LadspaEffectsModule::FindPluginPaths(), NyquistEffectsModule::FindPluginPaths(), and VSTEffectsModule::FindPluginPaths().

Here is the caller graph for this function:

◆ GetPrivateConfig() [1/5]

virtual bool PluginManagerInterface::GetPrivateConfig ( const PluginID ID,
const RegistryPath group,
const RegistryPath key,
bool &  value,
bool  defval = false 
)
pure virtual

Implemented in PluginManager.

◆ GetPrivateConfig() [2/5]

virtual bool PluginManagerInterface::GetPrivateConfig ( const PluginID ID,
const RegistryPath group,
const RegistryPath key,
double &  value,
double  defval = 0.0 
)
pure virtual

Implemented in PluginManager.

◆ GetPrivateConfig() [3/5]

virtual bool PluginManagerInterface::GetPrivateConfig ( const PluginID ID,
const RegistryPath group,
const RegistryPath key,
float &  value,
float  defval = 0.0 
)
pure virtual

Implemented in PluginManager.

◆ GetPrivateConfig() [4/5]

virtual bool PluginManagerInterface::GetPrivateConfig ( const PluginID ID,
const RegistryPath group,
const RegistryPath key,
int &  value,
int  defval = 0 
)
pure virtual

Implemented in PluginManager.

◆ GetPrivateConfig() [5/5]

virtual bool PluginManagerInterface::GetPrivateConfig ( const PluginID ID,
const RegistryPath group,
const RegistryPath key,
wxString &  value,
const wxString &  defval = wxString() 
)
pure virtual

Implemented in PluginManager.

◆ GetPrivateConfigSubgroups()

virtual bool PluginManagerInterface::GetPrivateConfigSubgroups ( const PluginID ID,
const RegistryPath group,
RegistryPaths subgroups 
)
pure virtual

Implemented in PluginManager.

◆ GetSharedConfig() [1/5]

virtual bool PluginManagerInterface::GetSharedConfig ( const PluginID ID,
const RegistryPath group,
const RegistryPath key,
bool &  value,
bool  defval = false 
)
pure virtual

Implemented in PluginManager.

◆ GetSharedConfig() [2/5]

virtual bool PluginManagerInterface::GetSharedConfig ( const PluginID ID,
const RegistryPath group,
const RegistryPath key,
double &  value,
double  defval = 0.0 
)
pure virtual

Implemented in PluginManager.

◆ GetSharedConfig() [3/5]

virtual bool PluginManagerInterface::GetSharedConfig ( const PluginID ID,
const RegistryPath group,
const RegistryPath key,
float &  value,
float  defval = 0.0 
)
pure virtual

Implemented in PluginManager.

◆ GetSharedConfig() [4/5]

virtual bool PluginManagerInterface::GetSharedConfig ( const PluginID ID,
const RegistryPath group,
const RegistryPath key,
int &  value,
int  defval = 0 
)
pure virtual

Implemented in PluginManager.

◆ GetSharedConfig() [5/5]

virtual bool PluginManagerInterface::GetSharedConfig ( const PluginID ID,
const RegistryPath group,
const RegistryPath key,
wxString &  value,
const wxString &  defval = wxString() 
)
pure virtual

Implemented in PluginManager.

◆ GetSharedConfigSubgroups()

virtual bool PluginManagerInterface::GetSharedConfigSubgroups ( const PluginID ID,
const RegistryPath group,
RegistryPaths subgroups 
)
pure virtual

Implemented in PluginManager.

◆ IsPluginRegistered()

virtual bool PluginManagerInterface::IsPluginRegistered ( const PluginPath path,
const TranslatableString pName = nullptr 
)
pure virtual

Was the plugin registry already populated for a path (maybe from loading the config file)?

Parameters
pathan identifier for the plug-in with meaning defined by provider; not always a file path
pNameif supplied, a correction for the user visible name associated with the plug-in, if it is registered already. (Needed because the configuration file only stores an internal name.)

Implemented in PluginManager.

Referenced by BuiltinCommandsModule::AutoRegisterPlugins(), LadspaEffectsModule::AutoRegisterPlugins(), BuiltinEffectsModule::AutoRegisterPlugins(), and NyquistEffectsModule::AutoRegisterPlugins().

Here is the caller graph for this function:

◆ RegisterPlugin() [1/2]

virtual const PluginID& PluginManagerInterface::RegisterPlugin ( ModuleInterface module)
pure virtual

Implemented in PluginManager.

◆ RegisterPlugin() [2/2]

virtual const PluginID& PluginManagerInterface::RegisterPlugin ( ModuleInterface provider,
EffectDefinitionInterface effect,
int  type 
)
pure virtual

Implemented in PluginManager.

◆ RemovePrivateConfig()

virtual bool PluginManagerInterface::RemovePrivateConfig ( const PluginID ID,
const RegistryPath group,
const RegistryPath key 
)
pure virtual

Implemented in PluginManager.

◆ RemovePrivateConfigSubgroup()

virtual bool PluginManagerInterface::RemovePrivateConfigSubgroup ( const PluginID ID,
const RegistryPath group 
)
pure virtual

Implemented in PluginManager.

◆ RemoveSharedConfig()

virtual bool PluginManagerInterface::RemoveSharedConfig ( const PluginID ID,
const RegistryPath group,
const RegistryPath key 
)
pure virtual

Implemented in PluginManager.

◆ RemoveSharedConfigSubgroup()

virtual bool PluginManagerInterface::RemoveSharedConfigSubgroup ( const PluginID ID,
const RegistryPath group 
)
pure virtual

Implemented in PluginManager.

◆ SetPrivateConfig() [1/5]

virtual bool PluginManagerInterface::SetPrivateConfig ( const PluginID ID,
const RegistryPath group,
const RegistryPath key,
const bool &  value 
)
pure virtual

Implemented in PluginManager.

◆ SetPrivateConfig() [2/5]

virtual bool PluginManagerInterface::SetPrivateConfig ( const PluginID ID,
const RegistryPath group,
const RegistryPath key,
const double &  value 
)
pure virtual

Implemented in PluginManager.

◆ SetPrivateConfig() [3/5]

virtual bool PluginManagerInterface::SetPrivateConfig ( const PluginID ID,
const RegistryPath group,
const RegistryPath key,
const float &  value 
)
pure virtual

Implemented in PluginManager.

◆ SetPrivateConfig() [4/5]

virtual bool PluginManagerInterface::SetPrivateConfig ( const PluginID ID,
const RegistryPath group,
const RegistryPath key,
const int &  value 
)
pure virtual

Implemented in PluginManager.

◆ SetPrivateConfig() [5/5]

virtual bool PluginManagerInterface::SetPrivateConfig ( const PluginID ID,
const RegistryPath group,
const RegistryPath key,
const wxString &  value 
)
pure virtual

Implemented in PluginManager.

◆ SetSharedConfig() [1/5]

virtual bool PluginManagerInterface::SetSharedConfig ( const PluginID ID,
const RegistryPath group,
const RegistryPath key,
const bool &  value 
)
pure virtual

Implemented in PluginManager.

◆ SetSharedConfig() [2/5]

virtual bool PluginManagerInterface::SetSharedConfig ( const PluginID ID,
const RegistryPath group,
const RegistryPath key,
const double &  value 
)
pure virtual

Implemented in PluginManager.

◆ SetSharedConfig() [3/5]

virtual bool PluginManagerInterface::SetSharedConfig ( const PluginID ID,
const RegistryPath group,
const RegistryPath key,
const float &  value 
)
pure virtual

Implemented in PluginManager.

◆ SetSharedConfig() [4/5]

virtual bool PluginManagerInterface::SetSharedConfig ( const PluginID ID,
const RegistryPath group,
const RegistryPath key,
const int &  value 
)
pure virtual

Implemented in PluginManager.

◆ SetSharedConfig() [5/5]

virtual bool PluginManagerInterface::SetSharedConfig ( const PluginID ID,
const RegistryPath group,
const RegistryPath key,
const wxString &  value 
)
pure virtual

Implemented in PluginManager.


The documentation for this class was generated from the following files:
PluginTypeEffect
@ PluginTypeEffect
Definition: PluginManager.h:35
PluginManager::RegisterPlugin
const PluginID & RegisterPlugin(ModuleInterface *module) override
Definition: PluginManager.cpp:397
PluginManager::Get
static PluginManager & Get()
Definition: PluginManager.cpp:695
EffectDefinitionInterface
EffectDefinitionInterface is a ComponentInterface that additionally tracks flag-functions for interac...
Definition: EffectInterface.h:76
ComponentInterface
ComponentInterface provides name / vendor / version functions to identify plugins....
Definition: ComponentInterface.h:62