Internal module to auto register all built in commands. It is closely modelled on BuiltinEffectsModule. More...

#include <LoadCommands.h>

Inheritance diagram for BuiltinCommandsModule:

Collaboration diagram for BuiltinCommandsModule:

Classes
struct	Entry

struct	Registration

Public Types
using	Factory = std::function< std::unique_ptr< AudacityCommand >() >

Public Types inherited from PluginProvider
using	RegistrationCallback = std::function< const PluginID &(PluginProvider , ComponentInterface ) >
	Further expand a path reported by FindModulePaths. More...

Public Member Functions
	BuiltinCommandsModule ()

virtual	~BuiltinCommandsModule ()

PluginPath	GetPath () const override

ComponentInterfaceSymbol	GetSymbol () const override

VendorSymbol	GetVendor () const override

wxString	GetVersion () const override

TranslatableString	GetDescription () const override

bool	Initialize () override
	Called immediately after creation. Let provider initialize. More...

void	Terminate () override
	Called just prior to deletion to allow releasing any resources. More...

EffectFamilySymbol	GetOptionalFamilySymbol () override
	A symbol identifying the family of plug-ins provided by this. More...

const FileExtensions &	GetFileExtensions () override
	File types associated with this protocol. More...

FilePath	InstallPath () override
	Where plug-in files should be copied to install them. More...

void	AutoRegisterPlugins (PluginManagerInterface &pm) override
	Called so that a provider of a static set of plug-ins can register them. More...

PluginPaths	FindModulePaths (PluginManagerInterface &pm) override

unsigned	DiscoverPluginsAtPath (const PluginPath &path, TranslatableString &errMsg, const RegistrationCallback &callback) override

bool	CheckPluginExist (const PluginPath &path) const override
	Performs plugin/module existence check, still plugin may fail to load. Implementation should avoid loading plugins during this check. More...

std::unique_ptr< ComponentInterface >	LoadPlugin (const PluginPath &path) override
	Load the plug-in at a path reported by DiscoverPluginsAtPath. More...

Public Member Functions inherited from PluginProvider
virtual	~PluginProvider ()

virtual bool	Initialize ()=0
	Called immediately after creation. Let provider initialize. More...

virtual void	Terminate ()=0
	Called just prior to deletion to allow releasing any resources. More...

virtual EffectFamilySymbol	GetOptionalFamilySymbol ()=0
	A symbol identifying the family of plug-ins provided by this. More...

virtual const FileExtensions &	GetFileExtensions ()=0
	File types associated with this protocol. More...

virtual FilePath	InstallPath ()=0
	Where plug-in files should be copied to install them. More...

virtual void	AutoRegisterPlugins (PluginManagerInterface &pluginManager)=0
	Called so that a provider of a static set of plug-ins can register them. More...

virtual PluginPaths	FindModulePaths (PluginManagerInterface &pluginManager)=0

virtual unsigned	DiscoverPluginsAtPath (const PluginPath &path, TranslatableString &errMsg, const RegistrationCallback &callback)=0

virtual bool	CheckPluginExist (const PluginPath &path) const =0
	Performs plugin/module existence check, still plugin may fail to load. Implementation should avoid loading plugins during this check. More...

virtual std::unique_ptr< Validator >	MakeValidator () const

virtual std::unique_ptr< ComponentInterface >	LoadPlugin (const PluginPath &path)=0
	Load the plug-in at a path reported by DiscoverPluginsAtPath. More...

Public Member Functions inherited from ComponentInterface
virtual	~ComponentInterface ()

virtual PluginPath	GetPath () const =0

virtual ComponentInterfaceSymbol	GetSymbol () const =0

virtual VendorSymbol	GetVendor () const =0

virtual wxString	GetVersion () const =0

virtual TranslatableString	GetDescription () const =0

TranslatableString	GetName () const

Private Types
using	CommandHash = std::unordered_map< wxString, const Entry * >

Private Member Functions
std::unique_ptr< AudacityCommand >	Instantiate (const PluginPath &path)

Static Private Member Functions
static void	DoRegistration (const ComponentInterfaceSymbol &name, const Factory &factory)

Private Attributes
CommandHash	mCommands

Detailed Description

Internal module to auto register all built in commands. It is closely modelled on BuiltinEffectsModule.

Definition at line 30 of file LoadCommands.h.

Member Typedef Documentation

◆ CommandHash

using BuiltinCommandsModule::CommandHash = std::unordered_map< wxString, const Entry* >

private

Definition at line 86 of file LoadCommands.h.

◆ Factory

using BuiltinCommandsModule::Factory = std::function< std::unique_ptr<AudacityCommand> () >

Definition at line 36 of file LoadCommands.h.

Constructor & Destructor Documentation

◆ BuiltinCommandsModule()

