[POC] OSCQuery

CMakeLists.txt

@@ -1296,6 +1296,7 @@ add_library(
   src/network/jsonwebtask.cpp
   src/network/networktask.cpp
   src/network/webtask.cpp
+  src/osc/query/oscquerydescription.cpp
   src/preferences/colorpaletteeditor.cpp
   src/preferences/colorpaletteeditor.cpp
   src/preferences/colorpaletteeditormodel.cpp

src/control/control.cpp

@@ -2,6 +2,7 @@
 
 #include "control/controlobject.h"
 #include "moc_control.cpp"
+#include "osc/query/oscquerydescription.h"
 #include "util/mutex.h"
 #include "util/stat.h"
 
@@ -37,6 +38,9 @@ QHash<ConfigKey, QWeakPointer<ControlDoublePrivate>> s_qCOHash
 QHash<ConfigKey, ConfigKey> s_qCOAliasHash
         GUARDED_BY(s_qCOHashMutex);
 
+OscQueryDescription s_oscQueryDecription
+        GUARDED_BY(s_qCOHashMutex);
+
 /// is used instead of a nullptr, helps to omit null checks everywhere
 QWeakPointer<ControlDoublePrivate> s_pDefaultCO;
 } // namespace
@@ -82,6 +86,7 @@ ControlDoublePrivate::ControlDoublePrivate(
 ControlDoublePrivate::~ControlDoublePrivate() {
     s_qCOHashMutex.lock();
     //qDebug() << "ControlDoublePrivate::s_qCOHash.remove(" << m_key.group << "," << m_key.item << ")";
+    s_oscQueryDecription.removeControlKey(m_key);
     s_qCOHash.remove(m_key);
     s_qCOHashMutex.unlock();
 
@@ -187,6 +192,7 @@ QSharedPointer<ControlDoublePrivate> ControlDoublePrivate::getControl(
         const MMutexLocker locker(&s_qCOHashMutex);
         //qDebug() << "ControlDoublePrivate::s_qCOHash.insert(" << key.group << "," << key.item << ")";
         s_qCOHash.insert(key, pControl);
+        s_oscQueryDecription.insertControlKey(key);
         return pControl;
     }
 
@@ -215,6 +221,12 @@ QSharedPointer<ControlDoublePrivate> ControlDoublePrivate::getDefaultControl() {
     return defaultCO;
 }
 
+// static
+void ControlDoublePrivate::writeOscQueryDescription(QString& oscQueryFileName) {
+    const MMutexLocker locker(&s_qCOHashMutex);
+    s_oscQueryDecription.saveToFile(oscQueryFileName);
+}
+
 // static
 QList<QSharedPointer<ControlDoublePrivate>> ControlDoublePrivate::getAllInstances() {
     QList<QSharedPointer<ControlDoublePrivate>> result;

src/control/control.h

@@ -59,6 +59,8 @@ class ControlDoublePrivate : public QObject {
             double defaultValue = kDefaultValue);
     static QSharedPointer<ControlDoublePrivate> getDefaultControl();
 
+    static void writeOscQueryDescription(QString& oscQueryFileName);
+
     // Returns a list of all existing instances.
     static QList<QSharedPointer<ControlDoublePrivate>> getAllInstances();
     // Clears all existing instances and returns them as a list.

src/dialog/dlgdevelopertools.cpp

@@ -47,6 +47,10 @@ DlgDeveloperTools::DlgDeveloperTools(QWidget* pParent,
             &QPushButton::clicked,
             this,
             &DlgDeveloperTools::slotControlDump);
+    connect(oscQuerryDump,
+            &QPushButton::clicked,
+            this,
+            &DlgDeveloperTools::slotOscQuerryDump);
 
     // Set up the log search box
     connect(logSearch,
@@ -133,6 +137,12 @@ void DlgDeveloperTools::slotControlDump() {
     }
 }
 
+void DlgDeveloperTools::slotOscQuerryDump() {
+    QString oscQueryFileName = m_pConfig->getSettingsPath() +
+            "/oscquery.json";
+    ControlDoublePrivate::writeOscQueryDescription(oscQueryFileName);
+}
+
 void DlgDeveloperTools::slotLogSearch() {
     QString textToFind = logSearch->text();
     m_logCursor = logTextView->document()->find(textToFind, m_logCursor);

src/dialog/dlgdevelopertools.h

@@ -21,6 +21,7 @@ class DlgDeveloperTools : public QDialog, public Ui::DlgDeveloperTools {
     void slotControlSearch(const QString& search);
     void slotLogSearch();
     void slotControlDump();
+    void slotOscQuerryDump();
 
   private:
     UserSettingsPointer m_pConfig;

src/dialog/dlgdevelopertoolsdlg.ui

@@ -78,6 +78,16 @@
          </attribute>
         </widget>
        </item>
+       <item row="0" column="2">
+        <widget class="QPushButton" name="oscQuerryDump">
+         <property name="toolTip">
+          <string>Dumps a OSCQuery description to settings path (e.g. ~/.mixxx)</string>
+         </property>
+         <property name="text">
+          <string>Dump OSCQuerry Description</string>
+         </property>
+        </widget>
+       </item>
       </layout>
      </widget>
      <widget class="QWidget" name="logTab">

src/osc/query/oscquerydescription.cpp

@@ -0,0 +1,191 @@
+#include "osc/query/oscquerydescription.h"
+
+#include <QDebug>
+#include <QFile>
+#include <QJsonDocument>
+#include <QJsonValue>
+
+#include "preferences/configobject.h"
+
+namespace {
+
+template<typename T>
+T take_back(std::vector<T>* pVec) {
+    T last_element = std::move(pVec->back());
+    pVec->pop_back();
+    return last_element;
+}
+
+QString toOscAddress(const ConfigKey& key) {
+    QString groupWithoutBrackets = key.group.mid(1, key.group.size() - 2);
+    QString oscAddress = groupWithoutBrackets + QChar('/') + key.item;
+    oscAddress.replace(QChar('['), QChar('('));
+    oscAddress.replace(QChar(']'), QChar(')'));
+    oscAddress.replace(QChar('_'), QChar('/'));
+    return oscAddress;
+}
+
+} // namespace
+
+OscQueryDescription::OscQueryDescription()
+        : m_rootObject({{"DESCRIPTION", "Mixxx OSC root node"},
+                  {"FULL_PATH", "/"},
+                  {"ACCESS", "0"},
+                  {"CONTENTS", QJsonObject()}}) {
+}
+
+void OscQueryDescription::addAddress(
+        const QString& address,
+        const QString& type,
+        const QString& access,
+        const QString& description) {
+    QStringList pathParts = address.split('/');
+    QString fullPath;
+
+    std::vector<QJsonObject> objects;
+    objects.reserve(pathParts.size());
+
+    // Create a list of QJsonObjects.
+    // Note: QJsonObject is only temporary helper class for writing a QJsonValue
+    for (const auto& pathPart : pathParts) {
+        if (pathPart.isEmpty()) {
+            continue;
+        }
+        fullPath += "/" + pathPart;
+        if (objects.size()) {
+            QJsonValueRef currentContent = objects.back()["CONTENTS"];
+            if (currentContent.isObject()) {
+                objects.push_back(currentContent.toObject());
+            } else {
+                objects.emplace_back();
+            }
+        } else {
+            objects.push_back(m_rootObject["CONTENTS"].toObject());
+        }
+
+        QJsonValueRef currentPart = objects.back()[pathPart];
+        if (currentPart.isObject()) {
+            objects.push_back(currentPart.toObject());
+        } else {
+            objects.emplace_back(QJsonObject({{"ACCESS", "0"}, {"FULL_PATH", fullPath}}));
+        }
+    }
+
+    // populate
+    objects.back()["FULL_PATH"] = address;
+    objects.back()["TYPE"] = type;
+    objects.back()["ACCESS"] = access;
+    objects.back()["DESCRIPTION"] = description;
+
+    // recreate form the leaves
+    for (auto it = pathParts.crbegin(); it != pathParts.crend(); ++it) {
+        objects.back()[*it] = take_back(&objects);
+        if (objects.size() == 1) {
+            m_rootObject["CONTENTS"] = take_back(&objects);
+            break;
+        }
+        objects.back()["CONTENTS"] = take_back(&objects);
+    }
+}
+
+void OscQueryDescription::removeAddress(const QString& address) {
+    QStringList pathParts = address.split('/');
+
+    std::vector<QJsonObject> objects;
+    objects.reserve(pathParts.size());
+
+    // Create a list of QJsonObjects.
+    // Note: QJsonObject is only temporary helper class for writing a QJsonValue
+    for (const auto& pathPart : pathParts) {
+        if (pathPart.isEmpty()) {
+            continue;
+        }
+        if (objects.size()) {
+            QJsonValueRef currentContent = objects.back()["CONTENTS"];
+            if (currentContent.isObject()) {
+                objects.push_back(currentContent.toObject());
+            } else {
+                objects.back().remove("CONTENTS");
+                return;
+            }
+        } else {
+            objects.push_back(m_rootObject["CONTENTS"].toObject());
+        }
+
+        QJsonValueRef currentPart = objects.back()[pathPart];
+        if (currentPart.isObject()) {
+            objects.push_back(currentPart.toObject());
+        } else {
+            objects.back().remove(pathPart);
+            return;
+        }
+    }
+
+    if (objects.back().contains("CONTENTS")) {
+        objects.back().remove("TYPE");
+        objects.back().remove("DESCRIPTION");
+        objects.back()["ACCESS"] = "0";
+    } else {
+        objects.pop_back();
+        objects.back().remove(pathParts.takeLast());
+        if (objects.back().isEmpty()) {
+            objects.pop_back();
+            objects.back().remove("CONTENTS");
+        } else {
+            objects.back()["CONTENTS"] = take_back(&objects);
+        }
+    }
+
+    // recreate form the leaves
+    for (auto it = pathParts.crbegin(); it != pathParts.crend(); ++it) {
+        if (!objects.back().contains("CONTENTS") && !objects.back().contains("TYPE")) {
+            objects.pop_back();
+            objects.back().remove(*it);
+        } else {
+            objects.back()[*it] = take_back(&objects);
+        }
+        if (objects.size() == 1) {
+            m_rootObject["CONTENTS"] = take_back(&objects);
+            break;
+        }
+        if (objects.back().isEmpty()) {
+            objects.pop_back();
+            objects.back().remove("CONTENTS");
+        } else {
+            objects.back()["CONTENTS"] = take_back(&objects);
+        }
+    }
+}
+
+QString OscQueryDescription::toJsonString() const {
+    QJsonDocument doc(m_rootObject);
+    return doc.toJson(QJsonDocument::Indented);
+}
+
+bool OscQueryDescription::saveToFile(const QString& filePath) const {
+    QFile file(filePath);
+    if (!file.open(QIODevice::WriteOnly)) {
+        qWarning() << "Failed to open file for writing:" << filePath;
+        return false;
+    }
+
+    file.write(toJsonString().toUtf8());
+    file.close();
+    return true;
+}
+
+void OscQueryDescription::insertControlKey(const ConfigKey& key) {
+    QString address = toOscAddress(key);
+    addAddress("/cop/" + address, "f", "3", "");
+    addAddress("/get/cop/" + address, "f", "3", "");
+    addAddress("/cov/" + address, "f", "3", "");
+    addAddress("/get/cov/" + address, "f", "3", "");
+}
+
+void OscQueryDescription::removeControlKey(const ConfigKey& key) {
+    QString address = toOscAddress(key);
+    removeAddress("/cop/" + address);
+    removeAddress("/get/cop/" + address);
+    removeAddress("/cov/" + address);
+    removeAddress("/get/cov/" + address);
+}

src/osc/query/oscquerydescription.h

@@ -0,0 +1,30 @@
+#pragma once
+
+#include <QJsonObject>
+
+class QString;
+class QVariant;
+class ConfigKey;
+
+class OscQueryDescription {
+  public:
+    OscQueryDescription();
+
+    void addAddress(
+            const QString& address,
+            const QString& type,
+            const QString& access,
+            const QString& description);
+
+    void removeAddress(const QString& address);
+
+    void insertControlKey(const ConfigKey& key);
+    void removeControlKey(const ConfigKey& key);
+
+    QString toJsonString() const;
+
+    bool saveToFile(const QString& filePath) const;
+
+  private:
+    QJsonObject m_rootObject;
+};