feat: add a way to display log in a ScriptDialog

Added a QPlainTextEdit widget to allow real-time log display in the user interface. The actual code did not allow windows users to view logs when launching knut from the command line.

The QPlainTextEdit can be made visible using the qml setDisplayLogs method and taking as parameter the minimum log level that we want to have.

Fixes #26

docs/API/knut/scriptdialog.md

@@ -22,6 +22,7 @@ import Knut
 ||**[firstStep](#firstStep)**(string firstStep)|
 ||**[nextStep](#nextStep)**(string title)|
 ||**[runSteps](#runSteps)**(function generator)|
+||**[setDisplayLogs](#setDisplayLogs)**(const QString &level)|
 ||**[setStepCount](#setStepCount)**(int stepCount)|
 ||**[verify](#verify)**(bool value, string message = {})|
 
@@ -171,6 +172,11 @@ function convert() {
 }
 ```
 
+#### <a name="setDisplayLogs"></a>**setDisplayLogs**(const QString &level)
+
+This method enables real-time logging display within the ScriptDialog by configuring a QPlainTextEdit widget as a log output panel.
+It filters the logs to show only those that are of the specified log level or higher.
+
 #### <a name="setStepCount"></a>**setStepCount**(int stepCount)
 
 Sets the number of steps to show in the progress bar.

examples/ex_gui_interactive.qml

@@ -21,6 +21,7 @@ ScriptDialog {
         // This can be done using the `stepCount` property of ScriptDialog
         // Note: if you don't set the step count, a moving scrollbar will be displayed
         setStepCount(5);
+        setDisplayLogs("warn");
 
         // 3) Initialize the first step using `firstStep` and run the different commands for this step
         firstStep("Step 1...");

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 {
 
@@ -431,6 +433,36 @@ void ScriptDialogItem::verify(bool value, QString message)
     ScriptRunner::verify(this, value, message);
 }
 
+/*!
+ * \qmlmethod ScriptDialog::setDisplayLogs(const QString &level)
+ * This method enables real-time logging display within the ScriptDialog by configuring a QPlainTextEdit widget as a log
+ * output panel. It filters the logs to show only those that are of the specified log level or higher.
+ */
+void ScriptDialogItem::setDisplayLogs(const QString &level)
+{
+    QPlainTextEdit *logPanel = m_progressDialog->setLogsAvailable();
+    logPanel->setReadOnly(true);
+
+    new Core::LogHighlighter(logPanel->document());
+
+    const std::vector<const QString> levels = {"trace", "debug", "info", "warn", "error", "critical"};
+    const auto it = std::find(levels.begin(), levels.end(), level);
+    const int index = (it != levels.end()) ? std::distance(levels.begin(), it) : 0;
+
+    spdlog::level::level_enum logLevel = static_cast<spdlog::level::level_enum>(index);
+
+    auto logger = spdlog::default_logger();
+
+    auto currentLogLevel = logger->level();
+    auto logLevelMin = static_cast<spdlog::level::level_enum>(std::min(static_cast<int>(currentLogLevel), index));
+
+    logger->set_level(logLevelMin);
+
+    auto sink = std::make_shared<spdlog::sinks::qt_sink_mt>(logPanel, "appendPlainText");
+    sink->set_level(logLevel);
+    logger->sinks().push_back(sink);
+}
+
 void ScriptDialogItem::showProgressDialog()
 {
     // If there's no interaction or the progress bar is already displayed, do nothing

src/core/scriptdialogitem.h

@@ -19,6 +19,7 @@
 
 class ScriptProgressDialog;
 class QTextDocument;
+class QPlainTextEdit;
 
 namespace KSyntaxHighlighting {
 }
@@ -62,6 +63,8 @@ class ScriptDialogItem : public QDialog
     Q_INVOKABLE void compare(const QJSValue &actual, const QJSValue &expected, QString message = {});
     Q_INVOKABLE void verify(bool value, QString message = {});
 
+    Q_INVOKABLE void setDisplayLogs(const QString &level);
+
 public slots:
     void setStepCount(int stepCount);
     void done(int code) override;

src/core/scriptprogressdialog.cpp

@@ -21,6 +21,7 @@ ScriptProgressDialog::ScriptProgressDialog(QWidget *parent)
     setAttribute(Qt::WA_DeleteOnClose);
 
     ui->buttonBox->button(QDialogButtonBox::Yes)->setText(tr("Continue"));
+    ui->logsPanel->hide();
     connect(ui->buttonBox, &QDialogButtonBox::accepted, this, &ScriptProgressDialog::apply);
     connect(ui->buttonBox, &QDialogButtonBox::rejected, this, &ScriptProgressDialog::abort);
 }
@@ -63,3 +64,9 @@ void ScriptProgressDialog::setReadOnly(bool readOnly)
 {
     ui->buttonBox->setEnabled(!readOnly);
 }
+
+QPlainTextEdit *ScriptProgressDialog::setLogsAvailable()
+{
+    ui->logsPanel->show();
+    return ui->logsPanel;
+}

src/core/scriptprogressdialog.h

@@ -15,6 +15,7 @@
 namespace Ui {
 class ScriptProgressDialog;
 }
+class QPlainTextEdit;
 
 class ScriptProgressDialog : public QDialog
 {
@@ -34,6 +35,8 @@ class ScriptProgressDialog : public QDialog
 
     int value() const;
 
+    QPlainTextEdit *setLogsAvailable();
+
 signals:
     void apply();
     void abort();

src/core/scriptprogressdialog.ui

@@ -7,7 +7,7 @@
     <x>0</x>
     <y>0</y>
     <width>360</width>
-    <height>94</height>
+    <height>189</height>
    </rect>
   </property>
   <property name="minimumSize">
@@ -48,6 +48,9 @@
      </property>
     </widget>
    </item>
+   <item row="3" column="0">
+    <widget class="QPlainTextEdit" name="logsPanel"/>
+   </item>
   </layout>
  </widget>
  <resources>