This is the simplest builder which generates nodes in the ExplodedGraph. More...

#include <CoreEngine.h>

Inheritance diagram for clang::ento::NodeBuilder:

Collaboration diagram for clang::ento::NodeBuilder:

Public Types
typedef ExplodedNodeSet::iterator	iterator
Public Member Functions
	NodeBuilder (ExplodedNode *SrcNode, ExplodedNodeSet &DstSet, const NodeBuilderContext &Ctx, bool F=true)
	NodeBuilder (const ExplodedNodeSet &SrcSet, ExplodedNodeSet &DstSet, const NodeBuilderContext &Ctx, bool F=true)
virtual	~NodeBuilder ()
ExplodedNode *	generateNode (const ProgramPoint &PP, ProgramStateRef State, ExplodedNode *Pred)
	Generates a node in the ExplodedGraph.
ExplodedNode *	generateSink (const ProgramPoint &PP, ProgramStateRef State, ExplodedNode *Pred)
	Generates a sink in the ExplodedGraph.
const ExplodedNodeSet &	getResults ()
iterator	begin ()
	Iterators through the results frontier.
iterator	end ()
const NodeBuilderContext &	getContext ()
bool	hasGeneratedNodes ()
void	takeNodes (const ExplodedNodeSet &S)
void	takeNodes (ExplodedNode *N)
void	addNodes (const ExplodedNodeSet &S)
void	addNodes (ExplodedNode *N)
Protected Member Functions
virtual bool	checkResults ()
	Checkes if the results are ready.
bool	hasNoSinksInFrontier ()
virtual void	finalizeResults ()
	Allow subclasses to finalize results before result_begin() is executed.
ExplodedNode *	generateNodeImpl (const ProgramPoint &PP, ProgramStateRef State, ExplodedNode *Pred, bool MarkAsSink=false)
Protected Attributes
const NodeBuilderContext &	C
bool	Finalized
bool	HasGeneratedNodes
ExplodedNodeSet &	Frontier
	The frontier set - a set of nodes which need to be propagated after the builder dies.

Detailed Description

This is the simplest builder which generates nodes in the ExplodedGraph.

The main benefit of the builder is that it automatically tracks the frontier nodes (or destination set). This is the set of nodes which should be propagated to the next step / builder. They are the nodes which have been added to the builder (either as the input node set or as the newly constructed nodes) but did not have any outgoing transitions added.

Definition at line 207 of file CoreEngine.h.

Member Typedef Documentation

typedef ExplodedNodeSet::iterator clang::ento::NodeBuilder::iterator

Definition at line 283 of file CoreEngine.h.

Constructor & Destructor Documentation

clang::ento::NodeBuilder::NodeBuilder	(	ExplodedNode *	SrcNode,
		ExplodedNodeSet &	DstSet,
		const NodeBuilderContext &	Ctx,
		bool	F = `true`
	)		`[inline]`

Definition at line 244 of file CoreEngine.h.

References clang::ento::ExplodedNodeSet::Add(), and Frontier.

clang::ento::NodeBuilder::NodeBuilder	(	const ExplodedNodeSet &	SrcSet,
		ExplodedNodeSet &	DstSet,
		const NodeBuilderContext &	Ctx,
		bool	F = `true`
	)		`[inline]`

Definition at line 250 of file CoreEngine.h.

References Frontier, hasNoSinksInFrontier(), and clang::ento::ExplodedNodeSet::insert().

virtual clang::ento::NodeBuilder::~NodeBuilder ( ) [inline, virtual]

Definition at line 257 of file CoreEngine.h.

Member Function Documentation

void clang::ento::NodeBuilder::addNodes ( const ExplodedNodeSet & S ) [inline]

Definition at line 303 of file CoreEngine.h.

References Frontier, and clang::ento::ExplodedNodeSet::insert().

Referenced by clang::ento::ExprEngine::Visit(), clang::ento::ExprEngine::VisitDeclStmt(), clang::ento::ExprEngine::VisitIncrementDecrementOperator(), clang::ento::ExprEngine::VisitMemberExpr(), and clang::ento::ExprEngine::VisitUnaryOperator().

void clang::ento::NodeBuilder::addNodes ( ExplodedNode * N ) [inline]

Definition at line 304 of file CoreEngine.h.

References clang::ento::ExplodedNodeSet::Add(), and Frontier.

iterator clang::ento::NodeBuilder::begin ( ) [inline]

Iterators through the results frontier.

Definition at line 285 of file CoreEngine.h.

References clang::ento::ExplodedNodeSet::begin(), checkResults(), finalizeResults(), and Frontier.

virtual bool clang::ento::NodeBuilder::checkResults ( ) [inline, protected, virtual]

Checkes if the results are ready.

Definition at line 221 of file CoreEngine.h.

References Finalized.

Referenced by begin(), and getResults().

iterator clang::ento::NodeBuilder::end ( ) [inline]

Definition at line 290 of file CoreEngine.h.

References clang::ento::ExplodedNodeSet::end(), finalizeResults(), and Frontier.

virtual void clang::ento::NodeBuilder::finalizeResults ( ) [inline, protected, virtual]

Allow subclasses to finalize results before result_begin() is executed.

Definition at line 236 of file CoreEngine.h.

Referenced by begin(), end(), and getResults().

ExplodedNode* clang::ento::NodeBuilder::generateNode	(	const ProgramPoint &	PP,
		ProgramStateRef	State,
		ExplodedNode *	Pred
	)		`[inline]`

Generates a node in the ExplodedGraph.

Definition at line 260 of file CoreEngine.h.

References generateNodeImpl().

Referenced by clang::ento::ExprEngine::ProcessInitializer(), and clang::ento::ExprEngine::ProcessNewAllocator().

ExplodedNode * NodeBuilder::generateNodeImpl	(	const ProgramPoint &	PP,
		ProgramStateRef	State,
		ExplodedNode *	Pred,
		bool	MarkAsSink = `false`
	)		`[protected]`

Definition at line 625 of file CoreEngine.cpp.

References clang::ento::ExplodedNode::addPredecessor(), and AttributeLangSupport::C.

Referenced by generateNode(), and generateSink().

ExplodedNode* clang::ento::NodeBuilder::generateSink	(	const ProgramPoint &	PP,
		ProgramStateRef	State,
		ExplodedNode *	Pred
	)		`[inline]`

Generates a sink in the ExplodedGraph.

When a node is marked as sink, the exploration from the node is stopped - the node becomes the last node on the path and certain kinds of bugs are suppressed.

Definition at line 271 of file CoreEngine.h.

References generateNodeImpl().

const NodeBuilderContext& clang::ento::NodeBuilder::getContext ( ) [inline]

Definition at line 295 of file CoreEngine.h.

References C.

Referenced by clang::ento::CheckerContext::blockCount(), clang::ento::CheckerContext::getBlockID(), and clang::ento::ExprEngine::processCFGBlockEntrance().

const ExplodedNodeSet& clang::ento::NodeBuilder::getResults ( ) [inline]

Definition at line 277 of file CoreEngine.h.

References checkResults(), finalizeResults(), and Frontier.

Referenced by clang::ento::ExprEngine::VisitCXXNewExpr(), and clang::ento::ExprEngine::VisitDeclStmt().

bool clang::ento::NodeBuilder::hasGeneratedNodes ( ) [inline]

Definition at line 296 of file CoreEngine.h.