Autres/audacity
1
0
Fork 0
mirror of https://github.com/cookiengineer/audacity synced 2025-06-16 08:09:32 +02:00
Code Issues Releases Wiki Activity

Move command functors to a new header file, and generalize with templates...

Browse Source 
... so that member functions of other than AudacityProject may be called.

Will use this new generality soon for scrubbing menu items.
This commit is contained in:
Paul Licameli 2016-04-23 00:50:27 -04:00 committed by Paul Licameli
parent 8667f23ed5
commit 367b2c1011
7 changed files with 169 additions and 111 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

56
mac/Audacity.xcodeproj/project.pbxproj
View File

@ -2971,6 +2971,7 @@
28FE4A060ABF4E960056F5C4 /* mmx_optimized.cpp */ = {isa = PBXFileReference; fileEncoding = 5; indentWidth = 3; lastKnownFileType = sourcecode.cpp.cpp; path = mmx_optimized.cpp; sourceTree = "<group>"; tabWidth = 3; };
28FE4A070ABF4E960056F5C4 /* sse_optimized.cpp */ = {isa = PBXFileReference; fileEncoding = 5; indentWidth = 3; lastKnownFileType = sourcecode.cpp.cpp; path = sse_optimized.cpp; sourceTree = "<group>"; tabWidth = 3; };
28FEC1B21A12B6FB00FACE48 /* EffectAutomationParameters.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = EffectAutomationParameters.h; path = ../include/audacity/EffectAutomationParameters.h; sourceTree = SOURCE_ROOT; };
5E4685F81CCA9D84008741F2 /* CommandFunctors.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = CommandFunctors.h; sourceTree = "<group>"; };
5E61EE0C1CBAA6BB0009FCF1 /* MemoryX.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = MemoryX.h; sourceTree = "<group>"; };
5E74D2D61CC4425D00D88B0B /* TrackPanelOverlay.cpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.cpp; path = TrackPanelOverlay.cpp; sourceTree = "<group>"; };
5E74D2D71CC4425D00D88B0B /* TrackPanelOverlay.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = TrackPanelOverlay.h; sourceTree = "<group>"; };
@ -3569,58 +3570,59 @@
isa = PBXGroup;
children = (
28D53FFA0FD1912A00FA7C75 /* AppCommandEvent.cpp */,
28D53FFB0FD1912A00FA7C75 /* AppCommandEvent.h */,
28BD8AA9101DF4C600686679 /* BatchEvalCommand.cpp */,
28D53FFC0FD1912A00FA7C75 /* BatchEvalCommand.h */,
28851F9C1027F16400152EE1 /* Command.cpp */,
28D53FFD0FD1912A00FA7C75 /* Command.h */,
28D53FFE0FD1912A00FA7C75 /* CommandBuilder.cpp */,
28D53FFF0FD1912A00FA7C75 /* CommandBuilder.h */,
28BD8AAA101DF4C600686679 /* CommandDirectory.cpp */,
28BD8AAB101DF4C600686679 /* CommandDirectory.h */,
28D540000FD1912A00FA7C75 /* CommandHandler.cpp */,
28D540010FD1912A00FA7C75 /* CommandHandler.h */,
174D9026098C78AF00D5909F /* CommandManager.cpp */,
174D9027098C78AF00D5909F /* CommandManager.h */,
1818558F0FFE916C0026D190 /* CommandMisc.h */,
28851F9D1027F16400152EE1 /* CommandSignature.cpp */,
28851F9E1027F16400152EE1 /* CommandSignature.h */,
28851F9F1027F16400152EE1 /* CommandType.cpp */,
28851FA01027F16400152EE1 /* CommandType.h */,
181855900FFE916C0026D190 /* CommandTargets.h */,
28851FA11027F16400152EE1 /* CompareAudioCommand.cpp */,
28851FA21027F16400152EE1 /* CompareAudioCommand.h */,
28BD8AAC101DF4C600686679 /* ExecMenuCommand.cpp */,
28BD8AAD101DF4C600686679 /* ExecMenuCommand.h */,
28BD8AAE101DF4C600686679 /* GetAllMenuCommands.cpp */,
28BD8AAF101DF4C600686679 /* GetAllMenuCommands.h */,
284249EA10D337CE004330A6 /* GetProjectInfoCommand.cpp */,
284249EB10D337CE004330A6 /* GetProjectInfoCommand.h */,
28851FA31027F16400152EE1 /* GetTrackInfoCommand.cpp */,
28851FA41027F16400152EE1 /* GetTrackInfoCommand.h */,
28851FA51027F16400152EE1 /* HelpCommand.cpp */,
28851FA61027F16400152EE1 /* HelpCommand.h */,
EDD94ED9103CB520000873F1 /* ImportExportCommands.cpp */,
EDD94EDA103CB520000873F1 /* ImportExportCommands.h */,
174D902A098C78AF00D5909F /* Keyboard.cpp */,
174D902B098C78AF00D5909F /* Keyboard.h */,
28851FA71027F16400152EE1 /* MessageCommand.cpp */,
28851FA81027F16400152EE1 /* MessageCommand.h */,
EDFCEB9A18894AE600C98E51 /* OpenSaveCommands.cpp */,
EDFCEB9B18894AE600C98E51 /* OpenSaveCommands.h */,
28DE72AA10388583007E18EC /* PreferenceCommands.cpp */,
28DE72AB10388583007E18EC /* PreferenceCommands.h */,
28DB34770FDC2C5D0011F589 /* ResponseQueue.h */,
28DB34780FDC2C5D0011F589 /* ResponseQueue.cpp */,
181855950FFE916C0026D190 /* ScreenshotCommand.cpp */,
181855960FFE916C0026D190 /* ScreenshotCommand.h */,
28D540030FD1912A00FA7C75 /* ScriptCommandRelay.cpp */,
28D540040FD1912A00FA7C75 /* ScriptCommandRelay.h */,
28851FA91027F16400152EE1 /* SelectCommand.cpp */,
28851FAA1027F16400152EE1 /* SelectCommand.h */,
284249EC10D337CE004330A6 /* SetProjectInfoCommand.cpp */,
284249ED10D337CE004330A6 /* SetProjectInfoCommand.h */,
28DE72AC10388583007E18EC /* SetTrackInfoCommand.cpp */,
28D53FFB0FD1912A00FA7C75 /* AppCommandEvent.h */,
28D53FFC0FD1912A00FA7C75 /* BatchEvalCommand.h */,
28D53FFD0FD1912A00FA7C75 /* Command.h */,
28D53FFF0FD1912A00FA7C75 /* CommandBuilder.h */,
28BD8AAB101DF4C600686679 /* CommandDirectory.h */,
5E4685F81CCA9D84008741F2 /* CommandFunctors.h */,
28D540010FD1912A00FA7C75 /* CommandHandler.h */,
174D9027098C78AF00D5909F /* CommandManager.h */,
1818558F0FFE916C0026D190 /* CommandMisc.h */,
28851F9E1027F16400152EE1 /* CommandSignature.h */,
181855900FFE916C0026D190 /* CommandTargets.h */,
28851FA01027F16400152EE1 /* CommandType.h */,
28851FA21027F16400152EE1 /* CompareAudioCommand.h */,
28BD8AAD101DF4C600686679 /* ExecMenuCommand.h */,
28BD8AAF101DF4C600686679 /* GetAllMenuCommands.h */,
284249EB10D337CE004330A6 /* GetProjectInfoCommand.h */,
28851FA41027F16400152EE1 /* GetTrackInfoCommand.h */,
28851FA61027F16400152EE1 /* HelpCommand.h */,
EDD94EDA103CB520000873F1 /* ImportExportCommands.h */,
174D902B098C78AF00D5909F /* Keyboard.h */,
28851FA81027F16400152EE1 /* MessageCommand.h */,
EDFCEB9B18894AE600C98E51 /* OpenSaveCommands.h */,
28DE72AB10388583007E18EC /* PreferenceCommands.h */,
28DB34770FDC2C5D0011F589 /* ResponseQueue.h */,
181855960FFE916C0026D190 /* ScreenshotCommand.h */,
28D540040FD1912A00FA7C75 /* ScriptCommandRelay.h */,
28851FAA1027F16400152EE1 /* SelectCommand.h */,
284249ED10D337CE004330A6 /* SetProjectInfoCommand.h */,
28DE72AD10388583007E18EC /* SetTrackInfoCommand.h */,
28BD8AB0101DF4C600686679 /* Validators.h */,
);