BuiltinCommandsModule::BuiltinCommandsModule ( )

Definition at line 74 of file LoadCommands.cpp.

75{

76}

◆ ~BuiltinCommandsModule()

BuiltinCommandsModule::~BuiltinCommandsModule ( )

virtual

Definition at line 78 of file LoadCommands.cpp.

79{

80}

Member Function Documentation

◆ AutoRegisterPlugins()

void BuiltinCommandsModule::AutoRegisterPlugins ( PluginManagerInterface & pluginManager )

overridevirtual

Called so that a provider of a static set of plug-ins can register them.

Implements PluginProvider.

Definition at line 145 of file LoadCommands.cpp.

{
   TranslatableString ignoredErrMsg;
   for (const auto &pair : mCommands)
   {
      const auto &path = pair.first;
      if (!pm.IsPluginRegistered(path, &pair.second->name.Msgid()))
      {
         // No checking of error ?
         // Uses Generic Registration, not Default.
         // Registers as TypeGeneric, not TypeEffect.
         DiscoverPluginsAtPath(path, ignoredErrMsg,
            PluginManagerInterface::AudacityCommandRegistrationCallback);
      }
   }
}

References PluginManagerInterface::AudacityCommandRegistrationCallback(), DiscoverPluginsAtPath(), PluginManagerInterface::IsPluginRegistered(), and mCommands.

Here is the call graph for this function:

◆ CheckPluginExist()

bool BuiltinCommandsModule::CheckPluginExist ( const PluginPath & path ) const

overridevirtual

Performs plugin/module existence check, still plugin may fail to load. Implementation should avoid loading plugins during this check.

Parameters

path	Internal plugin path/ID discovered via DiscoverPluginsAtPath or module path returned by FindModulePaths

Implements PluginProvider.

Definition at line 197 of file LoadCommands.cpp.

{
   return mCommands.find( path ) != mCommands.end();
}

References mCommands.

◆ DiscoverPluginsAtPath()

unsigned BuiltinCommandsModule::DiscoverPluginsAtPath	(	const PluginPath &	path,
		TranslatableString &	errMsg,
		const RegistrationCallback &	callback
	)

overridevirtual

Implements PluginProvider.

Definition at line 171 of file LoadCommands.cpp.

{
   // At most one
   errMsg = {};
   auto Command = Instantiate(path);
   if (Command)
   {
      if (callback){
         callback(this, Command.get());
      }
      return 1;
   }
 
   errMsg = XO("Unknown built-in command name");
   return 0;
}

References MenuRegistry::Command, Instantiate(), and XO().

Referenced by AutoRegisterPlugins().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DoRegistration()

void BuiltinCommandsModule::DoRegistration	(	const ComponentInterfaceSymbol &	name,
		const Factory &	factory
	)

staticprivate

Definition at line 40 of file LoadCommands.cpp.

{
   wxASSERT( !sInitialized );
   Entry::Registry().emplace_back( Entry{ name, factory } );
}

References factory, name, BuiltinCommandsModule::Entry::Registry(), and sInitialized.

Here is the call graph for this function:

◆ FindModulePaths()

PluginPaths BuiltinCommandsModule::FindModulePaths ( PluginManagerInterface & pluginManager )

overridevirtual

Find available "paths", which may each be presented to the user, and then reexamined (possibly loading libraries) to find one or more plug-ins

Paths are not necessarily file system paths. Only the provider reinterprets the paths.

Modules may be associated with plug-ins, one-to-many.

See also: GetFileExtensions DiscoverPluginsAtPath

Implements PluginProvider.

Definition at line 162 of file LoadCommands.cpp.

{
   // Not really libraries
   PluginPaths names;
   for ( const auto &pair : mCommands )
      names.push_back( pair.first );
   return names;
}

References mCommands, and names.

◆ GetDescription()

TranslatableString BuiltinCommandsModule::GetDescription ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 107 of file LoadCommands.cpp.

{
   return XO("Provides builtin commands to Audacity");
}

References XO().

Here is the call graph for this function:

◆ GetFileExtensions()

const FileExtensions & BuiltinCommandsModule::GetFileExtensions ( )

overridevirtual

File types associated with this protocol.

"Paths" returned by FindModulePaths() and passed back to DiscoverPluginsAtPath() have provider-specific meaning. They are not necessarily file system paths to existent files that could be placed in any folder and queried for plug-in information.

This function returns nonempty only when that is the case, and lists the possible extensions of such files (an empty string in a nonempty array means any file is a candidate).

Implements PluginProvider.

Definition at line 139 of file LoadCommands.cpp.

{
   static FileExtensions empty;
   return empty;
}

◆ GetOptionalFamilySymbol()

EffectFamilySymbol BuiltinCommandsModule::GetOptionalFamilySymbol ( )

