clang  6.0.0svn
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
clang::ento::NodeBuilder Class Reference

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

#include "clang/StaticAnalyzer/Core/PathSensitive/CoreEngine.h"

Inheritance diagram for clang::ento::NodeBuilder:
Inheritance graph
[legend]
Collaboration diagram for clang::ento::NodeBuilder:
Collaboration graph
[legend]

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 ()
 
ExplodedNodegenerateNode (const ProgramPoint &PP, ProgramStateRef State, ExplodedNode *Pred)
 Generates a node in the ExplodedGraph. More...
 
ExplodedNodegenerateSink (const ProgramPoint &PP, ProgramStateRef State, ExplodedNode *Pred)
 Generates a sink in the ExplodedGraph. More...
 
const ExplodedNodeSetgetResults ()
 
iterator begin ()
 Iterators through the results frontier. More...
 
iterator end ()
 
const NodeBuilderContextgetContext ()
 
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. More...
 
bool hasNoSinksInFrontier ()
 
virtual void finalizeResults ()
 Allow subclasses to finalize results before result_begin() is executed. More...
 
ExplodedNodegenerateNodeImpl (const ProgramPoint &PP, ProgramStateRef State, ExplodedNode *Pred, bool MarkAsSink=false)
 

Protected Attributes

const NodeBuilderContextC
 
bool Finalized
 Specifies if the builder results have been finalized. More...
 
bool HasGeneratedNodes
 
ExplodedNodeSetFrontier
 The frontier set - a set of nodes which need to be propagated after the builder dies. More...
 

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 211 of file CoreEngine.h.

Member Typedef Documentation

◆ iterator

Definition at line 287 of file CoreEngine.h.

Constructor & Destructor Documentation

◆ NodeBuilder() [1/2]

clang::ento::NodeBuilder::NodeBuilder ( ExplodedNode SrcNode,
ExplodedNodeSet DstSet,
const NodeBuilderContext Ctx,
bool  F = true 
)
inline

Definition at line 248 of file CoreEngine.h.

References clang::ento::ExplodedNodeSet::Add().

◆ NodeBuilder() [2/2]

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

Definition at line 254 of file CoreEngine.h.

References clang::ento::ExplodedNodeSet::insert().

◆ ~NodeBuilder()

virtual clang::ento::NodeBuilder::~NodeBuilder ( )
inlinevirtual

Definition at line 261 of file CoreEngine.h.

Member Function Documentation

◆ addNodes() [1/2]

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

Definition at line 307 of file CoreEngine.h.

◆ addNodes() [2/2]

void clang::ento::NodeBuilder::addNodes ( ExplodedNode N)
inline

Definition at line 308 of file CoreEngine.h.

References clang::ento::ExplodedNodeSet::Add().

◆ begin()

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

Iterators through the results frontier.

Definition at line 289 of file CoreEngine.h.

References clang::ento::ExplodedNodeSet::begin().

◆ checkResults()

virtual bool clang::ento::NodeBuilder::checkResults ( )
inlineprotectedvirtual

Checkes if the results are ready.

Definition at line 225 of file CoreEngine.h.

◆ end()

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

Definition at line 294 of file CoreEngine.h.

References clang::ento::ExplodedNodeSet::end().

◆ finalizeResults()

virtual void clang::ento::NodeBuilder::finalizeResults ( )
inlineprotectedvirtual

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

Definition at line 240 of file CoreEngine.h.

References State.

◆ generateNode()

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

◆ generateNodeImpl()

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

Definition at line 655 of file CoreEngine.cpp.

References clang::ento::ExplodedNode::addPredecessor().

◆ 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 275 of file CoreEngine.h.

Referenced by clang::ento::NodeBuilderWithSinks::generateSink().

◆ getContext()

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

◆ getResults()

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

Definition at line 281 of file CoreEngine.h.

Referenced by clang::ento::ExprEngine::VisitCXXNewExpr().

◆ hasGeneratedNodes()

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

Definition at line 300 of file CoreEngine.h.

◆ hasNoSinksInFrontier()

bool clang::ento::NodeBuilder::hasNoSinksInFrontier ( )
inlineprotected

Definition at line 231 of file CoreEngine.h.

◆ takeNodes() [1/2]

void clang::ento::NodeBuilder::takeNodes ( const ExplodedNodeSet S)
inline

◆ takeNodes() [2/2]

void clang::ento::NodeBuilder::takeNodes ( ExplodedNode N)
inline

Definition at line 306 of file CoreEngine.h.

References clang::ento::ExplodedNodeSet::erase().

Member Data Documentation

◆ C

const NodeBuilderContext& clang::ento::NodeBuilder::C
protected

Definition at line 214 of file CoreEngine.h.

◆ Finalized

bool clang::ento::NodeBuilder::Finalized
protected

Specifies if the builder results have been finalized.

For example, if it is set to false, autotransitions are yet to be generated.

Definition at line 218 of file CoreEngine.h.

◆ Frontier

ExplodedNodeSet& clang::ento::NodeBuilder::Frontier
protected

The frontier set - a set of nodes which need to be propagated after the builder dies.

Definition at line 222 of file CoreEngine.h.

◆ HasGeneratedNodes

bool clang::ento::NodeBuilder::HasGeneratedNodes
protected

Definition at line 219 of file CoreEngine.h.


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