1
0
mirror of https://github.com/cookiengineer/audacity synced 2025-10-21 14:02:57 +02:00

Use IdentInterfaceSymbol to identify commands and effects

This commit is contained in:
Paul Licameli
2018-03-09 13:11:20 -05:00
parent 11d217076a
commit b200819f75
116 changed files with 239 additions and 332 deletions

View File

@@ -81,8 +81,7 @@ AudacityCommand::~AudacityCommand()
}
wxString AudacityCommand::GetPath(){ return BUILTIN_GENERIC_COMMAND_PREFIX + GetSymbol();}
wxString AudacityCommand::GetName(){ return GetSymbol();}
wxString AudacityCommand::GetPath(){ return BUILTIN_GENERIC_COMMAND_PREFIX + GetSymbol().Internal(); }
IdentInterfaceSymbol AudacityCommand::GetVendor(){ return XO("Audacity");}
wxString AudacityCommand::GetVersion(){ return AUDACITY_VERSION_STRING;}

View File

@@ -64,14 +64,12 @@ class AUDACITY_DLL_API AudacityCommand /* not final */ : public wxEvtHandler,
//These four can be defaulted....
wxString GetPath() override;
wxString GetName() override;
IdentInterfaceSymbol GetVendor() override;
wxString GetVersion() override;
// virtual wxString GetFamily();
//These two must be implemented by instances.
virtual wxString GetSymbol() override
{ wxFAIL_MSG( "Implement a Symbol for this command");return "FAIL";};
IdentInterfaceSymbol GetSymbol() override = 0;
virtual wxString GetDescription() override
{wxFAIL_MSG( "Implement a Description for this command");return "FAIL";};

View File

