CommandManager can move to toolkit-neutral libraries!

Paul-Licameli · Nov 10, 2023 · 2b49b0e · 2b49b0e
1 parent 0c8db49
commit 2b49b0e
Show file tree

Hide file tree

Showing 34 changed files with 43 additions and 44 deletions.
diff --git a/libraries/lib-menus/CMakeLists.txt b/libraries/lib-menus/CMakeLists.txt
@@ -2,10 +2,11 @@
 Vocabulary to describe toolbar menu items, their grouping, conditions to enable
 them, and their actions.
 
-A global registry of menu descriptions and a visitor function.
+A global MenuRegistry of menu descriptions and a visitor function.
 
-It does not contain a visitor to build menus, becuase that is not
-toolkit-neutral.
+A per-project CommandManager with a nested Populator type that visits the
+registry, and can build menus, if a subclass overrides certain virtual functions
+appropriately for the UI toolkit.
 ]]
 
 set(SOURCES
@@ -14,6 +15,8 @@ set(SOURCES
    CommandFlag.cpp
    CommandFlag.h
    CommandFunctors.h
+   CommandManager.cpp
+   CommandManager.h
    CommandTargets.cpp
    CommandTargets.h
    Keyboard.cpp
@@ -23,7 +26,7 @@ set(SOURCES
 )
 
 set( LIBRARIES
-   lib-project-interface
+   lib-project-history-interface
 )
 
 audacity_library(lib-menus "${SOURCES}" "${LIBRARIES}"

diff --git a/src/commands/CommandManager.cpp → libraries/lib-menus/CommandManager.cpp b/src/commands/CommandManager.cpp → libraries/lib-menus/CommandManager.cpp
@@ -62,8 +62,6 @@ CommandManager.  It holds the callback for one command.
 #include "BasicUI.h"
 #include "Project.h"
 #include "ProjectHistory.h"
-#include "AudacityMessageBox.h"
-#include "HelpSystem.h"
 #include "UndoManager.h"
 
 #include <cassert>

diff --git a/src/commands/CommandManager.h → libraries/lib-menus/CommandManager.h b/src/commands/CommandManager.h → libraries/lib-menus/CommandManager.h
@@ -46,7 +46,7 @@ class CommandContext;
 //! Sent when menus update (such as for changing enablement of items)
 struct MenuUpdateMessage {};
 
-class AUDACITY_DLL_API CommandManager /* not final */
+class MENUS_API CommandManager /* not final */
    : public XMLTagHandler
    , public ClientData::Base
    , public Observer::Publisher<MenuUpdateMessage>
@@ -67,7 +67,7 @@ class AUDACITY_DLL_API CommandManager /* not final */
 
    // Interception of menu item handling.
    // If it returns true, bypass the usual dispatch of commands.
-   struct AUDACITY_DLL_API GlobalMenuHook : GlobalHook<GlobalMenuHook,
+   struct MENUS_API GlobalMenuHook : GlobalHook<GlobalMenuHook,
       bool(const CommandID&)
    >{};
 
@@ -119,7 +119,7 @@ class AUDACITY_DLL_API CommandManager /* not final */
 
    void PurgeData();
 
-   struct AUDACITY_DLL_API Populator
+   struct MENUS_API Populator
       : MenuRegistry::Visitor<MenuRegistry::Traits>
    {
       using LeafVisitor = std::function<
@@ -373,7 +373,7 @@ class AUDACITY_DLL_API CommandManager /* not final */
    AudacityProject &mProject;
 
 public:
-   struct CommandListEntry
+   struct MENUS_API CommandListEntry
    {
       static wxString FormatLabelForMenu(
          const TranslatableString &translatableLabel,

diff --git a/modules/mod-nyq-bench/NyqBench.h b/modules/mod-nyq-bench/NyqBench.h
@@ -17,7 +17,7 @@
 #include <ostream>
 #include <sstream>
 
-#include "commands/CommandManager.h"
+#include "CommandManager.h"
 #include "effects/nyquist/Nyquist.h"
 
 class wxFileName;

diff --git a/src/BatchCommands.cpp b/src/BatchCommands.cpp
@@ -46,7 +46,7 @@ processing.  See also MacrosWindow and ApplyMacroDialog.
 
 #include "CommandContext.h"
 #include "commands/CommandDispatch.h"
-#include "commands/CommandManager.h"
+#include "CommandManager.h"
 
 MacroCommands::MacroCommands( AudacityProject &project )
 : mProject{ project }

diff --git a/src/BatchProcessDialog.cpp b/src/BatchProcessDialog.cpp
@@ -44,7 +44,7 @@
 #include "ProjectWindow.h"
 #include "SelectUtilities.h"
 #include "Track.h"
-#include "commands/CommandManager.h"
+#include "CommandManager.h"
 #include "Effect.h"
 #include "effects/EffectUI.h"
 #include "../images/Arrow.xpm"

diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt
@@ -258,8 +258,6 @@ list( APPEND SOURCES
       commands/CommandDispatch.h
       commands/CommandHandler.cpp
       commands/CommandHandler.h
-      commands/CommandManager.cpp
-      commands/CommandManager.h
       commands/CommandManagerWindowClasses.cpp
       commands/CommandManagerWindowClasses.h
       commands/CommandMisc.h

diff --git a/src/FreqWindow.cpp b/src/FreqWindow.cpp
@@ -1220,7 +1220,7 @@ void FreqPlot::OnMouseEvent(wxMouseEvent & event)
 
 // Remaining code hooks this add-on into the application
 #include "CommandContext.h"
-#include "commands/CommandManager.h"
+#include "CommandManager.h"
 #include "ProjectWindows.h"
 
 namespace {

diff --git a/src/MenuCreator.h b/src/MenuCreator.h
@@ -13,7 +13,7 @@
 #define __AUDACITY_MENU_CREATOR__
 
 #include "Callable.h"
-#include "commands/CommandManager.h"
+#include "CommandManager.h"
 
 class AUDACITY_DLL_API MenuCreator final : public CommandManager
 {

diff --git a/src/ProjectAudioManager.cpp b/src/ProjectAudioManager.cpp
@@ -19,7 +19,7 @@ Paul Licameli split from ProjectManager.cpp
 
 #include "AudioIO.h"
 #include "BasicUI.h"
-#include "commands/CommandManager.h"
+#include "CommandManager.h"
 #include "CommonCommandFlags.h"
 #include "DefaultPlaybackPolicy.h"
 #include "Meter.h"

diff --git a/src/ProjectWindow.cpp b/src/ProjectWindow.cpp
@@ -26,7 +26,7 @@ Paul Licameli split from AudacityProject.cpp
 #include "WaveClip.h"
 #include "WaveTrack.h"
 #include "CommandContext.h"
-#include "commands/CommandManager.h"
+#include "CommandManager.h"
 #include "prefs/ThemePrefs.h"
 #include "prefs/TracksPrefs.h"
 #include "toolbars/ToolManager.h"

diff --git a/src/Screenshot.cpp b/src/Screenshot.cpp
@@ -814,7 +814,7 @@ void ScreenshotBigDialog::UpdatePrefs()
 }
 
 #include "CommonCommandFlags.h"
-#include "commands/CommandManager.h"
+#include "CommandManager.h"
 
 namespace {
 void OnScreenshot(const CommandContext &context )

diff --git a/src/SelectUtilities.cpp b/src/SelectUtilities.cpp
@@ -30,7 +30,7 @@
 #include "ViewInfo.h"
 #include "WaveTrack.h"
 
-#include "commands/CommandManager.h"
+#include "CommandManager.h"
 
 namespace {
 

diff --git a/src/SpectralDataDialog.cpp b/src/SpectralDataDialog.cpp
@@ -42,7 +42,7 @@
 #include "ClientData.h"
 #include "Clipboard.h"
 #include "CommandContext.h"
-#include "commands/CommandManager.h"
+#include "CommandManager.h"
 #include "UndoManager.h"
 #include "Prefs.h"
 #include "Project.h"

diff --git a/src/commands/ScreenshotCommand.cpp b/src/commands/ScreenshotCommand.cpp
@@ -44,7 +44,7 @@ small calculations of rectangles.
 #include "Track.h"
 #include "../widgets/VetoDialogHook.h"
 #include "CommandContext.h"
-#include "commands/CommandManager.h"
+#include "CommandManager.h"
 #include "CommandDispatch.h"
 #include "../CommonCommandFlags.h"
 

diff --git a/src/effects/Contrast.cpp b/src/effects/Contrast.cpp
@@ -652,7 +652,7 @@ void ContrastDialog::OnReset(wxCommandEvent & /*event*/)
 
 // Remaining code hooks this add-on into the application
 #include "CommandContext.h"
-#include "commands/CommandManager.h"
+#include "CommandManager.h"
 #include "ProjectWindows.h"
 
 namespace {

diff --git a/src/effects/EffectUI.cpp b/src/effects/EffectUI.cpp
@@ -19,7 +19,7 @@
 #include "AllThemeResources.h"
 #include "widgets/BasicMenu.h"
 #include "BasicUI.h"
-#include "../commands/CommandManager.h"
+#include "CommandManager.h"
 #include "ConfigInterface.h"
 #include "EffectManager.h"
 #include "PluginManager.h"
@@ -1135,7 +1135,7 @@ DialogFactoryResults EffectUI::DialogFactory(wxWindow &parent,
 #include "../SelectUtilities.h"
 #include "../TrackPanel.h"
 #include "WaveTrack.h"
-#include "../commands/CommandManager.h"
+#include "CommandManager.h"
 
 /// DoEffect() takes a PluginID and executes the associated effect.
 ///

diff --git a/src/menus/PluginMenus.cpp b/src/menus/PluginMenus.cpp
@@ -23,7 +23,7 @@
 #include "TempDirectory.h"
 #include "UndoManager.h"
 #include "CommandContext.h"
-#include "../commands/CommandManager.h"
+#include "CommandManager.h"
 #include "../effects/EffectManager.h"
 #include "../effects/EffectUI.h"
 #include "RealtimeEffectManager.h"

diff --git a/src/menus/TimelineMenus.cpp b/src/menus/TimelineMenus.cpp
@@ -12,7 +12,7 @@
 
 #include "Project.h"
 
-#include "../commands/CommandManager.h"
+#include "CommandManager.h"
 #include "CommandContext.h"
 
 namespace

diff --git a/src/menus/ViewMenus.cpp b/src/menus/ViewMenus.cpp
@@ -11,7 +11,7 @@
 #include "UndoManager.h"
 #include "ViewInfo.h"
 #include "CommandContext.h"
-#include "../commands/CommandManager.h"
+#include "CommandManager.h"
 #include "../prefs/GUIPrefs.h"
 #include "../prefs/TracksPrefs.h"
 #include "../tracks/ui/ChannelView.h"

diff --git a/src/prefs/PrefsDialog.cpp b/src/prefs/PrefsDialog.cpp
@@ -33,7 +33,7 @@
 #include "Prefs.h"
 #include "ProjectWindows.h"
 #include "ShuttleGui.h"
-#include "../commands/CommandManager.h"
+#include "CommandManager.h"
 
 #include "PrefsPanel.h"
 

diff --git a/src/toolbars/CutCopyPasteToolBar.cpp b/src/toolbars/CutCopyPasteToolBar.cpp
@@ -53,7 +53,7 @@
 #include "../widgets/AButton.h"
 
 #include "CommandContext.h"
-#include "../commands/CommandManager.h"
+#include "CommandManager.h"
 #include "../commands/CommandDispatch.h"
 
 #include "ToolManager.h"

diff --git a/src/toolbars/EditToolBar.cpp b/src/toolbars/EditToolBar.cpp
@@ -52,7 +52,7 @@
 #include "../widgets/AButton.h"
 
 #include "CommandContext.h"
-#include "../commands/CommandManager.h"
+#include "CommandManager.h"
 #include "../commands/CommandDispatch.h"
 
 enum {

diff --git a/src/toolbars/ToolBar.cpp b/src/toolbars/ToolBar.cpp
@@ -48,7 +48,7 @@ in which buttons can be placed.
 #include "AColor.h"
 #include "ImageManipulation.h"
 #include "Project.h"
-#include "../commands/CommandManager.h"
+#include "CommandManager.h"
 #include "../widgets/AButton.h"
 #include "../widgets/Grabber.h"
 #include "Prefs.h"

diff --git a/src/toolbars/ToolBarButtons.cpp b/src/toolbars/ToolBarButtons.cpp
@@ -19,7 +19,7 @@
 #include "Project.h"
 
 #include "CommandContext.h"
-#include "../commands/CommandManager.h"
+#include "CommandManager.h"
 #include "../commands/CommandDispatch.h"
 
 // flags so 1,2,4,8 etc.

diff --git a/src/toolbars/ToolManager.cpp b/src/toolbars/ToolManager.cpp
@@ -50,7 +50,7 @@
 
 #include "AColor.h"
 #include "AllThemeResources.h"
-#include "commands/CommandManager.h"
+#include "CommandManager.h"
 #include "ImageManipulation.h"
 #include "Prefs.h"
 #include "Project.h"
@@ -1538,7 +1538,7 @@ void ToolManager::ModifyAllProjectToolbarMenus()
    }
 }
 
-#include "../commands/CommandManager.h"
+#include "CommandManager.h"
 void ToolManager::ModifyToolbarMenus(AudacityProject &project)
 {
    // Refreshes can occur during shutdown and the toolmanager may already

diff --git a/src/tracks/playabletrack/ui/PlayableTrackButtonHandles.cpp b/src/tracks/playabletrack/ui/PlayableTrackButtonHandles.cpp
@@ -10,7 +10,7 @@ Paul Licameli split from TrackPanel.cpp
 #include "PlayableTrackButtonHandles.h"
 #include "PlayableTrack.h"
 #include "PlayableTrackControls.h"
-#include "../../../commands/CommandManager.h"
+#include "CommandManager.h"
 #include "Project.h"
 #include "../../../RefreshCode.h"
 #include "../../../RealtimeEffectPanel.h"

diff --git a/src/tracks/ui/CommonTrackControls.cpp b/src/tracks/ui/CommonTrackControls.cpp
@@ -24,7 +24,7 @@ Paul Licameli split from TrackControls.cpp
 #include "../../TrackUtilities.h"
 #include <wx/textdlg.h>
 #include "../../commands/AudacityCommand.h"
-#include "../../commands/CommandManager.h"
+#include "CommandManager.h"
 #include "ShuttleGui.h"
 #include "Track.h"
 #include "../../widgets/PopupMenuTable.h"

diff --git a/src/tracks/ui/CommonTrackPanelCell.cpp b/src/tracks/ui/CommonTrackPanelCell.cpp
@@ -17,7 +17,7 @@ Paul Licameli split from TrackPanel.cpp
 #include "../../widgets/BasicMenu.h"
 #include "BasicUI.h"
 #include "CommandContext.h"
-#include "../../commands/CommandManager.h"
+#include "CommandManager.h"
 #include "../../HitTestResult.h"
 #include "../../RefreshCode.h"
 #include "../../TrackPanelMouseEvent.h"

diff --git a/src/tracks/ui/Scrubbing.cpp b/src/tracks/ui/Scrubbing.cpp
@@ -14,7 +14,7 @@ Paul Licameli split from TrackPanel.cpp
 #include <functional>
 
 #include "AudioIO.h"
-#include "commands/CommandManager.h"
+#include "CommandManager.h"
 #include "../../CommonCommandFlags.h"
 #include "Project.h"
 #include "ProjectAudioIO.h"

diff --git a/src/tracks/ui/SelectHandle.cpp b/src/tracks/ui/SelectHandle.cpp
@@ -15,7 +15,7 @@ Paul Licameli split from TrackPanel.cpp
 #include "ChannelView.h"
 
 #include "AColor.h"
-#include "commands/CommandManager.h"
+#include "CommandManager.h"
 #include "../../SpectrumAnalyst.h"
 #include "../../LabelTrack.h"
 #include "NumberScale.h"

diff --git a/src/tracks/ui/TrackButtonHandles.cpp b/src/tracks/ui/TrackButtonHandles.cpp
@@ -22,7 +22,7 @@ Paul Licameli split from TrackPanel.cpp
 #include "../../TrackInfo.h"
 #include "../../TrackPanel.h"
 #include "../../TrackUtilities.h"
-#include "../../commands/CommandManager.h"
+#include "CommandManager.h"
 #include "../../tracks/ui/ChannelView.h"
 
 MinimizeButtonHandle::MinimizeButtonHandle

diff --git a/src/widgets/KeyView.cpp b/src/widgets/KeyView.cpp
@@ -21,7 +21,7 @@
 
 #include "AColor.h"
 #include "ShuttleGui.h"
-#include "../commands/CommandManager.h"
+#include "CommandManager.h"
 
 #include <wx/dc.h>
 #include <wx/menu.h>

diff --git a/src/widgets/PopupMenuTable.h b/src/widgets/PopupMenuTable.h
@@ -26,7 +26,7 @@ class wxCommandEvent;
 #include <memory>
 
 #include "Internat.h"
-#include "../commands/CommandManager.h"
+#include "CommandManager.h"
 
 class PopupMenuHandler;
 struct PopupMenuSection;