Implemented stubs for shortcuts module

CMakeLists.txt

@@ -54,6 +54,7 @@ option(BUILD_TELEMETRY_MODULE "Build with telemetry module" ON)
 set(TELEMETRY_TRACK_ID "" CACHE STRING "Telemetry track id")
 set(CRASH_REPORT_URL "" CACHE STRING "URL where to send crash reports")
 
+option(BUILD_SHORTCUTS_MODULE "Build shortcuts module" ON)
 option(BUILD_SYSTEM_MODULE "Build system module" ON)
 option(BUILD_NETWORK_MODULE "Build network module" ON)
 option(BUILD_USERSCORES_MODULE "Build userscores module" ON)

build/config.h.in

@@ -43,6 +43,7 @@
 #cmakedefine BUILD_TELEMETRY_MODULE
 #define TELEMETRY_TRACK_ID "${TELEMETRY_TRACK_ID}"
 
+#cmakedefine BUILD_SHORTCUTS_MODULE
 #cmakedefine BUILD_SYSTEM_MODULE
 #cmakedefine BUILD_NETWORK_MODULE
 #cmakedefine BUILD_USERSCORES_MODULE

src/framework/CMakeLists.txt

@@ -4,7 +4,10 @@ add_subdirectory(ui)
 add_subdirectory(uicomponents)
 add_subdirectory(fonts)
 add_subdirectory(actions)
-add_subdirectory(shortcuts)
+
+if (BUILD_SHORTCUTS_MODULE)
+    add_subdirectory(shortcuts)
+endif (BUILD_SHORTCUTS_MODULE)
 
 if (BUILD_NETWORK_MODULE)
     add_subdirectory(network)

src/main/main.cpp

@@ -30,7 +30,11 @@
 #include "framework/uicomponents/uicomponentsmodule.h"
 #include "framework/fonts/fontsmodule.h"
 #include "framework/actions/actionsmodule.h"
+#ifdef BUILD_SHORTCUTS_MODULE
 #include "framework/shortcuts/shortcutsmodule.h"
+#else
+#include "stubs/framework/shortcuts/shortcutsstubmodule.h"
+#endif
 
 #ifdef BUILD_SYSTEM_MODULE
 #include "framework/system/systemmodule.h"
@@ -161,7 +165,11 @@ int main(int argc, char** argv)
     app.addModule(new mu::appshell::AppShellModule());
 
     app.addModule(new mu::context::ContextModule());
+#ifdef BUILD_SHORTCUTS_MODULE
     app.addModule(new mu::shortcuts::ShortcutsModule());
+#else
+    app.addModule(new mu::shortcuts::ShortcutsStubModule());
+#endif
 
     app.addModule(new mu::audio::AudioModule());
     app.addModule(new mu::midi::MidiModule());

src/notation/view/notationpaintview.h

@@ -31,7 +31,6 @@
 #include "context/iglobalcontext.h"
 #include "async/asyncable.h"
 #include "playback/iplaybackcontroller.h"
-#include "shortcuts/ishortcutsregister.h"
 
 #include "notationviewinputcontroller.h"
 #include "noteinputcursor.h"
@@ -47,7 +46,6 @@ class NotationPaintView : public QQuickPaintedItem, public IControlledView, publ
     INJECT(notation, context::IGlobalContext, globalContext)
     INJECT(notation, playback::IPlaybackController, playbackController)
     INJECT(notation, INotationContextMenu, notationContextMenu)
-    INJECT(notation, shortcuts::IShortcutsRegister, shortcutsRegister)
 
     Q_PROPERTY(qreal startHorizontalScrollPosition READ startHorizontalScrollPosition NOTIFY horizontalScrollChanged)
     Q_PROPERTY(qreal horizontalScrollSize READ horizontalScrollSize NOTIFY horizontalScrollChanged)

src/stubs/framework/CMakeLists.txt

@@ -1,4 +1,8 @@
 
+if (NOT BUILD_SHORTCUTS_MODULE)
+    add_subdirectory(shortcuts)
+endif (NOT BUILD_SHORTCUTS_MODULE)
+
 if (NOT BUILD_NETWORK_MODULE)
 add_subdirectory(network)
 endif (NOT BUILD_NETWORK_MODULE)

