Merge pull request #148 from igorkorsukov/w/rcmd/rcmd_step0

returned shortcut module v1

Author: igorkorsukov

framework/CMakeLists.txt

@@ -110,7 +110,11 @@ if (MUSE_MODULE_RCONTROL)
 endif()
 
 if (MUSE_MODULE_SHORTCUTS)
-    add_subdirectory(shortcuts)
+    if (MUSE_MODULE_SHORTCUTS_V2)
+        add_subdirectory(shortcuts_v2)
+    else()
+        add_subdirectory(shortcuts)
+    endif()
 endif()
 
 if (MUSE_MODULE_TOURS)

framework/cmake/MuseDeclareOptions.cmake

@@ -84,6 +84,8 @@ declare_muse_module_opt(RCOMMAND ON)
 declare_muse_module_opt(RCONTROL ON)
 
 declare_muse_module_opt(SHORTCUTS ON)
+option(MUSE_MODULE_SHORTCUTS_V2 "Use shortcuts v2" OFF)
+
 declare_muse_module_opt(TESTFLOW ON)
 declare_muse_module_opt(TOURS ON)
 

framework/cmake/muse_framework_config.h.in

@@ -139,6 +139,7 @@
 #cmakedefine MUSE_MODULE_SHORTCUTS 1
 #cmakedefine MUSE_MODULE_SHORTCUTS_TESTS 1
 #cmakedefine MUSE_MODULE_SHORTCUTS_API 1
+#cmakedefine MUSE_MODULE_SHORTCUTS_V2 1
 
 #cmakedefine MUSE_MODULE_TOURS 1
 #cmakedefine MUSE_MODULE_TOURS_TESTS 1

framework/shortcuts/CMakeLists.txt

@@ -28,18 +28,14 @@ target_sources(muse_shortcuts PRIVATE
     shortcutstypes.h
     shortcutcontext.h
     ishortcutsregister.h
-    icommandshortcutsregister.h
     ishortcutscontroller.h
     ishortcutsconfiguration.h
-    ishortcutsresolver.h
 
     api/shortcutsapi.cpp
     api/shortcutsapi.h
 
     internal/shortcutsregister.cpp
     internal/shortcutsregister.h
-    internal/commandshortcutsregister.cpp
-    internal/commandshortcutsregister.h
     internal/shortcutscontroller.cpp
     internal/shortcutscontroller.h
     internal/shortcutsconfiguration.cpp

framework/shortcuts/internal/shortcutsconfiguration.cpp

@@ -58,21 +58,7 @@ io::path_t ShortcutsConfiguration::shortcutsAppDataPath() const
 {
 #if defined(Q_OS_MACOS)
     return m_config.value("shortcuts_mac").toPath();
-#else
-    return m_config.value("shortcuts").toPath();
 #endif
-}
-
-io::path_t ShortcutsConfiguration::commandShortcutsUserAppDataPath() const
-{
-    return globalConfiguration()->userAppDataPath() + "/shortcuts.json";
-}
 
-io::path_t ShortcutsConfiguration::commandShortcutsAppDataPath() const
-{
-#if defined(Q_OS_MACOS)
-    return m_config.value("command_shortcuts_mac").toPath();
-#else
-    return m_config.value("command_shortcuts").toPath();
-#endif
+    return m_config.value("shortcuts").toPath();
 }

framework/shortcuts/internal/shortcutsconfiguration.h

@@ -47,9 +47,6 @@ class ShortcutsConfiguration : public IShortcutsConfiguration, public Contextabl
     io::path_t shortcutsUserAppDataPath() const override;
     io::path_t shortcutsAppDataPath() const override;
 
-    io::path_t commandShortcutsUserAppDataPath() const override;
-    io::path_t commandShortcutsAppDataPath() const override;
-
 private:
     Config m_config;
 };

framework/shortcuts/internal/shortcutscontroller.cpp

@@ -21,21 +21,10 @@
  */
 #include "shortcutscontroller.h"
 
-#include "actions/actiontypes.h"
 #include "log.h"
 
