CommandImplementation Class Reference

is derived from OldStyleCommand. It validates and applies the command. CommandImplementation::Apply() is overloaded in classes derived from it. More...

#include <Command.h>

Inheritance diagram for CommandImplementation:

Collaboration diagram for CommandImplementation:

Public Member Functions
	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

Protected Member Functions
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)

Private Member Functions
bool	Valid (const wxString &paramName, const wxVariant &paramValue)

Private Attributes
OldStyleCommandType &	mType
ParamValueMap	mParams
ParamBoolMap	mSetParams

Additional Inherited Members
Public Attributes inherited from OldStyleCommand
AudacityProject &	mProject

Detailed Description

is derived from OldStyleCommand. It validates and applies the command. CommandImplementation::Apply() is overloaded in classes derived from it.

Definition at line 76 of file Command.h.

Constructor & Destructor Documentation

CommandImplementation()

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

Constructor should not be called directly; only by a factory which ensures name and params are set appropriately for the command.

Definition at line 171 of file Command.cpp.

:  OldStyleCommand{ project },
   mType(type),
   mParams(type.GetSignature().GetDefaults()),
   mSetParams()
{
}

~CommandImplementation()

CommandImplementation::~CommandImplementation ( )

virtual

Definition at line 180 of file Command.cpp.

{
}

Member Function Documentation

Apply() [1/2]

bool CommandImplementation::Apply ( )

inlineoverridevirtual

Actually carry out the command. Return true if successful and false otherwise.

Implements OldStyleCommand.

Definition at line 122 of file Command.h.

{ return false;};// No longer supported.

Apply() [2/2]

bool CommandImplementation::Apply ( const CommandContext &  context )

overridevirtual

Implements OldStyleCommand.

CheckParam()

void CommandImplementation::CheckParam ( const wxString &  paramName )

protected

Definition at line 198 of file Command.cpp.

{
   // this macro is empty if wxWidgets is not compiled in debug mode
   wxASSERT_MSG(mParams.find(paramName) != mParams.end(),
                GetSymbol().Internal()
                + wxT("command tried to get '")
                + paramName
                + wxT("' parameter, but that parameter doesn't exist in the command signature!"));
}

References GetSymbol(), Internal, mParams, and wxT().

Referenced by GetBool(), GetDouble(), GetLong(), and GetString().

Here is the call graph for this function:

Here is the caller graph for this function:

GetBool()

bool CommandImplementation::GetBool ( const wxString &  paramName )

protected

Definition at line 216 of file Command.cpp.

{
   CheckParam(paramName);
   const wxVariant &v = mParams[paramName];
   TypeCheck(wxT("bool"), paramName, v);
   return v.GetBool();
}

References CheckParam(), mParams, TypeCheck(), and wxT().

Here is the call graph for this function:

GetDouble()

double CommandImplementation::GetDouble ( const wxString &  paramName )

protected

Definition at line 232 of file Command.cpp.

{
   CheckParam(paramName);
   const wxVariant &v = mParams[paramName];
   TypeCheck(wxT("double"), paramName, v);
   return v.GetDouble();
}

References CheckParam(), mParams, TypeCheck(), and wxT().

Here is the call graph for this function:

GetLong()

long CommandImplementation::GetLong ( const wxString &  paramName )

protected

Definition at line 224 of file Command.cpp.

{
   CheckParam(paramName);
   const wxVariant &v = mParams[paramName];
   TypeCheck(wxT("double"), paramName, v);
   return (long)v.GetDouble();
}

References CheckParam(), mParams, TypeCheck(), and wxT().

Here is the call graph for this function:

GetSignature()

CommandSignature & CommandImplementation::GetSignature ( )

overridevirtual

Get the signature of the command.

Implements OldStyleCommand.

Definition at line 255 of file Command.cpp.

{
   return mType.GetSignature();
}

References OldStyleCommandType::GetSignature(), and mType.

Here is the call graph for this function:

GetString()

wxString CommandImplementation::GetString ( const wxString &  paramName )

protected

Definition at line 240 of file Command.cpp.

{
   CheckParam(paramName);
   const wxVariant &v = mParams[paramName];
   TypeCheck(wxT("string"), paramName, v);
   return v.GetString();
}

