Fix #14516 (Review progress messages)

Author: danmar

lib/cppcheck.cpp

@@ -1316,6 +1316,8 @@ void CppCheck::internalError(const std::string &filename, const std::string &msg
 
 void CppCheck::checkNormalTokens(const Tokenizer &tokenizer, AnalyzerInformation* analyzerInformation, const std::string& currentConfig)
 {
+    ProgressReporter(mErrorLogger, mSettings.reportProgress >= 0, tokenizer.list.getSourceFilePath(), "Run checkers");
+
     CheckUnusedFunctions unusedFunctionsChecker;
 
     // TODO: this should actually be the behavior if only "--enable=unusedFunction" is specified - see #10648

lib/errorlogger.h

@@ -26,6 +26,7 @@
 
 #include <cstddef>
 #include <cstdint>
+#include <ctime>
 #include <list>
 #include <set>
 #include <string>
@@ -286,6 +287,41 @@ class CPPCHECKLIB ErrorLogger {
     static const std::set<std::string> mCriticalErrorIds;
 };
 
+/// RAII class for reporting progress messages
+class CPPCHECKLIB ProgressReporter {
+public:
+    ProgressReporter(ErrorLogger& e, bool reportProgress, const std::string& filename, const std::string& stage) :
+        errorLogger(e),
+        reportProgress(reportProgress),
+        filename(filename),
+        stage(stage) {
+        if (reportProgress)
+            errorLogger.reportProgress(filename, stage.c_str(), 0);
+    }
+
+    ~ProgressReporter() {
+        if (reportProgress)
+            errorLogger.reportProgress(filename, stage.c_str(), 100);
+    }
+
+    void report(int value) {
+        if (!reportProgress)
+            return;
+        const auto t = std::time(nullptr);
+        if (t != lastTime) {
+            errorLogger.reportProgress(filename, stage.c_str(), value);
+            lastTime = t;
+        }
+    }
+
+private:
+    ErrorLogger& errorLogger;
+    const bool reportProgress;
+    const std::string filename;
+    const std::string stage;
+    std::time_t lastTime{0};
+};
+
 /** Replace substring. Example replaceStr("1,NR,3", "NR", "2") => "1,2,3" */
 std::string replaceStr(std::string s, const std::string &from, const std::string &to);
 

lib/symboldatabase.cpp

@@ -174,8 +174,6 @@ void SymbolDatabase::createSymbolDatabaseFindAllScopes()
     // Store current access in each scope (depends on evaluation progress)
     std::map<const Scope*, AccessControl> access;
 
-    const bool doProgress = (mSettings.reportProgress != -1);
-
     std::map<Scope *, std::set<std::string>> forwardDecls;
 
     const std::function<Scope *(const Token *, Scope *)> findForwardDeclScope = [&](const Token *tok, Scope *startScope) {
@@ -200,13 +198,14 @@ void SymbolDatabase::createSymbolDatabaseFindAllScopes()
         return it->second.count(tok->str()) > 0 ? startScope : nullptr;
     };
 
+    ProgressReporter progressReporter(mErrorLogger, (mSettings.reportProgress >= 0), mTokenizer.list.getSourceFilePath(), "SymbolDatabase (find all scopes)");
+
     // find all scopes
     for (const Token *tok = mTokenizer.tokens(); tok; tok = tok ? tok->next() : nullptr) {
         // #5593 suggested to add here:
-        if (doProgress)
-            mErrorLogger.reportProgress(mTokenizer.list.getSourceFilePath(),
-                                        "SymbolDatabase",
-                                        tok->progressValue());
+
+        progressReporter.report(tok->progressValue());
+
         // Locate next class
         if ((tok->isCpp() && tok->isKeyword() &&
              ((Token::Match(tok, "class|struct|union|namespace ::| %name% final| {|:|::|<") &&

lib/tokenize.cpp

@@ -1167,11 +1167,10 @@ void Tokenizer::simplifyTypedefCpp()
     std::vector<Space> spaceInfo(1);
 
     const std::time_t maxTime = mSettings.typedefMaxTime > 0 ? std::time(nullptr) + mSettings.typedefMaxTime: 0;
-    const bool doProgress = (mSettings.reportProgress != -1) && !list.getFiles().empty();
+    ProgressReporter progressReporter(mErrorLogger, (mSettings.reportProgress >= 0), list.getSourceFilePath(), "Tokenize (typedef)");
 
     for (Token *tok = list.front(); tok; tok = tok->next()) {
-        if (doProgress)
-            mErrorLogger.reportProgress(list.getFiles()[0], "Tokenize (typedef)", tok->progressValue());
+        progressReporter.report(tok->progressValue());
 
         if (Settings::terminated())
             return;
@@ -2932,11 +2931,10 @@ bool Tokenizer::simplifyUsing()
     };
     std::list<Using> usingList;
 
-    const bool doProgress = (mSettings.reportProgress != -1) && !list.getFiles().empty();
+    ProgressReporter progressReporter(mErrorLogger, (mSettings.reportProgress >= 0), list.getSourceFilePath(), "Tokenize (using)");
 
     for (Token *tok = list.front(); tok; tok = tok->next()) {
-        if (doProgress)
-            mErrorLogger.reportProgress(list.getFiles()[0], "Tokenize (using)", tok->progressValue());
+        progressReporter.report(tok->progressValue());
 
         if (Settings::terminated())
             return substitute;

lib/valueflow.cpp

@@ -7202,7 +7202,9 @@ struct ValueFlowPassRunner {
         std::size_t n = state.settings.vfOptions.maxIterations;
         while (n > 0 && values != getTotalValues()) {
             values = getTotalValues();
+            const std::string passnum = std::to_string(state.settings.vfOptions.maxIterations - n + 1);
             if (std::any_of(passes.begin(), passes.end(), [&](const ValuePtr<ValueFlowPass>& pass) {
+                ProgressReporter progressReporter(state.errorLogger, state.settings.reportProgress >= 0, state.tokenlist.getSourceFilePath(), std::string("ValueFlow::") + pass->name() + (' ' + passnum));
                 return run(pass);
             }))
                 return true;
@@ -7346,6 +7348,8 @@ void ValueFlow::setValues(TokenList& tokenlist,
                           const Settings& settings,
                           TimerResultsIntf* timerResults)
 {
+    ProgressReporter progressReporter(errorLogger, settings.reportProgress >= 0, tokenlist.getSourceFilePath(), "ValueFlow");
+
     for (Token* tok = tokenlist.front(); tok; tok = tok->next())
         tok->clearValueFlow();