Clean-up: Builtin-viewer in builtin module, effectmanagemenu in effects_base module

docs/effect-view-architecture.md

@@ -21,20 +21,20 @@ classDiagram
   IEffectViewLauncher <|-- Vst3ViewLauncher
   IEffectViewLauncher <|-- BuiltinViewLauncher
 
-  RealtimeEffectViewerDialog o.. EffectsViewer
+  RealtimeEffectViewerDialog o.. BuiltinEffectViewer
   RealtimeEffectViewerDialog o.. VstViewer
   EffectsViewerDialog o.. VstViewer
-  EffectsViewerDialog o.. EffectsViewer
-  EffectsViewer *-- EffectViewLoader
-  EffectViewLoader o.. ReverbView: loads
-  EffectViewLoader o.. CompressorView: loads
+  EffectsViewerDialog o.. BuiltinEffectViewer
+  BuiltinEffectViewer *-- BuiltinEffectViewLoader
+  BuiltinEffectViewLoader o.. ReverbView: loads
+  BuiltinEffectViewLoader o.. CompressorView: loads
   Vst3ViewLauncher ..> EffectsViewerDialog
   BuiltinViewLauncher ..> EffectsViewerDialog
 
   class ReverbView:::qml
   class CompressorView:::qml
 
-  class EffectViewLoader {
+  class BuiltinEffectViewLoader {
     load(instanceId)
   }
 
@@ -63,7 +63,7 @@ classDiagram
     manageBtn
   }
 