@@ -81,7 +81,7 @@ void CommandDirectory::AddCommand(movable_ptr<OldStyleCommandType> &&type)
{
wxASSERT(type != NULL);
// Internal string is shown but only in assertion message
auto cmdName = type->GetName();
auto cmdName = type->GetSymbol().Internal();
wxASSERT_MSG(mCmdMap.find(cmdName) == mCmdMap.end()
, wxT("A command named ") + cmdName
+ wxT(" already exists."));

View File

@@ -31,11 +31,11 @@ OldStyleCommandType::~OldStyleCommandType()
{
}
wxString OldStyleCommandType::GetName()
IdentInterfaceSymbol OldStyleCommandType::GetSymbol()
{
if (mSymbol.empty())
mSymbol = BuildName();
return mSymbol.Internal();
return mSymbol;
}
CommandSignature &OldStyleCommandType::GetSignature()
@@ -52,7 +52,7 @@ wxString OldStyleCommandType::Describe()
{
// PRL: Is this intended for end-user visibility or just debugging? It did not
// use _(""), so I assume it is meant to use internal strings
wxString desc = GetName() + wxT("\nParameters:");
wxString desc = GetSymbol().Internal() + wxT("\nParameters:");
GetSignature();
ParamValueMap::iterator iter;
ParamValueMap defaults = mSignature->GetDefaults();

View File

@@ -50,7 +50,7 @@ private:
public:
OldStyleCommandType();
virtual ~OldStyleCommandType();
wxString GetName() override;
IdentInterfaceSymbol GetSymbol() override;
CommandSignature &GetSignature();
wxString Describe(); // for debugging only ?

View File

@@ -23,13 +23,13 @@ classes
class WaveTrack;
#define COMPARE_AUDIO_PLUGIN_SYMBOL XO("Compare Audio")
#define COMPARE_AUDIO_PLUGIN_SYMBOL IdentInterfaceSymbol{ XO("Compare Audio") }
class CompareAudioCommand final : public AudacityCommand
{
public:
// CommandDefinitionInterface overrides
wxString GetSymbol() override {return XO("Compare Audio");}
IdentInterfaceSymbol GetSymbol() override {return XO("Compare Audio");}
wxString GetDescription() override {return _("Compares a range on two tracks.");};
bool DefineParams( ShuttleParams & S ) override;
void PopulateOrExchange(ShuttleGui & S) override;

View File

@@ -20,13 +20,13 @@
class ShuttleGui;
#define DEMO_PLUGIN_SYMBOL XO("Demo")
#define DEMO_PLUGIN_SYMBOL IdentInterfaceSymbol{ XO("Demo") }
class DemoCommand final : public AudacityCommand
{
public:
// CommandDefinitionInterface overrides
wxString GetSymbol() override {return DEMO_PLUGIN_SYMBOL;};
IdentInterfaceSymbol GetSymbol() override {return DEMO_PLUGIN_SYMBOL;};
wxString GetDescription() override {return _("Does the demo action.");};
bool DefineParams( ShuttleParams & S ) override;
void PopulateOrExchange(ShuttleGui & S) override;

View File

@@ -19,14 +19,14 @@
#include "Command.h"
#include "CommandType.h"
#define DRAG_PLUGIN_SYMBOL XO("Drag")
#define DRAG_PLUGIN_SYMBOL IdentInterfaceSymbol{ XO("Drag") }
class DragCommand : public AudacityCommand
{
public:
DragCommand();
// CommandDefinitionInterface overrides
wxString GetSymbol() override {return DRAG_PLUGIN_SYMBOL;};
IdentInterfaceSymbol GetSymbol() override {return DRAG_PLUGIN_SYMBOL;};
wxString GetDescription() override {return _("Drags mouse from one place to another.");};
bool DefineParams( ShuttleParams & S ) override;
void PopulateOrExchange(ShuttleGui & S) override;

View File

@@ -26,13 +26,13 @@ channel.
class wxMenuBar;
class wxPoint;
#define GET_INFO_PLUGIN_SYMBOL XO("Get Info")
#define GET_INFO_PLUGIN_SYMBOL IdentInterfaceSymbol{ XO("Get Info") }
class GetInfoCommand : public AudacityCommand
{
public:
// CommandDefinitionInterface overrides
wxString GetSymbol() override {return GET_INFO_PLUGIN_SYMBOL;};
IdentInterfaceSymbol GetSymbol() override {return GET_INFO_PLUGIN_SYMBOL;};
wxString GetDescription() override {return _("Gets information in JSON format.");};
bool DefineParams( ShuttleParams & S ) override;
void PopulateOrExchange(ShuttleGui & S) override;

View File

@@ -19,14 +19,14 @@
#include "Command.h"
#include "CommandType.h"
#define GET_TRACK_INFO_PLUGIN_SYMBOL XO("Get Track Info")
#define GET_TRACK_INFO_PLUGIN_SYMBOL IdentInterfaceSymbol{ XO("Get Track Info") }
class GetTrackInfoCommand final : public AudacityCommand
{
public:
GetTrackInfoCommand();
// CommandDefinitionInterface overrides
wxString GetSymbol() override {return GET_TRACK_INFO_PLUGIN_SYMBOL;};
IdentInterfaceSymbol GetSymbol() override {return GET_TRACK_INFO_PLUGIN_SYMBOL;};
wxString GetDescription() override {return _("Gets track values as JSON.");};
bool DefineParams( ShuttleParams & S ) override;
void PopulateOrExchange(ShuttleGui & S) override;

View File

@@ -23,13 +23,13 @@
#include "CommandType.h"
#include "Command.h"
#define HELP_PLUGIN_SYMBOL XO("Help")
#define HELP_PLUGIN_SYMBOL IdentInterfaceSymbol{ XO("Help") }
class HelpCommand : public AudacityCommand
{
public:
// CommandDefinitionInterface overrides
wxString GetSymbol() override {return HELP_PLUGIN_SYMBOL;};
IdentInterfaceSymbol GetSymbol() override {return HELP_PLUGIN_SYMBOL;};
wxString GetDescription() override {return _("Gives help on a command.");};
bool DefineParams( ShuttleParams & S ) override;
void PopulateOrExchange(ShuttleGui & S) override;

View File

@@ -23,13 +23,13 @@
// Import
#define IMPORT_PLUGIN_SYMBOL XO("Import2")
#define IMPORT_PLUGIN_SYMBOL IdentInterfaceSymbol{ XO("Import2") }
class ImportCommand : public AudacityCommand
{
public:
// CommandDefinitionInterface overrides
wxString GetSymbol() override {return IMPORT_PLUGIN_SYMBOL;};
IdentInterfaceSymbol GetSymbol() override {return IMPORT_PLUGIN_SYMBOL;};
wxString GetDescription() override {return _("Imports from a file.");};
bool DefineParams( ShuttleParams & S ) override;
void PopulateOrExchange(ShuttleGui & S) override;
@@ -41,13 +41,13 @@ public:
wxString mFileName;
};
#define EXPORT_PLUGIN_SYMBOL XO("Export2")
#define EXPORT_PLUGIN_SYMBOL IdentInterfaceSymbol{ XO("Export2") }
class ExportCommand : public AudacityCommand
{
public:
// CommandDefinitionInterface overrides
wxString GetSymbol() override {return EXPORT_PLUGIN_SYMBOL;};
IdentInterfaceSymbol GetSymbol() override {return EXPORT_PLUGIN_SYMBOL;};
wxString GetDescription() override {return _("Exports to a file.");};
bool DefineParams( ShuttleParams & S ) override;
void PopulateOrExchange(ShuttleGui & S) override;

View File

@@ -100,7 +100,7 @@ enum
// Redefine COMMAND() to add the COMMAND's name to an array
//
#undef COMMAND
#define COMMAND(n, i, args) n ## _PLUGIN_SYMBOL,
#define COMMAND(n, i, args) (n ## _PLUGIN_SYMBOL).Internal(),
//
// Create the COMMAND name array
@@ -176,12 +176,7 @@ wxString BuiltinCommandsModule::GetPath()
return mPath;
}
wxString BuiltinCommandsModule::GetSymbol()
{
return XO("Builtin Commands");
}
wxString BuiltinCommandsModule::GetName()
IdentInterfaceSymbol BuiltinCommandsModule::GetSymbol()
{
return XO("Builtin Commands");
}

View File

@@ -31,8 +31,7 @@ public:
// IdentInterface implementation
wxString GetPath() override;
wxString GetSymbol() override;
wxString GetName() override;
IdentInterfaceSymbol GetSymbol() override;
IdentInterfaceSymbol GetVendor() override;
wxString GetVersion() override;
wxString GetDescription() override;

View File

@@ -24,13 +24,13 @@
#include "CommandType.h"
#include "Command.h"
#define MESSAGE_PLUGIN_SYMBOL XO("Message")
#define MESSAGE_PLUGIN_SYMBOL IdentInterfaceSymbol{ XO("Message") }
class MessageCommand : public AudacityCommand
{
public:
// CommandDefinitionInterface overrides
wxString GetSymbol() override {return MESSAGE_PLUGIN_SYMBOL;};
IdentInterfaceSymbol GetSymbol() override {return MESSAGE_PLUGIN_SYMBOL;};
wxString GetDescription() override {return _("Echos a message.");};
bool DefineParams( ShuttleParams & S ) override;
void PopulateOrExchange(ShuttleGui & S) override;

View File

@@ -21,13 +21,13 @@
#include "Command.h"
#include "CommandType.h"
#define OPEN_PROJECT_PLUGIN_SYMBOL XO("Open Project2")
#define OPEN_PROJECT_PLUGIN_SYMBOL IdentInterfaceSymbol{ XO("Open Project2") }
class OpenProjectCommand : public AudacityCommand
{
public:
// CommandDefinitionInterface overrides
wxString GetSymbol() override {return OPEN_PROJECT_PLUGIN_SYMBOL;};
IdentInterfaceSymbol GetSymbol() override {return OPEN_PROJECT_PLUGIN_SYMBOL;};
wxString GetDescription() override {return _("Opens a project.");};
bool DefineParams( ShuttleParams & S ) override;
void PopulateOrExchange(ShuttleGui & S) override;
@@ -41,13 +41,13 @@ public:
bool bHasAddToHistory;
};
#define SAVE_PROJECT_PLUGIN_SYMBOL XO("Save Project2")
#define SAVE_PROJECT_PLUGIN_SYMBOL IdentInterfaceSymbol{ XO("Save Project2") }
class SaveProjectCommand : public AudacityCommand
{
public:
// CommandDefinitionInterface overrides
wxString GetSymbol() override {return SAVE_PROJECT_PLUGIN_SYMBOL;};
IdentInterfaceSymbol GetSymbol() override {return SAVE_PROJECT_PLUGIN_SYMBOL;};
wxString GetDescription() override {return _("Saves a project.");};
bool DefineParams( ShuttleParams & S ) override;
void PopulateOrExchange(ShuttleGui & S) override;

View File

@@ -26,14 +26,14 @@
// GetPreference
#define GET_PREFERENCE_PLUGIN_SYMBOL XO("Get Preference")
#define SET_PREFERENCE_PLUGIN_SYMBOL XO("Set Preference")
#define GET_PREFERENCE_PLUGIN_SYMBOL IdentInterfaceSymbol{ XO("Get Preference") }
#define SET_PREFERENCE_PLUGIN_SYMBOL IdentInterfaceSymbol{ XO("Set Preference") }
class GetPreferenceCommand final : public AudacityCommand
{
public:
// CommandDefinitionInterface overrides
wxString GetSymbol() override {return GET_PREFERENCE_PLUGIN_SYMBOL;};
IdentInterfaceSymbol GetSymbol() override {return GET_PREFERENCE_PLUGIN_SYMBOL;};
wxString GetDescription() override {return _("Gets the value of a single preference.");};
bool DefineParams( ShuttleParams & S ) override;
void PopulateOrExchange(ShuttleGui & S) override;
@@ -51,7 +51,7 @@ class SetPreferenceCommand final : public AudacityCommand
{
public:
// CommandDefinitionInterface overrides
wxString GetSymbol() override {return SET_PREFERENCE_PLUGIN_SYMBOL;};
IdentInterfaceSymbol GetSymbol() override {return SET_PREFERENCE_PLUGIN_SYMBOL;};
wxString GetDescription() override {return _("Sets the value of a single preference.");};
bool DefineParams( ShuttleParams & S ) override;
void PopulateOrExchange(ShuttleGui & S) override;

View File

@@ -28,7 +28,7 @@ class AdornedRulerPanel;
class AudacityProject;
class CommandContext;
#define SCREENSHOT_PLUGIN_SYMBOL XO("Screenshot")
#define SCREENSHOT_PLUGIN_SYMBOL IdentInterfaceSymbol{ XO("Screenshot") }
class ScreenshotCommand : public AudacityCommand
{
@@ -80,7 +80,7 @@ public:
ScreenshotCommand(){ mbBringToTop=true;};
// CommandDefinitionInterface overrides
wxString GetSymbol() override {return SCREENSHOT_PLUGIN_SYMBOL;};
IdentInterfaceSymbol GetSymbol() override {return SCREENSHOT_PLUGIN_SYMBOL;};
wxString GetDescription() override {return _("Takes screenshots.");};
bool DefineParams( ShuttleParams & S ) override;
void PopulateOrExchange(ShuttleGui & S) override;

View File

@@ -25,16 +25,16 @@
//#include "../commands/AudacityCommand.h"
#define SELECT_TIME_PLUGIN_SYMBOL XO("Select Time")
#define SELECT_FREQUENCIES_PLUGIN_SYMBOL XO("Select Frequencies")
#define SELECT_TRACKS_PLUGIN_SYMBOL XO("Select Tracks")
#define SELECT_PLUGIN_SYMBOL XO("Select")
#define SELECT_TIME_PLUGIN_SYMBOL IdentInterfaceSymbol{ XO("Select Time") }
#define SELECT_FREQUENCIES_PLUGIN_SYMBOL IdentInterfaceSymbol{ XO("Select Frequencies") }
#define SELECT_TRACKS_PLUGIN_SYMBOL IdentInterfaceSymbol{ XO("Select Tracks") }
#define SELECT_PLUGIN_SYMBOL IdentInterfaceSymbol{ XO("Select") }
class SelectTimeCommand : public AudacityCommand
{
public:
// CommandDefinitionInterface overrides
wxString GetSymbol() override {return SELECT_TIME_PLUGIN_SYMBOL;};
IdentInterfaceSymbol GetSymbol() override {return SELECT_TIME_PLUGIN_SYMBOL;};
wxString GetDescription() override {return _("Selects a time range.");};
bool DefineParams( ShuttleParams & S ) override;
void PopulateOrExchange(ShuttleGui & S) override;
@@ -58,7 +58,7 @@ class SelectFrequenciesCommand : public AudacityCommand
{
public:
// CommandDefinitionInterface overrides
wxString GetSymbol() override {return SELECT_FREQUENCIES_PLUGIN_SYMBOL;};
IdentInterfaceSymbol GetSymbol() override {return SELECT_FREQUENCIES_PLUGIN_SYMBOL;};
wxString GetDescription() override {return _("Selects a frequency range.");};
bool DefineParams( ShuttleParams & S ) override;
void PopulateOrExchange(ShuttleGui & S) override;
@@ -79,7 +79,7 @@ class SelectTracksCommand : public AudacityCommand
{
public:
// CommandDefinitionInterface overrides
wxString GetSymbol() override {return SELECT_TRACKS_PLUGIN_SYMBOL;};
IdentInterfaceSymbol GetSymbol() override {return SELECT_TRACKS_PLUGIN_SYMBOL;};
wxString GetDescription() override {return _("Selects a range of tracks.");};
bool DefineParams( ShuttleParams & S ) override;
void PopulateOrExchange(ShuttleGui & S) override;
@@ -101,7 +101,7 @@ class SelectCommand : public AudacityCommand
{
public:
// CommandDefinitionInterface overrides
wxString GetSymbol() override {return SELECT_PLUGIN_SYMBOL;};
IdentInterfaceSymbol GetSymbol() override {return SELECT_PLUGIN_SYMBOL;};
wxString GetDescription() override {return _("Selects Audio.");};
bool DefineParams( ShuttleParams & S ) override {
return

View File

@@ -20,14 +20,14 @@
#include "CommandType.h"
#include "SetTrackInfoCommand.h"
#define SET_CLIP_PLUGIN_SYMBOL XO("Set Clip")
#define SET_CLIP_PLUGIN_SYMBOL IdentInterfaceSymbol{ XO("Set Clip") }
class SetClipCommand : public SetTrackBase
{
public:
SetClipCommand();
// CommandDefinitionInterface overrides
wxString GetSymbol() override {return SET_CLIP_PLUGIN_SYMBOL;};
IdentInterfaceSymbol GetSymbol() override {return SET_CLIP_PLUGIN_SYMBOL;};
wxString GetDescription() override {return _("Sets various values for a clip.");};
bool DefineParams( ShuttleParams & S ) override;
void PopulateOrExchange(ShuttleGui & S) override;

View File

@@ -20,14 +20,14 @@
#include "CommandType.h"
#include "SetTrackInfoCommand.h"
#define SET_ENVELOPE_PLUGIN_SYMBOL XO("Set Envelope")
#define SET_ENVELOPE_PLUGIN_SYMBOL IdentInterfaceSymbol{ XO("Set Envelope") }
class SetEnvelopeCommand : public SetTrackBase
{
public:
SetEnvelopeCommand();
// CommandDefinitionInterface overrides
wxString GetSymbol() override {return SET_ENVELOPE_PLUGIN_SYMBOL;};
IdentInterfaceSymbol GetSymbol() override {return SET_ENVELOPE_PLUGIN_SYMBOL;};
wxString GetDescription() override {return _("Sets an envelope point position.");};
bool DefineParams( ShuttleParams & S ) override;
void PopulateOrExchange(ShuttleGui & S) override;

View File

@@ -19,14 +19,14 @@
#include "Command.h"
#include "CommandType.h"
#define SET_LABEL_PLUGIN_SYMBOL XO("Set Label")
#define SET_LABEL_PLUGIN_SYMBOL IdentInterfaceSymbol{ XO("Set Label") }
class SetLabelCommand : public AudacityCommand
{
public:
SetLabelCommand();
// CommandDefinitionInterface overrides
wxString GetSymbol() override {return SET_LABEL_PLUGIN_SYMBOL;};
IdentInterfaceSymbol GetSymbol() override {return SET_LABEL_PLUGIN_SYMBOL;};
wxString GetDescription() override {return _("Sets various values for a label.");};
bool DefineParams( ShuttleParams & S ) override;
void PopulateOrExchange(ShuttleGui & S) override;

View File

@@ -20,14 +20,14 @@
#include "Command.h"
#include "CommandType.h"
#define SET_PROJECT_PLUGIN_SYMBOL XO("Set Project")
#define SET_PROJECT_PLUGIN_SYMBOL IdentInterfaceSymbol{ XO("Set Project") }
class SetProjectCommand : public AudacityCommand
{
public:
SetProjectCommand();
// CommandDefinitionInterface overrides
wxString GetSymbol() override {return SET_PROJECT_PLUGIN_SYMBOL;};
IdentInterfaceSymbol GetSymbol() override {return SET_PROJECT_PLUGIN_SYMBOL;};
wxString GetDescription() override {return _("Sets various values for a project.");};
bool DefineParams( ShuttleParams & S ) override;
void PopulateOrExchange(ShuttleGui & S) override;

View File

@@ -20,10 +20,10 @@
#include "Command.h"
#include "CommandType.h"
#define SET_TRACK_PLUGIN_SYMBOL XO("Set Track")
#define SET_TRACK_STATUS_PLUGIN_SYMBOL XO("Set Track Status")
#define SET_TRACK_AUDIO_PLUGIN_SYMBOL XO("Set Track Audio")
#define SET_TRACK_VISUALS_PLUGIN_SYMBOL XO("Set Track Visuals")
#define SET_TRACK_PLUGIN_SYMBOL IdentInterfaceSymbol{ XO("Set Track") }
#define SET_TRACK_STATUS_PLUGIN_SYMBOL IdentInterfaceSymbol{ XO("Set Track Status") }
#define SET_TRACK_AUDIO_PLUGIN_SYMBOL IdentInterfaceSymbol{ XO("Set Track Audio") }
#define SET_TRACK_VISUALS_PLUGIN_SYMBOL IdentInterfaceSymbol{ XO("Set Track Visuals") }
class Track;
@@ -51,7 +51,7 @@ class SetTrackStatusCommand : public SetTrackBase
public:
//SetTrackStatusCommand();
// CommandDefinitionInterface overrides
wxString GetSymbol() override {return SET_TRACK_STATUS_PLUGIN_SYMBOL;};
IdentInterfaceSymbol GetSymbol() override {return SET_TRACK_STATUS_PLUGIN_SYMBOL;};
wxString GetDescription() override {return _("Sets various values for a track.");};
bool DefineParams( ShuttleParams & S ) override;
void PopulateOrExchange(ShuttleGui & S) override;
@@ -76,7 +76,7 @@ class SetTrackAudioCommand : public SetTrackBase
public:
//SetTrackAudioCommand();
// CommandDefinitionInterface overrides
wxString GetSymbol() override {return SET_TRACK_AUDIO_PLUGIN_SYMBOL;};
IdentInterfaceSymbol GetSymbol() override {return SET_TRACK_AUDIO_PLUGIN_SYMBOL;};
wxString GetDescription() override {return _("Sets various values for a track.");};
bool DefineParams( ShuttleParams & S ) override;
void PopulateOrExchange(ShuttleGui & S) override;
@@ -103,7 +103,7 @@ class SetTrackVisualsCommand : public SetTrackBase
public:
//SetTrackVisualsCommand();
// CommandDefinitionInterface overrides
wxString GetSymbol() override {return SET_TRACK_VISUALS_PLUGIN_SYMBOL;};
IdentInterfaceSymbol GetSymbol() override {return SET_TRACK_VISUALS_PLUGIN_SYMBOL;};
wxString GetDescription() override {return _("Sets various values for a track.");};
bool DefineParams( ShuttleParams & S ) override;
void PopulateOrExchange(ShuttleGui & S) override;
@@ -140,7 +140,7 @@ class SetTrackCommand : public SetTrackBase
public:
SetTrackCommand();
// CommandDefinitionInterface overrides
wxString GetSymbol() override {return SET_TRACK_PLUGIN_SYMBOL;};
IdentInterfaceSymbol GetSymbol() override {return SET_TRACK_PLUGIN_SYMBOL;};
wxString GetDescription() override {return _("Sets various values for a track.");};
// AudacityCommand overrides
wxString ManualPage() override {return wxT("Extra_Menu:_Tools#set_track");};