-#define SHORTCUTS_DEBUG 1
-
-#if SHORTCUTS_DEBUG
-#define SC_LOG() LOGDA() << "[SC] "
-#else
-#define SC_LOG() LOGN()
-#endif
-
 using namespace muse::shortcuts;
 using namespace muse::actions;
-using namespace muse::rcommand;
-using namespace muse::ui;
 
 void ShortcutsController::init()
 {
@@ -49,42 +38,10 @@ void ShortcutsController::activate(const std::string& sequence)
 {
     LOGD() << sequence;
 
-    //! NOTE: command shortcuts first
-    bool commandShortcutsProcessed = false;
-    {
-        ShortcutList allowedShortcuts;
-        const ShortcutList& commandShortcuts = commandShortcutsRegister()->shortcutsForSequence(sequence);
-        SC_LOG() << "commandShortcuts: " << commandShortcuts.size();
-        for (const Shortcut& sc : commandShortcuts) {
-            const Command& command = Command(sc.command);
-            if (commandsState()->commandState(command).enabled) {
-                allowedShortcuts.push_back(sc);
-            }
-        }
-        SC_LOG() << "allowedShortcuts: " << allowedShortcuts.size();
-
-        Shortcut selectedShortcut;
-        if (allowedShortcuts.size() == 1) {
-            selectedShortcut = allowedShortcuts.front();
-        } else if (allowedShortcuts.size() > 1) {
-            if (shortcutsResolver()) {
-                selectedShortcut = shortcutsResolver()->selectOne(allowedShortcuts);
-            } else {
-                selectedShortcut = allowedShortcuts.front();
-            }
-        }
-        SC_LOG() << "selectedShortcut: " << selectedShortcut.command;
-        if (selectedShortcut.isValid()) {
-            commandDispatcher()->dispatch(Command(selectedShortcut.command));
-            commandShortcutsProcessed = true;
-        }
-    }
+    ActionCode actionCode = resolveAction(sequence);
 
-    if (!commandShortcutsProcessed) {
-        ActionCode actionCode = resolveAction(sequence);
-        if (!actionCode.empty()) {
-            dispatcher()->dispatch(actionCode);
-        }
+    if (!actionCode.empty()) {
+        dispatcher()->dispatch(actionCode);
     }
 }
 
@@ -112,8 +69,7 @@ static bool defaultHasLowerPriorityThan(const std::string& ctx1, const std::stri
 ActionCode ShortcutsController::resolveAction(const std::string& sequence) const
 {
     ShortcutList shortcutsForSequence = shortcutsRegister()->shortcutsForSequence(sequence);
-    if (shortcutsForSequence.empty()) {
-        LOGD() << "No shortcuts found for sequence: " << sequence;
+    IF_ASSERT_FAILED(!shortcutsForSequence.empty()) {
         return ActionCode();
     }
 

framework/shortcuts/internal/shortcutscontroller.h

@@ -27,31 +27,23 @@
 #include "async/asyncable.h"
 #include "modularity/ioc.h"
 #include "actions/iactionsdispatcher.h"
-#include "rcommand/icommanddispatcher.h"
-#include "rcommand/icommandsstate.h"
 #include "interactive/iinteractive.h"
 #include "ui/iuiactionsregister.h"
 #include "ui/iuicontextresolver.h"
 #include "ishortcutsregister.h"
-#include "icommandshortcutsregister.h"
 #include "shortcutcontext.h"
-#include "../ishortcutsresolver.h"
 
 namespace muse::shortcuts {
 class ShortcutsController : public IShortcutsController, public Contextable, public async::Asyncable
 {
-    GlobalInject<ICommandShortcutsRegister> commandShortcutsRegister;
     ContextInject<muse::ui::IUiActionsRegister> aregister = { this };
     ContextInject<IShortcutsRegister> shortcutsRegister = { this };
     ContextInject<muse::actions::IActionsDispatcher> dispatcher = { this };
-    ContextInject<muse::rcommand::ICommandsState> commandsState = { this };
-    ContextInject<muse::rcommand::ICommandDispatcher> commandDispatcher = { this };
     ContextInject<muse::IInteractive> interactive = { this };
     ContextInject<muse::ui::IUiContextResolver> uiContextResolver = { this };
 
     //! NOTE May be missing because it must be implemented outside the framework
     ContextInject<IShortcutContextPriority> shortcutContextPriority = { this };
-    ContextInject<IShortcutsResolver> shortcutsResolver = { this };
 
 public:
     ShortcutsController(const modularity::ContextPtr& iocCtx)

framework/shortcuts/internal/shortcutsregister.cpp

@@ -28,17 +28,14 @@
 #include "global/io/file.h"
 #include "global/serialization/xmlstreamreader.h"
 #include "global/serialization/xmlstreamwriter.h"
-#include "global/containers.h"
 
 #include "multiwindows/resourcelockguard.h"
-#include "ui/navigationcommands.h"
 
 #include "log.h"
 
 using namespace muse;
 using namespace muse::shortcuts;
 using namespace muse::async;
-using namespace muse::ui;
 
 static constexpr std::string_view SHORTCUTS_TAG("Shortcuts");
 static constexpr std::string_view SHORTCUT_TAG("SC");
@@ -49,25 +46,6 @@ static constexpr std::string_view AUTOREPEAT_TAG("autorepeat");
 
 static const std::string SHORTCUTS_RESOURCE_NAME("SHORTCUTS");
 
-static const std::map<std::string, rcommand::Command> compatActionToCommand = {
-    { "nav-next-section", NEXT_SECTION_COMMAND },
-    { "nav-prev-section", PREV_SECTION_COMMAND },
-    { "nav-next-panel", NEXT_PANEL_COMMAND },
-    { "nav-prev-panel", PREV_PANEL_COMMAND },
-    { "nav-next-tab", NEXT_PANEL_COMMAND },
-    { "nav-prev-tab", PREV_PANEL_COMMAND },
-    { "nav-trigger-control", TRIGGER_CONTROL_COMMAND },
-    { "nav-right", RIGHT_COMMAND },
-    { "nav-left", LEFT_COMMAND },
-    { "nav-up", UP_COMMAND },
-    { "nav-down", DOWN_COMMAND },
-    { "nav-escape", ESCAPE_COMMAND },
-    { "nav-first-control", FIRST_CONTROL_COMMAND },
-    { "nav-last-control", LAST_CONTROL_COMMAND },
-    { "nav-nextrow-control", NEXTROW_CONTROL_COMMAND },
-    { "nav-prevrow-control", PREVROW_CONTROL_COMMAND },
-};
-
 static const std::map<QKeySequence::StandardKey, QKeyCombination> SHORTCUTS_EXPAND_IGNORE_MAP = {
     { QKeySequence::StandardKey::HelpContents, Qt::Key_Help },
     { QKeySequence::StandardKey::Open, Qt::Key_Open },
@@ -346,10 +324,6 @@ Shortcut ShortcutsRegister::readShortcut(XmlStreamReader& reader) const
 
         if (tag == ACTION_CODE_TAG) {
             shortcut.action = reader.readAsciiText();
-            const rcommand::Command& command = muse::value(compatActionToCommand, shortcut.action);
-            if (command.isValid()) {
-                shortcut.action = command.toString();
-            }
         } else if (tag == STANDARD_KEY_TAG) {
             shortcut.standardKey = QKeySequence::StandardKey(reader.readInt());
         } else if (tag == SEQUENCE_TAG) {

framework/shortcuts/ishortcutsconfiguration.h

@@ -39,8 +39,5 @@ class IShortcutsConfiguration : MODULE_GLOBAL_INTERFACE
 
     virtual io::path_t shortcutsUserAppDataPath() const = 0;
     virtual io::path_t shortcutsAppDataPath() const = 0;
-
-    virtual io::path_t commandShortcutsUserAppDataPath() const = 0;
-    virtual io::path_t commandShortcutsAppDataPath() const = 0;
 };
 }