src/stubs/framework/shortcuts/CMakeLists.txt

@@ -0,0 +1,42 @@
+#=============================================================================
+#  MuseScore
+#  Music Composition & Notation
+#
+#  Copyright (C) 2020 MuseScore BVBA and others
+#
+#  This program is free software; you can redistribute it and/or modify
+#  it under the terms of the GNU General Public License version 2.
+#
+#  This program is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#  GNU General Public License for more details.
+#
+#  You should have received a copy of the GNU General Public License
+#  along with this program; if not, write to the Free Software
+#  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+#=============================================================================
+
+set(MODULE shortcuts)
+
+set(MODULE_QRC shortcuts.qrc)
+
+set(MODULE_QML_IMPORT ${CMAKE_CURRENT_LIST_DIR}/qml )
+
+set(MODULE_SRC
+    ${CMAKE_CURRENT_LIST_DIR}/shortcutsstubmodule.cpp
+    ${CMAKE_CURRENT_LIST_DIR}/shortcutsstubmodule.h
+    ${CMAKE_CURRENT_LIST_DIR}/shortcutsregisterstub.cpp
+    ${CMAKE_CURRENT_LIST_DIR}/shortcutsregisterstub.h
+    ${CMAKE_CURRENT_LIST_DIR}/shortcutscontrollerstub.cpp
+    ${CMAKE_CURRENT_LIST_DIR}/shortcutscontrollerstub.h
+    ${CMAKE_CURRENT_LIST_DIR}/shortcutsconfigurationstub.cpp
+    ${CMAKE_CURRENT_LIST_DIR}/shortcutsconfigurationstub.h
+    ${CMAKE_CURRENT_LIST_DIR}/shortcutcontextresolverstub.cpp
+    ${CMAKE_CURRENT_LIST_DIR}/shortcutcontextresolverstub.h
+    ${CMAKE_CURRENT_LIST_DIR}/midiremotestub.cpp
+    ${CMAKE_CURRENT_LIST_DIR}/midiremotestub.h
+    )
+
+include(${PROJECT_SOURCE_DIR}/build/module.cmake)
+

src/stubs/framework/shortcuts/midiremotestub.cpp

@@ -0,0 +1,39 @@
+//=============================================================================
+//  MuseScore
+//  Music Composition & Notation
+//
+//  Copyright (C) 2020 MuseScore BVBA and others
+//
+//  This program is free software; you can redistribute it and/or modify
+//  it under the terms of the GNU General Public License version 2.
+//
+//  This program is distributed in the hope that it will be useful,
+//  but WITHOUT ANY WARRANTY; without even the implied warranty of
+//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+//  GNU General Public License for more details.
+//
+//  You should have received a copy of the GNU General Public License
+//  along with this program; if not, write to the Free Software
+//  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+//=============================================================================
+#include "midiremotestub.h"
+
+using namespace mu::shortcuts;
+
+void MidiRemoteStub::setIsSettingMode(bool)
+{
+}
+
+bool MidiRemoteStub::isSettingMode() const
+{
+    return false;
+}
+
+void MidiRemoteStub::setCurrentActionEvent(const mu::midi::Event&)
+{
+}
+
+mu::Ret MidiRemoteStub::process(const mu::midi::Event&)
+{
+    return make_ret(Ret::Code::NotSupported);
+}

src/stubs/framework/shortcuts/midiremotestub.h

