BatchEvalCommand Class Reference

Given a string representing a command, pass it to the MacroCommands system. More...

#include <BatchEvalCommand.h>

Inheritance diagram for BatchEvalCommand:

Collaboration diagram for BatchEvalCommand:

Public Member Functions
	BatchEvalCommand (AudacityProject &project, OldStyleCommandType &type)
virtual	~BatchEvalCommand ()
bool	Apply (const CommandContext &context) override
Public Member Functions inherited from CommandImplementation
	CommandImplementation (AudacityProject &project, OldStyleCommandType &type)
virtual	~CommandImplementation ()
ComponentInterfaceSymbol	GetSymbol () override
	An instance method for getting the command name (for consistency) More...
CommandSignature &	GetSignature () override
	Get the signature of the command. More...
bool	SetParameter (const wxString &paramName, const wxVariant &paramValue) override
bool	Apply () override
bool	Apply (const CommandContext &context) override
Public Member Functions inherited from OldStyleCommand
	OldStyleCommand (AudacityProject &project)
virtual	~OldStyleCommand ()
virtual ComponentInterfaceSymbol	GetSymbol ()=0
virtual CommandSignature &	GetSignature ()=0
virtual bool	SetParameter (const wxString &paramName, const wxVariant &paramValue)
virtual bool	Apply ()=0
virtual bool	Apply (const CommandContext &context)=0

Additional Inherited Members
Public Attributes inherited from OldStyleCommand
AudacityProject &	mProject
Protected Member Functions inherited from CommandImplementation
void	TypeCheck (const wxString &typeName, const wxString &paramName, const wxVariant &param)
void	CheckParam (const wxString &paramName)
bool	HasParam (const wxString &paramName)
bool	GetBool (const wxString &paramName)
long	GetLong (const wxString &paramName)
double	GetDouble (const wxString &paramName)
wxString	GetString (const wxString &paramName)

Detailed Description

Given a string representing a command, pass it to the MacroCommands system.

Command to make processing of macros available to scripting. It can either make a one command macro, or invoke an existing macro. It will become redundant when menu commands are integrated into scripting.

The eventual aim is to move the code from MacroCommands out into separate command classes, but until this happens, BatchEvalCommand can act as a 'bridge' to that system.

Definition at line 40 of file BatchEvalCommand.h.

Constructor & Destructor Documentation

BatchEvalCommand()

BatchEvalCommand::BatchEvalCommand ( AudacityProject &  project, OldStyleCommandType &  type  )

inline

Definition at line 43 of file BatchEvalCommand.h.

      : CommandImplementation(project, type)
   { }

~BatchEvalCommand()

BatchEvalCommand::~BatchEvalCommand ( )

virtual

Definition at line 83 of file BatchEvalCommand.cpp.

{ }

Member Function Documentation

Apply()

bool BatchEvalCommand::Apply ( const CommandContext &  context )

overridevirtual

Implements OldStyleCommand.

Definition at line 48 of file BatchEvalCommand.cpp.

{
   // Uh oh, I need to build a catalog, expensively
   // Maybe it can be built in one long-lived place and shared among command
   // objects instead?
   // The catalog though may change during a session, as it includes the 
   // names of macro commands - so the long-lived copy will need to 
   // be refreshed after macros are added/deleted.
   MacroCommandsCatalog catalog(&context.project);
 
   wxString macroName = GetString(wxT("MacroName"));
   if (!macroName.empty())
   {
      MacroCommands batch{ context.project };
      batch.ReadMacro(macroName);
      return batch.ApplyMacro(catalog);
   }
 
   auto cmdName = GetString(wxT("CommandName"));
   wxString cmdParams = GetString(wxT("ParamString"));
   auto iter = catalog.ByCommandId(cmdName);
   const auto friendly = (iter == catalog.end())
      ? Verbatim( cmdName ) // Expose internal name to user, in default of a better one!
      : iter->name.Msgid().Stripped();
 
   // Create a Batch that will have just one command in it...
   MacroCommands Batch{ context.project };
   bool bResult = Batch.ApplyCommandInBatchMode(friendly, cmdName, cmdParams, &context);
   // Relay messages, if any.
   wxString Message = Batch.GetMessage();
   if( !Message.empty() )
      context.Status( Message );
   return bResult;
}

References MacroCommandsCatalog::ByCommandId(), TranslatableString::empty(), MacroCommandsCatalog::end(), CommandImplementation::GetString(), anonymous_namespace{TrackSelectHandle.cpp}::Message(), CommandContext::project, CommandContext::Status(), TranslatableString::Stripped(), Verbatim(), and wxT().

Here is the call graph for this function:

---

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

• BatchEvalCommand.h
• BatchEvalCommand.cpp