overridevirtual

A symbol identifying the family of plug-ins provided by this.

If it is not empty, then the family as a whole can be enabled or disabled by the user in Preferences

Implements PluginProvider.

Definition at line 133 of file LoadCommands.cpp.

{
   // Commands are not enabled and disabled in EffectsPrefs
   return {};
}

◆ GetPath()

PluginPath BuiltinCommandsModule::GetPath ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 86 of file LoadCommands.cpp.

{
   return {};
}

◆ GetSymbol()

ComponentInterfaceSymbol BuiltinCommandsModule::GetSymbol ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 91 of file LoadCommands.cpp.

{
   return XO("Builtin Commands");
}

References XO().

Here is the call graph for this function:

◆ GetVendor()

VendorSymbol BuiltinCommandsModule::GetVendor ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 96 of file LoadCommands.cpp.

{
   return XO("The Audacity Team");
}

References XO().

Here is the call graph for this function:

◆ GetVersion()

wxString BuiltinCommandsModule::GetVersion ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 101 of file LoadCommands.cpp.

{
   // This "may" be different if this were to be maintained as a separate DLL
   return AUDACITY_VERSION_STRING;
}

◆ Initialize()

bool BuiltinCommandsModule::Initialize ( )

overridevirtual

Called immediately after creation. Let provider initialize.

Returns: "true" if initialization was successful

Implements PluginProvider.

Definition at line 116 of file LoadCommands.cpp.

{
   for ( const auto &entry : Entry::Registry() ) {
      auto path = wxString(BUILTIN_GENERIC_COMMAND_PREFIX)
         + entry.name.Internal();
      mCommands[ path ] = &entry;
   }
   sInitialized = true;
   return true;
}

References BUILTIN_GENERIC_COMMAND_PREFIX, entry, mCommands, BuiltinCommandsModule::Entry::Registry(), and sInitialized.

Here is the call graph for this function:

◆ InstallPath()

FilePath BuiltinCommandsModule::InstallPath ( )

inlineoverridevirtual

Where plug-in files should be copied to install them.

Returns: may be empty. Drag-and-drop is supported only if GetFileExtensions() returns nonempty and this function returns nonempty.

Implements PluginProvider.

Definition at line 61 of file LoadCommands.h.

61{ return {}; }

◆ Instantiate()

std::unique_ptr< AudacityCommand > BuiltinCommandsModule::Instantiate ( const PluginPath & path )

private

Definition at line 206 of file LoadCommands.cpp.

{
   wxASSERT(path.StartsWith(BUILTIN_GENERIC_COMMAND_PREFIX));
   auto iter = mCommands.find( path );
   if ( iter != mCommands.end() )
      return iter->second->factory();
 
   wxASSERT( false );
   return nullptr;
}

References BUILTIN_GENERIC_COMMAND_PREFIX, and mCommands.

Referenced by DiscoverPluginsAtPath(), and LoadPlugin().

Here is the caller graph for this function:

◆ LoadPlugin()

std::unique_ptr< ComponentInterface > BuiltinCommandsModule::LoadPlugin ( const PluginPath & path )

overridevirtual

Load the plug-in at a path reported by DiscoverPluginsAtPath.

Returns: smart pointer managing the later unloading

Implements PluginProvider.

Definition at line 191 of file LoadCommands.cpp.

{
   // Acquires a resource for the application.
   return Instantiate(path);
}

References Instantiate().

Here is the call graph for this function:

◆ Terminate()

void BuiltinCommandsModule::Terminate ( )

overridevirtual

Called just prior to deletion to allow releasing any resources.

Implements PluginProvider.

Definition at line 127 of file LoadCommands.cpp.

{
   // Nothing to do here
   return;
}

Member Data Documentation

◆ mCommands

CommandHash BuiltinCommandsModule::mCommands

private

Definition at line 87 of file LoadCommands.h.

Referenced by AutoRegisterPlugins(), CheckPluginExist(), FindModulePaths(), Initialize(), and Instantiate().

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

Classes

Public Types

Public Member Functions

Private Types

Private Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ CommandHash

◆ Factory

Constructor & Destructor Documentation

◆ BuiltinCommandsModule()

◆ ~BuiltinCommandsModule()

Member Function Documentation

◆ AutoRegisterPlugins()

◆ CheckPluginExist()

◆ DiscoverPluginsAtPath()

◆ DoRegistration()

◆ FindModulePaths()

◆ GetDescription()

◆ GetFileExtensions()

◆ GetOptionalFamilySymbol()

◆ GetPath()

◆ GetSymbol()

◆ GetVendor()

◆ GetVersion()

◆ Initialize()

◆ InstallPath()

◆ Instantiate()

◆ LoadPlugin()

◆ Terminate()

Member Data Documentation

◆ mCommands