CommandDirectory Class Reference

Allows registration and lookup (by name) of command types. More...

#include <CommandDirectory.h>

Collaboration diagram for CommandDirectory:

Classes
struct	RegisterType

Public Member Functions
	~CommandDirectory ()
OldStyleCommandType *	LookUp (const wxString &cmdName) const

Static Public Member Functions
static CommandDirectory *	Get ()
	Get a pointer to the singleton instance. More...

Private Member Functions
	CommandDirectory ()

Static Private Member Functions
static CommandMap &	sCmdMap ()
static void	AddCommand (std::unique_ptr< OldStyleCommandType > type)

Static Private Attributes
static std::unique_ptr< CommandDirectory >	mInstance

Detailed Description

Allows registration and lookup (by name) of command types.

A singleton. This fulfills a similar purpose to CommandManager, but for general Commands rather than menu items. Eventually they could be unified but for now they are kept separate to make things simpler.

Definition at line 30 of file CommandDirectory.h.

Constructor & Destructor Documentation

~CommandDirectory()

CommandDirectory::~CommandDirectory

(

)

Definition at line 62 of file CommandDirectory.cpp.

{
}

CommandDirectory()

CommandDirectory::CommandDirectory ( )

private

Definition at line 22 of file CommandDirectory.cpp.

{
   // Create the command map.
   // First we have commands which return information
   //AddCommand(std::make_unique<MessageCommandType>());
 
//   AddCommand(std::make_unique<BatchEvalCommandType>());
 
 
   // Legacy adapter commands that previously was needed to 
   // access menu items.
   //AddCommand(std::make_unique<ExecMenuCommandType>());
 
   // Not needed.  Sets selected/solo/mute on multiple tracks.
   //AddCommand(std::make_unique<SetProjectInfoCommandType>());
 
//   Moved to AudacityCommand
//   AddCommand(std::make_unique<OpenProjectCommandType>());
//   AddCommand(std::make_unique<SaveProjectCommandType>());
//   AddCommand(std::make_unique<ImportCommandType>());
//   AddCommand(std::make_unique<ExportCommandType>());
//   AddCommand(std::make_unique<HelpCommandType>());
//   AddCommand(std::make_unique<GetInfoCommandType>("GetAll"));
//   AddCommand(std::make_unique<GetInfoCommandType>("GetCommands"));
//   AddCommand(std::make_unique<GetInfoCommandType>("GetMenus"));
//   AddCommand(std::make_unique<GetInfoCommandType>("GetMenusPlus"));
//   AddCommand(std::make_unique<GetInfoCommandType>("GetBoxes"));
//   AddCommand(std::make_unique<GetInfoCommandType>("GetClips"));
 
//   AddCommand(std::make_unique<GetTrackInfoCommandType>());
//   AddCommand(std::make_unique<GetProjectInfoCommandType>());
//   AddCommand(std::make_unique<CompareAudioCommandType>());
//   AddCommand(std::make_unique<GetPreferenceCommandType>());
//   AddCommand(std::make_unique<SetPreferenceCommandType>());
//   AddCommand(std::make_unique<ScreenshotCommandType>());
//   AddCommand(std::make_unique<SelectCommandType>());
//   AddCommand(std::make_unique<SetTrackInfoCommandType>());
 
}

Referenced by Get().

Here is the caller graph for this function:

Member Function Documentation

AddCommand()

void CommandDirectory::AddCommand ( std::unique_ptr< OldStyleCommandType >  type )

staticprivate

Definition at line 82 of file CommandDirectory.cpp.

{
   wxASSERT(type != NULL);
   // Internal string is shown but only in assertion message
   auto cmdName = type->GetSymbol().Internal();
   wxASSERT_MSG(sCmdMap().find(cmdName) == sCmdMap().end()
         , wxT("A command named ") + cmdName
         + wxT(" already exists."));
 
   sCmdMap()[cmdName] = std::move(type);
}

References details::end(), sCmdMap(), and wxT().

Here is the call graph for this function:

Get()

CommandDirectory * CommandDirectory::Get ( )

static

Get a pointer to the singleton instance.

Definition at line 94 of file CommandDirectory.cpp.

{
   if (!mInstance)
      mInstance.reset(safenew CommandDirectory());
   return mInstance.get();
}

References CommandDirectory(), mInstance, and safenew.

Referenced by CommandBuilder::BuildCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

LookUp()

OldStyleCommandType * CommandDirectory::LookUp

(

const wxString &

cmdName

)

const

If a command with the given name has been registered in the directory, return a pointer to the factory for commands of that type. Otherwise return NULL.

Definition at line 66 of file CommandDirectory.cpp.

{
   auto iter = sCmdMap().find(cmdName);
   if (iter == sCmdMap().end())
   {
      return nullptr;
   }
   return iter->second.get();
}

References details::end(), and sCmdMap().

Referenced by CommandBuilder::BuildCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

sCmdMap()

CommandMap & CommandDirectory::sCmdMap ( )

staticprivate

Definition at line 76 of file CommandDirectory.cpp.

{
   static CommandMap theMap;
   return theMap;
}

Referenced by AddCommand(), and LookUp().

Here is the caller graph for this function:

Member Data Documentation

mInstance

std::unique_ptr< CommandDirectory > CommandDirectory::mInstance

staticprivate

Definition at line 33 of file CommandDirectory.h.

Referenced by Get().

---

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

• CommandDirectory.h
• CommandDirectory.cpp