@@ -0,0 +1,37 @@
+//=============================================================================
+//  MuseScore
+//  Music Composition & Notation
+//
+//  Copyright (C) 2020 MuseScore BVBA and others
+//
+//  This program is free software; you can redistribute it and/or modify
+//  it under the terms of the GNU General Public License version 2.
+//
+//  This program is distributed in the hope that it will be useful,
+//  but WITHOUT ANY WARRANTY; without even the implied warranty of
+//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+//  GNU General Public License for more details.
+//
+//  You should have received a copy of the GNU General Public License
+//  along with this program; if not, write to the Free Software
+//  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+//=============================================================================
+#ifndef MU_SHORTCUTS_MIDIREMOTESTUB_H
+#define MU_SHORTCUTS_MIDIREMOTESTUB_H
+
+#include "shortcuts/imidiremote.h"
+
+namespace mu::shortcuts {
+class MidiRemoteStub : public IMidiRemote
+{
+public:
+    void setIsSettingMode(bool arg) override;
+    bool isSettingMode() const override;
+
+    void setCurrentActionEvent(const midi::Event& ev) override;
+
+    Ret process(const midi::Event& ev) override;
+};
+}
+
+#endif // MU_SHORTCUTS_MIDIREMOTESTUB_H

src/stubs/framework/shortcuts/qml/MuseScore/Shortcuts/Shortcuts.qml

@@ -0,0 +1,3 @@
+import QtQuick 2.15
+
+QtObject { }

src/stubs/framework/shortcuts/qml/MuseScore/Shortcuts/qmldir

@@ -0,0 +1,2 @@
+module MuseScore.Shortcuts
+Shortcuts 1.0 Shortcuts.qml

src/stubs/framework/shortcuts/shortcutcontextresolverstub.cpp

@@ -0,0 +1,26 @@
+//=============================================================================
+//  MuseScore
+//  Music Composition & Notation
+//
+//  Copyright (C) 2020 MuseScore BVBA and others
+//
+//  This program is free software; you can redistribute it and/or modify
+//  it under the terms of the GNU General Public License version 2.
+//
+//  This program is distributed in the hope that it will be useful,
+//  but WITHOUT ANY WARRANTY; without even the implied warranty of
+//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+//  GNU General Public License for more details.
+//
+//  You should have received a copy of the GNU General Public License
+//  along with this program; if not, write to the Free Software
+//  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+//=============================================================================
+#include "shortcutcontextresolverstub.h"
+
+using namespace mu::shortcuts;
+
+ShortcutContext ShortcutContextResolverStub::currentShortcutContext() const
+{
+    return ShortcutContext();
+}

src/stubs/framework/shortcuts/shortcutcontextresolverstub.h

@@ -0,0 +1,32 @@
+//=============================================================================
+//  MuseScore
+//  Music Composition & Notation
+//
+//  Copyright (C) 2020 MuseScore BVBA and others
+//
+//  This program is free software; you can redistribute it and/or modify
+//  it under the terms of the GNU General Public License version 2.
+//
+//  This program is distributed in the hope that it will be useful,
+//  but WITHOUT ANY WARRANTY; without even the implied warranty of
+//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+//  GNU General Public License for more details.
+//
+//  You should have received a copy of the GNU General Public License
+//  along with this program; if not, write to the Free Software
+//  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+//=============================================================================
+#ifndef MU_SHORTCUTS_SHORTCUTCONTEXTRESOLVERSTUB_H
+#define MU_SHORTCUTS_SHORTCUTCONTEXTRESOLVERSTUB_H
+
+#include "shortcuts/ishortcutcontextresolver.h"
+
+namespace mu::shortcuts {
+class ShortcutContextResolverStub : public IShortcutContextResolver
+{
+public:
+    ShortcutContext currentShortcutContext() const override;
+};
+}
+
+#endif // MU_SHORTCUTS_SHORTCUTCONTEXTRESOLVERSTUB_H

src/stubs/framework/shortcuts/shortcuts.qrc

@@ -0,0 +1,6 @@
+<RCC>
+    <qresource prefix="/">
+        <file>qml/MuseScore/Shortcuts/qmldir</file>
+        <file>qml/MuseScore/Shortcuts/Shortcuts.qml</file>
+    </qresource>
+</RCC>

src/stubs/framework/shortcuts/shortcutsconfigurationstub.cpp

