Command.h

Go to the documentation of this file.

/**********************************************************************
 
   Audacity - A Digital Audio Editor
   Copyright 1999-2009 Audacity Team
   File License: wxWidgets
 
   Dan Horgan
 
******************************************************************//*******************************************************************/
 
#ifndef __COMMAND__
#define __COMMAND__
 
#include "CommandSignature.h"
#include "ComponentInterfaceSymbol.h"
 
class AudacityProject;
class AudacityApp;
class CommandContext;
class CommandOutputTargets;
 
// Abstract base class for command interface.
class OldStyleCommand /* not final */
{
public:
   AudacityProject &mProject;
 
   OldStyleCommand(AudacityProject &project) : mProject{ 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;
};
 
using OldStyleCommandPointer = std::shared_ptr<OldStyleCommand>;
 
class DecoratedCommand /* not final */ : public OldStyleCommand
{
protected:
   OldStyleCommandPointer mCommand;
public:
   DecoratedCommand(const OldStyleCommandPointer &cmd)
      : OldStyleCommand{ cmd->mProject }, mCommand(cmd)
   {
      wxASSERT(cmd != NULL);
   }
   virtual ~DecoratedCommand();
   ComponentInterfaceSymbol GetSymbol() override;
   CommandSignature &GetSignature() override;
   bool SetParameter(const wxString &paramName, const wxVariant &paramValue) override;
};
 
// Decorator command that performs the given command and then outputs a status
// message according to the result
class ApplyAndSendResponse : public DecoratedCommand
{
public:
   ApplyAndSendResponse(
      const OldStyleCommandPointer &cmd, std::unique_ptr<CommandOutputTargets> &target);
   bool Apply() override;
   bool Apply(const CommandContext &context) override;// Error to use this.
   std::unique_ptr<const CommandContext> mCtx;
 
};
 
class AUDACITY_DLL_API CommandImplementation /* not final */
   : public OldStyleCommand
{
private:
   OldStyleCommandType &mType;
   ParamValueMap mParams;
   ParamBoolMap mSetParams;
 
   bool Valid(const wxString &paramName, const wxVariant &paramValue);
 
protected:
   // Convenience methods for allowing subclasses to access parameters
   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);
 
public:
   CommandImplementation(AudacityProject &project, OldStyleCommandType &type);
 
   virtual ~CommandImplementation();
 
   ComponentInterfaceSymbol GetSymbol() override;
 
   CommandSignature &GetSignature() override;
 
   bool SetParameter(const wxString &paramName, const wxVariant &paramValue) override;
 
   // Subclasses should override the following:
   // =========================================
 
   bool Apply() override { return false;};// No longer supported.
   bool Apply(const CommandContext &context) override;
};
 
#endif /* End of include guard: __COMMAND__ */