#include "clang/Analysis/Analyses/Consumed.h"

Public Member Functions
	ConsumedStateMap ()=default

	ConsumedStateMap (const ConsumedStateMap &Other)

ConsumedStateMap &	operator= (const ConsumedStateMap &)=delete

void	checkParamsForReturnTypestate (SourceLocation BlameLoc, ConsumedWarningsHandlerBase &WarningsHandler) const
	Warn if any of the parameters being tracked are not in the state they were declared to be in upon return from a function.

void	clearTemporaries ()
	Clear the TmpMap.

ConsumedState	getState (const VarDecl *Var) const
	Get the consumed state of a given variable.

ConsumedState	getState (const CXXBindTemporaryExpr *Tmp) const
	Get the consumed state of a given temporary value.

void	intersect (const ConsumedStateMap &Other)
	Merge this state map with another map.

void	intersectAtLoopHead (const CFGBlock LoopHead, const CFGBlock LoopBack, const ConsumedStateMap *LoopBackStates, ConsumedWarningsHandlerBase &WarningsHandler)

bool	isReachable () const
	Return true if this block is reachable.

void	markUnreachable ()
	Mark the block as unreachable.

void	setSource (const Stmt *Source)
	Set the source for a decision about the branching of states.

void	setState (const VarDecl *Var, ConsumedState State)
	Set the consumed state of a given variable.

void	setState (const CXXBindTemporaryExpr *Tmp, ConsumedState State)
	Set the consumed state of a given temporary value.

void	remove (const CXXBindTemporaryExpr *Tmp)
	Remove the temporary value from our state map.

bool	operator!= (const ConsumedStateMap *Other) const
	Tests to see if there is a mismatch in the states stored in two maps.

Protected Attributes
bool	Reachable = true

const Stmt *	From = nullptr

VarMapType	VarMap

TmpMapType	TmpMap

Detailed Description

Definition at line 142 of file Consumed.h.

Constructor & Destructor Documentation

◆ ConsumedStateMap() [1/2]

clang::consumed::ConsumedStateMap::ConsumedStateMap ( )

default

◆ ConsumedStateMap() [2/2]

clang::consumed::ConsumedStateMap::ConsumedStateMap ( const ConsumedStateMap & Other )

inline

Definition at line 155 of file Consumed.h.

Member Function Documentation

◆ checkParamsForReturnTypestate()

void ConsumedStateMap::checkParamsForReturnTypestate	(	SourceLocation	BlameLoc,
		ConsumedWarningsHandlerBase &	WarningsHandler
	)		const

Warn if any of the parameters being tracked are not in the state they were declared to be in upon return from a function.

Definition at line 1089 of file Consumed.cpp.

References mapReturnTypestateAttrState(), stateToString(), VarMap, and clang::consumed::ConsumedWarningsHandlerBase::warnParamReturnTypestateMismatch().

Referenced by clang::consumed::ConsumedStmtVisitor::VisitReturnStmt().

◆ clearTemporaries()

void ConsumedStateMap::clearTemporaries ( )

Clear the TmpMap.

Definition at line 1109 of file Consumed.cpp.

References TmpMap.

◆ getState() [1/2]

ConsumedState ConsumedStateMap::getState ( const CXXBindTemporaryExpr * Tmp ) const

Get the consumed state of a given temporary value.

Definition at line 1123 of file Consumed.cpp.

References clang::consumed::CS_None, and TmpMap.

◆ getState() [2/2]

ConsumedState ConsumedStateMap::getState ( const VarDecl * Var ) const

Get the consumed state of a given variable.

Definition at line 1113 of file Consumed.cpp.

References clang::consumed::CS_None, and VarMap.

Referenced by clang::consumed::ConsumedStmtVisitor::checkCallability(), clang::consumed::PropagationInfo::getAsState(), intersect(), intersectAtLoopHead(), operator!=(), splitVarStateForIf(), splitVarStateForIfBinOp(), and clang::consumed::ConsumedStmtVisitor::VisitDeclRefExpr().

◆ intersect()

void ConsumedStateMap::intersect ( const ConsumedStateMap & Other )

Merge this state map with another map.

Definition at line 1132 of file Consumed.cpp.

References clang::consumed::CS_None, clang::consumed::CS_Unknown, getState(), markUnreachable(), clang::Other, and VarMap.

◆ intersectAtLoopHead()

