improved progress output. Show progress messages in the ThreadDetails

Author: danmar

gui/checkthread.h

@@ -111,8 +111,8 @@ class CheckThread : public QThread {
      */
     void done();
 
-    void startCheck(CheckThread::Details details);
-    void finishCheck(CheckThread::Details details);
+    void startCheck(const CheckThread::Details& details);
+    void finishCheck(const CheckThread::Details& details);
 protected:
 
     /**

gui/mainwindow.cpp

@@ -1071,6 +1071,7 @@ bool MainWindow::getCppcheckSettings(Settings& settings, Suppressions& supprs)
 
     settings.exename = QCoreApplication::applicationFilePath().toStdString();
     settings.templateFormat = "{file}:{line}:{column}: {severity}:{inconclusive:inconclusive:} {message} [{id}]";
+    settings.reportProgress = 10;
 
     // default to --check-level=normal for GUI for now
     settings.setCheckLevel(Settings::CheckLevel::normal);
@@ -2118,6 +2119,8 @@ void MainWindow::showThreadDetails()
     auto* threadDetails = new ThreadDetails(this);
     connect(mThread, &ThreadHandler::threadDetailsUpdated,
             threadDetails, &ThreadDetails::threadDetailsUpdated, Qt::QueuedConnection);
+    connect(mThread, &ThreadHandler::progress,
+            threadDetails, &ThreadDetails::progress, Qt::QueuedConnection);
     threadDetails->setAttribute(Qt::WA_DeleteOnClose);
     threadDetails->show();
     mThread->emitThreadDetailsUpdated();

gui/resultsview.cpp

@@ -162,7 +162,7 @@ void ResultsView::setResultsSource(ResultsTree::ResultsSource source)
     mUI->mTree->setResultsSource(source);
 }
 
-void ResultsView::progress(int value, const QString& description)
+void ResultsView::filesCheckedProgress(int value, const QString& description)
 {
     mUI->mProgress->setValue(value);
     mUI->mProgress->setFormat(QString("%p% (%1)").arg(description));

gui/resultsview.h

@@ -307,7 +307,7 @@ public slots:
      * @param value Current progress value
      * @param description Description to accompany the progress
      */
-    void progress(int value, const QString& description);
+    void filesCheckedProgress(int value, const QString& description);
 
     /**
      * @brief Slot for new error to be displayed

gui/threaddetails.cpp

@@ -1,6 +1,8 @@
 #include "threaddetails.h"
 #include "ui_threaddetails.h"
 
+#include <QMutexLocker>
+
 ThreadDetails* ThreadDetails::mInstance;
 
 ThreadDetails::ThreadDetails(QWidget *parent)
@@ -10,6 +12,8 @@ ThreadDetails::ThreadDetails(QWidget *parent)
     mInstance = this;
     setWindowFlags(Qt::Window);
     mUi->setupUi(this);
+    connect(&mTimer, &QTimer::timeout, this, &ThreadDetails::updateUI);
+    mTimer.start(1000);
 }
 
 ThreadDetails::~ThreadDetails()
@@ -20,9 +24,28 @@ ThreadDetails::~ThreadDetails()
 
 void ThreadDetails::threadDetailsUpdated(const QMap<int, CheckThread::Details>& threadDetails)
 {
-    QString text("Thread\tStart time\tFile\n");
-    for (const auto& td: threadDetails) {
-        text += QString("%1\t%2\t%3\n").arg(td.threadIndex).arg(td.startTime.toString(Qt::TextDate)).arg(td.file);
+    QMutexLocker locker(&mMutex);
+    mThreadDetails = threadDetails;
+    if (threadDetails.empty()) {
+        mProgress.clear();
+    }
+}
+
+void ThreadDetails::progress(const QString &filename, const QString& stage, const std::size_t value) {
+    QMutexLocker locker(&mMutex);
+    mProgress[filename] = {QString(), stage + QString(value > 0 ? ": %1%" : "").arg(value)};
+}
+
+void ThreadDetails::updateUI() {
+    QString text("Thread\tStart time\tFile/Progress\n");
+    {
+        QMutexLocker locker(&mMutex);
+        for (const auto& td: mThreadDetails) {
+            auto& progress = mProgress[td.file];
+            if (progress.first.isEmpty() && !progress.second.isEmpty())
+                progress.first = QTime::currentTime().toString(Qt::TextDate);
+            text += QString("%1\t%2\t%3\n\t%4\t%5\n").arg(td.threadIndex).arg(td.startTime.toString(Qt::TextDate)).arg(td.file).arg(progress.first).arg(progress.second);
+        }
     }
     mUi->plainTextEdit->setPlainText(text);
 }

gui/threaddetails.h

@@ -3,6 +3,8 @@
 
 #include <QWidget>
 #include <QMap>
+#include <QMutex>
+#include <QTimer>
 #include "checkthread.h"
 
 namespace Ui {
@@ -23,10 +25,20 @@ class ThreadDetails : public QWidget
 
 public slots:
     void threadDetailsUpdated(const QMap<int, CheckThread::Details>& threadDetails);
+    void progress(const QString &filename, const QString& stage, const std::size_t value);
+
+private slots:
+    void updateUI();
 
 private:
     static ThreadDetails* mInstance;
     Ui::ThreadDetails *mUi;
+    QMap<QString, QPair<QString,QString>> mProgress;
+    QMap<int, CheckThread::Details> mThreadDetails;
+    QTimer mTimer;
+
+    /** accessing mProgress and mThreadDetails in slots that are triggered from different threads */
+    QMutex mMutex;
 };
 
 #endif // THREADDETAILS_H

