430 lines
14 KiB
C++
430 lines
14 KiB
C++
/*
|
|
* Cppcheck - A tool for static C/C++ code analysis
|
|
* Copyright (C) 2007-2019 Cppcheck team.
|
|
*
|
|
* This program is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation, either version 3 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
//---------------------------------------------------------------------------
|
|
#ifndef errorloggerH
|
|
#define errorloggerH
|
|
//---------------------------------------------------------------------------
|
|
|
|
#include "config.h"
|
|
#include "suppressions.h"
|
|
|
|
#include <cstddef>
|
|
#include <fstream>
|
|
#include <list>
|
|
#include <string>
|
|
#include <utility>
|
|
#include <vector>
|
|
|
|
/**
|
|
* CWE id (Common Weakness Enumeration)
|
|
* See https://cwe.mitre.org/ for further reference.
|
|
* */
|
|
struct CWE {
|
|
explicit CWE(unsigned short ID) : id(ID) {}
|
|
unsigned short id;
|
|
};
|
|
|
|
|
|
|
|
class Token;
|
|
class TokenList;
|
|
|
|
namespace tinyxml2 {
|
|
class XMLElement;
|
|
}
|
|
|
|
/// @addtogroup Core
|
|
/// @{
|
|
|
|
/** @brief Simple container to be thrown when internal error is detected. */
|
|
struct InternalError {
|
|
enum Type {AST, SYNTAX, UNKNOWN_MACRO, INTERNAL, LIMIT};
|
|
InternalError(const Token *tok, const std::string &errorMsg, Type type = INTERNAL);
|
|
const Token *token;
|
|
std::string errorMessage;
|
|
Type type;
|
|
std::string id;
|
|
};
|
|
|
|
/** @brief enum class for severity. Used when reporting errors. */
|
|
class CPPCHECKLIB Severity {
|
|
public:
|
|
/**
|
|
* Message severities.
|
|
*/
|
|
enum SeverityType {
|
|
/**
|
|
* No severity (default value).
|
|
*/
|
|
none,
|
|
/**
|
|
* Programming error.
|
|
* This indicates severe error like memory leak etc.
|
|
* The error is certain.
|
|
*/
|
|
error,
|
|
/**
|
|
* Warning.
|
|
* Used for dangerous coding style that can cause severe runtime errors.
|
|
* For example: forgetting to initialize a member variable in a constructor.
|
|
*/
|
|
warning,
|
|
/**
|
|
* Style warning.
|
|
* Used for general code cleanup recommendations. Fixing these
|
|
* will not fix any bugs but will make the code easier to maintain.
|
|
* For example: redundant code, unreachable code, etc.
|
|
*/
|
|
style,
|
|
/**
|
|
* Performance warning.
|
|
* Not an error as is but suboptimal code and fixing it probably leads
|
|
* to faster performance of the compiled code.
|
|
*/
|
|
performance,
|
|
/**
|
|
* Portability warning.
|
|
* This warning indicates the code is not properly portable for
|
|
* different platforms and bitnesses (32/64 bit). If the code is meant
|
|
* to compile in different platforms and bitnesses these warnings
|
|
* should be fixed.
|
|
*/
|
|
portability,
|
|
/**
|
|
* Checking information.
|
|
* Information message about the checking (process) itself. These
|
|
* messages inform about header files not found etc issues that are
|
|
* not errors in the code but something user needs to know.
|
|
*/
|
|
information,
|
|
/**
|
|
* Debug message.
|
|
* Debug-mode message useful for the developers.
|
|
*/
|
|
debug
|
|
};
|
|
|
|
static std::string toString(SeverityType severity) {
|
|
switch (severity) {
|
|
case none:
|
|
return "";
|
|
case error:
|
|
return "error";
|
|
case warning:
|
|
return "warning";
|
|
case style:
|
|
return "style";
|
|
case performance:
|
|
return "performance";
|
|
case portability:
|
|
return "portability";
|
|
case information:
|
|
return "information";
|
|
case debug:
|
|
return "debug";
|
|
}
|
|
throw InternalError(nullptr, "Unknown severity");
|
|
}
|
|
static SeverityType fromString(const std::string &severity) {
|
|
if (severity.empty())
|
|
return none;
|
|
if (severity == "none")
|
|
return none;
|
|
if (severity == "error")
|
|
return error;
|
|
if (severity == "warning")
|
|
return warning;
|
|
if (severity == "style")
|
|
return style;
|
|
if (severity == "performance")
|
|
return performance;
|
|
if (severity == "portability")
|
|
return portability;
|
|
if (severity == "information")
|
|
return information;
|
|
if (severity == "debug")
|
|
return debug;
|
|
return none;
|
|
}
|
|
};
|
|
|
|
|
|
typedef std::pair<const Token *, std::string> ErrorPathItem;
|
|
typedef std::list<ErrorPathItem> ErrorPath;
|
|
|
|
/**
|
|
* @brief This is an interface, which the class responsible of error logging
|
|
* should implement.
|
|
*/
|
|
class CPPCHECKLIB ErrorLogger {
|
|
protected:
|
|
std::ofstream plistFile;
|
|
public:
|
|
|
|
/**
|
|
* Wrapper for error messages, provided by reportErr()
|
|
*/
|
|
class CPPCHECKLIB ErrorMessage {
|
|
public:
|
|
/**
|
|
* File name and line number.
|
|
* Internally paths are stored with / separator. When getting the filename
|
|
* it is by default converted to native separators.
|
|
*/
|
|
class CPPCHECKLIB FileLocation {
|
|
public:
|
|
FileLocation()
|
|
: fileIndex(0), line(0), col(0) {
|
|
}
|
|
|
|
FileLocation(const std::string &file, int line)
|
|
: fileIndex(0), line(line), col(0), mOrigFileName(file), mFileName(file) {
|
|
}
|
|
|
|
FileLocation(const std::string &file, const std::string &info, int line)
|
|
: fileIndex(0), line(line), col(0), mOrigFileName(file), mFileName(file), mInfo(info) {
|
|
}
|
|
|
|
FileLocation(const Token* tok, const TokenList* tokenList);
|
|
FileLocation(const Token* tok, const std::string &info, const TokenList* tokenList);
|
|
|
|
/**
|
|
* Return the filename.
|
|
* @param convert If true convert path to native separators.
|
|
* @return filename.
|
|
*/
|
|
std::string getfile(bool convert = true) const;
|
|
|
|
std::string getOrigFile(bool convert = true) const;
|
|
|
|
/**
|
|
* Set the filename.
|
|
* @param file Filename to set.
|
|
*/
|
|
void setfile(const std::string &file);
|
|
|
|
/**
|
|
* @return the location as a string. Format: [file:line]
|
|
*/
|
|
std::string stringify() const;
|
|
|
|
unsigned int fileIndex;
|
|
int line; // negative value means "no line"
|
|
unsigned int col;
|
|
|
|
std::string getinfo() const {
|
|
return mInfo;
|
|
}
|
|
void setinfo(const std::string &i) {
|
|
mInfo = i;
|
|
}
|
|
|
|
private:
|
|
std::string mOrigFileName;
|
|
std::string mFileName;
|
|
std::string mInfo;
|
|
};
|
|
|
|
ErrorMessage(const std::list<FileLocation> &callStack,
|
|
const std::string& file1,
|
|
Severity::SeverityType severity,
|
|
const std::string &msg,
|
|
const std::string &id, bool inconclusive);
|
|
ErrorMessage(const std::list<FileLocation> &callStack,
|
|
const std::string& file1,
|
|
Severity::SeverityType severity,
|
|
const std::string &msg,
|
|
const std::string &id,
|
|
const CWE &cwe,
|
|
bool inconclusive);
|
|
ErrorMessage(const std::list<const Token*>& callstack,
|
|
const TokenList* list,
|
|
Severity::SeverityType severity,
|
|
const std::string& id,
|
|
const std::string& msg,
|
|
bool inconclusive);
|
|
ErrorMessage(const std::list<const Token*>& callstack,
|
|
const TokenList* list,
|
|
Severity::SeverityType severity,
|
|
const std::string& id,
|
|
const std::string& msg,
|
|
const CWE &cwe,
|
|
bool inconclusive);
|
|
ErrorMessage(const ErrorPath &errorPath,
|
|
const TokenList *tokenList,
|
|
Severity::SeverityType severity,
|
|
const char id[],
|
|
const std::string &msg,
|
|
const CWE &cwe,
|
|
bool inconclusive);
|
|
ErrorMessage();
|
|
explicit ErrorMessage(const tinyxml2::XMLElement * const errmsg);
|
|
|
|
/**
|
|
* Format the error message in XML format
|
|
*/
|
|
std::string toXML() const;
|
|
|
|
static std::string getXMLHeader();
|
|
static std::string getXMLFooter();
|
|
|
|
/**
|
|
* Format the error message into a string.
|
|
* @param verbose use verbose message
|
|
* @param templateFormat Empty string to use default output format
|
|
* or template to be used. E.g. "{file}:{line},{severity},{id},{message}"
|
|
* @param templateLocation Format Empty string to use default output format
|
|
* or template to be used. E.g. "{file}:{line},{info}"
|
|
* @return formatted string
|
|
*/
|
|
std::string toString(bool verbose,
|
|
const std::string &templateFormat = emptyString,
|
|
const std::string &templateLocation = emptyString) const;
|
|
|
|
std::string serialize() const;
|
|
bool deserialize(const std::string &data);
|
|
|
|
std::list<FileLocation> _callStack;
|
|
std::string _id;
|
|
|
|
/** source file (not header) */
|
|
std::string file0;
|
|
|
|
Severity::SeverityType _severity;
|
|
CWE _cwe;
|
|
bool _inconclusive;
|
|
|
|
/** set short and verbose messages */
|
|
void setmsg(const std::string &msg);
|
|
|
|
/** Short message (single line short message) */
|
|
const std::string &shortMessage() const {
|
|
return mShortMessage;
|
|
}
|
|
|
|
/** Verbose message (may be the same as the short message) */
|
|
const std::string &verboseMessage() const {
|
|
return mVerboseMessage;
|
|
}
|
|
|
|
/** Symbol names */
|
|
const std::string &symbolNames() const {
|
|
return mSymbolNames;
|
|
}
|
|
|
|
Suppressions::ErrorMessage toSuppressionsErrorMessage() const;
|
|
|
|
private:
|
|
/**
|
|
* Replace all occurrences of searchFor with replaceWith in the
|
|
* given source.
|
|
* @param source The string to modify
|
|
* @param searchFor What should be searched for
|
|
* @param replaceWith What will replace the found item
|
|
*/
|
|
static void findAndReplace(std::string &source, const std::string &searchFor, const std::string &replaceWith);
|
|
|
|
static std::string fixInvalidChars(const std::string& raw);
|
|
|
|
/** Short message */
|
|
std::string mShortMessage;
|
|
|
|
/** Verbose message */
|
|
std::string mVerboseMessage;
|
|
|
|
/** symbol names */
|
|
std::string mSymbolNames;
|
|
};
|
|
|
|
ErrorLogger() { }
|
|
virtual ~ErrorLogger() {
|
|
if (plistFile.is_open()) {
|
|
plistFile << ErrorLogger::plistFooter();
|
|
plistFile.close();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Information about progress is directed here.
|
|
* Override this to receive the progress messages.
|
|
*
|
|
* @param outmsg Message to show e.g. "Checking main.cpp..."
|
|
*/
|
|
virtual void reportOut(const std::string &outmsg) = 0;
|
|
|
|
/**
|
|
* 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.
|
|
*/
|
|
virtual void reportErr(const ErrorLogger::ErrorMessage &msg) = 0;
|
|
|
|
/**
|
|
* Report progress to client
|
|
* @param filename main file that is checked
|
|
* @param stage for example preprocess / tokenize / simplify / check
|
|
* @param value progress value (0-100)
|
|
*/
|
|
virtual void reportProgress(const std::string &filename, const char stage[], const std::size_t value) {
|
|
(void)filename;
|
|
(void)stage;
|
|
(void)value;
|
|
}
|
|
|
|
/**
|
|
* Output information messages.
|
|
* @param msg Location and other information about the found error.
|
|
*/
|
|
virtual void reportInfo(const ErrorLogger::ErrorMessage &msg) {
|
|
reportErr(msg);
|
|
}
|
|
|
|
/**
|
|
* Report unmatched suppressions
|
|
* @param unmatched list of unmatched suppressions (from Settings::Suppressions::getUnmatched(Local|Global)Suppressions)
|
|
* @return true is returned if errors are reported
|
|
*/
|
|
bool reportUnmatchedSuppressions(const std::list<Suppressions::Suppression> &unmatched);
|
|
|
|
static std::string callStackToString(const std::list<ErrorLogger::ErrorMessage::FileLocation> &callStack);
|
|
|
|
/**
|
|
* Convert XML-sensitive characters into XML entities
|
|
* @param str The input string containing XML-sensitive characters
|
|
* @return The output string containing XML entities
|
|
*/
|
|
static std::string toxml(const std::string &str);
|
|
|
|
static std::string plistHeader(const std::string &version, const std::vector<std::string> &files);
|
|
static std::string plistData(const ErrorLogger::ErrorMessage &msg);
|
|
static const char *plistFooter() {
|
|
return " </array>\r\n"
|
|
"</dict>\r\n"
|
|
"</plist>";
|
|
}
|
|
};
|
|
|
|
/** 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);
|
|
|
|
/// @}
|
|
//---------------------------------------------------------------------------
|
|
#endif // errorloggerH
|