1
src/Makefile.am
View File

@ -263,6 +263,7 @@ audacity_SOURCES = \
commands/CommandBuilder.h \
commands/CommandDirectory.cpp \
commands/CommandDirectory.h \
commands/CommandFunctors.h \
commands/CommandHandler.cpp \
commands/CommandHandler.h \
commands/CommandManager.cpp \

71
src/Menus.cpp
View File

@ -158,76 +158,7 @@ enum {
POST_TIMER_RECORD_SHUTDOWN
};
// Define functor subclasses that dispatch to the correct call sequence on
// member functions of AudacityProject
using audCommandFunction = void (AudacityProject::*)();
class VoidFunctor final : public CommandFunctor
{
public:
explicit VoidFunctor(AudacityProject *project, audCommandFunction pfn)
: mProject{ project }, mCommandFunction{ pfn } {}
void operator () (int, const wxEvent *) override
{ (mProject->*mCommandFunction) (); }
private:
AudacityProject *const mProject;
const audCommandFunction mCommandFunction;
};
using audCommandKeyFunction = void (AudacityProject::*)(const wxEvent *);
class KeyFunctor final : public CommandFunctor
{
public:
explicit KeyFunctor(AudacityProject *project, audCommandKeyFunction pfn)
: mProject{ project }, mCommandKeyFunction{ pfn } {}
void operator () (int, const wxEvent *evt) override
{ (mProject->*mCommandKeyFunction) (evt); }
private:
AudacityProject *const mProject;
const audCommandKeyFunction mCommandKeyFunction;
};
using audCommandListFunction = void (AudacityProject::*)(int);
class ListFunctor final : public CommandFunctor
{
public:
explicit ListFunctor(AudacityProject *project, audCommandListFunction pfn)
: mProject{ project }, mCommandListFunction{ pfn } {}
void operator () (int index, const wxEvent *) override
{ (mProject->*mCommandListFunction)(index); }
private:
AudacityProject *const mProject;
const audCommandListFunction mCommandListFunction;
};
using audCommandPluginFunction = bool (AudacityProject::*)(const PluginID &, int);
class PluginFunctor final : public CommandFunctor
{
public:
explicit PluginFunctor(AudacityProject *project, const PluginID &id, audCommandPluginFunction pfn)
: mPluginID{ id }, mProject{ project }, mCommandPluginFunction{ pfn } {}
void operator () (int, const wxEvent *) override
{ (mProject->*mCommandPluginFunction) (mPluginID, AudacityProject::OnEffectFlags::kNone); }
private:
const PluginID mPluginID;
AudacityProject *const mProject;
const audCommandPluginFunction mCommandPluginFunction;
};
// Now define an overloaded factory function
inline CommandFunctorPointer MakeFunctor(AudacityProject *project, audCommandFunction pfn)
{ return CommandFunctorPointer{ safenew VoidFunctor{ project, pfn } }; }
inline CommandFunctorPointer MakeFunctor(AudacityProject *project, audCommandKeyFunction pfn)
{ return CommandFunctorPointer{ safenew KeyFunctor{ project, pfn } }; }
inline CommandFunctorPointer MakeFunctor(AudacityProject *project, audCommandListFunction pfn)
{ return CommandFunctorPointer{ safenew ListFunctor{ project, pfn } }; }
inline CommandFunctorPointer MakeFunctor(AudacityProject *project, const PluginID &id, audCommandPluginFunction pfn)
{ return CommandFunctorPointer{ safenew PluginFunctor{ project, id, pfn } }; }
// Now define the macro abbreviations that call the factory
#define FN(X) (MakeFunctor(this, &AudacityProject:: X ))
#define FNS(X, S) (MakeFunctor(this, (S), &AudacityProject:: X ))
#include "commands/CommandFunctors.h"
//
// Effects menu arrays
//

