CommandBuilder Class Reference

A type of factory for Commands of various sorts. More...

#include <CommandBuilder.h>

Collaboration diagram for CommandBuilder:

Public Member Functions
	CommandBuilder (AudacityProject &project, const wxString &cmdString)
	CommandBuilder (AudacityProject &project, const wxString &cmdName, const wxString &cmdParams)
	~CommandBuilder ()
bool	WasValid ()
OldStyleCommandPointer	GetCommand ()
wxString	GetResponse ()

Private Member Functions
void	Failure (const wxString &msg={})
void	Success (const OldStyleCommandPointer &cmd)
void	BuildCommand (AudacityProject &project, const wxString &cmdName, const wxString &cmdParams)
void	BuildCommand (AudacityProject &project, const wxString &cmdString)

Private Attributes
bool	mValid
ResponseTargetPointer	mResponse
OldStyleCommandPointer	mCommand
wxString	mError

Detailed Description

A type of factory for Commands of various sorts.

CommandBuilder has the task of deciding what command is meant by a given command string, and producing a suitable command object. For now, it doesn't actually do any processing - it just passes everything on to the BatchCommand system by constructing BatchCommandEval objects.

Definition at line 32 of file CommandBuilder.h.

Constructor & Destructor Documentation

CommandBuilder() [1/2]

CommandBuilder::CommandBuilder	(	AudacityProject &	project,
		const wxString &	cmdString
	)

Definition at line 33 of file CommandBuilder.cpp.

   : mValid(false)
{
   BuildCommand(project, cmdString);
}

References BuildCommand(), and project.

Here is the call graph for this function:

CommandBuilder() [2/2]

CommandBuilder::CommandBuilder	(	AudacityProject &	project,
		const wxString &	cmdName,
		const wxString &	cmdParams
	)

Definition at line 40 of file CommandBuilder.cpp.

   : mValid(false)
{
   BuildCommand(project, cmdName, params);
}

References BuildCommand(), params, and project.

Here is the call graph for this function:

~CommandBuilder()

CommandBuilder::~CommandBuilder

(

)

Definition at line 47 of file CommandBuilder.cpp.

{
}

Member Function Documentation

BuildCommand() [1/2]

void CommandBuilder::BuildCommand ( AudacityProject &  project, const wxString &  cmdName, const wxString &  cmdParams  )

private

Definition at line 139 of file CommandBuilder.cpp.

{
   // Stage 1: create a Command object of the right type
 
   mResponse = std::make_shared< ResponseTarget >();
   auto output
      = std::make_unique<CommandOutputTargets>(std::make_unique<NullProgressTarget>(),
                                mResponse,
                                mResponse);
 
#ifdef OLD_BATCH_SYSTEM
   OldStyleCommandType *factory = CommandDirectory::Get()->LookUp(cmdName);
 
   if (factory == NULL)
   {
      // Fall back to hoping the Batch Command system can handle it
#endif
      OldStyleCommandType *type = CommandDirectory::Get()->LookUp(wxT("BatchCommand"));
      wxASSERT(type != NULL);
      mCommand = type->Create(project, nullptr);
      mCommand->SetParameter(wxT("CommandName"), cmdName);
      mCommand->SetParameter(wxT("ParamString"), cmdParamsArg);
      auto aCommand = std::make_shared<ApplyAndSendResponse>(mCommand, output);
      Success(aCommand);
      return;
#ifdef OLD_BATCH_SYSTEM
   }
 
   CommandSignature &signature = factory->GetSignature();
   mCommand = factory->Create(nullptr);
   //mCommand->SetOutput( std::move(output) );
   // Stage 2: set the parameters
 
   ShuttleCli shuttle;
   shuttle.mParams = cmdParamsArg;
 
   ParamValueMap::const_iterator iter;
   ParamValueMap params = signature.GetDefaults();
 
   // Iterate through the parameters defined by the command
   for (iter = params.begin(); iter != params.end(); ++iter)
   {
      wxString paramString;
      // IF there is a match in the args actually used
      if (shuttle.TransferString(iter->first, paramString, wxT("")))
      {
         // Then set that parameter.
         if (!mCommand->SetParameter(iter->first, paramString))
         {
            Failure();
            return;
         }
      }
   }
 
   // Check for unrecognised parameters
 
   wxString cmdParams(cmdParamsArg);
 
   while (!cmdParams.empty())
   {
      cmdParams.Trim(true);
      cmdParams.Trim(false);
      int splitAt = cmdParams.Find(wxT('='));
      if (splitAt < 0 && !cmdParams.empty())
      {
         Failure(wxT("Parameter string is missing '='"));
         return;
      }
      wxString paramName = cmdParams.Left(splitAt);
      if (params.find(paramName) == params.end())
      {
         Failure(wxT("Unrecognized parameter: '") + paramName + wxT("'"));
         return;
      }
      // Handling of quoted strings is quite limited.
      // You start and end with a " or a '.
      // There is no escaping in the string.
      cmdParams = cmdParams.Mid(splitAt+1);
      if( cmdParams.empty() )
         splitAt =-1;
      else if( cmdParams[0] == '\"' ){
         cmdParams = cmdParams.Mid(1);
         splitAt = cmdParams.Find(wxT('\"'))+1;
      }
      else if( cmdParams[0] == '\'' ){
         cmdParams = cmdParams.Mid(1);
         splitAt = cmdParams.Find(wxT('\''))+1;
      }
      else
         splitAt = cmdParams.Find(wxT(' '))+1;
      if (splitAt < 1)
      {
         splitAt = cmdParams.length();
      }
      cmdParams = cmdParams.Mid(splitAt);
   }
   auto aCommand = std::make_shared<ApplyAndSendResponse>(mCommand, output);
   Success(aCommand);
#endif
}

