Refactoring information messages.

kimmov · kimmov · commit 68c52ddd699e · 2012-06-19T00:16:20.000+03:00
Currently the information severity messages are outputted as error
messages with Severity::Information. This causes constant confusion
as people think it as mildest error severity (and rightfully so).
When it was meant to be for printing messages about the checking
procedure itself (like missing header files etc).

So I'm adding a new function for the ErrorLogger for printing these
informative messages. This makes clear the distinction of errors
found from the code and messages related to the checking itself.
It also makes it easier for clients to handle these separately.
diff --git a/cli/cppcheckexecutor.cpp b/cli/cppcheckexecutor.cpp
@@ -207,7 +207,7 @@ int CppCheckExecutor::check(int argc, const char* const argv[])
                                           "--check-config.",
                                           "missingInclude",
                                           false);
-            reportErr(msg);
+            reportInfo(msg);
         }
     }
 
@@ -265,6 +265,11 @@ void CppCheckExecutor::reportProgress(const std::string &filename, const char st
     }
 }
 
+void CppCheckExecutor::reportInfo(const ErrorLogger::ErrorMessage &msg)
+{
+    reportOut(msg.toXML(false, _settings._xml_version));
+}
+
 void CppCheckExecutor::reportStatus(size_t fileindex, size_t filecount, size_t sizedone, size_t sizetotal)
 {
     if (filecount > 1) {
diff --git a/cli/cppcheckexecutor.h b/cli/cppcheckexecutor.h
@@ -72,6 +72,11 @@ class CppCheckExecutor : public ErrorLogger {
 
     void reportProgress(const std::string &filename, const char stage[], const unsigned int value);
 
+    /**
+     * Output information messages.
+     */
+    virtual void reportInfo(const ErrorLogger::ErrorMessage &msg);
+
     /**
      * Information about how many files have been checked
      *
diff --git a/cli/threadexecutor.cpp b/cli/threadexecutor.cpp
@@ -290,6 +290,11 @@ void ThreadExecutor::reportErr(const ErrorLogger::ErrorMessage &msg)
     writeToPipe(REPORT_ERROR, msg.serialize());
 }
 
+void ThreadExecutor::reportInfo(const ErrorLogger::ErrorMessage &msg)
+{
+    writeToPipe(REPORT_OUT, msg.serialize());
+}
+
 #else
 
 void ThreadExecutor::addFileContent(const std::string &/*path*/, const std::string &/*content*/)
@@ -311,4 +316,9 @@ void ThreadExecutor::reportErr(const ErrorLogger::ErrorMessage &/*msg*/)
 
 }
 
+void ThreadExecutor::reportInfo(const ErrorLogger::ErrorMessage &msg)
+{
+
+}
+
 #endif
diff --git a/cli/threadexecutor.h b/cli/threadexecutor.h
@@ -44,6 +44,7 @@ class ThreadExecutor : public ErrorLogger {
     unsigned int check();
     virtual void reportOut(const std::string &outmsg);
     virtual void reportErr(const ErrorLogger::ErrorMessage &msg);
+    virtual void reportInfo(const ErrorLogger::ErrorMessage &msg);
 
     /**
      * @brief Add content to a file, to be used in unit testing.
diff --git a/lib/cppcheck.cpp b/lib/cppcheck.cpp
@@ -209,8 +209,7 @@ unsigned int CppCheck::processFile(const std::string& filename)
                                                  "toomanyconfigs",
                                                  false);
 
-                reportErr(errmsg);
-
+                reportInfo(errmsg);
                 break;
             }
 
@@ -512,6 +511,11 @@ void CppCheck::reportProgress(const std::string &filename, const char stage[], c
     _errorLogger.reportProgress(filename, stage, value);
 }
 
+void CppCheck::reportInfo(const ErrorLogger::ErrorMessage &msg)
+{
+    _errorLogger.reportInfo(msg);
+}
+
 void CppCheck::reportStatus(unsigned int /*fileindex*/, unsigned int /*filecount*/, size_t /*sizedone*/, size_t /*sizetotal*/)
 {
 
diff --git a/lib/cppcheck.h b/lib/cppcheck.h
@@ -175,6 +175,11 @@ class CPPCHECKLIB CppCheck : ErrorLogger {
 
     void reportProgress(const std::string &filename, const char stage[], const unsigned int value);
 
+    /**
+     * Output information messages.
+     */
+    virtual void reportInfo(const ErrorLogger::ErrorMessage &msg);
+
     CheckUnusedFunctions _checkUnusedFunctions;
     ErrorLogger &_errorLogger;
 
diff --git a/lib/errorlogger.h b/lib/errorlogger.h
@@ -266,8 +266,7 @@ class CPPCHECKLIB ErrorLogger {
      * Information about found errors and warnings is directed
      * here. Override this to receive the errormessages.
      *
-     * @param msg Location and other information about the found.
-     * error
+     * @param msg Location and other information about the found error.
      */
     virtual void reportErr(const ErrorLogger::ErrorMessage &msg) = 0;
 
@@ -283,6 +282,12 @@ class CPPCHECKLIB ErrorLogger {
         (void)value;
     }
 
+    /**
+     * Output information messages.
+     * @param msg Location and other information about the found error.
+     */
+    virtual void reportInfo(const ErrorLogger::ErrorMessage &msg) = 0;
+
     /**
      * Report list of unmatched suppressions
      * @param unmatched list of unmatched suppressions (from Settings::Suppressions::getUnmatched(Local|Global)Suppressions)
diff --git a/lib/preprocessor.cpp b/lib/preprocessor.cpp
@@ -2100,7 +2100,7 @@ void Preprocessor::missingInclude(const std::string &filename, unsigned int line
     const std::string id = userheader ? "missingInclude" : "debug";
     ErrorLogger::ErrorMessage errmsg(locationList, severity, "Include file: \"" + header + "\" not found.", id, false);
     errmsg.file0 = file0;
-    _errorLogger->reportErr(errmsg);
+    errorLogger->reportInfo(errmsg);
 }
 
 /**

Original file line number	Diff line number	Diff line change
`@@ -207,7 +207,7 @@ int CppCheckExecutor::check(int argc, const char* const argv[])`
`207`	`207`	`"--check-config.",`
`208`	`208`	`"missingInclude",`
`209`	`209`	`false);`
`210`		`- reportErr(msg);`
	`210`	`+ reportInfo(msg);`
`211`	`211`	`}`
`212`	`212`	`}`
`213`	`213`
`@@ -265,6 +265,11 @@ void CppCheckExecutor::reportProgress(const std::string &filename, const char st`
`265`	`265`	`}`
`266`	`266`	`}`
`267`	`267`
	`268`	`+void CppCheckExecutor::reportInfo(const ErrorLogger::ErrorMessage &msg)`
	`269`	`+{`
	`270`	`+ reportOut(msg.toXML(false, _settings._xml_version));`
	`271`	`+}`
	`272`	`+`
`268`	`273`	`void CppCheckExecutor::reportStatus(size_t fileindex, size_t filecount, size_t sizedone, size_t sizetotal)`
`269`	`274`	`{`
`270`	`275`	`if (filecount > 1) {`
Original file line number	Diff line number	Diff line change
`@@ -209,8 +209,7 @@ unsigned int CppCheck::processFile(const std::string& filename)`
`209`	`209`	`"toomanyconfigs",`
`210`	`210`	`false);`
`211`	`211`
`212`		`- reportErr(errmsg);`
`213`		`-`
	`212`	`+ reportInfo(errmsg);`
`214`	`213`	`break;`
`215`	`214`	`}`
`216`	`215`
`@@ -512,6 +511,11 @@ void CppCheck::reportProgress(const std::string &filename, const char stage[], c`
`512`	`511`	`_errorLogger.reportProgress(filename, stage, value);`
`513`	`512`	`}`
`514`	`513`
	`514`	`+void CppCheck::reportInfo(const ErrorLogger::ErrorMessage &msg)`
	`515`	`+{`
	`516`	`+ _errorLogger.reportInfo(msg);`
	`517`	`+}`
	`518`	`+`
`515`	`519`	`void CppCheck::reportStatus(unsigned int /fileindex/, unsigned int /filecount/, size_t /sizedone/, size_t /sizetotal/)`
`516`	`520`	`{`
`517`	`521`
Original file line number	Diff line number	Diff line change
`@@ -2100,7 +2100,7 @@ void Preprocessor::missingInclude(const std::string &filename, unsigned int line`
`2100`	`2100`	`const std::string id = userheader ? "missingInclude" : "debug";`
`2101`	`2101`	`ErrorLogger::ErrorMessage errmsg(locationList, severity, "Include file: \"" + header + "\" not found.", id, false);`
`2102`	`2102`	`errmsg.file0 = file0;`
`2103`		`- _errorLogger->reportErr(errmsg);`
	`2103`	`+ errorLogger->reportInfo(errmsg);`
`2104`	`2104`	`}`
`2105`	`2105`
`2106`	`2106`	`/**`