@@ -0,0 +1,31 @@
+//=============================================================================
+//  MuseScore
+//  Music Composition & Notation
+//
+//  Copyright (C) 2020 MuseScore BVBA and others
+//
+//  This program is free software; you can redistribute it and/or modify
+//  it under the terms of the GNU General Public License version 2.
+//
+//  This program is distributed in the hope that it will be useful,
+//  but WITHOUT ANY WARRANTY; without even the implied warranty of
+//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+//  GNU General Public License for more details.
+//
+//  You should have received a copy of the GNU General Public License
+//  along with this program; if not, write to the Free Software
+//  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+//=============================================================================
+#include "shortcutsconfigurationstub.h"
+
+using namespace mu::shortcuts;
+
+mu::io::path ShortcutsConfigurationStub::shortcutsUserPath() const
+{
+    return mu::io::path();
+}
+
+mu::io::path ShortcutsConfigurationStub::shortcutsDefaultPath() const
+{
+    return mu::io::path();
+}

src/stubs/framework/shortcuts/shortcutsconfigurationstub.h

@@ -0,0 +1,33 @@
+//=============================================================================
+//  MuseScore
+//  Music Composition & Notation
+//
+//  Copyright (C) 2020 MuseScore BVBA and others
+//
+//  This program is free software; you can redistribute it and/or modify
+//  it under the terms of the GNU General Public License version 2.
+//
+//  This program is distributed in the hope that it will be useful,
+//  but WITHOUT ANY WARRANTY; without even the implied warranty of
+//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+//  GNU General Public License for more details.
+//
+//  You should have received a copy of the GNU General Public License
+//  along with this program; if not, write to the Free Software
+//  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+//=============================================================================
+#ifndef MU_SHORTCUTS_SHORTCUTSCONFIGURATIONSTUB_H
+#define MU_SHORTCUTS_SHORTCUTSCONFIGURATIONSTUB_H
+
+#include "shortcuts/ishortcutsconfiguration.h"
+
+namespace mu::shortcuts {
+class ShortcutsConfigurationStub : public IShortcutsConfiguration
+{
+public:
+    io::path shortcutsUserPath() const override;
+    io::path shortcutsDefaultPath() const override;
+};
+}
+
+#endif // MU_SHORTCUTS_SHORTCUTSCONFIGURATIONSTUB_H

src/stubs/framework/shortcuts/shortcutscontrollerstub.cpp

@@ -0,0 +1,25 @@
+//=============================================================================
+//  MuseScore
+//  Music Composition & Notation
+//
+//  Copyright (C) 2020 MuseScore BVBA and others
+//
+//  This program is free software; you can redistribute it and/or modify
+//  it under the terms of the GNU General Public License version 2.
+//
+//  This program is distributed in the hope that it will be useful,
+//  but WITHOUT ANY WARRANTY; without even the implied warranty of
+//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+//  GNU General Public License for more details.
+//
+//  You should have received a copy of the GNU General Public License
+//  along with this program; if not, write to the Free Software
+//  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+//=============================================================================
+#include "shortcutscontrollerstub.h"
+
+using namespace mu::shortcuts;
+
+void ShortcutsControllerStub::activate(const std::string&)
+{
+}

src/stubs/framework/shortcuts/shortcutscontrollerstub.h

@@ -0,0 +1,32 @@
+//=============================================================================
+//  MuseScore
+//  Music Composition & Notation
+//
+//  Copyright (C) 2020 MuseScore BVBA and others
+//
+//  This program is free software; you can redistribute it and/or modify
+//  it under the terms of the GNU General Public License version 2.
+//
+//  This program is distributed in the hope that it will be useful,
+//  but WITHOUT ANY WARRANTY; without even the implied warranty of
+//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+//  GNU General Public License for more details.
+//
+//  You should have received a copy of the GNU General Public License
+//  along with this program; if not, write to the Free Software
+//  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+//=============================================================================
+#ifndef MU_SHORTCUTS_SHORTCUTSCONTROLLERSTUB_H
+#define MU_SHORTCUTS_SHORTCUTSCONTROLLERSTUB_H
+
+#include "shortcuts/ishortcutscontroller.h"
+
+namespace mu::shortcuts {
+class ShortcutsControllerStub : public IShortcutsController
+{
+public:
+    void activate(const std::string& sequence) override;
+};
+}
+
+#endif // MU_SHORTCUTS_SHORTCUTSCONTROLLERSTUB_H