Check for condition mismatches. More...

#include <checkcondition.h>

Inheritance diagram for CheckCondition:

Public Member Functions
	CheckCondition ()
	This constructor is used when registering the CheckAssignIf. More...

Public Member Functions inherited from Check
	Check (const std::string &aname)
	This constructor is used when registering the CheckClass. More...

virtual	~Check ()

	Check (const Check &)=delete

Check &	operator= (const Check &)=delete

const std::string &	name () const
	class name, used to generate documentation More...

virtual FileInfo *	getFileInfo (const Tokenizer &, const Settings &) const

virtual FileInfo *	loadFileInfoFromXml (const tinyxml2::XMLElement *xmlElement) const

virtual bool	analyseWholeProgram (const CTU::FileInfo ctu, const std::list< FileInfo > &fileInfo, const Settings &, ErrorLogger &)

Private Member Functions
	CheckCondition (const Tokenizer tokenizer, const Settings settings, ErrorLogger *errorLogger)
	This constructor is used when running checks. More...

void	runChecks (const Tokenizer &tokenizer, ErrorLogger *errorLogger) override
	run checks, the token list is not simplified More...

void	assignIf ()
	mismatching assignment / comparison More...

bool	assignIfParseScope (const Token const assignTok, const Token const startTok, const nonneg int varid, const bool islocal, const char bitop, const MathLib::bigint num)
	parse scopes recursively More...

void	checkBadBitmaskCheck ()
	check bitmask using \| instead of & More...

void	comparison ()
	mismatching lhs and rhs in comparison More...

void	duplicateCondition ()

void	multiCondition ()
	match 'if' and 'else if' conditions More...

void	multiCondition2 ()
	multiconditions #2 More...

void	checkIncorrectLogicOperator ()
	Check for testing for mutual exclusion over \|\| More...

