split up ControllerEngine

CMakeLists.txt

@@ -380,12 +380,14 @@ add_library(mixxx-lib STATIC EXCLUDE_FROM_ALL
   src/controllers/dlgprefcontrollerdlg.ui
   src/controllers/dlgprefcontrollers.cpp
   src/controllers/dlgprefcontrollersdlg.ui
-  src/controllers/engine/controllerengine.cpp
-  src/controllers/engine/controllerenginejsproxy.cpp
-  src/controllers/engine/colormapper.cpp
-  src/controllers/engine/colormapperjsproxy.cpp
-  src/controllers/engine/scriptconnection.cpp
-  src/controllers/engine/scriptconnectionjsproxy.cpp
+  src/controllers/scripting/controllerscriptenginebase.cpp
+  src/controllers/scripting/controllerscriptmoduleengine.cpp
+  src/controllers/scripting/colormapper.cpp
+  src/controllers/scripting/colormapperjsproxy.cpp
+  src/controllers/scripting/legacy/controllerscriptenginelegacy.cpp
+  src/controllers/scripting/legacy/controllerscriptinterfacelegacy.cpp
+  src/controllers/scripting/legacy/scriptconnection.cpp
+  src/controllers/scripting/legacy/scriptconnectionjsproxy.cpp
   src/controllers/keyboard/keyboardeventfilter.cpp
   src/controllers/learningutils.cpp
   src/controllers/midi/midicontroller.cpp
@@ -1262,7 +1264,7 @@ add_executable(mixxx-test
   src/test/compatibility_test.cpp
   src/test/configobject_test.cpp
   src/test/controller_preset_validation_test.cpp
-  src/test/controllerengine_test.cpp
+  src/test/controllerscriptenginelegacy_test.cpp
   src/test/controlobjecttest.cpp
   src/test/coverartcache_test.cpp
   src/test/coverartutils_test.cpp

build/depends.py

@@ -922,12 +922,14 @@ def sources(self, build):
                    "src/controllers/delegates/midibytedelegate.cpp",
                    "src/controllers/delegates/midioptionsdelegate.cpp",
                    "src/controllers/learningutils.cpp",
-                   "src/controllers/engine/controllerengine.cpp",
-                   "src/controllers/engine/controllerenginejsproxy.cpp",
-                   "src/controllers/engine/colormapper.cpp",
-                   "src/controllers/engine/colormapperjsproxy.cpp",
-                   "src/controllers/engine/scriptconnection.cpp",
-                   "src/controllers/engine/scriptconnectionjsproxy.cpp",
+                   "src/controllers/scripting/controllerscriptenginebase.cpp",
+                   "src/controllers/scripting/controllerscriptmoduleengine.cpp",
+                   "src/controllers/scripting/colormapper.cpp",
+                   "src/controllers/scripting/colormapperjsproxy.cpp",
+                   "src/controllers/scripting/legacy/controllerscriptenginelegacy.cpp",
+                   "src/controllers/scripting/legacy/controllerscriptinterfacelegacy.cpp",
+                   "src/controllers/scripting/legacy/scriptconnection.cpp",
+                   "src/controllers/scripting/legacy/scriptconnectionjsproxy.cpp",
                    "src/controllers/midi/midimessage.cpp",
                    "src/controllers/midi/midiutils.cpp",
                    "src/controllers/midi/midicontroller.cpp",

src/control/controlobjectscript.cpp

@@ -1,9 +1,11 @@
+#include "control/controlobjectscript.h"
+
 #include <QtDebug>
 
-#include "control/controlobjectscript.h"
+#include "controllers/controllerdebug.h"
 
 ControlObjectScript::ControlObjectScript(const ConfigKey& key, QObject* pParent)
-        : ControlProxy(key, pParent, ControlFlag::NoAssertIfMissing) {
+        : ControlProxy(key, pParent, ControllerDebug::shouldAssertForInvalidControlObjects()) {
 }
 
 bool ControlObjectScript::addScriptConnection(const ScriptConnection& conn) {

src/control/controlobjectscript.h

@@ -4,8 +4,7 @@
 #include <QVector>
 
 #include "control/controlproxy.h"
-#include "controllers/controllerdebug.h"
-#include "controllers/engine/scriptconnection.h"
+#include "controllers/scripting/legacy/scriptconnection.h"
 
 // this is used for communicate with controller scripts
 class ControlObjectScript : public ControlProxy {

src/controllers/bulk/bulkcontroller.cpp

@@ -52,8 +52,8 @@ void BulkReader::run() {
         if (result >= 0) {
             Trace process("BulkReader process packet");
             //qDebug() << "Read" << result << "bytes, pointer:" << data;
-            QByteArray outData((char*)data, transferred);
-            emit incomingData(outData, mixxx::Time::elapsed());
+            QByteArray byteArray(reinterpret_cast<char*>(data), transferred);
+            emit incomingData(byteArray, mixxx::Time::elapsed());
         }
     }
     qDebug() << "Stopped Reader";

src/controllers/bulk/bulkcontroller.h

@@ -1,14 +1,7 @@
-/**
-  * @file bulkcontroller.h
-  * @author Neale Picket  [email protected]
-  * @date Thu Jun 28 2012
-  * @brief USB Bulk controller backend
-  */
-
-#ifndef BULKCONTROLLER_H
-#define BULKCONTROLLER_H
+#pragma once
 
 #include <QAtomicInt>
+#include <QThread>
 
 #include "controllers/controller.h"
 #include "controllers/hid/hidcontrollerpreset.h"
@@ -28,7 +21,7 @@ class BulkReader : public QThread {
     void stop();
 
   signals:
-    void incomingData(QByteArray data, mixxx::Duration timestamp);
+    void incomingData(const QByteArray& data, mixxx::Duration timestamp);
 
   protected:
     void run();
@@ -107,5 +100,3 @@ class BulkController : public Controller {
     BulkReader* m_pReader;
     HidControllerPreset m_preset;
 };
-
-#endif

src/controllers/controller.cpp

@@ -14,7 +14,7 @@
 #include "util/screensaver.h"
 
 Controller::Controller()
-        : m_pEngine(nullptr),
+        : m_pScriptEngineLegacy(nullptr),
           m_bIsOutputDevice(false),
           m_bIsInputDevice(false),
           m_bIsOpen(false),
@@ -34,31 +34,30 @@ ControllerJSProxy* Controller::jsProxy() {
 void Controller::startEngine()
 {
     controllerDebug("  Starting engine");
-    if (m_pEngine != NULL) {
+    if (m_pScriptEngineLegacy) {
         qWarning() << "Controller: Engine already exists! Restarting:";
         stopEngine();
     }
-    m_pEngine = new ControllerEngine(this);
+    m_pScriptEngineLegacy = new ControllerScriptEngineLegacy(this);
 }
 
 void Controller::stopEngine() {
     controllerDebug("  Shutting down engine");
-    if (m_pEngine == NULL) {
+    if (!m_pScriptEngineLegacy) {
         qWarning() << "Controller::stopEngine(): No engine exists!";
         return;
     }
-    m_pEngine->gracefulShutdown();
-    delete m_pEngine;
-    m_pEngine = NULL;
+    delete m_pScriptEngineLegacy;
+    m_pScriptEngineLegacy = nullptr;
 }
 
-bool Controller::applyPreset(bool initializeScripts) {
+bool Controller::applyPreset() {
     qDebug() << "Applying controller preset...";
 
     const ControllerPreset* pPreset = preset();
 
     // Load the script code into the engine
-    if (m_pEngine == NULL) {
+    if (!m_pScriptEngineLegacy) {
         qWarning() << "Controller::applyPreset(): No engine exists!";
         return false;
     }
@@ -69,19 +68,8 @@ bool Controller::applyPreset(bool initializeScripts) {
         return true;
     }
 
-    bool success = m_pEngine->loadScriptFiles(scriptFiles);
-    if (success && initializeScripts) {
-        m_pEngine->initializeScripts(scriptFiles);
-    }
-
-    // QFileInfo does not have a isValid/isEmpty/isNull method to check if it
-    // actually contains a reference, so we check if the filePath is empty as a
-    // workaround.
-    // See https://stackoverflow.com/a/45652741/1455128 for details.
-    if (initializeScripts && !pPreset->moduleFileInfo().filePath().isEmpty()) {
-        m_pEngine->loadModule(pPreset->moduleFileInfo());
-    }
-    return success;
+    m_pScriptEngineLegacy->setScriptFiles(scriptFiles);
+    return m_pScriptEngineLegacy->initialize();
 }
 
 void Controller::startLearning() {
@@ -117,9 +105,8 @@ void Controller::triggerActivity()
         m_userActivityInhibitTimer.start();
     }
 }
-void Controller::receive(const QByteArray data, mixxx::Duration timestamp) {
-
-    if (m_pEngine == NULL) {
+void Controller::receive(const QByteArray& data, mixxx::Duration timestamp) {
+    if (!m_pScriptEngineLegacy) {
         //qWarning() << "Controller::receive called with no active engine!";
         // Don't complain, since this will always show after closing a device as
         //  queued signals flush out
@@ -143,14 +130,5 @@ void Controller::receive(const QByteArray data, mixxx::Duration timestamp) {
         controllerDebug(message);
     }
 
-    foreach (QString function, m_pEngine->getScriptFunctionPrefixes()) {
-        if (function == "") {
-            continue;
-        }
-        function.append(".incomingData");
-        QJSValue incomingDataFunction = m_pEngine->wrapFunctionCode(function, 2);
-        m_pEngine->executeFunction(incomingDataFunction, data);
-    }
-
-    m_pEngine->handleInput(data, timestamp);
+    m_pScriptEngineLegacy->handleIncomingData(data);
 }

src/controllers/controller.h

@@ -1,27 +1,21 @@
-/**
-* @file controller.h
-* @author Sean Pappalardo [email protected]
-* @date Sat Apr 30 2011
-* @brief Base class representing a physical (or software) controller.
-*
-* This is a base class representing a physical (or software) controller.  It
-* must be inherited by a class that implements it on some API. Note that the
-* subclass' destructor should call close() at a minimum.
-*/
-
-#ifndef CONTROLLER_H
-#define CONTROLLER_H
+#pragma once
+
+#include <QElapsedTimer>
+#include <QTimerEvent>
 
 #include "controllers/controllerpreset.h"
 #include "controllers/controllerpresetfilehandler.h"
 #include "controllers/controllerpresetinfo.h"
 #include "controllers/controllerpresetvisitor.h"
 #include "controllers/controllervisitor.h"
-#include "controllers/engine/controllerengine.h"
+#include "controllers/scripting/legacy/controllerscriptenginelegacy.h"
 #include "util/duration.h"
 
 class ControllerJSProxy;
 
+/// This is a base class representing a physical (or software) controller.  It
+/// must be inherited by a class that implements it on some API. Note that the
+/// subclass' destructor should call close() at a minimum.
 class Controller : public QObject, ConstControllerPresetVisitor {
     Q_OBJECT
   public:
@@ -88,15 +82,9 @@ class Controller : public QObject, ConstControllerPresetVisitor {
     // Handles packets of raw bytes and passes them to an ".incomingData" script
     // function that is assumed to exist. (Sub-classes may want to reimplement
     // this if they have an alternate way of handling such data.)
-    virtual void receive(const QByteArray data, mixxx::Duration timestamp);
+    virtual void receive(const QByteArray& data, mixxx::Duration timestamp);
 
-    /// Apply the preset to the controller.
-    /// @brief Initializes both controller engine and static output mappings.
-    ///
-    /// @param initializeScripts Can be set to false to skip script
-    /// initialization for unit tests.
-    /// @return Returns whether it was successful.
-    virtual bool applyPreset(bool initializeScripts = true);
+    virtual bool applyPreset();
 
     // Puts the controller in and out of learning mode.
     void startLearning();
@@ -113,17 +101,17 @@ class Controller : public QObject, ConstControllerPresetVisitor {
 
     // To be called in sub-class' open() functions after opening the device but
     // before starting any input polling/processing.
-    void startEngine();
+    virtual void startEngine();
 
     // To be called in sub-class' close() functions after stopping any input
     // polling/processing but before closing the device.
-    void stopEngine();
+    virtual void stopEngine();
 
     // To be called when receiving events
     void triggerActivity();
 
-    inline ControllerEngine* getEngine() const {
-        return m_pEngine;
+    inline ControllerScriptEngineLegacy* getScriptEngine() const {
+        return m_pScriptEngineLegacy;
     }
     inline void setDeviceName(QString deviceName) {
         m_sDeviceName = deviceName;
@@ -160,7 +148,7 @@ class Controller : public QObject, ConstControllerPresetVisitor {
     // Returns a pointer to the currently loaded controller preset. For internal
     // use only.
     virtual ControllerPreset* preset() = 0;
-    ControllerEngine* m_pEngine;
+    ControllerScriptEngineLegacy* m_pScriptEngineLegacy;
 
     // Verbose and unique device name suitable for display.
     QString m_sDeviceName;
@@ -203,5 +191,3 @@ class ControllerJSProxy : public QObject {
   private:
     Controller* const m_pController;
 };
-
-#endif

src/controllers/controllerdebug.cpp

@@ -5,6 +5,7 @@
 
 //static
 bool ControllerDebug::s_enabled = false;
+bool ControllerDebug::s_testing = false;
 
 //static
 bool ControllerDebug::enabled() {

src/controllers/controllerdebug.h

@@ -3,6 +3,7 @@
 
 #include <QDebug>
 
+#include "control/control.h"
 
 // Specifies whether or not we should dump incoming data to the console at
 // runtime. This is useful for end-user debugging and script-writing.
@@ -24,10 +25,24 @@ class ControllerDebug {
         s_enabled = false;
     }
 
+    static void enableTesting() {
+        s_enabled = true;
+        s_testing = true;
+    }
+
+    static ControlFlags shouldAssertForInvalidControlObjects() {
+        if (s_enabled && !s_testing) {
+            return ControlFlag::None;
+        }
+
+        return ControlFlag::AllowMissingOrInvalid;
+    }
+
   private:
     ControllerDebug() = delete;
 
     static bool s_enabled;
+    static bool s_testing;
 };
 
 // Usage: controllerDebug("hello" << "world");

src/controllers/controllermanager.cpp

@@ -1,20 +1,14 @@
-/**
-  * @file controllermanager.cpp
-  * @author Sean Pappalardo [email protected]
-  * @date Sat Apr 30 2011
-  * @brief Manages creation/enumeration/deletion of hardware controllers.
-  */
+#include "controllers/controllermanager.h"
 
 #include <QSet>
+#include <QThread>
 
-#include "util/trace.h"
-#include "controllers/controllermanager.h"
-#include "controllers/defs_controllers.h"
 #include "controllers/controllerlearningeventfilter.h"
+#include "controllers/defs_controllers.h"
+#include "controllers/midi/portmidienumerator.h"
 #include "util/cmdlineargs.h"
 #include "util/time.h"
-
-#include "controllers/midi/portmidienumerator.h"
+#include "util/trace.h"
 #ifdef __HSS1394__
 #include "controllers/midi/hss1394enumerator.h"
 #endif