128
src/commands/CommandFunctors.h Normal file
View File

@ -0,0 +1,128 @@
//
// CommandFunctors.h
// Audacity
//
// Created by Paul Licameli on 4/22/16.
//
//
#ifndef __AUDACITY_COMMAND_FUNCTORS__
#define __AUDACITY_COMMAND_FUNCTORS__
#include <wx/string.h>
#include "../MemoryX.h"
class wxEvent;
typedef wxString PluginID;
class AUDACITY_DLL_API CommandFunctor /* not final */
{
public:
CommandFunctor(){};
virtual ~CommandFunctor(){};
virtual void operator()(int index, const wxEvent *e) = 0;
};
using CommandFunctorPointer = std::shared_ptr <CommandFunctor>;
// Define functor subclasses that dispatch to the correct call sequence on
// member functions of AudacityProject (or other class!)
template<typename THIS>
using audCommandFunction = void (THIS::*)();
template<typename THIS>
class VoidFunctor final : public CommandFunctor
{
public:
explicit VoidFunctor(THIS *This, audCommandFunction<THIS> pfn)
: mThis{ This }, mCommandFunction{ pfn } {}
void operator () (int, const wxEvent *) override
{ (mThis->*mCommandFunction) (); }
private:
THIS *const mThis;
const audCommandFunction<THIS> mCommandFunction;
};
template<typename THIS>
using audCommandKeyFunction = void (THIS::*)(const wxEvent *);
template<typename THIS>
class KeyFunctor final : public CommandFunctor
{
public:
explicit KeyFunctor(THIS *This, audCommandKeyFunction<THIS> pfn)
: mThis{ This }, mCommandKeyFunction{ pfn } {}
void operator () (int, const wxEvent *evt) override
{ (mThis->*mCommandKeyFunction) (evt); }
private:
THIS *const mThis;
const audCommandKeyFunction<THIS> mCommandKeyFunction;
};
template<typename THIS>
using audCommandListFunction = void (THIS::*)(int);
template<typename THIS>
class ListFunctor final : public CommandFunctor
{
public:
explicit ListFunctor(THIS *This, audCommandListFunction<THIS> pfn)
: mThis{ This }, mCommandListFunction{ pfn } {}
void operator () (int index, const wxEvent *) override
{ (mThis->*mCommandListFunction)(index); }
private:
THIS *const mThis;
const audCommandListFunction<THIS> mCommandListFunction;
};
template<typename THIS>
using audCommandPluginFunction = bool (THIS::*)(const PluginID &, int);
template<typename THIS>
class PluginFunctor final : public CommandFunctor
{
public:
explicit PluginFunctor(THIS *This, const PluginID &id, audCommandPluginFunction<THIS> pfn)
: mPluginID{ id }, mThis{ This }, mCommandPluginFunction{ pfn } {}
void operator () (int, const wxEvent *) override
{ (mThis->*mCommandPluginFunction)
(mPluginID,
0 // AudacityProject::OnEffectFlags::kNone
); }
private:
const PluginID mPluginID;
THIS *const mThis;
const audCommandPluginFunction<THIS> mCommandPluginFunction;
};
// Now define an overloaded factory function
template<typename THIS>
inline CommandFunctorPointer MakeFunctor(THIS *This,
audCommandFunction<THIS> pfn)
{ return CommandFunctorPointer{ safenew VoidFunctor<THIS>{ This, pfn } }; }
template<typename THIS>
inline CommandFunctorPointer MakeFunctor(THIS *This,
audCommandKeyFunction<THIS> pfn)
{ return CommandFunctorPointer{ safenew KeyFunctor<THIS>{ This, pfn } }; }
template<typename THIS>
inline CommandFunctorPointer MakeFunctor(THIS *This,
audCommandListFunction<THIS> pfn)
{ return CommandFunctorPointer{ safenew ListFunctor<THIS>{ This, pfn } }; }
template<typename THIS>
inline CommandFunctorPointer MakeFunctor(THIS *This, const PluginID &id,
audCommandPluginFunction<THIS> pfn)
{ return CommandFunctorPointer{ safenew PluginFunctor<THIS>{ This, id, pfn } }; }
// Now define the macro abbreviations that call the factory
#define FNT(THIS, This, X) (MakeFunctor<THIS>(This, X ))
#define FNTS(THIS, This, X, S) (MakeFunctor<THIS>(This, (S), X ))
#define FN(X) FNT(AudacityProject, this, & AudacityProject :: X)
#define FNS(X, S) FNTS(AudacityProject, this, & AudacityProject :: X, S)
#endif

