Wrapper for error messages, provided by reportErr() More...

#include <errorlogger.h>

Classes
class	FileLocation
	File name and line number. More...

Public Member Functions
	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 ()

	ErrorMessage (const tinyxml2::XMLElement *const errmsg)

std::string	toXML () const
	Format the error message in XML format. More...

std::string	toString (bool verbose, const std::string &templateFormat=emptyString, const std::string &templateLocation=emptyString) const
	Format the error message into a string. More...

std::string	serialize () const

bool	deserialize (const std::string &data)

void	setmsg (const std::string &msg)
	set short and verbose messages More...

const std::string &	shortMessage () const
	Short message (single line short message) More...

const std::string &	verboseMessage () const
	Verbose message (may be the same as the short message) More...

const std::string &	symbolNames () const
	Symbol names. More...

Suppressions::ErrorMessage	toSuppressionsErrorMessage () const

Static Public Member Functions
static std::string	getXMLHeader ()

static std::string	getXMLFooter ()

Public Attributes
std::list< FileLocation >	callStack

std::string	id

std::string	file0
	For GUI rechecking; source file (not header) More...

std::string	function
	For GUI bug hunting; function name. More...

bool	incomplete
	For GUI bug hunting; incomplete analysis. More...

Severity::SeverityType	severity

CWE	cwe

bool	inconclusive

Static Private Member Functions
static void	findAndReplace (std::string &source, const std::string &searchFor, const std::string &replaceWith)
	Replace all occurrences of searchFor with replaceWith in the given source. More...

static std::string	fixInvalidChars (const std::string &raw)

Private Attributes
std::string	mShortMessage
	Short message. More...

std::string	mVerboseMessage
	Verbose message. More...

std::string	mSymbolNames
	symbol names More...

Detailed Description

Wrapper for error messages, provided by reportErr()

Definition at line 149 of file errorlogger.h.

Constructor & Destructor Documentation

◆ ErrorMessage() [1/7]

ErrorLogger::ErrorMessage::ErrorMessage	(	const std::list< FileLocation > &	callStack,
		const std::string &	file1,
		Severity::SeverityType	severity,
		const std::string &	msg,
		const std::string &	id,
		bool	inconclusive
	)

Definition at line 111 of file errorlogger.cpp.

References setmsg().

◆ ErrorMessage() [2/7]

ErrorLogger::ErrorMessage::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
	)

Definition at line 126 of file errorlogger.cpp.

References setmsg().

◆ ErrorMessage() [3/7]

ErrorLogger::ErrorMessage::ErrorMessage	(	const std::list< const Token *> &	callstack,
		const TokenList *	list,
		Severity::SeverityType	severity,
		const std::string &	id,
		const std::string &	msg,
		bool	inconclusive
	)

Definition at line 139 of file errorlogger.cpp.

References callStack, file0, TokenList::getFiles(), and setmsg().

◆ ErrorMessage() [4/7]

ErrorLogger::ErrorMessage::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
	)

Definition at line 158 of file errorlogger.cpp.

References callStack, file0, TokenList::getFiles(), and setmsg().

◆ ErrorMessage() [5/7]

ErrorLogger::ErrorMessage::ErrorMessage	(	const ErrorPath &	errorPath,
		const TokenList *	tokenList,
		Severity::SeverityType	severity,
		const char	id[],
		const std::string &	msg,
		const CWE &	cwe,
		bool	inconclusive
	)

Definition at line 176 of file errorlogger.cpp.

References callStack, file0, TokenList::getFiles(), and setmsg().

◆ ErrorMessage() [6/7]

ErrorLogger::ErrorMessage::ErrorMessage ( )

Definition at line 106 of file errorlogger.cpp.

◆ ErrorMessage() [7/7]

ErrorLogger::ErrorMessage::ErrorMessage ( const tinyxml2::XMLElement *const errmsg )

explicit

Definition at line 195 of file errorlogger.cpp.

References callStack, cwe, Severity::fromString(), CWE::id, inconclusive, mShortMessage, mVerboseMessage, Severity::none, and severity.

Member Function Documentation

◆ deserialize()

bool ErrorLogger::ErrorMessage::deserialize ( const std::string & data )

Definition at line 305 of file errorlogger.cpp.

References callStack, cwe, Severity::fromString(), CWE::id, inconclusive, mShortMessage, mVerboseMessage, ErrorLogger::ErrorMessage::FileLocation::setfile(), ErrorLogger::ErrorMessage::FileLocation::setinfo(), severity, and MathLib::toLongNumber().

Referenced by ThreadExecutor::~ThreadExecutor().

◆ findAndReplace()

void ErrorLogger::ErrorMessage::findAndReplace	(	std::string &	source,
		const std::string &	searchFor,
		const std::string &	replaceWith
	)

staticprivate

Replace all occurrences of searchFor with replaceWith in the given source.

Parameters

source	The string to modify
searchFor	What should be searched for
replaceWith	What will replace the found item

Definition at line 483 of file errorlogger.cpp.

Referenced by toString().

◆ fixInvalidChars()

std::string ErrorLogger::ErrorMessage::fixInvalidChars ( const std::string & raw )

staticprivate

Definition at line 421 of file errorlogger.cpp.

Referenced by serialize(), and toXML().

◆ getXMLFooter()

std::string ErrorLogger::ErrorMessage::getXMLFooter ( )

static

Definition at line 414 of file errorlogger.cpp.

Referenced by CppCheckExecutor::check_internal(), and CppCheckExecutor::parseFromArgs().

◆ getXMLHeader()

std::string ErrorLogger::ErrorMessage::getXMLHeader ( )

static

Definition at line 393 of file errorlogger.cpp.

References CppCheck::version().

Referenced by CppCheckExecutor::check_internal(), and CppCheckExecutor::parseFromArgs().

◆ serialize()

std::string ErrorLogger::ErrorMessage::serialize ( ) const

Definition at line 277 of file errorlogger.cpp.

References callStack, cwe, fixInvalidChars(), CWE::id, id, inconclusive, mShortMessage, mVerboseMessage, severity, MathLib::toString(), and Severity::toString().

Referenced by ThreadExecutor::~ThreadExecutor().

◆ setmsg()

void ErrorLogger::ErrorMessage::setmsg ( const std::string & msg )

set short and verbose messages

Definition at line 237 of file errorlogger.cpp.

References endsWith(), mShortMessage, mSymbolNames, mVerboseMessage, and replaceStr().

Referenced by CppCheck::analyseClangTidy(), and ErrorMessage().

◆ shortMessage()

const std::string& ErrorLogger::ErrorMessage::shortMessage ( ) const

inline

Short message (single line short message)

Definition at line 292 of file errorlogger.h.

Referenced by ErrorLogger::plistData().

◆ symbolNames()

const std::string& ErrorLogger::ErrorMessage::symbolNames ( ) const

inline

Symbol names.

Definition at line 302 of file errorlogger.h.

◆ toString()

std::string ErrorLogger::ErrorMessage::toString	(	bool	verbose,
		const std::string &	templateFormat = `emptyString`,
		const std::string &	templateLocation = `emptyString`
	)		const

Format the error message into a string.

Parameters

verbose	use verbose message
templateFormat	Empty string to use default output format or template to be used. E.g. "{file}:{line},{severity},{id},{message}"
templateLocation	Format Empty string to use default output format or template to be used. E.g. "{file}:{line},{info}"