Add startCheck, finishCheck and threadDetailsUpdated signals/slots

Author: ludviggunne

gui/checkthread.cpp

@@ -147,9 +147,14 @@ void CheckThread::run()
     while (file && mState == Running) {
         const std::string& fname = file->spath();
         qDebug() << "Checking file" << QString::fromStdString(fname);
+
+        const Details details = { mThreadIndex, fname, QTime::currentTime(), };
+        emit startCheck(details);
+
         cppcheck.check(*file);
         runAddonsAndTools(mSettings, nullptr, QString::fromStdString(fname));
-        emit fileChecked(QString::fromStdString(fname));
+
+        emit finishCheck(details);
 
         if (mState == Running)
             mResult.getNextFile(file);
@@ -160,9 +165,15 @@ void CheckThread::run()
     while (fileSettings && mState == Running) {
         const std::string& fname = fileSettings->filename();
         qDebug() << "Checking file" << QString::fromStdString(fname);
-        cppcheck.check(*fileSettings);
+
+        const Details details = { mThreadIndex, fname, QTime::currentTime(), };
+        emit startCheck(details);
+
+        cppcheck.check(*file);
         runAddonsAndTools(mSettings, fileSettings, QString::fromStdString(fname));
-        emit fileChecked(QString::fromStdString(fname));
+
+        emit finishCheck(details);
+
 
         if (mState == Running)
             mResult.getNextFileSettings(fileSettings);

gui/checkthread.h

@@ -36,6 +36,7 @@
 #include <QString>
 #include <QStringList>
 #include <QThread>
+#include <QTime>
 
 class ThreadResult;
 
@@ -48,6 +49,14 @@ class ThreadResult;
  */
 class CheckThread : public QThread {
     Q_OBJECT
+
+public:
+    struct Details {
+        int index;
+        std::string file;
+        QTime startTime;
+    };
+
 public:
     explicit CheckThread(ThreadResult &result);
 
@@ -104,8 +113,8 @@ class CheckThread : public QThread {
      */
     void done();
 
-    // NOLINTNEXTLINE(readability-inconsistent-declaration-parameter-name) - caused by generated MOC code
-    void fileChecked(const QString &file);
+    void startCheck(CheckThread::Details details);
+    void finishCheck(CheckThread::Details details);
 protected:
 
     /**

gui/threadhandler.cpp

@@ -150,8 +150,12 @@ void ThreadHandler::createThreads(const int count)
         mThreads.last()->setThreadIndex(i + 1);
         connect(mThreads.last(), &CheckThread::done,
                 this, &ThreadHandler::threadDone, Qt::QueuedConnection);
-        connect(mThreads.last(), &CheckThread::fileChecked,
-                &mResults, &ThreadResult::fileChecked, Qt::QueuedConnection);
+        connect(mThreads.last(), &CheckThread::finishCheck,
+                &mResults, &ThreadResult::finishCheck, Qt::QueuedConnection);
+        connect(mThreads.last(), &CheckThread::startCheck,
+                this, &ThreadHandler::startCheck, Qt::QueuedConnection);
+        connect(mThreads.last(), &CheckThread::finishCheck,
+                this, &ThreadHandler::finishCheck, Qt::QueuedConnection);
     }
 }
 
@@ -165,8 +169,12 @@ void ThreadHandler::removeThreads()
         }
         disconnect(thread, &CheckThread::done,
                    this, &ThreadHandler::threadDone);
-        disconnect(thread, &CheckThread::fileChecked,
-                   &mResults, &ThreadResult::fileChecked);
+        disconnect(thread, &CheckThread::finishCheck,
+                   &mResults, &ThreadResult::finishCheck);
+        disconnect(mThreads.last(), &CheckThread::startCheck,
+                   this, &ThreadHandler::startCheck);
+        disconnect(mThreads.last(), &CheckThread::finishCheck,
+                   this, &ThreadHandler::finishCheck);
         delete thread;
     }
 
@@ -318,3 +326,29 @@ void ThreadHandler::setCheckStartTime(QDateTime checkStartTime)
 {
     mCheckStartTime = std::move(checkStartTime);
 }
+
+void ThreadHandler::startCheck(CheckThread::Details details)
+{
+    mThreadDetails[details.index] = details;
+    emit threadDetailsUpdated(buildThreadDetailsText());
+}
+
+void ThreadHandler::finishCheck(CheckThread::Details details)
+{
+    mThreadDetails.erase(details.index);
+    emit threadDetailsUpdated(buildThreadDetailsText());
+}
+
+QString ThreadHandler::buildThreadDetailsText() const
+{
+    QString result;
+
+    for (const auto &details : mThreadDetails) {
+        result += QString("Thread %1 (%2): %3\n")
+            .arg(details.second.index)
+            .arg(details.second.startTime.toString(Qt::TextDate))
+            .arg(QString::fromStdString(details.second.file));
+    }
+
+    return result;
+}

gui/threadhandler.h

@@ -191,13 +191,33 @@ class ThreadHandler : public QObject {
     // NOLINTNEXTLINE(readability-inconsistent-declaration-parameter-name) - caused by generated MOC code
     void debugError(const ErrorItem &item);
 
+    /**
+     * @brief Emitted when thread details are updated.
+     *
+     * @param text Text for the ThreadDetails widget to display
+     */
+    void threadDetailsUpdated(const QString &text);
+
 public slots:
 
     /**
      * @brief Slot to stop all threads
      *
      */
     void stop();
+
+    /**
+     * @brief Slot threads use to signal this class that it started checking a file
+     * @param details Details about what file is being checked and by what thread
+     */
+    void startCheck(CheckThread::Details details);
+
+    /**
+     * @brief Slot threads use to signal this class that it finish checking a file
+     * @param details Details about what file finished being checked and by what thread
+     */
+    void finishCheck(CheckThread::Details details);
+
 protected slots:
     /**
      * @brief Slot that a single thread is done
@@ -285,13 +305,21 @@ protected slots:
     Settings mCheckSettings;
     std::shared_ptr<Suppressions> mCheckSuppressions;
     /// @}
+
+    /**
+     * @bried Details about currently running threads
+     */
+    std::map<int, CheckThread::Details> mThreadDetails;
+
 private:
 
     /**
      * @brief Check if a file needs to be rechecked. Recursively checks
      * included headers. Used by GetReCheckFiles()
      */
     bool needsReCheck(const QString &filename, std::set<QString> &modified, std::set<QString> &unmodified) const;
+
+    QString buildThreadDetailsText() const;
 };
 /// @}
 #endif // THREADHANDLER_H

gui/threadresult.cpp

@@ -34,11 +34,11 @@ void ThreadResult::reportOut(const std::string &outmsg, Color /*c*/)
     emit log(QString::fromStdString(outmsg));
 }
 
-void ThreadResult::fileChecked(const QString &file)
+void ThreadResult::finishCheck(CheckThread::Details details)
 {
     std::lock_guard<std::mutex> locker(mutex);
 
-    mProgress += QFile(file).size();
+    mProgress += QFile(QString::fromStdString(details.file)).size();
     mFilesChecked++;
 
     if (mMaxProgress > 0) {

gui/threadresult.h

@@ -85,12 +85,12 @@ class ThreadResult : public QObject, public ErrorLogger {
     }
 
 public slots:
-
     /**
-     * @brief Slot threads use to signal this class that a specific file is checked
-     * @param file File that is checked
+     * @brief Slot threads use to signal this class that it finish checking a file
+     * @param details Details about what file finished being checked and by what thread
      */
-    void fileChecked(const QString &file);
+    void finishCheck(CheckThread::Details details);
+
 signals:
     /**
      * @brief Progress signal