12
src/commands/CommandManager.h
View File

@ -14,6 +14,8 @@
#include "../Experimental.h"
#include "CommandFunctors.h"
#include "../MemoryX.h"
#include <vector>
#include <wx/string.h>
@ -26,14 +28,6 @@
#include "audacity/Types.h"
class AUDACITY_DLL_API CommandFunctor /* not final */
{
public:
CommandFunctor(){};
virtual ~CommandFunctor(){};
virtual void operator()(int index, const wxEvent *e) = 0;
};
struct MenuBarListEntry
{
MenuBarListEntry(const wxString &name_, wxMenuBar *menubar_)
@ -54,8 +48,6 @@ struct SubMenuListEntry
wxMenu *menu;
};
using CommandFunctorPointer = std::shared_ptr <CommandFunctor>;
struct CommandListEntry
{
int id;

5
win/Projects/Audacity/Audacity.vcxproj
View File

@ -1,4 +1,4 @@
<?xml version="1.0" encoding="utf-8"?>
<?xml version="1.0" encoding="utf-8"?>
<Project DefaultTargets="Build" ToolsVersion="12.0" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
<ItemGroup Label="ProjectConfigurations">
<ProjectConfiguration Include="Debug|Win32">
@ -414,6 +414,7 @@
<ClInclude Include="..\..\..\src\BatchProcessDialog.h" />
<ClInclude Include="..\..\..\src\Benchmark.h" />
<ClInclude Include="..\..\..\src\BlockFile.h" />
<ClInclude Include="..\..\..\src\commands\CommandFunctors.h" />
<ClInclude Include="..\..\..\src\commands\OpenSaveCommands.h" />
<ClInclude Include="..\..\..\src\DeviceChange.h" />
<ClInclude Include="..\..\..\src\Diags.h" />
@ -1107,4 +1108,4 @@
<ImportGroup Label="ExtensionTargets">
<Import Project="..\..\ny.targets" />
</ImportGroup>
</Project>
</Project>

7
win/Projects/Audacity/Audacity.vcxproj.filters
View File

@ -1,4 +1,4 @@
<?xml version="1.0" encoding="utf-8"?>
<?xml version="1.0" encoding="utf-8"?>
<Project ToolsVersion="4.0" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
<ItemGroup>
<Filter Include="src">
@ -1768,6 +1768,9 @@
<ClInclude Include="..\..\..\src\TrackPanelCellIterator.h">
<Filter>src</Filter>
</ClInclude>
<ClInclude Include="..\..\..\src\commands\CommandFunctors.h">
<Filter>src\commands</Filter>
</ClInclude>
</ItemGroup>
<ItemGroup>
<Image Include="..\..\audacity.ico">
@ -1988,4 +1991,4 @@
<Filter>plug-ins</Filter>
</copy>
</ItemGroup>
</Project>
</Project>