feat: add a way to display log in a ScriptDialog

Fixes KDAB#26
smnppKDAB · Aug 29, 2024 · 7b106d9 · 7b106d9
1 parent 223f682
commit 7b106d9
Show file tree

Hide file tree

Showing 2 changed files with 37 additions and 0 deletions.
diff --git a/src/core/scriptdialogitem.cpp b/src/core/scriptdialogitem.cpp
@@ -9,6 +9,7 @@
 */
 
 #include "scriptdialogitem.h"
+#include "loghighlighter.h"
 #include "scriptdialogitem_p.h"
 #include "scriptprogressdialog.h"
 #include "scriptrunner.h"
@@ -44,6 +45,7 @@
 #include <QToolButton>
 #include <QUiLoader>
 #include <QVBoxLayout>
+#include <spdlog/sinks/qt_sinks.h>
 
 namespace Core {
 
@@ -576,6 +578,8 @@ void ScriptDialogItem::createProperties(QWidget *dialogWidget)
             });
             m_data->addProperty((widget->objectName() + "Syntax").toLocal8Bit(), "QString", QMetaType::QString,
                                 QString());
+            m_data->addProperty((widget->objectName() + "DisplayLogs").toLocal8Bit(), "QString", QMetaType::QString,
+                                QString());
         }
     }
 
@@ -637,6 +641,14 @@ void ScriptDialogItem::changeValue(const QString &key, const QVariant &value)
         return;
     }
 
+    // It may be a log panel
+    if (key.endsWith("DisplayLogs")) {
+        if (auto logOutput = findChild<QPlainTextEdit *>(key.left(key.length() - 11))) {
+            displayLogs(logOutput, value.toString());
+            return;
+        }
+    }
+
     if (!widget) {
         spdlog::warn("No widget found for the key '{}'.", key.toStdString());
     } else {
@@ -645,6 +657,29 @@ void ScriptDialogItem::changeValue(const QString &key, const QVariant &value)
     }
 }
 
+void ScriptDialogItem::displayLogs(QPlainTextEdit *logOutput, const QString &level)
+{
+    if (logOutput) {
+        logOutput->setReadOnly(true);
+
+        new LogHighlighter(logOutput->document());
+
+        auto logger = spdlog::default_logger();
+
+        std::vector<QString> levels = {"trace", "debug", "info", "warn", "error", "critical"};
+        auto it = std::find(levels.begin(), levels.end(), level);
+        int index = (it != levels.end()) ? std::distance(levels.begin(), it) : 0;
+        spdlog::level::level_enum logLevel = static_cast<spdlog::level::level_enum>(index);
+        logger->set_level(logLevel);
+
+        logger->sinks().push_back(std::make_shared<spdlog::sinks::qt_sink_mt>(logOutput, "appendPlainText"));
+        for (auto &sink : logger->sinks()) {
+            sink->set_level(logLevel);
+        }
+    }
+    return;
+}
+
 void ScriptDialogItem::applySyntaxHighlighting(QTextDocument *document, const QString &syntax)
 {
     if (!syntax.isEmpty()) {

diff --git a/src/core/scriptdialogitem.h b/src/core/scriptdialogitem.h
@@ -19,6 +19,7 @@
 
 class ScriptProgressDialog;
 class QTextDocument;
+class QPlainTextEdit;
 
 namespace KSyntaxHighlighting {
 }
@@ -90,6 +91,7 @@ public slots:
     static void clearChildren(QQmlListProperty<QObject> *list);
 
     void applySyntaxHighlighting(QTextDocument *document, const QString &syntax);
+    void displayLogs(QPlainTextEdit *logOutput, const QString &level);
 
 private:
     DynamicObject *m_data;