void ConsumedStateMap::intersectAtLoopHead	(	const CFGBlock *	LoopHead,
		const CFGBlock *	LoopBack,
		const ConsumedStateMap *	LoopBackStates,
		ConsumedWarningsHandlerBase &	WarningsHandler
	)

Definition at line 1151 of file Consumed.cpp.

References clang::consumed::CS_None, clang::consumed::CS_Unknown, getLastStmtLoc(), getState(), VarMap, and clang::consumed::ConsumedWarningsHandlerBase::warnLoopStateMismatch().

◆ isReachable()

bool clang::consumed::ConsumedStateMap::isReachable ( ) const

inline

Return true if this block is reachable.

Definition at line 184 of file Consumed.h.

References Reachable.

◆ markUnreachable()

void ConsumedStateMap::markUnreachable ( )

Mark the block as unreachable.

Definition at line 1172 of file Consumed.cpp.

References Reachable, TmpMap, and VarMap.

Referenced by intersect(), splitVarStateForIf(), and splitVarStateForIfBinOp().

◆ operator!=()

bool ConsumedStateMap::operator!= ( const ConsumedStateMap * Other ) const

Tests to see if there is a mismatch in the states stored in two maps.

Parameters

Other – The second map to compare against.

Definition at line 1191 of file Consumed.cpp.

References getState(), and clang::Other.

◆ operator=()

ConsumedStateMap & clang::consumed::ConsumedStateMap::operator= ( const ConsumedStateMap & )

delete

◆ remove()

void ConsumedStateMap::remove ( const CXXBindTemporaryExpr * Tmp )

Remove the temporary value from our state map.

Definition at line 1187 of file Consumed.cpp.

References TmpMap.

◆ setSource()

void clang::consumed::ConsumedStateMap::setSource ( const Stmt * Source )

inline

Set the source for a decision about the branching of states.

Parameters

Source – The statement that was the origin of a branching decision.

Definition at line 192 of file Consumed.h.

◆ setState() [1/2]

void ConsumedStateMap::setState	(	const CXXBindTemporaryExpr *	Tmp,
		ConsumedState	State
	)

Set the consumed state of a given temporary value.

Definition at line 1182 of file Consumed.cpp.

References TmpMap.

◆ setState() [2/2]

void ConsumedStateMap::setState	(	const VarDecl *	Var,
		ConsumedState	State
	)

Set the consumed state of a given variable.

Definition at line 1178 of file Consumed.cpp.

References VarMap.

Referenced by clang::consumed::ConsumedStmtVisitor::handleCall(), setStateForVarOrTmp(), splitVarStateForIf(), splitVarStateForIfBinOp(), clang::consumed::ConsumedStmtVisitor::VisitCXXBindTemporaryExpr(), clang::consumed::ConsumedStmtVisitor::VisitParmVarDecl(), and clang::consumed::ConsumedStmtVisitor::VisitVarDecl().

Member Data Documentation

◆ From

const Stmt* clang::consumed::ConsumedStateMap::From = nullptr

protected

Definition at line 149 of file Consumed.h.

◆ Reachable

bool clang::consumed::ConsumedStateMap::Reachable = true

protected

Definition at line 148 of file Consumed.h.

Referenced by isReachable(), and markUnreachable().

◆ TmpMap

TmpMapType clang::consumed::ConsumedStateMap::TmpMap

protected

Definition at line 151 of file Consumed.h.

Referenced by clearTemporaries(), getState(), markUnreachable(), remove(), and setState().

◆ VarMap

VarMapType clang::consumed::ConsumedStateMap::VarMap

protected

Definition at line 150 of file Consumed.h.

Referenced by checkParamsForReturnTypestate(), getState(), intersect(), intersectAtLoopHead(), markUnreachable(), and setState().

The documentation for this class was generated from the following files:

include/clang/Analysis/Analyses/Consumed.h
lib/Analysis/Consumed.cpp

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ConsumedStateMap() [1/2]

◆ ConsumedStateMap() [2/2]

Member Function Documentation

◆ checkParamsForReturnTypestate()

◆ clearTemporaries()

◆ getState() [1/2]

◆ getState() [2/2]

◆ intersect()

◆ intersectAtLoopHead()

◆ isReachable()

◆ markUnreachable()

◆ operator!=()

◆ operator=()

◆ remove()

◆ setSource()

◆ setState() [1/2]

◆ setState() [2/2]

Member Data Documentation

◆ From

◆ Reachable

◆ TmpMap

◆ VarMap