-  class EffectsViewer:::qml {
+  class BuiltinEffectViewer:::qml {
     load(instanceId)
   }
 

src/effects/builtin/CMakeLists.txt

@@ -23,8 +23,9 @@ set(MODULE_SRC
     ${CMAKE_CURRENT_LIST_DIR}/common/generatoreffect.h
     ${CMAKE_CURRENT_LIST_DIR}/common/generatoreffectmodel.cpp
     ${CMAKE_CURRENT_LIST_DIR}/common/generatoreffectmodel.h
-    ${CMAKE_CURRENT_LIST_DIR}/common/effectmanagemenu.cpp
-    ${CMAKE_CURRENT_LIST_DIR}/common/effectmanagemenu.h
+
+    ${CMAKE_CURRENT_LIST_DIR}/view/builtineffectviewloader.cpp
+    ${CMAKE_CURRENT_LIST_DIR}/view/builtineffectviewloader.h
 
     ${CMAKE_CURRENT_LIST_DIR}/general/generalviewmodel.cpp
     ${CMAKE_CURRENT_LIST_DIR}/general/generalviewmodel.h

src/effects/builtin/builtineffectsmodule.cpp

@@ -7,7 +7,8 @@
 #include "internal/builtinviewlauncher.h"
 
 #include "common/abstracteffectmodel.h"
-#include "common/effectmanagemenu.h"
+
+#include "view/builtineffectviewloader.h"
 
 #include "effects/effects_base/ieffectviewlaunchregister.h"
 
@@ -45,8 +46,8 @@ void BuiltinEffectsModule::registerResources()
 
 void BuiltinEffectsModule::registerUiTypes()
 {
-    qmlRegisterUncreatableType<AbstractEffectModel>("Audacity.Effects", 1, 0, "AbstractEffectModel", "Not creatable abstract type");
-    qmlRegisterType<EffectManageMenu>("Audacity.Effects", 1, 0, "EffectManageMenu");
+    qmlRegisterUncreatableType<AbstractEffectModel>("Audacity.BuiltinEffects", 1, 0, "AbstractEffectModel", "Not creatable abstract type");
+    qmlRegisterType<BuiltinEffectViewLoader>("Audacity.BuiltinEffects", 1, 0, "BuiltinEffectViewLoader");
 }
 
 void BuiltinEffectsModule::onPreInit(const muse::IApplication::RunMode&)

src/effects/builtin/common/EffectBase.qml

@@ -4,7 +4,7 @@ import QtQuick.Layouts
 import Muse.Ui
 import Muse.UiComponents
 
-import Audacity.Effects
+import Audacity.BuiltinEffects
 
 Rectangle {
 

src/effects/builtin/effects_builtin.qrc

@@ -1,5 +1,7 @@
 <RCC>
     <qresource prefix="/">
+        <file>qml/Audacity/BuiltinEffects/qmldir</file>
+        <file>qml/Audacity/BuiltinEffects/BuiltinEffectViewer.qml</file>
         <file>common/EffectBase.qml</file>
         <file>amplify/AmplifyView.qml</file>
         <file>tonegen/ChirpView.qml</file>

src/effects/builtin/qml/Audacity/BuiltinEffects/BuiltinEffectViewer.qml

@@ -3,7 +3,7 @@
 */
 import QtQuick
 
-import Audacity.Effects
+import Audacity.BuiltinEffects
 
 Rectangle {
 
@@ -40,7 +40,7 @@ Rectangle {
         }
     }
 
-    EffectViewLoader {
+    BuiltinEffectViewLoader {
         id: builder
 
         onCloseRequested: root.closeRequested()

src/effects/builtin/qml/Audacity/BuiltinEffects/qmldir

@@ -0,0 +1,2 @@
+module Audacity.BuiltinEffects
+BuiltinEffectViewer 1.0 BuiltinEffectViewer.qml

src/effects/builtin/view/builtineffectviewloader.cpp

@@ -19,8 +19,8 @@
  * You should have received a copy of the GNU General Public License
  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
-#include "effectviewloader.h"
-#include "effectstypes.h"
+#include "builtineffectviewloader.h"
+#include "effects/effects_base/effectstypes.h"
 
 #include <QQmlEngine>
 
@@ -33,11 +33,11 @@
 
 using namespace au::effects;
 
-EffectViewLoader::EffectViewLoader(QObject* parent)
+BuiltinEffectViewLoader::BuiltinEffectViewLoader(QObject* parent)
     : QObject(parent)
 {}
 
-EffectViewLoader::~EffectViewLoader()
+BuiltinEffectViewLoader::~BuiltinEffectViewLoader()
 {
     if (m_contentItem) {
         m_contentItem->deleteLater();
@@ -45,7 +45,7 @@ EffectViewLoader::~EffectViewLoader()
     }
 }
 
-void EffectViewLoader::load(const QString& instanceId, QObject* itemParent)
+void BuiltinEffectViewLoader::load(const QString& instanceId, QObject* itemParent)
 {
     LOGD() << "instanceId: " << instanceId;
 
@@ -108,7 +108,7 @@ void EffectViewLoader::load(const QString& instanceId, QObject* itemParent)
     emit contentItemChanged();
 }
 
-QQuickItem* EffectViewLoader::contentItem() const
+QQuickItem* BuiltinEffectViewLoader::contentItem() const
 {
     return m_contentItem;
 }

src/effects/builtin/view/builtineffectviewloader.h

@@ -8,15 +8,15 @@
 #include <QQuickItem>
 
 #include "global/async/asyncable.h"
-
 #include "modularity/ioc.h"
-#include "../ieffectsviewregister.h"
-#include "../ieffectsuiengine.h"
-#include "../ieffectinstancesregister.h"
+
+#include "effects/effects_base/ieffectsviewregister.h"
+#include "effects/effects_base/ieffectsuiengine.h"
+#include "effects/effects_base/ieffectinstancesregister.h"
 
 namespace au::effects {
 //! TODO Move to builtin module
-class EffectViewLoader : public QObject, public muse::async::Asyncable
+class BuiltinEffectViewLoader : public QObject, public muse::async::Asyncable
 {
     Q_OBJECT
 
@@ -27,8 +27,8 @@ class EffectViewLoader : public QObject, public muse::async::Asyncable
     muse::Inject<IEffectInstancesRegister> instancesRegister;
 
 public:
-    EffectViewLoader(QObject* parent = nullptr);
-    ~EffectViewLoader() override;
+    BuiltinEffectViewLoader(QObject* parent = nullptr);
+    ~BuiltinEffectViewLoader() override;
 
     QQuickItem* contentItem() const;
 

src/effects/effects_base/CMakeLists.txt

@@ -64,10 +64,10 @@ set(MODULE_SRC
     # view
     ${CMAKE_CURRENT_LIST_DIR}/view/effectsviewregister.cpp
     ${CMAKE_CURRENT_LIST_DIR}/view/effectsviewregister.h
+    ${CMAKE_CURRENT_LIST_DIR}/view/effectmanagemenu.cpp
+    ${CMAKE_CURRENT_LIST_DIR}/view/effectmanagemenu.h
     ${CMAKE_CURRENT_LIST_DIR}/view/effectsuiengine.cpp
     ${CMAKE_CURRENT_LIST_DIR}/view/effectsuiengine.h
-    ${CMAKE_CURRENT_LIST_DIR}/view/effectviewloader.cpp
-    ${CMAKE_CURRENT_LIST_DIR}/view/effectviewloader.h
     ${CMAKE_CURRENT_LIST_DIR}/view/realtimeeffectviewerdialogmodel.cpp
     ${CMAKE_CURRENT_LIST_DIR}/view/realtimeeffectviewerdialogmodel.h
     )

src/effects/effects_base/effects_base.qrc

@@ -6,7 +6,6 @@
         <file>qml/Audacity/Effects/EffectsViewerDialog.qml</file>
         <file>qml/Audacity/Effects/EffectStyledDialogView.qml</file>
         <file>qml/Audacity/Effects/RealtimeEffectViewerDialog.qml</file>
-        <file>qml/Audacity/Effects/EffectsViewer.qml</file>
         <file>qml/Audacity/Effects/PresetNameDialog.qml</file>
     </qresource>
 </RCC>

src/effects/effects_base/effectsmodule.cpp

@@ -20,8 +20,8 @@
 #include "internal/effectpresetsscenario.h"
 #include "internal/effectviewlaunchregister.h"
 
+#include "view/effectmanagemenu.h"
 #include "view/effectsviewregister.h"
-#include "view/effectviewloader.h"
 #include "view/effectsuiengine.h"
 #include "view/realtimeeffectviewerdialogmodel.h"
 
@@ -73,7 +73,7 @@ void EffectsModule::registerResources()
 
 void EffectsModule::registerUiTypes()
 {
-    qmlRegisterType<EffectViewLoader>("Audacity.Effects", 1, 0, "EffectViewLoader");
+    qmlRegisterType<EffectManageMenu>("Audacity.Effects", 1, 0, "EffectManageMenu");
     qmlRegisterType<RealtimeEffectViewerDialogModel>("Audacity.Effects", 1, 0, "RealtimeEffectViewerDialogModel");
     qmlRegisterUncreatableType<EffectFamilies>("Audacity.Effects", 1, 0, "EffectFamily", "Not creatable from QML");
 }

src/effects/effects_base/qml/Audacity/Effects/EffectsViewerDialog.qml

@@ -8,6 +8,7 @@ import Muse.Ui
 import Muse.UiComponents
 
 import Audacity.Effects
+import Audacity.BuiltinEffects
 import Audacity.Lv2
 import Audacity.Vst
 
@@ -77,7 +78,7 @@ EffectStyledDialogView {
 
         Component {
             id: builtinViewerComp
-            EffectsViewer {
+            BuiltinEffectViewer {
                 instanceId: root.instanceId
             }
         }

src/effects/effects_base/qml/Audacity/Effects/RealtimeEffectViewerDialog.qml

@@ -8,6 +8,7 @@ import Muse.Ui
 import Muse.UiComponents
 
 import Audacity.Effects
+import Audacity.BuiltinEffects
 import Audacity.Lv2
 import Audacity.Vst
 
@@ -74,7 +75,7 @@ EffectStyledDialogView {
             rightPadding: prv.padding
             bottomPadding: prv.padding
 
-            EffectsViewer {
+            BuiltinEffectViewer {
                 id: view
                 instanceId: root.instanceId
             }

src/effects/effects_base/qml/Audacity/Effects/qmldir

@@ -1,5 +1,4 @@
 module Audacity.Effects
 BypassEffectButton 1.0 BypassEffectButton.qml
-EffectsViewer 1.0 EffectsViewer.qml
 EffectPresetsBar 1.0 EffectPresetsBar.qml
 EffectStyledDialogView 1.0 EffectStyledDialogView.qml