References CheckParam(), mParams, TypeCheck(), and wxT().

Referenced by BatchEvalCommand::Apply().

Here is the call graph for this function:

Here is the caller graph for this function:

GetSymbol()

ComponentInterfaceSymbol CommandImplementation::GetSymbol ( )

overridevirtual

An instance method for getting the command name (for consistency)

Get the name of the command.

Implements OldStyleCommand.

Definition at line 249 of file Command.cpp.

{
   return mType.GetSymbol();
}

References OldStyleCommandType::GetSymbol(), and mType.

Referenced by CheckParam(), SetParameter(), and TypeCheck().

Here is the call graph for this function:

Here is the caller graph for this function:

HasParam()

bool CommandImplementation::HasParam ( const wxString &  paramName )

protected

Definition at line 208 of file Command.cpp.

{
   // Test for not even in map...
   if( mParams.count(paramName) < 1)
      return false;
   return mSetParams[paramName];
}

References mParams, and mSetParams.

SetParameter()

bool CommandImplementation::SetParameter ( const wxString &  paramName, const wxVariant &  paramValue  )

overridevirtual

Attempt to one of the command's parameters to a particular value. (Note: wxVariant is reference counted)

Reimplemented from OldStyleCommand.

Definition at line 260 of file Command.cpp.

{
   wxASSERT(!paramValue.IsType(wxT("null")));
   CommandContext context( mProject );
   ParamValueMap::iterator iter = mParams.find(paramName);
   if (iter == mParams.end())
   {
      // Translated format, but untranslated command name substituted into it?
      // Perhaps these formats that don't need translating.
      context.Error( wxString::Format(
         _("%s is not a parameter accepted by %s"),
            paramName, GetSymbol().Internal() ) );
                    // neglect translation for scripting ??
      return false;
   }
 
   Validator &validator = mType.GetSignature().GetValidator(iter->first);
   if (!validator.Validate(paramValue))
   {
      context.Error( wxString::Format(
         _("Invalid value for parameter '%s': should be %s"),
            paramName, validator.GetDescription() ) );
      return false;
   }
   mParams[paramName] = validator.GetConverted();
   mSetParams[ paramName ] = true;
 
   // (debug)
   // context.Status(wxT("Set parameter ") + paramName + wxT(" to type ") + mParams[paramName].GetType() + wxT(", value ") + mParams[paramName].MakeString());
 
   return true;
}

References _, CommandContext::Error(), Validator::GetConverted(), Validator::GetDescription(), OldStyleCommandType::GetSignature(), GetSymbol(), CommandSignature::GetValidator(), Internal, mParams, OldStyleCommand::mProject, mSetParams, mType, Validator::Validate(), and wxT().

Here is the call graph for this function:

TypeCheck()

void CommandImplementation::TypeCheck ( const wxString &  typeName, const wxString &  paramName, const wxVariant &  param  )

protected

Definition at line 184 of file Command.cpp.

{
   // this macro is empty if wxWidgets is not compiled in debug mode
   wxASSERT_MSG(param.IsType(typeName),
                GetSymbol().Internal()
                + wxT("command tried to get '")
                + paramName
                + wxT("' parameter as a ")
                + typeName
                + wxT(", but that wasn't enforced by the command signature."));
}

References GetSymbol(), Internal, and wxT().

Referenced by GetBool(), GetDouble(), GetLong(), and GetString().

Here is the call graph for this function:

Here is the caller graph for this function:

Valid()

bool CommandImplementation::Valid ( const wxString &  paramName, const wxVariant &  paramValue  )

private

Using the command signature, looks up a possible parameter value and checks whether it passes the validator.

Member Data Documentation

mParams

ParamValueMap CommandImplementation::mParams

private

Definition at line 81 of file Command.h.

Referenced by CheckParam(), GetBool(), GetDouble(), GetLong(), GetString(), HasParam(), and SetParameter().

mSetParams

ParamBoolMap CommandImplementation::mSetParams

private

Definition at line 82 of file Command.h.

Referenced by HasParam(), and SetParameter().

mType

OldStyleCommandType& CommandImplementation::mType

private

Definition at line 80 of file Command.h.

Referenced by GetSignature(), GetSymbol(), and SetParameter().

---

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

• Command.h
• Command.cpp