gui/threadhandler.cpp

@@ -223,8 +223,8 @@ void ThreadHandler::stop()
 
 void ThreadHandler::initialize(const ResultsView *view)
 {
-    connect(&mResults, &ThreadResult::progress,
-            view, &ResultsView::progress);
+    connect(&mResults, &ThreadResult::filesCheckedProgress,
+            view, &ResultsView::filesCheckedProgress);
 
     connect(&mResults, &ThreadResult::error,
             view, &ResultsView::error);
@@ -234,6 +234,9 @@ void ThreadHandler::initialize(const ResultsView *view)
 
     connect(&mResults, &ThreadResult::debugError,
             this, &ThreadHandler::debugError);
+
+    connect(&mResults, &ThreadResult::progress,
+            this, &ThreadHandler::progress);
 }
 
 void ThreadHandler::loadSettings(const QSettings &settings)

gui/threadhandler.h

@@ -221,6 +221,9 @@ public slots:
      */
     void finishCheck(const CheckThread::Details& details);
 
+signals:
+    void progress(const QString &filename, const QString& stage, const std::size_t value);
+
 protected slots:
     /**
      * @brief Slot that a single thread is done

gui/threadresult.cpp

@@ -39,14 +39,14 @@ void ThreadResult::finishCheck(const CheckThread::Details& details)
 {
     std::lock_guard<std::mutex> locker(mutex);
 
-    mProgress += QFile(details.file).size();
+    mCheckedFileSize += QFile(details.file).size();
     mFilesChecked++;
 
-    if (mMaxProgress > 0) {
-        const int value = static_cast<int>(PROGRESS_MAX * mProgress / mMaxProgress);
+    if (mTotalFileSize > 0) {
+        const int value = static_cast<int>(PROGRESS_MAX * mCheckedFileSize / mTotalFileSize);
         const QString description = tr("%1 of %2 files checked").arg(mFilesChecked).arg(mTotalFiles);
 
-        emit progress(value, description);
+        emit filesCheckedProgress(value, description);
     }
 }
 
@@ -60,6 +60,10 @@ void ThreadResult::reportErr(const ErrorMessage &msg)
         emit debugError(item);
 }
 
+void ThreadResult::reportProgress(const std::string &filename, const char stage[], const std::size_t value) {
+    emit progress(QString::fromStdString(filename), stage, value);
+}
+
 void ThreadResult::getNextFile(const FileWithDetails*& file)
 {
     std::lock_guard<std::mutex> locker(mutex);
@@ -88,15 +92,15 @@ void ThreadResult::setFiles(std::list<FileWithDetails> files)
     mTotalFiles = files.size();
     mFiles = std::move(files);
     mItNextFile = mFiles.cbegin();
-    mProgress = 0;
+    mCheckedFileSize = 0;
     mFilesChecked = 0;
 
     // Determine the total size of all of the files to check, so that we can
     // show an accurate progress estimate
     quint64 sizeOfFiles = std::accumulate(mFiles.cbegin(), mFiles.cend(), 0, [](quint64 total, const FileWithDetails& file) {
         return total + file.size();
     });
-    mMaxProgress = sizeOfFiles;
+    mTotalFileSize = sizeOfFiles;
 }
 
 void ThreadResult::setProject(const ImportProject &prj)
@@ -106,13 +110,13 @@ void ThreadResult::setProject(const ImportProject &prj)
     mItNextFile = mFiles.cbegin();
     mFileSettings = prj.fileSettings;
     mItNextFileSettings = mFileSettings.cbegin();
-    mProgress = 0;
+    mCheckedFileSize = 0;
     mFilesChecked = 0;
     mTotalFiles = prj.fileSettings.size();
 
     // Determine the total size of all of the files to check, so that we can
     // show an accurate progress estimate
-    mMaxProgress = std::accumulate(prj.fileSettings.begin(), prj.fileSettings.end(), quint64{ 0 }, [](quint64 v, const FileSettings& fs) {
+    mTotalFileSize = std::accumulate(prj.fileSettings.begin(), prj.fileSettings.end(), quint64{ 0 }, [](quint64 v, const FileSettings& fs) {
         return v + QFile(QString::fromStdString(fs.filename())).size();
     });
 }

gui/threadresult.h

@@ -84,6 +84,7 @@ class ThreadResult : public QObject, public ErrorLogger {
     {
         (void) metric;
     }
+    void reportProgress(const std::string &filename, const char stage[], const std::size_t value) override;
 
 public slots:
 
@@ -97,10 +98,10 @@ public slots:
     /**
      * @brief Files checked progress
      * @param value Current progress (0 - PROGRESS_MAX)
-     * @param description Description of the current stage (example: 13/45 files checked)
+     * @param description Description of the current stage (example: "13/45 files checked")
      */
     // NOLINTNEXTLINE(readability-inconsistent-declaration-parameter-name) - caused by generated MOC code
-    void progress(int value, const QString& description);
+    void filesCheckedProgress(int value, const QString& description);
 
     /**
      * @brief Signal of a new error
@@ -126,6 +127,8 @@ public slots:
     // NOLINTNEXTLINE(readability-inconsistent-declaration-parameter-name) - caused by generated MOC code
     void debugError(const ErrorItem &item);
 
+    void progress(const QString &filename, const QString& stage, const std::size_t value);
+
 protected:
 
     /**
@@ -144,17 +147,11 @@ public slots:
     std::list<FileSettings> mFileSettings;
     std::list<FileSettings>::const_iterator mItNextFileSettings{mFileSettings.cbegin()};
 
-    /**
-     * @brief Max progress
-     *
-     */
-    quint64 mMaxProgress{};
+    /** @brief Total file size */
+    quint64 mTotalFileSize{};
 
-    /**
-     * @brief Current progress
-     *
-     */
-    quint64 mProgress{};
+    /** @brief File size of checked files */
+    quint64 mCheckedFileSize{};
 
     /**
      * @brief Current number of files checked