void	checkModuloAlwaysTrueFalse ()
	Check for suspicious usage of modulo (e.g. More...

void	clarifyCondition ()
	Suspicious condition (assignment+comparison) More...

void	alwaysTrueFalse ()
	Condition is always true/false. More...

void	checkInvalidTestForOverflow ()
	Check for invalid test for overflow 'x+100 < x' More...

void	checkPointerAdditionResultNotNull ()
	Check if pointer addition result is NULL '(ptr + 1) == NULL'. More...

void	checkDuplicateConditionalAssign ()

void	checkAssignmentInCondition ()
	Assignment in condition. More...

bool	diag (const Token *tok, bool insert=true)

bool	isAliased (const std::set< int > &vars) const

bool	isOverlappingCond (const Token const cond1, const Token const cond2, bool pure) const

void	assignIfError (const Token tok1, const Token tok2, const std::string &condition, bool result)

void	mismatchingBitAndError (const Token tok1, const MathLib::bigint num1, const Token tok2, const MathLib::bigint num2)

void	badBitmaskCheckError (const Token *tok, bool isNoOp=false)

void	comparisonError (const Token *tok, const std::string &bitop, MathLib::bigint value1, const std::string &op, MathLib::bigint value2, bool result)

void	duplicateConditionError (const Token tok1, const Token tok2, ErrorPath errorPath)

void	overlappingElseIfConditionError (const Token *tok, nonneg int line1)

void	oppositeElseIfConditionError (const Token ifCond, const Token elseIfCond, ErrorPath errorPath)

void	oppositeInnerConditionError (const Token tok1, const Token tok2, ErrorPath errorPath)

void	identicalInnerConditionError (const Token tok1, const Token tok2, ErrorPath errorPath)

void	identicalConditionAfterEarlyExitError (const Token cond1, const Token cond2, ErrorPath errorPath)

void	incorrectLogicOperatorError (const Token *tok, const std::string &condition, bool always, bool inconclusive, ErrorPath errors)

void	redundantConditionError (const Token *tok, const std::string &text, bool inconclusive)

void	moduloAlwaysTrueFalseError (const Token *tok, const std::string &maxVal)

void	clarifyConditionError (const Token *tok, bool assign, bool boolop)

void	alwaysTrueFalseError (const Token tok, const Token condition, const ValueFlow::Value *value)

void	invalidTestForOverflow (const Token tok, const ValueType valueType, const std::string &replace)

void	pointerAdditionResultNotNullError (const Token tok, const Token calc)

void	duplicateConditionalAssignError (const Token condTok, const Token assignTok, bool isRedundant=false)

void	assignmentInCondition (const Token *eq)

void	checkCompareValueOutOfTypeRange ()

void	compareValueOutOfTypeRangeError (const Token *comparison, const std::string &type, long long value, bool result)

void	getErrorMessages (ErrorLogger errorLogger, const Settings settings) const override
	get error messages More...

std::string	classInfo () const override
	get information about this class, used to generate documentation More...

Static Private Member Functions
static std::string	myName ()

Private Attributes
std::set< const Token * >	mCondDiags

Additional Inherited Members
Static Public Member Functions inherited from Check
static std::list< Check * > &	instances ()
	List of registered check classes. More...

static void	writeToErrorList (const ErrorMessage &errmsg)
	Write given error to stdout in xml format. More...

Protected Member Functions inherited from Check
	Check (std::string aname, const Tokenizer tokenizer, const Settings settings, ErrorLogger *errorLogger)
	This constructor is used when running checks. More...

void	reportError (const Token *tok, const Severity severity, const std::string &id, const std::string &msg)
	report an error More...

void	reportError (const Token *tok, const Severity severity, const std::string &id, const std::string &msg, const CWE &cwe, Certainty certainty)
	report an error More...

void	reportError (const std::list< const Token * > &callstack, Severity severity, const std::string &id, const std::string &msg)
	report an error More...

void	reportError (const std::list< const Token * > &callstack, Severity severity, const std::string &id, const std::string &msg, const CWE &cwe, Certainty certainty)
	report an error More...

void	reportError (const ErrorPath &errorPath, Severity severity, const char id[], const std::string &msg, const CWE &cwe, Certainty certainty)

void	logChecker (const char id[])
	log checker More...

ErrorPath	getErrorPath (const Token errtok, const ValueFlow::Value value, std::string bug) const

bool	wrongData (const Token tok, const char str)
	Use WRONG_DATA in checkers when you check for wrong data. More...

Static Protected Member Functions inherited from Check
static std::string	getMessageId (const ValueFlow::Value &value, const char id[])

Protected Attributes inherited from Check
const Tokenizer *const	mTokenizer {}

const Settings *const	mSettings {}

ErrorLogger *const	mErrorLogger {}

Detailed Description

Check for condition mismatches.

Definition at line 50 of file checkcondition.h.

Constructor & Destructor Documentation

◆ CheckCondition() [1/2]

CheckCondition::CheckCondition ( )

inline

This constructor is used when registering the CheckAssignIf.

Definition at line 53 of file checkcondition.h.

◆ CheckCondition() [2/2]

CheckCondition::CheckCondition	(	const Tokenizer *	tokenizer,
		const Settings *	settings,
		ErrorLogger *	errorLogger
	)

inlineprivate

This constructor is used when running checks.

Definition at line 57 of file checkcondition.h.

Member Function Documentation

◆ alwaysTrueFalse()

void CheckCondition::alwaysTrueFalse ( )

private

Condition is always true/false.

Definition at line 1483 of file checkcondition.cpp.

References alwaysTrueFalseError(), Token::astOperand1(), Token::astParent(), Scope::bodyEnd, Scope::bodyStart, CheckOther::comparisonNonZeroExpressionLessThanZero(), diag(), Function::functionScope, SymbolDatabase::functionScopes, Tokenizer::getSymbolDatabase(), Token::isArithmeticalOp(), Token::isComparisonOp(), Token::isConstexpr(), isConstVarExpression(), SimpleEnableGroup< T >::isEnabled(), Token::isExpandedMacro(), Token::isNumber(), Settings::isPremiumEnabled(), isSameExpression(), isUsedAsBool(), isWithoutSideEffects(), Check::logChecker(), Token::Match(), Check::mSettings, Check::mTokenizer, Token::next(), none, op1_and_op2, precedes(), Token::previous(), Settings::severity, Token::simpleMatch(), Token::str(), style, CheckOther::testIfNonZeroExpressionIsPositive(), Token::values(), and visitAstNodes().

Referenced by runChecks().

◆ alwaysTrueFalseError()

void CheckCondition::alwaysTrueFalseError	(	const Token *	tok,
		const Token *	condition,
		const ValueFlow::Value *	value
	)

private

Definition at line 1630 of file checkcondition.cpp.

References bool_to_string(), CWE570, CWE571, Token::expressionString(), Check::getErrorPath(), ValueFlow::Value::intvalue, ValueFlow::Value::isImpossible(), normal, Check::reportError(), Token::simpleMatch(), and style.

Referenced by alwaysTrueFalse(), and getErrorMessages().

◆ assignIf()

void CheckCondition::assignIf ( )

private

mismatching assignment / comparison

Definition at line 88 of file checkcondition.cpp.

References assignIfParseScope(), Variable::declarationId(), Token::findsimplematch(), SimpleEnableGroup< T >::isEnabled(), Variable::isLocal(), Settings::isPremiumEnabled(), Check::logChecker(), Token::Match(), Check::mSettings, Check::mTokenizer, Token::next(), Token::previous(), Settings::severity, Token::str(), Token::strAt(), style, MathLib::toBigNumber(), Token::tokAt(), and Tokenizer::tokens().

Referenced by runChecks().

◆ assignIfError()

void CheckCondition::assignIfError	(	const Token *	tok1,
		const Token *	tok2,
		const std::string &	condition,
		bool	result
	)

private

Definition at line 239 of file checkcondition.cpp.

References bool_to_string(), CWE398, diag(), normal, Check::reportError(), style, and Token::tokAt().

Referenced by assignIfParseScope(), and getErrorMessages().

◆ assignIfParseScope()

bool CheckCondition::assignIfParseScope	(	const Token *const	assignTok,
		const Token *const	startTok,
		const nonneg int	varid,
		const bool	islocal,
		const char	bitop,
		const MathLib::bigint	num
	)

private

parse scopes recursively

Definition at line 161 of file checkcondition.cpp.

References assignIfError(), isParameterChanged(), isVariableChanged(), Token::link(), Token::linkAt(), Token::Match(), mismatchingBitAndError(), Check::mSettings, Token::next(), Token::simpleMatch(), Token::str(), Token::strAt(), MathLib::toBigNumber(), and Token::tokAt().

Referenced by assignIf().

◆ assignmentInCondition()

void CheckCondition::assignmentInCondition ( const Token * eq )

private

Definition at line 1907 of file checkcondition.cpp.

References CWE571, Token::expressionString(), normal, Check::reportError(), and style.

Referenced by checkAssignmentInCondition(), and getErrorMessages().

◆ badBitmaskCheckError()

void CheckCondition::badBitmaskCheckError	(	const Token *	tok,
		bool	isNoOp = `false`
	)

private

Definition at line 347 of file checkcondition.cpp.

References CWE571, normal, Check::reportError(), style, and warning.

Referenced by checkBadBitmaskCheck(), and getErrorMessages().

◆ checkAssignmentInCondition()

void CheckCondition::checkAssignmentInCondition ( )

private

Assignment in condition.

Definition at line 1873 of file checkcondition.cpp.

References assignmentInCondition(), Scope::bodyEnd, Scope::bodyStart, SymbolDatabase::functionScopes, Tokenizer::getSymbolDatabase(), SimpleEnableGroup< T >::isEnabled(), Settings::isPremiumEnabled(), Check::logChecker(), Token::Match(), Check::mSettings, Check::mTokenizer, Token::next(), Settings::severity, Token::simpleMatch(), and style.

Referenced by runChecks().

◆ checkBadBitmaskCheck()

void CheckCondition::checkBadBitmaskCheck ( )

private

check bitmask using | instead of &

Definition at line 307 of file checkcondition.cpp.

References Token::astOperand1(), Token::astOperand2(), Token::astParent(), badBitmaskCheckError(), Tokenizer::hasIfdef(), inBooleanFunction(), SimpleEnableGroup< T >::isEnabled(), isOperandExpanded(), Settings::isPremiumEnabled(), isTrue(), Check::logChecker(), Token::Match(), Check::mSettings, Check::mTokenizer, Token::next(), Settings::severity, Token::str(), style, and Tokenizer::tokens().

Referenced by runChecks().

◆ checkCompareValueOutOfTypeRange()

void CheckCondition::checkCompareValueOutOfTypeRange ( )

private

◆ checkDuplicateConditionalAssign()

void CheckCondition::checkDuplicateConditionalAssign ( )

private

◆ checkIncorrectLogicOperator()

void CheckCondition::checkIncorrectLogicOperator ( )

private

Check for testing for mutual exclusion over ||

Definition at line 1124 of file checkcondition.cpp.

References astIsFloat(), Token::astOperand1(), Token::astOperand2(), Scope::bodyEnd, Scope::bodyStart, Settings::certainty, checkFloatRelation(), checkIntRelation(), conditionString(), Token::expressionString(), SymbolDatabase::functionScopes, Tokenizer::getSymbolDatabase(), inconclusive, incorrectLogicOperatorError(), SimpleEnableGroup< T >::isEnabled(), MathLib::isFloat(), isIfConstexpr(), isOppositeCond(), Settings::isPremiumEnabled(), isSameExpression(), Check::logChecker(), Token::Match(), Check::mSettings, Check::mTokenizer, Token::next(), op1, op2, parseComparison(), redundantConditionError(), Settings::severity, Token::str(), style, sufficientCondition(), MathLib::toBigNumber(), MathLib::toDoubleNumber(), ValueType::type, ValueType::UNKNOWN_TYPE, Token::valueType(), and warning.

Referenced by runChecks().

◆ checkInvalidTestForOverflow()

void CheckCondition::checkInvalidTestForOverflow ( )

private

Check for invalid test for overflow 'x+100 < x'

Definition at line 1644 of file checkcondition.cpp.

References Token::astOperand1(), Token::astSibling(), bool_to_string(), Token::getKnownIntValue(), invalidTestForOverflow(), SimpleEnableGroup< T >::isEnabled(), ValueType::isIntegral(), Token::isNumber(), isSameExpression(), Check::logChecker(), Token::Match(), Check::mSettings, Check::mTokenizer, Token::next(), Settings::severity, ValueType::sign, Token::str(), Tokenizer::tokens(), Token::valueType(), Token::varId(), and warning.

Referenced by runChecks().

◆ checkModuloAlwaysTrueFalse()

void CheckCondition::checkModuloAlwaysTrueFalse ( )

private

Check for suspicious usage of modulo (e.g.

"if(var % 4 == 4)")

Definition at line 1363 of file checkcondition.cpp.

References Token::astOperand1(), Token::astOperand2(), Scope::bodyEnd, Scope::bodyStart, SymbolDatabase::functionScopes, Tokenizer::getSymbolDatabase(), SimpleEnableGroup< T >::isEnabled(), MathLib::isLessEqual(), Check::logChecker(), Token::Match(), moduloAlwaysTrueFalseError(), Check::mSettings, Check::mTokenizer, Token::next(), Settings::severity, Token::simpleMatch(), Token::str(), and warning.

Referenced by runChecks().

◆ checkPointerAdditionResultNotNull()

void CheckCondition::checkPointerAdditionResultNotNull ( )

private

Check if pointer addition result is NULL '(ptr + 1) == NULL'.

Definition at line 1747 of file checkcondition.cpp.

References Token::astOperand1(), Token::astOperand2(), Scope::bodyEnd, Scope::bodyStart, SymbolDatabase::functionScopes, Tokenizer::getSymbolDatabase(), Token::getValue(), Token::hasKnownIntValue(), SimpleEnableGroup< T >::isEnabled(), Check::logChecker(), Check::mSettings, Check::mTokenizer, Token::next(), ValueType::pointer, pointerAdditionResultNotNullError(), Settings::severity, Token::valueType(), and warning.

Referenced by runChecks().

◆ clarifyCondition()

void CheckCondition::clarifyCondition ( )

private

Suspicious condition (assignment+comparison)

Definition at line 1419 of file checkcondition.cpp.

References Scope::bodyEnd, Scope::bodyStart, ValueType::BOOL, clarifyConditionError(), countPar(), Token::eBitOp, SymbolDatabase::functionScopes, Tokenizer::getSymbolDatabase(), SimpleEnableGroup< T >::isEnabled(), Settings::isPremiumEnabled(), Check::logChecker(), Token::Match(), Check::mSettings, Check::mTokenizer, Token::next(), Settings::severity, Token::simpleMatch(), style, Token::tokAt(), and ValueType::type.

Referenced by runChecks().

◆ clarifyConditionError()

void CheckCondition::clarifyConditionError	(	const Token *	tok,
		bool	assign,
		bool	boolop
	)

private

Definition at line 1460 of file checkcondition.cpp.

References CWE398, normal, Check::reportError(), and style.

Referenced by clarifyCondition(), and getErrorMessages().

◆ classInfo()

std::string CheckCondition::classInfo ( ) const

inlineoverrideprivatevirtual

get information about this class, used to generate documentation

Implements Check.

Definition at line 203 of file checkcondition.h.

◆ compareValueOutOfTypeRangeError()

void CheckCondition::compareValueOutOfTypeRangeError	(	const Token *	comparison,
		const std::string &	type,
		long long	value,
		bool	result
	)

private

Definition at line 2039 of file checkcondition.cpp.

References bool_to_string(), comparison(), CWE398, normal, Check::reportError(), and style.

Referenced by checkCompareValueOutOfTypeRange(), and getErrorMessages().

◆ comparison()

void CheckCondition::comparison ( )

private

mismatching lhs and rhs in comparison

Definition at line 355 of file checkcondition.cpp.

References Token::astOperand1(), Token::astOperand2(), comparisonError(), getnumchildren(), SimpleEnableGroup< T >::isEnabled(), Token::isNumber(), Settings::isPremiumEnabled(), Check::logChecker(), Token::Match(), Check::mSettings, Check::mTokenizer, Token::next(), Settings::severity, Token::str(), style, MathLib::toBigNumber(), and Tokenizer::tokens().

Referenced by compareValueOutOfTypeRangeError(), and runChecks().

◆ comparisonError()

void CheckCondition::comparisonError	(	const Token *	tok,
		const std::string &	bitop,
		MathLib::bigint	value1,
		const std::string &	op,
		MathLib::bigint	value2,
		bool	result
	)