feat: add a way to initialize script dialog from command line (#136)

Fixes #32
Tested in MR: https://codereview.kdab.com/c/kdab/mfc-utils/+/144788

Author: smnppKDAB

src/core/knutcore.cpp

@@ -124,6 +124,18 @@ bool KnutCore::process(const QStringList &arguments)
         }
     }
 
+    // Get json data if provided
+    const QString jsonDataStr = parser.value("data");
+    json jsonData;
+    if (!jsonDataStr.isEmpty()) {
+        try {
+            jsonData = json::parse(jsonDataStr.toStdString());
+        } catch (const json::parse_error &ex) {
+            spdlog::error("JSON parsing error at byte {}: {}", ex.byte, ex.what());
+            return false;
+        }
+    }
+
     // Run the script passed in parameter, if any
     // Exit Knut if there are no windows opened
     auto scriptName = parser.value("run");
@@ -132,8 +144,8 @@ bool KnutCore::process(const QStringList &arguments)
     }
 
     if (!scriptName.isEmpty()) {
-        QTimer::singleShot(0, this, [scriptName]() {
-            ScriptManager::instance()->runScript(scriptName);
+        QTimer::singleShot(0, this, [scriptName, jsonData = std::move(jsonData)]() mutable {
+            ScriptManager::instance()->runScript(scriptName, std::move(jsonData));
         });
         connect(
             ScriptManager::instance(), &ScriptManager::scriptFinished, qApp,
@@ -160,6 +172,7 @@ void KnutCore::initParser(QCommandLineParser &parser) const
                        {{"i", "input"}, "Opens document <file> on startup.", "file"},
                        {{"l", "line"}, "Line in the current file, if any.", "line"},
                        {{"c", "column"}, "Column in the current file, if any.", "column"},
+                       {{"d", "data"}, "JSON data string for initializing the dialog.", "data"},
                        {"json-list", "Returns the list of all available scripts as a JSON file"},
                        {"json-settings", "Returns the settings as a JSON file"}});
 }

src/core/scriptdialogitem.cpp

@@ -24,6 +24,9 @@
 #include <QDoubleSpinBox>
 #include <QFile>
 #include <QFileInfo>
+#include <QJsonDocument>
+#include <QJsonObject>
+#include <QJsonValue>
 #include <QLineEdit>
 #include <QMessageBox>
 #include <QPushButton>
@@ -145,6 +148,29 @@ ScriptDialogItem::ScriptDialogItem(QWidget *parent)
     });
 }
 
+void ScriptDialogItem::initialize(nlohmann::json &&jsonData)
+{
+    for (auto it = jsonData.cbegin(); it != jsonData.cend(); ++it) {
+        const QString key = QString::fromStdString(it.key());
+
+        QVariant value;
+        if (it.value().is_string()) {
+            value = QString::fromStdString(it.value().get<std::string>());
+        } else if (it.value().is_boolean()) {
+            value = it.value().get<bool>();
+        } else if (it.value().is_number_integer()) {
+            value = it.value().get<int>();
+        } else if (it.value().is_number_float()) {
+            value = it.value().get<double>();
+        } else {
+            spdlog::error("Unsupported data type for key '{}'", it.key());
+            value = QString::fromStdString(it.value().dump());
+        }
+
+        changeValue(key, value);
+    }
+}
+
 void ScriptDialogItem::done(int code)
 {
     // When showing progress, the `onAccepted` handler will likely call `QCoreApplication::processEvents` multiple
@@ -535,18 +561,25 @@ void ScriptDialogItem::createProperties(QWidget *dialogWidget)
 void ScriptDialogItem::changeValue(const QString &key, const QVariant &value)
 {
     auto widget = findChild<QWidget *>(key);
+
     if (auto lineEdit = qobject_cast<QLineEdit *>(widget)) {
         lineEdit->setText(value.toString());
+        return;
     } else if (auto checkBox = qobject_cast<QCheckBox *>(widget)) {
         checkBox->setChecked(value.toBool());
+        return;
     } else if (auto radioButton = qobject_cast<QRadioButton *>(widget)) {
         radioButton->setChecked(value.toBool());
+        return;
     } else if (auto spinBox = qobject_cast<QSpinBox *>(widget)) {
         spinBox->setValue(value.toInt());
+        return;
     } else if (auto doubleSpinBox = qobject_cast<QDoubleSpinBox *>(widget)) {
         doubleSpinBox->setValue(value.toDouble());
+        return;
     } else if (auto comboBox = qobject_cast<QComboBox *>(widget)) {
         comboBox->setCurrentText(value.toString());
+        return;
     }
 
     // It may be a combobox model
@@ -557,6 +590,14 @@ void ScriptDialogItem::changeValue(const QString &key, const QVariant &value)
             if (comboBox->count())
                 comboBox->setCurrentIndex(0);
         }
+        return;
+    }
+
+    if (!widget) {
+        spdlog::warn("No widget found for the key '{}'.", key.toStdString());
+    } else {
+        spdlog::warn("Unsupported widget type '{}' for the key '{}'.", widget->metaObject()->className(),
+                     key.toStdString());
     }
 }
 