References OldStyleCommandType::Create(), factory, Failure(), CommandDirectory::Get(), CommandSignature::GetDefaults(), CommandDirectory::LookUp(), mCommand, mResponse, params, project, Success(), and wxT().

Referenced by BuildCommand(), and CommandBuilder().

Here is the call graph for this function:

Here is the caller graph for this function:

BuildCommand() [2/2]

void CommandBuilder::BuildCommand ( AudacityProject &  project, const wxString &  cmdString  )

private

Definition at line 243 of file CommandBuilder.cpp.

{
   wxString cmdString(cmdStringArg);
 
   // Find the command name terminator...  If there is more than one word and
   // no terminator, the command is badly formed
   cmdString.Trim(true); cmdString.Trim(false);
   int splitAt = cmdString.Find(wxT(':'));
   if (splitAt < 0 && cmdString.Find(wxT(' ')) >= 0) {
      Failure(wxT("Syntax error!\nCommand is missing ':'"));
      return;
   }
 
   wxString cmdName = cmdString.Left(splitAt);
   wxString cmdParams = cmdString.Mid(splitAt+1);
   if( splitAt < 0 )
      cmdParams = "";
 
   cmdName.Trim(true);
   cmdParams.Trim(false);
 
   BuildCommand(project, cmdName, cmdParams);
}

References BuildCommand(), Failure(), project, and wxT().

Here is the call graph for this function:

Failure()

void CommandBuilder::Failure ( const wxString &  msg = {} )

private

Definition at line 73 of file CommandBuilder.cpp.

{
   mError = msg;
   mValid = false;
}

References mError, and mValid.

Referenced by BuildCommand().

Here is the caller graph for this function:

GetCommand()

OldStyleCommandPointer CommandBuilder::GetCommand

(

)

Definition at line 56 of file CommandBuilder.cpp.

{
   wxASSERT(mValid);
   wxASSERT(mCommand);
   auto result = mCommand;
   mCommand.reset();
   return result;
}

References mCommand, and mValid.

Referenced by ExecCommand().

Here is the caller graph for this function:

GetResponse()

wxString CommandBuilder::GetResponse

(

)

Definition at line 65 of file CommandBuilder.cpp.

{
   if (!mValid && !mError.empty()) {
      return mError + wxT("\n");
   }
   return mResponse->GetResponse() + wxT("\n");
}

References mError, mResponse, mValid, and wxT().

Referenced by ExecCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

Success()

void CommandBuilder::Success ( const OldStyleCommandPointer &  cmd )

private

Definition at line 79 of file CommandBuilder.cpp.

{
   mCommand = cmd;
   mValid = true;
}

References mCommand, and mValid.

Referenced by BuildCommand().

Here is the caller graph for this function:

WasValid()

bool CommandBuilder::WasValid

(

)

Definition at line 51 of file CommandBuilder.cpp.

{
   return mValid;
}

References mValid.

Referenced by ExecCommand().

Here is the caller graph for this function:

Member Data Documentation

mCommand

OldStyleCommandPointer CommandBuilder::mCommand

private

Definition at line 37 of file CommandBuilder.h.

Referenced by BuildCommand(), GetCommand(), and Success().

mError

wxString CommandBuilder::mError

private

Definition at line 38 of file CommandBuilder.h.

Referenced by Failure(), and GetResponse().

mResponse

ResponseTargetPointer CommandBuilder::mResponse

private

Definition at line 36 of file CommandBuilder.h.

Referenced by BuildCommand(), and GetResponse().

mValid

bool CommandBuilder::mValid

private

Definition at line 35 of file CommandBuilder.h.

Referenced by Failure(), GetCommand(), GetResponse(), Success(), and WasValid().

---

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

• CommandBuilder.h
• CommandBuilder.cpp