src/core/scriptdialogitem.h

@@ -14,6 +14,7 @@
 #include <QJSValue>
 #include <QQmlListProperty>
 #include <QQmlPropertyMap>
+#include <nlohmann/json_fwd.hpp>
 #include <vector>
 
 class ScriptProgressDialog;
@@ -35,6 +36,8 @@ class ScriptDialogItem : public QDialog
 public:
     explicit ScriptDialogItem(QWidget *parent = nullptr);
 
+    void initialize(nlohmann::json &&jsonData);
+
     QObject *data() const;
     QQmlListProperty<QObject> childrenData();
 

src/core/scriptmanager.cpp

@@ -77,7 +77,7 @@ QAbstractItemModel *ScriptManager::model()
     return model;
 }
 
-void ScriptManager::runScript(const QString &fileName, bool async, bool log)
+void ScriptManager::runScript(const QString &fileName, nlohmann::json &&data, bool async, bool log)
 {
     if (log)
         spdlog::debug("==> Start script {}", fileName);
@@ -88,11 +88,11 @@ void ScriptManager::runScript(const QString &fileName, bool async, bool log)
     };
 
     if (async)
-        QTimer::singleShot(0, this, [this, fileName, endScriptCallback]() {
-            doRunScript(fileName, endScriptCallback);
+        QTimer::singleShot(0, this, [this, fileName, data = std::move(data), endScriptCallback]() mutable {
+            doRunScript(fileName, std::move(data), endScriptCallback);
         });
     else
-        doRunScript(fileName, endScriptCallback);
+        doRunScript(fileName, std::move(data), endScriptCallback);
 }
 
 void ScriptManager::addScript(const QString &fileName)
@@ -199,9 +199,9 @@ ScriptManager::ScriptList::iterator ScriptManager::removeScript(const ScriptList
     return it;
 }
 
-void ScriptManager::doRunScript(const QString &fileName, const std::function<void()> &endFunc)
+void ScriptManager::doRunScript(const QString &fileName, nlohmann::json &&data, const std::function<void()> &endFunc)
 {
-    m_result = m_runner->runScript(fileName, endFunc);
+    m_result = m_runner->runScript(fileName, std::move(data), endFunc);
     if (m_runner->hasError()) {
         const auto errors = m_runner->errors();
         for (const auto &error : errors)

src/core/scriptmanager.h

@@ -14,6 +14,7 @@
 #include <QStringList>
 #include <QVariant>
 #include <functional>
+#include <nlohmann/json.hpp>
 #include <vector>
 
 class QFileSystemWatcher;
@@ -57,8 +58,8 @@ class ScriptManager : public QObject
 
     static QAbstractItemModel *model();
 
-public slots:
-    void runScript(const QString &fileName, bool async = true, bool log = true);
+    void runScript(const QString &fileName, nlohmann::json &&data = nlohmann::json::object(), bool async = true,
+                   bool log = true);
 
 signals:
     void scriptFinished(const QVariant &result);
@@ -79,7 +80,7 @@ public slots:
     void addScriptsFromPath(const QString &path);
     void removeScriptsFromPath(const QString &path);
 
-    void doRunScript(const QString &fileName, const std::function<void()> &endFunc);
+    void doRunScript(const QString &fileName, nlohmann::json &&data, const std::function<void()> &endFunc);
 
     void updateDirectories();
     void updateScriptDirectory(const QString &path);

src/core/scriptrunner.cpp

@@ -171,7 +171,8 @@ ScriptRunner::ScriptRunner(QObject *parent)
 
 ScriptRunner::~ScriptRunner() = default;
 
-QVariant ScriptRunner::runScript(const QString &fileName, const std::function<void()> &endCallback)
+QVariant ScriptRunner::runScript(const QString &fileName, nlohmann::json &&data,
+                                 const std::function<void()> &endCallback)
 {
     const QFileInfo fi(fileName);
 
@@ -191,7 +192,7 @@ QVariant ScriptRunner::runScript(const QString &fileName, const std::function<vo
         if (fi.suffix() == "js") {
             result = runJavascript(fullName, engine);
         } else {
-            result = runQml(fullName, engine);
+            result = runQml(fullName, std::move(data), engine);
         }
         // engine is deleted in runJavascript or runQml
     } else {
@@ -312,7 +313,7 @@ QVariant ScriptRunner::runJavascript(const QString &fileName, QQmlEngine *engine
     return QVariant(ErrorCode);
 }
 
-QVariant ScriptRunner::runQml(const QString &fileName, QQmlEngine *engine)
+QVariant ScriptRunner::runQml(const QString &fileName, nlohmann::json &&data, QQmlEngine *engine)
 {
     auto component = new QQmlComponent(engine, engine);
     component->loadUrl(QUrl::fromLocalFile(fileName));
@@ -346,6 +347,7 @@ QVariant ScriptRunner::runQml(const QString &fileName, QQmlEngine *engine)
                 window->show();
             } else if (auto dialog = qobject_cast<ScriptDialogItem *>(topLevel)) {
                 engine->setProperty("scriptWindow", true);
+                dialog->initialize(std::move(data));
                 dialog->show();
                 connect(dialog, &ScriptDialogItem::scriptFinished, engine, &QObject::deleteLater);
             }

src/core/scriptrunner.h

@@ -17,6 +17,7 @@
 #include <QSharedPointer>
 #include <QString>
 #include <functional>
+#include <nlohmann/json.hpp>
 
 namespace Core {
 
@@ -36,7 +37,7 @@ class ScriptRunner : public QObject
 
     // Run a script
     using EndScriptFunc = std::function<void()>;
-    QVariant runScript(const QString &fileName, const EndScriptFunc &endCallback = {});
+    QVariant runScript(const QString &fileName, nlohmann::json &&data, const EndScriptFunc &endCallback = {});
 
     bool hasError() const { return m_hasError; }
     QList<QQmlError> errors() const { return m_errors; }
@@ -52,7 +53,7 @@ class ScriptRunner : public QObject
 private:
     QQmlEngine *getEngine(const QString &fileName);
     QVariant runJavascript(const QString &fileName, QQmlEngine *engine);
-    QVariant runQml(const QString &fileName, QQmlEngine *engine);
+    QVariant runQml(const QString &fileName, nlohmann::json &&data, QQmlEngine *engine);
     void filterErrors(const QQmlComponent &component);
 
 private:

src/core/utils.cpp

@@ -111,7 +111,7 @@ void Utils::runScript(const QString &path, bool log)
     LOG("Utils::runScript", LOG_ARG("path", path), log);
 
     // Run the script synchronously
-    ScriptManager::instance()->runScript(path, false, log);
+    ScriptManager::instance()->runScript(path, nlohmann::json::object(), false, log);
 }
 
 /*!